parse.py 88.8 KB
Newer Older
1
# parse.py - parser combinators for DHParser
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
#
# Copyright 2016  by Eckhart Arnold (arnold@badw.de)
#                 Bavarian Academy of Sciences an Humanities (badw.de)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.  See the License for the specific language governing
# permissions and limitations under the License.
Eckhart Arnold's avatar
Eckhart Arnold committed
17

18
19

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

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

32

33
from collections import defaultdict
34
import copy
35

36
from DHParser.error import Error, linebreaks, line_col
37
38
from DHParser.log import is_logging, HistoryRecord
from DHParser.preprocess import BEGIN_TOKEN, END_TOKEN, RX_TOKEN_NAME
39
from DHParser.stringview import StringView, EMPTY_STRING_VIEW
di68kap's avatar
di68kap committed
40
41
from DHParser.syntaxtree import Node, RootNode, WHITESPACE_PTYPE, \
    TOKEN_PTYPE, ZOMBIE, ResultType
eckhart's avatar
eckhart committed
42
from DHParser.toolkit import sane_parser_name, escape_control_characters, re, typing, cython
Eckhart Arnold's avatar
Eckhart Arnold committed
43
from typing import Callable, cast, List, Tuple, Set, Dict, DefaultDict, Union, Optional, Any
44

45

46
__all__ = ('Parser',
47
           'UnknownParserError',
48
49
           'Grammar',
           'PreprocessorToken',
50
           'Token',
51
           'RegExp',
52
53
           'RE',
           'TKN',
54
           'Whitespace',
55
           'mixin_comment',
eckhart's avatar
eckhart committed
56
57
           'UnaryOperator',
           'NaryOperator',
58
59
60
61
62
63
64
65
66
           'Synonym',
           'Option',
           'ZeroOrMore',
           'OneOrMore',
           'Series',
           'Alternative',
           'AllOf',
           'SomeOf',
           'Unordered',
eckhart's avatar
eckhart committed
67
           'Required',
68
69
70
71
72
73
74
75
76
77
           'Lookahead',
           'NegativeLookahead',
           'Lookbehind',
           'NegativeLookbehind',
           'last_value',
           'counterpart',
           'accumulate',
           'Capture',
           'Retrieve',
           'Pop',
78
           'Forward')
79
80
81
82


