dsl.py 23.1 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
eckhart's avatar
eckhart committed
26
27
import platform
import stat
28

eckhart's avatar
eckhart committed
29
from DHParser.compile import Compiler, compile_source
30
from DHParser.ebnf import EBNFCompiler, grammar_changed, \
31
32
    get_ebnf_preprocessor, get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
    PreprocessorFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc
33
from DHParser.error import Error, is_error, has_errors, only_errors
34
from DHParser.log import logging
35
from DHParser.parse import Grammar
36
from DHParser.preprocess import nil_preprocessor, PreprocessorFunc
37
from DHParser.syntaxtree import Node
eckhart's avatar
eckhart committed
38
from DHParser.transform import TransformationFunc
39
from DHParser.toolkit import load_if_file, is_python_code, compile_python_object, \
eckhart's avatar
eckhart committed
40
41
42
    re, typing
from typing import Any, cast, List, Tuple, Union, Iterator, Iterable

43

44
45
__all__ = ('DHPARSER_IMPORTS',
           'GrammarError',
Eckhart Arnold's avatar
Eckhart Arnold committed
46
47
48
           'CompilationError',
           'load_compiler_suite',
           'compileDSL',
Eckhart Arnold's avatar
Eckhart Arnold committed
49
           'raw_compileEBNF',
50
           'compileEBNF',
51
           'grammar_provider',
52
53
           'compile_on_disk',
           'recompile_grammar')
Eckhart Arnold's avatar
Eckhart Arnold committed
54
55


56
57
58
59
60
61
62
63
64
SECTION_MARKER = """\n
#######################################################################
#
# {marker}
#
#######################################################################
\n"""

RX_SECTION_MARKER = re.compile(SECTION_MARKER.format(marker=r'.*?SECTION.*?'))
65
RX_WHITESPACE = re.compile(r'\s*')
66
67

SYMBOLS_SECTION = "SYMBOLS SECTION - Can be edited. Changes will be preserved."
68
PREPROCESSOR_SECTION = "PREPROCESSOR SECTION - Can be edited. Changes will be preserved."
69
70
71
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
72
END_SECTIONS_MARKER = "END OF DHPARSER-SECTIONS"
73
74


eckhart's avatar
eckhart committed
75
76
77
dhparserdir = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))


78
DHPARSER_IMPORTS = '''
di68kap's avatar
di68kap committed
79
from functools import partial
Eckhart Arnold's avatar
Eckhart Arnold committed
80
import os
81
import sys
eckhart's avatar
eckhart committed
82

83
sys.path.append(r'{dhparserdir}')
eckhart's avatar
eckhart committed
84

di68kap's avatar
di68kap committed
85
86
87
88
try:
    import regex as re
except ImportError:
    import re
89
from DHParser import logging, is_filename, load_if_file, \\
90
    Grammar, Compiler, nil_preprocessor, PreprocessorToken, Whitespace, \\
91
    Lookbehind, Lookahead, Alternative, Pop, Token, Synonym, AllOf, SomeOf, Unordered, \\
92
    Option, NegativeLookbehind, OneOrMore, RegExp, Retrieve, Series, RE, Capture, \\
93
    ZeroOrMore, Forward, NegativeLookahead, mixin_comment, compile_source, \\
94
    last_value, counterpart, accumulate, PreprocessorFunc, \\
eckhart's avatar
eckhart committed
95
    Node, TransformationFunc, TransformationDict, \\
96
    traverse, remove_children_if, merge_children, is_anonymous, \\
Eckhart Arnold's avatar
Eckhart Arnold committed
97
    reduce_single_child, replace_by_single_child, replace_or_reduce, remove_whitespace, \\
98
    remove_expendables, remove_empty, remove_tokens, flatten, is_whitespace, \\
99
    is_empty, is_expendable, collapse, replace_content, WHITESPACE_PTYPE, TOKEN_PTYPE, \\
eckhart's avatar
eckhart committed
100
    remove_nodes, remove_content, remove_brackets, replace_parser, \\
101
    keep_children, is_one_of, has_content, apply_if, remove_first, remove_last, \\
102
    remove_anonymous_empty, keep_nodes, traverse_locally, strip, lstrip, rstrip
eckhart's avatar
eckhart committed
103
'''.format(dhparserdir=dhparserdir)
di68kap's avatar
di68kap committed
104

105

