2.12.2021, 9:00 - 11:00: Due to updates GitLab may be unavailable for some minutes between 09:00 and 11:00.

parse.py 72.1 KB
Newer Older
1
# parse.py - parser combinators for DHParser
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
#
# Copyright 2016  by Eckhart Arnold (arnold@badw.de)
#                 Bavarian Academy of Sciences an Humanities (badw.de)
#
# 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 Arnold's avatar
Eckhart Arnold committed
17

18
19

"""
20
Module ``parse`` contains the python classes and functions for
21
22
DHParser's packrat-parser. It's central class is the
``Grammar``-class, which is the base class for any concrete
23
24
25
26
27
28
29
30
31
Grammar. Grammar-objects are callable and parsing is done by
calling a Grammar-object with a source text as argument.

The different parsing functions are callable descendants of class
``Parser``. Usually, they are organized in a tree and defined
within the namespace of a grammar-class. See ``ebnf.EBNFGrammar``
for an example.
"""

32

33
from collections import defaultdict
34
import copy
35
36
37
38

from DHParser.error import Error, linebreaks
from DHParser.log import is_logging, HistoryRecord
from DHParser.preprocess import BEGIN_TOKEN, END_TOKEN, RX_TOKEN_NAME
39
from DHParser.stringview import StringView, EMPTY_STRING_VIEW
40
from DHParser.syntaxtree import Node, RootNode, ParserBase, WHITESPACE_PTYPE, \
41
    TOKEN_PTYPE, ZOMBIE_PARSER
42
from DHParser.toolkit import sane_parser_name, escape_control_characters, re, typing
43
from typing import Callable, cast, Dict, DefaultDict, List, Set, Tuple, Union, Optional
44

45

46
__all__ = ('Parser',
47
           'UnknownParserError',
48
49
           'Grammar',
           'PreprocessorToken',
50
           'Token',
51
           'RegExp',
52
53
           'RE',
           'TKN',
54
           'Whitespace',
55
56
57
58
59
60
61
62
63
64
65
66
           'mixin_comment',
           # 'UnaryOperator',
           # 'NaryOperator',
           'Synonym',
           'Option',
           'ZeroOrMore',
           'OneOrMore',
           'Series',
           'Alternative',
           'AllOf',
           'SomeOf',
           'Unordered',
eckhart's avatar
eckhart committed
67
           'Required',
68
69
70
71
72
73
74
75
76
77
           'Lookahead',
           'NegativeLookahead',
           'Lookbehind',
           'NegativeLookbehind',
           'last_value',
           'counterpart',
           'accumulate',
           'Capture',
           'Retrieve',
           'Pop',
78
           'Forward')
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102


########################################################################
#
# Grammar and parsing infrastructure
#
########################################################################


LEFT_RECURSION_DEPTH = 8  # type: int
# because of python's recursion depth limit, this value ought not to be
# set too high. PyPy allows higher values than CPython
MAX_DROPOUTS = 3  # type: int
# stop trying to recover parsing after so many errors


def add_parser_guard(parser_func):
    """
    Add a wrapper function to a parser functions (i.e. Parser.__call__ method)
    that takes care of memoizing, left recursion and, optionally, tracing
    (aka "history tracking") of parser calls. Returns the wrapped call.
    """
    def guarded_call(parser: 'Parser', text: StringView) -> Tuple[Optional[Node], StringView]:
        try:
Eckhart Arnold's avatar
Eckhart Arnold committed
103
104
            grammar = parser.grammar
            location = grammar.document_length__ - len(text)
105

Eckhart Arnold's avatar
Eckhart Arnold committed
106
            if grammar.last_rb__loc__ >= location:
107
108
109
110
111
                grammar.rollback_to__(location)

            # if location has already been visited by the current parser,
            # return saved result
            if location in parser.visited:
112
                # no history recording in case of meomized results
113
114
115
116
117
118
119
120
                return parser.visited[location]

            if grammar.history_tracking__:
                grammar.call_stack__.append(parser)
                grammar.moving_forward__ = True

            # break left recursion at the maximum allowed depth
            if grammar.left_recursion_handling__:
121
                if parser.recursion_counter[location] > LEFT_RECURSION_DEPTH:
122
123
124
125
126
127
128
129
130
                    grammar.recursion_locations__.add(location)
                    return None, text
                parser.recursion_counter[location] += 1

            # run original __call__ method
            node, rest = parser_func(parser, text)

            if grammar.left_recursion_handling__:
                parser.recursion_counter[location] -= 1
131
                # don't clear recursion_locations__ !!!
132
133
134
135
136
137
138
139
140
141
142
143

            if node is None:
                # retrieve an earlier match result (from left recursion) if it exists
                if location in grammar.recursion_locations__:
                    if location in parser.visited:
                        node, rest = parser.visited[location]
                        # TODO: maybe add a warning about occurrence of left-recursion here?
                    # don't overwrite any positive match (i.e. node not None) in the cache
                    # and don't add empty entries for parsers returning from left recursive calls!
                elif grammar.memoization__:
                    # otherwise also cache None-results
                    parser.visited[location] = (None, rest)
eckhart's avatar
eckhart committed
144
            else:
145
                assert node._pos < 0
Eckhart Arnold's avatar
Eckhart Arnold committed
146
147
148
                node._pos = location
                assert node._pos >= 0, str("%i < %i" % (grammar.document_length__, location))
                if (grammar.last_rb__loc__ < location
eckhart's avatar
eckhart committed
149
150
151
152
153
154
                        and (grammar.memoization__ or location in grammar.recursion_locations__)):
                    # - variable manipulating parsers will not be entered into the cache,
                    #   because caching would interfere with changes of variable state
                    # - in case of left recursion, the first recursive step that
                    #   matches will store its result in the cache
                    parser.visited[location] = (node, rest)
155

156
            # Mind that meomized parser calls will not appear in the history record!
157
158
            if grammar.history_tracking__:
                # don't track returning parsers except in case an error has occurred
159
                # remaining = len(rest)
di68kap's avatar
di68kap committed
160
                if (grammar.moving_forward__ or (node and node.errors)):
161
162
163
164
165
166
167
168
                    record = HistoryRecord(grammar.call_stack__, node, text)
                    grammar.history__.append(record)
                    # print(record.stack, record.status, rest[:20].replace('\n', '|'))
                grammar.moving_forward__ = False
                grammar.call_stack__.pop()

        except RecursionError:
            node = Node(None, str(text[:min(10, max(1, text.find("\n")))]) + " ...")
169
            node._pos = location
eckhart's avatar
eckhart committed
170
            grammar.tree__.new_error(node, "maximum recursion depth of parser reached; "
171
                                     "potentially due to too many errors!")
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
            rest = EMPTY_STRING_VIEW

        return node, rest

    return guarded_call