########################################################################
#
83
# Parser base class
84
85
86
87
88
89
90
91
92
93
94
#
########################################################################


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


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

    Currently, the only case when a `ParserError` is thrown (and not some
    different kind of error like `UnknownParserError`, is when a `Series`-
    detects a missing mandatory element.
    """
106
    def __init__(self, node: Node, rest: StringView, first_throw: bool):
Eckhart Arnold's avatar
Eckhart Arnold committed
107
108
        self.node = node  # type: Node
        self.rest = rest  # type: StringView
109
        self.first_throw = first_throw  # type: bool
Eckhart Arnold's avatar
Eckhart Arnold committed
110
111


112
ResumeList = List[Union[str, Any]]  # list of strings or regular expressiones
Eckhart Arnold's avatar
Eckhart Arnold committed
113
114


115
def reentry_point(rest: StringView, rules: ResumeList) -> int:
Eckhart Arnold's avatar
Eckhart Arnold committed
116
117
118
119
120
121
122
123
124
    """
    Finds the point where parsing should resume after a ParserError has been caught.
    Args:
        rest:  The rest of the parsed text or, in other words, the point where
                a ParserError was thrown.
        rules: A list of strings or regular expressions. The rest of the text is
                searched for each of these. The closest match is the point where
                parsing will be resumed.
    Returns:
125
126
        The integer index of the closest reentry point or -1 if no reentry-point
        was found.
Eckhart Arnold's avatar
Eckhart Arnold committed
127
    """
128
    upper_limit = len(rest) + 1
Eckhart Arnold's avatar
Eckhart Arnold committed
129
130
131
132
    i = upper_limit
    #find closest match
    for rule in rules:
        if isinstance(rule, str):
133
134
            k = rest.find(rule)
            i = min(k if k >= 0 else upper_limit, i)
Eckhart Arnold's avatar
Eckhart Arnold committed
135
136
137
        else:
            m = rest.search(rule)
            if m:
138
                i = min(rest.index(m.start()), i)
139
    # in case no rule matched return -1
140
    if i == upper_limit:
141
142
143
        i = -1
    return i
    # return Node(None, rest[:i]), rest[i:]
Eckhart Arnold's avatar
Eckhart Arnold committed
144
145


eckhart's avatar
eckhart committed
146
147
148
149
ApplyFunc = Callable[['Parser'], None]
FlagFunc = Callable[[ApplyFunc, Set[ApplyFunc]], bool]


150
class Parser:
151
152
153
154
155
156
157
158
159
160
161
162
163
164
    """
    (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
165
    1. *Named parsers* for which a name is set in field `parser.pname`.
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
       The results produced by these parsers can later be retrieved in
       the AST by the parser name.

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

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

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

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

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

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

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

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

208
    def __init__(self) -> None:
209
        # assert isinstance(name, str), str(name)
di68kap's avatar
di68kap committed
210
        self.pname = ''  # type: str
211
        self.tag_name = self.ptype  # type: str
212
        if not isinstance(self, ZombieParser):
213
            self._grammar = ZOMBIE_GRAMMAR  # type: Grammar
214
215
216
        self.reset()

    def __deepcopy__(self, memo):
217
        """        Deepcopy method of the parser. Upon instantiation of a Grammar-
218
219
220
221
222
        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.
        """
223
        duplicate = self.__class__()
di68kap's avatar
di68kap committed
224
        duplicate.pname = self.pname
225
        duplicate.tag_name = self.tag_name
226
        return duplicate
227

228
    def __repr__(self):
di68kap's avatar
di68kap committed
229
        return self.pname + self.ptype
230
231

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

234
235
236
237
238
239
    @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__

240
241
242
    @property
    def repr(self) -> str:
        """Returns the parser's name if it has a name and self.__repr___() otherwise."""
di68kap's avatar
di68kap committed
243
        return self.pname if self.pname else self.__repr__()
244

245
246
247
248
    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."""
249
        self.visited = dict()  # type: Dict[int, Tuple[Optional[Node], StringView]]
eckhart's avatar
eckhart committed
250
        self.recursion_counter = defaultdict(int)  # type: DefaultDict[int, int]
eckhart's avatar
eckhart committed
251
        self.cycle_detection = set()  # type: Set[ApplyFunc]
252

eckhart's avatar
eckhart committed
253
    @cython.locals(location=cython.int, gap=cython.int, i=cython.int)
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
    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
        done in the overridden method `_parse()`.
        """
        grammar = self._grammar  # read protected member instead property to avoid function call
        location = grammar.document_length__ - len(text)

        try:
            if grammar.last_rb__loc__ >= location:
                grammar.rollback_to__(location)

            # if location has already been visited by the current parser,
            # return saved result
            if location in self.visited:
                # no history recording in case of memoized results
                return self.visited[location]

            # break left recursion at the maximum allowed depth
            if grammar.left_recursion_handling__:
                if self.recursion_counter[location] > LEFT_RECURSION_DEPTH:
                    grammar.recursion_locations__.add(location)
                    return None, text
                self.recursion_counter[location] += 1

            if grammar.history_tracking__:
280
281
                grammar.call_stack__.append(self.repr if self.tag_name in (':RegExp', ':Token')
                                            else self.tag_name)
282
283
284
285
286
287
288
289
                grammar.moving_forward__ = True

            try:
                # PARSER CALL: run _parse() method
                node, rest = self._parse(text)
            except ParserError as error:
                # does this play well with variable setting? add rollback clause here? tests needed...
                gap = len(text) - len(error.rest)
di68kap's avatar
di68kap committed
290
                rules = grammar.resume_rules__.get(self.pname, [])
291
292
293
294
295
296
297
298
299
300
301
302
303
                rest = error.rest[len(error.node):]
                i = reentry_point(rest, rules)
                if i >= 0 or self == grammar.start_parser__:
                    # apply reentry-rule or catch error at root-parser
                    if i < 0:
                        i = 1
                    nd = Node(None, rest[:i])
                    rest = rest[i:]
                    assert error.node.children
                    if error.first_throw:
                        node = error.node
                        node.result += (nd,)
                    else:
304
                        node = Node(self.tag_name, (Node(None, text[:gap]), error.node, nd))
305
306
307
308
                elif error.first_throw:
                    raise ParserError(error.node, error.rest, first_throw=False)
                else:
                    result = (Node(None, text[:gap]), error.node) if gap else error.node  # type: ResultType
309
                    raise ParserError(Node(self.tag_name, result), text, first_throw=False)
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344

            if grammar.left_recursion_handling__:
                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__:
                    if location in self.visited:
                        node, rest = self.visited[location]
                        # TODO: maybe add a warning about occurrence of left-recursion here?
                    # don't overwrite any positive match (i.e. node not None) in the cache
                    # and don't add empty entries for parsers returning from left recursive calls!
                elif grammar.memoization__:
                    # otherwise also cache None-results
                    self.visited[location] = (None, rest)
            else:
                assert node._pos < 0
                node._pos = location
                assert node._pos >= 0, str("%i < %i" % (grammar.document_length__, location))
                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?
                    self.visited[location] = (node, rest)

            # Mind that memoized parser calls will not appear in the history record!
            # Does this make sense? Or should it be changed?
            if grammar.history_tracking__:
                # don't track returning parsers except in case an error has occurred
                # remaining = len(rest)
                if (grammar.moving_forward__ or (node and node.errors)):
345
346
                    record = HistoryRecord(grammar.call_stack__, node, text,
                                           grammar.line_col__(text))
347
348
349
350
351
352
353
354
355
356
357
358
359
                    grammar.history__.append(record)
                    # print(record.stack, record.status, rest[:20].replace('\n', '|'))
                grammar.moving_forward__ = False
                grammar.call_stack__.pop()

        except RecursionError:
            node = Node(None, str(text[:min(10, max(1, text.find("\n")))]) + " ...")
            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
360
361
362
363
364
365
366
367
368
369
370
371

    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)

372
373
374
375
376
377
378
    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
        # return None, text  # default behaviour: don't match

379
    @property
eckhart's avatar
eckhart committed
380
381
    def grammar(self) -> 'Grammar':
        if self._grammar != ZOMBIE_GRAMMAR:
eckhart's avatar
eckhart committed
382
383
384
            return self._grammar
        else:
            raise AssertionError('Grammar has not yet been set!')
385
386
387

    @grammar.setter
    def grammar(self, grammar: 'Grammar'):
eckhart's avatar
eckhart committed
388
        if self._grammar == ZOMBIE_GRAMMAR:
389
390
            self._grammar = grammar
            self._grammar_assigned_notifier()
eckhart's avatar
eckhart committed
391
392
393
        elif self._grammar != grammar:
              raise AssertionError("Parser has already been assigned"
                                   "to a different Grammar object!")
394
395
396
397
398
399

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

eckhart's avatar
eckhart committed
400
    def _apply(self, func: ApplyFunc, flip: FlagFunc) -> bool:
401
402
        """
        Applies function `func(parser)` recursively to this parser and all
eckhart's avatar
eckhart committed
403
404
405
406
407
408
409
410
411
        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!
412
        """
eckhart's avatar
eckhart committed
413
        if flip(func, self.cycle_detection):
414
415
416
417
418
            return False
        else:
            func(self)
            return True

eckhart's avatar
eckhart committed
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
    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)

