syntaxtree.py 52.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# syntaxtree.py - syntax tree classes for DHParser
#
# Copyright 2016  by Eckhart Arnold (arnold@badw.de)
#                 Bavarian Academy of Sciences an Humanities (badw.de)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.  See the License for the specific language governing
# permissions and limitations under the License.
17
18
19


"""
20
21
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
import json
29
from typing import Callable, cast, Iterator, List, AbstractSet, Set, Union, Tuple, Optional, Dict
30

31
32
from DHParser.configuration import SERIALIZATIONS, XML_SERIALIZATION, SXPRESSION_SERIALIZATION, \
    COMPACT_SERIALIZATION, JSON_SERIALIZATION
eckhart's avatar
eckhart committed
33
from DHParser.error import Error, ErrorCode, linebreaks, line_col
34
from DHParser.stringview import StringView
35
from DHParser.toolkit import get_config_value, re
di68kap's avatar
di68kap committed
36

37

di68kap's avatar
di68kap committed
38
__all__ = ('WHITESPACE_PTYPE',
39
           'TOKEN_PTYPE',
40
41
           'ZOMBIE_TAG',
           'PLACEHOLDER',
eckhart's avatar
eckhart committed
42
43
44
           'ResultType',
           'StrictResultType',
           'ChildrenType',
45
           'Node',
46
           'serialize',
47
           'FrozenNode',
48
           'tree_sanity_check',
di68kap's avatar
di68kap committed
49
           'RootNode',
50
           'parse_sxpr',
51
           'parse_xml',
52
           'parse_json_syntaxtree',
eckhart's avatar
eckhart committed
53
           'parse_tree',
54
55
           'flatten_sxpr',
           'flatten_xml')
Eckhart Arnold's avatar
Eckhart Arnold committed
56
57


58
59
60
61
62
63
64
65
#######################################################################
#
# parser base and mock parsers
#
#######################################################################


WHITESPACE_PTYPE = ':Whitespace'
66
TOKEN_PTYPE = ':Token'
67

68
ZOMBIE_TAG = "__ZOMBIE__"
69

70
71
72
73
74
75
76
#######################################################################
#
# syntaxtree nodes
#
#######################################################################


eckhart's avatar
eckhart committed
77
78
RX_IS_SXPR = re.compile(r'\s*\(')
RX_IS_XML = re.compile(r'\s*<')
79
RX_ATTR_NAME = re.compile(r'[\w.:-]')
eckhart's avatar
eckhart committed
80
81


82
def flatten_sxpr(sxpr: str, threshold: int = -1) -> str:
83
84
    """
    Returns S-expression ``sxpr`` as a one-liner without unnecessary
Eckhart Arnold's avatar
Eckhart Arnold committed
85
86
    whitespace.

87
88
89
90
91
92
93
    The ``threshold`` value is a maximum number of
    characters allowed in the flattened expression. If this number
    is exceeded the the unflattened S-expression is returned. A
    negative number means that the S-expression will always be
    flattened. Zero or (any postive integer <= 3) essentially means
    that the expression will not be flattened.

Eckhart Arnold's avatar
Eckhart Arnold committed
94
    Example:
Eckhart Arnold's avatar
Eckhart Arnold committed
95
    >>> flatten_sxpr('(a\\n    (b\\n        c\\n    )\\n)\\n')
Eckhart Arnold's avatar
Eckhart Arnold committed
96
97
    '(a (b c))'
    """
eckhart's avatar
eckhart committed
98
99
100
    assert RX_IS_SXPR.match(sxpr)
    if threshold == 0:
        return sxpr
101
    flat = re.sub(r'\s(?=\))', '', re.sub(r'\s+', ' ', sxpr)).strip()
eckhart's avatar
eckhart committed
102
    if len(flat) > threshold >= 0:
103
104
        return sxpr.strip()
    return flat
Eckhart Arnold's avatar
Eckhart Arnold committed
105
106


107
def flatten_xml(xml: str) -> str:
108
109
    """
    Returns an XML-tree as a one liner without unnecessary whitespace,
110
    i.e. only whitespace within leaf-nodes is preserved.
