test_parse.py 49.6 KB
Newer Older
1
#!/usr/bin/env python3
2

3
"""test_parse.py - tests of the parsers-module of DHParser
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

Author: Eckhart Arnold <arnold@badw.de>

Copyright 2017 Bavarian Academy of Sciences and Humanities

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""

eckhart's avatar
eckhart committed
22
import copy
23
import os
24
import sys
25
from functools import partial
26
from typing import List
27

28
29
scriptpath = os.path.dirname(__file__) or '.'
sys.path.append(os.path.abspath(os.path.join(scriptpath, '..')))
30

eckhart's avatar
eckhart committed
31
from DHParser.configuration import get_config_value, set_config_value
32
from DHParser.toolkit import compile_python_object, re
33
from DHParser.log import is_logging, log_ST, log_parsing_history
34
35
from DHParser.error import Error, is_error, adjust_error_locations, MANDATORY_CONTINUATION, PARSER_DID_NOT_MATCH, \
    MALFORMED_ERROR_STRING, MANDATORY_CONTINUATION_AT_EOF, RESUME_NOTICE, PARSER_STOPPED_BEFORE_END
36
from DHParser.parse import ParserError, Parser, Grammar, Forward, TKN, ZeroOrMore, RE, \
eckhart's avatar
eckhart committed
37
    RegExp, Lookbehind, NegativeLookahead, OneOrMore, Series, Alternative, \
38
39
    Interleave, UnknownParserError, MetaParser, Token, EMPTY_NODE, Capture, Drop, Whitespace, \
    GrammarError
40
from DHParser import compile_source
41
from DHParser.ebnf import get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
eckhart's avatar
eckhart committed
42
    parse_ebnf, DHPARSER_IMPORTS
43
from DHParser.dsl import grammar_provider
44
from DHParser.syntaxtree import Node, parse_sxpr
45
from DHParser.stringview import StringView
46
from DHParser.trace import set_tracer, trace_history, resume_notices_on
47
48


49
50
51
52
53
54

class TestWhitespace:
    # TODO: add test cases here
    def test_whitespace_comment_mangling(self):
        pass

Eckhart Arnold's avatar
Eckhart Arnold committed
55
    def test_non_empty_derivation(self):
56
57
        pass

58

59
60
class TestParserError:
    def test_parser_error_str(self):
61
        pe = ParserError(Node('TAG', 'test').with_pos(0), StringView('Beispiel'), None, True)
62
63
        assert str(pe).find('Beispiel') >= 0 and str(pe).find('TAG') >= 0

64
    def test_false_lookahead_only_message(self):
65
        """PARSER_LOOKAHEAD_*_ONLY errors must not be reported if there
66
67
68
69
70
71
        no lookahead parser in the history!"""
        lang = """
        word = letters { letters | `-` letters }
        letters = /[A-Za-z]+/
        """
        gr = grammar_provider(lang)()
72
73
        set_tracer(gr, trace_history)
        st = gr('hard-time')
74
        assert not st.errors
75
        st = gr('hard-')
76
77
        assert st.errors and not any(e.code == 1045 for e in st.errors)

eckhart's avatar
eckhart committed
78

eckhart's avatar
eckhart committed
79
80
81
82
83
84
85
86
87
class TestParserClass:
    def test_apply(self):
        minilang ="""
            expr = expr ("+"|"-") term | term
            term = term ("*"|"/") factor | factor
            factor = /[0-9]+/~
            """
        gr = grammar_provider(minilang)()
        l = []
88
89
        def visitor(context: List[Parser]):
            p = context[-1]
di68kap's avatar
di68kap committed
90
            l.append(p.pname + p.ptype)
eckhart's avatar
eckhart committed
91
92
93
94
95
96
97
98
99
100
        gr.root__.apply(visitor)
        s1 = ", ".join(l)
        l = []
        gr.root__.apply(visitor)
        s2 = ", ".join(l)
        l = []
        gr.root__.apply(visitor)
        s3 = ", ".join(l)
        assert s1 == s2 == s3

101
102
103
104
105
106
107
108
    def test_symbol(self):
        class MyGrammar(Grammar):
            wrong = Token('wrong')
            word = OneOrMore(wrong) + Whitespace(r'\s*') + OneOrMore(RegExp(r'\w+'))
            root__ = word
        gr = MyGrammar()
        regex = gr['word'].parsers[-1].parser
        result = gr.associated_symbol(regex).symbol
109
        assert result == 'word', result
110

eckhart's avatar
eckhart committed
111

112
class TestInfiLoopsAndRecursion:
113
    def test_direct_left_recursion1(self):
eckhart's avatar
eckhart committed
114
        minilang = """
115
116
117
118
            expr = expr ("+"|"-") term | term
            term = term ("*"|"/") factor | factor
            factor = /[0-9]+/~
            """
119
        snippet = "9 + 8 + 7 + 6 + 5 + 3 * 4"
120
        parser = grammar_provider(minilang)()
121
        assert parser
Eckhart Arnold's avatar
Eckhart Arnold committed
122
        syntax_tree = parser(snippet)
123
124
        assert not is_error(syntax_tree.error_flag), str(syntax_tree.errors_sorted)
        assert snippet == syntax_tree.content, str(syntax_tree)
Eckhart Arnold's avatar
Eckhart Arnold committed
125
        if is_logging():
126
            log_ST(syntax_tree, "test_LeftRecursion_direct.cst")
127
            log_parsing_history(parser, "test_LeftRecursion_direct")
128

129
    def test_direct_left_recursion2(self):
130
131
132
133
134
135
        minilang = """
            expr = ex
            ex   = expr ("+"|"-") term | term
            term = term ("*"|"/") factor | factor
            factor = /[0-9]+/~
            """
136
        snippet = "9 + 8 + 7 + 6 + 5 + 3 * 4"
137
        parser = grammar_provider(minilang)()
138
        assert parser
139
        syntax_tree = parser(snippet)
140
141
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
        assert snippet == syntax_tree.content
142

143
    def test_indirect_left_recursion1(self):
144
145
        minilang = """
            Expr    = //~ (Product | Sum | Value)
