ogParser.py 142 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
31
32
#!/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
import logging
import traceback
33
from itertools import chain, permutations
Maxime Perrotin's avatar
Maxime Perrotin committed
34
35
36
37
38
39
40
41
import antlr3
import antlr3.tree

import sdl92Lexer as lexer
from sdl92Parser import sdl92Parser

import samnmax
import ogAST
42
from Asn1scc import parse_asn1, ASN1
Maxime Perrotin's avatar
Maxime Perrotin committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

LOG = logging.getLogger(__name__)

OPKIND = {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.PRIMARY: ogAST.Primary}

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

DV = None

# 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.
TMPVAR = 0

# ASN.1 types used to support the signature of special operators
77
78
79
INTEGER = type('IntegerType', (object,), {'kind': 'IntegerType',
                                          'Min': str(-(2 ** 63)),
                                          'Max': str(2 ** 63 - 1)})
Maxime Perrotin's avatar
Maxime Perrotin committed
80
81
82
INT32 = type('Integer32Type', (object,), {'kind': 'Integer32Type',
                                          'Min':'-2147483648',
                                          'Max':'2147483647'})
Maxime Perrotin's avatar
Maxime Perrotin committed
83
84
NUMERICAL = type('NumericalType', (object,), {'kind': 'Numerical'})
TIMER = type('TimerType', (object,), {'kind': 'TimerType'})
85
86
87
REAL = type('RealType', (object,), {'kind': 'RealType',
                                    'Min': str(1e-308),
                                    'Max': str(1e308)})
