Notice to GitKraken users: A vulnerability has been found in the SSH key generation of GitKraken versions 7.6.0 to 8.0.0 (https://www.gitkraken.com/blog/weak-ssh-key-fix). If you use GitKraken and have generated a SSH key using one of these versions, please remove it both from your local workstation and from your LRZ GitLab profile.

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

syntaxtree.py 24.7 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# syntaxtree.py - syntax tree classes for DHParser
#
# 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.
17
18
19


"""
20
21
22
23
24
25
Module ``syntaxtree`` defines the ``Node``-class for syntax trees as well
as an abstract base class for parser-objects. The latter is defined
here, becuase node-objects refer to parser-objects. All concrete
parser classes are defined in the ``parse`` module.
"""

26

Eckhart Arnold's avatar
Eckhart Arnold committed
27
import collections.abc
28
import copy
29
30
from functools import partial

31
from DHParser.error import Error, linebreaks, line_col
32
from DHParser.stringview import StringView
33
from DHParser.toolkit import re, typing
di68kap's avatar
di68kap committed
34
35
from typing import Any, Callable, cast, Iterator, List, Union, Tuple, Hashable, Optional

36

37
38
39
40
41
42
43
__all__ = ('ParserBase',
           'WHITESPACE_PTYPE',
           'TOKEN_PTYPE',
           'MockParser',
           'ZombieParser',
           'ZOMBIE_PARSER',
           'Node',
44
           'mock_syntax_tree',
45
           'flatten_sxpr',
46
           'TransformationFunc')
Eckhart Arnold's avatar
Eckhart Arnold committed
47
48


49
50
51
52
53
54
55
56
57
58
59
60
61
62
#######################################################################
#
# 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()):
63
        self._name = name  # type: str
64
65
66
        self._ptype = ':' + self.__class__.__name__  # type: str

    def __repr__(self):
di68kap's avatar
di68kap committed
67
         return self.name + self.ptype
68
69
70
71

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

72
73
74
    def __call__(self, text: StringView) -> Tuple[Optional['Node'], StringView]:
        return None, text

75
76
    @property
    def name(self):
77
78
        """Returns the name of the parser or the empty string '' for unnamed
        parsers."""
79
80
        return self._name

81
82
    @property
    def ptype(self) -> str:
83
84
        """Returns the type of the parser. By default this is the parser's
        class name preceded by a colon, e.g. ':ZeroOrMore'."""
85
86
87
88
        return self._ptype

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

92
    def reset(self):
93
        """Resets any parser variables. (Should be overridden.)"""
94
95
        pass

eckhart's avatar
eckhart committed
96
    def grammar(self) -> Optional[object]:
97
98
        """Returns the Grammar object to which the parser belongs. If not
        yet connected to any Grammar object, None is returned."""
99
100
101
        return None

    def apply(self, func: Callable) -> bool:
eckhart's avatar
eckhart committed
102
        """Applies the function `func` to the parser. Returns False, if
103
        - for whatever reason - the functions has not been applied, True
eckhart's avatar
eckhart committed
104
        otherwise."""
105
106
        return False

107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

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] == ':'
124
        super().__init__(name)
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
159
160
161
162
163
164
165
166
        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
#
#######################################################################


167
ChildrenType = Tuple['Node', ...]
Eckhart Arnold's avatar
Eckhart Arnold committed
168
NoChildren = cast(ChildrenType, ())  # type: ChildrenType
169
StrictResultType = Union[ChildrenType, str]
170
ResultType = Union[ChildrenType, 'Node', StringView, str, None]
171
172


Eckhart Arnold's avatar
Eckhart Arnold committed
173
def flatten_sxpr(sxpr: str) -> str:
174
    """Returns S-expression ``sxpr`` as a one-liner without unnecessary
Eckhart Arnold's avatar
Eckhart Arnold committed
175
176
177
    whitespace.

    Example:
Eckhart Arnold's avatar
Eckhart Arnold committed
178
    >>> flatten_sxpr('(a\\n    (b\\n        c\\n    )\\n)\\n')
Eckhart Arnold's avatar
Eckhart Arnold committed
179
180
    '(a (b c))'
    """
181
    return re.sub(r'\s(?=\))', '', re.sub(r'\s+', ' ', sxpr)).strip()
Eckhart Arnold's avatar
Eckhart Arnold committed
182
183