146
147
            Product = Expr { ('*' | '/') Expr }+
            Sum     = Expr { ('+' | '-') Expr }+
148
            Value   = /[0-9.]+/~ | '(' §Expr ')'
149
            """
150
        parser = grammar_provider(minilang)()
151
        assert parser
152
        snippet = "8 * 4"
153
        syntax_tree = parser(snippet)
154
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
155
156
        snippet = "7 + 8 * 4"
        syntax_tree = parser(snippet)
157
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
158
159
        snippet = "9 + 8 * (4 + 3)"
        syntax_tree = parser(snippet)
160
161
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
        assert snippet == syntax_tree.content
162
        if is_logging():
163
            log_ST(syntax_tree, "test_LeftRecursion_indirect.cst")
164
            log_parsing_history(parser, "test_LeftRecursion_indirect")
165

166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
    # # BEWARE: EXPERIMENTAL TEST can be long running
    # def test_indirect_left_recursion2(self):
    #     arithmetic_syntax = """
    #         expression     = addition | subtraction
    #         addition       = (expression | term) "+" (expression | term)
    #         subtraction    = (expression | term) "-" (expression | term)
    #         term           = multiplication | division
    #         multiplication = (term | factor) "*" (term | factor)
    #         division       = (term | factor) "/" (term | factor)
    #         factor         = [SIGN] ( NUMBER | VARIABLE | group ) { VARIABLE | group }
    #         group          = "(" expression ")"
    #         SIGN           = /[+-]/
    #         NUMBER         = /(?:0|(?:[1-9]\d*))(?:\.\d+)?/~
    #         VARIABLE       = /[A-Za-z]/~
    #         """
    #     arithmetic = grammar_provider(arithmetic_syntax)()
    #     arithmetic.left_recursion_depth__ = 2
    #     assert arithmetic
    #     syntax_tree = arithmetic("(a + b) * (a - b)")
    #     assert syntax_tree.errors
186

187
188
189
    def test_break_inifnite_loop_ZeroOrMore(self):
        forever = ZeroOrMore(RegExp(''))
        result = Grammar(forever)('')  # infinite loops will automatically be broken
190
        assert repr(result) == "Node(':EMPTY', '')", repr(result)
191
192
193
194

    def test_break_inifnite_loop_OneOrMore(self):
        forever = OneOrMore(RegExp(''))
        result = Grammar(forever)('')  # infinite loops will automatically be broken
195
        assert repr(result) == "Node(':EMPTY', '')", repr(result)
196

197
198
199
200
201
    # def test_infinite_loops(self):
    #     minilang = """forever = { // } \n"""
    #     try:
    #         parser_class = grammar_provider(minilang)
    #     except CompilationError as error:
202
    #         assert all(e.code == INFINITE_LOOP for e in error.errors)
203
204
205
206
207
208
    #     save = get_config_value('static_analysis')
    #     set_config_value('static_analysis', 'late')
    #     provider = grammar_provider(minilang)
    #     try:
    #         parser = provider()
    #     except GrammarError as error:
209
    #         assert error.errors[0][2].code == INFINITE_LOOP
210
211
212
213
    #     set_config_value('static_analysis', 'none')
    #     parser = provider()
    #     snippet = " "
    #     syntax_tree = parser(snippet)
214
    #     assert any(e.code == INFINITE_LOOP for e in syntax_tree.errors)
215
    #     res = parser.static_analysis()
216
    #     assert res and res[0][2].code == INFINITE_LOOP
217
218
219
220
221
    #     minilang = """not_forever = { / / } \n"""
    #     parser = grammar_provider(minilang)()
    #     res = parser.static_analysis()
    #     assert not res
    #     set_config_value('static_analysis', save)
222

eckhart's avatar
eckhart committed
223

Eckhart Arnold's avatar
Eckhart Arnold committed
224
class TestFlowControl:
225
226
227
228
229
230
    t1 = """
         All work and no play
         makes Jack a dull boy
         END
         """
    t2 = "All word and not play makes Jack a dull boy END\n"
231

Eckhart Arnold's avatar
Eckhart Arnold committed
232
    def test_lookbehind(self):
233
        ws = RegExp(r'\s*')
Eckhart Arnold's avatar
Eckhart Arnold committed
234
        end = RegExp("END")
235
        doc_end = Lookbehind(RegExp('\\s*?\\n')) + end
236
        word = RegExp(r'\w+')
Eckhart Arnold's avatar
Eckhart Arnold committed
237
238
239
240
        sequence = OneOrMore(NegativeLookahead(end) + word + ws)
        document = ws + sequence + doc_end + ws

        parser = Grammar(document)
