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

"""
Module ``compile`` contains a skeleton class for syntax
driven compilation support. Class ``Compiler`` can serve as base
class for a compiler. Compiler objects
are callable an receive the Abstract syntax tree (AST)
as argument and yield whatever output the compiler produces. In
most Digital Humanities applications this will be
XML-code. However, it can also be anything else, like binary
code or, as in the case of DHParser's EBNF-compiler, Python
source code.

Function ``compile_source`` invokes all stages of the compilation
eckhart's avatar
eckhart committed
30
process, i.e. pre-processing, parsing, CST to AST-transformation
eckhart's avatar
mend  
eckhart committed
31
32
33
34
35
36
and compilation.

See module ``ebnf`` for a sample of the implementation of a
compiler object.
"""

eckhart's avatar
eckhart committed
37
import copy
eckhart's avatar
eckhart committed
38
from typing import Any, Optional, Tuple, List
eckhart's avatar
mend  
eckhart committed
39

eckhart's avatar
eckhart committed
40
from DHParser.preprocess import with_source_mapping, PreprocessorFunc, SourceMapFunc
41
from DHParser.syntaxtree import Node, RootNode, ZOMBIE_TAG, StrictResultType
eckhart's avatar
mend  
eckhart committed
42
43
44
45
from DHParser.transform import TransformationFunc
from DHParser.parse import Grammar
from DHParser.error import adjust_error_locations, is_error, Error
from DHParser.log import log_parsing_history, log_ST, is_logging, logfile_basename
eckhart's avatar
eckhart committed
46
from DHParser.toolkit import load_if_file
eckhart's avatar
mend  
eckhart committed
47
48


eckhart's avatar
eckhart committed
49
__all__ = ('CompilerError', 'Compiler', 'compile_source', 'visitor_name')
eckhart's avatar
eckhart committed
50
51
52


class CompilerError(Exception):
53
54
    """
    Exception raised when an error of the compiler itself is detected.
eckhart's avatar
eckhart committed
55
56
    Compiler errors are not to be confused with errors in the source
    code to be compiled, which do not raise Exceptions but are merely
57
58
    reported as an error.
    """
eckhart's avatar
eckhart committed
59
60
61
    pass


eckhart's avatar
eckhart committed
62
63
64
65
66
67
68
69
70
71
72
def visitor_name(node_name: str) -> str:
    """
    Returns the method name for `node_name`, e.g.::

        >>> visitor_name('expression')
        'on_expression'
    """
    # assert re.match(r'\w+$', node_name)
    return 'on_' + node_name


73
74
75
ROOTNODE_PLACEHOLDER = RootNode()


eckhart's avatar
mend  
eckhart committed
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
class Compiler:
    """
    Class Compiler is the abstract base class for compilers. Compiler
    objects are callable and take the root node of the abstract
    syntax tree (AST) as argument and return the compiled code in a
    format chosen by the compiler itself.

    Subclasses implementing a compiler must define `on_XXX()`-methods
    for each node name that can occur in the AST where 'XXX' is the
    node's name(for unnamed nodes it is the node's ptype without the
    leading colon ':').

    These compiler methods take the node on which they are run as
    argument. Other than in the AST transformation, which runs depth-first,
    compiler methods are called forward moving starting with the root
    node, and they are responsible for compiling the child nodes
    themselves. This should be done by invoking the `compile(node)`-
    method which will pick the right `on_XXX`-method. It is not
    recommended to call the `on_XXX`-methods directly.

    Attributes:
        context:  A list of parent nodes that ends with the currently
                compiled node.
99
100
        tree:  The root of the abstract syntax tree.
        source:  The source code.
eckhart's avatar
eckhart committed
101

eckhart's avatar
mend  
eckhart committed
102
103
104
105
106
        _dirty_flag:  A flag indicating that the compiler has already been
                called at least once and that therefore all compilation
                variables must be reset when it is called again.
    """

