dsl.py 24.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# dsl.py - Support for domain specific notations 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.
17
18


19
"""
20
Module ``dsl`` contains various functions to support the
21
22
23
compilation of domain specific languages based on an EBNF-grammar.
"""

24

25
import os
eckhart's avatar
eckhart committed
26
27
import platform
import stat
28

eckhart's avatar
eckhart committed
29
from DHParser.compile import Compiler, compile_source
30
from DHParser.ebnf import EBNFCompiler, grammar_changed, \
31
32
    get_ebnf_preprocessor, get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
    PreprocessorFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc
33
from DHParser.error import Error, is_error, has_errors, only_errors
34
from DHParser.log import logging
35
from DHParser.parse import Grammar
36
from DHParser.preprocess import nil_preprocessor, PreprocessorFunc
37
from DHParser.syntaxtree import Node
eckhart's avatar
eckhart committed
38
from DHParser.transform import TransformationFunc
39
from DHParser.toolkit import load_if_file, is_python_code, compile_python_object, \
eckhart's avatar
eckhart committed
40
    re, typing
41
from typing import Any, cast, List, Tuple, Union, Iterator, Iterable, Optional, Callable
eckhart's avatar
eckhart committed
42

43

44
45
__all__ = ('DHPARSER_IMPORTS',
           'GrammarError',
Eckhart Arnold's avatar
Eckhart Arnold committed
46
47
48
           'CompilationError',
           'load_compiler_suite',
           'compileDSL',
Eckhart Arnold's avatar
Eckhart Arnold committed
49
           'raw_compileEBNF',
50
           'compileEBNF',
51
           'grammar_provider',
52
53
           'compile_on_disk',
           'recompile_grammar')
Eckhart Arnold's avatar
Eckhart Arnold committed
54
55


56
57
58
59
60
61
62
63
64
SECTION_MARKER = """\n
#######################################################################
#
# {marker}
#
#######################################################################
\n"""

RX_SECTION_MARKER = re.compile(SECTION_MARKER.format(marker=r'.*?SECTION.*?'))
65
RX_WHITESPACE = re.compile(r'\s*')
66
67

SYMBOLS_SECTION = "SYMBOLS SECTION - Can be edited. Changes will be preserved."
68
PREPROCESSOR_SECTION = "PREPROCESSOR SECTION - Can be edited. Changes will be preserved."
69
70
71
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
72
END_SECTIONS_MARKER = "END OF DHPARSER-SECTIONS"
73
74


eckhart's avatar
eckhart committed
75
76
77
dhparserdir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))


78
DHPARSER_IMPORTS = '''
79
import collections
di68kap's avatar
di68kap committed
80
from functools import partial
Eckhart Arnold's avatar
Eckhart Arnold committed
81
import os
82
import sys
eckhart's avatar
eckhart committed
83

84
sys.path.append(r'{dhparserdir}')
eckhart's avatar
eckhart committed
85

di68kap's avatar
di68kap committed
86
87
88
89
try:
    import regex as re
except ImportError:
    import re
di68kap's avatar
di68kap committed
90
from DHParser import logging, is_filename, load_if_file, MockParser, \\
91
    Grammar, Compiler, nil_preprocessor, PreprocessorToken, Whitespace, \\
92
    Lookbehind, Lookahead, Alternative, Pop, Token, Synonym, AllOf, SomeOf, Unordered, \\
93
    Option, NegativeLookbehind, OneOrMore, RegExp, Retrieve, Series, Capture, \\
eckhart's avatar
eckhart committed
94
    ZeroOrMore, Forward, NegativeLookahead, Required, mixin_comment, compile_source, \\
95
    grammar_changed, last_value, counterpart, accumulate, PreprocessorFunc, \\
di68kap's avatar
di68kap committed
96
97
    Node, TransformationFunc, TransformationDict, transformation_factory, traverse, \\
    remove_children_if, move_whitespace, normalize_whitespace, is_anonymous, matches_re, \\
Eckhart Arnold's avatar
Eckhart Arnold committed
98
    reduce_single_child, replace_by_single_child, replace_or_reduce, remove_whitespace, \\
di68kap's avatar
di68kap committed
99
100
    remove_expendables, remove_empty, remove_tokens, flatten, is_whitespace, is_empty, \\
    is_expendable, collapse, collapse_if, replace_content, WHITESPACE_PTYPE, TOKEN_PTYPE, \\
101
    remove_nodes, remove_content, remove_brackets, replace_parser, remove_anonymous_tokens, \\
di68kap's avatar
di68kap committed
102
    keep_children, is_one_of, not_one_of, has_content, apply_if, remove_first, remove_last, \\
103
    remove_anonymous_empty, keep_nodes, traverse_locally, strip, lstrip, rstrip, \\
104
    replace_content, replace_content_by, error_on, recompile_grammar
eckhart's avatar
eckhart committed
105
'''.format(dhparserdir=dhparserdir)
di68kap's avatar
di68kap committed
106

