ripmors 0.1.0

ripmors is a library for encoding and decoding international Morse code and several variants
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
macro_rules! element_to_binary_digit {
    ($binary_value:ident, $elements:expr, $offset:expr) => {
        let elements = $elements;
        let offset = $offset;
        if elements.len() > offset {
            $binary_value *= 2;
            if elements[offset] == b'.' {
                $binary_value += 0;
            } else if elements[offset] == b'-' {
                $binary_value += 1;
            } else {
                panic!("Unexpected element");
            }
        }
    };
}

macro_rules! to_script {
    ($(#[$outer:meta])* $array_name:ident, $function_name:ident, $($elements:expr => $character:expr),+ $(,)? ) => {
        const $array_name: [char; 256] = {
            let mut x = ['\0'; 256];
            $(
                let elements = $elements.as_bytes();
                let mut binary_value = 1;
                if elements.len() > 8 { panic!("Too many elements"); }
                element_to_binary_digit!(binary_value, elements, 7);
                element_to_binary_digit!(binary_value, elements, 6);
                element_to_binary_digit!(binary_value, elements, 5);
                element_to_binary_digit!(binary_value, elements, 4);
                element_to_binary_digit!(binary_value, elements, 3);
                element_to_binary_digit!(binary_value, elements, 2);
                element_to_binary_digit!(binary_value, elements, 1);
                element_to_binary_digit!(binary_value, elements, 0);
                if x[binary_value as usize] != '\0' {
                    panic!("Conflict between binary values");
                }
                x[binary_value as usize] = $character;
            )+
            x[0] = ' ';
            x
        };
        $(#[$outer])*
        ///
        /// This function should not be called directly, but passed as an argument to either
        /// [decode_stream][crate::decode_stream] or [decode_string][crate::decode_string].
        ///
        /// The `elements` parameter represents up to 7 Morse code elements. There is one bit per
        /// element (0 for dot, 1 for dash), and a leading bit do detect the number of elements.
        pub fn $function_name(elements: u8) -> char {
            $array_name[elements as usize]
        }
    };
}

to_script! {
    /// Mapping from Morse code to Latin text
    TO_STANDARD,
    to_standard,
    // NOTE: Mappings are sorted like a complete binary tree in array representation. In other
    // words, they are sorted by length, then in lexicographic order. For lengths up to 5, all
    // possible combinations of Morse symbols are listed.
    //
    // This is the same order as in
    // The ARRL handbook for the Radio Amateur (1985), 19-20 https://archive.org/details/arrlhandbookforr0000unse_w7j4/page/n433/mode/2up

    // One element
    "." => 'E',
    "-" => 'T',

    // Two elements
    ".." => 'I',
    ".-" => 'A',
    "-." => 'N',
    "--" => 'M',

    // Three elements
    "..." => 'S',
    "..-" => 'U',
    ".-." => 'R',
    ".--" => 'W',
    "-.." => 'D',
    "-.-" => 'K',
    "--." => 'G',
    "---" => 'O',

    // Four elements
    "...." => 'H',
    "...-" => 'V',
    "..-." => 'F',
    "..--" => 'Ü',
    ".-.." => 'L',
    ".-.-" => 'Ä',
    ".--." => 'P',
    ".---" => 'J',
    "-..." => 'B',
    "-..-" => 'X',
    "-.-." => 'C',
    "-.--" => 'Y',
    "--.." => 'Z',
    "--.-" => 'Q',
    "---." => 'Ö',
    // "----" => 'CH', // no single Unicode codepoint for this digraph

    // Five elements
    "....." => '5',
    "....-" => '4',
    // "...-." => '<SN>', // prosign
    "...--" => '3',
    "..-.." => 'É', // or 'È' or 'Ę'
    // "..-.-" => '<INT>', // prosign
    "..--." => '!', // ??
    "..---" => '2',
    // ".-..." => '<AS>',
    // ".-..-" => '<AU>',
    ".-.-." => '+', // or '<AR>'
    // .-.--
    // .--..
    ".--.-" => 'Á', // or 'À' or 'Ä' or 'Å'
    // .---.
    ".----" => '1',
    "-...." => '6',
    "-...-" => '=', // or '<BT>'
    "-..-." => '/', // or '<DN>'
    // -..--
    "-.-.." => 'Ç',
    // "-.-.-" => '<KA>', // prosign
    "-.--." => '(', // or '<KN>'
    // -.---
    "--..." => '7',
    "--..-" => 'Ź', // or 'Ż', probably, but not listed in ARRL handbook
    // --.-. // NOTE: missing from the ARRL handbook
    "--.--" => 'Ñ', // NOTE: typo in the ARRL handbook incorrectly shows it encoded as --..--
    "---.." => '8',
    // ---.-
    "----." => '9',
    "-----" => '0',

    // Six elements (only mapped)
    // "....--" => '<HM>', // prosign
    // "...-.-" => '<SK>', // prosign
    // "..-..-" => '<IX>', // prosign
    "..--.." => '?', // or '<IMI>'
    "..--.-" => '_', // or '<IQ>'
    ".-..-." => '"', // or '<AF>'
    ".-.-.-" => '.', // or '<AAA>'
    ".--.-." => '@', // becaome official after 1985 ARRL handbook was published
    ".----." => '\'', // or '<WG>'
    "-....-" => '-', // or '<DU>'
    "-.-.-." => ';', // or '<KR>'
    "-.--.-" => ')', // or '<KK>'
    "--..--" => ',', // or '<MIM>'
    "---..." => ':', // or '<OS>'

    // Seven elements (only mapped)
    "...-..-" => '$', // or '<SX>'
    ".-----." => '`',
}

to_script! {
    /// Mapping from Morse code to Greek text
    TO_GREEK,
    to_greek,
    // Greek Morse code
    // Wikipedia: The Greek Morse code alphabet is very similar to the
    //            Latin alphabet. It uses one extra letter for Greek
    //            letter Χ and no longer uses the codes for Latin
    //            letters "J ", "U" and "V".
    // https://en.wikipedia.org/wiki/Morse_code_for_non-Latin_alphabets#Greek
    ".-" => 'Α',
    "-..." => 'Β',
    "--." => 'Γ',
    "-.." => 'Δ',
    "." => 'Ε',
    "--.." => 'Ζ',
    "...." => 'Η',
    "-.-." => 'Θ',
    ".." => 'Ι',
    "-.-" => 'Κ',
    ".-.." => 'Λ',
    "--" => 'Μ',
    "-." => 'Ν',
    "-..-" => 'Ξ',
    "---" => 'Ο',
    ".--." => 'Π',
    ".-." => 'Ρ',
    "..." => 'Σ',
    "-" => 'Τ',
    "-.--" => 'Υ',
    "..-." => 'Φ',
    "----" => 'Χ',
    "--.-" => 'Ψ',
}

to_script! {
    /// Mapping from Morse code to Russian (Cyrillic) text
    TO_RUSSIAN,
    to_russian,
    // Russian Morse code for Cyrillic
    // https://en.wikipedia.org/wiki/Russian_Morse_code (1857)
    // Полное собрание законов Российской Империи. Собрание Второе
    // These are listed in the order of the Wikipedia page (alphabetical
    // order of the corresponding latin script character)
    ".-" => 'А',   // a
    "-..." => 'Б', // be
    ".--" => 'В',  // ve
    "--." => 'Г',  // ghe
    "-.." => 'Д',  // de
    "." => 'Е',    // ie
    "...-" => 'Ж', // zhe
    "--.." => 'З', // ze
    ".." => 'И',   // i
    ".---" => 'Й', // short i
    "-.-" => 'К',  // ka
    ".-.." => 'Л', // el
    "--" => 'М',   // em
    "-." => 'Н',   // en
    "---" => 'О',  // o
    ".--." => 'П', // pe
    ".-." => 'Р',  // er
    "..." => 'С',  // es
    "-" => 'Т',
    "..-" => 'У',   // u
    "..-." => 'Ф',  // ef
    "...." => 'Х',  // ha
    "-.-." => 'Ц',  // tse
    "---." => 'Ч',  // che
    "----" => 'Ш',  // sha
    "--.-" => 'Щ',  // shcha
    "-..-" => 'Ъ',  // hard sign
    "-.--" => 'Ы',  // yeru
    "..-.." => 'Ѣ', // yat  in Wikipedia article and in Russian law document
    "..--" => 'Ю',  // yu
    ".-.-" => 'Я',  // ya
}

to_script! {
    /// Mapping from Morse code to Japanese (Katakana) text
    TO_JAPANESE,
    to_japanese,
    // Wabun code for Japanese, tnx JE1TRV
    // https://en.wikipedia.org/wiki/Wabun_code
    // https://www.rfcafe.com/references/qst/japanese-morse-telegraph-code-sep-1942-qst.htm (1942)
    // https://web.archive.org/web/20220129114408/https://elaws.e-gov.go.jp/data/325M50080000017_20200622_502M60000008061/pict/S25F30901000017-001.pdf (1945?)
    // 1. Kanas without any diacritics (dakuten or handakuten)
    ".-" => '',    // i
    ".-.-" => '',  // ro
    "-..." => '',  // ha
    "-.-." => '',  // ni
    "-.." => '',   // ho
    "." => '',     // he
    "..-.." => '', // to
    "..-." => '',  // ti
    "--." => '',   // ri
    "...." => '',  // nu
    "-.--." => '', // ru
    ".---" => '',  // wo
    "-.-" => '',   // wa
    ".-.." => '',  // ka
    "--" => '',    // yo
    "-." => '',    // ta
    "---" => '',   // re
    "---." => '',  // so
    ".--." => '',  // tu
    "--.-" => '',  // ne
    ".-." => '',   // na
    "..." => '',   // ra
    "-" => '',     // mu
    "..-" => '',   // u
    ".-..-" => '', // yi
    "..--" => '',  // no
    ".-..." => '', // o
    "...-" => '',  // ku
    ".--" => '',   // ya
    "-..-" => '',  // ma
    "-.--" => '',  // ke
    "--.." => '',  // fu
    "----" => '',  // ko
    "-.---" => '', // e
    ".-.--" => '', // te
    "--.--" => '', // a
    "-.-.-" => '', // sa
    "-.-.." => '', // ki
    "-..--" => '', // yu
    "-...-" => '', // me
    "..-.-" => '', // mi
    "--.-." => '', // si
    ".--.." => '', // ye
    "--..-" => '', // hi
    "-..-." => '', // mo
    ".---." => '', // se
    "---.-" => '', // su
    ".-.-." => '', // n
    ".." => '',          // dakuten modifier
    "..--." => '',       // handakuten modifier
    ".--.-" => '',       // mapped to -
    "-.--.-" => '',      // mapped to (
    ".-..-." => '',      // mapped to )
    ".-.-.-" => '',      // mapped to .
    ".-.-.." => '',      // mapped to .
}

to_script! {
    /// Mapping from Morse code to Korean (Hangul) text
    TO_KOREAN,
    to_korean,
    // SKATS for Korean
    // The ARRL handbook for the radio amateur, 19-3 (1985)
    // https://archive.org/details/arrlhandbookforr0000unse_w7j4/page/n415/mode/2up
    ".-.." => '',    // kiyeok
    "..-." => '',    // nieun
    "-..." => '',    // tikeut
    "...-" => '',    // rieul
    "--" => '',      // mieum
    ".--" => '',     // pieup
    "--." => '',     // sios
    "-.-" => '',     // ieung
    ".--." => '',    // cieuc
    "-.-." => '',    // chieuch
    "-..-" => '',    // khieukh
    "--.." => '',    // thieuth
    "---" => '',     // phieuph
    ".---" => '',    // hieuh
    "." => '',       // a
    "--.-" => '',    // ae
    ".." => '',      // ya
    //".. ..-" => 'ㅒ',  // yae
    "-" => '',       // eo
    "-.--" => '',    // e
    "..." => '',     // yeo
    //"... ..-" => 'ㅖ', // ye
    ".-" => '',      // o
    "-." => '',      // yo
    "...." => '',    // u
    ".-." => '',     // yu
    "-.." => '',     // eu
    "..-" => '',     // i
}

to_script! {
    /// Mapping from Morse code to Hebrew text
    TO_HEBREW,
    to_hebrew,
    // Hebrew
    // The ARRL handbook for the radio amateur, 19-3 (1985)
    // https://archive.org/details/arrlhandbookforr0000unse_w7j4/page/n415/mode/2up
    ".-" => 'א',   // alef
    "-..." => 'ב', // bet
    "--." => 'ג',  // gimel
    "-.." => 'ד',  // dalet
    "---" => 'ה',  // he
    "." => 'ו',    // vav
    "--.." => 'ז', // zayin
    "...." => 'ח', // chet
    "..-" => 'ט',  // tet
    ".." => 'י',   // yod
    "-.-" => 'כ',  // kaf
    ".-.." => 'ל', // lamed
    "--" => 'מ',   // mem
    "-." => 'נ',   // nun
    "-.-." => 'ס', // samekh
    ".---" => 'ע', // ayin
    ".--." => 'פ', // pe
    ".--" => 'צ',  // tsadi
    "--.-" => 'ק', // qof
    ".-." => 'ר',  // resh
    "..." => 'ש',  // dotless shin
    "-" => 'ת',    // dotless tav
}

to_script! {
    /// Mapping from Morse code to Arabic text
    TO_ARABIC,
    to_arabic,
    // Arabic
    // The ARRL handbook for the radio amateur, 19-3 (1985)
    // https://archive.org/details/arrlhandbookforr0000unse_w7j4/page/n415/mode/2up
    // Unicode points were copied from “Isolated form”, and names from “Letter name” in
    // https://en.wikipedia.org/wiki/Arabic_alphabet#Table_of_basic_letters
    // TODO: add contextual forms
    ".-" => 'ا',    // ʾalif
    "-..." => 'ب',  // bāʾ/bah
    "-" => 'ت',     // tāʾ/tah
    "-.-." => 'ث',  // thāʾ/thah
    ".---" => 'ج',  // jīm
    "...." => 'ح',  // ḥāʾ/ḥah
    "---" => 'خ',   // khāʾ/khah
    "-.." => 'د',   // dāl/dāʾ/dah
    "--.." => 'ذ',  // dhāl/dhāʾ/dhah
    ".-." => 'ر',   // rāʾ/rah
    "---." => 'ز',  // zāy/zayn/zāʾ/zah
    "..." => 'س',   // sīn
    "----" => 'ش',  // shīn
    "-..-" => 'ص',  // ṣād
    "...-" => 'ض',  // ḍād/ḍāʾ/ḍah
    "..-" => 'ط',   // ṭāʾ/ṭah
    "-.--" => 'ظ',  // ẓāʾ/ẓah
    ".-.-" => 'ع',  // ʿayn
    "--." => 'غ',   // ghayn
    "..-." => 'ف',  // fāʾ/fah
    "--.-" => 'ق',  // qāf
    "-.-" => 'ڪ',   // kāf/kāʾ/kah
    ".-.." => 'ل',  // lām
    "--" => 'م',    // mīm
    "-." => 'ن',    // nūn
    "..-.." => 'ه', // hāʾ/hah
    ".--" => 'و',   // wāw
    ".." => 'ے',    // yāʾ/yah
    //".-...-" => 'لا', // lām-alif (ligature)
    // other characters without a reference
    "." => 'ء', // hamzah
}