ogParser.py 203 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
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
110

111
SPECIAL_OPERATORS = {
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
    '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'},
                    {'type': INTEGER,    'direction': 'in'}
                   ],
    'present'    : [{'type': CHOICE,     'direction': 'in'}],
    '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'}],
136
}
Maxime Perrotin's avatar
Maxime Perrotin committed
137
138
139
140

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


# 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', {})


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


180
def substring_range(substring):
Maxime Perrotin's avatar
Maxime Perrotin committed
181
    # type: (ogAST.PrimSubstring) -> Tuple[str, str]
182
183
184
185
186
187
188
    ''' 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
189
190
191
192
193
def is_number(basic_ty):
    ''' Return true if basic type is a raw number (i.e. not a variable) '''
    return basic_ty.__name__ in ('Universal_Integer', 'PrReal')


dbarbera's avatar
dbarbera committed
194
def is_integer(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
195
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
196
197
198
199
200
201
202
    ''' Return true if a type is an Integer Type '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type'
    )


203
def is_real(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
204
    # type: (Any) -> bool
205
206
207
208
    ''' Return true if a type is a Real Type '''
    return find_basic_type(ty).kind == 'RealType'


209
def is_numeric(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
210
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
211
    ''' Return true if a type is a Numeric Type '''
212
213
214
215
216
217
218
219
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type',
        'Numerical',
        'RealType'
    )


220
def is_boolean(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
221
    # type: (Any) -> bool
222
223
224
225
    ''' Return true if a type is a Boolean Type '''
    return find_basic_type(ty).kind == 'BooleanType'


226
def is_null(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
227
    # type: (Any) -> bool
228
229
230
231
    ''' Return true if a type is a NULL Type '''
    return find_basic_type(ty).kind == 'NullType'


dbarbera's avatar
dbarbera committed
232
def is_string(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
233
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
234
235
236
    ''' Return true if a type is a String Type '''
    return find_basic_type(ty).kind in (
        'StandardStringType',
237
238
        'OctetStringType',
        'StringType'
dbarbera's avatar
dbarbera committed
239
240
241
    )


242
def is_sequenceof(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
243
    # type: (Any) -> bool
244
245
246
247
248
    ''' 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
249
    # type: (Any) -> bool
250
251
252
253
254
    ''' 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
255
    # type: (Any) -> bool
256
257
258
259
260
    ''' 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
261
    # type: (Any) -> bool
262
263
264
265
266
    ''' 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
267
    # type: (Any) -> bool
268
269
270
271
272
    ''' 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
273
    # type: (Any) -> bool
274
275
276
277
    ''' Return true if a type is a Timer Type '''
    return find_basic_type(ty).kind == 'TimerType'


Maxime Perrotin's avatar
Maxime Perrotin committed
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
324
325
326
327
328
329
330
331
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:
332
333
334
            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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
                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
359
360
361
        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
362
    '''
363
    all_signals, async_signals, errors = [], [], set()
364
    system = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
365
366
367
368
369
370
371
372
373
374
375
376

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


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
428
def error(root, msg):
Maxime Perrotin's avatar
Maxime Perrotin committed
429
    # type: (Any, str) -> str
dbarbera's avatar
dbarbera committed
430
    ''' Return an error message '''
431
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
432
433
434


def warning(root, msg):
Maxime Perrotin's avatar
Maxime Perrotin committed
435
    # type: (Any, str) -> str
dbarbera's avatar
dbarbera committed
436
    ''' Return a warning message '''
437
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
438
439


dbarbera's avatar
dbarbera committed
440
def tmp():
Maxime Perrotin's avatar
Maxime Perrotin committed
441
    # type : () -> int
dbarbera's avatar
dbarbera committed
442
443
444
445
446
447
448
    ''' Return a temporary variable name '''
    global TMPVAR
    varname = TMPVAR
    TMPVAR += 1
    return varname


Maxime Perrotin's avatar
Maxime Perrotin committed
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
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)


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


480
481
482
483
484
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
485

486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
    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)


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

511
    # Special case for write/writeln functions
512
    if name.lower() in ('write', 'writeln'):
513
        def check_one_param(p, name):
514
            p_ty = p.exprType
515
516
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty) or \
                    is_enumerated(p_ty):
517
                return
518
519
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
        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)
                # check that both "then" and "else" are both of a similar type
                # (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
541
        return UNKNOWN_TYPE
Maxime Perrotin's avatar
Maxime Perrotin committed
542
543
544

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

    # (2) Check that the number of given parameters matches the signature
548
549
550
    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
551

552
553
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
554
        warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
555
556
        expr               = ogAST.ExprAssign()
        expr.left          = ogAST.PrimVariable()
557
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
558
        expr.right         = param
559
560

        try:
561
562
563
            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
564
            warnings.extend(fix_expression_types(expr, context))
565
            params[idx] = expr.right
566
        except TypeError as err:
567
568
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
569
570
571
            raise TypeError('In call to {}: Type of parameter {} is incorrect'
                            ' ({}) - {}'
                            .format(name, idx+1, received, str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
572
        if (warnings):
573
574
575
576
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise Warning('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
577
578

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

583
584
585
    # (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
586
        # The implementation of abs in *all* programming languages returns
Maxime Perrotin's avatar
Maxime Perrotin committed
587
588
        # 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
589
590
        # this is an issue in an assign statement, if the recipient is
        # unsigned .. A cast is necessary if the parameter of abs is negative
Maxime Perrotin's avatar
Maxime Perrotin committed
591
592
593
594
595
        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))
#       })
596
597
598
599
600
601
602

    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
603
604
605
606
607
608
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
    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':
628
        return type('Length', (INT32,), {
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
            '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
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
    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)))
        })