class Parser(ParserBase):
    """
    (Abstract) Base class for Parser combinator parsers. Any parser
    object that is actually used for parsing (i.e. no mock parsers)
    should should be derived from this class.

    Since parsers can contain other parsers (see classes UnaryOperator
    and NaryOperator) they form a cyclical directed graph. A root
    parser is a parser from which all other parsers can be reached.
    Usually, there is one root parser which serves as the starting
    point of the parsing process. When speaking of "the root parser"
    it is this root parser object that is meant.

    There are two different types of parsers:

    1. *Named parsers* for which a name is set in field `parser.name`.
       The results produced by these parsers can later be retrieved in
       the AST by the parser name.

    2. *Anonymous parsers* where the name-field just contains the empty
       string. AST-transformation of Anonymous parsers can be hooked
       only to their class name, and not to the individual parser.

    Parser objects are callable and parsing is done by calling a parser
    object with the text to parse.

    If the parser matches it returns a tuple consisting of a node
    representing the root of the concrete syntax tree resulting from the
    match as well as the substring `text[i:]` where i is the length of
    matched text (which can be zero in the case of parsers like
    `ZeroOrMore` or `Option`). If `i > 0` then the parser has "moved
    forward".

    If the parser does not match it returns `(None, text). **Note** that
    this is not the same as an empty match `("", text)`. Any empty match
    can for example be returned by the `ZeroOrMore`-parser in case the
    contained parser is repeated zero times.

    Attributes and Properties:
        visited:  Mapping of places this parser has already been to
                during the current parsing process onto the results the
                parser returned at the respective place. This dictionary
                is used to implement memoizing.

        recursion_counter:  Mapping of places to how often the parser
                has already been called recursively at this place. This
                is needed to implement left recursion. The number of
                calls becomes irrelevant once a resault has been memoized.

        cycle_detection:  The apply()-method uses this variable to make
                sure that one and the same function will not be applied
                (recursively) a second time, if it has already been
                applied to this parser.

        grammar:  A reference to the Grammar object to which the parser
                is attached.
    """

    ApplyFunc = Callable[['Parser'], None]

239
    def __init__(self) -> None:
240
        # assert isinstance(name, str), str(name)
241
        super().__init__()
eckhart's avatar
eckhart committed
242
        self._grammar = None  # type: Optional['Grammar']
243
244
245
246
        self.reset()

        # add "aspect oriented" wrapper around parser calls
        # for memoizing, left recursion and tracing
di68kap's avatar
di68kap committed
247
        if not isinstance(self, Forward):  # should Forward-Parser not be guarded? Not sure...
248
249
250
251
252
253
            guarded_parser_call = add_parser_guard(self.__class__.__call__)
            # The following check is necessary for classes that don't override
            # the __call__() method, because in these cases the non-overridden
            # __call__()-method would be substituted a second time!
            if self.__class__.__call__.__code__ != guarded_parser_call.__code__:
                self.__class__.__call__ = guarded_parser_call
254
255
256
257
258
259
260
261

    def __deepcopy__(self, memo):
        """Deepcopy method of the parser. Upon instantiation of a Grammar-
        object, parsers will be deep-copied to the Grammar object. If a
        derived parser-class changes the signature of the constructor,
        `__deepcopy__`-method must be replaced (i.e. overridden without
        calling the same method from the superclass) by the derived class.
        """
262
263
        duplicate = self.__class__()
        duplicate.name = self.name
264
        duplicate.ptype =   self.ptype
265
        return duplicate
266
267
268
269
270

    def reset(self):
        """Initializes or resets any parser variables. If overwritten,
        the `reset()`-method of the parent class must be called from the
        `reset()`-method of the derived class."""
271
272
273
        self.visited = dict()  # type: Dict[int, Tuple[Optional[Node], StringView]]
        self.recursion_counter = defaultdict(lambda :0)  # type: DefaultDict[int, int]
        self.cycle_detection = set()  # type: Set[Callable]
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

    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
        """Applies the parser to the given `text` and returns a node with
        the results or None as well as the text at the position right behind
        the matching string."""
        return None, text  # default behaviour: don't match

    def __add__(self, other: 'Parser') -> 'Series':
        """The + operator generates a series-parser that applies two
        parsers in sequence."""
        return Series(self, other)

    def __or__(self, other: 'Parser') -> 'Alternative':
        """The | operator generates an alternative parser that applies
        the first parser and, if that does not match, the second parser.
        """
        return Alternative(self, other)

    @property
    def grammar(self) -> 'Grammar':
        return self._grammar

    @grammar.setter
    def grammar(self, grammar: 'Grammar'):
        if self._grammar is None:
            self._grammar = grammar
            self._grammar_assigned_notifier()
        else:
            assert self._grammar == grammar, \
                "Parser has already been assigned to a different Grammar object!"

    def _grammar_assigned_notifier(self):
        """A function that notifies the parser object that it has been
        assigned to a grammar."""
        pass

    def apply(self, func: ApplyFunc) -> bool:
        """
        Applies function `func(parser)` recursively to this parser and all
        descendant parsers if any exist. The same function can never
        be applied twice between calls of the ``reset()``-method!
        Returns `True`, if function has been applied, `False` if function
        had been applied earlier already and thus has not been applied again.
        """
        if func in self.cycle_detection:
            return False
        else:
            assert not self.visited, "No calls to Parser.apply() during or " \
                                     "after ongoing parsing process. (Call Parser.reset() first.)"
            self.cycle_detection.add(func)
            func(self)
            return True


def mixin_comment(whitespace: str, comment: str) -> str:
    """
    Returns a regular expression that merges comment and whitespace
    regexps. Thus comments cann occur whereever whitespace is allowed
    and will be skipped just as implicit whitespace.

    Note, that because this works on the level of regular expressions,
    nesting comments is not possible. It also makes it much harder to
    use directives inside comments (which isn't recommended, anyway).
    """
    wspc = '(?:' + whitespace + '(?:' + comment + whitespace + ')*)'
    return wspc


342
class UnknownParserError(KeyError):
eckhart's avatar
eckhart committed
343
    """UnknownParserError is raised if a Grammar object is called with a
344
    parser that does not exist or if in the course of parsing a parser
eckhart's avatar
eckhart committed
345
    is referred to that does not exist."""
346
347