111
112
    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`.
113
    """
114
115
    # works only with regex
    # return re.sub(r'\s+(?=<\w)', '', re.sub(r'(?<=</\w+>)\s+', '', xml))
eckhart's avatar
eckhart committed
116
    assert RX_IS_XML.match(xml)
eckhart's avatar
eckhart committed
117

118
    def tag_only(m):
eckhart's avatar
eckhart committed
119
        """Return only the tag, drop the whitespace."""
120
        return m.groupdict()['closing_tag']
121
    return re.sub(r'\s+(?=<[\w:])', '', re.sub(r'(?P<closing_tag></:?\w+>)\s+', tag_only, xml))
122
123


124
125
126
127
128
ChildrenType = Tuple['Node', ...]
NoChildren = cast(ChildrenType, ())  # type: ChildrenType
StrictResultType = Union[ChildrenType, StringView, str]
ResultType = Union[ChildrenType, 'Node', StringView, str, None]

eckhart's avatar
eckhart committed
129
RX_AMP = re.compile(r'&(?!\w+;)')
130
131


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

136
137
    TODO: Add some documentation and doc-tests here...

eckhart's avatar
eckhart committed
138
    Attributes and Properties:
139
140
        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
141

142
143
144
        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.
145

146
147
        children (tuple):  The tuple of child nodes or an empty tuple
            if there are no child nodes. READ ONLY!
148

eckhart's avatar
eckhart committed
149
150
151
152
        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.

153
154
155
        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
156
            the length before AST-transformation and will never change
157
            through AST-transformation. READ ONLY!
158

159
160
        pos (int):  the position of the node within the parsed text.

Eckhart Arnold's avatar
Eckhart Arnold committed
161
            The value of ``pos`` is -1 meaning invalid by default.
162
            Setting this value will set the positions of all child
Eckhart Arnold's avatar
Eckhart Arnold committed
163
            nodes relative to this value.
164
165

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

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

173
174
        attr (dict): An optional dictionary of XML-attr. This
            dictionary is created lazily upon first usage. The attr
175
176
            will only be shown in the XML-Representation, not in the
            S-Expression-output.
177
    """
178

179
    __slots__ = '_result', 'children', '_pos', 'tag_name', '_xml_attr'
180

181
    def __init__(self, tag_name: str, result: ResultType, leafhint: bool = False) -> None:
182
183
        """
        Initializes the ``Node``-object with the ``Parser``-Instance
184
185
        that generated the node and the parser's result.
        """
eckhart's avatar
eckhart committed
186
        self._pos = -1                  # type: int
187
        # Assignment to self.result initializes the attr _result, children and _len
di68kap's avatar
di68kap committed
188
        # The following if-clause is merely an optimization, i.e. a fast-path for leaf-Nodes
189
        if leafhint:
eckhart's avatar
eckhart committed
190
            self._result = result       # type: StrictResultType  # cast(StrictResultType, result)
191
192
193
            self.children = NoChildren  # type: ChildrenType
        else:
            self.result = result
194
        self.tag_name = tag_name        # type: str
195

eckhart's avatar
eckhart committed
196

eckhart's avatar
eckhart committed
197
198
    def __deepcopy__(self, memo):
        if self.children:
199
            duplicate = self.__class__(self.tag_name, copy.deepcopy(self.children), False)
eckhart's avatar
eckhart committed
200
        else:
201
            duplicate = self.__class__(self.tag_name, self.result, True)
eckhart's avatar
eckhart committed
202
        duplicate._pos = self._pos
203
        if self.has_attr():
di68kap's avatar
di68kap committed
204
205
            duplicate.attr.update(copy.deepcopy(self._xml_attr))
            # duplicate._xml_attr = copy.deepcopy(self._xml_attr)  # this is not cython compatible
eckhart's avatar
eckhart committed
206
        return duplicate
Eckhart Arnold's avatar
Eckhart Arnold committed
207

eckhart's avatar
eckhart committed
208

209
    def __str__(self):
210
211
        if isinstance(self, RootNode):
            root = cast(RootNode, self)
212
            errors = root.errors_sorted
213
214
            if errors:
                e_pos = errors[0].pos
Eckhart Arnold's avatar
Eckhart Arnold committed
215
                content = self.content
eckhart's avatar
eckhart committed
216
217
                return content[:e_pos] + ' <<< Error on "%s" | %s >>> ' % \
                    (content[e_pos - self.pos:], '; '.join(e.message for e in errors))
218
        return self.content
Eckhart Arnold's avatar
Eckhart Arnold committed
219

eckhart's avatar
eckhart committed
220

221
    def __repr__(self):
222
        # mpargs = {'name': self.parser.name, 'ptype': self.parser.ptype}
223
224
        # name, ptype = (self._tag_name.split(':') + [''])[:2]
        # parg = "MockParser({name}, {ptype})".format(name=name, ptype=ptype)
225
        rarg = str(self) if not self.children else \
226
            "(" + ", ".join(child.__repr__() for child in self.children) + ")"
227
        return "Node(%s, %s)" % (self.tag_name, rarg)
228

Eckhart Arnold's avatar
Eckhart Arnold committed
229

230
    def __len__(self):
231
232
        return (sum(len(child) for child in self.children)
                if self.children else len(self._result))
233
234
235


    def __bool__(self):
236
237
238
239
        """Returns the bool value of a node, which is always True. The reason
        for this is that a boolean test on a variable that can contain a node
        or None will only yield `False` in case of None.
        """
240
241
242
        return True


243
    def __hash__(self):
244
        return hash(self.tag_name)
245

Eckhart Arnold's avatar
Eckhart Arnold committed
246

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

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

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


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


294
    def equals(self, other: 'Node') -> bool:
295
        """
296
297
298
299
300
301
        Equality of value: Two nodes are considered as having the same value,
        if their tag name is the same, if their results are equal and
        if their attributes and attribute values are the same.

        Returns True, if the tree originating in node `self` is equal by
        value to the tree originating in node `other`.
302
303
304
305
306
307
308
309
310
311
        """
        if self.tag_name == other.tag_name and self.compare_attr(other):
            if self.children:
                return (len(self.children) == len(other.children)
                        and all(a.equals(b) for a, b in zip(self.children, other.children)))
            else:
                return self.result == other.result
        return False


312
313
314
315
316
317
318
319
320
321
322
323
324
325
    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


326
    def is_anonymous(self) -> bool:
eckhart's avatar
eckhart committed
327
328
329
330
331
332
333
334
        """Returns True, if the Node is an "anonymous" Node, i.e. a node that
        has not been created by a named parser.

        The tag name of anonymous node is a colon followed by the class name
        of the parser that created the node, i.e. ":Series". It is recommended
        practice to remove (or name) all anonymous nodes during the
        AST-transformation.
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
335
        return not self.tag_name or self.tag_name[0] == ':'
336

Eckhart Arnold's avatar
Eckhart Arnold committed
337

338
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
339
    def result(self) -> StrictResultType:
340
341
342
343
344
        """
        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.
        """
345
346
        return self._result

347

348
    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
349
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
350
        # # made obsolete by static type checking with mypy
eckhart's avatar
eckhart committed
351
352
353
354
        # assert ((isinstance(result, tuple) and all(isinstance(child, Node) for child in result))
        #         or isinstance(result, Node)
        #         or isinstance(result, str)
        #         or isinstance(result, StringView)), "%s (%s)" % (str(result), str(type(result)))
Eckhart Arnold's avatar
Eckhart Arnold committed
355
356
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
357
        # self._content = None
358
359
360
361
362
363
364
365
366
        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
367
                self._result = result  # cast(StrictResultType, result)
368

369

370
371
372
373
374
375
376
377
378
379
380
381
    def _content(self) -> List[str]:
        """
        Returns string content as list of string fragments
        that are gathered from all child nodes in order.
        """
        if self.children:
            fragments = []
            for child in self.children:
                fragments.extend(child._content())
            return fragments
        self._result = str(self._result)
        return [self._result]
382

383

384
    @property
eckhart's avatar
eckhart committed
385
    def content(self) -> str:
386
        """
387
388
389
        Returns content as string. If the node has child-nodes, the
        string content of the child-nodes is recursively read and then
        concatenated.
390
        """
391
392
393
394
395
396
397
398
        if self.children:
            fragments = []
            for child in self.children:
                fragments.extend(child._content())
            return ''.join(fragments)
        self._result = str(self._result)
        return self._result
        # unoptimized
Eckhart Arnold's avatar
Eckhart Arnold committed
399
400
        # return "".join(child.content for child in self.children) if self.children \
        #     else str(self._result)
di68kap's avatar
di68kap committed
401
402


403
    @property
404
    def pos(self) -> int:
eckhart's avatar
eckhart committed
405
406
        """Returns the position of the Node's content in the source text."""
        if self._pos < 0:
Eckhart Arnold's avatar
Eckhart Arnold committed
407
            raise AssertionError("Position value not initialized! Use Node.with_pos()")
408
409
        return self._pos

eckhart's avatar
eckhart committed
410

Eckhart Arnold's avatar
Eckhart Arnold committed
411
    def with_pos(self, pos: int) -> 'Node':
eckhart's avatar
eckhart committed
412
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
413
        Initialize position value. Usually, the parser guard
eckhart's avatar
eckhart committed
414
415
        (`parsers.add_parser_guard()`) takes care of assigning the
        position in the document to newly created nodes. However,
Eckhart Arnold's avatar
Eckhart Arnold committed
416
        when Nodes are created outside the reach of the parser
eckhart's avatar
eckhart committed
417
        guard, their document-position must be assigned manually.
Eckhart Arnold's avatar
Eckhart Arnold committed
418
419
        Position values of the child nodes are assigned recursively, too.
        Returns the node itself for convenience.
eckhart's avatar
eckhart committed
420
        """
421
422
423
424
        # condition self.pos == pos cannot be assumed when tokens or whitespace
        # are dropped early!
        # assert self._pos < 0 or self.pos == pos, ("pos mismatch %i != %i at Node: %s"
        #                                           % (self._pos, pos, repr(self)))
Eckhart Arnold's avatar
Eckhart Arnold committed
425
426
427
428
429
430
431
432
433
434
        if pos != self._pos >= 0:
            raise AssertionError("Position value cannot be reassigned to a different value!")
        if self._pos < 0:
            self._pos = pos
            # recursively adjust pos-values of all children
            offset = self.pos
            for child in self.children:
                if child._pos < 0:
                    child.with_pos(offset)
                offset = child.pos + len(child)
eckhart's avatar
eckhart committed
435
436
        return self

437

438
439
440
441
    @property
    def attr(self):
        """
        Returns a dictionary of XML-attr attached to the node.
442
443
444
445
446
447
448
449
450
451

        Examples:
            >>> node = Node(None, '')
            >>> print('Any attributes present?', node.has_attr())
            Any attributes present? False
            >>> node.attr['id'] = 'identificator'
            >>> node.attr
            OrderedDict([('id', 'identificator')])
            >>> node.attr['id']
            'identificator'
452
            >>> del node.attr['id']
453
454
455
456
457
458
459
            >>> node.attr
            OrderedDict()

        NOTE: Use `node.attr_active()` rather than bool(node.attr) to check the
        presence of any attributes. Attribute dictionaries are created lazily
        and node.attr would create a dictionary, even though it may never be
        needed any more.
460
461
462
463
464
465
466
467
468
        """
        try:
            if self._xml_attr is None:          # cython compatibility
                self._xml_attr = OrderedDict()
        except AttributeError:
            self._xml_attr = OrderedDict()
        return self._xml_attr


469
    def has_attr(self) -> bool:
eckhart's avatar
eckhart committed
470
        """
471
472
473
474
475
        Returns `True`, if the node has any attributes, `False` otherwise.

        This function does not create an attribute dictionary, therefore
        it should be prefered to querying node.attr when testing for the
        existence of any attributes.
eckhart's avatar
eckhart committed
476
477
        """
        try:
478
479
480
            # if self._xml_attr is not None:
            #     return True
            return bool(self._xml_attr)
eckhart's avatar
eckhart committed
481
482
483
484
485
        except AttributeError:
            pass
        return False


486
    def compare_attr(self, other: 'Node') -> bool:
487
        """
488
489
        Returns True, if `self` and `other` have the same attributes with the
        same attribute values.
490
        """
491
492
        if self.has_attr():
            if other.has_attr():
493
494
495
                return self.attr == other.attr
            return len(self.attr) == 0
            # self has empty dictionary and other has no attributes
496
        elif other.has_attr():
497
498
499
            return len(other.attr) == 0
            # other has empty attribute dictionary and self as no attributes
        return True  # neither self nor other have any attributes
500

Eckhart Arnold's avatar
Eckhart Arnold committed
501

502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
    def select(self, match_function: Callable, include_root: bool = False, reverse: bool = False) \
            -> Iterator['Node']:
        """
        Finds nodes in the tree that fulfill a given criterion.

        `select` is a generator that yields all nodes for which the
        given `match_function` evaluates to True. The tree is
        traversed pre-order.

        See function `Node.select_by_tag` for some examples.

        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
            include_root (bool): If False, only descendant nodes will be
                checked for a match.
            reverse (bool): If True, the tree will be walked in reverse
                order, i.e. last children first.
        Yields:
            Node: All nodes of the tree for which
            ``match_function(node)`` returns True
        """
        if include_root and match_function(self):
            yield self
        child_iterator = reversed(self.children) if reverse else self.children
        for child in child_iterator:
            if match_function(child):
                yield child
            yield from child.select(match_function, False, reverse)
        # The above variant is slightly faster
        # for child in child_iterator:
        #     yield from child.select(match_function, True, reverse)


    def select_by_tag(self, tag_names: Union[str, AbstractSet[str]],
                      include_root: bool = False) -> Iterator['Node']:
        """
        Returns an iterator that runs through all descendants that have one
        of the given tag names.

        Examples::

            >>> tree = parse_sxpr('(a (b "X") (X (c "d")) (e (X "F")))')
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag("X", False))
            ['(X (c "d"))', '(X "F")']
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag({"X", "b"}, False))
            ['(b "X")', '(X (c "d"))', '(X "F")']
            >>> any(tree.select_by_tag('a', False))
            False
            >>> list(flatten_sxpr(item.as_sxpr()) for item in tree.select_by_tag('a', True))
            ['(a (b "X") (X (c "d")) (e (X "F")))']
            >>> flatten_sxpr(next(tree.select_by_tag("X", False)).as_sxpr())
            '(X (c "d"))'

        Args:
eckhart's avatar
eckhart committed
557
            tag_names(set): A tag name or set of tag names that is being
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
                searched for
            include_root (bool): If False, only descendant nodes will be
                checked for a match.
        Yields:
            Node: All nodes which have a given tag name.
        """
        if isinstance(tag_names, str):
            tag_names = frozenset({tag_names})
        return self.select(lambda node: node.tag_name in tag_names, include_root)


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


    def tree_size(self) -> int:
        """
        Recursively counts the number of nodes in the tree including the root node.
        """
        return sum(child.tree_size() for child in self.children) + 1

    #
    # serialization methods
    #

594
    def _tree_repr(self, tab, open_fn, close_fn, data_fn=lambda i: i,
595
                   density=0, inline=False, inline_fn=lambda node: False) -> str:
596
597
598
599
600
601
602
603
        """
        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.

604
        Args:
605
            tab (str):  The indentation string, e.g. '\t' or '    '
eckhart's avatar
eckhart committed
606
            open_fn:   (Node->str) A function that returns an opening
607
                string (e.g. an XML-tag_name) for a given node
eckhart's avatar
eckhart committed
608
            close_fn:  (Node->str) A function that returns a closeF
609
                string (e.g. an XML-tag_name) for a given node.
eckhart's avatar
eckhart committed
610
            data_fn:   (str->str) A function that filters the data string
611
612
613
614
615
616
                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
617
618
        head = open_fn(self)
        tail = close_fn(self)
619
620

        if not self.result:
621
            return head.rstrip() + tail.lstrip()
622

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

625
        inline = inline or inline_fn(self)
626
627
628
629
630
        if inline:
            head = head.rstrip()
            tail = tail.lstrip()
            usetab, sep = '', ''
        else:
eckhart's avatar
eckhart committed
631
632
            usetab = tab if head else ''    # no indentation if tag is already omitted
            sep = '\n'
633

634
635
        if self.children:
            content = []
636
            for child in self.children:
637
                subtree = child._tree_repr(tab, open_fn, close_fn, data_fn,
638
                                           density, inline, inline_fn)
eckhart's avatar
eckhart committed
639
                if subtree:
eckhart's avatar
eckhart committed
640
641
                    st = [subtree] if inline else subtree.split('\n')
                    content.append((sep + usetab).join(s for s in st))
642
            return head + usetab + (sep + usetab).join(content) + tail
643

eckhart's avatar
eckhart committed
644
        res = self.content
eckhart's avatar
eckhart committed
645
        if not inline and not head:
eckhart's avatar
eckhart committed
646
            # strip whitespace for omitted non inline node, e.g. CharData in mixed elements
eckhart's avatar
eckhart committed
647
            res = res.strip()
648
649
        if density & 1 and res.find('\n') < 0:  # and head[0] == "<":
            # except for XML, add a gap between opening statement and content
650
            gap = ' ' if not inline and head and head.rstrip()[-1:] != '>' else ''
eckhart's avatar
eckhart committed
651
            return head.rstrip() + gap + data_fn(res) + tail.lstrip()
652
        else:
653
            return head + '\n'.join([usetab + data_fn(s) for s in res.split('\n')]) + tail
654

Eckhart Arnold's avatar
Eckhart Arnold committed
655

656
    def as_sxpr(self, src: Optional[str] = None,
657
                indentation: int = 2,
658
                compact: bool = False,
eckhart's avatar
eckhart committed
659
                flatten_threshold: int = 92) -> str:
660
        """
661
        Returns content as S-expression, i.e. in lisp-like form. If this
eckhart's avatar
eckhart committed
662
        method is called on a RootNode-object,
663

664
        Args:
665
666
            src:  The source text or `None`. In case the source text is
                given the position of the element in the text will be
667
668
669
                reported as position, line, column. In case the empty string is
                given rather than None, only the position value will be
                reported in case it has been initialized, i.e. pos >= 0.
670
671
            indentation: The number of whitespaces for indentation
            compact:  If True, a compact representation is returned where
672
                brackets are omitted and only the indentation indicates the
Eckhart Arnold's avatar
Eckhart Arnold committed
673
                tree structure.
674
675
676
            flatten_threshold:  Return the S-expression in flattened form if
                the flattened expression does not exceed the threshold length.
                A negative number means that it will always be flattened.
677
678
        """

eckhart's avatar
eckhart committed
679
        left_bracket, right_bracket, density = ('', '', 1) if compact else ('(', '\n)', 0)
eckhart's avatar
eckhart committed
680
        lbreaks = linebreaks(src) if src else []  # type: List[int]
681
        root = cast(RootNode, self) if isinstance(self, RootNode) else None  # type: Optional[RootNode]
682

683
        def opening(node: Node) -> str:
eckhart's avatar
eckhart committed
684
            """Returns the opening string for the representation of `node`."""
eckhart's avatar
eckhart committed
685
            txt = [left_bracket, node.tag_name]
686
            # s += " '(pos %i)" % node.add_pos
687
            # txt.append(str(id(node)))  # for debugging
688
            if node.has_attr():
689
                txt.extend(' `(%s "%s")' % (k, v) for k, v in node.attr.items())
