transform.py 36.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# transform.py - transformation functions for converting the
#                concrete into the abstract syntax tree
#
# 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.
18
19


20
21
22
"""
Module ``transform`` contains the functions for transforming the
concrete syntax tree (CST) into an abstract syntax tree (AST).
23

24
25
26
As these functions are very generic, they can in principle be
used for any kind of tree transformations, not necessarily only
for CST -> AST transformations.
27
28
"""

29

30
import collections.abc
31
import inspect
Eckhart Arnold's avatar
Eckhart Arnold committed
32
import fnmatch
33
34
from functools import partial, reduce, singledispatch

35
from DHParser.error import Error
eckhart's avatar
eckhart committed
36
from DHParser.syntaxtree import Node, WHITESPACE_PTYPE, TOKEN_PTYPE, MockParser, ZOMBIE_NODE
37
from DHParser.toolkit import issubtype, isgenerictype, expand_table, smart_list, re, typing
38
from typing import AbstractSet, Any, ByteString, Callable, cast, Container, Dict, \
39
    Tuple, List, Sequence, Union, Text, Generic
40

41
42
__all__ = ('TransformationDict',
           'TransformationProc',
43
           'TransformationFunc',
44
45
46
           'ConditionFunc',
           'KeyFunc',
           'transformation_factory',
47
48
49
           'key_parser_name',
           'key_tag_name',
           'traverse',
50
           'is_named',
51
           'replace_by_single_child',
Eckhart Arnold's avatar
Eckhart Arnold committed
52
           'reduce_single_child',
53
           'replace_or_reduce',
54
55
           'replace_parser',
           'collapse',
56
           'merge_children',
57
           'replace_content',
58
           'replace_content_by',
59
           'apply_if',
eckhart's avatar
eckhart committed
60
           'apply_unless',
61
           'traverse_locally',
62
           'is_anonymous',
63
64
65
66
           'is_whitespace',
           'is_empty',
           'is_expendable',
           'is_token',
67
           'is_one_of',
Eckhart Arnold's avatar
Eckhart Arnold committed
68
           'matches_re',
69
           'has_content',
di68kap's avatar
di68kap committed
70
           'has_parent',
71
72
73
74
75
76
77
78
           'lstrip',
           'rstrip',
           'strip',
           'keep_children',
           'keep_children_if',
           'keep_tokens',
           'keep_nodes',
           'keep_content',
79
           'remove_children_if',
eckhart's avatar
eckhart committed
80
           'remove_nodes',
81
82
83
84
85
           'remove_content',
           'remove_first',
           'remove_last',
           'remove_whitespace',
           'remove_empty',
di68kap's avatar
di68kap committed
86
           'remove_anonymous_empty',
87
88
           'remove_anonymous_expendables',
           'remove_anonymous_tokens',
89
90
           'remove_expendables',
           'remove_brackets',
91
92
           'remove_infix_operator',
           'remove_single_child',
93
94
95
96
           'remove_tokens',
           'flatten',
           'forbid',
           'require',
97
           'assert_content',
98
99
           'error_on',
           'warn_on',
di68kap's avatar
di68kap committed
100
101
           'assert_has_children',
           'peek')
102
103


104
TransformationProc = Callable[[List[Node]], None]
Eckhart Arnold's avatar
Eckhart Arnold committed
105
TransformationDict = Dict[str, Sequence[Callable]]
106
TransformationFunc = Union[Callable[[Node], Any], partial]
Eckhart Arnold's avatar
Eckhart Arnold committed
107
ProcessingTableType = Dict[str, Union[Sequence[Callable], TransformationDict]]
108
109
ConditionFunc = Callable  # Callable[[List[Node]], bool]
KeyFunc = Callable[[Node], str]
eckhart's avatar
eckhart committed
110
CriteriaType = Union[int, str, Callable]
111
112


113
def transformation_factory(t1=None, t2=None, t3=None, t4=None, t5=None):
114
    """Creates factory functions from transformation-functions that
115
    dispatch on the first parameter after the context parameter.
116
117

    Decorating a transformation-function that has more than merely the
Eckhart Arnold's avatar
Eckhart Arnold committed
118
    ``context``-parameter with ``transformation_factory`` creates a
119
    function with the same name, which returns a partial-function that
120
    takes just the context-parameter.
121
122
123
124
125
126
127
128
129

    Additionally, there is some some syntactic sugar for
    transformation-functions that receive a collection as their second
    parameter and do not have any further parameters. In this case a
    list of parameters passed to the factory function will be converted
    into a collection.

    Main benefit is readability of processing tables.

130
131
    Usage::

eckhart's avatar
eckhart committed
132
        @transformation_factory(AbstractSet[str])
133
        def remove_tokens(context, tokens):
134
            ...
135
136
137

    or, alternatively::

138
        @transformation_factory
139
        def remove_tokens(context, tokens: AbstractSet[str]):
140
141
            ...

142
143
    Example::

144
        trans_table = { 'expression': remove_tokens('+', '-') }
145
146
147

    instead of::

148
        trans_table = { 'expression': partial(remove_tokens, tokens={'+', '-'}) }
149
150

    Parameters:
151
        t1:  type of the second argument of the transformation function,
152
153
            only necessary if the transformation functions' parameter list
            does not have type annotations.
154
155
    """

