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

syntaxtree.py 24.4 KB
Newer Older
1
"""syntaxtree.py - syntax tree classes for DHParser
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

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
19
import collections.abc
20
import copy
21
22
from functools import partial

23
from DHParser.error import Error, linebreaks, line_col
24
from DHParser.stringview import StringView
25
from DHParser.toolkit import re, typing
di68kap's avatar
di68kap committed
26
27
from typing import Any, Callable, cast, Iterator, List, Union, Tuple, Hashable, Optional

28

29
30
31
32
33
34
35
__all__ = ('ParserBase',
           'WHITESPACE_PTYPE',
           'TOKEN_PTYPE',
           'MockParser',
           'ZombieParser',
           'ZOMBIE_PARSER',
           'Node',
36
           'mock_syntax_tree',
37
           'flatten_sxpr',
38
           'TransformationFunc')
Eckhart Arnold's avatar
Eckhart Arnold committed
39
40


41
42
43
44
45
46
47
48
49
50
51
52
53
54
#######################################################################
#
# parser base and mock parsers
#
#######################################################################


class ParserBase:
    """
    ParserBase is the base class for all real and mock parser classes.
    It is defined here, because Node objects require a parser object
    for instantiation.
    """
    def __init__(self, name=''):  # , pbases=frozenset()):
55
        self._name = name  # type: str
56
57
58
        self._ptype = ':' + self.__class__.__name__  # type: str

    def __repr__(self):
di68kap's avatar
di68kap committed
59
         return self.name + self.ptype
60
61
62
63

    def __str__(self):
        return self.name + (' = ' if self.name else '') + repr(self)

64
65
66
    def __call__(self, text: StringView) -> Tuple[Optional['Node'], StringView]:
        return None, text

67
68
    @property
    def name(self):
69
70
        """Returns the name of the parser or the empty string '' for unnamed
        parsers."""
71
72
        return self._name

73
74
    @property
    def ptype(self) -> str:
75
76
        """Returns the type of the parser. By default this is the parser's
        class name preceded by a colon, e.g. ':ZeroOrMore'."""
77
78
79
80
        return self._ptype

    @property
    def repr(self) -> str:
di68kap's avatar
di68kap committed
81
        """Returns the parser's name if it has a name and repr()"""
82
83
        return self.name if self.name else repr(self)

84
    def reset(self):
85
        """Resets any parser variables. (Should be overridden.)"""
86
87
        pass

eckhart's avatar
eckhart committed
88
    def grammar(self) -> Optional[object]:
89
90
        """Returns the Grammar object to which the parser belongs. If not
        yet connected to any Grammar object, None is returned."""
91
92
93
        return None

    def apply(self, func: Callable) -> bool:
eckhart's avatar
eckhart committed
94
        """Applies the function `func` to the parser. Returns False, if
95
        - for whatever reason - the functions has not been applied, True
eckhart's avatar
eckhart committed
96
        otherwise."""
97
98
        return False

99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

WHITESPACE_PTYPE = ':Whitespace'
TOKEN_PTYPE = ':Token'


class MockParser(ParserBase):
    """
    MockParser objects can be used to reconstruct syntax trees from a
    serialized form like S-expressions or XML. Mock objects can mimic
    different parser types by assigning them a ptype on initialization.

    Mock objects should not be used for anything other than
    syntax tree (re-)construction. In all other cases where a parser
    object substitute is needed, chose the singleton ZOMBIE_PARSER.
    """
    def __init__(self, name='', ptype=''):  # , pbases=frozenset()):
        assert not ptype or ptype[0] == ':'
116
        super().__init__(name)
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
        self._ptype = ptype or ':' + self.__class__.__name__


class ZombieParser(MockParser):
    """
    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.
    """
    alive = False

    def __init__(self):
        super(ZombieParser, self).__init__("__ZOMBIE__")
        assert not self.__class__.alive, "There can be only one!"
        assert self.__class__ == ZombieParser, "No derivatives, please!"
        self.__class__.alive = True

    def __copy__(self):
        return self

    def __deepcopy__(self, memo):
        return self

    def __call__(self, text):
        """Better call Saul ;-)"""
        return None, text


