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

syntaxtree.py 42 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
eckhart's avatar
eckhart committed
29
import copy
30

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

36

37 38 39 40 41
__all__ = ('ParserBase',
           'WHITESPACE_PTYPE',
           'TOKEN_PTYPE',
           'MockParser',
           'ZombieParser',
42
           'ZOMBIE',
43
           'ZOMBIE_PARSER',
eckhart's avatar
eckhart committed
44
           'ZOMBIE_NODE',
eckhart's avatar
eckhart committed
45 46 47
           'ResultType',
           'StrictResultType',
           'ChildrenType',
48
           'Node',
di68kap's avatar
di68kap committed
49
           'RootNode',
eckhart's avatar
eckhart committed
50
           'ZOMBIE_ROOTNODE',
51
           'parse_sxpr',
52 53 54
           'parse_xml',
           'flatten_sxpr',
           'flatten_xml')
Eckhart Arnold's avatar
Eckhart Arnold committed
55 56


57 58 59 60 61 62 63 64 65 66 67 68 69
#######################################################################
#
# 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.
    """
70

71
    __slots__ = 'name', 'ptype', 'tag_name'
Eckhart Arnold's avatar
Eckhart Arnold committed
72

73 74 75
    def __init__(self,):  # , pbases=frozenset()):
        self.name = ''  # type: str
        self.ptype = ':' + self.__class__.__name__  # type: str
76
        self.tag_name = self.ptype  # type: str
77 78

    def __repr__(self):
eckhart's avatar
eckhart committed
79
        return self.name + self.ptype
80 81 82 83

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

84 85 86
    def __call__(self, text: StringView) -> Tuple[Optional['Node'], StringView]:
        return None, text

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

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

Eckhart Arnold's avatar
Eckhart Arnold committed
96
    @property
eckhart's avatar
eckhart committed
97
    def grammar(self) -> 'Grammar':
98 99
        """Returns the Grammar object to which the parser belongs. If not
        yet connected to any Grammar object, None is returned."""
eckhart's avatar
eckhart committed
100
        raise NotImplementedError
101

eckhart's avatar
eckhart committed
102 103 104 105
    def apply(self, func: Callable):
        """Applies the function `func` recursively to the parser and all
        descendant parsers, if any exist."""
        pass
106

107 108

WHITESPACE_PTYPE = ':Whitespace'
109
TOKEN_PTYPE = ':Token'
110 111 112 113 114 115


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
116
    different parser types by assigning them a `ptype` on initialization.
117 118 119 120 121

    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.
    """
122

Eckhart Arnold's avatar
Eckhart Arnold committed
123 124
    __slots__ = ()

125 126
    def __init__(self, name='', ptype=''):  # , pbases=frozenset()):
        assert not ptype or ptype[0] == ':'
127 128
        super().__init__()
        self.name = name
di68kap's avatar
di68kap committed
129 130
        if ptype:
            self.ptype = ptype  # or ':' + self.__class__.__name__
131 132


133 134 135
ZOMBIE = "__ZOMBIE__"


136 137 138 139 140 141 142 143 144 145
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.
    """
146

147
    alive = False
Eckhart Arnold's avatar
Eckhart Arnold committed
148
    __slots__ = ()
149 150

    def __init__(self):
151
        super(ZombieParser, self).__init__()
152 153
        assert not self.__class__.alive, "There can be only one!"
        assert self.__class__ == ZombieParser, "No derivatives, please!"
154
        self.name = ZOMBIE
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
        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
#
#######################################################################


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


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

    Example:
Eckhart Arnold's avatar
Eckhart Arnold committed
190
    >>> flatten_sxpr('(a\\n    (b\\n        c\\n    )\\n)\\n')
Eckhart Arnold's avatar
Eckhart Arnold committed
191 192
    '(a (b c))'
    """
193

194
    return re.sub(r'\s(?=\))', '', re.sub(r'\s+', ' ', sxpr)).strip()
Eckhart Arnold's avatar
Eckhart Arnold committed
195 196


197
def flatten_xml(xml: str) -> str:
198 199
    """
    Returns an XML-tree as a one liner without unnecessary whitespace,
200
    i.e. only whitespace within leaf-nodes is preserved.
201 202
    A more precise alternative to `flatten_xml` is to use Node.as_xml()
    ans passing a set containing the top level tag to parameter `inline_tags`.
203
    """
204