690
            if src:
691
                line, col = line_col(lbreaks, node.pos)
692
693
694
                txt.append(' `(pos %i %i %i)' % (node.pos, line, col))
            elif src is not None and node._pos >= 0:
                txt.append(' `(pos %i)' % node.pos)
695
696
            if root and id(node) in root.error_nodes:
                txt.append(" `(err `%s)" % ' '.join(str(err) for err in root.get_errors(node)))
697
            return "".join(txt) + '\n'
698

699
        def closing(node: Node) -> str:
eckhart's avatar
eckhart committed
700
701
            """Returns the closing string for the representation of `node`."""
            return right_bracket
702

703
        def pretty(strg: str) -> str:
eckhart's avatar
eckhart committed
704
705
706
707
            """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'\"')
708

709
        sxpr = self._tree_repr(' ' * indentation, opening, closing, pretty, density=density)
eckhart's avatar
eckhart committed
710
        return sxpr if compact else flatten_sxpr(sxpr, flatten_threshold)
Eckhart Arnold's avatar
Eckhart Arnold committed
711

eckhart's avatar
eckhart committed
712

713
714
    def as_xml(self, src: str = None,
               indentation: int = 2,
eckhart's avatar
eckhart committed
715
716
717
               inline_tags: Set[str] = frozenset(),
               omit_tags: Set[str] = frozenset(),
               empty_tags: Set[str] = frozenset()) -> str:
718
719
720
        """
        Returns content as XML-tree.

