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

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

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

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

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

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

    Designed and implemented by Maxime Perrotin

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

__author__ = 'Maxime Perrotin'

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

import sdl92Lexer as lexer
from sdl92Parser import sdl92Parser

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

LOG = logging.getLogger(__name__)

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

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

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

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

# ASN.1 types used to support the signature of special operators
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
109

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

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


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


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


179
def substring_range(substring):
Maxime Perrotin's avatar
Maxime Perrotin committed
180
    # type: (ogAST.PrimSubstring) -> Tuple[str, str]
181
182
183
184
185
186
187
    ''' 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
188
189
190
191
192
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
193
def is_integer(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
194
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
195
196
197
198
199
200
201
    ''' Return true if a type is an Integer Type '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type'
    )


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


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


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


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


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


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


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

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


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


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


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


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


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


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

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


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

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

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

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

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

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

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

582
583
584
    # (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
585
        # The implementation of abs in *all* programming languages returns
Maxime Perrotin's avatar
Maxime Perrotin committed
586
587
        # 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
588
589
        # 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
590
591
592
593
594
        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))
#       })
595
596
597
598
599
600
601

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

608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
    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':
627
        return type('Length', (INT32,), {
628
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
            '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
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
    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)))
        })

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

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

685
686
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
687

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


Maxime Perrotin's avatar
Maxime Perrotin committed
704
705
def fix_append_expression_type(expr, expected_type):
    ''' In an Append expression, all components must be of the same type,
706
        which is the type expected by the user of the append, for example
Maxime Perrotin's avatar
Maxime Perrotin committed
707
708
709
710
711
712
713
        the left part of an assign expression.
        We must recursively fix the Append type, in case we have a//b//c
        that is handled as (a//b)//c
        Inputs:
           expr: the append expression (possibly recursive)
           expected_type : the type to assign to the expression
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
714
    #print "[DEBUG] Fix append expression: ", expr.inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
715
716
717
718
    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)
719
720
721
            if each.exprType == UNKNOWN_TYPE:
                # eg. if the side is a PrimConditional (ternary)
                each.exprType = set_type
Maxime Perrotin's avatar
Maxime Perrotin committed
722
723
724
725
            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
726
    #print expr.exprType
Maxime Perrotin's avatar
Maxime Perrotin committed
727
728


Maxime Perrotin's avatar
Maxime Perrotin committed
729
def check_type_compatibility(primary, type_ref, context):  # type: -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
730
731
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
732
        is compatible with a given type (type_ref is an ASN1Scc type)
733
        Possibly returns a list of warnings; can raises TypeError
Maxime Perrotin's avatar
Maxime Perrotin committed
734
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
735
    warnings = []    # function returns a list of warnings
736
737
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
738
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
739
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
740

741
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
742
743

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

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

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

Maxime Perrotin's avatar
Maxime Perrotin committed
783
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
784
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
785
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
786

787
    elif isinstance(primary, ogAST.ExprNeg):
Maxime Perrotin's avatar
Maxime Perrotin committed
788
789
790
        warnings.extend(check_type_compatibility(primary.expr,
                                                 type_ref,
                                                 context))
791

dbarbera's avatar
dbarbera committed
792
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
793
        return warnings
794

795
    elif isinstance(primary, ogAST.PrimNull) and is_null(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
796
        return warnings
797

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

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

Maxime Perrotin's avatar
Maxime Perrotin committed
947

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

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

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

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

Maxime Perrotin's avatar
Maxime Perrotin committed
1030
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
1031
1032
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
dbarbera's avatar
dbarbera committed
1033

Maxime Perrotin's avatar
Maxime Perrotin committed
1034
1035
1036
1037
1038
1039
1040
1041
    # 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
1042

Maxime Perrotin's avatar
Maxime Perrotin committed
1043
1044
1045
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
1046
1047
            return vartype

Maxime Perrotin's avatar
Maxime Perrotin committed
1048
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
1049
        if var.lower() == timer.lower():
1050
            return TIMER
Maxime Perrotin's avatar
Maxime Perrotin committed
1051

dbarbera's avatar
dbarbera committed
1052
1053
1054
1055
1056
    # 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
1057
1058
1059
    raise AttributeError('Variable {var} not defined'.format(var=var))


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


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

1088
1089
1090
1091
1092
1093
1094
    for side in (expr.right, expr.left):
        if side.is_raw:
            raw_expr = side
        else:
            typed_expr = side
            ref_type = typed_expr.exprType

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