Maxime Perrotin's avatar
Maxime Perrotin committed
88
89
90
91
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'})
92
RAWSTRING = type('RawString', (object,), {'kind': 'StandardStringType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
93
94
95
96
97
98
99
100
101
102
103

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


# Special SDL operators and signature
SPECIAL_OPERATORS = {'length': [LIST],
                     'write': [ANY_TYPE],
                     'writeln': [ANY_TYPE],
                     'present': [CHOICE],
                     'set_timer': [INTEGER, TIMER],
                     'reset_timer': [TIMER],
104
105
106
107
                     'abs': [NUMERICAL],
                     'float': [NUMERICAL],
                     'fix': [NUMERICAL],
                     'power': [NUMERICAL, INTEGER]}
Maxime Perrotin's avatar
Maxime Perrotin committed
108
109
110
111

# 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,), {})
112
                    for a, b in lexer.__dict__.viewitems() if type(b) == int}
Maxime Perrotin's avatar
Maxime Perrotin committed
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224


# 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', {})


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
    '''
    all_signals = []
    async_signals = []
    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:
225
226
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
227
228
229
            break
    else:
        if isinstance(ast, ogAST.Block):
230
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
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
        else:
            raise TypeError('Process ' + process_name +
                        ' is defined but not not declared in a system')
    # Find in and out signals names using the signalroutes
    for signalroute in process_parent.signalroutes:
        for route in signalroute['routes']:
            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
                found, = [dict(sig) for sig in all_signals
                          if sig['name'] == sig_id]
                found['direction'] = direction
                async_signals.append(found)
    return async_signals, system.procedures


def get_input_string(root):
    ''' Return the input string of a tree node '''
    return token_stream(root).toString(root.getTokenStartIndex(),
            root.getTokenStopIndex())


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)


def find_basic_type(a_type):
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type or UNKNOWN_TYPE
    while basic_type.kind == 'ReferenceType':
        # Find type with proper case in the data view
        for typename in types().viewkeys():
            if typename.lower() == basic_type.ReferencedTypeName.lower():
                basic_type = types()[typename].type
                break
        else:
            raise TypeError('Type "' + type_name(basic_type) +
                            '" was not found in Dataview')
    return basic_type


def is_constant(var):
    ''' Check in ASN.1 modules if var (Primary) is declared as a constant '''
    if var is None:
        return False
    if isinstance(var, ogAST.PrimConstant):
        return True
    if DV and isinstance(var, ogAST.PrimPath):
        for mod in DV.asn1Modules:
            for constant in DV.exportedVariables[mod]:
                if(constant.lower() == var.value[0].lower().replace('_', '-')):
                    LOG.debug('Constant ' + var.inputString + ' found')
                    return True
    return False


def fix_special_operators(op_name, expr_list, context):
    ''' Verify/fix type of special operators parameters '''
305
    if op_name.lower() in ('length', 'present', 'abs', 'float', 'fix'):
Maxime Perrotin's avatar
Maxime Perrotin committed
306
307
308
309
310
        if len(expr_list) != 1:
            raise AttributeError('Only one parameter for the {} operator'
                                 .format(op_name))
        expr = expr_list[0]
        if expr.exprType is UNKNOWN_TYPE:
311
            expr.exprType = find_variable(expr.value[0], context)
Maxime Perrotin's avatar
Maxime Perrotin committed
312
313
314
315
316
317
318
            # XXX should change type to PrimVariable
        basic = find_basic_type(expr.exprType)
        if op_name.lower() == 'length' and basic.kind != 'SequenceOfType' \
                                 and not basic.kind.endswith('StringType'):
            raise TypeError('Length operator works only on strings/lists')
        elif op_name.lower() == 'present' and basic.kind != 'ChoiceType':
            raise TypeError('Present operator works only on CHOICE types')
319
320
321
322
323
324
325
326
327
328
        elif op_name.lower() in ('abs', 'float', 'fix') and not basic.kind in (
                'IntegerType', 'Integer32Type', 'RealType', 'NumericalType'):
            raise TypeError('"{}" operator needs a numerical parameter'.format(
                op_name))
    elif op_name.lower() == 'power':
        if len(expr_list) != 2:
            raise AttributeError('The "power" operator takes two parameters')
        types = {}
        for idx, expr in enumerate(expr_list):
            if expr.exprType is UNKNOWN_TYPE:
329
                expr.exprType = find_variable(expr.value[0], context)
330
331
332
333
334
335
336
                # XXX should change type to PrimVariable
            if idx == 0 and not find_basic_type(expr.exprType).kind in (
                    'IntegerType', 'Integer32Type', 'Numerical', 'RealType'):
                raise TypeError('First parameter of power must be numerical')
            elif idx == 1 and not find_basic_type(expr.exprType).kind in (
                    'IntegerType', 'Integer32Type'):
                raise TypeError('Second parameter of power must be integer')
Maxime Perrotin's avatar
Maxime Perrotin committed
337
338
339
    elif op_name.lower() in ('write', 'writeln'):
        for param in expr_list:
            if param.exprType is UNKNOWN_TYPE:
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
                for each in (INTEGER, REAL, BOOLEAN, RAWSTRING):
                    try:
                        check_type_compatibility(param, each, context)
                        param.exprType = each
                        break
                    except TypeError:
                        continue
                else:
                    # Type not found among supported types
                    # Has to be a variable...otherwise, error!
                    try:
                        param.exprType = find_variable(param.value[0], context)
                    except KeyError, AttributeError:
                        raise TypeError('Could not determine type of argument'
                                        ' "{}"'.format(param.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
355
356
357
358
359
360
            basic = find_basic_type(param.exprType)
            if basic.kind not in ('IntegerType', 'Integer32Type',
                                  'RealType', 'BooleanType') \
                                and not basic.kind.endswith('StringType'):
                # Currently supported printable types
                raise TypeError('Write operator does not support type')
Maxime Perrotin's avatar
Maxime Perrotin committed
361
362
363
364
365
366
367
    elif op_name.lower() == 'set_timer':
        if len(expr_list) != 2:
            raise TypeError('SET_TIMER has 2 parameters: (int, timer_name)')
        basic = find_basic_type(expr_list[0].exprType)
        if not basic.kind.startswith('Integer'):
            raise TypeError('SET_TIMER first parameter is not an integer')
        timer = expr_list[1].inputString
Maxime Perrotin's avatar
Maxime Perrotin committed
368
        for each in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
369
370
371
372
373
374
375
376
377
378
379
380
381
            if each.lower() == timer.lower():
                break
        else:
            raise TypeError('Timer {} is not defined'.format(timer))
    elif op_name.lower == 'reset_timer':
        if len(expr_list) != 1:
            raise TypeError('RESET_TIMER has 1 parameter: timer_name')
        timer = expr_list[0].inputString
        for each in context.timers:
            if each.lower() == timer.lower():
                break
        else:
            raise TypeError('Timer {} is not defined'.format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
    else:
        # TODO: other operators
        return


def check_and_fix_op_params(op_name, expr_list, context):
    '''
        Verify and/or set the type of a procedure/output parameters
        TODO: when supported, add operators
    '''
    # (1) Find the signature of the function
    # signature will hold the list of parameters for the function
    LOG.debug('[check_and_fix_op_params] ' + op_name + ' - ' + str(expr_list))
    signature = []
    key = ''

    for out_sig in context.output_signals:
        if out_sig['name'].lower() == op_name.lower():
            if out_sig.get('type'):
                # output signals: one single parameter
                signature = [{'type': out_sig.get('type'),
                              'name': out_sig.get('param_name' or ''),
                              'direction': 'in'}]
            break
    else:
        # Procedures (inner and external)
408
        for inner_proc in context.procedures:
Maxime Perrotin's avatar
Maxime Perrotin committed
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
            key = inner_proc.inputString
            if key.lower() == op_name.lower():
                signature = inner_proc.fpar
                break
        else:
            if op_name.lower() not in SPECIAL_OPERATORS:
                raise AttributeError('Operator/output/procedure not found: '
                    + op_name)
            else:
                # Special operators: parameters are context dependent
                fix_special_operators(op_name, expr_list, context)
                return
    # (2) Check that the number of given parameters matches the signature
    if signature is not None and len(signature) != len(expr_list):
        raise TypeError('Wrong number of parameters')
    # (3) Check each individual parameter type
    for idx, param in enumerate(expr_list):
        if signature is None:
            break
        # Get parameter type name from the function signature:
        param_type = type_name(signature[idx].get('type'))
        # Retrieve the type (or None if it is a sepecial operator)
        dataview_entry = types().get(param_type) or UNKNOWN_TYPE
        if dataview_entry is not UNKNOWN_TYPE:
            dataview_type = new_ref_type(param_type)
        else:
            dataview_type = UNKNOWN_TYPE

        expr = ogAST.ExprAssign()
        expr.left = ogAST.PrimPath()
        expr.left.exprType = dataview_type
        expr.right = param
        fix_expression_types(expr, context)
        expr_list[idx] = expr.right
443
444
445
446
        if signature[idx].get('direction') != 'in' \
                and not isinstance(expr.right, ogAST.PrimVariable):
            raise TypeError('OUT parameter "{}" is not a variable'
                            .format(expr.right.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
447
448


Maxime Perrotin's avatar
Maxime Perrotin committed
449
450
451
452
453
454
455
456
457
458
459
460
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
        both types assumed to be basic types 
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
            raise TypeError('Expression evaluation in range [{}..{}], '
                            'outside expected range [{}..{}]'
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
461
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
462
463
464
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
def check_type_compatibility(primary, typeRef, context):
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
        is compatible with a given type (typeRef is an ASN1Scc type)
        Does not return anything if OK, otherwise raises TypeError
    '''
    assert typeRef is not None
    if typeRef is UNKNOWN_TYPE:
        raise TypeError('Type reference is unknown')
    if isinstance(primary, ogAST.PrimConstant):
        # ASN.1 constants type is unknown (Asn1 backend to be completed)
        return
    actual_type = find_basic_type(typeRef)
    LOG.debug("[check_type_compatibility] "
              "checking if {value} is of type {typeref}: "
              .format(value=primary.inputString, typeref=type_name(typeRef)))

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
            and actual_type.kind.endswith('EnumeratedType')):
        # 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
        enumerant = primary.inputString.replace('_', '-')
        corr_type = actual_type.EnumValues.get(enumerant)
        if corr_type:
            return
        else:
