ogParser.py 222 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
from inspect import currentframe, getframeinfo
35
import binascii
36
from textwrap import dedent
Maxime Perrotin's avatar
Maxime Perrotin committed
37
from itertools import chain, permutations, combinations
38
from collections import defaultdict, Counter
Maxime Perrotin's avatar
Maxime Perrotin committed
39
40
41
42
43
44
45
46
import antlr3
import antlr3.tree

import sdl92Lexer as lexer
from sdl92Parser import sdl92Parser

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

LOG = logging.getLogger(__name__)

51
EXPR_NODE = {
52
    lexer.PLUS:     ogAST.ExprPlus,
53
    lexer.ASTERISK: ogAST.ExprMul,
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
    lexer.IMPLIES:  ogAST.ExprImplies,
    lexer.DASH:     ogAST.ExprMinus,
    lexer.OR:       ogAST.ExprOr,
    lexer.AND:      ogAST.ExprAnd,
    lexer.XOR:      ogAST.ExprXor,
    lexer.EQ:       ogAST.ExprEq,
    lexer.NEQ:      ogAST.ExprNeq,
    lexer.GT:       ogAST.ExprGt,
    lexer.GE:       ogAST.ExprGe,
    lexer.LT:       ogAST.ExprLt,
    lexer.LE:       ogAST.ExprLe,
    lexer.DIV:      ogAST.ExprDiv,
    lexer.MOD:      ogAST.ExprMod,
    lexer.APPEND:   ogAST.ExprAppend,
    lexer.IN:       ogAST.ExprIn,
    lexer.REM:      ogAST.ExprRem,
    lexer.NOT:      ogAST.ExprNot,
    lexer.NEG:      ogAST.ExprNeg,
    lexer.PRIMARY:  ogAST.Primary,
Maxime Perrotin's avatar
Maxime Perrotin committed
73
} # type: Dict[int, ogAST.Expression]
Maxime Perrotin's avatar
Maxime Perrotin committed
74
75
76
77

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

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

# Code generator backends may need some intemediate variables to process
# expressions. For convenience and to avoid multiple pass parsing, the parser
# tries to guess where they may be useful, and adds a hint in the AST.
Maxime Perrotin's avatar
Maxime Perrotin committed
83
TMPVAR = 0  # type: int
Maxime Perrotin's avatar
Maxime Perrotin committed
84
85

# ASN.1 types used to support the signature of special operators
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
INTEGER      = type('IntegerType',    (object,), {'kind': 'IntegerType',
                                                  'Min' : str(-(2 ** 63)),
                                                  'Max' : str(2 ** 63 - 1)})
UNSIGNED     = type('IntegerType',    (object,), {'kind': 'IntegerType',
                                                  'Min' : "0",
                                                  'Max' : str(2 ** 64 - 1)})
INT32        = type('Integer32Type',  (object,), {'kind': 'Integer32Type',
                                                  'Min' : '-2147483648',
                                                  'Max' : '2147483647'})
NUMERICAL    = type('NumericalType',  (object,), {'kind': 'Numerical'})
TIMER        = type('TimerType',      (object,), {'kind': 'TimerType'})
REAL         = type('RealType',       (object,), {'kind': 'RealType',
                                                  'Min' : str(1e-308),
                                                  'Max' : str(1e308)})
LIST         = type('ListType',       (object,), {'kind': 'ListType'})
ANY_TYPE     = type('AnyType',        (object,), {'kind': 'AnyType'})
CHOICE       = type('ChoiceType',     (object,), {'kind': 'ChoiceType'})
BOOLEAN      = type('BooleanType',    (object,), {'kind': 'BooleanType'})
RAWSTRING    = type('RawString',      (object,), {'kind': 'StandardStringType',
                                                  'Min' : '0',
                                                  'Max' : '255'})
OCTETSTRING  = type('OctetString',    (object,), {'kind': 'OctetStringType'})
ENUMERATED   = type('EnumeratedType', (object,), {'kind': 'EnumeratedType'})
UNKNOWN_TYPE = type('UnknownType',    (object,), {'kind': 'UnknownType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
110

111
SPECIAL_OPERATORS = {
112
113
114
115
116
117
118
119
120
121
    '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'},
122
                    {'type': NUMERICAL,  'direction': 'in'}
123
124
                   ],
    'present'    : [{'type': CHOICE,     'direction': 'in'}],
125
    'exist'      : [{'type': ANY_TYPE,   'direction': 'in'}],
126
127
128
129
130
131
132
133
134
135
136
    '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'}],
