parse.py 107 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
from typing import Callable, cast, List, Tuple, Set, Iterator, Dict, \
    DefaultDict, Union, Optional, Any
37

eckhart's avatar
eckhart committed
38
from DHParser.configuration import get_config_value
39
from DHParser.error import Error, linebreaks, line_col
40
41
from DHParser.log import is_logging, HistoryRecord
from DHParser.preprocess import BEGIN_TOKEN, END_TOKEN, RX_TOKEN_NAME
42
from DHParser.stringview import StringView, EMPTY_STRING_VIEW
43
44
from DHParser.syntaxtree import Node, FrozenNode, RootNode, WHITESPACE_PTYPE, \
    TOKEN_PTYPE, ZOMBIE_TAG, ResultType
45
from DHParser.toolkit import sane_parser_name, escape_control_characters, re, cython, \
46
    RX_NEVER_MATCH, RxPatternType
47

48

49
__all__ = ('Parser',
50
           'UnknownParserError',
51
52
           'GrammarErrorType',
           'GrammarError',
53
           'Grammar',
Eckhart Arnold's avatar
Eckhart Arnold committed
54
           'EMPTY_NODE',
55
           'PreprocessorToken',
56
           'Token',
57
           'DropToken',
58
           'RegExp',
59
60
           'RE',
           'TKN',
61
           'Whitespace',
62
           'DropWhitespace',
63
           'mixin_comment',
64
           'MetaParser',
eckhart's avatar
eckhart committed
65
66
           'UnaryParser',
           'NaryParser',
67
68
69
70
71
72
73
74
75
           'Synonym',
           'Option',
           'ZeroOrMore',
           'OneOrMore',
           'Series',
           'Alternative',
           'AllOf',
           'SomeOf',
           'Unordered',
eckhart's avatar
eckhart committed
76
           'Required',
77
78
79
80
81
82
83
84
85
86
           'Lookahead',
           'NegativeLookahead',
           'Lookbehind',
           'NegativeLookbehind',
           'last_value',
           'counterpart',
           'accumulate',
           'Capture',
           'Retrieve',
           'Pop',
87
           'Forward')
88
89
90
91


########################################################################
#
92
# Parser base class
93
94
95
96
#
########################################################################


97
EMPTY_NODE = FrozenNode(':EMPTY__', '')
98
99


Eckhart Arnold's avatar
Eckhart Arnold committed
100
101
102
class ParserError(Exception):
    """
    A `ParserError` is thrown for those parser errors that allow the
103
    controlled re-entrance of the parsing process after the error occurred.
Eckhart Arnold's avatar
Eckhart Arnold committed
104
    If a reentry-rule has been configured for the parser where the error
105
    occurred, the parser guard can resume the parsing process.
Eckhart Arnold's avatar
Eckhart Arnold committed
106
107
108
109
110

    Currently, the only case when a `ParserError` is thrown (and not some
    different kind of error like `UnknownParserError`, is when a `Series`-
    detects a missing mandatory element.
    """
111
112
113
114
    def __init__(self, node: Node, rest: StringView, error: Optional[Error], first_throw: bool):
        self.node = node   # type: Node
        self.rest = rest   # type: StringView
        self.error = error # type: Optional[Error]
115
        self.first_throw = first_throw  # type: bool
Eckhart Arnold's avatar
Eckhart Arnold committed
116

117
    def __str__(self):
118
        return "%i: %s    %s" % (self.node.pos, str(self.rest[:25]), repr(self.node))
119

Eckhart Arnold's avatar
Eckhart Arnold committed
120

121
ResumeList = List[RxPatternType]  # list of regular expressiones
Eckhart Arnold's avatar
Eckhart Arnold committed
122
123


124
def reentry_point(rest: StringView, rules: ResumeList, comment_regex) -> int:
Eckhart Arnold's avatar
Eckhart Arnold committed
125
126
    """
    Finds the point where parsing should resume after a ParserError has been caught.
127
    The algorithm makes sure that this reentry-point does not lie inside a comment.
128
129
130
    The re-entry point is always the point after the end of the match of the regular
    expression defining the re-entry point. (Use look ahead, if you wand to define
    the re-entry point by what follows rather than by what text precedes the point.)
Eckhart Arnold's avatar
Eckhart Arnold committed
131
132
    Args:
        rest:  The rest of the parsed text or, in other words, the point where
133
134
135
136
            a ParserError was thrown.
        rules: A list of regular expressions. The rest of the text is searched for
            each of these. The closest match is the point where parsing will be
            resumed.
137
        comment_regex: A regular expression object that matches comments.
Eckhart Arnold's avatar
Eckhart Arnold committed
138
    Returns:
139
140
        The integer index of the closest reentry point or -1 if no reentry-point
        was found.
Eckhart Arnold's avatar
Eckhart Arnold committed
141
    """
