dsl.py 22.5 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

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
Module ``dsl`` contains various functions to support the
19
20
21
22
compilation of domain specific languages based on an EBNF-grammar.
"""

import os
23
from typing import Any, cast, List, Tuple, Union, Iterator, Iterable
24

25
from DHParser.ebnf import EBNFCompiler, grammar_changed, \
26
27
    get_ebnf_preprocessor, get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
    PreprocessorFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc
28
from DHParser.error import Error, is_error, has_errors, only_errors
29
from DHParser.log import logging
30
31
from DHParser.parse import Grammar, Compiler, compile_source
from DHParser.preprocess import nil_preprocessor, PreprocessorFunc
32
from DHParser.syntaxtree import Node, TransformationFunc
33
from DHParser.toolkit import load_if_file, is_python_code, compile_python_object, \
34
    re
35

36
37
__all__ = ('DHPARSER_IMPORTS',
           'GrammarError',
Eckhart Arnold's avatar
Eckhart Arnold committed
38
39
40
           'CompilationError',
           'load_compiler_suite',
           'compileDSL',
Eckhart Arnold's avatar
Eckhart Arnold committed
41
           'raw_compileEBNF',
42
           'compileEBNF',
43
           'grammar_provider',
44
45
           'compile_on_disk',
           'recompile_grammar')
Eckhart Arnold's avatar
Eckhart Arnold committed
46
47


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

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

SYMBOLS_SECTION = "SYMBOLS SECTION - Can be edited. Changes will be preserved."
60
PREPROCESSOR_SECTION = "PREPROCESSOR SECTION - Can be edited. Changes will be preserved."
61
62
63
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
64
END_SECTIONS_MARKER = "END OF DHPARSER-SECTIONS"
65
66


67
DHPARSER_IMPORTS = '''
di68kap's avatar
di68kap committed
68
from functools import partial
Eckhart Arnold's avatar
Eckhart Arnold committed
69
import os
70
import sys
di68kap's avatar
di68kap committed
71
72
73
74
try:
    import regex as re
except ImportError:
    import re
75
from DHParser import logging, is_filename, load_if_file, \\
76
    Grammar, Compiler, nil_preprocessor, PreprocessorToken, \\
77
    Lookbehind, Lookahead, Alternative, Pop, Token, Synonym, AllOf, SomeOf, Unordered, \\
78
    Option, NegativeLookbehind, OneOrMore, RegExp, Retrieve, Series, RE, Capture, \\
79
    ZeroOrMore, Forward, NegativeLookahead, mixin_comment, compile_source, \\
80
    last_value, counterpart, accumulate, PreprocessorFunc, \\
eckhart's avatar
eckhart committed
81
    Node, TransformationFunc, TransformationDict, \\
82
    traverse, remove_children_if, merge_children, is_anonymous, \\
Eckhart Arnold's avatar
Eckhart Arnold committed
83
    reduce_single_child, replace_by_single_child, replace_or_reduce, remove_whitespace, \\
84
    remove_expendables, remove_empty, remove_tokens, flatten, is_whitespace, \\
85
    is_empty, is_expendable, collapse, replace_content, WHITESPACE_PTYPE, TOKEN_PTYPE, \\
eckhart's avatar
eckhart committed
86
    remove_nodes, remove_content, remove_brackets, replace_parser, \\
87
88
    keep_children, is_one_of, has_content, apply_if, remove_first, remove_last, \\
    remove_anonymous_empty, keep_nodes, traverse_locally, strip
89
'''
di68kap's avatar
di68kap committed
90

91

Eckhart Arnold's avatar
Eckhart Arnold committed
92
DHPARSER_MAIN = '''
di68kap's avatar
di68kap committed
93
def compile_src(source, log_dir=''):
94
95
    """Compiles ``source`` and returns (result, errors, ast).
    """
di68kap's avatar
di68kap committed
96
    with logging(log_dir):
97
        compiler = get_compiler()
Eckhart Arnold's avatar
Eckhart Arnold committed
98
99
        cname = compiler.__class__.__name__
        log_file_name = os.path.basename(os.path.splitext(source)[0]) \\
100
101
            if is_filename(source) < 0 else cname[:cname.find('.')] + '_out'
        result = compile_source(source, get_preprocessor(),
102
103
                                get_grammar(),
                                get_transformer(), compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
104
105
    return result

106
107
108

if __name__ == "__main__":
    if len(sys.argv) > 1:
di68kap's avatar
di68kap committed
109
110
111
112
        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'
        result, errors, ast = compile_src(file_name, log_dir)
113
        if errors:
di68kap's avatar
di68kap committed
114
115
            cwd = os.getcwd()
            rel_path = file_name[len(cwd):] if file_name.startswith(cwd) else file_name
116
            for error in errors:
di68kap's avatar
di68kap committed
117
                print(rel_path + ':' + str(error))
118
            sys.exit(1)
119
        else:
120
            print(result.as_xml() if isinstance(result, Node) else result)
121
    else:
122
        print("Usage: {NAME}Compiler.py [FILENAME]")
123
124
'''

125

126
127
128
129
130
class DSLException(Exception):
    """
    Base class for DSL-exceptions.
    """
    def __init__(self, errors):
Eckhart Arnold's avatar
Eckhart Arnold committed
131
132
        assert isinstance(errors, Iterator) or isinstance(errors, list) \
               or isinstance(errors, tuple)
133
134
135
136
137
138
139
        self.errors = errors

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


class GrammarError(DSLException):
140
141
    """
    Raised when (already) the grammar of a domain specific language (DSL)
