syntaxtree.py 38.4 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
Module ``syntaxtree`` defines the ``Node``-class for syntax trees as well
as an abstract base class for parser-objects. The latter is defined
eckhart's avatar
eckhart committed
22
here, because node-objects refer to parser-objects. All concrete
23 24 25
parser classes are defined in the ``parse`` module.
"""

26

Eckhart Arnold's avatar
Eckhart Arnold committed
27
import collections.abc
28
from collections import OrderedDict
29

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

35

36 37
__all__ = ('ParserBase',
           'WHITESPACE_PTYPE',
di68kap's avatar
di68kap committed
38
           'PLAINTEXT_PTYPE',
39 40 41 42
           'TOKEN_PTYPE',
           'MockParser',
           'ZombieParser',
           'ZOMBIE_PARSER',
eckhart's avatar
eckhart committed
43
           'ZOMBIE_NODE',
44
           'Node',
di68kap's avatar
di68kap committed
45
           'RootNode',
46
           'parse_sxpr',
47 48 49
           'parse_xml',
           'flatten_sxpr',
           'flatten_xml')
Eckhart Arnold's avatar
Eckhart Arnold committed
50 51


52 53 54 55 56 57 58 59 60 61 62 63 64
#######################################################################
#
# 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.
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
65 66
    __slots__ = '_name', '_ptype'

67
    def __init__(self, name=''):  # , pbases=frozenset()):
68
        self._name = name  # type: str
69 70 71
        self._ptype = ':' + self.__class__.__name__  # type: str

    def __repr__(self):
di68kap's avatar
di68kap committed
72
         return self.name + self.ptype
73 74 75 76

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

77 78 79
    def __call__(self, text: StringView) -> Tuple[Optional['Node'], StringView]:
        return None, text

80 81
    @property
    def name(self):
82 83
        """Returns the name of the parser or the empty string '' for unnamed
        parsers."""
84 85
        return self._name

86 87
    @property
    def ptype(self) -> str:
88 89
        """Returns the type of the parser. By default this is the parser's
        class name preceded by a colon, e.g. ':ZeroOrMore'."""
90 91 92 93
        return self._ptype

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

97
    def reset(self):
98
        """Resets any parser variables. (Should be overridden.)"""
99 100
        pass

eckhart's avatar
eckhart committed
101
    def grammar(self) -> Optional[object]:
102 103
        """Returns the Grammar object to which the parser belongs. If not
        yet connected to any Grammar object, None is returned."""
104 105 106
        return None

    def apply(self, func: Callable) -> bool:
eckhart's avatar
eckhart committed
107
        """Applies the function `func` to the parser. Returns False, if
108
        - for whatever reason - the functions has not been applied, True
eckhart's avatar
eckhart committed
109
        otherwise."""
110 111
        return False

112 113

WHITESPACE_PTYPE = ':Whitespace'
di68kap's avatar
di68kap committed
114
PLAINTEXT_PTYPE = ':PlainText'
115 116 117 118 119 120 121
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
eckhart's avatar
eckhart committed
122
    different parser types by assigning them a `ptype` on initialization.
123 124 125 126 127

    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.
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
128 129
    __slots__ = ()

130 131
    def __init__(self, name='', ptype=''):  # , pbases=frozenset()):
        assert not ptype or ptype[0] == ':'
132
        super().__init__(name)
133 134 135 136 137 138 139 140 141 142 143 144 145 146
        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
Eckhart Arnold's avatar
Eckhart Arnold committed
147
    __slots__ = ()
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175

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


176
ChildrenType = Tuple['Node', ...]
Eckhart Arnold's avatar
Eckhart Arnold committed
177
NoChildren = cast(ChildrenType, ())  # type: ChildrenType
eckhart's avatar
eckhart committed
178
StrictResultType = Union[ChildrenType, StringView, str]
179
ResultType = Union[ChildrenType, 'Node', StringView, str, None]
180 181


Eckhart Arnold's avatar
Eckhart Arnold committed
182
def flatten_sxpr(sxpr: str) -> str:
183
    """Returns S-expression ``sxpr`` as a one-liner without unnecessary
Eckhart Arnold's avatar
Eckhart Arnold committed
184 185 186
    whitespace.

    Example:
Eckhart Arnold's avatar
Eckhart Arnold committed
187
    >>> flatten_sxpr('(a\\n    (b\\n        c\\n    )\\n)\\n')