142
    upper_limit = len(rest) + 1
143
    closest_match = upper_limit
144
145
146
147
148
149
150
151
152
153
154
155
156
    comments = None  # typ: Optional[Iterator]

    def next_comment() -> Tuple[int, int]:
        nonlocal rest, comments
        if comments:
            try:
                m = next(comments)
                a, b = m.span()
                return rest.index(a), rest.index(b)
            except StopIteration:
                comments = None
        return -1, -2

157
158
159
    # def str_search(s, start: int = 0) -> Tuple[int, int]:
    #     nonlocal rest
    #     return rest.find(s, start), len(s)
160
161
162

    def rx_search(rx, start: int = 0) -> Tuple[int, int]:
        nonlocal rest
163
164
165
        m = rest.search(rx, start)
        if m:
            start, end = m.span()
166
            return rest.index(start), end - start
167
168
        return -1, 0

169
170
171
172
173
174
    def entry_point(search_func, search_rule) -> int:
        a, b = next_comment()
        k, length = search_func(search_rule)
        while a < b <= k:
            a, b = next_comment()
        while a <= k < b:
175
            k, length = search_func(search_rule, k + max(length, 1))
176
177
            while a < b <= k:
                a, b = next_comment()
178
        return k + length if k >= 0 else upper_limit
179

180
    # find closest match
Eckhart Arnold's avatar
Eckhart Arnold committed
181
    for rule in rules:
182
        comments = rest.finditer(comment_regex)
183
184
185
        assert not isinstance(rule, str), \
            'Strings not allowed as search rules, use a regular expression instead.'
        pos = entry_point(rx_search, rule)
186
        closest_match = min(pos, closest_match)
187

188
    # in case no rule matched return -1
189
190
191
    if closest_match == upper_limit:
        closest_match = -1
    return closest_match
Eckhart Arnold's avatar
Eckhart Arnold committed
192
193


eckhart's avatar
eckhart committed
194
195
196
197
ApplyFunc = Callable[['Parser'], None]
FlagFunc = Callable[[ApplyFunc, Set[ApplyFunc]], bool]


198
class Parser:
199
200
201
202
203
204
205
206
207
208
209
210
211
212
    """
    (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:

di68kap's avatar
di68kap committed
213
    1. *Named parsers* for which a name is set in field `parser.pname`.
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
       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:
237
238
239
240
241
        pname:    The parser name or the empty string in case the parser
                remains anonymous.
        tag_name:  The tag_name for the nodes that are created by
                the parser. If the parser is named, this is the same as
                `pname`, otherwise it is the name of the parser's type.
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
        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.

257
        _grammar:  A reference to the Grammar object to which the parser
258
259
260
                is attached.
    """

261
    def __init__(self) -> None:
262
        # assert isinstance(name, str), str(name)
263
264
265
        self.pname = ''               # type: str
        self.tag_name = self.ptype    # type: str
        self.cycle_detection = set()  # type: Set[ApplyFunc]
266
267
268
269
        try:
            self._grammar = GRAMMAR_PLACEHOLDER  # type: Grammar
        except NameError:
            pass
270
271
272
        self.reset()

    def __deepcopy__(self, memo):
273
        """        Deepcopy method of the parser. Upon instantiation of a Grammar-
274
275
276
277
278
        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.
        """
279
        duplicate = self.__class__()
di68kap's avatar
di68kap committed
280
        duplicate.pname = self.pname
281
        duplicate.tag_name = self.tag_name
282
        return duplicate
283

284
    def __repr__(self):
di68kap's avatar
di68kap committed
285
        return self.pname + self.ptype
286
287

    def __str__(self):
di68kap's avatar
di68kap committed
288
        return self.pname + (' = ' if self.pname else '') + repr(self)
289