205 206 207 208
    # works only with regex
    # return re.sub(r'\s+(?=<\w)', '', re.sub(r'(?<=</\w+>)\s+', '', xml))
    def tag_only(m):
        return m.groupdict()['closing_tag']
209
    return re.sub(r'\s+(?=<[\w:])', '', re.sub(r'(?P<closing_tag></:?\w+>)\s+', tag_only, xml))
210 211


eckhart's avatar
eckhart committed
212
RX_AMP = re.compile(r'&(?!\w+;)')
213 214


Eckhart Arnold's avatar
Eckhart Arnold committed
215
class Node:  # (collections.abc.Sized): Base class omitted for cython-compatibility
216 217 218
    """
    Represents a node in the concrete or abstract syntax tree.

219 220
    TODO: Add some documentation and doc-tests here...

221
    Attributes:
222 223
        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
224

225 226 227
        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.
228

229 230
        children (tuple):  The tuple of child nodes or an empty tuple
            if there are no child nodes. READ ONLY!
231

eckhart's avatar
eckhart committed
232 233 234 235
        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
236
        parser (Parser):  The parser which generated this node.
237 238
            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
239 240
            rely on this being a real parser object in any phase after
            parsing (i.e. AST-transformation and compiling), for
241
            example by calling ``isinstance(node.parer, ...)``.
242

243 244 245
        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
246
            the length before AST-transformation and will never change
247
            through AST-transformation. READ ONLY!
248

249 250
        pos (int):  the position of the node within the parsed text.

Eckhart Arnold's avatar
Eckhart Arnold committed
251
            The value of ``pos`` is -1 meaning invalid by default.
252
            Setting this value will set the positions of all child
Eckhart Arnold's avatar
Eckhart Arnold committed
253
            nodes relative to this value.
254 255

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

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

263 264
        errors (list):  A list of all errors that occured on this node.

265 266
        attr (dict): An optional dictionary of XML-attr. This
            dictionary is created lazily upon first usage. The attr
267 268
            will only be shown in the XML-Representation, not in the
            S-Expression-output.
269
    """
270

271
    __slots__ = '_result', 'children', '_len', '_pos', '_tag_name', 'errors', '_xml_attr', '_content'
272

273
    def __init__(self, name: Optional[str], result: ResultType, leafhint: bool = False) -> None:
274 275
        """
        Initializes the ``Node``-object with the ``Parser``-Instance
276 277
        that generated the node and the parser's result.
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
278
        self.errors = []                # type: List[Error]
eckhart's avatar
eckhart committed
279
        self._pos = -1                  # type: int
280
        # Assignment to self.result initializes the attr _result, children and _len
di68kap's avatar
di68kap committed
281
        # The following if-clause is merely an optimization, i.e. a fast-path for leaf-Nodes
282
        if leafhint:
eckhart's avatar
eckhart committed
283
            self._result = result       # type: StrictResultType  # cast(StrictResultType, result)
eckhart's avatar
eckhart committed
284
            self._content = None        # type: Optional[str]
285
            self.children = NoChildren  # type: ChildrenType
286
            self._len = -1              # type: int  # lazy evaluation
287 288
        else:
            self.result = result
289 290 291 292 293 294
        assert name is None or isinstance(name, str)   # TODO: Delete this line
        self._tag_name = name if name else ZOMBIE
        # if parser is None:
        #     self._tag_name = ZOMBIE
        # else:
        #     self._tag_name = parser.name or parser.ptype
295

eckhart's avatar
eckhart committed
296 297
    def __deepcopy__(self, memo):
        if self.children:
298
            duplicate = self.__class__(self._tag_name, copy.deepcopy(self.children), False)
eckhart's avatar
eckhart committed
299
        else:
300
            duplicate = self.__class__(self._tag_name, self.result, True)
eckhart's avatar
eckhart committed
301 302 303 304 305 306
        duplicate.errors = copy.deepcopy(self.errors) if self.errors else []
        duplicate._pos = self._pos
        duplicate._len = self._len
        if hasattr(self, '_xml_attr'):
            duplicate._xml_attr = copy.deepcopy(self._xml_attr)
        return duplicate
Eckhart Arnold's avatar
Eckhart Arnold committed
307

308
    def __str__(self):
309
        s = "".join(str(child) for child in self.children) if self.children else self.content
eckhart's avatar
eckhart committed
310
        if self.errors:
311
            return ' <<< Error on "%s" | %s >>> ' % \
eckhart's avatar
eckhart committed
312
                   (s, '; '.join(e.message for e in self.errors))
313
        return s
314

Eckhart Arnold's avatar
Eckhart Arnold committed
315

316
    def __repr__(self):
317
        # mpargs = {'name': self.parser.name, 'ptype': self.parser.ptype}
318 319
        # name, ptype = (self._tag_name.split(':') + [''])[:2]
        # parg = "MockParser({name}, {ptype})".format(name=name, ptype=ptype)
320
        rarg = str(self) if not self.children else \
eckhart's avatar
eckhart committed
321
            "(" + ", ".join(repr(child) for child in self.children) + ")"
322
        return "Node(%s, %s)" % (self._tag_name, rarg)
323

Eckhart Arnold's avatar
Eckhart Arnold committed
324

325
    def __len__(self):
326
        if self._len < 0:
di68kap's avatar
di68kap committed
327
            self._len = sum(len(child) for child in self.children) \
328
                if self.children else len(self._result)
329 330 331 332 333 334 335 336
        return self._len


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


337
    def __eq__(self, other):
338 339 340
        """
        Equality of nodes: Two nodes are considered as equal, if their tag
        name is the same and if their results are equal.