Eckhart Arnold's avatar
Eckhart Arnold committed
106
DHPARSER_MAIN = '''
di68kap's avatar
di68kap committed
107
def compile_src(source, log_dir=''):
108
109
    """Compiles ``source`` and returns (result, errors, ast).
    """
di68kap's avatar
di68kap committed
110
    with logging(log_dir):
111
        compiler = get_compiler()
Eckhart Arnold's avatar
Eckhart Arnold committed
112
113
        cname = compiler.__class__.__name__
        log_file_name = os.path.basename(os.path.splitext(source)[0]) \\
114
115
            if is_filename(source) < 0 else cname[:cname.find('.')] + '_out'
        result = compile_source(source, get_preprocessor(),
116
117
                                get_grammar(),
                                get_transformer(), compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
118
119
    return result

120
121
122

if __name__ == "__main__":
    if len(sys.argv) > 1:
di68kap's avatar
di68kap committed
123
124
125
126
        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)
127
        if errors:
di68kap's avatar
di68kap committed
128
129
            cwd = os.getcwd()
            rel_path = file_name[len(cwd):] if file_name.startswith(cwd) else file_name
130
            for error in errors:
di68kap's avatar
di68kap committed
131
                print(rel_path + ':' + str(error))
132
            sys.exit(1)
133
        else:
134
            print(result.as_xml() if isinstance(result, Node) else result)
135
    else:
136
        print("Usage: {NAME}Compiler.py [FILENAME]")
137
138
'''

139

140
141
142
143
144
class DSLException(Exception):
    """
    Base class for DSL-exceptions.
    """
    def __init__(self, errors):
Eckhart Arnold's avatar
Eckhart Arnold committed
145
146
        assert isinstance(errors, Iterator) or isinstance(errors, list) \
               or isinstance(errors, tuple)
147
148
149
150
151
152
153
        self.errors = errors

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


class GrammarError(DSLException):
154
155
    """
    Raised when (already) the grammar of a domain specific language (DSL)
156
157
    contains errors.
    """
158
159
    def __init__(self, errors, grammar_src):
        super().__init__(errors)
160
161
162
        self.grammar_src = grammar_src


163
class CompilationError(DSLException):
164
165
    """
    Raised when a string or file in a domain specific language (DSL)
166
167
    contains errors.
    """
168
169
    def __init__(self, errors, dsl_text, dsl_grammar, AST, result):
        super().__init__(errors)
170
171
172
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST
173
        self.result = result
174
175


176
177
178
179
180
def error_str(messages: Iterable[Error]) -> str:
    """
    Returns all true errors (i.e. not just warnings) from the
    `messages` as a concatenated multiline string.
    """
181
    return '\n\n'.join(str(m) for m in messages if is_error(m.code))
182
183


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


215
def compileDSL(text_or_file: str,
216
               preprocessor: PreprocessorFunc,
217
               dsl_grammar: Union[str, Grammar],
218
               ast_transformation: TransformationFunc,
219
               compiler: Compiler) -> Any:
220
221
    """
    Compiles a text in a domain specific language (DSL) with an
222
223
    EBNF-specified grammar. Returns the compiled text or raises a
    compilation error.
eckhart's avatar
eckhart committed
224

225
    Raises:
226
        CompilationError if any errors occurred during compilation
227
228
    """
    assert isinstance(text_or_file, str)
229
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
230

231
    parser, grammar_src = grammar_instance(dsl_grammar)
232
    result, messages, AST = compile_source(text_or_file, preprocessor, parser,
233
                                           ast_transformation, compiler)
234
    if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
235
        src = load_if_file(text_or_file)
Eckhart Arnold's avatar
Eckhart Arnold committed
236
        raise CompilationError(only_errors(messages), src, grammar_src, AST, result)
237
238
239
    return result


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

Eckhart Arnold's avatar
Eckhart Arnold committed
246
247
248
249
    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
250
            code.
Eckhart Arnold's avatar
Eckhart Arnold committed
251
252
253
    Returns:
        An instance of class ``ebnf.EBNFCompiler``
    Raises:
eckhart's avatar
eckhart committed
254
        CompilationError if any errors occurred during compilation
Eckhart Arnold's avatar
Eckhart Arnold committed
255
256
    """
    grammar = get_ebnf_grammar()
257
    compiler = get_ebnf_compiler(branding, ebnf_src)
258
259
    transformer = get_ebnf_transformer()
    compileDSL(ebnf_src, nil_preprocessor, grammar, transformer, compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
260
261
262
    return compiler


263
def compileEBNF(ebnf_src: str, branding="DSL") -> str:
264
265
    """
    Compiles an EBNF source file and returns the source code of a
