parse.py 119 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
from typing import Callable, cast, List, Tuple, Set, Container, Dict, \
36
    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
from DHParser.log import HistoryRecord
41
from DHParser.preprocess import BEGIN_TOKEN, END_TOKEN, RX_TOKEN_NAME
42
from DHParser.stringview import StringView, EMPTY_STRING_VIEW
43
from DHParser.syntaxtree import Node, FrozenNode, RootNode, WHITESPACE_PTYPE, \
44
    TOKEN_PTYPE, ZOMBIE_TAG, EMPTY_NODE, ResultType
45
from DHParser.toolkit import sane_parser_name, escape_control_characters, re, cython, \
46
    RX_NEVER_MATCH, RxPatternType
47

48

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


########################################################################
#
94
# ParserError class
95
96
97
98
#
########################################################################


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

    Currently, the only case when a `ParserError` is thrown (and not some
107
108
    different kind of error like `UnknownParserError`) is when a `Series`-
    or `AllOf`-parser detects a missing mandatory element.
Eckhart Arnold's avatar
Eckhart Arnold committed
109
    """
110
111
112
113
    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]
114
        self.first_throw = first_throw  # type: bool
Eckhart Arnold's avatar
Eckhart Arnold committed
115

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

Eckhart Arnold's avatar
Eckhart Arnold committed
119

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


eckhart's avatar
eckhart committed
123
@cython.locals(upper_limit=cython.int, closest_match=cython.int, pos=cython.int)
124
125
126
def reentry_point(rest: StringView,
                  rules: ResumeList,
                  comment_regex,
127
                  search_window: int = -1) -> int:
Eckhart Arnold's avatar
Eckhart Arnold committed
128
129
    """
    Finds the point where parsing should resume after a ParserError has been caught.
130
    The algorithm makes sure that this reentry-point does not lie inside a comment.
131
132
133
    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
134
135
    Args:
        rest:  The rest of the parsed text or, in other words, the point where
136
137
138
139
            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.
140
        comment_regex: A regular expression object that matches comments.
141
142
        search_window: The maximum size of the search window for finding the
            reentry-point. A value smaller or equal zero means that
Eckhart Arnold's avatar
Eckhart Arnold committed
143
    Returns:
144
145
        The integer index of the closest reentry point or -1 if no reentry-point
        was found.
