parser.py 81.5 KB
Newer Older
1
"""parsers.py - parser combinators for 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
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

Module ``parsers.py`` contains a number of classes that together
make up parser combinators for left-recursive grammers. For each
element of the extended Backus-Naur-Form as well as for a regular
expression token a class is defined. The set of classes can be used to
define a parser for (ambiguous) left-recursive grammers.


References and Acknowledgements:

Dominikus Herzberg: Objekt-orientierte Parser-Kombinatoren in Python,
Blog-Post, September, 18th 2008 on denkspuren. gedanken, ideen,
anregungen und links rund um informatik-themen, URL:
http://denkspuren.blogspot.de/2008/09/objekt-orientierte-parser-kombinatoren.html

Dominikus Herzberg: Eine einfache Grammatik für LaTeX, Blog-Post,
September, 18th 2008 on denkspuren. gedanken, ideen, anregungen und
links rund um informatik-themen, URL:
http://denkspuren.blogspot.de/2008/09/eine-einfache-grammatik-fr-latex.html

Dominikus Herzberg: Uniform Syntax, Blog-Post, February, 27th 2007 on
denkspuren. gedanken, ideen, anregungen und links rund um
informatik-themen, URL:
http://denkspuren.blogspot.de/2007/02/uniform-syntax.html

Richard A. Frost, Rahmatullah Hafiz and Paul Callaghan: Parser
Combinators for Ambiguous Left-Recursive Grammars, in: P. Hudak and
D.S. Warren (Eds.): PADL 2008, LNCS 4902, pp. 167–181, Springer-Verlag
Berlin Heidelberg 2008.

47
48
49
50
Elizabeth Scott and Adrian Johnstone, GLL Parsing,
in: Electronic Notes in Theoretical Computer Science 253 (2010) 177–189,
http://dotat.at/tmp/gll.pdf

Eckhart Arnold's avatar
Eckhart Arnold committed
51
52
Juancarlo Añez: grako, a PEG parser generator in Python,
https://bitbucket.org/apalala/grako
53
54
55

Vegard Øye: General Parser Combinators in Racket, 2012,
https://epsil.github.io/gll/
56
57
"""

58

Eckhart Arnold's avatar
Eckhart Arnold committed
59
import abc
60
import copy
61
import os
Eckhart Arnold's avatar
Eckhart Arnold committed
62
63
from functools import partial

64
65
66
67
try:
    import regex as re
except ImportError:
    import re
68
try:
69
    from typing import Any, Callable, cast, Dict, Iterator, List, Set, Tuple, Union, Optional
70
71
72
73
    # try:
    #     from typing import Collection
    # except ImportError:
    #     pass
74
except ImportError:
75
    from .typing34 import Any, Callable, cast, Dict, Iterator, List, Set, Tuple, Union, Optional
76

77
from DHParser.toolkit import is_logging, log_dir, logfile_basename, escape_re, sane_parser_name
78
79
from DHParser.syntaxtree import Node, TransformationFunc, ParserBase, WHITESPACE_PTYPE, TOKEN_PTYPE, \
    ZOMBIE_PARSER
80
from DHParser.error import Error, is_error, has_errors, linebreaks, line_col
81
from DHParser.toolkit import load_if_file
82
83
84
85
86
try:
    import pyximport; pyximport.install()
    from DHParser.cstringview import StringView, EMPTY_STRING_VIEW
except ImportError:
    from DHParser.stringview import StringView, EMPTY_STRING_VIEW
Eckhart Arnold's avatar
Eckhart Arnold committed
87

88
__all__ = ('PreprocessorFunc',
89
           'HistoryRecord',
Eckhart Arnold's avatar
Eckhart Arnold committed
90
           'Parser',
91
           'Grammar',
92
93
94
           'RX_PREPROCESSOR_TOKEN',
           'BEGIN_TOKEN',
           'END_TOKEN',
Eckhart Arnold's avatar
Eckhart Arnold committed
95
           'make_token',
96
97
           'nil_preprocessor',
           'PreprocessorToken',
Eckhart Arnold's avatar
Eckhart Arnold committed
98
99
100
101
           'RegExp',
           'RE',
           'Token',
           'mixin_comment',
102
103
104
           # 'UnaryOperator',
           # 'NaryOperator',
           'Synonym',
105
           'Option',
Eckhart Arnold's avatar
Eckhart Arnold committed
106
107
           'ZeroOrMore',
           'OneOrMore',
108
           'Series',
Eckhart Arnold's avatar
Eckhart Arnold committed
109
110
111
112
113
114
115
           'Alternative',
           'FlowOperator',
           'Required',
           'Lookahead',
           'NegativeLookahead',
           'Lookbehind',
           'NegativeLookbehind',
116
117
118
           'last_value',
           'counterpart',
           'accumulate',
Eckhart Arnold's avatar
Eckhart Arnold committed
119
120
121
122
           'Capture',
           'Retrieve',
           'Pop',
           'Forward',
123
           'Compiler',
124
           'compile_source')
