AdaGenerator.py 77.2 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
UNICODE_SEP = u'\u00dc'
Maxime Perrotin's avatar
Maxime Perrotin committed
91
92

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


Maxime Perrotin's avatar
Maxime Perrotin committed
99
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
100
@generate.register(ogAST.Process)
101
def _process(process, simu=False, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
102
103
104
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)

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

113
    # In case model has nested states, flatten everything
114
    Helper.flatten(process, sep=UNICODE_SEP)
115

Maxime Perrotin's avatar
Maxime Perrotin committed
116
117
118
119
    # 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
120
121
122
123
124
125
126
127
    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
128
            dst, dstr, dlocal = expression(def_value)
129
130
131
            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
132
133
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
134
135
136
137
                        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
138

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

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

Maxime Perrotin's avatar
Maxime Perrotin committed
152
    # Add function allowing to trace current state as a string
153
154
    #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
155
    #                                                    .format(process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
156
157

    # Add the declaration of the runTransition procedure
158
    process_level_decl.append('procedure runTransition(Id: Integer);')
Maxime Perrotin's avatar
Maxime Perrotin committed
159
160

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

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

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

Maxime Perrotin's avatar
Maxime Perrotin committed
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
{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,
196
                                    dataview=asn1_modules)]
Maxime Perrotin's avatar
Maxime Perrotin committed
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

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

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

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

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

    # for the .ads file, generate the declaration of the external procedures
298
299
    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
300
301
        params = []
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
302
303
304
305
            typename = type_name(param['type'])
            params.append(u'{par[name]}: access {sort}'
                          .format(par=param,
                                  sort=typename))
Maxime Perrotin's avatar
Maxime Perrotin committed
306
        if params:
Maxime Perrotin's avatar
Maxime Perrotin committed
307
            ri_header += u'(' + u';'.join(params) + ')'
