dsl.py 22.5 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# dsl.py - Support for domain specific notations for DHParser
#
# 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.
17
18


19
"""
20
Module ``dsl`` contains various functions to support the
21
22
23
compilation of domain specific languages based on an EBNF-grammar.
"""

24

25
import os
26
from typing import Any, cast, List, Tuple, Union, Iterator, Iterable
27

28
from DHParser.ebnf import EBNFCompiler, grammar_changed, \
29
30
    get_ebnf_preprocessor, get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
    PreprocessorFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc
31
from DHParser.error import Error, is_error, has_errors, only_errors
32
from DHParser.log import logging
33
34
from DHParser.parse import Grammar, Compiler, compile_source
from DHParser.preprocess import nil_preprocessor, PreprocessorFunc
35
from DHParser.syntaxtree import Node, TransformationFunc
36
from DHParser.toolkit import load_if_file, is_python_code, compile_python_object, \
37
    re
38

39
40
__all__ = ('DHPARSER_IMPORTS',
           'GrammarError',
Eckhart Arnold's avatar
Eckhart Arnold committed
41
42
43
           'CompilationError',
           'load_compiler_suite',
           'compileDSL',
Eckhart Arnold's avatar
Eckhart Arnold committed
44
           'raw_compileEBNF',
45
           'compileEBNF',
46
           'grammar_provider',
47
48
           'compile_on_disk',
           'recompile_grammar')
Eckhart Arnold's avatar
Eckhart Arnold committed
49
50


51
52
53
54
55
56
57
58
59
SECTION_MARKER = """\n
#######################################################################
#
# {marker}
#
#######################################################################
\n"""

RX_SECTION_MARKER = re.compile(SECTION_MARKER.format(marker=r'.*?SECTION.*?'))
60
RX_WHITESPACE = re.compile(r'\s*')
61
62

SYMBOLS_SECTION = "SYMBOLS SECTION - Can be edited. Changes will be preserved."
63
PREPROCESSOR_SECTION = "PREPROCESSOR SECTION - Can be edited. Changes will be preserved."
64
65
66
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
67
END_SECTIONS_MARKER = "END OF DHPARSER-SECTIONS"
68
69


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

94

