dsl.py 21.8 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
30
from DHParser.parse import Grammar, Compiler, compile_source
from DHParser.preprocess import nil_preprocessor, PreprocessorFunc
31
from DHParser.syntaxtree import Node, TransformationFunc
32
from DHParser.toolkit import logging, load_if_file, is_python_code, compile_python_object, \
33
    re
34

35
36
__all__ = ('DHPARSER_IMPORTS',
           'GrammarError',
Eckhart Arnold's avatar
Eckhart Arnold committed
37
38
39
           'CompilationError',
           'load_compiler_suite',
           'compileDSL',
Eckhart Arnold's avatar
Eckhart Arnold committed
40
           'raw_compileEBNF',
41
           'compileEBNF',
42
           'grammar_provider',
43
44
           'compile_on_disk',
           'recompile_grammar')
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

SYMBOLS_SECTION = "SYMBOLS SECTION - Can be edited. Changes will be preserved."
59
PREPROCESSOR_SECTION = "PREPROCESSOR SECTION - Can be edited. Changes will be preserved."
60
61
62
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
74
from DHParser import logging, is_filename, load_if_file, \\
75
    Grammar, Compiler, nil_preprocessor, PreprocessorToken, \\
76
    Lookbehind, Lookahead, Alternative, Pop, Token, Synonym, AllOf, SomeOf, Unordered, \\
77
    Option, NegativeLookbehind, OneOrMore, RegExp, Retrieve, Series, RE, Capture, \\
78
    ZeroOrMore, Forward, NegativeLookahead, mixin_comment, compile_source, \\
79
    last_value, counterpart, accumulate, PreprocessorFunc, \\
eckhart's avatar
eckhart committed
80
    Node, TransformationFunc, TransformationDict, \\
81
    traverse, remove_children_if, merge_children, is_anonymous, \\
Eckhart Arnold's avatar
Eckhart Arnold committed
82
    reduce_single_child, replace_by_single_child, replace_or_reduce, remove_whitespace, \\
83
    remove_expendables, remove_empty, remove_tokens, flatten, is_whitespace, \\
84
    is_empty, is_expendable, collapse, replace_content, WHITESPACE_PTYPE, TOKEN_PTYPE, \\
eckhart's avatar
eckhart committed
85
    remove_nodes, remove_content, remove_brackets, replace_parser, \\
86
    keep_children, is_one_of, has_content, apply_if, remove_first, remove_last
87
'''
di68kap's avatar
di68kap committed
88

89

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

104
105
106

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

118

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

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


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


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


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


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


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

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

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


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

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


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

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


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

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


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

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

326
    return preprocessor, parser, ast, compiler
327
328


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

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

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


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

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

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


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

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

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

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

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

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

    else:
485
        f = None
486
487
488
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
489
490
491
492
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
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:
500
501
            if f:
                f.close()
502

503
    return messages
504
505
506
507


def recompile_grammar(ebnf_filename, force=False) -> bool:
    """
508
    Re-compiles an EBNF-grammar if necessary, that is, if either no
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
    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'
530
    messages = []  # type: Iterable[Error]
531
532
533
    if (not os.path.exists(compiler_name) or force or
            grammar_changed(compiler_name, ebnf_filename)):
        # print("recompiling parser for: " + ebnf_filename)
534
535
        messages = compile_on_disk(ebnf_filename)
        if messages:
536
            # print("Errors while compiling: " + ebnf_filename + '!')
Eckhart Arnold's avatar
Eckhart Arnold committed
537
            with open(error_file_name, 'w', encoding="UTF-8") as f:
538
                for e in messages:
Eckhart Arnold's avatar
Eckhart Arnold committed
539
                    f.write(str(e))
540
                    f.write('\n')
541
542
            if has_errors(messages):
                return False
543

544
    if not messages and os.path.exists(error_file_name):
545
546
        os.remove(error_file_name)
    return True