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

syntaxtree.py 16.7 KB
Newer Older
1
"""syntaxtree.py - syntax tree classes for DHParser
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

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

19
import copy
20
import os
21 22
from functools import partial

23 24 25 26
try:
    import regex as re
except ImportError:
    import re
27 28 29 30 31 32
try:
    from typing import AbstractSet, Any, ByteString, Callable, cast, Container, Dict, \
        Iterator, List, NamedTuple, Sequence, Union, Text, Tuple
except ImportError:
    from .typing34 import AbstractSet, Any, ByteString, Callable, cast, Container, Dict, \
        Iterator, List, NamedTuple, Sequence, Union, Text, Tuple
33

34
from DHParser.toolkit import log_dir, line_col
35

Eckhart Arnold's avatar
Eckhart Arnold committed
36

37 38
__all__ = ['WHITESPACE_PTYPE',
           'TOKEN_PTYPE',
Eckhart Arnold's avatar
Eckhart Arnold committed
39
           'ZOMBIE_PARSER',
Eckhart Arnold's avatar
Eckhart Arnold committed
40
           'ParserBase',
Eckhart Arnold's avatar
Eckhart Arnold committed
41 42
           'Error',
           'Node',
43
           'TransformationFunc']
Eckhart Arnold's avatar
Eckhart Arnold committed
44 45


Eckhart Arnold's avatar
Eckhart Arnold committed
46 47 48 49 50 51 52 53 54 55
class ParserBase:
    """
    ParserBase is the base class for all real and mock parser classes.
    It is defined here, because Node objects require a parser object
    for instantiation.
    """
    def __init__(self, name=''):  # , pbases=frozenset()):
        self.name = name  # type: str
        self._ptype = ':' + self.__class__.__name__  # type: str

56 57 58
    def __repr__(self):
        return self.name + self.ptype

Eckhart Arnold's avatar
Eckhart Arnold committed
59
    def __str__(self):
60
        return self.name + (' = ' if self.name else '') + repr(self)
Eckhart Arnold's avatar
Eckhart Arnold committed
61 62 63 64 65

    @property
    def ptype(self) -> str:
        return self._ptype

66 67 68
    @property
    def repr(self) -> str:
        return self.name if self.name else repr(self)
Eckhart Arnold's avatar
Eckhart Arnold committed
69

70

71 72 73 74
WHITESPACE_PTYPE = ':Whitespace'
TOKEN_PTYPE = ':Token'


Eckhart Arnold's avatar
Eckhart Arnold committed
75
class MockParser(ParserBase):
76 77
    """
    MockParser objects can be used to reconstruct syntax trees from a
Eckhart Arnold's avatar
Eckhart Arnold committed
78 79
    serialized form like S-expressions or XML. Mock objects can mimic
    different parser types by assigning them a ptype on initialization.
80 81 82 83 84
    
    Mock objects should not be used for anything other than 
    syntax tree (re-)construction. In all other cases where a parser
    object substitute is needed, chose the singleton ZOMBIE_PARSER.
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
85
    def __init__(self, name='', ptype=''):  # , pbases=frozenset()):
86
        assert not ptype or ptype[0] == ':'
Eckhart Arnold's avatar
Eckhart Arnold committed
87
        super(MockParser, self).__init__(name)
88
        self.name = name
Eckhart Arnold's avatar
Eckhart Arnold committed
89
        self._ptype = ptype or ':' + self.__class__.__name__
90 91 92


class ZombieParser(MockParser):
93 94 95 96 97 98 99 100 101 102 103 104
    """
    Serves as a substitute for a Parser instance.

    ``ZombieParser`` is the class of the singelton object
    ``ZOMBIE_PARSER``. The  ``ZOMBIE_PARSER`` has a name and can be
    called, but it never matches. It serves as a substitute where only
    these (or one of these properties) is needed, but no real Parser-
    object is instantiated.
    """
    alive = False

    def __init__(self):
105
        super(ZombieParser, self).__init__("__ZOMBIE__")
106 107 108 109
        assert not self.__class__.alive, "There can be only one!"
        assert self.__class__ == ZombieParser, "No derivatives, please!"
        self.__class__.alive = True