Eckhart Arnold's avatar
Eckhart Arnold committed
146
    """
147
    upper_limit = len(rest) + 1
148
    closest_match = upper_limit
149
150
    comments = None  # typ: Optional[Iterator]

eckhart's avatar
eckhart committed
151
    @cython.locals(a=cython.int, b=cython.int)
152
153
154
155
156
157
158
159
160
161
162
    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

163
164
    # def str_search(s, start: int = 0) -> Tuple[int, int]:
    #     nonlocal rest
165
    #     return rest.find(s, start, start + search_window), len(s)
166

eckhart's avatar
eckhart committed
167
    @cython.locals(start=cython.int, end=cython.int)
168
169
    def rx_search(rx, start: int = 0) -> Tuple[int, int]:
        nonlocal rest
170
        m = rest.search(rx, start, start + search_window)
171
        if m:
172
173
            begin, end = m.span()
            return rest.index(begin), end - begin
174
175
        return -1, 0

eckhart's avatar
eckhart committed
176
    @cython.locals(a=cython.int, b=cython.int, k=cython.int, length=cython.int)
177
178
179
180
181
    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()
182
183
184
        # find next as long as start or end point of resume regex are inside a comment
        while (a < k < b) or (a < k + length < b):
            k, length = search_func(search_rule, b)
185
186
            while a < b <= k:
                a, b = next_comment()
187
        return k + length if k >= 0 else upper_limit
188

189
    # find closest match
Eckhart Arnold's avatar
Eckhart Arnold committed
190
    for rule in rules:
191
        comments = rest.finditer(comment_regex)
192
193
194
        assert not isinstance(rule, str), \
            'Strings not allowed as search rules, use a regular expression instead.'
        pos = entry_point(rx_search, rule)
195
        closest_match = min(pos, closest_match)
196

197
    # in case no rule matched return -1
198
199
200
    if closest_match == upper_limit:
        closest_match = -1
    return closest_match
Eckhart Arnold's avatar
Eckhart Arnold committed
201
202


203
204
205
206
207
208
209
########################################################################
#
# Parser base class
#
########################################################################


eckhart's avatar
eckhart committed
210
211
ApplyFunc = Callable[['Parser'], None]
FlagFunc = Callable[[ApplyFunc, Set[ApplyFunc]], bool]
212
ParseFunc = Callable[['Parser', StringView], Tuple[Optional[Node], StringView]]
eckhart's avatar
eckhart committed
213
214


215
216
217
218
def copy_parser_attrs(src: 'Parser', duplicate: 'Parser'):
    """Duplicates all parser attributes from source to dest."""
    duplicate.pname = src.pname
    duplicate.anonymous = src.anonymous
Eckhart Arnold's avatar
Eckhart Arnold committed
219
    duplicate.drop_content = src.drop_content
220
221
222
    duplicate.tag_name = src.tag_name


223
class Parser:
224
225
226
227
228
229
230
231
232
233
234
235
236
237
    """
    (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
238
    1. *Named parsers* for which a name is set in field `parser.pname`.
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
       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:
262

263
264
        pname:  The parser's name or a (possibly empty) alias name in case
                of an anonymous parser.
265

266
267
268
269
270
        anonymous: A property indicating that the parser remains anynomous
                anonymous with respect to the nodes it returns. For performance
                reasons this is implemented as an object variable rather
                than a property. This property must always be equal to
                `self.tag_name[0] == ":"`.
271

272
273
274
275
        drop_content: A property (for performance reasons implemented as
                simple field) that, if set, induces the parser not to return
                the parsed content or sub-tree if it has matched but the
                dummy `EMPTY_NODE`. In effect the parsed content will be
276
277
278
                dropped from the concrete syntax tree already. Only
                anonymous (or pseudo-anonymous) parsers are allowed to
                drop content.
279

280
        tag_name: The tag_name for the nodes that are created by
281
282
                the parser. If the parser is named, this is the same as
                `pname`, otherwise it is the name of the parser's type.
283

284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
        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.

299
300
301
302
        proxied: The original `_parse()`-method is stored here, if a
                proxy (e.g. a tracing debugger) is installed via the
                `set_proxy()`-method.

303
        _grammar:  A reference to the Grammar object to which the parser
304
305
306
                is attached.
    """

307
    def __init__(self) -> None:
308
        # assert isinstance(name, str), str(name)
309
        self.pname = ''               # type: str
310
        self.anonymous = True         # type: bool
311
        self.drop_content = False     # type: bool
312
313
        self.tag_name = self.ptype    # type: str
        self.cycle_detection = set()  # type: Set[ApplyFunc]
314
315
316
        # this indirection is required for Cython-compatibility
        self.__parse = self._parse    # type: ParseMethod
        # self.proxied = None           # type: Optional[ParseMethod]
317
318
319
320
        try:
            self._grammar = GRAMMAR_PLACEHOLDER  # type: Grammar
        except NameError:
            pass
321
322
323
        self.reset()

    def __deepcopy__(self, memo):
324
        """        Deepcopy method of the parser. Upon instantiation of a Grammar-
325
        object, parsers will be deep-copied to the Grammar object. If a
326
        derived parser-class changes the signature of the `__init__`-constructor,
327
328
329
        `__deepcopy__`-method must be replaced (i.e. overridden without
        calling the same method from the superclass) by the derived class.
        """
330
        duplicate = self.__class__()
331
        copy_parser_attrs(self, duplicate)
332
        return duplicate
333

334
    def __repr__(self):
di68kap's avatar
di68kap committed
335
        return self.pname + self.ptype
336
337

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

340
341
342
343
344
345
    @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__

346
347
348
    @property
    def repr(self) -> str:
        """Returns the parser's name if it has a name and self.__repr___() otherwise."""
di68kap's avatar
di68kap committed
349
        return self.pname if self.pname else self.__repr__()
350

351
352
353
354
    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."""
355
        self.visited = dict()  # type: Dict[int, Tuple[Optional[Node], StringView]]
eckhart's avatar
eckhart committed
356
        self.recursion_counter = defaultdict(int)  # type: DefaultDict[int, int]
357

358
359
360
    def _add_resume_notice(self, rest: StringView, err_node: Node) -> None:
        """Adds a resume notice to the error node with information about
        the reentry point and the parser."""
di68kap's avatar
di68kap committed
361
        if not self._grammar.resume_notices__ or self == self._grammar.start_parser__:
362
            return
363
        call_stack = self._grammar.call_stack__
364
        if len(call_stack) >= 2:
365
366
367
            i, N = -2, -len(call_stack)
            while i >= N and call_stack[i][0][0:1] in (':', '/', '"', "'", "`"):
                i -= 1
368
369
            if i >= N and i != -2:
                parent_info = "{}->{}".format(call_stack[i][0], call_stack[-2][0])
370
            else:
371
                parent_info = call_stack[-2][0]
372
373
        else:
            parent_info = "?"
di68kap's avatar
di68kap committed
374
375
        notice = Error('Resuming from parser {} with parser {} at point: {}'
                       .format(self.pname or self.ptype, parent_info, repr(rest[:10])),
376
                       self._grammar.document_length__ - len(rest), Error.RESUME_NOTICE)
377
        self._grammar.tree__.add_error(err_node, notice)
378

eckhart's avatar
eckhart committed
379
    @cython.locals(location=cython.int, gap=cython.int, i=cython.int)
380
381
382
    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
383
384
        done in the overridden method `_parse()`. This wrapper-method can be thought of
        as a "parser guard", because it guards the parsing process.
385
        """
386
387
388
389
390
391
392
393
394
        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

395
        grammar = self._grammar
di68kap's avatar
di68kap committed
396
        location = grammar.document_length__ - text._len  # faster then len(text)?
397
398

        try:
399
400
            # rollback variable changing operation if parser backtracks
            # to a position before the variable changing operation occurred
401
402
403
            if grammar.last_rb__loc__ >= location:
                grammar.rollback_to__(location)

404
            # if location has already been visited by the current parser, return saved result
405
406
            visited = self.visited  # using local variable for better performance
            if location in visited:
407
                # no history recording in case of memoized results
408
                return visited[location]
409
410

            # break left recursion at the maximum allowed depth
411
412
413
            left_recursion_depth__ = grammar.left_recursion_depth__
            if left_recursion_depth__:
                if self.recursion_counter[location] > left_recursion_depth__:
414
415
416
417
                    grammar.recursion_locations__.add(location)
                    return None, text
                self.recursion_counter[location] += 1

418
            # write current step to call stack, if history tracking is configured
419
420
            history_tracking__ = grammar.history_tracking__
            if history_tracking__:
di68kap's avatar
di68kap committed
421
                grammar.call_stack__.append(
422
                    ((self.repr if self.tag_name in (':RegExp', ':Token', ':DropToken')
423
                      else (self.pname or self.tag_name)), location))
424
425
                grammar.moving_forward__ = True

426
            # finally, the actual parser call!
427
            try:
428
                node, rest = self.__parse(text)
429
            except ParserError as pe:
430
                # catching up with parsing after an error occurred
431
                gap = len(text) - len(pe.rest)
di68kap's avatar
di68kap committed
432
                rules = grammar.resume_rules__.get(self.pname, [])
433
                rest = pe.rest[len(pe.node):]
434
435
                i = reentry_point(rest, rules, grammar.comment_rx__,
                                  grammar.reentry_search_window__)
436
                if i >= 0 or self == grammar.start_parser__:
437
                    assert pe.node.children or (not pe.node.result)
438
                    # apply reentry-rule or catch error at root-parser
di68kap's avatar
di68kap committed
439
440
                    # if i < 0:
                    #     i = 1
441
442
                    try:
                        zombie = pe.node[ZOMBIE_TAG]
443
                    except (KeyError, ValueError):
444
445
446
447
448
449
450
451
                        zombie = None
                    if zombie and not zombie.result:
                        zombie.result = rest[:i]
                        tail = tuple()
                    else:
                        nd = Node(ZOMBIE_TAG, rest[:i]).with_pos(location)
                        nd.attr['err'] = pe.error.message
                        tail = (nd,)
452
                    rest = rest[i:]
453
454
                    if pe.first_throw:
                        node = pe.node
455
                        node.result = node.children + tail
456
                    else:
457
458
                        node = Node(
                            self.tag_name,
di68kap's avatar
di68kap committed
459
460
461
                            (Node(ZOMBIE_TAG, text[:gap]).with_pos(location), pe.node) + tail) \
                            .with_pos(location)
                    self._add_resume_notice(rest, node)
462
                elif pe.first_throw:
eckhart's avatar
eckhart committed
463
                    # TODO: Will this option be needed, if history tracking is deferred to module "trace"?
464
                    if history_tracking__:  grammar.call_stack__.pop()
465
                    raise ParserError(pe.node, pe.rest, pe.error, first_throw=False)
466
                elif grammar.tree__.errors[-1].code == Error.MANDATORY_CONTINUATION_AT_EOF:
467
                    node = Node(self.tag_name, pe.node).with_pos(location)  # try to create tree as faithful as possible
468
                else:
469
470
                    result = (Node(ZOMBIE_TAG, text[:gap]).with_pos(location), pe.node) if gap \
                        else pe.node  # type: ResultType
471
                    if history_tracking__:  grammar.call_stack__.pop()
472
473
                    raise ParserError(Node(self.tag_name, result).with_pos(location),
                                      text, pe.error, first_throw=False)
474
                grammar.most_recent_error__ = pe.error  # needed for history tracking
475

476
            if left_recursion_depth__:
477
478
479
480
481
482
                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__:
483
484
                    if location in visited:
                        node, rest = visited[location]
485
                        if location != grammar.last_recursion_location__:
486
487
488
                            grammar.tree__.add_error(
                                node, Error("Left recursion encountered. "
                                            "Refactor grammar to avoid slow parsing.",
489
490
                                            node.pos if node else location,
                                            Error.LEFT_RECURSION_WARNING))
491
                            error_id = id(node)
492
                            grammar.last_recursion_location__ = location
493
494
495
496
                    # 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
497
                    visited[location] = (None, rest)
498
            else:
499
                # assert node._pos < 0 or node == EMPTY_NODE
500
                # if node._pos != EMPTY_NODE:
501
                node._pos = location
502
503
                # assert node._pos >= 0 or node == EMPTY_NODE, \
                #     str("%i < %i" % (grammar.document_length__, location))
504
505
506
507
508
509
510
                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?
511
                    visited[location] = (node, rest)
512
513
514

            # Mind that memoized parser calls will not appear in the history record!
            # Does this make sense? Or should it be changed?
515
            if history_tracking__:
516
                # don't track returning parsers except in case an error has occurred
517
                if grammar.moving_forward__:
518
                    record = HistoryRecord(grammar.call_stack__, node, text,
di68kap's avatar
di68kap committed
519
                                           grammar.line_col__(text))
520
                    grammar.history__.append(record)
521
                elif grammar.most_recent_error__:
522
523
524
                    # 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
525
                                           grammar.line_col__(text),
526
527
                                           [grammar.most_recent_error__])
                    grammar.most_recent_error__ = None