341 342 343 344

        Note: It is not required that two nodes have the same errors attached.
        In case you need to check for error equality as well, compare a
        serialization that includes error messages, as_sxpr() will do!
345
        """
346
        return self.tag_name == other.tag_name and self.result == other.result
347

Eckhart Arnold's avatar
Eckhart Arnold committed
348

349
    def __hash__(self):
350
        return hash(self.tag_name)
351

Eckhart Arnold's avatar
Eckhart Arnold committed
352

353 354 355
    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
356
        an integer or the first child node with the given tag name. Examples::
357

358
            >>> tree = parse_sxpr('(a (b "X") (X (c "d")) (e (X "F")))')
359 360
            >>> flatten_sxpr(tree[0].as_sxpr())
            '(b "X")'
361 362
            >>> flatten_sxpr(tree["X"].as_sxpr())
            '(X (c "d"))'
363 364 365 366

        Args:
            index_or_tagname(str): Either an index of a child node or a
                tag name.
367
        Returns:
368 369
            Node: All nodes which have a given tag name.
        """
370 371 372
        if self.children:
            if isinstance(index_or_tagname, int):
                return self.children[index_or_tagname]
373
            else:
374 375 376 377 378
                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!')
379 380 381 382


    def __contains__(self, tag_name: str) -> bool:
        """
383
        Returns true if a child with the given tag name exists.
384
        Args:
385 386
            tag_name (str): tag_name which will be searched among to immediate
                descendants of this node.
387 388 389 390
        Returns:
            bool:  True, if at least one descendant node with the given tag
                name exists, False otherwise
        """
391 392 393 394 395
        # assert isinstance(tag_name, str)
        if self.children:
            for child in self.children:
                if child.tag_name == tag_name:
                    return True
396
            return False
397
        raise ValueError('Leave node cannot contain other nodes')
398 399


400 401 402 403 404 405 406 407 408 409 410 411 412 413
    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


414
    @property   # this needs to be a (dynamic) property, in case sef.parser gets updated
415
    def tag_name(self) -> str:
416 417 418 419 420 421
        """
        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`.
        """
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
        return self._tag_name

    @tag_name.setter
    def tag_name(self, tag_name: str):
        assert tag_name
        self._tag_name = tag_name


    def is_anonymous(self):
        return self._tag_name[0] == ':'


    @property
    def parser(self) -> MockParser:
        name, ptype = (self.tag_name.split(':') + [''])[:2]
        return MockParser(name, ':' + ptype)
438

Eckhart Arnold's avatar
Eckhart Arnold committed
439

440
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
441
    def result(self) -> StrictResultType:
442 443 444 445 446
        """
        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.
        """
447 448
        return self._result

449

450
    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
451
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
452
        # # made obsolete by static type checking with mypy
453 454 455
        # 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
456 457
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
458 459
        self._len = -1        # lazy evaluation
        self._content = None
460 461 462 463 464 465 466 467 468
        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
eckhart's avatar
eckhart committed
469
                self._result = result  # cast(StrictResultType, result)
470

471 472

    @property
eckhart's avatar
eckhart committed
473
    def content(self) -> str:
474
        """
di68kap's avatar
di68kap committed
475 476 477
        Returns content as string, omitting error messages. If the node has
        child-nodes, the string content of the child-nodes is recursively read
        and then concatenated.
478
        """
