ogParser.py 138 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

LOG = logging.getLogger(__name__)

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

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

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],
110
111
112
113
                     'abs': [NUMERICAL],
                     'float': [NUMERICAL],
                     'fix': [NUMERICAL],
                     'power': [NUMERICAL, INTEGER]}
Maxime Perrotin's avatar
Maxime Perrotin committed
114
115
116
117

# 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,), {})
118
                    for a, b in lexer.__dict__.viewitems() if type(b) == int}
Maxime Perrotin's avatar
Maxime Perrotin committed
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133


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


134
135
136
137
138
139
140
141
142
143
def is_numeric(ty):
    ''' Return true if a type is numeric '''
    return find_basic_type(ty).kind in (
        'IntegerType',
        'Integer32Type',
        'Numerical',
        'RealType'
    )


Maxime Perrotin's avatar
Maxime Perrotin committed
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
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:
241
242
            # Go to the block where the process is defined
            process_parent = process_ref.parent
Maxime Perrotin's avatar
Maxime Perrotin committed
243
244
245
            break
    else:
        if isinstance(ast, ogAST.Block):
246
            process_parent = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
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
        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())


dbarbera's avatar
dbarbera committed
274
275
276
277
278
279
280
281
282
283
def error(root, msg):
    ''' Return an error message '''
    return '{} - line {}'.format(msg, root.getLine())


def warning(root, msg):
    ''' Return a warning message '''
    return '{} - line {}'.format(msg, root.getLine())


dbarbera's avatar
dbarbera committed
284
285
286
287
288
289
290
291
def tmp():
    ''' Return a temporary variable name '''
    global TMPVAR
    varname = TMPVAR
    TMPVAR += 1
    return varname


Maxime Perrotin's avatar
Maxime Perrotin committed
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
def 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
dbarbera's avatar
dbarbera committed
328
    if DV and isinstance(var, ogAST.PrimVariable):
Maxime Perrotin's avatar
Maxime Perrotin committed
329
330
331
332
333
334
335
336
337
338
        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 '''
339
    if op_name.lower() in ('length', 'present', 'abs', 'float', 'fix'):
Maxime Perrotin's avatar
Maxime Perrotin committed
340
341
342
343
344
        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:
345
            expr.exprType = find_variable(expr.value[0], context)
Maxime Perrotin's avatar
Maxime Perrotin committed
346
347
348
349
350
351
352
            # 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')
353
354
355
356
357
358
359
360
361
        elif op_name.lower() in ('abs', 'float', 'fix') and not basic.kind in (
                'IntegerType', 'Integer32Type', 'RealType', 'NumericalType'):
            raise TypeError('"{}" operator needs a numerical parameter'.format(
                op_name))
    elif op_name.lower() == 'power':
        if len(expr_list) != 2:
            raise AttributeError('The "power" operator takes two parameters')
        for idx, expr in enumerate(expr_list):
            if expr.exprType is UNKNOWN_TYPE:
362
                expr.exprType = find_variable(expr.value[0], context)
363
364
365
366
367
368
369
                # XXX should change type to PrimVariable
            if idx == 0 and not find_basic_type(expr.exprType).kind in (
                    'IntegerType', 'Integer32Type', 'Numerical', 'RealType'):
                raise TypeError('First parameter of power must be numerical')
            elif idx == 1 and not find_basic_type(expr.exprType).kind in (
                    'IntegerType', 'Integer32Type'):
                raise TypeError('Second parameter of power must be integer')
Maxime Perrotin's avatar
Maxime Perrotin committed
370
371
372
    elif op_name.lower() in ('write', 'writeln'):
        for param in expr_list:
            if param.exprType is UNKNOWN_TYPE:
373
                for each in (INTEGER, REAL, BOOLEAN, RAWSTRING, OCTETSTRING):
374
375
                    try:
                        check_type_compatibility(param, each, context)
376
377
378
379
380
                        if each is OCTETSTRING and isinstance(param,
                                                         ogAST.PrimIfThenElse):
                            param.exprType = param.value['then'].exprType
                        else:
                            param.exprType = each
381
382
383
384
385
386
387
388
                        break
                    except TypeError:
                        continue
                else:
                    # Type not found among supported types
                    # Has to be a variable...otherwise, error!
                    try:
                        param.exprType = find_variable(param.value[0], context)
dbarbera's avatar
dbarbera committed
389
                    except (KeyError, AttributeError):
390
391
                        raise TypeError('Could not determine type of argument'
                                        ' "{}"'.format(param.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
392
393
394
395
396
397
            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
398
399
400
401
402
403
404
    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
405
        for each in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
406
407
408
409
410
411
412
413
414
415
416
417
418
            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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
    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)
445
        for inner_proc in context.procedures:
Maxime Perrotin's avatar
Maxime Perrotin committed
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
            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()
dbarbera's avatar
dbarbera committed
475
        expr.left = ogAST.PrimVariable()
Maxime Perrotin's avatar
Maxime Perrotin committed
476
477
478
479
        expr.left.exprType = dataview_type
        expr.right = param
        fix_expression_types(expr, context)
        expr_list[idx] = expr.right
480
481
482
483
        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
484
485


Maxime Perrotin's avatar
Maxime Perrotin committed
486
487
488
def check_range(typeref, type_to_check):
    ''' Verify the that the Min/Max bounds of two types are compatible
        Called to test that assignments are withing allowed range
