test_parse.py 59 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, Tuple
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, start_logging
eckhart's avatar
eckhart committed
34
35
from DHParser.error import Error, is_error, adjust_error_locations, MANDATORY_CONTINUATION, \
    MALFORMED_ERROR_STRING, MANDATORY_CONTINUATION_AT_EOF, RESUME_NOTICE, PARSER_STOPPED_BEFORE_END, \
36
    PARSER_NEVER_TOUCHES_DOCUMENT, CAPTURE_DROPPED_CONTENT_WARNING
37
from DHParser.parse import ParserError, Parser, Grammar, Forward, TKN, ZeroOrMore, RE, \
eckhart's avatar
eckhart committed
38
    RegExp, Lookbehind, NegativeLookahead, OneOrMore, Series, Alternative, \
39
    Interleave, CombinedParser, Text, EMPTY_NODE, Capture, Drop, Whitespace, \
40
    GrammarError, Counted, Always, INFINITE
41
from DHParser import compile_source
42
from DHParser.ebnf import get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
43
    parse_ebnf, DHPARSER_IMPORTS, compile_ebnf
eckhart's avatar
eckhart committed
44
from DHParser.dsl import grammar_provider, create_parser, raw_compileEBNF
45
from DHParser.syntaxtree import Node, parse_sxpr
46
from DHParser.stringview import StringView
47
from DHParser.trace import set_tracer, trace_history, resume_notices_on
48
49


50
51
52
53
54
55

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

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

59

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

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

eckhart's avatar
eckhart committed
80

eckhart's avatar
eckhart committed
81
82
83
84
85
86
87
88
89
class TestParserClass:
    def test_apply(self):
        minilang ="""
            expr = expr ("+"|"-") term | term
            term = term ("*"|"/") factor | factor
            factor = /[0-9]+/~
            """
        gr = grammar_provider(minilang)()
        l = []
90
91
        def visitor(context: List[Parser]):
            p = context[-1]
di68kap's avatar
di68kap committed
92
            l.append(p.pname + p.ptype)
eckhart's avatar
eckhart committed
93
94
95
96
97
98
99
100
101
102
        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

103
104
    def test_symbol(self):
        class MyGrammar(Grammar):
105
            wrong = Text('wrong')
106
107
108
109
110
            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
111
        assert result == 'word', result
112