721
        Args:
722
723
            src:  The source text or `None`. In case the source text is given,
                the position will also be reported as line and column.
724
            indentation: The number of whitespaces for indentation
725
726
727
            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
728
                neither the opening tag nor its attr nor the closing tag. This
729
730
731
                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.
732
733
            empty_tags:  A set of tags which shall be rendered as empty elements, e.g.
                "<empty/>" instead of "<empty><empty>".
734
        """
735
        root = cast(RootNode, self) if isinstance(self, RootNode) else None  # type: Optional[RootNode]
736

737
        def opening(node: Node) -> str:
738
739
740
            """Returns the opening string for the representation of `node`."""
            if node.tag_name in omit_tags:
                return ''
eckhart's avatar
eckhart committed
741
            txt = ['<', node.tag_name]
742
            has_reserved_attrs = node.has_attr() \
eckhart's avatar
eckhart committed
743
                and any(r in node.attr for r in {'err', 'line', 'col'})
744
            if node.has_attr():
745
                txt.extend(' %s="%s"' % (k, v) for k, v in node.attr.items())
746
            if src and not has_reserved_attrs:
eckhart's avatar
eckhart committed
747
                txt.append(' line="%i" col="%i"' % line_col(line_breaks, node.pos))
748
            if src == '' and not (node.has_attr() and '_pos' in node.attr) and node.pos >= 0:
749
                txt.append(' _pos="%i"' % node.pos)
750
            if root and id(node) in root.error_nodes and not has_reserved_attrs:
eckhart's avatar
eckhart committed
751
                txt.append(' err="%s"' % ''.join(str(err).replace('"', r'\"')
eckhart's avatar
eckhart committed
752
                                                 for err in root.get_errors(node)))
753
754
755
            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
756
                ending = "/>\n" if not node.tag_name[0] == '?' else "?>\n"
757
758
759
            else:
                ending = ">\n"
            return "".join(txt + [ending])
760

761
        def closing(node: Node):
762
            """Returns the closing string for the representation of `node`."""
763
            if node.tag_name in omit_tags or node.tag_name in empty_tags:
764
                return ''
eckhart's avatar
eckhart committed
765
            return '\n</' + node.tag_name + '>'
766

767
768
769
770
771
772
        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

773
        def inlining(node: Node):
774
775
776
777
            """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