528
                    grammar.history__.append(record)
529
530
531
532
                grammar.moving_forward__ = False
                grammar.call_stack__.pop()

        except RecursionError:
533
            node = Node(ZOMBIE_TAG, str(text[:min(10, max(1, text.find("\n")))]) + " ...")
534
535
536
537
538
539
            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
540
541
542
543
544
545
546
547
548
549
550
551

    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)

552
553
554
555
556
557
    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

558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
    def set_proxy(self, proxy: Optional[ParseFunc]):
        """Sets a proxy that replaces the _parse()-method. The original
        parse-method is copied to the `proxied`-filed of the Parser object and
        can be called by the proxy. Call `set_proxy` with `None` to remove
        a previously set proxy. Typical use case is the installation of a
        tracing debugger. See module `trace`.
        """
        if proxy is None:
            self.__parse = self._parse
        else:
            if type(proxy) != type(self._parse):
                # assume that proxy is a function
                proxy = proxy.__get__(self, type(self))
            else:
                # if proxy is a method it must be a method od self
                assert proxy.__self__ == self
            self.__parse = proxy

576
    @property
eckhart's avatar
eckhart committed
577
    def grammar(self) -> 'Grammar':
578
579
580
581
582
        try:
            if self._grammar != GRAMMAR_PLACEHOLDER:
                return self._grammar
            else:
                raise AssertionError('Grammar has not yet been set!')