492
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
                   '" not in this enumeration: ' +
                   str(actual_type.EnumValues.keys()))
            raise TypeError(err)
    elif isinstance(primary, ogAST.PrimIfThenElse):
        # check that IF expr returns BOOL, and that Then and Else expressions
        # are compatible with actual_type
        if_expr = primary.value['if']
        then_expr = primary.value['then']
        else_expr = primary.value['else']
        if if_expr.exprType.kind != 'BooleanType':
            raise TypeError('IF expression does not return a boolean')
        else:
            for expr in (then_expr, else_expr):
                if expr.is_raw:
                    check_type_compatibility(expr, typeRef, context)
                # compare the types for semantic equivalence:
                else:
510
511
512
513
514
515
                    if expr.exprType is UNKNOWN_TYPE:
                        # If it was not resolved before, it must be a variable
                        # this can happen in the context of a special operator
                        # (write), where at no point before where the type
                        # could be compared to another type
                        expr.exprType = find_variable(expr.value[0], context)
Maxime Perrotin's avatar
Maxime Perrotin committed
516
517
518
519
520
521
522
523
524
525
526
527
528
529
                    compare_types(expr.exprType, typeRef)
        return
    elif isinstance(primary, ogAST.PrimVariable):
        try:
            compare_types(primary.exprType, typeRef)
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
                                    ty=type_name(typeRef),
                                    err=str(err)))
        return
    elif isinstance(primary, ogAST.PrimInteger) \
            and actual_type.kind.startswith('Integer'):
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
530

