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

"""
    OpenGEODE - A tiny SDL Editor for TASTE

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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


import logging
from singledispatch import singledispatch

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

LOG = logging.getLogger(__name__)

__all__ = ['generate']

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


@singledispatch
def generate(ast):
    ''' Generate the code for an item of the AST '''
    raise TypeError('[AdaGenerator] Unsupported AST construct')
95
    return [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
96
97


Maxime Perrotin's avatar
Maxime Perrotin committed
98
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
99
100
101
102
103
104
105
106
107
108
109
110
111
@generate.register(ogAST.Process)
def _process(process):
    ''' Generate the code for a complete process (AST Top level) '''
    process_name = process.processName
    global TYPES
    TYPES = process.dataview
    del OUT_SIGNALS[:]
    del PROCEDURES[:]
    OUT_SIGNALS.extend(process.output_signals)
    PROCEDURES.extend(process.procedures)

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

112
    # In case model has nested states, flatten everything
Maxime Perrotin's avatar
Maxime Perrotin committed
113
    Helper.flatten(process, sep=u'\u00dc')
114

Maxime Perrotin's avatar
Maxime Perrotin committed
115
116
117
118
    # 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
119
120
121
122
123
124
125
126
    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
127
            dst, dstr, dlocal = expression(def_value)
Maxime Perrotin's avatar
Maxime Perrotin committed
128
129
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
130
                u'l_{n} : aliased asn1Scc{t}{default};'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
131
                        n=var_name,
132
                        t=var_type.ReferencedTypeName.replace('-', '_'),
Maxime Perrotin's avatar
Maxime Perrotin committed
133
                        default=u' := ' + dstr if def_value else u''))
Maxime Perrotin's avatar
Maxime Perrotin committed
134

Maxime Perrotin's avatar
Maxime Perrotin committed
135
    # Add the process states list to the process-level variables
136
    statelist = ', '.join(name for name in process.mapping.iterkeys()
Maxime Perrotin's avatar
Maxime Perrotin committed
137
                             if not name.endswith(u'START')) or 'No_State'
138
    if statelist:
Maxime Perrotin's avatar
Maxime Perrotin committed
139
        states_decl = u'type states is ({});'.format(statelist)
140
141
        process_level_decl.append(states_decl)
        process_level_decl.append('state : states;')
Maxime Perrotin's avatar
Maxime Perrotin committed
142

143
    for name, val in process.mapping.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
144
145
        if name.endswith(u'START') and name != u'START':
            process_level_decl.append(u'{name} : constant := {val};'
146
147
                                      .format(name=name, val=str(val)))

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

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

    # Generate the code of the start transition:
160
161
    start_transition = ['begin',
                        'runTransition(0);']
162

Maxime Perrotin's avatar
Maxime Perrotin committed
163
164
165
166
167
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
168
        asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
169
170
171
172
173
174
175
176
    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;

177
with Ada.Unchecked_Conversion;
178
with Ada.Numerics.Generic_Elementary_Functions;
179

Maxime Perrotin's avatar
Maxime Perrotin committed
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
{dataview}

with Interfaces;
use Interfaces;

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

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

{dataview}

package {process_name} is'''.format(process_name=process_name,
195
                                    dataview=asn1_modules)]
Maxime Perrotin's avatar
Maxime Perrotin committed
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

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

    # 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
213
        if signal.get('name', u'START') == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
214
215
216
217
218
219
220
            continue
        pi_header = 'procedure {sig_name}'.format(sig_name=signal['name'])
        param_name = signal.get('param_name') or 'MISSING_PARAM_NAME'
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
            typename = signal['type'].ReferencedTypeName.replace('-', '_')
            pi_header += '({pName}: access asn1Scc{pType})'.format(
dbarbera's avatar
dbarbera committed
221
                                        pName=param_name, pType=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
222
223
224
225

        # Add declaration of the provided interface in the .ads file
        ads_template.append('--  Provided interface "' + signal['name'] + '"')
        ads_template.append(pi_header + ';')
226
227
        ads_template.append('pragma export(C, {name}, "{proc}_{name}");'
                            .format(name=signal['name'], proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
228
229
230
231
232
233

        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
234
            if state.endswith(u'START'):
Maxime Perrotin's avatar
Maxime Perrotin committed
235
                continue
Maxime Perrotin's avatar
Maxime Perrotin committed
236
            taste_template.append(u'when {state} =>'.format(state=state))
Maxime Perrotin's avatar
Maxime Perrotin committed
237
            input_def = mapping[signal['name']].get(state)
238
            # Check for nested states to call optional exit procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
239
            sep = u'\u00dc'
240
            state_tree = state.split(sep)
Maxime Perrotin's avatar
Maxime Perrotin committed
241
            context = process
242
243
244
245
246
247
            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:
248
                    if current.lower() == comp.statename.lower():
249
250
251
252
253
254
255
256
                        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):
Maxime Perrotin's avatar
Maxime Perrotin committed
257
                    taste_template.append(each + sep + u'exit;')
258

Maxime Perrotin's avatar
Maxime Perrotin committed
259
260
261
262
            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
263
                    taste_template.append(u'l_{inp} := {tInp}.all;'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
264
265
266
                        inp=inp, tInp=param_name))
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
267
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
268
269
270
271
272
273
274
275
                        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
276
        taste_template.append(u'end {sig_name};'.format(
dbarbera's avatar
dbarbera committed
277
                                                    sig_name=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
278
279
280
281
282
        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:
Maxime Perrotin's avatar
Maxime Perrotin committed
283
        ri_header = u'procedure {sig_name}'.format(sig_name=signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
284
285
286
287
        param_name = signal.get('param_name') or 'MISSING_PARAM_NAME'
        # Add (optional) RI parameter
        if 'type' in signal:
            typename = signal['type'].ReferencedTypeName.replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
288
            ri_header += u'({pName}: access asn1Scc{pType})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
289
                pName=param_name, pType=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
290
        ads_template.append(u'--  Required interface "' + signal['name'] + '"')
Maxime Perrotin's avatar
Maxime Perrotin committed
291
        ads_template.append(ri_header + ';')
Maxime Perrotin's avatar
Maxime Perrotin committed
292
        ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
293
294
295
                .format(sig=signal['name'], proc=process_name))

    # for the .ads file, generate the declaration of the external procedures
296
297
    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
298
299
300
        params = []
        for param in proc.fpar:
            typename = param['type'].ReferencedTypeName.replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
301
            params.append(u'{par[name]}: access asn1Scc{partype}'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
302
303
                par=param, partype=typename))
        if params:
Maxime Perrotin's avatar
Maxime Perrotin committed
304
            ri_header += u'(' + u';'.join(params) + ')'
Maxime Perrotin's avatar
Maxime Perrotin committed
305
        ads_template.append(
dbarbera's avatar
dbarbera committed
306
                        u'--  Sync required interface "' + proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
307
308
        ads_template.append(ri_header + u';')
        ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
309
310
311
312
313
                .format(sig=proc.inputString, proc=process_name))

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
        ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
314
                u'--  Timer {} SET and RESET functions'.format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
315
        ads_template.append(u'procedure SET_{}(val: access asn1SccT_UInt32);'
Maxime Perrotin's avatar
Maxime Perrotin committed
316
317
                .format(timer))
        ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
318
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
319
                .format(timer=timer, proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
320
        ads_template.append(u'procedure RESET_{};'.format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
321
        ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
322
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
323
324
                .format(timer=timer, proc=process_name))

325
326
327
    taste_template.append('procedure runTransition(Id: Integer) is')
    taste_template.append('trId : Integer := Id;')

328
329
330
331
332
333
    # 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;')

334
335
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352

    # 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
353
    decl = [u'{line}'.format(line=l)
354
            for l in set(local_decl_transitions)]
Maxime Perrotin's avatar
Maxime Perrotin committed
355
356
357
    taste_template.extend(decl)
    taste_template.append('begin')

358
359
360
361
    # 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
362
363
364
365
    # 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
366
367
        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
368
369
370
371
372
373
374
375
376
        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;')
377
378
379
380
    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
381
382
383
384

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

Maxime Perrotin's avatar
Maxime Perrotin committed
385
386
387
    #if code_labels:
    taste_template.append('<<next_transition>>')
    taste_template.append('null;')
388
    taste_template.append('end loop;')
Maxime Perrotin's avatar
Maxime Perrotin committed
389
390
391
392
    taste_template.append('end runTransition;')
    taste_template.append('\n')

    # Code of the function allowing to trace current state
393
394
395
396
397
    #taste_template.append('function get_state return String is')
    #taste_template.append('begin')
    #taste_template.append("return states'Image(state);")
    #taste_template.append('end get_state;')
    #taste_template.append('\n')
Maxime Perrotin's avatar
Maxime Perrotin committed
398
399
400
401
402
403
404
405
406

    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
407
408
        ada_file.write(
                u'\n'.join(format_ada_code(taste_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
409
410

    with open(process_name + '.ads', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
411
412
        ada_file.write(
                u'\n'.join(format_ada_code(ads_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
413
414
415
416
417
418
419
420
421
422
423
424


def write_statement(param, newline):
    ''' Generate the code for the special "write" operator '''
    code = []
    string = ''
    local = []
    basic_type = find_basic_type(param.exprType) or {}
    type_kind = basic_type.kind
    if type_kind.endswith('StringType'):
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
425
            string = '"' + param.value[1:-1].replace('"', "'") + '"'
Maxime Perrotin's avatar
Maxime Perrotin committed
426
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
427
            code, string, local = expression(param)
428
429
430
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
                sep = u'\u00dc'
431
432
433
                localstr = u'tmp{}{}str'.format(str(param.tmpVar), sep)
                local.append(u'{} : String(1 .. {});'
                             .format(localstr, basic_type.Max))
434
435
436
437
438
439
440
441
442
443
                if isinstance(param, ogAST.PrimSubstring):
                    range_str = u"{}'Range".format(string)
                elif basic_type.Min == basic_type.Max:
                    range_str = u"{}.Data'Range".format(string)
                    string += u".Data"
                else:
                    range_str = u"1 .. {}.Length".format(string)
                    string += u".Data"
                code.extend([u"for i in {} loop".format(range_str),
                             u"{tmp}(i) := Character'Val({st}(i));"
444
                             .format(tmp=localstr, st=string, sep=sep),
445
                             u"end loop;"])
446
                string = u'{}({})'.format(localstr, range_str)
Maxime Perrotin's avatar
Maxime Perrotin committed
447
448
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
449
        code, string, local = expression(param)
dbarbera's avatar
dbarbera committed
450
        if type_kind in ('IntegerType', 'Integer32Type'):
451
            cast = "Asn1Int"
Maxime Perrotin's avatar
Maxime Perrotin committed
452
453
454
455
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
Maxime Perrotin's avatar
Maxime Perrotin committed
456
        string = u"{cast}'Image({s})".format(cast=cast, s=string)
Maxime Perrotin's avatar
Maxime Perrotin committed
457
    else:
458
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
459
460
461
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
Maxime Perrotin's avatar
Maxime Perrotin committed
462
463
    code.append(u'Put{line}({string});'.format(
        line=u'_Line' if newline else u'',
Maxime Perrotin's avatar
Maxime Perrotin committed
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
        string=string))
    return code, string, local


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

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

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

        if signal_name.lower() in ('write', 'writeln'):
            # special built-in SDL procedure for printing strings
            # supports printing of native types (int, real, bool)
            # but not yet complex ASN.1 structures (sequence/seqof/choice)
            for param in out['params'][:-1]:
                stmts, _, local = write_statement(param, newline=False)
                code.extend(stmts)
                local_decl.extend(local)
            for param in out['params'][-1:]:
                # Last parameter - add newline if necessary
                stmts, _, local = write_statement(param, newline=True if
                        signal_name.lower() == 'writeln' else False)
                code.extend(stmts)
                local_decl.extend(local)
            continue
        elif signal_name.lower() == 'reset_timer':
            # built-in operator for resetting timers. param = timer name
            param, = out['params']
Maxime Perrotin's avatar
Maxime Perrotin committed
499
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
500
501
502
503
504
505
506
            code.extend(p_code)
            local_decl.extend(p_local)
            code.append('RESET_{};'.format(p_id))
            continue
        elif signal_name.lower() == 'set_timer':
            # built-in operator for setting a timer: SET(1000, timer_name)
            timer_value, timer_id = out['params']
Maxime Perrotin's avatar
Maxime Perrotin committed
507
508
            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
509
510
511
512
513
514
            code.extend(t_code)
            code.extend(p_code)
            local_decl.extend(t_local)
            local_decl.extend(p_local)
            # Use a temporary variable to store the timer value
            tmp_id = 'tmp' + str(out['tmpVars'][0])
Maxime Perrotin's avatar
Maxime Perrotin committed
515
            local_decl.append('{} : aliased asn1SccT_UInt32;'
516
                              .format(tmp_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
517
518
519
520
521
522
523
524
525
            code.append('{tmp} := {val};'.format(tmp=tmp_id, val=t_val))
            code.append("SET_{timer}({value}'access);"
                                             .format(timer=p_id, value=tmp_id))
            continue
        proc, out_sig = None, None
        try:
            out_sig, = [sig for sig in OUT_SIGNALS
                        if sig['name'].lower() == signal_name.lower()]
        except ValueError:
526
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
527
            try:
528
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
529
                            if sig.inputString.lower() == signal_name.lower()]
530
531
                if proc.external:
                    out_sig = proc
Maxime Perrotin's avatar
Maxime Perrotin committed
532
            except ValueError:
533
534
                # Not there? Impossible, the parser would have barked
                raise ValueError('Probably a bug - please report')
Maxime Perrotin's avatar
Maxime Perrotin committed
535
536
537
538
539
540
541
542
543
544
545
546
547
        if out_sig:
            list_of_params = []
            for idx, param in enumerate(out.get('params') or []):
                param_direction = 'in'
                try:
                    # If it is an output, there is a single parameter
                    param_type = out_sig['type']
                except TypeError:
                    # Else if it is a procedure, get the type
                    param_type = out_sig.fpar[idx]['type']
                    param_direction = out_sig.fpar[idx]['direction']

                typename = param_type.ReferencedTypeName.replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
548
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
549
550
551
                code.extend(p_code)
                local_decl.extend(p_local)
                # Create a temporary variable for input parameters only
Maxime Perrotin's avatar
Maxime Perrotin committed
552
553
                # (If needed, i.e. if argument is not a local variable)
                if param_direction == 'in' \
dbarbera's avatar
dbarbera committed
554
                        and (not (isinstance(param, ogAST.PrimVariable) and
Maxime Perrotin's avatar
Maxime Perrotin committed
555
                p_id.startswith('l_')) or isinstance(param, ogAST.PrimFPAR)):
556
557
558
559
560
561
562
                    tmp_id = out['tmpVars'][idx]
                    local_decl.append('tmp{idx} : aliased asn1Scc{oType};'
                                      .format(idx=tmp_id, oType=typename))
                    code.append('tmp{idx} := {p_id};'
                                .format(idx=tmp_id, p_id=p_id))
                    list_of_params.append("tmp{idx}'access"
                                          .format(idx=out['tmpVars'][idx]))
Maxime Perrotin's avatar
Maxime Perrotin committed
563
564
                else:
                    # Output parameters - no need for a temp variable
Maxime Perrotin's avatar
Maxime Perrotin committed
565
                    list_of_params.append(u"{var}'access".format(var=p_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
566
            if list_of_params:
Maxime Perrotin's avatar
Maxime Perrotin committed
567
                code.append(u'{RI}({params});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
568
569
                    RI=out['outputName'], params=', '.join(list_of_params)))
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
570
                code.append(u'{RI};'.format(RI=out['outputName']))
Maxime Perrotin's avatar
Maxime Perrotin committed
571
572
573
        else:
            # inner procedure call
            list_of_params = []
574
            for param in out.get('params', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
575
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
576
577
578
579
580
                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:
Maxime Perrotin's avatar
Maxime Perrotin committed
581
                code.append(u'{proc}({params});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
582
583
584
                    proc=proc.inputString,
                    params=', '.join(list_of_params)))
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
585
                code.append(u'{};'.format(proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
586
587
588
589
590
591
592
593
594
595
596
    return code, local_decl


@generate.register(ogAST.TaskAssign)
def _task_assign(task):
    ''' 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))
597
598
        # ExprAssign only returns code statements, no string
        code_assign, _, decl_assign = expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
599
        code.extend(code_assign)
600
        # code.append(ada_string[1:-1] + ';')
Maxime Perrotin's avatar
Maxime Perrotin committed
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
        local_decl.extend(decl_assign)
    return code, local_decl


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


@generate.register(ogAST.TaskForLoop)
def _task_forloop(task):
    '''
        Return the code corresponding to a for loop. Two forms are possible:
        for x in range ([start], stop [, step])
        for x in iterable (a SEQUENCE OF)
    '''
    stmt, local_decl = [], []
    if task.comment:
        stmt.extend(traceability(task.comment))
    stmt.extend(traceability(task))
    for loop in task.elems:
        if loop['range']:
            start_str, stop_str = '0', ''
            if loop['range']['start']:
Maxime Perrotin's avatar
Maxime Perrotin committed
630
                start_stmt, start_str, start_local = expression(
dbarbera's avatar
dbarbera committed
631
                                                    loop['range']['start'])
Maxime Perrotin's avatar
Maxime Perrotin committed
632
633
634
635
                local_decl.extend(start_local)
                stmt.extend(start_stmt)
            if loop['range']['step'] == 1:
                start_str += '..'
Maxime Perrotin's avatar
Maxime Perrotin committed
636
            stop_stmt, stop_str, stop_local = expression(loop['range']['stop'])
Maxime Perrotin's avatar
Maxime Perrotin committed
637
638
639
            local_decl.extend(stop_local)
            stmt.extend(stop_stmt)
            if loop['range']['step'] == 1:
Maxime Perrotin's avatar
Maxime Perrotin committed
640
641
642
643
                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
644
                stmt.append(
645
                        u'for {it} in {start}{stop} loop'
dbarbera's avatar
dbarbera committed
646
                        .format(it=loop['var'], start=start_str, stop=stop_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
647
648
649
            else:
                # Step is not directly supported in Ada, we need to use 'while'
                stmt.extend(['declare',
650
                             u'{it} : Integer := {start};'
Maxime Perrotin's avatar
Maxime Perrotin committed
651
652
653
654
                             .format(it=loop['var'],
                             start=start_str),
                             '',
                             'begin',
655
                             u'while {it} < {stop} loop'.format(it=loop['var'],
Maxime Perrotin's avatar
Maxime Perrotin committed
656
657
658
659
                                                               stop=stop_str)])
        else:
            # case of form: FOR x in SEQUENCE OF
            elem_type = loop['type'].ReferencedTypeName.replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
660
            list_stmt, list_str, list_local = expression(loop['list'])
Maxime Perrotin's avatar
Maxime Perrotin committed
661
            basic_type = find_basic_type(loop['list'].exprType)
662
            list_payload = list_str + string_payload(loop['list'], list_str)
663
664
665
666
667
            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
668
669
670
671
672
673
674
675
            stmt.extend(list_stmt)
            local_decl.extend(list_local)
            stmt.extend(['declare',
                         '{it} : asn1Scc{it_ty};'.format(it=loop['var'],
                                                         it_ty=elem_type),
                         '',
                         'begin',
                         'for {it}_idx in {rc} loop'.format(it=loop['var'],
676
                                                            rc=range_str),
677
678
                         '{it} := {var}({it}_idx);'.format(it=loop['var'],
                                                          var=list_payload)])
Maxime Perrotin's avatar
Maxime Perrotin committed
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
        try:
            code_trans, local_trans = generate(loop['transition'])
            if local_trans:
                stmt.append('declare')
                stmt.extend(local_trans)
                stmt.append('')
                stmt.append('begin')
            stmt.extend(code_trans)
            if local_trans:
                stmt.append('end;')
        except AttributeError:
            stmt.append('null;')
        if loop['range'] and loop['range']['step'] != 1:
            stmt.append('{it} := {it} + {step};'.format(it=loop['var'],
                                                   step=loop['range']['step']))
        stmt.append('end loop;')
        if (loop['range'] and loop['range']['step'] != 1) or loop['list']:
            stmt.append('end;')
    return stmt, local_decl


Maxime Perrotin's avatar
Maxime Perrotin committed
700
701
702
703
704
705
706
707
708
709
@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
710

Maxime Perrotin's avatar
Maxime Perrotin committed
711
@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
712
713
def _primary_variable(prim):
    ''' Single variable reference '''
Maxime Perrotin's avatar
Maxime Perrotin committed
714
    sep = u'l_' if find_var(prim.value[0]) else u''
Maxime Perrotin's avatar
Maxime Perrotin committed
715

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

718
719
    if prim.exprType.__name__ == 'for_range':
        # Ada iterator in FOR loops is an Integer - we must cast to 64 bits
720
        ada_string = u'Asn1Int({})'.format(ada_string)
721
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
722
723


724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
@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
739
                'Asn1Int' if ident == 'fix' else 'Asn1Real'
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
                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
762
763
        if min_length == max_length \
                and not isinstance(exp, ogAST.PrimSubstring):
764
765
            ada_string += min_length
        else:
766
767
768
769
770
            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))
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
    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
        exp_typename = \
                (getattr(exp.exprType, 'ReferencedTypeName',
                     None) or exp.exprType.kind).replace('-', '_')
        if exp_type.kind != 'ChoiceType':
            error = '{} is not a CHOICE'.format(exp.inputString)
            LOG.error(error)
            raise TypeError(error)
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        ada_string += ('asn1Scc{t}_Kind({e})'.format(
            t=exp_typename, e=param_str))
790
791
792
    elif ident == 'num':
        # User wants to get an enumerated corresponding integer value
        exp = params[0]
793
        #exp_type = find_basic_type(exp.exprType)
794
795
796
797
798
799
800
801
802
803
        # Get the ASN.1 type name as it is needed to build the Ada expression
        exp_typename = \
                (getattr(exp.exprType, 'ReferencedTypeName', None)
                        or exp.exprType.kind).replace('-', '_')
        param_stmts, param_str, local_var = expression(exp)
        local_decl.append('function num_{t} is new Ada.Unchecked_Conversion'
                          '(asn1scc{t}, Asn1Int);'.format(t=exp_typename))
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        ada_string += ('num_{t}({p})'.format(t=exp_typename, p=param_str))
dbarbera's avatar
dbarbera committed
804
    elif ident == 'floor':
805
806
807
        # Get the ASN.1 type name as it is needed to build the Ada expression
        exp = params[0]
        exp_typename = (getattr(exp.exprType, 'ReferencedTypeName', None)
808
                        or 'Long_Float').replace('-', '_')
809
810
811
812
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        ada_string += "{t}'Floor({p})".format(t=exp_typename, p=param_str)
dbarbera's avatar
dbarbera committed
813
    elif ident == 'ceil':
814
815
816
        # Get the ASN.1 type name as it is needed to build the Ada expression
        exp = params[0]
        exp_typename = (getattr(exp.exprType, 'ReferencedTypeName', None)
817
                        or 'Long_Float').replace('-', '_')
818
819
820
821
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        ada_string += "{t}'Ceiling({p})".format(t=exp_typename, p=param_str)
dbarbera's avatar
dbarbera committed
822
    elif ident == 'cos':
823
824
825
826
827
828
829
830
        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'
                          '(Long_Float);')
        ada_string += "Math.Cos({})".format(param_str)
dbarbera's avatar
dbarbera committed
831
    elif ident == 'round':
832
833
834
        exp = params[0]
        # Get the ASN.1 type name as it is needed to build the Ada expression
        exp_typename = (getattr(exp.exprType, 'ReferencedTypeName', None)
835
                        or 'Long_Float').replace('-', '_')
836
837
838
839
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        ada_string += "{t}'Rounding({p})".format(t=exp_typename, p=param_str)
dbarbera's avatar
dbarbera committed
840
    elif ident == 'sin':
841
842
843
844
845
846
847
848
        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'
                          '(Long_Float);')
        ada_string += "Math.Sin({})".format(param_str)
dbarbera's avatar
dbarbera committed
849
    elif ident == 'sqrt':
850
851
852
853
854
855
856
857
        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'
                          '(Long_Float);')
        ada_string += "Math.Sqrt({})".format(param_str)
dbarbera's avatar
dbarbera committed
858
    elif ident == 'trunc':
859
860
861
        exp = params[0]
        # Get the ASN.1 type name as it is needed to build the Ada expression
        exp_typename = (getattr(exp.exprType, 'ReferencedTypeName', None)
862
                        or 'Long_Float').replace('-', '_')
863
864
865
866
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
        ada_string += "{t}'Truncation({p})".format(t=exp_typename, p=param_str)
867
868
869
870
871
872
873
874
875
876
877
878
    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 += ')'

879
    return stmts, unicode(ada_string), local_decl
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897


@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
898
899
900
    if not isinstance(receiver, ogAST.PrimSubstring):
        ada_string += '.Data'
    ada_string += '({idx})'.format(idx=idx_string)
901
902
903
    stmts.extend(idx_stmts)
    local_decl.extend(idx_var)

904
    return stmts, unicode(ada_string), local_decl
905
906
907
908


@expression.register(ogAST.PrimSubstring)
def _prim_substring(prim):
909
    ''' Generate expression for SEQOF/OCT.STRING substrings, e.g. foo(1,2) '''
910
911
912
913
914
915
916
917
918
919
920
921
    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)

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

922
923
924
925
926
927
928
929
930
931
    # 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
932
933
934
    if not isinstance(receiver, ogAST.PrimSubstring):
        ada_string += '.Data'
    ada_string += '({r1}..{r2})'.format(r1=r1_string, r2=r2_string)
935
936
937
938
939
    stmts.extend(r1_stmts)
    stmts.extend(r2_stmts)
    local_decl.extend(r1_local)
    local_decl.extend(r2_local)

940
    return stmts, unicode(ada_string), local_decl
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958


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

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

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

    receiver_bty = find_basic_type(receiver.exprType)
    receiver_ty_name = receiver.exprType.ReferencedTypeName.replace('-', '_')

    if receiver_bty.kind == 'ChoiceType':
dbarbera's avatar
dbarbera committed
959
960
        ada_string = ('asn1Scc{typename}_{field_name}_get({ada_string})'.format(
            typename=receiver_ty_name, field_name=field_name, ada_string=ada_string))
961
962
963
    else:
        ada_string += '.' + field_name

Maxime Perrotin's avatar
Maxime Perrotin committed
964
    return stmts, unicode(ada_string), local_decl
965
966


Maxime Perrotin's avatar
Maxime Perrotin committed
967
968
969
970
971
972
973
974
975
976
@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
977
def _basic_operators(expr):
978
    ''' Expressions with two sides '''
Maxime Perrotin's avatar
Maxime Perrotin committed
979
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
980
981
    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
982
    ada_string = u'({left} {op} {right})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
983
984
985
986
987
            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
988
    return code, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
989

dbarbera's avatar
dbarbera committed
990

Maxime Perrotin's avatar
Maxime Perrotin committed
991
992
993
994
995
996
997
998
999
1000
@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)
    actual_type = getattr(expr.left.exprType,
                          'ReferencedTypeName',
                          None) or expr.left.exprType.kind
Maxime Perrotin's avatar
Maxime Perrotin committed
1001
1002
1003
1004
1005
1006
1007
    actual_type = actual_type.replace('-', '_')
    basic = find_basic_type(expr.left.exprType).kind in ('IntegerType',
                                                         'Integer32Type',
                                                         'BooleanType',
                                                         'RealType',
                                                         'EnumeratedType',
                                                        'ChoiceEnumeratedType')
Maxime Perrotin's avatar
Maxime Perrotin committed
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
    if basic:
        ada_string = u'({left} {op} {right})'.format(
                left=left_str, op=expr.operand, right=right_str)
    else:
        ada_string = u'asn1Scc{asn1}_Equal({left}, {right})'.format(
                            asn1=actual_type, left=left_str, right=right_str)
        if isinstance(expr, ogAST.ExprNeq):
            ada_string = u'not {}'.format(ada_string)
    return code, unicode(ada_string), local_decl


1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
@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)
    if basic_left.kind in ('SequenceOfType', 'OctetStringType') \
            and isinstance(expr.right, ogAST.PrimSubstring):
        strings.append(u"{lvar}.Data(1..{rvar}'Length) := {rvar};"
                       .format(lvar=left_str, rvar=right_str))
        if basic_left.Min != basic_left.Max:
            strings.append(u"{lvar}.Length := {rvar}'Length;"
                           .format(lvar=left_str, rvar=right_str))
    else:
        strings.append(u"{} := {};".format(left_str, right_str))
    code.extend(left_stmts)
    code.extend(right_stmts)
    code.extend(strings)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
    return code, '', local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1044

dbarbera's avatar
dbarbera committed
1045

Maxime Perrotin's avatar
Maxime Perrotin committed
1046
1047
1048
@expression.register(ogAST.ExprOr)
@expression.register(ogAST.ExprAnd)
@expression.register(ogAST.ExprXor)
dbarbera's avatar
dbarbera committed
1049
@expression.register(ogAST.ExprImplies)
1050
1051
1052
def _bitwise_operators(expr):
    ''' Logical operators '''
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
1053
1054
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
1055
1056
1057
1058
1059
    basic_type = find_basic_type(expr.exprType)
    if basic_type.kind != 'BooleanType':
        # Sequence of boolean or bit string
        if expr.right.is_raw:
            # Declare a temporary variable to store the raw value
Maxime Perrotin's avatar
Maxime Perrotin committed
1060
            tmp_string = u'tmp{}'.format(expr.right.tmpVar)
Maxime Perrotin's avatar
Maxime Perrotin committed
1061
            local_decl.append(u'{tmp} : aliased asn1Scc{eType};'.format(
1062
1063
1064
                        tmp=tmp_string,
                        eType=expr.right.exprType.ReferencedTypeName
                        .replace('-', '_')))
Maxime Perrotin's avatar
Maxime Perrotin committed
1065
            code.append(u'{tmp} := {right};'.format(tmp=tmp_string,
1066
1067
                                                  right=right_str))
            right_str = tmp_string
1068
1069
1070
1071
            right_payload = right_str + '.Data'
        else:
            right_payload = right_str + string_payload(expr.right, right_str)
        left_payload = left_str + string_payload(expr.left, left_str)
dbarbera's avatar
dbarbera committed
1072
1073
1074
1075
1076
1077

        if isinstance(expr, ogAST.ExprImplies):
            ada_string = u'(Data => (({left} and {right}) or not {left}))'\
                .format(left=left_payload, right=right_payload)
        else:
            ada_string = u'(Data => ({left} {op} {right}))'.format(
1078
                left=left_payload, op=expr.operand, right=right_payload)
dbarbera's avatar
dbarbera committed
1079
1080
1081
1082
1083
1084

    elif isinstance(expr, ogAST.ExprImplies):
        ada_string = u'(({left} and {right}) or not {left})'.format(
                                left=left_str,
                                right=right_str)

1085
    else:
1086
        ada_string = u'({left} {op}{short} {right})'.format(
dbarbera's avatar
dbarbera committed
1087
1088
1089
1090
                                left=left_str,
                                op=expr.operand,
                                short=expr.shortcircuit,
                                right=right_str)
1091
1092
1093
1094
    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
1095
    return code, unicode(ada_string), local_decl
dbarbera's avatar
dbarbera committed
1096
1097
1098


@expression.register(ogAST.ExprNot)
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
def _not_expression(expr):
    ''' Generate the code for a not expression '''
    code, local_decl = [], []
    expr_stmts, expr_str, expr_local = expression(expr.expr)

    basic_type = find_basic_type(expr.exprType)
    if basic_type.kind != 'BooleanType':
        expr_payload = expr_str + string_payload(expr.expr, expr_str)
        ada_string = u'(Data => (not {expr}))'.format(expr=expr_payload)
    else:
        ada_string = u'(not {expr})'.format(expr=expr_str)

    code.extend(expr_stmts)
    local_decl.extend(expr_local)
    return code, unicode(ada_string), local_decl


dbarbera's avatar
dbarbera committed
1116
@expression.register(ogAST.ExprNeg)
1117
1118
def _neg_expression(expr):
    ''' Generate the code for a negative expression '''
dbarbera's avatar
dbarbera committed
1119
1120
    code, local_decl = [], []
    expr_stmts, expr_str, expr_local = expression(expr.expr)
1121
    ada_string = u'(-{expr})'.format(op=expr.operand, expr=expr_str)
dbarbera's avatar
dbarbera committed
1122
1123
    code.extend(expr_stmts)
    local_decl.extend(expr_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
1124
    return code, unicode(ada_string), local_decl
1125

Maxime Perrotin's avatar
Maxime Perrotin committed
1126

Maxime Perrotin's avatar
Maxime Perrotin committed
1127
@expression.register(ogAST.ExprAppend)
Maxime Perrotin's avatar
Maxime Perrotin committed
1128
1129
1130
def _append(expr):
    ''' Generate code for the APPEND construct: a // b '''
    stmts, ada_string, local_decl = [], '', []
Maxime Perrotin's avatar
Maxime Perrotin committed
1131
1132
    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
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
    stmts.extend(left_stmts)
    stmts.extend(right_stmts)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
    # Declare a temporary variable to hold the result of the append
    ada_string = 'tmp{}'.format(expr.tmpVar)
    local_decl.append('{tmp} : aliased asn1Scc{eType};'.format(
                    tmp=ada_string,
                    eType=expr.exprType.ReferencedTypeName
                    .replace('-', '_')))

    # If right or left is raw, declare a temporary variable for it, too
    for sexp, sid in zip((expr.right, expr.left), (right_str, left_str)):
        if sexp.is_raw:
1147
            local_decl.append(u'tmp{idx} : aliased asn1Scc{eType};'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1148
1149
1150
                    idx=sexp.tmpVar,
                    eType=sexp.exprType.ReferencedTypeName
                    .replace('-', '_')))
1151
            stmts.append(u'tmp{idx} := {s_id};'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1152
                idx=sexp.tmpVar, s_id=sid))
1153
            sexp.sid = u'tmp' + unicode(sexp.tmpVar)
Maxime Perrotin's avatar
Maxime Perrotin committed
1154
1155
            # Length of raw string - update for sequence of
            if isinstance(sexp, ogAST.PrimStringLiteral):
1156
                sexp.slen = unicode(len(sexp.value[1:-1]))
Maxime Perrotin's avatar
Maxime Perrotin committed
1157
            elif isinstance(sexp, ogAST.PrimEmptyString):
1158
                sexp.slen = u'0'
Maxime Perrotin's avatar
Maxime Perrotin committed
1159
            elif isinstance(sexp, ogAST.PrimSequenceOf):
1160
                sexp.slen = unicode(len(sexp.value))
Maxime Perrotin's avatar
Maxime Perrotin committed
1161
1162
1163
1164
1165
1166
1167
            else:
                raise TypeError('Not a string/Sequence in APPEND')
        else:
            sexp.sid = sid
            basic = find_basic_type(sexp.exprType)
            if basic.Min == basic.Max:
                # Fixed-size string
1168
                sexp.slen = unicode(basic.Max)
Maxime Perrotin's avatar
Maxime Perrotin committed
1169
1170
            else:
                # Variable-size types have a Length field
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
                if isinstance(sexp, ogAST.PrimSubstring):
                    sexp.slen = u"{}'Length".format(sexp.sid)
                else:
                    sexp.slen = u'{}.Length'.format(sexp.sid)
    left_payload = expr.left.sid + string_payload(expr.left, expr.left.sid)
    right_payload = expr.right.sid + string_payload(expr.right, expr.right.sid)
    if unicode.isnumeric(expr.left.slen) \
            and unicode.isnumeric(expr.right.slen):
        length = unicode(int(expr.left.slen) + int(expr.right.slen))
    else:
1181
1182
        length = u'{} + {}'.format(expr.left.slen, expr.right.slen)
    stmts.append(u'{res}.Data(1 .. {length}) := {lid} & {rid};'
1183
1184
1185
1186
1187
1188
1189
                 .format(length=length,
                         res=ada_string,
                         lid=left_payload,
                         rid=right_payload))
    basic_tmp = find_basic_type(expr.exprType)
    if basic_tmp.Min != basic_tmp.Max:
        # Update lenght field of resulting variable (if variable size)
1190
        stmts.append(u'{}.Length := {};'.format(ada_string, length))
Maxime Perrotin's avatar
Maxime Perrotin committed
1191
    return stmts, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1192
1193


Maxime Perrotin's avatar
Maxime Perrotin committed
1194
@expression.register(ogAST.ExprIn)
Maxime Perrotin's avatar
Maxime Perrotin committed
1195
1196
1197
1198
1199
1200
1201
def _expr_in(expr):
    ''' IN expressions: check if item is in a SEQUENCE OF '''
    # Check if item is in a SEQUENCE OF
    # Temporary variable needed to hold the test result
    ada_string = 'tmp{}'.format(expr.tmpVar)
    stmts = []
    local_decl = ['{} : BOOLEAN := False;'.format(ada_string)]
Maxime Perrotin's avatar
Maxime Perrotin committed
1202
1203
    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
1204
1205
1206
1207
1208
1209
    stmts.extend(left_stmts)
    stmts.extend(right_stmts)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
    stmts.append("in_loop_{}:".format(ada_string))
    left_type = find_basic_type(expr.left.exprType)
1210
1211
1212
1213
1214
    if isinstance(expr.left, ogAST.PrimSubstring):
        len_str = u"{}'Length".format(left_str)
    else:
        len_str = u"{}.Length".format(left_str)
        left_str += u".Data"
Maxime Perrotin's avatar
Maxime Perrotin committed
1215
    if left_type.Min != left_type.Max:
1216
        stmts.append("for elem in 1..{} loop".format(len_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
1217
    else:
1218
1219
        stmts.append("for elem in {}'Range loop".format(left_str))
    stmts.append("if {container}(elem) = {pattern} then".format
Maxime Perrotin's avatar
Maxime Perrotin committed
1220
1221
1222
1223
1224
1225
            (container=left_str, pattern=right_str))
    stmts.append("{} := True;".format(ada_string))
    stmts.append("end if;")
    stmts.append("exit in_loop_{tmp} when {tmp} = True;"
                  .format(tmp=ada_string))
    stmts.append("end loop in_loop_{};".format(ada_string))
Maxime Perrotin's avatar
Maxime Perrotin committed
1226
    return stmts, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1227
1228


Maxime Perrotin's avatar
Maxime Perrotin committed
1229
@expression.register(ogAST.PrimEnumeratedValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
1230
1231
1232
1233
def _enumerated_value(primary):
    ''' Generate code for an enumerated value '''
    enumerant = primary.value[0].replace('_', '-')
    basic = find_basic_type(primary.exprType)
Maxime Perrotin's avatar
Maxime Perrotin committed
1234
1235
    ada_string = (u'asn1Scc' + basic.EnumValues[enumerant].EnumID)
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1236
1237


Maxime Perrotin's avatar
Maxime Perrotin committed
1238
@expression.register(ogAST.PrimChoiceDeterminant)
Maxime Perrotin's avatar
Maxime Perrotin committed
1239
1240
1241
1242
def _choice_determinant(primary):
    ''' Generate code for a choice determinant (enumerated) '''
    enumerant = primary.value[0].replace('_', '-')
    ada_string = primary.exprType.EnumValues[enumerant].EnumID
Maxime Perrotin's avatar
Maxime Perrotin committed
1243
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1244
1245


Maxime Perrotin's avatar
Maxime Perrotin committed
1246
1247
@expression.register(ogAST.PrimInteger)
@expression.register(ogAST.PrimReal)
1248
1249
def _integer(primary):
    ''' Generate code for a raw numerical value  '''
dbarbera's avatar
dbarbera committed
1250
    if float(primary.value[0]) < 0:
Maxime Perrotin's avatar
Maxime Perrotin committed
1251
1252
1253
        # Parentesize negative integers for maintaining
        # the precedence in the generated code
        ada_string = u'({})'.format(primary.value[0])
dbarbera's avatar
dbarbera committed
1254
1255
    else:
        ada_string = primary.value[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1256
    return [], unicode(ada_string), []
1257
1258


Maxime Perrotin's avatar
Maxime Perrotin committed
1259
@expression.register(ogAST.PrimBoolean)
dbarbera's avatar
dbarbera committed
1260
def _boolean(primary