241
242
243
244
245
246
247
        cst = parser(self.t1)
        assert not cst.error_flag, cst.as_sxpr()
        cst = parser(self.t2)
        assert cst.error_flag, cst.as_sxpr()

    def test_lookbehind_indirect(self):
        class LookbehindTestGrammar(Grammar):
eckhart's avatar
eckhart committed
248
            parser_initialization__ = ["upon instantiation"]
249
            ws = RegExp(r'\s*')
250
            end = RegExp('END')
251
            SUCC_LB = RegExp('\\s*?\\n')
252
            doc_end = Series(Lookbehind(SUCC_LB), end)
253
            word = RegExp(r'\w+')
254
255
256
257
258
259
            sequence = OneOrMore(Series(NegativeLookahead(end), word, ws))
            document = Series(ws, sequence, doc_end, ws)
            root__ = document

        parser = LookbehindTestGrammar()
        cst = parser(self.t1)
Eckhart Arnold's avatar
Eckhart Arnold committed
260
        assert not cst.error_flag, cst.as_sxpr()
261
        cst = parser(self.t2)
Eckhart Arnold's avatar
Eckhart Arnold committed
262
263
264
        assert cst.error_flag, cst.as_sxpr()


265
266
267
268
269
270
271
class TestRegex:
    def test_multilineRegex(self):
        mlregex = r"""
        regex =  /\w+    # one or more alphabetical characters including the underscore
                  [+]    # followed by a plus sign
                  \w*    # possibly followed by more alpha chracters/
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
272
        result, messages, _ = compile_source(mlregex, None, get_ebnf_grammar(),
Eckhart Arnold's avatar
Eckhart Arnold committed
273
                        get_ebnf_transformer(), get_ebnf_compiler('MultilineRegexTest'))
274
        assert result
275
        assert not messages, str(messages)
276
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
eckhart's avatar
eckhart committed
277
278
        node = parser('abc+def', parser.regex)
        assert not node.error_flag
279
        assert node.tag_name == "regex"
280
281
        assert str(node) == 'abc+def'

282
283
    def test_multilineRegex_wo_Comments(self):
        mlregex = r"""
eckhart's avatar
eckhart committed
284
285
        regex =  /\w+
                  [+]
286
287
                  \w* /
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
288
        result, messages, _ = compile_source(mlregex, None, get_ebnf_grammar(),
289
290
291
                        get_ebnf_transformer(), get_ebnf_compiler('MultilineRegexTest'))
        assert result
        assert not messages, str(messages)
292
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
293
294
        node = parser('abc+def', parser.regex)
        assert not node.error_flag
295
        assert node.tag_name == "regex"
296
297
        assert str(node) == 'abc+def'

298
    def test_ignore_case(self):
299
300
301
302
        mlregex = r"""
        @ ignorecase = True
        regex = /alpha/
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
303
        result, messages, _ = compile_source(mlregex, None, get_ebnf_grammar(),
304
305
306
                        get_ebnf_transformer(), get_ebnf_compiler('MultilineRegexTest'))
        assert result
        assert not messages
307
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
308
        node, rest = parser.regex(StringView('Alpha'))
309
310
        assert node
        assert rest == ''
311
        assert node.tag_name == "regex"
312
313
314
315
316
317
        assert str(node) == 'Alpha'

        mlregex = r"""
        @ ignorecase = False
        regex = /alpha/
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
318
        result, messages, _ = compile_source(mlregex, None, get_ebnf_grammar(),
319
320
321
                        get_ebnf_transformer(), get_ebnf_compiler('MultilineRegexTest'))
        assert result
        assert not messages
322
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
323
324
        node, rest = parser.regex(StringView('Alpha'))
        assert node is None
325

326
327
328
329
330
331
332
333
334
335
336
337
    def test_token(self):
        tokenlang = r"""
            @whitespace = linefeed
            lang        = "" begin_token {/\w+/ ""} end_token
            begin_token = "\begin{document}"
            end_token   = "\end{document}"
            """
        testdoc = r"""
            \begin{document}
            test
            \end{document}
            """
Eckhart Arnold's avatar
Eckhart Arnold committed
338
        result, messages, _ = compile_source(
eckhart's avatar
eckhart committed
339
340
            tokenlang, None, get_ebnf_grammar(), get_ebnf_transformer(),
            get_ebnf_compiler("TokenTest"))
341
        assert result
eckhart's avatar
eckhart committed
342
        assert not messages, str(messages)
343
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
Eckhart Arnold's avatar
Eckhart Arnold committed
344
        result = parser(testdoc)
345
        # log_parsing_history(parser, "test.log")
346
        assert not result.error_flag, str(result.errors_sorted)
347

348

349
class TestGrammar:
350
351
352
353
354
355
356
357
358
359
    grammar = r"""@whitespace = horizontal
    haupt        = textzeile LEERZEILE
    textzeile    = { WORT }+
    WORT         = /[^ \t]+/~
    LEERZEILE    = /\n[ \t]*(?=\n)/~
    """
    pyparser, messages, _ = compile_source(grammar, None, get_ebnf_grammar(),
                                           get_ebnf_transformer(), get_ebnf_compiler("PosTest"))
    assert pyparser
    assert not messages
360
361
362
363

    def test_pos_values_initialized(self):
        # checks whether pos values in the parsing result and in the
        # history record have been initialized
364
365
        grammar = compile_python_object(DHPARSER_IMPORTS + self.pyparser, r'\w+Grammar$')()
        grammar("no_file_name*")
366
        for record in grammar.history__:
367
368
            assert not record.node or record.node.pos >= 0

369
    def test_select_parsing(self):
370
        grammar = compile_python_object(DHPARSER_IMPORTS + self.pyparser, r'\w+Grammar$')()
371
372
373
374
        grammar("wort", "WORT")
        grammar("eine Zeile", "textzeile")
        grammar("kein Haupt", "haupt")
        grammar("so ist es richtig", "haupt")
375

di68kap's avatar
di68kap committed
376
377
    def test_grammar_subclassing(self):
        class Arithmetic(Grammar):
378
            r'''
di68kap's avatar
di68kap committed
379
380
381
382
383
384
            expression =  term  { ("+" | "-") term }
            term       =  factor  { ("*" | "/") factor }
            factor     =  INTEGER | "("  expression  ")"
            INTEGER    =  /\d+/~
            '''
            expression = Forward()
385
386
387
388
            INTEGER = RE('\\d+')
            factor = INTEGER | TKN("(") + expression + TKN(")")
            term = factor + ZeroOrMore((TKN("*") | TKN("/")) + factor)
            expression.set(term + ZeroOrMore((TKN("+") | TKN("-")) + term))
di68kap's avatar
di68kap committed
389
390
391
392
393
394
            root__ = expression

        grammar = Arithmetic()
        CST = grammar('3+4')
        assert not CST.error_flag, CST.as_sxpr()

395
396
397
398
399
400
401
    def test_incomplete_matching(self):
        """Tests whether the flag `complete_match` works as expected when
        calling a grammar object in order to parse a document."""
        gr = grammar_provider('word = ~/\\w+/\n')()
        st = gr('eins')
        assert not st.errors
        st = gr('eins zwei')
402
        assert st.errors[0].code == PARSER_STOPPED_BEFORE_END
403
404
405
        st = gr('eins zwei', complete_match=False)
        assert not st.errors

406
    def test_synonym(self):
di68kap's avatar
di68kap committed
407
        lang = r"""
408
409
410
411
412
413
414
415
416
417
418
419
            doc  = { word | number }
            word = /\w+/ S
            number = [VZ] /\d+/ S 
            S    = ~        # let S by a synonym for anonymous whitespace
            VZ   = "-"
        """
        gr = grammar_provider(lang)()
        st = gr('eins 1 zwei2drei 3')
        # set_config_value('compiled_EBNF_log', 'grammar.log')
        gr = grammar_provider("@drop = whitespace, token" + lang)()
        st = gr('eins 1 zwei2drei 3')
        st = gr('-3')
420
        assert str(gr['S']) == "S = ~", str(gr['S'])
421

422

423
424
425
426
427
428
429
class TestSeries:
    def test_non_mandatory(self):
        lang = """
        document = series | /.*/
        series = "A" "B" "C" "D"
        """
        parser = grammar_provider(lang)()
Eckhart Arnold's avatar
Eckhart Arnold committed
430
        st = parser("ABCD")
431
        assert not st.error_flag
Eckhart Arnold's avatar
Eckhart Arnold committed
432
        st = parser("A_CD")
433
        assert not st.error_flag
Eckhart Arnold's avatar
Eckhart Arnold committed
434
        st = parser("AB_D")
435
436
437
438
439
440
441
442
443
444
445
        assert not st.error_flag

    def test_mandatory(self):
        """Test for the §-operator. The Series-parser should raise an
        error for any non-match that occurs after the mandatory-operator.
        """
        lang = """
        document = series | /.*/
        series = "A" "B" §"C" "D"
        """
        parser = grammar_provider(lang)()
446
447
448
        st = parser("ABCD");  assert not st.error_flag
        st = parser("A_CD");  assert not st.error_flag
        st = parser("AB_D");  assert st.error_flag
449
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
450
        # transitivity of mandatory-operator
451
        st = parser("ABC_");  assert st.error_flag
452
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
453
454

    def test_series_composition(self):
455
        TA, TB, TC, TD, TE = (TKN(b) for b in "ABCDE")
456
457
458
459
460
        s1 = Series(TA, TB, TC, mandatory=2)
        s2 = Series(TD, TE)

        combined = Alternative(s1 + s2, RegExp('.*'))
        parser = Grammar(combined)
461
462
463
        st = parser("ABCDE");  assert not st.error_flag
        st = parser("A_CDE");  assert not st.error_flag
        st = parser("AB_DE");  assert st.error_flag
464
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
465
        st = parser("ABC_E");  assert st.error_flag
466
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
467
468
469

        combined = Alternative(s2 + s1, RegExp('.*'))
        parser = Grammar(combined)
470
471
472
473
474
475
        st = parser("DEABC");  assert not st.error_flag
        st = parser("_EABC");  assert not st.error_flag
        st = parser("D_ABC");  assert not st.error_flag
        st = parser("DE_BC");  assert not st.error_flag
        st = parser("DEA_C");  assert not st.error_flag
        st = parser("DEAB_");  assert st.error_flag
476
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
477

eckhart's avatar
eckhart committed
478
479
480
481
482
483
484
485
486
487
    # def test_boundary_cases(self):
    #     lang = """
    #     document = series | §!single | /.*/
    #     series = "A" "B" §"C" "D"
    #     single = "E"
    #     """
    #     parser_class = grammar_provider(lang)
    #     parser = parser_class()
    #     print(parser.python_src__)
    #     print(parser_class.python_src__)
eckhart's avatar
eckhart committed
488