Eckhart Arnold's avatar
Eckhart Arnold committed
188 189
    '(a (b c))'
    """
190
    return re.sub(r'\s(?=\))', '', re.sub(r'\s+', ' ', sxpr)).strip()
Eckhart Arnold's avatar
Eckhart Arnold committed
191 192


193 194 195 196 197 198 199
def flatten_xml(xml: str) -> str:
    """Returns an XML-tree as a one linter without unnecessary whitespace,
    i.e. only whitespace within leaf-nodes is preserved.
    """
    return re.sub(r'\s+(?=<\w)', '', re.sub(r'(?<=</\w+>)\s+', '', xml))


Eckhart Arnold's avatar
Eckhart Arnold committed
200
class Node(collections.abc.Sized):
201 202 203
    """
    Represents a node in the concrete or abstract syntax tree.

204
    Attributes:
205 206
        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
207

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

212 213
        children (tuple):  The tuple of child nodes or an empty tuple
            if there are no child nodes. READ ONLY!
214

eckhart's avatar
eckhart committed
215 216 217 218
        content (str):  Yields the contents of the tree as string. The
            difference to ``str(node)`` is that ``node.content`` does
            not add the error messages to the returned string.

Eckhart Arnold's avatar
Eckhart Arnold committed
219
        parser (Parser):  The parser which generated this node.
220 221
            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
222 223
            rely on this being a real parser object in any phase after
            parsing (i.e. AST-transformation and compiling), for
224
            example by calling ``isinstance(node.parer, ...)``.
225

226 227 228
        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
229
            the length before AST-transformation and will never change
230
            through AST-transformation. READ ONLY!
231

232 233
        pos (int):  the position of the node within the parsed text.

Eckhart Arnold's avatar
Eckhart Arnold committed
234
            The value of ``pos`` is -1 meaning invalid by default.
235
            Setting this value will set the positions of all child
Eckhart Arnold's avatar
Eckhart Arnold committed
236
            nodes relative to this value.
237 238

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

Eckhart Arnold's avatar
Eckhart Arnold committed
242
            Other than that, this value should be considered READ ONLY.
243 244
            At any rate, it should only be reassigned during the parsing
            stage and never during or after the AST-transformation.
245

246 247
        errors (list):  A list of all errors that occured on this node.

248
        attributes (dict): An optional dictionary of XML-attributes. This
249 250 251
            dictionary is created lazily upon first usage. The attributes
            will only be shown in the XML-Representation, not in the
            S-Expression-output.
252
    """
253

Eckhart Arnold's avatar
Eckhart Arnold committed
254
    __slots__ = '_result', 'children', '_len', '_pos', 'parser', 'errors', '_xml_attr', '_content'
255

256 257 258
    def __init__(self, parser, result: ResultType, leafhint: bool = False) -> None:
        """
        Initializes the ``Node``-object with the ``Parser``-Instance
259 260
        that generated the node and the parser's result.
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
261
        self.errors = []                # type: List[Error]
eckhart's avatar
eckhart committed
262
        self._pos = -1                  # type: int
di68kap's avatar
di68kap committed
263 264
        # 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
265
        if leafhint:
eckhart's avatar
eckhart committed
266
            self._result = result       # type: StrictResultType
eckhart's avatar
eckhart committed
267
            self._content = None        # type: Optional[str]
268
            self.children = NoChildren  # type: ChildrenType
269
            self._len = -1              # type: int  # lazy evaluation
270 271
        else:
            self.result = result
272 273
        self.parser = parser or ZOMBIE_PARSER

Eckhart Arnold's avatar
Eckhart Arnold committed
274

275
    def __str__(self):
Eckhart Arnold's avatar
Eckhart Arnold committed
276 277 278
        # s = self._content if self._content is not None else \
        #     "".join(str(child) for child in self.children) if self.children else self.content
        s = self.content
eckhart's avatar
eckhart committed
279
        if self.errors:
280
            return ' <<< Error on "%s" | %s >>> ' % \
eckhart's avatar
eckhart committed
281
                   (s, '; '.join(e.message for e in self.errors))
282
        return s
283

Eckhart Arnold's avatar
Eckhart Arnold committed
284

285 286 287 288 289 290
    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)
291

Eckhart Arnold's avatar
Eckhart Arnold committed
292

293
    def __len__(self):
294
        if self._len < 0:
di68kap's avatar
di68kap committed
295
            self._len = sum(len(child) for child in self.children) \
296
                if self.children else len(self._result)
297 298 299 300 301 302 303 304
        return self._len


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


305
    def __eq__(self, other):
306 307 308 309
        """
        Equality of nodes: Two nodes are considered as equal, if their tag
        name is the same and if their results are equal.
        """
310
        return self.tag_name == other.tag_name and self.result == other.result
311

Eckhart Arnold's avatar
Eckhart Arnold committed
312

313
    def __hash__(self):
314
        return hash(self.tag_name)
315

Eckhart Arnold's avatar
Eckhart Arnold committed
316

317 318 319
    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
320
        an integer or the first child node with the given tag name. Examples::
321

322
            >>> tree = parse_sxpr('(a (b "X") (X (c "d")) (e (X "F")))')
323 324
            >>> flatten_sxpr(tree[0].as_sxpr())
            '(b "X")'
325 326
            >>> flatten_sxpr(tree["X"].as_sxpr())
            '(X (c "d"))'
327 328 329 330

        Args:
            index_or_tagname(str): Either an index of a child node or a
                tag name.
331
        Returns:
332 333
            Node: All nodes which have a given tag name.
        """
334 335 336
        if self.children:
            if isinstance(index_or_tagname, int):
                return self.children[index_or_tagname]
337
            else:
338 339 340 341 342
                for child in self.children:
                    if child.tag_name == index_or_tagname:
                        return child
                raise KeyError(index_or_tagname)
        raise ValueError('Leave nodes have no children that can be indexed!')
343 344 345 346


    def __contains__(self, tag_name: str) -> bool:
        """
347
        Returns true if a child with the given tag name exists.
348
        Args:
349 350
            tag_name (str): tag_name which will be searched among to immediate
                descendants of this node.