449

450
451
452
453
454
455
456
457
458
459
class ZombieParser(Parser):
    """
    Serves as a substitute for a Parser instance.

    ``ZombieParser`` is the class of the singelton object
    ``ZOMBIE_PARSER``. The  ``ZOMBIE_PARSER`` has a name and can be
    called, but it never matches. It serves as a substitute where only
    these (or one of these properties) is needed, but no real Parser-
    object is instantiated.
    """
eckhart's avatar
eckhart committed
460
461
    alive = [False]  # cython compatibility: cython forbits writing to class attributes

462
    def __init__(self):
463
        super().__init__()
di68kap's avatar
di68kap committed
464
        self.pname = ZOMBIE
465
        self.tag_name = ZOMBIE
466
        # no need to call super class constructor
eckhart's avatar
eckhart committed
467
        assert not ZombieParser.alive[0], "There can be only one!"
468
        assert self.__class__ == ZombieParser, "No derivatives, please!"
eckhart's avatar
eckhart committed
469
        ZombieParser.alive[0] = True
470
471
472
473
474
475
476
477
478
479
480
        self.reset()

    def __copy__(self):
        return self

    def __deepcopy__(self, memo):
        return self

    def __call__(self, text):
        raise AssertionError("Better call Saul ;-)")

481
482
483
484
485
486
487
    @property
    def grammar(self) -> 'Grammar':
        raise AssertionError("Zombie parser doesn't have a grammar!")

    @grammar.setter
    def grammar(self, grammar: 'Grammar'):
        raise AssertionError('Cannot assign a grammar a zombie parser or vice versa!')
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502

    def apply(self, func: ApplyFunc):
        return "Eaten alive..."


ZOMBIE_PARSER = ZombieParser()


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


503
504
505
506
507
508
509
510
511
512
513
514
515
516
def mixin_comment(whitespace: str, comment: str) -> str:
    """
    Returns a regular expression that merges comment and whitespace
    regexps. Thus comments cann occur whereever whitespace is allowed
    and will be skipped just as implicit whitespace.

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


517
class UnknownParserError(KeyError):
eckhart's avatar
eckhart committed
518
    """UnknownParserError is raised if a Grammar object is called with a
519
    parser that does not exist or if in the course of parsing a parser