479 480 481 482
        if self._content is None:
            if self.children:
                self._content = "".join(child.content for child in self.children)
            else:
483
                # self._content = self._result
484 485 486
                self._content = str(self._result)
                self._result = self._content  # self._result might be more efficient as a string!?
        return self._content
487 488


di68kap's avatar
di68kap committed
489 490 491 492 493
    @content.setter
    def content(self, content: str):
        self.result = content


494 495 496 497 498 499 500 501 502
    @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))


503
    @property
504
    def pos(self) -> int:
eckhart's avatar
eckhart committed
505 506
        """Returns the position of the Node's content in the source text."""
        if self._pos < 0:
507
            raise AssertionError("Position value not initialized!")
508 509
        return self._pos

eckhart's avatar
eckhart committed
510

eckhart's avatar
eckhart committed
511
    def init_pos(self, pos: int) -> 'Node':
eckhart's avatar
eckhart committed
512 513 514 515 516 517 518 519 520
        """
        (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
521 522
        assert self._pos < 0 or self.pos == pos, str("pos mismatch %i != %i" % (self._pos, pos))
        self._pos = pos
523
        # recursively adjust pos-values of all children
eckhart's avatar
eckhart committed
524
        offset = self.pos
525
        for child in self.children:
eckhart's avatar
eckhart committed
526
            child.init_pos(offset)
eckhart's avatar
eckhart committed
527 528 529
            offset = child.pos + len(child)
        return self

530

531
    @property
532
    def attr(self):
533
        """
534
        Returns a dictionary of XML-attr attached to the node.
535
        """
536 537 538 539
        if not hasattr(self, '_xml_attr'):
            self._xml_attr = OrderedDict()
        return self._xml_attr

Eckhart Arnold's avatar
Eckhart Arnold committed
540

541
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=lambda i: i,
542
                   density=0, inline=False, inline_fn=lambda node: False) -> str:
543 544 545 546 547 548 549 550
        """
        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.

551
        Args:
552
            tab (str):  The indentation string, e.g. '\t' or '    '
eckhart's avatar
eckhart committed
553
            open_fn:   (Node->str) A function that returns an opening
554
                string (e.g. an XML-tag_name) for a given node
eckhart's avatar
eckhart committed
555
            close_fn:  (Node->str) A function that returns a closeF
556
                string (e.g. an XML-tag_name) for a given node.
eckhart's avatar
eckhart committed
557
            data_fn:   (str->str) A function that filters the data string
558 559 560 561 562 563
                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
564 565
        head = open_fn(self)
        tail = close_fn(self)
566 567

        if not self.result:
568
            return head.rstrip() + tail.lstrip()
569

eckhart's avatar
eckhart committed
570
        tail = tail.lstrip(None if density & 2 else '')
571

572
        inline = inline or inline_fn(self)
573 574 575 576 577
        if inline:
            head = head.rstrip()
            tail = tail.lstrip()
            usetab, sep = '', ''
        else:
eckhart's avatar
eckhart committed
578 579
            usetab = tab if head else ''    # no indentation if tag is already omitted
            sep = '\n'
580

581 582
        if self.children:
            content = []
583
            for child in self.children:
584
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn,
585
                                           density, inline, inline_fn)
eckhart's avatar
eckhart committed
586
                if subtree:
eckhart's avatar
eckhart committed
587 588
                    st = [subtree] if inline else subtree.split('\n')
                    content.append((sep + usetab).join(s for s in st))
589
            return head + usetab + (sep + usetab).join(content) + tail
590

eckhart's avatar
eckhart committed
591
        res = self.content
eckhart's avatar
eckhart committed
592
        if not inline and not head:
eckhart's avatar
eckhart committed
593
            # strip whitespace for omitted non inline node, e.g. CharData in mixed elements
eckhart's avatar
eckhart committed
594
            res = res.strip()
595 596
        if density & 1 and res.find('\n') < 0:  # and head[0] == "<":
            # except for XML, add a gap between opening statement and content
597
            gap = ' ' if not inline and head and head.rstrip()[-1:] != '>' else ''
eckhart's avatar
eckhart committed
598
            return head.rstrip() + gap + data_fn(res) + tail.lstrip()
599
        else:
600
            return head + '\n'.join([usetab + data_fn(s) for s in res.split('\n')]) + tail
601

Eckhart Arnold's avatar
Eckhart Arnold committed
602

603 604 605
    def as_sxpr(self, src: str = None,
                showerrors: bool = True,
                indentation: int = 2,
606
                compact: bool = False) -> str:
607 608 609
        """
        Returns content as S-expression, i.e. in lisp-like form.

610
        Args:
611 612 613
            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.
614 615 616
            showerrors: If True, error messages will be shown.
            indentation: The number of whitespaces for indentation
            compact:  If True, a compact representation is returned where
617
                brackets are omitted and only the indentation indicates the
Eckhart Arnold's avatar
Eckhart Arnold committed
618
                tree structure.
619 620
        """

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

624
        def opening(node) -> str:
eckhart's avatar
eckhart committed
625
            """Returns the opening string for the representation of `node`."""
eckhart's avatar
eckhart committed
626
            txt = [left_bracket, node.tag_name]
627
            # s += " '(pos %i)" % node.add_pos
628
            if hasattr(node, '_xml_attr'):
629
                txt.extend(' `(%s "%s")' % (k, v) for k, v in node.attr.items())
630
            if src:
631 632
                line, col = line_col(lbreaks, node.pos)
                txt.append(" `(pos %i %i %i)" % (node.pos, line, col))
633
            if showerrors and node.errors:
634
                txt.append(" `(err `%s)" % ' '.join(str(err) for err in node.errors))
635
            return "".join(txt) + '\n'
636

eckhart's avatar
eckhart committed
637 638 639
        def closing(node) -> str:
            """Returns the closing string for the representation of `node`."""
            return right_bracket
640

eckhart's avatar
eckhart committed
641 642 643 644 645
        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'\"')
646

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

eckhart's avatar
eckhart committed
649

650 651 652
    def as_xml(self, src: str = None,
               showerrors: bool = True,
               indentation: int = 2,
eckhart's avatar
eckhart committed
653 654 655
               inline_tags: Set[str] = set(),
               omit_tags: Set[str] = set(),
               empty_tags: Set[str] = set()) -> str:
656 657 658
        """
        Returns content as XML-tree.

659
        Args:
660 661 662
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
663 664
            showerrors: If True, error messages will be shown.
            indentation: The number of whitespaces for indentation
665 666 667
            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
668
                neither the opening tag nor its attr nor the closing tag. This
669 670 671
                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.
672 673
            empty_tags:  A set of tags which shall be rendered as empty elements, e.g.
                "<empty/>" instead of "<empty><empty>".
674 675
        """

676
        def opening(node) -> str:
677 678 679
            """Returns the opening string for the representation of `node`."""
            if node.tag_name in omit_tags:
                return ''
eckhart's avatar
eckhart committed
680
            txt = ['<', node.tag_name]
681
            has_reserved_attrs = hasattr(node, '_xml_attr') \
eckhart's avatar
eckhart committed
682
                and any(r in node.attr for r in {'err', 'line', 'col'})
di68kap's avatar
di68kap committed
683
            if hasattr(node, '_xml_attr'):
684
                txt.extend(' %s="%s"' % (k, v) for k, v in node.attr.items())
685
            if src and not has_reserved_attrs:
eckhart's avatar
eckhart committed
686
                txt.append(' line="%i" col="%i"' % line_col(line_breaks, node.pos))
687
            if showerrors and node.errors and not has_reserved_attrs:
eckhart's avatar
eckhart committed
688 689
                txt.append(' err="%s"' % ''.join(str(err).replace('"', r'\"')
                                                 for err in node.errors))
690 691 692
            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
693
                ending = "/>\n" if not node.tag_name[0] == '?' else "?>\n"
694 695 696
            else:
                ending = ">\n"
            return "".join(txt + [ending])
697 698

        def closing(node):
699
            """Returns the closing string for the representation of `node`."""
700
            if node.tag_name in omit_tags or node.tag_name in empty_tags:
701
                return ''
702
            return ('\n</') + node.tag_name + '>'
703

704 705 706 707 708 709 710
        def sanitizer(content: str) -> str:
            """Substitute "&", "<", ">" in XML-content by the respective entities."""
            content = RX_AMP.sub('&amp;', content)
            content = content.replace('<', '&lt;').replace('>', '&gt;')
            return content


711 712 713 714 715
        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.
            """
eckhart's avatar
eckhart committed
716 717 718
            return node.tag_name in inline_tags \
                or (hasattr(node, '_xml_attr')
                    and node.attr.get('xml:space', 'default') == 'preserve')
719

720
        line_breaks = linebreaks(src) if src else []
721
        return self._tree_repr(' ' * indentation, opening, closing, sanitizer,
722
                               density=1, inline_fn=inlining)
723

Eckhart Arnold's avatar
Eckhart Arnold committed
724

eckhart's avatar
eckhart committed
725
    def select(self, match_function: Callable, include_root: bool = False, reverse: bool = False) \
726
            -> Iterator['Node']:
eckhart's avatar
eckhart committed
727
        """