ZOMBIE_PARSER = ZombieParser()


#######################################################################
#
# syntaxtree nodes
#
#######################################################################


159
ChildrenType = Tuple['Node', ...]
Eckhart Arnold's avatar
Eckhart Arnold committed
160
NoChildren = cast(ChildrenType, ())  # type: ChildrenType
161
StrictResultType = Union[ChildrenType, str]
162
ResultType = Union[ChildrenType, 'Node', StringView, str, None]
163
164


Eckhart Arnold's avatar
Eckhart Arnold committed
165
166
def flatten_sxpr(sxpr: str) -> str:
    """Returns S-expression `sxpr` as a one-liner without unnecessary
Eckhart Arnold's avatar
Eckhart Arnold committed
167
168
169
    whitespace.

    Example:
Eckhart Arnold's avatar
Eckhart Arnold committed
170
    >>> flatten_sxpr('(a\\n    (b\\n        c\\n    )\\n)\\n')
Eckhart Arnold's avatar
Eckhart Arnold committed
171
172
    '(a (b c))'
    """
173
    return re.sub(r'\s(?=\))', '', re.sub(r'\s+', ' ', sxpr)).strip()
Eckhart Arnold's avatar
Eckhart Arnold committed
174
175


Eckhart Arnold's avatar
Eckhart Arnold committed
176
class Node(collections.abc.Sized):
177
178
179
    """
    Represents a node in the concrete or abstract syntax tree.

180
    Attributes and Properties:
181
182
183
184
185
186
187
        tag_name (str):  The name of the node, which is either its
            parser's name or, if that is empty, the parser's class name
        result (str or tuple):  The result of the parser which
            generated this node, which can be either a string or a
            tuple of child nodes.
        children (tuple):  The tuple of child nodes or an empty tuple
            if there are no child nodes. READ ONLY!
Eckhart Arnold's avatar
Eckhart Arnold committed
188
        parser (Parser):  The parser which generated this node.
189
190
            WARNING: In case you use mock syntax trees for testing or
            parser replacement during the AST-transformation: DO NOT
Eckhart Arnold's avatar
Eckhart Arnold committed
191
192
            rely on this being a real parser object in any phase after
            parsing (i.e. AST-transformation and compiling), for
193
            example by calling ``isinstance(node.parer, ...)``.
194
195
        errors (list):  A list of parser- or compiler-errors:
            tuple(position, string) attached to this node
196
197
198
        error_flag (int):  0 if no error occurred in either the node
            itself or any of its descendants. Otherwise contains the
            highest warning or error level or all errors that occurred.
199
200
201
        len (int):  The full length of the node's string result if the
            node is a leaf node or, otherwise, the concatenated string
            result's of its descendants. The figure always represents
202
            the length before AST-transformation and will never change
203
204
205
            through AST-transformation. READ ONLY!
        pos (int):  the position of the node within the parsed text.

Eckhart Arnold's avatar
Eckhart Arnold committed
206
            The value of ``pos`` is -1 meaning invalid by default.
207
            Setting this value will set the positions of all child
Eckhart Arnold's avatar
Eckhart Arnold committed
208
            nodes relative to this value.
209
210

            To set the pos values of all nodes in a syntax tree, the
Eckhart Arnold's avatar
Eckhart Arnold committed
211
            pos value of the root node should be set to 0 right
212
213
            after parsing.

Eckhart Arnold's avatar
Eckhart Arnold committed
214
            Other than that, this value should be considered READ ONLY.
215
216
            At any rate, it should only be reassigned during the parsing
            stage and never during or after the AST-transformation.
217
    """
218

219
220
    __slots__ = ['_result', 'children', '_errors', '_len', '_pos', 'parser', 'error_flag']