778
            return node.tag_name in inline_tags \
779
                or (node.has_attr()
eckhart's avatar
eckhart committed
780
                    and node.attr.get('xml:space', 'default') == 'preserve')
781

782
        line_breaks = linebreaks(src) if src else []
783
        return self._tree_repr(' ' * indentation, opening, closing, sanitizer,
784
                               density=1, inline_fn=inlining)
785

Eckhart Arnold's avatar
Eckhart Arnold committed
786

787
    def to_json_obj(self) -> Dict:
eckhart's avatar
eckhart committed
788
        """Serialize a node or tree as json-object"""
Eckhart Arnold's avatar
Eckhart Arnold committed
789
790
791
        data = [self.tag_name,
                [child.to_json_obj() for child in self.children]
                if self.children else str(self._result)]
792
        has_attr = self.has_attr()
793
794
795
796
        if self._pos >= 0 or has_attr:
            data.append(self._pos)
        if has_attr:
            data.append(dict(self._xml_attr))
eckhart's avatar
eckhart committed
797
        return {'__class__': 'DHParser.Node', 'data': data}
798
799


800
801
    @staticmethod
    def from_json_obj(json_obj: Dict) -> 'Node':
802
803
804
805
806
807
        """Convert a json object representing a node (or tree) back into a
        Node object. Raises a ValueError, if `json_obj` does not represent
        a node."""
        if json_obj.get('__class__', '') != 'DHParser.Node':
            raise ValueError('JSON object: ' + str(json_obj) +
                             ' does not represent a Node object.')
