ogParser.py 197 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
#!/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.

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

    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
32
import operator
Maxime Perrotin's avatar
Maxime Perrotin committed
33
34
import logging
import traceback
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
Maxime Perrotin's avatar
Maxime Perrotin committed
48
49
50

LOG = logging.getLogger(__name__)

51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
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
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
INTEGER = type('IntegerType', (object,), {'kind': 'IntegerType',
                                          'Min': str(-(2 ** 63)),
                                          'Max': str(2 ** 63 - 1)})
89
90
91
UNSIGNED = type('IntegerType', (object,), {'kind': 'IntegerType',
                                          'Min': "0",
                                          'Max': str(2 ** 64 - 1)})
Maxime Perrotin's avatar
Maxime Perrotin committed
92
INT32 = type('Integer32Type', (object,), {'kind': 'Integer32Type',
dbarbera's avatar
dbarbera committed
93
94
                                          'Min': '-2147483648',
                                          'Max': '2147483647'})
Maxime Perrotin's avatar
Maxime Perrotin committed
95
96
NUMERICAL = type('NumericalType', (object,), {'kind': 'Numerical'})
TIMER = type('TimerType', (object,), {'kind': 'TimerType'})
97
98
99
REAL = type('RealType', (object,), {'kind': 'RealType',
                                    'Min': str(1e-308),
                                    'Max': str(1e308)})
Maxime Perrotin's avatar
Maxime Perrotin committed
100
101
102
103
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'})
104
105
RAWSTRING = type('RawString', (object,), {'kind': 'StandardStringType',
                                          'Min': '0', 'Max': '255'})
106
OCTETSTRING = type('OctetString', (object,), {'kind': 'OctetStringType'})
107
ENUMERATED = type('EnumeratedType', (object,), {'kind': 'EnumeratedType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
108
109
110

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

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

# Container to keep a list of types mapped from ANTLR Tokens
# (Used with singledispatch/visitor pattern)
ANTLR_TOKEN_TYPES = {a: type(a, (antlr3.tree.CommonTree,), {})
141
                    for a, b in lexer.__dict__.viewitems() if type(b) == int}
Maxime Perrotin's avatar
Maxime Perrotin committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156


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

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

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


157
def set_global_DV(asn1_filenames):
Maxime Perrotin's avatar
Maxime Perrotin committed
158
    # type: (List[str]) -> None
159
160
    ''' Call ASN.1 parser and set the global dataview AST entry (DV) '''
    global DV
161
162
163
164
    if '--toC' in sys.argv:
        rename_policy = ASN1.RenameOnlyConflicting
    else:
        rename_policy = ASN1.NoRename
165
166
167
    try:
        DV = parse_asn1(tuple(asn1_filenames),
                        ast_version=ASN1.UniqueEnumeratedNames,
168
                        rename_policy=rename_policy,
Maxime Perrotin's avatar
Maxime Perrotin committed
169
170
                        flags=[ASN1.AstOnly],
                        pretty_print=True)
171
172
173
174
175
176
177
178
179
    except (ImportError, NameError) as err:
        # Can happen if DataView.py is not there
        LOG.error('Error loading ASN.1 model')
        LOG.debug(str(err))
    except TypeError as err:
        LOG.debug(traceback.format_exc())
        raise TypeError('ASN.1 compiler failed - {}'.format(str(err)))


180
def substring_range(substring):
Maxime Perrotin's avatar
Maxime Perrotin committed
181
    # type: (ogAST.PrimSubstring) -> Tuple[str, str]
182
183
184
185
186
187
188
    ''' Return the range of a substring '''
    left, right = substring.value[1]['substring']
    left_bty = find_basic_type(left.exprType)
    right_bty = find_basic_type(right.exprType)
    return left_bty.Min, right_bty.Max


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


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


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


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


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


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


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


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

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


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


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


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


Maxime Perrotin's avatar
Maxime Perrotin committed
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
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)


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


475
476
477
478
479
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
480

481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
    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)


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

506
    # Special case for write/writeln functions
507
    if name.lower() in ('write', 'writeln'):
508
509
        for p in params:
            p_ty = p.exprType
510
511
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty) or \
                    is_enumerated(p_ty):
512
513
514
                continue
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
Maxime Perrotin's avatar
Maxime Perrotin committed
515
        return UNKNOWN_TYPE