Eckhart Arnold's avatar
Eckhart Arnold committed
110 111 112 113 114 115
    def __copy__(self):
        return self

    def __deepcopy__(self, memo):
        return self

116 117 118 119
    def __call__(self, text):
        """Better call Saul ;-)"""
        return None, text

120 121 122 123

ZOMBIE_PARSER = ZombieParser()


124 125 126 127 128
# # Python 3.6:
# class Error(NamedTuple):
#     pos: int
#     msg: str
Error = NamedTuple('Error', [('pos', int), ('msg', str)])
129

130 131 132
ChildrenType = Tuple['Node', ...]
StrictResultType = Union[ChildrenType, str]
ResultType = Union[ChildrenType, 'Node', str, None]
133 134


135 136 137 138 139 140 141 142 143 144 145 146
class Node:
    """
    Represents a node in the concrete or abstract syntax tree.

    Attributes:
        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
        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.
        children (tuple):  The tuple of child nodes or an empty tuple
            if there are no child nodes. READ ONLY!
147 148 149 150 151 152
        parser (Parser):  The parser which generated this node. 
            WARNING: In case you use mock syntax trees for testing or
            parser replacement during the AST-transformation: DO NOT
            rely on this being a real parser object in any phase after 
            parsing (i.e. AST-transformation and compiling), for 
            example by calling ``isinstance(node.parer, ...)``.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
        errors (list):  A list of parser- or compiler-errors:
            tuple(position, string) attached to this node
        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
            the length before AST-transformation ans will never change
            through AST-transformation. READ ONLY!
        pos (int):  the position of the node within the parsed text.

            The value of ``pos`` is -1 meaning invalid by default. 
            Setting this value will set the positions of all child
            nodes relative to this value.  

            To set the pos values of all nodes in a syntax tree, the
            pos value of the root node should be set to 0 right 
            after parsing.

            Other than that, this value should be considered READ ONLY. 
            At any rate, it should only be reassigned only during
            parsing stage and never during or after the
            AST-transformation.
    """
175

Eckhart Arnold's avatar
Eckhart Arnold committed
176
    def __init__(self, parser, result: ResultType) -> None:
177 178 179
        """Initializes the ``Node``-object with the ``Parser``-Instance
        that generated the node and the parser's result.
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
180 181
        # self._result = ''  # type: StrictResultType
        # self._children = ()  # type: ChildrenType
182
        self._errors = []  # type: List[str]
183
        self.result = result
Eckhart Arnold's avatar
Eckhart Arnold committed
184 185 186
        self._len = len(result) if not self._children else \
            sum(child._len for child in self._children)  # type: int
        # self.pos: int  = 0  # continuous updating of pos values wastes a lot of time
187
        self._pos = -1  # type: int
188
        self.parser = parser or ZOMBIE_PARSER
Eckhart Arnold's avatar
Eckhart Arnold committed
189 190
        self.error_flag = any(r.error_flag for r in self._children) \
            if self._children else False  # type: bool
191 192 193

    def __str__(self):
        if self.children:
194
            return "".join(str(child) for child in self.children)
195 196 197 198 199 200 201 202
        return str(self.result)

    def __repr__(self):
        mpargs = {'name': self.parser.name, 'ptype': self.parser.ptype}
        parg = "MockParser({name}, {ptype})".format(**mpargs)
        rarg = str(self) if not self.children else \
               "(" + ", ".join(repr(child) for child in self.children) + ")"
        return "Node(%s, %s)" % (parg, rarg)
203

204
    def __eq__(self, other):
205 206
        # return str(self.parser) == str(other.parser) and self.result == other.result
        return self.tag_name == other.tag_name and self.result == other.result
207

208
    def __hash__(self):
209
        return hash(self.tag_name)
210 211 212 213 214 215 216

    def __deepcopy__(self, memodict={}):
        result = copy.deepcopy(self.result)
        other = Node(self.parser, result)
        other._pos = self._pos
        return other

217
    @property   # this needs to be a (dynamic) property, in case sef.parser gets updated
218
    def tag_name(self) -> str:
219
        return self.parser.name or self.parser.ptype
220 221

    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
222
    def result(self) -> StrictResultType:
223 224 225
        return self._result

    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
226
    def result(self, result: ResultType):
227 228 229 230
        # # made obsolete by static type checking with mypy is done
        # 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
231
        self._result = (result,) if isinstance(result, Node) else result or ''  # type: StrictResultType
232
        self._children = cast(ChildrenType, self._result) \
Eckhart Arnold's avatar
Eckhart Arnold committed
233
            if isinstance(self._result, tuple) else cast(ChildrenType, ())  # type: ChildrenType
234 235

    @property
236
    def children(self) -> ChildrenType:
237 238 239
        return self._children

    @property
240
    def len(self) -> int:
241
        # DEBUGGING:  print(self.tag_name, str(self.pos), str(self._len), str(self)[:10].replace('\n','.'))
242 243 244
        return self._len

    @property
245
    def pos(self) -> int:
246 247 248 249
        assert self._pos >= 0, "position value not initialized!"
        return self._pos

    @pos.setter
250 251
    def pos(self, pos: int):
        # assert isinstance(pos, int)
252 253 254 255 256 257 258
        self._pos = pos
        offset = 0
        for child in self.children:
            child.pos = pos + offset
            offset += child.len

    @property
259
    def errors(self) -> List[Error]:
260 261
        return [Error(self.pos, err) for err in self._errors]

262 263
    def show(self) -> str:
        """Returns content as string, inserting error messages where