290
291
292
293
294
295
    @property
    def ptype(self) -> str:
        """Returns a type name for the parser. By default this is the name of
        the parser class with an added leading colon ':'. """
        return ':' + self.__class__.__name__

296
297
298
    @property
    def repr(self) -> str:
        """Returns the parser's name if it has a name and self.__repr___() otherwise."""
di68kap's avatar
di68kap committed
299
        return self.pname if self.pname else self.__repr__()
300

301
302
303
304
    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."""
305
        self.visited = dict()  # type: Dict[int, Tuple[Optional[Node], StringView]]
eckhart's avatar
eckhart committed
306
        self.recursion_counter = defaultdict(int)  # type: DefaultDict[int, int]
307

eckhart's avatar
eckhart committed
308
    @cython.locals(location=cython.int, gap=cython.int, i=cython.int)
309
310
311
    def __call__(self: 'Parser', text: StringView) -> Tuple[Optional[Node], StringView]:
        """Applies the parser to the given text. This is a wrapper method that adds
        the business intelligence that is common to all parsers. The actual parsing is
312
313
        done in the overridden method `_parse()`. This wrapper-method can be thought of
        as a "parser guard", because it guards the parsing process.
314
        """
315
316
317
318
319
320
321
322
323
        def get_error_node_id(error_node: Node, root_node: RootNode) -> int:
            if error_node:
                error_node_id = id(error_node)
                while error_node_id not in grammar.tree__.error_nodes and error_node.children:
                    error_node = error_node.result[-1]
                    error_node_id = id(error_node)
            else:
                error_node_id = 0

324
        grammar = self._grammar
325
326
327
        location = grammar.document_length__ - len(text)

        try:
328
329
            # rollback variable changing operation if parser backtracks
            # to a position before the variable changing operation occurred
330
331
332
            if grammar.last_rb__loc__ >= location:
                grammar.rollback_to__(location)

333
            # if location has already been visited by the current parser, return saved result
334
335
            visited = self.visited  # using local variable for better performance
            if location in visited:
336
                # no history recording in case of memoized results
337
                return visited[location]
338
339

            # break left recursion at the maximum allowed depth
340
341
342
            left_recursion_depth__ = grammar.left_recursion_depth__
            if left_recursion_depth__:
                if self.recursion_counter[location] > left_recursion_depth__:
343
344
345
346
                    grammar.recursion_locations__.add(location)
                    return None, text
                self.recursion_counter[location] += 1

347
            # write current step to call stack, if history tracking is configured
348
349
            history_tracking__ = grammar.history_tracking__
            if history_tracking__:
di68kap's avatar
di68kap committed
350
                grammar.call_stack__.append(
351
352
                    ((self.repr if self.tag_name in (':RegExp', ':Token', ':DropToken')
                      else self.tag_name), location))
353
                grammar.moving_forward__ = True
354
                error = None
355

356
            # finally, the actual parser call!
357
358
            try:
                node, rest = self._parse(text)
359
            except ParserError as pe:
360
                # catching up with parsing after an error occurred
361
                gap = len(text) - len(pe.rest)
di68kap's avatar
di68kap committed
362
                rules = grammar.resume_rules__.get(self.pname, [])
363
                rest = pe.rest[len(pe.node):]
364
                i = reentry_point(rest, rules, grammar.comment_rx__)
365
366
367
                if i >= 0 or self == grammar.start_parser__:
                    # apply reentry-rule or catch error at root-parser
                    if i < 0:
368
                        i = 1
369
                    nd = Node(ZOMBIE_TAG, rest[:i]).with_pos(location)
370
                    nd.attr['err'] = pe.error.message
371
                    rest = rest[i:]
372
373
374
                    assert pe.node.children or (not pe.node.result)
                    if pe.first_throw:
                        node = pe.node
eckhart's avatar
eckhart committed
375
                        node.result = node.children + (nd,)
376
                    else:
377
                        node = Node(self.tag_name,
378
                                    (Node(ZOMBIE_TAG, text[:gap]).with_pos(location), pe.node, nd))
379
380
                elif pe.first_throw:
                    raise ParserError(pe.node, pe.rest, pe.error, first_throw=False)
381
                elif grammar.tree__.errors[-1].code == Error.MANDATORY_CONTINUATION_AT_EOF:
382
                    node = pe.node
383
                else:
384
385
                    result = (Node(ZOMBIE_TAG, text[:gap]).with_pos(location), pe.node) if gap \
                        else pe.node  # type: ResultType
386
387
                    raise ParserError(Node(self.tag_name, result).with_pos(location),
                                      text, pe.error, first_throw=False)
388
389
                error = pe.error  # needed for history tracking

390

391
            if left_recursion_depth__:
392
393
394
395
396
397
                self.recursion_counter[location] -= 1
                # don't clear recursion_locations__ !!!

            if node is None:
                # retrieve an earlier match result (from left recursion) if it exists
                if location in grammar.recursion_locations__:
398
399
                    if location in visited:
                        node, rest = visited[location]
400
                        if location != grammar.last_recursion_location__:
401
402
403
                            grammar.tree__.add_error(
                                node, Error("Left recursion encountered. "
                                            "Refactor grammar to avoid slow parsing.",
404
405
                                            node.pos if node else location,
                                            Error.LEFT_RECURSION_WARNING))
406
                            error_id = id(node)
407
                            grammar.last_recursion_location__ = location
408
409
410
411
                    # 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
412
                    visited[location] = (None, rest)
413
            else:
414
                # assert node._pos < 0 or node == EMPTY_NODE
415
                # if node._pos != EMPTY_NODE:
416
                node._pos = location
417
418
                # assert node._pos >= 0 or node == EMPTY_NODE, \
                #     str("%i < %i" % (grammar.document_length__, location))
419
420
421
422
423
424
425
                if (grammar.last_rb__loc__ < location
                        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
                    # TODO: need a unit-test concerning interference of variable manipulation and left recursion algorithm?
426
                    visited[location] = (node, rest)
427
428
429

            # Mind that memoized parser calls will not appear in the history record!
            # Does this make sense? Or should it be changed?
430
            if history_tracking__:
431
432
                # don't track returning parsers except in case an error has occurred
                # remaining = len(rest)
433
                if grammar.moving_forward__:
434
                    record = HistoryRecord(grammar.call_stack__, node, text,
di68kap's avatar
di68kap committed
435
                                           grammar.line_col__(text))
436
                    grammar.history__.append(record)
437
438
439
440
                elif error:
                    # error_nid = id(node)  # type: int
                    # if error_nid in grammar.tree__.error_nodes:
                    record = HistoryRecord(grammar.call_stack__, node, text,
di68kap's avatar
di68kap committed
441
                                           grammar.line_col__(text),
442
443
                                           [error])
                    grammar.history__.append(record)
444
445
446
447
                grammar.moving_forward__ = False
                grammar.call_stack__.pop()

        except RecursionError:
448
            node = Node(ZOMBIE_TAG, str(text[:min(10, max(1, text.find("\n")))]) + " ...")
449
450
451
452
453
454
            node._pos = location
            grammar.tree__.new_error(node, "maximum recursion depth of parser reached; "
                                           "potentially due to too many errors!")
            rest = EMPTY_STRING_VIEW

        return node, rest
455
456
457
458
459
460
461
462
463
464
465
466

    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)

eckhart's avatar
eckhart committed
467

468
469
470
471
472
473
    def _parse(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."""
        raise NotImplementedError