221

222
223
224
    def __init__(self, parser, result: ResultType, leafhint: bool = False) -> None:
        """
        Initializes the ``Node``-object with the ``Parser``-Instance
225
226
        that generated the node and the parser's result.
        """
227
228
        self.error_flag = 0             # type: int
        self._errors = []               # type: List[Error]
eckhart's avatar
eckhart committed
229
        self._pos = -1                  # type: int
di68kap's avatar
di68kap committed
230
231
        # Assignment to self.result initializes the attributes _result, children and _len
        # The following if-clause is merely an optimization, i.e. a fast-path for leaf-Nodes
232
        if leafhint:
233
            self._result = str(result)  # type: StrictResultType
234
            self.children = NoChildren  # type: ChildrenType
235
            self._len = -1              # type: int  # lazy evaluation
236
237
        else:
            self.result = result
238
239
        self.parser = parser or ZOMBIE_PARSER

Eckhart Arnold's avatar
Eckhart Arnold committed
240

241
    def __str__(self):
242
243
244
245
246
        s = "".join(str(child) for child in self.children) if self.children else self.result
        if self._errors:
            return ' <<< Error on "%s" | %s >>> ' % \
                   (s, '; '.join(e.message for e in self._errors))
        return s
247

Eckhart Arnold's avatar
Eckhart Arnold committed
248

249
250
251
252
253
254
    def __repr__(self):
        mpargs = {'name': self.parser.name, 'ptype': self.parser.ptype}
        parg = "MockParser({name}, {ptype})".format(**mpargs)
        rarg = str(self) if not self.children else \
               "(" + ", ".join(repr(child) for child in self.children) + ")"
        return "Node(%s, %s)" % (parg, rarg)
255

Eckhart Arnold's avatar
Eckhart Arnold committed
256

257
    def __len__(self):
258
        if self._len < 0:
di68kap's avatar
di68kap committed
259
            self._len = sum(len(child) for child in self.children) \
260
                if self.children else len(self._result)
261
262
263
        return self._len


264

265
266
267
268
269
    def __bool__(self):
        # A node that is not None is always True, even if it's empty
        return True


270
    def __eq__(self, other):
271
272
        # return str(self.parser) == str(other.parser) and self.result == other.result
        return self.tag_name == other.tag_name and self.result == other.result
273

Eckhart Arnold's avatar
Eckhart Arnold committed
274

275
    def __hash__(self):
276
        return hash(self.tag_name)
277

Eckhart Arnold's avatar
Eckhart Arnold committed
278

279
280
281
282
283
284
    def __deepcopy__(self, memodict={}):
        result = copy.deepcopy(self.result)
        other = Node(self.parser, result)
        other._pos = self._pos
        return other

Eckhart Arnold's avatar
Eckhart Arnold committed
285

286
    @property   # this needs to be a (dynamic) property, in case sef.parser gets updated
287
    def tag_name(self) -> str:
288
289
290
291
292
293
        """
        Returns the tage name of Node, i.e. the name for XML or
        S-expression representation. By default the tag name is the
        name of the node's parser or, if the node's parser is unnamed, the
        node's parser's `ptype`.
        """
294
        return self.parser.name or self.parser.ptype
295

Eckhart Arnold's avatar
Eckhart Arnold committed
296

297
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
298
    def result(self) -> StrictResultType:
299
300
301
302
303
        """
        Returns the result from the parser that created the node.
        Error messages are not included in the result. Use `self.content()`
        if the result plus any error messages is needed.
        """
304
305
        return self._result

306

307
    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
308
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
309
        # # made obsolete by static type checking with mypy
310
311
312
        # assert ((isinstance(result, tuple) and all(isinstance(child, Node) for child in result))
        #         or isinstance(result, Node)
        #         or isinstance(result, str)), str(result)
Eckhart Arnold's avatar
Eckhart Arnold committed
313
314
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
315
        self._len = -1  # lazy evaluation
