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.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
import os
22
23
from functools import partial

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

29

30
31
32
33
34
35
36
__all__ = ('ParserBase',
           'WHITESPACE_PTYPE',
           'TOKEN_PTYPE',
           'MockParser',
           'ZombieParser',
           'ZOMBIE_PARSER',
           'Node',
37
38
           'mock_syntax_tree',
           '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
59
60
61
62
63
        self._ptype = ':' + self.__class__.__name__  # type: str

    def __repr__(self):
        return self.name + self.ptype

    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:
81
82
        """Returns the parser's name if it has a name and the parser's
        `ptype` otherwise. Note that for named parsers this is not the
eckhart's avatar
eckhart committed
83
        same as `repr(parsers)` which always returns the comined name
84
        and ptype, e.g. 'term:OneOrMore'."""
85
86
        return self.name if self.name else repr(self)

87
    def reset(self):
88
        """Resets any parser variables. (Should be overridden.)"""
89
90
        pass

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

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

102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

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] == ':'
119
        super().__init__(name)
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
159
160
161
        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
#
#######################################################################


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


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

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


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

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

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

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

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

222
223
    __slots__ = ['_result', 'children', '_errors', '_len', '_pos', 'parser', 'error_flag']

224

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

Eckhart Arnold's avatar
Eckhart Arnold committed
243

244
    def __str__(self):
245
246
247
248
249
        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
250

Eckhart Arnold's avatar
Eckhart Arnold committed
251

252
253
254
255
256
257
    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)
258

Eckhart Arnold's avatar
Eckhart Arnold committed
259

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


267

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


273
    def __eq__(self, other):
274
275
        # return str(self.parser) == str(other.parser) and self.result == other.result
        return self.tag_name == other.tag_name and self.result == other.result
276

Eckhart Arnold's avatar
Eckhart Arnold committed
277

278
    def __hash__(self):
279
        return hash(self.tag_name)
280

Eckhart Arnold's avatar
Eckhart Arnold committed
281

282
283
284
285
286
287
    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
288

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

Eckhart Arnold's avatar
Eckhart Arnold committed
299

300
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
301
    def result(self) -> StrictResultType:
302
303
304
305
306
        """
        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.
        """
307
308
        return self._result

309

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

345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365

    @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)
        return self._result


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


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

eckhart's avatar
eckhart committed
373

eckhart's avatar
eckhart committed
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
    # @pos.setter
    # def pos(self, pos: int):
    #     assert self._pos == pos, str("%i != %i" % (self._pos, pos))
    #     offset = 0
    #     # recursively adjust pos-values of all children
    #     for child in self.children:
    #         assert child.pos == pos + offset
    #         offset += len(child)
    #     # add pos-values to Error-objects
    #     for err in self._errors:
    #         err.pos = pos


    def init_pos(self, pos: int, overwrite: bool = False) -> 'Node':
        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))
394
        # recursively adjust pos-values of all children
eckhart's avatar
eckhart committed
395
        offset = self.pos
396
        for child in self.children:
eckhart's avatar
eckhart committed
397
398
399
400
            child.init_pos(offset)
            offset = child.pos + len(child)
        return self

401

Eckhart Arnold's avatar
Eckhart Arnold committed
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
427
    def collect_errors(self, document: Union[StringView, str] = '', clear_errors=False) \
            -> List[Error]:
Eckhart Arnold's avatar
Eckhart Arnold committed
428
        """
429
        Recursively adds line- and column-numbers to all error objects.
Eckhart Arnold's avatar
Eckhart Arnold committed
430
431
432
433
        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.
        """
434
435
436
437
438
439
        if self.error_flag:
            lbreaks = linebreaks(document) if document else []
            return self._collect_errors(lbreaks, clear_errors)
        else:
            return []

eckhart's avatar
eckhart committed
440
    def _collect_errors(self, lbreaks: List[int] = [], clear_errors=False) -> List[Error]:
441
442
443
444
445
446
447
448
449
450
451
        errors = self.errors
        if errors and lbreaks:
            for err in errors:
                err.pos = self.pos
                err.line, err.column = line_col(lbreaks, err.pos)
        if self.children:
            for child in self.children:
                errors.extend(child._collect_errors(lbreaks, clear_errors))
        if clear_errors:
            self._errors = []
            self.error_flag = 0
452
        else:
453
454
455
456
457
458
459
            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

460

Eckhart Arnold's avatar
Eckhart Arnold committed
461