728
        Finds nodes in the tree that fulfill a given criterion.
eckhart's avatar
eckhart committed
729

730
        `select` is a generator that yields all nodes for which the
di68kap's avatar
di68kap committed
731
        given `match_function` evaluates to True. The tree is
732 733 734
        traversed pre-order.

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

736 737 738
        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
739 740
            include_root (bool): If False, only descendant nodes will be
                checked for a match.
741 742
            reverse (bool): If True, the tree will be walked in reverse
                order, i.e. last children first.
743
        Yields:
744
            Node: All nodes of the tree for which
745 746
            ``match_function(node)`` returns True
        """
747
        if include_root and match_function(self):
748
            yield self
749 750 751
        child_iterator = reversed(self.children) if reverse else self.children
        for child in child_iterator:
            for node in child.select(match_function, True, reverse):
eckhart's avatar
eckhart committed
752
                yield node
753

Eckhart Arnold's avatar
Eckhart Arnold committed
754

eckhart's avatar
eckhart committed
755
    def select_by_tag(self, tag_names: Union[str, AbstractSet[str]],
eckhart's avatar
eckhart committed
756
                      include_root: bool = False) -> Iterator['Node']:
757
        """
758 759 760 761
        Returns an iterator that runs through all descendants that have one
        of the given tag names.

        Examples::
762

763
            >>> tree = parse_sxpr('(a (b "X") (X (c "d")) (e (X "F")))')
764
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag("X", False))
765
            ['(X (c "d"))', '(X "F")']
766
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag({"X", "b"}, False))
767
            ['(b "X")', '(X (c "d"))', '(X "F")']
768
            >>> any(tree.select_by_tag('a', False))
769
            False
770
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag('a', True))
771
            ['(a (b "X") (X (c "d")) (e (X "F")))']
772 773
            >>> flatten_sxpr(next(tree.select_by_tag("X", False)).as_sxpr())
            '(X (c "d"))'
774 775

        Args:
776 777 778 779
            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.
780 781 782
        Yields:
            Node: All nodes which have a given tag name.
        """
783
        if isinstance(tag_names, str):
eckhart's avatar
eckhart committed
784
            tag_names = frozenset({tag_names})
785
        return self.select(lambda node: node.tag_name in tag_names, include_root)
786 787


788 789 790 791
    def pick(self, tag_names: Union[str, Set[str]]) -> Optional['Node']:
        """
        Picks the first descendant with one of the given tag_names.

792
        This function is mostly just syntactic sugar for
793 794 795 796 797 798 799 800 801 802
        ``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


803
    def tree_size(self) -> int:
eckhart's avatar
eckhart committed
804 805 806
        """
        Recursively counts the number of nodes in the tree including the root node.
        """
807 808 809
        return sum(child.tree_size() for child in self.children) + 1


810
ZOMBIE_NODE = Node(ZOMBIE, '')
di68kap's avatar
di68kap committed
811 812


di68kap's avatar
di68kap committed
813
class RootNode(Node):
814
    """TODO: Add Documentation!!!
di68kap's avatar
di68kap committed
815

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

820 821
        error_flag (int):  the highest warning or error level of all errors
                that occurred.
di68kap's avatar
di68kap committed
822
    """
823

eckhart's avatar
eckhart committed
824
    def __init__(self, node: Optional[Node] = None):
825
        super().__init__(ZOMBIE, '')
eckhart's avatar
eckhart committed
826
        self.all_errors = []  # type: List[Error]
di68kap's avatar
di68kap committed
827
        self.error_flag = 0
eckhart's avatar
eckhart committed
828 829
        if node is not None:
            self.swallow(node)
830
        # customization for XML-Representation
eckhart's avatar
eckhart committed
831 832 833
        self.inline_tags = set()  # type: Set[str]
        self.omit_tags = set()  # type: Set[str]
        self.empty_tags = set()  # type: Set[str]
di68kap's avatar
di68kap committed
834

835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852
    def __deepcopy__(self, memodict={}):
        duplicate = self.__class__(None)
        if self.children:
            duplicate.children = copy.deepcopy(self.children)
            duplicate._result = duplicate.children
        else: