AdaGenerator.py 96.9 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

187
188
    # Find recursively in the AST all state aggregations
    # Format: {'aggregation_name' : [list of ogAST.CompositeState]
189
    aggregates = Helper.state_aggregations(process)
190

191
192
193
    # Extract the list of parallel states names inside the composite states
    # of state aggregations XXX add to C generator
    parallel_states = Helper.parallel_states(aggregates)
194

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

    process_level_decl = []
202

203
204
205
206
207
208
209
210
211
    # Establish the list of states (excluding START states) XXX update C backend
    full_statelist = list(chain(aggregates.viewkeys(),
                               (name for name in process.mapping.iterkeys()
                                    if not name.endswith(u'START'))))
    reduced_statelist = [s for s in full_statelist if s not in parallel_states]

    if full_statelist:
        process_level_decl.append(u'type States is ({});'
                            .format(u', '.join(full_statelist) or u'No_State'))
212
213
214
215

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

216
    if full_statelist:
217
218
        process_level_decl.append('state : States;')

Maxime Perrotin's avatar
Maxime Perrotin committed
219
    # State aggregation: add list of substates (XXX to be added in C generator)
220
221
222
    for substates in aggregates.viewvalues():
        for each in substates:
            process_level_decl.append(u'{}{}state: States;'
223
                                      .format(each.statename, UNICODE_SEP))
Maxime Perrotin's avatar
Maxime Perrotin committed
224

Maxime Perrotin's avatar
Maxime Perrotin committed
225
226
227
228
    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
229
            dst, dstr, dlocal = expression(def_value)
230
231
232
            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
233
234
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
235
236
                        u'{n} : aliased {sort}{default};'
                        .format(n=var_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
237
238
                                sort=type_name(var_type),
                                default=u' := ' + dstr if def_value else u''))
Maxime Perrotin's avatar
Maxime Perrotin committed
239

240
241
242
    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
243

244
    for name, val in process.mapping.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
245
246
        if name.endswith(u'START') and name != u'START':
            process_level_decl.append(u'{name} : constant := {val};'
247
248
                                      .format(name=name, val=str(val)))

249
    # Declare start procedure for aggregate states XXX add in C generator
250
251
252
253
254
255
256
257
    # should create one START per "via" clause, TODO later
    aggreg_start_proc = []
    for name, substates in aggregates.viewitems():
        proc_name = u'procedure {}{}START'.format(name, UNICODE_SEP)
        process_level_decl.append(u'{};'.format(proc_name))
        aggreg_start_proc.extend([u'{} is'.format(proc_name),
                                  'begin'])
        aggreg_start_proc.extend(u'runTransition({sub}{sep}START);'
258
259
                                 .format(sub=subname.statename,
                                         sep=UNICODE_SEP)
260
                                 for subname in substates)
261
262
263
        #Following done in the transition, not needed here
        #aggreg_start_proc.append(u'{ctxt}.state := {name};'
        #                         .format(ctxt=LPREFIX, name=name))
264
265
266
        aggreg_start_proc.extend([u'end {}{}START;'
                                 .format(name, UNICODE_SEP),
                                 '\n'])
267

268
269
270
    # 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
271

272
    # Generate the code of the start transition (if process not empty)
273
    start_transition = ['begin',
274
                        'runTransition(0);'] if process.transitions else []
275

Maxime Perrotin's avatar
Maxime Perrotin committed
276
277
278
279
280
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
281
        asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
282
283
284
285
286
287
288
289
    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;

290
with Ada.Unchecked_Conversion;
291
with Ada.Numerics.Generic_Elementary_Functions;
292

Maxime Perrotin's avatar
Maxime Perrotin committed
293
294
295
296
{dataview}