Maxime Perrotin's avatar
Maxime Perrotin committed
531
532
533
    elif isinstance(primary, ogAST.PrimReal) \
            and actual_type.kind.startswith('Real'):
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
534

Maxime Perrotin's avatar
Maxime Perrotin committed
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
    elif isinstance(primary, ogAST.PrimBoolean) \
            and actual_type.kind.startswith('Boolean'):
        return
    elif (isinstance(primary, ogAST.PrimEmptyString) and
                                         actual_type.kind == 'SequenceOfType'):
        if int(actual_type.Min) == 0:
            return
        else:
            raise TypeError('SEQUENCE OF has a minimum size of '
                            + actual_type.Min + ')')
    elif isinstance(primary, ogAST.PrimSequenceOf) \
            and actual_type.kind == 'SequenceOfType':
        if (len(primary.value) < int(actual_type.Min) or
                len(primary.value) > int(actual_type.Max)):
            raise TypeError(str(len(primary.value)) +
                      ' elements in SEQUENCE OF, while constraint is [' +
                      str(actual_type.Min) + '..' + str(actual_type.Max) + ']')
        for elem in primary.value:
            check_type_compatibility(elem, actual_type.type, context)
        return
    elif isinstance(primary, ogAST.PrimSequence) \
            and actual_type.kind == 'SequenceType':
        user_nb_elem = len(primary.value.keys())
        type_nb_elem = len(actual_type.Children.keys())
        if user_nb_elem != type_nb_elem:
            raise TypeError('Wrong number of fields in SEQUENCE of type {}'
                            .format(type_name(typeRef)))
        else:
            for field, fd_data in actual_type.Children.viewitems():
                ufield = field.replace('-', '_')
                if ufield not in primary.value:
                    raise TypeError('Missing field {field} in SEQUENCE'
                                    ' of type {t1} '
                                    .format(field=ufield,
                                            t1=type_name(typeRef)))
                else:
                    # If the user field is a raw value
                    if primary.value[ufield].is_raw:
                        check_type_compatibility(primary.value[ufield],
                                                 fd_data.type, context)
                    else:
                        # Compare the types for semantic equivalence
                        try:
Maxime Perrotin's avatar
Maxime Perrotin committed
578
579
                            compare_types(
                                  primary.value[ufield].exprType, fd_data.type)
Maxime Perrotin's avatar
Maxime Perrotin committed
580
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
                        except TypeError as err:
                            raise TypeError('Field ' + ufield +
                                        ' is not of the proper type, i.e. ' +
                                        type_name(fd_data.type) +
                                        ' - ' + str(err))
        return
    elif isinstance(primary, ogAST.PrimChoiceItem) \
                              and actual_type.kind.startswith('Choice'):
        for choicekey, choice in actual_type.Children.viewitems():
            if choicekey.lower() == primary.value['choice'].lower():
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
                            t1=type_name(typeRef)))
        # compare primary.value['value']
        # with actual_type['Children'][primary.choiceItem['choice']]
        value = primary.value['value']
        choice_field_type = choice.type
        # if the user field is a raw value:
        if value.is_raw:
            check_type_compatibility(value, choice_field_type, context)
        # Compare the types for semantic equivalence:
        else:
            try:
                compare_types(value.exprType, choice_field_type)
            except TypeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
