dotrain 6.0.1-alpha.24

.rain to rainlang composer
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
412
413
414
415
416
417
418
419
420
421
422
423
424
425
//! All Regular Expression patterns used for parsing texts

use regex::Regex;
use once_cell::sync::Lazy;

/// pragma keyword in rainlang
pub const PRAGMA_KEYWORD: &str = "using-words-from";

/// reserved keywords in rainlang
pub const KEYWORDS: [&str; 1] = [PRAGMA_KEYWORD];

/// front matter separator
pub const FRONTMATTER_SEPARATOR: &str = "---";

/// Illegal character pattern
pub static ILLEGAL_CHAR: Lazy<Regex> = Lazy::new(|| Regex::new(r"[^ -~\s]+").unwrap());

/// word pattern
pub static WORD_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(r"^[a-z][0-9a-z-]*$").unwrap());

/// Import hash pattern
pub static HASH_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(r"^0x[0-9a-fA-F]{64}$").unwrap());

/// numeric pattern
pub static NUMERIC_PATTERN: Lazy<Regex> = Lazy::new(|| {
    Regex::new(
        (HEX_PATTERN.as_str().to_string() + "|" + INT_PATTERN.as_str() + "|" + E_PATTERN.as_str())
            .as_str(),
    )
    .unwrap()
});

/// string literal pattern
pub static STRING_LITERAL_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r#"^\"[\s\S]*?\"$"#).unwrap());

/// sub parser literal pattern
pub static SUB_PARSER_LITERAL_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r#"^\[[\s\S]*?\]$"#).unwrap());

/// literal pattern (numeric + string literal + sub parser)
pub static LITERAL_PATTERN: Lazy<Regex> = Lazy::new(|| {
    Regex::new(
        (NUMERIC_PATTERN.as_str().to_string()
            + "|"
            + STRING_LITERAL_PATTERN.as_str()
            + "|"
            + SUB_PARSER_LITERAL_PATTERN.as_str())
        .as_str(),
    )
    .unwrap()
});

/// Hex pattern
pub static HEX_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(r"^0x[0-9a-fA-F]+$").unwrap());

/// e numberic pattern
pub static E_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r"^[1-9][0-9]*(\.[0-9]+)?e-?[0-9]+$").unwrap());

/// Integer pattern
pub static INT_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(r"^[0-9]+(\.[0-9]+)?$").unwrap());

/// RainDocument Namespace pattern
pub static NAMESPACE_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r"^(\.?[a-z][0-9a-z-]*)*\.?$").unwrap());

/// Comment pattern
pub static COMMENT_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r"\/\*[\s\S]*?(?:\*\/|$)").unwrap());

/// whitespace pattern
pub static WS_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(r"\s+").unwrap());

/// binding dependency pattern
pub static DEP_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r"'\.?[a-z][0-9a-z-]*(\.[a-z][0-9a-z-]*)*").unwrap());

/// import pattern
pub static IMPORTS_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new("@").unwrap());

/// binding pattern
pub static BINDING_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new("#").unwrap());

/// non-empty text pattern
pub static NON_EMPTY_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(r"[^\s]").unwrap());

/// operand arguments pattern (literal + namespace + quoted namespace)
pub static OPERAND_ARG_PATTERN: Lazy<Regex> = Lazy::new(|| {
    Regex::new(
        (HEX_PATTERN.as_str().to_string()
            + "|"
            + INT_PATTERN.as_str()
            + "|"
            + E_PATTERN.as_str()
            + "|"
            + STRING_LITERAL_PATTERN.as_str()
            + "|"
            + SUB_PARSER_LITERAL_PATTERN.as_str()
            + "|"
            + r#"^'?\.?[a-z][0-9a-z-]*(\.[a-z][0-9a-z-]*)*$"#)
            .as_str(),
    )
    .unwrap()
});

/// quote pattern
pub static QUOTE_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r"^'\.?[a-z][0-9a-z-]*(\.[a-z][0-9a-z-]*)*$").unwrap());

