dsl.py 19.3 KB
Newer Older
1
"""dsl.py - Support for domain specific notations for DHParser
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26

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.

Module ``DSLsupport`` contains various functions to support the
compilation of domain specific languages based on an EBNF-grammar.
"""

import os
try:
    import regex as re
except ImportError:
    import re
27 28 29 30
try:
    from typing import Any, cast, Tuple, Union
except ImportError:
    from .typing34 import Any, cast, Tuple, Union
31

32
from DHParser.ebnf import EBNFTransformer, EBNFCompiler, grammar_changed, \
33 34
    get_ebnf_preprocessor, get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler, \
    PreprocessorFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc
35
from DHParser.toolkit import logging, load_if_file, is_python_code, compile_python_object
36
from DHParser.parsers import Grammar, Compiler, compile_source, nil_preprocessor, PreprocessorFunc
37
from DHParser.syntaxtree import Node, TransformationFunc
38

Eckhart Arnold's avatar
Eckhart Arnold committed
39 40 41 42 43

__all__ = ['GrammarError',
           'CompilationError',
           'load_compiler_suite',
           'compileDSL',
Eckhart Arnold's avatar
Eckhart Arnold committed
44
           'raw_compileEBNF',
45
           'compileEBNF',
46
           'parser_factory',
47
           'compile_on_disk']
Eckhart Arnold's avatar
Eckhart Arnold committed
48 49


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

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

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


69
DHPARSER_IMPORTS = '''
di68kap's avatar
di68kap committed
70
from functools import partial
Eckhart Arnold's avatar
Eckhart Arnold committed
71
import os
72
import sys
di68kap's avatar
di68kap committed
73 74 75 76
try:
    import regex as re
except ImportError:
    import re
Eckhart Arnold's avatar
Eckhart Arnold committed
77
from DHParser.toolkit import logging, is_filename, load_if_file    
78
from DHParser.parsers import Grammar, Compiler, nil_preprocessor, \\
79
    Lookbehind, Lookahead, Alternative, Pop, Required, Token, Synonym, \\
80
    Optional, NegativeLookbehind, OneOrMore, RegExp, Retrieve, Series, RE, Capture, \\
81
    ZeroOrMore, Forward, NegativeLookahead, mixin_comment, compile_source, \\
82
    last_value, counterpart, accumulate, PreprocessorFunc
83
from DHParser.syntaxtree import Node, traverse, remove_children_if, \\
84
    reduce_single_child, replace_by_single_child, remove_whitespace, \\
85
    remove_expendables, remove_empty, remove_tokens, flatten, is_whitespace, \\
86
    is_empty, is_expendable, collapse, replace_content, WHITESPACE_PTYPE, TOKEN_PTYPE, \\
87
    TransformationFunc, remove_parser, remove_content, remove_brackets, \\
Eckhart Arnold's avatar
Eckhart Arnold committed
88
    keep_children, has_name, has_content, apply_if, remove_first, remove_last
89
'''
di68kap's avatar
di68kap committed
90

91

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

106 107 108

if __name__ == "__main__":
    if len(sys.argv) > 1:
109
        result, errors, ast = compile_src(sys.argv[1])
110 111 112
        if errors:
            for error in errors:
                print(error)
113
            sys.exit(1)
114
        else:
115
            print(result.as_xml() if isinstance(result, Node) else result)
116
    else:
117
        print("Usage: {NAME}Compiler.py [FILENAME]")