673
674
675
676
677
678
    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)))
        })

679
680
681
682
683
684
685
    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

686
687
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
688

Maxime Perrotin's avatar
Maxime Perrotin committed
689
690
691
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
692
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
693
694
695
696
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
697
            raise Warning('Expression evaluation in range [{}..{}], '
Maxime Perrotin's avatar
Maxime Perrotin committed
698
                          'could be outside expected range [{}..{}]'
Maxime Perrotin's avatar
Maxime Perrotin committed
699
700
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
701
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
702
703
704
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
705
706
def fix_append_expression_type(expr, expected_type):
    ''' In an Append expression, all components must be of the same type,
707
        which is the type expected by the user of the append, for example
Maxime Perrotin's avatar
Maxime Perrotin committed
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
        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
    '''
    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)
            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
725
def check_type_compatibility(primary, type_ref, context):  # type: -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
726
727
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
728
        is compatible with a given type (type_ref is an ASN1Scc type)
729
        Possibly returns a list of warnings; can raises TypeError
Maxime Perrotin's avatar
Maxime Perrotin committed
730
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
731
    warnings = []    # function returns a list of warnings
732
733
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
734
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
735
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
736

737
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
738
739

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
740
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
741
742
743
        # 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
744
745
746
747
        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
748
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
749
        else:
750
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
751
                   '" not in this enumeration: ' +
752
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
753
            raise TypeError(err)
754
755
756
757
758
759
    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
760
761
762
763
                warnings.extend(check_type_compatibility(expr,
                                                         type_ref,
                                                         context))
        return warnings
764

765
    elif isinstance(primary, (ogAST.PrimVariable, ogAST.PrimSelector)):
Maxime Perrotin's avatar
Maxime Perrotin committed
766
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
767
            warnings.extend(compare_types(primary.exprType, type_ref))
Maxime Perrotin's avatar
Maxime Perrotin committed
768
769
770
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
771
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
772
                                    err=str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
773
        return warnings
774

Maxime Perrotin's avatar
Maxime Perrotin committed
775
    elif isinstance(primary, (ogAST.PrimInteger, ogAST.ExprMod)) \
dbarbera's avatar
dbarbera committed
776
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
777
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
778

Maxime Perrotin's avatar
Maxime Perrotin committed
779
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
780
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
781
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
782

783
    elif isinstance(primary, ogAST.ExprNeg):
Maxime Perrotin's avatar
Maxime Perrotin committed
784
785
786
        warnings.extend(check_type_compatibility(primary.expr,
                                                 type_ref,
                                                 context))
787

dbarbera's avatar
dbarbera committed
788
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
789
        return warnings
790

791
    elif isinstance(primary, ogAST.PrimNull) and is_null(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
792
        return warnings
793

794
795
796
797
    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
798
                return warnings
799
800
801
802
803
804
            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
805
        else:
806
            raise TypeError('Not a type compatible with empty string syntax')
Maxime Perrotin's avatar
Maxime Perrotin committed
807
    elif isinstance(primary, ogAST.PrimSequenceOf) \
808
            and basic_type.kind == 'SequenceOfType':
809
810
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
811
                len(primary.value) > int(basic_type.Max)):
812
            #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
813
            raise TypeError(str(len(primary.value)) +
814
815
                      ' element(s) in SEQUENCE OF, while constraint is [' +
                      str(basic_type.Min) + ' .. ' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
816
        for elem in primary.value:
Maxime Perrotin's avatar
Maxime Perrotin committed
817
818
819
            warnings.extend(check_type_compatibility(elem,
                                                     basic_type.type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
820
821
        if not hasattr(primary, 'expected_type') \
               and type_ref.__name__ not in ('Apnd', 'SubStr'):
822
            primary.expected_type = type_ref
Maxime Perrotin's avatar
Maxime Perrotin committed
823
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
824
    elif isinstance(primary, ogAST.PrimSequence) \
825
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
826
        user_nb_elem = len(primary.value.keys())
827
        type_nb_elem = len(basic_type.Children.keys())
828
829
830
831
832
833
834
835
836
837
838
839
        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)))