348
349
350
351
352
353
354
355
356
357
358
359
360
class Grammar:
    r"""
    Class Grammar directs the parsing process and stores global state
    information of the parsers, i.e. state information that is shared
    accross parsers.

    Grammars are basically collections of parser objects, which are
    connected to an instance object of class Grammar. There exist two
    ways of connecting parsers to grammar objects: Either by passing
    the root parser object to the constructor of a Grammar object
    ("direct instantiation"), or by assigning the root parser to the
    class variable "root__" of a descendant class of class Grammar.

eckhart's avatar
eckhart committed
361
    Example for direct instantiation of a grammar::
362

363
        >>> number = RE('\d+') + RE('\.') + RE('\d+') | RE('\d+')
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
        >>> number_parser = Grammar(number)
        >>> number_parser("3.1416").content
        '3.1416'

    Collecting the parsers that define a grammar in a descendant class of
    class Grammar and assigning the named parsers to class variables
    rather than global variables has several advantages:

    1. It keeps the namespace clean.

    2. The parser names of named parsers do not need to be passed to the
       constructor of the Parser object explicitly, but it suffices to
       assign them to class variables, which results in better
       readability of the Python code.

    3. The parsers in the class do not necessarily need to be connected
       to one single root parser, which is helpful for testing and
       building up a parser successively of several components.

    As a consequence, though, it is highly recommended that a Grammar
    class should not define any other variables or methods with names
    that are legal parser names. A name ending with a double
    underscore '__' is *not* a legal parser name and can safely be
    used.

389
    Example::
390
391
392
393
394
395
396
397
398

        class Arithmetic(Grammar):
            # special fields for implicit whitespace and comment configuration
            COMMENT__ = r'#.*(?:\n|$)'  # Python style comments
            wspR__ = mixin_comment(whitespace=r'[\t ]*', comment=COMMENT__)

            # parsers
            expression = Forward()
            INTEGER = RE('\\d+')
399
400
401
            factor = INTEGER | TKN("(") + expression + TKN(")")
            term = factor + ZeroOrMore((TKN("*") | TKN("/")) + factor)
            expression.set(term + ZeroOrMore((TKN("+") | TKN("-")) + term))
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
            root__ = expression

    Upon instantiation the parser objects are deep-copied to the
    Grammar object and assigned to object variables of the same name.
    Any parser that is directly assigned to a class variable is a
    'named' parser and its field `parser.name` contains the variable
    name after instantiation of the Grammar class. All other parsers,
    i.e. parsers that are defined within a `named` parser, remain
    "anonymous parsers" where `parser.name` is the empty string, unless
    a name has been passed explicitly upon instantiation.
    If one and the same parser is assigned to several class variables
    such as, for example the parser `expression` in the example above,
    the first name sticks.

    Grammar objects are callable. Calling a grammar object with a UTF-8
    encoded document, initiates the parsing of the document with the
    root parser. The return value is the concrete syntax tree. Grammar
    objects can be reused (i.e. called again) after parsing. Thus, it
    is not necessary to instantiate more than one Grammar object per
    thread.

    Grammar classes contain a few special class fields for implicit
    whitespace and comments that should be overwritten, if the defaults
    (no comments, horizontal right aligned whitespace) don't fit:

427
428
429
430
431
    Attributes:
        root__:  The root parser of the grammar. Theoretically, all parsers of the
                 grammar should be reachable by the root parser. However, for testing
                 of yet incomplete grammars class Grammar does not assume that this
                 is the case.
432

433
434
435
436
437
        parser_initializiation__:  Before the parser class (!) has been initialized,
                 which happens upon the first time it is instantiated (see
                 :func:_assign_parser_names()` for an explanation), this class
                 field contains a value other than "done". A value of "done" indicates
                 that the class has already been initialized.
438

eckhart's avatar
eckhart committed
439
440
441
442
        python__src__:  For the purpose of debugging and inspection, this field can
                 take the python src of the concrete grammar class
                 (see `dsl.grammar_provider`).

443
444
445
446
447
448
449
450
451
452
453
454
455
    Attributes:
        all_parsers__:  A set of all parsers connected to this grammar object

        history_tracking__:  A flag indicating that the parsing history shall
                be tracked

        _dirty_flag__:  A flag indicating that the Grammar has been called at
                least once so that the parsing-variables need to be reset
                when it is called again.

        document__:  the text that has most recently been parsed or that is
                currently being parsed.

eckhart's avatar
eckhart committed
456
457
        document_length__:  the length of the document.

458
459
460
        document_lbreaks__:  list of linebreaks within the document, starting
                with -1 and ending with EOF. This helps generating line
                and column number for history recording and will only be
461
                initialized if :attr:`history_tracking__` is true.
462

463
464
465
466
467
        tree__: The root-node of the parsing tree. This variable is available
               for error-reporting already during parsing  via
               ``self.grammar.tree__.add_error``, but it references the full
               parsing tree only after parsing has been finished.

468
        _reversed__:  the same text in reverse order - needed by the `Lookbehind`-
469
470
471
                parsers.

        variables__:  A mapping for variable names to a stack of their respective
472
473
                string values - needed by the :class:`Capture`-, :class:`Retrieve`-
                and :class:`Pop`-parsers.
474
475

        rollback__:  A list of tuples (location, rollback-function) that are
476
477
478
479
                deposited by the :class:`Capture`- and :class:`Pop`-parsers.
                If the parsing process reaches a dead end then all
                rollback-functions up to the point to which it retreats will be
                called and the state of the variable stack restored accordingly.
480
481
482

        last_rb__loc__:  The last, i.e. most advanced location in the text
                where a variable changing operation occurred. If the parser
483
484
                backtracks to a location at or before last_rb__loc__ (i.e.
                location <= last_rb__loc__) then a rollback of all variable
485
486
                changing operations is necessary that occurred after the
                location to which the parser backtracks. This is done by
487
                calling method :func:`rollback_to__(location)`.
488
489
490
491
492
493
494
495
496
497
498
499
500

        call_stack__:  A stack of all parsers that have been called. This
                is required for recording the parser history (for debugging)
                and, eventually, i.e. one day in the future, for tracing through
                the parsing process.

        history__:  A list of parser-call-stacks. A parser-call-stack is
                appended to the list each time a parser either matches, fails
                or if a parser-error occurs.

        moving_forward__: This flag indicates that the parsing process is currently
                moving forward . It is needed to reduce noise in history recording
                and should not be considered as having a valid value if history
501
502
                recording is turned off! (See :func:`add_parser_guard` and its local
                function :func:`guarded_call`)
503
504
505
506

        recursion_locations__:  Stores the locations where left recursion was
                detected. Needed to provide minimal memoization for the left
                recursion detection algorithm, but, strictly speaking, superfluous
507
508
                if full memoization is enabled. (See :func:`add_parser_guard` and its
                local function :func:`guarded_call`)
509
510
511
512
513
514
515
516
517
518

        memoization__:  Turns full memoization on or off. Turning memoization off
                results in less memory usage and sometimes reduced parsing time.
                In some situations it may drastically increase parsing time, so
                it is safer to leave it on. (Default: on)

        left_recursion_handling__:  Turns left recursion handling on or off.
                If turned off, a recursion error will result in case of left
                recursion.
    """
eckhart's avatar
eckhart committed
519
    python_src__ = ''  # type: str
520
521
522
523
    root__ = ZOMBIE_PARSER  # type: ParserBase
    # root__ must be overwritten with the root-parser by grammar subclass
    parser_initialization__ = "pending"  # type: str
    # some default values
524
525
    # COMMENT__ = r''  # type: str  # r'#.*(?:\n|$)'
    # WSP_RE__ = mixin_comment(whitespace=r'[\t ]*', comment=COMMENT__)  # type: str
