2.12.2021, 9:00 - 11:00: Due to updates GitLab may be unavailable for some minutes between 09:00 and 11:00.

dsl.py 23.8 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 = '''
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
90
from DHParser import logging, is_filename, load_if_file, \\
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, \\
96
    Node, TransformationFunc, TransformationDict, transformation_factory, \\
eckhart's avatar
eckhart committed
97
    traverse, remove_children_if, merge_children, is_anonymous, matches_re, \\
Eckhart Arnold's avatar
Eckhart Arnold committed
98
    reduce_single_child, replace_by_single_child, replace_or_reduce, remove_whitespace, \\
99
    remove_expendables, remove_empty, remove_tokens, flatten, is_whitespace, \\
100
    is_empty, is_expendable, collapse, replace_content, WHITESPACE_PTYPE, TOKEN_PTYPE, \\
101
    remove_nodes, remove_content, remove_brackets, replace_parser, remove_anonymous_tokens, \\
102
    keep_children, is_one_of, has_content, apply_if, remove_first, remove_last, \\
103
104
    remove_anonymous_empty, keep_nodes, traverse_locally, strip, lstrip, rstrip, \\
    replace_content, replace_content_by
eckhart's avatar
eckhart committed
105
'''.format(dhparserdir=dhparserdir)
di68kap's avatar
di68kap committed
106

107

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

122
123
124

if __name__ == "__main__":
    if len(sys.argv) > 1:
125
126
127
128
129
130
131
132
        try:
            grammar_file_name = os.path.basename(__file__).replace('Compiler.py', '.ebnf')
            if grammar_changed({NAME}Grammar, grammar_file_name):
                print("Grammar has changed. Please recompile Grammar first.")
                sys.exit(1)
        except FileNotFoundError:
            print('Could not check for changed grammar, because grammar file "%s" was not found!'
                  % grammar_file_name)    
di68kap's avatar
di68kap committed
133
134
135
        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'
136
        result, errors, ast = compile_src(file_name, log_dir)
137
        if errors:
di68kap's avatar
di68kap committed
138
139
            cwd = os.getcwd()
            rel_path = file_name[len(cwd):] if file_name.startswith(cwd) else file_name
140
            for error in errors:
di68kap's avatar
di68kap committed
141
                print(rel_path + ':' + str(error))
142
            sys.exit(1)
143
        else:
144
            print(result.as_xml() if isinstance(result, Node) else result)
145
    else:
146
        print("Usage: {NAME}Compiler.py [FILENAME]")