607
608
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
                            .format(field=primary.value['choice'],
                                    t1=type_name(choice_field_type),
                                    e=str(err)))
        value.exprType = choice_field_type         # XXX
        return
    elif isinstance(primary, ogAST.PrimChoiceDeterminant) \
                                     and actual_type.kind.startswith('Choice'):
        for choicekey, choice in actual_type.EnumValues.viewitems():
            if choicekey.replace('-', '_').lower() == \
                                                   primary.inputString.lower():
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
                            t1=type_name(typeRef)))

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
        basic_type = find_basic_type(typeRef)
628
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
629
            return
630
631
632
633
634
635
636
        elif basic_type.kind.endswith('StringType'):
            if int(basic_type.Min) <= len(
                          primary.value[1:-1]) <= int(basic_type.Max):
                return
            else:
                raise TypeError('Invalid string literal - check that length is'
                                'within the bound limits {Min}..{Max}'.format
Maxime Perrotin's avatar
Maxime Perrotin committed
637
                            (Min=str(basic_type.Min), Max=str(basic_type.Max)))
638
639
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
640
641
642
643
644
645
646
647
648
649
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
                                            actual_type.kind == 'RealType'):
        LOG.debug('PROBABLY (it is a float but I did not check'
                  'if values are compatible)')
        return
    else:
        raise TypeError('{prim} does not match type {t1}'
                        .format(prim=primary.inputString,
                                t1=type_name(typeRef)))

Maxime Perrotin's avatar
Maxime Perrotin committed
650

Maxime Perrotin's avatar
Maxime Perrotin committed
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
def compare_types(type_a, type_b):
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
    LOG.debug('[compare_types]' + str(type_a) + ' and ' + str(type_b) + ': ')
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
    if type_a == type_b:
        return
    # Check if both types have basic compatibility
    simple_types = [elem for elem in (type_a, type_b) if elem.kind in
                       ('IntegerType', 'BooleanType', 'RealType', 'StringType',
                        'SequenceOfType', 'Integer32Type', 'OctetStringType')]
    if len(simple_types) < 2:
        # Either A or B is not a basic type - cannot be compatible
        raise TypeError('One of the types is not a basic type: '
                + type_name(type_a) + ' or ' + type_name(type_b))
    elif type_a.kind == type_b.kind:
        if type_a.kind == 'SequenceOfType':
            if type_a.Min == type_b.Min and type_a.Max == type_b.Max:
                compare_types(type_a.type, type_b.type)
                return
            else:
                raise TypeError('Incompatible arrays')
        return
    elif type_a.kind.endswith('StringType') and type_b.kind.endswith(
                                                                 'StringType'):
        # Allow Octet String values to be printable strings.. for convenience
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
681
682
683
684
685
686
687
    elif not(type_a.kind in ('IntegerType', 'Integer32Type') and
             type_b.kind in ('IntegerType', 'Integer32Type')):
        raise TypeError('One type is an integer, not the other one')
    elif any(side.kind == 'RealType' for side in (type_a, type_b)):
        raise TypeError('One type is an REAL, not the other one')
    elif all(side.kind.startswith('Integer') for side in (type_a, type_b)) \
            or all(side.kind == 'RealType' for side in (type_a, type_b)):
Maxime Perrotin's avatar
Maxime Perrotin committed
688
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
689
690
691
692
693
694
695
696
697
    else:
        return


def find_variable(var, context):
    ''' Look for a variable name in the context and return its type '''
    result = UNKNOWN_TYPE
    LOG.debug('[find_variable] checking if ' + str(var) + ' is defined')
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
698
699
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
Maxime Perrotin's avatar
Maxime Perrotin committed
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
    # First check locally, i.e. in FPAR
    try:
        for variable in context.fpar:
            if variable['name'].lower() == var.lower():
                LOG.debug(str(var) + ' is defined')
                return variable['type']
    except AttributeError:
        # No FPAR section
        pass
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
            result = vartype
            LOG.debug(str(var) + ' is defined')
            return result
