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

syntaxtree.py 26.8 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 DHParser.error import Error, linebreaks, line_col
31
from DHParser.stringview import StringView
32 33
from DHParser.toolkit import re
from typing import Callable, cast, Iterator, List, Union, Tuple, Optional
di68kap's avatar
di68kap committed
34

35

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


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

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

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

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

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

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

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

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

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

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

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121

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] == ':'
122
        super().__init__(name)
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 163 164
        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
#
#######################################################################


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


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

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


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

186
    Attributes:
187 188
        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
189

190 191 192
        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.
193

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

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

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

207 208 209
        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.
210

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

217 218
        pos (int):  the position of the node within the parsed text.

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

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

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

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

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

Eckhart Arnold's avatar
Eckhart Arnold committed
253

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

Eckhart Arnold's avatar
Eckhart Arnold committed
261

262 263 264 265 266 267
    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)
268

Eckhart Arnold's avatar
Eckhart Arnold committed
269

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


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


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

Eckhart Arnold's avatar
Eckhart Arnold committed
289

290
    def __hash__(self):
291
        return hash(self.tag_name)
292

Eckhart Arnold's avatar
Eckhart Arnold committed
293

294 295 296 297 298 299
    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
300

301 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
    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
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
            return self.find(match_function, False)


    def __contains__(self, tag_name: str) -> bool:
        """
        Returns true if a descendant with the given tag name exists.
        Args:
            tag_name: tag_name which will be searched among the descendant
                nodes
        Returns:
            bool:  True, if at least one descendant node with the given tag
                name exists, False otherwise
        """
        generator = self[tag_name]
        try:
            generator.__next__()
            return True
        except StopIteration:
            return False
346 347


348
    @property   # this needs to be a (dynamic) property, in case sef.parser gets updated
349
    def tag_name(self) -> str:
350 351 352 353 354 355
        """
        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`.
        """
356
        return self.parser.name or self.parser.ptype
357

Eckhart Arnold's avatar
Eckhart Arnold committed
358

359
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
360
    def result(self) -> StrictResultType:
361 362 363 364 365
        """
        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.
        """
366 367
        return self._result

368

369
    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
370
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
371
        # # made obsolete by static type checking with mypy
372 373 374
        # 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
375 376
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
377
        self._len = -1  # lazy evaluation
378 379 380 381
        if isinstance(result, Node):
            self.children = (result,)
            self._result = self.children
            self.error_flag = result.error_flag
382 383
            # if self._pos < 0:
            #     self._pos = result._pos
384 385 386 387
        else:
            if isinstance(result, tuple):
                self.children = result
                self._result = result or ''
388 389 390
                if result:
                    if self.error_flag == 0:
                        self.error_flag = max(child.error_flag for child in self.children)
391 392
                    # if self._pos < 0:
                    #     self._pos = result[0]._pos
393 394
            else:
                self.children = NoChildren
395
                self._result = str(result)
396 397 398 399 400 401 402 403
        # # 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

404 405 406 407 408 409 410 411 412

    @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
413
        return cast(str, self._result)
414 415 416 417 418 419 420 421 422 423 424


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


425
    @property
426
    def pos(self) -> int:
eckhart's avatar
eckhart committed
427 428
        """Returns the position of the Node's content in the source text."""
        if self._pos < 0:
429
            raise AssertionError("Position value not initialized!")
430 431
        return self._pos

eckhart's avatar
eckhart committed
432

eckhart's avatar
eckhart committed
433
    def init_pos(self, pos: int, overwrite: bool = False) -> 'Node':
eckhart's avatar
eckhart committed
434 435 436 437 438 439 440 441 442
        """
        (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
443 444 445 446 447 448
        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))
449
        # recursively adjust pos-values of all children
eckhart's avatar
eckhart committed
450
        offset = self.pos
451
        for child in self.children:
eckhart's avatar
eckhart committed
452
            child.init_pos(offset, overwrite)
eckhart's avatar
eckhart committed
453 454 455
            offset = child.pos + len(child)
        return self

456 457

    @property
458
    def errors(self) -> List[Error]:
eckhart's avatar
eckhart committed
459
        """
460
        Returns the errors that occurred at this Node,
eckhart's avatar
eckhart committed
461 462
        not including any errors from child nodes.
        """
463 464
        return self._errors.copy()

465

eckhart's avatar
eckhart committed
466 467
    def add_error(self,
                  message: str,
468
                  code: int = Error.ERROR) -> 'Node':
eckhart's avatar
eckhart committed
469 470 471
        """
        Adds an error to this Node.
        Parameters:
eckhart's avatar
eckhart committed
472 473
            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
474
        """
475 476
        self._errors.append(Error(message, code))
        self.error_flag = max(self.error_flag, self._errors[-1].code)
Eckhart Arnold's avatar
Eckhart Arnold committed
477 478
        return self

479

480
    def collect_errors(self, clear_errors=False) -> List[Error]:
Eckhart Arnold's avatar
Eckhart Arnold committed
481
        """
482
        Recursively adds line- and column-numbers to all error objects.
Eckhart Arnold's avatar
Eckhart Arnold committed
483 484 485 486
        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.
        """
487
        errors = self.errors
488 489
        for err in errors:
            err.pos = self.pos
490 491
        if self.children:
            for child in self.children:
492
                errors.extend(child.collect_errors(clear_errors))
493 494 495
        if clear_errors:
            self._errors = []
            self.error_flag = 0
496
        else:
497 498 499 500 501 502 503
            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

504

Eckhart Arnold's avatar
Eckhart Arnold committed
505

506
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=lambda i: i, density=0) -> str:
507 508 509 510 511 512 513 514
        """
        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.

515
        Args:
516
            tab (str):  The indentation string, e.g. '\t' or '    '
eckhart's avatar
eckhart committed
517
            open_fn:   (Node->str) A function that returns an opening
518
                string (e.g. an XML-tag_name) for a given node
eckhart's avatar
eckhart committed
519
            close_fn:  (Node->str) A function that returns a closeF
520
                string (e.g. an XML-tag_name) for a given node.
eckhart's avatar
eckhart committed
521
            data_fn:   (str->str) A function that filters the data string
522 523 524 525 526 527
                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
528 529
        head = open_fn(self)
        tail = close_fn(self)
530 531

        if not self.result:
532
            return head.rstrip() + tail.lstrip()
533

eckhart's avatar
eckhart committed
534
        tail = tail.lstrip(None if density & 2 else '')
535 536 537

        if self.children:
            content = []
538
            for child in self.children:
eckhart's avatar
eckhart committed
539
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn, density).split('\n')
540
                content.append('\n'.join((tab + s) for s in subtree))
eckhart's avatar
eckhart committed
541
            return head + '\n'.join(content) + tail
542

543
        res = cast(str, self.result)  # safe, because if there are no children, result is a string
544 545 546
        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
547
            return head.rstrip() + gap + data_fn(self.result) + tail.lstrip()
548
        else:
eckhart's avatar
eckhart committed
549
            return head + '\n'.join([tab + data_fn(s) for s in res.split('\n')]) + tail
550

Eckhart Arnold's avatar
Eckhart Arnold committed
551

552
    def as_sxpr(self, src: str = None, compact: bool = False, showerrors: bool = True) -> str:
553 554 555
        """
        Returns content as S-expression, i.e. in lisp-like form.

556
        Args:
557 558 559
            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
560
            compact:  If True a compact representation is returned where
561
                brackets are omitted and only the indentation indicates the
Eckhart Arnold's avatar
Eckhart Arnold committed
562
                tree structure.
563 564
        """

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

567
        def opening(node) -> str:
eckhart's avatar
eckhart committed
568 569
            """Returns the opening string for the representation of `node`."""
            txt = left_bracket + node.tag_name
570 571
            # s += " '(pos %i)" % node.pos
            if src:
eckhart's avatar
eckhart committed
572
                txt += " '(pos %i " % node.pos  # + " %i %i)" % line_col(src, node.pos)
di68kap's avatar
di68kap committed
573 574
            # if node.error_flag:   # just for debugging error collecting
            #     txt += " HAS ERRORS"
575
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
576 577 578
                txt += " '(err '(%s))" % ' '.join(str(err).replace('"', r'\"')
                                                  for err in node.errors)
            return txt + '\n'
579

eckhart's avatar
eckhart committed
580 581 582
        def closing(node) -> str:
            """Returns the closing string for the representation of `node`."""
            return right_bracket
583

eckhart's avatar
eckhart committed
584 585 586 587 588
        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'\"')
589

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

eckhart's avatar
eckhart committed
592

eckhart's avatar
eckhart committed
593 594 595 596 597 598 599 600
    @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


