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

Eckhart Arnold's avatar
Eckhart Arnold committed
19
import collections.abc
20
import copy
21
import os
22 23
from functools import partial

24 25 26 27
try:
    import regex as re
except ImportError:
    import re
28 29
try:
    from typing import AbstractSet, Any, ByteString, Callable, cast, Container, Dict, \
Eckhart Arnold's avatar
Eckhart Arnold committed
30
        Iterator, Iterable, List, NamedTuple, Sequence, Union, Text, Tuple, Hashable
31 32
except ImportError:
    from .typing34 import AbstractSet, Any, ByteString, Callable, cast, Container, Dict, \
Eckhart Arnold's avatar
Eckhart Arnold committed
33
        Iterator, Iterable, List, NamedTuple, Sequence, Union, Text, Tuple, Hashable
34

35 36 37 38
from DHParser.toolkit import is_logging, log_dir, linebreaks, line_col, identity
from DHParser.base import MockParser, ZOMBIE_PARSER, Error, StringView

__all__ = ('Node',
39 40
           'mock_syntax_tree',
           'TransformationFunc')
Eckhart Arnold's avatar
Eckhart Arnold committed
41 42


43
ChildrenType = Tuple['Node', ...]
44 45
StrictResultType = Union[ChildrenType, StringView, str]
ResultType = Union[ChildrenType, 'Node', StringView, str, None]
46 47


Eckhart Arnold's avatar
Eckhart Arnold committed
48 49
def flatten_sxpr(sxpr: str) -> str:
    """Returns S-expression `sxpr` as a one-liner without unnecessary
Eckhart Arnold's avatar
Eckhart Arnold committed
50 51 52
    whitespace.

    Example:
Eckhart Arnold's avatar
Eckhart Arnold committed
53
    >>> flatten_sxpr('(a\\n    (b\\n        c\\n    )\\n)\\n')
Eckhart Arnold's avatar
Eckhart Arnold committed
54 55 56 57 58
    '(a (b c))'
    """
    return re.sub('\s(?=\))', '', re.sub('\s+', ' ', sxpr)).strip()


Eckhart Arnold's avatar
Eckhart Arnold committed
59
class Node(collections.abc.Sized):
60 61 62 63 64 65 66 67 68 69 70
    """
    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!
71 72 73 74 75 76
        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, ...)``.
77 78
        errors (list):  A list of parser- or compiler-errors:
            tuple(position, string) attached to this node
79 80 81
        error_flag (int):  0 if no error occurred in either the node
            itself or any of its descendants. Otherwise contains the
            highest warning or error level or all errors that occurred.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
        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.
    """
102

103 104
    __slots__ = ['_result', 'children', '_errors', '_len', '_pos', 'parser', 'error_flag']

105

Eckhart Arnold's avatar
Eckhart Arnold committed
106
    def __init__(self, parser, result: ResultType) -> None:
107 108 109
        """Initializes the ``Node``-object with the ``Parser``-Instance
        that generated the node and the parser's result.
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
110
        # self._result = ''  # type: StrictResultType
111
        # self.children = ()  # type: ChildrenType
112
        self.error_flag = 0   # type: bool
113
        self._errors = []  # type: List[Error]
114
        self.result = result
Eckhart Arnold's avatar
Eckhart Arnold committed
115
        self._len = len(self._result) if not self.children else \
116
            sum(child._len for child in self.children)  # type: int
Eckhart Arnold's avatar
Eckhart Arnold committed
117
        # self.pos: int  = 0  # continuous updating of pos values wastes a lot of time
118
        self._pos = -1  # type: int
119 120
        self.parser = parser or ZOMBIE_PARSER

Eckhart Arnold's avatar
Eckhart Arnold committed
121

122 123
    def __str__(self):
        if self.children:
124
            return "".join(str(child) for child in self.children)
125 126
        return str(self.result)

Eckhart Arnold's avatar
Eckhart Arnold committed
127

128 129 130 131 132 133
    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)
134

Eckhart Arnold's avatar
Eckhart Arnold committed
135

136 137 138 139 140 141 142 143 144
    def __len__(self):
        return self._len


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


145
    def __eq__(self, other):
146 147
        # return str(self.parser) == str(other.parser) and self.result == other.result
        return self.tag_name == other.tag_name and self.result == other.result
148

Eckhart Arnold's avatar
Eckhart Arnold committed
149

150
    def __hash__(self):
151
        return hash(self.tag_name)
152

Eckhart Arnold's avatar
Eckhart Arnold committed
153

154 155 156 157 158 159
    def __deepcopy__(self, memodict={}):
        result = copy.deepcopy(self.result)
        other = Node(self.parser, result)
        other._pos = self._pos
        return other

Eckhart Arnold's avatar
Eckhart Arnold committed
160

161
    @property   # this needs to be a (dynamic) property, in case sef.parser gets updated
162
    def tag_name(self) -> str:
163
        return self.parser.name or self.parser.ptype
164

Eckhart Arnold's avatar
Eckhart Arnold committed
165

166
    @property
Eckhart Arnold's avatar
Eckhart Arnold committed
167
    def result(self) -> StrictResultType:
168 169 170
        return self._result

    @result.setter
Eckhart Arnold's avatar
Eckhart Arnold committed
171
    def result(self, result: ResultType):
Eckhart Arnold's avatar
Eckhart Arnold committed
172
        # # made obsolete by static type checking with mypy
173 174 175
        # 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
176 177
        # Possible optimization: Do not allow single nodes as argument:
        # assert not isinstance(result, Node)
178
        self._result = (result,) if isinstance(result, Node) else str(result) \
179
            if isinstance(result, StringView) else result or ''  # type: StrictResultType
180
        self.children = cast(ChildrenType, self._result) \
Eckhart Arnold's avatar
Eckhart Arnold committed
181
            if isinstance(self._result, tuple) else cast(ChildrenType, ())  # type: ChildrenType
182 183 184
        if self.children:
            self.error_flag = max(self.error_flag,
                                  max(child.error_flag for child in self.children))  # type: bool
185 186

    @property
187
    def pos(self) -> int:
188 189 190 191
        assert self._pos >= 0, "position value not initialized!"
        return self._pos

    @pos.setter
192
    def pos(self, pos: int):
193 194
        self._pos = pos
        offset = 0
195
        # recursively adjust pos-values of all children
196 197
        for child in self.children:
            child.pos = pos + offset
198
            offset += len(child)
199 200 201
        # add pos-values to Error-objects
        for err in self._errors:
            err.pos = pos
202

Eckhart Arnold's avatar
Eckhart Arnold committed
203

204
    @property
205
    def errors(self) -> List[Error]:
206 207
        return self._errors.copy()

208

209
    def add_error(self, message: str, level: int= Error.ERROR, code: Hashable=0) -> 'Node':
Eckhart Arnold's avatar
Eckhart Arnold committed
210
        self._errors.append(Error(message, level, code))
211
        self.error_flag = max(self.error_flag, self._errors[-1].level)
Eckhart Arnold's avatar
Eckhart Arnold committed
212 213
        return self

Eckhart Arnold's avatar
Eckhart Arnold committed
214

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231
    def _finalize_errors(self, lbreaks: List[int]):
        if self.error_flag:
            for err in self._errors:
                assert err.pos >= 0
                err.line, err.column = line_col(lbreaks, err.pos)
            for child in self.children:
                child._finalize_errors(lbreaks)


    def finalize_errors(self, source_text: Union[StringView, str]):
        """Recursively adds line- and column-numbers to all error objects.
        """
        if self.error_flag:
            lbreaks = linebreaks(source_text)
            self._finalize_errors(lbreaks)


Eckhart Arnold's avatar
Eckhart Arnold committed
232 233 234 235 236 237 238 239 240
    def collect_errors(self, clear_errors=False) -> List[Error]:
        """
        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.
        """
        errors = self.errors
        if clear_errors:
            self._errors = []
241
            self.error_flag = 0
Eckhart Arnold's avatar
Eckhart Arnold committed
242 243 244 245
        if self.children:
            for child in self.children:
                errors.extend(child.collect_errors(clear_errors))
        return errors
246

Eckhart Arnold's avatar
Eckhart Arnold committed
247

248
    def _tree_repr(self, tab, openF, closeF, dataF=identity, density=0) -> str:
249 250 251 252 253 254 255 256
        """
        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.

257
        Args:
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
            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:
274
            return head.rstrip() + tail.lstrip()
275

276
        D = None if density & 2 else ''
277 278 279

        if self.children:
            content = []
280
            for child in self.children:
281
                subtree = child._tree_repr(tab, openF, closeF, dataF, density).split('\n')
282
                content.append('\n'.join((tab + s) for s in subtree))
283
            return head + '\n'.join(content) + tail.lstrip(D)
284

285
        res = cast(str, self.result)  # safe, because if there are no children, result is a string
286 287 288 289
        if density & 1 and res.find('\n') < 0:  # and head[0] == "<":
            # except for XML, add a gap between opening statement and content
            gap = ' ' if head.rstrip()[-1] != '>' else ''
            return head.rstrip() + gap + dataF(self.result) + tail.lstrip()
290
        else:
291
            return head + '\n'.join([tab + dataF(s) for s in res.split('\n')]) + tail.lstrip(D)
292

Eckhart Arnold's avatar
Eckhart Arnold committed
293

294
    def as_sxpr(self, src: str=None, compact: bool=False) -> str:
295 296 297
        """
        Returns content as S-expression, i.e. in lisp-like form.

298
        Args:
299 300 301
            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.
Eckhart Arnold's avatar
Eckhart Arnold committed
302 303 304
            compact:  If True a compact representation is returned where
                brackets are ommited and only the indentation indicates the
                tree structure.
305 306
        """

307 308
        lB, rB, D = ('', '', 1) if compact else ('(', '\n)', 0)

309
        def opening(node) -> str:
310
            s = lB + node.tag_name
311 312
            # s += " '(pos %i)" % node.pos
            if src:
