dsl.py 17.6 KB
Newer Older
1
"""dsl.py - Support for domain specific notations for DHParser
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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 ``DSLsupport`` contains various functions to support the
compilation of domain specific languages based on an EBNF-grammar.
"""

di68kap's avatar
di68kap committed
22
import collections
23
import os
24

25
26
27
28
29
try:
    import regex as re
except ImportError:
    import re

Eckhart Arnold's avatar
Eckhart Arnold committed
30
from .ebnf import EBNFGrammar, EBNFTransform, EBNFCompiler, grammar_changed, \
31
    get_ebnf_scanner, get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler
Eckhart Arnold's avatar
Eckhart Arnold committed
32
33
from .toolkit import logging, load_if_file, is_python_code, compile_python_object
from .parsers import GrammarBase, CompilerBase, compile_source, nil_scanner
34
from .syntaxtree import Node
35

Eckhart Arnold's avatar
Eckhart Arnold committed
36
37
38
39
40

__all__ = ['GrammarError',
           'CompilationError',
           'load_compiler_suite',
           'compileDSL',
41
           'compile_on_disk']
Eckhart Arnold's avatar
Eckhart Arnold committed
42
43


44
45
46
47
48
49
50
51
52
SECTION_MARKER = """\n
#######################################################################
#
# {marker}
#
#######################################################################
\n"""

RX_SECTION_MARKER = re.compile(SECTION_MARKER.format(marker=r'.*?SECTION.*?'))
53
RX_WHITESPACE = re.compile('\s*')
54
55
56
57
58
59

SYMBOLS_SECTION = "SYMBOLS SECTION - Can be edited. Changes will be preserved."
SCANNER_SECTION = "SCANNER SECTION - Can be edited. Changes will be preserved."
PARSER_SECTION = "PARSER SECTION - Don't edit! CHANGES WILL BE OVERWRITTEN!"
AST_SECTION = "AST SECTION - Can be edited. Changes will be preserved."
COMPILER_SECTION = "COMPILER SECTION - Can be edited. Changes will be preserved."
di68kap's avatar
di68kap committed
60
END_SECTIONS_MARKER = "END OF DHPARSER-SECTIONS"
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84


class GrammarError(Exception):
    """Raised when (already) the grammar of a domain specific language (DSL)
    contains errors.
    """

    def __init__(self, error_messages, grammar_src):
        self.error_messages = error_messages
        self.grammar_src = grammar_src


class CompilationError(Exception):
    """Raised when a string or file in a domain specific language (DSL)
    contains errors.
    """

    def __init__(self, error_messages, dsl_text, dsl_grammar, AST):
        self.error_messages = error_messages
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST

    def __str__(self):
85
        return '\n'.join(self.error_messages)
86
87


88
DHPARSER_IMPORTS = '''
di68kap's avatar
di68kap committed
89
from functools import partial
Eckhart Arnold's avatar
Eckhart Arnold committed
90
import os
91
import sys
di68kap's avatar
di68kap committed
92
93
94
95
try:
    import regex as re
except ImportError:
    import re
Eckhart Arnold's avatar
Eckhart Arnold committed
96
from DHParser.toolkit import logging, is_filename, load_if_file    
97
from DHParser.parsers import GrammarBase, CompilerBase, nil_scanner, \\
di68kap's avatar
di68kap committed
98
99
    Lookbehind, Lookahead, Alternative, Pop, Required, Token, \\
    Optional, NegativeLookbehind, OneOrMore, RegExp, Retrieve, Sequence, RE, Capture, \\
Eckhart Arnold's avatar
Eckhart Arnold committed
100
    ZeroOrMore, Forward, NegativeLookahead, mixin_comment, compile_source
101
102
103
104
from DHParser.syntaxtree import Node, traverse, remove_enclosing_delimiters, \\
    remove_children_if, reduce_single_child, replace_by_single_child, remove_whitespace, \\
    no_operation, remove_expendables, remove_tokens, flatten, is_whitespace, is_expendable, \\
    WHITESPACE_KEYWORD, TOKEN_KEYWORD
105
'''
di68kap's avatar
di68kap committed
106

107

Eckhart Arnold's avatar
Eckhart Arnold committed
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
DHPARSER_SCANNER = '''
def get_{NAME}_scanner():
    return {NAME}Scanner
'''


DHPARSER_GRAMMAR = '''
def get_{NAME}_grammar():
    global thread_local_{NAME}_grammar_singleton
    try:
        grammar = thread_local_{NAME}_grammar_singleton
        return grammar
    except NameError:
        thread_local_{NAME}_grammar_singleton = {NAME}Grammar()
        return thread_local_{NAME}_grammar_singleton
'''