eckhart's avatar
eckhart committed
520
    is referred to that does not exist."""
521
522


523
524
525
526
527
528
529
530
531
532
533
534
535
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
536
    Example for direct instantiation of a grammar::
537

538
        >>> number = RE('\d+') + RE('\.') + RE('\d+') | RE('\d+')
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
        >>> number_parser = Grammar(number)
        >>> number_parser("3.1416").content
        '3.1416'

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

    1. It keeps the namespace clean.

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

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

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

564
    Example::
565
566
567
568
569
570
571
572
573

        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+')
574
575
576
            factor = INTEGER | TKN("(") + expression + TKN(")")
            term = factor + ZeroOrMore((TKN("*") | TKN("/")) + factor)
            expression.set(term + ZeroOrMore((TKN("+") | TKN("-")) + term))
577
578
579
580
581
            root__ = expression

    Upon instantiation the parser objects are deep-copied to the
    Grammar object and assigned to object variables of the same name.
    Any parser that is directly assigned to a class variable is a
di68kap's avatar
di68kap committed
582
    'named' parser and its field `parser.pname` contains the variable
583
584
    name after instantiation of the Grammar class. All other parsers,
    i.e. parsers that are defined within a `named` parser, remain
di68kap's avatar
di68kap committed
585
    "anonymous parsers" where `parser.pname` is the empty string, unless
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
    a name has been passed explicitly upon instantiation.
    If one and the same parser is assigned to several class variables
    such as, for example the parser `expression` in the example above,
    the first name sticks.

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

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

602
603
604
605
606
    Attributes:
        root__:  The root parser of the grammar. Theoretically, all parsers of the
                 grammar should be reachable by the root parser. However, for testing
                 of yet incomplete grammars class Grammar does not assume that this
                 is the case.
607

Eckhart Arnold's avatar
Eckhart Arnold committed
608
        resume_rules__: A mapping of parser names to a list of regular expressions or search
609
                strings that act as rules to find the the reentry point if a ParserError
Eckhart Arnold's avatar
Eckhart Arnold committed
610
611
                was thrown during the execution of the parser with the respective name.

612
613
614
615
616
        parser_initializiation__:  Before the parser class (!) has been initialized,
                 which happens upon the first time it is instantiated (see
                 :func:_assign_parser_names()` for an explanation), this class
                 field contains a value other than "done". A value of "done" indicates
                 that the class has already been initialized.
617

eckhart's avatar
eckhart committed
618
619
620
621
        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`).

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

eckhart's avatar
eckhart committed
625
626
627
628
        start_parser__:  During parsing, the parser with which the parsing process
                was started (see method `__call__`) or `None` if no parsing process
                is running.

629
630
631
632
633
634
635
636
637
638
        history_tracking__:  A flag indicating that the parsing history shall
                be tracked

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

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

eckhart's avatar
eckhart committed
639
640
        document_length__:  the length of the document.

641
642
643
        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
644
                initialized if :attr:`history_tracking__` is true.
645

646
647
648
649
650
        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.

651
        _reversed__:  the same text in reverse order - needed by the `Lookbehind`-
652
653
654
                parsers.

        variables__:  A mapping for variable names to a stack of their respective
655
656
                string values - needed by the :class:`Capture`-, :class:`Retrieve`-
                and :class:`Pop`-parsers.
657
658

        rollback__:  A list of tuples (location, rollback-function) that are
659
660
661
662
                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.
663
664
665

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

672
673
        call_stack__:  A stack of the tag names of all parsers that have been called.
                This is required for recording the parser history (for debugging)
674
675
676
677
678
679
680
681
682
683
                and, eventually, i.e. one day in the future, for tracing through
                the parsing process.

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

        moving_forward__: This flag indicates that the parsing process is currently
                moving forward . It is needed to reduce noise in history recording
                and should not be considered as having a valid value if history
684
685
                recording is turned off! (See :func:`add_parser_guard` and its local
                function :func:`guarded_call`)
686
687
688
689

        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
690
691
                if full memoization is enabled. (See :func:`add_parser_guard` and its
                local function :func:`guarded_call`)
692
693
694
695
696
697
698
699
700
701

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

        left_recursion_handling__:  Turns left recursion handling on or off.
                If turned off, a recursion error will result in case of left
                recursion.
    """
eckhart's avatar
eckhart committed
702
    python_src__ = ''  # type: str
703
    root__ = ZOMBIE_PARSER  # type: Parser
704
    # root__ must be overwritten with the root-parser by grammar subclass
eckhart's avatar
eckhart committed
705
    parser_initialization__ = ["pending"]  # type: list[str]
eckhart's avatar
eckhart committed
706
    resume_rules__ = dict()  # type: Dict[str, ResumeList]
707
    # some default values
708
709
    # COMMENT__ = r''  # type: str  # r'#.*(?:\n|$)'
    # WSP_RE__ = mixin_comment(whitespace=r'[\t ]*', comment=COMMENT__)  # type: str
710
711
712
713
714


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

719
720
            class Grammar(Grammar):
                ...
721
                symbol = RE('(?!\\d)\\w+')
722

di68kap's avatar
di68kap committed
723
        After the call of this method symbol.pname == "symbol" holds.
di68kap's avatar
di68kap committed
724
725
        Parser names starting or ending with a double underscore like
        ``root__`` will be ignored. See :func:`sane_parser_name()`
