syntaxtree.py 38.6 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
from collections import OrderedDict
eckhart's avatar
eckhart committed
27
import copy
28

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

34

di68kap's avatar
di68kap committed
35
__all__ = ('WHITESPACE_PTYPE',
36
           'TOKEN_PTYPE',
37
           'ZOMBIE',
eckhart's avatar
eckhart committed
38
           'ZOMBIE_NODE',
eckhart's avatar
eckhart committed
39 40 41
           'ResultType',
           'StrictResultType',
           'ChildrenType',
42
           'Node',
di68kap's avatar
di68kap committed
43
           'RootNode',
eckhart's avatar
eckhart committed
44
           'ZOMBIE_ROOTNODE',
45
           'parse_sxpr',
46 47 48
           'parse_xml',
           'flatten_sxpr',
           'flatten_xml')
Eckhart Arnold's avatar
Eckhart Arnold committed
49 50


51 52 53 54 55 56 57 58
#######################################################################
#
# parser base and mock parsers
#
#######################################################################


WHITESPACE_PTYPE = ':Whitespace'
59
TOKEN_PTYPE = ':Token'
60

61 62
ZOMBIE = "__ZOMBIE__"

63 64 65 66 67 68 69
#######################################################################
#
# syntaxtree nodes
#
#######################################################################


70
ChildrenType = Tuple['Node', ...]
Eckhart Arnold's avatar
Eckhart Arnold committed
71
NoChildren = cast(ChildrenType, ())  # type: ChildrenType
eckhart's avatar
eckhart committed
72
StrictResultType = Union[ChildrenType, StringView, str]
73
ResultType = Union[ChildrenType, 'Node', StringView, str, None]
74 75


Eckhart Arnold's avatar
Eckhart Arnold committed
76
def flatten_sxpr(sxpr: str) -> str:
77 78
    """
    Returns S-expression ``sxpr`` as a one-liner without unnecessary
Eckhart Arnold's avatar
Eckhart Arnold committed
79 80 81
    whitespace.

    Example:
Eckhart Arnold's avatar
Eckhart Arnold committed
82
    >>> flatten_sxpr('(a\\n    (b\\n        c\\n    )\\n)\\n')
Eckhart Arnold's avatar
Eckhart Arnold committed
83 84
    '(a (b c))'
    """
85

86
    return re.sub(r'\s(?=\))', '', re.sub(r'\s+', ' ', sxpr)).strip()
Eckhart Arnold's avatar
Eckhart Arnold committed
87 88


89
def flatten_xml(xml: str) -> str:
90 91
    """
    Returns an XML-tree as a one liner without unnecessary whitespace,
92
    i.e. only whitespace within leaf-nodes is preserved.
93 94
    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`.
95
    """
96

97 98 99 100
    # 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']
101
    return re.sub(r'\s+(?=<[\w:])', '', re.sub(r'(?P<closing_tag></:?\w+>)\s+', tag_only, xml))
102 103


eckhart's avatar
eckhart committed
104
RX_AMP = re.compile(r'&(?!\w+;)')
105 106


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

111 112
    TODO: Add some documentation and doc-tests here...

113
    Attributes:
114 115
        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
116

117 118 119
        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.
120

121 122
        children (tuple):  The tuple of child nodes or an empty tuple
            if there are no child nodes. READ ONLY!
123

eckhart's avatar
eckhart committed
124 125 126 127
        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
128
        parser (Parser):  The parser which generated this node.
129 130
            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
131 132
            rely on this being a real parser object in any phase after
            parsing (i.e. AST-transformation and compiling), for
133
            example by calling ``isinstance(node.parer, ...)``.
134

135 136 137
        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
138
            the length before AST-transformation and will never change
139
            through AST-transformation. READ ONLY!
140

141 142
        pos (int):  the position of the node within the parsed text.

Eckhart Arnold's avatar
Eckhart Arnold committed
143
            The value of ``pos`` is -1 meaning invalid by default.