489
490
    def test_ebnf_serialization(self):
        ebnf_grammar = get_ebnf_grammar()
eckhart's avatar
eckhart committed
491
        # TODO: Add test here
492
        ebnf = ebnf_grammar.as_ebnf()
493
        # print(ebnf)
494
495


496
497
498
class TestAllOfSomeOf:
    def test_allOf_order(self):
        """Test that parsers of an AllOf-List can match in arbitrary order."""
eckhart's avatar
eckhart committed
499
        prefixes = Interleave(TKN("A"), TKN("B"))
500
501
        assert Grammar(prefixes)('A B').content == 'A B'
        assert Grammar(prefixes)('B A').content == 'B A'
502
503
504
505

    def test_allOf_completeness(self):
        """Test that an error is raised if not  all parsers of an AllOf-List
        match."""
eckhart's avatar
eckhart committed
506
        prefixes = Interleave(TKN("A"), TKN("B"))
507
508
509
510
511
        assert Grammar(prefixes)('B').error_flag

    def test_allOf_redundance(self):
        """Test that one and the same parser may be listed several times
        and must be matched several times accordingly."""
eckhart's avatar
eckhart committed
512
        prefixes = Interleave(TKN("A"), TKN("B"), TKN("A"))
513
514
515
        assert Grammar(prefixes)('A A B').content == 'A A B'
        assert Grammar(prefixes)('A B A').content == 'A B A'
        assert Grammar(prefixes)('B A A').content == 'B A A'
516
517
518
519
        assert Grammar(prefixes)('A B B').error_flag

    def test_someOf_order(self):
        """Test that parsers of an AllOf-List can match in arbitrary order."""
eckhart's avatar
eckhart committed
520
        prefixes = Interleave(TKN("A"), TKN("B"))
521
522
        assert Grammar(prefixes)('A B').content == 'A B'
        assert Grammar(prefixes)('B A').content == 'B A'
eckhart's avatar
eckhart committed
523
524
525
        st = Grammar(prefixes)('B')
        assert st.error_flag
        prefixes = Interleave(TKN("B"), TKN("A"), repetitions=((0, 1), (0, 1)))
526
        assert Grammar(prefixes)('A B').content == 'A B'
eckhart's avatar
eckhart committed
527
528
529
        st = Grammar(prefixes)('B')
        assert not st.error_flag
        assert st.content == 'B'
530
531
532
533

    def test_someOf_redundance(self):
        """Test that one and the same parser may be listed several times
        and must be matched several times accordingly."""
eckhart's avatar
eckhart committed
534
        prefixes = Interleave(TKN("A"), TKN("B"), TKN("A"))
535
536
537
        assert Grammar(prefixes)('A A B').content == 'A A B'
        assert Grammar(prefixes)('A B A').content == 'A B A'
        assert Grammar(prefixes)('B A A').content == 'B A A'
538
539
540
        assert Grammar(prefixes)('A B B').error_flag


541
542
543
544
545
class TestInterleave:
    def test_interleave_most_simple(self):
        letterset = Interleave(Token("A"), Token("B"), Token("C"))
        gr = Grammar(letterset)
        st = gr('ABC')
546
        assert not st.errors, str(st.errors)
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
        assert st.content == "ABC"
        st = gr('BCA')
        assert not st.errors
        assert st.content == "BCA"
        st = gr('BCBA')
        assert st.errors
        st = gr('AB')
        assert st.errors

    def test_interleave(self):
        letterset = Interleave(Token("A"), Token("B"), Token("C"),
                               repetitions=[(1, 1000), (0, 1), (1, 1)])
        gr = Grammar(letterset)
        st = gr('AABC')
        assert not st.errors
562
563
564
565
566
567
568
569
570
571
        st = gr('BACAAA')
        assert not st.errors
        st = gr('ABCC')
        assert st.errors
        st = gr('AAACAAA')
        assert not st.errors
        st = gr('AAABAAA')
        assert st.errors


572
573
574
575
class TestErrorRecovery:
    def test_series_skip(self):
        lang = """
        document = series | /.*/
576
        @series_skip = /(?=[A-Z])/
577
578
579
580
581
        series = "A" "B" §"C" "D"
        """
        parser = grammar_provider(lang)()
        st = parser('AB_D')
        assert len(st.errors) == 1  # no additional "stopped before end"-error!
582
        resume_notices_on(parser)
583
        st = parser('AB_D')
584
        assert len(st.errors) == 2 and any(err.code == RESUME_NOTICE for err in st.errors)
eckhart's avatar
eckhart committed
585
        assert 'Skipping' in str(st.errors_sorted[1])
586

587
    def test_Interleave_skip(self):
588
589
590
        lang = """
        document = allof | /.*/
        @allof_skip = /[A-Z]/
591
        allof = "A" ° §"B" ° "C" ° "D"
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
        """
        parser = grammar_provider(lang)()
        st = parser('CADB')
        assert 'allof' in st and st['allof'].content == "CADB"
        st = parser('_BCD')
        assert st.equals(parse_sxpr('(document "_BCD")'))
        st = parser('_ABC')
        assert st.equals(parse_sxpr('(document "_ABC")'))
        st = parser('A_CD')
        assert st['allof'].content == "A_CD"
        st = parser('AB_D')
        assert st['allof'].content == "AB_D"
        st = parser('A__D')
        assert st['allof'].content == "A__D"
        st = parser('CA_D')
        assert st['allof'].content == "CA_D"
