AdaGenerator.py 88.8 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
Maxime Perrotin's avatar
Maxime Perrotin committed
74
75
76
from singledispatch import singledispatch

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

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

91
92
93
# Specify that the target is a shared library
SHARED_LIB = False

94
UNICODE_SEP = u'\u00dc'
Maxime Perrotin's avatar
Maxime Perrotin committed
95
96

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


Maxime Perrotin's avatar
Maxime Perrotin committed
103
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
104
@generate.register(ogAST.Process)
105
def _process(process, simu=False, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
106
107
108
109
110
111
112
113
    ''' 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)
114
115
116
    global SHARED_LIB
    if simu:
        SHARED_LIB = True
Maxime Perrotin's avatar
Maxime Perrotin committed
117

118
119
120
121
122
123
124
125
126
127
128
    # 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 = []
129
130
131
132
133
        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 ''
134
135
136
137
138
139
        # 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} '
140
141
142
                          '{{encoding=>Native;}};'.format(pname=param_name,
                                                          sort=sort,
                                                          io=direction))
143
144
145
146
147
148
149
150
151
        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)

152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
    # 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)

174

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

177
    # In case model has nested states, flatten everything
178
    Helper.flatten(process, sep=UNICODE_SEP)
179

Maxime Perrotin's avatar
Maxime Perrotin committed
180
181
182
183
    # 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
184
185
186
187
188
189
190
191
    VARIABLES.update(process.variables)

    # Generate the code to declare process-level variables
    process_level_decl = []
    for var_name, (var_type, def_value) in process.variables.viewitems():
        if def_value:
            # Expression must be a ground expression, i.e. must not
            # require temporary variable to store computed result
Maxime Perrotin's avatar
Maxime Perrotin committed
192
            dst, dstr, dlocal = expression(def_value)
193
194
195
            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
196
197
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
198
199
200
201
                        u'l_{n} : aliased {sort}{default};'
                        .format(n=var_name,
                                sort=type_name(var_type),
                                default=u' := ' + dstr if def_value else u''))
Maxime Perrotin's avatar
Maxime Perrotin committed
202

Maxime Perrotin's avatar
Maxime Perrotin committed
203
    # Add the process states list to the process-level variables
204
    statelist = ', '.join(name for name in process.mapping.iterkeys()
Maxime Perrotin's avatar
Maxime Perrotin committed
205
                             if not name.endswith(u'START')) or 'No_State'
206
    if statelist:
207
        states_decl = u'type States is ({});'.format(statelist)
208
209
        process_level_decl.append(states_decl)
        process_level_decl.append('state : states;')
Maxime Perrotin's avatar
Maxime Perrotin committed
210

211
    for name, val in process.mapping.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
212
213
        if name.endswith(u'START') and name != u'START':
            process_level_decl.append(u'{name} : constant := {val};'
214
215
                                      .format(name=name, val=str(val)))

Maxime Perrotin's avatar
Maxime Perrotin committed
216
    # Add the declaration of the runTransition procedure
217
    process_level_decl.append('procedure runTransition(Id: Integer);')
Maxime Perrotin's avatar
Maxime Perrotin committed
218

219
    # Generate the code of the start transition (if process not empty)
220
    start_transition = ['begin',
221
                        'runTransition(0);'] if process.transitions else []
222

Maxime Perrotin's avatar
Maxime Perrotin committed
223
224
225
226
227
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
228
        asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
229
230
231
232
233
234
235
236
    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;

237
with Ada.Unchecked_Conversion;
238
with Ada.Numerics.Generic_Elementary_Functions;
239

Maxime Perrotin's avatar
Maxime Perrotin committed
240
241
242
243
{dataview}

with Interfaces;
use Interfaces;
244
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
245
package body {process_name} is'''.format(process_name=process_name,
246
247
248
249
                                         dataview=asn1_modules,
                                         C='with Interfaces.C.Strings;\n'
                                           'use Interfaces.C.Strings;'
                                            if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
250
251
252
253
254
255

    # 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
256
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
257
258

package {process_name} is'''.format(process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
259
260
261
262
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
263

Maxime Perrotin's avatar
Maxime Perrotin committed
264
    dll_api = []
265
266
    if simu:
        ads_template.append('--  DLL Interface')
267
        dll_api.append('-- DLL Interface to remotely change internal data')
268
269
270
271
272
273
        # Add function allowing to trace current state as a string
        process_level_decl.append("function get_state return chars_ptr "
                                  "is (New_String(states'Image(state))) "
                                  "with Export, Convention => C, "
                                  'Link_Name => "{}_state";'
                                  .format(process_name))
274
275
        set_state_decl = "procedure set_state(new_state: chars_ptr)"
        ads_template.append("{};".format(set_state_decl))
276
        ads_template.append('pragma export(C, set_state, "_set_state");')
277
278
279
280
281
282
        dll_api.append("{} is".format(set_state_decl))
        dll_api.append("begin")
        dll_api.append("state := States'Value(Value(new_state));")
        dll_api.append("end set_state;")
        dll_api.append("")

283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
        # 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 "
                                      "is (l_{name}'Size/8) with Export, "
                                      "Convention => C, "
                                      'Link_Name => "{name}_size";'
                                      .format(name=var_name))
            process_level_decl.append("function l_{name}_value"
                                      " return access {sort} "
                                      "is (l_{name}'access) with Export, "
                                      "Convention => C, "
                                      'Link_Name => "{name}_value";'
                                      .format(name=var_name,
                                              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))
302
303
            ads_template.append('pragma export(C, dll_set_l_{name},'
                                ' "_set_{name}");'.format(name=var_name))
304
305
306
307
308
309
310
            dll_api.append('{} is'.format(setter_decl))
            dll_api.append('begin')
            dll_api.append('l_{} := value.all;'.format(var_name))
            dll_api.append('end dll_set_l_{};'.format(var_name))
            dll_api.append('')


Maxime Perrotin's avatar
Maxime Perrotin committed
311
312
313
314
315
316
317
318
319
320
321
322
323
    # 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)

324
325
326
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
327
328
329
    # 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
330
        if signal.get('name', u'START') == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
331
            continue
332
333
334
        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
335
336
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
337
            typename = type_name(signal['type'])
338
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
339
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
340
341

        # Add declaration of the provided interface in the .ads file
342
        ads_template.append(u'--  Provided interface "' + signal['name'] + '"')
Maxime Perrotin's avatar
Maxime Perrotin committed
343
        ads_template.append(pi_header + ';')
344
345
346
347
348
349
350
        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 []
351
            minicv.append(aadl_template(signal['name'], params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
352
353
354
355
356
357

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
        taste_template.append('case state is')
        for state in process.mapping.viewkeys():
Maxime Perrotin's avatar
Maxime Perrotin committed
358
            if state.endswith(u'START'):
Maxime Perrotin's avatar
Maxime Perrotin committed
359
                continue
Maxime Perrotin's avatar
Maxime Perrotin committed
360
            taste_template.append(u'when {state} =>'.format(state=state))
Maxime Perrotin's avatar
Maxime Perrotin committed
361
            input_def = mapping[signal['name']].get(state)
362
            # Check for nested states to call optional exit procedure
363
            sep = UNICODE_SEP
364
            state_tree = state.split(sep)
Maxime Perrotin's avatar
Maxime Perrotin committed
365
            context = process
366
367
368
369
370
371
            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:
372
                    if current.lower() == comp.statename.lower():
373
374
375
376
377
378
379
380
                        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):
381
382
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
                                          .format(ref=each, sep=sep))
383

Maxime Perrotin's avatar
Maxime Perrotin committed
384
385
386
387
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
Maxime Perrotin's avatar
Maxime Perrotin committed
388
                    taste_template.append(u'l_{inp} := {tInp}.all;'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
389
390
391
                        inp=inp, tInp=param_name))
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
392
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
393
394
395
396
397
398
399
400
                        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;')
Maxime Perrotin's avatar
Maxime Perrotin committed
401
        taste_template.append(u'end {sig_name};'.format(
dbarbera's avatar
dbarbera committed
402
                                                    sig_name=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
403
404
405
406
407
        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:
408

409
410
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
411
        # Add (optional) RI parameter
Maxime Perrotin's avatar
Maxime Perrotin committed
412
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
413
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
414
            typename = type_name(signal['type'])
415
416
417
418
419
            param_spec = u'({pName}: access {sort}{shared})' \
                         .format(pName=param_name,
                                 sort=typename,
                                 shared=u'; Size: Integer'
                                        if SHARED_LIB else '')
Maxime Perrotin's avatar
Maxime Perrotin committed
420
        ads_template.append(u'--  Required interface "' + signal['name'] + '"')
421
422
423
424
425
426
        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']))
427
            ads_template.append('{sig} : {sig}_T;'
428
                                .format(sig=signal['name']))
429
430
431
432
433
            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']))
434
435
436
437

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

440
441
442
443
444
445
446
            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('')
447
448
449
450
451
        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
452
453

    # for the .ads file, generate the declaration of the external procedures
454
455
    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
456
457
        params = []
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
458
459
460
461
            typename = type_name(param['type'])
            params.append(u'{par[name]}: access {sort}'
                          .format(par=param,
                                  sort=typename))
Maxime Perrotin's avatar
Maxime Perrotin committed
462
        if params:
Maxime Perrotin's avatar
Maxime Perrotin committed
463
            ri_header += u'(' + u';'.join(params) + ')'
Maxime Perrotin's avatar
Maxime Perrotin committed
464
        ads_template.append(
dbarbera's avatar
dbarbera committed
465
                        u'--  Sync required interface "' + proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
466
467
        ads_template.append(ri_header + u';')
        ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
468
469
470
471
                .format(sig=proc.inputString, proc=process_name))

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
472
473
474
475
476
        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
477
                                 '(name: chars_ptr; duration: Integer);'
478
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
479
480
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
            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
507
                .format(timer))
508
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
509
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
510
                .format(timer=timer, proc=process_name))
511
512
            ads_template.append(u'procedure RESET_{};'.format(timer))
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
513
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
514
515
                .format(timer=timer, proc=process_name))

516
517
518
    taste_template.append('procedure runTransition(Id: Integer) is')
    taste_template.append('trId : Integer := Id;')

519
520
521
522
523
524
    # 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;')

525
526
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543

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

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

    # Declare the local variables needed by the transitions in the template
544
    taste_template.extend(set(local_decl_transitions))
Maxime Perrotin's avatar
Maxime Perrotin committed
545
546
    taste_template.append('begin')

547
548
549
550
    # 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
551
552
553
554
    # Generate the switch-case on the transition id
    taste_template.append('case trId is')

    for idx, val in enumerate(code_transitions):
Maxime Perrotin's avatar
Maxime Perrotin committed
555
556
        taste_template.append(u'when {idx} =>'.format(idx=idx))
        val = [u'{line}'.format(line=l) for l in val]
Maxime Perrotin's avatar
Maxime Perrotin committed
557
558
559
560
561
562
563
564
565
        if val:
            taste_template.extend(val)
        else:
            taste_template.append('null;')

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

    taste_template.append('end case;')
566
567
568
569
    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
570
571
572
573

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

Maxime Perrotin's avatar
Maxime Perrotin committed
574
575
576
    #if code_labels:
    taste_template.append('<<next_transition>>')
    taste_template.append('null;')
577
    taste_template.append('end loop;')
Maxime Perrotin's avatar
Maxime Perrotin committed
578
579
580
581
582
583
584
585
586
587
588
    taste_template.append('end runTransition;')
    taste_template.append('\n')

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

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

    with open(process_name + '.adb', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
589
590
        ada_file.write(
                u'\n'.join(format_ada_code(taste_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
591
592

    with open(process_name + '.ads', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
593
594
        ada_file.write(
                u'\n'.join(format_ada_code(ads_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
595

596
597
598
599
    if simu:
        with open(u'{}_interface.aadl'.format(process_name), 'w') as aadl:
            aadl.write(u'\n'.join(minicv).encode('latin1'))

600
601
602
603
    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
604
605
606
607
608
609
610
611

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
612
613
614
615
616
617
618
619
620
    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
621
622
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
623
624
            code.append(u'Put("{}");'
                        .format(param.value[1:-1].replace('"', "'")))
Maxime Perrotin's avatar
Maxime Perrotin committed
625
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
626
            code, string, local = expression(param)
627
628
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
629
                sep = UNICODE_SEP
630
                last_it = u""
631
632
                if isinstance(param, ogAST.PrimSubstring):
                    range_str = u"{}'Range".format(string)
633
                    iterator = u"i - {}'First + 1".format(string)
634
635
636
                elif basic_type.Min == basic_type.Max:
                    range_str = u"{}.Data'Range".format(string)
                    string += u".Data"
637
                    iterator = u"i"
638
639
640
                else:
                    range_str = u"1 .. {}.Length".format(string)
                    string += u".Data"
641
642
                    iterator = u"i"
                    last_it = u"({})".format(range_str)
643
                code.extend([u"for i in {} loop".format(range_str),
644
645
                             u"Put(Character'Val({st}(i)));"
                             .format(st=string, sep=sep, it=iterator),
646
                             u"end loop;"])
647
648
            else:
                code.append("Put({});".format(string))
Maxime Perrotin's avatar
Maxime Perrotin committed
649
650
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
651
        code, string, local = expression(param)
dbarbera's avatar
dbarbera committed
652
        if type_kind in ('IntegerType', 'Integer32Type'):
653
            cast = "Asn1Int"
Maxime Perrotin's avatar
Maxime Perrotin committed
654
655
656
657
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
658
        code.append(u"Put({cast}'Image({s}));".format(cast=cast, s=string))
Maxime Perrotin's avatar
Maxime Perrotin committed
659
    else:
660
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
661
662
663
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
664
665
    if newline:
        code.append(u"New_Line;")
Maxime Perrotin's avatar
Maxime Perrotin committed
666
667
668
669
670
    return code, string, local


@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
671
def _call_external_function(output, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
    ''' Generate the code of a set of output or procedure call statement '''
    code = []
    local_decl = []

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

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

        if signal_name.lower() in ('write', 'writeln'):
            # special built-in SDL procedure for printing strings
            # supports printing of native types (int, real, bool)
            # but not yet complex ASN.1 structures (sequence/seqof/choice)
            for param in out['params'][:-1]:
                stmts, _, local = write_statement(param, newline=False)
                code.extend(stmts)
                local_decl.extend(local)
            for param in out['params'][-1:]:
                # Last parameter - add newline if necessary
                stmts, _, local = write_statement(param, newline=True if
                        signal_name.lower() == 'writeln' else False)
                code.extend(stmts)
                local_decl.extend(local)
            continue
        elif signal_name.lower() == 'reset_timer':
            # built-in operator for resetting timers. param = timer name
            param, = out['params']
Maxime Perrotin's avatar
Maxime Perrotin committed
700
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
701
702
            code.extend(p_code)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
703
704
705
706
            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
707
708
709
710
            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
711
712
            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
713
714
715
716
            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
717
718
719
720
721
722
723
724
725
726
727
            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
728
729
            continue
        proc, out_sig = None, None
730
        is_out_sig = False
Maxime Perrotin's avatar
Maxime Perrotin committed
731
732
733
        try:
            out_sig, = [sig for sig in OUT_SIGNALS
                        if sig['name'].lower() == signal_name.lower()]
734
            is_out_sig = True if SHARED_LIB else False
Maxime Perrotin's avatar
Maxime Perrotin committed
735
        except ValueError:
736
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
737
            try:
738
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
739
                            if sig.inputString.lower() == signal_name.lower()]
740
741
                if proc.external:
                    out_sig = proc
Maxime Perrotin's avatar
Maxime Perrotin committed
742
            except ValueError:
743
                # Not there? Impossible, the parser would have barked
744
                raise ValueError(u'Probably a bug - please report')
Maxime Perrotin's avatar
Maxime Perrotin committed
745
746
747
748
749
750
751
752
753
754
755
756
        if out_sig:
            list_of_params = []
            for idx, param in enumerate(out.get('params') or []):
                param_direction = 'in'
                try:
                    # If it is an output, there is a single parameter
                    param_type = out_sig['type']
                except TypeError:
                    # Else if it is a procedure, get the type
                    param_type = out_sig.fpar[idx]['type']
                    param_direction = out_sig.fpar[idx]['direction']

Maxime Perrotin's avatar
Maxime Perrotin committed
757
                typename = type_name(param_type)
Maxime Perrotin's avatar
Maxime Perrotin committed
758
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
759
760
761
                code.extend(p_code)
                local_decl.extend(p_local)
                # Create a temporary variable for input parameters only
Maxime Perrotin's avatar
Maxime Perrotin committed
762
763
                # (If needed, i.e. if argument is not a local variable)
                if param_direction == 'in' \
764
765
766
                        and (not (isinstance(param, ogAST.PrimVariable)
                        and p_id.startswith('l_'))
                        or isinstance(param, ogAST.PrimFPAR)):
767
768
769
770
                    tmp_id = 'tmp{}'.format(out['tmpVars'][idx])
                    local_decl.append('{tmp} : aliased {sort};'
                                      .format(tmp=tmp_id,
                                              sort=typename))
771
772
773
774
                    if isinstance(param,
                              (ogAST.PrimSequenceOf, ogAST.PrimStringLiteral)):
                        p_id = array_content(param, p_id,
                                             find_basic_type(param_type))
775
776
777
778
779
                    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
780
                else:
781
782
783
                    # Output parameters/local variables
                    list_of_params.append(u"{var}'access{shared}"
                                         .format(var=p_id,
Maxime Perrotin's avatar
Maxime Perrotin committed
784
785
                                                shared=", {}'Size".format(p_id)
                                                  if is_out_sig else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
786
            if list_of_params:
787
788
789
                code.append(u'{RI}({params});'
                            .format(RI=out['outputName'],
                                    params=', '.join(list_of_params)))
Maxime Perrotin's avatar
Maxime Perrotin committed
790
            else:
791
792
793
                if not SHARED_LIB:
                    code.append(u'{RI};'.format(RI=out['outputName']))
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
794
795
                    code.append(u'{RI}(New_String("{RI}"));'
                                .format(RI=out['outputName']))
Maxime Perrotin's avatar
Maxime Perrotin committed
796
797
798
        else:
            # inner procedure call
            list_of_params = []
799
            for param in out.get('params', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
800
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
801
802
803
804
805
                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:
806
807
                code.append(u'p{sep}{proc}({params});'.format(
                    sep=UNICODE_SEP,
Maxime Perrotin's avatar
Maxime Perrotin committed
808
809
810
                    proc=proc.inputString,
                    params=', '.join(list_of_params)))
            else:
811
                code.append(u'p{}{};'.format(UNICODE_SEP, proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
812
813
814
815
    return code, local_decl


@generate.register(ogAST.TaskAssign)
816
def _task_assign(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
817
818
819
820
821
822
    ''' 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))