eckhart's avatar
eckhart committed
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
class TestInfiLoopsAndRecursion:
    def setup(self):
        pass
        # set_config_value('history_tracking', True)
        # set_config_value('resume_notices', True)
        # start_logging('LOGS')

    def test_very_simple(self):
        minilang = """
            term = term (`*`|`/`) factor | factor
            factor = /[0-9]+/
            """
        grammar_factory = grammar_provider(minilang)
        parser = grammar_factory()
        snippet = "5*4*3*2"
        # set_tracer(parser, trace_history)
        st = parser(snippet)
        if is_logging():
            log_ST(st, 'test_LeftRecursion_very_simple.cst')
            log_parsing_history(parser, 'test_LeftRecursion_very_simple')
        assert not is_error(st.error_flag), str(st.errors)
        st = parser("1*2*3*4*5*6*7*8*9")
        # if is_logging():
        #     log_ST(st, 'test_LeftRecursion_very_simple_2.cst')
        #     log_parsing_history(parser, 'test_LeftRecursion_very_simple_2')
        assert not is_error(st.error_flag)

    def test_direct_left_recursion1(self):
        minilang = """@literalws = right
            expr = expr ("+"|"-") term | term
            term = term ("*"|"/") factor | factor
            factor = /[0-9]+/~
            """
        snippet = "9 + 8 + 7 + 6 + 5 + 3 * 4"
        parser = grammar_provider(minilang)()
        # print(raw_compileEBNF(minilang).result)
        assert parser
        syntax_tree = parser(snippet)
        if is_logging():
            log_ST(syntax_tree, "test_LeftRecursion_direct1.cst")
            log_parsing_history(parser, "test_LeftRecursion_direct1")
        assert not is_error(syntax_tree.error_flag), str(syntax_tree.errors_sorted)
        assert snippet == syntax_tree.content, str(syntax_tree)

    def test_direct_left_recursion2(self):
        minilang = """@literalws = right
            expr = ex
            ex   = expr ("+"|"-") term | term
            term = tr
            tr   = term ("*"|"/") factor | factor
            factor = /[0-9]+/~
            """
        snippet = "9 + 8 + 7 + 6 + 5 + 3 * 4"
        parser = grammar_provider(minilang)()
        assert parser
        syntax_tree = parser(snippet)
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
        assert snippet == syntax_tree.content
        if is_logging():
            log_ST(syntax_tree, "test_LeftRecursion_direct2.cst")
            log_parsing_history(parser, "test_LeftRecursion_direct2")

    def test_indirect_left_recursion1(self):
        minilang = """@literalws = right
            Expr    = //~ (Product | Sum | Value)
            Product = Expr { ('*' | '/') Expr }+
            Sum     = Expr { ('+' | '-') Expr }+
            Value   = /[0-9.]+/~ | '(' §Expr ')'
            """
        # print(raw_compileEBNF(minilang).result)
        parser = grammar_provider(minilang)()
        snippet = "8 * 4"
        syntax_tree = parser(snippet)
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
        snippet = "7 + 8 * 4"
        syntax_tree = parser(snippet)
        if is_logging():
            log_ST(syntax_tree, "test_LeftRecursion_indirect1.cst")
            log_parsing_history(parser, "test_LeftRecursion_indirect1")
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
        snippet = "9 + 8 * (4 + 3)"
        syntax_tree = parser(snippet)
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
        assert snippet == syntax_tree.content
        snippet = "9 + 8 * (4 - 3 / (5 - 1))"
        syntax_tree = parser(snippet)
        assert not is_error(syntax_tree.error_flag), syntax_tree.errors_sorted
        assert snippet == syntax_tree.content
        if is_logging():
            log_ST(syntax_tree, "test_LeftRecursion_indirect1.cst")
            log_parsing_history(parser, "test_LeftRecursion_indirect1")

    # BEWARE: EXPERIMENTAL TEST can be long running
    def test_indirect_left_recursion2(self):
        arithmetic_syntax = r"""@literalws = right
            expression     = addition | subtraction  # | term
            addition       = (expression | term) "+" (expression | term)
            subtraction    = (expression | term) "-" (expression | term)
            term           = multiplication | division  # | factor
            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)()
        assert arithmetic
        syntax_tree = arithmetic("(a + b) * (a - b)")
        assert syntax_tree.errors
        if is_logging():
            log_ST(syntax_tree, "test_LeftRecursion_indirect2.cst")
            log_parsing_history(arithmetic, "test_LeftRecursion_indirect2")

    def test_indirect_left_recursion3(self):
        arithmetic_syntax = r"""@literalws = right
            expression     = addition | subtraction | term
            addition       = (expression | term) "+" (expression | term)
            subtraction    = (expression | term) "-" (expression | term)
            term           = multiplication | division | factor
            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)()
        assert arithmetic
        syntax_tree = arithmetic("(a + b) * (a - b)")
        assert not syntax_tree.errors
        if is_logging():
            log_ST(syntax_tree, "test_LeftRecursion_indirect3.cst")
            log_parsing_history(arithmetic, "test_LeftRecursion_indirect3")


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

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

    def test_break_infinite_loop_Counted(self):
        forever = Counted(Always(), (0, INFINITE))
        result = Grammar(forever)('')  # if this takes very long, something is wrong
        assert repr(result) == "Node(':EMPTY', '')", repr(result)
        forever = Counted(Always(), (5, INFINITE))
        result = Grammar(forever)('')  # if this takes very long, something is wrong
        assert repr(result) == "Node(':EMPTY', '')", repr(result)
        forever = Counted(Always(), (INFINITE, INFINITE))
        result = Grammar(forever)('')  # if this takes very long, something is wrong
        assert repr(result) == "Node(':EMPTY', '')", repr(result)
        forever = Counted(Always(), (1000, INFINITE - 1))
        result = Grammar(forever)('')  # if this takes very long, something is wrong
        assert repr(result) == "Node(':EMPTY', '')", repr(result)

    def test_break_infinite_loop_Interleave(self):
        forever = Interleave(Always(), repetitions = [(0, INFINITE)])
        result = Grammar(forever)('')  # if this takes very long, something is wrong
        assert repr(result) == "Node(':EMPTY', '')", repr(result)
        forever = Interleave(Always(), Always(),
                             repetitions = [(5, INFINITE), (INFINITE, INFINITE)])
        result = Grammar(forever)('')  # if this takes very long, something is wrong
        assert repr(result) == "Node(':EMPTY', '')", repr(result)
        forever = Interleave(Always(), repetitions = [(1000, INFINITE - 1)])
        result = Grammar(forever)('')  # if this takes very long, something is wrong
        assert repr(result) == "Node(':EMPTY', '')", repr(result)

    # def test_infinite_loops(self):
    #     minilang = """forever = { // } \n"""
    #     try:
    #         parser_class = grammar_provider(minilang)
    #     except CompilationError as error:
    #         assert all(e.code == INFINITE_LOOP for e in error.errors)
    #     save = get_config_value('static_analysis')
    #     set_config_value('static_analysis', 'late')
    #     provider = grammar_provider(minilang)
    #     try:
    #         parser = provider()
    #     except GrammarError as error:
    #         assert error.errors[0][2].code == INFINITE_LOOP
    #     set_config_value('static_analysis', 'none')
    #     parser = provider()
    #     snippet = " "
    #     syntax_tree = parser(snippet)
    #     assert any(e.code == INFINITE_LOOP for e in syntax_tree.errors)
    #     res = parser.static_analysis()
    #     assert res and res[0][2].code == INFINITE_LOOP
    #     minilang = """not_forever = { / / } \n"""
    #     parser = grammar_provider(minilang)()
    #     res = parser.static_analysis()
    #     assert not res
    #     set_config_value('static_analysis', save)