351 352 353 354
        Returns:
            bool:  True, if at least one descendant node with the given tag
                name exists, False otherwise
        """
355 356 357 358 359
        # assert isinstance(tag_name, str)
        if self.children:
            for child in self.children:
                if child.tag_name == tag_name:
                    return True
360
            return False
361
        raise ValueError('Leave node cannot contain other nodes')
362
        # generator = self.select_by_tag(tag_name, False)
363 364 365 366 367
        # try:
        #     generator.__next__()
        #     return True
        # except StopIteration:
        #     return False
368 369


370 371 372 373 374 375 376 377 378 379 380 381 382 383
    def get(self, index_or_tagname: Union[int, str],
            surrogate: Union['Node', Iterator['Node']]) -> Union['Node', Iterator['Node']]:
        """Returns the child node with the given index if ``index_or_tagname``
        is an integer or the first child node with the given tag name. If no
        child with the given index or tag_name exists, the ``surrogate`` is
        returned instead. This mimics the behaviour of Python's dictionary's
        get-method.
        """
        try:
            return self[index_or_tagname]
        except KeyError:
            return surrogate


384
    @property   # this needs to be a (dynamic) property, in case sef.parser gets updated
385
    def tag_name(self) -> str:
386 387 388 389 390 391
        """
        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`.
        """
392
        return self.parser.name or self.parser.ptype
393

Eckhart Arnold's avatar
Eckhart Arnold committed
394

395
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
396
    def result(self) -> StrictResultType:
397 398 399 400 401
        """
        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.
        """
402 403
        return self._result

404

405
    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
406
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
407
        # # made obsolete by static type checking with mypy
408 409 410
        # 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
411 412
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
413 414
        self._len = -1        # lazy evaluation
        self._content = None
415 416 417 418 419 420 421 422 423
        if isinstance(result, Node):
            self.children = (result,)
            self._result = self.children
        else:
            if isinstance(result, tuple):
                self.children = result
                self._result = result or ''
            else:
                self.children = NoChildren
424
                self._result = result
425

426 427

    @property
eckhart's avatar
eckhart committed
428
    def content(self) -> str:
429
        """
430
        Returns content as string, omitting error messages.
431
        """
432 433 434 435
        if self._content is None:
            if self.children:
                self._content = "".join(child.content for child in self.children)
            else:
436
                # self._content = self._result
437 438 439
                self._content = str(self._result)
                self._result = self._content  # self._result might be more efficient as a string!?
        return self._content
440 441 442 443 444 445 446 447 448 449 450


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


451
    @property
452
    def pos(self) -> int:
eckhart's avatar
eckhart committed
453 454
        """Returns the position of the Node's content in the source text."""
        if self._pos < 0:
455
            raise AssertionError("Position value not initialized!")
456 457
        return self._pos

eckhart's avatar
eckhart committed
458

eckhart's avatar
eckhart committed
459
    def init_pos(self, pos: int) -> 'Node':
eckhart's avatar
eckhart committed
460 461 462 463 464 465 466 467 468
        """
        (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
469 470
        assert self._pos < 0 or self.pos == pos, str("pos mismatch %i != %i" % (self._pos, pos))
        self._pos = pos
471
        # recursively adjust pos-values of all children
eckhart's avatar
eckhart committed
472
        offset = self.pos
473
        for child in self.children:
eckhart's avatar
eckhart committed
474
            child.init_pos(offset)
eckhart's avatar
eckhart committed
475 476 477
            offset = child.pos + len(child)
        return self

478

479 480
    @property
    def attributes(self):
481 482 483
        """
        Returns a dictionary of XML-Attributes attached to the Node.
        """
484 485 486 487
        if not hasattr(self, '_xml_attr'):
            self._xml_attr = OrderedDict()
        return self._xml_attr

Eckhart Arnold's avatar
Eckhart Arnold committed
488

489
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=lambda i: i,
490
                   density=0, inline=False, inline_fn=lambda node: False) -> 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
        inline = inline or inline_fn(self)
521 522 523 524 525
        if inline:
            head = head.rstrip()
            tail = tail.lstrip()
            usetab, sep = '', ''
        else:
eckhart's avatar
eckhart committed
526 527
            usetab = tab if head else ''    # no indentation if tag is already omitted
            sep = '\n'
528

529 530
        if self.children:
            content = []
531
            for child in self.children:
532
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn,
533
                                           density, inline, inline_fn)
eckhart's avatar
eckhart committed
534 535 536
                if subtree:
                    subtree = [subtree] if inline else subtree.split('\n')
                    content.append((sep + usetab).join(s for s in subtree))
537
            return head + usetab + (sep + usetab).join(content) + tail
538

539
        res = cast(str, self.result)  # safe, because if there are no children, result is a string
eckhart's avatar
eckhart committed
540
        if not inline and not head:
eckhart's avatar
eckhart committed
541
            # strip whitespace for omitted non inline node, e.g. CharData in mixed elements
eckhart's avatar
eckhart committed
542
            res = res.strip()
543 544
        if density & 1 and res.find('\n') < 0:  # and head[0] == "<":
            # except for XML, add a gap between opening statement and content
545
            gap = ' ' if not inline and head and head.rstrip()[-1:] != '>' else ''
eckhart's avatar
eckhart committed
546
            return head.rstrip() + gap + data_fn(res) + tail.lstrip()
547
        else:
548
            return head + '\n'.join([usetab + data_fn(s) for s in res.split('\n')]) + tail
549

Eckhart Arnold's avatar
Eckhart Arnold committed
550

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

558
        Args:
559 560 561
            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.
562 563 564
            showerrors: If True, error messages will be shown.
            indentation: The number of whitespaces for indentation
            compact:  If True, a compact representation is returned where
565
                brackets are omitted and only the indentation indicates the
Eckhart Arnold's avatar
Eckhart Arnold committed
566
                tree structure.
567 568
        """

eckhart's avatar
eckhart committed
569
        left_bracket, right_bracket, density = ('', '', 1) if compact else ('(', '\n)', 0)
eckhart's avatar
eckhart committed
570
        lbreaks = linebreaks(src) if src else []  # type: List[int]
571

572
        def opening(node) -> str:
eckhart's avatar
eckhart committed
573
            """Returns the opening string for the representation of `node`."""
574
            txt = [left_bracket,  node.tag_name]
575
            # s += " '(pos %i)" % node.add_pos
576
            if hasattr(node, '_xml_attr'):
577
                txt.extend(' `(%s "%s")' % (k, v) for k, v in node.attributes.items())
578
            if src:
eckhart's avatar
eckhart committed
579
                txt.append(" `(pos %i %i %i)" % (node.pos, *line_col(lbreaks, node.pos)))
580
            if showerrors and node.errors:
581
                txt.append(" `(err `%s)" % ' '.join(str(err) for err in node.errors))
582
            return "".join(txt) + '\n'
583

