dsl.py 18.7 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
22
23
24
25
26

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

import os
try:
    import regex as re
except ImportError:
    import re
Eckhart Arnold's avatar
Eckhart Arnold committed
27
from .typing import Any, cast, Tuple, Union
28

29
30
31
32
33
from DHParser.ebnf import EBNFTransformer, EBNFCompiler, grammar_changed, \
    get_ebnf_scanner, get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
    ScannerFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc
from DHParser.toolkit import logging, load_if_file, is_python_code, compile_python_object
from DHParser.parsers import Grammar, Compiler, compile_source, nil_scanner, ScannerFunc
34
from DHParser.syntaxtree import Node, TransformationFunc
35

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

__all__ = ['GrammarError',
           'CompilationError',
           'load_compiler_suite',
           'compileDSL',
Eckhart Arnold's avatar
Eckhart Arnold committed
41
           'raw_compileEBNF',
42
           'compileEBNF',
43
           'parser_factory',
44
           'compile_on_disk']
Eckhart Arnold's avatar
Eckhart Arnold committed
45
46


47
48
49
50
51
52
53
54
55
SECTION_MARKER = """\n
#######################################################################
#
# {marker}
#
#######################################################################
\n"""

RX_SECTION_MARKER = re.compile(SECTION_MARKER.format(marker=r'.*?SECTION.*?'))
56
RX_WHITESPACE = re.compile('\s*')
57
58
59
60
61
62

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
63
END_SECTIONS_MARKER = "END OF DHPARSER-SECTIONS"
64
65


66
DHPARSER_IMPORTS = '''
di68kap's avatar
di68kap committed
67
from functools import partial
Eckhart Arnold's avatar
Eckhart Arnold committed
68
import os
69
import sys
di68kap's avatar
di68kap committed
70
71
72
73
try:
    import regex as re
except ImportError:
    import re
Eckhart Arnold's avatar
Eckhart Arnold committed
74
from DHParser.toolkit import logging, is_filename, load_if_file    
75
from DHParser.parsers import Grammar, Compiler, nil_scanner, \\
76
    Lookbehind, Lookahead, Alternative, Pop, Required, Token, Synonym, \\
di68kap's avatar
di68kap committed
77
    Optional, NegativeLookbehind, OneOrMore, RegExp, Retrieve, Sequence, RE, Capture, \\
78
    ZeroOrMore, Forward, NegativeLookahead, mixin_comment, compile_source, \\
79
    last_value, counterpart, accumulate, ScannerFunc
80
81
from DHParser.syntaxtree import Node, traverse, remove_enclosing_delimiters, \\
    remove_children_if, reduce_single_child, replace_by_single_child, remove_whitespace, \\
82
83
    no_transformation, remove_expendables, remove_tokens, flatten, is_whitespace, is_expendable, \\
    collapse, map_content, WHITESPACE_PTYPE, TOKEN_PTYPE, TransformationFunc
84
'''
di68kap's avatar
di68kap committed
85

86

Eckhart Arnold's avatar
Eckhart Arnold committed
87
DHPARSER_MAIN = '''
88
def compile_src(source):
89
90
    """Compiles ``source`` and returns (result, errors, ast).
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
91
    with logging("LOGS"):
92
        compiler = get_compiler()
Eckhart Arnold's avatar
Eckhart Arnold committed
93
94
95
        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'    
96
97
98
        result = compile_source(source, get_scanner(), 
                                get_grammar(),
                                get_transformer(), compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
99
100
    return result

101
102
103

if __name__ == "__main__":
    if len(sys.argv) > 1:
104
        result, errors, ast = compile_src(sys.argv[1])
105
106
107
        if errors:
            for error in errors:
                print(error)
108
            sys.exit(1)
109
110
111
        else:
            print(result)
    else:
112
        print("Usage: {NAME}Compiler.py [FILENAME]")
113
114
'''

115

116
117
118
119
120
121
122
123
124
125
126
127
128
129
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.
    """
130
    def __init__(self, error_messages, dsl_text, dsl_grammar, AST, result):
131
132
133
134
        self.error_messages = error_messages
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST
135
        self.result = result
136
137
138
139
140

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


141
def grammar_instance(grammar_representation) -> Tuple[Grammar, str]:
142
143
    """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,
144
    python-code, a Grammar-derived grammar class or an instance of
145
146
    such a class (i.e. a grammar object already).
    """
147
    if isinstance(grammar_representation, str):
148
        # read grammar
149
        grammar_src = load_if_file(grammar_representation)
150
        if is_python_code(grammar_src):
151
152
            parser_py, errors, AST = grammar_src, '', None
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
153
154
            with logging(False):
                parser_py, errors, AST = compile_source(grammar_src, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
155
                    get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
156
        if errors:
157
            raise GrammarError('\n\n'.join(errors), grammar_src)
158
        parser_root = compile_python_object(DHPARSER_IMPORTS + parser_py, '\w+Grammar$')()
159
160
161
    else:
        # assume that dsl_grammar is a ParserHQ-object or Grammar class
        grammar_src = ''
162
        if isinstance(grammar_representation, Grammar):
163
            parser_root = grammar_representation
164
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
165
            # assume ``grammar_representation`` is a grammar class and get the root object
166
            parser_root = grammar_representation()
167
168
169
    return parser_root, grammar_src


170
171
def compileDSL(text_or_file: str,
               scanner: ScannerFunc,
172
               dsl_grammar: Union[str, Grammar],
173
               ast_transformation: TransformationFunc,
174
               compiler: Compiler) -> Any:
175
    """Compiles a text in a domain specific language (DSL) with an
176
177
    EBNF-specified grammar. Returns the compiled text or raises a
    compilation error.
178
179
    
    Raises:
180
        CompilationError if any errors occurred during compilation
181
182
    """
    assert isinstance(text_or_file, str)
183
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
184

185
186
    parser, grammar_src = grammar_instance(dsl_grammar)
    result, errors, AST = compile_source(text_or_file, scanner, parser,
Eckhart Arnold's avatar
Eckhart Arnold committed
187
188
189
                                         ast_transformation, compiler)
    if errors:
        src = load_if_file(text_or_file)
190
        raise CompilationError(errors, src, grammar_src, AST, result)
191
192
193
    return result


194
def raw_compileEBNF(ebnf_src: str, branding="DSL") -> EBNFCompiler:
Eckhart Arnold's avatar
Eckhart Arnold committed
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
    """Compiles an EBNF grammar file and returns the compiler object
    that was used and which can now be queried for the result as well
    as skeleton code for scanner, transformer and compiler objects.
    
    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
        branding (str):  Branding name for the compiler suite source
            code. 
    Returns:
        An instance of class ``ebnf.EBNFCompiler``
    Raises:
        CompilationError if any errors occurred during compilation      
    """
    grammar = get_ebnf_grammar()
    compiler = get_ebnf_compiler(branding , ebnf_src)
    compileDSL(ebnf_src, nil_scanner, grammar, EBNFTransformer, compiler)
    return compiler


215
def compileEBNF(ebnf_src: str, branding="DSL") -> str:
Eckhart Arnold's avatar
Eckhart Arnold committed
216
217
218
    """Compiles an EBNF source file and returns the source code of a
    compiler suite with skeletons for scanner, transformer and 
    compiler.
219
220
221
222

    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
223
224
        branding (str):  Branding name for the compiler suite source
            code. 
225
    Returns:
226
        The complete compiler suite skeleton as Python source code.
227
228
    Raises:
        CompilationError if any errors occurred during compilation        
229
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
230
    compiler = raw_compileEBNF(ebnf_src, branding)
231
232
233
    src = ["#/usr/bin/python\n",
           SECTION_MARKER.format(marker=SYMBOLS_SECTION), DHPARSER_IMPORTS,
           SECTION_MARKER.format(marker=SCANNER_SECTION), compiler.gen_scanner_skeleton(),
Eckhart Arnold's avatar
Eckhart Arnold committed
234
           SECTION_MARKER.format(marker=PARSER_SECTION), compiler.result,
235
236
237
           SECTION_MARKER.format(marker=AST_SECTION), compiler.gen_transformer_skeleton(),
           SECTION_MARKER.format(marker=COMPILER_SECTION), compiler.gen_compiler_skeleton(),
           SECTION_MARKER.format(marker=SYMBOLS_SECTION), DHPARSER_MAIN.format(NAME=branding)]
238
239
240
    return '\n'.join(src)


241
def parser_factory(ebnf_src: str, branding="DSL") -> Grammar:
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
    """Compiles an EBNF grammar and returns a grammar-parser factory
    function for that grammar.

    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
        branding (str or bool):  Branding name for the compiler
            suite source code. 
    
    Returns:
        A factory function for a grammar-parser for texts in the
        language defined by ``ebnf_src``.
    """
    grammar_src = compileDSL(ebnf_src, nil_scanner, get_ebnf_grammar(),
                             get_ebnf_transformer(), get_ebnf_compiler(branding))
257
    return compile_python_object(DHPARSER_IMPORTS + grammar_src, 'get_(?:\w+_)?grammar$')
258
259


260
261
def load_compiler_suite(compiler_suite: str) -> \
        Tuple[ScannerFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc]:
262
263
    """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
264
265
266
    
    Returns:
        4-tuple (scanner function, parser class, ast transformer function, compiler class)
267
268
269
270
271
272
273
274
275
276
277
    """
    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.')
278
        # TODO: Compile in one step and pick parts from namespace later ?
279
280
281
        scanner = compile_python_object(imports + scanner_py, 'get_(?:\w+_)?scanner$')
        parser = compile_python_object(imports + parser_py, 'get_(?:\w+_)?grammar$')
        ast = compile_python_object(imports + ast_py, 'get_(?:\w+_)?transformer$')
282
    else:
283
        # assume source is an ebnf grammar. Is there really any reasonable application case for this?
Eckhart Arnold's avatar
Eckhart Arnold committed
284
        with logging(False):
285
            compile_py, errors, AST = compile_source(source, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
286
                get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
287
288
        if errors:
            raise GrammarError('\n\n'.join(errors), source)
289
        scanner = get_ebnf_scanner
290
        parser = get_ebnf_grammar
291
        ast = get_ebnf_transformer
292
    compiler = compile_python_object(imports + compiler_py, 'get_(?:\w+_)?compiler$')
293
294
295
296

    return scanner, parser, ast, compiler


297
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
298
299
300
301
302
303
304
305
    """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. 

306
    Args:
307
308
309
310
311
312
313
314
315
316
        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)
317
        return grammar_changed(grammar(), grammar_source)
318
319
320
321
    except ValueError:
        return True


322
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
    """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)
342
    return compileDSL(text_or_file, scanner(), parser(), ast(), compiler())
343
344


345
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml"):
346
347
348
    """Compiles the a source file with a given compiler and writes the
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
349
350
351
352
353
354
    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
355
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
356
357
    returns a list of error messages or an empty list if no errors
    occurred.
358
359
360
361
362
    
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
363
            (usually ending with 'Compiler.py'), with which the source
364
365
366
367
368
369
370
371
372
373
374
            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
375
    """
376
    filepath = os.path.normpath(source_file)
377
378
    # with open(source_file, encoding="utf-8") as f:
    #     source = f.read()
379
    rootname = os.path.splitext(filepath)[0]
380
    compiler_name = os.path.basename(rootname)
381
    if compiler_suite:
382
        sfactory, pfactory, tfactory, cfactory = load_compiler_suite(compiler_suite)
383
    else:
384
385
386
        sfactory = get_ebnf_scanner
        pfactory = get_ebnf_grammar
        tfactory = get_ebnf_transformer
387
        cfactory = get_ebnf_compiler
388
389
390
    compiler1 = cfactory()
    compiler1.set_grammar_name(compiler_name, source_file)
    result, errors, ast = compile_source(source_file, sfactory(), pfactory(), tfactory(), compiler1)
391
392
393
    if errors:
        return errors

394
    elif cfactory == get_ebnf_compiler:  # trans == get_ebnf_transformer or trans == EBNFTransformer:  # either an EBNF- or no compiler suite given
395
        ebnf_compiler = cast(EBNFCompiler, compiler1)
396
        global SECTION_MARKER, RX_SECTION_MARKER, SCANNER_SECTION, PARSER_SECTION, \
Eckhart Arnold's avatar
Eckhart Arnold committed
397
398
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER, RX_WHITESPACE, \
            DHPARSER_MAIN, DHPARSER_IMPORTS
399
        f = None
400
        try:
401
            f = open(rootname + 'Compiler.py', 'r', encoding="utf-8")
402
            source = f.read()
403
404
            sections = RX_SECTION_MARKER.split(source)
            intro, imports, scanner, parser, ast, compiler, outro = sections
405
        except (PermissionError, FileNotFoundError, IOError) as error:
406
            intro, imports, scanner, parser, ast, compiler, outro = '', '', '', '', '', '', ''
407
        except ValueError as error:
408
409
410
            name = '"' + rootname + 'Compiler.py"'
            raise ValueError('Could not identify all required sections in ' + name +
                             '. Please delete or repair ' + name + ' manually!')
411
        finally:
412
413
414
            if f:
                f.close()
                f = None
415

416
417
418
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
419
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
420
421
422
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
        if RX_WHITESPACE.fullmatch(scanner):
423
            scanner = ebnf_compiler.gen_scanner_skeleton()
424
        if RX_WHITESPACE.fullmatch(ast):
425
            ast = ebnf_compiler.gen_transformer_skeleton()
426
        if RX_WHITESPACE.fullmatch(compiler):
427
            compiler = ebnf_compiler.gen_compiler_skeleton()
428

429
        try:
430
            f = open(rootname + 'Compiler.py', 'w', encoding="utf-8")
431
432
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
433
            f.write(imports)
434
435
436
            f.write(SECTION_MARKER.format(marker=SCANNER_SECTION))
            f.write(scanner)
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
437
            f.write(result)
438
439
440
441
442
443
444
            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:
445
            print('# Could not write file "' + rootname + 'Compiler.py" because of: '
446
447
448
449
450
451
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
            if f:  f.close()

    else:
452
        f = None
453
454
455
456
457
458
459
460
461
462
463
464
465
466
        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 []