526
527
528
529
530
531
532


    @classmethod
    def _assign_parser_names__(cls):
        """
        Initializes the `parser.name` fields of those
        Parser objects that are directly assigned to a class field with
533
        the field's name, e.g.::
534

535
536
            class Grammar(Grammar):
                ...
537
                symbol = RE('(?!\\d)\\w+')
538

di68kap's avatar
di68kap committed
539
540
541
        After the call of this method symbol.name == "symbol" holds.
        Parser names starting or ending with a double underscore like
        ``root__`` will be ignored. See :func:`sane_parser_name()`
542
543
544
545
546
547
548
549
550
551
552
553
554
555

        This is done only once, upon the first instantiation of the
        grammar class!

        Attention: If there exists more than one reference to the same
        parser, only the first one will be chosen for python versions
        greater or equal 3.6.  For python version <= 3.5 an arbitrarily
        selected reference will be chosen. See PEP 520
        (www.python.org/dev/peps/pep-0520/) for an explanation of why.
        """
        if cls.parser_initialization__ != "done":
            cdict = cls.__dict__
            for entry, parser in cdict.items():
                if isinstance(parser, Parser) and sane_parser_name(entry):
di68kap's avatar
di68kap committed
556
557
558
559
                    if isinstance(parser, Forward):
                        if  not cast(Forward, parser).parser.name:
                            cast(Forward, parser).parser.name = entry
                    else:   # if not parser.name:
560
                        parser.name = entry
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
            cls.parser_initialization__ = "done"


    def __init__(self, root: Parser = None) -> None:
        # if not hasattr(self.__class__, 'parser_initialization__'):
        #     self.__class__.parser_initialization__ = "pending"
        # if not hasattr(self.__class__, 'wspL__'):
        #     self.wspL__ = ''
        # if not hasattr(self.__class__, 'wspR__'):
        #     self.wspR__ = ''
        self.all_parsers__ = set()             # type: Set[ParserBase]
        self._dirty_flag__ = False             # type: bool
        self.history_tracking__ = False        # type: bool
        self.memoization__ = True              # type: bool
        self.left_recursion_handling__ = True  # type: bool
        self._reset__()

        # prepare parsers in the class, first
        self._assign_parser_names__()

        # then deep-copy the parser tree from class to instance;
        # parsers not connected to the root object will be copied later
        # on demand (see Grammar.__getitem__()). Usually, the need to
        # do so only arises during testing.
        self.root__ = copy.deepcopy(root) if root else copy.deepcopy(self.__class__.root__)
        self.root__.apply(self._add_parser__)


    def __getitem__(self, key):
        try:
            return self.__dict__[key]
        except KeyError:
            parser_template = getattr(self, key, None)
            if parser_template:
                # add parser to grammar object on the fly...
                parser = copy.deepcopy(parser_template)
                parser.apply(self._add_parser__)
                # assert self[key] == parser
                return self[key]
600
            raise UnknownParserError('Unknown parser "%s" !' % key)
601
602
603


    def _reset__(self):
604
        self.tree__ = RootNode()              # type: RootNode
605
606
        self.document__ = EMPTY_STRING_VIEW   # type: StringView
        self._reversed__ = EMPTY_STRING_VIEW  # type: StringView
eckhart's avatar
eckhart committed
607
        self.document_length__ = 0            # type: int
608
609
        self.document_lbreaks__ = []          # type: List[int]
        # variables stored and recalled by Capture and Retrieve parsers
610
        self.variables__ = defaultdict(lambda :[])  # type: DefaultDict[str, List[str]]
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
        self.rollback__ = []                  # type: List[Tuple[int, Callable]]
        self.last_rb__loc__ = -1              # type: int
        # support for call stack tracing
        self.call_stack__ = []                # type: List[Parser]
        # snapshots of call stacks
        self.history__ = []                   # type: List[HistoryRecord]
        # also needed for call stack tracing
        self.moving_forward__ = False         # type: bool
        self.recursion_locations__ = set()    # type: Set[int]


    @property
    def reversed__(self) -> StringView:
        """
        Returns a reversed version of the currently parsed document. As
        about the only case where this is needed is the Lookbehind-parser,
        this is done lazily.
        """
        if not self._reversed__:
            self._reversed__ = StringView(self.document__.text[::-1])
        return self._reversed__


    def _add_parser__(self, parser: Parser) -> None:
        """
        Adds the particular copy of the parser object to this
        particular instance of Grammar.
        """
        if parser.name:
            # prevent overwriting instance variables or parsers of a different class
            assert parser.name not in self.__dict__ or \
642
                isinstance(self.__dict__[parser.name], parser.__class__), \
643
                ('Cannot add parser "%s" because a field with the same name '
di68kap's avatar
di68kap committed
644
645
                 'already exists in grammar object: %s!'
                 % (parser.name, str(self.__dict__[parser.name])))
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
            setattr(self, parser.name, parser)
        self.all_parsers__.add(parser)
        parser.grammar = self


    def __call__(self, document: str, start_parser="root__") -> Node:
        """
        Parses a document with with parser-combinators.

        Args:
            document (str): The source text to be parsed.
            start_parser (str): The name of the parser with which to
                start. This is useful for testing particular parsers
                (i.e. particular parts of the EBNF-Grammar.)
        Returns:
            Node: The root node ot the parse tree.
        """
663
664

        def tail_pos(predecessors: Union[List[Node], Tuple[Node, ...]]) -> int:
eckhart's avatar
eckhart committed
665
666
            """Adds the position after the last node in the list of
            predecessors to the node."""
eckhart's avatar
eckhart committed
667
            return predecessors[-1].pos + len(predecessors[-1]) if predecessors else 0
eckhart's avatar
eckhart committed
668

669
670
671
672
673
674
675
676
677
678
679
        # assert isinstance(document, str), type(document)
        if self.root__ is None:
            raise NotImplementedError()
        if self._dirty_flag__:
            self._reset__()
            for parser in self.all_parsers__:
                parser.reset()
        else:
            self._dirty_flag__ = True
        self.history_tracking__ = is_logging()
        self.document__ = StringView(document)
eckhart's avatar
eckhart committed
680
        self.document_length__ = len(self.document__)
681
        self.document_lbreaks__ = linebreaks(document) if self.history_tracking__ else []
Eckhart Arnold's avatar
Eckhart Arnold committed
682
        self.last_rb__loc__ = -1  # rollback location
683
684
685
686
687
688
689
690
691
        parser = self[start_parser] if isinstance(start_parser, str) else start_parser
        assert parser.grammar == self, "Cannot run parsers from a different grammar object!" \
                                       " %s vs. %s" % (str(self), str(parser.grammar))
        result = None  # type: Optional[Node]
        stitches = []  # type: List[Node]
        rest = self.document__
        if not rest:
            result, _ = parser(rest)
            if result is None:
eckhart's avatar
eckhart committed
692
                result = Node(None, '').init_pos(0)