dbarbera's avatar
dbarbera committed
489
        both types assumed to be basic types
Maxime Perrotin's avatar
Maxime Perrotin committed
490
491
492
493
494
495
496
497
    '''
    try:
        if float(type_to_check.Min) < float(typeref.Min) \
                or float(type_to_check.Max) > float(typeref.Max):
            raise TypeError('Expression evaluation in range [{}..{}], '
                            'outside expected range [{}..{}]'
                    .format(type_to_check.Min, type_to_check.Max,
                            typeref.Min, typeref.Max))
498
    except (AttributeError, ValueError):
Maxime Perrotin's avatar
Maxime Perrotin committed
499
500
501
        raise TypeError('Missing range')


Maxime Perrotin's avatar
Maxime Perrotin committed
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
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:
529
            err = ('Value "' + primary.inputString +
Maxime Perrotin's avatar
Maxime Perrotin committed
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
                   '" 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:
547
548
549
550
551
552
                    if expr.exprType is UNKNOWN_TYPE:
                        # If it was not resolved before, it must be a variable
                        # this can happen in the context of a special operator
                        # (write), where at no point before where the type
                        # could be compared to another type
                        expr.exprType = find_variable(expr.value[0], context)
Maxime Perrotin's avatar
Maxime Perrotin committed
553
554
555
556
557
558
559
560
561
562
563
564
565
566
                    compare_types(expr.exprType, typeRef)
        return
    elif isinstance(primary, ogAST.PrimVariable):
        try:
            compare_types(primary.exprType, typeRef)
        except TypeError as err:
            raise TypeError('{expr} should be of type {ty} - {err}'
                            .format(expr=primary.inputString,
                                    ty=type_name(typeRef),
                                    err=str(err)))
        return
    elif isinstance(primary, ogAST.PrimInteger) \
            and actual_type.kind.startswith('Integer'):
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
567

Maxime Perrotin's avatar
Maxime Perrotin committed
568
569
570
    elif isinstance(primary, ogAST.PrimReal) \
            and actual_type.kind.startswith('Real'):
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
571

Maxime Perrotin's avatar
Maxime Perrotin committed
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
    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
615
                            compare_types(
dbarbera's avatar
dbarbera committed
616
                                    primary.value[ufield].exprType, fd_data.type)
Maxime Perrotin's avatar
Maxime Perrotin committed
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
                        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
644
645
                raise TypeError(
                            'Field {field} in CHOICE is not of type {t1} - {e}'
Maxime Perrotin's avatar
Maxime Perrotin committed
646
647
648
649
650
651
                            .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) \
dbarbera's avatar
dbarbera committed
652
                and actual_type.kind.startswith('Choice'):
Maxime Perrotin's avatar
Maxime Perrotin committed
653
654
        for choicekey, choice in actual_type.EnumValues.viewitems():
            if choicekey.replace('-', '_').lower() == \
dbarbera's avatar
dbarbera committed
655
                    primary.inputString.lower():
Maxime Perrotin's avatar
Maxime Perrotin committed
656
657
658
659
660
661
662
663
664
                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)
665
        if basic_type.kind == 'StandardStringType':
Maxime Perrotin's avatar
Maxime Perrotin committed
666
            return
667
668
        elif basic_type.kind.endswith('StringType'):
            if int(basic_type.Min) <= len(
dbarbera's avatar
dbarbera committed
669
                    primary.value[1:-1]) <= int(basic_type.Max):
670
671
672
673
                return
            else:
                raise TypeError('Invalid string literal - check that length is'
                                'within the bound limits {Min}..{Max}'.format
Maxime Perrotin's avatar
Maxime Perrotin committed
674
                            (Min=str(basic_type.Min), Max=str(basic_type.Max)))
675
676
        else:
            raise TypeError('String literal not expected')
Maxime Perrotin's avatar
Maxime Perrotin committed
677
678
679
680
681
682
683
684
685
686
    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
687

Maxime Perrotin's avatar
Maxime Perrotin committed
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
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
dbarbera's avatar
dbarbera committed
714
    elif type_a.kind.endswith('StringType') and type_b.kind.endswith('StringType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
715
716
        # Allow Octet String values to be printable strings.. for convenience
        return
Maxime Perrotin's avatar
Maxime Perrotin committed
717
718
719
720
721
722
723
    elif not(type_a.kind in ('IntegerType', 'Integer32Type') and
             type_b.kind in ('IntegerType', 'Integer32Type')):
        raise TypeError('One type is an integer, not the other one')
    elif any(side.kind == 'RealType' for side in (type_a, type_b)):
        raise TypeError('One type is an REAL, not the other one')
    elif all(side.kind.startswith('Integer') for side in (type_a, type_b)) \
            or all(side.kind == 'RealType' for side in (type_a, type_b)):
Maxime Perrotin's avatar
Maxime Perrotin committed
724
        pass
Maxime Perrotin's avatar
Maxime Perrotin committed
725
726
727
728
729
730
731
732
733
    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
734
735
    all_visible_variables = dict(context.global_variables)
    all_visible_variables.update(context.variables)
Maxime Perrotin's avatar
Maxime Perrotin committed
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
    # 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
751
    for timer in chain(context.timers, context.global_timers):
Maxime Perrotin's avatar
Maxime Perrotin committed
752
753
754
755
756
757
758
759
        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))


760
def fix_expression_types(expr, context):
dbarbera's avatar
dbarbera committed
761
    ''' Check/ensure type consistency in binary expressions '''
762
    # If a side of the expression is of Enumerated or Choice type, check if
763
    # the other side is a literal of that sort, and change type accordingly
764
    for side in permutations(('left', 'right')):
765
766
767
768
769
770
771
772
773
774
775
776
777
778
        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
779
    for side in permutations(('left', 'right')):
780
781
782
783
784
785
786
787
788
789
790
791
        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

792
793
794
795
796
797
798
799
800
801
802
803
804
    # If a side is a raw Sequence Of with unknown type, try to resolve it
    for side in permutations(('left', 'right')):
        value = getattr(expr, side[0])  # get expr.left then expr.right
        if not isinstance(value, ogAST.PrimSequenceOf):
            continue
        other = getattr(expr, side[1])  # other side
        basic = find_basic_type(value.exprType)
        if basic.kind == 'SequenceOfType' and basic.type == UNKNOWN_TYPE:
            asn_type = find_basic_type(other.exprType)
            if asn_type.kind == 'SequenceOfType':
                asn_type = asn_type.type
                for idx, elem in enumerate(value.value):
                    check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
805
                    check_expr.left = ogAST.PrimVariable()
806
807
808
809
810
811
812
                    check_expr.left.exprType = asn_type
                    check_expr.right = elem
                    fix_expression_types(check_expr, context)
                    value.value[idx] = check_expr.right
            # the type of the raw PrimSequenceOf can be set now
            value.exprType.type = asn_type

813
814
815
    if isinstance(expr, ogAST.ExprIn):
        return

816
    if not expr.right.is_raw and not expr.left.is_raw:
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
        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(
dbarbera's avatar
dbarbera committed
835
                            field.replace('_', '-')).type
836
837
838
                except AttributeError:
                    raise TypeError('Field not found: ' + field)
                check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
839
                check_expr.left = ogAST.PrimVariable()
840
841
842
843
844
845
846
847
848
849
850
                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()]:
851
            raise TypeError('Field is not valid in CHOICE:' + field)
852
853
854
855
856
857
858
859
        key, = [key for key in asn_type.Children.viewkeys()
                if key.lower() == field.lower()]
        if expr.right.value['value'].exprType == UNKNOWN_TYPE:
            try:
                expected_type = asn_type.Children.get(key).type
            except AttributeError:
                raise TypeError('Field not found in CHOICE: ' + field)
            check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
860
            check_expr.left = ogAST.PrimVariable()
861
862
863
864
865
866
867
868
            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'):
            # Recursively fix possibly missing types in the expression
            check_expr = ogAST.ExprAssign()
dbarbera's avatar
dbarbera committed
869
            check_expr.left = ogAST.PrimVariable()
870
871
872
873
874
875
876
            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

    if expr.right.is_raw != expr.left.is_raw:
        check_type_compatibility(raw_expr, ref_type, context)
Maxime Perrotin's avatar
Maxime Perrotin committed
877
878
879
880
        if not raw_expr.exprType.kind.startswith(('Integer', 'Real')):
            # Raw int/real must keep their type because of the range
            # that can be computed
            raw_expr.exprType = ref_type
881
882
883
    else:
        compare_types(expr.left.exprType, expr.right.exprType)

Maxime Perrotin's avatar
Maxime Perrotin committed
884

Maxime Perrotin's avatar
Maxime Perrotin committed
885
886
887
888
889
890
891
892
893
894
895
896
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
897

dbarbera's avatar
dbarbera committed
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
def primary_variable(root, context):
    ''' Primary Variable analysis '''
    lexeme = root.children[0].text

    # Differentiate DCL and FPAR variables
    Prim = ogAST.PrimVariable
    if isinstance(context, ogAST.Procedure):
        for each in context.fpar:
            if each['name'].lower() == lexeme.lower():
                Prim = ogAST.PrimFPAR
                break

    prim, errors, warnings = Prim(), [], []
    prim.value = [root.children[0].text]
    prim.exprType = UNKNOWN_TYPE
    prim.inputString = get_input_string(root)
    prim.tmpVar = tmp()

    try:
        prim.exprType = find_variable(lexeme, context)
    except AttributeError:
        pass

    return prim, errors, warnings


dbarbera's avatar
dbarbera committed
924
925
926
def binary_expression(root, context):
    ''' Binary expression analysys '''
    errors, warnings = [], []
dbarbera's avatar
dbarbera committed
927

dbarbera's avatar
dbarbera committed
928
929
    ExprNode = EXPR_NODE[root.type]
    expr = ExprNode(
930
931
932
933
        get_input_string(root),
        root.getLine(),
        root.getCharPositionInLine()
    )
dbarbera's avatar
dbarbera committed
934
935
    expr.exprType = UNKNOWN_TYPE
    expr.tmpVar = tmp()
936
937
938
939
940
941
942
943
944

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

945
946
947
948
949
    try:
        fix_expression_types(expr, context)
    except (AttributeError, TypeError) as err:
        errors.append(error(root, str(err)))

950
951
952
953
954
    return expr, errors, warnings


def unary_expression(root, context):
    ''' Unary expression analysys '''
dbarbera's avatar
dbarbera committed
955
956
957
958
959
960
961
962
    ExprNode = EXPR_NODE[root.type]
    expr = ExprNode(
        get_input_string(root),
        root.getLine(),
        root.getCharPositionInLine()
    )
    expr.exprType = UNKNOWN_TYPE
    expr.tmpVar = tmp()
963

dbarbera's avatar
dbarbera committed
964
    expr.expr, errors, warnings = expression(root.children[0], context)
965
966
967
968

    return expr, errors, warnings


Maxime Perrotin's avatar
Maxime Perrotin committed
969
970
def expression(root, context):
    ''' Expression analysis (e.g. 5+5*hello(world)!foo) '''
971
972
973
974
    logic = (lexer.OR, lexer.AND, lexer.XOR)
    arithmetic = (lexer.PLUS, lexer.ASTERISK, lexer.DASH, lexer.DIV, lexer.MOD, lexer.REM)
    relational = (lexer.EQ, lexer.NEQ, lexer.GT, lexer.GE, lexer.LT, lexer.LE)

975
    if root.type in logic:
976
977
978
979
980
981
982
983
984
985
986
987
988
        return logic_expression(root, context)
    elif root.type in arithmetic:
        return arithmetic_expression(root, context)
    elif root.type in relational:
        return relational_expression(root, context)
    elif root.type == lexer.IN:
        return in_expression(root, context)
    elif root.type == lexer.APPEND:
        return append_expression(root, context)
    elif root.type == lexer.NOT:
        return not_expression(root, context)
    elif root.type == lexer.NEG:
        return neg_expression(root, context)
989
990
991
992
    elif root.type == lexer.PAREN:
        return expression(root.children[0], context)
    elif root.type == lexer.IFTHENELSE:
        return if_then_else_expression(root, context)
993
994
    elif root.type == lexer.PRIMARY:
        return primary(root.children[0], context)
995
996
997
998
    elif root.type == lexer.CALL:
        return call_expression(root, context)
    elif root.type == lexer.SELECTOR:
        return selector_expression(root, context)
999
1000
1001
1002
1003
1004
    else:
        raise NotImplementedError


def logic_expression(root, context):
    ''' Logic expression analysis '''
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
    shortcircuit = ''
    # detect optional THEN in AND/OR expressions, indicating that the
    # short-circuit version of the operator is needed, to prevent the
    # evaluation of the right part if the left part does not evaluate
    # to true.
    if root.type in (lexer.OR, lexer.AND) and len(root.children) == 3:
        if root.children[1].type in (lexer.THEN, lexer.ELSE):
            root.children.pop(1)
            shortcircuit = ' else' if root.type == lexer.OR else ' then'

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

dbarbera's avatar
dbarbera committed
1018
1019
1020
1021
1022
1023
1024
1025
1026
    left_bty = find_basic_type(expr.left.exprType)
    right_bty = find_basic_type(expr.right.exprType)
    for bty in left_bty, right_bty:
        if bty.kind in ('BooleanType', 'BitStringType'):
            continue
        elif bty.kind == 'SequenceOfType' and bty.type.kind == 'BooleanType':
            continue
        else:
            msg = 'Bitwise operators only work with booleans and arrays of booleans'
dbarbera's avatar
dbarbera committed
1027
            errors.append(error(root, msg))
dbarbera's avatar
dbarbera committed
1028
1029
1030

    # TODO: Is this correct?
    if left_bty.kind == right_bty.kind == 'BooleanType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1031
        expr.exprType = BOOLEAN
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
    else:
        expr.exprType = expr.left.exprType

    return expr, errors, warnings


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

Maxime Perrotin's avatar
Maxime Perrotin committed
1042
1043
    # Expressions returning a numerical type must have their range defined
    # accordingly with the kind of opration used between operand:
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
    basic = find_basic_type(expr.left.exprType)
    left = find_basic_type(expr.left.exprType)
    right = find_basic_type(expr.right.exprType)
    try:
        if isinstance(expr, ogAST.ExprPlus):
            attrs = {'Min': str(float(left.Min) + float(right.Min)),
                     'Max': str(float(left.Max) + float(right.Max))}
            expr.exprType = type('Plus', (basic,), attrs)
        elif isinstance(expr, ogAST.ExprMul):
            attrs = {'Min': str(float(left.Min) * float(right.Min)),
                     'Max': str(float(left.Max) * float(right.Max))}
            expr.exprType = type('Mul', (basic,), attrs)
        elif isinstance(expr, ogAST.ExprMinus):
            attrs = {'Min': str(float(left.Min) - float(right.Min)),
                     'Max': str(float(left.Max) - float(right.Max))}
            expr.exprType = type('Minus', (basic,), attrs)
        elif isinstance(expr, ogAST.ExprDiv):
            attrs = {'Min': str(float(left.Min) / (float(right.Min) or 1)),
                     'Max': str(float(left.Max) / (float(right.Max) or 1))}
            expr.exprType = type('Div', (basic,), attrs)
        elif isinstance(expr, (ogAST.ExprMod, ogAST.ExprRem)):
            attrs = {'Min': right.Min, 'Max': right.Max}
            expr.exprType = type('Mod', (basic,), attrs)
    except (ValueError, AttributeError):
1068
        msg = 'Check that all your numerical data types have a range constraint'
dbarbera's avatar
dbarbera committed
1069
        errors.append(error(root, msg))
1070

1071
    return expr, errors, warnings
dbarbera's avatar
dbarbera committed
1072

Maxime Perrotin's avatar
Maxime Perrotin committed
1073

1074
1075
1076
def relational_expression(root, context):
    ''' Relational expression analysys '''
    expr, errors, warnings = binary_expression(root, context)
dbarbera's avatar
dbarbera committed
1077

1078
1079
1080
1081
1082
1083
    if root.type not in (lexer.EQ, lexer.NEQ):
        for ty in (expr.left.exprType, expr.right.exprType):
            if not is_numeric(ty):
                errors.append(error(root,
                    'Operands in relational expressions must be numerical'))
                break
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095

    expr.exprType = BOOLEAN

    return expr, errors, warnings


def in_expression(root, context):
    ''' In expression analysis '''
    # Left and right are reversed for IN operator
    root.children[0], root.children[1] = root.children[1], root.children[0]

    expr, errors, warnings = binary_expression(root, context)
dbarbera's avatar
dbarbera committed
1096
    expr.exprType = BOOLEAN
1097

dbarbera's avatar
dbarbera committed
1098
1099
1100
1101
1102
1103
1104
1105
    # 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:
        msg = 'IN expression: right part must be a list'
dbarbera's avatar
dbarbera committed
1106
        errors.append(error(root, msg))
dbarbera's avatar
dbarbera committed
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
        return expr, errors, warnings

    compare_types(expr.right.exprType, ref_type)
    if expr.right.is_raw and expr.left.is_raw:
        # If both sides are raw (e.g. "3 in {1,2,3}"), evaluate expression
        bool_expr = ogAST.PrimBoolean()
        bool_expr.inputString = expr.inputString
        bool_expr.line = expr.line
        bool_expr.charPositionInLine = expr.charPositionInLine
        bool_expr.exprType = type('PrBool', (object,), {'kind': 'BooleanType'})
        if expr.right.value in [each.value for each in expr.left.value]:
            bool_expr.value = ['true']
1119
            warnings.append('Expression {} is always true'.format(expr.inputString))
dbarbera's avatar
dbarbera committed
1120
1121
        else:
            bool_expr.value = ['false']
1122
            warnings.append('Expression {} is always false'.format(expr.inputString))
dbarbera's avatar
dbarbera committed
1123
        expr = bool_expr
1124
1125
1126
1127
1128
1129
1130
1131

    return expr, errors, warnings


def append_expression(root, context):
    ''' Append expression analysis '''
    expr, errors, warnings = binary_expression(root, context)

1132
    # TODO: Check types
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149

    expr.exprType = expr.left.exprType
    return expr, errors, warnings


def not_expression(root, context):
    ''' Not expression analysis '''
    expr, errors, warnings = unary_expression(root, context)

    bty = find_basic_type(expr.expr.exprType)
    if bty.kind in ('BooleanType', ):
        expr.exprType = BOOLEAN
    elif bty.kind == 'BitStringType':
        expr.exprType = expr.expr.exprType
    elif bty.kind == 'SequenceOfType' and bty.type.kind == 'BooleanType':
        expr.exprType = expr.expr.exprType
    else:
1150
        msg = 'Bitwise operators only work with booleans and arrays of booleans'
dbarbera's avatar
dbarbera committed
1151
        errors.append(error(root, msg))
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161

    return expr, errors, warnings


def neg_expression(root, context):
    ''' Negative expression analysis '''
    expr, errors, warnings = unary_expression(root, context)

    basic = find_basic_type(expr.expr.exprType)
    if not basic.kind in ('IntegerType', 'Integer32Type', 'RealType'):
1162
        msg = 'Negative expressions can only be applied to numeric types'
dbarbera's avatar
dbarbera committed
1163
        errors.append(error(root, msg))
1164
1165
1166
1167
1168
1169
        return expr, errors, warnings

    try:
        attrs = {'Min': str(-float(basic.Max)), 'Max': str(-float(basic.Min))}
        expr.exprType = type('Neg', (basic,), attrs)
    except (ValueError, AttributeError):
1170
        msg = 'Check that all your numerical data types have a range constraint'
dbarbera's avatar
dbarbera committed
1171
        errors.append(error(root, msg))
Maxime Perrotin's avatar
Maxime Perrotin committed
1172
1173
1174

    return expr, errors, warnings

Maxime Perrotin's avatar
Maxime Perrotin committed
1175

1176
1177
def if_then_else_expression(root, context):
    ''' If Then Else expression analysis '''
dbarbera's avatar
dbarbera committed
1178
1179
1180
1181
1182
1183
1184
1185
1186
    errors, warnings = [], []

    expr = ogAST.PrimIfThenElse(
        get_input_string(root),
        root.getLine(),
        root.getCharPositionInLine()
    )
    expr.exprType = UNKNOWN_TYPE
    expr.tmpVar = tmp()
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212

    if_part, then_part, else_part = root.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)

    # TODO: Refactor this
    expr.value = {
        'if': if_expr,
        'then': then_expr,
        'else': else_expr,
        'tmpVar': expr.tmpVar
    }

    return expr, errors, warnings


1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
def call_expression(root, context):
    ''' Call expression analysis '''
    errors, warnings = [], []

    if root.children[0].type == lexer.PRIMARY:
        primary = root.children[0]
        if primary.children[0].type == lexer.VARIABLE:
            variable = primary.children[0]
            ident = variable.children[0].text.lower()
            proc_list = [proc.inputString.lower() for proc in context.procedures]
            if ident in (SPECIAL_OPERATORS.keys() + proc_list):
                return primary_call(root, context)

    num_params = len(root.children[1].children)

    if num_params == 1:
        return primary_index(root, context)

    elif num_params == 2:
        return primary_substring(root, context)

    else:
        node = ogAST.PrimCall()  # Use error node instead?
        node.inputString = get_input_string(root)
        node.exprType = UNKNOWN_TYPE
dbarbera's avatar
dbarbera committed
1238
        errors.append(error(root, 'Wrong number of parameters'))
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
        return node, errors, warnings


def primary_call(root, context):
    ''' Primary call analysis '''
    node, errors, warnings = ogAST.PrimCall(), [], []

    node.exprType = UNKNOWN_TYPE
    node.inputString = get_input_string(root)
    node.tmpVar = tmp()

    ident = root.children[0].children[0].children[0].text.lower()

    params, params_errors, param_warnings = expression_list(root.children[1], context)
    errors.extend(params_errors)
    warnings.extend(param_warnings)

    try:
        check_and_fix_op_params(ident, params, context)
    except (AttributeError, TypeError) as err:
dbarbera's avatar
dbarbera committed
1259
        errors.append(error(root, str(err)))
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272

    node.value = [ident, {'procParams': params}]

    params_bty = [find_basic_type(p.exprType) for p in params]

    if ident == 'present':
        node.exprType = type('present', (object,), {
            'kind': 'ChoiceEnumeratedType',
            'EnumValues': {}
        })
        # present(choiceType): must return an enum
        # with elements being the choice options
        if len(params) != 1:
dbarbera's avatar
dbarbera committed
1273
1274
            errors.append(error(root, 'Wrong number of parameters in '
                                      'PRESENT clause (only one expected)'))
1275
1276

        if find_basic_type(params[0].exprType).kind != 'ChoiceType':
dbarbera's avatar
dbarbera committed
1277
            errors.append(error(root, 'PRESENT parameter must be a CHOICE type'))
1278
1279
1280
1281
1282
        else:
            node.exprType.EnumValues = params_bty[0].Children

    elif ident in ('length', 'fix'):
        if len(params) != 1:
dbarbera's avatar
dbarbera committed
1283
1284
1285
            msg = 'Wrong number of parameters in {} operator'.format(ident)
            errors.append(error(root, msg))

1286
1287
1288
1289
1290
        # result is an integer type with range of the param type
        node.exprType = type('fix', (INTEGER,), {
            'Min': params_bty[0].Min,
            'Max': params_bty[0].Max
        })
dbarbera's avatar
dbarbera committed
1291

1292
1293
    elif ident == 'float':
        if len(params) != 1:
dbarbera's avatar
dbarbera committed
1294
1295
1296
            msg = 'Wrong number of parameters in {} operator'.format(ident)
            errors.append(root, msg)

1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
        node.exprType = type('float_op', (REAL,), {
            'Min': params_bty[0].Min,
            'Max': params_bty[0].Max
        })

    elif ident == 'power':
        try:
            node.exprType = type('Power', (params_bty[0],), {
                'Min': str(pow(float(params_bty[0].Min), float(params_bty[1].Min))),
                'Max': str(pow(float(params_bty[0].Max), float(params_bty[1].Max)))
            })
        except OverflowError:
dbarbera's avatar
dbarbera committed
1309
            errors.append(error(root, 'Result can exceeds 64-bits'))
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348

    elif ident == 'abs':
        node.exprType = type('Abs', (params_bty[0],), {
            'Min': str(max(float(params_bty[0].Min), 0)),
            'Max': str(max(float(params_bty[0].Max), 0))
        })

    elif ident in ('write', 'writeln'):
        # write and writeln return void
        pass

    else:
        raise NotImplementedError

    return node, errors, warnings


def primary_index(root, context):
    ''' Primary index analysis '''
    node, errors, warnings = ogAST.PrimIndex(), [], []

    node.exprType = UNKNOWN_TYPE
    node.inputString = get_input_string(root)
    node.tmpVar = tmp()

    receiver, receiver_err, receiver_warn = expression(root.children[0], context)
    receiver_bty = find_basic_type(receiver.exprType)
    errors.extend(receiver_err)
    warnings.extend(receiver_warn)

    params, params_errors, param_warnings = expression_list(root.children[1], context)
    errors.extend(params_errors)
    warnings.extend(param_warnings)

    node.value = [receiver, {'index': params}]

    if receiver_bty.kind == 'SequenceOfType':
        node.exprType = receiver_bty.type
    else:
dbarbera's avatar
dbarbera committed
1349
1350
        msg = 'Element {} cannot have an index'.format(receiver)
        errors.append(error(root, msg))
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376

    return node, errors, warnings


def primary_substring(root, context):
    ''' Primary substring analysis '''
    node, errors, warnings = ogAST.PrimSubstring(), [], []

    node.exprType = UNKNOWN_TYPE
    node.inputString = get_input_string(root)
    node.tmpVar = tmp()

    receiver, receiver_err, receiver_warn = expression(root.children[0], context)
    receiver_bty = find_basic_type(receiver.exprType)
    errors.extend(receiver_err)
    warnings.extend(receiver_warn)

    params, params_errors, param_warnings = expression_list(root.children[1], context)
    errors.extend(params_errors)
    warnings.extend(param_warnings)

    node.value = [receiver, {'substring': params, 'tmpVar': tmp()}]

    if receiver_bty.kind == 'SequenceOfType' or receiver_bty.kind.endswith('StringType'):
        node.exprType = receiver.exprType
    else:
dbarbera's avatar
dbarbera committed
1377
1378
        msg = 'Element {} cannot have a substring'.format(receiver)
        errors.append(error(root, msg))
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403

    return node, errors, warnings


def selector_expression(root, context):
    ''' Selector expression analysis '''
    errors, warnings = [], []

    node = ogAST.PrimSelector()
    node.exprType = UNKNOWN_TYPE
    node.inputString = get_input_string(root)
    node.tmpVar = tmp()

    receiver, receiver_err, receiver_warn = expression(root.children[0], context)
    receiver_bty = find_basic_type(receiver.exprType)
    errors.extend(receiver_err)
    warnings.extend(receiver_warn)

    field_name = root.children[1].text.replace('_', '-').lower()

    for n, f in receiver_bty.Children.viewitems():
        if n.lower() == field_name:
            node.exprType = f.type
            break
    else:
dbarbera's avatar
dbarbera committed
1404
1405
        msg = 'Field "{}" not found in expression {}'.format(field_name)
        errors.append(error(root, msg))
1406
1407
1408
1409
1410
1411

    node.value = [receiver, field_name.replace('-', '_').lower()]

    return node, errors, warnings


1412
def primary(root, context):
1413
1414
1415
    ''' Literal expression analysis '''
    prim, errors, warnings = None, [], []

dbarbera's avatar
dbarbera committed
1416
1417
    if root.type == lexer.VARIABLE:
        return primary_variable(root, context)
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
    elif root.type == lexer.INT:
        prim = ogAST.PrimInteger()
        prim.value = [root.text.lower()]
        prim.exprType = type('PrInt', (object,), {
            'kind': 'IntegerType',
            'Min': root.text,
            'Max': root.text
        })
    elif root.type in (lexer.TRUE, lexer.FALSE):
        prim = ogAST.PrimBoolean()
        prim.value = [root.text.lower()]
        prim.exprType = type('PrBool', (object,), {'kind': 'BooleanType'})
    elif root.type == lexer.FLOAT:
        prim = ogAST.PrimReal()
        prim.value = [root.text]
        prim.exprType = type('PrReal', (object,), {
            'kind': 'RealType',
            'Min': prim.value[0],
            'Max': prim.value[0]
        })
    elif root.type == lexer.STRING:
        prim = ogAST.PrimStringLiteral()
        prim.value = root.text
        prim.exprType = type('PrStr', (object,), {
            'kind': 'StringType',
            'Min': str(len(prim.value) - 2),
            'Max': str(len(prim.value) - 2)
        })
    elif root.type == lexer.FLOAT2:
        prim = ogAST.PrimMantissaBaseExp()
        mant = float(root.getChild(0).toString())
        base = int(root.getChild(1).toString())
        exp = int(root.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 root.type == lexer.EMPTYSTR:
        # Empty SEQUENCE OF (i.e. "{}")
        prim = ogAST.PrimEmptyString()
        prim.exprType = type('PrES', (object,), {
            'kind': 'SequenceOfType',
            'Min': '0',
            'Max': '0'
        })
    elif root.type == lexer.CHOICE:
        prim = ogAST.PrimChoiceItem()
        choice = root.getChild(0).toString()
        expr, err, warn = expression(root.getChild(1), context)
        errors.extend(err)
        warnings.extend(warn)
        prim.value = {'choice': choice, 'value': expr}
        prim.exprType = UNKNOWN_TYPE
    elif root.type == lexer.SEQUENCE:
        prim = ogAST.PrimSequence()
        prim.value = {}
        for elem in root.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 root.type == lexer.SEQOF:
        prim = ogAST.PrimSequenceOf()
        prim.value = []
        for elem in root.getChildren():
            # SEQUENCE OF elements cannot have fieldnames/indexes
1491
            prim_elem, prim_elem_errors, prim_elem_warnings = primary(elem, context)
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
            errors += prim_elem_errors
            warnings += prim_elem_warnings
            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(root.children)),
            'Max': str(len(root.children)),
            'type': UNKNOWN_TYPE
        })
    elif root.type == lexer.BITSTR:
        prim = ogAST.PrimBitStringLiteral()
dbarbera's avatar
dbarbera committed
1506
        warnings.append(warning(root, 'Bit string literal not supported yet'))
1507
1508
    elif root.type == lexer.OCTSTR:
        prim = ogAST.PrimOctetStringLiteral()
dbarbera's avatar
dbarbera committed
1509
        warnings.append(warning(root, 'Octet string literal not supported yet'))
1510
1511
1512
1513
1514
    else:
        # TODO: return error message
        raise NotImplementedError

    prim.inputString = get_input_string(root)
dbarbera's avatar
dbarbera committed
1515
    prim.tmpVar = tmp()
1516
1517
1518
1519

    return prim, errors, warnings


Maxime Perrotin's avatar
Maxime Perrotin committed
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
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:
dbarbera's avatar
dbarbera committed
1535
                errors.append(error(root, str(err)))
Maxime Perrotin's avatar
Maxime Perrotin committed
1536
1537
1538
1539
1540
1541
        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()
dbarbera's avatar
dbarbera committed
1542
            expr.left = ogAST.PrimVariable()
Maxime Perrotin's avatar
Maxime Perrotin committed
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
            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
1575

Maxime Perrotin's avatar
Maxime Perrotin committed
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
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
1590

Maxime Perrotin's avatar
Maxime Perrotin committed
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
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'
1601
        assert param.type == lexer.PARAM
Maxime Perrotin's avatar
Maxime Perrotin committed
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
        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

1626
1627
1628
1629
1630
1631
1632
1633
1634

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
1635
1636
        comp.global_timers = list(context.timers)
        comp.global_timers.extend(list(context.global_timers))
1637
1638
1639
1640
1641
1642
1643
        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
1644
    # and map a list of transitionsi to each state
1645
    comp.mapping = {name: [] for name in get_state_list(root)}
1646
1647
    inner_composite = []
    states = []
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
    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
1669
            new_proc, err, warn = procedure(child, context=comp)