726
727
728
729
730
731
732
733
734
735

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

        Attention: If there exists more than one reference to the same
        parser, only the first one will be chosen for python versions
        greater or equal 3.6.  For python version <= 3.5 an arbitrarily
        selected reference will be chosen. See PEP 520
        (www.python.org/dev/peps/pep-0520/) for an explanation of why.
        """
eckhart's avatar
eckhart committed
736
        if cls.parser_initialization__[0] != "done":
737
738
739
            cdict = cls.__dict__
            for entry, parser in cdict.items():
                if isinstance(parser, Parser) and sane_parser_name(entry):
di68kap's avatar
di68kap committed
740
                    if isinstance(parser, Forward):
di68kap's avatar
di68kap committed
741
742
743
744
                        if not cast(Forward, parser).parser.pname:
                            cast(Forward, parser).parser.pname = entry
                    else:   # if not parser.pname:
                        parser.pname = entry
eckhart's avatar
eckhart committed
745
            cls.parser_initialization__[0] = "done"
746
747
748


    def __init__(self, root: Parser = None) -> None:
749
750
        self.all_parsers__ = set()             # type: Set[Parser]
        self.start_parser__ = None             # type: Optional[Parser]
751
752
753
754
755
756
757
758
759
760
761
762
763
        self._dirty_flag__ = False             # type: bool
        self.history_tracking__ = False        # type: bool
        self.memoization__ = True              # type: bool
        self.left_recursion_handling__ = True  # type: bool
        self._reset__()

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

        # then deep-copy the parser tree from class to instance;
        # parsers not connected to the root object will be copied later
        # on demand (see Grammar.__getitem__()). Usually, the need to
        # do so only arises during testing.
eckhart's avatar
eckhart committed
764
765
766
767
        self.root_parser__ = copy.deepcopy(root) if root else copy.deepcopy(self.__class__.root__)
        self.root_parser__.apply(self._add_parser__)
        assert 'root_parser__' in self.__dict__
        assert self.root_parser__ == self.__dict__['root_parser__']
768
769
770
771
772
773


    def __getitem__(self, key):
        try:
            return self.__dict__[key]
        except KeyError:
eckhart's avatar
eckhart committed
774
            parser_template = getattr(self.__class__, key, None)
775
776
777
778
            if parser_template:
                # add parser to grammar object on the fly...
                parser = copy.deepcopy(parser_template)
                parser.apply(self._add_parser__)
eckhart's avatar
eckhart committed
779
                assert self[key] == parser
780
                return self[key]
781
            raise UnknownParserError('Unknown parser "%s" !' % key)
782

783
784
    def __contains__(self, key):
        return key in self.__dict__ or hasattr(self, key)
785
786

    def _reset__(self):
787
        self.tree__ = RootNode()              # type: RootNode
788
789
        self.document__ = EMPTY_STRING_VIEW   # type: StringView
        self._reversed__ = EMPTY_STRING_VIEW  # type: StringView
eckhart's avatar
eckhart committed
790
        self.document_length__ = 0            # type: int
791
792
        self.document_lbreaks__ = []          # type: List[int]
        # variables stored and recalled by Capture and Retrieve parsers
eckhart's avatar
eckhart committed
793
        self.variables__ = defaultdict(lambda: [])  # type: DefaultDict[str, List[str]]
794
795
796
        self.rollback__ = []                  # type: List[Tuple[int, Callable]]
        self.last_rb__loc__ = -1              # type: int
        # support for call stack tracing
797
        self.call_stack__ = []                # type: List[str]
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
        # snapshots of call stacks
        self.history__ = []                   # type: List[HistoryRecord]
        # also needed for call stack tracing
        self.moving_forward__ = False         # type: bool
        self.recursion_locations__ = set()    # type: Set[int]


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


    def _add_parser__(self, parser: Parser) -> None:
        """
        Adds the particular copy of the parser object to this
        particular instance of Grammar.
        """
di68kap's avatar
di68kap committed
822
        if parser.pname:
823
            # prevent overwriting instance variables or parsers of a different class
di68kap's avatar
di68kap committed
824
825
            assert parser.pname not in self.__dict__ or \
                   isinstance(self.__dict__[parser.pname], parser.__class__), \
826
                ('Cannot add parser "%s" because a field with the same name '
di68kap's avatar
di68kap committed
827
                 'already exists in grammar object: %s!'
di68kap's avatar
di68kap committed
828
829
830
                 % (parser.pname, str(self.__dict__[parser.pname])))
            setattr(self, parser.pname, parser)
        parser.tag_name = parser.pname or parser.ptype
831
832
833
834
        self.all_parsers__.add(parser)
        parser.grammar = self


eckhart's avatar
eckhart committed
835
836
    def __call__(self,
                 document: str,
eckhart's avatar
eckhart committed
837
                 start_parser: Union[str, Parser] = "root_parser__",
eckhart's avatar
eckhart committed
838
                 track_history: bool = False) -> RootNode:
839
840
841
842
843
        """
        Parses a document with with parser-combinators.

        Args:
            document (str): The source text to be parsed.
di68kap's avatar
di68kap committed
844
845
            start_parser (str or Parser): The name of the parser with which
                to start. This is useful for testing particular parsers
846
                (i.e. particular parts of the EBNF-Grammar.)
di68kap's avatar
di68kap committed
847
848
849
850
851
            track_history (bool): If true, the parsing history will be
                recorded in self.history__. If logging is turned on (i.e.
                DHParser.log.is_logging() returns true), the parsing history
                will always be recorded, even if `False` is passed to
                the `track_history` parameter.
852
        Returns:
di68kap's avatar
di68kap committed
853
            Node: The root node to the parse tree.
