AdaGenerator.py 64.7 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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
    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;

{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,
192
                                    dataview=asn1_modules)]
Maxime Perrotin's avatar
Maxime Perrotin committed
193
194
195
196
197
198
199
200
201
202
203

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

204
    # Generate the code for the start procedure
205
206
207
208
209
    #taste_template.extend([
    #    'procedure state_start is',
    #    'begin',
    #        'null;',
    #    'end state_start;', ''])
210

Maxime Perrotin's avatar
Maxime Perrotin committed
211
212
213
214
215
216
    # 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
217
        if signal.get('name', u'START') == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
218
219
220
221
222
223
224
            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
225
                                        pName=param_name, pType=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
226
227
228
229

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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
429
            string = '"' + param.value[1:-1].replace('"', "'") + '"'
Maxime Perrotin's avatar
Maxime Perrotin committed
430
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
431
            code, string, local = expression(param)
432
433
434
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
                sep = u'\u00dc'
435
436
437
438
439
440
441
442
443
                localstr = u'tmp{}{}str'.format(str(param.tmpVar), sep)
                local.append(u'{} : String(1 .. {});'
                             .format(localstr, basic_type.Max))
                range_len = u"{}.Data'Range".format(string) \
                                if basic_type.Min == basic_type.Max \
                                else "1 .. {}.Length".format(string)
                code.extend([u"for i in {} loop".format(range_len),
                             u"{tmp}(i) := Character'Val({st}.Data(i));"
                             .format(tmp=localstr, st=string, sep=sep),
444
                             u"end loop;"])
445
                if basic_type.Min != basic_type.Max:
dbarbera's avatar
dbarbera committed
446
                        code.extend(["if {string}.Length < {to} then"
447
448
449
450
451
452
453
                                     .format(string=string, to=basic_type.Max),
                         u"{tmp}({string}.Length + 1 .. {to}) "
                         u":= (others=>Character'Val(0));"
                                 .format(tmp=localstr,
                                         string=string,
                                         to=basic_type.Max),
                                 "end if;"])
454
                string = u'{}({})'.format(localstr, range_len)
Maxime Perrotin's avatar
Maxime Perrotin committed
455
456
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
457
        code, string, local = expression(param)
dbarbera's avatar
dbarbera committed
458
        if type_kind in ('IntegerType', 'Integer32Type'):
459
            cast = "Asn1Int"
Maxime Perrotin's avatar
Maxime Perrotin committed
460
461
462
463
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
Maxime Perrotin's avatar
Maxime Perrotin committed
464
        string = u"{cast}'Image({s})".format(cast=cast, s=string)
Maxime Perrotin's avatar
Maxime Perrotin committed
465
    else:
466
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
467
468
469
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
Maxime Perrotin's avatar
Maxime Perrotin committed
470
471
    code.append(u'Put{line}({string});'.format(
        line=u'_Line' if newline else u'',
Maxime Perrotin's avatar
Maxime Perrotin committed
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
499
500
501
502
503
504
505
506
        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
507
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
508
509
510
511
512
513
514
            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
515
516
            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
517
518
519
520
521
522
            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])