Eckhart Arnold's avatar
Eckhart Arnold committed
125

126

127

128
129
130
131
132
133
134
########################################################################
#
# Grammar and parsing infrastructure
#
########################################################################


135
PreprocessorFunc = Union[Callable[[str], str], partial]
136
137


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

144

145
146
147
148
149
150
151
152
153
154
155
156
157
class HistoryRecord:
    """
    Stores debugging information about one completed step in the
    parsing history. 

    A parsing step is "completed" when the last one of a nested
    sequence of parser-calls returns. The call stack including
    the last parser call will be frozen in the ``HistoryRecord``-
    object. In addition a reference to the generated leaf node
    (if any) will be stored and the result status of the last
    parser call, which ist either MATCH, FAIL (i.e. no match)
    or ERROR.
    """
158
    __slots__ = ('call_stack', 'node', 'remaining', 'line_col')
159
160
161
162
163

    MATCH = "MATCH"
    ERROR = "ERROR"
    FAIL = "FAIL"

164
    def __init__(self, call_stack: List['Parser'], node: Node, remaining: int) -> None:
165
        # copy call stack, dropping uninformative Forward-Parsers
Eckhart Arnold's avatar
Eckhart Arnold committed
166
        self.call_stack = [p for p in call_stack if p.ptype != ":Forward"]  # type: List['Parser']
167
168
        self.node = node                # type: Node
        self.remaining = remaining      # type: int
169
170
        self.line_col = (1, 1)          # type: Tuple[int, int]
        if call_stack:
171
172
173
174
            grammar = call_stack[-1].grammar
            document = grammar.document__
            lbreaks = grammar.document_lbreaks__
            self.line_col = line_col(lbreaks, len(document) - remaining)
175
176
177
178

    def __str__(self):
        return 'line %i, column %i:  %s  "%s"' % \
               (self.line_col[0], self.line_col[1], self.stack, str(self.node))
179

180
    def err_msg(self) -> str:
181
        return self.ERROR + ": " + "; ".join(str(e) for e in self.node._errors).replace('\n', '\\')
182

183
    @property
184
    def stack(self) -> str:
185
        return "->".join((p.repr if p.ptype == ':RegExp' else p.name or p.ptype)
186
                         for p in self.call_stack)
187
188

    @property
189
    def status(self) -> str:
190
        return self.FAIL if self.node is None else \
191
            self.err_msg() if has_errors(self.node._errors) else self.MATCH
192
193

    @property
194
    def extent(self) -> slice:
195
        return (slice(-self.remaining - len(self.node), -self.remaining) if self.node
196
                else slice(-self.remaining, None))
197

198
    @staticmethod
Eckhart Arnold's avatar
Eckhart Arnold committed
199
    def last_match(history: List['HistoryRecord']) -> Union['HistoryRecord', None]:
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
        """
        Returns the last match from the parsing-history.
        Args:
            history:  the parsing-history as a list of HistoryRecord objects

        Returns:
            the history record of the last match or none if either history is
            empty or no parser could match
        """
        for record in reversed(history):
            if record.status == HistoryRecord.MATCH:
                return record
        return None

    @staticmethod
Eckhart Arnold's avatar
Eckhart Arnold committed
215
    def most_advanced_match(history: List['HistoryRecord']) -> Union['HistoryRecord', None]:
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
        """
        Returns the closest-to-the-end-match from the parsing-history.
        Args:
            history:  the parsing-history as a list of HistoryRecord objects

        Returns:
            the history record of the closest-to-the-end-match or none if either history is
            empty or no parser could match
        """
        remaining = -1
        result = None
        for record in history:
            if (record.status == HistoryRecord.MATCH and
                    (record.remaining < remaining or remaining < 0)):
                result = record
                remaining = record.remaining
        return result


235
def add_parser_guard(parser_func):
236
237
238
239
240
    """
    Add a wrapper function to a parser functions (i.e. Parser.__call__ method)
    that takes care of memoizing, left recursion and optionally tracing
    (aka "history tracking") of parser calls. Returns the wrapped call.
    """
241
    def guarded_call(parser: 'Parser', text: StringView) -> Tuple[Node, StringView]:
di68kap's avatar
di68kap committed
242
243
244
245
246
247
248
249
250
251
252
        # def memoized(parser, location):
        #     node = parser.visited[location]
        #     rlen = location - (0 if node is None else node.len)
        #     rest = grammar.document__[-rlen:] if rlen else EMPTY_STRING_VIEW
        #     return node, rest
        #     # NOTE: An older and simpler implementation of memoization
        #     # relied on `parser.visited[location] == node, rest`. Although,
        #     # rest is really just a substring of one and the same document,
        #     # this resulted in an explosion of memory usage. Seems that
        #     # `rext = text[i:]` really copies the sub-string. See:
        #     # https://mail.python.org/pipermail/python-dev/2008-May/079699.html