144
            Setting this value will set the positions of all child
Eckhart Arnold's avatar
Eckhart Arnold committed
145
            nodes relative to this value.
146 147

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

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

155 156
        errors (list):  A list of all errors that occured on this node.

157 158
        attr (dict): An optional dictionary of XML-attr. This
            dictionary is created lazily upon first usage. The attr
159 160
            will only be shown in the XML-Representation, not in the
            S-Expression-output.
161
    """
162

163
    __slots__ = '_result', 'children', '_len', '_pos', 'tag_name', 'errors', '_xml_attr', '_content'
164

165
    def __init__(self, tag_name: Optional[str], result: ResultType, leafhint: bool = False) -> None:
166 167
        """
        Initializes the ``Node``-object with the ``Parser``-Instance
168 169
        that generated the node and the parser's result.
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
170
        self.errors = []                # type: List[Error]
eckhart's avatar
eckhart committed
171
        self._pos = -1                  # type: int
172
        # Assignment to self.result initializes the attr _result, children and _len
di68kap's avatar
di68kap committed
173
        # The following if-clause is merely an optimization, i.e. a fast-path for leaf-Nodes
174
        if leafhint:
eckhart's avatar
eckhart committed
175
            self._result = result       # type: StrictResultType  # cast(StrictResultType, result)
eckhart's avatar
eckhart committed
176
            self._content = None        # type: Optional[str]
177
            self.children = NoChildren  # type: ChildrenType
178
            self._len = -1              # type: int  # lazy evaluation
179 180
        else:
            self.result = result
181
        assert tag_name is None or isinstance(tag_name, str)   # TODO: Delete this line
182
        self.tag_name = tag_name if tag_name else ZOMBIE
183 184 185 186
        # if parser is None:
        #     self._tag_name = ZOMBIE
        # else:
        #     self._tag_name = parser.name or parser.ptype
187

eckhart's avatar
eckhart committed
188 189
    def __deepcopy__(self, memo):
        if self.children:
190
            duplicate = self.__class__(self.tag_name, copy.deepcopy(self.children), False)
eckhart's avatar
eckhart committed
191
        else:
192
            duplicate = self.__class__(self.tag_name, self.result, True)
eckhart's avatar
eckhart committed
193 194 195
        duplicate.errors = copy.deepcopy(self.errors) if self.errors else []
        duplicate._pos = self._pos
        duplicate._len = self._len
eckhart's avatar
eckhart committed
196
        if self.attr_active():
eckhart's avatar
eckhart committed
197 198
            duplicate._xml_attr = copy.deepcopy(self._xml_attr)
        return duplicate
Eckhart Arnold's avatar
Eckhart Arnold committed
199

200
    def __str__(self):
201
        s = "".join(str(child) for child in self.children) if self.children else self.content
eckhart's avatar
eckhart committed
202
        if self.errors:
203
            return ' <<< Error on "%s" | %s >>> ' % \
eckhart's avatar
eckhart committed
204
                   (s, '; '.join(e.message for e in self.errors))
205
        return s
206

Eckhart Arnold's avatar
Eckhart Arnold committed
207

208
    def __repr__(self):
209
        # mpargs = {'name': self.parser.name, 'ptype': self.parser.ptype}
210 211
        # name, ptype = (self._tag_name.split(':') + [''])[:2]
        # parg = "MockParser({name}, {ptype})".format(name=name, ptype=ptype)
212
        rarg = str(self) if not self.children else \
eckhart's avatar
eckhart committed
213
            "(" + ", ".join(repr(child) for child in self.children) + ")"
214
        return "Node(%s, %s)" % (self.tag_name, rarg)
215

Eckhart Arnold's avatar
Eckhart Arnold committed
216

217
    def __len__(self):
218
        if self._len < 0:
di68kap's avatar
di68kap committed
219
            self._len = sum(len(child) for child in self.children) \
