ogParser.py 208 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
                   ],
    'present'    : [{'type': CHOICE,     'direction': 'in'}],
124
    'exist'      : [{'type': ANY_TYPE,   'direction': 'in'}],
125
126
127
128
129
130
131
132
133
134
135
    '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
        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)
526
                # check that both "then" and "else" are of a similar type
527
528
529
530
531
532
533
534
535
536
537
538
539
540
                # (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
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
    # Special case for "exist" function
    elif name == 'exist':
        # "exist" shall return true if an optional SEQUENCE field is present
        # We have to check that the parameter is actually an optional field
        # So we check first that there is only one param
        # then that this is a PrimSelector (at least "a.b")
        # Then we analyse from the variable to the last field if that is
        # actually an optional field, using the ASN.1 data model
        if len(params) != 1:
            raise TypeError ('"exist" operator takes only one parameter')
        param, = params
        if not isinstance(param, ogAST.PrimSelector):
            raise TypeError ('"exist" operator only works on optional fields')
        left = param.value[0] # Can be a variable or another PrimSelector
        field_list = [param.value[1]] # string of the field name
        while isinstance(left, ogAST.PrimSelector):
            field_list.append(left.value[1])
            left = left.value[0]
        sort = find_basic_type(left.exprType)  # must have Children
        if sort.kind == 'UnknownType':
            raise TypeError('Variable not found in call to "exist" operator')
        # At this point we know that the expression is correct, so we will
        # not miss any child in the dataview. We can follow the children
        # in the ASN.1 model until we reach the last one, which shall be
        # optional
        while field_list:
            child_name = field_list.pop().replace('_', '-').lower()
            for child in sort.Children.viewkeys():
                if child.lower() == child_name:
                    break
            optional = sort.Children[child].Optional
            sort = sort.Children[child].type
            if sort.kind == 'ReferenceType':
                sort = find_basic_type (sort)
        # At this point we should have found the last type
        if optional != "True":
            raise TypeError('Field is not optional in call to "exist"')
        return type('Exist', (object,), {
            'kind': 'BooleanType'
        })

Maxime Perrotin's avatar
Maxime Perrotin committed
584
585
    # (1) Find the signature of the function
    # signature will hold the list of parameters for the function
586
    sign = signature(name, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
587
588

    # (2) Check that the number of given parameters matches the signature
589
590
591
    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
592

593
594
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
595
        warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
596
597
        expr               = ogAST.ExprAssign()
        expr.left          = ogAST.PrimVariable()
598
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
599
        expr.right         = param
600
601

        try:
602
603
604
            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
605
            warnings.extend(fix_expression_types(expr, context))
606
            params[idx] = expr.right
607
        except TypeError as err:
608
609
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
610
611
612
            raise TypeError('In call to {}: Type of parameter {} is incorrect'
                            ' ({}) - {}'
                            .format(name, idx+1, received, str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
613
        if (warnings):
614
615
616
617
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise Warning('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
618
619

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

624
625
626
    # (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
627
        # The implementation of abs in *all* programming languages returns
Maxime Perrotin's avatar
Maxime Perrotin committed
628
629
        # 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
630
631
        # 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
632
633
634
635
636
        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))
#       })
637
638
639
640
641
642
643

    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
644
645
646
647
648
649
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
    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':
669
        return type('Length', (INT32,), {
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
            '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
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
    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)))
        })

714
715
716
717
718
719
    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)))
        })

720
721
722
723
724
725
726
    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

727
728
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
729