583
584
        except (AttributeError, NameError):
            raise AttributeError('Parser placeholder does not have a grammar!')
585
586
587

    @grammar.setter
    def grammar(self, grammar: 'Grammar'):
588
589
590
591
592
593
594
595
596
        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
597
598
        except NameError:  # Cython: No access to GRAMMA_PLACEHOLDER, yet :-(
            self._grammar = grammar
599

600
601
602
603
604
605
    def sub_parsers(self) -> List['Parser']:
        """Returns the list of sub-parsers if there are any.
        Overridden by Unary, Nary and Forward.
        """
        return []

eckhart's avatar
eckhart committed
606
    def _apply(self, func: ApplyFunc, flip: FlagFunc) -> bool:
607
608
        """
        Applies function `func(parser)` recursively to this parser and all
eckhart's avatar
eckhart committed
609
610
611
612
613
614
615
616
617
        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!
618
        """
eckhart's avatar
eckhart committed
619
        if flip(func, self.cycle_detection):
620
621
622
            return False
        else:
            func(self)
623
624
            for parser in self.sub_parsers():
                parser._apply(func, flip)
625
626
            return True

eckhart's avatar
eckhart committed
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
    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)

657

eckhart's avatar
eckhart committed
658
659
def Drop(parser: Parser) -> Parser:
    """Returns the parser with the `parser.drop_content`-property set to `True`."""