Eckhart Arnold's avatar
Eckhart Arnold committed
313
                s += " '(pos %i " % node.pos + " %i %i)" % line_col(src, node.pos)
314 315 316
            if node.errors:
                s += " '(err '(%s))" % ' '.join(str(err).replace('"', r'\"')
                                                for err in node.errors)
317
            return s + '\n'
318 319 320 321 322 323

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

324
        return self._tree_repr('    ', opening, lambda node: rB, pretty, density=D)
325

Eckhart Arnold's avatar
Eckhart Arnold committed
326

327
    def as_xml(self, src: str=None) -> str:
328 329 330
        """
        Returns content as XML-tree.

331
        Args:
332 333 334 335 336
            src:  The source text or `None`. In case the source text is
                given the position will also be reported as line and
                column.
        """

337
        def opening(node) -> str:
338 339 340 341 342 343
            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)
344
            return s + ">\n"
345 346

        def closing(node):
347
            return '\n</' + node.tag_name + '>'
348

349
        return self._tree_repr('    ', opening, closing, density=1)
350

Eckhart Arnold's avatar
Eckhart Arnold committed
351

Eckhart Arnold's avatar
Eckhart Arnold committed
352 353 354
    def structure(self) -> str:
        """Return structure (and content) as S-expression on a single line
        without any line breaks."""
Eckhart Arnold's avatar
Eckhart Arnold committed
355 356
        return flatten_sxpr(self.as_sxpr())

357

Eckhart Arnold's avatar
Eckhart Arnold committed
358
    def content(self) -> str:
359
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
360 361
        Returns content as string, inserting error messages where
        errors occurred.
362
        """
Eckhart Arnold's avatar
Eckhart Arnold committed
363 364
        s = "".join(child.content() for child in self.children) if self.children \
            else str(self.result)
365 366
        return (' <<< Error on "%s" | %s >>> '
                % (s, '; '.join(e.message for e in self._errors))) if self._errors else s
367

Eckhart Arnold's avatar
Eckhart Arnold committed
368

369
    def find(self, match_function: Callable) -> Iterator['Node']:
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
        """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

Eckhart Arnold's avatar
Eckhart Arnold committed
390

391 392 393 394 395
    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


Eckhart Arnold's avatar
Eckhart Arnold committed
396
    def log(self, log_file_name):
397
        if is_logging():
Eckhart Arnold's avatar
Eckhart Arnold committed
398 399 400 401
            path = os.path.join(log_dir(), log_file_name)
            if os.path.exists(path):
                print('WARNING: Log-file "%s" already exists and will be overwritten!' % path)
            with open(path, "w", encoding="utf-8") as f:
402
                f.write(self.as_sxpr())
Eckhart Arnold's avatar
Eckhart Arnold committed
403

404

405
def mock_syntax_tree(sxpr):
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    """
    Generates a tree of nodes from an S-expression.

    Example:
    >>> mock_syntax_tree("(a (b c))").as_sxpr()
    '(a\\n    (b\\n        "c"\\n    )\\n)'
    """

    def next_block(s):
        s = s.strip()
        while s[0] != ')':
            if s[0] != '(': raise ValueError('"(" expected, not ' + s[:10])
            # assert s[0] == '(', s
            level = 1
            i = 1
            while level > 0:
                if s[i] == '(':
                    level += 1
                elif s[i] == ')':
                    level -= 1
                i += 1
            yield s[:i]
            s = s[i:].strip()

430 431 432 433 434 435 436 437 438
    sxpr = sxpr.strip()
    if sxpr[0] != '(': raise ValueError('"(" expected, not ' + sxpr[:10])
    # assert sxpr[0] == '(', sxpr
    sxpr = sxpr[1:].strip()
    m = re.match('[\w:]+', sxpr)
    name, class_name = (sxpr[:m.end()].split(':') + [''])[:2]
    sxpr = sxpr[m.end():].strip()
    if sxpr[0] == '(':
        result = tuple(mock_syntax_tree(block) for block in next_block(sxpr))
439 440
    else:
        lines = []
441
        while sxpr and sxpr[0] != ')':
442
            for qm in ['"""', "'''", '"', "'"]:
443
                m = re.match(qm + r'.*?' + qm, sxpr, re.DOTALL)
444 445
                if m:
                    i = len(qm)
446 447
                    lines.append(sxpr[i:m.end() - i])
                    sxpr = sxpr[m.end():].strip()
448 449
                    break
            else:
450 451 452
                m = re.match(r'(?:(?!\)).)*', sxpr, re.DOTALL)
                lines.append(sxpr[:m.end()])
                sxpr = sxpr[m.end():]
453 454 455 456
        result = "\n".join(lines)
    return Node(MockParser(name, ':' + class_name), result)


457
TransformationFunc = Union[Callable[[Node], Any], partial]
458

459 460 461 462 463

# if __name__ == "__main__":
#     st = mock_syntax_tree("(alpha (beta (gamma i\nj\nk) (delta y)) (epsilon z))")
#     print(st.as_sxpr())
#     print(st.as_xml())