Maxime Perrotin's avatar
Maxime Perrotin committed
516
517
518

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

    # (2) Check that the number of given parameters matches the signature
522
523
524
    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
525

526
527
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
528
        warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
529
        expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
530
        expr.left = ogAST.PrimVariable()
531
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
532
        expr.right = param
533
534

        try:
535
536
537
            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
538
            warnings.extend(fix_expression_types(expr, context))
539
            params[idx] = expr.right
540
        except TypeError as err:
541
542
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
543
544
545
            raise TypeError('In call to {}: Type of parameter {} is incorrect'
                            ' ({}) - {}'
                            .format(name, idx+1, received, str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
546
        if (warnings):
547
548
549
550
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise Warning('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))
551
552

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

557
558
559
    # (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
560
561
562
563
564
565
566
567
        # The implementation of abs in *all* progamming languages returns
        # 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
        return type('Abs', (param_btys[0],), {})
#       return type('Abs', (param_btys[0],), {
#           'Min': str(max(float(param_btys[0].Min), 0)),
#           'Max': str(max(float(param_btys[0].Max), 0))
#       })
568
569
570
571
572
573
574

    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
575
576
577
578
579
580
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
    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':
600
        return type('Length', (INT32,), {
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
            '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
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
    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)))
        })

645
646
647
648
649
650
    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)))
        })

651
652
653
654
655
656
657
    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

658
659
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
660

Maxime Perrotin's avatar
Maxime Perrotin committed
661
662
663
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
664
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
665
666
667
668
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
669
            raise Warning('Expression evaluation in range [{}..{}], '
Maxime Perrotin's avatar
Maxime Perrotin committed
670
                          'could be outside expected range [{}..{}]'
Maxime Perrotin's avatar
Maxime Perrotin committed
671
672
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
673
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
674
675
676
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
def fix_append_expression_type(expr, expected_type):
    ''' In an Append expression, all components must be of the same type,
        which is the type expected by the user of the append, for example 
        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
    '''
    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)
            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
697
def check_type_compatibility(primary, type_ref, context):  # type: -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
698
699
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
700
        is compatible with a given type (type_ref is an ASN1Scc type)
701
        Possibly returns a list of warnings; can raises TypeError
Maxime Perrotin's avatar
Maxime Perrotin committed
702
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
703
    warnings = []    # function returns a list of warnings
704
705
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
706
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
707
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
708

709
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
710
711

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
712
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
713
714
715
        # 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
716
717
718
719
        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
720
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
721
        else:
722
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
723
                   '" not in this enumeration: ' +
724
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
725
            raise TypeError(err)
726
727
728
729
730
731
    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
732
733
734
735
                warnings.extend(check_type_compatibility(expr,
                                                         type_ref,
                                                         context))
        return warnings
736

737
    elif isinstance(primary, (ogAST.PrimVariable, ogAST.PrimSelector)):
Maxime Perrotin's avatar
Maxime Perrotin committed
738
        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
739
            warnings.extend(compare_types(primary.exprType, type_ref))
Maxime Perrotin's avatar
Maxime Perrotin committed
740
741
742
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
743
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
744
                                    err=str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
745
        return warnings
746

Maxime Perrotin's avatar
Maxime Perrotin committed
747
    elif isinstance(primary, ogAST.PrimInteger) \
dbarbera's avatar
dbarbera committed
748
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
749
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
750

Maxime Perrotin's avatar
Maxime Perrotin committed
751
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
752
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
753
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
754

755
    elif isinstance(primary, ogAST.ExprNeg):
Maxime Perrotin's avatar
Maxime Perrotin committed
756
757
758
        warnings.extend(check_type_compatibility(primary.expr,
                                                 type_ref,
                                                 context))
759

dbarbera's avatar
dbarbera committed
760
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
761
        return warnings
762

763
    elif isinstance(primary, ogAST.PrimNull) and is_null(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
764
        return warnings
765

766
767
768
769
    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
770
                return warnings
771
772
773
774
775
776
            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
777
        else:
778
            raise TypeError('Not a type compatible with empty string syntax')
Maxime Perrotin's avatar
Maxime Perrotin committed
779
    elif isinstance(primary, ogAST.PrimSequenceOf) \
780
            and basic_type.kind == 'SequenceOfType':
781
782
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
783
                len(primary.value) > int(basic_type.Max)):
784
            #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
