ogParser.py 125 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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

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
INTEGER = type('IntegerType', (object,), {'kind': 'IntegerType'})
INT32 = type('Integer32Type', (object,), {'kind': 'Integer32Type'})
NUMERICAL = type('NumericalType', (object,), {'kind': 'Numerical'})
TIMER = type('TimerType', (object,), {'kind': 'TimerType'})
REAL = type('RealType', (object,), {'kind': 'RealType'})
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'})

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],
                     'abs': [NUMERICAL]}

# 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,), {})
102
                    for a, b in lexer.__dict__.viewitems() if type(b) == int}
Maxime Perrotin's avatar
Maxime Perrotin committed
103
104
105
106
107
108
109
110
111
112
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


# 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:
215
216
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
217
218
219
            break
    else:
        if isinstance(ast, ogAST.Block):
220
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
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
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
        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 '''
295
    if op_name.lower() in ('length', 'present', 'abs'):
Maxime Perrotin's avatar
Maxime Perrotin committed
296
297
298
299
300
301
        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:
            expr.exprType = find_variable(expr.inputString, context)
302
            # XXX don't use inputString, there can be brackets
Maxime Perrotin's avatar
Maxime Perrotin committed
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
            # 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')
    elif op_name.lower() in ('write', 'writeln'):
        for param in expr_list:
            if param.exprType is UNKNOWN_TYPE:
                param.exprType = find_variable(param.inputString, context)
            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
320
321
322
323
324
325
326
    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
327
        for each in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
328
329
330
331
332
333
334
335
336
337
338
339
340
            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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
    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)
367
        for inner_proc in context.procedures:
Maxime Perrotin's avatar
Maxime Perrotin committed
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
            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
402
403
404
405
        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
406
407
408
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


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:
435
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
                   '" 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:
                    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
    elif isinstance(primary, ogAST.PrimReal) \
            and actual_type.kind.startswith('Real'):
        return
    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
513
514
                            compare_types(
                                  primary.value[ufield].exprType, fd_data.type)
Maxime Perrotin's avatar
Maxime Perrotin committed
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
                        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
542
543
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
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
578
579
580
                            .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)
        if(basic_type.kind.endswith('StringType') and
           int(basic_type.Min) <= len(
                          primary.value[1:-1]) <= int(basic_type.Max)):
            return
        else:
            raise TypeError('Invalid string literal - check that lenght is'
                            'within the bound limits {Min}..{Max}'.format
                            (Min=str(basic_type.Min), Max=str(basic_type.Max)))
    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
581

Maxime Perrotin's avatar
Maxime Perrotin committed
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
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
    elif not(type_a.kind in ('IntegerType', 'Integer32Type', 'RealType') and
             type_b.kind in ('IntegerType', 'Integer32Type', 'RealType')):
        raise TypeError('Int/Real mismatch')
    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
624
625
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
Maxime Perrotin's avatar
Maxime Perrotin committed
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
    # 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
641
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
        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:
662
        raise AttributeError('Dataview is required to process types')
Maxime Perrotin's avatar
Maxime Perrotin committed
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
    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:
                # 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
                    param, = path[1].get('procParams') or [None]
                    if not param:
687
                        raise TypeError('Missing parameter in PRESENT clause')
Maxime Perrotin's avatar
Maxime Perrotin committed
688
689
690
691
                    else:
                        check_type = find_variable(param.inputString, context)\
                                if param.exprType == UNKNOWN_TYPE else \
                                param.exprType
692
                        param_type = find_basic_type(check_type)
Maxime Perrotin's avatar
Maxime Perrotin committed
693
                        if param_type.kind != 'ChoiceType':
694
695
                            raise TypeError('PRESENT parameter'
                                         ' must be a CHOICE type:' + str(path))
Maxime Perrotin's avatar
Maxime Perrotin committed
696
697
698
699
700
701
                        else:
                            result.EnumValues = param_type.Children
                elif main.lower() in ('length', 'abs'):
                    # XXX length et abs: we must set Min and Max
                    # and abs may return a RealType, not always integer
                    result = type('lenabs', (object,), {'kind': 'IntegerType'})
Maxime Perrotin's avatar
Maxime Perrotin committed
702
                else:  # write and writeln return void
Maxime Perrotin's avatar
Maxime Perrotin committed
703
704
705
706
707
                    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:]:
708
            basic = find_basic_type(result)
Maxime Perrotin's avatar
Maxime Perrotin committed
709
710
711
712
713
714
            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:
715
716
                    raise TypeError('Element {} cannot have an index'
                                    .format(path[0]))
Maxime Perrotin's avatar
Maxime Perrotin committed
717
718
719
720
721
722
                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:
723
724
725
                    raise TypeError('Field ' + elem
                                     + ' not found in expression '
                                     + '!'.join(path))
Maxime Perrotin's avatar
Maxime Perrotin committed
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
                    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:
742
                    raise TypeError('Index on a string is not supported')
Maxime Perrotin's avatar
Maxime Perrotin committed
743
744
745
746
747
                elif 'substring' in elem:
                    # don't change type, returns a string
                    # XXX Size may differ
                    pass
            else:
748
749
                raise TypeError('Incorrect field or index')
    return result
Maxime Perrotin's avatar
Maxime Perrotin committed
750
751


752
753
754
755
756
757
758
759
760
761
762
763
764
765
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.inputString, context)
                exprType = find_variable(uk_expr.value[0], context)
Maxime Perrotin's avatar
Maxime Perrotin committed
766
767
768
769
770
771
772
773
                # 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))
774
775
776
777
778
779
                getattr(expr, side).exprType = exprType
            except AttributeError:
                pass

    # If a side of the expression is of Enumerated of Choice type, check if
    # the other side is a literal of that sort, and change type accordingly
780
    for side in permutations(('left', 'right')):
781
782
783
784
785
786
787
788
789
790
791
792
793
794
        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
795
    for side in permutations(('left', 'right')):
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
        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

    # 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)
        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()]:
856
            raise TypeError('Field is not valid in CHOICE:' + field)
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
        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()
            check_expr.left = ogAST.PrimPath()
            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
    elif isinstance(expr.right, ogAST.PrimIfThenElse):
        for det in ('then', 'else'):
872
873
            #if expr.right.value[det].exprType == UNKNOWN_TYPE:
            #    expr.right.value[det].exprType = expr.left.exprType
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
            # Recursively fix possibly missing types in the expression
            check_expr = ogAST.ExprAssign()
            check_expr.left = ogAST.PrimPath()
            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
    elif isinstance(expr.right, ogAST.PrimSequenceOf):
        asn_type = find_basic_type(expr.left.exprType).type
        for idx, elem in enumerate(expr.right.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)
            expr.right.value[idx] = check_expr.right
        # the type of the raw PrimSequenceOf can be set now
        expr.right.exprType.type = asn_type

    if isinstance(expr, (ogAST.ExprAnd, ogAST.ExprOr, ogAST.ExprXor)):
        # Bitwise operators: check that both sides are booleans
        for side in expr.left, expr.right:
            basic_type = find_basic_type(side.exprType)
            if basic_type.kind in ('BooleanType', 'BitStringType'):
                continue
            elif basic_type.kind == 'SequenceOfType':
                if find_basic_type(side.exprType).type.kind == 'BooleanType':
                    continue
            else:
                raise TypeError('Bitwise operators only work with '
                                'booleans and arrays of booleans')
    if expr.right.is_raw != expr.left.is_raw:
        check_type_compatibility(raw_expr, ref_type, context)
        raw_expr.exprType = ref_type
    else:
        compare_types(expr.left.exprType, expr.right.exprType)


Maxime Perrotin's avatar
Maxime Perrotin committed
912
913
914
915
916
917
918
919
920
921
922
923
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
924

Maxime Perrotin's avatar
Maxime Perrotin committed
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
def primary_value(root, context=None):
    '''
        Process a primary expression such as a!b(4)!c(hello)
        or { x 1, y a:2 } (ASN.1 Value Notation)
        Try to determine the type of the primary when possible
        There are three cases where the type cannot be determined at all:
        (1) if the primary is a single literal (can be a var, enum or choice)
        (2) if the primary is a sequence literal
        (3) if the type is a choice literal
        In case of a SEQUENCE OF, the Min/Max values are set
    '''
    warnings = []
    errors = []
    prim = None
    global TMPVAR
Maxime Perrotin's avatar
Maxime Perrotin committed
940

Maxime Perrotin's avatar
Maxime Perrotin committed
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
    def primary_elem(child):
        ''' Process a single token '''
        prim = None
        if child.type == lexer.ID:
            prim = ogAST.PrimPath()
            prim.value = [child.text]
            prim.exprType = UNKNOWN_TYPE
        elif child.type == lexer.INT:
            prim = ogAST.PrimInteger()
            prim.value = [child.text.lower()]
            prim.exprType = type('PrInt', (object,),
                 {'kind': 'IntegerType', 'Min': child.text, 'Max': child.text})
        elif child.type in (lexer.TRUE, lexer.FALSE):
            prim = ogAST.PrimBoolean()
            prim.value = [child.text.lower()]
            prim.exprType = type('PrBool', (object,), {'kind': 'BooleanType'})
        elif child.type == lexer.FLOAT:
            prim = ogAST.PrimReal()
            prim.value = [child.getChild(0).text]
            prim.exprType = type('PrReal', (object,),
                 {'kind': 'RealType',
                  'Min': prim.value[0], 'Max': prim.value[0]})
        elif child.type == lexer.STRING:
            prim = ogAST.PrimStringLiteral()
            prim.value = child.getChild(0).text
            prim.exprType = type('PrStr', (object,),
Maxime Perrotin's avatar
Maxime Perrotin committed
967
968
969
                          {'kind': 'StringType',
                           'Min': str(len(prim.value) - 2),
                           'Max': str(len(prim.value) - 2)})
Maxime Perrotin's avatar
Maxime Perrotin committed
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
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
        elif child.type == lexer.FLOAT2:
            prim = ogAST.PrimMantissaBaseExp()
            mant = float(child.getChild(0).toString())
            base = int(child.getChild(1).toString())
            exp = int(child.getChild(2).toString())
            # Compute mantissa * base**exponent to get the value type range
            value = float(mant * pow(base, exp))
            prim.value = {'mantissa': mant, 'base': base, 'exponent': exp}
            prim.exprType = type('PrMantissa', (object,),
                 {'kind': 'RealType',
                  'Min': str(value), 'Max': str(value)})
        elif child.type == lexer.EMPTYSTR:
            # Empty SEQUENCE OF (i.e. "{}")
            prim = ogAST.PrimEmptyString()
            prim.exprType = type('PrES', (object,), {'kind': 'SequenceOfType',
                'Min': '0', 'Max': '0'})
        elif child.type == lexer.CHOICE:
            prim = ogAST.PrimChoiceItem()
            choice = child.getChild(0).toString()
            expr, err, warn = expression(child.getChild(1), context)
            errors.extend(err)
            warnings.extend(warn)
            prim.value = {'choice': choice, 'value': expr}
            prim.exprType = UNKNOWN_TYPE
        elif child.type == lexer.SEQUENCE:
            prim = ogAST.PrimSequence()
            prim.value = {}
            for elem in child.getChildren():
                if elem.type == lexer.ID:
                    field_name = elem.text
                else:
                    prim.value[field_name], err, warn = (
                                                     expression(elem, context))
                    errors.extend(err)
                    warnings.extend(warn)
            prim.exprType = UNKNOWN_TYPE
        elif child.type == lexer.SEQOF:
            prim = ogAST.PrimSequenceOf()
            prim.value = []
            for elem in child.getChildren():
                # SEQUENCE OF elements cannot have fieldnames/indexes
                prim_elem = primary_elem(elem)
                prim_elem.inputString = get_input_string(elem)
                prim_elem.line = elem.getLine()
                prim_elem.charPositionInLine = elem.getCharPositionInLine()
                prim.value.append(prim_elem)
            prim.exprType = type('PrSO', (object,), {'kind': 'SequenceOfType',
             'Min': str(len(child.children)), 'Max': str(len(child.children))})
        elif child.type == lexer.BITSTR:
            prim = ogAST.PrimBitStringLiteral()
            warnings.append('Bit string literal not supported yet')
        elif child.type == lexer.OCTSTR:
            prim = ogAST.PrimOctetStringLiteral()
            warnings.append('Octet string literal not supported yet')
        else:
            warnings.append('Unsupported primary construct, type:' +
                    str(child.type) +
                    ' (line ' + str(child.getLine()) + ')')
        return prim

    prim = primary_elem(root.getChild(0))

    # Process fields or params, if any
    for child in root.children[slice(1, len(root.children))]:
        if not isinstance(prim, ogAST.PrimPath):
            errors.append('Ground expression cannot have index or params: ' +
                           get_input_string(root))
        if child.type == lexer.PARAMS:
            # Cover parameters of operator calls within a task
            # but not parameters of output or procedure calls
            # (Except procedure calls embedded in a task)
            expr_list, err, warn = expression_list(child, context)
            errors.extend(err)
            warnings.extend(warn)
            procedures_list = [proc.inputString.lower() for proc in
                    context.procedures]
            if prim.value[0].lower() in (SPECIAL_OPERATORS.keys()
                                         + procedures_list):
                # here we must check/set the type of each param
                try:
                    check_and_fix_op_params(
                            prim.value[0].lower(), expr_list, context)
                except (AttributeError, TypeError) as err:
                    errors.append(str(err) + '- ' + get_input_string(root))
                prim.value.append({'procParams': expr_list})
            else:
                if len(expr_list) == 1:
                    # Index (only one param)
                    prim.value.append({'index': expr_list})
                elif len(expr_list) == 2:
                    # Substring (range, two params)
                    prim.value.append(
                            {'substring': expr_list, 'tmpVar': TMPVAR})
                    TMPVAR += 1
                else:
                    errors.append('Wrong number of parameters')
        elif child.type == lexer.FIELD_NAME:
            prim.value.append(child.getChild(0).text)

    # If there were parameters or index, try to determine the type of
    # the expression
1071
    if isinstance(prim, ogAST.PrimPath) and len(prim.value) > 1:
1072
1073
1074
1075
1076
        try:
            prim.exprType = find_type(prim.value, context)
        except TypeError as err:
            errors.append('Type of expression "'
                           + get_input_string(root)
Maxime Perrotin's avatar
Maxime Perrotin committed
1077
                           + '" not found: ' + str(err))
1078
1079
        except AttributeError as err:
            LOG.debug('[find_types] ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
1080
1081
1082
1083
1084
1085
    if prim:
        prim.inputString = get_input_string(root)
    else:
        prim = ogAST.PrimPath()
    return prim, errors, warnings

1086

Maxime Perrotin's avatar
Maxime Perrotin committed
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
def primary(root, context):
    ''' Process a primary (-/NOT value) '''
    warnings = []
    errors = []
    op_not, op_minus = False, False
    prim = None
    for child in root.getChildren():
        if child.type == lexer.NOT:
            op_not = True
        elif child.type == lexer.MINUS:
            op_minus = True
        elif child.type == lexer.PRIMARY_ID:
            # Variable reference, indexed values, or ASN.1 value notation
            prim, err, warn = primary_value(child, context=context)
            errors.extend(err)
            warnings.extend(warn)
        elif child.type == lexer.EXPRESSION:
            prim, err, warn = expression(child.getChild(0), context)
            errors.extend(err)
            warnings.extend(warn)
        elif child.type == lexer.IFTHENELSE:
            prim = ogAST.PrimIfThenElse()
            if_part, then_part, else_part = child.getChildren()
            if_expr, err, warn = expression(if_part, context)
            errors.extend(err)
            warnings.extend(warn)
            then_expr, err, warn = expression(then_part, context)
            errors.extend(err)
            warnings.extend(warn)
            else_expr, err, warn = expression(else_part, context)
            errors.extend(err)
            warnings.extend(warn)
            global TMPVAR
            prim.value = {'if': if_expr,
                          'then': then_expr,
                          'else': else_expr,
                          'tmpVar': TMPVAR}
            prim.exprType = UNKNOWN_TYPE
            TMPVAR += 1
        else:
            warnings.append('Unsupported primary child type:' +
                    str(child.type) + ' (line ' +
                    str(child.getLine()) + ')')
    if prim:
        prim.inputString = get_input_string(root)
        prim.line = root.getLine()
        prim.charPositionInLine = root.getCharPositionInLine()
Maxime Perrotin's avatar
Maxime Perrotin committed
1134
        prim.op_not, prim.op_minus = op_not, op_minus
Maxime Perrotin's avatar
Maxime Perrotin committed
1135
1136
    return prim, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1137

Maxime Perrotin's avatar
Maxime Perrotin committed
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
def expression(root, context):
    ''' Expression analysis (e.g. 5+5*hello(world)!foo) '''
    errors = []
    warnings = []
    global TMPVAR
    if root.type != lexer.PRIMARY:
        expr = OPKIND[root.type](get_input_string(root), root.getLine(),
                                 root.getCharPositionInLine())
        expr.exprType = UNKNOWN_TYPE

    if root.type in (lexer.PLUS,
                     lexer.ASTERISK,
                     lexer.DASH,
                     lexer.APPEND,
                     lexer.IMPLIES,
                     lexer.OR,
                     lexer.XOR,
                     lexer.AND,
                     lexer.EQ,
                     lexer.NEQ,
                     lexer.GT,
                     lexer.GE,
                     lexer.LT,
                     lexer.LE,
                     lexer.IN,
                     lexer.DIV,
                     lexer.MOD,
                     lexer.REM):

        left, right = root.getChildren()

        if root.type == lexer.IN:
            # Left and right are reversed for IN operator
            left, right = right, left

        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)

        try:
            fix_expression_types(expr, context)
        except (AttributeError, TypeError) as err:
            errors.append('Types are incompatible in expression: left (' +
                expr.left.inputString + ', type= ' +
                type_name(expr.left.exprType) + '), right (' +
                expr.right.inputString + ', type= ' +
                type_name(expr.right.exprType) + ') ' + str(err))

1189
    if root.type in (lexer.EQ,
Maxime Perrotin's avatar
Maxime Perrotin committed
1190
1191
1192
1193
1194
1195
1196
                     lexer.NEQ,
                     lexer.GT,
                     lexer.GE,
                     lexer.LT,
                     lexer.LE,
                     lexer.IN):
        expr.exprType = BOOLEAN
1197
#    elif root.type == lexer.PLUS:
Maxime Perrotin's avatar
Maxime Perrotin committed
1198
1199
        # Adjust type constraint upper range with sum of expressions
        # Create a new type to store the new constraint
1200
1201
1202
1203
1204
        # INCORRECT TO DO IT HERE - we must check right and left types FIRST
#       expr.exprType = type('Plus_Type',
#                           (find_basic_type(expr.left.exprType),), {})
#       expr.exprType.Max = str(int(find_basic_type(expr.left.exprType).Max) +
#                        int(find_basic_type(expr.right.exprType).Max))
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
    elif root.type in (lexer.OR, lexer.AND, lexer.XOR):
        # in the case of bitwise operators, if both sides are arrays,
        # then the result is an array too
        basic_left = find_basic_type(expr.left.exprType)
        basic_right = find_basic_type(expr.right.exprType)
        if basic_left.kind == basic_right.kind == 'BooleanType':
            expr.exprType = BOOLEAN
        else:
            expr.exprType = expr.left.exprType

Maxime Perrotin's avatar
Maxime Perrotin committed
1215
1216
1217
    elif root.type in (lexer.PLUS,
                       lexer.ASTERISK,
                       lexer.DASH,
1218
                       lexer.DIV,
1219
                       lexer.APPEND,
Maxime Perrotin's avatar
Maxime Perrotin committed
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
                       lexer.REM,
                       lexer.MOD):
        expr.exprType = expr.left.exprType

    if root.type == lexer.PRIMARY:
        expr, err, warn = primary(root, context)
        expr.inputString = get_input_string(root)
        expr.line = root.getLine()
        expr.charPositionInLine = root.getCharPositionInLine()
        errors.extend(err)
        warnings.extend(warn)

    # Expressions may need intermediate storage for code generation
    expr.tmpVar = TMPVAR
    TMPVAR += 1
    return expr, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1237

Maxime Perrotin's avatar
Maxime Perrotin committed
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
def variables(root, ta_ast, context):
    ''' Process declarations of variables (dcl a,b Type := 5) '''
    var = []
    errors = []
    warnings = []
    asn1_sort, def_value = UNKNOWN_TYPE, None
    for child in root.getChildren():
        if child.type == lexer.ID:
            var.append(child.text)
        elif child.type == lexer.SORT:
            sort = child.getChild(0).text
            # Find corresponding type in ASN.1 model
            try:
                asn1_sort = sdl_to_asn1(sort)
            except TypeError as err:
                errors.append(str(err) + '(line ' + str(child.getLine()) + ')')
        elif child.type == lexer.GROUND:
            # Default value for a variable - needs to be a ground expression
            def_value, err, warn = expression(child.getChild(0), context)
            errors.extend(err)
            warnings.extend(warn)
            expr = ogAST.ExprAssign()
            expr.left = ogAST.PrimPath()
            expr.left.inputString = var[-1]
            expr.left.exprType = asn1_sort
            expr.right = def_value
            try:
                fix_expression_types(expr, context)
                def_value = expr.right
            except(AttributeError, TypeError) as err:
                #print (traceback.format_exc())
                errors.append('Types are incompatible in DCL assignment: '
                    'left (' +
                    expr.left.inputString + ', type= ' +
                    type_name(expr.left.exprType) + '), right (' +
                    expr.right.inputString + ', type= ' +
                    type_name(expr.right.exprType) + ') ' + str(err))
            else:
                def_value.exprType = asn1_sort

            if not def_value.is_raw and not is_constant(def_value):
                errors.append('In variable declaration {}: default'
                              ' value is not a valid ground expression'.
                              format(var[-1]))
        else:
            warnings.append('Unsupported variables construct type: ' +
                    str(child.type))
    for variable in var:
        # Add to the context and text area AST entries
        context.variables[variable] = (asn1_sort, def_value)
        ta_ast.variables[variable] = (asn1_sort, def_value)
    if not DV:
        errors.append('Cannot do semantic checks on variable declarations')
    return errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1293

Maxime Perrotin's avatar
Maxime Perrotin committed
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
def dcl(root, ta_ast, context):
    ''' Process a set of variable declarations '''
    errors = []
    warnings = []
    for child in root.getChildren():
        if child.type == lexer.VARIABLES:
            err, warn = variables(child, ta_ast, context)
            errors.extend(err)
            warnings.extend(warn)
        else:
            warnings.append(
                    'Unsupported dcl construct, type: ' + str(child.type))
    return errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1308

Maxime Perrotin's avatar
Maxime Perrotin committed
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
def fpar(root):
    ''' Process a formal parameter declaration '''
    errors = []
    warnings = []
    params = []
    asn1_sort = UNKNOWN_TYPE
    for param in root.getChildren():
        param_names = []
        sort = ''
        direction = 'in'
1319
        assert param.type == lexer.PARAM
Maxime Perrotin's avatar
Maxime Perrotin committed
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
        for child in param.getChildren():
            if child.type == lexer.INOUT:
                direction = 'out'
            elif child.type == lexer.IN:
                pass
            elif child.type == lexer.ID:
                # variable name
                param_names.append(child.text)
            elif child.type == lexer.SORT:
                sort = child.getChild(0).text
                try:
                    asn1_sort = sdl_to_asn1(sort)
                except TypeError as err:
                    errors.append(str(err) +
                            '(line ' + str(child.getLine()) + ')')
                for name in param_names:
                    params.append({'name': name, 'direction': direction,
                                   'type': asn1_sort})
            else:
                warnings.append(
                        'Unsupported construct in FPAR, type: ' +
                        str(child.type))
    return params, errors, warnings

1344
1345
1346
1347
1348
1349
1350
1351
1352

def composite_state(root, parent=None, context=None):
    ''' Parse a composite state definition '''
    comp = ogAST.CompositeState()
    errors, warnings = [], []
    # Create a list of all inherited data
    try:
        comp.global_variables = dict(context.variables)
        comp.global_variables.update(context.global_variables)
Maxime Perrotin's avatar
Maxime Perrotin committed
1353
1354
        comp.global_timers = list(context.timers)
        comp.global_timers.extend(list(context.global_timers))
1355
1356
1357
1358
1359
1360
1361
        comp.input_signals = context.input_signals
        comp.output_signals = context.output_signals
        comp.procedures = context.procedures
        comp.operators = dict(context.operators)
    except AttributeError:
        LOG.debug('Procedure context is undefined')
    # Gather the list of states defined in the composite state
1362
    # and map a list of transitionsi to each state
1363
    comp.mapping = {name: [] for name in get_state_list(root)}
1364
1365
    inner_composite = []
    states = []
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
    for child in root.getChildren():
        if child.type == lexer.ID:
            comp.line = child.getLine()
            comp.charPositionInLine = child.getCharPositionInLine()
            comp.statename = child.toString().lower()
        elif child.type == lexer.COMMENT:
            comp.comment, _, _ = end(child)
        elif child.type == lexer.IN:
            # state entry point
            for point in child.getChildren():
                comp.state_entrypoints.append(point.toString().lower())
        elif child.type == lexer.OUT:
            # state exit point
            for point in child.getChildren():
                comp.state_exitpoints.append(point.toString().lower())
        elif child.type == lexer.TEXTAREA:
            textarea, err, warn = text_area(child, context=comp)
            errors.extend(err)
            warnings.extend(warn)
            comp.content.textAreas.append(textarea)
        elif child.type == lexer.PROCEDURE:
Maxime Perrotin's avatar
Maxime Perrotin committed
1387
            new_proc, err, warn = procedure(child, context=comp)
1388
1389
1390
1391
1392
1393
1394
            errors.extend(err)
            warnings.extend(warn)
            if new_proc.inputString.strip().lower() == 'entry':
                comp.entry_procedure = new_proc
            elif new_proc.inputString.strip().lower() == 'exit':
                comp.exit_procedure = new_proc
            comp.content.inner_procedures.append(new_proc)
1395
1396
            # Add procedure to the context, to make it visible at scope level
            context.procedures.append(new_proc)
1397
        elif child.type == lexer.COMPOSITE_STATE:
1398
            inner_composite.append(child)
1399
        elif child.type == lexer.STATE:
1400
            states.append(child)
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
        elif child.type == lexer.FLOATING_LABEL:
            lab, err, warn = floating_label(child, parent=None, context=comp)
            errors.extend(err)
            warnings.extend(warn)
            comp.content.floating_labels.append(lab)
        elif child.type == lexer.START:
            # START transition (fills the mapping structure)
            st, err, warn = start(child, context=comp)
            errors.extend(err)
            warnings.extend(warn)
            if st.inputString:
                comp.content.named_start.append(st)
            elif not comp.content.start:
                comp.content.start = st
            else:
                errors.append('Only one unnamed START transition is allowed')
        else:
            warnings.append(
                    'Unsupported construct in nested state, type: ' +
                    str(child.type) + ' - line ' + str(child.getLine()) +
                    ' - state name: ' + str(comp.statename))
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
    for each in inner_composite:
        # Parse inner composite states after the text areas to make sure
        # that all variables are propagated to the the inner scope
        inner, err, warn = composite_state(each, parent=None,
                                           context=comp)
        errors.extend(err)
        warnings.extend(warn)
        comp.composite_states.append(inner)
    for each in states:
        # And parse the states after inner states to make sure all CONNECTS
        # are properly defined.
        # Fill up the 'mapping' structure.
        newstate, err, warn = state(each, parent=None, context=comp)
        errors.extend(err)
        warnings.extend(warn)
        comp.content.states.append(newstate)
1438
1439
1440
    return comp, errors, warnings


Maxime Perrotin's avatar
Maxime Perrotin committed
1441
1442
1443
def procedure(root, parent=None, context=None):
    ''' Parse a procedure definition '''
    proc = ogAST.Procedure()
1444
1445
    errors = []
    warnings = []
Maxime Perrotin's avatar
Maxime Perrotin committed
1446
1447
1448
1449
    # Create a list of all inherited data
    try:
        proc.global_variables = dict(context.variables)
        proc.global_variables.update(context.global_variables)
Maxime Perrotin's avatar
Maxime Perrotin committed
1450
1451
        proc.global_timers = list(context.timers)
        proc.global_timers.extend(list(context.global_timers))
Maxime Perrotin's avatar
Maxime Perrotin committed
1452
1453
1454
1455
1456
1457
1458
        proc.input_signals = context.input_signals
        proc.output_signals = context.output_signals
        proc.procedures = context.procedures
        proc.operators = dict(context.operators)
    except AttributeError:
        LOG.debug('Procedure context is undefined')
    # Gather the list of states defined in the procedure
1459
1460
1461
    # and create a mapping of transitions to each state
    # (Note, procedures in OG currently do NOT support states)
    proc.mapping = {name: [] for name in get_state_list(root)}
Maxime Perrotin's avatar
Maxime Perrotin committed
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
    for child in root.getChildren():
        if child.type == lexer.CIF:
            # Get symbol coordinates
            proc.pos_x, proc.pos_y, proc.width, proc.height = cif(child)
        elif child.type == lexer.ID:
            proc.line = child.getLine()
            proc.charPositionInLine = child.getCharPositionInLine()
            proc.inputString = child.toString()
        elif child.type == lexer.COMMENT:
            proc.comment, _, ___ = end(child)
        elif child.type == lexer.TEXTAREA:
            textarea, err, warn = text_area(child, context=proc)
            errors.extend(err)
            warnings.extend(warn)
            proc.content.textAreas.append(textarea)
        elif child.type == lexer.PROCEDURE:
            new_proc, err, warn = procedure(child, context=proc)
            errors.extend(err)
            warnings.extend(warn)
            proc.content.inner_procedures.append(new_proc)
1482
1483
            # Add procedure to the context, to make it visible at scope level
            context.procedures.append(new_proc)
Maxime Perrotin's avatar
Maxime Perrotin committed
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
        elif child.type == lexer.EXTERNAL:
            proc.external = True
        elif child.type == lexer.FPAR:
            params, err, warn = fpar(child)
            errors.extend(err)
            warnings.extend(warn)
            proc.fpar = params
        elif child.type == lexer.START:
            # START transition (fills the mapping structure)
            proc.content.start, err, warn = start(child, context=proc)
            errors.extend(err)
            warnings.extend(warn)
        elif child.type == lexer.STATE:
            # STATE - fills up the 'mapping' structure.
            newstate, err, warn = state(child, parent=None, context=proc)
            errors.extend(err)
            warnings.extend(warn)
            proc.content.states.append(newstate)
        elif child.type == lexer.FLOATING_LABEL:
            lab, err, warn = floating_label(child, parent=None, context=proc)
            errors.extend(err)
            warnings.extend(warn)
            proc.content.floating_labels.append(lab)
        else:
            warnings.append(
                    'Unsupported construct in procedure, type: ' +
                    str(child.type) + ' - line ' + str(child.getLine()) +
                    ' - string: ' + str(proc.inputString))
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
    for each in proc.terminators:
        # check that RETURN statements type is correct
        if not proc.return_type and each.return_expr:
            errors.append('No return value expected in procedure '
                          + proc.inputString)
        elif proc.return_type and each.return_expr:
            check_expr = ogAST.ExprAssign()
            check_expr.left = ogAST.PrimPath()
            check_expr.left.exprType = proc.return_type
            check_expr.right = each.return_expr
            try:
                fix_expression_types(check_expr, context)
            except (TypeError, AttributeError) as err:
                errors.append(str(err))
            # Id of fd_expr may have changed (enumerated, choice)
            each.return_expr = check_expr.right
        elif proc.return_type and not each.return_expr:
            errors.append('Missing return value in procedure '
                          + proc.inputString)
        else:
            continue
Maxime Perrotin's avatar
Maxime Perrotin committed
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
    return proc, errors, warnings


def floating_label(root, parent, context):
    ''' Floating label: name and optional transition '''
    _ = parent
    errors = []
    warnings = []
    lab = ogAST.Floating_label()
    # Keep track of the number of terminator statements following the label
    # useful if we want to render graphs from the SDL model
    terminators = len(context.terminators)
    for child in root.getChildren():
        if child.type == lexer.ID:
            lab.inputString = child.text
            lab.line = child.getLine()
            lab.charPositionInLine = child.getCharPositionInLine()
        elif child.type == lexer.CIF:
            # Get symbol coordinates
            lab.pos_x, lab.pos_y, lab.width, lab.height = cif(child)
        elif child.type == lexer.HYPERLINK:
            lab.hyperlink = child.getChild(0).text[1:-1]
        elif child.type == lexer.TRANSITION:
            trans, err, warn = transition(
                                    child, parent=lab, context=context)
            errors.extend(err)
            warnings.extend(warn)
            lab.transition = trans
        else:
            warnings.append(
                    'Unsupported construct in floating label: ' +
                    str(child.type))
    if not lab.transition:
        warnings.append('Floating labels not followed by a transition: ' +
                        str(lab.inputString))
    # At the end of the label parsing, get the the list of terminators that
    # the transition contains by making a diff with the list at context
    # level (we counted the number of terminators before parsing the item)
    lab.terminators = list(context.terminators[terminators:])
    return lab, errors, warnings


def text_area_content(root, ta_ast, context):
    ''' Content of a text area: DCL, operators, procedures  '''
    errors = []
    warnings = []
    for child in root.getChildren():
        if child.type == lexer.DCL:
            err, warn = dcl(child, ta_ast, context)
            errors.extend(err)
            warnings.extend(warn)
        elif child.type == lexer.PROCEDURE:
            proc, err, warn = procedure(child, context=context)
            errors.extend(err)
            warnings.extend(warn)
            # Add procedure to the container (process or procedure)
            context.content.inner_procedures.append(proc)
1590
1591
            # Add to context to make it visible at scope level
            context.procedures.append(proc)
Maxime Perrotin's avatar
Maxime Perrotin committed
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
        elif child.type == lexer.FPAR:
            params, err, warn = fpar(child)
            errors.extend(err)
            warnings.extend(warn)
            try:
                if context.fpar:
                    errors.append('Duplicate declaration of FPAR section')
                else:
                    context.fpar = params
            except AttributeError:
                errors.append('Only procedures can have an FPAR section')
        elif child.type == lexer.TIMER:
            context.timers.extend(timer.text.lower()
                                            for timer in child.children)
        else:
            warnings.append(
                    'Unsupported construct in text area content, type: ' +
                    str(child.type))
    return errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1612

Maxime Perrotin's avatar
Maxime Perrotin committed
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
def text_area(root, parent=None, context=None):
    ''' Process a text area (DCL, procedure, operators declarations '''
    errors = []
    warnings = []
    ta = ogAST.TextArea()
    coord = False
    for child in root.getChildren():
        if child.type == lexer.CIF:
            userTextStartIndex = child.getTokenStopIndex() + 1
            ta.pos_x, ta.pos_y, ta.width, ta.height = cif(child)
            coord = True
        elif child.type == lexer.TEXTAREA_CONTENT:
            ta.line = child.getLine()
            ta.charPositionInLine = child.getCharPositionInLine()
            # Go update the process-level list of variables
            # (TODO: also ops and procedures)
            err, warn = text_area_content(child, ta, context)
            errors.extend(err)
            warnings.extend(warn)
        elif child.type == lexer.ENDTEXT:
            userTextStopIndex = child.getTokenStartIndex() - 1
            ta.inputString = token_stream(child).toString(
                    userTextStartIndex, userTextStopIndex).strip()
        elif child.type == lexer.HYPERLINK:
            ta.hyperlink = child.getChild(0).toString()[1:-1]
        else:
            warnings.append('Unsupported construct in text area, type: ' +
                    str(child.type))
    # Report errors with symbol coordinates
    if coord:
        errors = [[e, [ta.pos_x, ta.pos_y]] for e in errors]
        warnings = [[w, [ta.pos_x, ta.pos_y]] for w in warnings]
    return ta, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1647

Maxime Perrotin's avatar
Maxime Perrotin committed
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
def signal(root):
    ''' SIGNAL definition: name and optional list of types '''
    errors, warnings = [], []
    new_signal = {}
    for child in root.getChildren():
        if child.type == lexer.ID:
            new_signal['name'] = child.text
        elif child.type == lexer.PARAMNAMES:
            try:
                param_name, = [par.text for par in child.getChildren()]
                new_signal['param_name'] = param_name
            except ValueError:
                # Will be raised and reported at PARAMS token
                pass
        elif child.type == lexer.PARAMS:
            try:
                param, = [par.text for par in child.getChildren()]
                new_signal['type'] = sdl_to_asn1(param)
            except ValueError:
                errors.append(new_signal['name'] + ' cannot have more' +
                  ' than one parameter. Check signal declaration.')
    return new_signal, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1671

Maxime Perrotin's avatar
Maxime Perrotin committed
1672
1673
1674
1675
1676
1677
1678
def single_route(root):
    ''' Route (from id to id with [signal id] '''
    route = {'source': root.getChild(0).text,
             'dest': root.getChild(1).text,
             'signals': [sig.text for sig in root.getChildren()[2:]]}
    return route

Maxime Perrotin's avatar
Maxime Perrotin committed
1679

Maxime Perrotin's avatar
Maxime Perrotin committed
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
def channel_signalroute(root):
    ''' Channel/signalroute definition (connections) '''
    # no AST entry for edges - a simple dict is sufficient
    # (name, [route])
    edge = {'routes': []}
    for child in root.getChildren():
        if child.type == lexer.ID:
            edge['name'] = child.text
        elif child.type == lexer.ROUTE:
            edge['routes'].append(single_route(child))
    return edge

Maxime Perrotin's avatar
Maxime Perrotin committed
1692

Maxime Perrotin's avatar
Maxime Perrotin committed
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
def block_definition(root, parent):
    ''' BLOCK entity definition '''
    errors, warnings = [], []
    block = ogAST.Block()
    block.parent = parent
    parent.blocks.append(block)
    for child in root.getChildren():
        if child.type == lexer.ID:
            block.name = child.text
        elif child.type == lexer.SIGNAL:
            sig, err, warn = signal(child)
            errors.extend(err)
            warnings.extend(warn)
            block.signals.append(sig)
        elif child.type == lexer.CONNECTION:
            block.connections.append({'channel': cnx[0].text,
              'signalroute': cnx[1].text} for cnx in child.getChildren())
        elif child.type == lexer.BLOCK:
            block, err, warn = block_definition(child, parent=block)
            errors.extend(err)
            warnings.extend(warn)
        elif child.type == lexer.PROCESS:
            proc, err, warn = process_definition(child, parent=block)
Maxime Perrotin's avatar
Maxime Perrotin committed
1716
            block.processes.append(proc)
Maxime Perrotin's avatar
Maxime Perrotin committed
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
            errors.extend(err)
            warnings.extend(warn)
        elif child.type == lexer.SIGNALROUTE:
            sigroute = channel_signalroute(child)
            block.signalroutes.append(sigroute)
        else:
            warnings.append('Unsupported block child type: ' +
                str(child.type))
    return block, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1727

Maxime Perrotin's avatar
Maxime Perrotin committed
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
def system_definition(root, parent):
    ''' SYSTEM part - contains blocks, procedures and channels '''
    errors, warnings = [], []
    system = ogAST.System()
    # Store the name of the file where the system is defined
    system.filename = node_filename(root)
    system.ast = parent
    for child in root.getChildren():
        if child.type == lexer.ID:
            system.name = child.text
            LOG.debug('System name: ' + system.name)
        elif child.type == lexer.SIGNAL:
            sig, err, warn = signal(child)
            errors.extend(err)
            warnings.extend(warn)
            system.signals.append(sig)
            LOG.debug('Found signal: ' + str(sig))
        elif child.type == lexer.PROCEDURE:
            LOG.debug('procedure declaration')
            proc, err, warn = procedure(
                    child, parent=None, context=system)
            errors.extend(err)
            warnings.extend(warn)
            system.procedures.append(proc)
            LOG.debug('Added procedure: ' + proc.inputString)
        elif child.type == lexer.CHANNEL:
            LOG.debug('channel declaration')
            channel = channel_signalroute(child)
            system.channels.append(channel)
        elif child.type == lexer.BLOCK:
            LOG.debug('block declaration')
            block, err, warn = block_definition(child, parent=system)
            errors.extend(err)
            warnings.extend(warn)
1762
1763
1764
1765
        else:
            warnings.append('Unsupported construct in system: ' +
                    str(child.type))
    return system, errors, warnings
Maxime Perrotin's avatar
Maxime Perrotin committed
1766

Maxime Perrotin's avatar
Maxime Perrotin committed
1767

Maxime Perrotin's avatar
Maxime Perrotin committed
1768
def process_definition(root, parent=None, context=None):
Maxime Perrotin's avatar
Maxime Perrotin committed
1769
1770
1771
1772
1773
1774
    ''' Process definition analysis '''
    errors = []
    warnings = []
    process = ogAST.Process()
    process.filename = node_filename(root)
    process.parent = parent
1775
    coord = False
Maxime Perrotin's avatar
Maxime Perrotin committed
1776
    # Prepare the transition/state mapping
1777
    process.mapping = {name: [] for name in get_state_list(root)}
Maxime Perrotin's avatar
Maxime Perrotin committed
1778
    for child in root.getChildren():
1779
1780
1781
1782
1783
1784
        if child.type == lexer.CIF:
            # Get symbol coordinates
            process.pos_x, process.pos_y, process.width, process.height =\
                    cif(child)
            coord = True
        elif child.type == lexer.ID:
Maxime Perrotin's avatar
Maxime Perrotin committed
1785
1786
1787
1788
            # Get process (taste function) name
            process.processName = child.text
            try:
                # Retrieve process interface (PI/RI)
1789
                async_signals, procedures = get_interfaces(parent, child.text)
Maxime Perrotin's avatar
Maxime Perrotin committed
1790
                process.input_signals.extend([sig for sig in async_signals
1791
                                             if sig['direction'] == 'in'])
Maxime Perrotin's avatar
Maxime Perrotin committed
1792
                process.output_signals.extend([sig for sig in async_signals
1793
                                              if sig['direction'] == 'out'])
Maxime Perrotin's avatar
Maxime Perrotin committed
1794
1795
                process.procedures.extend(procedures)
            except AttributeError as err:
Maxime Perrotin's avatar
Maxime Perrotin committed
1796
1797
                # No interface because process is defined standalone
                LOG.debug('Discarding process ' + child.text + ' ' + str(err))
Maxime Perrotin's avatar
Maxime Perrotin committed
1798
1799
1800
            except TypeError as error:
                LOG.debug(str(error))
                errors.append(str(error))
1801
1802
1803
1804
            if coord:
                errors = [[e, [process.pos_x, process.pos_y]] for e in errors]
                warnings = [[w, [process.pos_x, process.pos_y]]
                             for w in warnings]
Maxime Perrotin's avatar
Maxime Perrotin committed
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
        elif child.type == lexer.TEXTAREA:
            # Text zone where variables and operators are declared
            textarea, err, warn = text_area(child, context=process)
            errors.extend(err)
            warnings.extend(warn)
            process.content.textAreas.append(textarea)
        elif child.type == lexer.START:
            # START transition (fills the mapping structure)
            process.content.start, err, warn = start(
                                             child, context=process)
            errors.extend(err)
            warnings.extend(warn)
        elif child.type == lexer.STATE:
            # STATE - fills up the 'mapping' structure.
            statedef, err, warn = state(
                    child, parent=None, context=process)
            errors.extend(err)
            warnings.extend(warn)
            process.content.states.append(statedef)
        elif child.type == lexer.NUMBER_OF_INSTANCES:
            # Number of instances - discarded (working on a single process)
            pass
        elif child.type == lexer.PROCEDURE:
            proc, err, warn = procedure(
                    child, parent=None, context=process)
            errors.extend(err)
            warnings.extend(warn)
            process.content.inner_procedures.append(proc)
1833
1834
            # Add it at process level so that it is in the scope
            process.procedures.append(proc)
Maxime Perrotin's avatar
Maxime Perrotin committed
1835
1836
1837
1838
1839
1840
        elif child.type == lexer.FLOATING_LABEL:
            lab, err, warn = floating_label(
                    child, parent=None, context=process)
            errors.extend(err)
            warnings.extend(warn)
            process.content.floating_labels.append(lab)
1841
        elif child.type == lexer.COMPOSITE_STATE:
1842
1843
1844
1845
1846
1847
            comp, err, warn = composite_state(child,
                                              parent=None,
                                              context=process)
            errors.extend(err)
            warnings.extend(warn)
            process.composite_states.append(comp)
Maxime Perrotin's avatar
Maxime Perrotin committed
1848
1849
1850
        elif child.type == lexer.REFERENCED:
            process.referenced = True
        else:
1851
1852
1853
            warnings.append('Unsupported process definition child: ' +
                             sdl92Parser.tokenNames[child.type] +
                            ' - line ' + str(child.getLine()))
Maxime Perrotin's avatar
Maxime Perrotin committed
1854
1855
    return process, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1856

Maxime Perrotin's avatar
Maxime Perrotin committed
1857
1858
1859
def input_part(root, parent, context):
    ''' Parse an INPUT - set of TASTE provided interfaces '''
    i = ogAST.Input()
Maxime Perrotin's avatar
Maxime Perrotin committed
1860
    warnings, errors = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
    coord = False
    # Keep track of the number of terminator statements follow the input
    # useful if we want to render graphs from the SDL model
    terminators = len(context.terminators)
    for child in root.getChildren():
        if child.type == lexer.CIF:
            # Get symbol coordinates
            i.pos_x, i.pos_y, i.width, i.height = cif(child)
            coord = True
        elif child.type == lexer.INPUTLIST:
            i.inputString = get_input_string(child)
            i.line = child.getLine()
            i.charPositionInLine = child.getCharPositionInLine()
            # get input name and parameters (support for one parameter only)
            sig_param_type, user_param_type = None, None
            inputnames = [c for c in child.getChildren()
                                                  if c.type != lexer.PARAMS]
            for inputname in inputnames:
                for inp_sig in context.input_signals:
                    if inp_sig['name'].lower() == inputname.text.lower():
                        i.inputlist.append(inp_sig['name'])
                        sig_param_type = inp_sig.get('type')
                        break
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
1885
                    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895