AdaGenerator.py 62.1 KB
Newer Older
Maxime Perrotin's avatar
Maxime Perrotin committed
1
2
3
4
5
6
7
8
9
10
11
#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
    OpenGEODE - A tiny SDL Editor for TASTE

    This module generates Ada code from SDL process models.
    The Ada code is compliant with the TASTE interfaces, and is
    using the ASN.1 "Space-Certified" compiler for data type definition.
    (See TASTE documentation for more information)

Maxime Perrotin's avatar
Maxime Perrotin committed
12
    The design is flexible and can be used as basis for other backends.
Maxime Perrotin's avatar
Maxime Perrotin committed
13
14
15
16
17
18
19
20
21
22
23

    Entry point:
    The AST of the model that is parsed is described in ogAST.py

    A Visitor Pattern using Python's "singledispatch" mechanism is used
    to go through the AST and generate code for each SDL construct.

    There is a single function called "generate", decorated with the
    singledispatch mechanism, that needs to be called to generate the code
    of any AST element.

Maxime Perrotin's avatar
Maxime Perrotin committed
24
25
26
    The generate function returns two values: "code" and "local_decl",
    containing a set of statements and a set of local variables
    (that can be later placed anywhere in the code).
Maxime Perrotin's avatar
Maxime Perrotin committed
27

Maxime Perrotin's avatar
Maxime Perrotin committed
28
29
30
31
32
    Expressions (all classes derived from ogAST.Expression) are generated
    using the "expression" visitor (singledispatch set of function).

    Expressions return three values: "code", "ada_string" and "local_decl".
    The "ada_string" value is the usable string that corresponds
Maxime Perrotin's avatar
Maxime Perrotin committed
33
34
35
36
37
38
39
40
41
42
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
    to the result of the expression evaluation.

    For example, take the SDL statement "OUTPUT hello(a+5)"

    This results (in TASTE terminology) in calling the required interface
    called "hello" and passing a parameter of an ASN.1 type (say MyInteger).
    The parameter is always passed by reference.

    It is therefore necessary to build a temporary variable to hold the result
    of the "a+5" expression.

    In this example, the "generate" function will return:
    local_decl = ["tmp01 : MyInteger;"]
    (The template backend can then place it wherever appropriate)

    and code = ["tmp01 := a + 5;", "hello(tmp01);"]
    (The template will then do a '\n'.join(code) - and add indents, etc.)

    To know about "tmp01" and generate the code "hello(tmp01);",
    the function will recursively call "generate" and
    pass a+5 as parameter. The call will return the tuple:

    local_decl = ["tmp01 : MyInteger;"]
    code = ["tmp01 := a + 5;"]
    ada_string = "tmp01"

    This design allows to have any level of complexity in the embedded
    expression in a way that is easy to handle (adding constructs with
    this pattern is straightforward, once the generate function for each AST
    entry is properly implemented).

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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


import logging
from singledispatch import singledispatch

import ogAST
76
import Helper
Maxime Perrotin's avatar
Maxime Perrotin committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

LOG = logging.getLogger(__name__)

__all__ = ['generate']

# reference to the ASN.1 Data view and to the visible variables (in scope)
TYPES = None
VARIABLES = {}
LOCAL_VAR = {}
# List of output signals and procedures
OUT_SIGNALS = []
PROCEDURES = []
INNER_PROCEDURES = []


@singledispatch
def generate(ast):
    ''' Generate the code for an item of the AST '''
95
    _ = ast
Maxime Perrotin's avatar
Maxime Perrotin committed
96
    raise TypeError('[AdaGenerator] Unsupported AST construct')
97
    return [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114

# Processing of the AST

@generate.register(ogAST.Process)
def _process(process):
    ''' Generate the code for a complete process (AST Top level) '''
    process_name = process.processName
    global TYPES
    TYPES = process.dataview
    del OUT_SIGNALS[:]
    del PROCEDURES[:]
    del INNER_PROCEDURES[:]
    OUT_SIGNALS.extend(process.output_signals)
    PROCEDURES.extend(process.procedures)

    LOG.info('Generating Ada code for process ' + str(process_name))

115
    # In case model has nested states, flatten everything
116
    Helper.flatten(process, sep='_')
117

Maxime Perrotin's avatar
Maxime Perrotin committed
118
119
120
121
    # Make an maping {input: {state: transition...}} in order to easily
    # generate the lookup tables for the state machine runtime
    mapping = Helper.map_input_state(process)

Maxime Perrotin's avatar
Maxime Perrotin committed
122
123
124
125
126
127
128
129
130
    VARIABLES.update(process.variables)
    INNER_PROCEDURES.extend(process.content.inner_procedures)

    # Generate the code to declare process-level variables
    process_level_decl = []
    for var_name, (var_type, def_value) in process.variables.viewitems():
        if def_value:
            # Expression must be a ground expression, i.e. must not
            # require temporary variable to store computed result
Maxime Perrotin's avatar
Maxime Perrotin committed
131
            dst, dstr, dlocal = expression(def_value)
Maxime Perrotin's avatar
Maxime Perrotin committed
132
133
134
135
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
                'l_{n} : aliased asn1Scc{t}{default};'.format(
                        n=var_name,
136
                        t=var_type.ReferencedTypeName.replace('-', '_'),
Maxime Perrotin's avatar
Maxime Perrotin committed
137
138
139
                        default=' := ' + dstr if def_value else ''))


Maxime Perrotin's avatar
Maxime Perrotin committed
140
141
    # Add the process states list to the process-level variables
    states_decl = 'type states is ('
Maxime Perrotin's avatar
Maxime Perrotin committed
142
143
    states_decl += ', '.join(name for name in process.mapping.iterkeys()
                             if not name.endswith('START')) + ');'
Maxime Perrotin's avatar
Maxime Perrotin committed
144
    process_level_decl.append(states_decl)
Maxime Perrotin's avatar
Maxime Perrotin committed
145
    process_level_decl.append('state : states;')
Maxime Perrotin's avatar
Maxime Perrotin committed
146

147
148
149
150
151
    for name, val in process.mapping.viewitems():
        if name.endswith('START') and name != 'START':
            process_level_decl.append('{name} : constant := {val};'
                                      .format(name=name, val=str(val)))

Maxime Perrotin's avatar
Maxime Perrotin committed
152
    # Add function allowing to trace current state as a string
153
154
155
    #process_level_decl.append('function get_state return String;')
    #process_level_decl.append('pragma export(C, get_state, "{}_state");'
    #                                                     .format(process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
156
157

    # Add the declaration of the runTransition procedure
158
    process_level_decl.append('procedure runTransition(Id: Integer);')
159
160
161
    process_level_decl.append('procedure state_start;')
    #process_level_decl.append('pragma export(C, start, "{}_start");'
    #                          .format(process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
162
163

    # Generate the code of the start transition:
164
165
    start_transition = ['begin',
                        'runTransition(0);']
166

Maxime Perrotin's avatar
Maxime Perrotin committed
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

    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
    except TypeError:
        asn1_modules = '--  No ASN.1 data types are used in this model'
    taste_template = ['''\
-- This file was generated automatically: DO NOT MODIFY IT !

with System.IO;
use System.IO;

{dataview}

with adaasn1rtl;
use adaasn1rtl;

with Interfaces;
use Interfaces;

package body {process_name} is'''.format(process_name=process_name,
    dataview=asn1_modules)]

    # Generate the source file (.ads) header
    ads_template = ['''\
-- This file was generated automatically: DO NOT MODIFY IT !

{dataview}

package {process_name} is'''.format(process_name=process_name,
    dataview=asn1_modules)]

    # Generate the the code of the procedures
    inner_procedures_code = []
    for proc in process.content.inner_procedures:
        proc_code, proc_local = generate(proc)
        process_level_decl.extend(proc_local)
        inner_procedures_code.extend(proc_code)

    # Generate the code for the process-level variable declarations
    taste_template.extend(process_level_decl)

211
212
    # Generate the code for the start procedure
    taste_template.extend([
213
        'procedure state_start is',
214
        'begin',
215
216
            'null;',
        'end state_start;', ''])
217