with Interfaces;
use Interfaces;
297
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
298
package body {process_name} is'''.format(process_name=process_name,
299
300
301
302
                                         dataview=asn1_modules,
                                         C='with Interfaces.C.Strings;\n'
                                           'use Interfaces.C.Strings;'
                                            if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
303
304
305
306
307
308

    # 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
309
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
310
311

package {process_name} is'''.format(process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
312
313
314
315
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
316

Maxime Perrotin's avatar
Maxime Perrotin committed
317
    dll_api = []
318
319
    if simu:
        ads_template.append('--  DLL Interface')
320
        dll_api.append('-- DLL Interface to remotely change internal data')
321
322
        # Add function allowing to trace current state as a string
        process_level_decl.append("function get_state return chars_ptr "
323
324
325
326
                                  "is (New_String(states'Image({ctxt}.state)))"
                                  " with Export, Convention => C, "
                                  'Link_Name => "{name}_state";'
                                  .format(name=process_name, ctxt=LPREFIX))
327
328
        set_state_decl = "procedure set_state(new_state: chars_ptr)"
        ads_template.append("{};".format(set_state_decl))
329
        ads_template.append('pragma export(C, set_state, "_set_state");')
330
331
        dll_api.append("{} is".format(set_state_decl))
        dll_api.append("begin")
332
333
        dll_api.append("{}.state := States'Value(Value(new_state));"
                       .format(LPREFIX))
334
335
336
        dll_api.append("end set_state;")
        dll_api.append("")

337
338
339
340
        # 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 "
341
342
343
344
                                     "is ({prefix}.{name}'Size/8) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_size";'
                                     .format(prefix=LPREFIX, name=var_name))
345
            process_level_decl.append("function l_{name}_value"
346
347
348
349
350
                                     " return access {sort} "
                                     "is ({prefix}.{name}'access) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_value";'
                                     .format(prefix=LPREFIX, name=var_name,
351
352
353
354
355
                                              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))
356
357
            ads_template.append('pragma export(C, dll_set_l_{name},'
                                ' "_set_{name}");'.format(name=var_name))
358
359
            dll_api.append('{} is'.format(setter_decl))
            dll_api.append('begin')
360
            dll_api.append('{}.{} := value.all;'.format(LPREFIX, var_name))
361
362
363
            dll_api.append('end dll_set_l_{};'.format(var_name))
            dll_api.append('')

Maxime Perrotin's avatar
Maxime Perrotin committed
364
365
366
367
368
369
370
371
372
373
374
375
376
    # 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)

377
378
379
380
    # Generate the code of the START procedures of state aggregations
    # XXX to be added to C generator
    taste_template.extend(aggreg_start_proc)

381
382
383
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
384
385
386
    # 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
387
        if signal.get('name', u'START') == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
388
            continue
389
390
391
        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
392
393
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
394
            typename = type_name(signal['type'])
395
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
396
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
397
398

        # Add declaration of the provided interface in the .ads file
399
        ads_template.append(u'--  Provided interface "' + signal['name'] + '"')
Maxime Perrotin's avatar
Maxime Perrotin committed
400
        ads_template.append(pi_header + ';')
401
402
403
404
405
406
407
        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 []
408
            minicv.append(aadl_template(signal['name'], params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
409
410
411
412

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
413
        taste_template.append('case {ctxt}.state is'.format(ctxt=LPREFIX))
414
415
416
417

        def execute_transition(state):
            ''' Generate the code that triggers the transition for the current
                state/input combination '''
Maxime Perrotin's avatar
Maxime Perrotin committed
418
            input_def = mapping[signal['name']].get(state)
419
            # Check for nested states to call optional exit procedure
420
            sep = UNICODE_SEP
421
            state_tree = state.split(sep)
Maxime Perrotin's avatar
Maxime Perrotin committed
422
            context = process
423
424
425
426
427
428
            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:
429
                    if current.lower() == comp.statename.lower():
430
431
432
433
434
435
436
437
                        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):
438
439
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
                                          .format(ref=each, sep=sep))
440

Maxime Perrotin's avatar
Maxime Perrotin committed
441
442
443
444
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
445
446
                    taste_template.append(u'{ctxt}.{inp} := {tInp}.all;'
                                          .format(ctxt=LPREFIX,
447
448
                                                  inp=inp,
                                                  tInp=param_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
449
450
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
451
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
452
453
454
455
456
                        idx=input_def.transition_id))
                else:
                    taste_template.append('null;')
            else:
                taste_template.append('null;')
457
458
459
460
461
462
463

        for state in reduced_statelist:  # XXX C Backend
            if state.endswith(u'START'):
                continue
            taste_template.append(u'when {state} =>'.format(state=state))
            if state in aggregates.viewkeys():
                taste_template.append(u'-- this is a state aggregation')
