ogParser.py 187 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#!/usr/bin/env python
# -*- coding: utf-8 -*-


"""
    OpenGEODE SDL92 parser

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

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

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

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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

__author__ = 'Maxime Perrotin'

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

import sdl92Lexer as lexer
from sdl92Parser import sdl92Parser

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

LOG = logging.getLogger(__name__)

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
EXPR_NODE = {
    lexer.PLUS: ogAST.ExprPlus,
    lexer.ASTERISK: ogAST.ExprMul,
    lexer.IMPLIES: ogAST.ExprImplies,
    lexer.DASH: ogAST.ExprMinus,
    lexer.OR: ogAST.ExprOr,
    lexer.AND: ogAST.ExprAnd,
    lexer.XOR: ogAST.ExprXor,
    lexer.EQ: ogAST.ExprEq,
    lexer.NEQ: ogAST.ExprNeq,
    lexer.GT: ogAST.ExprGt,
    lexer.GE: ogAST.ExprGe,
    lexer.LT: ogAST.ExprLt,
    lexer.LE: ogAST.ExprLe,
    lexer.DIV: ogAST.ExprDiv,
    lexer.MOD: ogAST.ExprMod,
    lexer.APPEND: ogAST.ExprAppend,
    lexer.IN: ogAST.ExprIn,
    lexer.REM: ogAST.ExprRem,
    lexer.NOT: ogAST.ExprNot,
    lexer.NEG: ogAST.ExprNeg,
    lexer.PRIMARY: ogAST.Primary,
Maxime Perrotin's avatar
Maxime Perrotin committed
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
INTEGER = type('IntegerType', (object,), {'kind': 'IntegerType',
                                          'Min': str(-(2 ** 63)),
                                          'Max': str(2 ** 63 - 1)})
Maxime Perrotin's avatar
Maxime Perrotin committed
88
INT32 = type('Integer32Type', (object,), {'kind': 'Integer32Type',
dbarbera's avatar
dbarbera committed
89
90
                                          'Min': '-2147483648',
                                          'Max': '2147483647'})
Maxime Perrotin's avatar
Maxime Perrotin committed
91
92
NUMERICAL = type('NumericalType', (object,), {'kind': 'Numerical'})
TIMER = type('TimerType', (object,), {'kind': 'TimerType'})
93
94
95
REAL = type('RealType', (object,), {'kind': 'RealType',
                                    'Min': str(1e-308),
                                    'Max': str(1e308)})
Maxime Perrotin's avatar
Maxime Perrotin committed
96
97
98
99
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'})
100
101
RAWSTRING = type('RawString', (object,), {'kind': 'StandardStringType',
                                          'Min': '0', 'Max': '255'})
102
OCTETSTRING = type('OctetString', (object,), {'kind': 'OctetStringType'})
103
ENUMERATED = type('EnumeratedType', (object,), {'kind': 'EnumeratedType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
104
105
106

UNKNOWN_TYPE = type('UnknownType', (object,), {'kind': 'UnknownType'})

107
SPECIAL_OPERATORS = {
dbarbera's avatar
dbarbera committed
108
109
    'abs': [{'type': NUMERICAL, 'direction': 'in'}],
    'ceil': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
110
    'cos': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
111
112
113
    'fix': [{'type': NUMERICAL, 'direction': 'in'}],
    'float': [{'type': NUMERICAL, 'direction': 'in'}],
    'floor': [{'type': REAL, 'direction': 'in'}],
114
    'length': [{'type': LIST, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
115
    'num': [{'type': ENUMERATED, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
116
117
118
119
    'power': [
        {'type': NUMERICAL, 'direction': 'in'},
        {'type': INTEGER, 'direction': 'in'}
    ],
120
121
    'present': [{'type': CHOICE, 'direction': 'in'}],
    'reset_timer': [{'type': TIMER, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
122
123
124
125
126
127
128
    'round': [{'type': REAL, 'direction': 'in'}],
    'set_timer': [
        {'type': INTEGER, 'direction': 'in'},
        {'type': TIMER, 'direction': 'in'}
    ],
    'sin': [{'type': REAL, 'direction': 'in'}],
    'sqrt': [{'type': REAL, 'direction': 'in'}],
dbarbera's avatar
dbarbera committed
129
130
131
    'trunc': [{'type': REAL, 'direction': 'in'}],
    'write': [{'type': ANY_TYPE, 'direction': 'in'}],
    'writeln': [{'type': ANY_TYPE, 'direction': 'in'}],
132
}
Maxime Perrotin's avatar
Maxime Perrotin committed
133
134
135
136

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


# Shortcut to create a new referenced ASN.1 type
new_ref_type = lambda refname: \
        type(str(refname), (object,),
                {'kind': 'ReferenceType',
                 'ReferencedTypeName': refname.replace('_', '-')})

# Shortcut to return a type name (Reference name or basic type)
type_name = lambda t: \
                t.kind if t.kind != 'ReferenceType' else t.ReferencedTypeName

types = lambda: getattr(DV, 'types', {})


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


176
def substring_range(substring):
Maxime Perrotin's avatar
Maxime Perrotin committed
177
    # type: (ogAST.PrimSubstring) -> Tuple[str, str]
178
179
180
181
182
183
184
    ''' 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


dbarbera's avatar
dbarbera committed
185
def is_integer(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
186
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
187
188
189
190
191
192
193
    ''' Return true if a type is an Integer Type '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type'
    )


194
def is_real(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
195
    # type: (Any) -> bool
196
197
198
199
    ''' Return true if a type is a Real Type '''
    return find_basic_type(ty).kind == 'RealType'


200
def is_numeric(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
201
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
202
    ''' Return true if a type is a Numeric Type '''
203
204
205
206
207
208
209
210
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type',
        'Numerical',
        'RealType'
    )


211
def is_boolean(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
212
    # type: (Any) -> bool
213
214
215
216
    ''' Return true if a type is a Boolean Type '''
    return find_basic_type(ty).kind == 'BooleanType'


217
def is_null(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
218
    # type: (Any) -> bool
219
220
221
222
    ''' Return true if a type is a NULL Type '''
    return find_basic_type(ty).kind == 'NullType'


dbarbera's avatar
dbarbera committed
223
def is_string(ty):
Maxime Perrotin's avatar
Maxime Perrotin committed
224
    # type: (Any) -> bool
dbarbera's avatar
dbarbera committed
225
226
227
    ''' Return true if a type is a String Type '''
    return find_basic_type(ty).kind in (
        'StandardStringType',
228
229
        'OctetStringType',
        'StringType'
dbarbera's avatar
dbarbera committed
230
231
232
    )


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


Maxime Perrotin's avatar
Maxime Perrotin committed
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
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:
            if process.processName == process_name:
                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
    '''
349
    all_signals, async_signals, errors = [], [], set()
Maxime Perrotin's avatar
Maxime Perrotin committed
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
    system = None

    # 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
    system = ast
    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)
        if process_ref:
365
366
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
367
368
369
            break
    else:
        if isinstance(ast, ogAST.Block):
370
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
371
372
        else:
            raise TypeError('Process ' + process_name +
373
                        ' is defined but not declared in a system')
Maxime Perrotin's avatar
Maxime Perrotin committed
374
    # Find in and out signals names using the signalroutes
375
    undeclared_signals = []
376
377
    for each in process_parent.signalroutes:
        for route in each['routes']:
Maxime Perrotin's avatar
Maxime Perrotin committed
378
379
380
381
382
383
384
385
            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
386
387
                try:
                    found, = [dict(sig) for sig in all_signals
388
                              if sig['name'].lower() == sig_id.lower()]
389
390
391
                    found['direction'] = direction
                    async_signals.append(found)
                except ValueError:
392
                    undeclared_signals.append(sig_id)
393
                except (KeyError, AttributeError) as err:
394
395
396
397
398
399
                    # 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')
400
    if undeclared_signals:
401
402
        errors.add('Missing declaration for signal(s) {}'
                   .format(', '.join(undeclared_signals)))
403
    return async_signals, system.procedures, errors
Maxime Perrotin's avatar
Maxime Perrotin committed
404
405
406
407
408
409
410
411


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
412
def error(root, msg):
Maxime Perrotin's avatar
Maxime Perrotin committed
413
    # type: (Any, str) -> str
dbarbera's avatar
dbarbera committed
414
    ''' Return an error message '''
415
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
416
417
418


def warning(root, msg):
Maxime Perrotin's avatar
Maxime Perrotin committed
419
    # type: (Any, str) -> str
dbarbera's avatar
dbarbera committed
420
    ''' Return a warning message '''
421
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
422
423


dbarbera's avatar
dbarbera committed
424
def tmp():
Maxime Perrotin's avatar
Maxime Perrotin committed
425
    # type : () -> int
dbarbera's avatar
dbarbera committed
426
427
428
429
430
431
432
    ''' Return a temporary variable name '''
    global TMPVAR
    varname = TMPVAR
    TMPVAR += 1
    return varname


Maxime Perrotin's avatar
Maxime Perrotin committed
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
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)


448
def find_basic_type(a_type, pool=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
449
450
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type or UNKNOWN_TYPE
451
    pool = pool or types()
Maxime Perrotin's avatar
Maxime Perrotin committed
452
453
    while basic_type.kind == 'ReferenceType':
        # Find type with proper case in the data view
454
        for typename in pool.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
455
            if typename.lower() == basic_type.ReferencedTypeName.lower():
456
                basic_type = pool[typename].type
Maxime Perrotin's avatar
Maxime Perrotin committed
457
458
459
460
461
462
463
                break
        else:
            raise TypeError('Type "' + type_name(basic_type) +
                            '" was not found in Dataview')
    return basic_type


464
465
466
467
468
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
469

470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
    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)


490
491
492
def check_call(name, params, context):
    ''' Check the parameter types of a procedure/output/operator call,
        returning the type of its result '''
493

494
    # Special case for write/writeln functions
495
    if name.lower() in ('write', 'writeln'):
496
497
        for p in params:
            p_ty = p.exprType
498
499
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty) or \
                    is_enumerated(p_ty):
500
501
502
                continue
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
Maxime Perrotin's avatar
Maxime Perrotin committed
503
        return UNKNOWN_TYPE
Maxime Perrotin's avatar
Maxime Perrotin committed
504
505
506

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

    # (2) Check that the number of given parameters matches the signature
510
511
512
    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
513

514
515
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
516
        warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
517
        expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
518
        expr.left = ogAST.PrimVariable()
519
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
520
        expr.right = param
521
522

        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
523
            warnings.extend(fix_expression_types(expr, context))
524
525
526
527
528
529
            params[idx] = expr.right
        except TypeError:
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise TypeError('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
Maxime Perrotin's avatar
Maxime Perrotin committed
530
        if (warnings):
531
532
533
534
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise Warning('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
535
536

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

541
542
543
544
545
546
547
548
549
550
551
552
553
554
    # (4) Compute the type of the result
    param_btys = [find_basic_type(p.exprType) for p in params]
    if name == 'abs':
        return type('Abs', (param_btys[0],), {
            'Min': str(max(float(param_btys[0].Min), 0)),
            'Max': str(max(float(param_btys[0].Max), 0))
        })

    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
555
556
557
558
559
560
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
    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':
580
        return type('Length', (INT32,), {
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
            'Min': param_btys[0].Min,
            'Max': param_btys[0].Max
        })

    elif name == 'num':
        enum_values = [int(each.IntValue)
                       for each in param_btys[0].EnumValues.viewvalues()]

        return type('Num', (INTEGER,), {
            'Min': str(min(enum_values)),
            'Max': str(max(enum_values))
        })

    elif name == 'power':
        return type('Power', (param_btys[0],), {
            'Min': str(pow(float(param_btys[0].Min),
                           float(param_btys[1].Min))),
            'Max': str(pow(float(param_btys[0].Max),
                           float(param_btys[1].Max)))
        })

    elif name == 'present':
        return type('Present', (object,), {
            'kind': 'ChoiceEnumeratedType',
            'EnumValues': param_btys[0].Children
        })

dbarbera's avatar
dbarbera committed
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
    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)))
        })

626
627
628
629
630
631
    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)))
        })

632
633
634
635
636
637
638
    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

639
640
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
641

Maxime Perrotin's avatar
Maxime Perrotin committed
642
643
644
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
645
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
646
647
648
649
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
650
            raise Warning('Expression evaluation in range [{}..{}], '
Maxime Perrotin's avatar
Maxime Perrotin committed
651
                          'could be outside expected range [{}..{}]'
Maxime Perrotin's avatar
Maxime Perrotin committed
652
653
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
654
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
655
656
657
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
658
def check_type_compatibility(primary, type_ref, context):  # type: -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
659
660
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
661
        is compatible with a given type (type_ref is an ASN1Scc type)
Maxime Perrotin's avatar
Maxime Perrotin committed
662
663
        Does not return anything if OK, otherwise raises TypeError
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
664
    warnings = []    # function returns a list of warnings
665
666
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
667
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
668
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
669

670
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
671
672

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
673
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
674
675
676
        # 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
677
678
679
680
        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
681
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
682
        else:
683
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
684
                   '" not in this enumeration: ' +
685
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
686
            raise TypeError(err)
687
688
689
690
691
692
    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
693
694
695
696
                warnings.extend(check_type_compatibility(expr,
                                                         type_ref,
                                                         context))
        return warnings
697

698
    elif isinstance(primary, (ogAST.PrimVariable, ogAST.PrimSelector)):
Maxime Perrotin's avatar
Maxime Perrotin committed
699
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
700
            warnings.extend(compare_types(primary.exprType, type_ref))
Maxime Perrotin's avatar
Maxime Perrotin committed
701
702
703
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
704
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
705
                                    err=str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
706
        return warnings
707

Maxime Perrotin's avatar
Maxime Perrotin committed
708
    elif isinstance(primary, ogAST.PrimInteger) \
dbarbera's avatar
dbarbera committed
709
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
710
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
711

Maxime Perrotin's avatar
Maxime Perrotin committed
712
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
713
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
714
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
715

716
    elif isinstance(primary, ogAST.ExprNeg):
Maxime Perrotin's avatar
Maxime Perrotin committed
717
718
719
        warnings.extend(check_type_compatibility(primary.expr,
                                                 type_ref,
                                                 context))
720

dbarbera's avatar
dbarbera committed
721
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
722
        return warnings
723

724
    elif isinstance(primary, ogAST.PrimNull) and is_null(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
725
        return warnings
726

727
728
729
730
    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
731
                return warnings
732
733
734
735
736
737
            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
738
        else:
739
            raise TypeError('Not a type compatible with empty string syntax')
Maxime Perrotin's avatar
Maxime Perrotin committed
740
    elif isinstance(primary, ogAST.PrimSequenceOf) \
741
            and basic_type.kind == 'SequenceOfType':
742
743
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
744
                len(primary.value) > int(basic_type.Max)):
Maxime Perrotin's avatar
Maxime Perrotin committed
745
746
            raise TypeError(str(len(primary.value)) +
                      ' elements in SEQUENCE OF, while constraint is [' +
747
                      str(basic_type.Min) + '..' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
748
        for elem in primary.value:
Maxime Perrotin's avatar
Maxime Perrotin committed
749
750
751
            warnings.extend(check_type_compatibility(elem,
                                                     basic_type.type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
752
753
        if not hasattr(primary, 'expected_type') \
               and type_ref.__name__ not in ('Apnd', 'SubStr'):
754
            primary.expected_type = type_ref
Maxime Perrotin's avatar
Maxime Perrotin committed
755
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
756
    elif isinstance(primary, ogAST.PrimSequence) \
757
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
758
        user_nb_elem = len(primary.value.keys())
759
        type_nb_elem = len(basic_type.Children.keys())
760
761
762
763
764
765
766
767
768
769
770
771
        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)))
772
            elif ufield.lower() not in user_fields:
773
774
775
776
                # Optional field not set - OK
                continue
            else:
                # If the user field is a raw value
777
778
779
780
781
782
                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
783
784
785
786
                    warnings.extend(check_type_compatibility
                                         (primary.value[casefield],
                                          fd_data.type,
                                          context))
Maxime Perrotin's avatar
Maxime Perrotin committed
787
                else:
788
789
                    # Compare the types for semantic equivalence
                    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
790
791
792
                        warnings.extend(compare_types
                                       (primary.value[casefield].exprType,
                                        fd_data.type))
793
                    except TypeError as err:
794
                        raise TypeError('Field "' + ufield + '" not of type ' +
795
796
                                    type_name(fd_data.type) +
                                    ' - ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
797
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
798
    elif isinstance(primary, ogAST.PrimChoiceItem) \
799
800
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
801
802
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
803
804
805
806
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
807
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
808
        # compare primary.value['value']
809
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
810
811
812
813
        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
814
815
816
            warnings.extend(check_type_compatibility(value,
                                                     choice_field_type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
817
818
819
        # Compare the types for semantic equivalence:
        else:
            try:
Maxime Perrotin's avatar
Maxime Perrotin committed
820
821
                warnings.extend(compare_types(value.exprType,
                                              choice_field_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
822
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
823
824
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
825
826
827
828
                            .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
829
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
830
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
831
832
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
833
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
834
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
835
836
837
838
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
839
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
840
841
842

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
843
        basic_type = find_basic_type(type_ref)
844
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
845
            return warnings
846
        elif basic_type.kind.endswith('StringType'):
847
848
849
            try:
                if int(basic_type.Min) <= len(
                        primary.value[1:-1]) <= int(basic_type.Max):
Maxime Perrotin's avatar
Maxime Perrotin committed
850
                    return warnings
851
852
853
854
855
856
857
858
859
                else:
                    raise TypeError('Invalid string literal'
                                    ' - check that length is'
                                    '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
860
                return warnings
861
862
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
863
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
864
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
865
866
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
Maxime Perrotin's avatar
Maxime Perrotin committed
867
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
868
869
870
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
871
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
872
    return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
873

Maxime Perrotin's avatar
Maxime Perrotin committed
874

Maxime Perrotin's avatar
Maxime Perrotin committed
875
def compare_types(type_a, type_b):   # type -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
876
877
878
879
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
880
    warnings = []
881
882
883
884
885
    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
886
887
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
888

Maxime Perrotin's avatar
Maxime Perrotin committed
889
    if type_a == type_b:
Maxime Perrotin's avatar
Maxime Perrotin committed
890
        return warnings
891
892
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
893
        return warnings
894
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
895
        return warnings
896
897
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
898
        return warnings
899
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
900
        return warnings
901

Maxime Perrotin's avatar
Maxime Perrotin committed
902
    # Check if both types have basic compatibility
903
904

    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
905
        if type_a.kind == 'SequenceOfType':
Maxime Perrotin's avatar
Maxime Perrotin committed
906
907
            if mismatch:
                raise TypeError(mismatch)
908
909
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
Maxime Perrotin's avatar
Maxime Perrotin committed
910
911
                    warnings.extend(compare_types(type_a.type, type_b.type))
                    return warnings
912
913
914
915
916
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
            elif(int(type_b.Min) >= int(type_a.Min)
                 and int(type_b.Max) <= int(type_a.Max)):
Maxime Perrotin's avatar
Maxime Perrotin committed
917
918
                warnings.extend(compare_types(type_a.type, type_b.type))
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
919
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
920
921
922
                warnings.extend(compare_types(type_a.type, type_b.type))
                warnings.append('Size constraints mismatch - risk of overflow')
                return warnings
923
        # TODO: Check that OctetString types have compatible range
924
925
926
        elif type_a.kind == 'SequenceType' and mismatch:
            raise TypeError(mismatch)
        elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
927
928
929
            warnings.append(mismatch)
        #print traceback.print_stack()
        return warnings
930
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
931
        return warnings
932
    elif is_integer(type_a) and is_integer(type_b):
933
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
934
935
            warnings.append(mismatch)
        return warnings
936
    elif is_real(type_a) and is_real(type_b):
937
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
938
939
            warnings.append(mismatch)
        return warnings
940
941
942
943
944
    else:
        raise TypeError('Incompatible types {} and {}'.format(
            type_name(type_a),
            type_name(type_b)
        ))
Maxime Perrotin's avatar
Maxime Perrotin committed
945

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

Maxime Perrotin's avatar
Maxime Perrotin committed
949
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
950
951
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
dbarbera's avatar
dbarbera committed
952

Maxime Perrotin's avatar
Maxime Perrotin committed
953
954
955
956
957
958
959
960
    # First check locally, i.e. in FPAR
    try:
        for variable in context.fpar:
            if variable['name'].lower() == var.lower():
                return variable['type']
    except AttributeError:
        # No FPAR section
        pass
961

Maxime Perrotin's avatar
Maxime Perrotin committed
962
963
964
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
965
966
            return vartype

Maxime Perrotin's avatar
Maxime Perrotin committed
967
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
968
        if var.lower() == timer.lower():
969
            return TIMER
Maxime Perrotin's avatar
Maxime Perrotin committed
970

dbarbera's avatar
dbarbera committed
971
972
973
974
975
    # check if is a ASN.1 constant
    for varname, vartype in DV.variables.viewitems():
        if var.lower() == varname.lower().replace('-', '_'):
            return vartype.type

Maxime Perrotin's avatar
Maxime Perrotin committed
976
977
978
    raise AttributeError('Variable {var} not defined'.format(var=var))


979
980
981
def fix_enumerated_and_choice(expr_enum, context):
    ''' If left side of the expression is of Enumerated or Choice type,
        check if right side is a literal of that sort, and update type '''
Maxime Perrotin's avatar
Maxime Perrotin committed
982
    warnings = []
983
    kind = find_basic_type(expr_enum.left.exprType).kind
984
    if kind in ('EnumeratedType', 'StateEnumeratedType'):
985
986
987
988
        prim = ogAST.PrimEnumeratedValue(primary=expr_enum.right)
    elif kind == 'ChoiceEnumeratedType':
        prim = ogAST.PrimChoiceDeterminant(primary=expr_enum.right)
    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
989
990
991
        warnings.extend(check_type_compatibility(prim,
                                                 expr_enum.left.exprType,
                                                 context))
992
993
994
995
        expr_enum.right = prim
        expr_enum.right.exprType = expr_enum.left.exprType
    except (UnboundLocalError, AttributeError, TypeError):
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
996
    return warnings
997
998


Maxime Perrotin's avatar
Maxime Perrotin committed
999
def fix_expression_types(expr, context): # type: -> [warnings]
dbarbera's avatar
dbarbera committed
1000
    ''' Check/ensure type consistency in binary expressions '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1001
    warnings = []
1002
    for _ in range(2):
1003
        # Check if a raw enumerated value is of a reference type
Maxime Perrotin's avatar
Maxime Perrotin committed
1004
        warnings.extend(fix_enumerated_and_choice(expr, context))
1005
1006
        expr.right, expr.left = expr.left, expr.right

1007
1008
1009
1010
1011
1012
1013
    for side in (expr.right, expr.left):
        if side.is_raw:
            raw_expr = side
        else:
            typed_expr = side
            ref_type = typed_expr.exprType

1014
    # If a side is a raw Sequence Of with unknown type, try to resolve it
1015
1016
    for side_a, side_b in permutations(('left', 'right')):
        value = getattr(expr, side_a)  # get expr.left then expr.right
1017
1018
        if not isinstance(value, ogAST.PrimSequenceOf):
            continue
1019
        other = getattr(expr, side_b)  # other side
1020
1021
1022
1023
1024
1025
1026
        basic = find_basic_type(value.exprType)
        if basic.kind == 'SequenceOfType' and basic.type == UNKNOWN_TYPE:
            asn_type = find_basic_type(other.exprType)
            if asn_type.kind == 'SequenceOfType':
                asn_type = asn_type.type
                for idx, elem in enumerate(value.value):
                    check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
1027
                    check_expr.left = ogAST.PrimVariable()
1028
1029
                    check_expr.left.exprType = asn_type
                    check_expr.right = elem
Maxime Perrotin's avatar
Maxime Perrotin committed
1030
                    warnings.extend(fix_expression_types(check_expr, context))
1031
1032
1033
1034
                    value.value[idx] = check_expr.right
            # the type of the raw PrimSequenceOf can be set now
            value.exprType.type = asn_type

1035
    if isinstance(expr, ogAST.ExprIn):
Maxime Perrotin's avatar
Maxime Perrotin committed
1036
        return warnings
1037

1038
    if not expr.right.is_raw and not expr.left.is_raw:
1039
1040
1041
        unknown = [uk_expr for uk_expr in expr.right, expr.left
                   if uk_expr.exprType == UNKNOWN_TYPE]
        if unknown:
1042
            #print traceback.print_stack()
1043
1044
1045
            raise TypeError('Cannot resolve type of "{}"'
                            .format(unknown[0].inputString))

1046
    # In Sequence, Choice and SEQUENCE OF expressions,
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
    # we must fix missing inner types
    # (due to similarities, the following should be refactored FIXME)
    if isinstance(expr.right, ogAST.PrimSequence):
        # left side must have a known type
        asn_type = find_basic_type(expr.left.exprType)
        if asn_type.kind != 'SequenceType':
            raise TypeError('left side must be a SEQUENCE type')
        for field, fd_expr in expr.right.value.viewitems():
            if fd_expr.exprType == UNKNOWN_TYPE:
                try:
                    expected_type = asn_type.Children.get(
dbarbera's avatar
dbarbera committed
1058
                            field.replace('_', '-')).type
1059
1060
1061
                except AttributeError:
                    raise TypeError('Field not found: ' + field)
                check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
1062
                check_expr.left = ogAST.PrimVariable()
1063
1064
                check_expr.left.exprType = expected_type
                check_expr.right = fd_expr
Maxime Perrotin's avatar
Maxime Perrotin committed
1065
                warnings.extend(fix_expression_types(check_expr, context))
1066
1067
1068
1069
1070
1071
1072
1073
                # Id of fd_expr may have changed (enumerated, choice)
                expr.right.value[field] = check_expr.right
    elif isinstance(expr.right, ogAST.PrimChoiceItem):
        asn_type = find_basic_type(expr.left.exprType)
        field = expr.right.value['choice'].replace('_', '-')
        if asn_type.kind != 'ChoiceType' \
                or field.lower() not in [key.lower()
                                  for key in asn_type.Children.viewkeys()]:
1074
            raise TypeError('Field is not valid in CHOICE:' + field)
1075
1076
1077
1078
1079
1080
1081
1082
        key, = [key for key in asn_type.Children.viewkeys()
                if key.lower() == field.lower()]
        if expr.right.value['value'].exprType == UNKNOWN_TYPE:
            try:
                expected_type = asn_type.Children.get(key).type
            except AttributeError:
                raise TypeError('Field not found in CHOICE: ' + field)
            check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
1083
            check_expr.left = ogAST.PrimVariable()
1084
1085
            check_expr.left.exprType = expected_type
            check_expr.right = expr.right.value['value']
Maxime Perrotin's avatar
Maxime Perrotin committed
1086
            warnings.extend(fix_expression_types(check_expr, context))
1087
            expr.right.value['value'] = check_expr.right
1088
1089
1090
1091
1092
1093
1094
    elif isinstance(expr.right, ogAST.PrimConditional):
        for det in ('then', 'else'):
            # Recursively fix possibly missing types in the expression
            check_expr = ogAST.ExprAssign()
            check_expr.left = ogAST.PrimVariable()
            check_expr.left.exprType = expr.left.exprType
            check_expr.right = expr.right.value[det]
Maxime Perrotin's avatar
Maxime Perrotin committed
1095
            warnings.extend(fix_expression_types(check_expr, context))
1096
            expr.right.value[det] = check_expr.right
1097
1098
            # Set the type of "then" and "else" to the reference type:
            expr.right.value[det].exprType = expr.left.exprType
1099
1100

    if expr.right.is_raw != expr.left.is_raw:
Maxime Perrotin's avatar
Maxime Perrotin committed
1101
        warnings.extend(check_type_compatibility(raw_expr, ref_type, context))
1102
1103
1104
1105
        if not raw_expr.exprType.kind.startswith(('Integer',
                                                  'Real',
                                                  'SequenceOf',
                                                  'String')):
Maxime Perrotin's avatar
Maxime Perrotin committed
1106
1107
            # Raw int/real must keep their type because of the range
            # that can be computed
1108
1109
            # Also true for raw SEQOF and String - Min/Max must not change
            # Substrings: CHECKME XXX
1110
1111
1112
            # EDIT: Size of raw SeqOf and Strings is known from looking at
            # the number of elements. Min/Max are irrelevant. In principle
            # removing SequenceOf and String from here should be OK.
Maxime Perrotin's avatar
Maxime Perrotin committed
1113
            raw_expr.exprType = ref_type
1114
    else:
Maxime Perrotin's avatar
Maxime Perrotin committed
1115
1116
        warnings.extend(compare_types(expr.left.exprType, expr.right.exprType))
    return list(set(warnings))