137
138
139
140
141
142
143
144
    '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'}
                   ],
145
146
147
148
    'val'    : [  #  to convert a number to an enumerated type value
                    {'type': UNSIGNED,   'direction': 'in'},  # eg. 1
                    {'type': ANY_TYPE,   'direction': 'in'}   # eg. MyChoice
                   ],
149
150
151
152
153
    'choice_to_int' : [  #  to return the value of a numerical choice item
                    {'type': CHOICE,     'direction': 'in'},  # choice variable
                    {'type': NUMERICAL,  'direction': 'in'}   # default value
                   ],

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

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


# 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

172
173
174
# return the line number of this python module, useful for debugging
lineno = lambda : currentframe().f_back.f_lineno

175
176
177
178
179
180
181
182
183
184
185
# 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
186
187


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


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


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


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


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


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


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


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


Maxime Perrotin's avatar
Maxime Perrotin committed
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
362
363
364
365
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:
366
367
368
            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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
                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
393
394
395
        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
396
    '''
397
    all_signals, async_signals, errors = [], [], set()
398
    system = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
399
400
401
402
403
404
405
406
407
408
409
410

    # 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)
411
412
        # Update process name with the name of the instance if we are parsing
        # a process type.
Maxime Perrotin's avatar
Maxime Perrotin committed
413
        if process_ref:
414
            process_name = process_ref.processName
415
416
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
417
418
419
            break
    else:
        if isinstance(ast, ogAST.Block):
420
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
421
422
        else:
            raise TypeError('Process ' + process_name +
423
                        ' is defined but not declared in a system')
Maxime Perrotin's avatar
Maxime Perrotin committed
424
    # Find in and out signals names using the signalroutes
425
    undeclared_signals = []
426
427
    for each in process_parent.signalroutes:
        for route in each['routes']:
Maxime Perrotin's avatar
Maxime Perrotin committed
428
429
430
431
432
433
434
435
            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
436
437
                try:
                    found, = [dict(sig) for sig in all_signals
438
                              if sig['name'].lower() == sig_id.lower()]
439
440
441
                    found['direction'] = direction
                    async_signals.append(found)
                except ValueError:
442
                    undeclared_signals.append(sig_id)
443
                except (KeyError, AttributeError) as err:
444
445
446
447
448
449
                    # 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')
450
    if undeclared_signals:
451
452
        errors.add('Missing declaration for signal(s) {}'
                   .format(', '.join(undeclared_signals)))
453
    return async_signals, system.procedures, errors
Maxime Perrotin's avatar
Maxime Perrotin committed
454
455
456
457
458
459
460
461


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


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


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


Maxime Perrotin's avatar
Maxime Perrotin committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
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)


498
def find_basic_type(a_type, pool=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
499
500
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type or UNKNOWN_TYPE
501
    pool = pool or types()
Maxime Perrotin's avatar
Maxime Perrotin committed
502
    while basic_type.kind == 'ReferenceType':
503
504
505
        Min = getattr(basic_type, "Min", None)
        Max = getattr(basic_type, "Max", None)

Maxime Perrotin's avatar
Maxime Perrotin committed
506
        # Find type with proper case in the data view
507
        for typename in pool.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
508
            if typename.lower() == basic_type.ReferencedTypeName.lower():
509
                basic_type = pool[typename].type
510
511
512
513
514
515
516
517
                if Min is not None and Max is not None \
                        and is_numeric(basic_type):
                    # Subtypes may have defined subranges
                    new_type = type('Subtype',  basic_type.__bases__,
                            dict (basic_type.__dict__))
                    new_type.Min = Min
                    new_type.Max = Max
                    basic_type = new_type
Maxime Perrotin's avatar
Maxime Perrotin committed
518
519
520
521
522
523
524
                break
        else:
            raise TypeError('Type "' + type_name(basic_type) +
                            '" was not found in Dataview')
    return basic_type


525
526
527
528
529
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
530

531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
    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)


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

556
    # Special case for write/writeln functions
557
    if name.lower() in ('write', 'writeln'):
558
        def check_one_param(p, name):
559
            p_ty = p.exprType
560
561
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty) or \
                    is_enumerated(p_ty):
562
                return
563
564
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
565
566
567
568
569
570
        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)
571
                # check that both "then" and "else" are of a similar type
572
573
574
575
576
577
578
579
580
581
582
583
584
585
                # (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
586
        return UNKNOWN_TYPE
Maxime Perrotin's avatar
Maxime Perrotin committed
587

588
589
590
591
592
593
594
595
596
    # 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:
597
            raise TypeError('"exist" operator takes only one parameter')
598
599
        param, = params
        if not isinstance(param, ogAST.PrimSelector):
600
            raise TypeError('"exist" operator only works on optional fields')
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
        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'
        })
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
    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
649

650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
    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
680
681
    # (1) Find the signature of the function
    # signature will hold the list of parameters for the function
682
    sign = signature(name, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
683
684

    # (2) Check that the number of given parameters matches the signature
685
686
687
    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
688

689
690
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
691
        warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
692
        expr               = ogAST.ExprAssign()
693
        expr.left          = ogAST.PrimVariable(debugLine=lineno())
694
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
695
        expr.right         = param
696
697

        try:
698
699
700
            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
701
            warnings.extend(fix_expression_types(expr, context))
702
            params[idx] = expr.right
703
        except TypeError as err:
704
705
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
706
707
708
            raise TypeError('In call to {}: Type of parameter {} is incorrect'
                            ' ({}) - {}'
                            .format(name, idx+1, received, str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
709
        if (warnings):
710
711
712
713
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise Warning('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
714
715

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

720
721
722
    # (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
723
        # The implementation of abs in *all* programming languages returns
Maxime Perrotin's avatar
Maxime Perrotin committed
724
725
        # 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
726
727
        # this is an issue in an assign statement, if the recipient is
        # unsigned .. A cast is necessary if the parameter of abs is negative
728
729
730
731
732
733
734
735
736
737
738
        Min = float(param_btys[0].Min)
        Max = float(param_btys[0].Max)
        if p.exprType.kind != 'ReferenceType' and Min == Max:
            # if param is a raw number, return a positive range
            # otherwise return the same type as the variable
            return type('Universal_Integer', (param_btys[0],), {
               'Min': str(max(Min, 0)),
               'Max': str(max(Max, 0))
           })
        else:
            return type('Abs', (param_btys[0],), {})
739
740
741
742
743
744
745

    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
746
747
748
749
750
751
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
    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':
771
        return type('Length', (INT32,), {
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
            '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':
793
        p, = params
794
795
        sort = type_name (p.exprType) + "-selection"
        return types()[sort].type
796

797
798
799
800
801
802
803
804
805
806
    # 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
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
    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)))
        })

825
826
827
828
829
830
    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)))
        })

831
832
833
834
835
836
837
    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

838
839
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
840

Maxime Perrotin's avatar
Maxime Perrotin committed
841
842
843
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
844
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
845
846
    '''
    try:
847
848
849
850
851
852
853
854
855
856
857
858
        min1, max1 = float(type_to_check.Min), float(type_to_check.Max)
        min2, max2 = float(typeref.Min), float(typeref.Max)
        error   = min1 > max2 or max1 < min2
        warning = min1 < min2 or max1 > max2
        if error:
            raise TypeError(
                    'Expression in range {} .. {} is outside range {} .. {}'
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
        elif warning:
            raise Warning('Expression in range {} .. {}, '
                          'could be outside expected range {} .. {}'
Maxime Perrotin's avatar
Maxime Perrotin committed
859
860
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
861
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
862
863
864
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
865
866
def fix_append_expression_type(expr, expected_type):
    ''' In an Append expression, all components must be of the same type,
867
        which is the type expected by the user of the append, for example
Maxime Perrotin's avatar
Maxime Perrotin committed
868
869
870
871
872
873
874
        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
875
    #print "[DEBUG] Fix append expression: ", expr.inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
876
877
878
879
    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)
880
881
882
            if each.exprType == UNKNOWN_TYPE:
                # eg. if the side is a PrimConditional (ternary)
                each.exprType = set_type
Maxime Perrotin's avatar
Maxime Perrotin committed
883
884
885
886
            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
887
    #print expr.exprType
Maxime Perrotin's avatar
Maxime Perrotin committed
888
889


Maxime Perrotin's avatar
Maxime Perrotin committed
890
def check_type_compatibility(primary, type_ref, context):  # type: -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
891
892
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
893
        is compatible with a given type (type_ref is an ASN1Scc type)
894
        Possibly returns a list of warnings; can raises TypeError
Maxime Perrotin's avatar
Maxime Perrotin committed
895
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
896
    warnings = []    # function returns a list of warnings
897
898
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
899
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
900
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
901

902
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
903
904

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
905
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
906
907
908
        # 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
909
910
911
912
        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
913
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
914
        else:
915
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
916
                   '" not in this enumeration: ' +
917
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
918
            raise TypeError(err)
919
920
921
922
923
924
    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
925
926
927
928
                warnings.extend(check_type_compatibility(expr,
                                                         type_ref,
                                                         context))
        return warnings
929

930
    elif isinstance(primary, (ogAST.PrimVariable, ogAST.PrimSelector)):
Maxime Perrotin's avatar
Maxime Perrotin committed
931
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
932
            warnings.extend(compare_types(primary.exprType, type_ref))
Maxime Perrotin's avatar
Maxime Perrotin committed
933
934
935
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
936
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
937
                                    err=str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
938
        return warnings
939

Maxime Perrotin's avatar
Maxime Perrotin committed
940
    elif isinstance(primary, (ogAST.PrimInteger, ogAST.ExprMod)) \
dbarbera's avatar
dbarbera committed
941
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
942
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
943

Maxime Perrotin's avatar
Maxime Perrotin committed
944
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
945
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
946
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
947

948
    elif isinstance(primary, ogAST.ExprNeg):
Maxime Perrotin's avatar
Maxime Perrotin committed
949
950
951
        warnings.extend(check_type_compatibility(primary.expr,
                                                 type_ref,
                                                 context))
952

dbarbera's avatar
dbarbera committed
953
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
954
        return warnings
955

956
    elif isinstance(primary, ogAST.PrimNull) and is_null(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
957
        return warnings
958

959
960
961
962
    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
963
                return warnings
964
965
966
967
968
969
            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
970
        else:
971
            raise TypeError('Not a type compatible with empty string syntax')
Maxime Perrotin's avatar
Maxime Perrotin committed
972
    elif isinstance(primary, ogAST.PrimSequenceOf) \
973
            and basic_type.kind == 'SequenceOfType':
974
975
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
976
                len(primary.value) > int(basic_type.Max)):
977
            #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
978
            raise TypeError(str(len(primary.value)) +
979
980
                      ' element(s) in SEQUENCE OF, while constraint is [' +
                      str(basic_type.Min) + ' .. ' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
981
        for elem in primary.value:
Maxime Perrotin's avatar
Maxime Perrotin committed
982
983
984
            warnings.extend(check_type_compatibility(elem,
                                                     basic_type.type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
985
986
        if not hasattr(primary, 'expected_type') \
               and type_ref.__name__ not in ('Apnd', 'SubStr'):
987
            primary.expected_type = type_ref
Maxime Perrotin's avatar
Maxime Perrotin committed
988
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
989
    elif isinstance(primary, ogAST.PrimSequence) \
990
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
991
        user_nb_elem = len(primary.value.keys())
992
        type_nb_elem = len(basic_type.Children.keys())
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
        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)))
1005
            elif ufield.lower() not in user_fields:
1006
1007
1008
1009
                # Optional field not set - OK
                continue
            else:
                # If the user field is a raw value
1010
1011
1012
1013
1014
1015
                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
1016
1017
1018
1019
                    warnings.extend(check_type_compatibility
                                         (primary.value[casefield],
                                          fd_data.type,
                                          context))
Maxime Perrotin's avatar
Maxime Perrotin committed
1020
                else:
1021
1022
                    # Compare the types for semantic equivalence
                    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
1023
1024
1025
                        warnings.extend(compare_types
                                       (primary.value[casefield].exprType,
                                        fd_data.type))
1026
                    except TypeError as err:
1027
                        raise TypeError('Field "' + ufield + '" not of type ' +
1028
1029
                                    type_name(fd_data.type) +
                                    ' - ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
1030
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1031
    elif isinstance(primary, ogAST.PrimChoiceItem) \
1032
1033
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
1034
1035
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
1036
1037
1038
1039
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
1040
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
1041
        # compare primary.value['value']
1042
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
1043
1044
1045
1046
        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
1047
1048
1049
            warnings.extend(check_type_compatibility(value,
                                                     choice_field_type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
1050
1051
1052
        # Compare the types for semantic equivalence:
        else:
            try:
Maxime Perrotin's avatar
Maxime Perrotin committed
1053
1054
                warnings.extend(compare_types(value.exprType,
                                              choice_field_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
1055
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
1056
1057
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
1058
1059
1060
1061
                            .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
1062
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1063
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
1064
1065
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
1066
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
1067
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
1068
1069
1070
1071
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
1072
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
1073
1074
1075

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
1076
        basic_type = find_basic_type(type_ref)
1077
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1078
            return warnings
1079
        elif basic_type.kind.endswith('StringType'):
1080
1081
1082
            try:
                if int(basic_type.Min) <= len(
                        primary.value[1:-1]) <= int(basic_type.Max):
Maxime Perrotin's avatar
Maxime Perrotin committed
1083
                    return warnings
1084
                else:
1085
                    #print traceback.print_stack()
1086
                    raise TypeError('Invalid string literal'
Maxime Perrotin's avatar
Maxime Perrotin committed
1087
                                    ' - check that length is '
1088
1089
1090
1091
1092
1093
                                    '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
1094
                return warnings
1095
1096
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
1097
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
1098
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
1099
1100
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
Maxime Perrotin's avatar
Maxime Perrotin committed
1101
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1102
1103
1104
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
1105
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
1106
    return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1107

Maxime Perrotin's avatar
Maxime Perrotin committed
1108

Maxime Perrotin's avatar
Maxime Perrotin committed
1109
def compare_types(type_a, type_b):   # type -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
1110
1111
1112
1113
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1114
    warnings = []
1115
1116
1117
1118
1119
    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
1120
1121
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
1122

Maxime Perrotin's avatar
Maxime Perrotin committed
1123
    if type_a == type_b:
Maxime Perrotin's avatar
Maxime Perrotin committed
1124
        return warnings
1125
1126
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1127
        return warnings
1128
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1129
        return warnings
1130
1131
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1132
        return warnings
1133
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1134
        return warnings
1135

Maxime Perrotin's avatar
Maxime Perrotin committed
1136
    # Check if both types have basic compatibility
1137
    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
1138
        if type_a.kind == 'SequenceOfType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1139
1140
            if mismatch:
                raise TypeError(mismatch)
1141
1142
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
Maxime Perrotin's avatar
Maxime Perrotin committed
1143
1144
                    warnings.extend(compare_types(type_a.type, type_b.type))
                    return warnings
1145
1146
1147
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
1148
1149
            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
1150
1151
                warnings.extend(compare_types(type_a.type, type_b.type))
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1152
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
1153
1154
1155
                warnings.extend(compare_types(type_a.type, type_b.type))
                warnings.append('Size constraints mismatch - risk of overflow')
                return warnings
1156
        # TODO: Check that OctetString types have compatible range
1157
1158
        elif type_a.kind == 'SequenceType' and mismatch:
            raise TypeError(mismatch)
1159
        elif type_a.kind == 'IntegerType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1160
1161
            # Detect Signed/Unsigned type mismatch
            min_a, min_b = float(type_a.Min), float(type_b.Min)
Maxime Perrotin's avatar
Maxime Perrotin committed
1162
1163
            if (min_a >= 0) != (min_b >= 0) \
                    and not (is_number(type_a) or is_number(type_b)):
1164
1165
1166
                raise TypeError("Signed vs Unsigned type mismatch " +
                        mismatch)
            elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1167
                warnings.append(mismatch)
1168
        elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1169
1170
1171
            warnings.append(mismatch)
        #print traceback.print_stack()
        return warnings
1172
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
1173
        return warnings
1174
    elif is_integer(type_a) and is_integer(type_b):
1175
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
1176
1177
            warnings.append(mismatch)
        return warnings