808
        tag_name, result, pos, attr = (json_obj['data'] + [-1, None])[:4]
809
        if isinstance(result, str):
810
811
812
813
814
815
816
            leafhint = True
        else:
            leafhint = False
            result = tuple(Node.from_json_obj(child) for child in result)
        node = Node(tag_name, result, leafhint)
        node._pos = pos
        if attr:
817
            node.attr.update(attr)
818
        return node
819

820
821
822
823
    def as_json(self, indent: Optional[int] = 2, ensure_ascii=False) -> str:
        return json.dumps(self.to_json_obj(), indent=indent, ensure_ascii=ensure_ascii,
                          separators=(', ', ': ') if indent is not None else (',', ':'))

824

eckhart's avatar
eckhart committed
825
def serialize(node: Node, how: str = 'default') -> str:
826
    """
827
    Serializes the tree starting with `node` either as S-expression, XML, JSON,
828
    or in compact form. Possible values for `how` are 'S-expression',
829
    'XML', 'JSON', 'compact' accordingly, or 'AST', 'CST', 'default' in which case
830
831
832
833
834
835
836
837
838
839
840
841
    the value of respective configuration variable determines the
    serialization format. (See module `configuration.py`.)
    """
    switch = how.lower()

    if switch == 'ast':
        switch = get_config_value('ast_serialization').lower()
    elif switch == 'cst':
        switch = get_config_value('cst_serialization').lower()
    elif switch == 'default':
        switch = get_config_value('default_serialization').lower()