142
143
    contains errors.
    """
144
145
    def __init__(self, errors, grammar_src):
        super().__init__(errors)
146
147
148
        self.grammar_src = grammar_src


149
class CompilationError(DSLException):
150
151
    """
    Raised when a string or file in a domain specific language (DSL)
152
153
    contains errors.
    """
154
155
    def __init__(self, errors, dsl_text, dsl_grammar, AST, result):
        super().__init__(errors)
156
157
158
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST
159
        self.result = result
160
161


162
163
164
165
166
def error_str(messages: Iterable[Error]) -> str:
    """
    Returns all true errors (i.e. not just warnings) from the
    `messages` as a concatenated multiline string.
    """
167
    return '\n\n'.join(str(m) for m in messages if is_error(m.code))
168
169


170
def grammar_instance(grammar_representation) -> Tuple[Grammar, str]:
171
172
    """
    Returns a grammar object and the source code of the grammar, from
173
    the given `grammar`-data which can be either a file name, ebnf-code,
174
    python-code, a Grammar-derived grammar class or an instance of
175
176
    such a class (i.e. a grammar object already).
    """
177
    if isinstance(grammar_representation, str):
178
        # read grammar
179
        grammar_src = load_if_file(grammar_representation)
180
        if is_python_code(grammar_src):
eckhart's avatar
eckhart committed
181
            parser_py, messages = grammar_src, []  # type: str, List[Error]
182
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
183
            with logging(False):
eckhart's avatar
eckhart committed
184
185
                parser_py, messages, _ = compile_source(
                    grammar_src, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
186
                    get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
187
        if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
188
            raise GrammarError(only_errors(messages), grammar_src)
eckhart's avatar
eckhart committed
189
        parser_root = compile_python_object(DHPARSER_IMPORTS + parser_py, r'\w+Grammar$')()
190
191
192
    else:
        # assume that dsl_grammar is a ParserHQ-object or Grammar class
        grammar_src = ''
193
        if isinstance(grammar_representation, Grammar):
194
            parser_root = grammar_representation
195
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
196
            # assume ``grammar_representation`` is a grammar class and get the root object
197
            parser_root = grammar_representation()
198
199
200
    return parser_root, grammar_src


201
def compileDSL(text_or_file: str,
202
               preprocessor: PreprocessorFunc,
203
               dsl_grammar: Union[str, Grammar],
204
               ast_transformation: TransformationFunc,
205
               compiler: Compiler) -> Any:
206
207
    """
    Compiles a text in a domain specific language (DSL) with an
