ogParser.py 215 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-2019 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, create_choice_determinant_types
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
137
138
139
140
141
142
143
    'to_selector': [  #  to convert an enum to a choice discriminant
                    {'type': ENUMERATED, 'direction': 'in'},
                    {'type': ANY_TYPE,   'direction': 'in'}
                   ],
    'to_enum'    : [  #  to convert a choice discriminant to an enum
                    {'type': ENUMERATED, 'direction': 'in'},
                    {'type': ANY_TYPE,   'direction': 'in'}
                   ],
144
145
146
147
    'val'    : [  #  to convert a number to an enumerated type value
                    {'type': UNSIGNED,   'direction': 'in'},  # eg. 1
                    {'type': ANY_TYPE,   'direction': 'in'}   # eg. MyChoice
                   ],
148
149
150
151
152
    'choice_to_int' : [  #  to return the value of a numerical choice item
                    {'type': CHOICE,     'direction': 'in'},  # choice variable
                    {'type': NUMERICAL,  'direction': 'in'}   # default value
                   ],

153
}
Maxime Perrotin's avatar
Maxime Perrotin committed
154
155
156
157

# 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,), {})
158
                    for a, b in lexer.__dict__.viewitems() if type(b) == int}
Maxime Perrotin's avatar
Maxime Perrotin committed
159
160
161
162
163
164
165
166
167
168
169
170


# 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

171
172
173
174
175
176
177
178
179
180
181
# user may create SDL (non-asn1) types with the newtype keyword
# they are stored in a dedicated dictionary with the same structure
# as the ASN1SCC generated python AST
USER_DEFINED_TYPES = dict()

def types():
    ''' Return all ASN.1 and user defined types '''
    ret = getattr(DV, 'types', {}).copy()
    ret.update(USER_DEFINED_TYPES)
    return ret
#types = lambda: getattr(DV, 'types', {}) or USER_DEFINED_TYPES
Maxime Perrotin's avatar
Maxime Perrotin committed
182
183


184
def set_global_DV(asn1_filenames):
Maxime Perrotin's avatar
Maxime Perrotin committed
185
    # type: (List[str]) -> None
186
187
    ''' Call ASN.1 parser and set the global dataview AST entry (DV) '''
    global DV
188
189
190
191
    if '--toC' in sys.argv:
        rename_policy = ASN1.RenameOnlyConflicting
    else:
        rename_policy = ASN1.NoRename
192
193
194
    try:
        DV = parse_asn1(tuple(asn1_filenames),
                        ast_version=ASN1.UniqueEnumeratedNames,
195
                        rename_policy=rename_policy,
Maxime Perrotin's avatar
Maxime Perrotin committed
196
197
                        flags=[ASN1.AstOnly],
                        pretty_print=True)
198
199
200
        # Create new types corresponding to CHOICE determinants as enum
        choice_selectors = create_choice_determinant_types (DV)
        DV.types.update(choice_selectors)
201
202
203
204
205
206
207
208
209
    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)))


210
def substring_range(substring):
Maxime Perrotin's avatar
Maxime Perrotin committed
211
    # type: (ogAST.PrimSubstring) -> Tuple[str, str]
212
213
214
215
216
217
218
    ''' 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
219
220
221
222
223
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
224
def is_integer(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
225
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
226
227
228
229
230
231
232
    ''' Return true if a type is an Integer Type '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type'
    )