Maxime Perrotin's avatar
Maxime Perrotin committed
308
        ads_template.append(
dbarbera's avatar
dbarbera committed
309
                        u'--  Sync required interface "' + proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
310
311
        ads_template.append(ri_header + u';')
        ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
312
313
314
315
316
                .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
317
                u'--  Timer {} SET and RESET functions'.format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
318
        ads_template.append(u'procedure SET_{}(val: access asn1SccT_UInt32);'
Maxime Perrotin's avatar
Maxime Perrotin committed
319
320
                .format(timer))
        ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
321
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
322
                .format(timer=timer, proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
323
        ads_template.append(u'procedure RESET_{};'.format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
324
        ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
325
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
326
327
                .format(timer=timer, proc=process_name))

328
329
330
    taste_template.append('procedure runTransition(Id: Integer) is')
    taste_template.append('trId : Integer := Id;')

331
332
333
334
335
336
    # 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;')

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

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

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

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

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

    # Code of the function allowing to trace current state
394
395
396
397
398
    #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
399
400
401
402
403
404
405
406
407

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

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


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
423
424
425
426
427
428
429
430
431
    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
432
433
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
434
435
            code.append(u'Put("{}");'
                        .format(param.value[1:-1].replace('"', "'")))
Maxime Perrotin's avatar
Maxime Perrotin committed
436
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
437
            code, string, local = expression(param)
438
439
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
440
                sep = UNICODE_SEP
441
                last_it = u""
442
443
                if isinstance(param, ogAST.PrimSubstring):
                    range_str = u"{}'Range".format(string)
444
                    iterator = u"i - {}'First + 1".format(string)
445
446
447
                elif basic_type.Min == basic_type.Max:
                    range_str = u"{}.Data'Range".format(string)
                    string += u".Data"
448
                    iterator = u"i"
449
450
451
                else:
                    range_str = u"1 .. {}.Length".format(string)
                    string += u".Data"
452
453
                    iterator = u"i"
                    last_it = u"({})".format(range_str)
454
                code.extend([u"for i in {} loop".format(range_str),
455
456
                             u"Put(Character'Val({st}(i)));"
                             .format(st=string, sep=sep, it=iterator),
457
                             u"end loop;"])
458
459
            else:
                code.append("Put({});".format(string))
Maxime Perrotin's avatar
Maxime Perrotin committed
460
461
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
462
        code, string, local = expression(param)
dbarbera's avatar
dbarbera committed
463
        if type_kind in ('IntegerType', 'Integer32Type'):
464
            cast = "Asn1Int"
Maxime Perrotin's avatar
Maxime Perrotin committed
465
466
467
468
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
469
        code.append(u"Put({cast}'Image({s}));".format(cast=cast, s=string))
Maxime Perrotin's avatar
Maxime Perrotin committed
470
    else:
471
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
472
473
474
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
475
476
    if newline:
        code.append(u"New_Line;")
Maxime Perrotin's avatar
Maxime Perrotin committed
477
478
479
480
481
    return code, string, local


@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
482
def _call_external_function(output, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
    ''' 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
511
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
512
513
514
515
516
517
518
            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
519
520
            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
521
522
523
524
525
526
            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
527
            local_decl.append('{} : aliased asn1SccT_UInt32;'
528
                              .format(tmp_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
529
530
531
532
533
534
535
536
537
            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:
538
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
539
            try:
540
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
541
                            if sig.inputString.lower() == signal_name.lower()]
542
543
                if proc.external:
                    out_sig = proc
Maxime Perrotin's avatar
Maxime Perrotin committed
544
            except ValueError:
545
                # Not there? Impossible, the parser would have barked
546
                raise ValueError(u'Probably a bug - please report')
Maxime Perrotin's avatar
Maxime Perrotin committed
547
548
549
550
551
552
553
554
555
556
557
558
        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
559
                typename = type_name(param_type)
Maxime Perrotin's avatar
Maxime Perrotin committed
560
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
561
562
563
                code.extend(p_code)
                local_decl.extend(p_local)
                # Create a temporary variable for input parameters only
Maxime Perrotin's avatar
Maxime Perrotin committed
564
565
                # (If needed, i.e. if argument is not a local variable)
                if param_direction == 'in' \
566
567
568
                        and (not (isinstance(param, ogAST.PrimVariable)
                        and p_id.startswith('l_'))
                        or isinstance(param, ogAST.PrimFPAR)):
569
                    tmp_id = out['tmpVars'][idx]
Maxime Perrotin's avatar
Maxime Perrotin committed
570
571
                    local_decl.append('tmp{idx} : aliased {sort};'
                                      .format(idx=tmp_id, sort=typename))
572
573
574
575
                    if isinstance(param,
                              (ogAST.PrimSequenceOf, ogAST.PrimStringLiteral)):
                        p_id = array_content(param, p_id,
                                             find_basic_type(param_type))
576
577
578
579
                    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
580
581
                else:
                    # Output parameters - no need for a temp variable
Maxime Perrotin's avatar
Maxime Perrotin committed
582
                    list_of_params.append(u"{var}'access".format(var=p_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
583
            if list_of_params:
Maxime Perrotin's avatar
Maxime Perrotin committed
584
                code.append(u'{RI}({params});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
585
586
                    RI=out['outputName'], params=', '.join(list_of_params)))
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
587
                code.append(u'{RI};'.format(RI=out['outputName']))
Maxime Perrotin's avatar
Maxime Perrotin committed
588
589
590
        else:
            # inner procedure call
            list_of_params = []
591
            for param in out.get('params', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
592
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
593
594
595
596
597
                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:
598
599
                code.append(u'p{sep}{proc}({params});'.format(
                    sep=UNICODE_SEP,
Maxime Perrotin's avatar
Maxime Perrotin committed
600
601
602
                    proc=proc.inputString,
                    params=', '.join(list_of_params)))
            else:
603
                code.append(u'p{}{};'.format(UNICODE_SEP, proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
604
605
606
607
    return code, local_decl


@generate.register(ogAST.TaskAssign)
608
def _task_assign(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
609
610
611
612
613
614
    ''' 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))
615
616
        # ExprAssign only returns code statements, no string
        code_assign, _, decl_assign = expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
617
618
619
620
621
622
        code.extend(code_assign)
        local_decl.extend(decl_assign)
    return code, local_decl


@generate.register(ogAST.TaskInformalText)
623
def _task_informal_text(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
624
625
626
627
628
629
630
631
632
    ''' 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)
633
def _task_forloop(task, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
634
635
636
637
638
639
640
641
642
643
644
645
646
    '''
        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
647
                start_stmt, start_str, start_local = expression(
dbarbera's avatar
dbarbera committed
648
                                                    loop['range']['start'])
Maxime Perrotin's avatar
Maxime Perrotin committed
649
650
651
652
                local_decl.extend(start_local)
                stmt.extend(start_stmt)
            if loop['range']['step'] == 1:
                start_str += '..'
Maxime Perrotin's avatar
Maxime Perrotin committed
653
            stop_stmt, stop_str, stop_local = expression(loop['range']['stop'])
Maxime Perrotin's avatar
Maxime Perrotin committed
654
655
656
            local_decl.extend(stop_local)
            stmt.extend(stop_stmt)
            if loop['range']['step'] == 1:
Maxime Perrotin's avatar
Maxime Perrotin committed
657
658
659
660
                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
661
                stmt.append(
662
                        u'for {it} in {start}{stop} loop'
dbarbera's avatar
dbarbera committed
663
                        .format(it=loop['var'], start=start_str, stop=stop_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
664
665
666
            else:
                # Step is not directly supported in Ada, we need to use 'while'
                stmt.extend(['declare',
667
                             u'{it} : Integer := {start};'
Maxime Perrotin's avatar
Maxime Perrotin committed
668
669
670
671
                             .format(it=loop['var'],
                             start=start_str),
                             '',
                             'begin',
672
                             u'while {it} < {stop} loop'.format(it=loop['var'],
Maxime Perrotin's avatar
Maxime Perrotin committed
673
674
675
                                                               stop=stop_str)])
        else:
            # case of form: FOR x in SEQUENCE OF
Maxime Perrotin's avatar
Maxime Perrotin committed
676
            list_stmt, list_str, list_local = expression(loop['list'])
Maxime Perrotin's avatar
Maxime Perrotin committed
677
            basic_type = find_basic_type(loop['list'].exprType)
678
            list_payload = list_str + string_payload(loop['list'], list_str)
679
680
681
682
683
            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
684
685
686
            stmt.extend(list_stmt)
            local_decl.extend(list_local)
            stmt.extend(['declare',
687
688
                         '{} : {};'.format(loop['var'],
                                           type_name(loop['type'])),
Maxime Perrotin's avatar
Maxime Perrotin committed
689
690
691
                         '',
                         'begin',
                         'for {it}_idx in {rc} loop'.format(it=loop['var'],
692
                                                            rc=range_str),
693
694
                         '{it} := {var}({it}_idx);'.format(it=loop['var'],
                                                          var=list_payload)])
Maxime Perrotin's avatar
Maxime Perrotin committed
695
696
697
698
        try:
            code_trans, local_trans = generate(loop['transition'])
            if local_trans:
                stmt.append('declare')
699
                stmt.extend(set(local_trans))
Maxime Perrotin's avatar
Maxime Perrotin committed
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
                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
716
717
718
719
720
721
722
723
724
725
@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
726

Maxime Perrotin's avatar
Maxime Perrotin committed
727
@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
728
729
def _primary_variable(prim):
    ''' Single variable reference '''
Maxime Perrotin's avatar
Maxime Perrotin committed
730
    sep = u'l_' if find_var(prim.value[0]) else u''
Maxime Perrotin's avatar
Maxime Perrotin committed
731

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

734
735
    if prim.exprType.__name__ == 'for_range':
        # Ada iterator in FOR loops is an Integer - we must cast to 64 bits
736
        ada_string = u'Asn1Int({})'.format(ada_string)
737
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
738
739


740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
@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
755
                'Asn1Int' if ident == 'fix' else 'Asn1Real'
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
                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
778
779
        if min_length == max_length \
                and not isinstance(exp, ogAST.PrimSubstring):
780
781
            ada_string += min_length
        else:
782
783
784
785
786
            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))
787
788
789
790
791
792
793
    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
794
        exp_typename = type_name(exp.exprType)
795
796
797
798
799
800
801
        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
802
803
804
        ada_string += ('{sort}_Kind({e})'
                       .format(sort=exp_typename,
                               e=param_str))
805
806
807
    elif ident == 'num':
        # User wants to get an enumerated corresponding integer value
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
808
        exp_typename = type_name(exp.exprType)
809
        param_stmts, param_str, local_var = expression(exp)
Maxime Perrotin's avatar
Maxime Perrotin committed
810
811
        local_decl.append('function num_{sort} is new Ada.Unchecked_Conversion'
                          '({sort}, Asn1Int);'.format(sort=exp_typename))
812
813
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
814
815
816
        ada_string += ('num_{sort}({p})'
                       .format(sort=exp_typename,
                               p=param_str))
dbarbera's avatar
dbarbera committed
817
    elif ident == 'floor':
818
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
819
        exp_typename = type_name(exp.exprType)
820
821
822
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
823
824
        ada_string += "{sort}'Floor({p})".format(sort=exp_typename,
                                                 p=param_str)
dbarbera's avatar
dbarbera committed
825
    elif ident == 'ceil':
826
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
827
        exp_typename = type_name(exp.exprType)
828
829
830
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
831
832
        ada_string += "{sort}'Ceiling({p})".format(sort=exp_typename,
                                                   p=param_str)
dbarbera's avatar
dbarbera committed
833
    elif ident == 'cos':
834
835
836
837
838
839
        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
840
                          '(Asn1Real);')
841
        ada_string += "Math.Cos({})".format(param_str)
dbarbera's avatar
dbarbera committed
842
    elif ident == 'round':
843
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
844
        exp_typename = type_name(exp.exprType)
845
846
847
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
848
849
        ada_string += "{sort}'Rounding({p})".format(sort=exp_typename,
                                                    p=param_str)
dbarbera's avatar
dbarbera committed
850
    elif ident == 'sin':
851
852
853
854
855
856
        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
857
                          '(Asn1Real);')