316
317
318
319
        if isinstance(result, Node):
            self.children = (result,)
            self._result = self.children
            self.error_flag = result.error_flag
320
321
            # if self._pos < 0:
            #     self._pos = result._pos
322
323
324
325
        else:
            if isinstance(result, tuple):
                self.children = result
                self._result = result or ''
326
327
328
                if result:
                    if self.error_flag == 0:
                        self.error_flag = max(child.error_flag for child in self.children)
329
330
                    # if self._pos < 0:
                    #     self._pos = result[0]._pos
331
332
            else:
                self.children = NoChildren
333
                self._result = str(result)
334
335
336
337
338
339
340
341
        # # shorter but slower:
        # self._result = (result,) if isinstance(result, Node) else result or ''  # type: StrictResultType
        # self.children = cast(ChildrenType, self._result) \
        #     if isinstance(self._result, tuple) else NoChildren  # type: ChildrenType
        # if self.children:
        #     self.error_flag = max(self.error_flag,
        #                           max(child.error_flag for child in self.children))  # type: bool

342
343
344
345
346
347
348
349
350

    @property
    def content(self) -> str:
        """
        Returns content as string, inserting error messages where
        errors occurred.
        """
        if self.children:
            return "".join(child.content for child in self.children)
eckhart's avatar
eckhart committed
351
        return cast(str, self._result)
352
353
354
355
356
357
358
359
360
361
362


    @property
    def structure(self) -> str:
        """
        Return structure (and content) as S-expression on a single line
        without any line breaks.
        """
        return flatten_sxpr(self.as_sxpr(showerrors=False))


363
    @property
364
    def pos(self) -> int:
eckhart's avatar
eckhart committed
365
366
        """Returns the position of the Node's content in the source text."""
        if self._pos < 0:
367
            raise AssertionError("Position value not initialized!")
368
369
        return self._pos

eckhart's avatar
eckhart committed
370

eckhart's avatar
eckhart committed
371
    def init_pos(self, pos: int, overwrite: bool = False) -> 'Node':
eckhart's avatar
eckhart committed
372
373
374
375
376
377
378
379
380
        """
        (Re-)initialize position value. Usually, the parser guard
        (`parsers.add_parser_guard()`) takes care of assigning the
        position in the document to newly created nodes. However,
        where Nodes are created outside the reach of the parser
        guard, their document-position must be assigned manually.
        This function recursively reassigns the position values
        of the child nodes, too.
        """
eckhart's avatar
eckhart committed
381
382
383
384
385
386
        if overwrite or self._pos < 0:
            self._pos = pos
            for err in self._errors:
                err.pos = pos
        else:
            assert self._pos == pos, str("%i != %i" % (self._pos, pos))
387
        # recursively adjust pos-values of all children
eckhart's avatar
eckhart committed
388
        offset = self.pos
389
        for child in self.children:
eckhart's avatar
eckhart committed
390
            child.init_pos(offset, overwrite)
eckhart's avatar
eckhart committed
391
392
393
            offset = child.pos + len(child)
        return self

394
395

    @property
396
    def errors(self) -> List[Error]:
eckhart's avatar
eckhart committed
397
        """
398
        Returns the errors that occurred at this Node,
eckhart's avatar
eckhart committed
399
400
        not including any errors from child nodes.
        """
401
402
        return self._errors.copy()

403

eckhart's avatar
eckhart committed
404
405
    def add_error(self,
                  message: str,
406
                  code: int = Error.ERROR) -> 'Node':
eckhart's avatar
eckhart committed
407
408
409
        """
        Adds an error to this Node.
        Parameters:
eckhart's avatar
eckhart committed
410
411
            message(str): A string with the error message.abs
            code(int):    An error code to identify the kind of error
eckhart's avatar
eckhart committed
412
        """
413
414
        self._errors.append(Error(message, code))
        self.error_flag = max(self.error_flag, self._errors[-1].code)