601
    def as_xml(self, src: str = None, showerrors: bool = True) -> str:
602 603 604
        """
        Returns content as XML-tree.

605
        Args:
606 607 608 609 610
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
        """

611
        def opening(node) -> str:
eckhart's avatar
eckhart committed
612
            """Returns the opening string for the representation of `node`."""            
eckhart's avatar
eckhart committed
613
            txt = ['<', node.tag_name]
614
            # s += ' pos="%i"' % node.pos
di68kap's avatar
di68kap committed
615 616
            if hasattr(node, '_xml_attr'):
                txt.extend(' %s="%s"' % (k, v) for k, v in node.xml_attr.items())
617
            if src:
eckhart's avatar
eckhart committed
618
                txt.append(' line="%i" col="%i"' % line_col(line_breaks, node.pos))
619
            if showerrors and node.errors:
eckhart's avatar
eckhart committed
620 621 622
                txt.append(' err="%s"' % ''.join(str(err).replace('"', r'\"')
                                                 for err in node.errors))
            return "".join(txt + [">\n"])
623 624

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

628
        line_breaks = linebreaks(src) if src else []
629
        return self._tree_repr('    ', opening, closing, density=1)
630

Eckhart Arnold's avatar
Eckhart Arnold committed
631

632
    def find(self, match_function: Callable, include_root: bool=True) -> Iterator['Node']:
eckhart's avatar
eckhart committed
633
        """
634
        Finds nodes in the tree that fulfill a given criterion.
eckhart's avatar
eckhart committed
635

di68kap's avatar
di68kap committed
636 637
        `find` is a generator that yields all nodes for which the
        given `match_function` evaluates to True. The tree is
638
        traversed pre-order.
eckhart's avatar
eckhart committed
639

640 641 642
        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
643 644
            include_root (bool): If False, only descendant nodes will be
                checked for a match.
645
        Yields:
646
            Node: All nodes of the tree for which
647 648
            ``match_function(node)`` returns True
        """
649
        if include_root and match_function(self):
650 651 652
            yield self
        else:
            for child in self.children:
653
                for node in child.find(match_function, True):
eckhart's avatar
eckhart committed
654
                    yield node
655

Eckhart Arnold's avatar
Eckhart Arnold committed
656

657 658 659 660 661 662 663 664 665 666 667
    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.
        """


668
    def tree_size(self) -> int:
eckhart's avatar
eckhart committed
669 670 671
        """
        Recursively counts the number of nodes in the tree including the root node.
        """
672 673 674
        return sum(child.tree_size() for child in self.children) + 1


675
def mock_syntax_tree(sxpr):
676
    """
di68kap's avatar
di68kap committed
677 678
    Generates a tree of nodes from an S-expression. The main purpose of this is
    to generate test data.
679 680 681 682 683 684 685

    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
686 687 688
        """Generator that yields all characters until the next closing bracket
        that does not match an opening bracket matched earlier within the same
        package."""
689
        s = s.strip()
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
        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)
709

710
    sxpr = sxpr.strip()
eckhart's avatar
eckhart committed
711 712
    if sxpr[0] != '(':
        raise ValueError('"(" expected, not ' + sxpr[:10])
713 714
    # assert sxpr[0] == '(', sxpr
    sxpr = sxpr[1:].strip()
eckhart's avatar
eckhart committed
715
    match = re.match(r'[\w:]+', sxpr)
716 717 718
    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
719 720
    name, class_name = (sxpr[:match.end()].split(':') + [''])[:2]
    sxpr = sxpr[match.end():].strip()
721 722
    if sxpr[0] == '(':
        result = tuple(mock_syntax_tree(block) for block in next_block(sxpr))
723 724 725 726
        pos = 0
        for node in result:
            node._pos = pos
            pos += len(node)
727 728
    else:
        lines = []
729
        while sxpr and sxpr[0] != ')':
eckhart's avatar
eckhart committed
730 731 732 733 734 735
            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()
736 737
                    break
            else:
eckhart's avatar
eckhart committed
738 739 740
                match = re.match(r'(?:(?!\)).)*', sxpr, re.DOTALL)
                lines.append(sxpr[:match.end()])
                sxpr = sxpr[match.end():]
741
        result = "\n".join(lines)
742 743 744
    node = Node(MockParser(name, ':' + class_name), result)
    node._pos = 0
    return node
745

746 747 748 749
# 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())