eckhart's avatar
eckhart committed
584 585 586
        def closing(node) -> str:
            """Returns the closing string for the representation of `node`."""
            return right_bracket
587

eckhart's avatar
eckhart committed
588 589 590 591 592
        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'\"')
593

594
        return self._tree_repr(' ' * indentation, opening, closing, pretty, density=density)
Eckhart Arnold's avatar
Eckhart Arnold committed
595

eckhart's avatar
eckhart committed
596

597 598 599 600 601 602
    def as_xml(self, src: str = None,
               showerrors: bool = True,
               indentation: int = 2,
               inline_tags: Set[str]=set(),
               omit_tags: Set[str]=set(),
               empty_tags: Set[str]=set()) -> str:
603 604 605
        """
        Returns content as XML-tree.

606
        Args:
607 608 609
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
610 611
            showerrors: If True, error messages will be shown.
            indentation: The number of whitespaces for indentation
612 613 614 615 616 617 618
            inline_tags:  A set of tag names, the content of which will always be written
                on a single line, unless it contains explicit line feeds ('\n').
            omit_tags:  A set of tags from which only the content will be printed, but
                neither the opening tag nor its attributes nor the closing tag. This
                allows producing a mix of plain text and child tags in the output,
                which otherwise is not supported by the Node object, because it
                requires its content to be either a tuple of children or string content.
619 620
            empty_tags:  A set of tags which shall be rendered as empty elements, e.g.
                "<empty/>" instead of "<empty><empty>".
621 622
        """

623
        def opening(node) -> str:
624 625 626
            """Returns the opening string for the representation of `node`."""
            if node.tag_name in omit_tags:
                return ''
eckhart's avatar
eckhart committed
627
            txt = ['<', node.tag_name]
628 629
            has_reserved_attrs = hasattr(node, '_xml_attr') \
                and any (r in node.attributes for r in {'err', 'line', 'col'})
di68kap's avatar
di68kap committed
630
            if hasattr(node, '_xml_attr'):
631
                txt.extend(' %s="%s"' % (k, v) for k, v in node.attributes.items())
632
            if src and not has_reserved_attrs:
eckhart's avatar
eckhart committed
633
                txt.append(' line="%i" col="%i"' % line_col(line_breaks, node.pos))
634
            if showerrors and node.errors and not has_reserved_attrs:
eckhart's avatar
eckhart committed
635 636
                txt.append(' err="%s"' % ''.join(str(err).replace('"', r'\"')
                                                 for err in node.errors))
637 638 639
            if node.tag_name in empty_tags:
                assert not node.result, ("Node %s with content %s is not an empty element!" %
                                         (node.tag_name, str(node)))
eckhart's avatar
eckhart committed
640
                ending = "/>\n" if not node.tag_name[0] == '?' else "?>\n"
641 642 643
            else:
                ending = ">\n"
            return "".join(txt + [ending])
644 645

        def closing(node):
646
            """Returns the closing string for the representation of `node`."""
647
            if node.tag_name in omit_tags or node.tag_name in empty_tags:
648
                return ''
649
            return ('\n</') + node.tag_name + '>'
650

651 652 653 654 655
        def inlining(node):
            """Returns True, if `node`'s tag name is contained in `inline_tags`,
            thereby signalling that the children of this node shall not be
            printed on several lines to avoid unwanted gaps in the output.
            """
656 657
            return node.tag_name in inline_tags or (hasattr(node, '_xml_attr') \
                and node.attributes.get('xml:space', 'default') == 'preserve')
658

659
        line_breaks = linebreaks(src) if src else []
660 661
        return self._tree_repr(' ' * indentation, opening, closing,
                               density=1, inline_fn=inlining)
662

Eckhart Arnold's avatar
Eckhart Arnold committed
663

664
    def select(self, match_function: Callable, include_root: bool=False) -> Iterator['Node']:
eckhart's avatar
eckhart committed
665
        """
666
        Finds nodes in the tree that fulfill a given criterion.
eckhart's avatar
eckhart committed
667

668
        `select` is a generator that yields all nodes for which the
di68kap's avatar
di68kap committed
669
        given `match_function` evaluates to True. The tree is
670 671 672
        traversed pre-order.

        See function `Node.select_by_tag` for some examples.
eckhart's avatar
eckhart committed
673

674 675 676
        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
677 678
            include_root (bool): If False, only descendant nodes will be
                checked for a match.
679
        Yields:
680
            Node: All nodes of the tree for which
681 682
            ``match_function(node)`` returns True
        """