858
        ada_string += "Math.Sin({})".format(param_str)
dbarbera's avatar
dbarbera committed
859
    elif ident == 'sqrt':
860
861
862
863
864
865
        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
866
                          '(Asn1Real);')
867
        ada_string += "Math.Sqrt({})".format(param_str)
dbarbera's avatar
dbarbera committed
868
    elif ident == 'trunc':
869
        exp = params[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
870
        exp_typename = type_name(exp.exprType)
871
872
873
        param_stmts, param_str, local_var = expression(exp)
        stmts.extend(param_stmts)
        local_decl.extend(local_var)
Maxime Perrotin's avatar
Maxime Perrotin committed
874
875
        ada_string += "{sort}'Truncation({p})".format(sort=exp_typename,
                                                      p=param_str)
876
877
878
879
880
881
882
883
884
885
886
887
    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 += ')'

888
    return stmts, unicode(ada_string), local_decl
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906


@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
907
908
909
    if not isinstance(receiver, ogAST.PrimSubstring):
        ada_string += '.Data'
    ada_string += '({idx})'.format(idx=idx_string)
910
911
912
    stmts.extend(idx_stmts)
    local_decl.extend(idx_var)

913
    return stmts, unicode(ada_string), local_decl
914
915
916
917


@expression.register(ogAST.PrimSubstring)
def _prim_substring(prim):
918
    ''' Generate expression for SEQOF/OCT.STRING substrings, e.g. foo(1,2) '''
919
920
921
922
    stmts, ada_string, local_decl = [], '', []

    receiver = prim.value[0]

923
924
    receiver_stms, receiver_string, receiver_decl = expression(receiver)
    ada_string = receiver_string
925
926
927
928
929
930
    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])