Eckhart Arnold's avatar
Eckhart Arnold committed
95
DHPARSER_MAIN = '''
di68kap's avatar
di68kap committed
96
def compile_src(source, log_dir=''):
97
98
    """Compiles ``source`` and returns (result, errors, ast).
    """
di68kap's avatar
di68kap committed
99
    with logging(log_dir):
100
        compiler = get_compiler()
Eckhart Arnold's avatar
Eckhart Arnold committed
101
102
        cname = compiler.__class__.__name__
        log_file_name = os.path.basename(os.path.splitext(source)[0]) \\
103
104
            if is_filename(source) < 0 else cname[:cname.find('.')] + '_out'
        result = compile_source(source, get_preprocessor(),
105
106
                                get_grammar(),
                                get_transformer(), compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
107
108
    return result

109
110
111

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

128

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

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


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


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


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


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


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

214
    Raises:
215
        CompilationError if any errors occurred during compilation
216
217
    """
    assert isinstance(text_or_file, str)
218
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
219

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


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

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


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

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


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

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


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

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

338
    return preprocessor, parser, ast, compiler
339
340


341
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
342
343
    """
    Returns ``True``  if the ``compile_suite`` needs to be updated.
eckhart's avatar
eckhart committed
344
345
346

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

351
    Args:
352
353
354
355
356
357
358
359
360
        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
361
        n1, grammar, n2, n3 = load_compiler_suite(compiler_suite)
362
        return grammar_changed(grammar(), grammar_source)
363
364
365
366
    except ValueError:
        return True


367
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
368
369
370
371
    """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
372
            the source code directly. (Which is determined by
373
374
375
376
377
            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
378

379
    Returns:
eckhart's avatar
eckhart committed
380
        The result of the compilation, the form and type of which
381
        depends entirely on the compiler.
eckhart's avatar
eckhart committed
382

383
384
385
    Raises:
        CompilerError
    """
386
387
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
388
389


390
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml") -> Iterable[Error]:
391
392
    """
    Compiles the a source file with a given compiler and writes the
393
394
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
395
396
397
    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
398
    skeletons for a preprocessor, AST transformation table, and compiler.
Eckhart Arnold's avatar
Eckhart Arnold committed
399
400
    If the Python script already exists only the parser name in the
    script will be updated. (For this to work, the different names
401
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
402
403
    returns a list of error messages or an empty list if no errors
    occurred.
404

405
406
407
408
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
409
            (usually ending with 'Compiler.py'), with which the source
410
411
412
413
414
415
416
            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
417

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

439
440
441
    elif cfactory == get_ebnf_compiler:
        # trans == get_ebnf_transformer or trans == EBNFTransformer:
        # either an EBNF- or no compiler suite given
442
        ebnf_compiler = cast(EBNFCompiler, compiler1)
443
        global SECTION_MARKER, RX_SECTION_MARKER, PREPROCESSOR_SECTION, PARSER_SECTION, \
Eckhart Arnold's avatar
Eckhart Arnold committed
444
445
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER, RX_WHITESPACE, \
            DHPARSER_MAIN, DHPARSER_IMPORTS
446
        f = None
447
        try:
448
            f = open(rootname + 'Compiler.py', 'r', encoding="utf-8")
449
            source = f.read()
450
            sections = RX_SECTION_MARKER.split(source)
451
            intro, imports, preprocessor, parser, ast, compiler, outro = sections
452
453
454
455
            # TODO: Verify transformation table
            ast_trans_table = compile_python_object(DHPARSER_IMPORTS + ast,
                                                    r'(?:\w+_)?AST_transformation_table$')
            messages.extend(ebnf_compiler.verify_transformation_table(ast_trans_table))
456
        except (PermissionError, FileNotFoundError, IOError) as error:
457
            intro, imports, preprocessor, parser, ast, compiler, outro = '', '', '', '', '', '', ''
458
        except ValueError as error:
459
460
461
            name = '"' + rootname + 'Compiler.py"'
            raise ValueError('Could not identify all required sections in ' + name +
                             '. Please delete or repair ' + name + ' manually!')
462
        finally:
463
464
465
            if f:
                f.close()
                f = None
466

467
468
469
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
470
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
471
472
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
473
474
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
475
        if RX_WHITESPACE.fullmatch(ast):
476
            ast = ebnf_compiler.gen_transformer_skeleton()
477
        if RX_WHITESPACE.fullmatch(compiler):
478
            compiler = ebnf_compiler.gen_compiler_skeleton()
479

480
        try:
481
            f = open(rootname + 'Compiler.py', 'w', encoding="utf-8")
482
483
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
484
            f.write(imports)
485
486
            f.write(SECTION_MARKER.format(marker=PREPROCESSOR_SECTION))
            f.write(preprocessor)
487
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
488
            f.write(result)
489
490
491
492
493
494
495
            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:
496
            print('# Could not write file "' + rootname + 'Compiler.py" because of: '
497
498
499
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
500
501
            if f:
                f.close()
502
503

    else:
504
        f = None
505
506
507
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
508
509
510
511
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
512
513
514
515
516
517
518
            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:
519
520
            if f:
                f.close()
521

522
    return messages
523
524
525
526


def recompile_grammar(ebnf_filename, force=False) -> bool:
    """
527
    Re-compiles an EBNF-grammar if necessary, that is, if either no
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
    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'
549
    messages = []  # type: Iterable[Error]
550
551
552
    if (not os.path.exists(compiler_name) or force or
            grammar_changed(compiler_name, ebnf_filename)):
        # print("recompiling parser for: " + ebnf_filename)
553
554
        messages = compile_on_disk(ebnf_filename)
        if messages:
555
            # print("Errors while compiling: " + ebnf_filename + '!')
Eckhart Arnold's avatar
Eckhart Arnold committed
556
            with open(error_file_name, 'w', encoding="utf-8") as f:
557
                for e in messages:
Eckhart Arnold's avatar
Eckhart Arnold committed
558
                    f.write(str(e))
559
                    f.write('\n')
560
561
            if has_errors(messages):
                return False
562

563
    if not messages and os.path.exists(error_file_name):
564
565
        os.remove(error_file_name)
    return True