AdaGenerator.py 115 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
    pr_path = ' '.join(parent.pr_files) if None not in parent.pr_files else ''
170 171 172 173 174
    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
181
cat {uniq} >> dataview-uniq.asn '''.format(pr=process_name.lower(),
Maxime Perrotin's avatar
Maxime Perrotin committed
182 183 184 185
                                           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
LD_LIBRARY_PATH=. opengeode-simulator
204
'''.format(pr=process_name.lower(),
205 206
           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;')

251 252
    process_level_decl.append('initDone : Boolean := False;')

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

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

Maxime Perrotin's avatar
Maxime Perrotin committed
274
    process_level_decl.append('end record;')
275
    process_level_decl.append('{ctxt}: {ctxt}_Ty;'.format(ctxt=LPREFIX))
276 277 278 279
    if simu:
        # Exhaustive simulation needs a backup of the context to quickly undo
        process_level_decl.append('{ctxt}_bk: {ctxt}_Ty;'.format(ctxt=LPREFIX))

280 281
    process_level_decl.append('CS_Only  : constant Integer := {};'
                              .format(len(process.transitions)))
282

Maxime Perrotin's avatar
Maxime Perrotin committed
283

284
    for name, val in process.mapping.viewitems():
Maxime Perrotin's avatar
Maxime Perrotin committed
285 286
        if name.endswith(u'START') and name != u'START':
            process_level_decl.append(u'{name} : constant := {val};'
287 288
                                      .format(name=name, val=str(val)))

289
    # Declare start procedure for aggregate states XXX add in C generator
290 291 292 293 294 295 296 297
    # 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);'
298 299
                                 .format(sub=subname.statename,
                                         sep=UNICODE_SEP)
300 301 302 303
                                 for subname in substates)
        aggreg_start_proc.extend([u'end {}{}START;'
                                 .format(name, UNICODE_SEP),
                                 '\n'])
304

305 306 307
    # 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
308

309
    # Generate the code of the start transition (if process not empty)
310 311 312 313 314 315 316 317 318 319 320 321
    if not simu:
        start_transition = ['begin',
                            'runTransition(0);'] if process.transitions else []
    else:
        start_transition = ['procedure Startup;',
                            'pragma Export(C, Startup, "{}_startup");'
                            .format(process_name),
                            'procedure Startup is',
                            'begin',
                            '   runTransition(0);' if process.transitions
                                                   else 'null;',
                            'end Startup;']
322

Maxime Perrotin's avatar
Maxime Perrotin committed
323 324 325 326 327
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
328 329
        if process.asn1Modules:
            asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
330 331 332 333 334 335 336 337
    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;

338
with Ada.Unchecked_Conversion;
339
with Ada.Numerics.Generic_Elementary_Functions;
340

Maxime Perrotin's avatar
Maxime Perrotin committed
341 342 343 344
{dataview}