Maxime Perrotin's avatar
Maxime Perrotin committed
464
465
466
467
468
469
470
                # we have to:
                # - find which substate manages this input
                # - add a swich case on the corresponding substate
                # This has to be recursive, no?
                # execute_transition(sub)
            else:
                execute_transition(state)
471

Maxime Perrotin's avatar
Maxime Perrotin committed
472
473
474
        taste_template.append('when others =>')
        taste_template.append('null;')
        taste_template.append('end case;')
475
        taste_template.append(u'end {};'.format(signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
476
477
478
479
480
        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:
481

482
483
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
484
        # Add (optional) RI parameter
485
486
487
        # 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
488
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
489
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
490
            typename = type_name(signal['type'])
491
492
493
494
495
            param_spec = u'({pName}: access {sort}{shared})' \
                         .format(pName=param_name,
                                 sort=typename,
                                 shared=u'; Size: Integer'
                                        if SHARED_LIB else '')
496
497
498
        ads_template.append(u'--  {}equired interface "{}"'
                            .format("Paramless r" if not 'type' in signal
                                else "R", signal['name']))
499
500
501
502
503
504
        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']))
505
            ads_template.append('{sig} : {sig}_T;'
506
                                .format(sig=signal['name']))
507
508
509
510
511
            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']))
512
513
514
515

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

518
519
520
521
522
523
524
            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('')
525
526
527
528
529
        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
530
531

    # for the .ads file, generate the declaration of the external procedures
532
533
    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
534
        params = []
535
536
537
538
        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
539
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
540
            typename = type_name(param['type'])
541
            params.append(u'{par[name]}: access {sort}{shared}'
Maxime Perrotin's avatar
Maxime Perrotin committed
542
                          .format(par=param,
543
544
545
546
                                  sort=typename,
                                  shared=u"; {}_Size: Integer"
                                         .format(param['name'])
                                         if SHARED_LIB else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
547
        if params:
548
549
            params_spec = "({})".format("; ".join(params))
            ri_header += params_spec
Maxime Perrotin's avatar
Maxime Perrotin committed
550
        ads_template.append(
dbarbera's avatar
dbarbera committed
551
                        u'--  Sync required interface "' + proc.inputString)
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
        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
577
578
579

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
580
581
582
583
584
        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
585
                                 '(name: chars_ptr; duration: Integer);'
586
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
587
588
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
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
            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
615
                .format(timer))
616
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
617
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
618
                .format(timer=timer, proc=process_name))
619
620
            ads_template.append(u'procedure RESET_{};'.format(timer))
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
621
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
622
623
                .format(timer=timer, proc=process_name))

624
625
626
627
628
629
    # 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;')

630
631
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647

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

648
649
650
651
    # 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
652

653
654
655
        # Declare the local variables needed by the transitions in the template
        taste_template.extend(set(local_decl_transitions))
        taste_template.append('begin')
656

657
658
659
        # 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
660

661
662
        # Generate the switch-case on the transition id
        taste_template.append('case trId is')
Maxime Perrotin's avatar
Maxime Perrotin committed
663

664
665
666
667
668
669
670
        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
671

672
673
674
675
676
677
678
679
        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
680

681
682
        # Add the code for the floating labels
        taste_template.extend(code_labels)
Maxime Perrotin's avatar
Maxime Perrotin committed
683

684
685
686
687
688
689
        #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
690

691
    # Add code of the package elaboration
Maxime Perrotin's avatar
Maxime Perrotin committed
692
693
694
695
696
697
698
    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))

