dsl.py 22.1 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 load_if_file, is_python_code, compile_python_object, \
33
    re
34
from DHParser.log import logging
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('\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
    keep_children, is_one_of, has_content, apply_if, remove_first, remove_last
88
'''
di68kap's avatar
di68kap committed
89

90

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

105
106
107

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

124

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

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


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


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


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


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


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

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

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


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

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


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

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


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

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


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

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

333
    return preprocessor, parser, ast, compiler
334
335


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

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

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


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

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

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


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

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

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

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

456
457
458
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
459
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
460
461
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
462
463
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
464
        if RX_WHITESPACE.fullmatch(ast):
465
            ast = ebnf_compiler.gen_transformer_skeleton()
466
        if RX_WHITESPACE.fullmatch(compiler):
467
            compiler = ebnf_compiler.gen_compiler_skeleton()
468

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

    else:
492
        f = None
493
494
495
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
496
497
498
499
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
500
501
502
503
504
505
506
            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:
507
508
            if f:
                f.close()
509

510
    return messages
511
512
513
514


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

551
    if not messages and os.path.exists(error_file_name):
552
553
        os.remove(error_file_name)
    return True