eckhart's avatar
eckhart committed
107
    def __init__(self):
108
        self._reset()
eckhart's avatar
mend  
eckhart committed
109
110

    def _reset(self):
111
        self.source = ''
112
        self.tree = ROOTNODE_PLACEHOLDER   # type: RootNode
eckhart's avatar
mend  
eckhart committed
113
114
115
        self.context = []  # type: List[Node]
        self._dirty_flag = False

eckhart's avatar
eckhart committed
116
    def __call__(self, root: RootNode, source: str = '') -> Any:
eckhart's avatar
mend  
eckhart committed
117
118
119
120
121
122
123
        """
        Compiles the abstract syntax tree with the root node `node` and
        returns the compiled code. It is up to subclasses implementing
        the compiler to determine the format of the returned data.
        (This very much depends on the kind and purpose of the
        implemented compiler.)
        """
124
        assert root.tag_name != ZOMBIE_TAG
eckhart's avatar
mend  
eckhart committed
125
126
127
        if self._dirty_flag:
            self._reset()
        self._dirty_flag = True
eckhart's avatar
eckhart committed
128
        self.tree = root  # type: RootNode
129
        self.source = source  # type: str
130
        result = self.compile(root)
eckhart's avatar
mend  
eckhart committed
131
132
        return result

133
134
135
136
137
138
139
140
141
142
    def compile_children(self, node: Node) -> StrictResultType:
        """Compiles all children of the given node and returns the tuple
        of the compiled children or the node's (potentially empty) result
        in case the node does not have any children.
        """
        if node.children:
            return tuple(self.compile(child) for child in node.children)
        else:
            return node.result

eckhart's avatar
mend  
eckhart committed
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
    def fallback_compiler(self, node: Node) -> Any:
        """This is a generic compiler function which will be called on
        all those node types for which no compiler method `on_XXX` has
        been defined."""
        if node.children:
            result = tuple(self.compile(nd) for nd in node.children)
            node.result = result
        return node

    def compile(self, node: Node) -> Any:
        """
        Calls the compilation method for the given node and returns the
        result of the compilation.

        The method's name is derived from either the node's parser
        name or, if the parser is anonymous, the node's parser's class
        name by adding the prefix ``on_``.

        Note that ``compile`` does not call any compilation functions
        for the parsers of the sub nodes by itself. Rather, this should
        be done within the compilation methods.
        """
165
166
167
        elem = node.tag_name
        if elem.startswith(':'):
            elem = elem[1:]
eckhart's avatar
eckhart committed
168
169
170
171
172
173
174
175
176
177
178
        try:
            compiler = self.__getattribute__(visitor_name(elem))
        except AttributeError:
            compiler = self.fallback_compiler
        self.context.append(node)
        result = compiler(node)
        self.context.pop()
        if result is None:
            raise CompilerError('Method on_%s returned `None` instead of a '
                                'valid compilation result!' % elem)
        return result
eckhart's avatar
mend  
eckhart committed
179
180
181
182
183


def compile_source(source: str,
                   preprocessor: Optional[PreprocessorFunc],  # str -> str
                   parser: Grammar,  # str -> Node (concrete syntax tree (CST))
184
                   transformer: TransformationFunc,  # Node (CST) -> Node (abstract ST (AST))
eckhart's avatar
eckhart committed
185
                   compiler: Compiler,  # Node (AST) -> Any
eckhart's avatar
eckhart committed
186
                   preserve_ast: bool = False) -> Tuple[Optional[Any], List[Error], Optional[Node]]:
eckhart's avatar
mend  
eckhart committed
187
188
    """
    Compiles a source in four stages:
eckhart's avatar
eckhart committed
189
    1. Pre-Processing (if needed)
eckhart's avatar
mend  
eckhart committed
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
    2. Parsing
    3. AST-transformation
    4. Compiling.

    The compilations stage is only invoked if no errors occurred in
    either of the two previous stages.

    Args:
        source (str): The input text for compilation or a the name of a
            file containing the input text.
        preprocessor (function):  text -> text. A preprocessor function
            or None, if no preprocessor is needed.
        parser (function):  A parsing function or grammar class
        transformer (function):  A transformation function that takes
            the root-node of the concrete syntax tree as an argument and
            transforms it (in place) into an abstract syntax tree.
        compiler (function): A compiler function or compiler class
            instance
eckhart's avatar
eckhart committed
208
        preserve_ast (bool): Preserves the AST-tree.
eckhart's avatar
mend  
eckhart committed
209
210
211
212
213
214

    Returns (tuple):
        The result of the compilation as a 3-tuple
        (result, errors, abstract syntax tree). In detail:
        1. The result as returned by the compiler or ``None`` in case of failure
        2. A list of error or warning messages
eckhart's avatar
eckhart committed
215
216
        3. The root-node of the abstract syntax tree if `preserve_ast` is True
           or `None` otherwise.
eckhart's avatar
mend  
eckhart committed
217
    """
eckhart's avatar
eckhart committed
218
219
220
    ast = None  # type: Optional[Node]
    original_text = load_if_file(source)  # type: str
    log_file_name = logfile_basename(source, compiler)  # type: str
eckhart's avatar
mend  
eckhart committed
221
    if preprocessor is None:
eckhart's avatar
eckhart committed
222
223
        source_text = original_text  # type: str
        source_mapping = lambda i: i  # type: SourceMapFunc
eckhart's avatar
mend  
eckhart committed
224
225
    else:
        source_text, source_mapping = with_source_mapping(preprocessor(original_text))
eckhart's avatar
eckhart committed
226
    syntax_tree = parser(source_text)  # type: RootNode
eckhart's avatar
mend  
eckhart committed
227
228
229
230
    if is_logging():
        log_ST(syntax_tree, log_file_name + '.cst')
        log_parsing_history(parser, log_file_name)

Eckhart Arnold's avatar
Eckhart Arnold committed
231
232
233
    # assert is_error(syntax_tree.error_flag) or str(syntax_tree) == strip_tokens(source_text), \
    #     str(syntax_tree) # Ony valid if neither tokens or whitespace are dropped early

eckhart's avatar
mend  
eckhart committed
234
235
236
    # only compile if there were no syntax errors, for otherwise it is
    # likely that error list gets littered with compile error messages
    result = None
237
    # efl = syntax_tree.error_flag
238
    # messages = syntax_tree.errors(clear_errors=True)
239
    if not is_error(syntax_tree.error_flag):
eckhart's avatar
mend  
eckhart committed
240
        transformer(syntax_tree)
241
        # efl = max(efl, syntax_tree.error_flag)
242
        # messages.extend(syntax_tree.errors(clear_errors=True))
eckhart's avatar
mend  
eckhart committed
243
244
245
        if is_logging():
            log_ST(syntax_tree, log_file_name + '.ast')
        if not is_error(syntax_tree.error_flag):
eckhart's avatar
eckhart committed
246
247
            if preserve_ast:
                ast = copy.deepcopy(syntax_tree)
248
            result = compiler(syntax_tree, original_text)
eckhart's avatar
mend  
eckhart committed
249
        # print(syntax_tree.as_sxpr())
250
        # messages.extend(syntax_tree.errors())
251
        # syntax_tree.error_flag = max(syntax_tree.error_flag, efl)
eckhart's avatar
mend  
eckhart committed
252

eckhart's avatar
eckhart committed
253
    messages = syntax_tree.errors_sorted  # type: List[Error]
eckhart's avatar
mend  
eckhart committed
254
    adjust_error_locations(messages, original_text, source_mapping)
255
    return result, messages, ast
di68kap's avatar
di68kap committed
256
257
258


# TODO: Verify compiler against grammar, i.e. make sure that for all on_X()-methods, `X` is the name of a parser