785
            raise TypeError(str(len(primary.value)) +
786
787
                      ' element(s) in SEQUENCE OF, while constraint is [' +
                      str(basic_type.Min) + ' .. ' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
788
        for elem in primary.value:
Maxime Perrotin's avatar
Maxime Perrotin committed
789
790
791
            warnings.extend(check_type_compatibility(elem,
                                                     basic_type.type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
792
793
        if not hasattr(primary, 'expected_type') \
               and type_ref.__name__ not in ('Apnd', 'SubStr'):
794
            primary.expected_type = type_ref
Maxime Perrotin's avatar
Maxime Perrotin committed
795
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
796
    elif isinstance(primary, ogAST.PrimSequence) \
797
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
798
        user_nb_elem = len(primary.value.keys())
799
        type_nb_elem = len(basic_type.Children.keys())
800
801
802
803
804
805
806
807
808
809
810
811
        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)))
812
            elif ufield.lower() not in user_fields:
813
814
815
816
                # Optional field not set - OK
                continue
            else:
                # If the user field is a raw value
817
818
819
820
821
822
                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
823
824
825
826
                    warnings.extend(check_type_compatibility
                                         (primary.value[casefield],
                                          fd_data.type,
                                          context))
Maxime Perrotin's avatar
Maxime Perrotin committed
827
                else:
828
829
                    # Compare the types for semantic equivalence
                    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
830
831
832
                        warnings.extend(compare_types
                                       (primary.value[casefield].exprType,
                                        fd_data.type))
833
                    except TypeError as err:
834
                        raise TypeError('Field "' + ufield + '" not of type ' +
835
836
                                    type_name(fd_data.type) +
                                    ' - ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
837
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
838
    elif isinstance(primary, ogAST.PrimChoiceItem) \
839
840
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
841
842
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
843
844
845
846
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
847
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
848
        # compare primary.value['value']
849
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
850
851
852
853
        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
854
855
856
            warnings.extend(check_type_compatibility(value,
                                                     choice_field_type,
                                                     context))
Maxime Perrotin's avatar
Maxime Perrotin committed
857
858
859
        # Compare the types for semantic equivalence:
        else:
            try:
Maxime Perrotin's avatar
Maxime Perrotin committed
860
861
                warnings.extend(compare_types(value.exprType,
                                              choice_field_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
862
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
863
864
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
865
866
867
868
                            .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
869
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
870
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
871
872
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
873
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
874
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
875
876
877
878
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
879
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
880
881
882

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
883
        basic_type = find_basic_type(type_ref)
884
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
885
            return warnings
886
        elif basic_type.kind.endswith('StringType'):
887
888
889
            try:
                if int(basic_type.Min) <= len(
                        primary.value[1:-1]) <= int(basic_type.Max):
Maxime Perrotin's avatar
Maxime Perrotin committed
890
                    return warnings
891
892
                else:
                    raise TypeError('Invalid string literal'
Maxime Perrotin's avatar
Maxime Perrotin committed
893
                                    ' - check that length is '
894
895
896
897
898
899
                                    '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
900
                return warnings
901
902
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
903
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
904
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
905
906
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
Maxime Perrotin's avatar
Maxime Perrotin committed
907
        return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
908
909
910
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
911
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
912
    return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
913

Maxime Perrotin's avatar
Maxime Perrotin committed
914

Maxime Perrotin's avatar
Maxime Perrotin committed
915
def compare_types(type_a, type_b):   # type -> [warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
916
917
918
919
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
Maxime Perrotin's avatar
Maxime Perrotin committed
920
    warnings = []
921
922
923
924
925
    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
926
927
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
928

Maxime Perrotin's avatar
Maxime Perrotin committed
929
    if type_a == type_b:
Maxime Perrotin's avatar
Maxime Perrotin committed
930
        return warnings
931
932
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
933
        return warnings
934
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
935
        return warnings
936
937
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
938
        return warnings
939
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
940
        return warnings
941

Maxime Perrotin's avatar
Maxime Perrotin committed
942
    # Check if both types have basic compatibility
943
    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
944
        if type_a.kind == 'SequenceOfType':
Maxime Perrotin's avatar
Maxime Perrotin committed
945
946
            if mismatch:
                raise TypeError(mismatch)
947
948
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
Maxime Perrotin's avatar
Maxime Perrotin committed
949
950
                    warnings.extend(compare_types(type_a.type, type_b.type))
                    return warnings
951
952
953
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
954
955
            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
956
957
                warnings.extend(compare_types(type_a.type, type_b.type))
                return warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
958
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
959
960
961
                warnings.extend(compare_types(type_a.type, type_b.type))
                warnings.append('Size constraints mismatch - risk of overflow')
                return warnings
962
        # TODO: Check that OctetString types have compatible range
963
964
        elif type_a.kind == 'SequenceType' and mismatch:
            raise TypeError(mismatch)
965
        elif type_a.kind == 'IntegerType':
Maxime Perrotin's avatar
Maxime Perrotin committed
966
967
968
            # Detect Signed/Unsigned type mismatch
            min_a, min_b = float(type_a.Min), float(type_b.Min)
            if (min_a >= 0) != (min_b >= 0):
969
970
971
                raise TypeError("Signed vs Unsigned type mismatch " +
                        mismatch)
            elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
972
                warnings.append(mismatch)
973
        elif mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
974
975
976
            warnings.append(mismatch)
        #print traceback.print_stack()
        return warnings
977
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
978
        return warnings
979
    elif is_integer(type_a) and is_integer(type_b):
980
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
981
982
            warnings.append(mismatch)
        return warnings
983
    elif is_real(type_a) and is_real(type_b):
984
        if mismatch:
Maxime Perrotin's avatar
Maxime Perrotin committed
985
986
            warnings.append(mismatch)
        return warnings
987
988
989
990
991
    else:
        raise TypeError('Incompatible types {} and {}'.format(
            type_name(type_a),
            type_name(type_b)
        ))
Maxime Perrotin's avatar
Maxime Perrotin committed
992

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

Maxime Perrotin's avatar
Maxime Perrotin committed
996
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
997
998
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
dbarbera's avatar
dbarbera committed
999

Maxime Perrotin's avatar
Maxime Perrotin committed
1000
1001
1002
1003
1004
1005
1006
1007
    # 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
1008

Maxime Perrotin's avatar
Maxime Perrotin committed
1009
1010
1011
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
1012
1013
            return vartype

Maxime Perrotin's avatar
Maxime Perrotin committed
1014
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
1015
        if var.lower() == timer.lower():
1016
            return TIMER
Maxime Perrotin's avatar
Maxime Perrotin committed
1017

dbarbera's avatar
dbarbera committed
1018
1019
1020
1021
1022
    # 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
1023
1024
1025
    raise AttributeError('Variable {var} not defined'.format(var=var))


1026
1027
1028
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
1029
    warnings = []
1030
    kind = find_basic_type(expr_enum.left.exprType).kind
1031
    if kind in ('EnumeratedType', 'StateEnumeratedType'):
1032
1033
1034
1035
        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
1036
1037
1038
        warnings.extend(check_type_compatibility(prim,
                                                 expr_enum.left.exprType,
                                                 context))
1039
1040
1041
1042
        expr_enum.right = prim
        expr_enum.right.exprType = expr_enum.left.exprType
    except (UnboundLocalError, AttributeError, TypeError):
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
1043
    return warnings
1044
1045


Maxime Perrotin's avatar
Maxime Perrotin committed
1046
def fix_expression_types(expr, context): # type: -> [warnings]
dbarbera's avatar
dbarbera committed
1047
    ''' Check/ensure type consistency in binary expressions '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1048
    warnings = []
1049
    for _ in range(2):
1050
        # Check if a raw enumerated value is of a reference type
Maxime Perrotin's avatar
Maxime Perrotin committed
1051
        warnings.extend(fix_enumerated_and_choice(expr, context))
1052
1053
        expr.right, expr.left = expr.left, expr.right

1054
1055
1056
1057
1058
1059
1060
    for side in (expr.right, expr.left):
        if side.is_raw:
            raw_expr = side
        else:
            typed_expr = side
            ref_type = typed_expr.exprType

1061
    # If a side is a raw Sequence Of with unknown type, try to resolve it
1062
1063
    for side_a, side_b in permutations(('left', 'right')):
        value = getattr(expr, side_a)  # get expr.left then expr.right
1064
1065
        if not isinstance(value, ogAST.PrimSequenceOf):
            continue
1066
        other = getattr(expr, side_b)  # other side
1067
1068
1069
1070
1071
1072
1073
        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
1074
                    check_expr.left = ogAST.PrimVariable()
1075
1076
                    check_expr.left.exprType = asn_type
                    check_expr.right = elem
Maxime Perrotin's avatar
Maxime Perrotin committed
1077
                    warnings.extend(fix_expression_types(check_expr, context))
1078
1079
1080
1081
                    value.value[idx] = check_expr.right
            # the type of the raw PrimSequenceOf can be set now
            value.exprType.type = asn_type

1082
    if isinstance(expr, (ogAST.ExprIn, ogAST.ExprAppend)):
Maxime Perrotin's avatar
Maxime Perrotin committed
1083
        return warnings
1084

1085
    if not expr.right.is_raw and not expr.left.is_raw:
1086
1087
1088
        unknown = [uk_expr for uk_expr in expr.right, expr.left
                   if uk_expr.exprType == UNKNOWN_TYPE]
        if unknown:
1089
            #print traceback.print_stack()
1090
1091
1092
            raise TypeError('Cannot resolve type of "{}"'
                            .format(unknown[0].inputString))

1093
    # In Sequence, Choice and SEQUENCE OF expressions,
1094
1095
1096
    # we must fix missing inner types
    # (due to similarities, the following should be refactored FIXME)
    if isinstance(expr.right, ogAST.PrimSequence):
Maxime Perrotin's avatar
Maxime Perrotin committed
1097
        #print "Left:", type_name(expr.left.exprType), "Right:", expr.right.inputString
1098
1099
1100
1101
1102
        # 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():
Maxime Perrotin's avatar
Maxime Perrotin committed
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
            try:
                for spelling in asn_type.Children:
                    if field.lower().replace('_', '-') == spelling.lower():
                        break
                expected_type = asn_type.Children[spelling].type
            except AttributeError:
                raise TypeError('Field not found: ' + field)
            check_expr = ogAST.ExprAssign()
            check_expr.left = ogAST.PrimVariable()
            check_expr.left.exprType = expected_type
            check_expr.right = fd_expr
            warnings.extend(fix_expression_types(check_expr, context))
            # Id of fd_expr may have changed (enumerated, choice)
            expr.right.value[field] = check_expr.right
1117
1118
1119
1120
1121
1122
    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()]:
1123
            raise TypeError('Field is not valid in CHOICE:' + field)
1124
1125
1126
1127
1128
1129
1130
1131
        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
1132
            check_expr.left = ogAST.PrimVariable()
1133
1134
            check_expr.left.exprType = expected_type
            check_expr.right = expr.right.value['value']
Maxime Perrotin's avatar
Maxime Perrotin committed
1135
            warnings.extend(fix_expression_types(check_expr, context))
1136
            expr.right.value['value'] = check_expr.right
1137
    elif isinstance(expr.right, ogAST.PrimConditional):
Maxime Perrotin's avatar
Maxime Perrotin committed
1138
1139
1140
        # in principle it could also be the left side that is a ternary
        # in which case, its type would be unknown and would need to be
        # set according to the right type.
Maxime Perrotin's avatar
Maxime Perrotin committed
1141
        #print "[Parser] [Conditional] ", expr.right.inputString
1142
1143
1144
1145
1146
1147
        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
1148
            warnings.extend(fix_expression_types(check_expr, context))
1149
            expr.right.value[det] = check_expr.right
1150
1151
            # Set the type of "then" and "else" to the reference type:
            expr.right.value[det].exprType = expr.left.exprType
Maxime Perrotin's avatar
Maxime Perrotin committed
1152
1153
        # We must also set the type of the overal expression to the same
        expr.right.exprType = expr.left.exprType
Maxime Perrotin's avatar
Maxime Perrotin committed
1154
1155
    elif isinstance(expr.right, ogAST.ExprAppend):
        fix_append_expression_type(expr.right, expr.left.exprType)
1156
1157

    if expr.right.is_raw != expr.left.is_raw:
Maxime Perrotin's avatar
Maxime Perrotin committed
1158
        warnings.extend(check_type_compatibility(raw_expr, ref_type, context))
1159
1160
1161
1162
        if not raw_expr.exprType.kind.startswith(('Integer',
                                                  'Real',
                                                  'SequenceOf',
                                                  'String')):
Maxime Perrotin's avatar
Maxime Perrotin committed
1163
1164
            # Raw int/real must keep their type because of the range
            # that can be computed
1165
1166
            # Also true for raw SEQOF and String - Min/Max must not change
            # Substrings: CHECKME XXX
1167
1168
1169
            # 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
1170
            raw_expr.exprType = ref_type
1171
    else:
Maxime Perrotin's avatar
Maxime Perrotin committed
1172
1173
        warnings.extend(compare_types(expr.left.exprType, expr.right.exprType))
    return list(set(warnings))
1174

Maxime Perrotin's avatar
Maxime Perrotin committed
1175

Maxime Perrotin's avatar
Maxime Perrotin committed
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
def expression_list(root, context):
    ''' Parse a list of expression parameters '''
    errors = []
    warnings = []
    result = []
    for param in root.getChildren():
        exp, err, warn = expression(param, context)
        errors.extend(err)
        warnings.extend(warn)
        result.append(exp)
    return result, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1188

dbarbera's avatar
dbarbera committed
1189
1190
def primary_variable(root, context):
    ''' Primary Variable analysis '''
1191
    name = getattr(root.getChild(0), 'text', 'error')
dbarbera's avatar
dbarbera committed
1192
    errors, warnings = [], []
1193
1194
1195
1196
1197
    # Detect reserved keywords
    if name.lower() in ('integer', 'real', 'procedure', 'begin', 'end',
                        'for', 'in', 'out', 'loop'):
        errors.append(u"Use of forbidden keyword for a variable name : {}"
                      .format(name))
dbarbera's avatar
dbarbera committed
1198

1199
    possible_constant = is_asn1constant(name)
1200
    if possible_constant is not None:
dbarbera's avatar
dbarbera committed
1201
        prim = ogAST.PrimConstant()
1202
1203
        prim.constant_c_name = possible_constant.varName
        prim.constant_value = possible_constant.value
dbarbera's avatar
dbarbera committed
1204
1205
1206
1207
    elif is_fpar(name, context):
        prim = ogAST.PrimFPAR()
    else:
        prim = ogAST.PrimVariable()
dbarbera's avatar
dbarbera committed
1208

dbarbera's avatar
dbarbera committed
1209
    prim.value = [name]
dbarbera's avatar
dbarbera committed
1210
1211
1212
1213
1214
    prim.exprType = UNKNOWN_TYPE
    prim.inputString = get_input_string(root)
    prim.tmpVar = tmp()

    try:
dbarbera's avatar
dbarbera committed
1215
        prim.exprType = find_variable_type(name, context)
dbarbera's avatar
dbarbera committed
1216
1217
1218
1219
1220
1221
    except AttributeError:
        pass

    return prim, errors, warnings


dbarbera's avatar
dbarbera committed
1222
1223
1224
1225
def is_fpar(name, context):
    name = name.lower()
    if isinstance(context, ogAST.Procedure):
        for each in context.fpar:
1226
            if each['name'].lower() == name.lower():
dbarbera's avatar
dbarbera committed
1227
1228
1229
1230
1231
1232
                return True
    return False


def is_asn1constant(name):
    name = name.lower().replace('-', '_')
1233
1234
1235
    try:
        for varname, vartype in DV.variables.viewitems():
            if varname.lower().replace('-', '_') == name:
1236
                return vartype
1237
1238
1239
    except AttributeError:
        # Ignore - No DV - e.g. in syntax check mode
        pass
1240
    return None
dbarbera's avatar
dbarbera committed
1241
1242


dbarbera's avatar
dbarbera committed
1243
def binary_expression(root, context):
1244
    ''' Binary expression analysis '''
dbarbera's avatar
dbarbera committed
1245
    errors, warnings = [], []
dbarbera's avatar
dbarbera committed
1246

dbarbera's avatar
dbarbera committed
1247
1248
    ExprNode = EXPR_NODE[root.type]
    expr = ExprNode(
1249
1250
1251
1252
        get_input_string(root),
        root.getLine(),
        root.getCharPositionInLine()
    )
dbarbera's avatar
dbarbera committed
1253
1254
    expr.exprType = UNKNOWN_TYPE
    expr.tmpVar = tmp()
1255
1256
1257
1258
1259
1260
1261
1262
1263

    left, right = root.children
    expr.left, err_left, warn_left = expression(left, context)
    expr.right, err_right, warn_right = expression(right, context)
    errors.extend(err_left)
    warnings.extend(warn_left)
    errors.extend(err_right)
    warnings.extend(warn_right)

1264
    try:
Maxime Perrotin's avatar
Maxime Perrotin committed
1265
        warnings.extend(fix_expression_types(expr, context))
1266
1267
1268
    except (AttributeError, TypeError) as err:
        errors.append(error(root, str(err)))