eckhart's avatar
eckhart committed
462
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=identity, density=0) -> str:
463
464
465
466
467
468
469
470
        """
        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.

471
        Args:
472
            tab (str):  The indentation string, e.g. '\t' or '    '
eckhart's avatar
eckhart committed
473
            open_fn:   (Node->str) A function that returns an opening
474
                string (e.g. an XML-tag_name) for a given node
eckhart's avatar
eckhart committed
475
            close_fn:  (Node->str) A function that returns a closeF
476
                string (e.g. an XML-tag_name) for a given node.
eckhart's avatar
eckhart committed
477
            data_fn:   (str->str) A function that filters the data string
478
479
480
481
482
483
                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
484
485
        head = open_fn(self)
        tail = close_fn(self)
486
487

        if not self.result:
488
            return head.rstrip() + tail.lstrip()
489

eckhart's avatar
eckhart committed
490
        tail = tail.lstrip(None if density & 2 else '')
491
492
493

        if self.children:
            content = []
494
            for child in self.children:
eckhart's avatar
eckhart committed
495
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn, density).split('\n')
496
                content.append('\n'.join((tab + s) for s in subtree))
eckhart's avatar
eckhart committed
497
            return head + '\n'.join(content) + tail
498

499
        res = cast(str, self.result)  # safe, because if there are no children, result is a string
500
501
502
        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
503
            return head.rstrip() + gap + data_fn(self.result) + tail.lstrip()
504
        else:
eckhart's avatar
eckhart committed
505
            return head + '\n'.join([tab + data_fn(s) for s in res.split('\n')]) + tail
506

Eckhart Arnold's avatar
Eckhart Arnold committed
507

508
    def as_sxpr(self, src: str = None, compact: bool = False, showerrors: bool = True) -> str:
509
510
511
        """
        Returns content as S-expression, i.e. in lisp-like form.

512
        Args:
513
514
515
            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
516
517
518
            compact:  If True a compact representation is returned where
                brackets are ommited and only the indentation indicates the
                tree structure.
519
520
        """

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

523
        def opening(node) -> str:
eckhart's avatar
eckhart committed
524
525
            """Returns the opening string for the representation of `node`."""
            txt = left_bracket + node.tag_name
526
527
            # s += " '(pos %i)" % node.pos
            if src:
eckhart's avatar
eckhart committed
528
                txt += " '(pos %i " % node.pos  # + " %i %i)" % line_col(src, node.pos)
di68kap's avatar
di68kap committed
529
530
            # if node.error_flag:   # just for debugging error collecting
            #     txt += " HAS ERRORS"
531
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
532
533
534
                txt += " '(err '(%s))" % ' '.join(str(err).replace('"', r'\"')
                                                  for err in node.errors)
            return txt + '\n'
535

eckhart's avatar
eckhart committed
536
537
538
        def closing(node) -> str:
            """Returns the closing string for the representation of `node`."""
            return right_bracket
539

eckhart's avatar
eckhart committed
540
541
542
543
544
        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'\"')
545

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

eckhart's avatar
eckhart committed
548

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

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

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

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

573
        return self._tree_repr('    ', opening, closing, density=1)
574

Eckhart Arnold's avatar
Eckhart Arnold committed
575

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

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

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

Eckhart Arnold's avatar
Eckhart Arnold committed
598

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


Eckhart Arnold's avatar
Eckhart Arnold committed
606
    def log(self, log_file_name):
eckhart's avatar
eckhart committed
607
        """
608
        Writes an S-expression-representation of the tree with root `self` to a file.
eckhart's avatar
eckhart committed
609
        """
610
        if is_logging():
Eckhart Arnold's avatar
Eckhart Arnold committed
611
612
613
614
            path = os.path.join(log_dir(), log_file_name)
            if os.path.exists(path):
                print('WARNING: Log-file "%s" already exists and will be overwritten!' % path)
            with open(path, "w", encoding="utf-8") as f:
615
                f.write(self.as_sxpr())
Eckhart Arnold's avatar
Eckhart Arnold committed
616

617

618
def mock_syntax_tree(sxpr):
619
    """
di68kap's avatar
di68kap committed
620
621
    Generates a tree of nodes from an S-expression. The main purpose of this is
    to generate test data.
622
623
624
625
626
627
628

    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
629
630
631
        """Generator that yields all characters until the next closing bracket
        that does not match an opening bracket matched earlier within the same
        package."""
632
633
        s = s.strip()
        while s[0] != ')':
eckhart's avatar
eckhart committed
634
635
            if s[0] != '(':
                raise ValueError('"(" expected, not ' + s[:10])
636
637
            # assert s[0] == '(', s
            level = 1
638
            k = 1
639
            while level > 0:
640
                if s[k] == '(':
641
                    level += 1
642
                elif s[k] == ')':
643
                    level -= 1
644
645
646
                k += 1
            yield s[:k]
            s = s[k:].strip()
647

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


676
TransformationFunc = Union[Callable[[Node], Any], partial]
677

678
679
680
681
682

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