107

Eckhart Arnold's avatar
Eckhart Arnold committed
108
DHPARSER_MAIN = '''
109
def compile_src(source, log_dir=''):
110
111
    """Compiles ``source`` and returns (result, errors, ast).
    """
di68kap's avatar
di68kap committed
112
    with logging(log_dir):
113
        compiler = get_compiler()
Eckhart Arnold's avatar
Eckhart Arnold committed
114
        cname = compiler.__class__.__name__
115
        result = compile_source(source, get_preprocessor(),
116
117
                                get_grammar(),
                                get_transformer(), compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
118
119
    return result

120
121

if __name__ == "__main__":
122
123
124
125
126
127
128
129
130
131
132
133
134
    # recompile grammar if needed
    grammar_path = os.path.abspath(__file__).replace('Compiler.py', '.ebnf')
    if os.path.exists(grammar_path):
        if not recompile_grammar(grammar_path, force=False,
                                  notify=lambda:print('recompiling ' + grammar_path)):
            error_file = os.path.basename(__file__).replace('Compiler.py', '_ebnf_ERRORS.txt')
            with open(error_file, encoding="utf-8") as f:
                print(f.read())
            sys.exit(1)
    else:
        print('Could not check whether grammar requires recompiling, '
              'because grammar was not found at: ' + grammar_path)

135
    if len(sys.argv) > 1:
136
        # compile file
di68kap's avatar
di68kap committed
137
138
139
        file_name, log_dir = sys.argv[1], ''
        if file_name in ['-d', '--debug'] and len(sys.argv) > 2:
            file_name, log_dir = sys.argv[2], 'LOGS'
140
        result, errors, ast = compile_src(file_name, log_dir)
141
        if errors:
di68kap's avatar
di68kap committed
142
143
            cwd = os.getcwd()
            rel_path = file_name[len(cwd):] if file_name.startswith(cwd) else file_name
144
            for error in errors:
di68kap's avatar
di68kap committed
145
                print(rel_path + ':' + str(error))
146
            sys.exit(1)
147
        else:
148
            print(result.as_xml() if isinstance(result, Node) else result)
149
    else:
150
        print("Usage: {NAME}Compiler.py [FILENAME]")
151
152
'''

153

154
155
156
157
158
class DSLException(Exception):
    """
    Base class for DSL-exceptions.
    """
    def __init__(self, errors):
Eckhart Arnold's avatar
Eckhart Arnold committed
159
        assert isinstance(errors, Iterator) or isinstance(errors, list) \
160
            or isinstance(errors, tuple)
161
162
163
164
165
166
167
        self.errors = errors

    def __str__(self):
        return '\n'.join(str(err) for err in self.errors)


class GrammarError(DSLException):
168
169
    """
    Raised when (already) the grammar of a domain specific language (DSL)
170
171
    contains errors.
    """
172
173
    def __init__(self, errors, grammar_src):
        super().__init__(errors)
174
175
176
        self.grammar_src = grammar_src


177
class CompilationError(DSLException):
178
179
    """
    Raised when a string or file in a domain specific language (DSL)
180
181
    contains errors.
    """
182
183
    def __init__(self, errors, dsl_text, dsl_grammar, AST, result):
        super().__init__(errors)
184
185
186
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST
187
        self.result = result
188
189


190
191
192
193
194
def error_str(messages: Iterable[Error]) -> str:
    """
    Returns all true errors (i.e. not just warnings) from the
    `messages` as a concatenated multiline string.
    """