523
524
            local_decl.append('{} : aliased Asn1Int;'
                              .format(tmp_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
525
526
527
528
529
530
531
532
533
            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:
534
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
535
            try:
536
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
537
                            if sig.inputString.lower() == signal_name.lower()]
538
539
                if proc.external:
                    out_sig = proc
Maxime Perrotin's avatar
Maxime Perrotin committed
540
            except ValueError:
541
542
                # Not there? Impossible, the parser would have barked
                raise ValueError('Probably a bug - please report')
Maxime Perrotin's avatar
Maxime Perrotin committed
543
544
545
546
547
548
549
550
551
552
553
554
555
        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
556
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
557
558
559
                code.extend(p_code)
                local_decl.extend(p_local)
                # Create a temporary variable for input parameters only
Maxime Perrotin's avatar
Maxime Perrotin committed
560
561
                # (If needed, i.e. if argument is not a local variable)
                if param_direction == 'in' \
dbarbera's avatar
dbarbera committed
562
                        and (not (isinstance(param, ogAST.PrimVariable) and
Maxime Perrotin's avatar
Maxime Perrotin committed
563
                p_id.startswith('l_')) or isinstance(param, ogAST.PrimFPAR)):
564
565
566
567
568
569
570
                    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
571
572
                else:
                    # Output parameters - no need for a temp variable
Maxime Perrotin's avatar
Maxime Perrotin committed
573
                    list_of_params.append(u"{var}'access".format(var=p_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
574
            if list_of_params:
Maxime Perrotin's avatar
Maxime Perrotin committed
575
                code.append(u'{RI}({params});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
576
577
                    RI=out['outputName'], params=', '.join(list_of_params)))
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
578
                code.append(u'{RI};'.format(RI=out['outputName']))
Maxime Perrotin's avatar
Maxime Perrotin committed
579
580
581
        else:
            # inner procedure call
            list_of_params = []
582
            for param in out.get('params', []):
Maxime Perrotin's avatar
Maxime Perrotin committed
583
                p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
584
585
586
587
588
                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
589
                code.append(u'{proc}({params});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
590
591
592
                    proc=proc.inputString,
                    params=', '.join(list_of_params)))
            else:
Maxime Perrotin's avatar
Maxime Perrotin committed
593
                code.append(u'{};'.format(proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
594
595
596
597
598
599
600
601
602
603
604
605
    return code, local_decl


@generate.register(ogAST.TaskAssign)
def _task_assign(task):
    ''' A list of assignments in a task symbol '''
    code, local_decl = [], []
    ada_string = ''
    if task.comment:
        code.extend(traceability(task.comment))
    for expr in task.elems:
        code.extend(traceability(expr))
Maxime Perrotin's avatar
Maxime Perrotin committed
606
        code_assign, ada_string, decl_assign = expression(expr)
Maxime Perrotin's avatar
Maxime Perrotin committed
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
        code.extend(code_assign)
        code.append(ada_string[1:-1] + ';')
        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
638
                start_stmt, start_str, start_local = expression(
dbarbera's avatar
dbarbera committed
639
                                                    loop['range']['start'])
Maxime Perrotin's avatar
Maxime Perrotin committed
640
641
642
643
                local_decl.extend(start_local)
                stmt.extend(start_stmt)
            if loop['range']['step'] == 1:
                start_str += '..'
Maxime Perrotin's avatar
Maxime Perrotin committed
644
            stop_stmt, stop_str, stop_local = expression(loop['range']['stop'])
Maxime Perrotin's avatar
Maxime Perrotin committed
645
646
647
            local_decl.extend(stop_local)
            stmt.extend(stop_stmt)
            if loop['range']['step'] == 1:
Maxime Perrotin's avatar
Maxime Perrotin committed
648
649
650
651
                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
652
                stmt.append(
653
                        u'for {it} in {start}{stop} loop'
dbarbera's avatar
dbarbera committed
654
                        .format(it=loop['var'], start=start_str, stop=stop_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
655
656
657
            else:
                # Step is not directly supported in Ada, we need to use 'while'
                stmt.extend(['declare',
658
                             u'{it} : Integer := {start};'
Maxime Perrotin's avatar
Maxime Perrotin committed
659
660
661
662
                             .format(it=loop['var'],
                             start=start_str),
                             '',
                             'begin',
663
                             u'while {it} < {stop} loop'.format(it=loop['var'],
Maxime Perrotin's avatar
Maxime Perrotin committed
664
665
666
667
                                                               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
668
            list_stmt, list_str, list_local = expression(loop['list'])
Maxime Perrotin's avatar
Maxime Perrotin committed
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
            basic_type = find_basic_type(loop['list'].exprType)
            range_cond = "{}.Data'Range".format(list_str)\
                    if basic_type.Min == basic_type.Max\
                    else "1..{}.Length".format(list_str)
            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'],
                                                            rc=range_cond),
                         '{it} := {var}.Data({it}_idx);'.format(it=loop['var'],
                                                                var=list_str)])
        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
705
706
707
708
709
710
711
712
713
714
@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
715

Maxime Perrotin's avatar
Maxime Perrotin committed
716
@expression.register(ogAST.PrimVariable)
Maxime Perrotin's avatar
Maxime Perrotin committed
717
718
def _primary_variable(prim):
    ''' Single variable reference '''
Maxime Perrotin's avatar
Maxime Perrotin committed
719
    sep = u'l_' if find_var(prim.value[0]) else u''
Maxime Perrotin's avatar
Maxime Perrotin committed
720

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

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


729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
@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
                'Asn1Int' if ident == 'fix'
                else 'adaasn1rtl.Asn1Real'
                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)
        if min_length == max_length:
            ada_string += min_length
        else:
            ada_string += ('Asn1Int({e}.Length)'.format(e=param_str))
    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))
    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 += ')'

803
    return stmts, unicode(ada_string), local_decl
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825


@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)
    ada_string += '.Data({idx})'.format(idx=idx_string)
    stmts.extend(idx_stmts)
    local_decl.extend(idx_var)

826
    return stmts, unicode(ada_string), local_decl
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851


@expression.register(ogAST.PrimSubstring)
def _prim_substring(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)

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

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

    # should we add 1 in case of numerical values? (see index)
    ada_string += '.Data({r1}..{r2})'.format(r1=r1_string, r2=r2_string)
    stmts.extend(r1_stmts)
    stmts.extend(r2_stmts)
    local_decl.extend(r1_local)
    local_decl.extend(r2_local)

dbarbera's avatar
dbarbera committed
852
853
    local_decl.append('tmp{idx} : aliased asn1Scc{parent_type};'.format(
            idx=prim.value[1]['tmpVar'], parent_type=receiver_ty_name))
854
855
856
857
858
859

    # XXX types with fixed length: substrings will not work
    if unicode.isnumeric(r1_string) and unicode.isnumeric(r2_string):
        length = int(r2_string) - int(r1_string) + 1
    else:
        length = ('{r2} - {r1} + 1'.format(r2=r2_string, r1=r1_string))
dbarbera's avatar
dbarbera committed
860
861
    stmts.append('tmp{idx}.Length := {length};'.format(
            idx=prim.value[1]['tmpVar'], length=length))
862

dbarbera's avatar
dbarbera committed
863
864
    stmts.append('tmp{idx}.Data(1..{length}) := {data};'.format(
        idx=prim.value[1]['tmpVar'], length=length, data=ada_string))
865
866
    ada_string = 'tmp{idx}'.format(idx=prim.value[1]['tmpVar'])

867
    return stmts, unicode(ada_string), local_decl
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885


@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
886
887
        ada_string = ('asn1Scc{typename}_{field_name}_get({ada_string})'.format(
            typename=receiver_ty_name, field_name=field_name, ada_string=ada_string))
888
889
890
    else:
        ada_string += '.' + field_name

Maxime Perrotin's avatar
Maxime Perrotin committed
891
    return stmts, unicode(ada_string), local_decl
892
893


Maxime Perrotin's avatar
Maxime Perrotin committed
894
895
896
897
898
899
900
901
902
903
904
905
906
@expression.register(ogAST.ExprPlus)
@expression.register(ogAST.ExprMul)
@expression.register(ogAST.ExprMinus)
@expression.register(ogAST.ExprEq)
@expression.register(ogAST.ExprNeq)
@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)
@expression.register(ogAST.ExprAssign)
Maxime Perrotin's avatar
Maxime Perrotin committed
907
def _basic_operators(expr):
908
    ''' Expressions with two sides '''