854
        """
855

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

861
862
863
864
865
866
867
        # assert isinstance(document, str), type(document)
        if self._dirty_flag__:
            self._reset__()
            for parser in self.all_parsers__:
                parser.reset()
        else:
            self._dirty_flag__ = True
di68kap's avatar
di68kap committed
868
869
870
871
        self.history_tracking__ = track_history or is_logging()
        # safe tracking state, because history_tracking__ might be set to false, later,
        # but original tracking state is needed for additional error information.
        track_history = self.history_tracking__
872
        self.document__ = StringView(document)
eckhart's avatar
eckhart committed
873
        self.document_length__ = len(self.document__)
874
        self.document_lbreaks__ = linebreaks(document) if self.history_tracking__ else []
Eckhart Arnold's avatar
Eckhart Arnold committed
875
        self.last_rb__loc__ = -1  # rollback location
876
        parser = self[start_parser] if isinstance(start_parser, str) else start_parser
eckhart's avatar
eckhart committed
877
        self.start_parser__ = parser
878
879
880
881
882
883
884
885
        assert parser.grammar == self, "Cannot run parsers from a different grammar object!" \
                                       " %s vs. %s" % (str(self), str(parser.grammar))
        result = None  # type: Optional[Node]
        stitches = []  # type: List[Node]
        rest = self.document__
        if not rest:
            result, _ = parser(rest)
            if result is None:
eckhart's avatar
eckhart committed
886
                result = Node(None, '').init_pos(0)
eckhart's avatar
eckhart committed
887
                self.tree__.new_error(result,
di68kap's avatar
di68kap committed
888
889
                                      'Parser "%s" did not match empty document.' % str(parser),
                                      Error.PARSER_DID_NOT_MATCH)
890
891
892
893
894
895
        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:
di68kap's avatar
di68kap committed
896
897
898
899
900
901
                    err_info = '' if not track_history else \
                               '\n    Most advanced: %s\n    Last match:    %s;' % \
                               (str(HistoryRecord.most_advanced_match(self.history__)),
                                str(HistoryRecord.last_match(self.history__)))
                    # Check if a Lookahead-Parser did match. Needed for testing, because
                    # in a test case this is not necessarily an error.
eckhart's avatar
eckhart committed
902
                    last_record = self.history__[-2] if len(self.history__) > 1 else None  # type: Optional[HistoryRecord]
903

eckhart's avatar
eckhart committed
904
                    if last_record and parser != self.root_parser__ \
di68kap's avatar
di68kap committed
905
                            and last_record.status == HistoryRecord.MATCH \
eckhart's avatar
eckhart committed
906
907
                            and last_record.node.pos \
                            + len(last_record.node) >= len(self.document__) \
908
909
910
                            and any(tn in self and isinstance(self[tn], Lookahead)
                                    or tn[0] == ':' and issubclass(eval(tn[1:]), Lookahead)
                                    for tn in last_record.call_stack):
di68kap's avatar
di68kap committed
911
912
913
914
915
                        error_msg = 'Parser did not match except for lookahead! ' + err_info
                        error_code = Error.PARSER_LOOKAHEAD_MATCH_ONLY
                    else:
                        error_msg = 'Parser did not match!' + err_info
                        error_code = Error.PARSER_DID_NOT_MATCH
916
917
                else:
                    stitches.append(result)
eckhart's avatar
eckhart committed
918
919
920
921
922
923
                    error_msg = "Parser stopped before end" \
                        + (("! trying to recover"
                            + (" but stopping history recording at this point."
                               if self.history_tracking__ else "..."))
                            if len(stitches) < MAX_DROPOUTS
                            else " too often! Terminating parser.")
di68kap's avatar
di68kap committed
924
                    error_code = Error.PARSER_STOPPED_BEFORE_END
eckhart's avatar
eckhart committed
925
                stitches.append(Node(None, skip).init_pos(tail_pos(stitches)))
di68kap's avatar
di68kap committed
926
                self.tree__.new_error(stitches[-1], error_msg, error_code)
927
                if self.history_tracking__:
eckhart's avatar
eckhart committed
928
929
930
931
932
933
934
                    # # some parsers may have matched and left history records with nodes != None.
                    # # Because these are not connected to the stitched root node, their pos-
                    # # properties will not be initialized by setting the root node's pos property
                    # # to zero. Therefore, their pos properties need to be initialized here
                    # for record in self.history__:
                    #     if record.node and record.node._pos < 0:
                    #         record.node.init_pos(0)
935
936
                    record = HistoryRecord(self.call_stack__.copy(), stitches[-1], rest,
                                           self.line_col__(rest))
937
938
939
940
941
                    self.history__.append(record)
                    # stop history tracking when parser returned too early
                    self.history_tracking__ = False
        if stitches:
            if rest:
Eckhart Arnold's avatar
Eckhart Arnold committed
942
                stitches.append(Node(None, rest))
943
944
945
946
947
948
            #try:
            result = Node(None, tuple(stitches)).init_pos(0)
            # except AssertionError as error:
            #     # some debugging output
            #     print(Node(None, tuple(stitches)).as_sxpr())
            #     raise error
949
        if any(self.variables__.values()):
di68kap's avatar
di68kap committed
950
            error_msg = "Capture-retrieve-stack not empty after end of parsing: " \
951
                + str(self.variables__)
di68kap's avatar
di68kap committed
952
            error_code = Error.CAPTURE_STACK_NOT_EMPTY
953
954
955
956
957
            if result:
                if result.children:
                    # add another child node at the end to ensure that the position
                    # of the error will be the end of the text. Otherwise, the error
                    # message above ("...after end of parsing") would appear illogical.
958
                    error_node = Node(ZOMBIE, '').init_pos(tail_pos(result.children))
di68kap's avatar
di68kap committed
959
                    self.tree__.new_error(error_node, error_msg, error_code)
eckhart's avatar
eckhart committed
960
                    result.result = result.children + (error_node,)
961
                else:
di68kap's avatar
di68kap committed
962
                    self.tree__.new_error(result, error_msg, error_code)
eckhart's avatar
eckhart committed
963
        # result.pos = 0  # calculate all positions
964
        # result.collect_errors(self.document__)
eckhart's avatar
eckhart committed
965
966
        if result:
            self.tree__.swallow(result)
eckhart's avatar
eckhart committed
967
        self.start_parser__ = None
968
        return self.tree__
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986


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


    def rollback_to__(self, location):
        """
        Rolls back the variable stacks (`self.variables`) to its
        state at an earlier location in the parsed document.
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
987
        while self.rollback__ and self.rollback__[-1][0] >= location:
988
989
990
991
992
993
994
995
996
997
            _, rollback_func = self.rollback__.pop()
            # assert not loc > self.last_rb__loc__, \
            #     "Rollback confusion: line %i, col %i < line %i, col %i" % \
            #     (*line_col(self.document__, len(self.document__) - loc),
            #      *line_col(self.document__, len(self.document__) - self.last_rb__loc__))
            rollback_func()
        self.last_rb__loc__ == self.rollback__[-1][0] if self.rollback__ \
            else (len(self.document__) + 1)


998
999
1000
1001
1002
1003
1004
1005
1006
    def line_col__(self, text):
        """
        Returns the line and column where text is located in the document.
        Does not check, whether text is actually a substring of the currently
        parsed document.
        """
        return line_col(self.document_lbreaks__, self.document_length__ - len(text))


1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
def dsl_error_msg(parser: Parser, error_str: str) -> str:
    """
    Returns an error message for errors in the parser configuration,
    e.g. errors that result in infinite loops.

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


eckhart's avatar
eckhart committed
1029
1030
1031
ZOMBIE_GRAMMAR = Grammar()


1032
1033
########################################################################
#
1034
# _Token and Regular Expression parser classes (i.e. leaf classes)
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
#
########################################################################


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

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

    def __init__(self, token: str) -> None:
        assert token and token.isupper()
1052
        assert RX_TOKEN_NAME.match(token)
1053
        super().__init__()
di68kap's avatar
di68kap committed
1054
        self.pname = token
1055

1056
    def __deepcopy__(self, memo):
di68kap's avatar
di68kap committed
1057
        duplicate = self.__class__(self.pname)
1058
        # duplicate.pname = self.pname  # will be written by the constructor, anyway
1059
        duplicate.tag_name = self.tag_name
1060
1061
        return duplicate

1062
    def _parse(self, text: StringView) -> Tuple[Optional[Node], StringView]:
1063
1064
1065
        if text[0:1] == BEGIN_TOKEN:
            end = text.find(END_TOKEN, 1)
            if end < 0:
1066
                node = Node(self.tag_name, '')
eckhart's avatar
eckhart committed
1067
1068
                self.grammar.tree__.new_error(
                    node,
1069
1070
                    'END_TOKEN delimiter missing from preprocessor token. '
                    '(Most likely due to a preprocessor bug!)')  # type: Node
1071
                return node, text[1:]
1072
            elif end == 0:
1073
                node = Node(self.tag_name, '')
eckhart's avatar
eckhart committed
1074
1075
                self.grammar.tree__.new_error(
                    node,
1076
1077
                    'Preprocessor-token cannot have zero length. '
                    '(Most likely due to a preprocessor bug!)')
1078
                return node, text[2:]
1079
            elif text.find(BEGIN_TOKEN, 1, end) >= 0:
di68kap's avatar
di68kap committed
1080
                node = Node(self.tag_name, text[len(self.pname) + 1:end])
eckhart's avatar
eckhart committed
1081
1082
                self.grammar.tree__.new_error(
                    node,
1083
1084
1085
1086
                    'Preprocessor-tokens must not be nested or contain '
                    'BEGIN_TOKEN delimiter as part of their argument. '
                    '(Most likely due to a preprocessor bug!)')
                return node, text[end:]
di68kap's avatar
di68kap committed
1087
1088
            if text[1:len(self.pname) + 1] == self.pname:
                return Node(self.tag_name, text[len(self.pname) + 2:end]), text[end + 1:]
1089
1090
1091
        return None, text


1092
class Token(Parser):
eckhart's avatar
eckhart committed
1093
    """
1094
    Parses plain text strings. (Could be done by RegExp as well, but is faster.)
eckhart's avatar
eckhart committed
1095

eckhart's avatar
eckhart committed
1096
1097
    Example::

1098
        >>> while_token = Token("while")