313

eckhart's avatar
eckhart committed
314

315
316
317
318
319
320
# class TestStaticAnalysis:
#     def test_alternative(self):
#         lang = 'doc = "A" | "AB"'
#         parser = create_parser(lang)


Eckhart Arnold's avatar
Eckhart Arnold committed
321
class TestFlowControl:
322
323
324
325
326
327
    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"
328

Eckhart Arnold's avatar
Eckhart Arnold committed
329
    def test_lookbehind(self):
330
331
        ws = RegExp(r'\s*');  ws.pname = "ws"
        end = RegExp("END");  end.pname = "end"
332
        doc_end = Lookbehind(RegExp('\\s*?\\n')) + end
333
        word = RegExp(r'\w+');  word.pname = "word"
Eckhart Arnold's avatar
Eckhart Arnold committed
334
335
336
        sequence = OneOrMore(NegativeLookahead(end) + word + ws)
        document = ws + sequence + doc_end + ws
        parser = Grammar(document)
337
338
339
340
341
        cst = parser(self.t1)
        assert not cst.error_flag, cst.as_sxpr()
        cst = parser(self.t2)
        assert cst.error_flag, cst.as_sxpr()

342
343
344
345
346
347
348
349
        cst = parser(self.t2, parser['ws'], complete_match=False)
        assert cst.did_match() and len(cst) == 0 and not cst.errors
        cst = parser(self.t2, parser['word'], complete_match=False)
        assert cst.did_match() and cst.content == "All" and not cst.errors
        cst = parser(self.t2, parser['end'], complete_match=False)
        assert not cst.did_match()


350
351
    def test_lookbehind_indirect(self):
        class LookbehindTestGrammar(Grammar):
eckhart's avatar
eckhart committed
352
            parser_initialization__ = ["upon instantiation"]
353
            ws = RegExp(r'\s*')
354
            end = RegExp('END')
355
            SUCC_LB = RegExp('\\s*?\\n')
356
            doc_end = Series(Lookbehind(SUCC_LB), end)
357
            word = RegExp(r'\w+')
358
359
360
361
362
363
            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
364
        assert not cst.error_flag, cst.as_sxpr()