233
def is_real(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
234
    # type: (Any) -> bool
235
236
237
238
    ''' Return true if a type is a Real Type '''
    return find_basic_type(ty).kind == 'RealType'


239
def is_numeric(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
240
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
241
    ''' Return true if a type is a Numeric Type '''
242
243
244
245
246
247
248
249
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type',
        'Numerical',
        'RealType'
    )


250
def is_boolean(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
251
    # type: (Any) -> bool
252
253
254
255
    ''' Return true if a type is a Boolean Type '''
    return find_basic_type(ty).kind == 'BooleanType'


256
def is_null(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
257
    # type: (Any) -> bool
258
259
260
261
    ''' Return true if a type is a NULL Type '''
    return find_basic_type(ty).kind == 'NullType'


dbarbera's avatar
dbarbera committed
262
def is_string(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
263
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
264
265
266
    ''' Return true if a type is a String Type '''
    return find_basic_type(ty).kind in (
        'StandardStringType',
267
268
        'OctetStringType',
        'StringType'
dbarbera's avatar
dbarbera committed
269
270
271
    )


272
def is_sequenceof(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
273
    # type: (Any) -> bool
274
275
276
277
278
    ''' 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
279
    # type: (Any) -> bool
280
281
282
283
284
    ''' 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
285
    # type: (Any) -> bool
286
287
288
289
290
    ''' 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
291
    # type: (Any) -> bool
292
293
294
295
296
    ''' 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
297
    # type: (Any) -> bool
298
299
300
301
302
    ''' 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
303
    # type: (Any) -> bool
304
305
306
307
    ''' Return true if a type is a Timer Type '''
    return find_basic_type(ty).kind == 'TimerType'


Maxime Perrotin's avatar
Maxime Perrotin committed
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
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:
362
363
364
            if process.processName.lower() == process_name.lower():
                return process
            elif process.instance_of_name.lower() == process_name.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
                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
389
390
391
        process_name can be the name of a process type, in which case the
        interfaces can only be found by looking at an instance of the type
        that is actually connected in the system
Maxime Perrotin's avatar
Maxime Perrotin committed
392
    '''
393
    all_signals, async_signals, errors = [], [], set()
394
    system = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
395
396
397
398
399
400
401
402
403
404
405
406

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

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

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


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
458
def error(root, msg):
Maxime Perrotin's avatar
Maxime Perrotin committed
459
    # type: (Any, str) -> str
dbarbera's avatar
dbarbera committed
460
    ''' Return an error message '''
461
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
462
463
464


def warning(root, msg):
Maxime Perrotin's avatar
Maxime Perrotin committed
465
    # type: (Any, str) -> str
dbarbera's avatar
dbarbera committed
466
    ''' Return a warning message '''
467
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
468
469


dbarbera's avatar
dbarbera committed
470
def tmp():
Maxime Perrotin's avatar
Maxime Perrotin committed
471
    # type : () -> int
dbarbera's avatar
dbarbera committed
472
473
474
475
476
477
478
    ''' Return a temporary variable name '''
    global TMPVAR
    varname = TMPVAR
    TMPVAR += 1
    return varname


Maxime Perrotin's avatar
Maxime Perrotin committed
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
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)


494
def find_basic_type(a_type, pool=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
495
496
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type or UNKNOWN_TYPE
497
    pool = pool or types()
Maxime Perrotin's avatar
Maxime Perrotin committed
498
499
    while basic_type.kind == 'ReferenceType':
        # Find type with proper case in the data view
500
        for typename in pool.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
501
            if typename.lower() == basic_type.ReferencedTypeName.lower():
502
                basic_type = pool[typename].type
Maxime Perrotin's avatar
Maxime Perrotin committed
503
504
505
506
507
508
509
                break
        else:
            raise TypeError('Type "' + type_name(basic_type) +
                            '" was not found in Dataview')
    return basic_type


510
511
512
513
514
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
515

516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
    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)


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

541
    # Special case for write/writeln functions
542
    if name.lower() in ('write', 'writeln'):
543
        def check_one_param(p, name):
544
            p_ty = p.exprType
545
546
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty) or \
                    is_enumerated(p_ty):
547
                return
548
549
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
550
551
552
553
554
555
        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)
556
                # check that both "then" and "else" are of a similar type
557
558
559
560
561
562
563
564
565
566
567
568
569
570
                # (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
571
        return UNKNOWN_TYPE
Maxime Perrotin's avatar
Maxime Perrotin committed
572

573
574
575
576
577
578
579
580
581
    # 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:
582
            raise TypeError('"exist" operator takes only one parameter')
583
584
        param, = params
        if not isinstance(param, ogAST.PrimSelector):
585
            raise TypeError('"exist" operator only works on optional fields')
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
        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'
        })
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
    elif name == 'val':
        # val converts a positive number to a enumeration literal
        # the first parameter is the number and the second is the type name
        # of the enumeration. It is equivalent in Ada to EnumType'Val(number)
        if len(params) != 2:
            raise TypeError(name + " takes 2 parameters: number, type")
        variable, target_type = params
        variable_sort = find_basic_type(variable.exprType)
        if variable_sort.kind != 'IntegerType':
            raise TypeError(name + ': First parameter is not an number')
        sort_name = target_type.value[0]  #  raw string of the type to cast
        for sort in types().keys():
            if sort.lower().replace('-', '_') == \
                    sort_name.lower().replace('-', '_'):
                break
        else:
            raise TypeError(name + ': type ' + sort_name + 'not found')
        # we could check if the range of the number is compatible with the
        # number of values...
        return_type = types()[sort].type
        return return_type