842
    if switch == SXPRESSION_SERIALIZATION.lower():
843
        return node.as_sxpr(flatten_threshold=get_config_value('flatten_sxpr_threshold'))
844
    elif switch == XML_SERIALIZATION.lower():
845
        return node.as_xml()
846
    elif switch == JSON_SERIALIZATION.lower():
847
        return node.as_json()
848
    elif switch == COMPACT_SERIALIZATION.lower():
849
850
        return node.as_sxpr(compact=True)
    else:
851
852
        raise ValueError('Unknown serialization %s. Allowed values are either: %s or : %s'
                         % (how, "'ast', 'cst', 'default'", ", ".join(list(SERIALIZATIONS))))
853
854


855
class FrozenNode(Node):
856
857
858
859
860
861
862
863
864
865
    """
    FrozenNode is an immutable kind of Node, i.e. it must not be changed
    after initialization. The purpose is mainly to allow certain kinds of
    optimization, like not having to instantiate empty nodes (because they
    are always the same and will be dropped while parsing, anyway).

    Frozen nodes must be used only temporarily during parsing or
    tree-transformation and should not occur in the product of the
    transformation any more. This can be verified with `tree_sanity_check()`.
    """
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882

    def __init__(self, tag_name: str, result: ResultType) -> None:
        if isinstance(result, str) or isinstance(result, StringView):
            result = str(result)
        else:
            raise TypeError('FrozenNode only accepts string as results. '
                            '(Only leaf-nodes can be frozen nodes.)')
        super(FrozenNode, self).__init__(tag_name, result, True)

    @property
    def result(self) -> StrictResultType:
        return self._result

    @result.setter
    def result(self, result: ResultType):
        raise TypeError('FrozenNode does not allow re-assignment of results.')