eckhart's avatar
eckhart committed
693
                self.tree__.new_error(result,
694
                                      'Parser "%s" did not match empty document.' % str(parser))
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
        while rest and len(stitches) < MAX_DROPOUTS:
            result, rest = parser(rest)
            if rest:
                fwd = rest.find("\n") + 1 or len(rest)
                skip, rest = rest[:fwd], rest[fwd:]
                if result is None:
                    error_msg = 'Parser did not match! Invalid source file?' \
                                '\n    Most advanced: %s\n    Last match:    %s;' % \
                                (str(HistoryRecord.most_advanced_match(self.history__)),
                                 str(HistoryRecord.last_match(self.history__)))
                else:
                    stitches.append(result)
                    error_msg = "Parser stopped before end" + \
                                (("! trying to recover" +
                                  (" but stopping history recording at this point."
                                   if self.history_tracking__ else "..."))
                                 if len(stitches) < MAX_DROPOUTS
                                 else " too often! Terminating parser.")
eckhart's avatar
eckhart committed
713
                stitches.append(Node(None, skip).init_pos(tail_pos(stitches)))
eckhart's avatar
eckhart committed
714
                self.tree__.new_error(stitches[-1], error_msg)
715
                if self.history_tracking__:
eckhart's avatar
eckhart committed
716
717
718
719
720
721
722
                    # # some parsers may have matched and left history records with nodes != None.
                    # # Because these are not connected to the stitched root node, their pos-
                    # # properties will not be initialized by setting the root node's pos property
                    # # to zero. Therefore, their pos properties need to be initialized here
                    # for record in self.history__:
                    #     if record.node and record.node._pos < 0:
                    #         record.node.init_pos(0)
723
724
725
726
727
728
                    record = HistoryRecord(self.call_stack__.copy(), stitches[-1], rest)
                    self.history__.append(record)
                    # stop history tracking when parser returned too early
                    self.history_tracking__ = False
        if stitches:
            if rest:
Eckhart Arnold's avatar
Eckhart Arnold committed
729
730
                stitches.append(Node(None, rest))
            result = Node(None, tuple(stitches)).init_pos(0)
731
        if any(self.variables__.values()):
732
733
            error_str = "Capture-retrieve-stack not empty after end of parsing: " \
                + str(self.variables__)
734
735
736
737
738
            if result:
                if result.children:
                    # add another child node at the end to ensure that the position
                    # of the error will be the end of the text. Otherwise, the error
                    # message above ("...after end of parsing") would appear illogical.
eckhart's avatar
eckhart committed
739
                    error_node = Node(ZOMBIE_PARSER, '').init_pos(tail_pos(result.children))
eckhart's avatar
eckhart committed
740
                    self.tree__.new_error(error_node, error_str)
eckhart's avatar
eckhart committed
741
                    result.result = result.children + (error_node,)
742
                else:
eckhart's avatar
eckhart committed
743
                    self.tree__.new_error(result, error_str)
eckhart's avatar
eckhart committed
744
        # result.pos = 0  # calculate all positions
745
        # result.collect_errors(self.document__)
746
747
        self.tree__.swallow(result)
        return self.tree__
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765


    def push_rollback__(self, location, func):
        """
        Adds a rollback function that either removes or re-adds
        values on the variable stack (`self.variables`) that have been
        added (or removed) by Capture or Pop Parsers, the results of
        which have been dismissed.
        """
        self.rollback__.append((location, func))
        self.last_rb__loc__ = location


    def rollback_to__(self, location):
        """
        Rolls back the variable stacks (`self.variables`) to its
        state at an earlier location in the parsed document.
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
766
        while self.rollback__ and self.rollback__[-1][0] >= location:
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
            _, rollback_func = self.rollback__.pop()
            # assert not loc > self.last_rb__loc__, \
            #     "Rollback confusion: line %i, col %i < line %i, col %i" % \
            #     (*line_col(self.document__, len(self.document__) - loc),
            #      *line_col(self.document__, len(self.document__) - self.last_rb__loc__))
            rollback_func()
        self.last_rb__loc__ == self.rollback__[-1][0] if self.rollback__ \
            else (len(self.document__) + 1)


def dsl_error_msg(parser: Parser, error_str: str) -> str:
    """
    Returns an error message for errors in the parser configuration,
    e.g. errors that result in infinite loops.

    Args:
        parser (Parser):  The parser where the error was noticed. Note
            that this is not necessarily the parser that caused the
            error but only where the error became apparent.
        error_str (str):  A short string describing the error.
    Returns:
        str: An error message including the call stack if history
        tacking has been turned in the grammar object.
    """
    msg = ["DSL parser specification error:", error_str, 'Caught by parser "%s".' % str(parser)]
    if parser.grammar.history__:
        msg.extend(["\nCall stack:", parser.grammar.history__[-1].stack])
    else:
        msg.extend(["\nEnable history tracking in Grammar object to display call stack."])
    return " ".join(msg)


########################################################################
#
801
# _Token and Regular Expression parser classes (i.e. leaf classes)
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
#
########################################################################


class PreprocessorToken(Parser):
    """
    Parses tokens that have been inserted by a preprocessor.

    Preprocessors can generate Tokens with the ``make_token``-function.
    These tokens start and end with magic characters that can only be
    matched by the PreprocessorToken Parser. Such tokens can be used to
    insert BEGIN - END delimiters at the beginning or ending of a
    quoted block, for example.
    """

    def __init__(self, token: str) -> None:
        assert token and token.isupper()
819
        assert RX_TOKEN_NAME.match(token)
820
821
        super().__init__()
        self.name = token
822

823
824
825
    def __deepcopy__(self, memo):
        duplicate = self.__class__(self.name)
        duplicate.name = self.name
826
        duplicate.ptype =   self.ptype
827
828
        return duplicate

829
830
831
832
    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
        if text[0:1] == BEGIN_TOKEN:
            end = text.find(END_TOKEN, 1)
            if end < 0:
833
                node = Node(self, '')
eckhart's avatar
eckhart committed
834
                self.grammar.tree__.new_error(node,
835
836
                    'END_TOKEN delimiter missing from preprocessor token. '
                    '(Most likely due to a preprocessor bug!)')  # type: Node
837
                return node, text[1:]
838
            elif end == 0:
839
                node = Node(self, '')
eckhart's avatar
eckhart committed
840
                self.grammar.tree__.new_error(node,
841
842
                    'Preprocessor-token cannot have zero length. '
                    '(Most likely due to a preprocessor bug!)')
843
                return node, text[2:]
844
845
            elif text.find(BEGIN_TOKEN, 1, end) >= 0:
                node = Node(self, text[len(self.name) + 1:end])
eckhart's avatar
eckhart committed
846
                self.grammar.tree__.new_error(node,
847
848
849
850
851
                    'Preprocessor-tokens must not be nested or contain '
                    'BEGIN_TOKEN delimiter as part of their argument. '
                    '(Most likely due to a preprocessor bug!)')
                return node, text[end:]
            if text[1:len(self.name) + 1] == self.name:
852
                return Node(self, text[len(self.name) + 2:end]), text[end + 1:]
853
854
855
        return None, text


856
class Token(Parser):
eckhart's avatar
eckhart committed
857
    """