474
    @property
eckhart's avatar
eckhart committed
475
    def grammar(self) -> 'Grammar':
476
477
478
479
480
        try:
            if self._grammar != GRAMMAR_PLACEHOLDER:
                return self._grammar
            else:
                raise AssertionError('Grammar has not yet been set!')
481
482
        except (AttributeError, NameError):
            raise AttributeError('Parser placeholder does not have a grammar!')
483
484
485

    @grammar.setter
    def grammar(self, grammar: 'Grammar'):
486
487
488
489
490
491
492
493
494
        try:
            if self._grammar == GRAMMAR_PLACEHOLDER:
                self._grammar = grammar
                # self._grammar_assigned_notifier()
            elif self._grammar != grammar:
                  raise AssertionError("Parser has already been assigned"
                                       "to a different Grammar object!")
        except AttributeError:
            pass  # ignore setting of grammar attribute for placeholder parser
495
496
        except NameError:  # Cython: No access to GRAMMA_PLACEHOLDER, yet :-(
            self._grammar = grammar
497

eckhart's avatar
eckhart committed
498
    def _apply(self, func: ApplyFunc, flip: FlagFunc) -> bool:
499
500
        """
        Applies function `func(parser)` recursively to this parser and all
eckhart's avatar
eckhart committed
501
502
503
504
505
506
507
508
509
        descendant parsers, if any exist.

        In order to break cycles, function `flip` is called, which should
        return `True`, if this parser has already been visited. If not, it
        flips the cycle detection flag and returns `False`.

        This is a protected function and should not called from outside
        class Parser or any of its descendants. The entry point for external
        calls is the method `apply()` without underscore!
510
        """