608
609
        st = parser('A_CB')
        assert st['allof'].content == "A_CB"
610
        st = parser('BC_A')
611
        assert 'allof' not in st
612
613


614
class TestPopRetrieve:
615
    mini_language = r"""
616
617
        document       = { text | codeblock }
        codeblock      = delimiter { text | (!:delimiter delimiter_sign) } ::delimiter
618
        delimiter      = delimiter_sign  # never use delimiter between capture and pop except for retrival!
619
        delimiter_sign = /`+/
eckhart's avatar
eckhart committed
620
        text           = /[^`]+/
621
        """
622
    mini_lang2 = r"""
623
        @braces_filter = matching_bracket()
624
625
626
627
628
629
630
        document       = { text | codeblock }
        codeblock      = braces { text | opening_braces | (!:braces closing_braces) } ::braces
        braces         = opening_braces
        opening_braces = /\{+/
        closing_braces = /\}+/
        text           = /[^{}]+/
        """
631
    mini_lang3 = r"""
632
633
634
635
        document       = { text | env }
        env            = (specialtag | opentag) text [closespecial | closetag]
        opentag        = "<" name ">"
        specialtag     = "<" /ABC/ !name ">"
eckhart's avatar
eckhart committed
636
        closetag       = close_slash | close_star
637
638
639
640
641
642
        close_slash    = "<" ::name "/>"
        close_star     = "<" ::name "*>"
        closespecial   = "<" /ABC/~ ">"
        name           = /\w+/~
        text           = /[^<>]+/
        """
643
644
645
646
647
648
649
650
    mini_lang4 = r"""
        document       = { text | env }
        env            = opentag document closetag
        opentag        = "<" name ">"
        closetag       = "</" :?name ">"
        name           = /\w+/~
        text           = /[^<>]+/        
    """
651
652

    def setup(self):
653
654
655
        self.minilang_parser = grammar_provider(self.mini_language)()
        self.minilang_parser2 = grammar_provider(self.mini_lang2)()
        self.minilang_parser3 = grammar_provider(self.mini_lang3)()
656
        self.minilang_parser4 = grammar_provider(self.mini_lang4)()
657
658

    @staticmethod
659
    def has_tag_name(node, name):
660
        return node.tag_name == name # and not isinstance(node.parser, Retrieve)
661

662
663
    def test_capture_assertions(self):
        try:
664
665
666
            _ = Grammar(Capture(Drop(Whitespace(r'\s*'))))
            assert False, "GrammarError expected!"
        except GrammarError as ge:
667
668
            pass
        try:
669
            _ = Grammar(Capture(Series(Token(' '), Drop(Whitespace(r'\s*')))))
670
            assert False, "ValueError expected!"
671
        except GrammarError:
672
            pass
673
674
675
        cp = Capture(RegExp(r'\w+'))
        cp.pname = "capture"
        _ = Grammar(cp)
676

677
678
679
680
    def test_compile_mini_language(self):
        assert self.minilang_parser
        assert self.minilang_parser2
        assert self.minilang_parser3
681
        assert self.minilang_parser4
682
683
684
685

    def test_stackhandling(self):
        ambigous_opening = "<ABCnormal> normal tag <ABCnormal*>"
        syntax_tree = self.minilang_parser3(ambigous_opening)
686
        assert not syntax_tree.error_flag, str(syntax_tree.errors_sorted)
687
688
689

        ambigous_opening = "<ABCnormal> normal tag <ABCnormal/>"
        syntax_tree = self.minilang_parser3(ambigous_opening)
690
        assert not syntax_tree.error_flag, str(syntax_tree.errors_sorted)
691
692
693

        forgot_closing_tag = "<em> where is the closing tag?"
        syntax_tree = self.minilang_parser3(forgot_closing_tag)
694
        assert syntax_tree.error_flag, str(syntax_tree.errors_sorted)
695
696
697

        proper = "<em> has closing tag <em/>"
        syntax_tree = self.minilang_parser3(proper)
698
        assert not syntax_tree.error_flag, str(syntax_tree.errors_sorted)
699
700
701

        proper = "<em> has closing tag <em*>"
        syntax_tree = self.minilang_parser3(proper)
702
        assert not syntax_tree.error_flag, str(syntax_tree.errors_sorted)
703

704
705
706
    def test_optional_match(self):
        test1 = '<info>Hey, you</info>'
        st = self.minilang_parser4(test1)
707
        assert not st.error_flag, str(st.errors_sorted)
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
        test12 = '<info>Hey, <emph>you</emph></info>'
        st = self.minilang_parser4(test1)
        assert not st.error_flag
        test2 = '<info>Hey, you</>'
        st = self.minilang_parser4(test2)
        assert not st.error_flag
        test3 = '<info>Hey, <emph>you</></>'
        st = self.minilang_parser4(test3)
        assert not st.error_flag
        test4 = '<info>Hey, <emph>you</></info>'
        st = self.minilang_parser4(test4)
        assert not st.error_flag

    def test_rollback_behaviour_of_optional_match(self):
        test1 = '<info>Hey, you</info*>'
        st = self.minilang_parser4(test1)
        assert not self.minilang_parser4.variables__['name']
        assert st.error_flag
        test2 = '<info>Hey, you</*>'
        st = self.minilang_parser4(test2)
        assert not self.minilang_parser4.variables__['name']
        assert st.error_flag

731
    def test_cache_neutrality(self):