365
        cst = parser(self.t2)
Eckhart Arnold's avatar
Eckhart Arnold committed
366
367
368
        assert cst.error_flag, cst.as_sxpr()


369
370
371
372
373
374
375
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
376
        result, messages, _ = compile_source(mlregex, None, get_ebnf_grammar(),
Eckhart Arnold's avatar
Eckhart Arnold committed
377
                        get_ebnf_transformer(), get_ebnf_compiler('MultilineRegexTest'))
378
        assert result
379
        assert not messages, str(messages)
380
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
eckhart's avatar
eckhart committed
381
382
        node = parser('abc+def', parser.regex)
        assert not node.error_flag
383
        assert node.tag_name == "regex"
384
385
        assert str(node) == 'abc+def'

386
387
    def test_multilineRegex_wo_Comments(self):
        mlregex = r"""
eckhart's avatar
eckhart committed
388
389
        regex =  /\w+
                  [+]
390
391
                  \w* /
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
392
        result, messages, _ = compile_source(mlregex, None, get_ebnf_grammar(),
393
394
395
                        get_ebnf_transformer(), get_ebnf_compiler('MultilineRegexTest'))
        assert result
        assert not messages, str(messages)
396
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
397
398
        node = parser('abc+def', parser.regex)
        assert not node.error_flag
399
        assert node.tag_name == "regex"
400
401
        assert str(node) == 'abc+def'

402
    def test_ignore_case(self):
403
404
405
406
        mlregex = r"""
        @ ignorecase = True
        regex = /alpha/
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
407
        result, messages, _ = compile_source(mlregex, None, get_ebnf_grammar(),
408
409
410
                        get_ebnf_transformer(), get_ebnf_compiler('MultilineRegexTest'))
        assert result
        assert not messages
411
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
412
        node, rest = parser.regex(StringView('Alpha'))
413
414
        assert node
        assert rest == ''
415
        assert node.tag_name == "regex"
416
417
418
419
420
421
        assert str(node) == 'Alpha'

        mlregex = r"""
        @ ignorecase = False
        regex = /alpha/
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
422
        result, messages, _ = compile_source(mlregex, None, get_ebnf_grammar(),
423
424
425
                        get_ebnf_transformer(), get_ebnf_compiler('MultilineRegexTest'))
        assert result
        assert not messages
426
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
427
428
        node, rest = parser.regex(StringView('Alpha'))
        assert node is None
429

430
    def test_token(self):
431
        tokenlang = r"""@literalws = right
432
433
434
435
436
437
438
439
440
441
            @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
442
        result, messages, _ = compile_source(
eckhart's avatar
eckhart committed
443
444
            tokenlang, None, get_ebnf_grammar(), get_ebnf_transformer(),
            get_ebnf_compiler("TokenTest"))
445
        assert result
eckhart's avatar
eckhart committed
446
        assert not messages, str(messages)
447
        parser = compile_python_object(DHPARSER_IMPORTS + result, r'\w+Grammar$')()
Eckhart Arnold's avatar
Eckhart Arnold committed
448
        result = parser(testdoc)
449
        # log_parsing_history(parser, "test.log")
450
        assert not result.error_flag, str(result.errors_sorted)
451

452

453
class TestGrammar:
454
455
456
457
458
459
460
461
    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"))
eckhart's avatar
eckhart committed
462
    assert pyparser, str(messages)
eckhart's avatar
eckhart committed
463
    assert not messages, str(messages)
464
465
466
467

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

473
    def test_select_parsing(self):
474
        grammar = compile_python_object(DHPARSER_IMPORTS + self.pyparser, r'\w+Grammar$')()
475
476
477
478
        grammar("wort", "WORT")
        grammar("eine Zeile", "textzeile")
        grammar("kein Haupt", "haupt")
        grammar("so ist es richtig", "haupt")
479

di68kap's avatar
di68kap committed
480
481
    def test_grammar_subclassing(self):
        class Arithmetic(Grammar):