Maxime Perrotin's avatar
Maxime Perrotin committed
730
731
732
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
733
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
734
735
736
737
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
738
            raise Warning('Expression evaluation in range [{}..{}], '
Maxime Perrotin's avatar
Maxime Perrotin committed
739
                          'could be outside expected range [{}..{}]'
Maxime Perrotin's avatar
Maxime Perrotin committed
740
741
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
742
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
743
744
745
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
746
747
def fix_append_expression_type(expr, expected_type):
    ''' In an Append expression, all components must be of the same type,
748
        which is the type expected by the user of the append, for example
Maxime Perrotin's avatar
Maxime Perrotin committed
749
750
751
752
753
754
755
        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
756
    #print "[DEBUG] Fix append expression: ", expr.inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
757
758
759
760
    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)
761
762
763
            if each.exprType == UNKNOWN_TYPE:
                # eg. if the side is a PrimConditional (ternary)
                each.exprType = set_type
Maxime Perrotin's avatar
Maxime Perrotin committed
764
765
766
767
            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
768
    #print expr.exprType
Maxime Perrotin's avatar
Maxime Perrotin committed
769
770


Maxime Perrotin's avatar
Maxime Perrotin committed
771
def check_type_compatibility(primary, type_ref, context):  # type: -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
772
773
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
774
        is compatible with a given type (type_ref is an ASN1Scc type)
775
        Possibly returns a list of warnings; can raises TypeError
Maxime Perrotin's avatar
Maxime Perrotin committed
776
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
777
    warnings = []    # function returns a list of warnings
778
779
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
780
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
781
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
782

783
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
784
785

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
786
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
787
788
789
        # 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
790
791
792
793
        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
794
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
795
        else:
796
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
797
                   '" not in this enumeration: ' +
798
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
799
            raise TypeError(err)
800
801
802
803
804
805
    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
806
807
808
809
                warnings.extend(check_type_compatibility(expr,
                                                         type_ref,
                                                         context))
        return warnings
810

811
    elif isinstance(primary, (ogAST.PrimVariable, ogAST.PrimSelector)):
Maxime Perrotin's avatar
Maxime Perrotin committed
812
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
813
            warnings.extend(compare_types(primary.exprType, type_ref))
Maxime Perrotin's avatar
Maxime Perrotin committed
814
815
816
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
817
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
818
                                    err=str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
819
        return warnings
820

Maxime Perrotin's avatar
Maxime Perrotin committed
821
    elif isinstance(primary, (ogAST.PrimInteger, ogAST.ExprMod)) \
dbarbera's avatar
dbarbera committed
822
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
823
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
824

Maxime Perrotin's avatar
Maxime Perrotin committed
825
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
826
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
827
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
828

829
    elif isinstance(primary, ogAST.ExprNeg):
Maxime Perrotin's avatar
Maxime Perrotin committed
830
831
832
        warnings.extend(check_type_compatibility(primary.expr,
                                                 type_ref,
                                                 context))
833

dbarbera's avatar
dbarbera committed
834
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
835
        return warnings
836

837
    elif isinstance(primary, ogAST.PrimNull) and is_null(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
838
        return warnings
839

840
841
842
843
    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
844
                return warnings
845
846
847
848
849
850
            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
851
        else:
852
            raise TypeError('Not a type compatible with empty string syntax')
Maxime Perrotin's avatar
Maxime Perrotin committed
853
    elif isinstance(primary, ogAST.PrimSequenceOf) \
854
            and basic_type.kind == 'SequenceOfType':
855
856
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
857
                len(primary.value) > int(basic_type.Max)):
858
            #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
859
            raise TypeError(str(len(primary.value)) +
860
861
                      ' element(s) in SEQUENCE OF, while constraint is [' +
                      str(basic_type.Min) + ' .. ' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
862
        for elem in primary.value:
Maxime Perrotin's avatar
Maxime Perrotin committed
863
864
865
            warnings.extend(check_type_compatibility(elem,
                                                     basic_type.type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
866
867
        if not hasattr(primary, 'expected_type') \
               and type_ref.__name__ not in ('Apnd', 'SubStr'):
868
            primary.expected_type = type_ref
Maxime Perrotin's avatar
Maxime Perrotin committed
869
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
870
    elif isinstance(primary, ogAST.PrimSequence) \
871
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
872
        user_nb_elem = len(primary.value.keys())
873
        type_nb_elem = len(basic_type.Children.keys())
874
875
876
877
878
879
880
881
882
883
884
885
        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)))
886
            elif ufield.lower() not in user_fields:
887
888
889
890
                # Optional field not set - OK
                continue
            else:
                # If the user field is a raw value
891
892
893
894
895
896
                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
897
898
899
900
                    warnings.extend(check_type_compatibility
                                         (primary.value[casefield],
                                          fd_data.type,
                                          context))
Maxime Perrotin's avatar
Maxime Perrotin committed
901
                else:
902
903
                    # Compare the types for semantic equivalence
                    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
904
905
906
                        warnings.extend(compare_types
                                       (primary.value[casefield].exprType,
                                        fd_data.type))
907
                    except TypeError as err:
908
                        raise TypeError('Field "' + ufield + '" not of type ' +
909
910
                                    type_name(fd_data.type) +
                                    ' - ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
911
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
912
    elif isinstance(primary, ogAST.PrimChoiceItem) \
913
914
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
915
916
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
917
918
919
920
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
921
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
922
        # compare primary.value['value']
923
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
924
925
926
927
        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
928
929
930
            warnings.extend(check_type_compatibility(value,
                                                     choice_field_type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
931
932
933
        # Compare the types for semantic equivalence:
        else:
            try:
Maxime Perrotin's avatar
Maxime Perrotin committed
934
935
                warnings.extend(compare_types(value.exprType,
                                              choice_field_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
936
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
937
938
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
939
940
941
942
                            .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
943
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
944
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
945
946
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
947
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
948
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
949
950
951
952
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
953
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
954
955
956

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
957
        basic_type = find_basic_type(type_ref)
958
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
959
            return warnings
960
        elif basic_type.kind.endswith('StringType'):
961
962
963
            try:
                if int(basic_type.Min) <= len(
                        primary.value[1:-1]) <= int(basic_type.Max):
Maxime Perrotin's avatar
Maxime Perrotin committed
964
                    return warnings
965
                else:
966
                    #print traceback.print_stack()
967
                    raise TypeError('Invalid string literal'
Maxime Perrotin's avatar
Maxime Perrotin committed
968
                                    ' - check that length is '
969
970
971
972
973
974
                                    '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
975
                return warnings
976
977
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
978
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
979
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
980
981
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
Maxime Perrotin's avatar
Maxime Perrotin committed
982
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
983
984
985
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
986
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
987
    return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
988

Maxime Perrotin's avatar
Maxime Perrotin committed
989

Maxime Perrotin's avatar
Maxime Perrotin committed
990
def compare_types(type_a, type_b):   # type -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
991
992
993
994
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
995
    warnings = []
996
997
998
999
1000
    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
1001
1002
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
1003

Maxime Perrotin's avatar
Maxime Perrotin committed
1004
    if type_a == type_b:
Maxime Perrotin's avatar
Maxime Perrotin committed
1005
        return warnings
1006
1007
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1008
        return warnings
1009
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1010
        return warnings
1011
1012
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1013
        return warnings
1014
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1015
        return warnings
1016

Maxime Perrotin's avatar
Maxime Perrotin committed
1017
    # Check if both types have basic compatibility
1018
    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
1019
        if type_a.kind == 'SequenceOfType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1020
1021
            if mismatch:
                raise TypeError(mismatch)
1022
1023
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
Maxime Perrotin's avatar
Maxime Perrotin committed
1024
1025
                    warnings.extend(compare_types(type_a.type, type_b.type))
                    return warnings
1026
1027
1028
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
1029
1030
            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
1031
1032
                warnings.extend(compare_types(type_a.type, type_b.type))
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1033
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
1034
1035
1036
                warnings.extend(compare_types(type_a.type, type_b.type))
                warnings.append('Size constraints mismatch - risk of overflow')
                return warnings
1037
        # TODO: Check that OctetString types have compatible range
1038
1039
        elif type_a.kind == 'SequenceType' and mismatch:
            raise TypeError(mismatch)
1040
        elif type_a.kind == 'IntegerType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1041
1042
            # Detect Signed/Unsigned type mismatch
            min_a, min_b = float(type_a.Min), float(type_b.Min)
Maxime Perrotin's avatar
Maxime Perrotin committed
1043
1044
            if (min_a >= 0) != (min_b >= 0) \
                    and not (is_number(type_a) or is_number(type_b)):
1045
1046
1047
                raise TypeError("Signed vs Unsigned type mismatch " +
                        mismatch)
            elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1048
                warnings.append(mismatch)
1049
        elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1050
1051
1052
            warnings.append(mismatch)
        #print traceback.print_stack()
        return warnings
1053
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1054
        return warnings
1055
    elif is_integer(type_a) and is_integer(type_b):
1056
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1057
1058
            warnings.append(mismatch)
        return warnings
1059
    elif is_real(type_a) and is_real(type_b):
1060
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1061
1062
            warnings.append(mismatch)
        return warnings
1063
1064
1065
1066
1067
    else:
        raise TypeError('Incompatible types {} and {}'.format(
            type_name(type_a),
            type_name(type_b)
        ))
Maxime Perrotin's avatar
Maxime Perrotin committed
1068

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

Maxime Perrotin's avatar
Maxime Perrotin committed
1072
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
1073
1074
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
dbarbera's avatar
dbarbera committed
1075

Maxime Perrotin's avatar
Maxime Perrotin committed
1076
1077
1078
1079
1080
1081
1082
1083
    # 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
1084

Maxime Perrotin's avatar
Maxime Perrotin committed
1085
1086
1087
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
1088
1089
            return vartype

Maxime Perrotin's avatar
Maxime Perrotin committed
1090
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
1091
        if var.lower() == timer.lower():
1092
            return TIMER
Maxime Perrotin's avatar
Maxime Perrotin committed
1093

dbarbera's avatar
dbarbera committed
1094
1095
1096
1097
1098
    # 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
1099
1100
1101
    raise AttributeError('Variable {var} not defined'.format(var=var))


1102
1103
1104
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
1105
    warnings = []
1106
    kind = find_basic_type(expr_enum.left.exprType).kind
1107
    if kind in ('EnumeratedType', 'StateEnumeratedType'):
1108
1109
1110
1111
        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
1112
1113
1114
        warnings.extend(check_type_compatibility(prim,
                                                 expr_enum.left.exprType,
                                                 context))
1115
1116
1117
1118
        expr_enum.right = prim
        expr_enum.right.exprType = expr_enum.left.exprType
    except (UnboundLocalError, AttributeError, TypeError):
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
1119
    return warnings
1120
1121


Maxime Perrotin's avatar
Maxime Perrotin committed
1122
def fix_expression_types(expr, context): # type: -> [warnings]
dbarbera's avatar
dbarbera committed
1123
    ''' Check/ensure type consistency in binary expressions '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1124
    warnings = []
1125
    for _ in range(2):
1126
        # Check if a raw enumerated value is of a reference type
Maxime Perrotin's avatar
Maxime Perrotin committed
1127
        warnings.extend(fix_enumerated_and_choice(expr, context))
1128
1129
        expr.right, expr.left = expr.left, expr.right

1130
1131
1132
1133