118 119
'''

120

121
class GrammarError(Exception):
122 123
    """
    Raised when (already) the grammar of a domain specific language (DSL)
124 125 126 127 128 129 130 131 132
    contains errors.
    """

    def __init__(self, error_messages, grammar_src):
        self.error_messages = error_messages
        self.grammar_src = grammar_src


class CompilationError(Exception):
133 134
    """
    Raised when a string or file in a domain specific language (DSL)
135 136
    contains errors.
    """
137
    def __init__(self, error_messages, dsl_text, dsl_grammar, AST, result):
138 139 140 141
        self.error_messages = error_messages
        self.dsl_text = dsl_text
        self.dsl_grammar = dsl_grammar
        self.AST = AST
142
        self.result = result
143 144 145 146 147

    def __str__(self):
        return '\n'.join(self.error_messages)


148
def grammar_instance(grammar_representation) -> Tuple[Grammar, str]:
149 150
    """
    Returns a grammar object and the source code of the grammar, from
151
    the given `grammar`-data which can be either a file name, ebnf-code,
152
    python-code, a Grammar-derived grammar class or an instance of
153 154
    such a class (i.e. a grammar object already).
    """
155
    if isinstance(grammar_representation, str):
156
        # read grammar
157
        grammar_src = load_if_file(grammar_representation)
158
        if is_python_code(grammar_src):
159 160
            parser_py, errors, AST = grammar_src, '', None
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
161 162
            with logging(False):
                parser_py, errors, AST = compile_source(grammar_src, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
163
                    get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
164
        if errors:
165
            raise GrammarError('\n\n'.join(errors), grammar_src)
166
        parser_root = compile_python_object(DHPARSER_IMPORTS + parser_py, '\w+Grammar$')()
167 168 169
    else:
        # assume that dsl_grammar is a ParserHQ-object or Grammar class
        grammar_src = ''
170
        if isinstance(grammar_representation, Grammar):
171
            parser_root = grammar_representation
172
        else:
Eckhart Arnold's avatar
Eckhart Arnold committed
173
            # assume ``grammar_representation`` is a grammar class and get the root object
174
            parser_root = grammar_representation()
175 176 177
    return parser_root, grammar_src


178
def compileDSL(text_or_file: str,
179
               preprocessor: PreprocessorFunc,
180
               dsl_grammar: Union[str, Grammar],
181
               ast_transformation: TransformationFunc,
182
               compiler: Compiler) -> Any:
183 184
    """
    Compiles a text in a domain specific language (DSL) with an
185 186
    EBNF-specified grammar. Returns the compiled text or raises a
    compilation error.
187 188
    
    Raises:
189
        CompilationError if any errors occurred during compilation
190 191
    """
    assert isinstance(text_or_file, str)
192
    assert isinstance(compiler, Compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
193

194
    parser, grammar_src = grammar_instance(dsl_grammar)
195
    result, errors, AST = compile_source(text_or_file, preprocessor, parser,
Eckhart Arnold's avatar
Eckhart Arnold committed
196 197 198
                                         ast_transformation, compiler)
    if errors:
        src = load_if_file(text_or_file)
199
        raise CompilationError(errors, src, grammar_src, AST, result)
200 201 202
    return result


203
def raw_compileEBNF(ebnf_src: str, branding="DSL") -> EBNFCompiler:
204 205
    """
    Compiles an EBNF grammar file and returns the compiler object
Eckhart Arnold's avatar
Eckhart Arnold committed
206
    that was used and which can now be queried for the result as well
207
    as skeleton code for preprocessor, transformer and compiler objects.
Eckhart Arnold's avatar
Eckhart Arnold committed
208 209 210 211 212 213 214 215 216 217 218 219 220
    
    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
            code. 
    Returns:
        An instance of class ``ebnf.EBNFCompiler``
    Raises:
        CompilationError if any errors occurred during compilation      
    """
    grammar = get_ebnf_grammar()
    compiler = get_ebnf_compiler(branding , ebnf_src)
221
    compileDSL(ebnf_src, nil_preprocessor, grammar, EBNFTransformer, compiler)
Eckhart Arnold's avatar
Eckhart Arnold committed
222 223 224
    return compiler


225
def compileEBNF(ebnf_src: str, branding="DSL") -> str:
226 227
    """
    Compiles an EBNF source file and returns the source code of a
228
    compiler suite with skeletons for preprocessor, transformer and
Eckhart Arnold's avatar
Eckhart Arnold committed
229
    compiler.
230 231 232 233

    Args:
        ebnf_src(str):  Either the file name of an EBNF grammar or
            the EBNF grammar itself as a string.
234 235
        branding (str):  Branding name for the compiler suite source
            code. 
236
    Returns:
237
        The complete compiler suite skeleton as Python source code.
238 239
    Raises:
        CompilationError if any errors occurred during compilation        
240
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
241
    compiler = raw_compileEBNF(ebnf_src, branding)
242 243
    src = ["#/usr/bin/python\n",
           SECTION_MARKER.format(marker=SYMBOLS_SECTION), DHPARSER_IMPORTS,
244
           SECTION_MARKER.format(marker=PREPROCESSOR_SECTION), compiler.gen_preprocessor_skeleton(),
Eckhart Arnold's avatar
Eckhart Arnold committed
245
           SECTION_MARKER.format(marker=PARSER_SECTION), compiler.result,
246 247 248
           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)]
249 250 251
    return '\n'.join(src)


252
def parser_factory(ebnf_src: str, branding="DSL") -> Grammar:
253 254
    """
    Compiles an EBNF grammar and returns a grammar-parser factory
255 256 257 258 259 260 261 262 263 264 265 266
    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
            suite source code. 
    
    Returns:
        A factory function for a grammar-parser for texts in the
        language defined by ``ebnf_src``.
    """
267
    grammar_src = compileDSL(ebnf_src, nil_preprocessor, get_ebnf_grammar(),
268
                             get_ebnf_transformer(), get_ebnf_compiler(branding))
269
    return compile_python_object(DHPARSER_IMPORTS + grammar_src, 'get_(?:\w+_)?grammar$')
270 271


272
def load_compiler_suite(compiler_suite: str) -> \
273
        Tuple[PreprocessorFactoryFunc, ParserFactoryFunc, TransformerFactoryFunc, CompilerFactoryFunc]:
274 275
    """
    Extracts a compiler suite from file or string ``compiler suite``
276
    and returns it as a tuple (preprocessor, parser, ast, compiler).
Eckhart Arnold's avatar
Eckhart Arnold committed
277 278
    
    Returns:
279
        4-tuple (preprocessor function, parser class, ast transformer function, compiler class)
280 281 282 283 284 285
    """
    global RX_SECTION_MARKER
    assert isinstance(compiler_suite, str)
    source = load_if_file(compiler_suite)
    if is_python_code(compiler_suite):
        try:
286
            intro, imports, preprocessor_py, parser_py, ast_py, compiler_py, outro = \
287 288 289 290
                RX_SECTION_MARKER.split(source)
        except ValueError as error:
            raise AssertionError('File "' + compiler_suite + '" seems to be corrupted. '
                                 'Please delete or repair file manually.')
291
        # TODO: Compile in one step and pick parts from namespace later ?
292
        preprocessor = compile_python_object(imports + preprocessor_py, 'get_(?:\w+_)?preprocessor$')
293 294
        parser = compile_python_object(imports + parser_py, 'get_(?:\w+_)?grammar$')
        ast = compile_python_object(imports + ast_py, 'get_(?:\w+_)?transformer$')
295
    else:
296
        # assume source is an ebnf grammar. Is there really any reasonable application case for this?
Eckhart Arnold's avatar
Eckhart Arnold committed
297
        with logging(False):
298
            compile_py, errors, AST = compile_source(source, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
299
                get_ebnf_grammar(), get_ebnf_transformer(), get_ebnf_compiler())
300 301
        if errors:
            raise GrammarError('\n\n'.join(errors), source)
302
        preprocessor = get_ebnf_preprocessor
303
        parser = get_ebnf_grammar
304
        ast = get_ebnf_transformer
305
    compiler = compile_python_object(imports + compiler_py, 'get_(?:\w+_)?compiler$')
306

307
    return preprocessor, parser, ast, compiler
308 309


310
def is_outdated(compiler_suite: str, grammar_source: str) -> bool:
311 312
    """
    Returns ``True``  if the ``compile_suite`` needs to be updated.
313 314 315 316 317 318 319
     
    An update is needed, if either the grammar in the compieler suite 
    does not reflect the latest changes of ``grammar_source`` or if 
    sections from the compiler suite have diligently been overwritten
    with whitespace order to trigger their recreation. Note: Do not
    delete or overwrite the section marker itself. 

320
    Args:
321 322 323 324 325 326 327 328 329
        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:
330
        preprocessor, grammar, ast, compiler = load_compiler_suite(compiler_suite)
331
        return grammar_changed(grammar(), grammar_source)
332 333 334 335
    except ValueError:
        return True


336
def run_compiler(text_or_file: str, compiler_suite: str) -> Any:
337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
    """Compiles a source with a given compiler suite.

    Args:
        text_or_file (str):  Either the file name of the source code or
            the source code directly. (Which is determined by 
            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.
        
    Returns:
        The result of the compilation, the form and type of which 
        depends entirely on the compiler.
        
    Raises:
        CompilerError
    """
355 356
    preprocessor, parser, ast, compiler = load_compiler_suite(compiler_suite)
    return compileDSL(text_or_file, preprocessor(), parser(), ast(), compiler())
357 358


359
def compile_on_disk(source_file: str, compiler_suite="", extension=".xml"):
360 361
    """
    Compiles the a source file with a given compiler and writes the
362 363
    result to a file.

Eckhart Arnold's avatar
Eckhart Arnold committed
364 365 366
    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
367
    skeletons for a preprocessor, AST transformation table, and compiler.
Eckhart Arnold's avatar
Eckhart Arnold committed
368 369
    If the Python script already exists only the parser name in the
    script will be updated. (For this to work, the different names
370
    need to be delimited section marker blocks.). `compile_on_disk()`
Eckhart Arnold's avatar
Eckhart Arnold committed
371 372
    returns a list of error messages or an empty list if no errors
    occurred.
373 374 375 376 377
    
    Parameters:
        source_file(str):  The file name of the source text to be
            compiled.
        compiler_suite(str):  The file name of the compiler suite
378
            (usually ending with 'Compiler.py'), with which the source
379 380 381 382 383 384 385 386 387 388 389
            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.
            
    Returns:
        A list of error messages or an empty list if there were no 
        errors. 
Eckhart Arnold's avatar
Eckhart Arnold committed
390
    """
391
    filepath = os.path.normpath(source_file)
392 393
    # with open(source_file, encoding="utf-8") as f:
    #     source = f.read()
394
    rootname = os.path.splitext(filepath)[0]
395
    compiler_name = os.path.basename(rootname)
396
    if compiler_suite:
397
        sfactory, pfactory, tfactory, cfactory = load_compiler_suite(compiler_suite)
398
    else:
399
        sfactory = get_ebnf_preprocessor
400 401
        pfactory = get_ebnf_grammar
        tfactory = get_ebnf_transformer
402
        cfactory = get_ebnf_compiler
403 404 405
    compiler1 = cfactory()
    compiler1.set_grammar_name(compiler_name, source_file)
    result, errors, ast = compile_source(source_file, sfactory(), pfactory(), tfactory(), compiler1)
406 407 408
    if errors:
        return errors

409
    elif cfactory == get_ebnf_compiler:  # trans == get_ebnf_transformer or trans == EBNFTransformer:  # either an EBNF- or no compiler suite given
410
        ebnf_compiler = cast(EBNFCompiler, compiler1)
411
        global SECTION_MARKER, RX_SECTION_MARKER, PREPROCESSOR_SECTION, PARSER_SECTION, \
Eckhart Arnold's avatar
Eckhart Arnold committed
412 413
            AST_SECTION, COMPILER_SECTION, END_SECTIONS_MARKER, RX_WHITESPACE, \
            DHPARSER_MAIN, DHPARSER_IMPORTS
414
        f = None
415
        try:
416
            f = open(rootname + 'Compiler.py', 'r', encoding="utf-8")
417
            source = f.read()
418
            sections = RX_SECTION_MARKER.split(source)
419
            intro, imports, preprocessor, parser, ast, compiler, outro = sections
420
        except (PermissionError, FileNotFoundError, IOError) as error:
421
            intro, imports, preprocessor, parser, ast, compiler, outro = '', '', '', '', '', '', ''
422
        except ValueError as error:
423 424 425
            name = '"' + rootname + 'Compiler.py"'
            raise ValueError('Could not identify all required sections in ' + name +
                             '. Please delete or repair ' + name + ' manually!')
426
        finally:
427 428 429
            if f:
                f.close()
                f = None
430

431 432 433
        if RX_WHITESPACE.fullmatch(intro):
            intro = '#!/usr/bin/python'
        if RX_WHITESPACE.fullmatch(outro):
Eckhart Arnold's avatar
Eckhart Arnold committed
434
            outro = DHPARSER_MAIN.format(NAME=compiler_name)
435 436
        if RX_WHITESPACE.fullmatch(imports):
            imports = DHPARSER_IMPORTS
437 438
        if RX_WHITESPACE.fullmatch(preprocessor):
            preprocessor = ebnf_compiler.gen_preprocessor_skeleton()
439
        if RX_WHITESPACE.fullmatch(ast):
440
            ast = ebnf_compiler.gen_transformer_skeleton()
441
        if RX_WHITESPACE.fullmatch(compiler):
442
            compiler = ebnf_compiler.gen_compiler_skeleton()
443

444
        try:
445
            f = open(rootname + 'Compiler.py', 'w', encoding="utf-8")
446 447
            f.write(intro)
            f.write(SECTION_MARKER.format(marker=SYMBOLS_SECTION))
448
            f.write(imports)
449 450
            f.write(SECTION_MARKER.format(marker=PREPROCESSOR_SECTION))
            f.write(preprocessor)
451
            f.write(SECTION_MARKER.format(marker=PARSER_SECTION))
452
            f.write(result)
453 454 455 456 457 458 459
            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:
460
            print('# Could not write file "' + rootname + 'Compiler.py" because of: '
461 462 463 464 465 466
                  + "\n# ".join(str(error).split('\n)')))
            print(result)
        finally:
            if f:  f.close()

    else:
467
        f = None
468 469 470
        try:
            f = open(rootname + extension, 'w', encoding="utf-8")
            if isinstance(result, Node):
471 472 473 474
                if extension.lower() == '.xml':
                    f.write(result.as_xml())
                else:
                    f.write(result.as_sxpr())
475 476 477 478 479 480 481 482 483 484
            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:
            if f:  f.close()

    return []