482
            r'''
di68kap's avatar
di68kap committed
483
484
485
486
487
488
            expression =  term  { ("+" | "-") term }
            term       =  factor  { ("*" | "/") factor }
            factor     =  INTEGER | "("  expression  ")"
            INTEGER    =  /\d+/~
            '''
            expression = Forward()
489
490
491
492
            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
493
494
495
496
497
498
            root__ = expression

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

499
500
501
502
503
504
505
    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')
506
        assert st.errors[0].code == PARSER_STOPPED_BEFORE_END
507
508
509
        st = gr('eins zwei', complete_match=False)
        assert not st.errors

510
    def test_synonym(self):
di68kap's avatar
di68kap committed
511
        lang = r"""
512
513
514
515
516
517
518
519
520
            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')
521
        gr = grammar_provider("@drop = whitespace, strings" + lang)()
522
523
        st = gr('eins 1 zwei2drei 3')
        st = gr('-3')
524
        assert str(gr['S']) == "S = ~", str(gr['S'])
525

526

527
528
529
530
531
532
533
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
534
        st = parser("ABCD")
535
        assert not st.error_flag
Eckhart Arnold's avatar
Eckhart Arnold committed
536
        st = parser("A_CD")
537
        assert not st.error_flag
Eckhart Arnold's avatar
Eckhart Arnold committed
538
        st = parser("AB_D")
539
540
541
542
543
544
545
546
547
548
549
        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)()
550
551
552
        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
553
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
554
        # transitivity of mandatory-operator
555
        st = parser("ABC_");  assert st.error_flag
556
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
557
558

    def test_series_composition(self):
559
        TA, TB, TC, TD, TE = (TKN(b) for b in "ABCDE")
560
561
562
563
564
        s1 = Series(TA, TB, TC, mandatory=2)
        s2 = Series(TD, TE)

        combined = Alternative(s1 + s2, RegExp('.*'))
        parser = Grammar(combined)
565
566
567
        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
568
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
569
        st = parser("ABC_E");  assert st.error_flag
570
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
571
572
573

        combined = Alternative(s2 + s1, RegExp('.*'))
        parser = Grammar(combined)
574
575
576
577
578
579
        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
580
        assert st.errors_sorted[0].code == MANDATORY_CONTINUATION
581

eckhart's avatar
eckhart committed
582
583
584
585
586
587
588
589
590
591
    # 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
592

593
594
    def test_ebnf_serialization(self):
        ebnf_grammar = get_ebnf_grammar()
eckhart's avatar
eckhart committed
595
        # TODO: Add test here
596
        ebnf = ebnf_grammar.as_ebnf()
597
        # print(ebnf)
598
599


600
601
602
class TestAllOfSomeOf:
    def test_allOf_order(self):
        """Test that parsers of an AllOf-List can match in arbitrary order."""
eckhart's avatar
eckhart committed
603
        prefixes = Interleave(TKN("A"), TKN("B"))
604
605
        assert Grammar(prefixes)('A B').content == 'A B'
        assert Grammar(prefixes)('B A').content == 'B A'
606
607
608
609

    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
610
        prefixes = Interleave(TKN("A"), TKN("B"))
611
612
613
614
615
        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
616
        prefixes = Interleave(TKN("A"), TKN("B"), TKN("A"))
617
618
619
        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'
620
621
622
623
        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
624
        prefixes = Interleave(TKN("A"), TKN("B"))
625
626
        assert Grammar(prefixes)('A B').content == 'A B'
        assert Grammar(prefixes)('B A').content == 'B A'
eckhart's avatar
eckhart committed
627
628
629
        st = Grammar(prefixes)('B')
        assert st.error_flag
        prefixes = Interleave(TKN("B"), TKN("A"), repetitions=((0, 1), (0, 1)))
630
        assert Grammar(prefixes)('A B').content == 'A B'
eckhart's avatar
eckhart committed
631
632
633
        st = Grammar(prefixes)('B')
        assert not st.error_flag
        assert st.content == 'B'
634
635
636
637

    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
638
        prefixes = Interleave(TKN("A"), TKN("B"), TKN("A"))
639
640
641
        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'
642
643
644
        assert Grammar(prefixes)('A B B').error_flag


645
646
class TestInterleave:
    def test_interleave_most_simple(self):
647
        letterset = Interleave(Text("A"), Text("B"), Text("C"))
648
649
        gr = Grammar(letterset)
        st = gr('ABC')
650
        assert not st.errors, str(st.errors)
651
652
653
654
655
656
657
658
659
660
        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):
661
        letterset = Interleave(Text("A"), Text("B"), Text("C"),
662
663
664
665
                               repetitions=[(1, 1000), (0, 1), (1, 1)])
        gr = Grammar(letterset)
        st = gr('AABC')
        assert not st.errors
666
667
668
669
670
671
672
673
674
675
        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


676
677
678
679
class TestErrorRecovery:
    def test_series_skip(self):
        lang = """
        document = series | /.*/