156
157
158
159
    def type_guard(t):
        """Raises an error if type `t` is a generic type or could be mistaken
        for the type of the canonical first parameter "List[Node] of
        transformation functions. Returns `t`."""
160
161
162
163
        # if isinstance(t, GenericMeta):
        #     raise TypeError("Generic Type %s not permitted\n in transformation_factory "
        #                     "decorator. Use the equivalent non-generic type instead!"
        #                     % str(t))
164
        if isgenerictype(t):
165
166
167
            raise TypeError("Generic Type %s not permitted\n in transformation_factory "
                            "decorator. Use the equivalent non-generic type instead!"
                            % str(t))
168
        if issubtype(List[Node], t):
169
170
            raise TypeError("Sequence type %s not permitted\nin transformation_factory "
                            "decorator, because it could be mistaken for a base class "
171
172
173
                            "of List[Node]\nwhich is the type of the canonical first "
                            "argument of transformation functions. Try 'tuple' instead!"
                            % str(t))
174
175
        return t

176
    def decorator(f):
177
        nonlocal t1
178
179
180
181
        sig = inspect.signature(f)
        params = list(sig.parameters.values())[1:]
        if len(params) == 0:
            return f  # '@transformer' not needed w/o free parameters
182
        assert t1 or params[0].annotation != params[0].empty, \
183
            "No type information on second parameter found! Please, use type " \
eckhart's avatar
eckhart committed
184
            "annotation or provide the type information via transformer-decorator."
185
        f = singledispatch(f)
186
187
188
        p1type = params[0].annotation
        if t1 is None:
            t1 = type_guard(p1type)
189
        elif issubtype(p1type, type_guard(t1)):
190
            try:
191
                if len(params) == 1 and issubtype(p1type, Container) \
192
                        and not (issubtype(p1type, Text) or issubtype(p1type, ByteString)):
193
                    def gen_special(*args):
194
195
                        c = set(args) if issubtype(p1type, AbstractSet) else \
                            tuple(args) if issubtype(p1type, Sequence) else args
196
197
198
199
200
201
202
203
                        d = {params[0].name: c}
                        return partial(f, **d)
                    f.register(type_guard(p1type.__args__[0]), gen_special)
            except AttributeError:
                pass  # Union Type does not allow subclassing, but is not needed here
        else:
            raise TypeError("Annotated type %s is not a subclass of decorated type %s !"
                            % (str(p1type), str(t1)))
204
205
206
207
208
209

        def gen_partial(*args, **kwargs):
            d = {p.name: arg for p, arg in zip(params, args)}
            d.update(kwargs)
            return partial(f, **d)

210
        for t in (t1, t2, t3, t4, t5):
211
            if t:
212
                f.register(type_guard(t), gen_partial)
213
214
            else:
                break
215
216
        return f

217
    if isinstance(t1, type(lambda: 1)):
218
219
220
        # Provide for the case that transformation_factory has been
        # written as plain decorator and not as a function call that
        # returns the decorator proper.
221
222
        func = t1
        t1 = None
223
224
225
226
227
        return decorator(func)
    else:
        return decorator


228
def key_parser_name(node: Node) -> str:
229
230
231
    return node.parser.name


232
def key_tag_name(node: Node) -> str:
233
234
235
    return node.tag_name


236
def traverse(root_node: Node,
Eckhart Arnold's avatar
Eckhart Arnold committed
237
             processing_table: ProcessingTableType,
238
239
240
             key_func: KeyFunc=key_tag_name) -> None:
    """
    Traverses the snytax tree starting with the given ``node`` depth
241
    first and applies the sequences of callback-functions registered
242
    in the ``processing_table``-dictionary.
243
244
245
246
247
248
249
250
251

    The most important use case is the transformation of a concrete
    syntax tree into an abstract tree (AST). But it is also imaginable
    to employ tree-traversal for the semantic analysis of the AST.

    In order to assign sequences of callback-functions to nodes, a
    dictionary ("processing table") is used. The keys usually represent
    tag names, but any other key function is possible. There exist
    three special keys:
252
253
254
255
256

    - '+': always called (before any other processing function)
    - '*': called for those nodes for which no (other) processing
      function appears in the table
    - '~': always called (after any other processing function)
257
258
259
260
261

    Args:
        root_node (Node): The root-node of the syntax tree to be traversed
        processing_table (dict): node key -> sequence of functions that
            will be applied to matching nodes in order. This dictionary
262
263
            is interpreted as a ``compact_table``. See
            :func:`expand_table` or :func:`EBNFCompiler.EBNFTransTable`
264
265
266
        key_func (function): A mapping key_func(node) -> keystr. The default
            key_func yields node.parser.name.

267
268
    Example::

269
        table = { "term": [replace_by_single_child, flatten],
270
                  "factor, flowmarker, retrieveop": replace_by_single_child }
271
        traverse(node, table)
272

273
    """
274
275
276
    # Is this optimazation really needed?
    if '__cache__' in processing_table:
        # assume that processing table has already been expanded
eckhart's avatar
eckhart committed
277
        table = processing_table               # type: ProcessingTableType
eckhart's avatar
eckhart committed
278
        cache = cast(TransformationDict, processing_table['__cache__'])  # type: TransformationDict
279
    else:
280
281
        # normalize processing_table entries by turning single values
        # into lists with a single value
282
283
        table = {name: cast(Sequence[Callable], smart_list(call))
                 for name, call in list(processing_table.items())}
284
        table = expand_table(table)
eckhart's avatar
eckhart committed
285
286
        cache = cast(TransformationDict,
                     table.setdefault('__cache__', cast(TransformationDict, dict())))
287
288
        # change processing table in place, so its already expanded and cache filled next time
        processing_table.clear()
289
290
291
292
293
294
        processing_table.update(table)

    # assert '__cache__' in processing_table
    # # Code without optimization
    # table = {name: smart_list(call) for name, call in list(processing_table.items())}
    # table = expand_table(table)
Eckhart Arnold's avatar
Eckhart Arnold committed
295
    # cache = {}  # type: Dict[str, List[Callable]]
296

297
    def traverse_recursive(context):
eckhart's avatar
eckhart committed
298
        nonlocal cache
299
        node = context[-1]
300
        if node.children:
eckhart's avatar
eckhart committed
301
            context.append(ZOMBIE_NODE)
di68kap's avatar
di68kap committed
302
            for child in node.children:
eckhart's avatar
eckhart committed
303
                context[-1] = child
304
                traverse_recursive(context)  # depth first
eckhart's avatar
eckhart committed
305
            context.pop()
306
307

        key = key_func(node)
308
309
310
        try:
            sequence = cache[key]
        except KeyError:
311
312
313
            sequence = table.get('+', []) \
                + table.get(key, table.get('*', [])) \
                + table.get('~', [])
314
315
316
317
318
319
320
            # '+' always called (before any other processing function)
            # '*' called for those nodes for which no (other) processing function
            #     appears in the table
            # '~' always called (after any other processing function)
            cache[key] = sequence

        for call in sequence:
321
            call(context)
322

323
    traverse_recursive([root_node])
324
325
    # assert processing_table['__cache__']

326

327
#######################################################################
328
#
329
330
# meta transformations, i.e. transformations that call other
# transformations
331
#
332
#######################################################################
333
334


eckhart's avatar
eckhart committed
335
@transformation_factory(dict)
336
337
338
339
340
341
342
343
344
345
346
def traverse_locally(context: List[Node],
                     processing_table: Dict,            # actually: ProcessingTableType
                     key_func: Callable=key_tag_name):  # actually: KeyFunc
    """Transforms the syntax tree starting from the last node in the context
    according to the given processing table. The purpose of this function is
    to apply certain transformations locally, i.e. only for those nodes that
    have the last node in the context as their parent node.
    """
    traverse(context[-1], processing_table, key_func)


347
@transformation_factory(collections.abc.Callable)
348
349
350
351
352
353
def apply_if(context: List[Node], transformation: Callable, condition: Callable):
    """Applies a transformation only if a certain condition is met."""
    if condition(context):
        transformation(context)


354
@transformation_factory(collections.abc.Callable)
eckhart's avatar
eckhart committed
355
356
357
358
359
360
def apply_unless(context: List[Node], transformation: Callable, condition: Callable):
    """Applies a transformation if a certain condition is *not* met."""
    if not condition(context):
        transformation(context)


361
362
363
364
365
366
367
368
369
370
371
372
373
374
#######################################################################
#
# conditionals that determine whether the context (or the last node in
# the context for that matter) fulfill a specific condition.
# ---------------------------------------------------------------------
#
# The context of a node is understood as a list of all parent nodes
# leading up to and including the node itself. If represented as list,
# the last element of the list is the node itself.
#
#######################################################################


def is_single_child(context: List[Node]) -> bool:
eckhart's avatar
eckhart committed
375
    """Returns ``True`` if the current node does not have any siblings."""
376
377
378
379
    return len(context[-2].children) == 1


def is_named(context: List[Node]) -> bool:
eckhart's avatar
eckhart committed
380
    """Returns ``True`` if the current node's parser is a named parser."""
381
382
383
384
    return bool(context[-1].parser.name)


def is_anonymous(context: List[Node]) -> bool:
eckhart's avatar
eckhart committed
385
    """Returns ``True`` if the current node's parser is an anonymous parser."""
386
387
388
389
390
391
392
393
394
395
    return not context[-1].parser.name


def is_whitespace(context: List[Node]) -> bool:
    """Removes whitespace and comments defined with the
    ``@comment``-directive."""
    return context[-1].parser.ptype == WHITESPACE_PTYPE


def is_empty(context: List[Node]) -> bool:
eckhart's avatar
eckhart committed
396
    """Returns ``True`` if the current node's content is empty."""
397
398
399
400
    return not context[-1].result


def is_expendable(context: List[Node]) -> bool:
eckhart's avatar
eckhart committed
401
402
    """Returns ``True`` if the current node either is a node containing
    whitespace or an empty node."""
403
404
405
    return is_empty(context) or is_whitespace(context)


406
@transformation_factory(collections.abc.Set)
407
408
409
410
def is_token(context: List[Node], tokens: AbstractSet[str] = frozenset()) -> bool:
    """Checks whether the last node in the context has `ptype == TOKEN_PTYPE`
    and it's content matches one of the given tokens. Leading and trailing
    whitespace-tokens will be ignored. In case an empty set of tokens is passed,
eckhart's avatar
eckhart committed
411
    any token is a match.
412
    """
di68kap's avatar
di68kap committed
413
414
415
416
417
418
419
420
421
422
423
424
425
    # def stripped(nd: Node) -> str:
    #     """Removes leading and trailing whitespace-nodes from content."""
    #     # assert node.parser.ptype == TOKEN_PTYPE
    #     if nd.children:
    #         i, k = 0, len(nd.children)
    #         while i < len(nd.children) and nd.children[i].parser.ptype == WHITESPACE_PTYPE:
    #             i += 1
    #         while k > 0 and nd.children[k - 1].parser.ptype == WHITESPACE_PTYPE:
    #             k -= 1
    #         return "".join(child.content for child in node.children[i:k])
    #     return nd.content
    # node = context[-1]
    # return node.parser.ptype == TOKEN_PTYPE and (not tokens or stripped(node) in tokens)
426
    node = context[-1]
di68kap's avatar
di68kap committed
427
    return node.parser.ptype == TOKEN_PTYPE and (not tokens or node.content in tokens)
428
429


430
@transformation_factory(collections.abc.Set)
431
432
433
434
435
def is_one_of(context: List[Node], tag_name_set: AbstractSet[str]) -> bool:
    """Returns true, if the node's tag_name is one of the given tag names."""
    return context[-1].tag_name in tag_name_set


Eckhart Arnold's avatar
Eckhart Arnold committed
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
# @transformation_factory(collections.abc.Set)
# def matches_wildcard(context: List[Node], wildcards: AbstractSet[str]) -> bool:
#     """Retruns true, if the node's tag_name matches one of the glob patterns
#     in `wildcards`. For example, ':*' matches all anonymous nodes. """
#     tn = context[-1].tag_name
#     for pattern in wildcards:
#         if fnmatch.fnmatch(tn, pattern):
#             return True
#     return False


@transformation_factory(collections.abc.Set)
def matches_re(context: List[Node], patterns: AbstractSet[str]) -> bool:
    """Retruns true, if the node's tag_name matches one of the regular
    expressions in `patterns`. For example, ':.*' matches all anonymous nodes.
    """
    tn = context[-1].tag_name
    for pattern in patterns:
        if re.match(pattern, tn):
            return True
    return False


eckhart's avatar
eckhart committed
459
@transformation_factory
460
def has_content(context: List[Node], regexp: str) -> bool:
461
462
463
464
465
466
467
468
    """
    Checks a node's content against a regular expression.

    In contrast to ``re.match`` the regular expression must match the complete
    string and not just the beginning of the string to succeed!
    """
    if not regexp.endswith('$'):
        regexp += "$"
469
470
471
    return bool(re.match(regexp, context[-1].content))


472
@transformation_factory(collections.abc.Set)
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
def has_parent(context: List[Node], tag_name_set: AbstractSet[str]) -> bool:
    """Checks whether a node with one of the given tag names appears somewhere
     in the context before the last node in the context."""
    for i in range(2, len(context)):
        if context[-i].tag_name in tag_name_set:
            return True
    return False


#######################################################################
#
# utility functions (private)
#
#######################################################################


def _replace_by(node: Node, child: Node):
490
491
492
493
    if not child.parser.name:
        child.parser = MockParser(node.parser.name, child.parser.ptype)
        # parser names must not be overwritten, else: child.parser.name = node.parser.name
    node.parser = child.parser
Eckhart Arnold's avatar
Eckhart Arnold committed
494
    # node.errors.extend(child.errors)
495
    node.result = child.result
496
    if hasattr(child, '_xml_attr'):
497
        node.attr.update(child.attr)
498
499


500
def _reduce_child(node: Node, child: Node):
Eckhart Arnold's avatar
Eckhart Arnold committed
501
    # node.errors.extend(child.errors)
502
    node.result = child.result
503
    if hasattr(child, '_xml_attr'):
504
        node.attr.update(child.attr)
505
506


eckhart's avatar
eckhart committed
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
# def _pick_child(context: List[Node], criteria: CriteriaType):
#     """Returns the first child that meets the criteria."""
#     if isinstance(criteria, int):
#         try:
#             return context[-1].children[criteria]
#         except IndexError:
#             return None
#     elif isinstance(criteria, str):
#         for child in context[-1].children:
#             if child.tag_name == criteria:
#                 return child
#         return None
#     else:  # assume criteria has type ConditionFunc
#         for child in context[-1].children:
#             context.append(child)
#             evaluation = criteria(context)
#             context.pop()
#             if evaluation:
#                 return child
#         return None
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
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
#######################################################################
#
# rearranging transformations
#
# - tree may be rearranged (e.g.flattened)
# - nodes that are not leaves may be dropped
# - order is preserved
# - leave content is preserved (though not necessarily the leaves
#   themselves)
#
#######################################################################


# @transformation_factory(int, str, Callable)
# def replace_by_child(context: List[Node], criteria: CriteriaType=is_single_child):
#     """
#     Replaces a node by the first of its immediate descendants
#     that meets the `criteria`. The criteria can either be the
#     index of the child (counting from zero), or the tag name or
#     a boolean-valued function on the context of the child.
#     If no child matching the criteria is found, the node will
#     not be replaced.
#     With the default value for `criteria` the same semantics is
#     the same that of `replace_by_single_child`.
#     """
#     child = _pick_child(context, criteria)
#     if child:
#         _replace_by(context[-1], child)
#
#
# @transformation_factory(int, str, Callable)
# def content_from_child(context: List[Node], criteria: CriteriaType = is_single_child):
#     """
#     Reduces a node, by transferring the result of the first of its
#     immediate descendants that meets the `criteria` to this node,
#     but keeping this node's parser entry. The criteria can either
#     be the index of the child (counting from zero), or the tag
#     name or a boolean-valued function on the context of the child.
#     If no child matching the criteria is found, the node will
#     not be replaced.
#     With the default value for `criteria` this has the same semantics
#     as `content_from_single_child`.
#     """
#     child = _pick_child(context, criteria)
#     if child:
#         _reduce_child(context[-1], child)
575
576


577
578
def replace_by_single_child(context: List[Node]):
    """
579
580
581
    Removes single branch node, replacing it by its immediate descendant.
    Replacement only takes place, if the last node in the context has
    exactly one child.
582
583
584
    """
    node = context[-1]
    if len(node.children) == 1:
585
        _replace_by(node, node.children[0])
586
587


Eckhart Arnold's avatar
Eckhart Arnold committed
588
def reduce_single_child(context: List[Node]):
589
    """
590
    Reduces a single branch node by transferring the result of its
591
    immediate descendant to this node, but keeping this node's parser entry.
592
593
    Reduction only takes place if the last node in the context has
    exactly one child.
594
595
596
    """
    node = context[-1]
    if len(node.children) == 1:
597
        _reduce_child(node, node.children[0])
598
599


600
@transformation_factory(collections.abc.Callable)
601
602
603
def replace_or_reduce(context: List[Node], condition: Callable=is_named):
    """
    Replaces node by a single child, if condition is met on child,
604
605
    otherwise (i.e. if the child is anonymous) reduces the child.
    """
606
    node = context[-1]
607
    if len(node.children) == 1:
di68kap's avatar
di68kap committed
608
        child = node.children[0]
609
        if condition(context):
610
            _replace_by(node, child)
611
        else:
612
            _reduce_child(node, child)
613
614
615


@transformation_factory
616
617
618
def replace_parser(context: List[Node], name: str):
    """
    Replaces the parser of a Node with a mock parser with the given
619
620
621
    name.

    Parameters:
622
        context: the context where the parser shall be replaced
eckhart's avatar
eckhart committed
623
        name: "NAME:PTYPE" of the surrogate. The ptype is optional
624
    """
625
    node = context[-1]
626
    name, ptype = (name.split(':') + [''])[:2]
di68kap's avatar
di68kap committed
627
    node.parser = MockParser(name, ':' + ptype)
628
629


630
@transformation_factory(collections.abc.Callable)
631
632
def flatten(context: List[Node], condition: Callable=is_anonymous, recursive: bool=True):
    """
633
    Flattens all children, that fulfil the given ``condition``
634
635
636
    (default: all unnamed children). Flattening means that wherever a
    node has child nodes, the child nodes are inserted in place of the
    node.
637
638

    If the parameter ``recursive`` is ``True`` the same will recursively be
639
640
641
    done with the child-nodes, first. In other words, all leaves of
    this node and its child nodes are collected in-order as direct
    children of this node.
642
643
644
645

    Applying flatten recursively will result in these kinds of
    structural transformation::

di68kap's avatar
di68kap committed
646
        (1 (+ 2) (+ 3))    ->   (1 + 2 + 3)
647
648
        (1 (+ (2 + (3))))  ->   (1 + 2 + 3)
    """
649
    node = context[-1]
650
    if node.children:
Eckhart Arnold's avatar
Eckhart Arnold committed
651
        new_result = []     # type: List[Node]
eckhart's avatar
eckhart committed
652
        context.append(ZOMBIE_NODE)
653
        for child in node.children:
eckhart's avatar
eckhart committed
654
            context[-1] = child
655
            if child.children and condition(context):
656
                if recursive:
657
                    flatten(context, condition, recursive)
658
659
660
                new_result.extend(child.children)
            else:
                new_result.append(child)
eckhart's avatar
eckhart committed
661
        context.pop()
662
663
664
        node.result = tuple(new_result)


665
666
667
def collapse(context: List[Node]):
    """
    Collapses all sub-nodes of a node by replacing them with the
668
    string representation of the node.
669
    """
670
    node = context[-1]
671
    node.result = node.content
672
673


674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
# @transformation_factory
# def collect_leaves(context: List[Node], whitespace: str=''):
#     """
#     Collects all leave nodes dropping any intermediary nodes.
#     Optionally adds whitespace between the nodes.
#     """
#     assert context[-1].children
#     node = context[-1]
#     leaves_iterator = node.select(lambda nd: not nd.children, include_root=False)
#     if whitespace:
#         mock_ws_parser = MockParser('', WHITESPACE_PTYPE)
#         result = []
#         for leave in leaves_iterator:
#             result.append(leave)
#             result.append(Node(mock_ws_parser, whitespace, leafhint=True))
#         result.pop()
#         node.result = tuple(result)
#     else:
#         node.result = (nd for nd in leaves_iterator)


695
696
@transformation_factory(tuple)
def merge_children(context: List[Node], tag_names: Tuple[str]):
697
    """
698
699
700
    Joins all children next to each other and with particular tag-names
    into a single child node with a mock-parser with the name of the
    first tag-name in the list.
701
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
702
    node = context[-1]
703
    result = []
704
    name, ptype = ('', tag_names[0]) if tag_names[0][:1] == ':' else (tag_names[0], '')
705
    if node.children:
706
        i = 0
707
708
709
710
711
712
713
714
715
716
717
        L = len(node.children)
        while i < L:
            while i < L and not node.children[i].tag_name in tag_names:
                result.append(node.children[i])
                i += 1
            k = i + 1
            while (k < L and node.children[k].tag_name in tag_names
                   and bool(node.children[i].children) == bool(node.children[k].children)):
                k += 1
            if i < L:
                result.append(Node(MockParser(name, ptype),
Eckhart Arnold's avatar
Eckhart Arnold committed
718
719
                                   reduce(lambda a, b: a + b,
                                          (node.children for node in node.children[i:k]))))
720
721
722
723
            i = k
        node.result = tuple(result)


724
@transformation_factory(collections.abc.Callable)
725
def replace_content(context: List[Node], func: Callable):  # Callable[[Node], ResultType]
di68kap's avatar
di68kap committed
726
    """Replaces the content of the node. ``func`` takes the node's result
727
728
    as an argument an returns the mapped result.
    """
729
    node = context[-1]
730
731
732
    node.result = func(node.result)


733
@transformation_factory  # (str)
734
735
736
737
738
739
740
def replace_content_by(context: List[Node], content: str):  # Callable[[Node], ResultType]
    """Replaces the content of the node with the given text content.
    """
    node = context[-1]
    node.result = content


741
742
743
744
745
746
747
748
749
#######################################################################
#
# destructive transformations:
#
# - leaves may be dropped (e.g. if deemed irrelevant)
# - errors of dropped leaves will be lost
# - no promise that order will be preserved
#
#######################################################################
750
751


752
@transformation_factory(collections.abc.Callable)
753
754
755
756
757
758
759
760
761
762
763
764
765
def lstrip(context: List[Node], condition: Callable = is_expendable):
    """Recursively removes all leading child-nodes that fulfill a given condition."""
    node = context[-1]
    i = 1
    while i > 0 and node.children:
        lstrip(context + [node.children[0]], condition)
        i, L = 0, len(node.children)
        while i < L and condition(context + [node.children[i]]):
            i += 1
        if i > 0:
            node.result = node.children[i:]


766
@transformation_factory(collections.abc.Callable)
767
768
769
770
771
772
773
774
775
776
777
778
779
780
def rstrip(context: List[Node], condition: Callable = is_expendable):
    """Recursively removes all leading nodes that fulfill a given condition."""
    node = context[-1]
    i, L = 0, len(node.children)
    while i < L and node.children:
        rstrip(context + [node.children[-1]], condition)
        L = len(node.children)
        i = L
        while i > 0 and condition(context + [node.children[i-1]]):
            i -= 1
        if i < L:
            node.result = node.children[:i]


781
@transformation_factory(collections.abc.Callable)
eckhart's avatar
eckhart committed
782
def strip(context: List[Node], condition: Callable = is_expendable):
783
784
785
786
787
    """Removes leading and trailing child-nodes that fulfill a given condition."""
    lstrip(context, condition)
    rstrip(context, condition)


788
@transformation_factory  # (slice)
789
def keep_children(context: List[Node], section: slice = slice(None)):
790
    """Keeps only child-nodes which fall into a slice of the result field."""
791
    node = context[-1]
792
    if node.children:
793
        node.result = node.children[section]
794
795


796
@transformation_factory(collections.abc.Callable)
797
798
799
800
801
802
803
def keep_children_if(context: List[Node], condition: Callable):
    """Removes all children for which `condition()` returns `True`."""
    node = context[-1]
    if node.children:
        node.result = tuple(c for c in node.children if condition(context + [c]))


804
@transformation_factory(collections.abc.Set)
eckhart's avatar
eckhart committed
805
def keep_tokens(context: List[Node], tokens: AbstractSet[str]=frozenset()):
806
807
808
809
810
811
    """Removes any among a particular set of tokens from the immediate
    descendants of a node. If ``tokens`` is the empty set, all tokens
    are removed."""
    keep_children_if(context, partial(is_token, tokens=tokens))


812
@transformation_factory(collections.abc.Set)
813
814
815
816
817
818
819
820
821
822
823
def keep_nodes(context: List[Node], tag_names: AbstractSet[str]):
    """Removes children by tag name."""
    keep_children_if(context, partial(is_one_of, tag_name_set=tag_names))


@transformation_factory
def keep_content(context: List[Node], regexp: str):
    """Removes children depending on their string value."""
    keep_children_if(context, partial(has_content, regexp=regexp))


824
@transformation_factory(collections.abc.Callable)
825
def remove_children_if(context: List[Node], condition: Callable):
826
827
828
829
    """Removes all children for which `condition()` returns `True`."""
    node = context[-1]
    if node.children:
        node.result = tuple(c for c in node.children if not condition(context + [c]))
eckhart's avatar
eckhart committed
830
    pass
831

eckhart's avatar
eckhart committed
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
# @transformation_factory(Callable)
# def remove_children(context: List[Node],
#                     condition: Callable = TRUE_CONDITION,
#                     section: slice = slice(None)):
#     """Removes all nodes from a slice of the result field if the function
#     `condition(child_node)` evaluates to `True`."""
#     node = context[-1]
#     if node.children:
#         c = node.children
#         N = len(c)
#         rng = range(*section.indices(N))
#         node.result = tuple(c[i] for i in range(N)
#                             if i not in rng or not condition(context + [c[i]]))
#         # selection = []
#         # for i in range(N):
#         #     context.append(c[i])
#         #     if not i in rng or not condition(context):
#         #         selection.append(c[i])
#         #     context.pop()
#         # if len(selection) != c:
#         #     node.result = tuple(selection)
853
854


855
856
remove_whitespace = remove_children_if(is_whitespace)
# partial(remove_children_if, condition=is_whitespace)
857
remove_empty = remove_children_if(is_empty)
di68kap's avatar
di68kap committed
858
remove_anonymous_empty = remove_children_if(lambda ctx: is_empty(ctx) and is_anonymous(ctx))
859
860
861
862
remove_expendables = remove_children_if(is_expendable)
# partial(remove_children_if, condition=is_expendable)
remove_anonymous_expendables = remove_children_if(lambda ctx: is_anonymous(ctx)
                                                  and is_expendable(ctx))
863
remove_anonymous_tokens = remove_children_if(lambda ctx: is_token(ctx) and is_anonymous(ctx))
864
865
866
# remove_first = apply_if(keep_children(slice(1, None)), lambda ctx: len(ctx[-1].children) > 1)
# remove_last = apply_if(keep_children(slice(None, -1)), lambda ctx: len(ctx[-1].children) > 1)
# remove_brackets = apply_if(keep_children(slice(1, -1)), lambda ctx: len(ctx[-1].children) >= 2)
867
remove_infix_operator = keep_children(slice(0, None, 2))
868
remove_single_child = apply_if(keep_children(slice(0)), lambda ctx: len(ctx[-1].children) == 1)
869
870


871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
def remove_first(context: List[Node]):
    """Removes the first non-whitespace child."""
    node = context[-1]
    if node.children:
        for i, child in enumerate(node.children):
            if child.parser.ptype != WHITESPACE_PTYPE:
                break
        else:
            return
        node.result = node.children[:i] + node.children[i+1:]


def remove_last(context: List[Node]):
    """Removes the last non-whitespace child."""
    node = context[-1]
    if node.children:
        for i, child in enumerate(reversed(node.children)):
            if child.parser.ptype != WHITESPACE_PTYPE:
                break
        else:
            return
        i = len(node.children) - i - 1
        node.result = node.children[:i] + node.children[i+1:]


def remove_brackets(context: List[Node]):
    """Removes the first and the last non-whitespace child."""
    remove_first(context)
    remove_last(context)


902
@transformation_factory(collections.abc.Set)
eckhart's avatar
eckhart committed
903
def remove_tokens(context: List[Node], tokens: AbstractSet[str]=frozenset()):
904
    """Removes any among a particular set of tokens from the immediate
905
906
    descendants of a node. If ``tokens`` is the empty set, all tokens
    are removed."""
907
    remove_children_if(context, partial(is_token, tokens=tokens))
908
909


910
@transformation_factory(collections.abc.Set)
eckhart's avatar
eckhart committed
911
def remove_nodes(context: List[Node], tag_names: AbstractSet[str]):
Eckhart Arnold's avatar
Eckhart Arnold committed
912
    """Removes children by tag name."""
913
    remove_children_if(context, partial(is_one_of, tag_name_set=tag_names))
914
915
916


@transformation_factory
917
def remove_content(context: List[Node], regexp: str):
918
    """Removes children depending on their string value."""
919
    remove_children_if(context, partial(has_content, regexp=regexp))
920
921
922
923


########################################################################
#
924
# AST semantic validation functions (EXPERIMENTAL!!!)
925
926
927
#
########################################################################

928
@transformation_factory(collections.abc.Callable)
929
930
931
932
def error_on(context: List[Node], condition: Callable, error_msg: str = ''):
    """
    Checks for `condition`; adds an error message if condition is not met.
    """
933
    node = context[-1]
934
    if not condition(context):
935
936
937
938
939
940
        if error_msg:
            node.add_error(error_msg % node.tag_name if error_msg.find("%s") > 0 else error_msg)
        else:
            cond_name = condition.__name__ if hasattr(condition, '__name__') \
                        else condition.__class__.__name__ if hasattr(condition, '__class__') \
                        else '<unknown>'
941
942
943
            node.add_error("transform.error_on: Failed to meet condition " + cond_name)


944
@transformation_factory(collections.abc.Callable)
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
def warn_on(context: List[Node], condition: Callable, warning: str = ''):
    """
    Checks for `condition`; adds an warning message if condition is not met.
    """
    node = context[-1]
    if not condition(context):
        if warning:
            node.add_error(warning % node.tag_name if warning.find("%s") > 0 else warning,
                           Error.WARNING)
        else:
            cond_name = condition.__name__ if hasattr(condition, '__name__') \
                        else condition.__class__.__name__ if hasattr(condition, '__class__') \
                        else '<unknown>'
            node.add_error("transform.warn_on: Failed to meet condition " + cond_name,
                           Error.WARNING)
960
961


962
assert_has_children = error_on(lambda nd: nd.children, 'Element "%s" has no children')
963
964
965


@transformation_factory
966
def assert_content(context: List[Node], regexp: str):
967
    node = context[-1]
968
    if not has_content(context, regexp):
eckhart's avatar
eckhart committed
969
        context[0].new_error(node, 'Element "%s" violates %s on %s' %
eckhart's avatar
eckhart committed
970
                             (node.parser.name, str(regexp), node.content))
971

972

973
@transformation_factory(collections.abc.Set)
974
def require(context: List[Node], child_tags: AbstractSet[str]):
975
    node = context[-1]
976
977
    for child in node.children:
        if child.tag_name not in child_tags:
eckhart's avatar
eckhart committed
978
            context[0].new_error(node, 'Element "%s" is not allowed inside "%s".' %
eckhart's avatar
eckhart committed
979
                                 (child.parser.name, node.parser.name))
980
981


982
@transformation_factory(collections.abc.Set)
983
def forbid(context: List[Node], child_tags: AbstractSet[str]):
984
    node = context[-1]
985
986
    for child in node.children:
        if child.tag_name in child_tags:
eckhart's avatar
eckhart committed
987
            context[0].new_error(node, 'Element "%s" cannot be nested inside "%s".' %
eckhart's avatar
eckhart committed
988
                                 (child.parser.name, node.parser.name))
di68kap's avatar
di68kap committed
989
990
991
992
993


def peek(context: List[Node]):
    """For debugging: Prints the last node in the context as S-expression."""
    print(context[-1].as_sxpr())