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

"""
    OpenGEODE - A tiny SDL Editor for TASTE

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    Copyright (c) 2012-2013 European Space Agency

    Designed and implemented by Maxime Perrotin

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


import logging
73
import traceback
74
import os
75
import stat
76
from itertools import chain, product
Maxime Perrotin's avatar
Maxime Perrotin committed
77 78 79
from singledispatch import singledispatch

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

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

94 95 96
# Specify that the target is a shared library
SHARED_LIB = False

97
UNICODE_SEP = u'\u00dc'
98
LPREFIX = u'ctxt'
Maxime Perrotin's avatar
Maxime Perrotin committed
99 100

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


Maxime Perrotin's avatar
Maxime Perrotin committed
107
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
108
@generate.register(ogAST.Process)
109
def _process(process, simu=False, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
110 111 112 113 114 115 116 117
    ''' 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)
118
    global SHARED_LIB
119
    global LPREFIX
120 121
    if simu:
        SHARED_LIB = True
122
        LPREFIX = process_name + u'_ctxt'
Maxime Perrotin's avatar
Maxime Perrotin committed
123

124 125 126 127 128 129 130 131 132 133 134
    # When building a shared library (with simu=True), generate a "mini-cv"
    # for aadl2glueC to create the code interfacing with asn1scc
    minicv = ['-- Automatically generated by OpenGEODE - do NOT modify!']
    def aadl_template(sp_name, io_param, pi_or_ri):
        ''' AADL mini-cv code in case of shared library
            sp_name  : name of the PI or RI
            io_param : list of (param_name, type_name, direction)
            pi_or_ri : string "PI" or "RI" depending on the direction
            return a string
        '''
        res = []
135 136 137 138 139
        if not io_param:
            LOG.info('Parameterless interface "{}" will not appear in the'
                     ' AADL file but will be handled directly by the GUI'
                     .format(sp_name))
            return ''
140 141 142 143 144 145
        # In case of shared library, generate the AADL "mini-cv" code
        res.append('SUBPROGRAM {}'.format(sp_name))
        if io_param:
            res.append('FEATURES')
            for param_name, sort, direction in io_param:
                res.append('    {pname}: {io} PARAMETER DataView::{sort} '
146 147 148
                          '{{encoding=>Native;}};'.format(pname=param_name,
                                                          sort=sort,
                                                          io=direction))
149 150 151 152 153 154 155 156 157
        res.append('END {};\n'.format(sp_name))
        res.append('SUBPROGRAM IMPLEMENTATION {}.GUI_{}'
                      .format(sp_name, pi_or_ri))
        res.append('PROPERTIES')
        res.append('    FV_Name => "{}";'.format(process_name))
        res.append('    Source_Language => GUI_{};'.format(pi_or_ri))
        res.append('END {}.GUI_{};\n'.format(sp_name, pi_or_ri))
        return '\n'.join(res)

158
    # bash script to simulate the system (TEMPORARY)
159 160 161 162 163 164 165 166

    # go up to the root of the AST to get the list of ASN.1 files
    parent = process.parent
    while hasattr(parent, 'parent') and parent.parent:
        parent = parent.parent
    if isinstance(parent, ogAST.System):
        parent = parent.ast
    asn1_filenames = ' '.join(parent.asn1_filenames)
Maxime Perrotin's avatar
Maxime Perrotin committed
167 168
    asn1_uniq = ' '.join(each for each in parent.asn1_filenames
                         if each != 'dataview-uniq.asn')
169 170 171 172 173 174
    pr_path = ' '.join(parent.pr_files)
    pr_names = ' '.join(
                      os.path.basename(pr_file) for pr_file in parent.pr_files)
    asn1_modules = (name.lower().replace('-', '_') + '.o'
                    for name in process.asn1Modules)

175
    simu_script = '''#!/bin/bash -e
176 177 178 179 180
rm -rf {pr}_simu
mkdir -p {pr}_simu
cp {pr_path} {asn1} {pr}_simu
cd {pr}_simu
opengeode {pr_names} --shared
Maxime Perrotin's avatar
Maxime Perrotin committed
181 182 183 184 185
cat {uniq} >> dataview-uniq.asn '''.format(pr=process_name,
                                           asn1=asn1_filenames,
                                           pr_path=pr_path,
                                           uniq=asn1_uniq or '/dev/null',
                                           pr_names=pr_names)
186 187 188 189 190 191 192

    if asn1_filenames:
        simu_script += '''
asn1.exe -Ada -typePrefix asn1Scc -equal {asn1}
asn1.exe -c -typePrefix asn1Scc -equal {asn1}'''.format(asn1=asn1_filenames)

    simu_script += '''
193 194 195
gnatmake -gnat2012 -c *.adb
gnatbind -n -Llib{pr} {pr}
gnatmake -c -gnat2012 b~{pr}.adb
196
gcc -shared -fPIC -o lib{pr}.so b~{pr}.o {pr}.o {asn1_mod} adaasn1rtl.o -lgnat
197
rm -f dataview-uniq.c dataview-uniq.h
198
asn2aadlPlus dataview-uniq.asn DataView.aadl
199 200 201
aadl2glueC DataView.aadl {pr}_interface.aadl
asn2dataModel -toPython dataview-uniq.asn
make -f Makefile.python
202
echo "errCodes=$(taste-asn1-errCodes ./dataview-uniq.h)" >>datamodel.py
203 204 205 206
LD_LIBRARY_PATH=. opengeode-simulator
'''.format(pr=process_name,
           asn1_files=asn1_filenames,
           asn1_mod=' '.join(asn1_modules))
207

208

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

211
    # In case model has nested states, flatten everything
212
    Helper.flatten(process, sep=UNICODE_SEP)
213

214
    # Process State aggregations (Parallel states) XXX Add to C backend
215

216 217
    # Find recursively in the AST all state aggregations
    # Format: {'aggregation_name' : [list of ogAST.CompositeState]
218
    aggregates = Helper.state_aggregations(process)
219

220 221 222
    # Extract the list of parallel states names inside the composite states
    # of state aggregations XXX add to C generator
    parallel_states = Helper.parallel_states(aggregates)
223

Maxime Perrotin's avatar
Maxime Perrotin committed
224 225 226 227
    # 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
228 229 230
    VARIABLES.update(process.variables)

    process_level_decl = []
231

232
    # Establish the list of states (excluding START states) XXX update C backend
233
    full_statelist = set(chain(aggregates.viewkeys(),
234 235
                               (name for name in process.mapping.iterkeys()
                                    if not name.endswith(u'START'))))
236
    reduced_statelist = {s for s in full_statelist if s not in parallel_states}
Maxime Perrotin's avatar
Maxime Perrotin committed
237
    if aggregates:
238 239
        # Parallel states in a state aggregation may terminate
        full_statelist.add(u'{}finished'.format(UNICODE_SEP))
240 241 242 243

    if full_statelist:
        process_level_decl.append(u'type States is ({});'
                            .format(u', '.join(full_statelist) or u'No_State'))
244 245 246 247

    # Generate the code to declare process-level context
    process_level_decl.extend(['type {}_Ty is'.format(LPREFIX), 'record'])

248
    if full_statelist:
249 250
        process_level_decl.append('state : States;')

Maxime Perrotin's avatar
Maxime Perrotin committed
251
    # State aggregation: add list of substates (XXX to be added in C generator)
252 253 254
    for substates in aggregates.viewvalues():
        for each in substates:
            process_level_decl.append(u'{}{}state: States;'
255
                                      .format(each.statename, UNICODE_SEP))
Maxime Perrotin's avatar
Maxime Perrotin committed
256

Maxime Perrotin's avatar
Maxime Perrotin committed
257 258 259 260
    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
261
            dst, dstr, dlocal = expression(def_value)
262 263 264
            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
265 266
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
        process_level_decl.append(
267 268
                        u'{n} : aliased {sort}{default};'
                        .format(n=var_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
269 270
                                sort=type_name(var_type),
                                default=u' := ' + dstr if def_value else u''))
Maxime Perrotin's avatar
Maxime Perrotin committed
271

272 273 274
    process_level_decl.append('end record;'.format(LPREFIX))
    process_level_decl.append('{ctxt}: {ctxt}_Ty;'.format(ctxt=LPREFIX))

Maxime Perrotin's avatar
Maxime Perrotin committed
275

276
    for name, val in process.mapping.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
277 278
        if name.endswith(u'START') and name != u'START':
            process_level_decl.append(u'{name} : constant := {val};'
279 280
                                      .format(name=name, val=str(val)))

281
    # Declare start procedure for aggregate states XXX add in C generator
282 283 284 285 286 287 288 289
    # should create one START per "via" clause, TODO later
    aggreg_start_proc = []
    for name, substates in aggregates.viewitems():
        proc_name = u'procedure {}{}START'.format(name, UNICODE_SEP)
        process_level_decl.append(u'{};'.format(proc_name))
        aggreg_start_proc.extend([u'{} is'.format(proc_name),
                                  'begin'])
        aggreg_start_proc.extend(u'runTransition({sub}{sep}START);'
290 291
                                 .format(sub=subname.statename,
                                         sep=UNICODE_SEP)
292 293 294 295
                                 for subname in substates)
        aggreg_start_proc.extend([u'end {}{}START;'
                                 .format(name, UNICODE_SEP),
                                 '\n'])
296

297 298 299
    # Add the declaration of the runTransition procedure, if needed
    if process.transitions:
        process_level_decl.append('procedure runTransition(Id: Integer);')
Maxime Perrotin's avatar
Maxime Perrotin committed
300

301
    # Generate the code of the start transition (if process not empty)
302
    start_transition = ['begin',
303
                        'runTransition(0);'] if process.transitions else []
304

Maxime Perrotin's avatar
Maxime Perrotin committed
305 306 307 308 309
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
310
        asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
311 312 313 314 315 316 317 318
    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;

319
with Ada.Unchecked_Conversion;
320
with Ada.Numerics.Generic_Elementary_Functions;
321

Maxime Perrotin's avatar
Maxime Perrotin committed
322 323 324 325
{dataview}

with Interfaces;
use Interfaces;
326
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
327
package body {process_name} is'''.format(process_name=process_name,
328 329 330 331
                                         dataview=asn1_modules,
                                         C='with Interfaces.C.Strings;\n'
                                           'use Interfaces.C.Strings;'
                                            if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
332 333 334 335 336 337

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

{dataview}
Maxime Perrotin's avatar
Maxime Perrotin committed
338
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
339 340

package {process_name} is'''.format(process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
341 342 343 344
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
345

Maxime Perrotin's avatar
Maxime Perrotin committed
346
    dll_api = []
347 348
    if simu:
        ads_template.append('--  DLL Interface')
349
        dll_api.append('-- DLL Interface to remotely change internal data')
350 351
        # Add function allowing to trace current state as a string
        process_level_decl.append("function get_state return chars_ptr "
352 353 354 355
                                  "is (New_String(states'Image({ctxt}.state)))"
                                  " with Export, Convention => C, "
                                  'Link_Name => "{name}_state";'
                                  .format(name=process_name, ctxt=LPREFIX))
356 357
        set_state_decl = "procedure set_state(new_state: chars_ptr)"
        ads_template.append("{};".format(set_state_decl))
358
        ads_template.append('pragma export(C, set_state, "_set_state");')
359 360
        dll_api.append("{} is".format(set_state_decl))
        dll_api.append("begin")
361 362
        dll_api.append("{}.state := States'Value(Value(new_state));"
                       .format(LPREFIX))
363 364 365
        dll_api.append("end set_state;")
        dll_api.append("")

366 367 368 369 370 371 372 373 374 375 376
        # interface to get/set state aggregations XXX add to C generator
        for substates in aggregates.viewvalues():
            for each in substates:
                process_level_decl.append(
                        u"function get_{name}_state return chars_ptr "
                        u"is (New_String(states'Image({ctxt}.{name}{sep}state)"
                        ")) with Export, Convention => C, "
                        'Link_Name => "{proc}_{name}_state";'
                        .format(name=each.statename, ctxt=LPREFIX,
                                proc=process_name, sep=UNICODE_SEP))

377 378 379 380
        # Functions to get gobal variables (length and value)
        for var_name, (var_type, _) in process.variables.viewitems():
            # Getters for local variables
            process_level_decl.append("function l_{name}_size return integer "
381 382 383 384
                                     "is ({prefix}.{name}'Size/8) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_size";'
                                     .format(prefix=LPREFIX, name=var_name))
385
            process_level_decl.append("function l_{name}_value"
386 387 388 389 390
                                     " return access {sort} "
                                     "is ({prefix}.{name}'access) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_value";'
                                     .format(prefix=LPREFIX, name=var_name,
391 392 393 394 395
                                              sort=type_name(var_type)))
            # Setters for local variables
            setter_decl = "procedure dll_set_l_{name}(value: access {sort})"\
                          .format(name=var_name, sort=type_name(var_type))
            ads_template.append('{};'.format(setter_decl))
396 397
            ads_template.append('pragma export(C, dll_set_l_{name},'
                                ' "_set_{name}");'.format(name=var_name))
398 399
            dll_api.append('{} is'.format(setter_decl))
            dll_api.append('begin')
400
            dll_api.append('{}.{} := value.all;'.format(LPREFIX, var_name))
401 402 403
            dll_api.append('end dll_set_l_{};'.format(var_name))
            dll_api.append('')

Maxime Perrotin's avatar
Maxime Perrotin committed
404 405 406 407 408 409 410 411 412 413 414 415 416
    # 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)

417 418 419 420
    # Generate the code of the START procedures of state aggregations
    # XXX to be added to C generator
    taste_template.extend(aggreg_start_proc)

421 422 423
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
424 425 426
    # 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]:
427
        signame = signal.get('name', u'START')
Maxime Perrotin's avatar
Maxime Perrotin committed
428
        if signame == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
429
            continue
430
        pi_header = u'procedure {sig_name}'.format(sig_name=signame)
431
        param_name = signal.get('param_name') \
Maxime Perrotin's avatar
Maxime Perrotin committed
432
                                or u'{}_param'.format(signame)
Maxime Perrotin's avatar
Maxime Perrotin committed
433 434
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
435
            typename = type_name(signal['type'])
436
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
437
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
438 439

        # Add declaration of the provided interface in the .ads file
440
        ads_template.append(u'--  Provided interface "{}"'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
441
        ads_template.append(pi_header + ';')
442
        ads_template.append(u'pragma export(C, {name}, "{proc}_{name}");'
443
                             .format(name=signame, proc=process_name))
444 445 446 447 448

        if simu:
            # Generate code for the mini-cv template
            params = [(param_name, type_name(signal['type'], use_prefix=False),
                      'IN')] if 'type' in signal else []
449
            minicv.append(aadl_template(signame, params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
450 451 452 453

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
454 455 456 457

        def execute_transition(state):
            ''' Generate the code that triggers the transition for the current
                state/input combination '''
458
            input_def = mapping[signame].get(state)
459
            # Check for nested states to call optional exit procedure
460
            state_tree = state.split(UNICODE_SEP)
Maxime Perrotin's avatar
Maxime Perrotin committed
461
            context = process
462 463 464 465 466 467
            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:
468
                    if current.lower() == comp.statename.lower():
469 470 471
                        if comp.exit_procedure:
                            exitlist.append(current)
                        context = comp
472
                        current = current + UNICODE_SEP
473 474 475 476
                        break
            for each in reversed(exitlist):
                if trans and all(each.startswith(trans_st)
                                 for trans_st in trans.possible_states):
477
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
478
                                          .format(ref=each, sep=UNICODE_SEP))
479

Maxime Perrotin's avatar
Maxime Perrotin committed
480 481 482 483
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
484 485
                    taste_template.append(u'{ctxt}.{inp} := {tInp}.all;'
                                          .format(ctxt=LPREFIX,
486 487
                                                  inp=inp,
                                                  tInp=param_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
488 489
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
490
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
491 492 493 494 495
                        idx=input_def.transition_id))
                else:
                    taste_template.append('null;')
            else:
                taste_template.append('null;')
496

497
        taste_template.append('case {}.state is'.format(LPREFIX))
498 499 500 501 502 503 504

        def case_state(state):
            ''' Recursive function (in case of state aggregation) to generate
                the code that calls the proper transition according
                to the current state
                The input name is in signame
            '''
505
            if state.endswith(u'START'):
506
                return
507
            taste_template.append(u'when {state} =>'.format(state=state))
508
            input_def = mapping[signame].get(state)
509
            if state in aggregates.viewkeys():
510
                # State aggregation:
Maxime Perrotin's avatar
Maxime Perrotin committed
511 512
                # - find which substate manages this input
                # - add a swich case on the corresponding substate
513 514
                taste_template.append(u'-- this is a state aggregation')
                for sub in aggregates[state]:
515 516 517 518 519 520 521 522
                    if [a for a in sub.mapping.viewkeys()
                            if a in mapping[signame].viewkeys()]:
                        taste_template.append(u'case '
                                              u'{ctxt}.{sub}{sep}state is'
                                              .format(ctxt=LPREFIX,
                                                     sub=sub.statename,
                                                     sep=UNICODE_SEP))
                        for par in sub.mapping.viewkeys():
523
                            case_state(par)
524 525 526 527
                        taste_template.append('when others =>')
                        taste_template.append('null;')
                        taste_template.append('end case;')
                        break
528 529
                else:
                    # Input is not managed in the state aggregation
530 531 532
                    if input_def:
                        # check if it is managed one level above
                        execute_transition(state)
533
                    taste_template.append('null;')
Maxime Perrotin's avatar
Maxime Perrotin committed
534 535
            else:
                execute_transition(state)
536

537 538
        map(case_state, reduced_statelist) # XXX update C generator

Maxime Perrotin's avatar
Maxime Perrotin committed
539 540 541
        taste_template.append('when others =>')
        taste_template.append('null;')
        taste_template.append('end case;')
542
        taste_template.append(u'end {};'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
543 544 545 546 547
        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:
548

549 550
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
551
        # Add (optional) RI parameter
552 553 554
        # Paramless TMs: when targetting simulation, the name of the TM is
        # passed as single parameter. This allows the simualor to handle them
        # dynamically, with a single callback function for all TMs
Maxime Perrotin's avatar
Maxime Perrotin committed
555
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
556
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
557
            typename = type_name(signal['type'])
558 559 560 561 562
            param_spec = u'({pName}: access {sort}{shared})' \
                         .format(pName=param_name,
                                 sort=typename,
                                 shared=u'; Size: Integer'
                                        if SHARED_LIB else '')
563 564 565
        ads_template.append(u'--  {}equired interface "{}"'
                            .format("Paramless r" if not 'type' in signal
                                else "R", signal['name']))
566 567 568 569 570 571
        if simu:
            # When generating a shared library, we need a callback mechanism
            ads_template.append(u'type {}_T is access procedure{};'
                                .format(signal['name'], param_spec))
            ads_template.append('pragma Convention(Convention => C,'
                                ' Entity => {}_T);'.format(signal['name']))
572
            ads_template.append('{sig} : {sig}_T;'
573
                                .format(sig=signal['name']))
574 575 576 577 578
            ads_template.append('procedure Register_{sig}(Callback: {sig}_T);'
                                .format(sig=signal['name']))
            ads_template.append('pragma Export(C, Register_{sig},'
                                ' "register_{sig}");'
                                .format(sig=signal['name']))
579 580 581 582

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

585 586 587 588 589 590 591
            taste_template.append('procedure Register_{sig}'
                                  '(Callback:{sig}_T) is'
                                  .format(sig=signal['name']))
            taste_template.append('begin')
            taste_template.append('{} := Callback;'.format(signal['name']))
            taste_template.append('end Register_{};'.format(signal['name']))
            taste_template.append('')
592 593 594 595 596
        else:
            ads_template.append(u'procedure {}{};'
                                .format(signal['name'], param_spec))
            ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
                                .format(sig=signal['name'], proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
597 598

    # for the .ads file, generate the declaration of the external procedures
599 600
    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
601
        params = []
602 603 604 605
        params_spec = u""
        if simu:
            # For simulators: add the TM name as first parameter
            params.append("tm: chars_ptr")
Maxime Perrotin's avatar
Maxime Perrotin committed
606
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
607
            typename = type_name(param['type'])
608
            params.append(u'{par[name]}: access {sort}{shared}'
Maxime Perrotin's avatar
Maxime Perrotin committed
609
                          .format(par=param,
610 611 612 613
                                  sort=typename,
                                  shared=u"; {}_Size: Integer"
                                         .format(param['name'])
                                         if SHARED_LIB else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
614
        if params:
615 616
            params_spec = "({})".format("; ".join(params))
            ri_header += params_spec
617 618
        ads_template.append(u'--  Sync required interface "{}"'
                            .format(proc.inputString))
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
        if simu:
            # As for async TM, generate a callback mechanism
            ads_template.append(u"type {}_T is access procedure{};"
                                .format(proc.inputString, params_spec))
            ads_template.append('pragma Convention(Convention => C,'
                                ' Entity => {}_T);'.format(proc.inputString))
            ads_template.append('{sig} : {sig}_T;'
                                .format(sig=proc.inputString))
            ads_template.append('procedure Register_{sig}(Callback: {sig}_T);'
                                .format(sig=proc.inputString))
            ads_template.append('pragma Export(C, Register_{sig},'
                                ' "register_{sig}");'
                                .format(sig=proc.inputString))
            taste_template.append('procedure Register_{sig}'
                                  '(Callback:{sig}_T) is'
                                  .format(sig=proc.inputString))
            taste_template.append('begin')
            taste_template.append('{} := Callback;'.format(proc.inputString))
            taste_template.append('end Register_{};'.format(proc.inputString))
            taste_template.append('')

        else:
            ads_template.append(ri_header + u';')
            ads_template.append(u'pragma import(C, {sig}, "{proc}_RI_{sig}");'
                    .format(sig=proc.inputString, proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
644 645 646

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
647 648 649 650 651
        ads_template.append(u'--  Timer {} SET and RESET functions'
                            .format(timer))
        if simu:
            # Declare callback registration for the SET and RESET functions
            ads_template.append(u'type SET_{}_T is access procedure'
Maxime Perrotin's avatar
Maxime Perrotin committed
652
                                 '(name: chars_ptr; duration: Integer);'
653
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
654 655
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
            for each in ('', 'RE'):
                ads_template.append('pragma Convention(Convention => C,'
                                    ' Entity => {re}SET_{t}_T);'
                                    .format(re=each, t=timer))
                ads_template.append('{re}SET_{t} : {re}SET_{t}_T;'
                                    .format(re=each, t=timer))
                ads_template.append('procedure Register_{re}SET_{t}'
                                    '(Callback: {re}SET_{t}_T);'
                                    .format(re=each, t=timer))
                ads_template.append('pragma Export(C, Register_{re}SET_{t},'
                                    ' "register_{re}SET_{t}");'
                                    .format(re=each, t=timer))
            # Code for the SET/RESET timer callback registration
            for each in ('', 'RE'):
                taste_template.append('procedure Register_{re}SET_{t}'
                                      '(Callback:{re}SET_{t}_T) is'
                                      .format(re=each, t=timer))
                taste_template.append('begin')
                taste_template.append('{re}SET_{t} := Callback;'
                                      .format(re=each, t=timer))
                taste_template.append('end Register_{re}SET_{t};'
                                      .format(re=each, t=timer))
                taste_template.append('')

        else:
            ads_template.append(u'procedure SET_{}(val: access asn1SccT_UInt32);'
Maxime Perrotin's avatar
Maxime Perrotin committed
682
                .format(timer))
683
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
684
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
685
                .format(timer=timer, proc=process_name))
686 687
            ads_template.append(u'procedure RESET_{};'.format(timer))
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
688
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
689 690
                .format(timer=timer, proc=process_name))

691 692 693 694 695 696
    # 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;')

697 698
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714

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

715 716 717 718
    # Generate the code of the runTransition procedure, if needed
    if process.transitions:
        taste_template.append('procedure runTransition(Id: Integer) is')
        taste_template.append('trId : Integer := Id;')
Maxime Perrotin's avatar
Maxime Perrotin committed
719

720 721 722
        # Declare the local variables needed by the transitions in the template
        taste_template.extend(set(local_decl_transitions))
        taste_template.append('begin')
723

724 725 726
        # 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
727

728 729
        # Generate the switch-case on the transition id
        taste_template.append('case trId is')
Maxime Perrotin's avatar
Maxime Perrotin committed
730

731 732 733 734 735 736 737
        for idx, val in enumerate(code_transitions):
            taste_template.append(u'when {idx} =>'.format(idx=idx))
            val = [u'{line}'.format(line=l) for l in val]
            if val:
                taste_template.extend(val)
            else:
                taste_template.append('null;')
Maxime Perrotin's avatar
Maxime Perrotin committed
738

739 740 741 742 743 744 745 746
        taste_template.append('when others =>')
        taste_template.append('null;')

        taste_template.append('end case;')
        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
747

748 749
        # Add the code for the floating labels
        taste_template.extend(code_labels)
Maxime Perrotin's avatar
Maxime Perrotin committed
750

751
        taste_template.append('<<next_transition>>')
752 753 754 755 756 757 758 759 760 761 762 763

        # After completing active transition(s), check continuous signals:
        #     - Check current state(s)
        #     - For each continuous signal generate code (test+transition)
        # XXX add to C backend
        if process.cs_mapping:
            taste_template.append('--  Process continuous signals')
        else:
            taste_template.append('null;')

        # Process the continuous states in state aggregations first
        done = []
764 765
        sep = 'if '
        last = ''
766 767 768 769 770 771 772 773 774 775 776
        for cs, agg in product(process.cs_mapping.viewitems(),
                               aggregates.viewitems()):
            (statename, cs_item), (agg_name, substates) = cs, agg
            for each in substates:
                if statename in each.mapping.viewkeys():
                    taste_template.append(u'{first}if trId = -1 and '
                            u'{ctxt}.state = {s1} and '
                            u'{ctxt}.{s2}{sep}state = {s3} then'
                            .format(ctxt=LPREFIX, s1=agg_name,
                                s2=each.statename, sep=UNICODE_SEP,
                                s3=statename, first='els' if done else ''))
777 778 779 780
                    for provided_clause in cs_item:
                        trId = process.transitions.index\
                                            (provided_clause.transition)
                        code, loc = generate(provided_clause.trigger,
781 782 783
                                             branch_to=trId,
                                             sep=sep, last=last)
                        sep='elsif '
784
                        taste_template.extend(code)
785
                    done.append(statename)
786 787
                    taste_template.append(u'end if;')
                    sep = 'if '
788 789 790 791 792
                    break
        for statename in process.cs_mapping.viewkeys() - done:
            cs_item = process.cs_mapping[statename]
            taste_template.append(u'{first}if trId = -1 and {}.state = {} then'
                    .format(LPREFIX, statename, first='els' if done else ''))
793 794 795
            for provided_clause in cs_item:
                trId = process.transitions.index(provided_clause.transition)
                code, loc = generate(provided_clause.trigger,
796 797
                                     branch_to=trId, sep=sep, last=last)
                sep='elsif '
798
                taste_template.extend(code)
799 800
        if process.cs_mapping:
            taste_template.append(u'end if;')
801
            taste_template.append(u'end if;')
802

803 804 805
        taste_template.append('end loop;')
        taste_template.append('end runTransition;')
        taste_template.append('\n')
Maxime Perrotin's avatar
Maxime Perrotin committed
806

807
    # Add code of the package elaboration
Maxime Perrotin's avatar
Maxime Perrotin committed
808 809 810 811 812 813 814
    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))

815
    with open(process_name.lower() + os.extsep + 'adb', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
816 817
        ada_file.write(
                u'\n'.join(format_ada_code(taste_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
818

819
    with open(process_name.lower() + os.extsep + 'ads', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
820 821
        ada_file.write(
                u'\n'.join(format_ada_code(ads_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
822

823 824 825
    if simu:
        with open(u'{}_interface.aadl'.format(process_name), 'w') as aadl:
            aadl.write(u'\n'.join(minicv).encode('latin1'))
826 827
        script = '{}_simu.sh'.format(process_name)
        with open(script, 'w') as bash_script:
828
            bash_script.write(simu_script)
829
        os.chmod(script, os.stat(script).st_mode | stat.S_IXUSR)
830

Maxime Perrotin's avatar
Maxime Perrotin committed
831 832 833 834 835 836 837 838

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
839 840 841 842 843 844 845 846 847
    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
848 849
        if isinstance(param, ogAST.PrimStringLiteral):
            # Raw string
850 851
            code.append(u'Put("{}");'
                        .format(param.value[1:-1].replace('"', "'")))
Maxime Perrotin's avatar
Maxime Perrotin committed
852
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
853
            code, string, local = expression(param)
854 855
            if type_kind == 'OctetStringType':
                # Octet string -> convert to Ada string
856
                last_it = u""
857 858
                if isinstance(param, ogAST.PrimSubstring):
                    range_str = u"{}'Range".format(string)
859
                    iterator = u"i - {}'First + 1".format(string)
860 861 862
                elif basic_type.Min == basic_type.Max:
                    range_str = u"{}.Data'Range".format(string)
                    string += u".Data"
863
                    iterator = u"i"
864 865 866
                else:
                    range_str = u"1 .. {}.Length".format(string)
                    string += u".Data"
867 868
                    iterator = u"i"
                    last_it = u"({})".format(range_str)
869
                code.extend([u"for i in {} loop".format(range_str),
870
                             u"Put(Character'Val({st}(i)));"
871
                             .format(st=string),
872
                             u"end loop;"])
873 874
            else:
                code.append("Put({});".format(string))
Maxime Perrotin's avatar
Maxime Perrotin committed
875 876
    elif type_kind in ('IntegerType', 'RealType',
                       'BooleanType', 'Integer32Type'):
Maxime Perrotin's avatar
Maxime Perrotin committed
877
        code, string, local = expression(param)
878
        if type_kind == 'IntegerType':
879
            cast = "Asn1Int"
880
        elif type_kind == 'Integer32Type':
881
            cast = "Integer"
Maxime Perrotin's avatar
Maxime Perrotin committed
882 883 884 885
        elif type_kind == 'RealType':
            cast = 'Long_Float'
        elif type_kind == 'BooleanType':
            cast = 'Boolean'
886
        code.append(u"Put({cast}'Image({s}));".format(cast=cast, s=string))
887 888 889 890
    elif type_kind == 'EnumeratedType':
        code, string, local = expression(param)
        code.append(u"Put({}'Image({}));".format(type_name(param.exprType),
                                                 string))
Maxime Perrotin's avatar
Maxime Perrotin committed
891
    else:
892
        error = (u'Unsupported parameter in write call ' +
Maxime Perrotin's avatar
Maxime Perrotin committed
893 894 895
                param.inputString)
        LOG.error(error)
        raise TypeError(error)
896 897
    if newline:
        code.append(u"New_Line;")
Maxime Perrotin's avatar
Maxime Perrotin committed
898 899 900 901 902
    return code, string, local


@generate.register(ogAST.Output)
@generate.register(ogAST.ProcedureCall)
903
def _call_external_function(output, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
904 905 906 907 908 909 910 911 912
    ''' 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']
913
        list_of_params = []
Maxime Perrotin's avatar
Maxime Perrotin committed
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932

        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
933
            p_code, p_id, p_local = expression(param)
Maxime Perrotin's avatar
Maxime Perrotin committed
934 935
            code.extend(p_code)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
936 937 938 939
            if not SHARED_LIB:
                code.append('RESET_{};'.format(p_id))
            else:
                code.append('RESET_{t}(New_String("{t}"));'.format(t=p_id))
Maxime Perrotin's avatar
Maxime Perrotin committed
940 941 942 943
            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
944 945
            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
946 947 948 949
            code.extend(t_code)
            code.extend(p_code)
            local_decl.extend(t_local)
            local_decl.extend(p_local)
Maxime Perrotin's avatar
Maxime Perrotin committed
950 951 952 953 954 955 956 957 958 959 960
            if not SHARED_LIB:
                # Use a temporary variable to store the timer value
                tmp_id = 'tmp' + str(out['tmpVars'][0])
                local_decl.append('{} : aliased asn1SccT_UInt32;'
                                  .format(tmp_id))
                code.append('{tmp} := {val};'.format(tmp=tmp_id, val=t_val))
                code.append("SET_{timer}({value}'access);"
                            .format(timer=p_id, value=tmp_id))
            else:
                code.append('SET_{t}(New_String("{t}"), {val});'
                            .format(t=p_id, val=t_val))
Maxime Perrotin's avatar
Maxime Perrotin committed
961 962
            continue
        proc, out_sig = None, None
963
        is_out_sig = False
Maxime Perrotin's avatar
Maxime Perrotin committed
964 965 966
        try:
            out_sig, = [sig for sig in OUT_SIGNALS
                        if sig['name'].lower() == signal_name.lower()]
967
            is_out_sig = True if SHARED_LIB else False
Maxime Perrotin's avatar
Maxime Perrotin committed
968
        except ValueError:
969
            # Not an output, try if it is an external or inner procedure
Maxime Perrotin's avatar
Maxime Perrotin committed
970
            try:
971
                proc, = [sig for sig in PROCEDURES
Maxime Perrotin's avatar
Maxime Perrotin committed
972
                            if sig.inputString.lower() == signal_name.lower()]