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

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

24
from DHParser.ebnf import EBNFCompiler, grammar_changed, \
25
26
    get_ebnf_preprocessor, get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
    PreprocessorFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc
27
from DHParser.error import Error, is_error, has_errors, only_errors
28
from DHParser.parsers import Grammar, Compiler, compile_source, nil_preprocessor, PreprocessorFunc
29
from DHParser.syntaxtree import Node, TransformationFunc
30
from DHParser.toolkit import logging, load_if_file, is_python_code, compile_python_object, \
di68kap's avatar
di68kap committed
31
32
    re, typing
from typing import Any, cast, List, Tuple, Union, Iterator, Iterable
33

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


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

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

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


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

87

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

102
103
104

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

116

117
118
119
120
121
class DSLException(Exception):
    """
    Base class for DSL-exceptions.
    """
    def __init__(self, errors):
Eckhart Arnold's avatar
Eckhart Arnold committed
122
123
        assert isinstance(errors, Iterator) or isinstance(errors, list) \
               or isinstance(errors, tuple)
124
125
126
127
128
129
130
        self.errors = errors

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


class GrammarError(DSLException):
131
132
    """
    Raised when (already) the grammar of a domain specific language (DSL)
133
134
    contains errors.
    """
135
136
    def __init__(self, errors, grammar_src):
        super().__init__(errors)
137
138
139
        self.grammar_src = grammar_src


140
class CompilationError(DSLException):
141
142
    """
    Raised when a string or file in a domain specific language (DSL)
143
144
    contains errors.
    """
145
146
    def __init__(self, errors, dsl_text, dsl_grammar, AST, result):
        super().__init__(errors)
147
148
149
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST
150
        self.result = result
151
152


153
154
155
156
157
def error_str(messages: Iterable[Error]) -> str:
    """
    Returns all true errors (i.e. not just warnings) from the
    `messages` as a concatenated multiline string.
    """
158
    return '\n\n'.join(str(m) for m in messages if is_error(m.level))
159
160


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


192
def compileDSL(text_or_file: str,
193
               preprocessor: PreprocessorFunc,
194
               dsl_grammar: Union[str, Grammar],
195
               ast_transformation: TransformationFunc,
196
               compiler: Compiler) -> Any:
197
198
    """
    Compiles a text in a domain specific language (DSL) with an
199
200
    EBNF-specified grammar. Returns the compiled text or raises a
    compilation error.
eckhart's avatar
eckhart committed
201

202
    Raises:
203
        CompilationError if any errors occurred during compilation
204
205
    """
    assert isinstance(text_or_file, str)
206
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
207

208
    parser, grammar_src = grammar_instance(dsl_grammar)
209
    result, messages, AST = compile_source(text_or_file, preprocessor, parser,
210
                                           ast_transformation, compiler)
211
    if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
212
        src = load_if_file(text_or_file)
Eckhart Arnold's avatar
Eckhart Arnold committed
213
        raise CompilationError(only_errors(messages), src, grammar_src, AST, result)
214
215
216
    return result


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

Eckhart Arnold's avatar
Eckhart Arnold committed
223
224
225
226
    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
227
            code.
Eckhart Arnold's avatar
Eckhart Arnold committed
228
229
230
    Returns:
        An instance of class ``ebnf.EBNFCompiler``
    Raises:
eckhart's avatar
eckhart committed
231
        CompilationError if any errors occurred during compilation
Eckhart Arnold's avatar
Eckhart Arnold committed
232
233
    """
    grammar = get_ebnf_grammar()
234
    compiler = get_ebnf_compiler(branding, ebnf_src)
235
236
    transformer = get_ebnf_transformer()
    compileDSL(ebnf_src, nil_preprocessor, grammar, transformer, compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
237
238
239
    return compiler


240
def compileEBNF(ebnf_src: str, branding="DSL") -> str:
241
242
    """
    Compiles an EBNF source file and returns the source code of a
243
    compiler suite with skeletons for preprocessor, transformer and
Eckhart Arnold's avatar
Eckhart Arnold committed
244
    compiler.
245
246
247
248

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


267
def grammar_provider(ebnf_src: str, branding="DSL") -> Grammar:
268
    """
269
    Compiles an EBNF grammar and returns a grammar-parser provider
270
271
272
273
274
275
    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
276
277
            suite source code.

278
    Returns:
279
        A provider function for a grammar object for texts in the
280
281
        language defined by ``ebnf_src``.
    """
282
    grammar_src = compileDSL(ebnf_src, nil_preprocessor, get_ebnf_grammar(),
283
                             get_ebnf_transformer(), get_ebnf_compiler(branding))
eckhart's avatar
eckhart committed
284
    return compile_python_object(DHPARSER_IMPORTS + grammar_src, r'get_(?:\w+_)?grammar$')
285
286


287
def load_compiler_suite(compiler_suite: str) -> \
eckhart's avatar
eckhart committed
288
    Tuple[PreprocessorFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc]:
289
290
    """
    Extracts a compiler suite from file or string ``compiler suite``
291
    and returns it as a tuple (preprocessor, parser, ast, compiler).
eckhart's avatar
eckhart committed
292

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

324
    return preprocessor, parser, ast, compiler
325
326


327
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
328
329
    """
    Returns ``True``  if the ``compile_suite`` needs to be updated.
eckhart's avatar
eckhart committed
330
331
332

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

337
    Args:
338
339
340
341
342
343
344
345
346
        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