Maxime Perrotin's avatar
Maxime Perrotin committed
715
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
        if var.lower() == timer.lower():
            LOG.debug(str(var) + ' is defined')
            return result

    LOG.debug('[find_variable] result: not found, raising exception')
    raise AttributeError('Variable {var} not defined'.format(var=var))


def find_type(path, context):
    '''
        Determine the type of an element using the data model,
        and the list of variables, operators and procedures
        path must contain either an index or parameters, it is not possible
        with this function to find the type of a single variable, because
        it is context-dependent (the name of a variable may conflict with the
        name of a enumeration item or a choice determinant)
    '''
    result = UNKNOWN_TYPE
    assert len(path) > 1, str(path)
    if not DV:
736
        raise AttributeError('Dataview is required to process types')
Maxime Perrotin's avatar
Maxime Perrotin committed
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
    LOG.debug('[find_type] ' + str(path))
    # First, find the type of the main element
    main = path[0]
    v, o = None, None
    # Try to find the name in the variables list
    try:
        result = find_variable(main, context)
    except AttributeError:
        for o in context.operators.viewkeys():
            # Case insensitive comparison with operators
            if main.lower() == o.lower():
                result = new_ref_type(context.operators[o])
                break
        else:
            if main.lower() in SPECIAL_OPERATORS:
Maxime Perrotin's avatar
Maxime Perrotin committed
752
753
754
755
756
757
758
759
760
761
762
                param = path[1].get('procParams') or []
                if not param:
                    raise TypeError('Missing parameter in {} operator call'
                                    .format(main))
                # Retrieve type of first parameter - all operators need it
                first_param = param[0]
                first_type = find_variable(first_param.inputString, context)\
                                 if first_param.exprType == UNKNOWN_TYPE else \
                                 first_param.exprType
                first_basic = find_basic_type(first_type)

Maxime Perrotin's avatar
Maxime Perrotin committed
763
764
765
766
767
768
769
                # Special operators require type elaboration
                if main.lower() == 'present':
                    result = type('present', (object,),
                                   {'kind': 'ChoiceEnumeratedType',
                                   'EnumValues': {}})
                    # present(choiceType): must return an enum
                    # with elements being the choice options
Maxime Perrotin's avatar
Maxime Perrotin committed
770
771
772
773
774
775
                    if len(param) != 1:
                        raise TypeError('Wrong number of parameters in '
                                        'PRESENT clause (only one expected)')
                    if first_basic.kind != 'ChoiceType':
                        raise TypeError('PRESENT parameter'
                                     ' must be a CHOICE type:' + str(path))
Maxime Perrotin's avatar
Maxime Perrotin committed
776
                    else:
Maxime Perrotin's avatar
Maxime Perrotin committed
777
778
779
780
781
782
783
784
                        result.EnumValues = first_basic.Children
                elif main.lower() in ('length', 'fix'):
                    if len(param) != 1:
                        raise TypeError('Wrong number of parameters in {} '
                                        'operator'.format(main))
                    # result is an integer type with range of the param type
                    result = type('fix', (INTEGER,), {'Min': first_basic.Min,
                                                      'Max': first_basic.Max})
785
                elif main.lower() == 'float':
Maxime Perrotin's avatar
Maxime Perrotin committed
786
787
788
789
790
                    if len(param) != 1:
                        raise TypeError('Wrong number of parameters in {} '
                                        'operator'.format(main))
                    result = type('float_op', (REAL,), {'Min': first_basic.Min,
                                                       'Max': first_basic.Max})
791
                elif main.lower() == 'power':