683
        if include_root and match_function(self):
684
            yield self
eckhart's avatar
eckhart committed
685 686 687
        for child in self.children:
            for node in child.select(match_function, True):
                yield node
688

Eckhart Arnold's avatar
Eckhart Arnold committed
689

eckhart's avatar
eckhart committed
690
    def select_by_tag(self, tag_names: Union[str, AbstractSet[str]],
691
                      include_root: bool=False) -> Iterator['Node']:
692
        """
693 694 695 696
        Returns an iterator that runs through all descendants that have one
        of the given tag names.

        Examples::
697

698
            >>> tree = parse_sxpr('(a (b "X") (X (c "d")) (e (X "F")))')
699
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag("X", False))
700
            ['(X (c "d"))', '(X "F")']
701
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag({"X", "b"}, False))
702
            ['(b "X")', '(X (c "d"))', '(X "F")']
703
            >>> any(tree.select_by_tag('a', False))
704
            False
705
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag('a', True))
706
            ['(a (b "X") (X (c "d")) (e (X "F")))']
707 708
            >>> flatten_sxpr(next(tree.select_by_tag("X", False)).as_sxpr())
            '(X (c "d"))'
709 710

        Args:
711 712 713 714
            tag_name(set): A tag name or set of tag names that is being
                searched for
            include_root (bool): If False, only descendant nodes will be
                checked for a match.
715 716 717
        Yields:
            Node: All nodes which have a given tag name.
        """
718
        if isinstance(tag_names, str):
eckhart's avatar
eckhart committed
719
            tag_names = frozenset({tag_names})
720
        return self.select(lambda node: node.tag_name in tag_names, include_root)
721 722


723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
    def pick(self, tag_names: Union[str, Set[str]]) -> Optional['Node']:
        """
        Picks the first descendant with one of the given tag_names.

        This function is just syntactic sugar for
        ``next(node.select_by_tag(tag_names, False))``. However, rather than
        raising a StopIterationError if no descendant with the given tag-name
        exists, it returns None.
        """
        try:
            return next(self.select_by_tag(tag_names, False))
        except StopIteration:
            return None


738
    def tree_size(self) -> int:
eckhart's avatar
eckhart committed
739 740 741
        """
        Recursively counts the number of nodes in the tree including the root node.
        """
742 743 744
        return sum(child.tree_size() for child in self.children) + 1


di68kap's avatar
di68kap committed
745
class RootNode(Node):
746
    """TODO: Add Documentation!!!
di68kap's avatar
di68kap committed
747

Eckhart Arnold's avatar
Eckhart Arnold committed
748
        all_errors (list):  A list of all errors that have occured so far during
749 750
                processing (i.e. parsing, AST-transformation, compiling)
                of this tree.
di68kap's avatar
di68kap committed
751

752 753
        error_flag (int):  the highest warning or error level of all errors
                that occurred.
di68kap's avatar
di68kap committed
754
    """
eckhart's avatar
eckhart committed
755
    def __init__(self, node: Optional[Node] = None) -> 'RootNode':
di68kap's avatar
di68kap committed
756
        super().__init__(ZOMBIE_PARSER, '')
757
        self.all_errors = []
di68kap's avatar
di68kap committed
758
        self.error_flag = 0
eckhart's avatar
eckhart committed
759 760
        if node is not None:
            self.swallow(node)
761 762 763 764
        # customization for XML-Representation
        self.inline_tags = set()
        self.omit_tags = set()
        self.empty_tags = set()
di68kap's avatar
di68kap committed
765

766
    def swallow(self, node: Node) -> 'RootNode':
767 768 769 770 771 772 773 774 775 776
        """Put `self` in the place of `node` by copying all its data.
        Returns self.

        This is done by the parse.Grammar object after
        parsing has finished, so that the Grammar object always
        returns a syntax tree rooted in a RootNode object.

        It is possible to add errors to a RootNode object, before it
        has actually swallowed the root of the syntax tree.
        """
di68kap's avatar
di68kap committed
777 778 779 780 781
        self._result = node._result
        self.children = node.children
        self._len = node._len
        self._pos = node._pos
        self.parser = node.parser
782 783
        if hasattr(node, '_xml_attr'):
            self._xml_attr = node._xml_attr
di68kap's avatar
di68kap committed
784
        self._content = node._content