195
    return '\n\n'.join(str(m) for m in messages if is_error(m.code))
196
197


198
def grammar_instance(grammar_representation) -> Tuple[Grammar, str]:
199
200
    """
    Returns a grammar object and the source code of the grammar, from
201
    the given `grammar`-data which can be either a file name, ebnf-code,
202
    python-code, a Grammar-derived grammar class or an instance of
203
204
    such a class (i.e. a grammar object already).
    """
205
    if isinstance(grammar_representation, str):
206
        # read grammar
207
        grammar_src = load_if_file(grammar_representation)
208
        if is_python_code(grammar_src):
eckhart's avatar
eckhart committed
209
            parser_py, messages = grammar_src, []  # type: str, List[Error]
210
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
211
            with logging(False):
212
                result, messages, _ = compile_source(
eckhart's avatar
eckhart committed
213
                    grammar_src, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
214
                    get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
215
                parser_py = cast(str, result)
216
        if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
217
            raise GrammarError(only_errors(messages), grammar_src)
eckhart's avatar
eckhart committed
218
        parser_root = compile_python_object(DHPARSER_IMPORTS + parser_py, r'\w+Grammar$')()
219
220
221
    else:
        # assume that dsl_grammar is a ParserHQ-object or Grammar class
        grammar_src = ''
222
        if isinstance(grammar_representation, Grammar):
223
            parser_root = grammar_representation
224
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
225
            # assume ``grammar_representation`` is a grammar class and get the root object
226
            parser_root = grammar_representation()
227
228
229
    return parser_root, grammar_src


230
def compileDSL(text_or_file: str,
231
               preprocessor: Optional[PreprocessorFunc],
232
               dsl_grammar: Union[str, Grammar],
233
               ast_transformation: TransformationFunc,
234
               compiler: Compiler) -> Any:
235
236
    """
    Compiles a text in a domain specific language (DSL) with an
237
238
    EBNF-specified grammar. Returns the compiled text or raises a
    compilation error.
eckhart's avatar
eckhart committed
239

240
    Raises:
241
        CompilationError if any errors occurred during compilation
242
243
    """
    assert isinstance(text_or_file, str)
244
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
245

246
    parser, grammar_src = grammar_instance(dsl_grammar)
247
    result, messages, AST = compile_source(text_or_file, preprocessor, parser,
248
                                           ast_transformation, compiler)
249
    if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
250
        src = load_if_file(text_or_file)
Eckhart Arnold's avatar
Eckhart Arnold committed
251
        raise CompilationError(only_errors(messages), src, grammar_src, AST, result)
252
253
254
    return result


255
def raw_compileEBNF(ebnf_src: str, branding="DSL") -> EBNFCompiler:
256
257
    """
    Compiles an EBNF grammar file and returns the compiler object
Eckhart Arnold's avatar
Eckhart Arnold committed
258
    that was used and which can now be queried for the result as well
259
    as skeleton code for preprocessor, transformer and compiler objects.
eckhart's avatar
eckhart committed
260

Eckhart Arnold's avatar
Eckhart Arnold committed
261
262
263
264
    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
eckhart's avatar
eckhart committed
265
            code.
Eckhart Arnold's avatar
Eckhart Arnold committed
266
267
268
    Returns:
        An instance of class ``ebnf.EBNFCompiler``
    Raises:
eckhart's avatar
eckhart committed
269
        CompilationError if any errors occurred during compilation
Eckhart Arnold's avatar
Eckhart Arnold committed
270
271
    """
    grammar = get_ebnf_grammar()
272
    compiler = get_ebnf_compiler(branding, ebnf_src)
273
274
    transformer = get_ebnf_transformer()
    compileDSL(ebnf_src, nil_preprocessor, grammar, transformer, compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
275
276
277
    return compiler


278
def compileEBNF(ebnf_src: str, branding="DSL") -> str:
279
280
    """
    Compiles an EBNF source file and returns the source code of a
281
    compiler suite with skeletons for preprocessor, transformer and
Eckhart Arnold's avatar
Eckhart Arnold committed
282
    compiler.
283
284
285
286

    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
287
        branding (str):  Branding name for the compiler suite source
eckhart's avatar
eckhart committed
288
            code.
289
    Returns:
290
        The complete compiler suite skeleton as Python source code.
291
    Raises:
eckhart's avatar
eckhart committed
292
        CompilationError if any errors occurred during compilation
293
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
294
    compiler = raw_compileEBNF(ebnf_src, branding)
295
296
    src = ["#/usr/bin/python\n",
           SECTION_MARKER.format(marker=SYMBOLS_SECTION), DHPARSER_IMPORTS,
297
           SECTION_MARKER.format(marker=PREPROCESSOR_SECTION), compiler.gen_preprocessor_skeleton(),
Eckhart Arnold's avatar
Eckhart Arnold committed
298
           SECTION_MARKER.format(marker=PARSER_SECTION), compiler.result,
299
300
301
           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)]
302
303
304
    return '\n'.join(src)


305
def grammar_provider(ebnf_src: str, branding="DSL") -> Grammar:
306
    """
307
    Compiles an EBNF grammar and returns a grammar-parser provider
308
309
310
311
312
313
    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
eckhart's avatar
eckhart committed
314
315
            suite source code.

316
    Returns:
317
        A provider function for a grammar object for texts in the
318
319
        language defined by ``ebnf_src``.
    """
320
    grammar_src = compileDSL(ebnf_src, nil_preprocessor, get_ebnf_grammar(),
eckhart's avatar
eckhart committed
321
322
323
324
                             get_ebnf_transformer(), get_ebnf_compiler(branding, ebnf_src))
    grammar_obj = compile_python_object(DHPARSER_IMPORTS + grammar_src, r'get_(?:\w+_)?grammar$')
    grammar_obj.python_src__ = grammar_src
    return grammar_obj
325
326


327
def load_compiler_suite(compiler_suite: str) -> \
328
329
        Tuple[PreprocessorFactoryFunc, ParserFactoryFunc,
              TransformerFactoryFunc, CompilerFactoryFunc]:
330
    """
331
    Extracts a compiler suite from file or string `compiler_suite`
332
    and returns it as a tuple (preprocessor, parser, ast, compiler).
eckhart's avatar
eckhart committed
333

Eckhart Arnold's avatar
Eckhart Arnold committed
334
    Returns:
335
336
        4-tuple (preprocessor function, parser class,
                 ast transformer function, compiler class)
337
338
339
340
    """
    global RX_SECTION_MARKER
    assert isinstance(compiler_suite, str)
    source = load_if_file(compiler_suite)
341
    imports = DHPARSER_IMPORTS
342
343
    if is_python_code(compiler_suite):
        try:
eckhart's avatar
eckhart committed
344
            _, imports, preprocessor_py, parser_py, ast_py, compiler_py, _ = \
345
                RX_SECTION_MARKER.split(source)
eckhart's avatar
eckhart committed
346
        except ValueError:
347
348
            raise AssertionError('File "' + compiler_suite + '" seems to be corrupted. '
                                 'Please delete or repair file manually.')
349
        # TODO: Compile in one step and pick parts from namespace later ?
eckhart's avatar
eckhart committed
350
351
352
353
        preprocessor = compile_python_object(imports + preprocessor_py,
                                             r'get_(?:\w+_)?preprocessor$')
        parser = compile_python_object(imports + parser_py, r'get_(?:\w+_)?grammar$')
        ast = compile_python_object(imports + ast_py, r'get_(?:\w+_)?transformer$')
354
    else:
355
356
        # Assume source is an ebnf grammar.
        # Is there really any reasonable application case for this?
Eckhart Arnold's avatar
Eckhart Arnold committed
357
        with logging(False):
eckhart's avatar
eckhart committed
358
            compiler_py, messages, n = compile_source(source, None, get_ebnf_grammar(),
eckhart's avatar
eckhart committed
359
360
                                                      get_ebnf_transformer(),
                                                      get_ebnf_compiler(compiler_suite, source))
361
        if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
362
            raise GrammarError(only_errors(messages), source)
363
        preprocessor = get_ebnf_preprocessor
364
        parser = get_ebnf_grammar
365
        ast = get_ebnf_transformer
eckhart's avatar
eckhart committed
366
    compiler = compile_python_object(imports + compiler_py, r'get_(?:\w+_)?compiler$')
367

368
    return preprocessor, parser, ast, compiler
369
370


371
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
372
373
    """
    Returns ``True``  if the ``compile_suite`` needs to be updated.
eckhart's avatar
eckhart committed
374
375
376

    An update is needed, if either the grammar in the compieler suite
    does not reflect the latest changes of ``grammar_source`` or if
377
378
    sections from the compiler suite have diligently been overwritten
    with whitespace order to trigger their recreation. Note: Do not
eckhart's avatar
eckhart committed
379
    delete or overwrite the section marker itself.
380

381
    Args:
382
383
384
385
386
387
388
389
390
        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:
eckhart's avatar
eckhart committed
391
        n1, grammar, n2, n3 = load_compiler_suite(compiler_suite)
392
        return grammar_changed(grammar(), grammar_source)
393
394
395
396
    except ValueError:
        return True


397
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
398
399
400
401
    """Compiles a source with a given compiler suite.

    Args:
        text_or_file (str):  Either the file name of the source code or
eckhart's avatar
eckhart committed
402
            the source code directly. (Which is determined by
403
404
405
406
407
            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.
eckhart's avatar
eckhart committed
408

409
    Returns:
eckhart's avatar
eckhart committed
410
        The result of the compilation, the form and type of which
411
        depends entirely on the compiler.
eckhart's avatar
eckhart committed
412

413
414
415
    Raises:
        CompilerError
    """
416
417
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
418
419


420
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml") -> Iterable[Error]:
421
422
    """
    Compiles the a source file with a given compiler and writes the
423
424
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
425
426
427
    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
428
    skeletons for a preprocessor, AST transformation table, and compiler.
Eckhart Arnold's avatar
Eckhart Arnold committed
429
430
    If the Python script already exists only the parser name in the
    script will be updated. (For this to work, the different names
431
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
432
433
    returns a list of error messages or an empty list if no errors
    occurred.
434

435
436
437
438
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
439
            (usually ending with 'Compiler.py'), with which the source
440
441
442
443
444
445
446
            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.
eckhart's avatar
eckhart committed
447

448
    Returns:
449
        A (potentially empty) list of error or warning messages.
Eckhart Arnold's avatar
Eckhart Arnold committed
450
    """
451
    filepath = os.path.normpath(source_file)
452
453
    with open(source_file, encoding="utf-8") as f:
        source = f.read()
454
    rootname = os.path.splitext(filepath)[0]
455
    compiler_name = os.path.basename(rootname)
456
    if compiler_suite:
457
        sfactory, pfactory, tfactory, cfactory = load_compiler_suite(compiler_suite)
458
    else:
459
        sfactory = get_ebnf_preprocessor
460
461
        pfactory = get_ebnf_grammar
        tfactory = get_ebnf_transformer
462
        cfactory = get_ebnf_compiler
463
464
    compiler1 = cfactory()
    compiler1.set_grammar_name(compiler_name, source_file)
465
    result, messages, _ = compile_source(source, sfactory(), pfactory(), tfactory(), compiler1)
eckhart's avatar
eckhart committed
466

467
468
    if has_errors(messages):
        return messages
469

470
471
472
    elif cfactory == get_ebnf_compiler:
        # trans == get_ebnf_transformer or trans == EBNFTransformer:
        # either an EBNF- or no compiler suite given
473
        ebnf_compiler = cast(EBNFCompiler, compiler1)
474
        global SECTION_MARKER, RX_SECTION_MARKER, PREPROCESSOR_SECTION, PARSER_SECTION, \
Eckhart Arnold's avatar
Eckhart Arnold committed
475
476
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER, RX_WHITESPACE, \
            DHPARSER_MAIN, DHPARSER_IMPORTS
477
        f = None
478
        try:
479
            f = open(rootname + 'Compiler.py', 'r', encoding="utf-8")
480
            source = f.read()
481
            sections = RX_SECTION_MARKER.split(source)
482
            intro, imports, preprocessor, _, ast, compiler, outro = sections
483
484
485
486
            # TODO: Verify transformation table
            ast_trans_table = compile_python_object(DHPARSER_IMPORTS + ast,
                                                    r'(?:\w+_)?AST_transformation_table$')
            messages.extend(ebnf_compiler.verify_transformation_table(ast_trans_table))
487
488
489
        except (PermissionError, FileNotFoundError, IOError):
            intro, imports, preprocessor, _, ast, compiler, outro = '', '', '', '', '', '', ''
        except ValueError:
490
            name = '"' + rootname + 'Compiler.py"'
eckhart's avatar
eckhart committed
491
492
            raise ValueError('Could not identify all required sections in ' + name
                             + '. Please delete or repair ' + name + ' manually!')
493
        finally:
494
495
496
            if f:
                f.close()
                f = None
497

498
499
500
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
501
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
502
503
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
504
505
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
506
        if RX_WHITESPACE.fullmatch(ast):
507
            ast = ebnf_compiler.gen_transformer_skeleton()
508
        if RX_WHITESPACE.fullmatch(compiler):
509
            compiler = ebnf_compiler.gen_compiler_skeleton()
510

eckhart's avatar
eckhart committed
511
        compilerscript = rootname + 'Compiler.py'
512
        try:
eckhart's avatar
eckhart committed
513
            f = open(compilerscript, 'w', encoding="utf-8")
514
515
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
516
            f.write(imports)
517
518
            f.write(SECTION_MARKER.format(marker=PREPROCESSOR_SECTION))
            f.write(preprocessor)
519
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
eckhart's avatar
eckhart committed
520
            f.write(cast(str, result))
521
522
523
524
525
526
527
            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:
eckhart's avatar
eckhart committed
528
            print('# Could not write file "' + compilerscript + '" because of: '
529
530
531
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
532
533
            if f:
                f.close()
534

eckhart's avatar
eckhart committed
535
536
537
538
539
        if platform.system() != "Windows":
            # set file permissions so that the compilerscript can be executed
            st = os.stat(compilerscript)
            os.chmod(compilerscript, st.st_mode | stat.S_IEXEC)

540
    else:
541
        f = None
542
543
544
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
545
546
547
548
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
549
550
551
552
553
554
555
            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:
556
557
            if f:
                f.close()
558

559
    return messages
560
561


562
def recompile_grammar(ebnf_filename, force=False,
eckhart's avatar
eckhart committed
563
                      notify: Callable = lambda: None) -> bool:
564
    """
565
    Re-compiles an EBNF-grammar if necessary, that is, if either no
566
567
568
569
    corresponding 'XXXXCompiler.py'-file exists or if that file is
    outdated.

    Parameters:
570
571
572
        ebnf_filename(str):  The filename of the ebnf-source of the grammar.
            In case this is a directory and not a file, all files within
            this directory ending with .ebnf will be compiled.
573
574
        force(bool):  If False (default), the grammar will only be
            recompiled if it has been changed.
575
576
577
        notify(Callable):  'notify' is a function without parameters that
            is called when recompilation actually takes place. This can
            be used to inform the user.
578
579
580
581
582
583
584
585
    """
    if os.path.isdir(ebnf_filename):
        success = True
        for entry in os.listdir(ebnf_filename):
            if entry.lower().endswith('.ebnf') and os.path.isfile(entry):
                success = success and recompile_grammar(entry, force)
        return success

586
    base, _ = os.path.splitext(ebnf_filename)
587
588
    compiler_name = base + 'Compiler.py'
    error_file_name = base + '_ebnf_ERRORS.txt'
589
    messages = []  # type: Iterable[Error]
590
591
    if (not os.path.exists(compiler_name) or force or
            grammar_changed(compiler_name, ebnf_filename)):
592
        notify()
593
594
        messages = compile_on_disk(ebnf_filename)
        if messages:
595
            # print("Errors while compiling: " + ebnf_filename + '!')
Eckhart Arnold's avatar
Eckhart Arnold committed
596
            with open(error_file_name, 'w', encoding="utf-8") as f:
597
                for e in messages:
Eckhart Arnold's avatar
Eckhart Arnold committed
598
                    f.write(str(e))
599
                    f.write('\n')
600
601
            if has_errors(messages):
                return False
602

603
    if not messages and os.path.exists(error_file_name):
604
605
        os.remove(error_file_name)
    return True