dsl.py 24.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
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
    re, typing
41
from typing import Any, cast, List, Tuple, Union, Iterator, Iterable, Optional, Callable
eckhart's avatar
eckhart committed
42

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 = '''
79
import collections
di68kap's avatar
di68kap committed
80
from functools import partial
Eckhart Arnold's avatar
Eckhart Arnold committed
81
import os
82
import sys
eckhart's avatar
eckhart committed
83

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

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

108

Eckhart Arnold's avatar
Eckhart Arnold committed
109
DHPARSER_MAIN = '''
110
def compile_src(source, log_dir=''):
111
112
    """Compiles ``source`` and returns (result, errors, ast).
    """
di68kap's avatar
di68kap committed
113
    with logging(log_dir):
114
        compiler = get_compiler()
Eckhart Arnold's avatar
Eckhart Arnold committed
115
        cname = compiler.__class__.__name__
116
        result = compile_source(source, get_preprocessor(),
117
118
                                get_grammar(),
                                get_transformer(), compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
119
120
    return result

121
122

if __name__ == "__main__":
123
124
125
126
127
128
129
130
131
132
133
134
135
    # recompile grammar if needed
    grammar_path = os.path.abspath(__file__).replace('Compiler.py', '.ebnf')
    if os.path.exists(grammar_path):
        if not recompile_grammar(grammar_path, force=False,
                                  notify=lambda:print('recompiling ' + grammar_path)):
            error_file = os.path.basename(__file__).replace('Compiler.py', '_ebnf_ERRORS.txt')
            with open(error_file, encoding="utf-8") as f:
                print(f.read())
            sys.exit(1)
    else:
        print('Could not check whether grammar requires recompiling, '
              'because grammar was not found at: ' + grammar_path)

136
    if len(sys.argv) > 1:
137
        # compile file
di68kap's avatar
di68kap committed
138
139
140
        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'
141
        result, errors, ast = compile_src(file_name, log_dir)
142
        if errors:
di68kap's avatar
di68kap committed
143
144
            cwd = os.getcwd()
            rel_path = file_name[len(cwd):] if file_name.startswith(cwd) else file_name
145
            for error in errors:
di68kap's avatar
di68kap committed
146
                print(rel_path + ':' + str(error))
147
            sys.exit(1)
148
        else:
149
            print(result.as_xml() if isinstance(result, Node) else result)
150
    else:
151
        print("Usage: {NAME}Compiler.py [FILENAME]")
152
153
'''

154

155
156
157
158
159
class DSLException(Exception):
    """
    Base class for DSL-exceptions.
    """
    def __init__(self, errors):
Eckhart Arnold's avatar
Eckhart Arnold committed
160
        assert isinstance(errors, Iterator) or isinstance(errors, list) \
161
            or isinstance(errors, tuple)
162
163
164
165
166
167
168
        self.errors = errors

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


class GrammarError(DSLException):
169
170
    """
    Raised when (already) the grammar of a domain specific language (DSL)
171
172
    contains errors.
    """
173
174
    def __init__(self, errors, grammar_src):
        super().__init__(errors)
175
176
177
        self.grammar_src = grammar_src


178
class CompilationError(DSLException):
179
180
    """
    Raised when a string or file in a domain specific language (DSL)
181
182
    contains errors.
    """
183
184
    def __init__(self, errors, dsl_text, dsl_grammar, AST, result):
        super().__init__(errors)
185
186
187
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST
188
        self.result = result
189
190


191
192
193
194
195
def error_str(messages: Iterable[Error]) -> str:
    """
    Returns all true errors (i.e. not just warnings) from the
    `messages` as a concatenated multiline string.
    """
196
    return '\n\n'.join(str(m) for m in messages if is_error(m.code))
197
198


199
def grammar_instance(grammar_representation) -> Tuple[Grammar, str]:
200
201
    """
    Returns a grammar object and the source code of the grammar, from
202
    the given `grammar`-data which can be either a file name, ebnf-code,
203
    python-code, a Grammar-derived grammar class or an instance of
204
205
    such a class (i.e. a grammar object already).
    """
206
    if isinstance(grammar_representation, str):
207
        # read grammar
208
        grammar_src = load_if_file(grammar_representation)
209
        if is_python_code(grammar_src):
eckhart's avatar
eckhart committed
210
            parser_py, messages = grammar_src, []  # type: str, List[Error]
211
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
212
            with logging(False):
213
                result, messages, _ = compile_source(
eckhart's avatar
eckhart committed
214
                    grammar_src, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
215
                    get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
216
                parser_py = cast(str, result)
217
        if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
218
            raise GrammarError(only_errors(messages), grammar_src)
eckhart's avatar
eckhart committed
219
        parser_root = compile_python_object(DHPARSER_IMPORTS + parser_py, r'\w+Grammar$')()
220
221
222
    else:
        # assume that dsl_grammar is a ParserHQ-object or Grammar class
        grammar_src = ''
223
        if isinstance(grammar_representation, Grammar):
224
            parser_root = grammar_representation
225
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
226
            # assume ``grammar_representation`` is a grammar class and get the root object
227
            parser_root = grammar_representation()
228
229
230
    return parser_root, grammar_src


231
def compileDSL(text_or_file: str,
232
               preprocessor: Optional[PreprocessorFunc],
233
               dsl_grammar: Union[str, Grammar],
234
               ast_transformation: TransformationFunc,
235
               compiler: Compiler) -> Any:
236
237
    """
    Compiles a text in a domain specific language (DSL) with an
238
239
    EBNF-specified grammar. Returns the compiled text or raises a
    compilation error.
eckhart's avatar
eckhart committed
240

241
    Raises:
242
        CompilationError if any errors occurred during compilation
243
244
    """
    assert isinstance(text_or_file, str)
245
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
246

247
    parser, grammar_src = grammar_instance(dsl_grammar)
248
    result, messages, AST = compile_source(text_or_file, preprocessor, parser,
249
                                           ast_transformation, compiler)
250
    if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
251
        src = load_if_file(text_or_file)
Eckhart Arnold's avatar
Eckhart Arnold committed
252
        raise CompilationError(only_errors(messages), src, grammar_src, AST, result)
253
254
255
    return result


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

Eckhart Arnold's avatar
Eckhart Arnold committed
262
263
264
265
    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
266
            code.
Eckhart Arnold's avatar
Eckhart Arnold committed
267
268
269
    Returns:
        An instance of class ``ebnf.EBNFCompiler``
    Raises:
eckhart's avatar
eckhart committed
270
        CompilationError if any errors occurred during compilation
Eckhart Arnold's avatar
Eckhart Arnold committed
271
272
    """
    grammar = get_ebnf_grammar()
273
    compiler = get_ebnf_compiler(branding, ebnf_src)
274
275
    transformer = get_ebnf_transformer()
    compileDSL(ebnf_src, nil_preprocessor, grammar, transformer, compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
276
277
278
    return compiler


279
def compileEBNF(ebnf_src: str, branding="DSL") -> str:
280
281
    """
    Compiles an EBNF source file and returns the source code of a
282
    compiler suite with skeletons for preprocessor, transformer and
Eckhart Arnold's avatar
Eckhart Arnold committed
283
    compiler.
284
285
286
287

    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
288
        branding (str):  Branding name for the compiler suite source
eckhart's avatar
eckhart committed
289
            code.
290
    Returns:
291
        The complete compiler suite skeleton as Python source code.
292
    Raises:
eckhart's avatar
eckhart committed
293
        CompilationError if any errors occurred during compilation
294
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
295
    compiler = raw_compileEBNF(ebnf_src, branding)
296
297
    src = ["#/usr/bin/python\n",
           SECTION_MARKER.format(marker=SYMBOLS_SECTION), DHPARSER_IMPORTS,
298
           SECTION_MARKER.format(marker=PREPROCESSOR_SECTION), compiler.gen_preprocessor_skeleton(),
Eckhart Arnold's avatar
Eckhart Arnold committed
299
           SECTION_MARKER.format(marker=PARSER_SECTION), compiler.result,
300
301
302
           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)]
303
304
305
    return '\n'.join(src)


306
def grammar_provider(ebnf_src: str, branding="DSL") -> Grammar:
307
    """
308
    Compiles an EBNF grammar and returns a grammar-parser provider
309
310
311
312
313
314
    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
315
316
            suite source code.

317
    Returns:
318
        A provider function for a grammar object for texts in the
319
320
        language defined by ``ebnf_src``.
    """
321
    grammar_src = compileDSL(ebnf_src, nil_preprocessor, get_ebnf_grammar(),
eckhart's avatar
eckhart committed
322
                             get_ebnf_transformer(), get_ebnf_compiler(branding, ebnf_src))
eckhart's avatar
eckhart committed
323
324
325
    grammar_factory = compile_python_object(DHPARSER_IMPORTS + grammar_src, r'get_(?:\w+_)?grammar$')
    grammar_factory.python_src__ = grammar_src
    return grammar_factory
326
327


328
def load_compiler_suite(compiler_suite: str) -> \
329
330
        Tuple[PreprocessorFactoryFunc, ParserFactoryFunc,
              TransformerFactoryFunc, CompilerFactoryFunc]:
331
    """
332
    Extracts a compiler suite from file or string `compiler_suite`
333
    and returns it as a tuple (preprocessor, parser, ast, compiler).
eckhart's avatar
eckhart committed
334

Eckhart Arnold's avatar
Eckhart Arnold committed
335
    Returns:
336
337
        4-tuple (preprocessor function, parser class,
                 ast transformer function, compiler class)
338
339
340
341
    """
    global RX_SECTION_MARKER
    assert isinstance(compiler_suite, str)
    source = load_if_file(compiler_suite)
342
    imports = DHPARSER_IMPORTS
343
344
    if is_python_code(compiler_suite):
        try:
eckhart's avatar
eckhart committed
345
            _, imports, preprocessor_py, parser_py, ast_py, compiler_py, _ = \
346
                RX_SECTION_MARKER.split(source)
eckhart's avatar
eckhart committed
347
        except ValueError:
348
349
            raise AssertionError('File "' + compiler_suite + '" seems to be corrupted. '
                                 'Please delete or repair file manually.')
350
        # TODO: Compile in one step and pick parts from namespace later ?
eckhart's avatar
eckhart committed
351
352
353
354
        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$')
355
    else:
356
357
        # Assume source is an ebnf grammar.
        # Is there really any reasonable application case for this?
Eckhart Arnold's avatar
Eckhart Arnold committed
358
        with logging(False):
eckhart's avatar
eckhart committed
359
            compiler_py, messages, n = compile_source(source, None, get_ebnf_grammar(),
eckhart's avatar
eckhart committed
360
361
                                                      get_ebnf_transformer(),
                                                      get_ebnf_compiler(compiler_suite, source))
362
        if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
363
            raise GrammarError(only_errors(messages), source)
364
        preprocessor = get_ebnf_preprocessor
365
        parser = get_ebnf_grammar
366
        ast = get_ebnf_transformer
eckhart's avatar
eckhart committed
367
    compiler = compile_python_object(imports + compiler_py, r'get_(?:\w+_)?compiler$')
368

369
    return preprocessor, parser, ast, compiler
370
371


372
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
373
374
    """
    Returns ``True``  if the ``compile_suite`` needs to be updated.
eckhart's avatar
eckhart committed
375
376
377

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

382
    Args:
383
384
385
386
387
388
389
390
391
        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
392
        n1, grammar, n2, n3 = load_compiler_suite(compiler_suite)
393
        return grammar_changed(grammar(), grammar_source)
394
395
396
397
    except ValueError:
        return True


398
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
399
400
401
402
    """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
403
            the source code directly. (Which is determined by
404
405
406
407
408
            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
409

410
    Returns:
eckhart's avatar
eckhart committed
411
        The result of the compilation, the form and type of which
412
        depends entirely on the compiler.
eckhart's avatar
eckhart committed
413

414
415
416
    Raises:
        CompilerError
    """
417
418
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
419
420


421
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml") -> Iterable[Error]:
422
423
    """
    Compiles the a source file with a given compiler and writes the
424
425
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
426
427
428
    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
429
    skeletons for a preprocessor, AST transformation table, and compiler.
Eckhart Arnold's avatar
Eckhart Arnold committed
430
431
    If the Python script already exists only the parser name in the
    script will be updated. (For this to work, the different names
432
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
433
434
    returns a list of error messages or an empty list if no errors
    occurred.
435

436
437
438
439
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
440
            (usually ending with 'Compiler.py'), with which the source
441
442
443
444
445
446
447
            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
448

449
    Returns:
450
        A (potentially empty) list of error or warning messages.
Eckhart Arnold's avatar
Eckhart Arnold committed
451
    """
452
    filepath = os.path.normpath(source_file)
eckhart's avatar
eckhart committed
453
    f = None  # Optional[TextIO]
454
455
    with open(source_file, encoding="utf-8") as f:
        source = f.read()
456
    rootname = os.path.splitext(filepath)[0]
457
    compiler_name = os.path.basename(rootname)
458
    if compiler_suite:
459
        sfactory, pfactory, tfactory, cfactory = load_compiler_suite(compiler_suite)
eckhart's avatar
eckhart committed
460
        compiler1 = cfactory()
461
    else:
462
        sfactory = get_ebnf_preprocessor
463
464
        pfactory = get_ebnf_grammar
        tfactory = get_ebnf_transformer
465
        cfactory = get_ebnf_compiler
eckhart's avatar
eckhart committed
466
467
        compiler1 = cfactory()
        compiler1.set_grammar_name(compiler_name, source_file)
468
    result, messages, _ = compile_source(source, sfactory(), pfactory(), tfactory(), compiler1)
eckhart's avatar
eckhart committed
469

470
471
    if has_errors(messages):
        return messages
472

473
474
475
    elif cfactory == get_ebnf_compiler:
        # trans == get_ebnf_transformer or trans == EBNFTransformer:
        # either an EBNF- or no compiler suite given
476
        ebnf_compiler = cast(EBNFCompiler, compiler1)
477
        global SECTION_MARKER, RX_SECTION_MARKER, PREPROCESSOR_SECTION, PARSER_SECTION, \
Eckhart Arnold's avatar
Eckhart Arnold committed
478
479
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER, RX_WHITESPACE, \
            DHPARSER_MAIN, DHPARSER_IMPORTS
480
        f = None
481
        try:
482
            f = open(rootname + 'Compiler.py', 'r', encoding="utf-8")
483
            source = f.read()
484
            sections = RX_SECTION_MARKER.split(source)
485
            intro, imports, preprocessor, _, ast, compiler, outro = sections
486
487
488
            ast_trans_table = compile_python_object(DHPARSER_IMPORTS + ast,
                                                    r'(?:\w+_)?AST_transformation_table$')
            messages.extend(ebnf_compiler.verify_transformation_table(ast_trans_table))
489
            # TODO: Verify compiler
490
491
492
        except (PermissionError, FileNotFoundError, IOError):
            intro, imports, preprocessor, _, ast, compiler, outro = '', '', '', '', '', '', ''
        except ValueError:
493
            name = '"' + rootname + 'Compiler.py"'
eckhart's avatar
eckhart committed
494
495
            raise ValueError('Could not identify all required sections in ' + name
                             + '. Please delete or repair ' + name + ' manually!')
496
        finally:
497
498
499
            if f:
                f.close()
                f = None
500

501
502
503
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
504
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
505
506
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
507
508
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
509
        if RX_WHITESPACE.fullmatch(ast):
510
            ast = ebnf_compiler.gen_transformer_skeleton()
511
        if RX_WHITESPACE.fullmatch(compiler):
512
            compiler = ebnf_compiler.gen_compiler_skeleton()
513

eckhart's avatar
eckhart committed
514
        compilerscript = rootname + 'Compiler.py'
515
        try:
eckhart's avatar
eckhart committed
516
            f = open(compilerscript, 'w', encoding="utf-8")
517
518
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
519
            f.write(imports)
520
521
            f.write(SECTION_MARKER.format(marker=PREPROCESSOR_SECTION))
            f.write(preprocessor)
522
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
eckhart's avatar
eckhart committed
523
            f.write(cast(str, result))
524
525
526
527
528
529
530
            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
531
            print('# Could not write file "' + compilerscript + '" because of: '
532
533
534
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
535
536
            if f:
                f.close()
537

eckhart's avatar
eckhart committed
538
539
540
541
542
        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)

543
    else:
544
        f = None
545
546
547
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
548
549
550
551
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
eckhart's avatar
eckhart committed
552
            elif isinstance(result, str):
553
                f.write(result)
eckhart's avatar
eckhart committed
554
555
            else:
                raise AssertionError('Illegal result type: ' + str(type(result)))
556
557
558
559
560
        except (PermissionError, FileNotFoundError, IOError) as error:
            print('# Could not write file "' + rootname + '.py" because of: '
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
561
562
            if f:
                f.close()
563

564
    return messages
565
566


567
def recompile_grammar(ebnf_filename, force=False,
eckhart's avatar
eckhart committed
568
                      notify: Callable = lambda: None) -> bool:
569
    """
570
    Re-compiles an EBNF-grammar if necessary, that is, if either no
571
572
573
574
    corresponding 'XXXXCompiler.py'-file exists or if that file is
    outdated.

    Parameters:
575
576
577
        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.
578
579
        force(bool):  If False (default), the grammar will only be
            recompiled if it has been changed.
580
581
582
        notify(Callable):  'notify' is a function without parameters that
            is called when recompilation actually takes place. This can
            be used to inform the user.
583
584
585
586
587
588
589
590
    """
    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

591
    base, _ = os.path.splitext(ebnf_filename)
592
593
    compiler_name = base + 'Compiler.py'
    error_file_name = base + '_ebnf_ERRORS.txt'
594
    messages = []  # type: Iterable[Error]
595
596
    if (not os.path.exists(compiler_name) or force or
            grammar_changed(compiler_name, ebnf_filename)):
597
        notify()
598
599
        messages = compile_on_disk(ebnf_filename)
        if messages:
600
            # print("Errors while compiling: " + ebnf_filename + '!')
Eckhart Arnold's avatar
Eckhart Arnold committed
601
            with open(error_file_name, 'w', encoding="utf-8") as f:
602
                for e in messages:
Eckhart Arnold's avatar
Eckhart Arnold committed
603
                    f.write(str(e))
604
                    f.write('\n')
605
606
            if has_errors(messages):
                return False
607

608
    if not messages and os.path.exists(error_file_name):
609
610
        os.remove(error_file_name)
    return True