Maxime Perrotin's avatar
Maxime Perrotin committed
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
    # Add the code of the procedures definitions
    taste_template.extend(inner_procedures_code)

    # Generate the code for each input signal (provided interface) and timers
    for signal in process.input_signals + [
                        {'name': timer.lower()} for timer in process.timers]:
        if signal.get('name', 'START') == 'START':
            continue
        pi_header = 'procedure {sig_name}'.format(sig_name=signal['name'])
        param_name = signal.get('param_name') or 'MISSING_PARAM_NAME'
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
            typename = signal['type'].ReferencedTypeName.replace('-', '_')
            pi_header += '({pName}: access asn1Scc{pType})'.format(
                                           pName=param_name, pType=typename)

        # Add declaration of the provided interface in the .ads file
        ads_template.append('--  Provided interface "' + signal['name'] + '"')
        ads_template.append(pi_header + ';')
237
238
        ads_template.append('pragma export(C, {name}, "{proc}_{name}");'
                            .format(name=signal['name'], proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
239
240
241
242
243
244

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
        taste_template.append('case state is')
        for state in process.mapping.viewkeys():
245
            if state.endswith('START'):
Maxime Perrotin's avatar
Maxime Perrotin committed
246
247
248
                continue
            taste_template.append('when {state} =>'.format(state=state))
            input_def = mapping[signal['name']].get(state)
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
            # Check for nested states to call optional exit procedure
            sep = '_'
            state_tree = state.split(sep)
            context=process
            exitlist = []
            current = ''
            trans = input_def and process.transitions[input_def.transition_id]
            while state_tree:
                current = current + state_tree.pop(0)
                for comp in context.composite_states:
                    if current == comp.statename.lower():
                        if comp.exit_procedure:
                            exitlist.append(current)
                        context = comp
                        current = current + sep
                        break
            for each in reversed(exitlist):
                if trans and all(each.startswith(trans_st)
                                 for trans_st in trans.possible_states):
                    taste_template.append(each + '_' + 'exit;')

Maxime Perrotin's avatar
Maxime Perrotin committed
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
                    taste_template.append('l_{inp} := {tInp}.all;'.format(
                        inp=inp, tInp=param_name))
                # Execute the correponding transition
                if input_def.transition:
                    taste_template.append('runTransition({idx});'.format(
                        idx=input_def.transition_id))
                else:
                    taste_template.append('null;')
            else:
                taste_template.append('null;')
        taste_template.append('when others =>')
        taste_template.append('null;')
        taste_template.append('end case;')
        taste_template.append('end {sig_name};'.format(
                                                      sig_name=signal['name']))
        taste_template.append('\n')

    # for the .ads file, generate the declaration of the required interfaces
    # output signals are the asynchronous RI - only one parameter
    for signal in process.output_signals:
        ri_header = 'procedure {sig_name}'.format(sig_name=signal['name'])
        param_name = signal.get('param_name') or 'MISSING_PARAM_NAME'
        # Add (optional) RI parameter
        if 'type' in signal:
            typename = signal['type'].ReferencedTypeName.replace('-', '_')
            ri_header += '({pName}: access asn1Scc{pType})'.format(
                pName=param_name, pType=typename)
        ads_template.append('--  Required interface "' + signal['name'] + '"')
        ads_template.append(ri_header + ';')
        ads_template.append('pragma import(C, {sig}, "{proc}_RI_{sig}");'
                .format(sig=signal['name'], proc=process_name))

    # for the .ads file, generate the declaration of the external procedures
    for proc in process.procedures:
        ri_header = 'procedure {sig_name}'.format(sig_name=proc.inputString)
        params = []
        for param in proc.fpar:
            typename = param['type'].ReferencedTypeName.replace('-', '_')
            params.append('{par[name]}: access asn1Scc{partype}'.format(
                par=param, partype=typename))
        if params:
            ri_header += '(' + ';'.join(params) + ')'
        ads_template.append('--  Sync required interface "' + proc.inputString)
        ads_template.append(ri_header + ';')
        ads_template.append('pragma import(C, {sig}, "{proc}_RI_{sig}");'
                .format(sig=proc.inputString, proc=process_name))

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
        ads_template.append(
                '--  Timer {} SET and RESET functions'.format(timer))
        ads_template.append('procedure SET_{}(val: access asn1SccT_UInt32);'
                .format(timer))
        ads_template.append(
                'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
                .format(timer=timer, proc=process_name))
        ads_template.append('procedure RESET_{};'.format(timer))
        ads_template.append(
                'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
                .format(timer=timer, proc=process_name))

335
336
337
    taste_template.append('procedure runTransition(Id: Integer) is')
    taste_template.append('trId : Integer := Id;')

338
339
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362

    # Generate the code for all transitions
    code_transitions = []
    local_decl_transitions = []
    for proc_tr in process.transitions:
        code_tr, tr_local_decl = generate(proc_tr)
        code_transitions.append(code_tr)
        local_decl_transitions.extend(tr_local_decl)


    # Generate code for the floating labels
    code_labels = []
    for label in process.content.floating_labels:
        code_label, label_decl = generate(label)
        local_decl_transitions.extend(label_decl)
        code_labels.extend(code_label)

    # Declare the local variables needed by the transitions in the template
    decl = ['{line}'.format(line=l)
            for l in local_decl_transitions]
    taste_template.extend(decl)
    taste_template.append('begin')

363
364
365
366
    # Generate a loop that ends when a next state is reached
    # (there can be chained transition when entering a nested state)
    taste_template.append('while (trId /= -1) loop')

Maxime Perrotin's avatar
Maxime Perrotin committed
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
    # Generate the switch-case on the transition id
    taste_template.append('case trId is')

    for idx, val in enumerate(code_transitions):
        taste_template.append('when {idx} =>'.format(idx=idx))
        val = ['{line}'.format(line=l) for l in val]
        if val:
            taste_template.extend(val)
        else:
            taste_template.append('null;')

    taste_template.append('when others =>')
    taste_template.append('null;')

    taste_template.append('end case;')
382
383
384
385
    if code_labels:
        # Due to nested states (chained transitions) jump over label code
        # (NEXTSTATEs do not return from runTransition)
        taste_template.append('goto next_transition;')
Maxime Perrotin's avatar
Maxime Perrotin committed
386
387
388
389

    # Add the code for the floating labels
    taste_template.extend(code_labels)

Maxime Perrotin's avatar
Maxime Perrotin committed
390
391
392
    #if code_labels:
    taste_template.append('<<next_transition>>')
    taste_template.append('null;')
393
    taste_template.append('end loop;')
Maxime Perrotin's avatar
Maxime Perrotin committed
394
395
396
397
    taste_template.append('end runTransition;')
    taste_template.append('\n')

    # Code of the function allowing to trace current state
398
399
400
401
402
    #taste_template.append('function get_state return String is')
    #taste_template.append('begin')
    #taste_template.append("return states'Image(state);")
    #taste_template.append('end get_state;')
    #taste_template.append('\n')
Maxime Perrotin's avatar
Maxime Perrotin committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428


    taste_template.extend(start_transition)
    taste_template.append('end {process_name};'
            .format(process_name=process_name))

    ads_template.append('end {process_name};'
            .format(process_name=process_name))

    with open(process_name + '.adb', 'w') as ada_file:
        ada_file.write('\n'.join(format_ada_code(taste_template)))

    with open(process_name + '.ads', 'w') as ada_file:
        ada_file.write('\n'.join(format_ada_code(ads_template)))


def write_statement(param, newline):
    ''' Generate the code for the special "write" operator '''
    code = []
    string = ''
    local = []
    basic_type = find_basic_type(param.exprType) or {}
    type_kind = basic_type.kind
    if type_kind.endswith('StringType'):
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
429
            string = '"' + param.value[1:-1].replace('"', "'") + '"'
Maxime Perrotin's avatar
Maxime Perrotin committed
430
431
        else:
            # XXX Cannot print an octet string like that...
Maxime Perrotin's avatar
Maxime Perrotin committed
432
            code, string, local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
433
434
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
435
        code, string, local = expression(param)
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
        if type_kind == 'IntegerType':
            cast = "Interfaces.Integer_64"
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
        elif type_kind == 'Integer32Type':
            cast = 'Integer'
        string = "{cast}'Image({s})".format(cast=cast, s=string)
    else:
        error = ('Unsupported parameter in write call ' +
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
    code.append('Put{line}({string});'.format(
        line='_Line' if newline else '',
        string=string))
    return code, string, local


@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
def _call_external_function(output):
    ''' Generate the code of a set of output or procedure call statement '''
    code = []
    local_decl = []

    # Add the traceability information
    code.extend(traceability(output))

    for out in output.output:
        signal_name = out['outputName']

        if signal_name.lower() in ('write', 'writeln'):
            # special built-in SDL procedure for printing strings
            # supports printing of native types (int, real, bool)
            # but not yet complex ASN.1 structures (sequence/seqof/choice)
            for param in out['params'][:-1]:
                stmts, _, local = write_statement(param, newline=False)
                code.extend(stmts)
                local_decl.extend(local)
            for param in out['params'][-1:]:
                # Last parameter - add newline if necessary
                stmts, _, local = write_statement(param, newline=True if
                        signal_name.lower() == 'writeln' else False)
                code.extend(stmts)
                local_decl.extend(local)
            continue
        elif signal_name.lower() == 'reset_timer':
            # built-in operator for resetting timers. param = timer name
            param, = out['params']
Maxime Perrotin's avatar
Maxime Perrotin committed
487
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
488
489
490
491
492
493
494
            code.extend(p_code)
            local_decl.extend(p_local)
            code.append('RESET_{};'.format(p_id))
            continue
        elif signal_name.lower() == 'set_timer':
            # built-in operator for setting a timer: SET(1000, timer_name)
            timer_value, timer_id = out['params']
Maxime Perrotin's avatar
Maxime Perrotin committed
495
496
            t_code, t_val, t_local = expression(timer_value)
            p_code, p_id, p_local = expression(timer_id)
Maxime Perrotin's avatar
Maxime Perrotin committed
497
498
499
500
501
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
529
530
531
532
533
534
            code.extend(t_code)
            code.extend(p_code)
            local_decl.extend(t_local)
            local_decl.extend(p_local)
            # Use a temporary variable to store the timer value
            tmp_id = 'tmp' + str(out['tmpVars'][0])
            local_decl.append('{} : aliased asn1SccT_Uint32;'.format(tmp_id))
            code.append('{tmp} := {val};'.format(tmp=tmp_id, val=t_val))
            code.append("SET_{timer}({value}'access);"
                                             .format(timer=p_id, value=tmp_id))
            continue
        proc, out_sig = None, None
        try:
            out_sig, = [sig for sig in OUT_SIGNALS
                        if sig['name'].lower() == signal_name.lower()]
        except ValueError:
            # Not an output, try if it is an external procedure
            try:
                out_sig, = [sig for sig in PROCEDURES
                            if sig.inputString.lower() == signal_name.lower()]
            except ValueError:
                # Not external? Must be an inner procedure then.
                # otherwise the parser would have barked
                proc, = [sig for sig in INNER_PROCEDURES
                     if sig.inputString.lower() == signal_name.lower()]
        if out_sig:
            list_of_params = []
            for idx, param in enumerate(out.get('params') or []):
                param_direction = 'in'
                try:
                    # If it is an output, there is a single parameter
                    param_type = out_sig['type']
                except TypeError:
                    # Else if it is a procedure, get the type
                    param_type = out_sig.fpar[idx]['type']
                    param_direction = out_sig.fpar[idx]['direction']

                typename = param_type.ReferencedTypeName.replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
535
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
536
537
538
                code.extend(p_code)
                local_decl.extend(p_local)
                # Create a temporary variable for input parameters only
Maxime Perrotin's avatar
Maxime Perrotin committed
539
540
541
542
                # (If needed, i.e. if argument is not a local variable)
                if param_direction == 'in' \
                and (not (isinstance(param, ogAST.PrimVariable) and
                p_id.startswith('l_')) or isinstance(param, ogAST.PrimFPAR)):
543
544
545
546
547
548
549
                    tmp_id = out['tmpVars'][idx]
                    local_decl.append('tmp{idx} : aliased asn1Scc{oType};'
                                      .format(idx=tmp_id, oType=typename))
                    code.append('tmp{idx} := {p_id};'
                                .format(idx=tmp_id, p_id=p_id))
                    list_of_params.append("tmp{idx}'access"
                                          .format(idx=out['tmpVars'][idx]))
Maxime Perrotin's avatar
Maxime Perrotin committed
550
551
552
553
554
555
556
557
558
559
560
                else:
                    # Output parameters - no need for a temp variable
                    list_of_params.append("{var}'access".format(var=p_id))
            if list_of_params:
                code.append('{RI}({params});'.format(
                    RI=out['outputName'], params=', '.join(list_of_params)))
            else:
                code.append('{RI};'.format(RI=out['outputName']))
        else:
            # inner procedure call
            list_of_params = []
561
            for param in out.get('params', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
562
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
                code.extend(p_code)
                local_decl.extend(p_local)
                # no need to use temporary variables, we are in pure Ada
                list_of_params.append(p_id)
            if list_of_params:
                code.append('{proc}({params});'.format(
                    proc=proc.inputString,
                    params=', '.join(list_of_params)))
            else:
                code.append('{};'.format(proc.inputString))
    return code, local_decl


@generate.register(ogAST.TaskAssign)
def _task_assign(task):
    ''' A list of assignments in a task symbol '''
    code, local_decl = [], []
    ada_string = ''
    if task.comment:
        code.extend(traceability(task.comment))
    for expr in task.elems:
        code.extend(traceability(expr))
Maxime Perrotin's avatar
Maxime Perrotin committed
585
        code_assign, ada_string, decl_assign = expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
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
        code.extend(code_assign)
        code.append(ada_string[1:-1] + ';')
        local_decl.extend(decl_assign)
    return code, local_decl


@generate.register(ogAST.TaskInformalText)
def _task_informal_text(task):
    ''' Generate Ada comments for informal text '''
    code = []
    if task.comment:
        code.extend(traceability(task.comment))
    code.extend(['-- ' + text.replace('\n', '\n-- ') for text in task.elems])
    return code, []


@generate.register(ogAST.TaskForLoop)
def _task_forloop(task):
    '''
        Return the code corresponding to a for loop. Two forms are possible:
        for x in range ([start], stop [, step])
        for x in iterable (a SEQUENCE OF)
    '''
    stmt, local_decl = [], []
    if task.comment:
        stmt.extend(traceability(task.comment))
    stmt.extend(traceability(task))
    for loop in task.elems:
        if loop['range']:
            start_str, stop_str = '0', ''
            if loop['range']['start']:
Maxime Perrotin's avatar
Maxime Perrotin committed
617
                start_stmt, start_str, start_local = expression\
Maxime Perrotin's avatar
Maxime Perrotin committed
618
619
620
621
622
623
624
625
                                                       (loop['range']['start'])
                local_decl.extend(start_local)
                stmt.extend(start_stmt)
                # ASN.1 Integers are 64 bits - we need to convert to 32 bits
                if isinstance(loop['range']['start'], ogAST.PrimInteger):
                    start_str = 'Integer({})'.format(start_str)
            if loop['range']['step'] == 1:
                start_str += '..'
Maxime Perrotin's avatar
Maxime Perrotin committed
626
            stop_stmt, stop_str, stop_local = expression(loop['range']['stop'])
Maxime Perrotin's avatar
Maxime Perrotin committed
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
            local_decl.extend(stop_local)
            stmt.extend(stop_stmt)
            if isinstance(loop['range']['stop'], ogAST.PrimInteger):
                stop_str = 'Integer({})'.format(stop_str)
            if loop['range']['step'] == 1:
                stmt.append(
                       'for {it} in {start}{stop} loop'
                       .format(it=loop['var'], start=start_str, stop=stop_str))
            else:
                # Step is not directly supported in Ada, we need to use 'while'
                stmt.extend(['declare',
                             '{it} : Integer := {start};'
                             .format(it=loop['var'],
                             start=start_str),
                             '',
                             'begin',
                             'while {it} < {stop} loop'.format(it=loop['var'],
                                                               stop=stop_str)])
        else:
            # case of form: FOR x in SEQUENCE OF
            elem_type = loop['type'].ReferencedTypeName.replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
648
            list_stmt, list_str, list_local = expression(loop['list'])
Maxime Perrotin's avatar
Maxime Perrotin committed
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
            basic_type = find_basic_type(loop['list'].exprType)
            range_cond = "{}.Data'Range".format(list_str)\
                    if basic_type.Min == basic_type.Max\
                    else "1..{}.Length".format(list_str)
            stmt.extend(list_stmt)
            local_decl.extend(list_local)
            stmt.extend(['declare',
                         '{it} : asn1Scc{it_ty};'.format(it=loop['var'],
                                                         it_ty=elem_type),
                         '',
                         'begin',
                         'for {it}_idx in {rc} loop'.format(it=loop['var'],
                                                            rc=range_cond),
                         '{it} := {var}.Data({it}_idx);'.format(it=loop['var'],
                                                                var=list_str)])
        try:
            code_trans, local_trans = generate(loop['transition'])
            if local_trans:
                stmt.append('declare')
                stmt.extend(local_trans)
                stmt.append('')
                stmt.append('begin')
            stmt.extend(code_trans)
            if local_trans:
                stmt.append('end;')
        except AttributeError:
            stmt.append('null;')
        if loop['range'] and loop['range']['step'] != 1:
            stmt.append('{it} := {it} + {step};'.format(it=loop['var'],
                                                   step=loop['range']['step']))
        stmt.append('end loop;')
        if (loop['range'] and loop['range']['step'] != 1) or loop['list']:
            stmt.append('end;')
    return stmt, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
685
686
687
688
689
690
691
692
693
694
695
696
@singledispatch
def expression(expr):
    ''' Generate the code for Expression-classes, returning 3 things:
        - list of statements
        - useable string corresponding to the evaluation of the expression,
        - list of local declarations
    '''
    _ = expr
    raise TypeError('Unsupported expression: ' + str(expr))
    return [], '', []

@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
697
698
def _primary_variable(prim):
    ''' Single variable reference '''
699
700
    sep = 'l_' if find_var(prim.value[0]) else ''
    return [], '{sep}{name}'.format(sep=sep, name=prim.value[0]), []
Maxime Perrotin's avatar
Maxime Perrotin committed
701
702


Maxime Perrotin's avatar
Maxime Perrotin committed
703
704
@expression.register(ogAST.PrimPath)
def _prim_path(primary_id):
Maxime Perrotin's avatar
Maxime Perrotin committed
705
    '''
706
        Return the Ada string of an element list (path)
Maxime Perrotin's avatar
Maxime Perrotin committed
707
708
709
710
711
712
713
714
715
716
717
        cases: a => 'l_a' (reference to a variable)
        a_timer => 'a_timer'  (reference to a timer)
        a!b => a.b (field of a structure)
        a!b if a is a CHOICE => TypeOfa_b_get(a)
        a(Expression) => a(ExpressionSolver) (array index)
        Expression can be complex (if-then-else-fi..)
    '''
    ada_string = ''
    stmts, local_decl = [], []

    # If first element is not a variable (can be a timer) do not add prefix
Maxime Perrotin's avatar
Maxime Perrotin committed
718
    sep = 'l_' if find_var(primary_id.value[0]) else ''
Maxime Perrotin's avatar
Maxime Perrotin committed
719
720

    sub_id = []
Maxime Perrotin's avatar
Maxime Perrotin committed
721
    for pr_id in primary_id.value:
Maxime Perrotin's avatar
Maxime Perrotin committed
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
        if type(pr_id) is not dict:
            if pr_id.lower() == 'length':
                special_op = 'Length'
                continue
            elif pr_id.lower() == 'present':
                special_op = 'ChoiceKind'
                continue
            elif pr_id.lower() == 'abs':
                special_op = 'Abs'
                continue
            special_op = ''
            parent_kind, parent_typename = path_type(sub_id)
            sub_id.append(pr_id)
            if parent_kind == 'ChoiceType':
                ada_string = ('asn1Scc{typename}_{p_id}_get({ada_string})'
                        .format(typename=parent_typename,
                                p_id=pr_id, ada_string=ada_string))
            else:
                ada_string += sep + pr_id
        else:
            if 'substring' in pr_id:
                # substring: two parameters (range)
Maxime Perrotin's avatar
Maxime Perrotin committed
744
745
746
747
                r1_stmts, r1_string, r1_local = \
                        expression(pr_id['substring'][0])
                r2_stmts, r2_string, r2_local = \
                        expression(pr_id['substring'][1])
Maxime Perrotin's avatar
Maxime Perrotin committed
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
                # should we add 1 in case of numerical values? (see index)
                ada_string += '.Data({r1}..{r2})'.format(
                                                r1=r1_string, r2=r2_string)
                stmts.extend(r1_stmts)
                stmts.extend(r2_stmts)
                local_decl.extend(r1_local)
                local_decl.extend(r2_local)
                _, parent_typename = path_type(sub_id)
                local_decl.append('tmp{idx} : aliased asn1Scc{parent_type};'
                          .format(idx=pr_id['tmpVar'],
                              parent_type=parent_typename))
                # XXX types with fixed length: substrings will not work
                if unicode.isnumeric(r1_string) and unicode.isnumeric(
                                                                r2_string):
                    length = int(r2_string) - int(r1_string) + 1
                else:
                    length = ('{r2} - {r1} + 1'
                        .format(r2=r2_string, r1=r1_string))
                stmts.append('tmp{idx}.Length := {length};'
                        .format(idx=pr_id['tmpVar'], length=length))

                stmts.append('tmp{idx}.Data(1..{length}) := {data};'
                        .format(idx=pr_id['tmpVar'],
                            length=length, data=ada_string))
                ada_string = 'tmp{idx}'.format(idx=pr_id['tmpVar'])
            elif 'index' in pr_id:
                # index is a list but it can have only one element
Maxime Perrotin's avatar
Maxime Perrotin committed
775
                idx_stmts, idx_string, local_var = expression(
Maxime Perrotin's avatar
Maxime Perrotin committed
776
777
778
779
                        pr_id['index'][0])
                if unicode.isnumeric(idx_string):
                    idx_string = int(idx_string) + 1
                else:
780
                    idx_string = '1+Integer({idx})'.format(idx=idx_string)
Maxime Perrotin's avatar
Maxime Perrotin committed
781
782
783
784
785
786
787
788
789
790
791
792
793
                ada_string += '.Data({idx})'.format(idx=idx_string)
                stmts.extend(idx_stmts)
                local_decl.extend(local_var)
            elif 'procParams' in pr_id:
                if special_op == 'Abs':
                    # Return absolute value of a number
                    exp, = pr_id['procParams']
                    exp_type = find_basic_type(exp.exprType)
                    if exp_type.kind not in ('IntegerType', 'RealType'):
                        error = ('{} must be a number to return absolute value'
                                .format(exp.inputString))
                        LOG.error(error)
                        raise TypeError(error)
Maxime Perrotin's avatar
Maxime Perrotin committed
794
                    param_stmts, param_str, local_var = expression(exp)
Maxime Perrotin's avatar
Maxime Perrotin committed
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
                    stmts.extend(param_stmts)
                    local_decl.extend(local_var)
                    ada_string += 'abs(' + param_str + ')'

                elif special_op == 'Length':
                    # Length of sequence of: take only the first parameter
                    exp, = pr_id['procParams']
                    exp_type = find_basic_type(exp.exprType)
                    min_length = getattr(exp_type, 'Min', None)
                    max_length = getattr(exp_type, 'Max', None)
                    if min_length is None or max_length is None:
                        error = '{} is not a SEQUENCE OF'.format(
                                exp.inputString)
                        LOG.error(error)
                        raise TypeError(error)
Maxime Perrotin's avatar
Maxime Perrotin committed
810
                    param_stmts, param_str, local_var = expression(
Maxime Perrotin's avatar
Maxime Perrotin committed
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
                            exp)
                    stmts.extend(param_stmts)
                    local_decl.extend(local_var)
                    if min_length == max_length:
                        ada_string += min_length
                    else:
                        ada_string += ('Interfaces.Integer_64({e}.Length)'
                                .format(e=param_str))
                elif special_op == 'ChoiceKind':
                    # User wants to know what CHOICE element is present
                    exp, = pr_id['procParams']
                    # Get the basic type to make sure it is a choice
                    exp_type = find_basic_type(exp.exprType)
                    # Also get the ASN.1 type name as it is
                    # needed to build the Ada expression
                    exp_typename = \
                            (getattr(exp.exprType, 'ReferencedTypeName',
                                 None) or exp.exprType.kind).replace('-', '_')
                    if exp_type.kind != 'ChoiceType':
                        error = '{} is not a CHOICE'.format(exp.inputString)
                        LOG.error(error)
                        raise TypeError(error)
Maxime Perrotin's avatar
Maxime Perrotin committed
833
                    param_stmts, param_str, local_var = expression(
Maxime Perrotin's avatar
Maxime Perrotin committed
834
835
836
837
838
839
840
841
842
843
844
                            exp)
                    stmts.extend(param_stmts)
                    local_decl.extend(local_var)
                    ada_string += ('asn1Scc{t}_Kind({e})'.format(
                        t=exp_typename, e=param_str))
                else:
                    ada_string += '('
                    # Take all params and join them with commas
                    list_of_params = []
                    for param in pr_id['procParams']:
                        param_stmt, param_str, local_var = (
Maxime Perrotin's avatar
Maxime Perrotin committed
845
                                expression(param))
Maxime Perrotin's avatar
Maxime Perrotin committed
846
847
848
849
850
851
852
853
854
                        list_of_params.append(param_str)
                        stmts.extend(param_stmt)
                        local_decl.extend(local_var)
                    ada_string += ', '.join(list_of_params)
                    ada_string += ')'
        sep = '.'
    return stmts, ada_string, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
855
856
857
858
859
860
861
862
863
864
865
866
867
@expression.register(ogAST.ExprPlus)
@expression.register(ogAST.ExprMul)
@expression.register(ogAST.ExprMinus)
@expression.register(ogAST.ExprEq)
@expression.register(ogAST.ExprNeq)
@expression.register(ogAST.ExprGt)
@expression.register(ogAST.ExprGe)
@expression.register(ogAST.ExprLt)
@expression.register(ogAST.ExprLe)
@expression.register(ogAST.ExprDiv)
@expression.register(ogAST.ExprMod)
@expression.register(ogAST.ExprRem)
@expression.register(ogAST.ExprAssign)
Maxime Perrotin's avatar
Maxime Perrotin committed
868
def _basic_operators(expr):
869
    ''' Expressions with two sides '''
Maxime Perrotin's avatar
Maxime Perrotin committed
870
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
871
872
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
Maxime Perrotin's avatar
Maxime Perrotin committed
873
874
875
876
877
878
879
880
    ada_string = '({left} {op} {right})'.format(
            left=left_str, op=expr.operand, right=right_str)
    code.extend(left_stmts)
    code.extend(right_stmts)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
    return code, ada_string, local_decl

Maxime Perrotin's avatar
Maxime Perrotin committed
881
882
883
@expression.register(ogAST.ExprOr)
@expression.register(ogAST.ExprAnd)
@expression.register(ogAST.ExprXor)
884
885
886
def _bitwise_operators(expr):
    ''' Logical operators '''
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
887
888
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
    basic_type = find_basic_type(expr.exprType)
    if basic_type.kind != 'BooleanType':
        # Sequence of boolean or bit string
        if expr.right.is_raw:
            # Declare a temporary variable to store the raw value
            tmp_string = 'tmp{}'.format(expr.right.tmpVar)
            local_decl.append('{tmp} : aliased asn1Scc{eType};'.format(
                        tmp=tmp_string,
                        eType=expr.right.exprType.ReferencedTypeName
                        .replace('-', '_')))
            code.append('{tmp} := {right};'.format(tmp=tmp_string,
                                                  right=right_str))
            right_str = tmp_string
        ada_string = '(Data => ({left}.Data {op} {right}.Data)'.format(
                left=left_str, op=expr.operand, right=right_str)
        if basic_type.Min != basic_type.Max:
            ada_string += ", Length => {left}.Length".format(left=left_str)
        ada_string += ')'
    else:
        ada_string = '({left} {op} {right})'.format(
                               left=left_str, op=expr.operand, right=right_str)
    code.extend(left_stmts)
    code.extend(right_stmts)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
    return code, ada_string, local_decl

Maxime Perrotin's avatar
Maxime Perrotin committed
916

Maxime Perrotin's avatar
Maxime Perrotin committed
917
@expression.register(ogAST.ExprAppend)
Maxime Perrotin's avatar
Maxime Perrotin committed
918
919
920
def _append(expr):
    ''' Generate code for the APPEND construct: a // b '''
    stmts, ada_string, local_decl = [], '', []
921
#    basic_type_expr = find_basic_type(expr.exprType)
Maxime Perrotin's avatar
Maxime Perrotin committed
922
923
924
925
926
927
928
929
930
931
932
933
934
    # We can do a length check if both strings are literals
    # XXX should be already done by the parser
#   if(expr.right.kind == 'primary'
#      and expr.right.var.kind == 'stringLiteral'
#      and expr.left.kind == 'primary'
#      and expr.left.var.kind == 'stringLiteral'
#      and len(expr.right.var.stringLiteral[1:-1]) +
#      len(expr.left.var.stringLiteral[1:-1]) > basic_type_expr.Max):
#       raise ValueError('String concatenation exceeds container length: '
#               'length(' + expr.left.var.stringLiteral[1:-1] +
#               expr.right.var.stringLiteral[1:-1] + ') > ' +
#               str(basic_type_expr.Max))

Maxime Perrotin's avatar
Maxime Perrotin committed
935
936
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
Maxime Perrotin's avatar
Maxime Perrotin committed
937
938
939
940
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
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
    stmts.extend(left_stmts)
    stmts.extend(right_stmts)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
    # Declare a temporary variable to hold the result of the append
    ada_string = 'tmp{}'.format(expr.tmpVar)
    local_decl.append('{tmp} : aliased asn1Scc{eType};'.format(
                    tmp=ada_string,
                    eType=expr.exprType.ReferencedTypeName
                    .replace('-', '_')))

    # If right or left is raw, declare a temporary variable for it, too
    for sexp, sid in zip((expr.right, expr.left), (right_str, left_str)):
        if sexp.is_raw:
            local_decl.append('tmp{idx} : aliased asn1Scc{eType};'.format(
                    idx=sexp.tmpVar,
                    eType=sexp.exprType.ReferencedTypeName
                    .replace('-', '_')))
            stmts.append('tmp{idx} := {s_id};'.format(
                idx=sexp.tmpVar, s_id=sid))
            sexp.sid = 'tmp' + str(sexp.tmpVar)
            # Length of raw string - update for sequence of
            if isinstance(sexp, ogAST.PrimStringLiteral):
                sexp.slen = len(sexp.value[1:-1])
            elif isinstance(sexp, ogAST.PrimEmptyString):
                sexp.slen = 0
            elif isinstance(sexp, ogAST.PrimSequenceOf):
                sexp.slen = len(sexp.value)
            else:
                raise TypeError('Not a string/Sequence in APPEND')
        else:
            sexp.sid = sid
            basic = find_basic_type(sexp.exprType)
            if basic.Min == basic.Max:
                # Fixed-size string
                sexp.slen = basic.Max
            else:
                # Variable-size types have a Length field
                sexp.slen = '{}.Length'.format(sexp.sid)
    stmts.append('{res}.Data(1..{l1}) := {lid}.Data(1..{l1});'.format(
                res=ada_string, l1=expr.left.slen, lid=expr.left.sid))
    stmts.append('{res}.Data({l1}+1..{l1}+{l2}) := {rid}.Data(1..{l2});'
                .format(res=ada_string, l1=expr.left.slen,
                rid=expr.right.sid, l2=expr.right.slen))
    stmts.append('{res}.Length := {l1} + {l2};'.format(
                res=ada_string, l1=expr.left.slen, l2=expr.right.slen))
    return stmts, ada_string, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
986
@expression.register(ogAST.ExprIn)
Maxime Perrotin's avatar
Maxime Perrotin committed
987
988
989
990
991
992
993
def _expr_in(expr):
    ''' IN expressions: check if item is in a SEQUENCE OF '''
    # Check if item is in a SEQUENCE OF
    # Temporary variable needed to hold the test result
    ada_string = 'tmp{}'.format(expr.tmpVar)
    stmts = []
    local_decl = ['{} : BOOLEAN := False;'.format(ada_string)]
Maxime Perrotin's avatar
Maxime Perrotin committed
994
995
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
Maxime Perrotin's avatar
Maxime Perrotin committed
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
    stmts.extend(left_stmts)
    stmts.extend(right_stmts)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
    stmts.append("in_loop_{}:".format(ada_string))
    left_type = find_basic_type(expr.left.exprType)
    if left_type.Min != left_type.Max:
        stmts.append("for elem in 1..Integer({}.Length) loop"
                     .format(left_str))
    else:
        stmts.append("for elem in {}.Data'Range loop".format(left_str))
    stmts.append("if {container}.Data(elem) = {pattern} then".format
            (container=left_str, pattern=right_str))
    stmts.append("{} := True;".format(ada_string))
    stmts.append("end if;")
    stmts.append("exit in_loop_{tmp} when {tmp} = True;"
                  .format(tmp=ada_string))
    stmts.append("end loop in_loop_{};".format(ada_string))
    return stmts, ada_string, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
1017
@expression.register(ogAST.PrimEnumeratedValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
1018
1019
1020
1021
1022
1023
1024
1025
def _enumerated_value(primary):
    ''' Generate code for an enumerated value '''
    enumerant = primary.value[0].replace('_', '-')
    basic = find_basic_type(primary.exprType)
    ada_string = ('asn1Scc' + basic.EnumValues[enumerant].EnumID)
    return [], ada_string, []


Maxime Perrotin's avatar
Maxime Perrotin committed
1026
@expression.register(ogAST.PrimChoiceDeterminant)
Maxime Perrotin's avatar
Maxime Perrotin committed
1027
1028
1029
1030
1031
1032
1033
def _choice_determinant(primary):
    ''' Generate code for a choice determinant (enumerated) '''
    enumerant = primary.value[0].replace('_', '-')
    ada_string = primary.exprType.EnumValues[enumerant].EnumID
    return [], ada_string, []


Maxime Perrotin's avatar
Maxime Perrotin committed
1034
1035
1036
@expression.register(ogAST.PrimInteger)
@expression.register(ogAST.PrimReal)
@expression.register(ogAST.PrimBoolean)
Maxime Perrotin's avatar
Maxime Perrotin committed
1037
1038
1039
1040
1041
def _integer(primary):
    ''' Generate code for a raw integer/real/boolean value  '''
    return [], primary.value[0], []


Maxime Perrotin's avatar
Maxime Perrotin committed
1042
@expression.register(ogAST.PrimEmptyString)
Maxime Perrotin's avatar
Maxime Perrotin committed
1043
1044
1045
1046
1047
1048
1049
def _empty_string(primary):
    ''' Generate code for an empty SEQUENCE OF: {} '''
    ada_string = 'asn1Scc{typeRef}_Init'.format(
             typeRef=primary.exprType.ReferencedTypeName.replace('-', '_'))
    return [], ada_string, []


Maxime Perrotin's avatar
Maxime Perrotin committed
1050
@expression.register(ogAST.PrimStringLiteral)
Maxime Perrotin's avatar
Maxime Perrotin committed
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
def _string_literal(primary):
    ''' Generate code for a string (Octet String) '''
    basic_type = find_basic_type(primary.exprType)
    # If user put a literal string to fill an Octet string,
    # then convert the string to an array of unsigned_8 integers
    # as expected by the Ada type corresponding to Octet String
    unsigned_8 = [str(ord(val)) for val in primary.value[1:-1]]
    ada_string = '(Data => (' + ', '.join(
                                         unsigned_8) + ', others => 0)'
    if basic_type.Min != basic_type.Max:
        # Non-fixed string size -> add Length field
        ada_string += ', Length => {}'.format(
                                str(len(primary.value[1:-1])))
    ada_string += ')'
    return [], ada_string, []


Maxime Perrotin's avatar
Maxime Perrotin committed
1068
@expression.register(ogAST.PrimConstant)
Maxime Perrotin's avatar
Maxime Perrotin committed
1069
1070
1071
1072
1073
def _constant(primary):
    ''' Generate code for a reference to an ASN.1 constant '''
    return [], primary.value[0], []


Maxime Perrotin's avatar
Maxime Perrotin committed
1074
@expression.register(ogAST.PrimMantissaBaseExp)
Maxime Perrotin's avatar
Maxime Perrotin committed
1075
1076
1077
def _mantissa_base_exp(primary):
    ''' Generate code for a Real with Mantissa-base-Exponent representation '''
    # TODO
1078
1079
    _ = primary
    return [], '', []
Maxime Perrotin's avatar
Maxime Perrotin committed
1080

Maxime Perrotin's avatar
Maxime Perrotin committed
1081
@expression.register(ogAST.PrimIfThenElse)
Maxime Perrotin's avatar
Maxime Perrotin committed
1082
1083
1084
1085
1086
1087
1088
def _if_then_else(ifThenElse):
    ''' Return string and statements for ternary operator '''
    resType = ifThenElse.exprType
    stmts = []
    local_decl = ['tmp{idx} : asn1Scc{resType};'.format(
        idx=ifThenElse.value['tmpVar'],
        resType=resType.ReferencedTypeName.replace('-', '_'))]
Maxime Perrotin's avatar
Maxime Perrotin committed
1089
1090
1091
    if_stmts, if_str, if_local = expression(ifThenElse.value['if'])
    then_stmts, then_str, then_local = expression(ifThenElse.value['then'])
    else_stmts, else_str, else_local = expression(ifThenElse.value['else'])
Maxime Perrotin's avatar
Maxime Perrotin committed
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
    stmts.extend(if_stmts)
    stmts.extend(then_stmts)
    stmts.extend(else_stmts)
    local_decl.extend(if_local)
    local_decl.extend(then_local)
    local_decl.extend(else_local)
    stmts.append('if {if_str} then'.format(
        if_str=if_str))
    stmts.append('tmp{idx} := {then_str};'.format(
        idx=ifThenElse.value['tmpVar'], then_str=then_str))
    stmts.append('else')
    stmts.append('tmp{idx} := {else_str};'.format(
        idx=ifThenElse.value['tmpVar'], else_str=else_str))
    stmts.append('end if;')
    ada_string = 'tmp{idx}'.format(idx=ifThenElse.value['tmpVar'])
    return stmts, ada_string, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
1110
@expression.register(ogAST.PrimSequence)
Maxime Perrotin's avatar
Maxime Perrotin committed
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
def _sequence(seq):
    ''' Return Ada string for an ASN.1 SEQUENCE '''
    stmts, local_decl = [], []
    seqType = seq.exprType
    LOG.debug('PrimSequence: ' + str(seq) + str(seqType))

    ada_string = "asn1Scc{seqType}'(".format(
            seqType=seqType.ReferencedTypeName.replace('-', '_'))
    sep = ''
    for elem, value in seq.value.viewitems():
        # Set the type of the field - easy thanks to ASN.1 flattened AST
        delem = elem.replace('_', '-')
        value.exprType = (TYPES
                    [seqType.ReferencedTypeName].type.Children[delem].type)
Maxime Perrotin's avatar
Maxime Perrotin committed
1125
        value_stmts, value_str, local_var = expression(value)
Maxime Perrotin's avatar
Maxime Perrotin committed
1126
1127
1128
1129
1130
1131
1132
1133
        ada_string += sep + elem + ' => ' + value_str
        sep = ', '
        stmts.extend(value_stmts)
        local_decl.extend(local_var)
    ada_string += ')'
    return stmts, ada_string, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
1134
@expression.register(ogAST.PrimSequenceOf)
Maxime Perrotin's avatar
Maxime Perrotin committed
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
def _sequence_of(seqof):
    ''' Return Ada string for an ASN.1 SEQUENCE OF '''
    stmts, local_decl = [], []
    seqofType = seqof.exprType
    typename = seqofType.ReferencedTypeName
    LOG.debug('SequenceOf Typename:' + str(typename))
    asn_type = TYPES[typename].type
    min_size = asn_type.Min
    max_size = asn_type.Max
    ada_string = 'asn1Scc{seqofType}\'('.format(
                                seqofType=typename.replace('-', '_'))
    if min_size == max_size:
        # Fixed-length array - no need to set the Length field
        ada_string += 'Data => asn1Scc{seqofType}_array\'('.format(
                seqofType=typename.replace('-', '_'))
    else:
        # Variable-length array
        ada_string += (
                'Length => {length}, Data => asn1Scc{seqofType}_array\'('
                .format(seqofType=typename.replace('-', '_'),
                        length=len(seqof.value)))
    for i in xrange(len(seqof.value)):
        # Set the type of the element (should not be useful anymore)
        #seqof.value[i].exprType = TYPES[typename].type.type
Maxime Perrotin's avatar
Maxime Perrotin committed
1159
        item_stmts, item_str, local_var = expression(seqof.value[i])
Maxime Perrotin's avatar
Maxime Perrotin committed
1160
1161
1162
1163
1164
1165
1166
        stmts.extend(item_stmts)
        local_decl.extend(local_var)
        ada_string += '{i} => {value}, '.format(i=i + 1, value=item_str)
    ada_string += 'others => {anyVal}))'.format(anyVal=item_str)
    return stmts, ada_string, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
1167
@expression.register(ogAST.PrimChoiceItem)
Maxime Perrotin's avatar
Maxime Perrotin committed
1168
1169
def _choiceitem(choice):
    ''' Return the Ada code for a CHOICE expression '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1170
    stmts, choice_str, local_decl = expression(choice.value['value'])
Maxime Perrotin's avatar
Maxime Perrotin committed
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
    choiceType = choice.exprType
    actual_type = getattr(
                     choiceType, 'ReferencedTypeName', None) or choiceType.kind
    actual_type = actual_type.replace('-', '_')
    ada_string = 'asn1Scc{cType}_{opt}_set({expr})'.format(
            cType=actual_type,
            opt=choice.value['choice'],
            expr=choice_str)
    return stmts, ada_string, local_decl


@generate.register(ogAST.Decision)
def _decision(dec):
    ''' generate the code for a decision '''
    code, local_decl = [], []
    question_type = dec.question.exprType
    # XXX check if we should get the type like this
    actual_type = getattr(
            question_type, 'ReferencedTypeName', None) or question_type.kind
    actual_type = actual_type.replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
1191
1192
1193
    basic = find_basic_type(question_type).kind in ('IntegerType',
                          'Integer32Type', 'BooleanType',
                          'RealType', 'EnumeratedType', 'ChoiceEnumeratedType')
Maxime Perrotin's avatar
Maxime Perrotin committed
1194
1195
1196
1197
    # for ASN.1 types, declare a local variable
    # to hold the evaluation of the question
    if not basic:
        local_decl.append('tmp{idx} : aliased asn1Scc{actType};'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1198
                          idx=dec.tmpVar, actType=actual_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
1199
    q_stmts, q_str, q_decl = expression(dec.question)
Maxime Perrotin's avatar
Maxime Perrotin committed
1200
1201
1202
1203
1204
1205
1206
1207
    # Add code-to-model traceability
    code.extend(traceability(dec))
    local_decl.extend(q_decl)
    code.extend(q_stmts)
    if not basic:
        code.append('tmp{idx} := {q};'.format(idx=dec.tmpVar, q=q_str))
    sep = 'if '
    for a in dec.answers:
Maxime Perrotin's avatar
Maxime Perrotin committed
1208
        code.extend(traceability(a))
Maxime Perrotin's avatar
Maxime Perrotin committed
1209
1210
1211
1212
        if a.kind in ('open_range', 'constant'):
            # Note: removed and a.transition here because empty transitions
            # have a different meaning, and a "null;" statement has to be
            # generated, to go into the branch
Maxime Perrotin's avatar
Maxime Perrotin committed
1213
            ans_stmts, ans_str, ans_decl = expression(a.constant)
Maxime Perrotin's avatar
Maxime Perrotin committed
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
            code.extend(ans_stmts)
            local_decl.extend(ans_decl)
            if not basic:
                if a.openRangeOp in (ogAST.ExprEq, ogAST.ExprNeq):
                    exp = 'asn1Scc{actType}_Equal(tmp{idx}, {ans})'.format(
                            actType=actual_type, idx=dec.tmpVar, ans=ans_str)
                    if a.openRangeOp == ogAST.ExprNeq:
                        exp = 'not ' + exp
                else:
                    exp = 'tmp{idx} {op} {ans}'.format(idx=dec.tmpVar,
Maxime Perrotin's avatar
Maxime Perrotin committed
1224
                            op=a.openRangeOp.operand, ans=ans_str)
Maxime Perrotin's avatar
Maxime Perrotin committed
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
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
            else:
                exp = '{q} {op} {ans}'.format(q=q_str,
                                              op=a.openRangeOp.operand,
                                              ans=ans_str)
            code.append(sep + exp + ' then')
            if a.transition:
                stmt, tr_decl = generate(a.transition)
            else:
                stmt, tr_decl = ['null;'], []
            code.extend(stmt)
            local_decl.extend(tr_decl)
            sep = 'elsif '
        elif a.kind == 'close_range':
            sep = 'elsif '
            # TODO support close_range
        elif a.kind == 'informal_text':
            continue
        elif a.kind == 'else':
            # Keep the ELSE statement for the end
            if a.transition:
                else_code, else_decl = generate(a.transition)
            else:
                else_code, else_decl = ['null;'], []
            local_decl.extend(else_decl)
    try:
        if sep != 'if ':
            # If there is at least one 'if' branch
            else_code.insert(0, 'else')
            code.extend(else_code)
        else:
            code.extend(else_code)
    except:
        pass
    if sep != 'if ':
        # If there is at least one 'if' branch
        code.append('end if;')
    return code, local_decl

@generate.register(ogAST.Label)
1264
def _label(lab):
Maxime Perrotin's avatar
Maxime Perrotin committed
1265
1266
1267
    ''' Transition following labels are generated in a separate section
        for visibility reasons (see Ada scope)
    '''
1268
    return ['goto {label};'.format(label=lab.inputString)], []
Maxime Perrotin's avatar
Maxime Perrotin committed
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291


@generate.register(ogAST.Transition)
def _transition(tr):
    ''' generate the code for a transition '''
    code, local_decl = [], []
    empty_transition = all(isinstance(act, ogAST.TaskInformalText)
                           for act in tr.actions)
    for action in tr.actions:
        stmt, local_var = generate(action)
        code.extend(stmt)
        local_decl.extend(local_var)
        if isinstance(action, ogAST.Label):
            break
    else:
        if tr.terminator:
            empty_transition = False
            code.extend(traceability(tr.terminator))
            if tr.terminator.label:
                code.append('<<{label}>>'.format(
                    label=tr.terminator.label.inputString))
            if tr.terminator.kind == 'next_state':
                if tr.terminator.inputString.strip() != '-':
1292
                    code.append('trId := ' + str(tr.terminator.next_id) + ';')
1293
1294
                    if tr.terminator.next_id == -1:
                        code.append('state := {nextState};'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1295
                                 nextState=tr.terminator.inputString))
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
                else:
                    if any(next_id
                           for next_id in tr.terminator.candidate_id.viewkeys()
                           if next_id != -1):
                        code.append('case state is')
                        for nid, sta in tr.terminator.candidate_id.viewitems():
                            if nid != -1:
                                for each in sta:
                                    code.extend(['when {} =>'.format(each),
                                                 'trId := {};'.format(nid)])

                        code.extend(['when others =>',
                                        'trId := -1;',
                                     'end case;'])
                    else:
                        code.append('trId := -1;')
Maxime Perrotin's avatar
Maxime Perrotin committed
1312
                code.append('goto next_transition;')
Maxime Perrotin's avatar
Maxime Perrotin committed
1313
1314
1315
1316
1317
1318
            elif tr.terminator.kind == 'join':
                code.append('goto {label};'.format(
                    label=tr.terminator.inputString))
            elif tr.terminator.kind == 'stop':
                pass
                # TODO
1319
1320
            elif tr.terminator.kind == 'return':
                string = ''
1321
1322
                if tr.terminator.next_id == -1:
                    if tr.terminator.return_expr:
Maxime Perrotin's avatar
Maxime Perrotin committed
1323
                        stmts, string, local = expression\
1324
1325
1326
                                                    (tr.terminator.return_expr)
                        code.extend(stmts)
                        local_decl.extend(local)
Maxime Perrotin's avatar
Maxime Perrotin committed
1327
1328
                    code.append('return{};'
                                .format(' ' + string if string else ''))
1329
1330
                else:
                    code.append('trId := ' + str(tr.terminator.next_id) + ';')
Maxime Perrotin's avatar
Maxime Perrotin committed
1331
                    code.append('goto next_transition;')
Maxime Perrotin's avatar
Maxime Perrotin committed
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
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
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
    if empty_transition:
        # If transition does not have any statement, generate an Ada 'null;'
        code.append('null;')
    return code, local_decl


@generate.register(ogAST.Floating_label)
def _floating_label(label):
    ''' Generate the code for a floating label (Ada label + transition) '''
    code = []
    local_decl = []
    # Add the traceability information
    code.extend(traceability(label))
    code.append('<<{label}>>'.format(label=label.inputString))
    if label.transition:
        code_trans, local_trans = generate(label.transition)
        code.extend(code_trans)
        local_decl.extend(local_trans)
    else:
        code.append('return;')
    return code, local_decl


@generate.register(ogAST.Procedure)
def _inner_procedure(proc):
    ''' Generate the code for a procedure - does not support states '''
    code = []
    local_decl = []
    # TODO: Update the global list of procedures
    # with procedure defined inside the current procedure
    # Not critical: the editor forbids procedures inside procedures

    # Save variable scope (as local variables may shadow process variables)
    outer_scope = dict(VARIABLES)
    VARIABLES.update(proc.variables)
    # Also add procedure parameters in scope
    for var in proc.fpar:
        VARIABLES.update({var['name']: (var['type'], None)})

    # Build the procedure signature
    pi_header = 'procedure {proc_name}'.format(proc_name=proc.inputString)
    if proc.fpar:
        pi_header += '('
        params = []
        for fpar in proc.fpar:
            typename = fpar['type'].ReferencedTypeName.replace('-', '_')
            params.append('l_{name}: in{out} asn1Scc{ptype}'.format(
                    name=fpar.get('name'),
                    out=' out' if fpar.get('direction') == 'out' else '',
                    ptype=typename))
        pi_header += ';'.join(params)
        pi_header += ')'

    local_decl.append(pi_header + ';')

1387
1388
1389
1390
1391
    if proc.external:
        local_decl.append('pragma import(C, {});'.format(proc.inputString))
    else:
        # Generate the code for the procedure itself
        # local variables and code of the START transition
Maxime Perrotin's avatar
Maxime Perrotin committed
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
        # Recursively generate the code for inner-defined procedures
        for inner_proc in proc.content.inner_procedures:
            inner_code, inner_local = generate(inner_proc)
            local_decl.extend(inner_local)
            code.extend(inner_code)
        code.append(pi_header + ' is')
        for var_name, (var_type, def_value) in proc.variables.viewitems():
            typename = var_type.ReferencedTypeName.replace('-', '_')
            if def_value:
                # Expression must be a ground expression, i.e. must not
                # require temporary variable to store computed result
Maxime Perrotin's avatar
Maxime Perrotin committed
1403
                dst, dstr, dlocal = expression(def_value)
Maxime Perrotin's avatar
Maxime Perrotin committed
1404
1405
1406
1407
1408
                assert not dst and not dlocal, 'Ground expression error'
            code.append('l_{name} : asn1Scc{sort}{default};'.format(
                name=var_name,
                sort=typename,
                default=' := ' + dstr if def_value else ''))
1409
1410

        # Look for labels in the diagram and transform them in floating labels
1411
        Helper.inner_labels_to_floating(proc)
1412

Maxime Perrotin's avatar
Maxime Perrotin committed
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
        tr_code, tr_decl = generate(proc.content.start.transition)
        # Generate code for the floating labels
        code_labels = []
        for label in proc.content.floating_labels:
            code_label, label_decl = generate(label)
            code_labels.extend(code_label)
            tr_decl.extend(label_decl)
        code.extend(tr_decl)
        code.append('begin')
        code.extend(tr_code)
        code.extend(code_labels)
        code.append('end {procName};'.format(procName=proc.inputString))
    code.append('\n')

    # Reset the scope to how it was prior to the procedure definition
    VARIABLES.clear()
    VARIABLES.update(outer_scope)

    return code, local_decl


# A few helper functions needed by the Ada backend

def find_basic_type(a_type):
1437
    ''' Return the ASN.1 basic type of a_type '''
Maxime Perrotin's avatar
Maxime Perrotin committed
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
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
    basic_type = a_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
    return basic_type


def find_var(var):
    ''' Return a variable from the scope, with proper case '''
    for visible_var in VARIABLES.viewkeys():
        if var.lower() == visible_var.lower():
            return visible_var
    return None


def path_type(path):
    '''
        Return the type of a path construct
        Input: path a!b!c in the form [a, b, c]
        Output: parent_kind, parent_typename (strings)
        Used for Ada to know about CHOICE types
    '''
    # NOTE: all this code is duplicated from the find_type function
    # in ogParser - XXX Refactoring to be done
    if not path or not find_var(path[0]):
        return None, None
    kind = ''
    vartype, _ = VARIABLES[find_var(path[0])]
    asn1_name = vartype.ReferencedTypeName
    # Get ASN.1 type of the first element
    current = TYPES[asn1_name].type
    if len(path) > 1:
        for elem in path[1:]:
            current = find_basic_type(current)
            if 'procParams' in elem:
                # Discard operator parameters: they do not change the type
                continue
            # Sequence, Choice (case insensitive)
            if current.kind in ('SequenceType', 'ChoiceType'):
                elem_asn1 = elem.replace('_', '-').lower()
                type_idx, = (c for c in current.Children
                                    if c.lower() == elem_asn1)
                current = current.Children[type_idx].type
            # Sequence of
            elif current.kind == 'SequenceOfType':
                current = current['type']
            elif current.kind.endswith('EnumeratedType'):
                pass
            else:
                raise TypeError('Expression ' + '.'.join(path) +
                                ' does not resolve')
        asn1_name = current.ReferencedTypeName
    kind = find_basic_type(current).kind.replace('-', '_')
    LOG.debug('[Ada Generator] Type of path ' + '!'.join(path) +
             ' is ' + asn1_name + ' (' + kind + ')')
    return kind, asn1_name.replace('-', '_')


def traceability(symbol):
    ''' Return a string with code-to-model traceability '''
    trace = ['-- {line}'.format(line=l) for l in
        repr(symbol).split('\n')]
    if hasattr(symbol, 'comment') and symbol.comment:
        trace.extend(traceability(symbol.comment))
    return trace

def format_ada_code(stmts):
    ''' Indent properly the Ada code '''
    indent = 0
    indent_pattern = '    '
    for line in stmts[:-1]:
        elems = line.strip().split()
        if elems and elems[0].startswith(('when', 'end', 'elsif', 'else')):
            indent = max(indent - 1, 0)
        if elems and elems[-1] == 'case;': # Corresponds to end case;
            indent = max(indent - 1, 0)
        if line:
            yield indent_pattern * indent + line
        if elems and elems[-1] in ('is', 'then', 'loop', 'declare'):
            indent += 1
        if elems and elems[0] in ('begin', 'case', 'else', 'when'):
            indent += 1
        if not elems:  # newline -> decrease indent
            indent -= 1
    yield stmts[-1]