Maxime Perrotin's avatar
Maxime Perrotin committed
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
                    second = param[1]
                    second_type = find_variable(second.inputString, context)\
                                  if second.exprType == UNKNOWN_TYPE else \
                                  second.exprType
                    second_basic = find_basic_type(second_type)
                    try:
                        result = type('Power', (first_basic,),
                                {'Min':str(pow(float(first_basic.Min),
                                    float(second_basic.Min))),
                                 'Max':str(pow(float(first_basic.Max),
                                    float(second_basic.Max)))})
                    except OverflowError:
                        raise TypeError('Result can exceeds 64-bits')
                elif main.lower() == 'abs':
                    result = type('Abs', (first_basic,),
                            {'Min':str(max(float(first_basic.Min), 0)),
                             'Max':str(max(float(first_basic.Max), 0))})
Maxime Perrotin's avatar
Maxime Perrotin committed
809
                else:  # write and writeln return void
Maxime Perrotin's avatar
Maxime Perrotin committed
810
811
812
813
814
                    pass
    if result.kind == 'ReferenceType':
        # We have more than one element and the first one is of type 'result'
        # Iterate over the path to get the type of the last element
        for elem in path[1:]:
815
            basic = find_basic_type(result)
Maxime Perrotin's avatar
Maxime Perrotin committed
816
817
818
819
820
821
            if 'procParams' in elem:
                # Discard operator parameters: they do not change the type
                continue
            # Sequence, Choice (case insensitive)
            if basic.kind in ('SequenceType', 'ChoiceType'):
                if 'index' in elem:
822
823
                    raise TypeError('Element {} cannot have an index'
                                    .format(path[0]))
Maxime Perrotin's avatar
Maxime Perrotin committed
824
825
826
827
828
829
                elem_asn1 = elem.replace('_', '-').lower()
                type_idx = [c for c in basic.Children
                            if c.lower() == elem_asn1]
                if type_idx:
                    result = basic.Children[type_idx[0]].type
                else:
830
831
832
                    raise TypeError('Field ' + elem
                                     + ' not found in expression '
                                     + '!'.join(path))
Maxime Perrotin's avatar
Maxime Perrotin committed
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
                    break
            # Sequence of
            elif basic.kind == 'SequenceOfType':
                # Can be an index or a substring
                if 'index' in elem:
                    # Index - change to the type of the Seqof elements
                    result = basic.type
                elif 'substring' in elem:
                    # Don't change the type, still a SEQUENCE OF
                    # XXX Size may differ
                    pass
            elif basic.kind == 'EnumeratedType':
                pass
            elif basic.kind.endswith('StringType'):
                # Can be an index or a substring
                if 'index' in elem:
849
                    raise TypeError('Index on a string is not supported')
Maxime Perrotin's avatar
Maxime Perrotin committed
850
851
852
853
854
                elif 'substring' in elem:
                    # don't change type, returns a string
                    # XXX Size may differ
                    pass
            else:
855
856
                raise TypeError('Incorrect field or index')
    return result
Maxime Perrotin's avatar
Maxime Perrotin committed
857
858


859
860
861
862
863
864
865
866
867
868
869
870
871
def fix_expression_types(expr, context):
    ''' Check/ensure type consistency in expressions having two sides '''
    if isinstance(expr, ogAST.Primary):
        return

    for side in ('left', 'right'):
        # Determine if the expression is a variable
        uk_expr = getattr(expr, side)
        if uk_expr.exprType == UNKNOWN_TYPE \
                and isinstance(uk_expr, ogAST.PrimPath) \
                and len(uk_expr.value) == 1:
            try:
                exprType = find_variable(uk_expr.value[0], context)
Maxime Perrotin's avatar
Maxime Perrotin committed
872
873
874
875
876
877
878
879
                # Differentiate DCL and FPAR variables
                use_type = ogAST.PrimVariable
                if isinstance(context, ogAST.Procedure):
                    for each in context.fpar:
                        if each['name'].lower() == uk_expr.value[0].lower():
                            use_type = ogAST.PrimFPAR
                            break
                setattr(expr, side, use_type(primary=uk_expr))
880
881
882
883
                getattr(expr, side).exprType = exprType
            except AttributeError:
                pass

884
    # If a side of the expression is of Enumerated or Choice type, check if
885
    # the other side is a literal of that sort, and change type accordingly
886
    for side in permutations(('left', 'right')):