732
733
        """Test that packrat-caching does not interfere with the variable-
        changing parsers: Capture and Retrieve."""
734
        lang = r"""
735
736
737
738
739
740
741
742
743
            text = opening closing
            opening = (unmarked_package | marked_package)
            closing = ::variable
            unmarked_package = package "."
            marked_package = package "*" "."
            package = "(" variable ")"
            variable = /\w+/~
            """
        case = "(secret)*. secret"
744
        gr = grammar_provider(lang)()
745
        st = gr(case)
746
        assert not st.error_flag, str(st.errors_sorted)
747
748
749
750

    def test_single_line(self):
        teststr = "Anfang ```code block `` <- keine Ende-Zeichen ! ``` Ende"
        syntax_tree = self.minilang_parser(teststr)
751
752
        assert not syntax_tree.errors_sorted, \
            ''.join(str(error) for error in syntax_tree.errors_sorted)
753
754
755
        matchf = partial(self.has_tag_name, name="delimiter")
        delim = str(next(syntax_tree.select_if(matchf)))
        pop = str(next(syntax_tree.select_if(matchf, reverse=True)))
756
757
        assert delim == pop
        if is_logging():
758
            log_ST(syntax_tree, "test_PopRetrieve_single_line.cst")
759
760
761
762
763
764
765
766
767
768
769

    def test_multi_line(self):
        teststr = """
            Anfang ```code block `` <- keine Ende-Zeichen ! ``` Ebde

            Absatz ohne ``` codeblock, aber
            das stellt sich erst am Ende herause...

            Mehrzeliger ```code block
            """
        syntax_tree = self.minilang_parser(teststr)
770
        assert not syntax_tree.errors_sorted
771
772
773
        matchf = partial(self.has_tag_name, name="delimiter")
        delim = str(next(syntax_tree.select_if(matchf)))
        pop = str(next(syntax_tree.select_if(matchf, reverse=True)))
774
775
        assert delim == pop
        if is_logging():
776
            log_ST(syntax_tree, "test_PopRetrieve_multi_line.cst")
777
778
779
780

    def test_single_line_complement(self):
        teststr = "Anfang {{{code block }} <- keine Ende-Zeichen ! }}} Ende"
        syntax_tree = self.minilang_parser2(teststr)
781
        assert not syntax_tree.errors_sorted
782
783
784
785
786
        matchf = partial(self.has_tag_name, name="braces")
        delim = str(next(syntax_tree.select_if(matchf)))
        pop = str(next(syntax_tree.select_if(matchf, reverse=True)))
        assert len(delim) == len(pop)
        assert delim != pop
787
        if is_logging():
788
            log_ST(syntax_tree, "test_PopRetrieve_single_line.cst")
789
790
791
792
793
794
795
796
797
798
799

    def test_multi_line_complement(self):
        teststr = """
            Anfang {{{code block {{ <- keine Ende-Zeichen ! }}} Ende

            Absatz ohne {{{ codeblock, aber
            das stellt sich erst am Ende heraus...

            Mehrzeliger }}}code block
            """
        syntax_tree = self.minilang_parser2(teststr)
800
        assert not syntax_tree.errors_sorted
801
802
803
        matchf = partial(self.has_tag_name, name="braces")
        delim = str(next(syntax_tree.select_if(matchf)))
        pop = str(next(syntax_tree.select_if(matchf, reverse=True)))
804
805
        assert len(delim) == len(pop) and delim != pop
        if is_logging():
806
            log_ST(syntax_tree, "test_PopRetrieve_multi_line.cst")
807

808
    def test_autoretrieve(self):
809
810
        lang = r"""
            document   = { definition } § EOF
811
            definition = symbol :defsign value
812
            symbol     = /\w+/~                      
813
814
            defsign    = "=" | ":="
            value      = /\d+/~
815
            EOF        = !/./ [:?defsign]   # eat up captured defsigns
816
        """
817
818
        # code, _, _ = compile_ebnf(lang)
        # print(code)
819
        parser = grammar_provider(lang)()
820
821
822
        st = parser("X := 1")
        assert not st.error_flag
        st1 = st
823
824
        st = parser("")
        assert not st.error_flag
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848

        lines = [line for line in lang.split('\n') if line.strip()]
        eof_line = lines.pop()
        lines.insert(1, eof_line)
        lang = '\n'.join(lines)
        parser = grammar_provider(lang)()
        st = parser("X := 1")
        assert not st.errors
        assert st.equals(st1)

        del lines[1]
        lines.insert(2, eof_line)
        lang = '\n'.join(lines)
        parser = grammar_provider(lang)()
        st = parser("X := 1")
        assert not st.errors
        assert st.equals(st1)

        # and, finally...
        lang_variant = r"""
            document   = { definition } § EOF
            symbol     = /\w+/~                      
            defsign    = "=" | ":="
            value      = /\d+/~
849
            EOF        = !/./ :?defsign   # eat up captured defsign, only if it has been retrieved
850
851
852
853
854
855
            definition = symbol :defsign value
        """
        parser = grammar_provider(lang_variant)()
        st = parser("X := 1")
        assert not st.errors
        assert st.equals(st1)
856
857
        st = parser('')
        assert "EOF expected" in str(st.errors)
di68kap's avatar
di68kap committed
858

859