634

635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
    elif name in ('to_selector', 'to_enum'):
        if len(params) != 2:
            raise TypeError(name + " takes 2 parameters: variable, type")
        variable, target_type = params
        variable_sort = find_basic_type(variable.exprType)
        if variable_sort.kind == 'UnknownType':
            raise TypeError(name + ': variable not found (parameter 1)')
        if variable_sort.kind != 'EnumeratedType':
            raise TypeError(name + ': First parameter is not an enumerated')
        sort_name = target_type.value[0]  #  raw string of the type to cast
        for sort in types().keys():
            if sort.lower().replace('-', '_') == \
                    sort_name.lower().replace('-', '_'):
                break
        else:
            raise TypeError(name + ': type ' + sort_name + 'not found')
        # check that the list of enumerants are identical. unfortunately we
        # cannot check the ordering, as it is an unordered dict
        if name == 'to_selector':
            return_type = types()[sort + '-selection'].type
        else:
            return_type = types()[sort].type
        if return_type.kind != 'EnumeratedType':
            raise TypeError(name + ': Second parameter is incorrect')
        return_type_keys = return_type.EnumValues.keys()
        variable_sort_keys = variable_sort.EnumValues.keys()
        if return_type_keys != variable_sort_keys:
            raise TypeError(name + ': Enumerated type are not equivalent')
        return return_type

Maxime Perrotin's avatar
Maxime Perrotin committed
665
666
    # (1) Find the signature of the function
    # signature will hold the list of parameters for the function
667
    sign = signature(name, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
668
669

    # (2) Check that the number of given parameters matches the signature
670
671
672
    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
673

674
675
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
676
        warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
677
678
        expr               = ogAST.ExprAssign()
        expr.left          = ogAST.PrimVariable()
679
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
680
        expr.right         = param
681
682

        try:
683
684
685
            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
686
            warnings.extend(fix_expression_types(expr, context))
687
            params[idx] = expr.right
688
        except TypeError as err:
689
690
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
691
692
693
            raise TypeError('In call to {}: Type of parameter {} is incorrect'
                            ' ({}) - {}'
                            .format(name, idx+1, received, str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
694
        if (warnings):
695
696
697
698
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise Warning('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
699
700

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

705
706
707
    # (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
708
        # The implementation of abs in *all* programming languages returns
Maxime Perrotin's avatar
Maxime Perrotin committed
709
710
        # 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
711
712
        # 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
713
714
715
716
717
        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))
#       })
718
719
720
721
722
723
724

    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
725
726
727
728
729
730
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
    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':
750
        return type('Length', (INT32,), {
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
            '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':
772
        p, = params
773
774
        sort = type_name (p.exprType) + "-selection"
        return types()[sort].type
775

776
777
778
779
780
781
782
783
784
785
    # choice_to_int: returns an integer corresponding to either the currently
    # selected choice value (e.g. foo in CHOICE { foo INTEGER (..), ... } when
    # foo is the current choice). or a default, user-defined value if the
    # current choice is not numerical. The first parameter is an instance of
    # a CHOICE type, and the second parameter is the default value.
    elif name == 'choice_to_int':
        p1, _ = params
        #sort = type_name (p1.exprType)
        return type('choice_to_int', (INTEGER,), {})

dbarbera's avatar
dbarbera committed
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
    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)))
        })

804
805
806
807
808
809
    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)))
        })

810
811
812
813
814
815
816
    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

817
818
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
819