Eckhart Arnold's avatar
Eckhart Arnold committed
660
    assert parser.anonymous, "Parser must be anonymous to be allowed to drop ist content."
eckhart's avatar
eckhart committed
661
662
663
    if isinstance(parser, Forward):
        cast(Forward, parser).parser.drop_content = True
    parser.drop_content = True
Eckhart Arnold's avatar
Eckhart Arnold committed
664
    return parser
eckhart's avatar
eckhart committed
665
666


667
PARSER_PLACEHOLDER = Parser()
668
669
670
671
672
673
674
675


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

676
677
def mixin_comment(whitespace: str, comment: str) -> str:
    """
678
    Returns a regular expression pattern that merges comment and whitespace
679
    regexps. Thus comments can occur wherever whitespace is allowed
680
681
682
683
684
685
    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).
    """
686
687
688
    if comment:
        return '(?:' + whitespace + '(?:' + comment + whitespace + ')*)'
    return whitespace
689
690


Eckhart Arnold's avatar
Eckhart Arnold committed
691
692
def mixin_noempty(whitespace: str) -> str:
    r"""
693
694
695
696
697
698
699
700
701
702
703
704
705
706
    Returns a regular expression pattern that matches only if the regular
    expression pattern `whitespace` matches AND if the match is not empty.

    If `whitespace` already matches the empty string '', then it will be
    returned unaltered.

    WARNING: `non_empty_ws` does not work regular expressions the matched
    strings of which can be followed by a symbol that can also occur at
    the start of the regular expression.

    In particular, it does not work for fixed size regular expressions,
    that ist / / or /   / or /\t/ won't work, but / */ or /\s*/ or /\s+/
    do work. There is no test for this. Fixed sizes regular expressions
    run through `non_empty_ws` will not match at any more if they are applied
Eckhart Arnold's avatar
Eckhart Arnold committed
707
708
709
710
711
    to the beginning or the middle of a sequence of whitespaces!

    In order to be safe, you whitespace regular expressions should follow
    the rule: "Whitespace cannot be followed by whitespace" or "Either
    grab it all or leave it all".
712
713
714
715
716
717
718
719
720
721

    :param whitespace: a regular expression pattern
    :return: new regular expression pattern that does not match the empty
        string '' any more.
    """
    if re.match(whitespace, ''):
        return r'(?:(?=(.|\n))' + whitespace + r'(?!\1))'
    return whitespace