eckhart's avatar
eckhart committed
883
884
885
886
    @property
    def attr(self):
        raise AssertionError("Attributes cannot be accessed on a frozen node")

Eckhart Arnold's avatar
Eckhart Arnold committed
887
    def with_pos(self, pos: int) -> 'Node':
888
889
890
        pass


891
PLACEHOLDER = FrozenNode('__PLACEHOLDER__', '')
di68kap's avatar
di68kap committed
892
893


894
def tree_sanity_check(tree: Node) -> bool:
895
896
897
898
899
900
901
902
903
    """
    Sanity check for syntax trees: One and the same node must never appear
    twice in the syntax tree. Frozen Nodes (EMTPY_NODE, PLACEHOLDER)
    should only exist temporarily and must have been dropped or eliminated
    before any kind of tree generation (i.e. parsing) or transformation
    is finished.
    :param tree: the root of the tree to be checked
    :return: True, if the tree is `sane`, False otherwise.
    """
904
    node_set = set()  # type: Set[Node]
905
    for node in tree.select(lambda nd: True, include_root=True):
906
        if node in node_set or isinstance(Node, FrozenNode):
907
908
909
910
911
            return False
        node_set.add(node)
    return True


di68kap's avatar
di68kap committed
912
class RootNode(Node):
913
914
915
916
917
918
919
920
921
922
923
924
    """The root node for the syntax tree is a special kind of node that keeps
    and manages global properties of the tree as a whole. These are first and
    foremost the list off errors that occurred during tree generation
    (i.e. parsing) or any transformation of the tree. Other properties concern
    the customization of the XML-serialization.

    The root node can be instantiated before the tree is fully parsed. This is
    necessary, because the root node is needed for managing error messages
    during the parsing process, already. In order to connect the root node to
    the tree, when parsing is finished, the swallow()-method must be called.

        errors (list):  A list of all errors that have occurred so far during
925
926
                processing (i.e. parsing, AST-transformation, compiling)
                of this tree.
di68kap's avatar
di68kap committed
927

928
929
930
931
932
933
        error_nodes (dict): A mapping of node-ids to a list of errors that
                occurred on the node with the respective id.

        error_positions (dict): A mapping of locations to a set of ids of
                nodes that contain an error at that particular location

934
935
        error_flag (int):  the highest warning or error level of all errors
                that occurred.
936
937
938
939
940
941

        inline_tags (set of strings): see `Node.as_xml()` for an explanation.

        omit_tags (set of strings): see `Node.as_xml()` for an explanation.

        empty_tags (set oif strings): see `Node.as_xml()` for an explanation.
di68kap's avatar
di68kap committed
942
    """
943

eckhart's avatar
eckhart committed
944
    def __init__(self, node: Optional[Node] = None):
945
        super().__init__('__not_yet_ready__', '')
946
        self.errors = []               # type: List[Error]
947
948
        self.error_nodes = dict()      # type: Dict[int, List[Error]]  # id(node) -> error list
        self.error_positions = dict()  # type: Dict[int, Set[int]]  # pos -> set of id(node)
di68kap's avatar
di68kap committed
949
        self.error_flag = 0
eckhart's avatar
eckhart committed
950
951
        if node is not None:
            self.swallow(node)
952
        # customization for XML-Representation
eckhart's avatar
eckhart committed
953
        self.inline_tags = set()  # type: Set[str]
954
955
        self.omit_tags = set()    # type: Set[str]
        self.empty_tags = set()   # type: Set[str]
di68kap's avatar
di68kap committed
956

957
958
959
960
961
962
963
964
965
    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._pos = self._pos
966
        if self.has_attr():
di68kap's avatar
di68kap committed
967
            duplicate.attr.update(copy.deepcopy(self._xml_attr))
968
            # duplicate._xml_attr = copy.deepcopy(self._xml_attr)  # this is blocked by cython
969
        duplicate.errors = copy.copy(self.errors)
970
971
        duplicate.error_nodes = copy.copy(self.error_nodes)
        duplicate.error_positions = copy.deepcopy(self.error_positions)
972
973
974
975
        duplicate.error_flag = self.error_flag
        duplicate.inline_tags = self.inline_tags
        duplicate.omit_tags = self.omit_tags
        duplicate.empty_tags = self.empty_tags
976
        duplicate.tag_name = self.tag_name
977
978
<