785
        return self
di68kap's avatar
di68kap committed
786

eckhart's avatar
eckhart committed
787 788
    def add_error(self, node: Node, error: Error) -> 'RootNode':
        """Adds an Error object to the tree, locating it at a specific node."""
di68kap's avatar
di68kap committed
789 790 791 792 793
        self.all_errors.append(error)
        self.error_flag = max(self.error_flag, error.code)
        node.errors.append(error)
        return self

eckhart's avatar
eckhart committed
794
    def new_error(self,
795
                  node: Node,
di68kap's avatar
di68kap committed
796
                  message: str,
di68kap's avatar
di68kap committed
797
                  code: int = Error.ERROR) -> 'RootNode':
di68kap's avatar
di68kap committed
798
        """
eckhart's avatar
eckhart committed
799
        Adds an error to this tree, locating it at a specific node.
di68kap's avatar
di68kap committed
800 801 802 803 804
        Parameters:
            pos(int):     The position of the error in the source text
            message(str): A string with the error message.abs
            code(int):    An error code to identify the kind of error
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
805
        error = Error(message, node.pos, code)
eckhart's avatar
eckhart committed
806 807
        self.add_error(node, error)
        return self
di68kap's avatar
di68kap committed
808

eckhart's avatar
eckhart committed
809
    def collect_errors(self) -> List[Error]:
di68kap's avatar
di68kap committed
810 811
        """Returns the list of errors, ordered bv their position.
        """
812
        self.all_errors.sort(key=lambda e: e.pos)
Eckhart Arnold's avatar
Eckhart Arnold committed
813
        return self.all_errors
di68kap's avatar
di68kap committed
814

815 816 817 818 819 820 821 822
    def customized_XML(self):
        """Returns a customized XML representation of the tree.
        See the docstring of `Node.as_xml()` for an explanation of the
        customizations."""
        return self.as_xml(inline_tags = self.inline_tags,
                           omit_tags=self.omit_tags,
                           empty_tags=self.empty_tags)

di68kap's avatar
di68kap committed
823

eckhart's avatar
eckhart committed
824 825 826
ZOMBIE_NODE = Node(ZOMBIE_PARSER, '')


827
def parse_sxpr(sxpr: str) -> Node:
828
    """
829 830 831 832 833
    Generates a tree of nodes from an S-expression.

    This can - among other things - be used for deserialization of trees that
    have been serialized with `Node.as_sxpr()` or as a convenient way to
    generate test data.
834 835

    Example:
836
    >>> parse_sxpr("(a (b c))").as_sxpr()
837 838
    '(a\\n    (b\\n        "c"\\n    )\\n)'
    """
839 840
    sxpr = StringView(sxpr).strip()
    mock_parsers = dict()
841

842
    def next_block(s: StringView):
eckhart's avatar
eckhart committed
843 844 845
        """Generator that yields all characters until the next closing bracket
        that does not match an opening bracket matched earlier within the same
        package."""
846
        s = s.strip()
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865
        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)
866

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
    def inner_parser(sxpr: StringView) -> Node:
        if sxpr[0] != '(':
            raise ValueError('"(" expected, not ' + sxpr[:10])
        # assert sxpr[0] == '(', sxpr
        sxpr = sxpr[1:].strip()
        match = sxpr.match(re.compile(r'[\w:]+'))
        if match is None:
            raise AssertionError('Malformed S-expression Node-tagname or identifier expected, '
                                 'not "%s"' % sxpr[:40].replace('\n', ''))
        end = match.end() - sxpr.begin
        tagname = sxpr[:end]
        name, class_name = (tagname.split(':') + [''])[:2]
        sxpr = sxpr[end:].strip()
        attributes = OrderedDict()
        if sxpr[0] == '(':
            result = tuple(inner_parser(block) for block in next_block(sxpr))
        else:
            lines = []
            while sxpr and sxpr[0:1] != ')':
                # parse attributes
                while sxpr[:2] == "`(":
                    i = sxpr.find('"')
                    k = sxpr.find(')')
                    # read very special attribute pos
                    if sxpr[2:5] == "pos" and 0 < i < k:
                        pos = int(sxpr[5:k].strip().split(' ')[0])
                    # ignore very special attribute err
                    elif sxpr[2:5] == "err" and 0 <= sxpr.find('`', 5) < k:
                        m = sxpr.find('(', <