Eckhart Arnold's avatar
Eckhart Arnold committed
184
class Node(collections.abc.Sized):
185
186
187
    """
    Represents a node in the concrete or abstract syntax tree.

188
    Attributes:
189
190
191
192
193
194
195
        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
196
        parser (Parser):  The parser which generated this node.
197
198
            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
199
200
            rely on this being a real parser object in any phase after
            parsing (i.e. AST-transformation and compiling), for
201
            example by calling ``isinstance(node.parer, ...)``.
202
203
        errors (list):  A list of parser- or compiler-errors:
            tuple(position, string) attached to this node
204
205
206
        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.
207
208
209
        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
210
            the length before AST-transformation and will never change
211
212
213
            through AST-transformation. READ ONLY!
        pos (int):  the position of the node within the parsed text.

Eckhart Arnold's avatar
Eckhart Arnold committed
214
            The value of ``pos`` is -1 meaning invalid by default.
215
            Setting this value will set the positions of all child
Eckhart Arnold's avatar
Eckhart Arnold committed
216
            nodes relative to this value.
217
218

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

Eckhart Arnold's avatar
Eckhart Arnold committed
222
            Other than that, this value should be considered READ ONLY.
223
224
            At any rate, it should only be reassigned during the parsing
            stage and never during or after the AST-transformation.
225
    """
226

di68kap's avatar
di68kap committed
227
228
    __slots__ = ['_result', 'children', '_errors', '_len', '_pos', 'parser', 'error_flag',
                 '_xml_attr']
229

230
231
232
    def __init__(self, parser, result: ResultType, leafhint: bool = False) -> None:
        """
        Initializes the ``Node``-object with the ``Parser``-Instance
233
234
        that generated the node and the parser's result.
        """
235
236
        self.error_flag = 0             # type: int
        self._errors = []               # type: List[Error]
eckhart's avatar
eckhart committed
237
        self._pos = -1                  # type: int
di68kap's avatar
di68kap committed
238
239
        # 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
240
        if leafhint:
241
            self._result = str(result)  # type: StrictResultType
242
            self.children = NoChildren  # type: ChildrenType
243
            self._len = -1              # type: int  # lazy evaluation
244
245
        else:
            self.result = result
246
247
        self.parser = parser or ZOMBIE_PARSER

Eckhart Arnold's avatar
Eckhart Arnold committed
248

249
    def __str__(self):
250
251
252
253
254
        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
255

Eckhart Arnold's avatar
Eckhart Arnold committed
256

257
258
259
260
261
262
    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)
263

Eckhart Arnold's avatar
Eckhart Arnold committed
264

265
    def __len__(self):
266
        if self._len < 0:
di68kap's avatar
di68kap committed
267
            self._len = sum(len(child) for child in self.children) \
268
                if self.children else len(self._result)
269
270
271
        return self._len


272

273
274
275
276
277
    def __bool__(self):
        # A node that is not None is always True, even if it's empty
        return True


278
    def __eq__(self, other):
279
280
        # return str(self.parser) == str(other.parser) and self.result == other.result
        return self.tag_name == other.tag_name and self.result == other.result
281

Eckhart Arnold's avatar
Eckhart Arnold committed
282

283
    def __hash__(self):
284
        return hash(self.tag_name)
285

Eckhart Arnold's avatar
Eckhart Arnold committed
286

287
288
289
290
291
292
    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
293

294
    @property   # this needs to be a (dynamic) property, in case sef.parser gets updated
295
    def tag_name(self) -> str:
296
297
298
299
300
301
        """
        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`.
        """
302
        return self.parser.name or self.parser.ptype
303

Eckhart Arnold's avatar
Eckhart Arnold committed
304

305
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
306
    def result(self) -> StrictResultType:
307
308
309
310
311
        """
        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.
        """
312
313
        return self._result

314

315
    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
316
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
317
        # # made obsolete by static type checking with mypy
318
319
320
        # 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
321
322
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
323
        self._len = -1  # lazy evaluation
324
325
326
327
        if isinstance(result, Node):
            self.children = (result,)
            self._result = self.children
            self.error_flag = result.error_flag
328
329
            # if self._pos < 0:
            #     self._pos = result._pos
330
331
332
333
        else:
            if isinstance(result, tuple):
                self.children = result
                self._result = result or ''
334
335
336
                if result:
                    if self.error_flag == 0:
                        self.error_flag = max(child.error_flag for child in self.children)
337
338
                    # if self._pos < 0:
                    #     self._pos = result[0]._pos
339
340
            else:
                self.children = NoChildren
341
                self._result = str(result)
342
343
344
345
346
347
348
349
        # # 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

350
351
352
353
354
355
356
357
358

    @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
359
        return cast(str, self._result)
360
361
362
363
364
365
366
367
368
369
370


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


371
    @property
372
    def pos(self) -> int:
eckhart's avatar
eckhart committed
373
374
        """Returns the position of the Node's content in the source text."""
        if self._pos < 0:
375
            raise AssertionError("Position value not initialized!")
376
377
        return self._pos