/// namespace segments delimitier pattern
pub static NAMESPACE_SEGMENT_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(r"\.").unwrap());

/// rainlang source delimiter pattern
pub static SOURCE_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(";").unwrap());

/// rainlang line delimiter pattern
pub static SUB_SOURCE_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(",").unwrap());

/// any not whitespace pattern
pub static ANY_PATTERN: Lazy<Regex> = Lazy::new(|| Regex::new(r"\S+").unwrap());

/// word pattern
pub static LHS_WORD_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r"^_?[a-z][0-9a-z-]*$").unwrap());

/// rainlang lhs pattern
pub static LHS_PATTERN: Lazy<Regex> = Lazy::new(|| {
    Regex::new((LHS_WORD_PATTERN.as_str().to_string() + "|" + "^_$").as_str()).unwrap()
});

/// pragma pattern (keyword + ws + hex)
pub static PRAGMA_PATTERN: Lazy<Regex> =
    Lazy::new(|| Regex::new(r"(:?(^|\s))using-words-from(:?($|\s))").unwrap());

/// the default elided binding msg
pub static DEFAULT_ELISION: &str = "elided binding, requires rebinding";

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_patterns() {
        // valids
        for i in [
            "a", "aa", "aA", "aAa", "a0", "aa0", "aA0", "aA0a", "aA0a0", "", "a-", "a-a", "-", " ",
            "a ", "0", "_", "0a", "0A", "`", "```", "\n", "\t", "\r", ":",
        ] {
            assert!(
                !ILLEGAL_CHAR.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }
        // invalids
        for i in ["♥", "∴"] {
            assert!(ILLEGAL_CHAR.is_match(i), "String '{}' considered valid.", i);
        }

        // invalids
        for i in [
            "-abcd",
            "-abcd-efg",
            "1abcd-efg",
            "1234",
            "AkjhJ-Qer",
            "_abcd-efg",
        ] {
            assert!(
                !WORD_PATTERN.is_match(i),
                "String '{}' considered valid.",
                i
            );
        }
        // valids
        for i in ["abcd", "abcd-efg", "abcd12-efg8", "a678", "a1876-"] {
            assert!(
                WORD_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in [
            "0x1234abcd",
            "x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
            "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdefa",
            "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdeg",
        ] {
            assert!(
                !HASH_PATTERN.is_match(i),
                "String '{}' considered valid.",
                i
            );
        }
        // valids
        for i in [
            "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
            "0x0000000000000000000000000000000000000000000000000000000000000000",
        ] {
            assert!(
                HASH_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in ["x123abcd", "123", "0b101", "4e15"] {
            assert!(!HEX_PATTERN.is_match(i), "String '{}' considered valid.", i);
        }
        // valids
        for i in ["0x123abcd", "0x1234567890abcdef", "0x123AbcDeF"] {
            assert!(
                HEX_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in ["0x123abcdef", "0b10101", "4e15"] {
            assert!(!INT_PATTERN.is_match(i), "String '{}' considered valid.", i);
        }
        // valids
        for i in ["123", "1234567890", "83276401", "123.123"] {
            assert!(
                INT_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in ["1235657", "0x1234abcdf", "0b101110", "e18"] {
            assert!(!E_PATTERN.is_match(i), "String '{}' considered valid.", i);
        }
        // valids
        for i in [
            "3e16",
            "2345e12987234",
            "101e1001",
            "123.45e12",
            "123.45e-12",
        ] {
            assert!(E_PATTERN.is_match(i), "String '{}' considered invalid.", i);
        }

        // invalids
        for i in [
            "_abcd-efg.hij10-",
            ".1abcd-jh.",
            "abcd_er",
            "123abcd.ert-ety",
            "qSE.asd98.E87-weR",
        ] {
            assert!(
                !NAMESPACE_PATTERN.is_match(i),
                "String '{}' considered valid.",
                i
            );
        }
        // valids
        for i in [
            "abcd-efg",
            "abcd-efg.qwe2-wer-.kjh8.poi345.oiu",
            "a-12-asd.lkj8",
        ] {
            assert!(
                NAMESPACE_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in [
            "/ sjdkhfsfsdf /",
            "// asjkhdf",
            "/// kjhfdgd ",
            "\\* jkhjgk */",
        ] {
            assert!(
                !COMMENT_PATTERN.is_match(i),
                "String '{}' considered valid.",
                i
            );
        }
        // valids
        for i in [
            "/* jhggf jhgj jkgkkytees54368 867 */",
            "/** kjhgkj */",
            "//** hjgjh 453sdratf jkghj */ khkj hjfghf",
        ] {
            assert!(
                COMMENT_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in ["k", "765", "/*&^", "-)("] {
            assert!(!WS_PATTERN.is_match(i), "String '{}' considered valid.", i);
        }
        // valids
        for i in [" ", "\n", "\t", "\r", " \n \t"] {
            assert!(WS_PATTERN.is_match(i), "String '{}' considered invalid.", i);
        }

        // valids
        for i in ["abcd.iuy1-hg", "123jhg-jkkj", "'Ajh", "qwS.oiE34-qwe.qw"] {
            assert!(!DEP_PATTERN.is_match(i), "String '{}' considered valid.", i);
        }
        // valids
        for i in ["'abcd123", "'a123.kjh-iuy.oiu12-oiu2-.mnm"] {
            assert!(
                DEP_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in ["._sad-kjh", "Abd", "123abcd", "'Abcd.iuy1-oiu"] {
            assert!(
                !OPERAND_ARG_PATTERN.is_match(i),
                "String '{}' considered valid.",
                i
            );
        }
        // valids
        for i in [
            "123456789",
            "0x123abcdefAdfe",
            "'abcd12-jh2.oiu.lkj89-",
            "'.asd12-wer.jh45-iu78.lk9",
            "123.123",
            "123.12e2",
        ] {
            assert!(
                OPERAND_ARG_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in ["-", "AbkE12", "12kjh", "-abcd-iuy", "sad12.jh5"] {
            assert!(!LHS_PATTERN.is_match(i), "String '{}' considered valid.", i);
        }
        // valids
        for i in ["abced67", "_", "as12-iuy-", "a12-456-678-", "_some-word"] {
            assert!(
                LHS_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in [r#"'ksdf iydsf'"#, r#"`ksdf iydsf`"#, r#"'ksdf iydsf""#] {
            assert!(
                !STRING_LITERAL_PATTERN.is_match(i),
                "String '{}' considered valid.",
                i
            );
        }
        // valids
        for i in [r#""ksdf iydsf""#, r#""ksdf #$%&$% ()( {} __!@ ksjdhf 487""#] {
            assert!(
                STRING_LITERAL_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in ["{123 jhgsdf}", "jkshdfksd kjshdfi ]", "(khku dtdyt 654)"] {
            assert!(
                !SUB_PARSER_LITERAL_PATTERN.is_match(i),
                "String '{}' considered valid.",
                i
            );
        }
        // valids
        for i in [
            "[asd wer 123 34 fgh ]",
            "[sdfjkh iuysf idsf 1231- -]",
            "[kjsdf 89435 #$^&$ )_)_}{}]",
        ] {
            assert!(
                SUB_PARSER_LITERAL_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }

        // invalids
        for i in [
            "using-words-from123",
            "using-word-from 0x123",
            "using-words-from-g",
        ] {
            assert!(
                !PRAGMA_PATTERN.is_match(i),
                "String '{}' considered valid.",
                i
            );
        }
        // valids
        for i in [
            "using-words-from \n\t 0x123abcedf",
            " using-words-from \n\n 0x09835356abcdef84765932342efabcd72305471 ",
        ] {
            assert!(
                PRAGMA_PATTERN.is_match(i),
                "String '{}' considered invalid.",
                i
            );
        }
    }
}