253

254
        try:
255
            location = len(text)    # mind that location is always the distance to the end
256
257
            grammar = parser.grammar  # grammar may be 'None' for unconnected parsers!

258
259
            if grammar.last_rb__loc__ <= location:
                grammar.rollback_to__(location)
260

261
262
263
            # if location has already been visited by the current parser,
            # return saved result
            if location in parser.visited:
di68kap's avatar
di68kap committed
264
                return parser.visited[location]
265

Eckhart Arnold's avatar
Eckhart Arnold committed
266
267
            if grammar.history_tracking__:
                grammar.call_stack__.append(parser)
268
                grammar.moving_forward__ = True
Eckhart Arnold's avatar
Eckhart Arnold committed
269

270
271
272
273
274
275
            # break left recursion at the maximum allowed depth
            if grammar.left_recursion_handling__:
                if parser.recursion_counter.setdefault(location, 0) > LEFT_RECURSION_DEPTH:
                    grammar.recursion_locations__.add(location)
                    return None, text
                parser.recursion_counter[location] += 1
276
277
278
279

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

280
281
282
            if grammar.left_recursion_handling__:
                parser.recursion_counter[location] -= 1

283
            if node is None:
284
                # retrieve an earlier match result (from left recursion) if it exists
285
286
                if location in grammar.recursion_locations__:
                    if location in parser.visited:
di68kap's avatar
di68kap committed
287
                        node, rest = parser.visited[location]
288
                        # TODO: maybe add a warning about occurrence of left-recursion here?
289
290
291
                    # 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__:
292
                    # otherwise also cache None-results
di68kap's avatar
di68kap committed
293
                    parser.visited[location] = (None, rest)
Eckhart Arnold's avatar
Eckhart Arnold committed
294
295
            elif (grammar.last_rb__loc__ > location
                  and (grammar.memoization__ or location in grammar.recursion_locations__)):
296
297
298
299
                # - 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
di68kap's avatar
di68kap committed
300
                parser.visited[location] = (node, rest)
301

302
            if grammar.history_tracking__:
303
                # don't track returning parsers except in case an error has occurred
304
                remaining = len(rest)
305
                if grammar.moving_forward__ or (node and node._errors):
306
                    record = HistoryRecord(grammar.call_stack__, node, remaining)
307
                    grammar.history__.append(record)
308
                    # print(record.stack, record.status, rest[:20].replace('\n', '|'))
309
                grammar.moving_forward__ = False
310
                grammar.call_stack__.pop()
311

312
        except RecursionError:
313
            node = Node(None, str(text[:min(10, max(1, text.find("\n")))]) + " ...")
314
315
            node.add_error("maximum recursion depth of parser reached; "
                           "potentially due to too many errors!")
316
            rest = EMPTY_STRING_VIEW
317
318
319
320
321
322

        return node, rest

    return guarded_call


Eckhart Arnold's avatar
Eckhart Arnold committed
323
class ParserMetaClass(abc.ABCMeta):
324
325
326
327
328
    """
    ParserMetaClass adds a wrapper to the __call__ method of parser
    objects during initialization that takes care of memoizing,
    left recursion and tracing.
    """
329
    def __init__(cls, name, bases, attrs):
330
331
        guarded_parser_call = add_parser_guard(cls.__call__)
        # The following check is necessary for classes that don't override
332
333
334
335
336
337
338
        # the __call__() method, because in these cases the non-overridden
        # __call__()-method would be substituted a second time!
        if cls.__call__.__code__ != guarded_parser_call.__code__:
            cls.__call__ = guarded_parser_call
        super(ParserMetaClass, cls).__init__(name, bases, attrs)