858
    Parses plain text strings. (Could be done by RegExp as well, but is faster.)
eckhart's avatar
eckhart committed
859

eckhart's avatar
eckhart committed
860
861
    Example::

862
        >>> while_token = Token("while")
eckhart's avatar
eckhart committed
863
864
        >>> Grammar(while_token)("while").content
        'while'
eckhart's avatar
eckhart committed
865
    """
866
    assert TOKEN_PTYPE == ":Token"
eckhart's avatar
eckhart committed
867

868
869
    def __init__(self, text: str) -> None:
        super().__init__()
eckhart's avatar
eckhart committed
870
        self.text = text
871
        self.len = len(text)
eckhart's avatar
eckhart committed
872
873

    def __deepcopy__(self, memo):
874
875
        duplicate = self.__class__(self.text)
        duplicate.name = self.name
876
        duplicate.ptype = self.ptype
877
        return duplicate
eckhart's avatar
eckhart committed
878
879
880

    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
        if text.startswith(self.text):
881
            return Node(self, self.text, True), text[self.len:]
eckhart's avatar
eckhart committed
882
883
        return None, text

884
885
886
    def __repr__(self):
        return ("'%s'" if self.text.find("'") <= 0 else '"%s"') % self.text

eckhart's avatar
eckhart committed
887

888
889
890
891
892
893
894
895
896
class RegExp(Parser):
    r"""
    Regular expression parser.

    The RegExp-parser parses text that matches a regular expression.
    RegExp can also be considered as the "atomic parser", because all
    other parsers delegate part of the parsing job to other parsers,
    but do not match text directly.

897
898
899
900
901
    Example::

        >>> word = RegExp(r'\w+')
        >>> Grammar(word)("Haus").content
        'Haus'
902

903
    EBNF-Notation:  ``/ ... /``
904

905
    EBNF-Example:   ``word = /\w+/``
906
907
    """

908
909
    def __init__(self, regexp) -> None:
        super().__init__()
910
911
912
913
914
915
916
917
        self.regexp = re.compile(regexp) if isinstance(regexp, str) else regexp

    def __deepcopy__(self, memo):
        # `regex` supports deep copies, but not `re`
        try:
            regexp = copy.deepcopy(self.regexp, memo)
        except TypeError:
            regexp = self.regexp.pattern
918
919
        duplicate = self.__class__(regexp)
        duplicate.name = self.name
920
        duplicate.ptype =   self.ptype
921
        return duplicate
922
923

    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
924
925
926
927
        match = text.match(self.regexp)
        if match:
            capture = match.group(0)
            end = text.index(match.end())
928
929
            # regular expression must never match preprocessor-tokens!
            # TODO: Find a better solution here? e.g. static checking/re-mangling at compile time
930
931
932
933
934
            i = capture.find(BEGIN_TOKEN)
            if i >= 0:
                capture = capture[:i]
                end = i
            return Node(self, capture, True), text[end:]
935
936
937
        return None, text

    def __repr__(self):
938
        return escape_control_characters('/%s/' % self.regexp.pattern)
939
940


941
942
def withWS(parser_factory, wsL='', wsR='\s*'):
    """Syntactic Sugar for 'Series(Whitespace(wsL), parser_factory(), Whitespace(wsR))'.
943
    """
944
945
946
947
948
949
950
951
952
953
954
955
    if wsL and isinstance(wsL, str):
        wsL = Whitespace(wsL)
    if wsR and isinstance(wsR, str):
        wsR = Whitespace(wsR)
    if wsL and wsR:
        return Series(wsL, parser_factory(), wsR)
    elif wsL:
        return Series(wsL, parser_factory())
    elif wsR:
        return Series(parser_factory(), wsR)
    else:
        return parser_factory()
956

957

958
959
960
def RE(regexp, wsL='', wsR='\s*'):
    """Syntactic Sugar for 'Series(Whitespace(wsL), RegExp(regexp), Whitespace(wsR))'"""
    return withWS(lambda : RegExp(regexp), wsL, wsR)
961
962


963
964
965
def TKN(token, wsL='', wsR='\s*'):
    """Syntactic Sugar for 'Series(Whitespace(wsL), Token(token), Whitespace(wsR))'"""
    return withWS(lambda: Token(token), wsL, wsR)
966
967


968
969
970
971
class Whitespace(RegExp):
    """An variant of RegExp that signifies through its class name that it
    is a RegExp-parser for whitespace."""
    assert WHITESPACE_PTYPE == ":Whitespace"
eckhart's avatar
eckhart committed
972

973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992

########################################################################
#
# Containing parser classes, i.e. parsers that contain other parsers
# to which they delegate parsing
#
########################################################################


class UnaryOperator(Parser):
    """
    Base class of all unary parser operators, i.e. parser that contains
    one and only one other parser, like the optional parser for example.

    The UnaryOperator base class supplies __deepcopy__ and apply
    methods for unary parser operators. The __deepcopy__ method needs
    to be overwritten, however, if the constructor of a derived class
    has additional parameters.
    """

993
994
    def __init__(self, parser: Parser) -> None:
        super(UnaryOperator, self).__init__()
995
996
997
998
999
        assert isinstance(parser, Parser), str(parser)
        self.parser = parser  # type: Parser

    def __deepcopy__(self, memo):
        parser = copy.deepcopy(self.parser, memo)
1000
1001
        duplicate = self.__class__(parser)
        duplicate.name = self.name
1002
        duplicate.ptype =   self.ptype
1003
        return duplicate
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023

    def apply(self, func: Parser.ApplyFunc) -> bool:
        if super().apply(func):
            self.parser.apply(func)
            return True
        return False


class NaryOperator(Parser):
    """
    Base class of all Nnary parser operators, i.e. parser that
    contains one or more other parsers, like the alternative
    parser for example.

    The NnaryOperator base class supplies __deepcopy__ and apply methods
    for unary parser operators. The __deepcopy__ method needs to be
    overwritten, however, if the constructor of a derived class has
    additional parameters.
    """

1024
1025
    def __init__(self, *parsers: Parser) -> None:
        super().__init__()
1026
1027
1028
1029
1030
        assert all([isinstance(parser, Parser) for parser in parsers]), str(parsers)
        self.parsers = parsers  # type: Tuple[Parser, ...]

    def __deepcopy__(self, memo):
        parsers = copy.deepcopy(self.parsers, memo)
1031
1032
        duplicate = self.__class__(*parsers)
        duplicate.name = self.name
1033
        duplicate.ptype =   self.ptype
1034
        return duplicate
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045

    def apply(self, func: Parser.ApplyFunc) -> bool:
        if super().apply(func):
            for parser in self.parsers:
                parser.apply(func)
            return True
        return False


class Option(UnaryOperator):
    r"""
1046
    Parser ``Option`` always matches, even if its child-parser
1047
1048
    did not match.