840
            elif ufield.lower() not in user_fields:
841
842
843
844
                # Optional field not set - OK
                continue
            else:
                # If the user field is a raw value
845
846
847
848
849
850
                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
851
852
853
854
                    warnings.extend(check_type_compatibility
                                         (primary.value[casefield],
                                          fd_data.type,
                                          context))
Maxime Perrotin's avatar
Maxime Perrotin committed
855
                else:
856
857
                    # Compare the types for semantic equivalence
                    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
858
859
860
                        warnings.extend(compare_types
                                       (primary.value[casefield].exprType,
                                        fd_data.type))
861
                    except TypeError as err:
862
                        raise TypeError('Field "' + ufield + '" not of type ' +
863
864
                                    type_name(fd_data.type) +
                                    ' - ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
865
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
866
    elif isinstance(primary, ogAST.PrimChoiceItem) \
867
868
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
869
870
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
871
872
873
874
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
875
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
876
        # compare primary.value['value']
877
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
878
879
880
881
        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
882
883
884
            warnings.extend(check_type_compatibility(value,
                                                     choice_field_type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
885
886
887
        # Compare the types for semantic equivalence:
        else:
            try:
Maxime Perrotin's avatar
Maxime Perrotin committed
888
889
                warnings.extend(compare_types(value.exprType,
                                              choice_field_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
890
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
891
892
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
893
894
895
896
                            .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
897
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
898
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
899
900
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
901
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
902
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
903
904
905
906
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
907
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
908
909
910

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
911
        basic_type = find_basic_type(type_ref)
912
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
913
            return warnings
914
        elif basic_type.kind.endswith('StringType'):
915
916
917
            try:
                if int(basic_type.Min) <= len(
                        primary.value[1:-1]) <= int(basic_type.Max):
Maxime Perrotin's avatar
Maxime Perrotin committed
918
                    return warnings
919
                else:
920
                    #print traceback.print_stack()
921
                    raise TypeError('Invalid string literal'
Maxime Perrotin's avatar
Maxime Perrotin committed
922
                                    ' - check that length is '
923
924
925
926
927
928
                                    '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
929
                return warnings
930
931
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
932
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
933
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
934
935
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
Maxime Perrotin's avatar
Maxime Perrotin committed
936
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
937
938
939
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
940
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
941
    return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
942

Maxime Perrotin's avatar
Maxime Perrotin committed
943

Maxime Perrotin's avatar
Maxime Perrotin committed
944
def compare_types(type_a, type_b):   # type -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
945
946
947
948
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
949
    warnings = []
950
951
952
953
954
    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
955
956
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
957

Maxime Perrotin's avatar
Maxime Perrotin committed
958
    if type_a == type_b:
Maxime Perrotin's avatar
Maxime Perrotin committed
959
        return warnings
960
961
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
962
        return warnings
963
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
964
        return warnings
965
966
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
967
        return warnings
968
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
969
        return warnings
970

Maxime Perrotin's avatar
Maxime Perrotin committed
971
    # Check if both types have basic compatibility
972
    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
973
        if type_a.kind == 'SequenceOfType':
Maxime Perrotin's avatar
Maxime Perrotin committed
974
975
            if mismatch:
                raise TypeError(mismatch)
976
977
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
Maxime Perrotin's avatar
Maxime Perrotin committed
978
979
                    warnings.extend(compare_types(type_a.type, type_b.type))
                    return warnings
980
981
982
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
983
984
            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
985
986
                warnings.extend(compare_types(type_a.type, type_b.type))
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
987
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
988
989
990
                warnings.extend(compare_types(type_a.type, type_b.type))
                warnings.append('Size constraints mismatch - risk of overflow')
                return warnings
991
        # TODO: Check that OctetString types have compatible range
992
993
        elif type_a.kind == 'SequenceType' and mismatch:
            raise TypeError(mismatch)
994
        elif type_a.kind == 'IntegerType':
Maxime Perrotin's avatar
Maxime Perrotin committed
995
996
            # Detect Signed/Unsigned type mismatch
            min_a, min_b = float(type_a.Min), float(type_b.Min)
Maxime Perrotin's avatar
Maxime Perrotin committed
997
998
            if (min_a >= 0) != (min_b >= 0) \
                    and not (is_number(type_a) or is_number(type_b)):
999
1000
1001
                raise TypeError("Signed vs Unsigned type mismatch " +
                        mismatch)
            elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1002
                warnings.append(mismatch)
1003
        elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1004
1005
1006
            warnings.append(mismatch)
        #print traceback.print_stack()
        return warnings
1007
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1008
        return warnings
1009
    elif is_integer(type_a) and is_integer(type_b):
1010
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1011
1012
            warnings.append(mismatch)
        return warnings
1013
    elif is_real(type_a) and is_real(type_b):
1014
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1015
1016
            warnings.append(mismatch)
        return warnings
1017
1018
1019
1020
1021
    else:
        raise TypeError('Incompatible types {} and {}'.format(
            type_name(type_a),
            type_name(type_b)
        ))
Maxime Perrotin's avatar
Maxime Perrotin committed
1022

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

Maxime Perrotin's avatar
Maxime Perrotin committed
1026
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
1027
1028
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
dbarbera's avatar
dbarbera committed
1029

Maxime Perrotin's avatar
Maxime Perrotin committed
1030
1031
1032
1033
1034
1035
1036
1037
    # 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
1038

Maxime Perrotin's avatar
Maxime Perrotin committed
1039
1040
1041
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
1042
1043
            return vartype

Maxime Perrotin's avatar
Maxime Perrotin committed
1044
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
1045
        if var.lower() == timer.lower():
1046
            return TIMER
Maxime Perrotin's avatar
Maxime Perrotin committed
1047

dbarbera's avatar
dbarbera committed
1048
1049
1050
1051
1052
    # 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
1053
1054
1055
    raise AttributeError('Variable {var} not defined'.format(var=var))


1056
1057
1058
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
1059
    warnings = []
1060
    kind = find_basic_type(expr_enum.left.exprType).kind
1061
    if kind in ('EnumeratedType', 'StateEnumeratedType'):
1062
1063
1064
1065
        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
1066
1067
1068
        warnings.extend(check_type_compatibility(prim,
                                                 expr_enum.left.exprType,
                                                 context))
1069
1070
1071
1072
        expr_enum.right = prim
        expr_enum.right.exprType = expr_enum.left.exprType
    except (UnboundLocalError, AttributeError, TypeError):
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
1073
    return warnings
1074
1075


Maxime Perrotin's avatar
Maxime Perrotin committed
1076
def fix_expression_types(expr, context): # type: -> [warnings]
dbarbera's avatar
dbarbera committed
1077
    ''' Check/ensure type consistency in binary expressions '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1078
    warnings = []
1079
    for _ in range(2):
1080
        # Check if a raw enumerated value is of a reference type
Maxime Perrotin's avatar
Maxime Perrotin committed
1081
        warnings.extend(fix_enumerated_and_choice(expr, context))
1082
1083
        expr.right, expr.left = expr.left, expr.right

1084
1085
1086
1087
1088
1089
1090
    for side in (expr.right, expr.left):
        if side.is_raw:
            raw_expr = side
        else:
            typed_expr = side
            ref_type = typed_expr.exprType

1091
    # If a side is a raw Sequence Of with unknown type, try to resolve it
1092
1093
    for side_a, side_b in permutations(('left', 'right')):
        value = getattr(expr, side_a)  # get expr.left then expr.right
1094
1095
        if not isinstance(value, ogAST.PrimSequenceOf):
            continue
1096
        other = getattr(expr, side_b)  # other side
1097
1098
1099
1100
1101
1102
1103
        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
1104
                    check_expr.left = ogAST.PrimVariable()
1105
1106
                    check_expr.left.exprType = asn_type
                    check_expr.right = elem
Maxime Perrotin's avatar
Maxime Perrotin committed
1107
                    warnings.extend(fix_expression_types(check_expr, context))
1108
1109
1110
1111
                    value.value[idx] = check_expr.right
            # the type of the raw PrimSequenceOf can be set now
            value.exprType.type = asn_type

1112
    if isinstance(expr, (ogAST.ExprIn, ogAST.ExprAppend)):
Maxime Perrotin's avatar
Maxime Perrotin committed
1113
        return warnings
1114

1115
    if not expr.right.is_raw and not expr.left.is_raw:
1116
1117
1118
        unknown = [uk_expr for uk_expr in expr.right, expr.left
                   if uk_expr.exprType == UNKNOWN_TYPE]
        if unknown:
1119
            #print traceback.print_stack()
1120
1121
1122
            raise TypeError('Cannot resolve type of "{}"'
                            .format(unknown[0].inputString))

1123
    # In Sequence, Choice and SEQUENCE OF expressions,
1124
1125
1126
    # 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
1127
        #print "Left:", type_name(expr.left.exprType), "Right:", expr.right.inputString