ogParser.py 196 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
#!/usr/bin/env python
# -*- coding: utf-8 -*-


"""
    OpenGEODE SDL92 parser

    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.

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

    Designed and implemented by Maxime Perrotin

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

__author__ = 'Maxime Perrotin'

import sys
import os
dbarbera's avatar
dbarbera committed
31
import math
32
import operator
Maxime Perrotin's avatar
Maxime Perrotin committed
33
34
import logging
import traceback
35
import binascii
36
from textwrap import dedent
Maxime Perrotin's avatar
Maxime Perrotin committed
37
from itertools import chain, permutations, combinations
38
from collections import defaultdict, Counter
Maxime Perrotin's avatar
Maxime Perrotin committed
39
40
41
42
43
44
45
46
import antlr3
import antlr3.tree

import sdl92Lexer as lexer
from sdl92Parser import sdl92Parser

import samnmax
import ogAST
47
from Asn1scc import parse_asn1, ASN1
Maxime Perrotin's avatar
Maxime Perrotin committed
48
49
50

LOG = logging.getLogger(__name__)

51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
EXPR_NODE = {
    lexer.PLUS: ogAST.ExprPlus,
    lexer.ASTERISK: ogAST.ExprMul,
    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
73
} # type: Dict[int, ogAST.Expression]
Maxime Perrotin's avatar
Maxime Perrotin committed
74
75
76
77

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

Maxime Perrotin's avatar
Maxime Perrotin committed
78
DV = None  # type: module
Maxime Perrotin's avatar
Maxime Perrotin committed
79
80
81
82

# 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
83
TMPVAR = 0  # type: int
Maxime Perrotin's avatar
Maxime Perrotin committed
84
85

# ASN.1 types used to support the signature of special operators
86
87
88
INTEGER = type('IntegerType', (object,), {'kind': 'IntegerType',
                                          'Min': str(-(2 ** 63)),
                                          'Max': str(2 ** 63 - 1)})
Maxime Perrotin's avatar
Maxime Perrotin committed
89
INT32 = type('Integer32Type', (object,), {'kind': 'Integer32Type',
dbarbera's avatar
dbarbera committed
90
91
                                          'Min': '-2147483648',
                                          'Max': '2147483647'})
Maxime Perrotin's avatar
Maxime Perrotin committed
92
93
NUMERICAL = type('NumericalType', (object,), {'kind': 'Numerical'})
TIMER = type('TimerType', (object,), {'kind': 'TimerType'})
94
95
96
REAL = type('RealType', (object,), {'kind': 'RealType',
                                    'Min': str(1e-308),
                                    'Max': str(1e308)})
Maxime Perrotin's avatar
Maxime Perrotin committed
97
98
99
100
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'})
101
102
RAWSTRING = type('RawString', (object,), {'kind': 'StandardStringType',
                                          'Min': '0', 'Max': '255'})
103
OCTETSTRING = type('OctetString', (object,), {'kind': 'OctetStringType'})
104
ENUMERATED = type('EnumeratedType', (object,), {'kind': 'EnumeratedType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
105
106
107

UNKNOWN_TYPE = type('UnknownType', (object,), {'kind': 'UnknownType'})

108
SPECIAL_OPERATORS = {
dbarbera's avatar
dbarbera committed
109
110
    'abs': [{'type': NUMERICAL, 'direction': 'in'}],
    'ceil': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
111
    'cos': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
112
113
114
    'fix': [{'type': NUMERICAL, 'direction': 'in'}],
    'float': [{'type': NUMERICAL, 'direction': 'in'}],
    'floor': [{'type': REAL, 'direction': 'in'}],
115
    'length': [{'type': LIST, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
116
    'num': [{'type': ENUMERATED, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
117
118
119
120
    'power': [
        {'type': NUMERICAL, 'direction': 'in'},
        {'type': INTEGER, 'direction': 'in'}
    ],
121
122
    'present': [{'type': CHOICE, 'direction': 'in'}],
    'reset_timer': [{'type': TIMER, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
123
124
125
126
127
128
129
    'round': [{'type': REAL, 'direction': 'in'}],
    'set_timer': [
        {'type': INTEGER, 'direction': 'in'},
        {'type': TIMER, 'direction': 'in'}
    ],
    'sin': [{'type': REAL, 'direction': 'in'}],
    'sqrt': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
130
131
132
    'trunc': [{'type': REAL, 'direction': 'in'}],
    'write': [{'type': ANY_TYPE, 'direction': 'in'}],
    'writeln': [{'type': ANY_TYPE, 'direction': 'in'}],
133
}
Maxime Perrotin's avatar
Maxime Perrotin committed
134
135
136
137

# 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,), {})
138
                    for a, b in lexer.__dict__.viewitems() if type(b) == int}
Maxime Perrotin's avatar
Maxime Perrotin committed
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153


# 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

types = lambda: getattr(DV, 'types', {})


154
def set_global_DV(asn1_filenames):
Maxime Perrotin's avatar
Maxime Perrotin committed
155
    # type: (List[str]) -> None
156
157
    ''' Call ASN.1 parser and set the global dataview AST entry (DV) '''
    global DV
158
159
160
161
    if '--toC' in sys.argv:
        rename_policy = ASN1.RenameOnlyConflicting
    else:
        rename_policy = ASN1.NoRename
162
163
164
    try:
        DV = parse_asn1(tuple(asn1_filenames),
                        ast_version=ASN1.UniqueEnumeratedNames,
165
                        rename_policy=rename_policy,
Maxime Perrotin's avatar
Maxime Perrotin committed
166
167
                        flags=[ASN1.AstOnly],
                        pretty_print=True)
168
169
170
171
172
173
174
175
176
    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)))


177
def substring_range(substring):
Maxime Perrotin's avatar
Maxime Perrotin committed
178
    # type: (ogAST.PrimSubstring) -> Tuple[str, str]
179
180
181
182
183
184
185
    ''' 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


dbarbera's avatar
dbarbera committed
186
def is_integer(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
187
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
188
189
190
191
192
193
194
    ''' Return true if a type is an Integer Type '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type'
    )


195
def is_real(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
196
    # type: (Any) -> bool
197
198
199
200
    ''' Return true if a type is a Real Type '''
    return find_basic_type(ty).kind == 'RealType'


201
def is_numeric(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
202
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
203
    ''' Return true if a type is a Numeric Type '''
204
205
206
207
208
209
210
211
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type',
        'Numerical',
        'RealType'
    )


212
def is_boolean(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
213
    # type: (Any) -> bool
214
215
216
217
    ''' Return true if a type is a Boolean Type '''
    return find_basic_type(ty).kind == 'BooleanType'


218
def is_null(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
219
    # type: (Any) -> bool
220
221
222
223
    ''' Return true if a type is a NULL Type '''
    return find_basic_type(ty).kind == 'NullType'


dbarbera's avatar
dbarbera committed
224
def is_string(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
225
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
226
227
228
    ''' Return true if a type is a String Type '''
    return find_basic_type(ty).kind in (
        'StandardStringType',
229
230
        'OctetStringType',
        'StringType'
dbarbera's avatar
dbarbera committed
231
232
233
    )


234
def is_sequenceof(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
235
    # type: (Any) -> bool
236
237
238
239
240
    ''' Return true if a type is a SequenceOf Type '''
    return find_basic_type(ty).kind == 'SequenceOfType'


def is_list(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
241
    # type: (Any) -> bool
242
243
244
245
246
    ''' Return true if a type is a List Type '''
    return is_string(ty) or is_sequenceof(ty) or ty == LIST


def is_enumerated(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
247
    # type: (Any) -> bool
248
249
250
251
252
    ''' Return true if a type is an Enumerated Type '''
    return find_basic_type(ty).kind == 'EnumeratedType' or ty == ENUMERATED


def is_sequence(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
253
    # type: (Any) -> bool
254
255
256
257
258
    ''' Return true if a type is a Sequence Type '''
    return find_basic_type(ty).kind == 'SequenceType'


def is_choice(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
259
    # type: (Any) -> bool
260
261
262
263
264
    ''' Return true if a type is a Choice Type '''
    return find_basic_type(ty).kind == 'ChoiceType' or ty == CHOICE


def is_timer(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
265
    # type: (Any) -> bool
266
267
268
269
    ''' Return true if a type is a Timer Type '''
    return find_basic_type(ty).kind == 'TimerType'


Maxime Perrotin's avatar
Maxime Perrotin committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
def sdl_to_asn1(sort):
    '''
        Convert case insensitive type reference to the actual type as found
        in the ASN.1 datamodel
    '''
    for asn1_type in types().viewkeys():
        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:
324
325
326
            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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
                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:
        yield out_sig['name'].lower()
    for proc in scope.procedures:
        yield proc.inputString.lower()
    for special_op in SPECIAL_OPERATORS:
        yield special_op.lower()


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
351
352
353
        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
354
    '''
355
    all_signals, async_signals, errors = [], [], set()
356
    system = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
357
358
359
360
361
362
363
364
365
366
367
368

    # 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)
369
370
        # Update process name with the name of the instance if we are parsing
        # a process type.
Maxime Perrotin's avatar
Maxime Perrotin committed
371
        if process_ref:
372
            process_name = process_ref.processName
373
374
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
375
376
377
            break
    else:
        if isinstance(ast, ogAST.Block):
378
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
379
380
        else:
            raise TypeError('Process ' + process_name +
381
                        ' is defined but not declared in a system')
Maxime Perrotin's avatar
Maxime Perrotin committed
382
    # Find in and out signals names using the signalroutes
383
    undeclared_signals = []
384
385
    for each in process_parent.signalroutes:
        for route in each['routes']:
Maxime Perrotin's avatar
Maxime Perrotin committed
386
387
388
389
390
391
392
393
            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
394
395
                try:
                    found, = [dict(sig) for sig in all_signals
396
                              if sig['name'].lower() == sig_id.lower()]
397
398
399
                    found['direction'] = direction
                    async_signals.append(found)
                except ValueError:
400
                    undeclared_signals.append(sig_id)
401
                except (KeyError, AttributeError) as err:
402
403
404
405
406
407
                    # 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')
408
    if undeclared_signals:
409
410
        errors.add('Missing declaration for signal(s) {}'
                   .format(', '.join(undeclared_signals)))
411
    return async_signals, system.procedures, errors
Maxime Perrotin's avatar
Maxime Perrotin committed
412
413
414
415
416
417
418
419


def get_input_string(root):
    ''' Return the input string of a tree node '''
    return token_stream(root).toString(root.getTokenStartIndex(),
            root.getTokenStopIndex())


dbarbera's avatar
dbarbera committed
420
def error(root, msg):
Maxime Perrotin's avatar
Maxime Perrotin committed
421
    # type: (Any, str) -> str
dbarbera's avatar
dbarbera committed
422
    ''' Return an error message '''
423
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
424
425
426


def warning(root, msg):
Maxime Perrotin's avatar
Maxime Perrotin committed
427
    # type: (Any, str) -> str
dbarbera's avatar
dbarbera committed
428
    ''' Return a warning message '''
429
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
430
431


dbarbera's avatar
dbarbera committed
432
def tmp():
Maxime Perrotin's avatar
Maxime Perrotin committed
433
    # type : () -> int
dbarbera's avatar
dbarbera committed
434
435
436
437
438
439
440
    ''' Return a temporary variable name '''
    global TMPVAR
    varname = TMPVAR
    TMPVAR += 1
    return varname


Maxime Perrotin's avatar
Maxime Perrotin committed
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
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)


456
def find_basic_type(a_type, pool=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
457
458
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type or UNKNOWN_TYPE
459
    pool = pool or types()
Maxime Perrotin's avatar
Maxime Perrotin committed
460
461
    while basic_type.kind == 'ReferenceType':
        # Find type with proper case in the data view
462
        for typename in pool.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
463
            if typename.lower() == basic_type.ReferencedTypeName.lower():
464
                basic_type = pool[typename].type
Maxime Perrotin's avatar
Maxime Perrotin committed
465
466
467
468
469
470
471
                break
        else:
            raise TypeError('Type "' + type_name(basic_type) +
                            '" was not found in Dataview')
    return basic_type


472
473
474
475
476
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
477

478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
    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)


498
499
500
def check_call(name, params, context):
    ''' Check the parameter types of a procedure/output/operator call,
        returning the type of its result '''
501

502
    # Special case for write/writeln functions
503
    if name.lower() in ('write', 'writeln'):
504
505
        for p in params:
            p_ty = p.exprType
506
507
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty) or \
                    is_enumerated(p_ty):
508
509
510
                continue
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
Maxime Perrotin's avatar
Maxime Perrotin committed
511
        return UNKNOWN_TYPE
Maxime Perrotin's avatar
Maxime Perrotin committed
512
513
514

    # (1) Find the signature of the function
    # signature will hold the list of parameters for the function
515
    sign = signature(name, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
516
517

    # (2) Check that the number of given parameters matches the signature
518
519
520
    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
521

522
523
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
524
        warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
525
        expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
526
        expr.left = ogAST.PrimVariable()
527
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
528
        expr.right = param
529
530

        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
531
            warnings.extend(fix_expression_types(expr, context))
532
533
534
535
536
537
            params[idx] = expr.right
        except TypeError:
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise TypeError('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
Maxime Perrotin's avatar
Maxime Perrotin committed
538
        if (warnings):
539
540
541
542
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise Warning('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
543
544

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

549
550
551
    # (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
552
553
554
555
556
557
558
559
        # The implementation of abs in *all* progamming languages returns
        # 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
        return type('Abs', (param_btys[0],), {})
#       return type('Abs', (param_btys[0],), {
#           'Min': str(max(float(param_btys[0].Min), 0)),
#           'Max': str(max(float(param_btys[0].Max), 0))
#       })
560
561
562
563
564
565
566

    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
567
568
569
570
571
572
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
    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':
592
        return type('Length', (INT32,), {
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
            'Min': param_btys[0].Min,
            'Max': param_btys[0].Max
        })

    elif name == 'num':
        enum_values = [int(each.IntValue)
                       for each in param_btys[0].EnumValues.viewvalues()]
        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':
        return type('Present', (object,), {
            'kind': 'ChoiceEnumeratedType',
            'EnumValues': param_btys[0].Children
        })

dbarbera's avatar
dbarbera committed
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
    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)))
        })

637
638
639
640
641
642
    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)))
        })

643
644
645
646
647
648
649
    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

650
651
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
652

Maxime Perrotin's avatar
Maxime Perrotin committed
653
654
655
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
656
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
657
658
659
660
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
661
            raise Warning('Expression evaluation in range [{}..{}], '
Maxime Perrotin's avatar
Maxime Perrotin committed
662
                          'could be outside expected range [{}..{}]'
Maxime Perrotin's avatar
Maxime Perrotin committed
663
664
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
665
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
666
667
668
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
669
def check_type_compatibility(primary, type_ref, context):  # type: -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
670
671
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
672
        is compatible with a given type (type_ref is an ASN1Scc type)
673
        Possibly returns a list of warnings; can raises TypeError
Maxime Perrotin's avatar
Maxime Perrotin committed
674
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
675
    warnings = []    # function returns a list of warnings
676
677
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
678
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
679
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
680

681
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
682
683

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
684
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
685
686
687
        # If type ref is an enumeration, check that the value is valid
        # Note, when using the "present" operator of a CHOICE type, the
        # resulting value is actually an EnumeratedType
688
689
690
691
        enumerant = primary.inputString.replace('_', '-').lower()
        for each in basic_type.EnumValues.keys():
            if each.lower() == enumerant:
                # Found -> all OK
Maxime Perrotin's avatar
Maxime Perrotin committed
692
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
693
        else:
694
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
695
                   '" not in this enumeration: ' +
696
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
697
            raise TypeError(err)
698
699
700
701
702
703
    elif isinstance(primary, ogAST.PrimConditional):
        then_expr = primary.value['then']
        else_expr = primary.value['else']

        for expr in (then_expr, else_expr):
            if expr.is_raw:
Maxime Perrotin's avatar
Maxime Perrotin committed
704
705
706
707
                warnings.extend(check_type_compatibility(expr,
                                                         type_ref,
                                                         context))
        return warnings
708

709
    elif isinstance(primary, (ogAST.PrimVariable, ogAST.PrimSelector)):
Maxime Perrotin's avatar
Maxime Perrotin committed
710
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
711
            warnings.extend(compare_types(primary.exprType, type_ref))
Maxime Perrotin's avatar
Maxime Perrotin committed
712
713
714
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
715
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
716
                                    err=str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
717
        return warnings
718

Maxime Perrotin's avatar
Maxime Perrotin committed
719
    elif isinstance(primary, ogAST.PrimInteger) \
dbarbera's avatar
dbarbera committed
720
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
721
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
722

Maxime Perrotin's avatar
Maxime Perrotin committed
723
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
724
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
725
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
726

727
    elif isinstance(primary, ogAST.ExprNeg):
Maxime Perrotin's avatar
Maxime Perrotin committed
728
729
730
        warnings.extend(check_type_compatibility(primary.expr,
                                                 type_ref,
                                                 context))
731

dbarbera's avatar
dbarbera committed
732
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
733
        return warnings
734

735
    elif isinstance(primary, ogAST.PrimNull) and is_null(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
736
        return warnings
737

738
739
740
741
    elif isinstance(primary, ogAST.PrimEmptyString):
        # Empty strings ("{ }") can be used for arrays and empty records
        if basic_type.kind == 'SequenceOfType':
            if int(basic_type.Min) == 0:
Maxime Perrotin's avatar
Maxime Perrotin committed
742
                return warnings
743
744
745
746
747
748
            else:
                raise TypeError('SEQUENCE OF has a minimum size of '
                                + basic_type.Min + ')')
        elif basic_type.kind == 'SequenceType':
            if len(basic_type.Children.keys()) > 0:
                raise TypeError('SEQUENCE is not empty, wrong "{}" syntax')
Maxime Perrotin's avatar
Maxime Perrotin committed
749
        else:
750
            raise TypeError('Not a type compatible with empty string syntax')
Maxime Perrotin's avatar
Maxime Perrotin committed
751
    elif isinstance(primary, ogAST.PrimSequenceOf) \
752
            and basic_type.kind == 'SequenceOfType':
753
754
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
755
                len(primary.value) > int(basic_type.Max)):
756
            #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
757
            raise TypeError(str(len(primary.value)) +
758
759
                      ' element(s) in SEQUENCE OF, while constraint is [' +
                      str(basic_type.Min) + ' .. ' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
760
        for elem in primary.value:
Maxime Perrotin's avatar
Maxime Perrotin committed
761
762
763
            warnings.extend(check_type_compatibility(elem,
                                                     basic_type.type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
764
765
        if not hasattr(primary, 'expected_type') \
               and type_ref.__name__ not in ('Apnd', 'SubStr'):
766
            primary.expected_type = type_ref
Maxime Perrotin's avatar
Maxime Perrotin committed
767
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
768
    elif isinstance(primary, ogAST.PrimSequence) \
769
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
770
        user_nb_elem = len(primary.value.keys())
771
        type_nb_elem = len(basic_type.Children.keys())
772
773
774
775
776
777
778
779
780
781
782
783
        optional_fields = [field.lower().replace('-', '_')
                           for field, val in basic_type.Children.viewitems()
                           if val.Optional == 'True']
        user_fields = [field.lower() for field in primary.value.keys()]
        for field, fd_data in basic_type.Children.viewitems():
            ufield = field.replace('-', '_')
            if ufield.lower() not in optional_fields \
                    and ufield.lower() not in user_fields:
                raise TypeError('Missing mandatory field {field} in SEQUENCE'
                                ' of type {t1} '
                                .format(field=ufield,
                                        t1=type_name(type_ref)))
784
            elif ufield.lower() not in user_fields:
785
786
787
788
                # Optional field not set - OK
                continue
            else:
                # If the user field is a raw value
789
790
791
792
793
794
                casefield = ufield
                for each in primary.value:
                    if each.lower() == ufield.lower():
                        casefield = each
                        break
                if primary.value[casefield].is_raw:
Maxime Perrotin's avatar
Maxime Perrotin committed
795
796
797
798
                    warnings.extend(check_type_compatibility
                                         (primary.value[casefield],
                                          fd_data.type,
                                          context))
Maxime Perrotin's avatar
Maxime Perrotin committed
799
                else:
800
801
                    # Compare the types for semantic equivalence
                    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
802
803
804
                        warnings.extend(compare_types
                                       (primary.value[casefield].exprType,
                                        fd_data.type))
805
                    except TypeError as err:
806
                        raise TypeError('Field "' + ufield + '" not of type ' +
807
808
                                    type_name(fd_data.type) +
                                    ' - ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
809
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
810
    elif isinstance(primary, ogAST.PrimChoiceItem) \
811
812
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
813
814
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
815
816
817
818
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
819
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
820
        # compare primary.value['value']
821
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
822
823
824
825
        value = primary.value['value']
        choice_field_type = choice.type
        # if the user field is a raw value:
        if value.is_raw:
Maxime Perrotin's avatar
Maxime Perrotin committed
826
827
828
            warnings.extend(check_type_compatibility(value,
                                                     choice_field_type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
829
830
831
        # Compare the types for semantic equivalence:
        else:
            try:
Maxime Perrotin's avatar
Maxime Perrotin committed
832
833
                warnings.extend(compare_types(value.exprType,
                                              choice_field_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
834
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
835
836
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
837
838
839
840
                            .format(field=primary.value['choice'],
                                    t1=type_name(choice_field_type),
                                    e=str(err)))
        value.exprType = choice_field_type         # XXX
Maxime Perrotin's avatar
Maxime Perrotin committed
841
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
842
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
843
844
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
845
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
846
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
847
848
849
850
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
851
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
852
853
854

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
855
        basic_type = find_basic_type(type_ref)
856
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
857
            return warnings
858
        elif basic_type.kind.endswith('StringType'):
859
860
861
            try:
                if int(basic_type.Min) <= len(
                        primary.value[1:-1]) <= int(basic_type.Max):
Maxime Perrotin's avatar
Maxime Perrotin committed
862
                    return warnings
863
864
865
866
867
868
869
870
871
                else:
                    raise TypeError('Invalid string literal'
                                    ' - check that length is'
                                    'within the bound limits {Min}..{Max}'
                                    .format(Min=str(basic_type.Min),
                                            Max=str(basic_type.Max)))
            except ValueError:
                # No size constraint (or MIN/MAX)
                LOG.debug('String literal size constraint discarded')
Maxime Perrotin's avatar
Maxime Perrotin committed
872
                return warnings
873
874
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
875
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
876
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
877
878
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
Maxime Perrotin's avatar
Maxime Perrotin committed
879
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
880
881
882
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
883
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
884
    return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
885

Maxime Perrotin's avatar
Maxime Perrotin committed
886

Maxime Perrotin's avatar
Maxime Perrotin committed
887
def compare_types(type_a, type_b):   # type -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
888
889
890
891
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
892
    warnings = []
893
894
895
896
897
    mismatch = ''
    if type_a.kind == 'ReferenceType' and type_b.kind == 'ReferenceType':
        if type_a.ReferencedTypeName != type_b.ReferencedTypeName:
            mismatch = '"{}" is not "{}"'.format(type_a.ReferencedTypeName,
                                                 type_b.ReferencedTypeName)
Maxime Perrotin's avatar
Maxime Perrotin committed
898
899
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
900

Maxime Perrotin's avatar
Maxime Perrotin committed
901
    if type_a == type_b:
Maxime Perrotin's avatar
Maxime Perrotin committed
902
        return warnings
903
904
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
905
        return warnings
906
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
907
        return warnings
908
909
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
910
        return warnings
911
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
912
        return warnings
913

Maxime Perrotin's avatar
Maxime Perrotin committed
914
    # Check if both types have basic compatibility
915
916

    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
917
        if type_a.kind == 'SequenceOfType':
Maxime Perrotin's avatar
Maxime Perrotin committed
918
919
            if mismatch:
                raise TypeError(mismatch)
920
921
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
Maxime Perrotin's avatar
Maxime Perrotin committed
922
923
                    warnings.extend(compare_types(type_a.type, type_b.type))
                    return warnings
924
925
926
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
927
928
            elif(float(type_b.Min) >= float(type_a.Min)
                 and float(type_b.Max) <= float(type_a.Max)):
Maxime Perrotin's avatar
Maxime Perrotin committed
929
930
                warnings.extend(compare_types(type_a.type, type_b.type))
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
931
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
932
933
934
                warnings.extend(compare_types(type_a.type, type_b.type))
                warnings.append('Size constraints mismatch - risk of overflow')
                return warnings
935
        # TODO: Check that OctetString types have compatible range
936
937
        elif type_a.kind == 'SequenceType' and mismatch:
            raise TypeError(mismatch)
Maxime Perrotin's avatar
Maxime Perrotin committed
938
939
940
941
942
943
944
        elif type_a.kind == 'IntegerType' and mismatch:
            # Detect Signed/Unsigned type mismatch
            min_a, min_b = float(type_a.Min), float(type_b.Min)
            if (min_a >= 0) != (min_b >= 0):
                raise TypeError(mismatch + "(signed vs unsigned type)")
            else:
                warnings.append(mismatch)
945
        elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
946
947
948
            warnings.append(mismatch)
        #print traceback.print_stack()
        return warnings
949
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
950
        return warnings
951
    elif is_integer(type_a) and is_integer(type_b):
952
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
953
954
            warnings.append(mismatch)
        return warnings
955
    elif is_real(type_a) and is_real(type_b):
956
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
957
958
            warnings.append(mismatch)
        return warnings
959
960
961
962
963
    else:
        raise TypeError('Incompatible types {} and {}'.format(
            type_name(type_a),
            type_name(type_b)
        ))
Maxime Perrotin's avatar
Maxime Perrotin committed
964

dbarbera's avatar
dbarbera committed
965
def find_variable_type(var, context):
Maxime Perrotin's avatar
Maxime Perrotin committed
966
    ''' Look for a variable name in the context and return its type '''
dbarbera's avatar
dbarbera committed
967

Maxime Perrotin's avatar
Maxime Perrotin committed
968
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
969
970
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
dbarbera's avatar
dbarbera committed
971

Maxime Perrotin's avatar
Maxime Perrotin committed
972
973
974
975
976
977
978
979
    # First check locally, i.e. in FPAR
    try:
        for variable in context.fpar:
            if variable['name'].lower() == var.lower():
                return variable['type']
    except AttributeError:
        # No FPAR section
        pass
980

Maxime Perrotin's avatar
Maxime Perrotin committed
981
982
983
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
984
985
            return vartype

Maxime Perrotin's avatar
Maxime Perrotin committed
986
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
987
        if var.lower() == timer.lower():
988
            return TIMER
Maxime Perrotin's avatar
Maxime Perrotin committed
989

dbarbera's avatar
dbarbera committed
990
991
992
993
994
    # check if is a ASN.1 constant
    for varname, vartype in DV.variables.viewitems():
        if var.lower() == varname.lower().replace('-', '_'):
            return vartype.type

Maxime Perrotin's avatar
Maxime Perrotin committed
995
996
997
    raise AttributeError('Variable {var} not defined'.format(var=var))


998
999
1000
def fix_enumerated_and_choice(expr_enum, context):
    ''' If left side of the expression is of Enumerated or Choice type,
        check if right side is a literal of that sort, and update type '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1001
    warnings = []
1002
    kind = find_basic_type(expr_enum.left.exprType).kind
1003
    if kind in ('EnumeratedType', 'StateEnumeratedType'):
1004
1005
1006
1007
        prim = ogAST.PrimEnumeratedValue(primary=expr_enum.right)
    elif kind == 'ChoiceEnumeratedType':
        prim = ogAST.PrimChoiceDeterminant(primary=expr_enum.right)
    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
1008
1009
1010
        warnings.extend(check_type_compatibility(prim,
                                                 expr_enum.left.exprType,
                                                 context))
1011
1012
1013
1014
        expr_enum.right = prim
        expr_enum.right.exprType = expr_enum.left.exprType
    except (UnboundLocalError, AttributeError, TypeError):
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
1015
    return warnings
1016
1017


Maxime Perrotin's avatar
Maxime Perrotin committed
1018
def fix_expression_types(expr, context): # type: -> [warnings]
dbarbera's avatar
dbarbera committed
1019
    ''' Check/ensure type consistency in binary expressions '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1020
    warnings = []
1021
    for _ in range(2):
1022
        # Check if a raw enumerated value is of a reference type
Maxime Perrotin's avatar
Maxime Perrotin committed
1023
        warnings.extend(fix_enumerated_and_choice(expr, context))
1024
1025
        expr.right, expr.left = expr.left, expr.right

1026
1027
1028
1029
1030
1031
1032
    for side in (expr.right, expr.left):
        if side.is_raw:
            raw_expr = side
        else:
            typed_expr = side
            ref_type = typed_expr.exprType

1033
    # If a side is a raw Sequence Of with unknown type, try to resolve it
1034
1035
    for side_a, side_b in permutations(('left', 'right')):
        value = getattr(expr, side_a)  # get expr.left then expr.right
1036
1037
        if not isinstance(value, ogAST.PrimSequenceOf):
            continue
1038
        other = getattr(expr, side_b)  # other side
1039
1040
1041
1042
1043
1044
1045
        basic = find_basic_type(value.exprType)
        if basic.kind == 'SequenceOfType' and basic.type == UNKNOWN_TYPE:
            asn_type = find_basic_type(other.exprType)
            if asn_type.kind == 'SequenceOfType':
                asn_type = asn_type.type
                for idx, elem in enumerate(value.value):
                    check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
1046
                    check_expr.left = ogAST.PrimVariable()
1047
1048
                    check_expr.left.exprType = asn_type
                    check_expr.right = elem
Maxime Perrotin's avatar
Maxime Perrotin committed
1049
                    warnings.extend(fix_expression_types(check_expr, context))
1050
1051
1052
1053
                    value.value[idx] = check_expr.right
            # the type of the raw PrimSequenceOf can be set now
            value.exprType.type = asn_type

1054
    if isinstance(expr, (ogAST.ExprIn, ogAST.ExprAppend)):
Maxime Perrotin's avatar
Maxime Perrotin committed
1055
        return warnings
1056

1057
    if not expr.right.is_raw and not expr.left.is_raw:
1058
1059
1060
        unknown = [uk_expr for uk_expr in expr.right, expr.left
                   if uk_expr.exprType == UNKNOWN_TYPE]
        if unknown:
1061
            #print traceback.print_stack()
1062
1063
1064
            raise TypeError('Cannot resolve type of "{}"'
                            .format(unknown[0].inputString))

1065
    # In Sequence, Choice and SEQUENCE OF expressions,
1066
1067
1068
    # we must fix missing inner types
    # (due to similarities, the following should be refactored FIXME)
    if isinstance(expr.right, ogAST.PrimSequence):
Maxime Perrotin's avatar
Maxime Perrotin committed
1069
        #print "Left:", type_name(expr.left.exprType), "Right:", expr.right.inputString
1070
1071
1072
1073
1074
        # left side must have a known type
        asn_type = find_basic_type(expr.left.exprType)
        if asn_type.kind != 'SequenceType':
            raise TypeError('left side must be a SEQUENCE type')
        for field, fd_expr in expr.right.value.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
1075
#            if fd_expr.exprType == UNKNOWN_TYPE:
1076
                try:
1077
1078
1079
1080
                    for spelling in asn_type.Children:
                        if field.lower().replace('_', '-') == spelling.lower():
                            break
                    expected_type = asn_type.Children[spelling].type
1081
1082
1083
                except AttributeError:
                    raise TypeError('Field not found: ' + field)
                check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
1084
                check_expr.left = ogAST.PrimVariable()
1085
1086
                check_expr.left.exprType = expected_type
                check_expr.right = fd_expr
Maxime Perrotin's avatar
Maxime Perrotin committed
1087
                warnings.extend(fix_expression_types(check_expr, context))
1088
1089
1090
1091
1092
1093
1094
1095
                # Id of fd_expr may have changed (enumerated, choice)
                expr.right.value[field] = check_expr.right
    elif isinstance(expr.right, ogAST.PrimChoiceItem):
        asn_type = find_basic_type(expr.left.exprType)
        field = expr.right.value['choice'].replace('_', '-')
        if asn_type.kind != 'ChoiceType' \
                or field.lower() not in [key.lower()
                                  for key in asn_type.Children.viewkeys()]:
1096
            raise TypeError('Field is not valid in CHOICE:' + field)
1097
1098
1099
1100
1101
1102
1103
1104
        key, = [key for key in asn_type.Children.viewkeys()
                if key.lower() == field.lower()]
        if expr.right.value['value'].exprType == UNKNOWN_TYPE:
            try:
                expected_type = asn_type.Children.get(key).type
            except AttributeError:
                raise TypeError('Field not found in CHOICE: ' + field)
            check_expr = ogAST.ExprAssign()