266
    compiler suite with skeletons for preprocessor, transformer and
Eckhart Arnold's avatar
Eckhart Arnold committed
267
    compiler.
268
269
270
271

    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
272
        branding (str):  Branding name for the compiler suite source
eckhart's avatar
eckhart committed
273
            code.
274
    Returns:
275
        The complete compiler suite skeleton as Python source code.
276
    Raises:
eckhart's avatar
eckhart committed
277
        CompilationError if any errors occurred during compilation
278
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
279
    compiler = raw_compileEBNF(ebnf_src, branding)
280
281
    src = ["#/usr/bin/python\n",
           SECTION_MARKER.format(marker=SYMBOLS_SECTION), DHPARSER_IMPORTS,
282
           SECTION_MARKER.format(marker=PREPROCESSOR_SECTION), compiler.gen_preprocessor_skeleton(),
Eckhart Arnold's avatar
Eckhart Arnold committed
283
           SECTION_MARKER.format(marker=PARSER_SECTION), compiler.result,
284
285
286
           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)]
287
288
289
    return '\n'.join(src)


290
def grammar_provider(ebnf_src: str, branding="DSL") -> Grammar:
291
    """
292
    Compiles an EBNF grammar and returns a grammar-parser provider
293
294
295
296
297
298
    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
299
300
            suite source code.

301
    Returns:
302
        A provider function for a grammar object for texts in the
303
304
        language defined by ``ebnf_src``.
    """
305
    grammar_src = compileDSL(ebnf_src, nil_preprocessor, get_ebnf_grammar(),
306
                             get_ebnf_transformer(), get_ebnf_compiler(branding))
eckhart's avatar
eckhart committed
307
    return compile_python_object(DHPARSER_IMPORTS + grammar_src, r'get_(?:\w+_)?grammar$')
308
309


310
def load_compiler_suite(compiler_suite: str) -> \
311
312
        Tuple[PreprocessorFactoryFunc, ParserFactoryFunc,
              TransformerFactoryFunc, CompilerFactoryFunc]:
313
    """
314
    Extracts a compiler suite from file or string `compiler_suite`
315
    and returns it as a tuple (preprocessor, parser, ast, compiler).
eckhart's avatar
eckhart committed
316

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

350
    return preprocessor, parser, ast, compiler
351
352


353
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
354
355
    """
    Returns ``True``  if the ``compile_suite`` needs to be updated.
eckhart's avatar
eckhart committed
356
357
358

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

363
    Args:
364
365
366
367
368
369
370
371
372
        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
373
        n1, grammar, n2, n3 = load_compiler_suite(compiler_suite)
374
        return grammar_changed(grammar(), grammar_source)
375
376
377
378
    except ValueError:
        return True


379
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
380
381
382
383
    """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
384
            the source code directly. (Which is determined by
385
386
387
388
389
            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
390

391
    Returns:
eckhart's avatar
eckhart committed
392
        The result of the compilation, the form and type of which
393
        depends entirely on the compiler.
eckhart's avatar
eckhart committed
394

395
396
397
    Raises:
        CompilerError
    """
398
399
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
400
401


402
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml") -> Iterable[Error]:
403
404
    """
    Compiles the a source file with a given compiler and writes the
405
406
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
407
408
409
    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
410
    skeletons for a preprocessor, AST transformation table, and compiler.
Eckhart Arnold's avatar
Eckhart Arnold committed
411
412
    If the Python script already exists only the parser name in the
    script will be updated. (For this to work, the different names
413
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
414
415
    returns a list of error messages or an empty list if no errors
    occurred.
416

417
418
419
420
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
421
            (usually ending with 'Compiler.py'), with which the source
422
423
424
425
426
427
428
            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
429

430
    Returns:
431
        A (potentially empty) list of error or warning messages.
Eckhart Arnold's avatar
Eckhart Arnold committed
432
    """
433
    filepath = os.path.normpath(source_file)
434
435
    with open(source_file, encoding="utf-8") as f:
        source = f.read()
436
    rootname = os.path.splitext(filepath)[0]
437
    compiler_name = os.path.basename(rootname)
438
    if compiler_suite:
439
        sfactory, pfactory, tfactory, cfactory = load_compiler_suite(compiler_suite)
440
    else:
441
        sfactory = get_ebnf_preprocessor
442
443
        pfactory = get_ebnf_grammar
        tfactory = get_ebnf_transformer
444
        cfactory = get_ebnf_compiler
445
446
    compiler1 = cfactory()
    compiler1.set_grammar_name(compiler_name, source_file)
447
    result, messages, AST = compile_source(source, sfactory(), pfactory(), tfactory(), compiler1)
448
449
    if has_errors(messages):
        return messages
450

451
452
453
    elif cfactory == get_ebnf_compiler:
        # trans == get_ebnf_transformer or trans == EBNFTransformer:
        # either an EBNF- or no compiler suite given
454
        ebnf_compiler = cast(EBNFCompiler, compiler1)
455
        global SECTION_MARKER, RX_SECTION_MARKER, PREPROCESSOR_SECTION, PARSER_SECTION, \
Eckhart Arnold's avatar
Eckhart Arnold committed
456
457
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER, RX_WHITESPACE, \
            DHPARSER_MAIN, DHPARSER_IMPORTS
458
        f = None
459
        try:
460
            f = open(rootname + 'Compiler.py', 'r', encoding="utf-8")
461
            source = f.read()
462
            sections = RX_SECTION_MARKER.split(source)
463
            intro, imports, preprocessor, parser, ast, compiler, outro = sections
464
465
466
467
            # 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))
468
        except (PermissionError, FileNotFoundError, IOError) as error:
469
            intro, imports, preprocessor, parser, ast, compiler, outro = '', '', '', '', '', '', ''
470
        except ValueError as error:
471
472
473
            name = '"' + rootname + 'Compiler.py"'
            raise ValueError('Could not identify all required sections in ' + name +
                             '. Please delete or repair ' + name + ' manually!')
474
        finally:
475
476
477
            if f:
                f.close()
                f = None
478

479
480
481
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
482
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
483
484
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
485
486
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
487
        if RX_WHITESPACE.fullmatch(ast):
488
            ast = ebnf_compiler.gen_transformer_skeleton()
489
        if RX_WHITESPACE.fullmatch(compiler):
490
            compiler = ebnf_compiler.gen_compiler_skeleton()
491

eckhart's avatar
eckhart committed
492
        compilerscript = rootname + 'Compiler.py'
493
        try:
eckhart's avatar
eckhart committed
494
            f = open(compilerscript, 'w', encoding="utf-8")
495
496
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
497
            f.write(imports)
498
499
            f.write(SECTION_MARKER.format(marker=PREPROCESSOR_SECTION))
            f.write(preprocessor)
500
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
501
            f.write(result)
502
503
504
505
506
507
508
            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:
eckhart's avatar
eckhart committed
509
            print('# Could not write file "' + compilerscript + '" because of: '
510
511
512
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
513
514
            if f:
                f.close()
515

eckhart's avatar
eckhart committed
516
517
518
519
520
        if platform.system() != "Windows":
            # set file permissions so that the compilerscript can be executed
            st = os.stat(compilerscript)
            os.chmod(compilerscript, st.st_mode | stat.S_IEXEC)

521
    else:
522
        f = None
523
524
525
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
526
527
528
529
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
530
531
532
533
534
535
536
            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:
537
538
            if f:
                f.close()
539

540
    return messages
541
542
543
544


def recompile_grammar(ebnf_filename, force=False) -> bool:
    """
545
    Re-compiles an EBNF-grammar if necessary, that is, if either no
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
    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'
567
    messages = []  # type: Iterable[Error]
568
569
570
    if (not os.path.exists(compiler_name) or force or
            grammar_changed(compiler_name, ebnf_filename)):
        # print("recompiling parser for: " + ebnf_filename)
571
572
        messages = compile_on_disk(ebnf_filename)
        if messages:
573
            # print("Errors while compiling: " + ebnf_filename + '!')
Eckhart Arnold's avatar
Eckhart Arnold committed
574
            with open(error_file_name, 'w', encoding="utf-8") as f:
575
                for e in messages:
Eckhart Arnold's avatar
Eckhart Arnold committed
576
                    f.write(str(e))
577
                    f.write('\n')
578
579
            if has_errors(messages):
                return False
580

581
    if not messages and os.path.exists(error_file_name):
582
583
        os.remove(error_file_name)
    return True