Maxime Perrotin's avatar
Maxime Perrotin committed
909
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
910
911
    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
912
    ada_string = u'({left} {op} {right})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
913
914
915
916
917
            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
918
    return code, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
919

Maxime Perrotin's avatar
Maxime Perrotin committed
920

Maxime Perrotin's avatar
Maxime Perrotin committed
921
922
923
@expression.register(ogAST.ExprOr)
@expression.register(ogAST.ExprAnd)
@expression.register(ogAST.ExprXor)
924
925
926
def _bitwise_operators(expr):
    ''' Logical operators '''
    code, local_decl = [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
927
928
    left_stmts, left_str, left_local = expression(expr.left)
    right_stmts, right_str, right_local = expression(expr.right)
929
930
931
932
933
    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
934
            tmp_string = u'tmp{}'.format(expr.right.tmpVar)
Maxime Perrotin's avatar
Maxime Perrotin committed
935
            local_decl.append(u'{tmp} : aliased asn1Scc{eType};'.format(
936
937
938
                        tmp=tmp_string,
                        eType=expr.right.exprType.ReferencedTypeName
                        .replace('-', '_')))
Maxime Perrotin's avatar
Maxime Perrotin committed
939
            code.append(u'{tmp} := {right};'.format(tmp=tmp_string,
940
941
                                                  right=right_str))
            right_str = tmp_string
Maxime Perrotin's avatar
Maxime Perrotin committed
942
        ada_string = u'(Data => ({left}.Data {op} {right}.Data)'.format(
943
944
                left=left_str, op=expr.operand, right=right_str)
        if basic_type.Min != basic_type.Max:
Maxime Perrotin's avatar
Maxime Perrotin committed
945
946
            ada_string += u", Length => {left}.Length".format(left=left_str)
        ada_string += u')'
947
    else:
948
        ada_string = u'({left} {op}{short} {right})'.format(
dbarbera's avatar
dbarbera committed
949
950
951
952
                                left=left_str,
                                op=expr.operand,
                                short=expr.shortcircuit,
                                right=right_str)
953
954
955
956
    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
957
    return code, unicode(ada_string), local_decl
dbarbera's avatar
dbarbera committed
958
959
960
961
962
963
964
965
966
967
968


@expression.register(ogAST.ExprNot)
@expression.register(ogAST.ExprNeg)
def _unary_operator(expr):
    ''' Generate the code for an unary expression '''
    code, local_decl = [], []
    expr_stmts, expr_str, expr_local = expression(expr.expr)
    ada_string = u'({op} {expr})'.format(op=expr.operand, expr=expr_str)
    code.extend(expr_stmts)
    local_decl.extend(expr_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
969
    return code, unicode(ada_string), local_decl
970

Maxime Perrotin's avatar
Maxime Perrotin committed
971

Maxime Perrotin's avatar
Maxime Perrotin committed
972
@expression.register(ogAST.ExprAppend)
Maxime Perrotin's avatar
Maxime Perrotin committed
973
974
975
def _append(expr):
    ''' Generate code for the APPEND construct: a // b '''
    stmts, ada_string, local_decl = [], '', []
976
#    basic_type_expr = find_basic_type(expr.exprType)
Maxime Perrotin's avatar
Maxime Perrotin committed
977
978
979
980
981
982
983
984
985
986
987
988
989
    # We can do a length check if both strings are literals
    # XXX should be already done by the parser
#   if(expr.right.kind == 'primary'
#      and expr.right.var.kind == 'stringLiteral'
#      and expr.left.kind == 'primary'
#      and expr.left.var.kind == 'stringLiteral'
#      and len(expr.right.var.stringLiteral[1:-1]) +
#      len(expr.left.var.stringLiteral[1:-1]) > basic_type_expr.Max):
#       raise ValueError('String concatenation exceeds container length: '
#               'length(' + expr.left.var.stringLiteral[1:-1] +
#               expr.right.var.stringLiteral[1:-1] + ') > ' +
#               str(basic_type_expr.Max))

Maxime Perrotin's avatar
Maxime Perrotin committed
990
991
    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
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
    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:
            local_decl.append('tmp{idx} : aliased asn1Scc{eType};'.format(
                    idx=sexp.tmpVar,
                    eType=sexp.exprType.ReferencedTypeName
                    .replace('-', '_')))
            stmts.append('tmp{idx} := {s_id};'.format(
                idx=sexp.tmpVar, s_id=sid))
            sexp.sid = 'tmp' + str(sexp.tmpVar)
            # Length of raw string - update for sequence of
            if isinstance(sexp, ogAST.PrimStringLiteral):
                sexp.slen = len(sexp.value[1:-1])
            elif isinstance(sexp, ogAST.PrimEmptyString):
                sexp.slen = 0
            elif isinstance(sexp, ogAST.PrimSequenceOf):
                sexp.slen = len(sexp.value)
            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
                sexp.slen = basic.Max
            else:
                # Variable-size types have a Length field
                sexp.slen = '{}.Length'.format(sexp.sid)
    stmts.append('{res}.Data(1..{l1}) := {lid}.Data(1..{l1});'.format(
                res=ada_string, l1=expr.left.slen, lid=expr.left.sid))
    stmts.append('{res}.Data({l1}+1..{l1}+{l2}) := {rid}.Data(1..{l2});'
                .format(res=ada_string, l1=expr.left.slen,
                rid=expr.right.sid, l2=expr.right.slen))
    stmts.append('{res}.Length := {l1} + {l2};'.format(
                res=ada_string, l1=expr.left.slen, l2=expr.right.slen))
Maxime Perrotin's avatar
Maxime Perrotin committed
1038
    return stmts, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1039
1040


Maxime Perrotin's avatar
Maxime Perrotin committed
1041
@expression.register(ogAST.ExprIn)
Maxime Perrotin's avatar
Maxime Perrotin committed
1042
1043
1044
1045
1046
1047
1048
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
1049
1050
    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
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
    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)
    if left_type.Min != left_type.Max:
        stmts.append("for elem in 1..Integer({}.Length) loop"
                     .format(left_str))
    else:
        stmts.append("for elem in {}.Data'Range loop".format(left_str))
    stmts.append("if {container}.Data(elem) = {pattern} then".format
            (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
1069
    return stmts, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1070
1071


Maxime Perrotin's avatar
Maxime Perrotin committed
1072
@expression.register(ogAST.PrimEnumeratedValue)
Maxime Perrotin's avatar
Maxime Perrotin committed
1073
1074
1075
1076
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
1077
1078
    ada_string = (u'asn1Scc' + basic.EnumValues[enumerant].EnumID)
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1079
1080


Maxime Perrotin's avatar
Maxime Perrotin committed
1081
@expression.register(ogAST.PrimChoiceDeterminant)
Maxime Perrotin's avatar
Maxime Perrotin committed
1082
1083
1084
1085
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
1086
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1087
1088


Maxime Perrotin's avatar
Maxime Perrotin committed
1089
1090
@expression.register(ogAST.PrimInteger)
@expression.register(ogAST.PrimReal)
1091
1092
def _integer(primary):
    ''' Generate code for a raw numerical value  '''
dbarbera's avatar
dbarbera committed
1093
    if float(primary.value[0]) < 0:
Maxime Perrotin's avatar
Maxime Perrotin committed
1094
1095
1096
        # Parentesize negative integers for maintaining
        # the precedence in the generated code
        ada_string = u'({})'.format(primary.value[0])
dbarbera's avatar
dbarbera committed
1097
1098
    else:
        ada_string = primary.value[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1099
    return [], unicode(ada_string), []
1100
1101


Maxime Perrotin's avatar
Maxime Perrotin committed
1102
@expression.register(ogAST.PrimBoolean)
dbarbera's avatar
dbarbera committed
1103
def _boolean(primary):
1104
1105
    ''' Generate code for a raw boolean value  '''
    ada_string = primary.value[0]
Maxime Perrotin's avatar
Maxime Perrotin committed
1106
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1107
1108


Maxime Perrotin's avatar
Maxime Perrotin committed
1109
@expression.register(ogAST.PrimEmptyString)
Maxime Perrotin's avatar
Maxime Perrotin committed
1110
1111
def _empty_string(primary):
    ''' Generate code for an empty SEQUENCE OF: {} '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1112
    ada_string = u'asn1Scc{typeRef}_Init'.format(
dbarbera's avatar
dbarbera committed
1113
            typeRef=primary.exprType.ReferencedTypeName.replace('-', '_'))
Maxime Perrotin's avatar
Maxime Perrotin committed
1114
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1115
1116


Maxime Perrotin's avatar
Maxime Perrotin committed
1117
@expression.register(ogAST.PrimStringLiteral)
Maxime Perrotin's avatar
Maxime Perrotin committed
1118
1119
1120
1121
1122
1123
1124
def _string_literal(primary):
    ''' Generate code for a string (Octet String) '''
    basic_type = find_basic_type(primary.exprType)
    # If user put a literal string to fill an Octet string,
    # then convert the string to an array of unsigned_8 integers
    # as expected by the Ada type corresponding to Octet String
    unsigned_8 = [str(ord(val)) for val in primary.value[1:-1]]
1125

Maxime Perrotin's avatar
Maxime Perrotin committed
1126
    ada_string = u'(Data => (' + ', '.join(
dbarbera's avatar
dbarbera committed
1127
                                        unsigned_8) + ', others => 0)'
Maxime Perrotin's avatar
Maxime Perrotin committed
1128
1129
    if basic_type.Min != basic_type.Max:
        # Non-fixed string size -> add Length field
Maxime Perrotin's avatar
Maxime Perrotin committed
1130
        ada_string += u', Length => {}'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1131
1132
                                str(len(primary.value[1:-1])))
    ada_string += ')'
Maxime Perrotin's avatar
Maxime Perrotin committed
1133
    return [], unicode(ada_string), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1134
1135


Maxime Perrotin's avatar
Maxime Perrotin committed
1136
@expression.register(ogAST.PrimConstant)
Maxime Perrotin's avatar
Maxime Perrotin committed
1137
1138
def _constant(primary):
    ''' Generate code for a reference to an ASN.1 constant '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1139
    return [], unicode(primary.value[0]), []
Maxime Perrotin's avatar
Maxime Perrotin committed
1140
1141


Maxime Perrotin's avatar
Maxime Perrotin committed
1142
@expression.register(ogAST.PrimMantissaBaseExp)
Maxime Perrotin's avatar
Maxime Perrotin committed
1143
1144
1145
def _mantissa_base_exp(primary):
    ''' Generate code for a Real with Mantissa-base-Exponent representation '''
    # TODO
Maxime Perrotin's avatar
Maxime Perrotin committed
1146
    return [], u'', []
Maxime Perrotin's avatar
Maxime Perrotin committed
1147

Maxime Perrotin's avatar
Maxime Perrotin committed
1148

Maxime Perrotin's avatar
Maxime Perrotin committed
1149
@expression.register(ogAST.PrimIfThenElse)
Maxime Perrotin's avatar
Maxime Perrotin committed
1150
1151
1152
1153
def _if_then_else(ifThenElse):
    ''' Return string and statements for ternary operator '''
    resType = ifThenElse.exprType
    stmts = []
1154
1155
1156
1157
1158
1159
1160
1161
1162
    if resType.kind.startswith('Integer'):
        tmp_type = 'Asn1Int'
    elif resType.kind == 'StandardStringType':
        then_str = ifThenElse.value['then'].value.replace("'", '"')
        else_str = ifThenElse.value['else'].value.replace("'", '"')
        lens = [len(then_str), len(else_str)]
        tmp_type = 'String(1 .. {})'.format(max(lens) - 2)
        # Ada require fixed-length strings, adjust with spaces
        if lens[0] < lens[1]:
dbarbera's avatar
dbarbera committed
1163
            then_str = then_str[0:-1] + ' ' * (lens[1] - lens[0]) + '"'
1164
        elif lens[1] < lens[0]:
dbarbera's avatar
dbarbera committed
1165
            else_str = else_str[0:-1] + ' ' * (lens[0] - lens[1]) + '"'
1166
1167
1168
1169
1170
    else:
        tmp_type = 'asn1Scc' + resType.ReferencedTypeName.replace('-', '_')
    local_decl = ['tmp{idx} : {tmpType};'.format(
                                                idx=ifThenElse.value['tmpVar'],
                                                tmpType=tmp_type)]
Maxime Perrotin's avatar
Maxime Perrotin committed
1171
    if_stmts, if_str, if_local = expression(ifThenElse.value['if'])
Maxime Perrotin's avatar
Maxime Perrotin committed
1172
1173
    stmts.extend(if_stmts)
    local_decl.extend(if_local)
1174
1175
1176
1177
1178
1179
1180
1181
    if resType.kind != 'StandardStringType':
        then_stmts, then_str, then_local = expression(ifThenElse.value['then'])
        else_stmts, else_str, else_local = expression(ifThenElse.value['else'])
        stmts.extend(then_stmts)
        stmts.extend(else_stmts)
        local_decl.extend(then_local)
        local_decl.extend(else_local)
    stmts.append(u'if {if_str} then'.format(if_str=if_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
1182
    stmts.append(u'tmp{idx} := {then_str};'.format(
1183
1184
                                                idx=ifThenElse.value['tmpVar'],
                                                then_str=then_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
1185
    stmts.append('else')
Maxime Perrotin's avatar
Maxime Perrotin committed
1186
    stmts.append(u'tmp{idx} := {else_str};'.format(
1187
1188
                                                idx=ifThenElse.value['tmpVar'],
                                                else_str=else_str))
Maxime Perrotin's avatar
Maxime Perrotin committed
1189
    stmts.append('end if;')
Maxime Perrotin's avatar
Maxime Perrotin committed
1190
    ada_string = u'tmp{idx}'.format(idx=ifThenElse.value['tmpVar'])
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.PrimSequence)
Maxime Perrotin's avatar
Maxime Perrotin committed
1195
1196
1197
1198
1199
1200
def _sequence(seq):
    ''' Return Ada string for an ASN.1 SEQUENCE '''
    stmts, local_decl = [], []
    seqType = seq.exprType
    LOG.debug('PrimSequence: ' + str(seq) + str(seqType))

Maxime Perrotin's avatar
Maxime Perrotin committed
1201
    ada_string = u"asn1Scc{seqType}'(".format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1202
1203
1204
1205
1206
1207
1208
            seqType=seqType.ReferencedTypeName.replace('-', '_'))
    sep = ''
    for elem, value in seq.value.viewitems():
        # Set the type of the field - easy thanks to ASN.1 flattened AST
        delem = elem.replace('_', '-')
        value.exprType = (TYPES
                    [seqType.ReferencedTypeName].type.Children[delem].type)
Maxime Perrotin's avatar
Maxime Perrotin committed
1209
        value_stmts, value_str, local_var = expression(value)
Maxime Perrotin's avatar
Maxime Perrotin committed
1210
1211
1212
1213
1214
        ada_string += sep + elem + ' => ' + value_str
        sep = ', '
        stmts.extend(value_stmts)
        local_decl.extend(local_var)
    ada_string += ')'
Maxime Perrotin's avatar
Maxime Perrotin committed
1215
    return stmts, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1216
1217


Maxime Perrotin's avatar
Maxime Perrotin committed
1218
@expression.register(ogAST.PrimSequenceOf)
Maxime Perrotin's avatar
Maxime Perrotin committed
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
def _sequence_of(seqof):
    ''' Return Ada string for an ASN.1 SEQUENCE OF '''
    stmts, local_decl = [], []
    seqofType = seqof.exprType
    typename = seqofType.ReferencedTypeName
    LOG.debug('SequenceOf Typename:' + str(typename))
    asn_type = TYPES[typename].type
    min_size = asn_type.Min
    max_size = asn_type.Max
    ada_string = 'asn1Scc{seqofType}\'('.format(
                                seqofType=typename.replace('-', '_'))
    if min_size == max_size:
        # Fixed-length array - no need to set the Length field
        ada_string += 'Data => asn1Scc{seqofType}_array\'('.format(
                seqofType=typename.replace('-', '_'))
    else:
        # Variable-length array
        ada_string += (
                'Length => {length}, Data => asn1Scc{seqofType}_array\'('
                .format(seqofType=typename.replace('-', '_'),
                        length=len(seqof.value)))
    for i in xrange(len(seqof.value)):
        # Set the type of the element (should not be useful anymore)
        #seqof.value[i].exprType = TYPES[typename].type.type
Maxime Perrotin's avatar
Maxime Perrotin committed
1243
        item_stmts, item_str, local_var = expression(seqof.value[i])
Maxime Perrotin's avatar
Maxime Perrotin committed
1244
1245
1246
1247
        stmts.extend(item_stmts)
        local_decl.extend(local_var)
        ada_string += '{i} => {value}, '.format(i=i + 1, value=item_str)
    ada_string += 'others => {anyVal}))'.format(anyVal=item_str)
Maxime Perrotin's avatar
Maxime Perrotin committed
1248
    return stmts, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1249
1250


Maxime Perrotin's avatar
Maxime Perrotin committed
1251
@expression.register(ogAST.PrimChoiceItem)
Maxime Perrotin's avatar
Maxime Perrotin committed
1252
1253
def _choiceitem(choice):
    ''' Return the Ada code for a CHOICE expression '''
Maxime Perrotin's avatar
Maxime Perrotin committed
1254
    stmts, choice_str, local_decl = expression(choice.value['value'])
Maxime Perrotin's avatar
Maxime Perrotin committed
1255
1256
    choiceType = choice.exprType
    actual_type = getattr(
dbarbera's avatar
dbarbera committed
1257
                    choiceType, 'ReferencedTypeName', None) or choiceType.kind
Maxime Perrotin's avatar
Maxime Perrotin committed
1258
1259
1260
1261
1262
    actual_type = actual_type.replace('-', '_')
    ada_string = 'asn1Scc{cType}_{opt}_set({expr})'.format(
            cType=actual_type,
            opt=choice.value['choice'],
            expr=choice_str)
Maxime Perrotin's avatar
Maxime Perrotin committed
1263
    return stmts, unicode(ada_string), local_decl
Maxime Perrotin's avatar
Maxime Perrotin committed
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274


@generate.register(ogAST.Decision)
def _decision(dec):
    ''' generate the code for a decision '''
    code, local_decl = [], []
    question_type = dec.question.exprType
    # XXX check if we should get the type like this
    actual_type = getattr(
            question_type, 'ReferencedTypeName', None) or question_type.kind
    actual_type = actual_type.replace('-', '_')
Maxime Perrotin's avatar
Maxime Perrotin committed
1275
1276
1277
    basic = find_basic_type(question_type).kind in ('IntegerType',
                          'Integer32Type', 'BooleanType',
                          'RealType', 'EnumeratedType', 'ChoiceEnumeratedType')
Maxime Perrotin's avatar
Maxime Perrotin committed
1278
1279
1280
1281
    # for ASN.1 types, declare a local variable
    # to hold the evaluation of the question
    if not basic:
        local_decl.append('tmp{idx} : aliased asn1Scc{actType};'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
1282
                          idx=dec.tmpVar, actType=actual_type))
Maxime Perrotin's avatar
Maxime Perrotin committed
1283
    q_stmts, q_str, q_decl = expression(dec.question)
Maxime Perrotin's avatar
Maxime Perrotin committed
1284