220
                if self.children else len(self._result)
221 222 223 224 225 226 227 228
        return self._len


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


229
    def __eq__(self, other):
230 231 232
        """
        Equality of nodes: Two nodes are considered as equal, if their tag
        name is the same and if their results are equal.
233 234 235 236

        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!
237
        """
238
        return self.tag_name == other.tag_name and self.result == other.result
239

Eckhart Arnold's avatar
Eckhart Arnold committed
240

241
    def __hash__(self):
242
        return hash(self.tag_name)
243

Eckhart Arnold's avatar
Eckhart Arnold committed
244

245 246 247
    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
248
        an integer or the first child node with the given tag name. Examples::
249

250
            >>> tree = parse_sxpr('(a (b "X") (X (c "d")) (e (X "F")))')
251 252
            >>> flatten_sxpr(tree[0].as_sxpr())
            '(b "X")'
253 254
            >>> flatten_sxpr(tree["X"].as_sxpr())
            '(X (c "d"))'
255 256 257 258

        Args:
            index_or_tagname(str): Either an index of a child node or a
                tag name.
259
        Returns:
260 261
            Node: All nodes which have a given tag name.
        """
262 263 264
        if self.children:
            if isinstance(index_or_tagname, int):
                return self.children[index_or_tagname]
265
            else:
266 267 268 269 270
                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!')
271 272 273 274


    def __contains__(self, tag_name: str) -> bool:
        """
275
        Returns true if a child with the given tag name exists.
276
        Args:
277 278
            tag_name (str): tag_name which will be searched among to immediate
                descendants of this node.
279 280 281 282
        Returns:
            bool:  True, if at least one descendant node with the given tag
                name exists, False otherwise
        """
283 284 285 286 287
        # assert isinstance(tag_name, str)
        if self.children:
            for child in self.children:
                if child.tag_name == tag_name:
                    return True
288
            return False
289
        raise ValueError('Leave node cannot contain other nodes')
290 291


292 293 294 295 296 297 298 299 300 301 302 303 304 305
    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


306
    def is_anonymous(self):
307
        return self.tag_name[0] == ':'
308

Eckhart Arnold's avatar
Eckhart Arnold committed
309

310
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
311
    def result(self) -> StrictResultType:
312 313 314 315 316
        """
        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.
        """
317 318
        return self._result

319

320
    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
321
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
322
        # # made obsolete by static type checking with mypy
323 324 325
        # 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
326 327
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
328 329
        self._len = -1        # lazy evaluation
        self._content = None
330 331 332 333 334 335 336 337 338
        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
339
                self._result = result  # cast(StrictResultType, result)
340

341 342

    @property
eckhart's avatar
eckhart committed
343
    def content(self) -> str:
344
        """
di68kap's avatar
di68kap committed
345 346 347
        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.
348
        """
349 350 351 352
        if self._content is None:
            if self.children:
                self._content = "".join(child.content for child in self.children)
            else:
353
                # self._content = self._result
354 355 356
                self._content = str(self._result)
                self._result = self._content  # self._result might be more efficient as a string!?
        return self._content
357 358 359 360 361
    #
    #
    # @content.setter
    # def content(self, content: str):
    #     self.result = content
di68kap's avatar
di68kap committed
362 363


364 365 366 367 368 369 370 371 372
    @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))


373
    @property
374
    def pos(self) -> int:
eckhart's avatar
eckhart committed
375 376
        """Returns the position of the Node's content in the source text."""
        if self._pos < 0:
377
            raise AssertionError("Position value not initialized!")
378 379
        return self._pos

eckhart's avatar
eckhart committed
380

eckhart's avatar
eckhart committed
381
    def init_pos(self, pos: int) -> 'Node':
