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

123

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

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


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


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


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


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


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

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

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


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

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


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

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


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

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


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

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

332
    return preprocessor, parser, ast, compiler
333
334


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

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

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


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

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

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


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

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

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

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

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

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

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

509
    return messages
510
511
512
513


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

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