680
        @series_skip = /(?=[A-Z])/
681
682
683
684
685
        series = "A" "B" §"C" "D"
        """
        parser = grammar_provider(lang)()
        st = parser('AB_D')
        assert len(st.errors) == 1  # no additional "stopped before end"-error!
686
        resume_notices_on(parser)
687
        st = parser('AB_D')
688
        assert len(st.errors) == 2 and any(err.code == RESUME_NOTICE for err in st.errors)
eckhart's avatar
eckhart committed
689
        assert 'Skipping' in str(st.errors_sorted[1])
690

691
    def test_Interleave_skip(self):
692
693
694
        lang = """
        document = allof | /.*/
        @allof_skip = /[A-Z]/
695
        allof = "A" ° §"B" ° "C" ° "D"
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
        """
        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"
712
713
        st = parser('A_CB')
        assert st['allof'].content == "A_CB"
714
        st = parser('BC_A')
715
        assert 'allof' not in st
716
717


718
class TestPopRetrieve:
719
    mini_language = r"""
720
721
        document       = { text | codeblock }
        codeblock      = delimiter { text | (!:delimiter delimiter_sign) } ::delimiter
722
        delimiter      = delimiter_sign  # never use delimiter between capture and pop except for retrieval!
723
        delimiter_sign = /`+/
eckhart's avatar
eckhart committed
724
        text           = /[^`]+/
725
        """
726
    mini_lang2 = r"""
727
        @braces_filter = matching_bracket()
728
729
730
731
732
733
734
        document       = { text | codeblock }
        codeblock      = braces { text | opening_braces | (!:braces closing_braces) } ::braces
        braces         = opening_braces
        opening_braces = /\{+/
        closing_braces = /\}+/
        text           = /[^{}]+/
        """
735
    mini_lang3 = r"""@literalws = right
736
        document       = { text | env }
eckhart's avatar
eckhart committed
737
        env            = (specialtag | opentag) text [ closespecial | closetag ]
738
739
        opentag        = "<" name ">"
        specialtag     = "<" /ABC/ !name ">"
eckhart's avatar
eckhart committed
740
        closetag       = close_slash | close_star
741
742
743
744
745
746
        close_slash    = "<" ::name "/>"
        close_star     = "<" ::name "*>"
        closespecial   = "<" /ABC/~ ">"
        name           = /\w+/~
        text           = /[^<>]+/
        """
747
    mini_lang4 = r"""@literalws = right