722
class UnknownParserError(KeyError):
eckhart's avatar
eckhart committed
723
    """UnknownParserError is raised if a Grammar object is called with a
724
    parser that does not exist or if in the course of parsing a parser
eckhart's avatar
eckhart committed
725
    is referred to that does not exist."""
726
727


728
GrammarErrorType = Tuple[str, Parser, Error]      # TODO: replace with a named tuple?
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745


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))


746
747
748
749
750
751
752
753
754
755
756
757
758
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
759
    Example for direct instantiation of a grammar::
760

761
        >>> number = RE(r'\d+') + RE(r'\.') + RE(r'\d+') | RE(r'\d+')
762
763
764
765
766
767
768
769
770
771
772
773
774
775
        >>> 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.
776
       See classmethod `Grammar._assign_parser_names__()`
777
778

    3. The parsers in the class do not necessarily need to be connected
779
780
       to one single root parser, which is helpful for testing and when
       building up a parser gradually from several components.
781
782
783
784
785
786
787

    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.

788
    Example::
789
790
791
792
793
794
795
796
797

        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+')
798
799
800
            factor = INTEGER | TKN("(") + expression + TKN(")")
            term = factor + ZeroOrMore((TKN("*") | TKN("/")) + factor)
            expression.set(term + ZeroOrMore((TKN("+") | TKN("-")) + term))
801
802
803
804
            root__ = expression

    Upon instantiation the parser objects are deep-copied to the
    Grammar object and assigned to object variables of the same name.
805
806
807
808
809
    For any parser that is directly assigned to a class variable the
    field `parser.pname` contains the variable name after instantiation
    of the Grammar class. The parser will never the less remain anonymous
    with respect to the tag names of the nodes it generates, if its name
    is matched by the `anonymous__` regular expression.
810
    If one and the same parser is assigned to several class variables
811
    such as, for example, the parser `expression` in the example above,
812
    which is also assigned to `root__`, the first name sticks.
813
814
815
816
817
818
819
820
821
822
823
824

    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:

825
    Class Attributes:
826
827
828
829
        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.
830

831
832
833
        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
834

