syntaxtree.py 25.1 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
26
from DHParser.toolkit import is_logging, log_dir, re, typing
di68kap's avatar
di68kap committed
27 28
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
           'mock_syntax_tree',
38
           'flatten_sxpr',
39
           'TransformationFunc')
Eckhart Arnold's avatar
Eckhart Arnold committed
40 41


42 43 44 45 46 47 48 49 50 51 52 53 54 55
#######################################################################
#
# 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()):
56
        self._name = name  # type: str
57 58 59 60 61 62 63 64
        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)

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

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

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

    @property
    def repr(self) -> str:
82 83
        """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
84
        same as `repr(parsers)` which always returns the comined name
85
        and ptype, e.g. 'term:OneOrMore'."""
86 87
        return self.name if self.name else repr(self)

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

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

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

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

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] == ':'
120
        super().__init__(name)
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 162
        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
#
#######################################################################


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


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

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


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

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

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

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

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

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

225

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

Eckhart Arnold's avatar
Eckhart Arnold committed
244

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

Eckhart Arnold's avatar
Eckhart Arnold committed
252

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

Eckhart Arnold's avatar
Eckhart Arnold committed
260

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


268

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


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

Eckhart Arnold's avatar
Eckhart Arnold committed
278

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

Eckhart Arnold's avatar
Eckhart Arnold committed
282

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

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

Eckhart Arnold's avatar
Eckhart Arnold committed
300

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

310

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

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

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


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

eckhart's avatar
eckhart committed
374

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

398 399

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

407

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

421

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

446

Eckhart Arnold's avatar
Eckhart Arnold committed
447

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

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

        if not self.result:
474
            return head.rstrip() + tail.lstrip()
475

eckhart's avatar
eckhart committed
476
        tail = tail.lstrip(None if density & 2 else '')
477 478 479

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

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

Eckhart Arnold's avatar
Eckhart Arnold committed
493

494
    def as_sxpr(self, src: str = None, compact: bool = False, showerrors: bool = True) -> str:
495 496 497
        """
        Returns content as S-expression, i.e. in lisp-like form.

498
        Args:
499 500 501
            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
502 503 504
            compact:  If True a compact representation is returned where
                brackets are ommited and only the indentation indicates the
                tree structure.
505 506
        """

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

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

eckhart's avatar
eckhart committed
522 523 524
        def closing(node) -> str:
            """Returns the closing string for the representation of `node`."""
            return right_bracket
525

eckhart's avatar
eckhart committed
526 527 528 529 530
        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'\"')
531

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

eckhart's avatar
eckhart committed
534

eckhart's avatar
eckhart committed
535 536 537 538 539 540 541 542
    @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


543
    def as_xml(self, src: str = None, showerrors: bool = True) -> str:
544 545 546
        """
        Returns content as XML-tree.

547
        Args:
548 549 550 551 552
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
        """

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

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

570
        line_breaks = linebreaks(src) if src else []
571
        return self._tree_repr('    ', opening, closing, density=1)
572

Eckhart Arnold's avatar
Eckhart Arnold committed
573

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

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

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

Eckhart Arnold's avatar
Eckhart Arnold committed
596

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


Eckhart Arnold's avatar
Eckhart Arnold committed
604
    def log(self, log_file_name):
eckhart's avatar
eckhart committed
605
        """
606
        Writes an S-expression-representation of the tree with root `self` to a file.
eckhart's avatar
eckhart committed
607
        """
608
        if is_logging():
Eckhart Arnold's avatar
Eckhart Arnold committed
609 610 611 612
            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:
613
                f.write(self.as_sxpr())
Eckhart Arnold's avatar
Eckhart Arnold committed
614

615

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

    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
627 628 629
        """Generator that yields all characters until the next closing bracket
        that does not match an opening bracket matched earlier within the same
        package."""
630
        s = s.strip()
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
        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)
650

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


688
TransformationFunc = Union[Callable[[Node], Any], partial]
689

690 691 692 693 694

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