887
888
889
890
891
892
893
894
895
896
897
898
899
900
        side_type = find_basic_type(getattr(expr, side[0]).exprType).kind
        if side_type == 'EnumeratedType':
            prim = ogAST.PrimEnumeratedValue(primary=getattr(expr, side[1]))
        elif side_type == 'ChoiceEnumeratedType':
            prim = ogAST.PrimChoiceDeterminant(primary=getattr(expr, side[1]))
        try:
            check_type_compatibility(prim, getattr(expr, side[0]).exprType,
                                     context)
            setattr(expr, side[1], prim)
            getattr(expr, side[1]).exprType = getattr(expr, side[0]).exprType
        except (UnboundLocalError, AttributeError, TypeError):
            pass

    # If a side type remains unknown, check if it is an ASN.1 constant
901
    for side in permutations(('left', 'right')):
902
903
904
905
906
907
908
909
910
911
912
913
        value = getattr(expr, side[0])
        if value.exprType == UNKNOWN_TYPE and is_constant(value):
            setattr(expr, side[0], ogAST.PrimConstant(primary=value))
            getattr(expr, side[0]).exprType = getattr(expr, side[1]).exprType

    for side in (expr.right, expr.left):
        if side.is_raw:
            raw_expr = side
        else:
            typed_expr = side
            ref_type = typed_expr.exprType

914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
    # If a side is a raw Sequence Of with unknown type, try to resolve it
    for side in permutations(('left', 'right')):
        value = getattr(expr, side[0])  # get expr.left then expr.right
        if not isinstance(value, ogAST.PrimSequenceOf):
            continue
        other = getattr(expr, side[1])  # other side
        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()
                    check_expr.left = ogAST.PrimPath()
                    check_expr.left.exprType = asn_type
                    check_expr.right = elem
                    fix_expression_types(check_expr, context)
                    value.value[idx] = check_expr.right
            # the type of the raw PrimSequenceOf can be set now
            value.exprType.type = asn_type


936
937
938
939
940
941
942
943
944
945
946
    # Type check that is specific to IN expressions
    if isinstance(expr, ogAST.ExprIn):
        # check that left part is a SEQUENCE OF or a string
        container_basic_type = find_basic_type(expr.left.exprType)
        if container_basic_type.kind == 'SequenceOfType':
            ref_type = container_basic_type.type
        elif container_basic_type.kind.endswith('StringType'):
            ref_type = container_basic_type
        else:
            raise TypeError('IN expression: right part must be a list')
        compare_types(expr.right.exprType, ref_type)
947
948
949
950
951
952
953
954
955
956
957
958
959
960
        if expr.right.is_raw == expr.left.is_raw == True:
            # If both sides are raw (e.g. "3 in {1,2,3}"), evaluate expression
            bool_expr = ogAST.PrimBoolean()
            bool_expr.inputString = expr.inputString
            bool_expr.line = expr.line
            bool_expr.charPositionInLine = expr.charPositionInLine
            bool_expr.exprType = type('PrBool', (object,),
                                      {'kind': 'BooleanType'})
            if expr.right.value in [each.value for each in expr.left.value]:
                bool_expr.value = ['true']
                raise Warning('Expression is always true', bool_expr)
            else:
                bool_expr.value = ['false']
                raise Warning('Expression is always false', bool_expr)
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
        return

    if expr.right.is_raw == expr.left.is_raw == False:
        unknown = [uk_expr for uk_expr in expr.right, expr.left
                   if uk_expr.exprType == UNKNOWN_TYPE]
        if unknown:
            raise TypeError('Cannot resolve type of "{}"'
                            .format(unknown[0].inputString))

    # In Sequence, Choice, SEQUENCE OF, and IfThenElse expressions,
    # 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(
                                                 field.replace('_', '-')).type
                except AttributeError:
                    raise TypeError('Field not found: ' + field)
                check_expr = ogAST.ExprAssign()
                check_expr.left = ogAST.PrimPath()
                check_expr.left.exprType = expected_type
                check_expr.right = fd_expr
                fix_expression_types(check_expr, context)
                # 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()]:
998
            raise TypeError('Field is not valid in CHOICE:' + field)
999
1000
        key, = [key for key in asn_type.Children.viewkeys()
                if key.lower() == field.lower()]