1049
    If the child-parser did not match ``Option`` returns a node
1050
1051
    with no content and does not move forward in the text.

1052
    If the child-parser did match, ``Option`` returns the a node
eckhart's avatar
eckhart committed
1053
    with the node returned by the child-parser as its single
1054
1055
1056
    child and the text at the position where the child-parser
    left it.

1057
1058
    Examples::

1059
        >>> number = Option(TKN('-')) + RegExp(r'\d+') + Option(RegExp(r'\.\d+'))
1060
1061
1062
1063
1064
1065
        >>> Grammar(number)('3.14159').content
        '3.14159'
        >>> Grammar(number)('3.14159').structure
        '(:Series (:Option) (:RegExp "3") (:Option (:RegExp ".14159")))'
        >>> Grammar(number)('-1').content
        '-1'
1066

1067
    EBNF-Notation: ``[ ... ]``
1068

1069
    EBNF-Example:  ``number = ["-"]  /\d+/  [ /\.\d+/ ]``
1070
1071
    """

1072
1073
    def __init__(self, parser: Parser) -> None:
        super().__init__(parser)
1074
1075
        # assert isinstance(parser, Parser)
        assert not isinstance(parser, Option), \
di68kap's avatar
di68kap committed
1076
            "Redundant nesting of options: %s" % (str(self.ptype), str(parser.name))
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094

    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
        node, text = self.parser(text)
        if node:
            return Node(self, node), text
        return Node(self, ()), text

    def __repr__(self):
        return '[' + (self.parser.repr[1:-1] if isinstance(self.parser, Alternative)
                      and not self.parser.name else self.parser.repr) + ']'


class ZeroOrMore(Option):
    r"""
    `ZeroOrMore` applies a parser repeatedly as long as this parser
    matches. Like `Option` the `ZeroOrMore` parser always matches. In
    case of zero repetitions, the empty match `((), text)` is returned.

1095
1096
    Examples::

1097
        >>> sentence = ZeroOrMore(RE(r'\w+,?')) + TKN('.')
1098
1099
1100
1101
        >>> Grammar(sentence)('Wo viel der Weisheit, da auch viel des Grämens.').content
        'Wo viel der Weisheit, da auch viel des Grämens.'
        >>> Grammar(sentence)('.').content  # an empty sentence also matches
        '.'
1102

1103
    EBNF-Notation: ``{ ... }``
1104

1105
    EBNF-Example:  ``sentence = { /\w+,?/ } "."``
1106
1107
1108
1109
    """

    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
        results = ()  # type: Tuple[Node, ...]
di68kap's avatar
di68kap committed
1110
1111
        n = len(text) + 1  # type: int
        infinite_loop_error = None  # type: Optional[Error]
1112
1113
1114
1115
1116
1117
        while text and len(text) < n:
            n = len(text)
            node, text = self.parser(text)
            if not node:
                break
            if len(text) == n:
Eckhart Arnold's avatar
Eckhart Arnold committed
1118
                node.errors.append(Error("Infinite loop!", node.pos, Error.MESSAGE))
eckhart's avatar
eckhart committed
1119
                infinite_loop_error = Error(dsl_error_msg(self, 'Infinite Loop encountered.'),
Eckhart Arnold's avatar
Eckhart Arnold committed
1120
                                            node.pos)
1121
            results += (node,)
di68kap's avatar
di68kap committed
1122
1123
        node = Node(self, results)
        if infinite_loop_error:
eckhart's avatar
eckhart committed
1124
            self.grammar.tree__.add_error(node, infinite_loop_error)
di68kap's avatar
di68kap committed
1125
        return node, text
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137

    def __repr__(self):
        return '{' + (self.parser.repr[1:-1] if isinstance(self.parser, Alternative)
                      and not self.parser.name else self.parser.repr) + '}'


class OneOrMore(UnaryOperator):
    r"""
    `OneOrMore` applies a parser repeatedly as long as this parser
    matches. Other than `ZeroOrMore` which always matches, at least
    one match is required by `OneOrMore`.

1138
1139
    Examples::

1140
        >>> sentence = OneOrMore(RE(r'\w+,?')) + TKN('.')
1141
1142
1143
1144
        >>> Grammar(sentence)('Wo viel der Weisheit, da auch viel des Grämens.').content
        'Wo viel der Weisheit, da auch viel des Grämens.'
        >>> str(Grammar(sentence)('.'))  # an empty sentence also matches
        ' <<< Error on "." | Parser did not match! Invalid source file?\n    Most advanced: None\n    Last match:    None; >>> '
1145

1146
    EBNF-Notation: ``{ ... }+``
1147

1148
    EBNF-Example:  ``sentence = { /\w+,?/ }+``
1149
1150
    """

1151
1152
    def __init__(self, parser: Parser) -> None:
        super().__init__(parser)
1153
1154
        assert not isinstance(parser, Option), \
            "Use ZeroOrMore instead of nesting OneOrMore and Option: " \
di68kap's avatar
di68kap committed
1155
            "%s(%s)" % (str(self.ptype), str(parser.name))
1156
1157
1158
1159

    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
        results = ()  # type: Tuple[Node, ...]
        text_ = text  # type: StringView
di68kap's avatar
di68kap committed
1160
1161
        n = len(text) + 1  # type: int
        infinite_loop_error = None  # type: Optional[Error]
1162
1163
1164
1165
1166
1167
        while text_ and len(text_) < n:
            n = len(text_)
            node, text_ = self.parser(text_)
            if not node:
                break
            if len(text_) == n:
Eckhart Arnold's avatar
Eckhart Arnold committed
1168
                node.errors.append(Error("Infinite loop!", node.pos, Error.MESSAGE))
eckhart's avatar
eckhart committed
1169
                infinite_loop_error = Error(dsl_error_msg(self, 'Infinite Loop encountered.'),
Eckhart Arnold's avatar
Eckhart Arnold committed
1170
                                            node.pos)
1171
1172
1173
            results += (node,)
        if results == ():
            return None, text
di68kap's avatar
di68kap committed
1174
1175
        node = Node(self, results)
        if infinite_loop_error:
eckhart's avatar
eckhart committed
1176
            self.grammar.tree__.add_error(node, infinite_loop_error)
di68kap's avatar
di68kap committed
1177
        return node, text_
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188

    def __repr__(self):
        return '{' + (self.parser.repr[1:-1] if isinstance(self.parser, Alternative)
                      and not self.parser.name else self.parser.repr) + '}+'


class Series(NaryOperator):
    r"""
    Matches if each of a series of parsers matches exactly in the order of
    the series.

1189
1190
    Example::

1191
        >>> variable_name = RegExp('(?!\d)\w') + RE('\w*')
1192
1193
1194
1195
        >>> Grammar(variable_name)('variable_1').content
        'variable_1'
        >>> str(Grammar(variable_name)('1_variable'))
        ' <<< Error on "1_variable" | Parser did not match! Invalid source file?\n    Most advanced: None\n    Last match:    None; >>> '