Maxime Perrotin's avatar
Maxime Perrotin committed
820
821
822
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
823
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
824
825
826
827
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
828
            raise Warning('Expression evaluation in range [{}..{}], '
Maxime Perrotin's avatar
Maxime Perrotin committed
829
                          'could be outside expected range [{}..{}]'
Maxime Perrotin's avatar
Maxime Perrotin committed
830
831
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
832
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
833
834
835
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
836
837
def fix_append_expression_type(expr, expected_type):
    ''' In an Append expression, all components must be of the same type,
838
        which is the type expected by the user of the append, for example
Maxime Perrotin's avatar
Maxime Perrotin committed
839
840
841
842
843
844
845
        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
846
    #print "[DEBUG] Fix append expression: ", expr.inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
847
848
849
850
    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)
851
852
853
            if each.exprType == UNKNOWN_TYPE:
                # eg. if the side is a PrimConditional (ternary)
                each.exprType = set_type
Maxime Perrotin's avatar
Maxime Perrotin committed
854
855
856
857
            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
858
    #print expr.exprType
Maxime Perrotin's avatar
Maxime Perrotin committed
859
860


Maxime Perrotin's avatar
Maxime Perrotin committed
861
def check_type_compatibility(primary, type_ref, context):  # type: -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
862
863
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
864
        is compatible with a given type (type_ref is an ASN1Scc type)
865
        Possibly returns a list of warnings; can raises TypeError
Maxime Perrotin's avatar
Maxime Perrotin committed
866
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
867
    warnings = []    # function returns a list of warnings
868
869
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
870
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
871
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
872

873
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
874
875

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
876
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
877
878
879
        # 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
880
881
882
883
        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
884
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
885
        else:
886
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
887
                   '" not in this enumeration: ' +
888
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
889
            raise TypeError(err)
890
891
892
893
894
895
    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
896
897
898
899
                warnings.extend(check_type_compatibility(expr,
                                                         type_ref,
                                                         context))
        return warnings
900

901
    elif isinstance(primary, (ogAST.PrimVariable, ogAST.PrimSelector)):
Maxime Perrotin's avatar
Maxime Perrotin committed
902
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
903
            warnings.extend(compare_types(primary.exprType, type_ref))
Maxime Perrotin's avatar
Maxime Perrotin committed
904
905
906
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
907
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
908
                                    err=str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
909
        return warnings
910

Maxime Perrotin's avatar
Maxime Perrotin committed
911
    elif isinstance(primary, (ogAST.PrimInteger, ogAST.ExprMod)) \
dbarbera's avatar
dbarbera committed
912
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
913
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
914

Maxime Perrotin's avatar
Maxime Perrotin committed
915
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
916
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
917
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
918

919
    elif isinstance(primary, ogAST.ExprNeg):
Maxime Perrotin's avatar
Maxime Perrotin committed
920
921
922
        warnings.extend(check_type_compatibility(primary.expr,
                                                 type_ref,
                                                 context))
923

dbarbera's avatar
dbarbera committed
924
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
925
        return warnings
926

927
    elif isinstance(primary, ogAST.PrimNull) and is_null(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
928
        return warnings
929

930
931
932
933
    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
934
                return warnings
935
936
937
938
939
940
            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
941
        else:
942
            raise TypeError('Not a type compatible with empty string syntax')
Maxime Perrotin's avatar
Maxime Perrotin committed
943
    elif isinstance(primary, ogAST.PrimSequenceOf) \
944
            and basic_type.kind == 'SequenceOfType':
945
946
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
947
                len(primary.value) > int(basic_type.Max)):
948
            #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
949
            raise TypeError(str(len(primary.value)) +
950
951
                      ' element(s) in SEQUENCE OF, while constraint is [' +
                      str(basic_type.Min) + ' .. ' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
952
        for elem in primary.value:
Maxime Perrotin's avatar
Maxime Perrotin committed
953
954
955
            warnings.extend(check_type_compatibility(elem,
                                                     basic_type.type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
956
957
        if not hasattr(primary, 'expected_type') \
               and type_ref.__name__ not in ('Apnd', 'SubStr'):
958
            primary.expected_type = type_ref
Maxime Perrotin's avatar
Maxime Perrotin committed
959
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
960
    elif isinstance(primary, ogAST.PrimSequence) \
961
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
962
        user_nb_elem = len(primary.value.keys())
963
        type_nb_elem = len(basic_type.Children.keys())
964
965
966
967
968
969
970
971
972
973
974
975
        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)))
976
            elif ufield.lower() not in user_fields:
977
978
979
980
                # Optional field not set - OK
                continue
            else:
                # If the user field is a raw value
981
982
983
984
985
986
                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
987
988
989
990
                    warnings.extend(check_type_compatibility
                                         (primary.value[casefield],
                                          fd_data.type,
                                          context))
Maxime Perrotin's avatar
Maxime Perrotin committed
991
                else:
992
993
                    # Compare the types for semantic equivalence
                    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
994
995
996
                        warnings.extend(compare_types
                                       (primary.value[casefield].exprType,
                                        fd_data.type))
997
                    except TypeError as err:
998
                        raise TypeError('Field "' + ufield + '" not of type ' +
999
1000
                                    type_name(fd_data.type) +
                                    ' - ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
1001
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1002
    elif isinstance(primary, ogAST.PrimChoiceItem) \
1003
1004
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
1005
1006
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
1007
1008
1009
1010
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
1011
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
1012
        # compare primary.value['value']
1013
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
1014
1015
1016
1017
        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
1018
1019
1020
            warnings.extend(check_type_compatibility(value,
                                                     choice_field_type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
1021
1022
1023
        # Compare the types for semantic equivalence:
        else:
            try:
Maxime Perrotin's avatar
Maxime Perrotin committed
1024
1025
                warnings.extend(compare_types(value.exprType,
                                              choice_field_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
1026
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
1027
1028
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
1029
1030
1031
1032
                            .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
1033
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1034
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
1035
1036
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
1037
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
1038
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
1039
1040
1041
1042
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
1043
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
1044
1045
1046

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
1047
        basic_type = find_basic_type(type_ref)
1048
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1049
            return warnings
1050
        elif basic_type.kind.endswith('StringType'):
1051
1052
1053
            try:
                if int(basic_type.Min) <= len(
                        primary.value[1:-1]) <= int(basic_type.Max):
Maxime Perrotin's avatar
Maxime Perrotin committed
1054
                    return warnings
1055
                else:
1056
                    #print traceback.print_stack()
1057
                    raise TypeError('Invalid string literal'
Maxime Perrotin's avatar
Maxime Perrotin committed
1058
                                    ' - check that length is '
1059
1060
1061
1062
1063
1064
                                    '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
1065
                return warnings
1066
1067
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
1068
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
1069
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
1070
1071
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
Maxime Perrotin's avatar
Maxime Perrotin committed
1072
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1073
1074
1075
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
1076
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
1077
    return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1078

Maxime Perrotin's avatar
Maxime Perrotin committed
1079

Maxime Perrotin's avatar
Maxime Perrotin committed
1080
def compare_types(type_a, type_b):   # type -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
1081
1082
1083
1084
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1085
    warnings = []
1086
1087
1088
1089
1090
    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
1091
1092
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
1093

Maxime Perrotin's avatar
Maxime Perrotin committed
1094
    if type_a == type_b:
Maxime Perrotin's avatar
Maxime Perrotin committed
1095
        return warnings
1096
1097
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1098
        return warnings
1099
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1100
        return warnings
1101
1102
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1103
        return warnings
1104
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1105
        return warnings
1106

Maxime Perrotin's avatar
Maxime Perrotin committed
1107
    # Check if both types have basic compatibility
1108
    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
1109
        if type_a.kind == 'SequenceOfType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1110
1111
            if mismatch:
                raise TypeError(mismatch)
1112
1113
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
Maxime Perrotin's avatar
Maxime Perrotin committed
1114
1115
                    warnings.extend(compare_types(type_a.type, type_b.type))
                    return warnings
1116
1117
1118
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
1119
1120
            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
1121
1122
                warnings.extend(compare_types(type_a.type, type_b.type))
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1123
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
1124
1125
1126
                warnings.extend(compare_types(type_a.type, type_b.type))
                warnings.append('Size constraints mismatch - risk of overflow')
                return warnings
1127
        # TODO: Check that OctetString types have compatible range
1128
1129
        elif type_a.kind == 'SequenceType' and mismatch:
            raise TypeError(mismatch)
1130
        elif type_a.kind == 'IntegerType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1131
1132
            # Detect Signed/Unsigned type mismatch
            min_a, min_b = float(type_a.Min), float(type_b.Min)
Maxime Perrotin's avatar
Maxime Perrotin committed
1133
1134
            if (min_a >= 0) != (min_b >= 0) \
                    and not (is_number(type_a) or is_number(type_b)):
1135
1136
1137
                raise TypeError("Signed vs Unsigned type mismatch " +
                        mismatch)
            elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1138
                warnings.append(mismatch)
1139
        elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1140
1141
1142
            warnings.append(mismatch)
        #print traceback.print_stack()
        return warnings
1143
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1144
        return warnings
1145
    elif is_integer(type_a) and is_integer(type_b):
1146
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1147
1148
            warnings.append(mismatch)
        return warnings
1149
    elif is_real(type_a) and is_real(type_b):
1150
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1151
1152
            warnings.append(mismatch)
        return warnings
1153
1154
1155
1156
1157
    else:
        raise TypeError('Incompatible types {} and {}'.format(
            type_name(type_a),
            type_name(type_b)
        ))
Maxime Perrotin's avatar
Maxime Perrotin committed
1158

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

Maxime Perrotin's avatar
Maxime Perrotin committed
1162
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
1163
1164
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)