931
932
933
934
935
936
937
938
939
940
    # 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
941
942
943
    if not isinstance(receiver, ogAST.PrimSubstring):
        ada_string += '.Data'
    ada_string += '({r1}..{r2})'.format(r1=r1_string, r2=r2_string)
944
945
946
947
948
    stmts.extend(r1_stmts)
    stmts.extend(r2_stmts)
    local_decl.extend(r1_local)
    local_decl.extend(r2_local)

949
    return stmts, unicode(ada_string), local_decl
950
951
952
953


@expression.register(ogAST.PrimSelector)
def _prim_selector(prim):
Maxime Perrotin's avatar
Maxime Perrotin committed
954
    ''' Selector (field access with '!' separation) '''
955
956
957
958
959
    stmts, ada_string, local_decl = [], '', []

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

960
961
    receiver_stms, receiver_string, receiver_decl = expression(receiver)
    ada_string = receiver_string
962
963
964
965
966
967
    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
968
969
        ada_string = ('{sort}_{field_name}_get({ada_string})'
                    .format(sort=type_name(receiver.exprType),
970
971
                            field_name=field_name,
                            ada_string=ada_string))
972
973
974
    else:
        ada_string += '.' + field_name

Maxime Perrotin's avatar
Maxime Perrotin committed
975
    return stmts, unicode(ada_string), local_decl