699
    with open(process_name.lower() + os.extsep + 'adb', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
700
701
        ada_file.write(
                u'\n'.join(format_ada_code(taste_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
702

703
    with open(process_name.lower() + os.extsep + 'ads', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
704
705
        ada_file.write(
                u'\n'.join(format_ada_code(ads_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
706

707
708
709
710
    if simu:
        with open(u'{}_interface.aadl'.format(process_name), 'w') as aadl:
            aadl.write(u'\n'.join(minicv).encode('latin1'))

711
712
713
714
    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
715
716
717
718
719
720
721
722

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
723
724
725
726
727
728
729
730
731
    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
732
733
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
734
735
            code.append(u'Put("{}");'
                        .format(param.value[1:-1].replace('"', "'")))
Maxime Perrotin's avatar
Maxime Perrotin committed
736
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
737
            code, string, local = expression(param)
738
739
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
740
                sep = UNICODE_SEP
741
                last_it = u""
742
743
                if isinstance(param, ogAST.PrimSubstring):
                    range_str = u"{}'Range".format(string)
744
                    iterator = u"i - {}'First + 1".format(string)
745
746
747
                elif basic_type.Min == basic_type.Max:
                    range_str = u"{}.Data'Range".format(string)
                    string += u".Data"
748
                    iterator = u"i"
749
750
751
                else:
                    range_str = u"1 .. {}.Length".format(string)
                    string += u".Data"
752
753
                    iterator = u"i"
                    last_it = u"({})".format(range_str)
754
                code.extend([u"for i in {} loop".format(range_str),
755
756
                             u"Put(Character'Val({st}(i)));"
                             .format(st=string, sep=sep, it=iterator),
757
                             u"end loop;"])
758
759
            else:
                code.append("Put({});".format(string))
Maxime Perrotin's avatar
Maxime Perrotin committed
760
761
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
762
        code, string, local = expression(param)
dbarbera's avatar
dbarbera committed
763
        if type_kind in ('IntegerType', 'Integer32Type'):
764
            cast = "Asn1Int"
Maxime Perrotin's avatar
Maxime Perrotin committed
765
766
767
768
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
769
        code.append(u"Put({cast}'Image({s}));".format(cast=cast, s=string))
770
771
772
773
    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
774
    else:
775
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
776
777
778
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
779
780
    if newline:
        code.append(u"New_Line;")
Maxime Perrotin's avatar
Maxime Perrotin committed
781
782
783
784
785
    return code, string, local


@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
786
def _call_external_function(output, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
787
788
789
790
791
792
793
794
795
    ''' 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']
796
        list_of_params = []
Maxime Perrotin's avatar
Maxime Perrotin committed
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815

        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
816
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
817
818
            code.extend(p_code)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
819
820
821
822
            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
823
824
825
826
            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
827
828
            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
829
830
831
832
            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
833
834
835
836
837
838
839
840
841
842
843
            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
844
845
            continue
        proc, out_sig = None, None
846
        is_out_sig = False
Maxime Perrotin's avatar
Maxime Perrotin committed
847
848
849
        try:
            out_sig, = [sig for sig in OUT_SIGNALS
                        if sig['name'].lower() == signal_name.lower()]
850
            is_out_sig = True if SHARED_LIB else False
Maxime Perrotin's avatar
Maxime Perrotin committed
851
        except ValueError:
852
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
853
            try:
854
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
855
                            if sig.inputString.lower() == signal_name.lower()]
856
857
                if proc.external:
                    out_sig = proc
858
859
860
861
                    if SHARED_LIB:
                        is_out_sig = True
                        list_of_params = ['New_String("{}")'
                                              .format(out['outputName'])]
Maxime Perrotin's avatar
Maxime Perrotin committed
862
            except ValueError:
863
                # Not there? Impossible, the parser would have barked
864
                raise ValueError(u'Probably a bug - please report')
Maxime Perrotin's avatar
Maxime Perrotin committed
865
        if out_sig:
866
            #list_of_params = []
Maxime Perrotin's avatar
Maxime Perrotin committed
867
868
869
870
871
872
873
874
875
876
            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
877
                typename = type_name(param_type)
Maxime Perrotin's avatar
Maxime Perrotin committed
878
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
879
880
881
                code.extend(p_code)
                local_decl.extend(p_local)
                # Create a temporary variable for input parameters only
Maxime Perrotin's avatar
Maxime Perrotin committed
882
883
                # (If needed, i.e. if argument is not a local variable)
                if param_direction == 'in' \
884
                        and (not (isinstance(param, ogAST.PrimVariable)
885
                        and p_id.startswith(LPREFIX)) # NO FIXME WITH CTXT
886
                        or isinstance(param, ogAST.PrimFPAR)):
887
888
889
890
                    tmp_id = 'tmp{}'.format(out['tmpVars'][idx])
                    local_decl.append('{tmp} : aliased {sort};'
                                      .format(tmp=tmp_id,
                                              sort=typename))
891
892
893
894
                    if isinstance(param,
                              (ogAST.PrimSequenceOf, ogAST.PrimStringLiteral)):
                        p_id = array_content(param, p_id,
                                             find_basic_type(param_type))
895
896
897
898
899
                    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
900
                else:
901
902
903
                    # Output parameters/local variables
                    list_of_params.append(u"{var}'access{shared}"
                                         .format(var=p_id,
Maxime Perrotin's avatar
Maxime Perrotin committed
904
905
                                                shared=", {}'Size".format(p_id)
                                                  if is_out_sig else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
906
            if list_of_params:
907
908
909
                code.append(u'{RI}({params});'
                            .format(RI=out['outputName'],
                                    params=', '.join(list_of_params)))
Maxime Perrotin's avatar
Maxime Perrotin committed
910
            else:
911
912
913
                if not SHARED_LIB:
                    code.append(u'{RI};'.format(RI=out['outputName']))
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
914
915
                    code.append(u'{RI}(New_String("{RI}"));'
                                .format(RI=out['outputName']))
Maxime Perrotin's avatar
Maxime Perrotin committed
916
917
918
        else:
            # inner procedure call
            list_of_params = []
919
            for param in out.get('params', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
920
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
921
922
923
924
925
                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:
926
927
                code.append(u'p{sep}{proc}({params});'.format(
                    sep=UNICODE_SEP,
Maxime Perrotin's avatar
Maxime Perrotin committed
928
929
930
                    proc=proc.inputString,
                    params=', '.join(list_of_params)))
            else:
931
                code.append(u'p{}{};'.format(UNICODE_SEP, proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
932
933
934
935
    return code, local_decl


@generate.register(ogAST.TaskAssign)
936
def _task_assign(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
937
938
939
940
941
942
    ''' 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))
943
944
        # ExprAssign only returns code statements, no string
        code_assign, _, decl_assign = expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
945
946
947
948
949
950
        code.extend(code_assign)
        local_decl.extend(decl_assign)
    return code, local_decl


@generate.register(ogAST.TaskInformalText)
951
def _task_informal_text(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
952
953
954
955
956
957
958
959
960
    ''' 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)
961
def _task_forloop(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
962
963
964
965
966
967
    '''
        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 = [], []
968
    local_scope = dict(LOCAL_VAR)
Maxime Perrotin's avatar
Maxime Perrotin committed
969
970
971
972
973
974
975
    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
976
                start_stmt, start_str, start_local = expression(
dbarbera's avatar
dbarbera committed
977
                                                    loop['range']['start'])
Maxime Perrotin's avatar
Maxime Perrotin committed
978
979
980
981
                local_decl.extend(start_local)
                stmt.extend(start_stmt)
            if loop['range']['step'] == 1:
                start_str += '..'
Maxime Perrotin's avatar
Maxime Perrotin committed
982
            stop_stmt, stop_str, stop_local = expression(loop['range']['stop'])
Maxime Perrotin's avatar
Maxime Perrotin committed
983
984
985
            local_decl.extend(stop_local)
            stmt.extend(stop_stmt)
            if loop['range']['step'] == 1:
Maxime Perrotin's avatar
Maxime Perrotin committed
986
987
988
989
                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
990
                stmt.append(
991
                        u'for {it} in {start}{stop} loop'
dbarbera's avatar
dbarbera committed
992
                        .format(it=loop['var'], start=start_str, stop=stop_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
993
994
995
            else:
                # Step is not directly supported in Ada, we need to use 'while'
                stmt.extend(['declare',
996
                             u'{it} : Asn1Int := {start};'
Maxime Perrotin's avatar
Maxime Perrotin committed
997
998
999
1000
                             .format(it=loop['var'],
                             start=start_str),
                             '',
                             'begin',
1001
                             u'while {it} < {stop} loop'.format(it=loop['var'],
Maxime Perrotin's avatar
Maxime Perrotin committed
1002
1003
1004
                                                               stop=stop_str)])
        else:
            # case of form: FOR x in SEQUENCE OF
1005
1006
1007
            # Add iterator to the list of local variables
            LOCAL_VAR.update({loop['var']: (loop['type'], None)})

Maxime Perrotin's avatar
Maxime Perrotin committed
1008
            list_stmt, list_str, list_local = expression(loop['list'])
Maxime Perrotin's avatar
Maxime Perrotin committed
1009
            basic_type = find_basic_type(loop['list'].exprType)
1010
            list_payload = list_str + string_payload(loop['list'], list_str)
1011
1012
1013
1014
1015
            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
1016
1017
1018
            stmt.extend(list_stmt)
            local_decl.extend(list_local)
            stmt.extend(['declare',
1019
1020
                         '{} : {};'.format(loop['var'],
                                           type_name(loop['type'])),
Maxime Perrotin's avatar
Maxime Perrotin committed
1021
1022
1023
                         '',
                         'begin',
                         'for {it}_idx in {rc} loop'.format(it=loop['var'],
1024
                                                            rc=range_str),
1025
1026
                         '{it} := {var}({it}_idx);'.format(it=loop['var'],
                                                          var=list_payload)])
Maxime Perrotin's avatar
Maxime Perrotin committed
1027
1028
1029
1030
        try:
            code_trans, local_trans = generate(loop['transition'])
            if local_trans:
                stmt.append('declare')
1031
                stmt.extend(set(local_trans))
Maxime Perrotin's avatar
Maxime Perrotin committed
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
                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;')
1045
1046
1047
    # Restore list of local variables
    LOCAL_VAR.clear()
    LOCAL_VAR.update(local_scope)
Maxime Perrotin's avatar
Maxime Perrotin committed
1048
1049
1050
    return stmt, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
@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
1061

Maxime Perrotin's avatar
Maxime Perrotin committed
1062
@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
1063
1064
def _primary_variable(prim):
    ''' Single variable reference '''
1065
1066
1067
1068
1069
1070
    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
1071

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

1074
1075
    if prim.exprType.__name__ == 'for_range':
        # Ada iterator in FOR loops is an Integer - we must cast to 64 bits
1076
        ada_string = u'Asn1Int({})'.format(ada_string)
1077
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1078
1079


1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
@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
1095
                'Asn1Int' if ident == 'fix' else 'Asn1Real'
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
                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
1118
1119
        if min_length == max_length \
                and not isinstance(exp, ogAST.PrimSubstring):
1120
1121
            ada_string += min_length
        else:
1122
1123
1124
1125
1126
            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))
1127
1128
1129
1130
1131
1132
1133
    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
1134
        exp_typename = type_name(exp.exprType)
1135
1136
1137
1138
1139
1140
1141
        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
1142
1143
1144
        ada_string += ('{sort}_Kind({e})'
                       .format(sort=exp_typename,
                               e=param_str))
1145
1146
1147
    elif ident == 'num':
        # User wants to get an enumerated corresponding integer value
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1148
        exp_typename = type_name(exp.exprType)
1149
        param_stmts, param_str, local_var = expression(exp)
Maxime Perrotin's avatar
Maxime Perrotin committed
1150
1151
        local_decl.append('function num_{sort} is new Ada.Unchecked_Conversion'
                          '({sort}, Asn1Int);'.format(sort=exp_typename))
1152
1153
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1154
1155
1156
        ada_string += ('num_{sort}({p})'
                       .format(sort=exp_typename,
                               p=param_str))
dbarbera's avatar
dbarbera committed
1157
    elif ident == 'floor':
1158
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1159
        exp_typename = type_name(exp.exprType)
1160
1161
1162
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1163
1164
        ada_string += "{sort}'Floor({p})".format(sort=exp_typename,
                                                 p=param_str)
dbarbera's avatar
dbarbera committed
1165
    elif ident == 'ceil':
1166
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1167
        exp_typename = type_name(exp.exprType)
1168
1169
1170
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1171
1172
        ada_string += "{sort}'Ceiling({p})".format(sort=exp_typename,
                                                   p=param_str)
dbarbera's avatar
dbarbera committed
1173
    elif ident == 'cos':
1174
1175
1176
1177
1178
1179
        exp = params[0]