147
148
'''

149

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

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


class GrammarError(DSLException):
164
165
    """
    Raised when (already) the grammar of a domain specific language (DSL)
166
167
    contains errors.
    """
168
169
    def __init__(self, errors, grammar_src):
        super().__init__(errors)
170
171
172
        self.grammar_src = grammar_src


173
class CompilationError(DSLException):
174
175
    """
    Raised when a string or file in a domain specific language (DSL)
176
177
    contains errors.
    """
178
179
    def __init__(self, errors, dsl_text, dsl_grammar, AST, result):
        super().__init__(errors)
180
181
182
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST
183
        self.result = result
184
185


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


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


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

235
    Raises:
236
        CompilationError if any errors occurred during compilation
237
238
    """
    assert isinstance(text_or_file, str)
239
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
240

241
    parser, grammar_src = grammar_instance(dsl_grammar)
242
    result, messages, AST = compile_source(text_or_file, preprocessor, parser,
243
                                           ast_transformation, compiler)
244
    if has_errors(messages):
Eckhart Arnold's avatar
Eckhart Arnold committed
245
        src = load_if_file(text_or_file)
Eckhart Arnold's avatar
Eckhart Arnold committed
246
        raise CompilationError(only_errors(messages), src, grammar_src, AST, result)
247
248
249
    return result


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

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


273
def compileEBNF(ebnf_src: str, branding="DSL") -> str:
274
275
    """
    Compiles an EBNF source file and returns the source code of a
276
    compiler suite with skeletons for preprocessor, transformer and
Eckhart Arnold's avatar
Eckhart Arnold committed
277
    compiler.
278
279
280
281

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


300
def grammar_provider(ebnf_src: str, branding="DSL") -> Grammar:
301
    """
302
    Compiles an EBNF grammar and returns a grammar-parser provider
303
304
305
306
307
308
    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
309
310
            suite source code.

311
    Returns:
312
        A provider function for a grammar object for texts in the
313
314
        language defined by ``ebnf_src``.
    """
315
    grammar_src = compileDSL(ebnf_src, nil_preprocessor, get_ebnf_grammar(),
eckhart's avatar
eckhart committed
316
317
318
319
                             get_ebnf_transformer(), get_ebnf_compiler(branding, ebnf_src))
    grammar_obj = compile_python_object(DHPARSER_IMPORTS + grammar_src, r'get_(?:\w+_)?grammar$')
    grammar_obj.python_src__ = grammar_src
    return grammar_obj
320
321


322
def load_compiler_suite(compiler_suite: str) -> \
323
324
        Tuple[PreprocessorFactoryFunc, ParserFactoryFunc,
              TransformerFactoryFunc, CompilerFactoryFunc]:
325
    """
326
    Extracts a compiler suite from file or string `compiler_suite`
327
    and returns it as a tuple (preprocessor, parser, ast, compiler).
eckhart's avatar
eckhart committed
328

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

363
    return preprocessor, parser, ast, compiler
364
365


366
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
367
368
    """
    Returns ``True``  if the ``compile_suite`` needs to be updated.
eckhart's avatar
eckhart committed
369
370
371

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

376
    Args:
377
378
379
380
381
382
383
384
385
        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
386
        n1, grammar, n2, n3 = load_compiler_suite(compiler_suite)
387
        return grammar_changed(grammar(), grammar_source)
388
389
390
391
    except ValueError:
        return True


392
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
393
394
395
396
    """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
397
            the source code directly. (Which is determined by
398
399
400
401
402
            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
403

404
    Returns:
eckhart's avatar
eckhart committed
405
        The result of the compilation, the form and type of which
406
        depends entirely on the compiler.
eckhart's avatar
eckhart committed
407

408
409
410
    Raises:
        CompilerError
    """
411
412
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
413
414


415
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml") -> Iterable[Error]:
416
417
    """
    Compiles the a source file with a given compiler and writes the
418
419
    result to a file.

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

430
431
432
433
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
434
            (usually ending with 'Compiler.py'), with which the source
435
436
437
438
439
440
441
            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
442

443
    Returns:
444
        A (potentially empty) list of error or warning messages.
Eckhart Arnold's avatar
Eckhart Arnold committed
445
    """
446
    filepath = os.path.normpath(source_file)
447
448
    with open(source_file, encoding="utf-8") as f:
        source = f.read()
449
    rootname = os.path.splitext(filepath)[0]
450
    compiler_name = os.path.basename(rootname)
451
    if compiler_suite:
452
        sfactory, pfactory, tfactory, cfactory = load_compiler_suite(compiler_suite)
453
    else:
454
        sfactory = get_ebnf_preprocessor
455
456
        pfactory = get_ebnf_grammar
        tfactory = get_ebnf_transformer
457
        cfactory = get_ebnf_compiler
458
459
    compiler1 = cfactory()
    compiler1.set_grammar_name(compiler_name, source_file)
460
    result, messages, AST = compile_source(source, sfactory(), pfactory(), tfactory(), compiler1)
461
462
    if has_errors(messages):
        return messages
463

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

492
493
494
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
495
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
496
497
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
498
499
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
500
        if RX_WHITESPACE.fullmatch(ast):
501
            ast = ebnf_compiler.gen_transformer_skeleton()
502
        if RX_WHITESPACE.fullmatch(compiler):
503
            compiler = ebnf_compiler.gen_compiler_skeleton()
504

eckhart's avatar
eckhart committed
505
        compilerscript = rootname + 'Compiler.py'
506
        try:
eckhart's avatar
eckhart committed
507
            f = open(compilerscript, 'w', encoding="utf-8")
508
509
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
510
            f.write(imports)
511
512
            f.write(SECTION_MARKER.format(marker=PREPROCESSOR_SECTION))
            f.write(preprocessor)
513
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
514
            f.write(result)
515
516
517
518
519
520
521
            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
522
            print('# Could not write file "' + compilerscript + '" because of: '
523
524
525
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
526
527
            if f:
                f.close()
528

eckhart's avatar
eckhart committed
529
530
531
532
533
        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)

534
    else:
535
        f = None
536
537
538
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
539
540
541
542
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
543
544
545
546
547
548
549
            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:
550
551
            if f:
                f.close()
552

553
    return messages
554
555
556
557


def recompile_grammar(ebnf_filename, force=False) -> bool:
    """
558
    Re-compiles an EBNF-grammar if necessary, that is, if either no
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
    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'
580
    messages = []  # type: Iterable[Error]
581
582
583
    if (not os.path.exists(compiler_name) or force or
            grammar_changed(compiler_name, ebnf_filename)):
        # print("recompiling parser for: " + ebnf_filename)
584
585
        messages = compile_on_disk(ebnf_filename)
        if messages:
586
            # print("Errors while compiling: " + ebnf_filename + '!')
Eckhart Arnold's avatar
Eckhart Arnold committed
587
            with open(error_file_name, 'w', encoding="utf-8") as f:
588
                for e in messages:
Eckhart Arnold's avatar
Eckhart Arnold committed
589
                    f.write(str(e))
590
                    f.write('\n')
591
592
            if has_errors(messages):
                return False
593

594
    if not messages and os.path.exists(error_file_name):
595
596
        os.remove(error_file_name)
    return True