DHPARSER_TRANSFORMER = '''
def get_{NAME}_transformer():
    return {NAME}Transform
'''


132
DHPARSER_COMPILER = '''
Eckhart Arnold's avatar
Eckhart Arnold committed
133
134
135
136
137
138
139
140
141
142
143
144
145
def get_{NAME}_compiler(grammar_name="{NAME}", grammar_source=""):
    global thread_local_{NAME}_compiler_singleton
    try:
        compiler = thread_local_{NAME}_compiler_singleton
        compiler.set_grammar_name(grammar_name, grammar_source)
        return compiler
    except NameError:
        thread_local_{NAME}_compiler_singleton = {NAME}Compiler(grammar_name, grammar_source)
        return thread_local_{NAME}_compiler_singleton 
'''


DHPARSER_MAIN = '''
146
147
148
def compile_{NAME}(source):
    """Compiles ``source`` and returns (result, errors, ast).
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
149
    with logging("LOGS"):
Eckhart Arnold's avatar
Eckhart Arnold committed
150
        compiler = get_{NAME}_compiler()
Eckhart Arnold's avatar
Eckhart Arnold committed
151
152
153
        cname = compiler.__class__.__name__
        log_file_name = os.path.basename(os.path.splitext(source)[0]) \\
            if is_filename(source) < 0 else cname[:cname.find('.')] + '_out'    
Eckhart Arnold's avatar
Eckhart Arnold committed
154
155
156
        result = compile_source(source, get_{NAME}_scanner(), 
                                get_{NAME}_grammar(),
                                get_{NAME}_transformer(), compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
157
158
    return result

159
160
161
162
163
164
165
166
167
168
169
170
171
172

if __name__ == "__main__":
    if len(sys.argv) > 1:
        result, errors, ast = compile_{NAME}(sys.argv[1])
        if errors:
            for error in errors:
                print(error)
                sys.exit(1)
        else:
            print(result)
    else:
        print("Usage: {NAME}_compiler.py [FILENAME]")
'''

173

174
def grammar_instance(grammar_representation):
175
176
177
178
179
    """Returns a grammar object and the source code of the grammar, from
    the given `grammar`-data which can be either a file name, ebnf-code,
    python-code, a GrammarBase-derived grammar class or an instance of
    such a class (i.e. a grammar object already).
    """
180
    if isinstance(grammar_representation, str):
181
        # read grammar
182
183
        grammar_src = load_if_file(grammar_representation)
        if is_python_code(grammar_representation):