835
836
837
838
839
        anonymous__: A regular expression to identify names of parsers that are
                assigned to class fields but shall never the less yield anonymous
                nodes (i.e. nodes the tag name of which starts with a colon ":"
                followed by the parser's class name). The default is to treat all
                parsers starting with an underscore as anonymous in addition to those
840
841
                parsers that are not directly assigned to a class field.

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

848
849
850
851
852
853
854
        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.
855

eckhart's avatar
eckhart committed
856
857
858
859
        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`).

860
    Instance Attributes:
861
862
        all_parsers__:  A set of all parsers connected to this grammar object

863
864
        comment_rx__:  The compiled regular expression for comments. If no
                comments have been defined, it defaults to RX_NEVER_MATCH
865
866
                This instance-attribute will only be defined if a class-attribute
                with the same name does not already exist!
867

eckhart's avatar
eckhart committed
868
869
870
871
        start_parser__:  During parsing, the parser with which the parsing process
                was started (see method `__call__`) or `None` if no parsing process
                is running.

872
873
874
875
876
877
878
        _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
879
880
        document_length__:  the length of the document.

881
882
        document_lbreaks__ (property):  list of linebreaks within the document,
                starting with -1 and ending with EOF. This helps generating line
883
                and column number for history recording and will only be
884
                initialized if :attr:`history_tracking__` is true.
885

886
887
888
889
890
        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.

891
        _reversed__:  the same text in reverse order - needed by the `Lookbehind`-
892
893
894
                parsers.

        variables__:  A mapping for variable names to a stack of their respective
895
896
                string values - needed by the :class:`Capture`-, :class:`Retrieve`-
                and :class:`Pop`-parsers.
897
898

        rollback__:  A list of tuples (location, rollback-function) that are
899
900
901
902
                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.
903
904
905

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

di68kap's avatar
di68kap committed
912
913
914
        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.
915
                This is required for recording the parser history (for debugging)
916
917
918
                and, eventually, i.e. one day in the future, for tracing through
                the parsing process.

919
920
921
922
        history__:  A list of history records. A history record is appended to
                the list each time a parser either matches, fails or if a
                parser-error occurs. See class `log.HistoryRecord`. History
                records store copies of the current call stack.
923
924
925
926

        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
927
                recording is turned off! (See :func:`Parser.__call__`)
928
929
930
931

        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
932
933
934
935
936
                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.
937

938
939
940
        most_recent_error__: The most recent parser error that has occurred
                or `None`. This can be read by tracers. See module `trace`

941
942
943
944
945
        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)

946
947
948
949
        # Configuration parameters. These values of theses parameters are copied
                from the global configuration in the constructor of the Grammar
                object. (see mpodule `configuration.py`)

950
951
952
        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.
953
                Default is on.
954
955
956

        left_recursion_depth__: the maximum allowed depth for left-recursion.
                A depth of zero means that no left recursion handling will
957
                take place. Default is 5.
958
959
960

        max_parser_dropouts__: Maximum allowed number of retries after errors
                where the parser would exit before the complete document has
961
962
                been parsed. Default is 1, as usually the retry-attemts lead
                to a proliferation of senseless error messages.
963
964
965

        reentry_search_window__: The number of following characters that the
                parser considers when searching a reentry point when a syntax error
966
967
968
969
970
971
972
973
974
                has been encountered. Default is 10.000 characters.

        history_tracking__:  A flag indicating that the parsing history shall
                be tracked. Default is off.

        resume_notices__: When resuming after an error a notice message is added
               in addition to the error message to report where, and, if history
               tracking is turned on, with which parser the parsing process
               will be resumed. Default is off.
975
    """
eckhart's avatar
eckhart committed
976
    python_src__ = ''  # type: str
977
    root__ = PARSER_PLACEHOLDER  # type: Parser
978
    # root__ must be overwritten with the root-parser by grammar subclass
eckhart's avatar
eckhart committed
979
    parser_initialization__ = ["pending"]  # type: List[str]
eckhart's avatar
eckhart committed
980
    resume_rules__ = dict()  # type: Dict[str, ResumeList]
981
    anonymous__ = RX_NEVER_MATCH  # type: RxPatternType
982
    # some default values
eckhart's avatar
eckhart committed
983
984
    COMMENT__ = r''  # type: str  # r'#.*(?:\n|$)'
    WSP_RE__ = mixin_comment(whitespace=r'[\t ]*', comment=COMMENT__)  # type: str
985
    static_analysis_pending__ = [True]  # type: List[bool]
986
987
988
989
990


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

995
996
            class Grammar(Grammar):
                ...
997
                symbol = RE(r'(?!\\d)\\w+')
998

di68kap's avatar
di68kap committed
999
        After the call of this method symbol.pname == "symbol" holds.
di68kap's avatar
di68kap committed
1000
        Parser names starting or ending with a double underscore like