748
749
750
751
752
753
754
        document       = { text | env }
        env            = opentag document closetag
        opentag        = "<" name ">"
        closetag       = "</" :?name ">"
        name           = /\w+/~
        text           = /[^<>]+/        
    """
755
756

    def setup(self):
757
758
759
        self.minilang_parser = grammar_provider(self.mini_language)()
        self.minilang_parser2 = grammar_provider(self.mini_lang2)()
        self.minilang_parser3 = grammar_provider(self.mini_lang3)()
760
        self.minilang_parser4 = grammar_provider(self.mini_lang4)()
761
762

    @staticmethod
763
    def has_tag_name(node, name):
764
        return node.tag_name == name # and not isinstance(node.parser, Retrieve)
765

766
767
    def test_capture_assertions(self):
        try:
768
            _ = Grammar(Capture(Drop(Whitespace(r'\s*'))))
769
            assert False, "GrammarError expected"
770
        except GrammarError as ge:
771
772
            assert ge.errors and ge.errors[0][-1].code == CAPTURE_DROPPED_CONTENT_WARNING, \
                "Capture-dropped-content-Warning expected"
773
        try:
774
            _ = Grammar(Capture(Series(Text(' '), Drop(Whitespace(r'\s*')))))
775
776
777
778
            assert False, "GrammarError expected"
        except GrammarError as ge:
            assert ge.errors and ge.errors[0][-1].code == CAPTURE_DROPPED_CONTENT_WARNING, \
                "Capture-dropped-content-Warning expected"
779
780
781
        cp = Capture(RegExp(r'\w+'))
        cp.pname = "capture"
        _ = Grammar(cp)
782

783
784
785
786
    def test_compile_mini_language(self):
        assert self.minilang_parser
        assert self.minilang_parser2
        assert self.minilang_parser3
787
        assert self.minilang_parser4
788
789
790
791

    def test_stackhandling(self):
        ambigous_opening = "<ABCnormal> normal tag <ABCnormal*>"
        syntax_tree = self.minilang_parser3(ambigous_opening)
792
        assert not syntax_tree.error_flag, str(syntax_tree.errors_sorted)
793
794
795

        ambigous_opening = "<ABCnormal> normal tag <ABCnormal/>"
        syntax_tree = self.minilang_parser3(ambigous_opening)
796
        assert not syntax_tree.error_flag, str(syntax_tree.errors_sorted)
797
798
799

        forgot_closing_tag = "<em> where is the closing tag?"
        syntax_tree = self.minilang_parser3(forgot_closing_tag)
800
        assert syntax_tree.error_flag, str(syntax_tree.errors_sorted)
801
802
803

        proper = "<em> has closing tag <em/>"
        syntax_tree = self.minilang_parser3(proper)
804
        assert not syntax_tree.error_flag, str(syntax_tree.errors_sorted)
805
806
807

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

810
    def test_optional_match(self):
811
812
813
814
        # from DHParser.dsl import compileEBNF
        # src = compileEBNF(self.mini_lang4)
        # print(src)
        # return
815
816
817
818
819
820
        test1 = '<info>Hey, you</info>'
        st = self.minilang_parser4(test1)
        assert not st.error_flag, str(st.errors_sorted)
        test12 = '<info>Hey, <emph>you</emph></info>'
        st = self.minilang_parser4(test1)
        assert not st.error_flag
821
        test2 = '<info>Hey, you</>'
822
823
824
        # set_config_value('history_tracking', True)
        # set_tracer(self.minilang_parser4, trace_history)
        # start_logging('LOGS')
825
        st = self.minilang_parser4(test2)
826
827
828
829
830
831
832
833
834
        # log_parsing_history(self.minilang_parser4, "optional_match")
        # print(st.as_sxpr())
        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
835
836
837
838
839
840
841
842
843
844
845

    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

846
    def test_cache_neutrality_1(self):
847
848
        """Test that packrat-caching does not interfere with the variable-
        changing parsers: Capture and Retrieve."""
849
        lang = r"""@literalws = right