Eckhart Arnold's avatar
Eckhart Arnold committed
415
416
        return self

417

418
    def collect_errors(self, clear_errors=False) -> List[Error]:
Eckhart Arnold's avatar
Eckhart Arnold committed
419
        """
420
        Recursively adds line- and column-numbers to all error objects.
Eckhart Arnold's avatar
Eckhart Arnold committed
421
422
423
424
        Returns all errors of this node or any child node in the form
        of a set of tuples (position, error_message), where position
        is always relative to this node.
        """
425
        errors = self.errors
426
427
        for err in errors:
            err.pos = self.pos
428
429
        if self.children:
            for child in self.children:
430
                errors.extend(child.collect_errors(clear_errors))
431
432
433
        if clear_errors:
            self._errors = []
            self.error_flag = 0
434
        else:
435
436
437
438
439
440
441
            if self._errors:
                self.error_flag = max(err.code for err in self.errors)
            if self.children:
                max_child_error = max(child.error_flag for child in self.children)
                self.error_flag = max(self.error_flag, max_child_error)
        return errors

442

Eckhart Arnold's avatar
Eckhart Arnold committed
443

444
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=lambda i: i, density=0) -> str:
445
446
447
448
449
450
451
452
        """
        Generates a tree representation of this node and its children
        in string from.

        The kind ot tree-representation that is determined by several
        function parameters. This could be an XML-representation or a
        lisp-like S-expression.

453
        Args:
454
            tab (str):  The indentation string, e.g. '\t' or '    '
eckhart's avatar
eckhart committed
455
            open_fn:   (Node->str) A function that returns an opening
456
                string (e.g. an XML-tag_name) for a given node
eckhart's avatar
eckhart committed
457
            close_fn:  (Node->str) A function that returns a closeF
458
                string (e.g. an XML-tag_name) for a given node.
eckhart's avatar
eckhart committed
459
            data_fn:   (str->str) A function that filters the data string
460
461
462
463
464
465
                before printing, e.g. to add quotation marks

        Returns (str):
            A string that contains a (serialized) tree representation
            of the node and its children.
        """
eckhart's avatar
eckhart committed
466
467
        head = open_fn(self)
        tail = close_fn(self)
468
469

        if not self.result:
470
            return head.rstrip() + tail.lstrip()
471

eckhart's avatar
eckhart committed
472
        tail = tail.lstrip(None if density & 2 else '')
473
474
475

        if self.children:
            content = []
476
            for child in self.children:
eckhart's avatar
eckhart committed
477
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn, density).split('\n')
478
                content.append('\n'.join((tab + s) for s in subtree))
eckhart's avatar
eckhart committed
479
            return head + '\n'.join(content) + tail
480

481
        res = cast(str, self.result)  # safe, because if there are no children, result is a string
482
483
484
        if density & 1 and res.find('\n') < 0:  # and head[0] == "<":
            # except for XML, add a gap between opening statement and content
            gap = ' ' if head.rstrip()[-1] != '>' else ''
eckhart's avatar
eckhart committed
485
            return head.rstrip() + gap + data_fn(self.result) + tail.lstrip()
486
        else:
eckhart's avatar
eckhart committed
487
            return head + '\n'.join([tab + data_fn(s) for s in res.split('\n')]) + tail
488

Eckhart Arnold's avatar
Eckhart Arnold committed
489

490
    def as_sxpr(self, src: str = None, compact: bool = False, showerrors: bool = True) -> str:
491
492
493
        """
        Returns content as S-expression, i.e. in lisp-like form.

494
        Args:
495
496
497
            src:  The source text or `None`. In case the source text is
                given the position of the element in the text will be
                reported as line and column.
Eckhart Arnold's avatar
Eckhart Arnold committed
498
            compact:  If True a compact representation is returned where
499
                brackets are omitted and only the indentation indicates the
Eckhart Arnold's avatar
Eckhart Arnold committed
500
                tree structure.
501
502
        """