eckhart's avatar
eckhart committed
382 383 384 385 386 387 388 389 390
        """
        (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
391 392
        assert self._pos < 0 or self.pos == pos, str("pos mismatch %i != %i" % (self._pos, pos))
        self._pos = pos
393
        # recursively adjust pos-values of all children
eckhart's avatar
eckhart committed
394
        offset = self.pos
395
        for child in self.children:
eckhart's avatar
eckhart committed
396
            child.init_pos(offset)
eckhart's avatar
eckhart committed
397 398 399
            offset = child.pos + len(child)
        return self

400

eckhart's avatar
eckhart committed
401 402 403 404 405 406 407 408 409 410 411 412 413
    def attr_active(self) -> bool:
        """
        Returns True, if XML-Attributes of this node have ever been set
        or queried, even if unsuccessfully.
        """
        try:
            if self._xml_attr is not None:
                return True
        except AttributeError:
            pass
        return False


414
    @property
415
    def attr(self):
416
        """
417
        Returns a dictionary of XML-attr attached to the node.
418
        """
eckhart's avatar
eckhart committed
419 420 421 422
        try:
            if self._xml_attr is None:          # cython compatibility
                self._xml_attr = OrderedDict()
        except AttributeError:
423 424 425
            self._xml_attr = OrderedDict()
        return self._xml_attr

Eckhart Arnold's avatar
Eckhart Arnold committed
426

427
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=lambda i: i,
428
                   density=0, inline=False, inline_fn=lambda node: False) -> str:
429 430 431 432 433 434 435 436
        """
        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.

437
        Args:
438
            tab (str):  The indentation string, e.g. '\t' or '    '
eckhart's avatar
eckhart committed
439
            open_fn:   (Node->str) A function that returns an opening
440
                string (e.g. an XML-tag_name) for a given node
eckhart's avatar
eckhart committed
441
            close_fn:  (Node->str) A function that returns a closeF
442
                string (e.g. an XML-tag_name) for a given node.
eckhart's avatar
eckhart committed
443
            data_fn:   (str->str) A function that filters the data string
444 445 446 447 448 449
                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
450 451
        head = open_fn(self)
        tail = close_fn(self)
452 453

        if not self.result:
454
            return head.rstrip() + tail.lstrip()
455

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

458
        inline = inline or inline_fn(self)
459 460 461 462 463
        if inline:
            head = head.rstrip()
            tail = tail.lstrip()
            usetab, sep = '', ''
        else:
eckhart's avatar
eckhart committed
464 465
            usetab = tab if head else ''    # no indentation if tag is already omitted
            sep = '\n'
466

467 468
        if self.children:
            content = []
469
            for child in self.children:
470
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn,
471
                                           density, inline, inline_fn)
eckhart's avatar
eckhart committed
472
                if subtree:
eckhart's avatar
eckhart committed
473 474
                    st = [subtree] if inline else subtree.split('\n')
                    content.append((sep + usetab).join(s for s in st))
475
            return head + usetab + (sep + usetab).join(content) + tail
476

eckhart's avatar
eckhart committed
477
        res = self.content
eckhart's avatar
eckhart committed
478
        if not inline and not head:
eckhart's avatar
eckhart committed
479
            # strip whitespace for omitted non inline node, e.g. CharData in mixed elements
eckhart's avatar
eckhart committed
480
            res = res.strip()
481 482
        if density & 1 and res.find('\n') < 0:  # and head[0] == "<":
            # except for XML, add a gap between opening statement and content
483
            gap = ' ' if not inline and head and head.rstrip()[-1:] != '>' else ''
eckhart's avatar
eckhart committed
484
            return head.rstrip() + gap + data_fn(res) + tail.lstrip()
485
        else:
486
            return head + '\n'.join([usetab + data_fn(s) for s in res.split('\n')]) + tail
487

Eckhart Arnold's avatar
Eckhart Arnold committed
488

489 490 491
    def as_sxpr(self, src: str = None,
                showerrors: bool = True,
                indentation: int = 2,
492
                compact: bool = False) -> str:
493 494 495
        """
        Returns content as S-expression, i.e. in lisp-like form.

496
        Args:
497 498 499
            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.
500 501 502
            showerrors: If True, error messages will be shown.
            indentation: The number of whitespaces for indentation
            compact:  If True, a compact representation is returned where
503
                brackets are omitted and only the indentation indicates the
Eckhart Arnold's avatar
Eckhart Arnold committed
504
                tree structure.
505 506
        """

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

510
        def opening(node) -> str:
eckhart's avatar
eckhart committed
511
            """Returns the opening string for the representation of `node`."""
eckhart's avatar
eckhart committed
512
            txt = [left_bracket, node.tag_name]
513
            # s += " '(pos %i)" % node.add_pos
eckhart's avatar
eckhart committed
514
            if node.attr_active():
515
                txt.extend(' `(%s "%s")' % (k, v) for k, v in node.attr.items())
516
            if src:
517 518
                line, col = line_col(lbreaks, node.pos)
                txt.append(" `(pos %i %i %i)" % (node.pos, line, col))
519
            if showerrors and node.errors:
520
                txt.append(" `(err `%s)" % ' '.join(str(err) for err in node.errors))
521
            return "".join(txt) + '\n'
522

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

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

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

eckhart's avatar
eckhart committed
535

536 537 538
    def as_xml(self, src: str = None,
               showerrors: bool = True,
               indentation: int = 2,
eckhart's avatar
eckhart committed
539 540 541
               inline_tags: Set[str] = set(),
               omit_tags: Set[str] = set(),
               empty_tags: Set[str] = set()) -> str:
542 543 544
        """
        Returns content as XML-tree.

545
        Args:
546 547 548
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
549 550
            showerrors: If True, error messages will be shown.
            indentation: The number of whitespaces for indentation
551 552 553
            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
554
                neither the opening tag nor its attr nor the closing tag. This
555 556 557
                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.
558 559
            empty_tags:  A set of tags which shall be rendered as empty elements, e.g.
                "<empty/>" instead of "<empty><empty>".
560 561
        """

562
        def opening(node) -> str:
563 564 565
            """Returns the opening string for the representation of `node`."""
            if node.tag_name in omit_tags:
                return ''
eckhart's avatar
eckhart committed
566
            txt = ['<', node.tag_name]
eckhart's avatar
eckhart committed
567
            has_reserved_attrs = node.attr_active() \
eckhart's avatar
eckhart committed
568
                and any(r in node.attr for r in {'err', 'line', 'col'})
eckhart's avatar
eckhart committed
569
            if node.attr_active():
570
                txt.extend(' %s="%s"' % (k, v) for k, v in node.attr.items())
571
            if src and not has_reserved_attrs:
eckhart's avatar
eckhart committed
572
                txt.append(' line="%i" col="%i"' % line_col(line_breaks, node.pos))
573
            if showerrors and node.errors and not has_reserved_attrs:
eckhart's avatar
eckhart committed
574 575
                txt.append(' err="%s"' % ''.join(str(err).replace('"', r'\"')
                                                 for err in node.errors))
576 577 578
            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
579
                ending = "/>\n" if not node.tag_name[0] == '?' else "?>\n"
580 581 582
            else:
                ending = ">\n"
            return "".join(txt + [ending])
583 584

        def closing(node):
585
            """Returns the closing string for the representation of `node`."""
586
            if node.tag_name in omit_tags or node.tag_name in empty_tags:
587
                return ''
588
            return ('\n</') + node.tag_name + '>'
589

590 591 592 593 594 595 596
        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


597 598 599 600 601
        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
602
            return node.tag_name in inline_tags \
eckhart's avatar
eckhart committed
603
                or (node.attr_active()
eckhart's avatar
eckhart committed
604
                    and node.attr.get('xml:space', 'default') == 'preserve')
605

606
        line_breaks = linebreaks(src) if src else []
