In January 2021 we will introduce a 10 GB quota for project repositories. Higher limits for individual projects will be available on request. Please see https://doku.lrz.de/display/PUBLIC/GitLab for more information.

syntaxtree.py 26.2 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
        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
191

192 193 194
        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.
195

196 197
        children (tuple):  The tuple of child nodes or an empty tuple
            if there are no child nodes. READ ONLY!
198

Eckhart Arnold's avatar
Eckhart Arnold committed
199
        parser (Parser):  The parser which generated this node.
200 201
            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
202 203
            rely on this being a real parser object in any phase after
            parsing (i.e. AST-transformation and compiling), for
204
            example by calling ``isinstance(node.parer, ...)``.
205

206 207
        errors (list):  A list of parser- or compiler-errors:
            tuple(position, string) attached to this node
208

209 210 211
        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.
212

213 214 215
        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
216
            the length before AST-transformation and will never change
217
            through AST-transformation. READ ONLY!
218

219 220
        pos (int):  the position of the node within the parsed text.

Eckhart Arnold's avatar
Eckhart Arnold committed
221
            The value of ``pos`` is -1 meaning invalid by default.
222
            Setting this value will set the positions of all child
Eckhart Arnold's avatar
Eckhart Arnold committed
223
            nodes relative to this value.
224 225

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

Eckhart Arnold's avatar
Eckhart Arnold committed
229
            Other than that, this value should be considered READ ONLY.
230 231
            At any rate, it should only be reassigned during the parsing
            stage and never during or after the AST-transformation.
232
    """
233

di68kap's avatar
di68kap committed
234 235
    __slots__ = ['_result', 'children', '_errors', '_len', '_pos', 'parser', 'error_flag',
                 '_xml_attr']
236

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

Eckhart Arnold's avatar
Eckhart Arnold committed
255

256
    def __str__(self):
257 258 259 260 261
        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
262

Eckhart Arnold's avatar
Eckhart Arnold committed
263

264 265 266 267 268 269
    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)
270

Eckhart Arnold's avatar
Eckhart Arnold committed
271

272
    def __len__(self):
273
        if self._len < 0:
di68kap's avatar
di68kap committed
274
            self._len = sum(len(child) for child in self.children) \
275
                if self.children else len(self._result)
276 277 278 279 280 281 282 283
        return self._len


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


284
    def __eq__(self, other):
285 286 287 288
        """
        Equality of nodes: Two nodes are considered as equal, if their tag
        name is the same and if their results are equal.
        """
289
        return self.tag_name == other.tag_name and self.result == other.result
290

Eckhart Arnold's avatar
Eckhart Arnold committed
291

292
    def __hash__(self):
293
        return hash(self.tag_name)
294

Eckhart Arnold's avatar
Eckhart Arnold committed
295

296 297 298 299 300 301
    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
302

303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
    def __getitem__(self, index_or_tagname: Union[int, str]) -> Union['Node', Iterator['Node']]:
        """
        Returns the child node with the given index if ``index_or_tagname`` is
        an integer value or a generator that yields all descendant nodes that
        match a particular tag name. Examples::

            >>> tree =  mock_syntax_tree('(a (b "X") (X (c "d")) (e (X "F")))')
            >>> flatten_sxpr(tree[0].as_sxpr())
            '(b "X")'
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree["X"])
            ['(X (c "d"))', '(X "F")']

        Args:
            index_or_tagname(str): Either an index of a child node or a
                tag name.
        Return:
            Node: All nodes which have a given tag name.
        """
        if isinstance(index_or_tagname, int):
            children = self.children
            if children:
                return children[index_or_tagname]
            else:
                raise ValueError('Leave nodes have no children that can be indexed!')
        else:
            match_function = lambda node: node.tag_name == index_or_tagname
            return self.find(match_function)


332
    @property   # this needs to be a (dynamic) property, in case sef.parser gets updated
333
    def tag_name(self) -> str:
334 335 336 337 338 339
        """
        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`.
        """
340
        return self.parser.name or self.parser.ptype
341

Eckhart Arnold's avatar
Eckhart Arnold committed
342

343
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
344
    def result(self) -> StrictResultType:
345 346 347 348 349
        """
        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.
        """
350 351
        return self._result

352

353
    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
354
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
355
        # # made obsolete by static type checking with mypy
356 357 358
        # 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
359 360
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
361
        self._len = -1  # lazy evaluation
362 363 364 365
        if isinstance(result, Node):
            self.children = (result,)
            self._result = self.children
            self.error_flag = result.error_flag
366 367
            # if self._pos < 0:
            #     self._pos = result._pos
368 369 370 371
        else:
            if isinstance(result, tuple):
                self.children = result
                self._result = result or ''
372 373 374
                if result:
                    if self.error_flag == 0:
                        self.error_flag = max(child.error_flag for child in self.children)
375 376
                    # if self._pos < 0:
                    #     self._pos = result[0]._pos
377 378
            else:
                self.children = NoChildren
379
                self._result = str(result)
380 381 382 383 384 385 386 387
        # # 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

388 389 390 391 392 393 394 395 396

    @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
397
        return cast(str, self._result)
398 399 400 401 402 403 404 405 406 407 408


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


409
    @property
410
    def pos(self) -> int:
eckhart's avatar
eckhart committed
411 412
        """Returns the position of the Node's content in the source text."""
        if self._pos < 0:
413
            raise AssertionError("Position value not initialized!")
414 415
        return self._pos

eckhart's avatar
eckhart committed
416

eckhart's avatar
eckhart committed
417
    def init_pos(self, pos: int, overwrite: bool = False) -> 'Node':
eckhart's avatar
eckhart committed
418 419 420 421 422 423 424 425 426
        """
        (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
427 428 429 430 431 432
        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))
433
        # recursively adjust pos-values of all children
eckhart's avatar
eckhart committed
434
        offset = self.pos
435
        for child in self.children:
eckhart's avatar
eckhart committed
436
            child.init_pos(offset, overwrite)
eckhart's avatar
eckhart committed
437 438 439
            offset = child.pos + len(child)
        return self

440 441

    @property
442
    def errors(self) -> List[Error]:
eckhart's avatar
eckhart committed
443
        """
444
        Returns the errors that occurred at this Node,
eckhart's avatar
eckhart committed
445 446
        not including any errors from child nodes.
        """
447 448
        return self._errors.copy()

449

eckhart's avatar
eckhart committed
450 451
    def add_error(self,
                  message: str,
452
                  code: int = Error.ERROR) -> 'Node':
eckhart's avatar
eckhart committed
453 454 455
        """
        Adds an error to this Node.
        Parameters:
eckhart's avatar
eckhart committed
456 457
            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
458
        """
459 460
        self._errors.append(Error(message, code))
        self.error_flag = max(self.error_flag, self._errors[-1].code)
Eckhart Arnold's avatar
Eckhart Arnold committed
461 462
        return self

463

464
    def collect_errors(self, clear_errors=False) -> List[Error]:
Eckhart Arnold's avatar
Eckhart Arnold committed
465
        """
466
        Recursively adds line- and column-numbers to all error objects.
Eckhart Arnold's avatar
Eckhart Arnold committed
467 468 469 470
        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.
        """
471
        errors = self.errors
472 473
        for err in errors:
            err.pos = self.pos
474 475
        if self.children:
            for child in self.children:
476
                errors.extend(child.collect_errors(clear_errors))
477 478 479
        if clear_errors:
            self._errors = []
            self.error_flag = 0
480
        else:
481 482 483 484 485 486 487
            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

488

Eckhart Arnold's avatar
Eckhart Arnold committed
489

490
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=lambda i: i, density=0) -> str:
491 492 493 494 495 496 497 498
        """
        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.

499
        Args:
500
            tab (str):  The indentation string, e.g. '\t' or '    '
eckhart's avatar
eckhart committed
501
            open_fn:   (Node->str) A function that returns an opening
502
                string (e.g. an XML-tag_name) for a given node
eckhart's avatar
eckhart committed
503
            close_fn:  (Node->str) A function that returns a closeF
504
                string (e.g. an XML-tag_name) for a given node.
eckhart's avatar
eckhart committed
505
            data_fn:   (str->str) A function that filters the data string
506 507 508 509 510 511
                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
512 513
        head = open_fn(self)
        tail = close_fn(self)
514 515

        if not self.result:
516
            return head.rstrip() + tail.lstrip()
517

eckhart's avatar
eckhart committed
518
        tail = tail.lstrip(None if density & 2 else '')
519 520 521

        if self.children:
            content = []
522
            for child in self.children:
eckhart's avatar
eckhart committed
523
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn, density).split('\n')
524
                content.append('\n'.join((tab + s) for s in subtree))
eckhart's avatar
eckhart committed
525
            return head + '\n'.join(content) + tail
526

527
        res = cast(str, self.result)  # safe, because if there are no children, result is a string
528 529 530
        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
531
            return head.rstrip() + gap + data_fn(self.result) + tail.lstrip()
532
        else:
eckhart's avatar
eckhart committed
533
            return head + '\n'.join([tab + data_fn(s) for s in res.split('\n')]) + tail
534

Eckhart Arnold's avatar
Eckhart Arnold committed
535

536
    def as_sxpr(self, src: str = None, compact: bool = False, showerrors: bool = True) -> str:
537 538 539
        """
        Returns content as S-expression, i.e. in lisp-like form.

540
        Args:
541 542 543
            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
544
            compact:  If True a compact representation is returned where
545
                brackets are omitted and only the indentation indicates the
Eckhart Arnold's avatar
Eckhart Arnold committed
546
                tree structure.
547 548
        """

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

551
        def opening(node) -> str:
eckhart's avatar
eckhart committed
552 553
            """Returns the opening string for the representation of `node`."""
            txt = left_bracket + node.tag_name
554 555
            # s += " '(pos %i)" % node.pos
            if src:
eckhart's avatar
eckhart committed
556
                txt += " '(pos %i " % node.pos  # + " %i %i)" % line_col(src, node.pos)
di68kap's avatar
di68kap committed
557 558
            # if node.error_flag:   # just for debugging error collecting
            #     txt += " HAS ERRORS"
559
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
560 561 562
                txt += " '(err '(%s))" % ' '.join(str(err).replace('"', r'\"')
                                                  for err in node.errors)
            return txt + '\n'
563

eckhart's avatar
eckhart committed
564 565 566
        def closing(node) -> str:
            """Returns the closing string for the representation of `node`."""
            return right_bracket
567

eckhart's avatar
eckhart committed
568 569 570 571 572
        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'\"')
573

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

eckhart's avatar
eckhart committed
576

eckhart's avatar
eckhart committed
577 578 579 580 581 582 583 584
    @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


585
    def as_xml(self, src: str = None, showerrors: bool = True) -> str:
586 587 588
        """
        Returns content as XML-tree.

589
        Args:
590 591 592 593 594
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
        """

595
        def opening(node) -> str:
eckhart's avatar
eckhart committed
596
            """Returns the opening string for the representation of `node`."""            
eckhart's avatar
eckhart committed
597
            txt = ['<', node.tag_name]
598
            # s += ' pos="%i"' % node.pos
di68kap's avatar
di68kap committed
599 600
            if hasattr(node, '_xml_attr'):
                txt.extend(' %s="%s"' % (k, v) for k, v in node.xml_attr.items())
601
            if src:
eckhart's avatar
eckhart committed
602
                txt.append(' line="%i" col="%i"' % line_col(line_breaks, node.pos))
603
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
604 605 606
                txt.append(' err="%s"' % ''.join(str(err).replace('"', r'\"')
                                                 for err in node.errors))
            return "".join(txt + [">\n"])
607 608

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

612
        line_breaks = linebreaks(src) if src else []
613
        return self._tree_repr('    ', opening, closing, density=1)
614

Eckhart Arnold's avatar
Eckhart Arnold committed
615

616
    def find(self, match_function: Callable) -> Iterator['Node']:
eckhart's avatar
eckhart committed
617
        """
618
        Finds nodes in the tree that fulfill a given criterion.
eckhart's avatar
eckhart committed
619

di68kap's avatar
di68kap committed
620 621
        `find` is a generator that yields all nodes for which the
        given `match_function` evaluates to True. The tree is
622
        traversed pre-order.
eckhart's avatar
eckhart committed
623

624 625 626 627
        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
        Yields:
628
            Node: All nodes of the tree for which
629 630 631 632 633 634
            ``match_function(node)`` returns True
        """
        if match_function(self):
            yield self
        else:
            for child in self.children:
eckhart's avatar
eckhart committed
635 636
                for node in child.find(match_function):
                    yield node
637

Eckhart Arnold's avatar
Eckhart Arnold committed
638

639 640 641 642 643 644 645 646 647 648 649
    def find_by_tag(self, tag_name: str) -> Iterator['Node']:
        """
        Finds all nodes with the given tag name.

        Args:
            tag_name(str): The tag name that is being searched for.
        Yields:
            Node: All nodes which have a given tag name.
        """


650
    def tree_size(self) -> int:
eckhart's avatar
eckhart committed
651 652 653
        """
        Recursively counts the number of nodes in the tree including the root node.
        """
654 655 656
        return sum(child.tree_size() for child in self.children) + 1


657
def mock_syntax_tree(sxpr):
658
    """
di68kap's avatar
di68kap committed
659 660
    Generates a tree of nodes from an S-expression. The main purpose of this is
    to generate test data.
661 662 663 664 665 666 667

    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
668 669 670
        """Generator that yields all characters until the next closing bracket
        that does not match an opening bracket matched earlier within the same
        package."""
671
        s = s.strip()
672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
        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)
691

692
    sxpr = sxpr.strip()
eckhart's avatar
eckhart committed
693 694
    if sxpr[0] != '(':
        raise ValueError('"(" expected, not ' + sxpr[:10])
695 696
    # assert sxpr[0] == '(', sxpr
    sxpr = sxpr[1:].strip()
eckhart's avatar
eckhart committed
697
    match = re.match(r'[\w:]+', sxpr)
698 699 700
    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
701 702
    name, class_name = (sxpr[:match.end()].split(':') + [''])[:2]
    sxpr = sxpr[match.end():].strip()
703 704
    if sxpr[0] == '(':
        result = tuple(mock_syntax_tree(block) for block in next_block(sxpr))
705 706 707 708
        pos = 0
        for node in result:
            node._pos = pos
            pos += len(node)
709 710
    else:
        lines = []
711
        while sxpr and sxpr[0] != ')':
eckhart's avatar
eckhart committed
712 713 714 715 716 717
            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()
718 719
                    break
            else:
eckhart's avatar
eckhart committed
720 721 722
                match = re.match(r'(?:(?!\)).)*', sxpr, re.DOTALL)
                lines.append(sxpr[:match.end()])
                sxpr = sxpr[match.end():]
723
        result = "\n".join(lines)
724 725 726
    node = Node(MockParser(name, ':' + class_name), result)
    node._pos = 0
    return node
727 728


729
TransformationFunc = Union[Callable[[Node], Any], partial]
730

731 732 733 734 735

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