eckhart's avatar
eckhart committed
1099
1100
        >>> Grammar(while_token)("while").content
        'while'
eckhart's avatar
eckhart committed
1101
    """
1102
    assert TOKEN_PTYPE == ":Token"
eckhart's avatar
eckhart committed
1103

1104
1105
    def __init__(self, text: str) -> None:
        super().__init__()
eckhart's avatar
eckhart committed
1106
        self.text = text
1107
        self.len = len(text)
eckhart's avatar
eckhart committed
1108
1109

    def __deepcopy__(self, memo):
1110
        duplicate = self.__class__(self.text)
di68kap's avatar
di68kap committed
1111
        duplicate.pname = self.pname
1112
        duplicate.tag_name = self.tag_name
1113
        return duplicate
eckhart's avatar
eckhart committed
1114

1115
    def _parse(self, text: StringView) -> Tuple[Optional[Node], StringView]:
eckhart's avatar
eckhart committed
1116
        if text.startswith(self.text):
1117
            return Node(self.tag_name, self.text, True), text[self.len:]
eckhart's avatar
eckhart committed
1118
1119
        return None, text

1120
1121
1122
    def __repr__(self):
        return ("'%s'" if self.text.find("'") <= 0 else '"%s"') % self.text

eckhart's avatar
eckhart committed
1123

1124
1125
1126
1127
1128
1129
1130
1131
1132
class RegExp(Parser):
    r"""
    Regular expression parser.

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

1133
1134
1135
1136
1137
    Example::

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

1139
    EBNF-Notation:  ``/ ... /``
1140

1141
    EBNF-Example:   ``word = /\w+/``
1142
1143
    """

1144
1145
    def __init__(self, regexp) -> None:
        super().__init__()
1146
1147
1148
1149
1150
1151
1152
1153
        self.regexp = re.compile(regexp) if isinstance(regexp, str) else regexp

    def __deepcopy__(self, memo):
        # `regex` supports deep copies, but not `re`
        try:
            regexp = copy.deepcopy(self.regexp, memo)
        except TypeError:
            regexp = self.regexp.pattern
1154
        duplicate = self.__class__(regexp)
di68kap's avatar
di68kap committed
1155
        duplicate.pname = self.pname
1156
        duplicate.tag_name = self.tag_name
1157
        return duplicate
1158

1159
    def _parse(self, text: StringView) -> Tuple[Optional[Node], StringView]:
1160
1161
1162
1163
        match = text.match(self.regexp)
        if match:
            capture = match.group(0)
            end = text.index(match.end())
1164
            # regular expression must never match preprocessor-tokens!
di68kap's avatar
di68kap committed
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
            # Should never happen, anyway, as long as text characters do not
            # fall into the range below 0x20
            # # Find a better solution here? e.g. static checking/re-mangling at compile time
            # # Needs testing!!!
            # i = capture.find(BEGIN_TOKEN)
            # if i >= 0:
            #     capture = capture[:i]
            #     end = i
            #     m = capture[:end].match(self.regexp)
            #     if m:
            #         capture = m.group(0)
            #         end = text.index(m.end())
            #     else:
            #         return None, text
1179
            return Node(self.tag_name, capture, True), text[end:]
1180
1181
1182
        return None, text

    def __repr__(self):
1183
        return escape_control_characters('/%s/' % self.regexp.pattern)
1184
1185


eckhart's avatar
eckhart committed
1186
def withWS(parser_factory, wsL='', wsR=r'\s*'):
1187
    """Syntactic Sugar for 'Series(Whitespace(wsL), parser_factory(), Whitespace(wsR))'.
1188
    """
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
    if wsL and isinstance(wsL, str):
        wsL = Whitespace(wsL)
    if wsR and isinstance(wsR, str):
        wsR = Whitespace(wsR)
    if wsL and wsR:
        return Series(wsL, parser_factory(), wsR)
    elif wsL:
        return Series(wsL, parser_factory())
    elif wsR:
        return Series(parser_factory(), wsR)
    else:
        return parser_factory()
1201

1202

eckhart's avatar
eckhart committed
1203
def RE(regexp, wsL='', wsR=r'\s*'):
1204
    """Syntactic Sugar for 'Series(Whitespace(wsL), RegExp(regexp), Whitespace(wsR))'"""
eckhart's avatar
eckhart committed
1205
    return withWS(lambda: RegExp(regexp), wsL, wsR)
1206
1207


eckhart's avatar
eckhart committed
1208
def TKN(token, wsL='', wsR=r'\s*'):
1209
1210
    """Syntactic Sugar for 'Series(Whitespace(wsL), Token(token), Whitespace(wsR))'"""
    return withWS(lambda: Token(token), wsL, wsR)
1211
1212


1213
1214
1215
1216
class Whitespace(RegExp):
    """An variant of RegExp that signifies through its class name that it
    is a RegExp-parser for whitespace."""
    assert WHITESPACE_PTYPE == ":Whitespace"
eckhart's avatar
eckhart committed
1217

eckhart's avatar
eckhart committed
1218
1219
1220
    def __repr__(self):
        return '~'

1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240

########################################################################