860
class TestWhitespaceHandling:
Eckhart Arnold's avatar
Eckhart Arnold committed
861
    minilang = """
862
863
864
865
866
867
868
        doc = A B
        A = "A"
        B = "B"
        Rdoc = ar br
        ar = /A/
        br = /B/
        """
869
    gr = grammar_provider(minilang)()
870
871
872
873
874
875
876
877
878
879
880
881

    def test_token_whitespace(self):
        st = self.gr("AB", 'doc')
        assert not st.error_flag
        st = self.gr("A B", 'doc')
        assert not st.error_flag

    def test_regexp_whitespace(self):
        st = self.gr("AB", 'Rdoc')
        assert not st.error_flag
        st = self.gr("A B", 'Rdoc')
        assert st.error_flag
di68kap's avatar
di68kap committed
882
883
884
885
886


class TestErrorReporting:
    grammar = """
        root      = series alpha | anything
eckhart's avatar
eckhart committed
887
        series    = subseries &alpha
di68kap's avatar
di68kap committed
888
889
890
891
892
893
894
895
896
897
898
899
900
901
        subseries = alpha §beta
        alpha     = /[a-z]+/
        beta      = /[A-Z]+/
        anything  = /.*/
        """

    def setup(self):
        self.parser = grammar_provider(self.grammar)()

    def test_error_propagation(self):
        testcode1 = "halloB"
        testcode2 = "XYZ"
        testcode3 = "hallo "
        cst = self.parser(testcode1)
902
        assert not cst.error_flag, str(cst.errors_sorted)
di68kap's avatar
di68kap committed
903
904
905
906
        cst = self.parser(testcode2)
        assert not cst.error_flag
        cst = self.parser(testcode3)
        assert cst.error_flag
907
908


di68kap's avatar
di68kap committed
909
910
class TestBorderlineCases:
    def test_not_matching(self):
911
        minilang = """parser = /X/\n"""
di68kap's avatar
di68kap committed
912
913
914
915
        gr = grammar_provider(minilang)()
        cst = gr('X', 'parser')
        assert not cst.error_flag
        cst = gr(' ', 'parser')
916
        assert cst.error_flag and cst.errors_sorted[0].code == PARSER_DID_NOT_MATCH
di68kap's avatar
di68kap committed
917
        cst = gr('', 'parser')
918
        assert cst.error_flag and cst.errors_sorted[0].code == PARSER_DID_NOT_MATCH
di68kap's avatar
di68kap committed
919
920
921
922
923
924
925

    def test_matching(self):
        minilang = """parser = /.?/"""
        gr = grammar_provider(minilang)()
        cst = gr(' ', 'parser')
        assert not cst.error_flag
        cst = gr('  ', 'parser')
926
        assert cst.error_flag and cst.errors_sorted[0].code == PARSER_STOPPED_BEFORE_END
di68kap's avatar
di68kap committed
927
928
929
930
        cst = gr('', 'parser')
        assert not cst.error_flag


eckhart's avatar
eckhart committed
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
EBNF_with_Errors = r"""# Test code with errors. All places marked by a "$" should yield and error

@ comment    = /#.*(?:\n|$)/
@ whitespace = /\s*/
@ literalws  = right
@ anonymous  = pure_elem, EOF
@ drop       = whitespace, EOF


# re-entry-rules for resuming after parsing-error
@ definition_resume = /\n\s*(?=@|\w+\w*\s*=)/
@ directive_resume  = /\n\s*(?=@|\w+\w*\s*=)/

# specialized error messages for certain cases

@ definition_error  = /,/, 'Delimiter "," not expected in definition!\nEither this was meant to '
                           'be a directive and the directive symbol @ is missing\nor the error is '
                           'due to inconsistent use of the comma as a delimiter\nfor the elements '
                           'of a sequence.'

#: top-level

syntax     = [~//] { definition | directive } §EOF
definition = symbol §:DEF~ expression :ENDL~
directive  = "@" §symbol "="
             (regexp | literals | symbol)
             { "," (regexp | literals | symbol) }

#: components

expression = sequence { :OR~ sequence }
sequence   = ["§"] ( interleave | lookaround )
             { :AND~ ["§"] ( interleave | lookaround ) }
interleave = difference { "°" ["§"] difference }
lookaround = flowmarker § (oneormore | pure_elem)
difference = term ["-" § (oneormore $ pure_elem)]               # <- ERROR
term       = oneormore | repetition | option | pure_elem        # resuming expected her

#: elements

pure_elem  = element § !/[?*+]/
element    = [retrieveop] symbol !DEF
           | literal
           | plaintext
           | regexp
           | whitespace
           | group$                                             # <- ERROR

#: flow-operators

flowmarker = "!"  | "&"                                         # resuming expected her
           | "<-!" | "<-&"
retr$ieveop = "::" | ":?" | ":"

#: groups

group      = "(" §expression ")"
oneormore  = "{" expression "}+" | element "+"
repetition = "{" §expressi$on "}" | element "*"                 # <- ERROR
option     = "[" §expression "]" | element "?"                  # resuming expected here

#: leaf-elements

symbol     = /(?!\d)\w+/~
$literals   = { literal }+                                      # <- ERROR
literal    = /"(?:(?<!\\)\\"|[^"])*?"/~                         # resuming expected her
           | /'(?:(?<!\\)\\'|[^'])*?'/~
plaintext  = /`(?:(?<!\\)\\`|[^`])*?`/~
regexp     = /\/(?:(?<!\\)\\(?:\/)|[^\/])*?\//~
whitespace = /~/~