eckhart's avatar
eckhart committed
503
        left_bracket, right_bracket, density = ('', '', 1) if compact else ('(', '\n)', 0)
504

505
        def opening(node) -> str:
eckhart's avatar
eckhart committed
506
507
            """Returns the opening string for the representation of `node`."""
            txt = left_bracket + node.tag_name
508
509
            # s += " '(pos %i)" % node.pos
            if src:
eckhart's avatar
eckhart committed
510
                txt += " '(pos %i " % node.pos  # + " %i %i)" % line_col(src, node.pos)
di68kap's avatar
di68kap committed
511
512
            # if node.error_flag:   # just for debugging error collecting
            #     txt += " HAS ERRORS"
513
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
514
515
516
                txt += " '(err '(%s))" % ' '.join(str(err).replace('"', r'\"')
                                                  for err in node.errors)
            return txt + '\n'
517

eckhart's avatar
eckhart committed
518
519
520
        def closing(node) -> str:
            """Returns the closing string for the representation of `node`."""
            return right_bracket
521

eckhart's avatar
eckhart committed
522
523
524
525
526
        def pretty(strg):
            """Encloses `strg` with the right kind of quotation marks."""
            return '"%s"' % strg if strg.find('"') < 0 \
                else "'%s'" % strg if strg.find("'") < 0 \
                else '"%s"' % strg.replace('"', r'\"')
527

eckhart's avatar
eckhart committed
528
        return self._tree_repr('    ', opening, closing, pretty, density=density)
Eckhart Arnold's avatar
Eckhart Arnold committed
529

eckhart's avatar
eckhart committed
530

eckhart's avatar
eckhart committed
531
532
533
534
535
536
537
538
    @property
    def xml_attr(self):
        """Returns a dictionary of XML-Attributes attached to the Node."""
        if not hasattr(self, '_xml_attr'):
            self._xml_attr = dict()
        return self._xml_attr


539
    def as_xml(self, src: str = None, showerrors: bool = True) -> str:
540
541
542
        """
        Returns content as XML-tree.

543
        Args:
544
545
546
547
548
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
        """

549
        def opening(node) -> str:
eckhart's avatar
eckhart committed
550
            """Returns the opening string for the representation of `node`."""            
eckhart's avatar
eckhart committed
551
            txt = ['<', node.tag_name]
552
            # s += ' pos="%i"' % node.pos
eckhart's avatar
eckhart committed
553
554
            if hasattr(self, '_xml_attr'):
                txt.extend(' %s="%s"' % (k, v) for k, v in self.xml_attr.items())
555
            if src:
eckhart's avatar
eckhart committed
556
                txt.append(' line="%i" col="%i"' % line_col(line_breaks, node.pos))
557
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
558
559
560
                txt.append(' err="%s"' % ''.join(str(err).replace('"', r'\"')
                                                 for err in node.errors))
            return "".join(txt + [">\n"])
561
562

        def closing(node):
eckhart's avatar
eckhart committed
563
            """Returns the closing string for the representation of `node`."""            
564
            return '\n</' + node.tag_name + '>'
565

566
        line_breaks = linebreaks(src) if src else []
567
        return self._tree_repr('    ', opening, closing, density=1)
568

Eckhart Arnold's avatar
Eckhart Arnold committed
569

570
    def find(self, match_function: Callable) -> Iterator['Node']:
eckhart's avatar
eckhart committed
571
572
573
        """
        Finds nodes in the tree that match a specific criterion.

di68kap's avatar
di68kap committed
574
575
        `find` is a generator that yields all nodes for which the
        given `match_function` evaluates to True. The tree is
576
        traversed pre-order.
eckhart's avatar
eckhart committed
577

578
579
580
581
        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
        Yields:
eckhart's avatar
eckhart committed
582
            Node: all nodes of the tree for which
583
584
585
586
587
588
            ``match_function(node)`` returns True
        """
        if match_function(self):
            yield self
        else:
            for child in self.children:
eckhart's avatar
eckhart committed
589
590
                for node in child.find(match_function):
                    yield node
591

Eckhart Arnold's avatar
Eckhart Arnold committed
592

593
    def tree_size(self) -> int:
eckhart's avatar
eckhart committed
594
595
596
        """
        Recursively counts the number of nodes in the tree including the root node.
        """
597
598
599
        return sum(child.tree_size() for child in self.children) + 1


600
def mock_syntax_tree(sxpr):
601
    """
di68kap's avatar
di68kap committed
602
603
    Generates a tree of nodes from an S-expression. The main purpose of this is
    to generate test data.
604
605
606
607
608
609
610

    Example:
    >>> mock_syntax_tree("(a (b c))").as_sxpr()
    '(a\\n    (b\\n        "c"\\n    )\\n)'
    """

    def next_block(s):
eckhart's avatar
eckhart committed
611
612
613
        """Generator that yields all characters until the next closing bracket
        that does not match an opening bracket matched earlier within the same
        package."""
614
        s = s.strip()
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
        try:
            while s[0] != ')':
                if s[0] != '(':
                    raise ValueError('"(" expected, not ' + s[:10])
                # assert s[0] == '(', s
                level = 1
                k = 1
                while level > 0:
                    if s[k] == '(':
                        level += 1
                    elif s[k] == ')':
                        level -= 1
                    k += 1
                yield s[:k]
                s = s[k:].strip()
        except IndexError:
            errmsg = ('Malformed S-expression. Unprocessed part: "%s"' % s) if s \
                else 'Malformed S-expression. Closing bracket(s) ")" missing.'
            raise AssertionError(errmsg)
634

635
    sxpr = sxpr.strip()
eckhart's avatar
eckhart committed
636
637
    if sxpr[0] != '(':
        raise ValueError('"(" expected, not ' + sxpr[:10])
638
639
    # assert sxpr[0] == '(', sxpr
    sxpr = sxpr[1:].strip()
eckhart's avatar
eckhart committed
640
    match = re.match(r'[\w:]+', sxpr)
641
642
643
    if match is None:
        raise AssertionError('Malformed S-expression Node-tagname or identifier expected, '
                             'not "%s"' % sxpr[:40].replace('\n', ''))
eckhart's avatar
eckhart committed
644
645
    name, class_name = (sxpr[:match.end()].split(':') + [''])[:2]
    sxpr = sxpr[match.end():].strip()
646
647
    if sxpr[0] == '(':
        result = tuple(mock_syntax_tree(block) for block in next_block(sxpr))
648
649
650
651
        pos = 0
        for node in result:
            node._pos = pos
            pos += len(node)
652
653
    else:
        lines = []
654
        while sxpr and sxpr[0] != ')':
eckhart's avatar
eckhart committed
655
656
657
658
659
660
            for qtmark in ['"""', "'''", '"', "'"]:
                match = re.match(qtmark + r'.*?' + qtmark, sxpr, re.DOTALL)
                if match:
                    i = len(qtmark)
                    lines.append(sxpr[i:match.end() - i])
                    sxpr = sxpr[match.end():].strip()
661
662
                    break
            else:
eckhart's avatar
eckhart committed
663
664
665
                match = re.match(r'(?:(?!\)).)*', sxpr, re.DOTALL)
                lines.append(sxpr[:match.end()])
                sxpr = sxpr[match.end():]
666
        result = "\n".join(lines)
667
668
669
    node = Node(MockParser(name, ':' + class_name), result)
    node._pos = 0
    return node
670
671


672
TransformationFunc = Union[Callable[[Node], Any], partial]
673

674
675
676
677
678

# if __name__ == "__main__":
#     st = mock_syntax_tree("(alpha (beta (gamma i\nj\nk) (delta y)) (epsilon z))")
#     print(st.as_sxpr())
#     print(st.as_xml())