976
977


Maxime Perrotin's avatar
Maxime Perrotin committed
978
979
980
981
982
983
984
985
986
987
@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
988
def _basic_operators(expr):
989
    ''' Expressions with two sides '''
Maxime Perrotin's avatar
Maxime Perrotin committed
990
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
991
992
    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
993
    ada_string = u'({left} {op} {right})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
994
995
996
997
998
            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
999
    return code, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1000

dbarbera's avatar
dbarbera committed
1001

Maxime Perrotin's avatar
Maxime Perrotin committed
1002
1003
1004
1005
1006
1007
1008
@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
1009
1010
    asn1_type = getattr(expr.left.exprType, 'ReferencedTypeName', None)
    actual_type = type_name(expr.left.exprType)
1011
1012
1013
    lbty = find_basic_type(expr.left.exprType)
    basic = lbty.kind in ('IntegerType', 'Integer32Type', 'BooleanType',
                          'RealType', 'EnumeratedType', 'ChoiceEnumeratedType')
Maxime Perrotin's avatar
Maxime Perrotin committed
1014
1015
1016
1017
    if basic:
        ada_string = u'({left} {op} {right})'.format(
                left=left_str, op=expr.operand, right=right_str)
    else:
1018
1019
1020
1021
        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
1022
1023
            ada_string = u'{sort}_Equal({left}, {right})'.format(
                           sort=actual_type, left=left_str, right=right_str)
1024
1025
1026
1027
        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
1028
1029
1030
1031
1032
        if isinstance(expr, ogAST.ExprNeq):
            ada_string = u'not {}'.format(ada_string)
    return code, unicode(ada_string), local_decl


1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
@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)
1043
1044
1045
1046
    if basic_left.kind in ('SequenceOfType', 'OctetStringType'):
        rlen = "{}'Length".format(right_str)
        if isinstance(expr.right, ogAST.PrimSubstring):
            strings.append(u"{lvar}.Data(1..{rvar}'Length) := {rvar};"
1047
                       .format(lvar=left_str, rvar=right_str))
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
        elif isinstance(expr.right, ogAST.ExprAppend):
            basic_right = find_basic_type(expr.right.exprType)
            rlen = append_size(expr.right)
            strings.append(u"{lvar}.Data(1..{lstr}) := {rvar};"
                           .format(lvar=left_str,
                                   rvar=right_str,
                                   lstr=rlen))
        elif isinstance(expr.right, (ogAST.PrimSequenceOf,
                                    ogAST.PrimStringLiteral)):
            strings.append(u"{lvar} := {value};"
                           .format(lvar=left_str,
                                   value=array_content(expr.right,
                                                       right_str,
                                                       basic_left)))
            rlen = None
        else:
            # Right part is a variable
            strings.append(u"{} := {};".format(left_str, right_str))
            rlen = None
        if rlen and basic_left.Min != basic_left.Max:
            strings.append(u"{lvar}.Length := {rlen};"
                           .format(lvar=left_str, rlen=rlen))
1070
1071
1072
1073
1074
1075
1076
1077
    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
1078

dbarbera's avatar
dbarbera committed
1079

Maxime Perrotin's avatar
Maxime Perrotin committed
1080
1081
1082
@expression.register(ogAST.ExprOr)
@expression.register(ogAST.ExprAnd)
@expression.register(ogAST.ExprXor)
dbarbera's avatar
dbarbera committed
1083
@expression.register(ogAST.ExprImplies)
1084
1085
1086
def _bitwise_operators(expr):
    ''' Logical operators '''
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
1087
1088
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
1089
1090
1091
1092
1093
    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
1094
            tmp_string = u'tmp{}'.format(expr.right.tmpVar)
Maxime Perrotin's avatar
Maxime Perrotin committed
1095
            local_decl.append(u'{tmp} : aliased {sort};'.format(
1096
                        tmp=tmp_string,
Maxime Perrotin's avatar
Maxime Perrotin committed
1097
                        sort=type_name(expr.right.exprType)))