with Interfaces;
use Interfaces;
345
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
346
package body {process_name} is'''.format(process_name=process_name,
347 348 349 350
                                         dataview=asn1_modules,
                                         C='with Interfaces.C.Strings;\n'
                                           'use Interfaces.C.Strings;'
                                            if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
351 352 353 354 355 356

    # 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
357
{C}
Maxime Perrotin's avatar
Maxime Perrotin committed
358 359

package {process_name} is'''.format(process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
360 361 362 363
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
364

Maxime Perrotin's avatar
Maxime Perrotin committed
365
    dll_api = []
366
    if simu:
367 368
        ads_template.append('--  API for simulation via DLL')
        dll_api.append('-- API to remotely change internal data')
369 370
        # Add function allowing to trace current state as a string
        process_level_decl.append("function get_state return chars_ptr "
371 372 373 374
                                  "is (New_String(states'Image({ctxt}.state)))"
                                  " with Export, Convention => C, "
                                  'Link_Name => "{name}_state";'
                                  .format(name=process_name, ctxt=LPREFIX))
375 376
        set_state_decl = "procedure set_state(new_state: chars_ptr)"
        ads_template.append("{};".format(set_state_decl))
377
        ads_template.append('pragma Export(C, set_state, "_set_state");')
378 379
        dll_api.append("{} is".format(set_state_decl))
        dll_api.append("begin")
380 381
        dll_api.append("{}.state := States'Value(Value(new_state));"
                       .format(LPREFIX))
382 383 384
        dll_api.append("end set_state;")
        dll_api.append("")

385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
        # Save/restore state allow one step undo, as needed for model checking
        save_state_decl = "procedure save_context"
        restore_state_decl = "procedure restore_context"
        ads_template.append("{};".format(save_state_decl))
        ads_template.append('pragma Export(C, save_context, "_save_context");')
        ads_template.append("{};".format(restore_state_decl))
        ads_template.append('pragma Export(C, restore_context, "_restore_context");')
        dll_api.append("{} is".format(save_state_decl))
        dll_api.append("begin")
        dll_api.append("{ctxt} := {ctxt}_bk;".format(ctxt=LPREFIX))
        dll_api.append("end save_context;")
        dll_api.append("")
        dll_api.append("{} is".format(restore_state_decl))
        dll_api.append("begin")
        dll_api.append("{ctxt}_bk := {ctxt};".format(ctxt=LPREFIX))
        dll_api.append("end restore_context;")
        dll_api.append("")

403 404 405 406 407 408 409 410 411 412 413
        # 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))

414 415 416
        # Functions to get gobal variables (length and value)
        for var_name, (var_type, _) in process.variables.viewitems():
            # Getters for local variables
417 418 419 420 421 422
# Removed size - this was needed by swig only, not ctypes
#           process_level_decl.append("function l_{name}_size return integer "
#                                    "is ({prefix}.{name}'Size/8) with Export,"
#                                    " Convention => C,"
#                                    ' Link_Name => "{name}_size";'
#                                    .format(prefix=LPREFIX, name=var_name))
423
            process_level_decl.append("function l_{name}_value"
424 425 426 427 428
                                     " return access {sort} "
                                     "is ({prefix}.{name}'access) with Export,"
                                     " Convention => C,"
                                     ' Link_Name => "{name}_value";'
                                     .format(prefix=LPREFIX, name=var_name,
429 430 431 432 433
                                              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))
434
            ads_template.append('pragma Export(C, dll_set_l_{name},'
435
                                ' "_set_{name}");'.format(name=var_name))
436 437
            dll_api.append('{} is'.format(setter_decl))
            dll_api.append('begin')
438
            dll_api.append('{}.{} := value.all;'.format(LPREFIX, var_name))
439 440 441
            dll_api.append('end dll_set_l_{};'.format(var_name))
            dll_api.append('')

Maxime Perrotin's avatar
Maxime Perrotin committed
442 443 444 445 446 447 448 449 450 451 452 453 454
    # 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)

455 456 457 458
    # Generate the code of the START procedures of state aggregations
    # XXX to be added to C generator
    taste_template.extend(aggreg_start_proc)

459 460 461
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
462 463 464
    # 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]:
465
        signame = signal.get('name', u'START')
Maxime Perrotin's avatar
Maxime Perrotin committed
466
        if signame == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
467
            continue
468
        pi_header = u'procedure {sig_name}'.format(sig_name=signame)
469
        param_name = signal.get('param_name') \
Maxime Perrotin's avatar
Maxime Perrotin committed
470
                                or u'{}_param'.format(signame)
Maxime Perrotin's avatar
Maxime Perrotin committed
471 472
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
473
            typename = type_name(signal['type'])
474
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
475
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
476 477

        # Add declaration of the provided interface in the .ads file
478
        ads_template.append(u'--  Provided interface "{}"'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
479
        ads_template.append(pi_header + ';')
480
        ads_template.append(u'pragma Export(C, {name}, "{proc}_{name}");'
481
                             .format(name=signame, proc=process_name))
482 483 484 485 486

        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 []
487
            minicv.append(aadl_template(signame, params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
488 489 490 491

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
492 493 494 495

        def execute_transition(state):
            ''' Generate the code that triggers the transition for the current
                state/input combination '''
496
            input_def = mapping[signame].get(state)
497
            # Check for nested states to call optional exit procedure
498
            state_tree = state.split(UNICODE_SEP)
Maxime Perrotin's avatar
Maxime Perrotin committed
499
            context = process
500 501 502 503 504 505
            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:
506
                    if current.lower() == comp.statename.lower():
507 508 509
                        if comp.exit_procedure:
                            exitlist.append(current)
                        context = comp
510
                        current = current + UNICODE_SEP
511 512 513 514
                        break
            for each in reversed(exitlist):
                if trans and all(each.startswith(trans_st)
                                 for trans_st in trans.possible_states):
515
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
516
                                          .format(ref=each, sep=UNICODE_SEP))
517

Maxime Perrotin's avatar
Maxime Perrotin committed
518 519 520 521
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
522 523
                    taste_template.append(u'{ctxt}.{inp} := {tInp}.all;'
                                          .format(ctxt=LPREFIX,
524 525
                                                  inp=inp,
                                                  tInp=param_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
526 527
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
528
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
529 530
                        idx=input_def.transition_id))
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
531
                    taste_template.append('runTransition(CS_Only);')
Maxime Perrotin's avatar
Maxime Perrotin committed
532
            else:
533
                taste_template.append('runTransition(CS_Only);')
534

535
        taste_template.append('case {}.state is'.format(LPREFIX))
536 537 538 539 540 541 542

        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
            '''
543
            if state.endswith(u'START'):
544
                return
545
            taste_template.append(u'when {state} =>'.format(state=state))
546
            input_def = mapping[signame].get(state)
547
            if state in aggregates.viewkeys():
548
                # State aggregation:
Maxime Perrotin's avatar
Maxime Perrotin committed
549 550
                # - find which substate manages this input
                # - add a swich case on the corresponding substate
551 552
                taste_template.append(u'-- this is a state aggregation')
                for sub in aggregates[state]:
553 554 555 556 557 558 559 560
                    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():
561
                            case_state(par)
562 563 564 565
                        taste_template.append('when others =>')
                        taste_template.append('null;')
                        taste_template.append('end case;')
                        break
566 567
                else:
                    # Input is not managed in the state aggregation
568 569 570
                    if input_def:
                        # check if it is managed one level above
                        execute_transition(state)
571
                    taste_template.append('null;')
Maxime Perrotin's avatar
Maxime Perrotin committed
572 573
            else:
                execute_transition(state)
574

575 576
        map(case_state, reduced_statelist) # XXX update C generator

Maxime Perrotin's avatar
Maxime Perrotin committed
577
        taste_template.append('when others =>')
578
        taste_template.append('runTransition(CS_Only);')
Maxime Perrotin's avatar
Maxime Perrotin committed
579
        taste_template.append('end case;')
580
        taste_template.append(u'end {};'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
581 582 583 584 585
        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:
586

587 588
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
589
        # Add (optional) RI parameter
590 591 592
        # 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
593
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
594
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
595
            typename = type_name(signal['type'])
596 597 598 599 600
            param_spec = u'({pName}: access {sort}{shared})' \
                         .format(pName=param_name,
                                 sort=typename,
                                 shared=u'; Size: Integer'
                                        if SHARED_LIB else '')
601 602 603
        ads_template.append(u'--  {}equired interface "{}"'
                            .format("Paramless r" if not 'type' in signal
                                else "R", signal['name']))
604 605 606 607
        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))
Maxime Perrotin's avatar
Maxime Perrotin committed
608 609 610 611 612
            ads_template.append(u'pragma Convention(Convention => C,'
                                u' Entity => {}_T);'.format(signal['name']))
            ads_template.append(u'RI{sep}{sig} : {sig}_T;'
                                .format(sep=UNICODE_SEP, sig=signal['name']))
            ads_template.append(u'procedure Register_{sig}(Callback: {sig}_T);'
613
                                .format(sig=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
614
            ads_template.append(u'pragma Export(C, Register_{sig},'
615 616
                                ' "register_{sig}");'
                                .format(sig=signal['name']))
617 618 619 620

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

Maxime Perrotin's avatar
Maxime Perrotin committed
623 624
            taste_template.append(u'procedure Register_{sig}'
                                  u'(Callback:{sig}_T) is'
625
                                  .format(sig=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
626 627 628 629 630
            taste_template.append(u'begin')
            taste_template.append(u'RI{sep}{sig} := Callback;'
                                  .format(sep=UNICODE_SEP, sig=signal['name']))
            taste_template.append(u'end Register_{};'.format(signal['name']))
            taste_template.append(u'')
631
        else:
Maxime Perrotin's avatar
Maxime Perrotin committed
632 633 634 635 636 637 638 639 640
            ads_template.append(u'procedure RI{}{}{};'
                                .format(UNICODE_SEP,
                                        signal['name'],
                                        param_spec))
            ads_template.append(u'pragma import(C, RI{sep}{sig},'
                                u' "{proc}_RI_{sig}");'
                                .format(sep=UNICODE_SEP,
                                        sig=signal['name'],
                                        proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
641 642

    # for the .ads file, generate the declaration of the external procedures
643
    for proc in (proc for proc in process.procedures if proc.external):
Maxime Perrotin's avatar
Maxime Perrotin committed
644 645 646
        ri_header = u'procedure RI{sep}{sig_name}'.format(
                                                     sep=UNICODE_SEP,
                                                     sig_name=proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
647
        params = []
648 649 650 651
        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
652
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
653
            typename = type_name(param['type'])
654
            params.append(u'{par[name]}: access {sort}{shared}'
Maxime Perrotin's avatar
Maxime Perrotin committed
655
                          .format(par=param,
656 657 658 659
                                  sort=typename,
                                  shared=u"; {}_Size: Integer"
                                         .format(param['name'])
                                         if SHARED_LIB else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
660
        if params:
661 662
            params_spec = "({})".format("; ".join(params))
            ri_header += params_spec
663 664
        ads_template.append(u'--  Sync required interface "{}"'
                            .format(proc.inputString))
665 666 667 668
        if simu:
            # As for async TM, generate a callback mechanism
            ads_template.append(u"type {}_T is access procedure{};"
                                .format(proc.inputString, params_spec))
Maxime Perrotin's avatar
Maxime Perrotin committed
669 670 671 672 673
            ads_template.append(u'pragma Convention(Convention => C,'
                                u' Entity => {}_T);'.format(proc.inputString))
            ads_template.append(u'RI{sep}{sig} : {sig}_T;'
                                .format(sep=UNICODE_SEP, sig=proc.inputString))
            ads_template.append(u'procedure Register_{sig}(Callback: {sig}_T);'
674
                                .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
675 676
            ads_template.append(u'pragma Export(C, Register_{sig},'
                                u' "register_{sig}");'
677
                                .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
678
            taste_template.append(u'procedure Register_{sig}'
679 680
                                  '(Callback:{sig}_T) is'
                                  .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
681 682 683 684 685 686
            taste_template.append(u'begin')
            taste_template.append(u'RI{sep}{sig} := Callback;'
                                  .format(sep=UNICODE_SEP,
                                          sig=proc.inputString))
            taste_template.append(u'end Register_{};'.format(proc.inputString))
            taste_template.append(u'')
687 688 689

        else:
            ads_template.append(ri_header + u';')
Maxime Perrotin's avatar
Maxime Perrotin committed
690 691 692 693 694
            ads_template.append(u'pragma import(C, RI{sep}{sig},'
                                u' "{proc}_RI_{sig}");'
                                .format(sep=UNICODE_SEP,
                                        sig=proc.inputString,
                                        proc=process_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
695 696 697

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
698 699 700 701 702
        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'
703
                                 '(name: chars_ptr; duration: Asn1Int);'
704
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
705 706
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
707
            for each in ('', 'RE'):
708 709
                ads_template.append(u'pragma Convention(Convention => C,'
                                    u' Entity => {re}SET_{t}_T);'
710
                                    .format(re=each, t=timer))
711
                ads_template.append(u'{re}SET_{t} : {re}SET_{t}_T;'
712
                                    .format(re=each, t=timer))
713 714
                ads_template.append(u'procedure Register_{re}SET_{t}'
                                    u'(Callback: {re}SET_{t}_T);'
715
                                    .format(re=each, t=timer))
716 717
                ads_template.append(u'pragma Export(C, Register_{re}SET_{t},'
                                    u' "register_{re}SET_{t}");'
718 719 720
                                    .format(re=each, t=timer))
            # Code for the SET/RESET timer callback registration
            for each in ('', 'RE'):
721 722
                taste_template.append(u'procedure Register_{re}SET_{t}'
                                      u'(Callback:{re}SET_{t}_T) is'
723
                                      .format(re=each, t=timer))
724 725
                taste_template.append(u'begin')
                taste_template.append(u'{re}SET_{t} := Callback;'
726
                                      .format(re=each, t=timer))
727
                taste_template.append(u'end Register_{re}SET_{t};'
728 729 730 731 732
                                      .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
733
                .format(timer))
734
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
735
                u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
736
                .format(timer=timer, proc=process_name))
737 738
            ads_template.append(u'procedure RESET_{};'.format(timer))
            ads_template.append(
Maxime Perrotin's avatar
Maxime Perrotin committed
739
                u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
Maxime Perrotin's avatar
Maxime Perrotin committed
740 741
                .format(timer=timer, proc=process_name))

742 743 744 745 746 747 748 749 750
    if simu and process.cs_mapping:
        # Callback registration for Check_Queue
        taste_template.append(u'procedure Register_Check_Queue'
                              u'(Callback: Check_Queue_T) is')
        taste_template.append(u'begin')
        taste_template.append(u'Check_Queue := Callback;')
        taste_template.append(u'end Register_Check_Queue;')
        taste_template.append(u'')

751 752 753 754 755 756
    # 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;')

757 758
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774

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

775 776 777 778
    # 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;')
779 780
        if process.cs_mapping:
            taste_template.append(
781
                              'msgPending : aliased Asn1Boolean := True;')
Maxime Perrotin's avatar
Maxime Perrotin committed
782

783 784 785
        # Declare the local variables needed by the transitions in the template
        taste_template.extend(set(local_decl_transitions))
        taste_template.append('begin')
786

787 788 789
        # 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
790

791 792
        # Generate the switch-case on the transition id
        taste_template.append('case trId is')
Maxime Perrotin's avatar
Maxime Perrotin committed
793

794 795 796 797 798 799 800
        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
801

802 803 804 805
        taste_template.append('when CS_Only =>')
        taste_template.append('trId := -1;')
        taste_template.append('goto next_transition;')

806 807 808 809 810 811 812 813
        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
814

815 816
        # Add the code for the floating labels
        taste_template.extend(code_labels)
Maxime Perrotin's avatar
Maxime Perrotin committed
817

818
        taste_template.append('<<next_transition>>')
819 820 821 822 823

        # 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
824 825
        # Check Queue: TODO implement when simu=True
        if process.cs_mapping and not simu:
826
            taste_template.append('--  Process continuous signals')
827
            taste_template.append('if {}.initDone then'.format(LPREFIX))
828 829
            taste_template.append("Check_Queue(msgPending'access);")
            taste_template.append('end if;')
830 831 832 833 834
            ads_template.append(
                    u'procedure Check_Queue(res: access Asn1Boolean);')
            ads_template.append(
                u'pragma import(C, Check_Queue, "{proc}_check_queue");'
                .format(proc=process_name))
835 836 837 838 839 840 841 842 843 844 845 846 847 848
        elif process.cs_mapping and simu:
            taste_template.append('if {}.initDone then'.format(LPREFIX))
            taste_template.append("Check_Queue(msgPending'access);")
            taste_template.append('end if;')
            # simulation: create a callback registration function
            ads_template.append(u'type Check_Queue_T is access procedure'
                                u'(res: access Asn1Boolean);')
            ads_template.append(u'pragma Convention(Convention => C,'
                                u' Entity => Check_Queue_T);')
            ads_template.append(u'Check_Queue : Check_Queue_T;')
            ads_template.append(u'procedure Register_Check_Queue'
                                u'(Callback: Check_Queue_T);')
            ads_template.append(u'pragma Export(C, Register_Check_Queue,'
                                ' "register_check_queue");')
849 850 851
        else:
            taste_template.append('null;')

852
        # Process the continuous signals in state aggregations first
853
        done = []
854 855
        sep = 'if '
        last = ''
856 857 858 859 860
        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():
861 862
                    taste_template.append(u'{first}if not msgPending and '
                            u'trId = -1 and '
863
                            u'{ctxt}.state = {s1} and '
864
                            u'{ctxt}.{s2}{unisep}state = {s3} then'
865
                            .format(ctxt=LPREFIX, s1=agg_name,
866
                                s2=each.statename, unisep=UNICODE_SEP,
867
                                s3=statename, first='els' if done else ''))
868 869 870 871 872 873 874 875 876
                    # Change priority 0 (no priority set) to lowest priority
                    lowest_priority = max(item.priority for item in cs_item)
                    for each in cs_item:
                        if each.priority == 0:
                            each.priority = lowest_priority + 1
                    for provided_clause in sorted(cs_item,
                                                 key=lambda itm: itm.priority):
                        taste_template.append(u'-- Priority {}'
                                             .format(provided_clause.priority))
877 878 879
                        trId = process.transitions.index\
                                            (provided_clause.transition)
                        code, loc = generate(provided_clause.trigger,
880 881 882
                                             branch_to=trId,
                                             sep=sep, last=last)
                        sep='elsif '
883
                        taste_template.extend(code)
884
                    done.append(statename)
885
                    taste_template.append(u'end if; -- inner')  # inner if
886
                    sep = 'if '
887 888 889
                    break
        for statename in process.cs_mapping.viewkeys() - done:
            cs_item = process.cs_mapping[statename]
890 891
            taste_template.append(u'{first}if not msgPending and '
                    u'trId = -1 and {}.state = {} then'
892
                    .format(LPREFIX, statename, first='els' if done else ''))
893 894 895 896 897 898 899 900 901
            # Change priority 0 (no priority set) to lowest priority
            lowest_priority = max(item.priority for item in cs_item)
            for each in cs_item:
                if each.priority == 0:
                    each.priority = lowest_priority + 1
            for provided_clause in sorted(cs_item,
                                          key=lambda itm: itm.priority):
                taste_template.append(u'-- Priority {}'
                                      .format(provided_clause.priority))
902 903
                trId = process.transitions.index(provided_clause.transition)
                code, loc = generate(provided_clause.trigger,
904 905
                                     branch_to=trId, sep=sep, last=last)
                sep='elsif '
906
                taste_template.extend(code)
907 908 909
            taste_template.append(u'end if;') # inner if
            taste_template.append(u'end if;') # current state
            sep = 'if '
910

911
        taste_template.append('end loop;')
912
        taste_template.append('{ctxt}.initDone := True;'.format(ctxt=LPREFIX))
913 914
        taste_template.append('end runTransition;')
        taste_template.append('\n')
Maxime Perrotin's avatar
Maxime Perrotin committed
915

916
    # Add code of the package elaboration
Maxime Perrotin's avatar
Maxime Perrotin committed
917 918 919 920 921 922 923
    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))

924
    with open(process_name.lower() + os.extsep + 'adb', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
925 926
        ada_file.write(
                u'\n'.join(format_ada_code(taste_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
927

928
    with open(process_name.lower() + os.extsep + 'ads', 'w') as ada_file:
Maxime Perrotin's avatar
Maxime Perrotin committed
929 930
        ada_file.write(
                u'\n'.join(format_ada_code(ads_template)).encode('latin1'))
Maxime Perrotin's avatar
Maxime Perrotin committed
931

932
    if simu:
Maxime Perrotin's avatar
Maxime Perrotin committed
933 934
        with open(u'{}_interface.aadl'
                  .format(process_name.lower()), 'w') as aadl:
935
            aadl.write(u'\n'.join(minicv).encode('latin1'))