184
185
            parser_py, errors, AST = grammar_src, '', None
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
186
187
            with logging(False):
                parser_py, errors, AST = compile_source(grammar_src, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
188
                    get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
189
        if errors:
190
            raise GrammarError('\n\n'.join(errors), grammar_src)
di68kap's avatar
di68kap committed
191
        parser_root = compile_python_object(DHPARSER_IMPORTS + parser_py, '\w*Grammar$')()
192
193
194
    else:
        # assume that dsl_grammar is a ParserHQ-object or Grammar class
        grammar_src = ''
195
196
        if isinstance(grammar_representation, GrammarBase):
            parser_root = grammar_representation
197
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
198
199
            # assume ``grammar_representation`` is a grammar class and get the root object
            # TODO: further case: grammar_representation is a method
200
            parser_root = grammar_representation()
201
202
203
    return parser_root, grammar_src


204
def compileDSL(text_or_file, scanner, dsl_grammar, ast_transformation, compiler):
205
    """Compiles a text in a domain specific language (DSL) with an
206
207
    EBNF-specified grammar. Returns the compiled text or raises a
    compilation error.
208
209
210
    
    Raises:
        CompilationError if any errors occured during compilation
211
212
213
    """
    assert isinstance(text_or_file, str)
    assert isinstance(compiler, CompilerBase)
Eckhart Arnold's avatar
Eckhart Arnold committed
214

215
    parser_root, grammar_src = grammar_instance(dsl_grammar)
Eckhart Arnold's avatar
Eckhart Arnold committed
216
217
218
219
220
    result, errors, AST = compile_source(text_or_file, scanner, parser_root,
                                         ast_transformation, compiler)
    if errors:
        src = load_if_file(text_or_file)
        raise CompilationError(errors, src, grammar_src, AST)
221
222
223
    return result


224
def compileEBNF(ebnf_src, ebnf_grammar_obj=None, source_only=False):
225
226
227
228
229
230
231
    """Compiles an EBNF source file into a Grammar class.

    Please note: This functions returns a class which must be 
    instantiated before calling its parse()-method! Calling the method
    directly from the class (which is technically possible in python
    yields an error message complaining about a missing parameter,
    the cause of which may not be obvious at first sight. 
232
233
234
235
236
237
238
239

    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
        ebnf_grammar_obj:  An existing instance of the 
            DHParser.EBNFcompiler.EBNFGrammar object. This can speed
            up compilation, because no new EBNFGrammar object needs to
            be instantiated.
240
241
        source_only (bool):  If True, the source code of the Grammar
            class is returned instead of the class itself.
242
243
    Returns:
        A Grammar class that can be instantiated for parsing a text
244
        which conforms to the language defined by ``ebnf_src``.
245
246
    """
    grammar = ebnf_grammar_obj or EBNFGrammar()
247
    grammar_src = compileDSL(ebnf_src, nil_scanner, grammar, EBNFTransform, EBNFCompiler())
248
249
    return grammar_src if source_only else \
        compile_python_object(DHPARSER_IMPORTS + grammar_src, '\w*Grammar$')
250
251


252
253
254
def load_compiler_suite(compiler_suite):
    """Extracts a compiler suite from file or string ``compiler suite``
    and returns it as a tuple (scanner, parser, ast, compiler).
Eckhart Arnold's avatar
Eckhart Arnold committed
255
256
257
    
    Returns:
        4-tuple (scanner function, parser class, ast transformer function, compiler class)
258
259
260
261
262
263
264
265
266
267
268
    """
    global RX_SECTION_MARKER
    assert isinstance(compiler_suite, str)
    source = load_if_file(compiler_suite)
    if is_python_code(compiler_suite):
        try:
            intro, imports, scanner_py, parser_py, ast_py, compiler_py, outro = \
                RX_SECTION_MARKER.split(source)
        except ValueError as error:
            raise AssertionError('File "' + compiler_suite + '" seems to be corrupted. '
                                 'Please delete or repair file manually.')
269
270
271
        scanner = compile_python_object(imports + scanner_py, 'get_\w*_scanner$')
        ast = compile_python_object(imports + ast_py, 'get_\w*_transformer$')
        compiler = compile_python_object(imports + compiler_py, 'get_\w*_compiler$')
272
273
    else:
        # assume source is an ebnf grammar
Eckhart Arnold's avatar
Eckhart Arnold committed
274
275
276
        with logging(False):
            parser_py, errors, AST = compile_source(source, None,
                get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
277
278
        if errors:
            raise GrammarError('\n\n'.join(errors), source)
279
280
281
282
        scanner = get_ebnf_scanner
        ast = get_ebnf_transformer
        compiler = get_ebnf_compiler
    parser = compile_python_object(DHPARSER_IMPORTS + parser_py, 'get_\w*_grammar$')
283
284
285
286

    return scanner, parser, ast, compiler


Eckhart Arnold's avatar
Eckhart Arnold committed
287
def is_outdated(compiler_suite, grammar_source):
288
289
290
291
292
293
294
295
    """Returns ``True``  if the ``compile_suite`` needs to be updated.
     
    An update is needed, if either the grammar in the compieler suite 
    does not reflect the latest changes of ``grammar_source`` or if 
    sections from the compiler suite have diligently been overwritten
    with whitespace order to trigger their recreation. Note: Do not
    delete or overwrite the section marker itself. 

296
    Args:
297
298
299
300
301
302
303
304
305
306
        compiler_suite:  the parser class representing the grammar
            or the file name of a compiler suite containing the grammar
        grammar_source:  File name or string representation of the
            EBNF code of the grammar

    Returns (bool):
        True, if ``compiler_suite`` seems to be out of date.
    """
    try:
        scanner, grammar, ast, compiler = load_compiler_suite(compiler_suite)
307
        return grammar_changed(grammar(), grammar_source)
308
309
310
311
    except ValueError:
        return True


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
def run_compiler(text_or_file, compiler_suite):
    """Compiles a source with a given compiler suite.

    Args:
        text_or_file (str):  Either the file name of the source code or
            the source code directly. (Which is determined by 
            heuristics. If ``text_or_file`` contains at least on
            linefeed then it is always assumed to be a source text and
            not a file name.)
        compiler_suite(str):  File name of the compiler suite to be
            used.
        
    Returns:
        The result of the compilation, the form and type of which 
        depends entirely on the compiler.
        
    Raises:
        CompilerError
    """
    scanner, parser, ast, compiler = load_compiler_suite(compiler_suite)
332
    return compileDSL(text_or_file, scanner(), parser(), ast(), compiler())
333
334
335


def compile_on_disk(source_file, compiler_suite="", extension=".xml"):
336
337
338
    """Compiles the a source file with a given compiler and writes the
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
339
340
341
342
343
344
    If no ``compiler_suite`` is given it is assumed that the source
    file is an EBNF grammar. In this case the result will be a Python
    script containing a parser for that grammar as well as the
    skeletons for a scanner, AST transformation table, and compiler.
    If the Python script already exists only the parser name in the
    script will be updated. (For this to work, the different names
345
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
346
347
    returns a list of error messages or an empty list if no errors
    occurred.
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
    
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
            (usually ending with '_compiler.py'), with which the source
            file shall be compiled. If this is left empty, the source
            file is assumed to be an EBNF-Grammar that will be compiled
            with the internal EBNF-Compiler.
        extension(str):  The result of the compilation (if successful)
            is written to a file with the same name but a different
            extension than the source file. This parameter sets the
            extension.
            
    Returns:
        A list of error messages or an empty list if there were no 
        errors. 
Eckhart Arnold's avatar
Eckhart Arnold committed
365
    """
366
    filepath = os.path.normpath(source_file)
367
368
    # with open(source_file, encoding="utf-8") as f:
    #     source = f.read()
369
    rootname = os.path.splitext(filepath)[0]
370
    compiler_name = os.path.basename(rootname)
371
    if compiler_suite:
372
        scanner, parser, trans, cfactory = load_compiler_suite(compiler_suite)
373
    else:
374
375
376
377
378
379
        scanner = get_ebnf_scanner
        parser = get_ebnf_grammar
        trans = get_ebnf_transformer
        cfactory = get_ebnf_compiler
    compiler1 = cfactory(compiler_name, source_file)
    result, errors, ast = compile_source(source_file, scanner(), parser(), trans(), compiler1)
380
381
382
    if errors:
        return errors

383
    elif trans == get_ebnf_transformer or trans == EBNFTransform:  # either an EBNF- or no compiler suite given
384
385
        global SECTION_MARKER, RX_SECTION_MARKER, SCANNER_SECTION, PARSER_SECTION, \
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER
386
        f = None
387
388
389
        try:
            f = open(rootname + '_compiler.py', 'r', encoding="utf-8")
            source = f.read()
390
391
            sections = RX_SECTION_MARKER.split(source)
            intro, imports, scanner, parser, ast, compiler, outro = sections
392
        except (PermissionError, FileNotFoundError, IOError) as error:
393
            intro, imports, scanner, parser, ast, compiler, outro = '', '', '', '', '', '', ''
394
395
396
397
        except ValueError as error:
            raise ValueError('File "' + rootname + '_compiler.py" seems to be corrupted. '
                                                   'Please delete or repair file manually!')
        finally:
398
399
400
            if f:
                f.close()
                f = None
401

402
403
404
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
405
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
406
407
408
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
        if RX_WHITESPACE.fullmatch(scanner):
Eckhart Arnold's avatar
Eckhart Arnold committed
409
410
            scanner = compiler1.gen_scanner_skeleton() + \
                      DHPARSER_SCANNER.format(NAME=compiler_name)
411
        if RX_WHITESPACE.fullmatch(ast):
Eckhart Arnold's avatar
Eckhart Arnold committed
412
413
            ast = compiler1.gen_AST_skeleton() + \
                  DHPARSER_TRANSFORMER.format(NAME=compiler_name)
414
        if RX_WHITESPACE.fullmatch(compiler):
Eckhart Arnold's avatar
Eckhart Arnold committed
415
416
            compiler = compiler1.gen_compiler_skeleton() + \
                       DHPARSER_COMPILER.format(NAME=compiler_name)
417

418
419
420
421
        try:
            f = open(rootname + '_compiler.py', 'w', encoding="utf-8")
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
422
            f.write(imports)
423
424
425
            f.write(SECTION_MARKER.format(marker=SCANNER_SECTION))
            f.write(scanner)
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
Eckhart Arnold's avatar
Eckhart Arnold committed
426
            f.write(result);  f.write(DHPARSER_GRAMMAR.format(NAME=compiler_name))
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
            f.write(SECTION_MARKER.format(marker=AST_SECTION))
            f.write(ast)
            f.write(SECTION_MARKER.format(marker=COMPILER_SECTION))
            f.write(compiler)
            f.write(SECTION_MARKER.format(marker=END_SECTIONS_MARKER))
            f.write(outro)
        except (PermissionError, FileNotFoundError, IOError) as error:
            print('# Could not write file "' + rootname + '_compiler.py" because of: '
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
            if f:  f.close()

    else:
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
                f.write(result.as_xml())
            else:
                f.write(result)
        except (PermissionError, FileNotFoundError, IOError) as error:
            print('# Could not write file "' + rootname + '.py" because of: '
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
            if f:  f.close()

    return []