1196

1197
    EBNF-Notation: ``... ...``    (sequence of parsers separated by a blank or new line)
1198

1199
    EBNF-Example:  ``series = letter letter_or_digit``
1200
1201
1202
1203
    """
    RX_ARGUMENT = re.compile(r'\s(\S)')
    NOPE = 1000

1204
1205
    def __init__(self, *parsers: Parser, mandatory: int = NOPE) -> None:
        super().__init__(*parsers)
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
        length = len(self.parsers)
        assert 1 <= length < Series.NOPE, \
            'Length %i of series exceeds maximum length of %i' % (length, Series.NOPE)
        if mandatory < 0:
            mandatory += length
        assert 0 <= mandatory < length or mandatory == Series.NOPE
        self.mandatory = mandatory

    def __deepcopy__(self, memo):
        parsers = copy.deepcopy(self.parsers, memo)
1216
1217
        duplicate = self.__class__(*parsers, mandatory=self.mandatory)
        duplicate.name = self.name
1218
        duplicate.ptype =   self.ptype
1219
        return duplicate
1220
1221
1222
1223
1224

    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
        results = ()  # type: Tuple[Node, ...]
        text_ = text  # type: StringView
        pos = 0
di68kap's avatar
di68kap committed
1225
        mandatory_violation = None
1226
1227
1228
1229
1230
1231
1232
1233
1234
        for parser in self.parsers:
            node, text_ = parser(text_)
            if not node:
                if pos < self.mandatory:
                    return None, text
                else:
                    # Provide useful error messages
                    match = text.search(Series.RX_ARGUMENT)
                    i = max(1, text.index(match.regs[1][0])) if match else 1
di68kap's avatar
di68kap committed
1235
1236
                    location = self.grammar.document_length__ - len(text_)
                    node = Node(self, text_[:i]).init_pos(location)
di68kap's avatar
di68kap committed
1237
                    node.errors.append(Error("§ %s violation" % parser.repr,
Eckhart Arnold's avatar
Eckhart Arnold committed
1238
                                             location, Error.MESSAGE))
di68kap's avatar
di68kap committed
1239
                    if not mandatory_violation:
di68kap's avatar
di68kap committed
1240
1241
                        msg = '%s expected, "%s" found!' \
                              % (parser.repr, text_[:10].replace('\n', '\\n '))
Eckhart Arnold's avatar
Eckhart Arnold committed
1242
                        mandatory_violation = Error(msg, location, Error.MANDATORY_CONTINUATION)
1243
1244
1245
1246
1247
1248
                    text_ = text_[i:]
            results += (node,)
            # if node.error_flag:  # break on first error
            #    break
            pos += 1
        assert len(results) <= len(self.parsers)
di68kap's avatar
di68kap committed
1249
1250
        node = Node(self, results)
        if mandatory_violation:
eckhart's avatar
eckhart committed
1251
            self.grammar.tree__.add_error(node, mandatory_violation)
di68kap's avatar
di68kap committed
1252
        return node, text_
1253
1254
1255
1256
1257
1258
1259

    def __repr__(self):
        return " ".join([parser.repr for parser in self.parsers[:self.mandatory]]
                        + (['§'] if self.mandatory != Series.NOPE else [])
                        + [parser.repr for parser in self.parsers[self.mandatory:]])

    # The following operator definitions add syntactical sugar, so one can write:
1260
    # `RE('\d+') + Optional(RE('\.\d+)` instead of `Series(RE('\d+'), Optional(RE('\.\d+))`
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278

    @staticmethod
    def combined_mandatory(left: Parser, right: Parser):
        """
        Returns the position of the first mandatory element (if any) when
        parsers `left` and `right` are joined to a sequence.
        """
        left_mandatory, left_length = (left.mandatory, len(left.parsers)) \
            if isinstance(left, Series) else (Series.NOPE, 1)
        if left_mandatory != Series.NOPE:
            return left_mandatory
        right_mandatory = right.mandatory if isinstance(right, Series) else Series.NOPE
        if right_mandatory != Series.NOPE:
            return right_mandatory + left_length
        return Series.NOPE

    def __add__(self, other: Parser) -> 'Series':
        other_parsers = cast('Series', other).parsers if isinstance(other, Series) \
1279
            else cast(Tuple[Parser, ...], (other,))  # type: Tuple[Parser, ...]
1280
1281
1282
1283
1284
        return Series(*(self.parsers + other_parsers),
                      mandatory=self.combined_mandatory(self, other))

    def __radd__(self, other: Parser) -> 'Series':
        other_parsers = cast('Series', other).parsers if isinstance(other, Series) \
1285
            else cast(Tuple[Parser, ...], (other,))  # type: Tuple[Parser, ...]
1286
1287
1288
1289
1290
        return Series(*(other_parsers + self.parsers),
                      mandatory=self.combined_mandatory(other, self))

    def __iadd__(self, other: Parser) -> 'Series':
        other_parsers = cast('Series', other).parsers if isinstance(other, Series) \
1291
            else cast(Tuple[Parser, ...], (other,))  # type: Tuple[Parser, ...]
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
        self.parsers += other_parsers
        self.mandatory = self.combined_mandatory(self, other)
        return self


class Alternative(NaryOperator):
    r"""
    Matches if one of several alternatives matches. Returns
    the first match.

    This parser represents the EBNF-operator "|" with the qualification
    that both the symmetry and the ambiguity of the EBNF-or-operator
1304
    are broken by selecting the first match.::
1305

1306
        # the order of the sub-expression matters!
1307
        >>> number = RE('\d+') | RE('\d+') + RE('\.') + RE('\d+')
1308
1309
        >>> str(Grammar(number)("3.1416"))
        '3 <<< Error on ".141" | Parser stopped before end! trying to recover... >>> '
1310

1311
        # the most selective expression should be put first:
1312
        >>> number = RE('\d+') + RE('\.') + RE('\d+') | RE('\d+')
1313
1314
        >>> Grammar(number)("3.1416").content
        '3.1416'
1315

1316
    EBNF-Notation: ``... | ...``
1317

1318
    EBNF-Example:  ``sentence = /\d+\.\d+/ | /\d+/``
1319
1320
    """

1321
1322
    def __init__(self, *parsers: Parser) -> None:
        super().__init__(*parsers)
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
        assert len(self.parsers) >= 1
        # only the last alternative may be optional. Could this be checked at compile time?
        assert all(not isinstance(p, Option) for p in self.parsers[:-1]), \
            "Parser-specification Error: only the last alternative may be optional!"

    def __call__(self, text: StringView) -> Tuple[Optional[Node], StringView]:
        for parser in self.parsers:
            node, text_ = parser(text)
            if node:
                return Node(self, node), text_
        return None, text

    def __repr__(self):
        return '(' + ' | '.join(parser.repr for parser in self.parsers) + ')'

    def reset(self):
        super(Alternative, self).reset()
        return self

    # The following operator definitions add syntactical sugar, so one can write:
di68kap's avatar