dsl.py 22 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 = '''
di68kap's avatar
di68kap committed
91
def compile_src(source, log_dir=''):
92
93
    """Compiles ``source`` and returns (result, errors, ast).
    """
di68kap's avatar
di68kap committed
94
    with logging(log_dir):
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:
di68kap's avatar
di68kap committed
107
108
109
110
        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)
111
112
113
        if errors:
            for error in errors:
                print(error)
114
            sys.exit(1)
115
        else:
116
            print(result.as_xml() if isinstance(result, Node) else result)
117
    else:
118
        print("Usage: {NAME}Compiler.py [FILENAME]")
119
120
'''

121

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

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


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


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


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


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


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

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

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


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

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


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

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


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

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


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

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

330
    return preprocessor, parser, ast, compiler
331
332


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

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

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


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

371
    Returns:
eckhart's avatar
eckhart committed
372
        The result of the compilation, the form and type of which
373
        depends entirely on the compiler.
eckhart's avatar
eckhart committed
374

375
376
377
    Raises:
        CompilerError
    """
378
379
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
380
381


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

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

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

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

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

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

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

507
    return messages
508
509
510
511


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

548
    if not messages and os.path.exists(error_file_name):
549
550
        os.remove(error_file_name)
    return True