347
        _, grammar, _, _ = load_compiler_suite(compiler_suite)
348
        return grammar_changed(grammar(), grammar_source)
349
350
351
352
    except ValueError:
        return True


353
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
354
355
356
357
    """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
358
            the source code directly. (Which is determined by
359
360
361
362
363
            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
364

365
    Returns:
eckhart's avatar
eckhart committed
366
        The result of the compilation, the form and type of which
367
        depends entirely on the compiler.
eckhart's avatar
eckhart committed
368

369
370
371
    Raises:
        CompilerError
    """
372
373
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
374
375


376
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml") -> Iterable[Error]:
377
378
    """
    Compiles the a source file with a given compiler and writes the
379
380
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
381
382
383
    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
384
    skeletons for a preprocessor, AST transformation table, and compiler.
Eckhart Arnold's avatar
Eckhart Arnold committed
385
386
    If the Python script already exists only the parser name in the
    script will be updated. (For this to work, the different names
387
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
388
389
    returns a list of error messages or an empty list if no errors
    occurred.
390
391
392
393
394
    
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
395
            (usually ending with 'Compiler.py'), with which the source
396
397
398
399
400
401
402
            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
403

404
    Returns:
405
        A (potentially empty) list of error or warning messages.
Eckhart Arnold's avatar
Eckhart Arnold committed
406
    """
407
    filepath = os.path.normpath(source_file)
408
409
    with open(source_file, encoding="utf-8") as f:
        source = f.read()
410
    rootname = os.path.splitext(filepath)[0]
411
    compiler_name = os.path.basename(rootname)
412
    if compiler_suite:
413
        sfactory, pfactory, tfactory, cfactory = load_compiler_suite(compiler_suite)
414
    else:
415
        sfactory = get_ebnf_preprocessor
416
417
        pfactory = get_ebnf_grammar
        tfactory = get_ebnf_transformer
418
        cfactory = get_ebnf_compiler
419
420
    compiler1 = cfactory()
    compiler1.set_grammar_name(compiler_name, source_file)
421
    result, messages, AST = compile_source(source, sfactory(), pfactory(), tfactory(), compiler1)
422
423
    if has_errors(messages):
        return messages
424

425
    elif cfactory == get_ebnf_compiler:  # trans == get_ebnf_transformer or trans == EBNFTransformer:  # either an EBNF- or no compiler suite given
426
        ebnf_compiler = cast(EBNFCompiler, compiler1)
427
        global SECTION_MARKER, RX_SECTION_MARKER, PREPROCESSOR_SECTION, PARSER_SECTION, \
Eckhart Arnold's avatar
Eckhart Arnold committed
428
429
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER, RX_WHITESPACE, \
            DHPARSER_MAIN, DHPARSER_IMPORTS
430
        f = None
431
        try:
432
            f = open(rootname + 'Compiler.py', 'r', encoding="utf-8")
433
            source = f.read()
434
            sections = RX_SECTION_MARKER.split(source)
435
            intro, imports, preprocessor, parser, ast, compiler, outro = sections
436
        except (PermissionError, FileNotFoundError, IOError) as error:
437
            intro, imports, preprocessor, parser, ast, compiler, outro = '', '', '', '', '', '', ''
438
        except ValueError as error:
439
440
441
            name = '"' + rootname + 'Compiler.py"'
            raise ValueError('Could not identify all required sections in ' + name +
                             '. Please delete or repair ' + name + ' manually!')
442
        finally:
443
444
445
            if f:
                f.close()
                f = None
446

447
448
449
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
450
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
451
452
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
453
454
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
455
        if RX_WHITESPACE.fullmatch(ast):
456
            ast = ebnf_compiler.gen_transformer_skeleton()
457
        if RX_WHITESPACE.fullmatch(compiler):
458
            compiler = ebnf_compiler.gen_compiler_skeleton()
459

460
        try:
461
            f = open(rootname + 'Compiler.py', 'w', encoding="utf-8")
462
463
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
464
            f.write(imports)
465
466
            f.write(SECTION_MARKER.format(marker=PREPROCESSOR_SECTION))
            f.write(preprocessor)
467
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
468
            f.write(result)
469
470
471
472
473
474
475
            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:
476
            print('# Could not write file "' + rootname + 'Compiler.py" because of: '
477
478
479
480
481
482
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
            if f:  f.close()

    else:
483
        f = None
484
485
486
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
487
488
489
490
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
491
492
493
494
495
496
497
498
499
            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()

500
    return messages
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526


def recompile_grammar(ebnf_filename, force=False) -> bool:
    """
    Recompiles an ebnf-grammar if necessary, that is, if either no
    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'
527
    messages = []  # type: Iterable[Error]
528
529
530
    if (not os.path.exists(compiler_name) or force or
            grammar_changed(compiler_name, ebnf_filename)):
        # print("recompiling parser for: " + ebnf_filename)
531
532
        messages = compile_on_disk(ebnf_filename)
        if messages:
533
            # print("Errors while compiling: " + ebnf_filename + '!')
Eckhart Arnold's avatar
Eckhart Arnold committed
534
            with open(error_file_name, 'w', encoding="UTF-8") as f:
535
                for e in messages:
Eckhart Arnold's avatar
Eckhart Arnold committed
536
                    f.write(str(e))
537
                    f.write('\n')
538
539
            if has_errors(messages):
                return False
540

541
    if not messages and os.path.exists(error_file_name):
542
543
        os.remove(error_file_name)
    return True