823
824
        # ExprAssign only returns code statements, no string
        code_assign, _, decl_assign = expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
825
826
827
828
829
830
        code.extend(code_assign)
        local_decl.extend(decl_assign)
    return code, local_decl


@generate.register(ogAST.TaskInformalText)
831
def _task_informal_text(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
832
833
834
835
836
837
838
839
840
    ''' 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)
841
def _task_forloop(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
842
843
844
845
846
847
848
849
850
851
852
853
854
    '''
        Return the code corresponding to a for loop. Two forms are possible:
        for x in range ([start], stop [, step])
        for x in iterable (a SEQUENCE OF)
    '''
    stmt, local_decl = [], []
    if task.comment:
        stmt.extend(traceability(task.comment))
    stmt.extend(traceability(task))
    for loop in task.elems:
        if loop['range']:
            start_str, stop_str = '0', ''
            if loop['range']['start']:
Maxime Perrotin's avatar
Maxime Perrotin committed
855
                start_stmt, start_str, start_local = expression(
dbarbera's avatar
dbarbera committed
856
                                                    loop['range']['start'])
Maxime Perrotin's avatar
Maxime Perrotin committed
857
858
859
860
                local_decl.extend(start_local)
                stmt.extend(start_stmt)
            if loop['range']['step'] == 1:
                start_str += '..'
Maxime Perrotin's avatar
Maxime Perrotin committed
861
            stop_stmt, stop_str, stop_local = expression(loop['range']['stop'])
Maxime Perrotin's avatar
Maxime Perrotin committed
862
863
864
            local_decl.extend(stop_local)
            stmt.extend(stop_stmt)
            if loop['range']['step'] == 1:
Maxime Perrotin's avatar
Maxime Perrotin committed
865
866
867
868
                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
869
                stmt.append(
870
                        u'for {it} in {start}{stop} loop'
dbarbera's avatar
dbarbera committed
871
                        .format(it=loop['var'], start=start_str, stop=stop_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
872
873
874
            else:
                # Step is not directly supported in Ada, we need to use 'while'
                stmt.extend(['declare',
875
                             u'{it} : Integer := {start};'
Maxime Perrotin's avatar
Maxime Perrotin committed
876
877
878
879
                             .format(it=loop['var'],
                             start=start_str),
                             '',
                             'begin',
880
                             u'while {it} < {stop} loop'.format(it=loop['var'],
Maxime Perrotin's avatar
Maxime Perrotin committed
881
882
883
                                                               stop=stop_str)])
        else:
            # case of form: FOR x in SEQUENCE OF
Maxime Perrotin's avatar
Maxime Perrotin committed
884
            list_stmt, list_str, list_local = expression(loop['list'])
Maxime Perrotin's avatar
Maxime Perrotin committed
885
            basic_type = find_basic_type(loop['list'].exprType)
886
            list_payload = list_str + string_payload(loop['list'], list_str)
887
888
889
890
891
            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
892
893
894
            stmt.extend(list_stmt)
            local_decl.extend(list_local)
            stmt.extend(['declare',
895
896
                         '{} : {};'.format(loop['var'],
                                           type_name(loop['type'])),
Maxime Perrotin's avatar
Maxime Perrotin committed
897
898
899
                         '',
                         'begin',
                         'for {it}_idx in {rc} loop'.format(it=loop['var'],
900
                                                            rc=range_str),
901
902
                         '{it} := {var}({it}_idx);'.format(it=loop['var'],
                                                          var=list_payload)])
Maxime Perrotin's avatar
Maxime Perrotin committed
903
904
905
906
        try:
            code_trans, local_trans = generate(loop['transition'])
            if local_trans:
                stmt.append('declare')
907
                stmt.extend(set(local_trans))
Maxime Perrotin's avatar
Maxime Perrotin committed
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
                stmt.append('')
                stmt.append('begin')
            stmt.extend(code_trans)
            if local_trans:
                stmt.append('end;')
        except AttributeError:
            stmt.append('null;')
        if loop['range'] and loop['range']['step'] != 1:
            stmt.append('{it} := {it} + {step};'.format(it=loop['var'],
                                                   step=loop['range']['step']))
        stmt.append('end loop;')
        if (loop['range'] and loop['range']['step'] != 1) or loop['list']:
            stmt.append('end;')
    return stmt, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
924
925
926
927
928
929
930
931
932
933
@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
934

Maxime Perrotin's avatar
Maxime Perrotin committed
935
@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
936
937
def _primary_variable(prim):
    ''' Single variable reference '''
Maxime Perrotin's avatar
Maxime Perrotin committed
938
    sep = u'l_' if find_var(prim.value[0]) else u''
Maxime Perrotin's avatar
Maxime Perrotin committed
939

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

942
943
    if prim.exprType.__name__ == 'for_range':
        # Ada iterator in FOR loops is an Integer - we must cast to 64 bits
944
        ada_string = u'Asn1Int({})'.format(ada_string)
945
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
946
947


948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
@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
963
                'Asn1Int' if ident == 'fix' else 'Asn1Real'
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
                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
986
987
        if min_length == max_length \
                and not isinstance(exp, ogAST.PrimSubstring):
988
989
            ada_string += min_length
        else:
990
991
992
993
994
            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))
995
996
997
998
999
1000
1001
    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
1002
        exp_typename = type_name(exp.exprType)
1003
1004
1005
1006
1007
1008
1009
        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
1010
1011
1012
        ada_string += ('{sort}_Kind({e})'
                       .format(sort=exp_typename,
                               e=param_str))
1013
1014
1015
    elif ident == 'num':
        # User wants to get an enumerated corresponding integer value
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1016
        exp_typename = type_name(exp.exprType)
1017
        param_stmts, param_str, local_var = expression(exp)
Maxime Perrotin's avatar
Maxime Perrotin committed
1018
1019
        local_decl.append('function num_{sort} is new Ada.Unchecked_Conversion'
                          '({sort}, Asn1Int);'.format(sort=exp_typename))
1020
1021
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1022
1023
1024
        ada_string += ('num_{sort}({p})'
                       .format(sort=exp_typename,
                               p=param_str))
dbarbera's avatar
dbarbera committed
1025
    elif ident == 'floor':
1026
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1027
        exp_typename = type_name(exp.exprType)
1028
1029
1030
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1031
1032
        ada_string += "{sort}'Floor({p})".format(sort=exp_typename,
                                                 p=param_str)
dbarbera's avatar
dbarbera committed
1033
    elif ident == 'ceil':
1034
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1035
        exp_typename = type_name(exp.exprType)
1036
1037
1038
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1039
1040
        ada_string += "{sort}'Ceiling({p})".format(sort=exp_typename,
                                                   p=param_str)
dbarbera's avatar
dbarbera committed
1041
    elif ident == 'cos':
1042
1043
1044
1045
1046
1047
        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
1048
                          '(Asn1Real);')
1049
        ada_string += "Math.Cos({})".format(param_str)
dbarbera's avatar
dbarbera committed
1050
    elif ident == 'round':
1051
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1052
        exp_typename = type_name(exp.exprType)
1053
1054
1055
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1056
1057
        ada_string += "{sort}'Rounding({p})".format(sort=exp_typename,
                                                    p=param_str)
dbarbera's avatar
dbarbera committed
1058
    elif ident == 'sin':
1059
1060
1061
1062
1063
1064
        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
1065
                          '(Asn1Real);')
1066
        ada_string += "Math.Sin({})".format(param_str)
dbarbera's avatar
dbarbera committed
1067
    elif ident == 'sqrt':
1068
1069
1070
1071
1072
1073
        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
1074
                          '(Asn1Real);')
1075
        ada_string += "Math.Sqrt({})".format(param_str)
dbarbera's avatar
dbarbera committed
1076
    elif ident == 'trunc':
1077
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1078
        exp_typename = type_name(exp.exprType)
1079
1080
1081
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1082
1083
        ada_string += "{sort}'Truncation({p})".format(sort=exp_typename,
                                                      p=param_str)
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
    else:
        ada_string += '('
        # Take all params and join them with commas
        list_of_params = []
        for param in params:
            param_stmt, param_str, local_var = (expression(param))
            list_of_params.append(param_str)
            stmts.extend(param_stmt)
            local_decl.extend(local_var)
        ada_string += ', '.join(list_of_params)
        ada_string += ')'

1096
    return stmts, unicode(ada_string), local_decl
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114


@expression.register(ogAST.PrimIndex)
def _prim_index(prim):
    stmts, ada_string, local_decl = [], '', []

    receiver = prim.value[0]

    receiver_stms, reciver_string, receiver_decl = expression(receiver)
    ada_string = reciver_string
    stmts.extend(receiver_stms)
    local_decl.extend(receiver_decl)

    idx_stmts, idx_string, idx_var = expression(prim.value[1]['index'][0])
    if unicode.isnumeric(idx_string):
        idx_string = int(idx_string) + 1
    else:
        idx_string = '1+Integer({idx})'.format(idx=idx_string)
Maxime Perrotin's avatar
Maxime Perrotin committed
1115
1116
1117
    if not isinstance(receiver, ogAST.PrimSubstring):
        ada_string += '.Data'
    ada_string += '({idx})'.format(idx=idx_string)
1118
1119
1120
    stmts.extend(idx_stmts)
    local_decl.extend(idx_var)

1121
    return stmts, unicode(ada_string), local_decl
1122
1123
1124
1125


@expression.register(ogAST.PrimSubstring)
def _prim_substring(prim):
1126
    ''' Generate expression for SEQOF/OCT.STRING substrings, e.g. foo(1,2) '''
1127
1128
1129
1130
    stmts, ada_string, local_decl = [], '', []

    receiver = prim.value[0]

1131
1132
    receiver_stms, receiver_string, receiver_decl = expression(receiver)
    ada_string = receiver_string
1133
1134
1135
1136
1137
1138
    stmts.extend(receiver_stms)
    local_decl.extend(receiver_decl)

    r1_stmts, r1_string, r1_local = expression(prim.value[1]['substring'][0])
    r2_stmts, r2_string, r2_local = expression(prim.value[1]['substring'][1])

1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
    # Adding 1 because SDL starts indexes at 0, ASN1 Ada types at 1
    if unicode.isnumeric(r1_string):
        r1_string = unicode(int(r1_string) + 1)
    else:
        r1_string += ' + 1'
    if unicode.isnumeric(r2_string):
        r2_string = unicode(int(r2_string) + 1)
    else:
        r2_string += ' + 1'

Maxime Perrotin's avatar
Maxime Perrotin committed
1149
1150
1151
    if not isinstance(receiver, ogAST.PrimSubstring):
        ada_string += '.Data'
    ada_string += '({r1}..{r2})'.format(r1=r1_string, r2=r2_string)
1152
1153
1154
1155
1156
    stmts.extend(r1_stmts)
    stmts.extend(r2_stmts)
    local_decl.extend(r1_local)
    local_decl.extend(r2_local)

1157
    return stmts, unicode(ada_string), local_decl
1158
1159
1160
1161


@expression.register(ogAST.PrimSelector)
def _prim_selector(prim):
Maxime Perrotin's avatar
Maxime Perrotin committed
1162
    ''' Selector (field access with '!' separation) '''
1163
1164
1165
1166
1167
    stmts, ada_string, local_decl = [], '', []

    receiver = prim.value[0]
    field_name = prim.value[1]

1168
1169
    receiver_stms, receiver_string, receiver_decl = expression(receiver)
    ada_string = receiver_string
1170
1171
1172
1173
1174
1175
    stmts.extend(receiver_stms)
    local_decl.extend(receiver_decl)

    receiver_bty = find_basic_type(receiver.exprType)

    if receiver_bty.kind == 'ChoiceType':
Maxime Perrotin's avatar
Maxime Perrotin committed
1176
1177
        ada_string = ('{sort}_{field_name}_get({ada_string})'
                    .format(sort=type_name(receiver.exprType),
1178
1179
                            field_name=field_name,
                            ada_string=ada_string))
1180
1181
1182
    else:
        ada_string += '.' + field_name

Maxime Perrotin's avatar
Maxime Perrotin committed
1183
    return stmts, unicode(ada_string), local_decl
1184
1185


1186
1187
1188
1189
1190
1191
@expression.register(ogAST.PrimStateReference)
def _primary_state_reference(prim):
    ''' Reference to the current state '''
    return [], u'state', []


Maxime Perrotin's avatar
Maxime Perrotin committed
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
@expression.register(ogAST.ExprPlus)
@expression.register(ogAST.ExprMul)
@expression.register(ogAST.ExprMinus)
@expression.register(ogAST.ExprGt)
@expression.register(ogAST.ExprGe)
@expression.register(ogAST.ExprLt)
@expression.register(ogAST.ExprLe)
@expression.register(ogAST.ExprDiv)
@expression.register(ogAST.ExprMod)
@expression.register(ogAST.ExprRem)
Maxime Perrotin's avatar
Maxime Perrotin committed
1202
def _basic_operators(expr):
1203
    ''' Expressions with two sides '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1204
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
1205
1206
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
Maxime Perrotin's avatar
Maxime Perrotin committed
1207
    ada_string = u'({left} {op} {right})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1208
1209
1210
1211
1212
            left=left_str, op=expr.operand, right=right_str)
    code.extend(left_stmts)
    code.extend(right_stmts)