eckhart's avatar
eckhart committed
511
        if flip(func, self.cycle_detection):
512
513
514
515
516
            return False
        else:
            func(self)
            return True

eckhart's avatar
eckhart committed
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
    def apply(self, func: ApplyFunc):
        """
        Applies function `func(parser)` recursively to this parser and all
        descendant parsers, if any exist. Traversal is pre-order.
        """
        def positive_flip(f: ApplyFunc, flagged: Set[Callable]) -> bool:
            """Returns True, if function `f` has already been applied to this
            parser and sets the flag accordingly. Interprets `f in flagged == True`
            as meaning that `f` has already been applied."""
            if f in flagged:
                return True
            else:
                flagged.add(f)
                return False

        def negative_flip(f: ApplyFunc, flagged: Set[Callable]) -> bool:
            """Returns True, if function `f` has already been applied to this
            parser and sets the flag accordingly. Interprets `f in flagged == False`
            as meaning that `f` has already been applied."""
            if f not in flagged:
                return True
            else:
                flagged.remove(f)
                return False

        if func in self.cycle_detection:
            self._apply(func, negative_flip)
        else:
            self._apply(func, positive_flip)

547

548
PARSER_PLACEHOLDER = Parser()
549
550
551
552
553
554
555
556


########################################################################
#
# Grammar class, central administration of all parser of a grammar
#
########################################################################

557
558
559
560
561
562
563
564
565
566
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).
    """
567
568
569
    if comment:
        return '(?:' + whitespace + '(?:' + comment + whitespace + ')*)'
    return whitespace
570
571


572
class UnknownParserError(KeyError):
eckhart's avatar
eckhart committed
573
    """UnknownParserError is raised if a Grammar object is called with a
574
    parser that does not exist or if in the course of parsing a parser