eckhart's avatar
eckhart committed
378

eckhart's avatar
eckhart committed
379
    def init_pos(self, pos: int, overwrite: bool = False) -> 'Node':
eckhart's avatar
eckhart committed
380
381
382
383
384
385
386
387
388
        """
        (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
389
390
391
392
393
394
        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))
395
        # recursively adjust pos-values of all children
eckhart's avatar
eckhart committed
396
        offset = self.pos
397
        for child in self.children:
eckhart's avatar
eckhart committed
398
            child.init_pos(offset, overwrite)
eckhart's avatar
eckhart committed
399
400
401
            offset = child.pos + len(child)
        return self

402
403

    @property
404
    def errors(self) -> List[Error]:
eckhart's avatar
eckhart committed
405
        """
406
        Returns the errors that occurred at this Node,
eckhart's avatar
eckhart committed
407
408
        not including any errors from child nodes.
        """
409
410
        return self._errors.copy()

411

eckhart's avatar
eckhart committed
412
413
    def add_error(self,
                  message: str,
414
                  code: int = Error.ERROR) -> 'Node':
eckhart's avatar
eckhart committed
415
416
417
        """
        Adds an error to this Node.
        Parameters:
eckhart's avatar
eckhart committed
418
419
            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
420
        """
421
422
        self._errors.append(Error(message, code))
        self.error_flag = max(self.error_flag, self._errors[-1].code)
Eckhart Arnold's avatar
Eckhart Arnold committed
423
424
        return self

425

426
    def collect_errors(self, clear_errors=False) -> List[Error]:
Eckhart Arnold's avatar
Eckhart Arnold committed
427
        """
428
        Recursively adds line- and column-numbers to all error objects.
Eckhart Arnold's avatar
Eckhart Arnold committed
429
430
431
432
        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.
        """
433
        errors = self.errors
434
435
        for err in errors:
            err.pos = self.pos
436
437
        if self.children:
            for child in self.children:
438
                errors.extend(child.collect_errors(clear_errors))
439
440
441
        if clear_errors:
            self._errors = []
            self.error_flag = 0
442
        else:
443
444
445
446
447
448
449
            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

450

Eckhart Arnold's avatar
Eckhart Arnold committed
451

452
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=lambda i: i, density=0) -> str:
453
454
455
456
457
458
459
460
        """
        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.

461
        Args:
462
            tab (str):  The indentation string, e.g. '\t' or '    '
eckhart's avatar
eckhart committed
463
            open_fn:   (Node->str) A function that returns an opening
464
                string (e.g. an XML-tag_name) for a given node
eckhart's avatar
eckhart committed
465
            close_fn:  (Node->str) A function that returns a closeF
466
                string (e.g. an XML-tag_name) for a given node.
eckhart's avatar
eckhart committed
467
            data_fn:   (str->str) A function that filters the data string
468
469
470
471
472
473
                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
474
475
        head = open_fn(self)
        tail = close_fn(self)
476
477

        if not self.result:
478
            return head.rstrip() + tail.lstrip()
479

eckhart's avatar
eckhart committed
480
        tail = tail.lstrip(None if density & 2 else '')
481
482
483

        if self.children:
            content = []
484
            for child in self.children:
eckhart's avatar
eckhart committed
485
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn, density).split('\n')
486
                content.append('\n'.join((tab + s) for s in subtree))
eckhart's avatar
eckhart committed
487
            return head + '\n'.join(content) + tail
488

489
        res = cast(str, self.result)  # safe, because if there are no children, result is a string
490
491
492
        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
493
            return head.rstrip() + gap + data_fn(self.result) + tail.lstrip()
494
        else:
eckhart's avatar
eckhart committed
495
            return head + '\n'.join([tab + data_fn(s) for s in res.split('\n')]) + tail
496

Eckhart Arnold's avatar
Eckhart Arnold committed
497

498
    def as_sxpr(self, src: str = None, compact: bool = False, showerrors: bool = True) -> str:
499
500
501
        """
        Returns content as S-expression, i.e. in lisp-like form.

502
        Args:
503
504
505
            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
506
            compact:  If True a compact representation is returned where
507
                brackets are omitted and only the indentation indicates the
Eckhart Arnold's avatar
Eckhart Arnold committed
508
                tree structure.
509
510
        """

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

513
        def opening(node) -> str:
eckhart's avatar
eckhart committed
514
515
            """Returns the opening string for the representation of `node`."""
            txt = left_bracket + node.tag_name
516
517
            # s += " '(pos %i)" % node.pos
            if src:
eckhart's avatar
eckhart committed
518
                txt += " '(pos %i " % node.pos  # + " %i %i)" % line_col(src, node.pos)