607
        return self._tree_repr(' ' * indentation, opening, closing, sanitizer,
608
                               density=1, inline_fn=inlining)
609

Eckhart Arnold's avatar
Eckhart Arnold committed
610

eckhart's avatar
eckhart committed
611
    def select(self, match_function: Callable, include_root: bool = False, reverse: bool = False) \
612
            -> Iterator['Node']:
eckhart's avatar
eckhart committed
613
        """
614
        Finds nodes in the tree that fulfill a given criterion.
eckhart's avatar
eckhart committed
615

616
        `select` is a generator that yields all nodes for which the
di68kap's avatar
di68kap committed
617
        given `match_function` evaluates to True. The tree is
618 619 620
        traversed pre-order.

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

622 623 624
        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
625 626
            include_root (bool): If False, only descendant nodes will be
                checked for a match.
627 628
            reverse (bool): If True, the tree will be walked in reverse
                order, i.e. last children first.
629
        Yields:
630
            Node: All nodes of the tree for which
631 632
            ``match_function(node)`` returns True
        """
633
        if include_root and match_function(self):
634
            yield self
635 636 637
        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
638
                yield node
639

Eckhart Arnold's avatar
Eckhart Arnold committed
640

eckhart's avatar
eckhart committed
641
    def select_by_tag(self, tag_names: Union[str, AbstractSet[str]],
eckhart's avatar
eckhart committed
642
                      include_root: bool = False) -> Iterator['Node']:
643
        """
644 645 646 647
        Returns an iterator that runs through all descendants that have one
        of the given tag names.

        Examples::
648

649
            >>> tree = parse_sxpr('(a (b "X") (X (c "d")) (e (X "F")))')
650
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag("X", False))
651
            ['(X (c "d"))', '(X "F")']
652
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag({"X", "b"}, False))
653
            ['(b "X")', '(X (c "d"))', '(X "F")']
654
            >>> any(tree.select_by_tag('a', False))
655
            False
656
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag('a', True))
657
            ['(a (b "X") (X (c "d")) (e (X "F")))']
658 659
            >>> flatten_sxpr(next(tree.select_by_tag("X", False)).as_sxpr())
            '(X (c "d"))'
660 661

        Args:
662 663 664 665
            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.
666 667 668
        Yields:
            Node: All nodes which have a given tag name.
        """
669
        if isinstance(tag_names, str):
eckhart's avatar
eckhart committed
670
            tag_names = frozenset({tag_names})
671
        return self.select(lambda node: node.tag_name in tag_names, include_root)
672 673


674 675 676 677
    def pick(self, tag_names: Union[str, Set[str]]) -> Optional['Node']:
        """
        Picks the first descendant with one of the given tag_names.

678
        This function is mostly just syntactic sugar for
679 680 681 682 683 684 685 686 687 688
        ``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


689
    def tree_size(self) -> int:
eckhart's avatar
eckhart committed
690 691 692
        """
        Recursively counts the number of nodes in the tree including the root node.
        """
693 694 695
        return sum(child.tree_size() for child in self.children) + 1


696
ZOMBIE_NODE = Node(ZOMBIE, '')
di68kap's avatar
di68kap committed
697 698


di68kap's avatar
di68kap committed
699
class RootNode(Node):
700
    """TODO: Add Documentation!!!
di68kap's avatar
di68kap committed
701

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

706 707
        error_flag (int):  the highest warning or error level of all errors
                that occurred.