Eckhart Arnold's avatar
Eckhart Arnold committed
339
class Parser(ParserBase, metaclass=ParserMetaClass):
340
341
342
343
    """
    (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.
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360

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

    There are two different types of parsers:

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

    2. *Anonymous parsers* where the name-field just contains the empty
       string. AST-transformation of Anonymous parsers can be hooked
       only to their class name, and not to the individual parser.
Eckhart Arnold's avatar
Eckhart Arnold committed
361
362

    Parser objects are callable and parsing is done by calling a parser
Eckhart Arnold's avatar
Eckhart Arnold committed
363
364
365
366
367
368
    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
369
    `ZeroOrMore` or `Option`). If `i > 0` then the parser has "moved
Eckhart Arnold's avatar
Eckhart Arnold committed
370
371
372
373
374
375
    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.
376
377

    Attributes:
378
        visited:  Mapping of places this parser has already been to
di68kap's avatar
di68kap committed
379
                during the current parsing process onto the results the
380
381
382
383
384
385
386
387
                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.

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

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

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

399
400
    def __init__(self, name: str = '') -> None:
        # assert isinstance(name, str), str(name)
Eckhart Arnold's avatar
Eckhart Arnold committed
401
        super(Parser, self).__init__(name)
402
        self._grammar = None  # type: 'Grammar'
403
404
        self.reset()

Eckhart Arnold's avatar
Eckhart Arnold committed
405
    def __deepcopy__(self, memo):
Eckhart Arnold's avatar
Eckhart Arnold committed
406
407
408
409
410
411
        """Deepcopy method of the parser. Upon instantiation of a Grammar-
        object, parsers will be deep-copied to the Grammar object. If a
        derived parser-class changes the signature of the constructor,
        `__deepcopy__`-method must be replaced (i.e. overridden without
        calling the same method from the superclass) by the derived class.
        """
412
413
        return self.__class__(self.name)

414
    def reset(self):
Eckhart Arnold's avatar
Eckhart Arnold committed
415
416
417
        """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."""
di68kap's avatar
di68kap committed
418
        self.visited = dict()            # type: Dict[int, Tuple[Node, StringView]]
419
        self.recursion_counter = dict()  # type: Dict[int, int]
420
        self.cycle_detection = set()     # type: Set[Callable]
421
        return self
422

423
    def __call__(self, text: StringView) -> Tuple[Node, StringView]:
Eckhart Arnold's avatar
Eckhart Arnold committed
424
425
426
        """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."""
427
428
        return None, text  # default behaviour: don't match

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

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

440
    @property
441
    def grammar(self) -> 'Grammar':
442
443
444
        return self._grammar

    @grammar.setter
445
    def grammar(self, grammar: 'Grammar'):
Eckhart Arnold's avatar
Eckhart Arnold committed
446
447
448
449
450
451
        if self._grammar is None:
            self._grammar = grammar
            self._grammar_assigned_notifier()
        else:
            assert self._grammar == grammar, \
                "Parser has already been assigned to a different Grammar object!"
452
453

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

458
    def apply(self, func: ApplyFunc):
459
460
        """
        Applies function `func(parser)` recursively to this parser and all
Eckhart Arnold's avatar
Eckhart Arnold committed
461
        descendant parsers if any exist. The same function can never
462
463
464
465
466
467
468
469
470
471
        be applied twice between calls of the ``reset()``-method!
        """
        if func in self.cycle_detection:
            return False
        else:
            self.cycle_detection.add(func)
            func(self)
            return True


472
def mixin_comment(whitespace: str, comment: str) -> str:
473
474
    """
    Returns a regular expression that merges comment and whitespace
475
476
477
478
479
480
481
482
483
484
485
    regexps. Thus comments cann occur whereever whitespace is allowed
    and will be skipped just as implicit whitespace.

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


486
class Grammar:
487
    """
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
    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.

    Example for direct instantian of a grammar:

        >>> number = RE('\d+') + RE('\.') + RE('\d+') | RE('\d+')
        >>> number_parser = Grammar(number)
Eckhart Arnold's avatar
Eckhart Arnold committed
503
        >>> number_parser("3.1416").content()
504
505
        '3.1416'

Eckhart Arnold's avatar
Eckhart Arnold committed
506
    Collecting the parsers that define a grammar in a descendant class of
507
508
509
510
511
512
513
    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
Eckhart Arnold's avatar
Eckhart Arnold committed
514
515
       assign them to class variables, which results in better
       readability of the Python code.
516

Eckhart Arnold's avatar
Eckhart Arnold committed
517
518
519
    3. The parsers in the class do not necessarily need to be connected
       to one single root parser, which is helpful for testing and
       building up a parser successively of several components.
520
521
522
523
524
525

    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.
526
527

    Example:
528

529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
        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+')
            factor = INTEGER | Token("(") + expression + Token(")")
            term = factor + ZeroOrMore((Token("*") | Token("/")) + factor)
            expression.set(term + ZeroOrMore((Token("+") | Token("-")) + term))
            root__ = expression

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

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

561
    Grammar classes contain a few special class fields for implicit
562
563
    whitespace and comments that should be overwritten, if the defaults
    (no comments, horizontal right aligned whitespace) don't fit:
564
565
    COMMENT__:  regular expression string for matching comments
    WSP__:   regular expression for whitespace and comments
Eckhart Arnold's avatar
Eckhart Arnold committed
566

567
568
    wspL__:  regular expression string for left aligned whitespace,
             which either equals WSP__ or is empty.
Eckhart Arnold's avatar
Eckhart Arnold committed
569

570
571
    wspR__:  regular expression string for right aligned whitespace,
             which either equals WSP__ or is empty.
Eckhart Arnold's avatar
Eckhart Arnold committed
572

573
574
575
576
    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.
Eckhart Arnold's avatar
Eckhart Arnold committed
577

578
579
580
581
582
583
584
585
586
    parser_initializiation__:  Before the parser class (!) has been initialized,
             which happens upon the first time it is instantiated (see doctring for
             method `_assign_parser_names()` for an explanation), this class
             field contains a value other than "done". A value of "done" indicates
             that the class has already been initialized.

    Attributes:
        all_parsers__:  A set of all parsers connected to this grammar object

Eckhart Arnold's avatar
Eckhart Arnold committed
587
        history_tracking__:  A flag indicating that the parsing history shall
588
589
590
591
592
593
594
                be tracked

        wsp_left_parser__:  A parser for the default left-adjacent-whitespace
                or the zombie-parser (see `syntaxtree.ZOMBIE_PARSER`) if the
                default is empty. The default whitespace will be used by parsers
                `Token` and, if no other parsers are passed to its constructor,
                by parser `RE'.
Eckhart Arnold's avatar
Eckhart Arnold committed
595

596
597
598
599
600
601
602
603
604
605
606
        wsp_right_parser__: The same for the default right-adjacent-whitespace.
                Both wsp_left_parser__ and wsp_right_parser__ merely serve the
                purpose to avoid having to specify the default whitespace
                explicitly every time an `RE`-parser-object is created.

        _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 Arnold's avatar
Eckhart Arnold committed
607

608
609
610
611
612
        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
                initialized if `history_tracking__` is true.

613
614
        _reversed__:  the same text in reverse order - needed by the `Lookbehind'-
                parsers.
Eckhart Arnold's avatar
Eckhart Arnold committed
615

616
617
618
        variables__:  A mapping for variable names to a stack of their respective
                string values - needed by the `Capture`-, `Retrieve`- and `Pop`-
                parsers.
Eckhart Arnold's avatar
Eckhart Arnold committed
619

620
621
622
623
624
        rollback__:  A list of tuples (location, rollback-function) that are
                deposited by the `Capture`- and `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.
Eckhart Arnold's avatar
Eckhart Arnold committed
625

626
627
628
629
630
631
632
633
        last_rb__loc__:  The last, i.e. most advanced location in the text
                where a variable changing operation occurred. If the parser
                backtracks to a location at or before `last_rb__loc__` (which,
                since locations are counted from the reverse, means:
                `location >= last_rb__loc__`) then a rollback of all variable
                changing operations is necessary that occurred after the
                location to which the parser backtracks. This is done by
                calling method `.rollback_to__(location)`.
Eckhart Arnold's avatar
Eckhart Arnold committed
634

635
636
637
638
        call_stack__:  A stack of all parsers that have been called. This
                is required for recording the parser history (for debugging)
                and, eventually, i.e. one day in the future, for tracing through
                the parsing process.
Eckhart Arnold's avatar
Eckhart Arnold committed
639

640
641
642
        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.
Eckhart Arnold's avatar
Eckhart Arnold committed
643

644
645
646
647
648
        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
                recording is turned off! (See `add_parser_guard` and its local
                function `guarded_call`)
Eckhart Arnold's avatar
Eckhart Arnold committed
649

650
651
652
653
654
        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
                if full memoization is enabled. (See `add_parser_guard` and its
                local function `guarded_call`)
Eckhart Arnold's avatar
Eckhart Arnold committed
655

656
657
658
        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
659
660
661
662
663
                it is safer to leave it on. (Default: on)

        left_recursion_handling__:  Turns left recursion handling on or off.
                If turned off, a recursion error will result in case of left
                recursion.
664
    """
665
666
    root__ = None  # type: Union[Parser, None]
    # root__ must be overwritten with the root-parser by grammar subclass
Eckhart Arnold's avatar
Eckhart Arnold committed
667
    parser_initialization__ = "pending"  # type: str
668
    # some default values
Eckhart Arnold's avatar
Eckhart Arnold committed
669
670
671
672
    COMMENT__ = r''  # type: str  # r'#.*(?:\n|$)'
    WSP__ = mixin_comment(whitespace=r'[\t ]*', comment=COMMENT__)  # type: str
    wspL__ = ''     # type: str
    wspR__ = WSP__  # type: str
673

674

675
    @classmethod
676
    def _assign_parser_names__(cls):
677
678
        """
        Initializes the `parser.name` fields of those
679
680
        Parser objects that are directly assigned to a class field with
        the field's name, e.g.
681
            class Grammar(Grammar):
682
683
684
                ...
                symbol = RE('(?!\\d)\\w+')
        After the call of this method symbol.name == "symbol"
685
686
687
688
        holds. Names assigned via the ``name``-parameter of the
        constructor will not be overwritten. Parser names starting or
        ending with a double underscore like ``root__`` will be
        ignored. See ``toolkit.sane_parser_name()``
689
690
691
692

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

693
694
695
696
697
        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. 
698
        """
699
700
701
702
703
        if cls.parser_initialization__ != "done":
            cdict = cls.__dict__
            for entry, parser in cdict.items():
                if isinstance(parser, Parser) and sane_parser_name(entry):
                    if not parser.name:
704
705
706
                        parser._name = entry
                    if (isinstance(parser, Forward) and (not parser.parser._name)):
                        parser.parser._name = entry
707
            cls.parser_initialization__ = "done"
708

709

Eckhart Arnold's avatar
Eckhart Arnold committed
710
711
712
    def __init__(self, root: Parser=None) -> None:
        # if not hasattr(self.__class__, 'parser_initialization__'):
        #     self.__class__.parser_initialization__ = "pending"
713
714
715
716
        # if not hasattr(self.__class__, 'wspL__'):
        #     self.wspL__ = ''
        # if not hasattr(self.__class__, 'wspR__'):
        #     self.wspR__ = ''
717
718
719
720
        self.all_parsers__ = set()             # type: Set[Parser]
        self._dirty_flag__ = False             # type: bool
        self.history_tracking__ = False        # type: bool
        self.memoization__ = True              # type: bool
721
        self.left_recursion_handling__ = True  # type: bool
722
        self._reset__()
723

Eckhart Arnold's avatar
Eckhart Arnold committed
724
        # prepare parsers in the class, first
725
        self._assign_parser_names__()
726

Eckhart Arnold's avatar
Eckhart Arnold committed
727
728
729
730
        # 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 Arnold's avatar
Eckhart Arnold committed
731
        self.root__ = copy.deepcopy(root) if root else copy.deepcopy(self.__class__.root__)
732

733
        if self.wspL__:
Eckhart Arnold's avatar
Eckhart Arnold committed
734
            self.wsp_left_parser__ = Whitespace(self.wspL__)  # type: ParserBase
735
            self.wsp_left_parser__.grammar = self
736
            self.all_parsers__.add(self.wsp_left_parser__)  # don't you forget about me...
737
738
739
        else:
            self.wsp_left_parser__ = ZOMBIE_PARSER
        if self.wspR__:
Eckhart Arnold's avatar
Eckhart Arnold committed
740
            self.wsp_right_parser__ = Whitespace(self.wspR__)  # type: ParserBase
741
            self.wsp_right_parser__.grammar = self
742
            self.all_parsers__.add(self.wsp_right_parser__)  # don't you forget about me...
743
744
        else:
            self.wsp_right_parser__ = ZOMBIE_PARSER
745
        self.root__.apply(self._add_parser__)
746

747

748
    def __getitem__(self, key):
749
750
751
        try:
            return self.__dict__[key]
        except KeyError:
752
753
            parser_template = getattr(self, key, None)
            if parser_template:
Eckhart Arnold's avatar
Eckhart Arnold committed
754
                # add parser to grammar object on the fly...
755
                parser = copy.deepcopy(parser_template)
756
                parser.apply(self._add_parser__)
757
                # assert self[key] == parser
Eckhart Arnold's avatar
Eckhart Arnold committed
758
                return self[key]
759
            raise KeyError('Unknown parser "%s" !' % key)
760

761

762
    def _reset__(self):
763
764
        self.document__ = EMPTY_STRING_VIEW   # type: StringView
        self._reversed__ = EMPTY_STRING_VIEW  # type: StringView
765
        self.document_lbreaks__ = []          # type: List[int]
766
        # variables stored and recalled by Capture and Retrieve parsers
767
768
        self.variables__ = dict()     # type: Dict[str, List[str]]
        self.rollback__ = []          # type: List[Tuple[int, Callable]]
769
        self.last_rb__loc__ = -1  # type: int
770
        # support for call stack tracing
771
        self.call_stack__ = []        # type: List[Parser]
772
        # snapshots of call stacks
773
        self.history__ = []           # type: List[HistoryRecord]
774
        # also needed for call stack tracing
775
776
        self.moving_forward__ = False  # type: bool
        self.recursion_locations__ = set()  # type: Set[int]
777

778

Eckhart Arnold's avatar
Eckhart Arnold committed
779
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
780
    def reversed__(self) -> StringView:
Eckhart Arnold's avatar
Eckhart Arnold committed
781
        if not self._reversed__:
782
            self._reversed__ = StringView(self.document__.text[::-1])
Eckhart Arnold's avatar
Eckhart Arnold committed
783
784
785
        return self._reversed__


786
    def _add_parser__(self, parser: Parser) -> None:
787
788
        """
        Adds the particular copy of the parser object to this
789
        particular instance of Grammar.
790
        """
791
        if parser.name:
Eckhart Arnold's avatar
Eckhart Arnold committed
792
793
794
            # prevent overwriting instance variables or parsers of a different class
            assert parser.name not in self.__dict__ or \
                   isinstance(self.__dict__[parser.name], parser.__class__), \
795
796
                ('Cannot add parser "%s" because a field with the same name '
                 'already exists in grammar object!' % parser.name)
797
            setattr(self, parser.name, parser)
798
        self.all_parsers__.add(parser)
799
800
        parser.grammar = self

801

Eckhart Arnold's avatar
Eckhart Arnold committed
802
    def __call__(self, document: str, start_parser="root__") -> Node:
803
804
        """
        Parses a document with with parser-combinators.
805
806
807

        Args:
            document (str): The source text to be parsed.
808
809
810
            start_parser (str): The name of the parser with which to
                start. This is useful for testing particular parsers
                (i.e. particular parts of the EBNF-Grammar.)
811
812
813
        Returns:
            Node: The root node ot the parse tree.
        """
814
        # assert isinstance(document, str), type(document)
815
816
        if self.root__ is None:
            raise NotImplementedError()
817
        if self._dirty_flag__:
818
            self._reset__()
819
            for parser in self.all_parsers__:
820
821
                parser.reset()
        else:
822
            self._dirty_flag__ = True
823
        self.history_tracking__ = is_logging()
824
        self.document__ = StringView(document)
825
        self.document_lbreaks__ = linebreaks(document) if self.history_tracking__ else []
826
        self.last_rb__loc__ = len(self.document__) + 1  # rollback location
Eckhart Arnold's avatar
Eckhart Arnold committed
827
        parser = self[start_parser] if isinstance(start_parser, str) else start_parser
828
829
        assert parser.grammar == self, "Cannot run parsers from a different grammar object!" \
                                       " %s vs. %s" % (str(self), str(parser.grammar))
830
        stitches = []  # type: List[Node]
831
        rest = self.document__
832
833
        if not rest:
            result, ignore = parser(rest)
di68kap's avatar
di68kap committed
834
835
836
            if result is None:
                result = Node(None, '')
                result.add_error('Parser "%s" did not match empty document.' % str(parser))
837
838
839
840
841
842
        while rest and len(stitches) < MAX_DROPOUTS:
            result, rest = parser(rest)
            if rest:
                fwd = rest.find("\n") + 1 or len(rest)
                skip, rest = rest[:fwd], rest[fwd:]
                if result is None:
843
844
845
846
                    error_msg = 'Parser did not match! Invalid source file?' \
                                '\n    Most advanced: %s\n    Last match:    %s;' % \
                                (str(HistoryRecord.most_advanced_match(self.history__)),
                                 str(HistoryRecord.last_match(self.history__)))
847
848
849
                else:
                    stitches.append(result)
                    error_msg = "Parser stopped before end" + \
850
851
                                (("! trying to recover" +
                                  (" but stopping history recording at this point."
852
                                   if self.history_tracking__ else "..."))
853
854
855
856
                                 if len(stitches) < MAX_DROPOUTS
                                 else " too often! Terminating parser.")
                stitches.append(Node(None, skip))
                stitches[-1].add_error(error_msg)
857
                if self.history_tracking__:
858
                    # some parsers may have matched and left history records with nodes != None.
859
                    # Because these are not connected to the stitched root node, their pos-
860
861
                    # properties will not be initialized by setting the root node's pos property
                    # to zero. Therefore, their pos properties need to be initialized here
862
                    for record in self.history__:
863
864
                        if record.node and record.node._pos < 0:
                            record.node.pos = 0
865
866
867
                    record = HistoryRecord(self.call_stack__.copy(), stitches[-1], len(rest))
                    self.history__.append(record)
                    self.history_tracking__ = False
868
869
870
871
        if stitches:
            if rest:
                stitches.append(Node(None, rest))
            result = Node(None, tuple(stitches))
872
        if any(self.variables__.values()):
Eckhart Arnold's avatar
Eckhart Arnold committed
873
874
875
876
877
878
879
880
881
882
883
            error_str = "Capture-retrieve-stack not empty after end of parsing: " + \
                            str(self.variables__)
            if result.children:
                # add another child node at the end to ensure that the position
                # of the error will be the end of the text. Otherwise, the error
                # message above ("...after end of parsing") would appear illogical.
                error_node = Node(ZOMBIE_PARSER, '')
                error_node.add_error(error_str)
                result.result = result.children + (error_node,)
            else:
                result.add_error(error_str)
884
        result.pos = 0  # calculate all positions
885
        # result.collect_errors(self.document__)
886
887
        return result

888

889
    def push_rollback__(self, location, func):
