AdaGenerator.py 95 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
    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
73
import traceback
74
import os
Maxime Perrotin's avatar
Maxime Perrotin committed
75
from itertools import chain
Maxime Perrotin's avatar
Maxime Perrotin committed
76
77
78
from singledispatch import singledispatch

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

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 = []

93
94
95
# Specify that the target is a shared library
SHARED_LIB = False

96
UNICODE_SEP = u'\u00dc'
97
LPREFIX = u'ctxt'
Maxime Perrotin's avatar
Maxime Perrotin committed
98
99

@singledispatch
100
def generate(*args, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
101
102
    ''' Generate the code for an item of the AST '''
    raise TypeError('[AdaGenerator] Unsupported AST construct')
103
    return [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
104
105


Maxime Perrotin's avatar
Maxime Perrotin committed
106
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
107
@generate.register(ogAST.Process)
108
def _process(process, simu=False, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
109
110
111
112
113
114
115
116
    ''' Generate the code for a complete process (AST Top level) '''
    process_name = process.processName
    global TYPES
    TYPES = process.dataview
    del OUT_SIGNALS[:]
    del PROCEDURES[:]
    OUT_SIGNALS.extend(process.output_signals)
    PROCEDURES.extend(process.procedures)
117
    global SHARED_LIB
118
    global LPREFIX
119
120
    if simu:
        SHARED_LIB = True
121
        LPREFIX = process_name + u'_ctxt'
Maxime Perrotin's avatar
Maxime Perrotin committed
122

123
124
125
126
127
128
129
130
131
132
133
    # When building a shared library (with simu=True), generate a "mini-cv"
    # for aadl2glueC to create the code interfacing with asn1scc
    minicv = ['-- Automatically generated by OpenGEODE - do NOT modify!']
    def aadl_template(sp_name, io_param, pi_or_ri):
        ''' AADL mini-cv code in case of shared library
            sp_name  : name of the PI or RI
            io_param : list of (param_name, type_name, direction)
            pi_or_ri : string "PI" or "RI" depending on the direction
            return a string
        '''
        res = []
134
135
136
137
138
        if not io_param:
            LOG.info('Parameterless interface "{}" will not appear in the'
                     ' AADL file but will be handled directly by the GUI'
                     .format(sp_name))
            return ''
139
140
141
142
143
144
        # In case of shared library, generate the AADL "mini-cv" code
        res.append('SUBPROGRAM {}'.format(sp_name))
        if io_param:
            res.append('FEATURES')
            for param_name, sort, direction in io_param:
                res.append('    {pname}: {io} PARAMETER DataView::{sort} '
145
146
147
                          '{{encoding=>Native;}};'.format(pname=param_name,
                                                          sort=sort,
                                                          io=direction))
148
149
150
151
152
153
154
155
156
        res.append('END {};\n'.format(sp_name))
        res.append('SUBPROGRAM IMPLEMENTATION {}.GUI_{}'
                      .format(sp_name, pi_or_ri))
        res.append('PROPERTIES')
        res.append('    FV_Name => "{}";'.format(process_name))
        res.append('    Source_Language => GUI_{};'.format(pi_or_ri))
        res.append('END {}.GUI_{};\n'.format(sp_name, pi_or_ri))
        return '\n'.join(res)

157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    # bash script to simulate the system (TEMPORARY)
    simu_script = '''#!/bin/bash -e
opengeode {pr}.pr --shared
asn1.exe -Ada dataview-uniq.asn -typePrefix asn1Scc -equal
asn1.exe -c dataview-uniq.asn -typePrefix asn1Scc -equal
gnatmake -gnat2012 -c *.adb
gnatbind -n -Llib{pr} {pr}
gnatmake -c -gnat2012 b~{pr}.adb
gcc -shared -fPIC -o lib{pr}.so b~{pr}.o {pr}.o taste_dataview.o adaasn1rtl.o -lgnat
rm -rf simu
mkdir -p simu
asn2aadlPlus dataview-uniq.asn simu/DataView.aadl
cp lib{pr}.so dataview-uniq.asn *.pr simu
mv *.aadl simu
cd simu
aadl2glueC DataView.aadl {pr}_interface.aadl
asn2dataModel -toPython dataview-uniq.asn
make -f Makefile.python
echo "errCodes=$(taste-asn1-errCodes ./dataview-uniq.h)" >>datamodel.py
LD_LIBRARY_PATH=. taste-gui -l
'''.format(pr=process_name)

179

Maxime Perrotin's avatar
Maxime Perrotin committed
180
181
    LOG.info('Generating Ada code for process ' + str(process_name))

182
    # In case model has nested states, flatten everything
183
    Helper.flatten(process, sep=UNICODE_SEP)
184

Maxime Perrotin's avatar
Maxime Perrotin committed
185
    # Process State aggregations (Parallel states)
186

Maxime Perrotin's avatar
Maxime Perrotin committed
187
188
189
    # Get list of parallel states to be added to the global list of states,
    # and list of their inner substates
    aggregates, substates = Helper.state_aggregations(process)
190
191
192

    # End debug

Maxime Perrotin's avatar
Maxime Perrotin committed
193
194
195
196
    # 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
197
198
199
    VARIABLES.update(process.variables)

    process_level_decl = []
200
201

    # Establish the list of states (excluding START states)
Maxime Perrotin's avatar
Maxime Perrotin committed
202
203
204
    statelist = ', '.join(chain(aggregates, (name for name in
                             process.mapping.iterkeys()
                             if not name.endswith(u'START')))) or 'No_State'
205
206
207
208
209
210
211
212
213
214
    if statelist:
        states_decl = u'type States is ({});'.format(statelist)
        process_level_decl.append(states_decl)

    # Generate the code to declare process-level context
    process_level_decl.extend(['type {}_Ty is'.format(LPREFIX), 'record'])

    if statelist:
        process_level_decl.append('state : States;')

Maxime Perrotin's avatar
Maxime Perrotin committed
215
216
217
218
219
    # State aggregation: add list of substates (XXX to be added in C generator)
    for each in substates:
        process_level_decl.append(u'{}{}state: States;'
                                  .format(each, UNICODE_SEP))

Maxime Perrotin's avatar
Maxime Perrotin committed
220
221
222
223
    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
224
            dst, dstr, dlocal = expression(def_value)
225
226
227
            varbty = find_basic_type(var_type)
            if varbty.kind in ('SequenceOfType', 'OctetStringType'):
                dstr = array_content(def_value, dstr, varbty)
Maxime Perrotin's avatar
Maxime Perrotin committed
228
229
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
230
231
                        u'{n} : aliased {sort}{default};'
                        .format(n=var_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
232
233
                                sort=type_name(var_type),
                                default=u' := ' + dstr if def_value else u''))
Maxime Perrotin's avatar
Maxime Perrotin committed
234

235
236
237
    process_level_decl.append('end record;'.format(LPREFIX))
    process_level_decl.append('{ctxt}: {ctxt}_Ty;'.format(ctxt=LPREFIX))

Maxime Perrotin's avatar
Maxime Perrotin committed
238

239
    for name, val in process.mapping.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
240
241
        if name.endswith(u'START') and name != u'START':
            process_level_decl.append(u'{name} : constant := {val};'
242
243
                                      .format(name=name, val=str(val)))

244
245
246
247
248
    # Declare start procedure for aggregate states XXX add in C generator
    for each in aggregates:
        process_level_decl.append(u'procedure {}{}START;'.format(each,
                                                                 UNICODE_SEP))

249
250
251
    # Add the declaration of the runTransition procedure, if needed
    if process.transitions:
        process_level_decl.append('procedure runTransition(Id: Integer);')
Maxime Perrotin's avatar
Maxime Perrotin committed
252

253
    # Generate the code of the start transition (if process not empty)
254
    start_transition = ['begin',
255
                        'runTransition(0);'] if process.transitions else []
256

Maxime Perrotin's avatar
Maxime Perrotin committed
257
258
259
260
261
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
262
        asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
263
264
265
266
267
268
269
270
    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;

271
with Ada.Unchecked_Conversion;
272
with Ada.Numerics.Generic_Elementary_Functions;
273

Maxime Perrotin's avatar
Maxime Perrotin committed
274
275
276
277
{dataview}

with Interfaces;
use Interfaces;
278
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
279
package body {process_name} is'''.format(process_name=process_name,
280
281
282
283
                                         dataview=asn1_modules,
                                         C='with Interfaces.C.Strings;\n'
                                           'use Interfaces.C.Strings;'
                                            if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
284
285
286
287
288
289

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

{dataview}
Maxime Perrotin's avatar
Maxime Perrotin committed
290
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
291
292

package {process_name} is'''.format(process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
293
294
295
296
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
297

Maxime Perrotin's avatar
Maxime Perrotin committed
298
    dll_api = []
299
300
    if simu:
        ads_template.append('--  DLL Interface')
301
        dll_api.append('-- DLL Interface to remotely change internal data')
302
303
        # Add function allowing to trace current state as a string
        process_level_decl.append("function get_state return chars_ptr "
304
305
306
307
                                  "is (New_String(states'Image({ctxt}.state)))"
                                  " with Export, Convention => C, "
                                  'Link_Name => "{name}_state";'
                                  .format(name=process_name, ctxt=LPREFIX))
308
309
        set_state_decl = "procedure set_state(new_state: chars_ptr)"
        ads_template.append("{};".format(set_state_decl))
310
        ads_template.append('pragma export(C, set_state, "_set_state");')
311
312
        dll_api.append("{} is".format(set_state_decl))
        dll_api.append("begin")
313
314
        dll_api.append("{}.state := States'Value(Value(new_state));"
                       .format(LPREFIX))
315
316
317
        dll_api.append("end set_state;")
        dll_api.append("")

318
319
320
321
        # Functions to get gobal variables (length and value)
        for var_name, (var_type, _) in process.variables.viewitems():
            # Getters for local variables
            process_level_decl.append("function l_{name}_size return integer "
322
323
324
325
                                     "is ({prefix}.{name}'Size/8) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_size";'
                                     .format(prefix=LPREFIX, name=var_name))
326
            process_level_decl.append("function l_{name}_value"
327
328
329
330
331
                                     " return access {sort} "
                                     "is ({prefix}.{name}'access) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_value";'
                                     .format(prefix=LPREFIX, name=var_name,
332
333
334
335
336
                                              sort=type_name(var_type)))
            # Setters for local variables
            setter_decl = "procedure dll_set_l_{name}(value: access {sort})"\
                          .format(name=var_name, sort=type_name(var_type))
            ads_template.append('{};'.format(setter_decl))
337
338
            ads_template.append('pragma export(C, dll_set_l_{name},'
                                ' "_set_{name}");'.format(name=var_name))
339
340
            dll_api.append('{} is'.format(setter_decl))
            dll_api.append('begin')
341
            dll_api.append('{}.{} := value.all;'.format(LPREFIX, var_name))
342
343
344
345
            dll_api.append('end dll_set_l_{};'.format(var_name))
            dll_api.append('')


Maxime Perrotin's avatar
Maxime Perrotin committed
346
347
348
349
350
351
352
353
354
355
356
357
358
    # 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)

    # Add the code of the procedures definitions
    taste_template.extend(inner_procedures_code)

359
360
361
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
362
363
364
    # 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]:
Maxime Perrotin's avatar
Maxime Perrotin committed
365
        if signal.get('name', u'START') == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
366
            continue
367
368
369
        pi_header = u'procedure {sig_name}'.format(sig_name=signal['name'])
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
370
371
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
372
            typename = type_name(signal['type'])
373
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
374
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
375
376

        # Add declaration of the provided interface in the .ads file
377
        ads_template.append(u'--  Provided interface "' + signal['name'] + '"')
Maxime Perrotin's avatar
Maxime Perrotin committed
378
        ads_template.append(pi_header + ';')
379
380
381
382
383
384
385
        ads_template.append(u'pragma export(C, {name}, "{proc}_{name}");'
                             .format(name=signal['name'], proc=process_name))

        if simu:
            # Generate code for the mini-cv template
            params = [(param_name, type_name(signal['type'], use_prefix=False),
                      'IN')] if 'type' in signal else []
386
            minicv.append(aadl_template(signal['name'], params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
387
388
389
390

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
391
        taste_template.append('case {ctxt}.state is'.format(ctxt=LPREFIX))
Maxime Perrotin's avatar
Maxime Perrotin committed
392
        for state in process.mapping.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
393
            if state.endswith(u'START'):
Maxime Perrotin's avatar
Maxime Perrotin committed
394
                continue
Maxime Perrotin's avatar
Maxime Perrotin committed
395
            taste_template.append(u'when {state} =>'.format(state=state))
Maxime Perrotin's avatar
Maxime Perrotin committed
396
            input_def = mapping[signal['name']].get(state)
397
            # Check for nested states to call optional exit procedure
398
            sep = UNICODE_SEP
399
            state_tree = state.split(sep)
Maxime Perrotin's avatar
Maxime Perrotin committed
400
            context = process
401
402
403
404
405
406
            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:
407
                    if current.lower() == comp.statename.lower():
408
409
410
411
412
413
414
415
                        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):
416
417
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
                                          .format(ref=each, sep=sep))
418

Maxime Perrotin's avatar
Maxime Perrotin committed
419
420
421
422
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
423
424
                    taste_template.append(u'{ctxt}.{inp} := {tInp}.all;'
                                          .format(ctxt=LPREFIX,
425
426
                                                  inp=inp,
                                                  tInp=param_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
427
428
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
429
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
430
431
432
433
434
435
436
437
                        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;')
438
        taste_template.append(u'end {};'.format(signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
439
440
441
442
443
        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:
444

445
446
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
447
        # Add (optional) RI parameter
448
449
450
        # Paramless TMs: when targetting simulation, the name of the TM is
        # passed as single parameter. This allows the simualor to handle them
        # dynamically, with a single callback function for all TMs
Maxime Perrotin's avatar
Maxime Perrotin committed
451
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
452
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
453
            typename = type_name(signal['type'])
454
455
456
457
458
            param_spec = u'({pName}: access {sort}{shared})' \
                         .format(pName=param_name,
                                 sort=typename,
                                 shared=u'; Size: Integer'
                                        if SHARED_LIB else '')
459
460
461
        ads_template.append(u'--  {}equired interface "{}"'
                            .format("Paramless r" if not 'type' in signal
                                else "R", signal['name']))
462
463
464
465
466
467
        if simu:
            # When generating a shared library, we need a callback mechanism
            ads_template.append(u'type {}_T is access procedure{};'
                                .format(signal['name'], param_spec))
            ads_template.append('pragma Convention(Convention => C,'
                                ' Entity => {}_T);'.format(signal['name']))
468
            ads_template.append('{sig} : {sig}_T;'
469
                                .format(sig=signal['name']))
470
471
472
473
474
            ads_template.append('procedure Register_{sig}(Callback: {sig}_T);'
                                .format(sig=signal['name']))
            ads_template.append('pragma Export(C, Register_{sig},'
                                ' "register_{sig}");'
                                .format(sig=signal['name']))
475
476
477
478

            # Generate code for the mini-cv template
            params = [(param_name, type_name(signal['type'], use_prefix=False),
                      'IN')] if 'type' in signal else []
479
            minicv.append(aadl_template(signal['name'], params, 'PI'))
480

481
482
483
484
485
486
487
            taste_template.append('procedure Register_{sig}'
                                  '(Callback:{sig}_T) is'
                                  .format(sig=signal['name']))
            taste_template.append('begin')
            taste_template.append('{} := Callback;'.format(signal['name']))
            taste_template.append('end Register_{};'.format(signal['name']))
            taste_template.append('')
488
489
490
491
492
        else:
            ads_template.append(u'procedure {}{};'
                                .format(signal['name'], param_spec))
            ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
                                .format(sig=signal['name'], proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
493
494

    # for the .ads file, generate the declaration of the external procedures
495
496
    for proc in (proc for proc in process.procedures if proc.external):
        ri_header = u'procedure {sig_name}'.format(sig_name=proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
497
        params = []
498
499
500
501
        params_spec = u""
        if simu:
            # For simulators: add the TM name as first parameter
            params.append("tm: chars_ptr")
Maxime Perrotin's avatar
Maxime Perrotin committed
502
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
503
            typename = type_name(param['type'])
504
            params.append(u'{par[name]}: access {sort}{shared}'
Maxime Perrotin's avatar
Maxime Perrotin committed
505
                          .format(par=param,
506
507
508
509
                                  sort=typename,
                                  shared=u"; {}_Size: Integer"
                                         .format(param['name'])
                                         if SHARED_LIB else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
510
        if params:
511
512
            params_spec = "({})".format("; ".join(params))
            ri_header += params_spec
Maxime Perrotin's avatar
Maxime Perrotin committed
513
        ads_template.append(
dbarbera's avatar
dbarbera committed
514
                        u'--  Sync required interface "' + proc.inputString)
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
        if simu:
            # As for async TM, generate a callback mechanism
            ads_template.append(u"type {}_T is access procedure{};"
                                .format(proc.inputString, params_spec))
            ads_template.append('pragma Convention(Convention => C,'
                                ' Entity => {}_T);'.format(proc.inputString))
            ads_template.append('{sig} : {sig}_T;'
                                .format(sig=proc.inputString))
            ads_template.append('procedure Register_{sig}(Callback: {sig}_T);'
                                .format(sig=proc.inputString))
            ads_template.append('pragma Export(C, Register_{sig},'
                                ' "register_{sig}");'
                                .format(sig=proc.inputString))
            taste_template.append('procedure Register_{sig}'
                                  '(Callback:{sig}_T) is'
                                  .format(sig=proc.inputString))
            taste_template.append('begin')
            taste_template.append('{} := Callback;'.format(proc.inputString))
            taste_template.append('end Register_{};'.format(proc.inputString))
            taste_template.append('')

        else:
            ads_template.append(ri_header + u';')
            ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
                    .format(sig=proc.inputString, proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
540
541
542

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
543
544
545
546
547
        ads_template.append(u'--  Timer {} SET and RESET functions'
                            .format(timer))
        if simu:
            # Declare callback registration for the SET and RESET functions
            ads_template.append(u'type SET_{}_T is access procedure'
Maxime Perrotin's avatar
Maxime Perrotin committed
548
                                 '(name: chars_ptr; duration: Integer);'
549
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
550
551
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
            for each in ('', 'RE'):
                ads_template.append('pragma Convention(Convention => C,'
                                    ' Entity => {re}SET_{t}_T);'
                                    .format(re=each, t=timer))
                ads_template.append('{re}SET_{t} : {re}SET_{t}_T;'
                                    .format(re=each, t=timer))
                ads_template.append('procedure Register_{re}SET_{t}'
                                    '(Callback: {re}SET_{t}_T);'
                                    .format(re=each, t=timer))
                ads_template.append('pragma Export(C, Register_{re}SET_{t},'
                                    ' "register_{re}SET_{t}");'
                                    .format(re=each, t=timer))
            # Code for the SET/RESET timer callback registration
            for each in ('', 'RE'):
                taste_template.append('procedure Register_{re}SET_{t}'
                                      '(Callback:{re}SET_{t}_T) is'
                                      .format(re=each, t=timer))
                taste_template.append('begin')
                taste_template.append('{re}SET_{t} := Callback;'
                                      .format(re=each, t=timer))
                taste_template.append('end Register_{re}SET_{t};'
                                      .format(re=each, t=timer))
                taste_template.append('')

        else:
            ads_template.append(u'procedure SET_{}(val: access asn1SccT_UInt32);'
Maxime Perrotin's avatar
Maxime Perrotin committed
578
                .format(timer))
579
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
580
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
581
                .format(timer=timer, proc=process_name))
582
583
            ads_template.append(u'procedure RESET_{};'.format(timer))
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
584
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
585
586
                .format(timer=timer, proc=process_name))

587
588
589
590
591
592
    # If the process has no input, output, procedures, or timers, then Ada
    # will not compile the body - generate a pragma to fix this
    if not process.timers and not process.procedures \
            and not process.input_signals and not process.output_signals:
        ads_template.append('pragma elaborate_body;')

593
594
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610

    # 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)

611
612
613
614
    # Generate the code of the runTransition procedure, if needed
    if process.transitions:
        taste_template.append('procedure runTransition(Id: Integer) is')
        taste_template.append('trId : Integer := Id;')
Maxime Perrotin's avatar
Maxime Perrotin committed
615

616
617
618
        # Declare the local variables needed by the transitions in the template
        taste_template.extend(set(local_decl_transitions))
        taste_template.append('begin')
619

620
621
622
        # 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
623

624
625
        # Generate the switch-case on the transition id
        taste_template.append('case trId is')
Maxime Perrotin's avatar
Maxime Perrotin committed
626

627
628
629
630
631
632
633
        for idx, val in enumerate(code_transitions):
            taste_template.append(u'when {idx} =>'.format(idx=idx))
            val = [u'{line}'.format(line=l) for l in val]
            if val:
                taste_template.extend(val)
            else:
                taste_template.append('null;')
Maxime Perrotin's avatar
Maxime Perrotin committed
634

635
636
637
638
639
640
641
642
        taste_template.append('when others =>')
        taste_template.append('null;')

        taste_template.append('end case;')
        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
643

644
645
        # Add the code for the floating labels
        taste_template.extend(code_labels)
Maxime Perrotin's avatar
Maxime Perrotin committed
646

647
648
649
650
651
652
        #if code_labels:
        taste_template.append('<<next_transition>>')
        taste_template.append('null;')
        taste_template.append('end loop;')
        taste_template.append('end runTransition;')
        taste_template.append('\n')
Maxime Perrotin's avatar
Maxime Perrotin committed
653

654
    # Add code of the package elaboration
Maxime Perrotin's avatar
Maxime Perrotin committed
655
656
657
658
659
660
661
    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))

662
    with open(process_name.lower() + os.extsep + 'adb', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
663
664
        ada_file.write(
                u'\n'.join(format_ada_code(taste_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
665

666
    with open(process_name.lower() + os.extsep + 'ads', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
667
668
        ada_file.write(
                u'\n'.join(format_ada_code(ads_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
669

670
671
672
673
    if simu:
        with open(u'{}_interface.aadl'.format(process_name), 'w') as aadl:
            aadl.write(u'\n'.join(minicv).encode('latin1'))

674
675
676
677
    if not simu:
        with open('{}_simu.sh'.format(process_name), 'w') as bash_script:
            bash_script.write(simu_script)

Maxime Perrotin's avatar
Maxime Perrotin committed
678
679
680
681
682
683
684
685

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
686
687
688
689
690
691
692
693
694
    if isinstance(param, ogAST.ExprAppend):
        # Append: call Put_Line separately for each side of the expression
        st1, _, lcl1= write_statement(param.left, newline = False)
        st2, _, lcl2 = write_statement(param.right, newline = False)
        code.extend(st1)
        code.extend(st2)
        local.extend(lcl1)
        local.extend(lcl2)
    elif type_kind.endswith('StringType'):
Maxime Perrotin's avatar
Maxime Perrotin committed
695
696
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
697
698
            code.append(u'Put("{}");'
                        .format(param.value[1:-1].replace('"', "'")))
Maxime Perrotin's avatar
Maxime Perrotin committed
699
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
700
            code, string, local = expression(param)
701
702
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
703
                sep = UNICODE_SEP
704
                last_it = u""
705
706
                if isinstance(param, ogAST.PrimSubstring):
                    range_str = u"{}'Range".format(string)
707
                    iterator = u"i - {}'First + 1".format(string)
708
709
710
                elif basic_type.Min == basic_type.Max:
                    range_str = u"{}.Data'Range".format(string)
                    string += u".Data"
711
                    iterator = u"i"
712
713
714
                else:
                    range_str = u"1 .. {}.Length".format(string)
                    string += u".Data"
715
716
                    iterator = u"i"
                    last_it = u"({})".format(range_str)
717
                code.extend([u"for i in {} loop".format(range_str),
718
719
                             u"Put(Character'Val({st}(i)));"
                             .format(st=string, sep=sep, it=iterator),
720
                             u"end loop;"])
721
722
            else:
                code.append("Put({});".format(string))
Maxime Perrotin's avatar
Maxime Perrotin committed
723
724
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
725
        code, string, local = expression(param)
dbarbera's avatar
dbarbera committed
726
        if type_kind in ('IntegerType', 'Integer32Type'):
727
            cast = "Asn1Int"
Maxime Perrotin's avatar
Maxime Perrotin committed
728
729
730
731
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
732
        code.append(u"Put({cast}'Image({s}));".format(cast=cast, s=string))
733
734
735
736
    elif type_kind == 'EnumeratedType':
        code, string, local = expression(param)
        code.append(u"Put({}'Image({}));".format(type_name(param.exprType),
                                                 string))
Maxime Perrotin's avatar
Maxime Perrotin committed
737
    else:
738
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
739
740
741
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
742
743
    if newline:
        code.append(u"New_Line;")
Maxime Perrotin's avatar
Maxime Perrotin committed
744
745
746
747
748
    return code, string, local


@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
749
def _call_external_function(output, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
750
751
752
753
754
755
756
757
758
    ''' 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']
759
        list_of_params = []
Maxime Perrotin's avatar
Maxime Perrotin committed
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778

        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
779
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
780
781
            code.extend(p_code)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
782
783
784
785
            if not SHARED_LIB:
                code.append('RESET_{};'.format(p_id))
            else:
                code.append('RESET_{t}(New_String("{t}"));'.format(t=p_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
786
787
788
789
            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
790
791
            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
792
793
794
795
            code.extend(t_code)
            code.extend(p_code)
            local_decl.extend(t_local)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
796
797
798
799
800
801
802
803
804
805
806
            if not SHARED_LIB:
                # 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))
            else:
                code.append('SET_{t}(New_String("{t}"), {val});'
                            .format(t=p_id, val=t_val))
Maxime Perrotin's avatar
Maxime Perrotin committed
807
808
            continue
        proc, out_sig = None, None
809
        is_out_sig = False
Maxime Perrotin's avatar
Maxime Perrotin committed
810
811
812
        try:
            out_sig, = [sig for sig in OUT_SIGNALS
                        if sig['name'].lower() == signal_name.lower()]
813
            is_out_sig = True if SHARED_LIB else False
Maxime Perrotin's avatar
Maxime Perrotin committed
814
        except ValueError:
815
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
816
            try:
817
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
818
                            if sig.inputString.lower() == signal_name.lower()]
819
820
                if proc.external:
                    out_sig = proc
821
822
823
824
                    if SHARED_LIB:
                        is_out_sig = True
                        list_of_params = ['New_String("{}")'
                                              .format(out['outputName'])]
Maxime Perrotin's avatar
Maxime Perrotin committed
825
            except ValueError:
826
                # Not there? Impossible, the parser would have barked
827
                raise ValueError(u'Probably a bug - please report')
Maxime Perrotin's avatar
Maxime Perrotin committed
828
        if out_sig:
829
            #list_of_params = []
Maxime Perrotin's avatar
Maxime Perrotin committed
830
831
832
833
834
835
836
837
838
839
            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']

Maxime Perrotin's avatar
Maxime Perrotin committed
840
                typename = type_name(param_type)
Maxime Perrotin's avatar
Maxime Perrotin committed
841
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
842
843
844
                code.extend(p_code)
                local_decl.extend(p_local)
                # Create a temporary variable for input parameters only
Maxime Perrotin's avatar
Maxime Perrotin committed
845
846
                # (If needed, i.e. if argument is not a local variable)
                if param_direction == 'in' \
847
                        and (not (isinstance(param, ogAST.PrimVariable)
848
                        and p_id.startswith(LPREFIX)) # NO FIXME WITH CTXT
849
                        or isinstance(param, ogAST.PrimFPAR)):
850
851
852
853
                    tmp_id = 'tmp{}'.format(out['tmpVars'][idx])
                    local_decl.append('{tmp} : aliased {sort};'
                                      .format(tmp=tmp_id,
                                              sort=typename))
854
855
856
857
                    if isinstance(param,
                              (ogAST.PrimSequenceOf, ogAST.PrimStringLiteral)):
                        p_id = array_content(param, p_id,
                                             find_basic_type(param_type))
858
859
860
861
862
                    code.append('{} := {};'.format(tmp_id, p_id))
                    list_of_params.append("{}'access{}"
                                          .format(tmp_id,
                                                  ", {}'Size".format(tmp_id)
                                                     if is_out_sig else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
863
                else:
864
865
866
                    # Output parameters/local variables
                    list_of_params.append(u"{var}'access{shared}"
                                         .format(var=p_id,
Maxime Perrotin's avatar
Maxime Perrotin committed
867
868
                                                shared=", {}'Size".format(p_id)
                                                  if is_out_sig else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
869
            if list_of_params:
870
871
872
                code.append(u'{RI}({params});'
                            .format(RI=out['outputName'],
                                    params=', '.join(list_of_params)))
Maxime Perrotin's avatar
Maxime Perrotin committed
873
            else:
874
875
876
                if not SHARED_LIB:
                    code.append(u'{RI};'.format(RI=out['outputName']))
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
877
878
                    code.append(u'{RI}(New_String("{RI}"));'
                                .format(RI=out['outputName']))
Maxime Perrotin's avatar
Maxime Perrotin committed
879
880
881
        else:
            # inner procedure call
            list_of_params = []
882
            for param in out.get('params', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
883
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
884
885
886
887
888
                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:
889
890
                code.append(u'p{sep}{proc}({params});'.format(
                    sep=UNICODE_SEP,
Maxime Perrotin's avatar
Maxime Perrotin committed
891
892
893
                    proc=proc.inputString,
                    params=', '.join(list_of_params)))
            else:
894
                code.append(u'p{}{};'.format(UNICODE_SEP, proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
895
896
897
898
    return code, local_decl


@generate.register(ogAST.TaskAssign)
899
def _task_assign(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
900
901
902
903
904
905
    ''' A list of assignments in a task symbol '''
    code, local_decl = [], []
    if task.comment:
        code.extend(traceability(task.comment))
    for expr in task.elems:
        code.extend(traceability(expr))
906
907
        # ExprAssign only returns code statements, no string
        code_assign, _, decl_assign = expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
908
909
910
911
912
913
        code.extend(code_assign)
        local_decl.extend(decl_assign)
    return code, local_decl


@generate.register(ogAST.TaskInformalText)
914
def _task_informal_text(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
915
916
917
918
919
920
921
922
923
    ''' 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)
924
def _task_forloop(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
925
926
927
928
929
930
    '''
        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 = [], []
931
    local_scope = dict(LOCAL_VAR)
Maxime Perrotin's avatar
Maxime Perrotin committed
932
933
934
935
936
937
938
    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
939
                start_stmt, start_str, start_local = expression(
dbarbera's avatar
dbarbera committed
940
                                                    loop['range']['start'])
Maxime Perrotin's avatar
Maxime Perrotin committed
941
942
943
944
                local_decl.extend(start_local)
                stmt.extend(start_stmt)
            if loop['range']['step'] == 1:
                start_str += '..'
Maxime Perrotin's avatar
Maxime Perrotin committed
945
            stop_stmt, stop_str, stop_local = expression(loop['range']['stop'])
Maxime Perrotin's avatar
Maxime Perrotin committed
946
947
948
            local_decl.extend(stop_local)
            stmt.extend(stop_stmt)
            if loop['range']['step'] == 1:
Maxime Perrotin's avatar
Maxime Perrotin committed
949
950
951
952
                if unicode.isnumeric(stop_str):
                    stop_str = unicode(int(stop_str) - 1)
                else:
                    stop_str = u'{} - 1'.format(stop_str)
Maxime Perrotin's avatar
Maxime Perrotin committed
953
                stmt.append(
954
                        u'for {it} in {start}{stop} loop'
dbarbera's avatar
dbarbera committed
955
                        .format(it=loop['var'], start=start_str, stop=stop_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
956
957
958
            else:
                # Step is not directly supported in Ada, we need to use 'while'
                stmt.extend(['declare',
959
                             u'{it} : Asn1Int := {start};'
Maxime Perrotin's avatar
Maxime Perrotin committed
960
961
962
963
                             .format(it=loop['var'],
                             start=start_str),
                             '',
                             'begin',
964
                             u'while {it} < {stop} loop'.format(it=loop['var'],
Maxime Perrotin's avatar
Maxime Perrotin committed
965
966
967
                                                               stop=stop_str)])
        else:
            # case of form: FOR x in SEQUENCE OF
968
969
970
            # Add iterator to the list of local variables
            LOCAL_VAR.update({loop['var']: (loop['type'], None)})

Maxime Perrotin's avatar
Maxime Perrotin committed
971
            list_stmt, list_str, list_local = expression(loop['list'])
Maxime Perrotin's avatar
Maxime Perrotin committed
972
            basic_type = find_basic_type(loop['list'].exprType)
973
            list_payload = list_str + string_payload(loop['list'], list_str)
974
975
976
977
978
            if isinstance(loop['list'], ogAST.PrimSubstring) or \
                    basic_type.Min == basic_type.Max:
                range_str = u"{}'Range".format(list_payload)
            else:
                range_str = u"1 .. {}.Length".format(list_str)
Maxime Perrotin's avatar
Maxime Perrotin committed
979
980
981
            stmt.extend(list_stmt)
            local_decl.extend(list_local)
            stmt.extend(['declare',
982
983
                         '{} : {};'.format(loop['var'],
                                           type_name(loop['type'])),
Maxime Perrotin's avatar
Maxime Perrotin committed
984
985
986
                         '',
                         'begin',
                         'for {it}_idx in {rc} loop'.format(it=loop['var'],
987
                                                            rc=range_str),
988
989
                         '{it} := {var}({it}_idx);'.format(it=loop['var'],
                                                          var=list_payload)])
Maxime Perrotin's avatar
Maxime Perrotin committed
990
991
992
993
        try:
            code_trans, local_trans = generate(loop['transition'])
            if local_trans:
                stmt.append('declare')
994
                stmt.extend(set(local_trans))
Maxime Perrotin's avatar
Maxime Perrotin committed
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
                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;')
1008
1009
1010
    # Restore list of local variables
    LOCAL_VAR.clear()
    LOCAL_VAR.update(local_scope)
Maxime Perrotin's avatar
Maxime Perrotin committed
1011
1012
1013
    return stmt, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
@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
    '''
    raise TypeError('Unsupported expression: ' + str(expr))
    return [], '', []

Maxime Perrotin's avatar
Maxime Perrotin committed
1024

Maxime Perrotin's avatar
Maxime Perrotin committed
1025
@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
1026
1027
def _primary_variable(prim):
    ''' Single variable reference '''
1028
1029
1030
1031
1032
1033
    var = find_var(prim.value[0])
    if not var or is_local(var):
        sep = ''
    else:
        sep = LPREFIX + '.'
    #sep = (LPREFIX + '.') if find_var(prim.value[0]) else u''
Maxime Perrotin's avatar
Maxime Perrotin committed
1034

dbarbera's avatar
dbarbera committed
1035
    ada_string = u'{sep}{name}'.format(sep=sep, name=prim.value[0])
Maxime Perrotin's avatar
Maxime Perrotin committed
1036

1037
1038
    if prim.exprType.__name__ == 'for_range':
        # Ada iterator in FOR loops is an Integer - we must cast to 64 bits
1039
        ada_string = u'Asn1Int({})'.format(ada_string)
1040
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1041
1042


1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
@expression.register(ogAST.PrimCall)
def _prim_call(prim):
    stmts, ada_string, local_decl = [], '', []

    ident = prim.value[0].lower()
    params = prim.value[1]['procParams']

    if ident in ('abs', 'fix', 'float'):
        # Return absolute value of a number
        param_stmts, param_str, local_var = expression(params[0])
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        ada_string += '{op}({param})'.format(
                param=param_str,
                op='abs' if ident == 'abs' else
Maxime Perrotin's avatar
Maxime Perrotin committed
1058
                'Asn1Int' if ident == 'fix' else 'Asn1Real'
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
                if ident == 'float' else 'ERROR')
    elif ident == 'power':
        operands = [None, None]
        for idx, param in enumerate(params):
            stmt, operands[idx], local = expression(param)
            stmts.extend(stmt)
            local_decl.extend(local)
        ada_string += '{op[0]} ** Natural({op[1]})'.format(op=operands)
    elif ident == 'length':
        # Length of sequence of: take only the first parameter
        exp = params[0]
        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)
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1081
1082
        if min_length == max_length \
                and not isinstance(exp, ogAST.PrimSubstring):
1083
1084
            ada_string += min_length
        else:
1085
1086
1087
1088
1089
            if isinstance(exp, ogAST.PrimSubstring):
                range_str = u"{}'Length".format(param_str)
            else:
                range_str = u"{}.Length".format(param_str)
            ada_string += ('Asn1Int({})'.format(range_str))
1090
1091
1092
1093
1094
1095
1096
    elif ident == 'present':
        # User wants to know what CHOICE element is present
        exp = params[0]
        # 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
Maxime Perrotin's avatar
Maxime Perrotin committed
1097
        exp_typename = type_name(exp.exprType)
1098
1099
1100
1101
1102
1103
1104
        if exp_type.kind != 'ChoiceType':
            error = '{} is not a CHOICE'.format(exp.inputString)
            LOG.error(error)
            raise TypeError(error)
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1105
1106
1107
        ada_string += ('{sort}_Kind({e})'
                       .format(sort=exp_typename,
                               e=param_str))
1108
1109
1110
    elif ident == 'num':
        # User wants to get an enumerated corresponding integer value
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1111
        exp_typename = type_name(exp.exprType)
1112
        param_stmts, param_str, local_var = expression(exp)
Maxime Perrotin's avatar
Maxime Perrotin committed
1113
1114
        local_decl.append('function num_{sort} is new Ada.Unchecked_Conversion'
                          '({sort}, Asn1Int);'.format(sort=exp_typename))
1115
1116
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1117
1118
1119
        ada_string += ('num_{sort}({p})'
                       .format(sort=exp_typename,
                               p=param_str))
dbarbera's avatar
dbarbera committed
1120
    elif ident == 'floor':
1121
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1122
        exp_typename = type_name(exp.exprType)
1123
1124
1125
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1126
1127
        ada_string += "{sort}'Floor({p})".format(sort=exp_typename,
                                                 p=param_str)
dbarbera's avatar
dbarbera committed
1128
    elif ident == 'ceil':
1129
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1130
        exp_typename = type_name(exp.exprType)
1131
1132
1133
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1134
1135
        ada_string += "{sort}'Ceiling({p})".format(sort=exp_typename,
                                                   p=param_str)
dbarbera's avatar
dbarbera committed
1136
    elif ident == 'cos':
1137
1138
1139
1140
1141
1142
        exp = params[0]
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        local_decl.append('package Math is new '
                          'Ada.Numerics.Generic_Elementary_Functions'
Maxime Perrotin's avatar
Maxime Perrotin committed
1143
                          '(Asn1Real);')
1144
        ada_string += "Math.Cos({})".format(param_str)
dbarbera's avatar
dbarbera committed
1145
    elif ident == 'round':
1146
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1147
        exp_typename = type_name(exp.exprType)
1148
1149
1150
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1151
1152
        ada_string += "{sort}'Rounding({p})".format(sort=exp_typename,
                                                    p=param_str)
dbarbera's avatar
dbarbera committed
1153
    elif ident == 'sin':
1154
1155
1156
1157
1158
1159
        exp = params[0]
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        local_decl.append('package Math is new '
                          'Ada.Numerics.Generic_Elementary_Functions'
Maxime Perrotin's avatar
Maxime Perrotin committed
1160
                          '(Asn1Real);')
1161
        ada_string += "Math.Sin({})".format(param_str)
dbarbera's avatar
dbarbera committed
1162
    elif ident == 'sqrt':
1163
1164
1165
1166
1167
1168
        exp = params[0]
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        local_decl.append('package Math is new '
                          'Ada.Numerics.Generic_Elementary_Functions'
Maxime Perrotin's avatar
Maxime Perrotin committed
1169
                          '(Asn1Real);')
1170
        ada_string += "Math.Sqrt({})".format(param_str)