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


"""
    OpenGEODE SDL92 parser

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

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

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

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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

__author__ = 'Maxime Perrotin'

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

import sdl92Lexer as lexer
from sdl92Parser import sdl92Parser

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

LOG = logging.getLogger(__name__)

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

# 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
84
85
86
INTEGER = type('IntegerType', (object,), {'kind': 'IntegerType',
                                          'Min': str(-(2 ** 63)),
                                          'Max': str(2 ** 63 - 1)})
Maxime Perrotin's avatar
Maxime Perrotin committed
87
INT32 = type('Integer32Type', (object,), {'kind': 'Integer32Type',
dbarbera's avatar
dbarbera committed
88
89
                                          'Min': '-2147483648',
                                          'Max': '2147483647'})
Maxime Perrotin's avatar
Maxime Perrotin committed
90
91
NUMERICAL = type('NumericalType', (object,), {'kind': 'Numerical'})
TIMER = type('TimerType', (object,), {'kind': 'TimerType'})
92
93
94
REAL = type('RealType', (object,), {'kind': 'RealType',
                                    'Min': str(1e-308),
                                    'Max': str(1e308)})
Maxime Perrotin's avatar
Maxime Perrotin committed
95
96
97
98
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'})
99
100
RAWSTRING = type('RawString', (object,), {'kind': 'StandardStringType',
                                          'Min': '0', 'Max': '255'})
101
OCTETSTRING = type('OctetString', (object,), {'kind': 'OctetStringType'})
102
ENUMERATED = type('EnumeratedType', (object,), {'kind': 'EnumeratedType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
103
104
105

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

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

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


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


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


173
174
175
176
177
178
179
180
def substring_range(substring):
    ''' 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
181
182
183
184
185
186
187
188
def is_integer(ty):
    ''' Return true if a type is an Integer Type '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type'
    )


189
190
191
192
193
def is_real(ty):
    ''' Return true if a type is a Real Type '''
    return find_basic_type(ty).kind == 'RealType'


194
def is_numeric(ty):
dbarbera's avatar
dbarbera committed
195
    ''' Return true if a type is a Numeric Type '''
196
197
198
199
200
201
202
203
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type',
        'Numerical',
        'RealType'
    )


204
205
206
207
208
def is_boolean(ty):
    ''' Return true if a type is a Boolean Type '''
    return find_basic_type(ty).kind == 'BooleanType'


dbarbera's avatar
dbarbera committed
209
210
211
212
def is_string(ty):
    ''' Return true if a type is a String Type '''
    return find_basic_type(ty).kind in (
        'StandardStringType',
213
214
        'OctetStringType',
        'StringType'
dbarbera's avatar
dbarbera committed
215
216
217
    )


218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
def is_sequenceof(ty):
    ''' Return true if a type is a SequenceOf Type '''
    return find_basic_type(ty).kind == 'SequenceOfType'


def is_list(ty):
    ''' Return true if a type is a List Type '''
    return is_string(ty) or is_sequenceof(ty) or ty == LIST


def is_enumerated(ty):
    ''' Return true if a type is an Enumerated Type '''
    return find_basic_type(ty).kind == 'EnumeratedType' or ty == ENUMERATED


def is_sequence(ty):
    ''' Return true if a type is a Sequence Type '''
    return find_basic_type(ty).kind == 'SequenceType'


def is_choice(ty):
    ''' Return true if a type is a Choice Type '''
    return find_basic_type(ty).kind == 'ChoiceType' or ty == CHOICE


def is_timer(ty):
    ''' Return true if a type is a Timer Type '''
    return find_basic_type(ty).kind == 'TimerType'


Maxime Perrotin's avatar
Maxime Perrotin committed
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
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
    '''
328
    all_signals, async_signals, errors = [], [], set()
Maxime Perrotin's avatar
Maxime Perrotin committed
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
    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:
344
345
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
346
347
348
            break
    else:
        if isinstance(ast, ogAST.Block):
349
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
350
351
        else:
            raise TypeError('Process ' + process_name +
352
                        ' is defined but not declared in a system')
Maxime Perrotin's avatar
Maxime Perrotin committed
353
    # Find in and out signals names using the signalroutes
354
    undeclared_signals = []
355
356
    for each in process_parent.signalroutes:
        for route in each['routes']:
Maxime Perrotin's avatar
Maxime Perrotin committed
357
358
359
360
361
362
363
364
            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
365
366
                try:
                    found, = [dict(sig) for sig in all_signals
367
                              if sig['name'].lower() == sig_id.lower()]
368
369
370
                    found['direction'] = direction
                    async_signals.append(found)
                except ValueError:
371
                    undeclared_signals.append(sig_id)
372
                except (KeyError, AttributeError) as err:
373
374
375
376
377
378
                    # 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')
379
    if undeclared_signals:
380
381
        errors.add('Missing declaration for signal(s) {}'
                   .format(', '.join(undeclared_signals)))
382
    return async_signals, system.procedures, errors
Maxime Perrotin's avatar
Maxime Perrotin committed
383
384
385
386
387
388
389
390


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
391
392
def error(root, msg):
    ''' Return an error message '''
393
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
394
395
396
397


def warning(root, msg):
    ''' Return a warning message '''
398
    return '{} - "{}"'.format(msg, get_input_string(root))
dbarbera's avatar
dbarbera committed
399
400


dbarbera's avatar
dbarbera committed
401
402
403
404
405
406
407
408
def tmp():
    ''' Return a temporary variable name '''
    global TMPVAR
    varname = TMPVAR
    TMPVAR += 1
    return varname


Maxime Perrotin's avatar
Maxime Perrotin committed
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
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)


424
def find_basic_type(a_type, pool=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
425
426
    ''' Return the ASN.1 basic type of a_type '''
    basic_type = a_type or UNKNOWN_TYPE
427
    pool = pool or types()
Maxime Perrotin's avatar
Maxime Perrotin committed
428
429
    while basic_type.kind == 'ReferenceType':
        # Find type with proper case in the data view
430
        for typename in pool.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
431
            if typename.lower() == basic_type.ReferencedTypeName.lower():
432
                basic_type = pool[typename].type
Maxime Perrotin's avatar
Maxime Perrotin committed
433
434
435
436
437
438
439
                break
        else:
            raise TypeError('Type "' + type_name(basic_type) +
                            '" was not found in Dataview')
    return basic_type


440
441
442
443
444
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
445

446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
    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)


466
467
468
def check_call(name, params, context):
    ''' Check the parameter types of a procedure/output/operator call,
        returning the type of its result '''
469

470
    # Special case for write/writeln functions
471
    if name.lower() in ('write', 'writeln'):
472
473
        for p in params:
            p_ty = p.exprType
474
475
            if is_numeric(p_ty) or is_boolean(p_ty) or is_string(p_ty) or \
                    is_enumerated(p_ty):
476
477
478
                continue
            raise TypeError('Type {} not supported in call to {}'.
                format(type_name(p.exprType), name))
479
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
480
481
482

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

    # (2) Check that the number of given parameters matches the signature
486
487
488
    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
489

490
491
    # (3) Check each individual parameter type
    for idx, param in enumerate(params):
Maxime Perrotin's avatar
Maxime Perrotin committed
492
        expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
493
        expr.left = ogAST.PrimVariable()
494
        expr.left.exprType = sign[idx]['type']
Maxime Perrotin's avatar
Maxime Perrotin committed
495
        expr.right = param
496
497
498
499
500
501
502
503
504
505
506

        try:
            fix_expression_types(expr, context)
            params[idx] = expr.right
        except TypeError:
            expected = type_name(sign[idx]['type'])
            received = type_name(expr.right.exprType)
            raise TypeError('Expected type {} in call to {} ({} received)'.
                format(expected, name, received))

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

511
512
513
514
515
516
517
518
519
520
521
522
523
524
    # (4) Compute the type of the result
    param_btys = [find_basic_type(p.exprType) for p in params]
    if name == 'abs':
        return type('Abs', (param_btys[0],), {
            'Min': str(max(float(param_btys[0].Min), 0)),
            'Max': str(max(float(param_btys[0].Max), 0))
        })

    elif name == 'ceil':
        return type('Ceil', (REAL,), {
            'Min': str(math.ceil(float(param_btys[0].Min))),
            'Max': str(math.ceil(float(param_btys[0].Max)))
        })

dbarbera's avatar
dbarbera committed
525
526
527
528
529
530
    elif name == 'cos':
        return type('Cos', (REAL,), {
            'Min': str(-1.0),
            'Max': str(1.0)
        })

531
532
533
534
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 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':
        return type('Length', (INTEGER,), {
            '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
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
    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)))
        })

596
597
598
599
600
601
    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)))
        })

602
603
604
605
606
607
608
    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

609
610
    return UNKNOWN_TYPE

Maxime Perrotin's avatar
Maxime Perrotin committed
611

Maxime Perrotin's avatar
Maxime Perrotin committed
612
613
614
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
615
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
616
617
618
619
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
620
            raise Warning('Expression evaluation in range [{}..{}], '
Maxime Perrotin's avatar
Maxime Perrotin committed
621
                          'could be outside expected range [{}..{}]'
Maxime Perrotin's avatar
Maxime Perrotin committed
622
623
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
624
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
625
626
627
        raise TypeError('Missing range')


628
def check_type_compatibility(primary, type_ref, context):
Maxime Perrotin's avatar
Maxime Perrotin committed
629
630
    '''
        Check if an ogAST.Primary (raw value, enumerated, ASN.1 Value...)
631
        is compatible with a given type (type_ref is an ASN1Scc type)
Maxime Perrotin's avatar
Maxime Perrotin committed
632
633
        Does not return anything if OK, otherwise raises TypeError
    '''
634
635
    assert type_ref is not None
    if type_ref is UNKNOWN_TYPE:
636
        #print traceback.print_stack()
Maxime Perrotin's avatar
Maxime Perrotin committed
637
        raise TypeError('Type reference is unknown')
dbarbera's avatar
dbarbera committed
638

639
    basic_type = find_basic_type(type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
640
641

    if (isinstance(primary, ogAST.PrimEnumeratedValue)
642
            and basic_type.kind.endswith('EnumeratedType')):
Maxime Perrotin's avatar
Maxime Perrotin committed
643
644
645
        # 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
646
647
648
649
650
        enumerant = primary.inputString.replace('_', '-').lower()
        for each in basic_type.EnumValues.keys():
            if each.lower() == enumerant:
                # Found -> all OK
                return
Maxime Perrotin's avatar
Maxime Perrotin committed
651
        else:
652
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
653
                   '" not in this enumeration: ' +
654
                   str(basic_type.EnumValues.keys()))
Maxime Perrotin's avatar
Maxime Perrotin committed
655
            raise TypeError(err)
656
657
658
659
660
661
    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:
662
                check_type_compatibility(expr, type_ref, context)
663
664
665
        return

    elif isinstance(primary, ogAST.PrimVariable):
Maxime Perrotin's avatar
Maxime Perrotin committed
666
        try:
667
            compare_types(primary.exprType, type_ref)
Maxime Perrotin's avatar
Maxime Perrotin committed
668
669
670
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
671
                                    ty=type_name(type_ref),
Maxime Perrotin's avatar
Maxime Perrotin committed
672
673
                                    err=str(err)))
        return
674

Maxime Perrotin's avatar
Maxime Perrotin committed
675
    elif isinstance(primary, ogAST.PrimInteger) \
dbarbera's avatar
dbarbera committed
676
            and (is_integer(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
677
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
678

Maxime Perrotin's avatar
Maxime Perrotin committed
679
    elif isinstance(primary, ogAST.PrimReal) \
dbarbera's avatar
dbarbera committed
680
            and (is_real(type_ref) or type_ref == NUMERICAL):
Maxime Perrotin's avatar
Maxime Perrotin committed
681
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
682

dbarbera's avatar
dbarbera committed
683
    elif isinstance(primary, ogAST.PrimBoolean) and is_boolean(type_ref):
Maxime Perrotin's avatar
Maxime Perrotin committed
684
        return
685

Maxime Perrotin's avatar
Maxime Perrotin committed
686
    elif (isinstance(primary, ogAST.PrimEmptyString) and
687
688
                                         basic_type.kind == 'SequenceOfType'):
        if int(basic_type.Min) == 0:
Maxime Perrotin's avatar
Maxime Perrotin committed
689
690
691
            return
        else:
            raise TypeError('SEQUENCE OF has a minimum size of '
692
                            + basic_type.Min + ')')
Maxime Perrotin's avatar
Maxime Perrotin committed
693
    elif isinstance(primary, ogAST.PrimSequenceOf) \
694
            and basic_type.kind == 'SequenceOfType':
695
696
        if type_ref.__name__ != 'Apnd' and \
                (len(primary.value) < int(basic_type.Min) or
697
                len(primary.value) > int(basic_type.Max)):
Maxime Perrotin's avatar
Maxime Perrotin committed
698
699
            raise TypeError(str(len(primary.value)) +
                      ' elements in SEQUENCE OF, while constraint is [' +
700
                      str(basic_type.Min) + '..' + str(basic_type.Max) + ']')
Maxime Perrotin's avatar
Maxime Perrotin committed
701
        for elem in primary.value:
702
            check_type_compatibility(elem, basic_type.type, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
703
704
        if not hasattr(primary, 'expected_type') \
               and type_ref.__name__ not in ('Apnd', 'SubStr'):
705
            primary.expected_type = type_ref
Maxime Perrotin's avatar
Maxime Perrotin committed
706
707
        return
    elif isinstance(primary, ogAST.PrimSequence) \
708
            and basic_type.kind == 'SequenceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
709
        user_nb_elem = len(primary.value.keys())
710
        type_nb_elem = len(basic_type.Children.keys())
711
712
713
714
715
716
717
718
719
720
721
722
        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)))
723
            elif ufield.lower() not in user_fields:
724
725
726
727
                # Optional field not set - OK
                continue
            else:
                # If the user field is a raw value
728
729
730
731
732
733
734
                casefield = ufield
                for each in primary.value:
                    if each.lower() == ufield.lower():
                        casefield = each
                        break
                if primary.value[casefield].is_raw:
                    check_type_compatibility(primary.value[casefield],
735
                                             fd_data.type, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
736
                else:
737
738
739
                    # Compare the types for semantic equivalence
                    try:
                        compare_types(
740
                            primary.value[casefield].exprType, fd_data.type)
741
742
743
744
745
                    except TypeError as err:
                        raise TypeError('Field ' + ufield +
                                    ' is not of the proper type, i.e. ' +
                                    type_name(fd_data.type) +
                                    ' - ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
746
747
        return
    elif isinstance(primary, ogAST.PrimChoiceItem) \
748
749
                              and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.Children.viewitems():
750
751
            if choicekey.lower().replace('-', '_') == \
                    primary.value['choice'].lower().replace('-', '_'):
Maxime Perrotin's avatar
Maxime Perrotin committed
752
753
754
755
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.value['choice'],
756
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
757
        # compare primary.value['value']
758
        # with basic_type['Children'][primary.choiceItem['choice']]
Maxime Perrotin's avatar
Maxime Perrotin committed
759
760
761
762
763
764
765
766
767
768
        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
769
770
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
771
772
773
774
775
776
                            .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) \
777
778
                and basic_type.kind.startswith('Choice'):
        for choicekey, choice in basic_type.EnumValues.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
779
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
780
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
781
782
783
784
                break
        else:
            raise TypeError('Non-existent choice "{choice}" in type {t1}'
                            .format(choice=primary.inputString,
785
                            t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
786
787
788

    elif isinstance(primary, ogAST.PrimStringLiteral):
        # Octet strings
789
        basic_type = find_basic_type(type_ref)
790
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
791
            return
792
        elif basic_type.kind.endswith('StringType'):
793
794
795
796
797
798
799
800
801
802
803
804
805
            try:
                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(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')
806
807
808
                return
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
809
    elif (isinstance(primary, ogAST.PrimMantissaBaseExp) and
810
                                            basic_type.kind == 'RealType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
811
812
813
814
815
816
        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,
817
                                t1=type_name(type_ref)))
Maxime Perrotin's avatar
Maxime Perrotin committed
818

Maxime Perrotin's avatar
Maxime Perrotin committed
819

Maxime Perrotin's avatar
Maxime Perrotin committed
820
821
822
823
824
def compare_types(type_a, type_b):
    '''
       Compare two types, return if they are semantically equivalent,
       otherwise raise TypeError
    '''
825

Maxime Perrotin's avatar
Maxime Perrotin committed
826
827
    type_a = find_basic_type(type_a)
    type_b = find_basic_type(type_b)
828

Maxime Perrotin's avatar
Maxime Perrotin committed
829
830
    if type_a == type_b:
        return
831
832
833
834
835
836
837
838
839
840
    elif NUMERICAL in (type_a, type_b) and is_numeric(type_a) \
            and is_numeric(type_b):
        return
    elif LIST in (type_a, type_b) and is_list(type_a) and is_list(type_b):
        return
    elif ENUMERATED in (type_a, type_b) and is_enumerated(type_a) \
            and is_enumerated(type_b):
        return
    elif CHOICE in (type_a, type_b) and is_choice(type_a) and is_choice(type_b):
        return
841

Maxime Perrotin's avatar
Maxime Perrotin committed
842
    # Check if both types have basic compatibility
843
844

    if type_a.kind == type_b.kind:
Maxime Perrotin's avatar
Maxime Perrotin committed
845
        if type_a.kind == 'SequenceOfType':
846
847
848
849
850
851
852
853
854
            if type_a.Min == type_a.Max:
                if type_a.Min == type_b.Min == type_b.Max:
                    compare_types(type_a.type, type_b.type)
                    return
                else:
                    raise TypeError('Incompatible sizes - size of {} can vary'
                                    .format(type_name(type_b)))
            elif(int(type_b.Min) >= int(type_a.Min)
                 and int(type_b.Max) <= int(type_a.Max)):
Maxime Perrotin's avatar
Maxime Perrotin committed
855
856
857
                compare_types(type_a.type, type_b.type)
                return
            else:
858
859
                compare_types(type_a.type, type_b.type)
                raise Warning('Size constraints mismatch - risk of overflow')
860
        # TODO: Check that OctetString types have compatible range
Maxime Perrotin's avatar
Maxime Perrotin committed
861
        return
862
    elif is_string(type_a) and is_string(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
863
        return
864
    elif is_integer(type_a) and is_integer(type_b):
Maxime Perrotin's avatar
Maxime Perrotin committed
865
        return
866
867
    elif is_real(type_a) and is_real(type_b):
        return
868
869
870
871
872
    else:
        raise TypeError('Incompatible types {} and {}'.format(
            type_name(type_a),
            type_name(type_b)
        ))
Maxime Perrotin's avatar
Maxime Perrotin committed
873
874


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

Maxime Perrotin's avatar
Maxime Perrotin committed
878
    # all DCL-variables
Maxime Perrotin's avatar
Maxime Perrotin committed
879
880
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
dbarbera's avatar
dbarbera committed
881

Maxime Perrotin's avatar
Maxime Perrotin committed
882
883
884
885
886
887
888
889
    # 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
890

Maxime Perrotin's avatar
Maxime Perrotin committed
891
892
893
    for varname, (vartype, _) in all_visible_variables.viewitems():
        # Case insensitive comparison with variables
        if var.lower() == varname.lower():
894
895
            return vartype

Maxime Perrotin's avatar
Maxime Perrotin committed
896
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
897
        if var.lower() == timer.lower():
898
            return TIMER
Maxime Perrotin's avatar
Maxime Perrotin committed
899

dbarbera's avatar
dbarbera committed
900
901
902
903
904
    # 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
905
906
907
    raise AttributeError('Variable {var} not defined'.format(var=var))


908
909
910
911
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 '''
    kind = find_basic_type(expr_enum.left.exprType).kind
912
    if kind in ('EnumeratedType', 'StateEnumeratedType'):
913
914
915
916
917
918
919
920
921
922
923
        prim = ogAST.PrimEnumeratedValue(primary=expr_enum.right)
    elif kind == 'ChoiceEnumeratedType':
        prim = ogAST.PrimChoiceDeterminant(primary=expr_enum.right)
    try:
        check_type_compatibility(prim, expr_enum.left.exprType, context)
        expr_enum.right = prim
        expr_enum.right.exprType = expr_enum.left.exprType
    except (UnboundLocalError, AttributeError, TypeError):
        pass


924
def fix_expression_types(expr, context):
dbarbera's avatar
dbarbera committed
925
    ''' Check/ensure type consistency in binary expressions '''
926
927
928
929
930
    for _ in range(2):
        # Check if an raw enumerated value is of a reference type
        fix_enumerated_and_choice(expr, context)
        expr.right, expr.left = expr.left, expr.right

931
932
933
934
935
936
937
    for side in (expr.right, expr.left):
        if side.is_raw:
            raw_expr = side
        else:
            typed_expr = side
            ref_type = typed_expr.exprType

938

939
    # If a side is a raw Sequence Of with unknown type, try to resolve it
940
941
    for side_a, side_b in permutations(('left', 'right')):
        value = getattr(expr, side_a)  # get expr.left then expr.right
942
943
        if not isinstance(value, ogAST.PrimSequenceOf):
            continue
944
        other = getattr(expr, side_b)  # other side
945
946
947
948
949
950
951
        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
952
                    check_expr.left = ogAST.PrimVariable()
953
954
955
956
957
958
959
                    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

960
961
962
    if isinstance(expr, ogAST.ExprIn):
        return

963
    if not expr.right.is_raw and not expr.left.is_raw:
964
965
966
        unknown = [uk_expr for uk_expr in expr.right, expr.left
                   if uk_expr.exprType == UNKNOWN_TYPE]
        if unknown:
967
            #print traceback.print_stack()
968
969
970
            raise TypeError('Cannot resolve type of "{}"'
                            .format(unknown[0].inputString))

971
    # In Sequence, Choice and SEQUENCE OF expressions,
972
973
974
975
976
977
978
979
980
981
982
    # we must fix missing inner types
    # (due to similarities, the following should be refactored FIXME)
    if isinstance(expr.right, ogAST.PrimSequence):
        # left side must have a known type
        asn_type = find_basic_type(expr.left.exprType)
        if asn_type.kind != 'SequenceType':
            raise TypeError('left side must be a SEQUENCE type')
        for field, fd_expr in expr.right.value.viewitems():
            if fd_expr.exprType == UNKNOWN_TYPE:
                try:
                    expected_type = asn_type.Children.get(
dbarbera's avatar
dbarbera committed
983
                            field.replace('_', '-')).type
984
985
986
                except AttributeError:
                    raise TypeError('Field not found: ' + field)
                check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
987
                check_expr.left = ogAST.PrimVariable()
988
989
990
991
992
993
994
995
996
997
998
                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()]:
999
            raise TypeError('Field is not valid in CHOICE:' + field)
1000
1001
1002
1003
1004
1005
1006
1007
        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
1008
            check_expr.left = ogAST.PrimVariable()
1009
1010
1011
1012
            check_expr.left.exprType = expected_type
            check_expr.right = expr.right.value['value']
            fix_expression_types(check_expr, context)
            expr.right.value['value'] = check_expr.right
1013
1014
1015
1016
1017
1018
1019
1020
1021
    elif isinstance(expr.right, ogAST.PrimConditional):
        for det in ('then', 'else'):
            # Recursively fix possibly missing types in the expression
            check_expr = ogAST.ExprAssign()
            check_expr.left = ogAST.PrimVariable()
            check_expr.left.exprType = expr.left.exprType
            check_expr.right = expr.right.value[det]
            fix_expression_types(check_expr, context)
            expr.right.value[det] = check_expr.right
1022
1023
1024

    if expr.right.is_raw != expr.left.is_raw:
        check_type_compatibility(raw_expr, ref_type, context)
1025
1026
1027
1028
        if not raw_expr.exprType.kind.startswith(('Integer',
                                                  'Real',
                                                  'SequenceOf',
                                                  'String')):
Maxime Perrotin's avatar
Maxime Perrotin committed
1029
1030
            # Raw int/real must keep their type because of the range
            # that can be computed
1031
1032
            # Also true for raw SEQOF and String - Min/Max must not change
            # Substrings: CHECKME XXX
1033
1034
1035
            # 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
1036
            raw_expr.exprType = ref_type
1037
1038
1039
    else:
        compare_types(expr.left.exprType, expr.right.exprType)

Maxime Perrotin's avatar
Maxime Perrotin committed
1040

Maxime Perrotin's avatar
Maxime Perrotin committed
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
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
1053

dbarbera's avatar
dbarbera committed
1054
1055
def primary_variable(root, context):
    ''' Primary Variable analysis '''
1056
    name = getattr(root.getChild(0), 'text', 'error')
dbarbera's avatar
dbarbera committed
1057
    errors, warnings = [], []
dbarbera's avatar
dbarbera committed
1058

dbarbera's avatar
dbarbera committed
1059
1060
1061
1062
1063
1064
    if is_asn1constant(name):
        prim = ogAST.PrimConstant()
    elif is_fpar(name, context):
        prim = ogAST.PrimFPAR()
    else:
        prim = ogAST.PrimVariable()
dbarbera's avatar
dbarbera committed
1065

dbarbera's avatar
dbarbera committed
1066
    prim.value = [name]
dbarbera's avatar
dbarbera committed
1067
1068
1069
1070
1071
    prim.exprType = UNKNOWN_TYPE
    prim.inputString = get_input_string(root)
    prim.tmpVar = tmp()

    try:
dbarbera's avatar
dbarbera committed
1072
        prim.exprType = find_variable_type(name, context)
dbarbera's avatar
dbarbera committed
1073
1074
1075
1076
1077
1078
    except AttributeError:
        pass

    return prim, errors, warnings


dbarbera's avatar
dbarbera committed
1079
1080
1081
1082
def is_fpar(name, context):
    name = name.lower()
    if isinstance(context, ogAST.Procedure):
        for each in context.fpar:
1083
            if each['name'].lower() == name.lower():
dbarbera's avatar
dbarbera committed
1084
1085
1086
1087
1088
1089
                return True
    return False


def is_asn1constant(name):
    name = name.lower().replace('-', '_')
1090
1091
1092
1093
1094
1095
1096
    try:
        for varname, vartype in DV.variables.viewitems():
            if varname.lower().replace('-', '_') == name:
                return True
    except AttributeError:
        # Ignore - No DV - e.g. in syntax check mode
        pass
dbarbera's avatar
dbarbera committed
1097
1098
1099
    return False


dbarbera's avatar
dbarbera committed
1100
def binary_expression(root, context):
1101
    ''' Binary expression analysis '''
dbarbera's avatar
dbarbera committed
1102
    errors, warnings = [], []
dbarbera's avatar
dbarbera committed
1103

dbarbera's avatar
dbarbera committed
1104
1105
    ExprNode = EXPR_NODE[root.type]
    expr = ExprNode(
1106
1107
1108
1109
        get_input_string(root),
        root.getLine(),
        root.getCharPositionInLine()
    )
dbarbera's avatar
dbarbera committed
1110
1111
    expr.exprType = UNKNOWN_TYPE
    expr.tmpVar = tmp()
1112
1113
1114
1115
1116
1117
1118
1119
1120

    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)

1121
1122
1123
1124
    try:
        fix_expression_types(expr, context)
    except (AttributeError, TypeError) as err:
        errors.append(error(root, str(err)))
1125
1126
    except Warning as warn:
        warnings.append(warning(root, str(warn)))
1127

1128
1129
1130
1131
1132
    return expr, errors, warnings


def unary_expression(root, context):
    ''' Unary expression analysys '''
dbarbera's avatar
dbarbera committed
1133
1134
1135
1136
1137
1138
1139
1140
    ExprNode = EXPR_NODE[root.type]
    expr = ExprNode(
        get_input_string(root),
        root.getLine(),
        root.getCharPositionInLine()
    )
    expr.exprType = UNKNOWN_TYPE
    expr.tmpVar = tmp()
1141

dbarbera's avatar
dbarbera committed
1142
    expr.expr, errors, warnings = expression(root.children[0], context)
1143
1144
1145
1146

    return expr, errors, warnings


Maxime Perrotin's avatar
Maxime Perrotin committed
1147
1148
def expression(root, context):
    ''' Expression analysis (e.g. 5+5*hello(world)!foo) '''
dbarbera's avatar
dbarbera committed
1149
    logic = (lexer.OR, lexer.AND, lexer.XOR, lexer.IMPLIES)
1150
1151
    arithmetic = (lexer.PLUS, lexer.ASTERISK, lexer.DASH,
                  lexer.DIV, lexer.MOD, lexer.REM)
1152
1153
    relational = (lexer.EQ, lexer.NEQ, lexer.GT, lexer.GE, lexer.LT, lexer.LE)

1154
    if root.type in logic:
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
        return logic_expression(root, context)
    elif root.type in arithmetic:
        return arithmetic_expression(root, context)
    elif root.type in relational:
        return relational_expression(root, context)
    elif root.type == lexer.IN:
        return in_expression(root, context)
    elif root.type == lexer.APPEND:
        return append_expression(root, context)
    elif root.type == lexer.NOT:
        return not_expression(root, context)
    elif root.type == lexer.NEG:
        return neg_expression(root, context)
1168
1169
    elif root.type == lexer.PAREN:
        return expression(root.children[0], context)
1170
    elif root.type == lexer.CONDITIONAL:
1171
        return conditional_expression(root, context)
1172
1173
    elif root.type == lexer.PRIMARY:
        return primary(root.children[0], context)
1174
1175
1176
1177
    elif root.type == lexer.CALL:
        return call_expression(root, context)
    elif root.type == lexer.SELECTOR:
        return selector_expression(root, context)
1178
    else:
1179
1180
        raise NotImplementedError(sdl92Parser.tokenNames[root.type] +
                                ' - line ' + str(root.getLine()))
1181
1182
1183
1184


def logic_expression(root, context):
    ''' Logic expression analysis '''
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
    shortcircuit = ''
    # detect optional THEN in AND/OR expressions, indicating that the
    # short-circuit version of the operator is needed, to prevent the
    # evaluation of the right part if the left part does not evaluate
    # to true.
    if root.type in (lexer.OR, lexer.AND) and len(root.children) == 3:
        if root.children[1].type in (lexer.THEN, lexer.ELSE):
            root.children.pop(1)
            shortcircuit = ' else' if root.type == lexer.OR else ' then'

    expr, errors, warnings = binary_expression(root, context)
    expr.shortcircuit = shortcircuit
Maxime Perrotin's avatar
Maxime Perrotin committed
1197

dbarbera's avatar
dbarbera committed
1198
1199
    left_bty = find_basic_type(expr.left.exprType)
    right_bty = find_basic_type(expr.right.exprType)
1200

dbarbera's avatar
dbarbera committed
1201
    for bty in left_bty, right_bty:
1202
1203
1204
1205
1206
        if shortcircuit and bty.kind != 'BooleanType':
            msg = 'Shortcircuit operators only work with type Boolean'
            errors.append(error(root, msg))
            break

1207
        if bty.kind == 'BooleanType':
dbarbera's avatar
dbarbera committed
1208
            continue
1209
1210
        elif bty.kind == 'BitStringType' and bty.Min == bty.Max:
            continue
1211
1212
        elif bty.kind == 'SequenceOfType' and bty.Min == bty.Max \
                and find_basic_type(bty.type).kind == 'BooleanType':
dbarbera's avatar
dbarbera committed
1213
1214
            continue
        else:
1215
            msg = 'Bitwise operators only work with Booleans, ' \
1216
                  'fixed size SequenceOf Booleans or fixed size BitStrings'
dbarbera's avatar
dbarbera committed
1217
            errors.append(error(root, msg))
1218
            break
dbarbera's avatar
dbarbera committed
1219
1220

    if left_bty.kind == right_bty.kind == 'BooleanType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1221
        expr.exprType = BOOLEAN
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
    else:
        expr.exprType = expr.left.exprType

    return expr, errors, warnings


def arithmetic_expression(root, context):
    ''' Arithmetic expression analysis '''
    expr, errors, warnings = binary_expression(root, context)

Maxime Perrotin's avatar
Maxime Perrotin committed
1232
1233
    # Expressions returning a numerical type must have their range defined
    # accordingly with the kind of opration used between operand:
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
    basic = find_basic_type(expr.left.exprType)
    left = find_basic_type(expr.left.exprType)
    right = find_basic_type(expr.right.exprType)
    try:
        if isinstance(expr, ogAST.ExprPlus):
            attrs = {'Min': str(float(left.Min) + float(right.Min)),
                     'Max': str(float(left.Max) + float(right.Max))}
            expr.exprType = type('Plus', (basic,), attrs)
        elif isinstance(expr, ogAST.ExprMul):
            attrs = {'Min': str(float(left.Min) * float(right.Min)),
                     'Max': str(float(left.Max) * float(right.Max))}
            expr.exprType = type('Mul', (basic,), attrs)
        elif isinstance(expr, ogAST.ExprMinus):
            attrs = {'Min': str(float(left.Min) - float(right.Min)),
                     'Max': str(float(left.Max) - float(right.Max))}
            expr.exprType = type('Minus', (basic,), attrs)
        elif isinstance(expr, ogAST.ExprDiv):
            attrs = {'Min': str(float(left.Min) / (float(right.Min) or 1)),
                     'Max': str(float(left.Max) / (float(right.Max) or 1))}
            expr.exprType = type('Div', (basic,), attrs)
        elif isinstance(expr, (ogAST.ExprMod, ogAST.ExprRem)):
            attrs = {'Min': right.Min, 'Max': right.Max}
            expr.exprType = type('Mod', (basic,), attrs)
    except (ValueError, AttributeError):
1258
1259
        msg = 'Check that all your numerical data types '\
              'have a range constraint'
dbarbera's avatar
dbarbera committed
1260
        errors.append(error(root, msg))
1261