ogParser.py 240 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
5
    OpenGEODE SDL parser
Maxime Perrotin's avatar
Maxime Perrotin committed
6
7
8
9
10
11
12
13
14
15
16
17
18

    This library builds the SDL AST (described in ogAST.py)
    The AST can then be used to build SDL backends such as the
    diagram editor (placing symbols in a graphical canvas for editition)
    or code generators, etc.

    The AST build is based on the ANTLR-grammar and generated lexer and parser
    (the grammar is in the file sdl92.g and requires antlr 3.1.3 for Python
    to be compiled and used).

    During the build of the AST this library makes a number of semantic
    checks on the SDL input mode.

19
    Copyright (c) 2012-2020 European Space Agency
Maxime Perrotin's avatar
Maxime Perrotin committed
20
21
22
23
24
25
26
27
28
29

    Designed and implemented by Maxime Perrotin

    Contact: maxime.perrotin@esa.int
"""

__author__ = 'Maxime Perrotin'

import sys
import os
dbarbera's avatar
dbarbera committed
30
import math
31
import operator
Maxime Perrotin's avatar
Maxime Perrotin committed
32
33
import logging
import traceback
Maxime Perrotin's avatar
Maxime Perrotin committed
34
from functools import partial
35
import codecs
Maxime Perrotin's avatar
Maxime Perrotin committed
36
from typing import Dict, Tuple
37
from inspect import currentframe, getframeinfo
38
import binascii
39
from textwrap import dedent
Maxime Perrotin's avatar
Maxime Perrotin committed
40
from itertools import chain, permutations, combinations
41
from collections import defaultdict, Counter
Maxime Perrotin's avatar
Maxime Perrotin committed
42

Maxime Perrotin's avatar
Maxime Perrotin committed
43
import antlr3
Maxime Perrotin's avatar
Maxime Perrotin committed
44
from antlr3 import tree
Maxime Perrotin's avatar
Maxime Perrotin committed
45

Maxime Perrotin's avatar
Maxime Perrotin committed
46
from . import sdl92Lexer as lexer
47
from . import sdl92Parser
Maxime Perrotin's avatar
Maxime Perrotin committed
48

Maxime Perrotin's avatar
Maxime Perrotin committed
49
from . import ogAST
Maxime Perrotin's avatar
Maxime Perrotin committed
50
from .Asn1scc import parse_asn1, ASN1, create_choice_determinant_types
Maxime Perrotin's avatar
Maxime Perrotin committed
51
52
53

LOG = logging.getLogger(__name__)

Maxime Perrotin's avatar
Maxime Perrotin committed
54
EXPR_NODE: Dict[int, ogAST.Expression] = {
55
    lexer.PLUS:     ogAST.ExprPlus,
56
    lexer.ASTERISK: ogAST.ExprMul,
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
    lexer.IMPLIES:  ogAST.ExprImplies,
    lexer.DASH:     ogAST.ExprMinus,
    lexer.OR:       ogAST.ExprOr,
    lexer.AND:      ogAST.ExprAnd,
    lexer.XOR:      ogAST.ExprXor,
    lexer.EQ:       ogAST.ExprEq,
    lexer.NEQ:      ogAST.ExprNeq,
    lexer.GT:       ogAST.ExprGt,
    lexer.GE:       ogAST.ExprGe,
    lexer.LT:       ogAST.ExprLt,
    lexer.LE:       ogAST.ExprLe,
    lexer.DIV:      ogAST.ExprDiv,
    lexer.MOD:      ogAST.ExprMod,
    lexer.APPEND:   ogAST.ExprAppend,
    lexer.IN:       ogAST.ExprIn,
    lexer.REM:      ogAST.ExprRem,
    lexer.NOT:      ogAST.ExprNot,
    lexer.NEG:      ogAST.ExprNeg,
    lexer.PRIMARY:  ogAST.Primary,
Maxime Perrotin's avatar
Maxime Perrotin committed
76
}
Maxime Perrotin's avatar
Maxime Perrotin committed
77
78
79
80

# Insert current path in the search list for importing modules
sys.path.insert(0, '.')

Maxime Perrotin's avatar
Maxime Perrotin committed
81
DV = None  # type: module
Maxime Perrotin's avatar
Maxime Perrotin committed
82
83
84
85

# Code generator backends may need some intemediate variables to process
# expressions. For convenience and to avoid multiple pass parsing, the parser
# tries to guess where they may be useful, and adds a hint in the AST.
Maxime Perrotin's avatar
Maxime Perrotin committed
86
TMPVAR = 0  # type: int
Maxime Perrotin's avatar
Maxime Perrotin committed
87
88

# ASN.1 types used to support the signature of special operators
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
INTEGER      = type('IntegerType',    (object,), {'kind': 'IntegerType',
                                                  'Min' : str(-(2 ** 63)),
                                                  'Max' : str(2 ** 63 - 1)})
UNSIGNED     = type('IntegerType',    (object,), {'kind': 'IntegerType',
                                                  'Min' : "0",
                                                  'Max' : str(2 ** 64 - 1)})
INT32        = type('Integer32Type',  (object,), {'kind': 'Integer32Type',
                                                  'Min' : '-2147483648',
                                                  'Max' : '2147483647'})
NUMERICAL    = type('NumericalType',  (object,), {'kind': 'Numerical'})
TIMER        = type('TimerType',      (object,), {'kind': 'TimerType'})
REAL         = type('RealType',       (object,), {'kind': 'RealType',
                                                  'Min' : str(1e-308),
                                                  'Max' : str(1e308)})
LIST         = type('ListType',       (object,), {'kind': 'ListType'})
ANY_TYPE     = type('AnyType',        (object,), {'kind': 'AnyType'})
CHOICE       = type('ChoiceType',     (object,), {'kind': 'ChoiceType'})
BOOLEAN      = type('BooleanType',    (object,), {'kind': 'BooleanType'})
RAWSTRING    = type('RawString',      (object,), {'kind': 'StandardStringType',
                                                  'Min' : '0',
                                                  'Max' : '255'})
OCTETSTRING  = type('OctetString',    (object,), {'kind': 'OctetStringType'})
ENUMERATED   = type('EnumeratedType', (object,), {'kind': 'EnumeratedType'})
UNKNOWN_TYPE = type('UnknownType',    (object,), {'kind': 'UnknownType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
113

114
SPECIAL_OPERATORS = {
115
116
117
118
119
120
121
122
123
124
    'abs'        : [{'type': NUMERICAL,  'direction': 'in'}],
    'ceil'       : [{'type': REAL,       'direction': 'in'}],
    'cos'        : [{'type': REAL,       'direction': 'in'}],
    'fix'        : [{'type': NUMERICAL,  'direction': 'in'}],
    'float'      : [{'type': NUMERICAL,  'direction': 'in'}],
    'floor'      : [{'type': REAL,       'direction': 'in'}],
    'length'     : [{'type': LIST,       'direction': 'in'}],
    'num'        : [{'type': ENUMERATED, 'direction': 'in'}],
    'power'      : [
                    {'type': NUMERICAL,  'direction': 'in'},
125
                    {'type': NUMERICAL,  'direction': 'in'}
126
127
                   ],
    'present'    : [{'type': CHOICE,     'direction': 'in'}],
128
    'exist'      : [{'type': ANY_TYPE,   'direction': 'in'}],
129
130
131
132
133
134
135
136
137
138
139
    'reset_timer': [{'type': TIMER,      'direction': 'in'}],
    'round'      : [{'type': REAL,       'direction': 'in'}],
    'set_timer'  : [
                    {'type': UNSIGNED,   'direction': 'in'},
                    {'type': TIMER,      'direction': 'in'}
                   ],
    'sin'        : [{'type': REAL,       'direction': 'in'}],
    'sqrt'       : [{'type': REAL,       'direction': 'in'}],
    'trunc'      : [{'type': REAL,       'direction': 'in'}],
    'write'      : [{'type': ANY_TYPE,   'direction': 'in'}],
    'writeln'    : [{'type': ANY_TYPE,   'direction': 'in'}],
140
141
142
143
144
145
146
147
    'to_selector': [  #  to convert an enum to a choice discriminant
                    {'type': ENUMERATED, 'direction': 'in'},
                    {'type': ANY_TYPE,   'direction': 'in'}
                   ],
    'to_enum'    : [  #  to convert a choice discriminant to an enum
                    {'type': ENUMERATED, 'direction': 'in'},
                    {'type': ANY_TYPE,   'direction': 'in'}
                   ],
148
149
150
151
    'val'    : [  #  to convert a number to an enumerated type value
                    {'type': UNSIGNED,   'direction': 'in'},  # eg. 1
                    {'type': ANY_TYPE,   'direction': 'in'}   # eg. MyChoice
                   ],
152
153
154
155
156
    'choice_to_int' : [  #  to return the value of a numerical choice item
                    {'type': CHOICE,     'direction': 'in'},  # choice variable
                    {'type': NUMERICAL,  'direction': 'in'}   # default value
                   ],

157
}
Maxime Perrotin's avatar
Maxime Perrotin committed
158
159
160
161

# Container to keep a list of types mapped from ANTLR Tokens
# (Used with singledispatch/visitor pattern)
ANTLR_TOKEN_TYPES = {a: type(a, (antlr3.tree.CommonTree,), {})
Maxime Perrotin's avatar
Maxime Perrotin committed
162
                    for a, b in lexer.__dict__.items() if type(b) == int}
Maxime Perrotin's avatar
Maxime Perrotin committed
163
164
165
166
167
168
169
170
171
172
173
174


# Shortcut to create a new referenced ASN.1 type
new_ref_type = lambda refname: \
        type(str(refname), (object,),
                {'kind': 'ReferenceType',
                 'ReferencedTypeName': refname.replace('_', '-')})

# Shortcut to return a type name (Reference name or basic type)
type_name = lambda t: \
                t.kind if t.kind != 'ReferenceType' else t.ReferencedTypeName

175
176
177
# return the line number of this python module, useful for debugging
lineno = lambda : currentframe().f_back.f_lineno

178
179
180
181
# user may create SDL (non-asn1) types with the newtype keyword
# they are stored in a dedicated dictionary with the same structure
# as the ASN1SCC generated python AST
USER_DEFINED_TYPES = dict()
182
CHOICE_SELECTORS = dict()
183

184

185
186
187
188
189
def types():
    ''' Return all ASN.1 and user defined types '''
    ret = getattr(DV, 'types', {}).copy()
    ret.update(USER_DEFINED_TYPES)
    return ret
Maxime Perrotin's avatar
Maxime Perrotin committed
190
191


192
def set_global_DV(asn1_filenames):
Maxime Perrotin's avatar
Maxime Perrotin committed
193
    # type: (List[str]) -> None
194
195
    ''' Call ASN.1 parser and set the global dataview AST entry (DV) '''
    global DV
196
    global USER_DEFINED_TYPES
197
198
199
200
    if '--toC' in sys.argv:
        rename_policy = ASN1.RenameOnlyConflicting
    else:
        rename_policy = ASN1.NoRename
201
202
203
    try:
        DV = parse_asn1(tuple(asn1_filenames),
                        ast_version=ASN1.UniqueEnumeratedNames,
204
                        rename_policy=rename_policy,
Maxime Perrotin's avatar
Maxime Perrotin committed
205
206
                        flags=[ASN1.AstOnly],
                        pretty_print=True)
207
208
        # Create new types corresponding to CHOICE determinants as enum
        choice_selectors = create_choice_determinant_types (DV)
209
210
211
212
213
        #  Add to user defined types, so that they wil be generated
        #  as explicit ASN.1 types
        CHOICE_SELECTORS.update(choice_selectors)
        USER_DEFINED_TYPES=CHOICE_SELECTORS.copy()
        #DV.types.update(choice_selectors)
214
215
216
217
218
219
220
221
222
    except (ImportError, NameError) as err:
        # Can happen if DataView.py is not there
        LOG.error('Error loading ASN.1 model')
        LOG.debug(str(err))
    except TypeError as err:
        LOG.debug(traceback.format_exc())
        raise TypeError('ASN.1 compiler failed - {}'.format(str(err)))


Maxime Perrotin's avatar
Maxime Perrotin committed
223
def substring_range(substring: ogAST.PrimSubstring) -> Tuple[str, str]:
224
225
226
227
228
229
230
    ''' Return the range of a substring '''
    left, right = substring.value[1]['substring']
    left_bty = find_basic_type(left.exprType)
    right_bty = find_basic_type(right.exprType)
    return left_bty.Min, right_bty.Max


Maxime Perrotin's avatar
Maxime Perrotin committed
231
def is_number(basic_ty) -> bool:
Maxime Perrotin's avatar
Maxime Perrotin committed
232
233
234
235
    ''' Return true if basic type is a raw number (i.e. not a variable) '''
    return basic_ty.__name__ in ('Universal_Integer', 'PrReal')


Maxime Perrotin's avatar
Maxime Perrotin committed
236
def is_integer(ty) -> bool:
dbarbera's avatar
dbarbera committed
237
238
239
240
241
242
243
    ''' Return true if a type is an Integer Type '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type'
    )


Maxime Perrotin's avatar
Maxime Perrotin committed
244
def is_real(ty) -> bool:
245
246
247
248
    ''' Return true if a type is a Real Type '''
    return find_basic_type(ty).kind == 'RealType'


Maxime Perrotin's avatar
Maxime Perrotin committed
249
def is_numeric(ty) -> bool:
dbarbera's avatar
dbarbera committed
250
    ''' Return true if a type is a Numeric Type '''
251
252
253
254
255
256
257
258
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type',
        'Numerical',
        'RealType'
    )


Maxime Perrotin's avatar
Maxime Perrotin committed
259
def is_boolean(ty) -> bool:
260
261
262
263
    ''' Return true if a type is a Boolean Type '''
    return find_basic_type(ty).kind == 'BooleanType'


Maxime Perrotin's avatar
Maxime Perrotin committed
264
def is_null(ty) -> bool:
265
266
267
268
    ''' Return true if a type is a NULL Type '''
    return find_basic_type(ty).kind == 'NullType'


Maxime Perrotin's avatar
Maxime Perrotin committed
269
def is_string(ty) -> bool:
dbarbera's avatar
dbarbera committed
270
271
272
    ''' Return true if a type is a String Type '''
    return find_basic_type(ty).kind in (
        'StandardStringType',
273
274
        'OctetStringType',
        'StringType'
dbarbera's avatar
dbarbera committed
275
276
277
    )


Maxime Perrotin's avatar
Maxime Perrotin committed
278
def is_sequenceof(ty) -> bool:
279
280
281
282
    ''' Return true if a type is a SequenceOf Type '''
    return find_basic_type(ty).kind == 'SequenceOfType'


Maxime Perrotin's avatar
Maxime Perrotin committed
283
def is_list(ty) -> bool:
284
285
286
287
    ''' Return true if a type is a List Type '''
    return is_string(ty) or is_sequenceof(ty) or ty == LIST


Maxime Perrotin's avatar
Maxime Perrotin committed
288
def is_enumerated(ty) -> bool:
289
290
291
292
    ''' Return true if a type is an Enumerated Type '''
    return find_basic_type(ty).kind == 'EnumeratedType' or ty == ENUMERATED


Maxime Perrotin's avatar
Maxime Perrotin committed
293
def is_sequence(ty) -> bool:
294
295
296
297
    ''' Return true if a type is a Sequence Type '''
    return find_basic_type(ty).kind == 'SequenceType'


Maxime Perrotin's avatar
Maxime Perrotin committed
298
def is_choice(ty) -> bool:
299
300
301
302
    ''' Return true if a type is a Choice Type '''
    return find_basic_type(ty).kind == 'ChoiceType' or ty == CHOICE


Maxime Perrotin's avatar
Maxime Perrotin committed
303
def is_timer(ty) -> bool:
304
305
306
307
    ''' Return true if a type is a Timer Type '''
    return find_basic_type(ty).kind == 'TimerType'


Maxime Perrotin's avatar
Maxime Perrotin committed
308
def sdl_to_asn1(sort: str):
Maxime Perrotin's avatar
Maxime Perrotin committed
309
310
311
312
    '''
        Convert case insensitive type reference to the actual type as found
        in the ASN.1 datamodel
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
313
    for asn1_type in types().keys():
Maxime Perrotin's avatar
Maxime Perrotin committed
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
        if sort.replace('_', '-').lower() == asn1_type.lower():
            break
    else:
        raise TypeError('Type {} not found in ASN.1 model'.format(sort))
    return new_ref_type(asn1_type)


def node_filename(node):
    ''' Return the filename associated to the stream of this node '''
    parent = node
    while parent:
        try:
            return parent.getToken().getInputStream().fileName
        except AttributeError:
            parent = parent.getParent()
    return None


def token_stream(node):
    '''
        Return the token stream associated to a tree node
        It is set at the root of the tree by the parser
    '''
    parent = node
    while parent:
        try:
            return parent.token_stream
        except AttributeError:
            parent = parent.getParent()


def signals_in_system(ast):
    ''' Recursively find signal definitions in a nested SDL model '''
    all_signals = []
    for block in ast.blocks:
        all_signals.extend(signals_in_system(block))
    all_signals.extend(ast.signals)
    return all_signals


def find_process_declaration(ast, process_name):
    ''' Recursively search for a process declaration in a nested SDL model '''
    for block in ast.blocks:
        result = find_process_declaration(block, process_name)
        if result:
            return result
    try:
        for process in ast.processes:
362
363
364
            if process.processName.lower() == process_name.lower():
                return process
            elif process.instance_of_name.lower() == process_name.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
365
366
367
368
369
370
371
372
373
374
375
376
377
                return process
    except AttributeError:
        return None
    return None


def valid_output(scope):
    '''
        Yields the output, procedures, and operators names,
        that is all the elements that can be valid in an OUTPUT symbol
        (does not mean it IS valid - caller still has to check it)
    '''
    for out_sig in scope.output_signals:
378
        yield out_sig['name']
Maxime Perrotin's avatar
Maxime Perrotin committed
379
    for proc in scope.procedures:
380
        yield proc.inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
381
    for special_op in SPECIAL_OPERATORS:
382
        yield special_op
Maxime Perrotin's avatar
Maxime Perrotin committed
383
384
385
386
387
388


def get_interfaces(ast, process_name):
    '''
        Search for the list of input and output signals (async PI/RI)
        and procedures (sync RI) of a process in a given top-level AST
389
390
391
        process_name can be the name of a process type, in which case the
        interfaces can only be found by looking at an instance of the type
        that is actually connected in the system
Maxime Perrotin's avatar
Maxime Perrotin committed
392
    '''
393
    all_signals, async_signals, errors = [], [], set()
394
    system = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
395
396
397
398
399
400
401
402
403
404
405
406

    # Move up to the system level, in case process is nested in a block
    # and not defined at root level as it is the case when it is referenced
    while hasattr(system, 'parent'):
        system = system.parent

    # If we are at AST level, check in all systems, otherwise in current one
    iterator = ast.systems if hasattr(ast, 'systems') else (system,)

    for system in iterator:
        all_signals.extend(signals_in_system(system))
        process_ref = find_process_declaration(system, process_name)
407
408
        # Update process name with the name of the instance if we are parsing
        # a process type.
Maxime Perrotin's avatar
Maxime Perrotin committed
409
        if process_ref:
410
            process_name = process_ref.processName
411
412
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
413
414
415
            break
    else:
        if isinstance(ast, ogAST.Block):
416
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
417
418
        else:
            raise TypeError('Process ' + process_name +
419
                        ' is defined but not declared in a system')
Maxime Perrotin's avatar
Maxime Perrotin committed
420
    # Find in and out signals names using the signalroutes
421
    undeclared_signals = []
422
423
    for each in process_parent.signalroutes:
        for route in each['routes']:
Maxime Perrotin's avatar
Maxime Perrotin committed
424
425
426
427
428
429
430
431
            if route['source'] == process_name:
                direction = 'out'
            elif route['dest'] == process_name:
                direction = 'in'
            else:
                continue
            for sig_id in route['signals']:
                # Copy the signal to the result dict
432
433
                try:
                    found, = [dict(sig) for sig in all_signals
434
                              if sig['name'].lower() == sig_id.lower()]
435
436
437
                    found['direction'] = direction
                    async_signals.append(found)
                except ValueError:
438
                    undeclared_signals.append(sig_id)
439
                except (KeyError, AttributeError) as err:
440
441
442
443
444
445
                    # Exceptions raised if a signal is not defined, i.e. there
                    # if an empty signal entry in the list. This can happen
                    # if the name of the signal is a reserved keyword, such as
                    # "stop", "reset"...
                    errors.add('Check the names of your signals against'
                               ' reserved keywords')
446
    if undeclared_signals:
447
448
        errors.add('Missing declaration for signal(s) {}'
                   .format(', '.join(undeclared_signals)))
449
    return async_signals, system.procedures, errors
Maxime Perrotin's avatar
Maxime Perrotin committed
450
451
452
453


def get_input_string(root):
    ''' Return the input string of a tree node '''
454
455
456
457
458
459
460
    try:
       res = token_stream(root).toString(root.getTokenStartIndex(),
                root.getTokenStopIndex())
       return res
    except AttributeError as err:
        # in case there is no token_strem(root)
        return ""
Maxime Perrotin's avatar
Maxime Perrotin committed
461
462


Maxime Perrotin's avatar
Maxime Perrotin committed
463
def error(root, msg: str) -> str:
dbarbera's avatar
dbarbera committed
464
    ''' Return an error message '''
465
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
466
467


Maxime Perrotin's avatar
Maxime Perrotin committed
468
def warning(root, msg: str) -> str:
dbarbera's avatar
dbarbera committed
469
    ''' Return a warning message '''
470
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
471
472


473
def check_syntax(node: antlr3.tree.CommonTree,
Maxime Perrotin's avatar
Maxime Perrotin committed
474
475
476
                 recursive:bool = False,
                 filename:str = "",
                 input_string:str = "") -> None:
477
478
479
480
481
482
483
484
485
    ''' Check if the ANTLR node is valid, otherwise raise an excption,
    meaning there is a syntax error, and report the string that could not be
    parsed '''
    def check(root: antlr3.tree.CommonTree,
              parent: antlr3.tree.CommonTree,
              rec: bool) -> None:
        if rec:
            for child in root.getChildren():
                check(child, parent, rec)
Maxime Perrotin's avatar
Maxime Perrotin committed
486
487
488
        if isinstance(root, antlr3.tree.CommonErrorNode):  #  in tree.py
            exc = root.trappedException    # in exceptions.py
            token = exc.token
489
490
491
            token_str = token.text
            line = token.line
            pos = token.charPositionInLine + 1
Maxime Perrotin's avatar
Maxime Perrotin committed
492
493
            if filename:
                text = open(filename, 'r').readlines()
494
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
                text = input_string.split('\n')
            if isinstance(exc, antlr3.exceptions.MismatchedTokenException):
                err_msg = f'{" "*(pos-1)}^__ Expected ' \
                          f'"{lexer.tokenNamesMap[exc.expecting]}", ' \
                          f'got "{token_str}"'
            else:
                err_msg = f'{" "*(pos-1)}^__ Unexpected "{token_str}"'
            if len(text) >= line:
                syntax_error = f'{text[line-1]}\n{err_msg}'
            else:
                LOG.error("Unrecoverable Error with text input")
                syntax_error = f'{err_msg} (line {line} offset {pos}) {len(text)} {text} {str(exc)}'
            se_exc          = SyntaxError(syntax_error)
            se_exc.filename = filename
            se_exc.lineno   = line
            se_exc.offset   = pos
            se_exc.text     = syntax_error
            raise se_exc
            #raise SyntaxError(syntax_error)
514
515
516
    check(node, parent=node, rec=recursive)


Maxime Perrotin's avatar
Maxime Perrotin committed
517
def tmp() -> int:
dbarbera's avatar
dbarbera committed
518
519
520
521
522
523
524
    ''' Return a temporary variable name '''
    global TMPVAR
    varname = TMPVAR
    TMPVAR += 1
    return varname


Maxime Perrotin's avatar
Maxime Perrotin committed
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
def get_state_list(process_root):
    ''' Return the list of states of a process '''
    # 1) get all STATE statements
    states = (child for child in process_root.getChildren()
            if child.type == lexer.STATE)
    # 2) keep only the ones containing a STATELIST token (i.e. no ASTERISK)
    relevant = (child for state in states for child in state.getChildren()
            if child.type == lexer.STATELIST)
    # 3) extract the state list from each of them
    state_list = [s.text.lower() for r in relevant for s in r.getChildren()]
    # state_list.append('START')
    # 4) create a set to remove duplicates
    return set(state_list)


540
def find_basic_type(a_type, pool=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
541
542
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type or UNKNOWN_TYPE
543
    pool = pool or types()
Maxime Perrotin's avatar
Maxime Perrotin committed
544
    while basic_type.kind == 'ReferenceType':
545
546
547
        Min = getattr(basic_type, "Min", None)
        Max = getattr(basic_type, "Max", None)

Maxime Perrotin's avatar
Maxime Perrotin committed
548
        # Find type with proper case in the data view
Maxime Perrotin's avatar
Maxime Perrotin committed
549
        for typename in pool.keys():
Maxime Perrotin's avatar
Maxime Perrotin committed
550
            if typename.lower() == basic_type.ReferencedTypeName.lower():
551
                basic_type = pool[typename].type
552
                if Min is not None and Max is not None \
553
554
                        and (is_numeric(basic_type) or is_string(basic_type)
                                or is_sequenceof(basic_type)):
555
556
557
558
559
560
                    # Subtypes may have defined subranges
                    new_type = type('Subtype',  basic_type.__bases__,
                            dict (basic_type.__dict__))
                    new_type.Min = Min
                    new_type.Max = Max
                    basic_type = new_type
Maxime Perrotin's avatar
Maxime Perrotin committed
561
562
563
564
565
566
                break
        else:
            raise TypeError('Type "' + type_name(basic_type) +
                            '" was not found in Dataview')
    return basic_type

Maxime Perrotin's avatar
Maxime Perrotin committed
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
def find_type_name(a_type, pool=None) -> str:
    ''' A Type may be an alias of another type, if it has a ReferencedTypeName
    and the same constraints as the referenced type. This function finds the
    name of the original type definition '''
    if a_type.kind != 'ReferenceType':
        raise TypeError('Not a referenced type')
    pool = pool or types()
    refname = a_type.ReferencedTypeName
    Min = getattr(a_type, "Min", None)
    Max = getattr(a_type, "Max", None)
    for typename in pool.keys():
        # Find the referenced type in the dataview
        if refname.lower() == typename.lower():
            parent = pool[typename].type
            parent_Min = getattr(parent, "Min", None)
            parent_Max = getattr(parent, "Max", None)
            if((Min != None and parent_Min != Min)
                    or (Max != None and parent_Max != Max)
                    or parent.kind != 'ReferenceType'):
                # Parent has different constraints or is a basic type
                return refname
            else:
                return find_type_name(parent)
Maxime Perrotin's avatar
Maxime Perrotin committed
590

591
592
593
594
595
def signature(name, context):
    ''' Return the signature of a procecure/output/operator '''
    name = name.lower()
    if name in SPECIAL_OPERATORS:
        return SPECIAL_OPERATORS[name]
Maxime Perrotin's avatar
Maxime Perrotin committed
596

597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
    for out_sig in context.output_signals:
        if out_sig['name'].lower() == name:
            signature = []
            if out_sig.get('type'):
                # output signals: one single parameter
                signature.append({
                    'type': out_sig.get('type'),
                    'name': out_sig.get('param_name' or ''),
                    'direction': 'in',
                })
            return signature

    for inner_proc in context.procedures:
        proc_name = inner_proc.inputString
        if proc_name.lower() == name:
            return inner_proc.fpar

    raise AttributeError('Operator/output/procedure not found: ' + name)


617
618
def check_call(name, params, context):
    ''' Check the parameter types of a procedure/output/operator call,
Maxime Perrotin's avatar
Maxime Perrotin committed
619
620
        returning the type of its result (value-returning functions only,
        i.e not signal sending '''
621

622
    # Special case for write/writeln functions
623
    if name.lower() in ('write', 'writeln'):
624
        def check_one_param(p, name):
625
            p_ty = p.exprType
626
627
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty) or \
                    is_enumerated(p_ty):
628
                return
629
630
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
631
632
633
634
635
636
        for p in params:
            if not isinstance(p, ogAST.PrimConditional):
                check_one_param(p, name)
            else:
                for each in (p.value['then'], p.value['else']):
                    check_one_param(each, name)
637
                # check that both "then" and "else" are of a similar type
638
639
640
641
642
643
644
645
646
647
648
649
650
651
                # (string, int, or enumerated), this is necessary for the
                # backends
                if (is_numeric(p.value['then'].exprType) ==
                   is_numeric(p.value['else'].exprType) == True) or \
                   (is_boolean(p.value['then'].exprType) ==
                   is_boolean(p.value['else'].exprType) == True) or \
                   (is_string(p.value['then'].exprType) ==
                   is_string(p.value['else'].exprType) == True) or \
                   (is_enumerated(p.value['then'].exprType) ==
                   is_enumerated(p.value['else'].exprType) == True):
                      p.exprType = p.value['then'].exprType
                else:
                    raise TypeError('{}: both options must have the type type.'
                                    .format(name))
Maxime Perrotin's avatar
Maxime Perrotin committed
652
        return UNKNOWN_TYPE
Maxime Perrotin's avatar
Maxime Perrotin committed
653

654
655
656
657
658
659
660
661
662
    # Special case for "exist" function
    elif name == 'exist':
        # "exist" shall return true if an optional SEQUENCE field is present
        # We have to check that the parameter is actually an optional field
        # So we check first that there is only one param
        # then that this is a PrimSelector (at least "a.b")
        # Then we analyse from the variable to the last field if that is
        # actually an optional field, using the ASN.1 data model
        if len(params) != 1:
663
            raise TypeError('"exist" operator takes only one parameter')
664
665
        param, = params
        if not isinstance(param, ogAST.PrimSelector):
666
            raise TypeError('"exist" operator only works on optional fields')
667
668
669
670
671
672
673
674
675
676
677
678
679
680
        left = param.value[0] # Can be a variable or another PrimSelector
        field_list = [param.value[1]] # string of the field name
        while isinstance(left, ogAST.PrimSelector):
            field_list.append(left.value[1])
            left = left.value[0]
        sort = find_basic_type(left.exprType)  # must have Children
        if sort.kind == 'UnknownType':
            raise TypeError('Variable not found in call to "exist" operator')
        # At this point we know that the expression is correct, so we will
        # not miss any child in the dataview. We can follow the children
        # in the ASN.1 model until we reach the last one, which shall be
        # optional
        while field_list:
            child_name = field_list.pop().replace('_', '-').lower()
Maxime Perrotin's avatar
Maxime Perrotin committed
681
            for child in sort.Children.keys():
682
683
684
685
686
687
688
689
690
691
692
693
                if child.lower() == child_name:
                    break
            optional = sort.Children[child].Optional
            sort = sort.Children[child].type
            if sort.kind == 'ReferenceType':
                sort = find_basic_type (sort)
        # At this point we should have found the last type
        if optional != "True":
            raise TypeError('Field is not optional in call to "exist"')
        return type('Exist', (object,), {
            'kind': 'BooleanType'
        })
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
    elif name == 'val':
        # val converts a positive number to a enumeration literal
        # the first parameter is the number and the second is the type name
        # of the enumeration. It is equivalent in Ada to EnumType'Val(number)
        if len(params) != 2:
            raise TypeError(name + " takes 2 parameters: number, type")
        variable, target_type = params
        variable_sort = find_basic_type(variable.exprType)
        if variable_sort.kind != 'IntegerType':
            raise TypeError(name + ': First parameter is not an number')
        sort_name = target_type.value[0]  #  raw string of the type to cast
        for sort in types().keys():
            if sort.lower().replace('-', '_') == \
                    sort_name.lower().replace('-', '_'):
                break
        else:
            raise TypeError(name + ': type ' + sort_name + 'not found')
        # we could check if the range of the number is compatible with the
        # number of values...
        return_type = types()[sort].type
        return return_type
715

716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
    elif name in ('to_selector', 'to_enum'):
        if len(params) != 2:
            raise TypeError(name + " takes 2 parameters: variable, type")
        variable, target_type = params
        variable_sort = find_basic_type(variable.exprType)
        if variable_sort.kind == 'UnknownType':
            raise TypeError(name + ': variable not found (parameter 1)')
        if variable_sort.kind != 'EnumeratedType':
            raise TypeError(name + ': First parameter is not an enumerated')
        sort_name = target_type.value[0]  #  raw string of the type to cast
        for sort in types().keys():
            if sort.lower().replace('-', '_') == \
                    sort_name.lower().replace('-', '_'):
                break
        else:
            raise TypeError(name + ': type ' + sort_name + 'not found')
        # check that the list of enumerants are identical. unfortunately we
        # cannot check the ordering, as it is an unordered dict
        if name == 'to_selector':
735
736
737
            # if the sort is a subtype, it may not have a -selection suffix
            # and an exception may be raised. FIXME : check "present" operator
            # as the issue is already fixed there
738
739
740
741
742
743
744
745
746
747
748
            return_type = types()[sort + '-selection'].type
        else:
            return_type = types()[sort].type
        if return_type.kind != 'EnumeratedType':
            raise TypeError(name + ': Second parameter is incorrect')
        return_type_keys = return_type.EnumValues.keys()
        variable_sort_keys = variable_sort.EnumValues.keys()
        if return_type_keys != variable_sort_keys:
            raise TypeError(name + ': Enumerated type are not equivalent')
        return return_type

Maxime Perrotin's avatar
Maxime Perrotin committed
749
750
    # (1) Find the signature of the function
    # signature will hold the list of parameters for the function
751
    sign = signature(name, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
752
753

    # (2) Check that the number of given parameters matches the signature
754
755
756
    if len(sign) != len(params):
        raise TypeError('Expected {} arguments in call to {} ({} received)'.
            format(len(sign), name, len(params)))
Maxime Perrotin's avatar
Maxime Perrotin committed
757

758
759
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
760
        warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
761
        expr               = ogAST.ExprAssign()
762
        expr.left          = ogAST.PrimVariable(debugLine=lineno())
763
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
764
        expr.right         = param
765
766

        try:
767
768
769
            basic_left  = find_basic_type(expr.left.exprType)
            basic_right = find_basic_type(expr.right.exprType)
            #print getattr(basic_left, "Min", 0), getattr(basic_right, "Min", 0)
Maxime Perrotin's avatar
Maxime Perrotin committed
770
            warnings.extend(fix_expression_types(expr, context))
771
            params[idx] = expr.right
772
        except TypeError as err:
773
774
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
775
776
777
            raise TypeError('In call to {}: Type of parameter {} is incorrect'
                            ' ({}) - {}'
                            .format(name, idx+1, received, str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
778
        if (warnings):
779
780
781
782
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise Warning('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
783
784

        if sign[idx].get('direction') != 'in' \
785
786
                and not isinstance(expr.right, ogAST.PrimVariable):
            raise TypeError('OUT parameter "{}" is not a variable'
787
                .format(expr.right.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
788

789
790
791
    # (4) Compute the type of the result
    param_btys = [find_basic_type(p.exprType) for p in params]
    if name == 'abs':
Maxime Perrotin's avatar
Maxime Perrotin committed
792
        # The implementation of abs in *all* programming languages returns
Maxime Perrotin's avatar
Maxime Perrotin committed
793
794
        # a type that is the same as the type of the parameter. The returned
        # value is *not* unsigned. abs(integer'Min) returns a NEGATIVE number
Maxime Perrotin's avatar
Maxime Perrotin committed
795
796
        # this is an issue in an assign statement, if the recipient is
        # unsigned .. A cast is necessary if the parameter of abs is negative
797
798
        Min = float(param_btys[0].Min)
        Max = float(param_btys[0].Max)
Maxime Perrotin's avatar
Maxime Perrotin committed
799
        if params[0].exprType.kind != 'ReferenceType' and Min == Max:
800
801
802
803
804
805
806
807
            # if param is a raw number, return a positive range
            # otherwise return the same type as the variable
            return type('Universal_Integer', (param_btys[0],), {
               'Min': str(max(Min, 0)),
               'Max': str(max(Max, 0))
           })
        else:
            return type('Abs', (param_btys[0],), {})
808
809
810
811
812
813
814

    elif name == 'ceil':
        return type('Ceil', (REAL,), {
            'Min': str(math.ceil(float(param_btys[0].Min))),
            'Max': str(math.ceil(float(param_btys[0].Max)))
        })

dbarbera's avatar
dbarbera committed
815
816
817
818
819
820
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
    elif name == 'fix':
        return type('Fix', (INTEGER,), {
            'Min': param_btys[0].Min,
            'Max': param_btys[0].Max
        })

    elif name == 'float':
        return type('Float', (REAL,), {
            'Min': param_btys[0].Min,
            'Max': param_btys[0].Max
        })

    elif name == 'floor':
        return type('Floor', (REAL,), {
            'Min': str(math.floor(float(param_btys[0].Min))),
            'Max': str(math.floor(float(param_btys[0].Max)))
        })

    elif name == 'length':
840
        return type('Length', (INT32,), {
841
842
843
844
845
846
            'Min': param_btys[0].Min,
            'Max': param_btys[0].Max
        })

    elif name == 'num':
        enum_values = [int(each.IntValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
847
                       for each in param_btys[0].EnumValues.values()]
848
849
850
851
852
853
854
855
856
857
858
859
860
861
        return type('Num', (INTEGER,), {
            'Min': str(min(enum_values)),
            'Max': str(max(enum_values))
        })

    elif name == 'power':
        return type('Power', (param_btys[0],), {
            'Min': str(pow(float(param_btys[0].Min),
                           float(param_btys[1].Min))),
            'Max': str(pow(float(param_btys[0].Max),
                           float(param_btys[1].Max)))
        })

    elif name == 'present':
862
        p, = params
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
        # When we get there, the parameter has been checked already and we
        # know it is a CHOICE type.
        # However it may be a subtype, and in the AST the choices are defined
        # in the supertype, so we must find it and and the -selection suffix
        # This suffix is added by the Asn1scc module.
        sort = p.exprType
        sort_name = type_name (sort)
        try:
            while sort.kind == "ReferenceType":
                sort_name = sort.ReferencedTypeName
                sort = types()[sort.ReferencedTypeName].type
        except AttributeError:
            # Native choice types don't have the kind field here
            pass
        return types()[sort_name + "-selection"].type
878

879
880
881
882
883
884
885
886
887
888
    # choice_to_int: returns an integer corresponding to either the currently
    # selected choice value (e.g. foo in CHOICE { foo INTEGER (..), ... } when
    # foo is the current choice). or a default, user-defined value if the
    # current choice is not numerical. The first parameter is an instance of
    # a CHOICE type, and the second parameter is the default value.
    elif name == 'choice_to_int':
        p1, _ = params
        #sort = type_name (p1.exprType)
        return type('choice_to_int', (INTEGER,), {})

dbarbera's avatar
dbarbera committed
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
    elif name == 'round':
        return type('Round', (REAL,), {
            'Min': str(round(float(param_btys[0].Min))),
            'Max': str(round(float(param_btys[0].Max)))
        })

    elif name == 'sin':
        return type('Sin', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

    elif name == 'sqrt':
        return type('Sqrt', (REAL,), {
            'Min': str(0.0),
            'Max': str(math.sqrt(float(param_btys[0].Max)))
        })

907
908
909
910
911
912
    elif name == 'trunc':
        return type('Trunc', (REAL,), {
            'Min': str(math.trunc(float(param_btys[0].Min))),
            'Max': str(math.trunc(float(param_btys[0].Max)))
        })

913
914
915
916
917
918
919
    else:
        # check if procedure is declared to return a type
        for inner_proc in context.procedures:
            proc_name = inner_proc.inputString
            if proc_name.lower() == name.lower() and inner_proc.return_type:
                return inner_proc.return_type

920
921
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
922

Maxime Perrotin's avatar
Maxime Perrotin committed
923
924
925
def check_range(typeref, type_to_check):
    ''' Verify the that the Min/Max bounds of two types are compatible
        Called to test that assignments are withing allowed range
dbarbera's avatar
dbarbera committed
926
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
927
928
    '''
    try:
929
930
931
932
933
934
935
936
937
938
939
940
        min1, max1 = float(type_to_check.Min), float(type_to_check.Max)
        min2, max2 = float(typeref.Min), float(typeref.Max)
        error   = min1 > max2 or max1 < min2
        warning = min1 < min2 or max1 > max2
        if error:
            raise TypeError(
                    'Expression in range {} .. {} is outside range {} .. {}'
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
        elif warning:
            raise Warning('Expression in range {} .. {}, '
                          'could be outside expected range {} .. {}'
Maxime Perrotin's avatar
Maxime Perrotin committed
941
942
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
943
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
944
945
946
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
947
948
def fix_append_expression_type(expr, expected_type):
    ''' In an Append expression, all components must be of the same type,
949
        which is the type expected by the user of the append, for example
Maxime Perrotin's avatar
Maxime Perrotin committed
950
951
952
953
954
955
956
        the left part of an assign expression.
        We must recursively fix the Append type, in case we have a//b//c
        that is handled as (a//b)//c
        Inputs:
           expr: the append expression (possibly recursive)
           expected_type : the type to assign to the expression
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
957
    #print "[DEBUG] Fix append expression: ", expr.inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
958
959
960
961
    def rec_append(inner_expr, set_type):
        for each in (inner_expr.left, inner_expr.right):
            if isinstance(each, ogAST.ExprAppend):
                rec_append(each, set_type)
962
963
964
            if each.exprType == UNKNOWN_TYPE:
                # eg. if the side is a PrimConditional (ternary)
                each.exprType = set_type
Maxime Perrotin's avatar
Maxime Perrotin committed
965
966
967
968
969
970
            each.expected_type = set_type
    rec_append(expr, expected_type)
    expr.exprType      = expected_type
    expr.expected_type = expected_type


Maxime Perrotin's avatar
Maxime Perrotin committed
971
def check_type_compatibility(primary, type_ref, context):
Maxime Perrotin's avatar
Maxime Perrotin committed
972
973
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
974
        is compatible with a given type (type_ref is an ASN1Scc type)
975
        Possibly returns a list of warnings; can raises TypeError
Maxime Perrotin's avatar
Maxime Perrotin committed
976
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
977
    warnings = []    # function returns a list of warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
978
979
    # assert type_ref is not None
    if type_ref is UNKNOWN_TYPE or type_ref is None:
980
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
981
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
982

Maxime Perrotin's avatar
Maxime Perrotin committed
983
984
985
    #if primary.exprType == type_ref:
    #    return warnings

986
    basic_type = find_basic_type(type_ref)
987
988
989
990
991
992
993
994
995
996
    # watch out: type_ref may be a subtype of basic_type with different
    # min/max constraint, in particular in case of substrings
    if type_ref.__name__ == 'SubStr':
        minR, maxR = type_ref.Min, type_ref.Max
    else:
        try:
            minR, maxR = basic_type.Min, basic_type.Max
        except AttributeError:
            # some types do not have Min/Max ranges
            pass
Maxime Perrotin's avatar
Maxime Perrotin committed
997
998

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
999
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
1000
        # If type ref is an enumeration, check that the value is valid