264
        errors occurred.
265
        """
266
        s = "".join(child.show() for child in self.children) if self.children \
267 268 269
            else str(self.result)
        return (' <<< Error on "%s" | %s >>> ' % (s, '; '.join(self._errors))) if self._errors else s

270
    def _tree_repr(self, tab, openF, closeF, dataF=lambda s: s) -> str:
271 272 273 274 275 276 277 278
        """
        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.

279
        Args:
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
            tab (str):  The indentation string, e.g. '\t' or '    '
            openF:  (Node->str) A function that returns an opening
                string (e.g. an XML-tag_name) for a given node
            closeF:  (Node->str) A function that returns a closeF
                string (e.g. an XML-tag_name) for a given node.
            dataF:  (str->str) A function that filters the data string
                before printing, e.g. to add quotation marks

        Returns (str):
            A string that contains a (serialized) tree representation
            of the node and its children.
        """
        head = openF(self)
        tail = closeF(self)

        if not self.result:
            return head + tail

        head = head + '\n'  # place the head, tail and content
        tail = '\n' + tail  # of the node on different lines

        if self.children:
            content = []
303
            for child in self.children:
304 305 306 307
                subtree = child._tree_repr(tab, openF, closeF, dataF).split('\n')
                content.append('\n'.join((tab + s) for s in subtree))
            return head + '\n'.join(content) + tail

308 309
        res = cast(str, self.result)  # safe, because if there are no children, result is a string
        if head[0] == "<" and res.find('\n') < 0:
310 311 312
            # for XML: place tags for leaf-nodes on one line if possible
            return head[:-1] + self.result + tail[1:]
        else:
313
            return head + '\n'.join([tab + dataF(s) for s in res.split('\n')]) + tail
314

315
    def as_sxpr(self, src: str=None) -> str:
316 317 318
        """
        Returns content as S-expression, i.e. in lisp-like form.

319
        Args:
320 321 322 323 324
            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.
        """

325
        def opening(node) -> str:
326 327 328
            s = '(' + node.tag_name
            # s += " '(pos %i)" % node.pos
            if src:
Eckhart Arnold's avatar
Eckhart Arnold committed
329
                s += " '(pos %i " % node.pos + " %i %i)" % line_col(src, node.pos)
330 331 332 333 334 335 336 337 338 339
            if node.errors:
                s += " '(err '(%s))" % ' '.join(str(err).replace('"', r'\"')
                                                for err in node.errors)
            return s

        def pretty(s):
            return '"%s"' % s if s.find('"') < 0 \
                else "'%s'" % s if s.find("'") < 0 \
                else '"%s"' % s.replace('"', r'\"')

340
        return self._tree_repr('    ', opening, lambda node: ')', pretty)
341

342
    def as_xml(self, src: str=None) -> str:
343 344 345
        """
        Returns content as XML-tree.