890
891
        """
        Adds a rollback function that either removes or re-adds
892
893
894
895
        values on the variable stack (`self.variables`) that have been
        added (or removed) by Capture or Pop Parsers, the results of
        which have been dismissed.
        """
896
        self.rollback__.append((location, func))
897
        # print("push:  line %i, col %i" % line_col(self.document__, len(self.document__) - location))
898
899
        self.last_rb__loc__ = location

900

901
    def rollback_to__(self, location):
902
903
        """
        Rolls back the variable stacks (`self.variables`) to its
904
905
        state at an earlier location in the parsed document.
        """
906
        # print("rollback:  line %i, col %i" % line_col(self.document__, len(self.document__) - location))
907
908
        while self.rollback__ and self.rollback__[-1][0] <= location:
            loc, rollback_func = self.rollback__.pop()
909
910
911
912
            # assert not loc > self.last_rb__loc__, \
            #     "Rollback confusion: line %i, col %i < line %i, col %i" % \
            #     (*line_col(self.document__, len(self.document__) - loc),
            #      *line_col(self.document__, len(self.document__) - self.last_rb__loc__))
913
            rollback_func()
914
            # print("rb to:  line %i, col %i" % line_col(self.document__, len(self.document__) - loc))
915
916
917
        self.last_rb__loc__ == self.rollback__[-1][0] if self.rollback__ \
            else (len(self.document__) + 1)

918

919
    def log_parsing_history__(self, log_file_name: str = '') -> None:
920
921
        """
        Writes a log of the parsing history of the most recently parsed
922
923
924
        document. 
        """
        def prepare_line(record):
925
            excerpt = self.document__.text.__getitem__(record.extent)[:25].replace('\n', '\\n')
926
            excerpt = "'%s'" % excerpt if len(excerpt) < 25 else "'%s...'" % excerpt
927
            return record.stack, record.status, excerpt
928
929

        def write_log(history, log_name):
Eckhart Arnold's avatar
Eckhart Arnold committed
930
            path = os.path.join(log_dir(), log_name + "_parser.log")
Eckhart Arnold's avatar
Eckhart Arnold committed
931
932
933
            if os.path.exists(path):
                os.remove(path)
                print('WARNING: Log-file "%s" already existed and was deleted.' % path)
934
935
936
937
            if history:
                with open(path, "w", encoding="utf-8") as f:
                    f.write("\n".join(history))

938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
        if is_logging():
            assert self.history__, \
                "Parser did not yet run or logging was turned off when running parser!"
            if not log_file_name:
                name = self.__class__.__name__
                log_file_name = name[:-7] if name.lower().endswith('grammar') else name
            full_history, match_history, errors_only = [], [], []
            for record in self.history__:
                line = ";  ".join(prepare_line(record))
                full_history.append(line)
                if record.node and record.node.parser.ptype != WHITESPACE_PTYPE:
                    match_history.append(line)
                    if record.node.error_flag:
                        errors_only.append(line)
            write_log(full_history, log_file_name + '_full')
            write_log(match_history, log_file_name + '_match')
            write_log(errors_only, log_file_name + '_errors')
955
956


Eckhart Arnold's avatar
Eckhart Arnold committed
957
def dsl_error_msg(parser: Parser, error_str: str) -> str:
958
959
    """
    Returns an error message for errors in the parser configuration,
960
961
962
    e.g. errors that result in infinite loops.

    Args:
Eckhart Arnold's avatar
Eckhart Arnold committed
963
        parser (Parser):  The parser where the error was noticed. Note
964
            that this is not necessarily the parser that caused the
965
            error but only where the error became apparent.
966
967
968
969
970
        error_str (str):  A short string describing the error.
    Returns:  
        str: An error message including the call stack if history 
        tacking has been turned in the grammar object.
    """
971
    msg = ["DSL parser specification error:", error_str, 'Caught by parser "%s".' % str(parser)]
972
973
    if parser.grammar.history__:
        msg.extend(["\nCall stack:", parser.grammar.history__[-1].stack])
974
975
976
977
978
    else:
        msg.extend(["\nEnable history tracking in Grammar object to display call stack."])
    return " ".join(msg)


979

980
981
982
983
984
985
986
########################################################################
#
# Token and Regular Expression parser classes (i.e. leaf classes)
#
########################################################################


987
988
989
RX_PREPROCESSOR_TOKEN = re.compile('\w+')
BEGIN_TOKEN = '\x1b'
END_TOKEN = '\x1c'
990
991


992
def make_token(token: str, argument: str = '') -> str:
993
994
    """
    Turns the ``token`` and ``argument`` into a special token that
995
    will be caught by the `PreprocessorToken`-parser.
996

997
998
    This function is a support function that should be used by
    preprocessors to inject preprocessor tokens into the source text.
999
    """
1000
    assert RX_PREPROCESSOR_TOKEN.match(token)