di68kap's avatar
di68kap committed
708
    """
709

eckhart's avatar
eckhart committed
710
    def __init__(self, node: Optional[Node] = None):
711
        super().__init__(ZOMBIE, '')
eckhart's avatar
eckhart committed
712
        self.all_errors = []  # type: List[Error]
di68kap's avatar
di68kap committed
713
        self.error_flag = 0
eckhart's avatar
eckhart committed
714 715
        if node is not None:
            self.swallow(node)
716
        # customization for XML-Representation
eckhart's avatar
eckhart committed
717 718 719
        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
720

721 722 723 724 725 726 727 728 729 730 731
    def __deepcopy__(self, memodict={}):
        duplicate = self.__class__(None)
        if self.children:
            duplicate.children = copy.deepcopy(self.children)
            duplicate._result = duplicate.children
        else:
            duplicate.children = NoChildren
            duplicate._result = self._result
        duplicate.errors = copy.deepcopy(self.errors) if self.errors else []
        duplicate._pos = self._pos
        duplicate._len = self._len
eckhart's avatar
eckhart committed
732
        if self.attr_active():
733 734 735 736 737 738
            duplicate._xml_attr = copy.deepcopy(self._xml_attr)
        duplicate.all_errors = copy.deepcopy(self.all_errors)
        duplicate.error_flag = self.error_flag
        duplicate.inline_tags = self.inline_tags
        duplicate.omit_tags = self.omit_tags
        duplicate.empty_tags = self.empty_tags
739
        duplicate.tag_name = self.tag_name
740 741 742
        return duplicate


743
    def swallow(self, node: Node) -> 'RootNode':
744 745
        """
        Put `self` in the place of `node` by copying all its data.
746 747 748 749 750 751 752 753 754
        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
755 756 757 758
        self._result = node._result
        self.children = node.children
        self._len = node._len
        self._pos = node._pos
759
        self.tag_name = node.tag_name
eckhart's avatar
eckhart committed
760
        if node.attr_active():
761
            self._xml_attr = node._xml_attr
di68kap's avatar
di68kap committed
762
        self._content = node._content
763
        return self
di68kap's avatar
di68kap committed
764

eckhart's avatar
eckhart committed
765
    def add_error(self, node: Node, error: Error) -> 'RootNode':
766 767 768
        """
        Adds an Error object to the tree, locating it at a specific node.
        """
di68kap's avatar
di68kap committed
769 770 771 772 773
        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
774
    def new_error(self,
775
                  node: Node,
di68kap's avatar
di68kap committed
776
                  message: str,
eckhart's avatar
eckhart committed
777
                  code: ErrorCode = Error.ERROR) -> 'RootNode':
di68kap's avatar
di68kap committed
778
        """
eckhart's avatar
eckhart committed
779
        Adds an error to this tree, locating it at a specific node.
di68kap's avatar
di68kap committed
780 781 782 783 784
        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
785
        error = Error(message, node.pos, code)
eckhart's avatar
eckhart committed
786 787
        self.add_error(node, error)
        return self
di68kap's avatar
di68kap committed
788

eckhart's avatar
eckhart committed
789
    def collect_errors(self) -> List[Error]:
790 791
        """
        Returns the list of errors, ordered bv their position.
di68kap's avatar
di68kap committed
792
        """
793
        self.all_errors.sort(key=lambda e: e.pos)
Eckhart Arnold's avatar
Eckhart Arnold committed
794
        return self.all_errors
di68kap's avatar
di68kap committed
795

796
    def customized_XML(self):
797 798
        """
        Returns a customized XML representation of the tree.
799
        See the docstring of `Node.as_xml()` for an explanation of the
800 801
        customizations.
        """
eckhart's avatar
eckhart committed
802
        return self.as_xml(inline_tags=self.inline_tags,
803 804 805
                           omit_tags=self.omit_tags,
                           empty_tags=self.empty_tags)

di68kap's avatar
di68kap committed
806

eckhart's avatar
eckhart committed
807 808
ZOMBIE_ROOTNODE = RootNode()

di68kap's avatar
di68kap committed
809 810 811 812 813
#######################################################################
#
# S-expression- and XML-parsers
#
#######################################################################
eckhart's avatar
eckhart committed
814 815


eckhart's avatar
eckhart committed
816
def parse_sxpr(sxpr: Union[str, StringView]) -> Node:
817
    """
818