208
209
    EBNF-specified grammar. Returns the compiled text or raises a
    compilation error.
eckhart's avatar
eckhart committed
210

211
    Raises:
212
        CompilationError if any errors occurred during compilation
213
214
    """
    assert isinstance(text_or_file, str)
215
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
216

217
    parser, grammar_src = grammar_instance(dsl_grammar)
218
    result, messages, AST = compile_source(text_or_file, preprocessor, parser,
219
                                           ast_transformation, compiler)
220
    if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
221
        src = load_if_file(text_or_file)
Eckhart Arnold's avatar
Eckhart Arnold committed
222
        raise CompilationError(only_errors(messages), src, grammar_src, AST, result)
223
224
225
    return result


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

Eckhart Arnold's avatar
Eckhart Arnold committed
232
233
234
235
    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
236
            code.
Eckhart Arnold's avatar
Eckhart Arnold committed
237
238
239
    Returns:
        An instance of class ``ebnf.EBNFCompiler``
    Raises:
eckhart's avatar
eckhart committed
240
        CompilationError if any errors occurred during compilation
Eckhart Arnold's avatar
Eckhart Arnold committed
241
242
    """
    grammar = get_ebnf_grammar()
243
    compiler = get_ebnf_compiler(branding, ebnf_src)
244
245
    transformer = get_ebnf_transformer()
    compileDSL(ebnf_src, nil_preprocessor, grammar, transformer, compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
246
247
248
    return compiler


249
def compileEBNF(ebnf_src: str, branding="DSL") -> str:
250
251
    """
    Compiles an EBNF source file and returns the source code of a
252
    compiler suite with skeletons for preprocessor, transformer and
Eckhart Arnold's avatar
Eckhart Arnold committed
253
    compiler.
254
255
256
257

    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
258
        branding (str):  Branding name for the compiler suite source
eckhart's avatar
eckhart committed
259
            code.
260
    Returns:
261
        The complete compiler suite skeleton as Python source code.
262
    Raises:
eckhart's avatar
eckhart committed
263
        CompilationError if any errors occurred during compilation
264
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
265
    compiler = raw_compileEBNF(ebnf_src, branding)
266
267
    src = ["#/usr/bin/python\n",
           SECTION_MARKER.format(marker=SYMBOLS_SECTION), DHPARSER_IMPORTS,
268
           SECTION_MARKER.format(marker=PREPROCESSOR_SECTION), compiler.gen_preprocessor_skeleton(),
Eckhart Arnold's avatar
Eckhart Arnold committed
269
           SECTION_MARKER.format(marker=PARSER_SECTION), compiler.result,
270
271
272
           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)]
273
274
275
    return '\n'.join(src)


276
def grammar_provider(ebnf_src: str, branding="DSL") -> Grammar:
277
    """
278
    Compiles an EBNF grammar and returns a grammar-parser provider
279
280
281
282
283
284
    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
285
286
            suite source code.

287
    Returns:
288
        A provider function for a grammar object for texts in the
289
290
        language defined by ``ebnf_src``.
    """
291
    grammar_src = compileDSL(ebnf_src, nil_preprocessor, get_ebnf_grammar(),
292
                             get_ebnf_transformer(), get_ebnf_compiler(branding))
eckhart's avatar
eckhart committed
293
    return compile_python_object(DHPARSER_IMPORTS + grammar_src, r'get_(?:\w+_)?grammar$')
294
295


296
def load_compiler_suite(compiler_suite: str) -> \
297
298
        Tuple[PreprocessorFactoryFunc, ParserFactoryFunc,
              TransformerFactoryFunc, CompilerFactoryFunc]:
299
    """
300
    Extracts a compiler suite from file or string `compiler_suite`
301
    and returns it as a tuple (preprocessor, parser, ast, compiler).
eckhart's avatar
eckhart committed
302

Eckhart Arnold's avatar
Eckhart Arnold committed
303
    Returns:
304
        4-tuple (preprocessor function, parser class, ast transformer function, compiler class)
305
306
307
308
    """
    global RX_SECTION_MARKER
    assert isinstance(compiler_suite, str)
    source = load_if_file(compiler_suite)
309
    imports = DHPARSER_IMPORTS
310
311
    if is_python_code(compiler_suite):
        try:
eckhart's avatar
eckhart committed
312
            _, imports, preprocessor_py, parser_py, ast_py, compiler_py, _ = \
313
                RX_SECTION_MARKER.split(source)
eckhart's avatar
eckhart committed
314
        except ValueError:
315
316
            raise AssertionError('File "' + compiler_suite + '" seems to be corrupted. '
                                 'Please delete or repair file manually.')
317
        # TODO: Compile in one step and pick parts from namespace later ?
eckhart's avatar
eckhart committed
318
319
320
321
        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$')
322
    else:
323
324
        # Assume source is an ebnf grammar.
        # Is there really any reasonable application case for this?
Eckhart Arnold's avatar
Eckhart Arnold committed
325
        with logging(False):
eckhart's avatar
eckhart committed
326
            compiler_py, messages, n = compile_source(source, None, get_ebnf_grammar(),
eckhart's avatar
eckhart committed
327
                                                      get_ebnf_transformer(), get_ebnf_compiler())
328
        if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
329
            raise GrammarError(only_errors(messages), source)
330
        preprocessor = get_ebnf_preprocessor
331
        parser = get_ebnf_grammar
332
        ast = get_ebnf_transformer
eckhart's avatar
eckhart committed
333
    compiler = compile_python_object(imports + compiler_py, r'get_(?:\w+_)?compiler$')
334

335
    return preprocessor, parser, ast, compiler
336
337


338
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
339
340
    """
    Returns ``True``  if the ``compile_suite`` needs to be updated.
eckhart's avatar
eckhart committed
341
342
343

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

348
    Args:
349
350
351
352
353
354
355
356
357
        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
358
        n1, grammar, n2, n3 = load_compiler_suite(compiler_suite)
359
        return grammar_changed(grammar(), grammar_source)
360
361
362
363
    except ValueError:
        return True


364
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
365
366
367
368
    """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
369
            the source code directly. (Which is determined by
370
371
372
373
374
            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
375

376
    Returns:
eckhart's avatar
eckhart committed
377
        The result of the compilation, the form and type of which
378
        depends entirely on the compiler.
eckhart's avatar
eckhart committed
379

380
381
382
    Raises:
        CompilerError
    """
383
384
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
385
386


387
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml") -> Iterable[Error]:
388
389
    """
    Compiles the a source file with a given compiler and writes the
390
391
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
392
393
394
    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
395
    skeletons for a preprocessor, AST transformation table, and compiler.
Eckhart Arnold's avatar
Eckhart Arnold committed
396
397
    If the Python script already exists only the parser name in the
    script will be updated. (For this to work, the different names
398
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
399
400
    returns a list of error messages or an empty list if no errors
    occurred.
401

402
403
404
405
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
406
            (usually ending with 'Compiler.py'), with which the source
407
408
409
410
411
412
413
            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
414

415
    Returns:
416
        A (potentially empty) list of error or warning messages.
Eckhart Arnold's avatar
Eckhart Arnold committed
417
    """
418
    filepath = os.path.normpath(source_file)
419
420
    with open(source_file, encoding="utf-8") as f:
        source = f.read()
421
    rootname = os.path.splitext(filepath)[0]
422
    compiler_name = os.path.basename(rootname)
423
    if compiler_suite:
424
        sfactory, pfactory, tfactory, cfactory = load_compiler_suite(compiler_suite)
425
    else:
426
        sfactory = get_ebnf_preprocessor
427
428
        pfactory = get_ebnf_grammar
        tfactory = get_ebnf_transformer
429
        cfactory = get_ebnf_compiler
430
431
    compiler1 = cfactory()
    compiler1.set_grammar_name(compiler_name, source_file)
432
    result, messages, AST = compile_source(source, sfactory(), pfactory(), tfactory(), compiler1)
433
434
    if has_errors(messages):
        return messages
435

436
437
438
    elif cfactory == get_ebnf_compiler:
        # trans == get_ebnf_transformer or trans == EBNFTransformer:
        # either an EBNF- or no compiler suite given
439
        ebnf_compiler = cast(EBNFCompiler, compiler1)
440
        global SECTION_MARKER, RX_SECTION_MARKER, PREPROCESSOR_SECTION, PARSER_SECTION, \
Eckhart Arnold's avatar
Eckhart Arnold committed
441
442
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER, RX_WHITESPACE, \
            DHPARSER_MAIN, DHPARSER_IMPORTS
443
        f = None
444
        try:
445
            f = open(rootname + 'Compiler.py', 'r', encoding="utf-8")
446
            source = f.read()
447
            sections = RX_SECTION_MARKER.split(source)
448
            intro, imports, preprocessor, parser, ast, compiler, outro = sections
449
450
451
452
            # 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))
453
        except (PermissionError, FileNotFoundError, IOError) as error:
454
            intro, imports, preprocessor, parser, ast, compiler, outro = '', '', '', '', '', '', ''
455
        except ValueError as error:
456
457
458
            name = '"' + rootname + 'Compiler.py"'
            raise ValueError('Could not identify all required sections in ' + name +
                             '. Please delete or repair ' + name + ' manually!')
459
        finally:
460
461
462
            if f:
                f.close()
                f = None
463

464
465
466
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
467
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
468
469
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
470
471
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
472
        if RX_WHITESPACE.fullmatch(ast):
473
            ast = ebnf_compiler.gen_transformer_skeleton()
474
        if RX_WHITESPACE.fullmatch(compiler):
475
            compiler = ebnf_compiler.gen_compiler_skeleton()
476

477
        try:
478
            f = open(rootname + 'Compiler.py', 'w', encoding="utf-8")
479
480
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
481
            f.write(imports)
482
483
            f.write(SECTION_MARKER.format(marker=PREPROCESSOR_SECTION))
            f.write(preprocessor)
484
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
485
            f.write(result)
486
487
488
489
490
491
492
            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:
493
            print('# Could not write file "' + rootname + 'Compiler.py" because of: '
494
495
496
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
497
498
            if f:
                f.close()
499
500

    else:
501
        f = None
502
503
504
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
505
506
507
508
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
509
510
511
512
513
514
515
            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:
516
517
            if f:
                f.close()
518

519
    return messages
520
521
522
523


def recompile_grammar(ebnf_filename, force=False) -> bool:
    """
524
    Re-compiles an EBNF-grammar if necessary, that is, if either no
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
    corresponding 'XXXXCompiler.py'-file exists or if that file is
    outdated.

    Parameters:
        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.
        force(bool):  If False (default), the grammar will only be
            recompiled if it has been changed.
    """
    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

    base, ext = os.path.splitext(ebnf_filename)
    compiler_name = base + 'Compiler.py'
    error_file_name = base + '_ebnf_ERRORS.txt'
546
    messages = []  # type: Iterable[Error]
547
548
549
    if (not os.path.exists(compiler_name) or force or
            grammar_changed(compiler_name, ebnf_filename)):
        # print("recompiling parser for: " + ebnf_filename)
550
551
        messages = compile_on_disk(ebnf_filename)
        if messages:
552
            # print("Errors while compiling: " + ebnf_filename + '!')
Eckhart Arnold's avatar
Eckhart Arnold committed
553
            with open(error_file_name, 'w', encoding="utf-8") as f:
554
                for e in messages:
Eckhart Arnold's avatar
Eckhart Arnold committed
555
                    f.write(str(e))
556
                    f.write('\n')
557
558
            if has_errors(messages):
                return False
559

560
    if not messages and os.path.exists(error_file_name):
561
562
        os.remove(error_file_name)
    return True