850
851
852
853
854
855
856
857
858
            text = opening closing
            opening = (unmarked_package | marked_package)
            closing = ::variable
            unmarked_package = package "."
            marked_package = package "*" "."
            package = "(" variable ")"
            variable = /\w+/~
            """
        case = "(secret)*. secret"
859
        gr = grammar_provider(lang)()
860
        st = gr(case)
861
        assert not st.error_flag, str(st.errors_sorted)
862

863
864
865
866
867
868
869
870
871
872
873
    def test_cache_neutrality_2(self):
        lang = r'''document = variantA | variantB
            variantA  = delimiter `X` ::delimiter `!` 
            variantB  = `A` delimiter ::delimiter `!` 
            delimiter = `A` | `X`
        '''
        gr = grammar_provider(lang)()
        case = 'AXA!'
        st = gr(case)
        assert not st.errors
        case = 'AXX!'
874
875
876
        # set_config_value('history_tracking', True)
        # start_logging('LOGS')
        # set_tracer(gr, trace_history)
877
        st = gr(case)
878
        # log_parsing_history(gr, 'test_cache_neutrality_2')
879
        # print(st.as_sxpr())
880
881
882
883
884
        assert not st.errors
        assert str(st) == "AXX!"

    def test_cache_neutrality_3(selfself):
        lang = r'''document = variantA | variantB
885
886
            variantA  = delimiter `X` [`---`] check ::delimiter `!` 
            variantB  = `A` delimiter [`---`] check ::delimiter `!`
887
888
889
890
            check = :delimiter 
            delimiter = `A` | `X`
        '''
        gr = grammar_provider(lang)()
891
        case = 'AX---XX!'
892
893
894
895
896
897
        # set_config_value('history_tracking', True)
        # start_logging('LOGS')
        # set_tracer(gr, trace_history)
        st = gr(case)
        # log_parsing_history(gr, 'test_cache_neutrality_3')
        # print(st.as_sxpr())
eckhart's avatar
eckhart committed
898
        assert not st.errors, str(errors)
899
900
901
        case = 'AXXX!'
        st = gr(case)
        assert not st.errors
902

903
904
905
    def test_single_line(self):
        teststr = "Anfang ```code block `` <- keine Ende-Zeichen ! ``` Ende"
        syntax_tree = self.minilang_parser(teststr)
906
907
        assert not syntax_tree.errors_sorted, \
            ''.join(str(error) for error in syntax_tree.errors_sorted)
908
909
910
        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)))
911
912
        assert delim == pop
        if is_logging():
913
            log_ST(syntax_tree, "test_PopRetrieve_single_line.cst")
914
915
916
917
918
919
920
921
922
923
924

    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)
925
        assert not syntax_tree.errors_sorted
926
927
928
        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)))
929
930
        assert delim == pop
        if is_logging():
931
            log_ST(syntax_tree, "test_PopRetrieve_multi_line.cst")
932
933
934
935

    def test_single_line_complement(self):
        teststr = "Anfang {{{code block }} <- keine Ende-Zeichen ! }}} Ende"
        syntax_tree = self.minilang_parser2(teststr)
936
        assert not syntax_tree.errors_sorted
937
938
939
940
941
        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
942
        if is_logging():
943
            log_ST(syntax_tree, "test_PopRetrieve_single_line.cst")
944
945
946
947
948
949
950
951
952
953
954

    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)
955
        assert not syntax_tree.errors_sorted
956
957
958
        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)))
959
960
        assert len(delim) == len(pop) and delim != pop
        if is_logging():
961
            log_ST(syntax_tree, "test_PopRetrieve_multi_line.cst")
962

963
    def test_autoretrieve(self):
964
        lang = r"""@literalws = right
965
            document   = { definition } § EOF
966
            definition = symbol :defsign value
967
            symbol     = /\w+/~                      
968
969
            defsign    = "=" | ":="
            value      = /\d+/~
eckhart's avatar
eckhart committed
970
            EOF        = !/./ [ :?defsign ]   # eat up captured defsigns
971
        """
972
        # print(raw_compileEBNF(lang).result)
973
        parser = grammar_provider(lang)()
974
        st = parser("X := 1")
975
        assert not st.error_flag, str(st.errors)
976
        st1 = st
977
978
        st = parser("")
        assert not st.error_flag
979
980
981

        lines = [line for line in lang.split('\n') if line.strip()]
        eof_line = lines.pop()
982
        lines.insert(2, eof_line)
983
984
985
        lang = '\n'.join(lines)
        parser = grammar_provider(lang)()
        st = parser("X := 1")
986
        assert not st.errors, str(st.errors)
987
988
        assert st.equals(st1)

989
990
        del lines[2]
        lines.insert(3, eof_line)
991
992
993
994
995
996
997
        lang = '\n'.join(lines)
        parser = grammar_provider(lang)()
        st = parser("X := 1")
        assert not st.errors
        assert st.equals(st1)

        # and, finally...
998
        lang_variant = r"""@literalws = right
999
1000
            document   = { definition } § EOF
            symbol     = /\w+/~