transform.py 31 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
31
32
import inspect
from functools import partial, reduce, singledispatch

33
from DHParser.syntaxtree import Node, WHITESPACE_PTYPE, TOKEN_PTYPE, MockParser
34
35
from DHParser.toolkit import expand_table, smart_list, re, typing
from typing import AbstractSet, Any, ByteString, Callable, cast, Container, Dict, \
eckhart's avatar
eckhart committed
36
    List, Sequence, Union, Text
37

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


97
TransformationProc = Callable[[List[Node]], None]
Eckhart Arnold's avatar
Eckhart Arnold committed
98
TransformationDict = Dict[str, Sequence[Callable]]
99
TransformationFunc = Union[Callable[[Node], Any], partial]
Eckhart Arnold's avatar
Eckhart Arnold committed
100
ProcessingTableType = Dict[str, Union[Sequence[Callable], TransformationDict]]
101
102
ConditionFunc = Callable  # Callable[[List[Node]], bool]
KeyFunc = Callable[[Node], str]
eckhart's avatar
eckhart committed
103
CriteriaType = Union[int, str, Callable]
104
105


106
def transformation_factory(t1=None, t2=None, t3=None, t4=None, t5=None):
107
    """Creates factory functions from transformation-functions that
108
    dispatch on the first parameter after the context parameter.
109
110
111
112

    Decorating a transformation-function that has more than merely the
    ``node``-parameter with ``transformation_factory`` creates a
    function with the same name, which returns a partial-function that
113
    takes just the context-parameter.
114
115
116
117
118
119
120
121
122

    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.

123
124
    Usage::

eckhart's avatar
eckhart committed
125
        @transformation_factory(AbstractSet[str])
126
        def remove_tokens(context, tokens):
127
            ...
128
129
130

    or, alternatively::

131
        @transformation_factory
132
        def remove_tokens(context, tokens: AbstractSet[str]):
133
134
            ...

135
136
    Example::

137
        trans_table = { 'expression': remove_tokens('+', '-') }
138
139
140

    instead of::

141
        trans_table = { 'expression': partial(remove_tokens, tokens={'+', '-'}) }
142
143

    Parameters:
144
        t1:  type of the second argument of the transformation function,
145
146
            only necessary if the transformation functions' parameter list
            does not have type annotations.
147
148
149
150
151
152
153
    """

    def decorator(f):
        sig = inspect.signature(f)
        params = list(sig.parameters.values())[1:]
        if len(params) == 0:
            return f  # '@transformer' not needed w/o free parameters
154
        assert t1 or params[0].annotation != params[0].empty, \
155
            "No type information on second parameter found! Please, use type " \
eckhart's avatar
eckhart committed
156
            "annotation or provide the type information via transformer-decorator."
157
        p1type = t1 or params[0].annotation
158
        f = singledispatch(f)
eckhart's avatar
eckhart committed
159
160
        try:
            if len(params) == 1 and issubclass(p1type, Container) \
eckhart's avatar
eckhart committed
161
                    and not (issubclass(p1type, Text) or issubclass(p1type, ByteString)):
eckhart's avatar
eckhart committed
162
163
164
165
166
167
168
169
170
                def gen_special(*args):
                    c = set(args) if issubclass(p1type, AbstractSet) else \
                        list(args) if issubclass(p1type, Sequence) else args
                    d = {params[0].name: c}
                    return partial(f, **d)

                f.register(p1type.__args__[0], gen_special)
        except AttributeError:
            pass  # Union Type does not allow subclassing, but is not needed here
171
172
173
174
175
176

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

177
178
179
180
181
        for t in (p1type, t2, t3, t4, t5):
            if t:
                f.register(t, gen_partial)
            else:
                break
182
183
        return f

184
    if isinstance(t1, type(lambda: 1)):
185
186
187
        # Provide for the case that transformation_factory has been
        # written as plain decorator and not as a function call that
        # returns the decorator proper.
188
189
        func = t1
        t1 = None
190
191
192
193
194
        return decorator(func)
    else:
        return decorator


195
def key_parser_name(node: Node) -> str:
196
197
198
    return node.parser.name


199
def key_tag_name(node: Node) -> str:
200
201
202
    return node.tag_name


203
def traverse(root_node: Node,
Eckhart Arnold's avatar
Eckhart Arnold committed
204
             processing_table: ProcessingTableType,
205
206
207
             key_func: KeyFunc=key_tag_name) -> None:
    """
    Traverses the snytax tree starting with the given ``node`` depth
208
    first and applies the sequences of callback-functions registered
209
    in the ``processing_table``-dictionary.
210
211
212
213
214
215
216
217
218

    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:
219
220
221
222
223

    - '+': 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)
224
225
226
227
228

    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
229
230
            is interpreted as a ``compact_table``. See
            :func:`expand_table` or :func:`EBNFCompiler.EBNFTransTable`
231
232
233
        key_func (function): A mapping key_func(node) -> keystr. The default
            key_func yields node.parser.name.

234
235
    Example::

236
        table = { "term": [replace_by_single_child, flatten],
237
                  "factor, flowmarker, retrieveop": replace_by_single_child }
238
        traverse(node, table)
239

240
    """
241
242
243
    # Is this optimazation really needed?
    if '__cache__' in processing_table:
        # assume that processing table has already been expanded
eckhart's avatar
eckhart committed
244
245
        table = processing_table               # type: ProcessingTableType
        cache = processing_table['__cache__']  # type: Dictionary[str, List[Callable]]
246
    else:
247
248
        # normalize processing_table entries by turning single values
        # into lists with a single value
249
250
        table = {name: cast(Sequence[Callable], smart_list(call))
                 for name, call in list(processing_table.items())}
251
        table = expand_table(table)
Eckhart Arnold's avatar
Eckhart Arnold committed
252
        cache = table.setdefault('__cache__', cast(TransformationDict, dict()))
253
254
        # change processing table in place, so its already expanded and cache filled next time
        processing_table.clear()
255
256
257
258
259
260
        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
261
    # cache = {}  # type: Dict[str, List[Callable]]
262

263
    def traverse_recursive(context):
eckhart's avatar
eckhart committed
264
        nonlocal cache
265
        node = context[-1]
266
267
        if node.children:
            for child in node.result:
268
269
                context.append(child)
                traverse_recursive(context)  # depth first
270
                node.error_flag = max(node.error_flag, child.error_flag)  # propagate error flag
271
                context.pop()
272
273

        key = key_func(node)
274
275
276
        try:
            sequence = cache[key]
        except KeyError:
277
278
279
            sequence = table.get('+', []) \
                + table.get(key, table.get('*', [])) \
                + table.get('~', [])
280
281
282
283
284
285
286
            # '+' 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:
287
            call(context)
288

289
    traverse_recursive([root_node])
290
291
    # assert processing_table['__cache__']

292

293
#######################################################################
294
#
295
296
# meta transformations, i.e. transformations that call other
# transformations
297
#
298
#######################################################################
299
300


eckhart's avatar
eckhart committed
301
@transformation_factory(dict)
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
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)


# @transformation_factory(List[Callable])
# def apply_to_child(context: List[Node], transformations: List[Callable], condition: Callable):
#     """Applies a list of transformations to those children that meet a specifc condition."""
#     node = context[-1]
#     for child in node.children:
#         context.append(child)
#         if condition(context):
#             for transform in transformations:
#                 transform(context)
#         context.pop()


@transformation_factory(Callable)
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)


eckhart's avatar
eckhart committed
332
333
334
335
336
337
338
@transformation_factory(Callable)
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)


339
340
341
342
343
344
345
346
347
348
349
350
351
352
#######################################################################
#
# 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
353
    """Returns ``True`` if the current node does not have any siblings."""
354
355
356
357
    return len(context[-2].children) == 1


def is_named(context: List[Node]) -> bool:
eckhart's avatar
eckhart committed
358
    """Returns ``True`` if the current node's parser is a named parser."""
359
360
361
362
    return bool(context[-1].parser.name)


def is_anonymous(context: List[Node]) -> bool:
eckhart's avatar
eckhart committed
363
    """Returns ``True`` if the current node's parser is an anonymous parser."""
364
365
366
367
368
369
370
371
372
373
    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
374
    """Returns ``True`` if the current node's content is empty."""
375
376
377
378
    return not context[-1].result


def is_expendable(context: List[Node]) -> bool:
eckhart's avatar
eckhart committed
379
380
    """Returns ``True`` if the current node either is a node containing
    whitespace or an empty node."""
381
382
383
    return is_empty(context) or is_whitespace(context)


eckhart's avatar
eckhart committed
384
@transformation_factory  # (AbstractSet[str])
385
386
387
388
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
389
    any token is a match.
390
391
    """
    def stripped(nd: Node) -> str:
392
        """Removes leading and trailing whitespace-nodes from content."""
393
394
395
396
397
        # 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
398
            while k > 0 and nd.children[k - 1].parser.ptype == WHITESPACE_PTYPE:
399
400
401
402
                k -= 1
            return "".join(child.content for child in node.children[i:k])
        return nd.content
    node = context[-1]
403
    return node.parser.ptype == TOKEN_PTYPE and (not tokens or stripped(node) in tokens)
404
405


eckhart's avatar
eckhart committed
406
@transformation_factory
407
408
409
410
411
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's avatar
eckhart committed
412
@transformation_factory
413
def has_content(context: List[Node], regexp: str) -> bool:
414
415
416
417
418
419
420
421
    """
    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 += "$"
422
423
424
    return bool(re.match(regexp, context[-1].content))


eckhart's avatar
eckhart committed
425
@transformation_factory
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
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):
443
444
445
446
447
448
449
450
    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
    node._errors.extend(child._errors)
    node.result = child.result


451
def _reduce_child(node: Node, child: Node):
452
453
454
455
    node._errors.extend(child._errors)
    node.result = child.result


456
def _pick_child(context: List[Node], criteria: CriteriaType):
eckhart's avatar
eckhart committed
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
    """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
476
477


478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
#######################################################################
#
# 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)
524
525


526
527
def replace_by_single_child(context: List[Node]):
    """
528
529
530
    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.
531
532
533
    """
    node = context[-1]
    if len(node.children) == 1:
534
        _replace_by(node, node.children[0])
535
536


Eckhart Arnold's avatar
Eckhart Arnold committed
537
def reduce_single_child(context: List[Node]):
538
    """
539
    Reduces a single branch node by transferring the result of its
540
    immediate descendant to this node, but keeping this node's parser entry.
541
542
    Reduction only takes place if the last node in the context has
    exactly one child.
543
544
545
    """
    node = context[-1]
    if len(node.children) == 1:
546
        _reduce_child(node, node.children[0])
547
548
549


@transformation_factory(Callable)
550
551
552
def replace_or_reduce(context: List[Node], condition: Callable=is_named):
    """
    Replaces node by a single child, if condition is met on child,
553
554
    otherwise (i.e. if the child is anonymous) reduces the child.
    """
555
    node = context[-1]
556
    if len(node.children) == 1:
di68kap's avatar
di68kap committed
557
        child = node.children[0]
558
        if condition(context):
559
            _replace_by(node, child)
560
        else:
561
            _reduce_child(node, child)
562
563
564


@transformation_factory
565
566
567
def replace_parser(context: List[Node], name: str):
    """
    Replaces the parser of a Node with a mock parser with the given
568
569
570
    name.

    Parameters:
571
        context: the context where the parser shall be replaced
eckhart's avatar
eckhart committed
572
        name: "NAME:PTYPE" of the surrogate. The ptype is optional
573
    """
574
    node = context[-1]
575
576
577
578
579
    name, ptype = (name.split(':') + [''])[:2]
    node.parser = MockParser(name, ptype)


@transformation_factory(Callable)
580
581
def flatten(context: List[Node], condition: Callable=is_anonymous, recursive: bool=True):
    """
582
    Flattens all children, that fulfil the given ``condition``
583
584
585
    (default: all unnamed children). Flattening means that wherever a
    node has child nodes, the child nodes are inserted in place of the
    node.
586
587

    If the parameter ``recursive`` is ``True`` the same will recursively be
588
589
590
    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.
591
592
593
594

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

di68kap's avatar
di68kap committed
595
        (1 (+ 2) (+ 3))    ->   (1 + 2 + 3)
596
597
        (1 (+ (2 + (3))))  ->   (1 + 2 + 3)
    """
598
    node = context[-1]
599
    if node.children:
Eckhart Arnold's avatar
Eckhart Arnold committed
600
        new_result = []     # type: List[Node]
601
        for child in node.children:
602
603
            context.append(child)
            if child.children and condition(context):
604
                if recursive:
605
                    flatten(context, condition, recursive)
606
607
608
                new_result.extend(child.children)
            else:
                new_result.append(child)
609
            context.pop()
610
611
612
        node.result = tuple(new_result)


613
614
615
def collapse(context: List[Node]):
    """
    Collapses all sub-nodes of a node by replacing them with the
616
    string representation of the node.
617
    """
618
    node = context[-1]
619
    node.result = node.content
620
621
622


@transformation_factory
623
624
def merge_children(context: List[Node], tag_names: List[str]):
    """
625
626
627
    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.
628
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
629
    node = context[-1]
630
    result = []
631
    name, ptype = ('', tag_names[0]) if tag_names[0][:1] == ':' else (tag_names[0], '')
632
    if node.children:
633
        i = 0
634
635
636
637
638
639
640
641
642
643
644
        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
645
646
                                   reduce(lambda a, b: a + b,
                                          (node.children for node in node.children[i:k]))))
647
648
649
650
            i = k
        node.result = tuple(result)


eckhart's avatar
eckhart committed
651
@transformation_factory(Callable)
652
def replace_content(context: List[Node], func: Callable):  # Callable[[Node], ResultType]
di68kap's avatar
di68kap committed
653
    """Replaces the content of the node. ``func`` takes the node's result
654
655
    as an argument an returns the mapped result.
    """
656
    node = context[-1]
657
658
659
    node.result = func(node.result)


660
661
662
663
664
665
666
667
668
#######################################################################
#
# 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
#
#######################################################################
669
670


671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
@transformation_factory(Callable)
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:]


@transformation_factory(Callable)
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]


@transformation_factory(Callable)
eckhart's avatar
eckhart committed
701
def strip(context: List[Node], condition: Callable = is_expendable):
702
703
704
705
706
    """Removes leading and trailing child-nodes that fulfill a given condition."""
    lstrip(context, condition)
    rstrip(context, condition)


707
@transformation_factory(slice)
708
def keep_children(context: List[Node], section: slice = slice(None)):
709
    """Keeps only child-nodes which fall into a slice of the result field."""
710
    node = context[-1]
711
    if node.children:
712
        node.result = node.children[section]
713
714
715


@transformation_factory(Callable)
716
717
718
719
720
721
722
723
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]))


@transformation_factory
eckhart's avatar
eckhart committed
724
def keep_tokens(context: List[Node], tokens: AbstractSet[str]=frozenset()):
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
    """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))


@transformation_factory
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))


@transformation_factory(Callable)
def remove_children_if(context: List[Node], condition: Callable):
745
746
747
748
    """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
749
    pass
750

eckhart's avatar
eckhart committed
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
# @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)
772
773


774
775
remove_whitespace = remove_children_if(is_whitespace)
# partial(remove_children_if, condition=is_whitespace)
776
remove_empty = remove_children_if(is_empty)
di68kap's avatar
di68kap committed
777
remove_anonymous_empty = remove_children_if(lambda ctx: is_empty(ctx) and is_anonymous(ctx))
778
779
780
781
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))
782
remove_anonymous_tokens = remove_children_if(lambda ctx: is_token(ctx) and is_anonymous(ctx))
783
784
785
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)
786
remove_infix_operator = keep_children(slice(0, None, 2))
787
remove_single_child = apply_if(keep_children(slice(0)), lambda ctx: len(ctx[-1].children) == 1)
788
789


eckhart's avatar
eckhart committed
790
791
@transformation_factory(AbstractSet[str])
def remove_tokens(context: List[Node], tokens: AbstractSet[str]=frozenset()):
792
    """Removes any among a particular set of tokens from the immediate
793
794
    descendants of a node. If ``tokens`` is the empty set, all tokens
    are removed."""
795
    remove_children_if(context, partial(is_token, tokens=tokens))
796
797
798


@transformation_factory
eckhart's avatar
eckhart committed
799
def remove_nodes(context: List[Node], tag_names: AbstractSet[str]):
Eckhart Arnold's avatar
Eckhart Arnold committed
800
    """Removes children by tag name."""
801
    remove_children_if(context, partial(is_one_of, tag_name_set=tag_names))
802
803
804


@transformation_factory
805
def remove_content(context: List[Node], regexp: str):
806
    """Removes children depending on their string value."""
807
    remove_children_if(context, partial(has_content, regexp=regexp))
808
809
810
811


########################################################################
#
812
# AST semantic validation functions (EXPERIMENTAL!!!)
813
814
815
#
########################################################################

816
@transformation_factory(Callable)
Eckhart Arnold's avatar
Eckhart Arnold committed
817
def assert_condition(context: List[Node], condition: Callable, error_msg: str = ''):
818
    """Checks for `condition`; adds an error message if condition is not met."""
819
    node = context[-1]
820
    if not condition(context):
821
822
823
824
825
826
827
828
829
830
831
832
833
        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>'
            node.add_error("transform.assert_condition: Failed to meet condition " + cond_name)


assert_has_children = assert_condition(lambda nd: nd.children, 'Element "%s" has no children')


@transformation_factory
834
def assert_content(context: List[Node], regexp: str):
835
    node = context[-1]
836
    if not has_content(context, regexp):
837
        node.add_error('Element "%s" violates %s on %s' %
838
                       (node.parser.name, str(regexp), node.content))
839

840
841

@transformation_factory
842
def require(context: List[Node], child_tags: AbstractSet[str]):
843
    node = context[-1]
844
845
846
847
848
849
850
    for child in node.children:
        if child.tag_name not in child_tags:
            node.add_error('Element "%s" is not allowed inside "%s".' %
                           (child.parser.name, node.parser.name))


@transformation_factory
851
def forbid(context: List[Node], child_tags: AbstractSet[str]):
852
    node = context[-1]
853
854
855
856
    for child in node.children:
        if child.tag_name in child_tags:
            node.add_error('Element "%s" cannot be nested inside "%s".' %
                           (child.parser.name, node.parser.name))
857