eckhart's avatar
eckhart committed
575
    is referred to that does not exist."""
576
577


578
GrammarErrorType = Tuple[str, Parser, Error]      # TODO: replace with a named tuple?
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595


class GrammarError(Exception):
    """GrammarError will be raised if static analysis reveals errors
    in the grammar.
    """
    def __init__(self, static_analysis_result: List[GrammarErrorType]):
        assert static_analysis_result  # must not be empty
        self.errors = static_analysis_result

    def __str__(self):
        if len(self.errors) == 1:
            return str(self.errors[0][2])
        return '\n' + '\n'.join(("%i. " % (i + 1) + str(err_tuple[2]))
                                for i, err_tuple in enumerate(self.errors))


596
597
598
599
600
601
602
603
604
605
606
607
608
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
609
    Example for direct instantiation of a grammar::
610

611
        >>> number = RE(r'\d+') + RE(r'\.') + RE(r'\d+') | RE(r'\d+')
612
613
614
615
616
617
618
619
620
621
622
623
624
625
        >>> 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.
626
       See classmethod `Grammar._assign_parser_names__()`
627
628

    3. The parsers in the class do not necessarily need to be connected
629
630
       to one single root parser, which is helpful for testing and when
       building up a parser gradually from several components.
631
632
633
634
635
636
637

    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.

638
    Example::
639
640
641
642
643
644
645
646
647

        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+')
648
649
650
            factor = INTEGER | TKN("(") + expression + TKN(")")
            term = factor + ZeroOrMore((TKN("*") | TKN("/")) + factor)
            expression.set(term + ZeroOrMore((TKN("+") | TKN("-")) + term))
651
652
653
654
655
            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
di68kap's avatar
di68kap committed
656
    'named' parser and its field `parser.pname` contains the variable
657
658
    name after instantiation of the Grammar class. All other parsers,
    i.e. parsers that are defined within a `named` parser, remain
659
    "anonymous parsers" where `parser.pname` is the empty string.
660
    If one and the same parser is assigned to several class variables
661
    such as, for example, the parser `expression` in the example above,
662
663
664
665
666
667
668
669
670
671
672
673
674
    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:

675
    Class Attributes:
676
677
678
679
        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.
680

681
682
683
        resume_rules__: A mapping of parser names to a list of regular expressions
                that act as rules to find the reentry point if a ParserError was
                thrown during the execution of the parser with the respective name.
Eckhart Arnold's avatar
Eckhart Arnold committed
684

eckhart's avatar
eckhart committed
685
        anonymous__: Either a regular expression or a set of strings that
686
687
688
689
690
691
                identify names of parsers that shall be treated as anonymous parsers,
                even though they are assigned to a class field (see
                `:func:_assign_parser_names()`). The default is to treat all parsers
                starting with an underscore as anonymous in addition to those
                parsers that are not directly assigned to a class field.

eckhart's avatar
eckhart committed
692
        parser_initialization__:  Before the grammar class (!) has been initialized,
693
                 which happens upon the first time it is instantiated (see
694
                 `:func:_assign_parser_names()` for an explanation), this class
695
696
                 field contains a value other than "done". A value of "done" indicates
                 that the class has already been initialized.
697

698
699
700
701
702
703
704
        static_analysis_pending__: True as long as no static analysis (see the method
                with the same name for more information) has been done to check
                parser tree for correctness. Static analysis
                is done at instantiation and the flag is then set to false, but it
                can also be carried out once the class has been generated
                (by DHParser.ebnf.EBNFCompiler) and then be set to false in the
                definition of the grammar class already.
705

eckhart's avatar
eckhart committed
706
707
708
709
        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`).

710
    Instance Attributes:
711
712
        all_parsers__:  A set of all parsers connected to this grammar object

713
714
        comment_rx__:  The compiled regular expression for comments. If no
                comments have been defined, it defaults to RX_NEVER_MATCH
715
716
                This instance-attribute will only be defined if a class-attribute
                with the same name does not already exist!
717

eckhart's avatar
eckhart committed
718
719
720
721
        start_parser__:  During parsing, the parser with which the parsing process
                was started (see method `__call__`) or `None` if no parsing process
                is running.

722
723
724
725
726
727
728
729
730
731
        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
732
733
        document_length__:  the length of the document.

734
735
736
        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
737
                initialized if :attr:`history_tracking__` is true.
738

739
740
741
742
743
        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.

744
        _reversed__:  the same text in reverse order - needed by the `Lookbehind`-
745
746
747
                parsers.

        variables__:  A mapping for variable names to a stack of their respective
748
749
                string values - needed by the :class:`Capture`-, :class:`Retrieve`-
                and :class:`Pop`-parsers.
750
751

        rollback__:  A list of tuples (location, rollback-function) that are
752
753
754
755
                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.
756
757
758

        last_rb__loc__:  The last, i.e. most advanced location in the text
                where a variable changing operation occurred. If the parser
759
760
                backtracks to a location at or before last_rb__loc__ (i.e.
                location <= last_rb__loc__) then a rollback of all variable
761
762
                changing operations is necessary that occurred after the
                location to which the parser backtracks. This is done by
763
                calling method :func:`rollback_to__(location)`.
764

di68kap's avatar
di68kap committed
765
766
767
        call_stack__:  A stack of the tag names and locations of all parsers
                in the call chain to the currently processed parser during
                parsing. The call stack can be thought of as a breadcrumb trail.
768
                This is required for recording the parser history (for debugging)
769
770
771
772
773
774
775
776
777
778
                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
779
                recording is turned off! (See :func:`Parser.__call__`)
780
781
782
783

        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
784
785
786
787
788
                if full memoization is enabled. (See :func:`Parser.__call__()`)

        last_recursion_location__:  Last location where left recursion was
                detected. This is used to avoid reduplicating warning messages
                about left recursion.
789
790
791
792
793
794

        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)

795
796
797
798
799
        flatten_tree__:  If True (default), anonymous nodes will be flattened
                during parsing already. This greatly reduces the concrete syntax
                tree and simplifies and speeds up abstract syntax tree generation.
                The initial value will be read from the config variable
                'flatten_tree_while_parsing' upon class instantiation.
800
801
802
803
804
805
806
807

        left_recursion_depth__: the maximum allowed depth for left-recursion.
                A depth of zero means that no left recursion handling will
                take place. See 'left_recursion_depth' in config.py.

        max_parser_dropouts__: Maximum allowed number of retries after errors
                where the parser would exit before the complete document has
                been parsed. See config.py
808
    """