Maxime Perrotin's avatar
Maxime Perrotin committed
1098
            code.append(u'{tmp} := {right};'.format(tmp=tmp_string,
1099
1100
                                                  right=right_str))
            right_str = tmp_string
1101
1102
1103
1104
            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
1105
1106
1107
1108
1109
1110

        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(
1111
                left=left_payload, op=expr.operand, right=right_payload)
dbarbera's avatar
dbarbera committed
1112
1113
1114
1115
1116
1117

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

1118
    else:
1119
        ada_string = u'({left} {op}{short} {right})'.format(
dbarbera's avatar
dbarbera committed
1120
1121
1122
1123
                                left=left_str,
                                op=expr.operand,
                                short=expr.shortcircuit,
                                right=right_str)
1124
1125
1126
1127
    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
1128
    return code, unicode(ada_string), local_decl
dbarbera's avatar
dbarbera committed
1129
1130
1131


@expression.register(ogAST.ExprNot)
1132
1133
1134
def _not_expression(expr):
    ''' Generate the code for a not expression '''
    code, local_decl = [], []
1135
1136
1137
1138
    if isinstance(expr.expr, ogAST.PrimSequenceOf):
        # Raw sequence of boolean (e.g. not "{true, false}") -> flip values
        for each in expr.expr.value:
            each.value[0] = 'true' if each.value[0] == 'false' else 'false'
1139
1140
    expr_stmts, expr_str, expr_local = expression(expr.expr)

1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
    bty_inner = find_basic_type(expr.expr.exprType)
    bty_outer = find_basic_type(expr.exprType)
    if bty_outer.kind != 'BooleanType':
        if bty_outer.Min == bty_outer.Max:
            size_expr = ''
        elif bty_inner.Min == bty_inner.Max:
            size_expr = ', Length => {}'.format(bty_inner.Min)
        else:
            size_expr = ', Length => {}.Length'.format(expr_str)
        if isinstance(expr.expr, ogAST.PrimSequenceOf):
            ada_string = array_content(expr.expr, expr_str, bty_outer)
        else:
            ada_string = u'(Data => (not {}.Data){})'.format(expr_str,
                                                             size_expr)
1155
1156
1157
1158
1159
1160
1161
1162
    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
1163
@expression.register(ogAST.ExprNeg)
1164
1165
def _neg_expression(expr):
    ''' Generate the code for a negative expression '''
dbarbera's avatar
dbarbera committed
1166
1167
    code, local_decl = [], []
    expr_stmts, expr_str, expr_local = expression(expr.expr)
1168
    ada_string = u'(-{expr})'.format(op=expr.operand, expr=expr_str)
dbarbera's avatar
dbarbera committed
1169
1170
    code.extend(expr_stmts)
    local_decl.extend(expr_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
1171
    return code, unicode(ada_string), local_decl
1172

Maxime Perrotin's avatar
Maxime Perrotin committed
1173

Maxime Perrotin's avatar
Maxime Perrotin committed
1174
@expression.register(ogAST.ExprAppend)
Maxime Perrotin's avatar
Maxime Perrotin committed
1175
1176
1177
def _append(expr):
    ''' Generate code for the APPEND construct: a // b '''
    stmts, ada_string, local_decl = [], '', []
Maxime Perrotin's avatar
Maxime Perrotin committed
1178
1179
    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
1180
1181
1182
1183
    stmts.extend(left_stmts)
    stmts.extend(right_stmts)
    local_decl.extend(left_local)
    local_decl.extend(right_local)
1184
1185
1186
1187
1188
1189

    left = '{}{}'.format(left_str, string_payload(expr.left, left_str) if
                    isinstance(expr.left, (ogAST.PrimVariable,
                                           ogAST.PrimConstant)) else '')
    right = '{}{}'.format(right_str, string_payload(expr.right, right_str) if
                    isinstance(expr.right, (ogAST.PrimVariable,
1190
                                            ogAST.PrimConditional,
1191
1192
1193
1194
                                            ogAST.PrimConstant)) else '')

    ada_string = '(({}) & ({}))'.format(left, right)

Maxime Perrotin's avatar
Maxime Perrotin committed
1195
    return stmts, unicode(ada_string), local_decl