346
        Args:
347 348 349 350 351
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
        """

352
        def opening(node) -> str:
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
            s = '<' + node.tag_name
            # s += ' pos="%i"' % node.pos
            if src:
                s += ' line="%i" col="%i"' % line_col(src, node.pos)
            if node.errors:
                s += ' err="%s"' % ''.join(str(err).replace('"', r'\"') for err in node.errors)
            s += ">"
            return s

        def closing(node):
            s = '</' + node.tag_name + '>'
            return s

        return self._tree_repr('    ', opening, closing)

368
    def add_error(self, error_str) -> 'Node':
369 370 371 372
        self._errors.append(error_str)
        self.error_flag = True
        return self

373 374
    def propagate_error_flags(self) -> None:
        """Recursively propagates error flags set on child nodes to its
375 376 377 378 379
        parents. This can be used if errors are added to descendant 
        nodes after syntaxtree construction, i.e. in the compile phase.
        """
        for child in self.children:
            child.propagate_error_flags()
380
            self.error_flag = self.error_flag or child.error_flag
381

382
    def collect_errors(self, clear_errors=False) -> List[Error]:
383 384 385 386 387
        """
        Returns all errors of this node or any child node in the form
        of a set of tuples (position, error_message), where position
        is always relative to this node.
        """
388 389 390 391 392
        errors = self.errors
        if clear_errors:
            self._errors = []
            self.error_flag = False
        if self.children:
393
            for child in self.children:
394
                errors.extend(child.collect_errors(clear_errors))
395
        return errors
396

Eckhart Arnold's avatar
Eckhart Arnold committed
397 398 399
    def log(self, log_file_name):
        st_file_name = log_file_name
        with open(os.path.join(log_dir(), st_file_name), "w", encoding="utf-8") as f:
400
            f.write(self.as_sxpr())
401

402
    def find(self, match_function: Callable) -> Iterator['Node']:
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
        """Finds nodes in the tree that match a specific criterion.
        
        ``find`` is a generator that yields all nodes for which the
        given ``match_function`` evaluates to True. The tree is 
        traversed pre-order.
        
        Args:
            match_function (function): A function  that takes as Node
                object as argument and returns True or False
        Yields:
            Node: all nodes of the tree for which 
            ``match_function(node)`` returns True
        """
        if match_function(self):
            yield self
        else:
            for child in self.children:
                for nd in child.find(match_function):
                    yield nd

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
    # def range(self, match_first, match_last):
    #     """Iterates over the range of nodes, starting from the first
    #     node for which ``match_first`` becomes True until the first node
    #     after this one for which ``match_last`` becomes true or until
    #     the end if it never does.
    #
    #     Args:
    #         match_first (function): A function  that takes as Node
    #             object as argument and returns True or False
    #         match_last (function): A function  that takes as Node
    #             object as argument and returns True or False
    #     Yields:
    #         Node: all nodes of the tree for which
    #         ``match_function(node)`` returns True
    #     """


440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
    # def navigate(self, path):
    #     """Yields the results of all descendant elements matched by
    #     ``path``, e.g.
    #     'd/s' yields 'l' from (d (s l)(e (r x1) (r x2))
    #     'e/r' yields 'x1', then 'x2'
    #     'e'   yields (r x1)(r x2)
    #
    #     Args:
    #         path (str):  The path of the object, e.g. 'a/b/c'. The
    #             components of ``path`` can be regular expressions
    #
    #     Returns:
    #         The object at the path, either a string or a Node or
    #         ``None``, if the path did not match.
    #     """
    #     def nav(node, pl):
    #         if pl:
    #             return itertools.chain(nav(child, pl[1:]) for child in node.children
    #                                    if re.match(pl[0], child.tag_name))
    #         else:
    #             return self.result,
    #     return nav(path.split('/'))
462 463


464
TransformationFunc = Union[Callable[[Node], Any], partial]