eckhart's avatar
eckhart committed
809
    python_src__ = ''  # type: str
810
    root__ = PARSER_PLACEHOLDER  # type: Parser
811
    # root__ must be overwritten with the root-parser by grammar subclass
eckhart's avatar
eckhart committed
812
    parser_initialization__ = ["pending"]  # type: List[str]
eckhart's avatar
eckhart committed
813
    resume_rules__ = dict()  # type: Dict[str, ResumeList]
814
    anonymous__ = re.compile(r'_\w+')  # type: Union[RxPatternType, Set[str]]
815
    # some default values
816
817
    # COMMENT__ = r''  # type: str  # r'#.*(?:\n|$)'
    # WSP_RE__ = mixin_comment(whitespace=r'[\t ]*', comment=COMMENT__)  # type: str
818
    static_analysis_pending__ = [True]  # type: List[bool]
819
820
821
822
823


    @classmethod
    def _assign_parser_names__(cls):
        """
di68kap's avatar
di68kap committed
824
        Initializes the `parser.pname` fields of those
825
        Parser objects that are directly assigned to a class field with
826
        the field's name, e.g.::
827

828
829
            class Grammar(Grammar):
                ...
830
                symbol = RE(r'(?!\\d)\\w+')
831

di68kap's avatar
di68kap committed
832
        After the call of this method symbol.pname == "symbol" holds.
di68kap's avatar
di68kap committed
833
834
        Parser names starting or ending with a double underscore like
        ``root__`` will be ignored. See :func:`sane_parser_name()`
835
836
837
838
839
840
841
842
843
844

        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.
        """
eckhart's avatar
eckhart committed
845
        if cls.parser_initialization__[0] != "done":
846
847
848
            cdict = cls.__dict__
            for entry, parser in cdict.items():
                if isinstance(parser, Parser) and sane_parser_name(entry):
di68kap's avatar
di68kap committed
849
                    if isinstance(parser, Forward):
di68kap's avatar
di68kap committed
850
851
852
853
                        if not cast(Forward, parser).parser.pname:
                            cast(Forward, parser).parser.pname = entry
                    else:   # if not parser.pname:
                        parser.pname = entry
eckhart's avatar
eckhart committed
854
            cls.parser_initialization__[0] = "done"
855
856
857


    def __init__(self, root: Parser = None) -> None:
858
        self.all_parsers__ = set()             # type: Set[Parser]
859
860
861
862
863
864
865
        # add compiled regular expression for comments, if it does not already exist
        if not hasattr(self, 'comment_rx__'):
            self.comment_rx__ = re.compile(self.COMMENT__) \
                if hasattr(self, 'COMMENT__') and self.COMMENT__ else RX_NEVER_MATCH
        else:
            assert ((self.COMMENT__ and self.COMMENT__ == self.comment_rx__.pattern)
                     or (not self.COMMENT__ and self.comment_rx__ == RX_NEVER_MATCH))
866
        self.start_parser__ = None             # type: Optional[Parser]
867
868
869
        self._dirty_flag__ = False             # type: bool
        self.history_tracking__ = False        # type: bool
        self.memoization__ = True              # type: bool
870
871
872
        self.flatten_tree__ = get_config_value('flatten_tree_while_parsing')    # type: bool
        self.left_recursion_depth__ = get_config_value('left_recursion_depth')  # type: int
        self.max_parser_dropouts__ = get_config_value('max_parser_dropouts')    # type: int
873
874
875
876
877
878
879
880
881
        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.
eckhart's avatar
eckhart committed
882
883
884
885
        self.root_parser__ = copy.deepcopy(root) if root else copy.deepcopy(self.__class__.root__)
        self.root_parser__.apply(self._add_parser__)
        assert 'root_parser__' in self.__dict__
        assert self.root_parser__ == self.__dict__['root_parser__']
886

887
888
889
890
891
892
893
894
895
        if self.__class__.static_analysis_pending__ \
                and get_config_value('static_analysis') in {'early', 'late'}:
            try:
                result = self.static_analysis()
                if result:
                    raise GrammarError(result)
                self.__class__.static_analysis_pending__.pop()
            except (NameError, AttributeError):
                pass  # don't fail the initialization of PLACEHOLDER