di68kap's avatar
di68kap committed
519
520
            # if node.error_flag:   # just for debugging error collecting
            #     txt += " HAS ERRORS"
521
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
522
523
524
                txt += " '(err '(%s))" % ' '.join(str(err).replace('"', r'\"')
                                                  for err in node.errors)
            return txt + '\n'
525

eckhart's avatar
eckhart committed
526
527
528
        def closing(node) -> str:
            """Returns the closing string for the representation of `node`."""
            return right_bracket
529

eckhart's avatar
eckhart committed
530
531
532
533
534
        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'\"')
535

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

eckhart's avatar
eckhart committed
538

eckhart's avatar
eckhart committed
539
540
541
542
543
544
545
546
    @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


547
    def as_xml(self, src: str = None, showerrors: bool = True) -> str:
548
549
550
        """
        Returns content as XML-tree.

551
        Args:
552
553
554
555
556
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
        """

557
        def opening(node) -> str:
eckhart's avatar
eckhart committed
558
            """Returns the opening string for the representation of `node`."""            
eckhart's avatar
eckhart committed
559
            txt = ['<', node.tag_name]
560
            # s += ' pos="%i"' % node.pos
di68kap's avatar
di68kap committed
561
562
            if hasattr(node, '_xml_attr'):
                txt.extend(' %s="%s"' % (k, v) for k, v in node.xml_attr.items())
563
            if src:
eckhart's avatar
eckhart committed
564
                txt.append(' line="%i" col="%i"' % line_col(line_breaks, node.pos))
565
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
566
567
568
                txt.append(' err="%s"' % ''.join(str(err).replace('"', r'\"')
                                                 for err in node.errors))
            return "".join(txt + [">\n"])
569
570

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

574
        line_breaks = linebreaks(src) if src else []
575
        return self._tree_repr('    ', opening, closing, density=1)
576

Eckhart Arnold's avatar
Eckhart Arnold committed
577

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

di68kap's avatar
di68kap committed
582
583
        `find` is a generator that yields all nodes for which the
        given `match_function` evaluates to True. The tree is
584
        traversed pre-order.
eckhart's avatar
eckhart committed
585

586
587
588
589
        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
        Yields:
eckhart's avatar
eckhart committed
590
            Node: all nodes of the tree for which
591
592
593
594
595
596
            ``match_function(node)`` returns True
        """
        if match_function(self):
            yield self
        else:
            for child in self.children:
eckhart's avatar
eckhart committed
597
598
                for node in child.find(match_function):
                    yield node
599

Eckhart Arnold's avatar
Eckhart Arnold committed
600

601
    def tree_size(self) -> int:
eckhart's avatar
eckhart committed
602
603
604
        """
        Recursively counts the number of nodes in the tree including the root node.
        """
605
606
607
        return sum(child.tree_size() for child in self.children) + 1


608
def mock_syntax_tree(sxpr):
609
    """
di68kap's avatar
di68kap committed
610
611
    Generates a tree of nodes from an S-expression. The main purpose of this is
    to generate test data.
612
613
614
615
616
617
618

    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
619
620
621
        """Generator that yields all characters until the next closing bracket
        that does not match an opening bracket matched earlier within the same
        package."""
622
        s = s.strip()
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
        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)
642

643
    sxpr = sxpr.strip()
eckhart's avatar
eckhart committed
644
645
    if sxpr[0] != '(':
        raise ValueError('"(" expected, not ' + sxpr[:10])
646
647
    # assert sxpr[0] == '(', sxpr
    sxpr = sxpr[1:].strip()
eckhart's avatar
eckhart committed
648
    match = re.match(r'[\w:]+', sxpr)
649
650
651
    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
652
653
    name, class_name = (sxpr[:match.end()].split(':') + [''])[:2]
    sxpr = sxpr[match.end():].strip()
654
655
    if sxpr[0] == '(':
        result = tuple(mock_syntax_tree(block) for block in next_block(sxpr))
656
657
658
659
        pos = 0
        for node in result:
            node._pos = pos
            pos += len(node)
660
661
    else:
        lines = []
662
        while sxpr and sxpr[0] != ')':
eckhart's avatar
eckhart committed
663
664
665
666
667
668
            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()
669
670
                    break
            else:
eckhart's avatar
eckhart committed
671
672
673
                match = re.match(r'(?:(?!\)).)*', sxpr, re.DOTALL)
                lines.append(sxpr[:match.end()])
                sxpr = sxpr[match.end():]
674
        result = "\n".join(lines)
675
676
677
    node = Node(MockParser(name, ':' + class_name), result)
    node._pos = 0
    return node
678
679


680
TransformationFunc = Union[Callable[[Node], Any], partial]
681

682
683
684
685
686

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