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

"""
    OpenGEODE - A tiny SDL Editor for TASTE

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

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

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

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

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

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

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

    Expressions return three values: "code", "ada_string" and "local_decl".
    The "ada_string" value is the usable string that corresponds
Maxime Perrotin's avatar
Maxime Perrotin committed
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
    to the result of the expression evaluation.

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

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

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

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

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

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

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

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

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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


import logging
from singledispatch import singledispatch

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

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

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

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

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


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

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


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

154
    # In case model has nested states, flatten everything
155
    Helper.flatten(process, sep=UNICODE_SEP)
156

Maxime Perrotin's avatar
Maxime Perrotin committed
157
158
159
160
    # 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
161
162
163
164
165
166
167
168
    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
169
            dst, dstr, dlocal = expression(def_value)
170
171
172
            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
173
174
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
175
176
177
178
                        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
179

Maxime Perrotin's avatar
Maxime Perrotin committed
180
    # Add the process states list to the process-level variables
181
    statelist = ', '.join(name for name in process.mapping.iterkeys()
Maxime Perrotin's avatar
Maxime Perrotin committed
182
                             if not name.endswith(u'START')) or 'No_State'
183
    if statelist:
Maxime Perrotin's avatar
Maxime Perrotin committed
184
        states_decl = u'type states is ({});'.format(statelist)
185
186
        process_level_decl.append(states_decl)
        process_level_decl.append('state : states;')
Maxime Perrotin's avatar
Maxime Perrotin committed
187

188
    for name, val in process.mapping.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
189
190
        if name.endswith(u'START') and name != u'START':
            process_level_decl.append(u'{name} : constant := {val};'
191
192
                                      .format(name=name, val=str(val)))

Maxime Perrotin's avatar
Maxime Perrotin committed
193
    # Add the declaration of the runTransition procedure
194
    process_level_decl.append('procedure runTransition(Id: Integer);')
Maxime Perrotin's avatar
Maxime Perrotin committed
195
196

    # Generate the code of the start transition:
197
198
    start_transition = ['begin',
                        'runTransition(0);']
199

Maxime Perrotin's avatar
Maxime Perrotin committed
200
201
202
203
204
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
205
        asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
206
207
208
209
210
211
212
213
    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;

214
with Ada.Unchecked_Conversion;
215
with Ada.Numerics.Generic_Elementary_Functions;
216

Maxime Perrotin's avatar
Maxime Perrotin committed
217
218
219
220
{dataview}

with Interfaces;
use Interfaces;
221
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
222
package body {process_name} is'''.format(process_name=process_name,
223
224
225
226
                                         dataview=asn1_modules,
                                         C='with Interfaces.C.Strings;\n'
                                           'use Interfaces.C.Strings;'
                                            if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
227
228
229
230
231
232

    # 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
233
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
234
235

package {process_name} is'''.format(process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
236
237
238
239
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
240

241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
    if simu:
        dll_api = []
        ads_template.append('--  DLL Interface')
        # 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))
        # Functions to get gobal variables (length and value)
        dll_api.append('-- DLL Interface to remotely change internal data')
        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))
            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
277
278
279
280
281
282
283
284
285
286
287
288
289
    # 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)

290
291
292
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
293
294
295
    # 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
296
        if signal.get('name', u'START') == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
297
            continue
298
299
300
        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
301
302
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
303
            typename = type_name(signal['type'])
304
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
305
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
306
307

        # Add declaration of the provided interface in the .ads file
308
        ads_template.append(u'--  Provided interface "' + signal['name'] + '"')
Maxime Perrotin's avatar
Maxime Perrotin committed
309
        ads_template.append(pi_header + ';')
310
311
312
313
314
315
316
        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 []
317
            minicv.append(aadl_template(signal['name'], params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
318
319
320
321
322
323

        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
324
            if state.endswith(u'START'):
Maxime Perrotin's avatar
Maxime Perrotin committed
325
                continue
Maxime Perrotin's avatar
Maxime Perrotin committed
326
            taste_template.append(u'when {state} =>'.format(state=state))
Maxime Perrotin's avatar
Maxime Perrotin committed
327
            input_def = mapping[signal['name']].get(state)
328
            # Check for nested states to call optional exit procedure
329
            sep = UNICODE_SEP
330
            state_tree = state.split(sep)
Maxime Perrotin's avatar
Maxime Perrotin committed
331
            context = process
332
333
334
335
336
337
            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:
338
                    if current.lower() == comp.statename.lower():
339
340
341
342
343
344
345
346
                        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):
347
348
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
                                          .format(ref=each, sep=sep))
349

Maxime Perrotin's avatar
Maxime Perrotin committed
350
351
352
353
            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
354
                    taste_template.append(u'l_{inp} := {tInp}.all;'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
355
356
357
                        inp=inp, tInp=param_name))
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
358
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
359
360
361
362
363
364
365
366
                        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
367
        taste_template.append(u'end {sig_name};'.format(
dbarbera's avatar
dbarbera committed
368
                                                    sig_name=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
369
370
371
372
373
        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:
374

375
376
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
377
        # Add (optional) RI parameter
Maxime Perrotin's avatar
Maxime Perrotin committed
378
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
379
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
380
            typename = type_name(signal['type'])
381
382
383
384
385
            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
386
        ads_template.append(u'--  Required interface "' + signal['name'] + '"')
387
388
389
390
391
392
        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']))
393
            ads_template.append('{sig} : {sig}_T;'
394
                                .format(sig=signal['name']))
395
396
397
398
399
            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']))
400
401
402
403

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

406
407
408
409
410
411
412
            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('')
413
414
415
416
417
        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
418
419

    # for the .ads file, generate the declaration of the external procedures
420
421
    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
422
423
        params = []
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
424
425
426
427
            typename = type_name(param['type'])
            params.append(u'{par[name]}: access {sort}'
                          .format(par=param,
                                  sort=typename))
Maxime Perrotin's avatar
Maxime Perrotin committed
428
        if params:
Maxime Perrotin's avatar
Maxime Perrotin committed
429
            ri_header += u'(' + u';'.join(params) + ')'
Maxime Perrotin's avatar
Maxime Perrotin committed
430
        ads_template.append(
dbarbera's avatar
dbarbera committed
431
                        u'--  Sync required interface "' + proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
432
433
        ads_template.append(ri_header + u';')
        ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
434
435
436
437
                .format(sig=proc.inputString, proc=process_name))

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
438
439
440
441
442
        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
443
                                 '(name: chars_ptr; duration: Integer);'
444
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
445
446
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
            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
473
                .format(timer))
474
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
475
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
476
                .format(timer=timer, proc=process_name))
477
478
            ads_template.append(u'procedure RESET_{};'.format(timer))
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
479
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
480
481
                .format(timer=timer, proc=process_name))

482
483
484
    taste_template.append('procedure runTransition(Id: Integer) is')
    taste_template.append('trId : Integer := Id;')

485
486
487
488
489
490
    # 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;')

491
492
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509

    # 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
510
    taste_template.extend(set(local_decl_transitions))
Maxime Perrotin's avatar
Maxime Perrotin committed
511
512
    taste_template.append('begin')

513
514
515
516
    # 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
517
518
519
520
    # 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
521
522
        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
523
524
525
526
527
528
529
530
531
        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;')
532
533
534
535
    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
536
537
538
539

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

Maxime Perrotin's avatar
Maxime Perrotin committed
540
541
542
    #if code_labels:
    taste_template.append('<<next_transition>>')
    taste_template.append('null;')
543
    taste_template.append('end loop;')
Maxime Perrotin's avatar
Maxime Perrotin committed
544
545
546
547
548
549
550
551
552
553
554
    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
555
556
        ada_file.write(
                u'\n'.join(format_ada_code(taste_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
557
558

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

562
563
564
565
    if simu:
        with open(u'{}_interface.aadl'.format(process_name), 'w') as aadl:
            aadl.write(u'\n'.join(minicv).encode('latin1'))

Maxime Perrotin's avatar
Maxime Perrotin committed
566
567
568
569
570
571
572
573

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
574
575
576
577
578
579
580
581
582
    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
583
584
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
585
586
            code.append(u'Put("{}");'
                        .format(param.value[1:-1].replace('"', "'")))
Maxime Perrotin's avatar
Maxime Perrotin committed
587
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
588
            code, string, local = expression(param)
589
590
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
591
                sep = UNICODE_SEP
592
                last_it = u""
593
594
                if isinstance(param, ogAST.PrimSubstring):
                    range_str = u"{}'Range".format(string)
595
                    iterator = u"i - {}'First + 1".format(string)
596
597
598
                elif basic_type.Min == basic_type.Max:
                    range_str = u"{}.Data'Range".format(string)
                    string += u".Data"
599
                    iterator = u"i"
600
601
602
                else:
                    range_str = u"1 .. {}.Length".format(string)
                    string += u".Data"
603
604
                    iterator = u"i"
                    last_it = u"({})".format(range_str)
605
                code.extend([u"for i in {} loop".format(range_str),
606
607
                             u"Put(Character'Val({st}(i)));"
                             .format(st=string, sep=sep, it=iterator),
608
                             u"end loop;"])
609
610
            else:
                code.append("Put({});".format(string))
Maxime Perrotin's avatar
Maxime Perrotin committed
611
612
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
613
        code, string, local = expression(param)
dbarbera's avatar
dbarbera committed
614
        if type_kind in ('IntegerType', 'Integer32Type'):
615
            cast = "Asn1Int"
Maxime Perrotin's avatar
Maxime Perrotin committed
616
617
618
619
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
620
        code.append(u"Put({cast}'Image({s}));".format(cast=cast, s=string))
Maxime Perrotin's avatar
Maxime Perrotin committed
621
    else:
622
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
623
624
625
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
626
627
    if newline:
        code.append(u"New_Line;")
Maxime Perrotin's avatar
Maxime Perrotin committed
628
629
630
631
632
    return code, string, local


@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
633
def _call_external_function(output, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
    ''' 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
662
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
663
664
            code.extend(p_code)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
665
666
667
668
            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
669
670
671
672
            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
673
674
            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
675
676
677
678
            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
679
680
681
682
683
684
685
686
687
688
689
            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
690
691
            continue
        proc, out_sig = None, None
692
        is_out_sig = False
Maxime Perrotin's avatar
Maxime Perrotin committed
693
694
695
        try:
            out_sig, = [sig for sig in OUT_SIGNALS
                        if sig['name'].lower() == signal_name.lower()]
696
            is_out_sig = True if SHARED_LIB else False
Maxime Perrotin's avatar
Maxime Perrotin committed
697
        except ValueError:
698
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
699
            try:
700
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
701
                            if sig.inputString.lower() == signal_name.lower()]
702
703
                if proc.external:
                    out_sig = proc
Maxime Perrotin's avatar
Maxime Perrotin committed
704
            except ValueError:
705
                # Not there? Impossible, the parser would have barked
706
                raise ValueError(u'Probably a bug - please report')
Maxime Perrotin's avatar
Maxime Perrotin committed
707
708
709
710
711
712
713
714
715
716
717
718
        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
719
                typename = type_name(param_type)
Maxime Perrotin's avatar
Maxime Perrotin committed
720
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
721
722
723
                code.extend(p_code)
                local_decl.extend(p_local)
                # Create a temporary variable for input parameters only
Maxime Perrotin's avatar
Maxime Perrotin committed
724
725
                # (If needed, i.e. if argument is not a local variable)
                if param_direction == 'in' \
726
727
728
                        and (not (isinstance(param, ogAST.PrimVariable)
                        and p_id.startswith('l_'))
                        or isinstance(param, ogAST.PrimFPAR)):
729
730
731
732
                    tmp_id = 'tmp{}'.format(out['tmpVars'][idx])
                    local_decl.append('{tmp} : aliased {sort};'
                                      .format(tmp=tmp_id,
                                              sort=typename))
733
734
735
736
                    if isinstance(param,
                              (ogAST.PrimSequenceOf, ogAST.PrimStringLiteral)):
                        p_id = array_content(param, p_id,
                                             find_basic_type(param_type))
737
738
739
740
741
                    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
742
                else:
743
744
745
                    # Output parameters/local variables
                    list_of_params.append(u"{var}'access{shared}"
                                         .format(var=p_id,
Maxime Perrotin's avatar
Maxime Perrotin committed
746
747
                                                shared=", {}'Size".format(p_id)
                                                  if is_out_sig else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
748
            if list_of_params:
749
750
751
                code.append(u'{RI}({params});'
                            .format(RI=out['outputName'],
                                    params=', '.join(list_of_params)))
Maxime Perrotin's avatar
Maxime Perrotin committed
752
            else:
753
754
755
                if not SHARED_LIB:
                    code.append(u'{RI};'.format(RI=out['outputName']))
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
756
757
                    code.append(u'{RI}(New_String("{RI}"));'
                                .format(RI=out['outputName']))
Maxime Perrotin's avatar
Maxime Perrotin committed
758
759
760
        else:
            # inner procedure call
            list_of_params = []
761
            for param in out.get('params', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
762
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
763
764
765
766
767
                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:
768
769
                code.append(u'p{sep}{proc}({params});'.format(
                    sep=UNICODE_SEP,
Maxime Perrotin's avatar
Maxime Perrotin committed
770
771
772
                    proc=proc.inputString,
                    params=', '.join(list_of_params)))
            else:
773
                code.append(u'p{}{};'.format(UNICODE_SEP, proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
774
775
776
777
    return code, local_decl


@generate.register(ogAST.TaskAssign)
778
def _task_assign(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
779
780
781
782
783
784
    ''' 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))
785
786
        # ExprAssign only returns code statements, no string
        code_assign, _, decl_assign = expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
787
788
789
790
791
792
        code.extend(code_assign)
        local_decl.extend(decl_assign)
    return code, local_decl


@generate.register(ogAST.TaskInformalText)
793
def _task_informal_text(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
794
795
796
797
798
799
800
801
802
    ''' 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)
803
def _task_forloop(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
804
805
806
807
808
809
810
811
812
813
814
815
816
    '''
        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
817
                start_stmt, start_str, start_local = expression(
dbarbera's avatar
dbarbera committed
818
                                                    loop['range']['start'])
Maxime Perrotin's avatar
Maxime Perrotin committed
819
820
821
822
                local_decl.extend(start_local)
                stmt.extend(start_stmt)
            if loop['range']['step'] == 1:
                start_str += '..'
Maxime Perrotin's avatar
Maxime Perrotin committed
823
            stop_stmt, stop_str, stop_local = expression(loop['range']['stop'])
Maxime Perrotin's avatar
Maxime Perrotin committed
824
825
826
            local_decl.extend(stop_local)
            stmt.extend(stop_stmt)
            if loop['range']['step'] == 1:
Maxime Perrotin's avatar
Maxime Perrotin committed
827
828
829
830
                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
831
                stmt.append(
832
                        u'for {it} in {start}{stop} loop'
dbarbera's avatar
dbarbera committed
833
                        .format(it=loop['var'], start=start_str, stop=stop_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
834
835
836
            else:
                # Step is not directly supported in Ada, we need to use 'while'
                stmt.extend(['declare',
837
                             u'{it} : Integer := {start};'
Maxime Perrotin's avatar
Maxime Perrotin committed
838
839
840
841
                             .format(it=loop['var'],
                             start=start_str),
                             '',
                             'begin',
842
                             u'while {it} < {stop} loop'.format(it=loop['var'],
Maxime Perrotin's avatar
Maxime Perrotin committed
843
844
845
                                                               stop=stop_str)])
        else:
            # case of form: FOR x in SEQUENCE OF
Maxime Perrotin's avatar
Maxime Perrotin committed
846
            list_stmt, list_str, list_local = expression(loop['list'])
Maxime Perrotin's avatar
Maxime Perrotin committed
847
            basic_type = find_basic_type(loop['list'].exprType)
848
            list_payload = list_str + string_payload(loop['list'], list_str)
849
850
851
852
853
            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
854
855
856
            stmt.extend(list_stmt)
            local_decl.extend(list_local)
            stmt.extend(['declare',
857
858
                         '{} : {};'.format(loop['var'],
                                           type_name(loop['type'])),
Maxime Perrotin's avatar
Maxime Perrotin committed
859
860
861
                         '',
                         'begin',
                         'for {it}_idx in {rc} loop'.format(it=loop['var'],
862
                                                            rc=range_str),
863
864
                         '{it} := {var}({it}_idx);'.format(it=loop['var'],
                                                          var=list_payload)])
Maxime Perrotin's avatar
Maxime Perrotin committed
865
866
867
868
        try:
            code_trans, local_trans = generate(loop['transition'])
            if local_trans:
                stmt.append('declare')
869
                stmt.extend(set(local_trans))
Maxime Perrotin's avatar
Maxime Perrotin committed
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
                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
886
887
888
889
890
891
892
893
894
895
@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
896

Maxime Perrotin's avatar
Maxime Perrotin committed
897
@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
898
899
def _primary_variable(prim):
    ''' Single variable reference '''
Maxime Perrotin's avatar
Maxime Perrotin committed
900
    sep = u'l_' if find_var(prim.value[0]) else u''
Maxime Perrotin's avatar
Maxime Perrotin committed
901

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

904
905
    if prim.exprType.__name__ == 'for_range':
        # Ada iterator in FOR loops is an Integer - we must cast to 64 bits
906
        ada_string = u'Asn1Int({})'.format(ada_string)
907
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
908
909


910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
@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
925
                'Asn1Int' if ident == 'fix' else 'Asn1Real'
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
                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
948
949
        if min_length == max_length \
                and not isinstance(exp, ogAST.PrimSubstring):
950
951
            ada_string += min_length
        else:
952
953
954
955
956
            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))
957
958
959
960
961
962
963
    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
964
        exp_typename = type_name(exp.exprType)
965
966
967
968
969
970
971
        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
972
973
974
        ada_string += ('{sort}_Kind({e})'
                       .format(sort=exp_typename,
                               e=param_str))
975
976
977
    elif ident == 'num':
        # User wants to get an enumerated corresponding integer value
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
978
        exp_typename = type_name(exp.exprType)
979
        param_stmts, param_str, local_var = expression(exp)
Maxime Perrotin's avatar
Maxime Perrotin committed
980
981
        local_decl.append('function num_{sort} is new Ada.Unchecked_Conversion'
                          '({sort}, Asn1Int);'.format(sort=exp_typename))
982
983
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
984
985
986
        ada_string += ('num_{sort}({p})'
                       .format(sort=exp_typename,
                               p=param_str))
dbarbera's avatar
dbarbera committed
987
    elif ident == 'floor':
988
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
989
        exp_typename = type_name(exp.exprType)
990
991
992
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
993
994
        ada_string += "{sort}'Floor({p})".format(sort=exp_typename,
                                                 p=param_str)
dbarbera's avatar
dbarbera committed
995
    elif ident == 'ceil':
996
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
997
        exp_typename = type_name(exp.exprType)
998
999
1000
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1001
1002
        ada_string += "{sort}'Ceiling({p})".format(sort=exp_typename,
                                                   p=param_str)
dbarbera's avatar
dbarbera committed
1003
    elif ident == 'cos':
1004
1005
1006
1007
1008
1009
        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
1010
                          '(Asn1Real);')
1011
        ada_string += "Math.Cos({})".format(param_str)
dbarbera's avatar
dbarbera committed
1012
    elif ident == 'round':
1013
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1014
        exp_typename = type_name(exp.exprType)
1015
1016
1017
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1018
1019
        ada_string += "{sort}'Rounding({p})".format(sort=exp_typename,
                                                    p=param_str)
dbarbera's avatar
dbarbera committed
1020
    elif ident == 'sin':
1021
1022
1023
1024
1025
1026
        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
1027
                          '(Asn1Real);')
1028
        ada_string += "Math.Sin({})".format(param_str)
dbarbera's avatar
dbarbera committed
1029
    elif ident == 'sqrt':
1030
1031
1032
1033
1034
1035
        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
1036
                          '(Asn1Real);')
1037
        ada_string += "Math.Sqrt({})".format(param_str)
dbarbera's avatar
dbarbera committed
1038
    elif ident == 'trunc':
1039
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1040
        exp_typename = type_name(exp.exprType)
1041
1042
1043
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
1044
1045
        ada_string += "{sort}'Truncation({p})".format(sort=exp_typename,
                                                      p=param_str)
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
    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 += ')'

1058
    return stmts, unicode(ada_string), local_decl
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076


@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
1077
1078
1079
    if not isinstance(receiver, ogAST.PrimSubstring):
        ada_string += '.Data'
    ada_string += '({idx})'.format(idx=idx_string)
1080
1081
1082
    stmts.extend(idx_stmts)
    local_decl.extend(idx_var)

1083
    return stmts, unicode(ada_string), local_decl
1084
1085
1086
1087


@expression.register(ogAST.PrimSubstring)
def _prim_substring(prim):
1088
    ''' Generate expression for SEQOF/OCT.STRING substrings, e.g. foo(1,2) '''
1089
1090
1091
1092
    stmts, ada_string, local_decl = [], '', []

    receiver = prim.value[0]

1093
1094
    receiver_stms, receiver_string, receiver_decl = expression(receiver)
    ada_string = receiver_string
1095
1096
1097
1098
1099
1100
    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])

1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
    # 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
1111
1112
1113
    if not isinstance(receiver, ogAST.PrimSubstring):
        ada_string += '.Data'
    ada_string += '({r1}..{r2})'.format(r1=r1_string, r2=r2_string)
1114
1115
1116
1117
1118
    stmts.extend(r1_stmts)
    stmts.extend(r2_stmts)
    local_decl.extend(r1_local)
    local_decl.extend(r2_local)

1119
    return stmts, unicode(ada_string), local_decl
1120
1121
1122
1123


@expression.register(ogAST.PrimSelector)
def _prim_selector(prim):
Maxime Perrotin's avatar
Maxime Perrotin committed
1124
    ''' Selector (field access with '!' separation) '''
1125
1126
1127
1128
1129
    stmts, ada_string, local_decl = [], '', []

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

1130
1131
    receiver_stms, receiver_string, receiver_decl = expression(receiver)
    ada_string = receiver_string
1132
1133
1134
1135
1136
1137
    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
1138
1139
        ada_string = ('{sort}_{field_name}_get({ada_string})'
                    .format(sort=type_name(receiver.exprType),
1140
1141
                            field_name=field_name,
                            ada_string=ada_string))
1142
1143
1144
    else:
        ada_string += '.' + field_name

Maxime Perrotin's avatar
Maxime Perrotin committed
1145
    return stmts, unicode(ada_string), local_decl
1146
1147


Maxime Perrotin's avatar
Maxime Perrotin committed
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
@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
1158
def _basic_operators(expr):
1159
    ''' Expressions with two sides '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1160
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
1161
1162
    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
1163
    ada_string = u'({left} {op} {right})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1164
1165
1166
1167
1168
            left=left_str, op=expr.operand, right=right_str)
    code.extend(left_stmts)
    code.extend(right_stmts)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
1169
    return code, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1170

dbarbera's avatar
dbarbera committed
1171

Maxime Perrotin's avatar
Maxime Perrotin committed
1172
1173
1174
1175
1176
1177
1178
@expression.register(ogAST.ExprEq)
@expression.register(ogAST.ExprNeq)
def _equality(expr):
    code, left_str, local_decl = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
    code.extend(right_stmts)
    local_decl.extend(right_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
1179
1180
    asn1_type = getattr(expr.left.exprType, 'ReferencedTypeName', None)
    actual_type = type_name(expr.left.exprType)
1181
1182
1183
    lbty = find_basic_type(expr.left.exprType)
    basic = lbty.kind in ('IntegerType', 'Integer32Type', 'BooleanType',
                          'RealType', 'EnumeratedType', 'ChoiceEnumeratedType')
Maxime Perrotin's avatar
Maxime Perrotin committed
1184
1185
1186
1187
    if basic:
        ada_string = u'({left} {op} {right})'.format(
                left=left_str, op=expr.operand, right=right_str)
    else:
1188
1189
1190
1191
        if asn1_type in TYPES:
            if isinstance(expr.right,
                          (ogAST.PrimSequenceOf, ogAST.PrimStringLiteral)):
                right_str = array_content(expr.right, right_str, lbty)
Maxime Perrotin's avatar
Maxime Perrotin committed
1192
1193
            ada_string = u'{sort}_Equal({left}, {right})'.format(
                           sort=actual_type, left=left_str, right=right_str)
1194
1195
1196
1197
        else:
            # Raw types on both left and right.... use simple operator
            ada_string = u"({left}) {op} ({right})".format(left=left_str,
                    op=expr.operand, right=right_str)
Maxime Perrotin's avatar
Maxime Perrotin committed
1198
1199
1200
1201
1202
        if isinstance(expr, ogAST.ExprNeq):
            ada_string = u'not {}'.format(ada_string)
    return code, unicode(ada_string), local_decl


1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
@expression.register(ogAST.ExprAssign)
def _assign_expression(expr):
    ''' Assignment: almost the same a basic operators, except for strings '''
    code, local_decl = [], []
    strings = []
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
    # If left side is a string/seqOf and right side is a substring, we must
    # assign the .Data and .Length parts properly
    basic_left = find_basic_type(expr.left.exprType)
1213
1214
1215
1216
    if basic_left.kind in ('SequenceOfType', 'OctetStringType'):
        rlen = "{}'Length".format(right_str)