896

897
898
899
900
901

    def __getitem__(self, key):
        try:
            return self.__dict__[key]
        except KeyError:
eckhart's avatar
eckhart committed
902
            parser_template = getattr(self.__class__, key, None)
903
904
905
906
            if parser_template:
                # add parser to grammar object on the fly...
                parser = copy.deepcopy(parser_template)
                parser.apply(self._add_parser__)
eckhart's avatar
eckhart committed
907
                assert self[key] == parser
908
                return self[key]
909
            raise UnknownParserError('Unknown parser "%s" !' % key)
910

911

912
913
    def __contains__(self, key):
        return key in self.__dict__ or hasattr(self, key)
914

915

916
    def _reset__(self):
917
        self.tree__ = RootNode()              # type: RootNode
918
919
        self.document__ = EMPTY_STRING_VIEW   # type: StringView
        self._reversed__ = EMPTY_STRING_VIEW  # type: StringView
eckhart's avatar
eckhart committed
920
        self.document_length__ = 0            # type: int
921
922
        self.document_lbreaks__ = []          # type: List[int]
        # variables stored and recalled by Capture and Retrieve parsers
eckhart's avatar
eckhart committed
923
        self.variables__ = defaultdict(lambda: [])  # type: DefaultDict[str, List[str]]
924
925
926
        self.rollback__ = []                  # type: List[Tuple[int, Callable]]
        self.last_rb__loc__ = -1              # type: int
        # support for call stack tracing
927
        self.call_stack__ = []                # type: List[Tuple[str, int]]  # tag_name, location
928
929
930
931
932
        # 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]
933
        self.last_recursion_location__ = -1   # type: int
934
935
936
937
938
939
940
941
942
943


    @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__:
944
            self._reversed__ = StringView(self.document__.get_text()[::-1])
945
946
947
948
949
950
951
952
        return self._reversed__


    def _add_parser__(self, parser: Parser) -> None:
        """
        Adds the particular copy of the parser object to this
        particular instance of Grammar.
        """
di68kap's avatar
di68kap committed
953
        if parser.pname:
954
            # prevent overwriting instance variables or parsers of a different class
di68kap's avatar
di68kap committed
955
956
            assert parser.pname not in self.__dict__ or \
                   isinstance(self.__dict__[parser.pname], parser.__class__), \
957
                ('Cannot add parser "%s" because a field with the same name '
di68kap's avatar
di68kap committed
958
                 'already exists in grammar object: %s!'
di68kap's avatar
di68kap committed
959
960
961
                 % (parser.pname, str(self.__dict__[parser.pname])))
            setattr(self, parser.pname, parser)
        parser.tag_name = parser.pname or parser.ptype
962
963
964
965
        self.all_parsers__.add(parser)
        parser.grammar = self


eckhart's avatar
eckhart committed
966
967
    def __call__(self,
                 document: str,
eckhart's avatar
eckhart committed
968
                 start_parser: Union[str, Parser] = "root_parser__",
969
                 *, complete_match: bool = True,
eckhart's avatar
eckhart committed
970
                 track_history: bool = False) -> RootNode:
971
972
973
974
975
        """
        Parses a document with with parser-combinators.

        Args:
            document (str): The source text to be parsed.
di68kap's avatar
di68kap committed
976
977
            start_parser (str or Parser): The name of the parser with which
                to start. This is useful for testing particular parsers
978
                (i.e. particular parts of the EBNF-Grammar.)
979
980
            complete_match (bool): If True, an error is generated, if
                `start_parser` did not match the entire document.
di68kap's avatar
di68kap committed
981
982
983
984
985
            track_history (bool): If true, the parsing history will be
                recorded in self.history__. If logging is turned on (i.e.
                DHParser.log.is_logging() returns true), the parsing history
                will always be recorded, even if `False` is passed to
                the `track_history` parameter.
986
        Returns:
di68kap's avatar
di68kap committed
987
            Node: The root node to the parse tree.
988
        """
989

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

995
996
997
998
999
1000
        def lookahead_failure_only(parser):
            """EXPERIMENTAL!

            Checks if failure to match document was only due to a succeeding
            lookahead parser, which is a common design pattern that can break test
            cases. (Testing for this case allows to modify the error message, so