AdaGenerator.py 141 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
    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).

64
    Copyright (c) 2012-2019 European Space Agency
Maxime Perrotin's avatar
Maxime Perrotin committed
65 66 67 68 69 70 71 72

    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 101 102 103 104 105 106 107 108 109

def is_numeric(string):
    ''' Return true if value is a number '''
    try:
        float(string)
    except ValueError:
        return False
    return True


110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
def external_ri_list(process):
    ''' Helper function: create a list of RI with proper signature
    Used for the formal parameters of generic packages when using process type
    '''
    result = []
    for signal in process.output_signals:
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
        param_spec = ''
        if 'type' in signal:
            typename = type_name(signal['type'])
            param_spec = u'({pName}: access {sort})'.format(pName=param_name,
                                                            sort=typename)
        result.append(u"procedure RI{sep}{name}{param}".format(sep=UNICODE_SEP,
                                                           name=signal['name'],
                                                           param=param_spec))
    for proc in (proc for proc in process.procedures if proc.external):
        ri_header = u'procedure RI{sep}{sig_name}'.format(
                                                     sep=UNICODE_SEP,
                                                     sig_name=proc.inputString)
        params = []
        params_spec = ''
        for param in proc.fpar:
            typename = type_name(param['type'])
            params.append(u'{par[name]}: access {sort}'.format(par=param,
                                                               sort=typename))
        if params:
            params_spec = u"({})".format("; ".join(params))
            ri_header += params_spec
        result.append(ri_header)
140 141

    for timer in process.timers:
142
        result.append(u"procedure Set_{}(val: access asn1SccT_Uint32)"
143
                      .format(timer))
144
        result.append(u"procedure Reset_{}"
145
                      .format(timer))
146 147 148
    return result


Maxime Perrotin's avatar
Maxime Perrotin committed
149
@singledispatch
150
def generate(*args, **kwargs):
Maxime Perrotin's avatar
Maxime Perrotin committed
151
    ''' Generate the code for an item of the AST '''
152
    raise TypeError('Incorrect, unsupported or missing data in model AST')
153
    return [], []
Maxime Perrotin's avatar
Maxime Perrotin committed
154 155


Maxime Perrotin's avatar
Maxime Perrotin committed
156
# Processing of the AST
Maxime Perrotin's avatar
Maxime Perrotin committed
157
@generate.register(ogAST.Process)
158
def _process(process, simu=False, instance=False, taste=False, **kwargs):
159 160 161 162
    ''' Generate the code for a complete process (AST Top level)
        use instance=True to generate the code for a process type instance
        rather than the process type itself.
    '''
163
    # support generation of code of a process type
164 165 166 167 168 169 170 171 172 173 174 175
    if not instance:
        process_name = process.instance_of_name or process.processName
        generic = process.instance_of_name  #  shortcut
        process_instance = process
        process = process.instance_of_ref or process
    else:
        process_name = process.processName
        generic = False
        process_instance = process

    if process_instance is not process:
        # Generate an instance of the process type, too.
176 177 178
        # First copy the list of timers to the instance (otherwise the
        # instance would miss some PIs and RIs to set the actual timers)
        process_instance.timers = process.timers
179
        generate(process_instance, simu, instance=True)
180

Maxime Perrotin's avatar
Maxime Perrotin committed
181 182 183 184 185 186
    global TYPES
    TYPES = process.dataview
    del OUT_SIGNALS[:]
    del PROCEDURES[:]
    OUT_SIGNALS.extend(process.output_signals)
    PROCEDURES.extend(process.procedures)
187
    global SHARED_LIB
188
    global LPREFIX
189 190
    if simu:
        SHARED_LIB = True
191
        LPREFIX = process_name + u'_ctxt'
Maxime Perrotin's avatar
Maxime Perrotin committed
192

193 194 195 196
    # taste-properties module-specific flag for the Ada backend:
    # import the state data from an external module
    import_context = kwargs["ppty_check"] if "ppty_check" in kwargs else ""

197 198 199 200 201 202 203 204 205 206 207
    # 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 = []
208 209 210 211 212
        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 ''
213 214 215 216 217 218
        # 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} '
219 220 221
                          '{{encoding=>Native;}};'.format(pname=param_name,
                                                          sort=sort,
                                                          io=direction))
222 223 224 225 226 227 228 229 230
        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)

231
    # bash script to simulate the system (TEMPORARY)
232 233 234 235 236 237 238 239

    # 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
240
    asn1_uniq = ' '.join(each for each in parent.asn1_filenames
241
                         if not each.endswith('dataview-uniq.asn'))
242
    pr_path = ' '.join(parent.pr_files) if None not in parent.pr_files else ''
243 244
    pr_names = ' '.join(
                      os.path.basename(pr_file) for pr_file in parent.pr_files)
Maxime Perrotin's avatar
Maxime Perrotin committed
245
    asn1_modules_o = (name.lower().replace('-', '_') + '.o'
246 247
                    for name in process.asn1Modules)

Maxime Perrotin's avatar
Maxime Perrotin committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
    asn1_mods = ("\"{}\"".format(mod.lower().replace('-', '_'))
                for mod in process.asn1Modules)

    #  Create a .gpr to build the library for the simulator
    lib_gpr = '''project {pr}_Lib is
   for Languages use ("Ada");
   for Library_Name use "{pr}";
   for Library_Interface use ("{pr}", "adaasn1rtl", {other_asn1_modules});
   for Object_Dir use "obj";
   for Library_Dir use "lib";
   for Library_Standalone use "encapsulated";
   for Library_Kind use "dynamic";
   for Source_Dirs use (".");
end {pr}_Lib;'''.format(pr=process_name.lower(),
                        other_asn1_modules=", ".join(asn1_mods))

    #  Create a .gpr to build the Ada generated code
    ada_gpr = '''project {pr}_Ada is
   for Languages use ("Ada");
Maxime Perrotin's avatar
Maxime Perrotin committed
267
      for Source_Dirs use (".") & External_As_List ("CODE_PATH", ":");
Maxime Perrotin's avatar
Maxime Perrotin committed
268 269 270
      for Object_Dir use "obj";
   end {pr}_Ada;'''.format(pr=process_name.lower())

271
    simu_script = '''#!/bin/bash -e
272 273 274 275 276
rm -rf {pr}_simu
mkdir -p {pr}_simu
cp {pr_path} {asn1} {pr}_simu
cd {pr}_simu
opengeode {pr_names} --shared
277
cat {uniq} >> dataview-uniq.asn '''.format(pr=process_name.lower(),
Maxime Perrotin's avatar
Maxime Perrotin committed
278 279 280 281
                                           asn1=asn1_filenames,
                                           pr_path=pr_path,
                                           uniq=asn1_uniq or '/dev/null',
                                           pr_names=pr_names)
282 283 284

    if asn1_filenames:
        simu_script += '''
285 286 287
mono $(which asn1.exe) -Ada -typePrefix asn1Scc -equal {asn1}
mono $(which asn1.exe) -c -typePrefix asn1Scc -equal {asn1}'''.format(
                                                           asn1=asn1_filenames)
288 289

    simu_script += '''
Maxime Perrotin's avatar
Maxime Perrotin committed
290
gprbuild -p -P ../{pr}_lib.gpr
291
rm -f dataview-uniq.c dataview-uniq.h
292
asn2aadlPlus dataview-uniq.asn DataView.aadl
293 294 295
aadl2glueC DataView.aadl {pr}_interface.aadl
asn2dataModel -toPython dataview-uniq.asn
make -f Makefile.python
296
echo "errCodes=$(taste-asn1-errCodes ./dataview-uniq.h)" >>datamodel.py
Maxime Perrotin's avatar
Maxime Perrotin committed
297
LD_LIBRARY_PATH=../lib:. opengeode-simulator
298
'''.format(pr=process_name.lower(),
299
           asn1_files=asn1_filenames,
Maxime Perrotin's avatar
Maxime Perrotin committed
300
           asn1_mod=' '.join(asn1_modules_o))
301

302

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

305
    # In case model has nested states, flatten everything
306
    Helper.flatten(process, sep=UNICODE_SEP)
307

308
    # Process State aggregations (Parallel states) XXX Add to C backend
309

310 311
    # Find recursively in the AST all state aggregations
    # Format: {'aggregation_name' : [list of ogAST.CompositeState]
312
    aggregates = Helper.state_aggregations(process)
313

314 315 316
    # 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)
317

Maxime Perrotin's avatar
Maxime Perrotin committed
318 319 320 321
    # 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
322 323 324
    VARIABLES.update(process.variables)

    process_level_decl = []
325

326
    # Establish the list of states (excluding START states) XXX update C backend
327
    full_statelist = set(chain(aggregates.viewkeys(),
328 329
                               (name for name in process.mapping.iterkeys()
                                    if not name.endswith(u'START'))))
330
    reduced_statelist = {s for s in full_statelist if s not in parallel_states}
Maxime Perrotin's avatar
Maxime Perrotin committed
331
    if aggregates:
332 333
        # Parallel states in a state aggregation may terminate
        full_statelist.add(u'{}finished'.format(UNICODE_SEP))
334

Maxime Perrotin's avatar
Maxime Perrotin committed
335
    context_decl = []
336
    if full_statelist:
Maxime Perrotin's avatar
Maxime Perrotin committed
337
        context_decl.append(u'type States is ({});'
338
                            .format(u', '.join(full_statelist) or u'No_State'))
339

340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
    # Generate ASN.1 model for the NEWTYPEs (types defined in SDL)
    if process.user_defined_types:
        asn1_template = [u'{}-Newtypes DEFINITIONS ::='.format(
            process_name.upper().replace('_', '-')), 'BEGIN']
        types_with_proper_case = []

        # The ASN.1 module must import the types from other asn1 modules
        for _, sortdef in process.user_defined_types.viewitems():
            sort = sortdef.type.type.ReferencedTypeName
            for moduleName, sorts in process.DV.exportedTypes.viewitems():
                for each in sorts:
                    if sort.lower().replace('-', '_') == \
                            each.lower().replace('-', '_'):
                        asn1_template.append(u'IMPORTS {t} FROM {m};'
                                .format (t=each, m=moduleName))
                        types_with_proper_case.append (each)

        for sortname, sortdef in process.user_defined_types.viewitems():
            rangeMin = sortdef.type.Min
            rangeMax = sortdef.type.Max
            refType  = sortdef.type.type.ReferencedTypeName
            for refTypeCase in types_with_proper_case:
                if refTypeCase.lower().replace('-', '_') == \
                        refType.lower().replace('-', '_'):
                    break
            asn1_template.append(
                    '{sort} ::= SEQUENCE (SIZE ({rangeMin} .. {rangeMax})) '
                    'OF {refType}'
                    .format(sort=sortname.upper().replace('_', '-'),
                            rangeMin=rangeMin,
                            rangeMax=rangeMax,
                            refType=refTypeCase.replace('_', '-')))
        asn1_template.append('END')
        with open(process_name + '_newtypes.asn', 'w') as asn1_file:
            asn1_file.write('\n'.join(asn1_template))
375

376
    # Generate the code to declare process-level context
Maxime Perrotin's avatar
Maxime Perrotin committed
377
    context_decl.extend(['type {}_Ty is'.format(LPREFIX), 'record'])
378

379
    if full_statelist:
Maxime Perrotin's avatar
Maxime Perrotin committed
380
        context_decl.append('state : States;')
381

Maxime Perrotin's avatar
Maxime Perrotin committed
382
    context_decl.append('initDone : Boolean := False;')
383

Maxime Perrotin's avatar
Maxime Perrotin committed
384
    # State aggregation: add list of substates (XXX to be added in C generator)
385 386
    for substates in aggregates.viewvalues():
        for each in substates:
Maxime Perrotin's avatar
Maxime Perrotin committed
387
            context_decl.append(u'{}{}state: States;'
388
                                      .format(each.statename, UNICODE_SEP))
Maxime Perrotin's avatar
Maxime Perrotin committed
389

Maxime Perrotin's avatar
Maxime Perrotin committed
390 391 392 393
    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
394
            dst, dstr, dlocal = expression(def_value)
395 396 397
            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
398
            assert not dst and not dlocal, 'DCL: Expecting a ground expression'
Maxime Perrotin's avatar
Maxime Perrotin committed
399
        context_decl.append(
400 401
                        u'{n} : aliased {sort}{default};'
                        .format(n=var_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
402 403
                                sort=type_name(var_type),
                                default=u' := ' + dstr if def_value else u''))
Maxime Perrotin's avatar
Maxime Perrotin committed
404

Maxime Perrotin's avatar
Maxime Perrotin committed
405
    context_decl.append('end record;')
406 407
    # context is aliased so that the model checker can work with access type
    context_decl.append('{ctxt}: aliased {ctxt}_Ty;'.format(ctxt=LPREFIX))
408
    if simu:
409 410
        # Export the context, so that it can be manipulated from outside
        # (in practice used by the "properties" module.
Maxime Perrotin's avatar
Maxime Perrotin committed
411
        context_decl.append(u'pragma export (C, {ctxt}, "{ctxt}");'
412
                                  .format(ctxt=LPREFIX))
413
        # Exhaustive simulation needs a backup of the context to quickly undo
Maxime Perrotin's avatar
Maxime Perrotin committed
414
        context_decl.append(u'{ctxt}_bk: {ctxt}_Ty;'
415 416 417 418 419
                                  .format(ctxt=LPREFIX))
    elif import_context:
        # Possibility to have the context defined outside the module
        # in order for a model checker to view/modify internals without any
        # copy at runtime
Maxime Perrotin's avatar
Maxime Perrotin committed
420
        context_decl.append(u'pragma import (C, ctxt, "{}_ctxt");'
421
                                  .format(import_context))
422

Maxime Perrotin's avatar
Maxime Perrotin committed
423
    if not simu and not instance:
Maxime Perrotin's avatar
Maxime Perrotin committed
424 425
        process_level_decl.extend(context_decl)

426
    aggreg_start_proc = []
Maxime Perrotin's avatar
Maxime Perrotin committed
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
    start_transition = []
    # Continuous State transition id
    if not instance:
        process_level_decl.append('CS_Only  : constant Integer := {};'
                                  .format(len(process.transitions)))

        for name, val in process.mapping.viewitems():
            # Test val, in principle there is a value but if the code targets
            # generation of properties, the model may have been cleant up and
            # in that case no value would be set..
            if name.endswith(u'START') and name != u'START' and val:
                process_level_decl.append(u'{name} : constant := {val};'
                                          .format(name=name, val=str(val)))

        # Declare start procedure for aggregate states XXX add in C generator
        # should create one START per "via" clause, TODO later
        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);'
                                     .format(sub=subname.statename,
                                             sep=UNICODE_SEP)
                                     for subname in substates)
            aggreg_start_proc.extend([u'end {}{}START;'
                                     .format(name, UNICODE_SEP),
                                     '\n'])

        # Add the declaration of the runTransition procedure
        process_level_decl.append('procedure runTransition(Id: Integer);')

        # Generate the code of the start transition (if process not empty)
        initDone =  u'{ctxt}.initDone := True;'.format(ctxt=LPREFIX)
        if not simu:
            start_transition = [u'begin']
            if process.transitions:
                start_transition.append(u'runTransition(0);')
            start_transition.append(initDone)
        else:
            start_transition = [u'procedure Startup is',
                                u'begin',
                                u'   runTransition(0);' if process.transitions
                                                       else 'null;',
                                initDone,
                                u'end Startup;']
473

Maxime Perrotin's avatar
Maxime Perrotin committed
474 475 476 477 478
    # Generate the TASTE template
    try:
        asn1_modules = '\n'.join(['with {dv};\nuse {dv};'.format(
            dv=dv.replace('-', '_'))
            for dv in process.asn1Modules])
479 480
        if process.asn1Modules:
            asn1_modules += '\nwith adaasn1rtl;\nuse adaasn1rtl;'
Maxime Perrotin's avatar
Maxime Perrotin committed
481 482
    except TypeError:
        asn1_modules = '--  No ASN.1 data types are used in this model'
483 484

    include_custom_types = u'''with {process_name}_newtypes;
485 486
use {process_name}_newtypes;'''.format(process_name=process_name) \
        if process.user_defined_types else u''
487

Maxime Perrotin's avatar
Maxime Perrotin committed
488
    taste_template = [u'''\
Maxime Perrotin's avatar
Maxime Perrotin committed
489 490 491 492 493
-- This file was generated automatically: DO NOT MODIFY IT !

with System.IO;
use System.IO;

494
with Ada.Unchecked_Conversion;
495
with Ada.Numerics.Generic_Elementary_Functions;
496

Maxime Perrotin's avatar
Maxime Perrotin committed
497
{dataview}
498
{custom_data_types}
Maxime Perrotin's avatar
Maxime Perrotin committed
499 500 501

with Interfaces;
use Interfaces;
502
{C}
503 504 505 506 507 508 509 510
package body {process_name} is'''.format(
    process_name=process_name,
    dataview=asn1_modules,
    custom_data_types=include_custom_types,
    C='with Interfaces.C.Strings;\n'
      'use Interfaces.C.Strings;'
      if simu else '') if not instance
                       else u"package body {} is".format(process_name)]
Maxime Perrotin's avatar
Maxime Perrotin committed
511

512
    generic_spec, instance_decl = "", ""
513 514 515 516 517
    if generic:
        generic_spec = u"generic\n"
        ri_list = external_ri_list(process)
        if ri_list:
            generic_spec += u"    with " + u";\n    with ".join(ri_list) + ';'
518 519 520
    if instance:
        instance_decl = u"with {};".format(process.instance_of_name)

Maxime Perrotin's avatar
Maxime Perrotin committed
521
    # Generate the source file (.ads) header
522
    ads_template = [u'''\
Maxime Perrotin's avatar
Maxime Perrotin committed
523 524 525
-- This file was generated automatically: DO NOT MODIFY IT !

{dataview}
Maxime Perrotin's avatar
Maxime Perrotin committed
526
{C}
527
{instance}
528
{generic}
529 530
package {process_name} is'''.format(generic=generic_spec,
                                    instance=instance_decl,
531
                                    process_name=process_name,
Maxime Perrotin's avatar
Maxime Perrotin committed
532 533 534 535
                                    dataview=asn1_modules,
                                    C='with Interfaces.C.Strings;\n'
                                      'use Interfaces.C.Strings;'
                                        if simu else '')]
Maxime Perrotin's avatar
Maxime Perrotin committed
536
    dll_api = []
537
    if simu:
Maxime Perrotin's avatar
Maxime Perrotin committed
538
        ads_template.extend(context_decl)
539 540
        ads_template.append('--  API for simulation via DLL')
        dll_api.append('-- API to remotely change internal data')
541 542
        # Add function allowing to trace current state as a string
        process_level_decl.append("function get_state return chars_ptr "
543 544 545 546
                                  "is (New_String(states'Image({ctxt}.state)))"
                                  " with Export, Convention => C, "
                                  'Link_Name => "{name}_state";'
                                  .format(name=process_name, ctxt=LPREFIX))
547 548
        set_state_decl = "procedure set_state(new_state: chars_ptr)"
        ads_template.append("{};".format(set_state_decl))
549
        ads_template.append('pragma Export(C, set_state, "_set_state");')
550 551
        dll_api.append("{} is".format(set_state_decl))
        dll_api.append("begin")
552 553
        dll_api.append("{}.state := States'Value(Value(new_state));"
                       .format(LPREFIX))
554 555 556
        dll_api.append("end set_state;")
        dll_api.append("")

557 558 559 560 561 562 563 564 565
        # 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")
566
        dll_api.append("{ctxt}_bk := {ctxt};".format(ctxt=LPREFIX))
567 568 569 570
        dll_api.append("end save_context;")
        dll_api.append("")
        dll_api.append("{} is".format(restore_state_decl))
        dll_api.append("begin")
571
        dll_api.append("{ctxt} := {ctxt}_bk;".format(ctxt=LPREFIX))
572 573 574
        dll_api.append("end restore_context;")
        dll_api.append("")

575 576 577 578 579
        # Declare procedure Startup in .ads
        ads_template.append(u'procedure Startup;')
        ads_template.append(u'pragma Export(C, Startup, "{}_startup");'
                            .format(process_name))

580 581 582 583 584 585 586 587 588 589 590
        # 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))

591 592
        # Functions to get gobal variables (length and value)
        for var_name, (var_type, _) in process.variables.viewitems():
593
            # Getters for external applications to view local variables via dll
594 595 596 597 598
            process_level_decl.append(u"function l_{name}_value"
                                     u" return access {sort} "
                                     u"is ({prefix}.{name}'access) with Export,"
                                     u" Convention => C,"
                                     u' Link_Name => "{name}_value";'
599
                                     .format(prefix=LPREFIX, name=var_name,
600 601
                                              sort=type_name(var_type)))
            # Setters for local variables
602
            setter_decl = u"procedure dll_set_l_{name}(value: access {sort})"\
603
                          .format(name=var_name, sort=type_name(var_type))
604 605
            ads_template.append(u'{};'.format(setter_decl))
            ads_template.append(u'pragma Export(C, dll_set_l_{name},'
606
                                ' "_set_{name}");'.format(name=var_name))
607 608 609 610
            dll_api.append(u'{} is'.format(setter_decl))
            dll_api.append(u'begin')
            dll_api.append(u'{}.{} := value.all;'.format(LPREFIX, var_name))
            dll_api.append(u'end dll_set_l_{};'.format(var_name))
611 612
            dll_api.append('')

Maxime Perrotin's avatar
Maxime Perrotin committed
613 614 615 616 617 618
    # 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)
619 620 621 622
        if proc.exported:
            # Exported procedures must be declared in the .ads
            pi_header = procedure_header(proc)
            ads_template.append(u'{};'.format(pi_header))
623
            if not proc.external and not generic:
624 625 626 627
                ads_template.append(u'pragma Export'
                                    u'(C, p{sep}{proc_name}, "_{proc_name}");'
                                    .format(sep=UNICODE_SEP,
                                            proc_name=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
628 629 630 631 632 633 634

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

635 636 637 638
    # Generate the code of the START procedures of state aggregations
    # XXX to be added to C generator
    taste_template.extend(aggreg_start_proc)

639 640 641
    # Add the code of the DLL interface
    taste_template.extend(dll_api)

Maxime Perrotin's avatar
Maxime Perrotin committed
642 643 644
    # 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]:
645
        signame = signal.get('name', u'START')
Maxime Perrotin's avatar
Maxime Perrotin committed
646
        if signame == u'START':
Maxime Perrotin's avatar
Maxime Perrotin committed
647
            continue
648
        pi_header = u'procedure {sig_name}'.format(sig_name=signame)
649
        param_name = signal.get('param_name') \
Maxime Perrotin's avatar
Maxime Perrotin committed
650
                                or u'{}_param'.format(signame)
Maxime Perrotin's avatar
Maxime Perrotin committed
651 652
        # Add (optional) PI parameter (only one is possible in TASTE PI)
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
653
            typename = type_name(signal['type'])
654
            pi_header += u'({pName}: access {sort})'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
655
                                        pName=param_name, sort=typename)
Maxime Perrotin's avatar
Maxime Perrotin committed
656 657

        # Add declaration of the provided interface in the .ads file
658
        ads_template.append(u'--  Provided interface "{}"'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
659
        ads_template.append(pi_header + ';')
660
        if not generic:
661 662 663
            ads_template.append(
                    u'pragma Export(C, {name}, "{proc}_PI_{name}");'
                     .format(name=signame.lower(), proc=process_name.lower()))
664 665 666 667 668

        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 []
669
            minicv.append(aadl_template(signame, params, 'RI'))
Maxime Perrotin's avatar
Maxime Perrotin committed
670 671 672 673

        pi_header += ' is'
        taste_template.append(pi_header)
        taste_template.append('begin')
674 675 676 677

        def execute_transition(state):
            ''' Generate the code that triggers the transition for the current
                state/input combination '''
678
            input_def = mapping[signame].get(state)
679
            # Check for nested states to call optional exit procedure
680
            state_tree = state.split(UNICODE_SEP)
Maxime Perrotin's avatar
Maxime Perrotin committed
681
            context = process
682 683 684 685 686 687
            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:
688
                    if current.lower() == comp.statename.lower():
689 690 691
                        if comp.exit_procedure:
                            exitlist.append(current)
                        context = comp
692
                        current = current + UNICODE_SEP
693 694 695 696
                        break
            for each in reversed(exitlist):
                if trans and all(each.startswith(trans_st)
                                 for trans_st in trans.possible_states):
697
                    taste_template.append(u'p{sep}{ref}{sep}exit;'
698
                                          .format(ref=each, sep=UNICODE_SEP))
699

Maxime Perrotin's avatar
Maxime Perrotin committed
700 701 702 703
            if input_def:
                for inp in input_def.parameters:
                    # Assign the (optional and unique) parameter
                    # to the corresponding process variable
704 705
                    taste_template.append(u'{ctxt}.{inp} := {tInp}.all;'
                                          .format(ctxt=LPREFIX,
706 707
                                                  inp=inp,
                                                  tInp=param_name))
Maxime Perrotin's avatar
Maxime Perrotin committed
708 709
                # Execute the correponding transition
                if input_def.transition:
Maxime Perrotin's avatar
Maxime Perrotin committed
710
                    taste_template.append(u'runTransition({idx});'.format(
Maxime Perrotin's avatar
Maxime Perrotin committed
711 712
                        idx=input_def.transition_id))
                else:
Maxime Perrotin's avatar
Maxime Perrotin committed
713
                    taste_template.append('runTransition(CS_Only);')
Maxime Perrotin's avatar
Maxime Perrotin committed
714
            else:
715
                taste_template.append('runTransition(CS_Only);')
716

Maxime Perrotin's avatar
Maxime Perrotin committed
717 718
        if not instance:
            taste_template.append('case {}.state is'.format(LPREFIX))
719 720 721 722 723 724 725

        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
            '''
726
            if state.endswith(u'START'):
727
                return
728
            taste_template.append(u'when {state} =>'.format(state=state))
729
            input_def = mapping[signame].get(state)
730
            if state in aggregates.viewkeys():
731
                # State aggregation:
Maxime Perrotin's avatar
Maxime Perrotin committed
732 733
                # - find which substate manages this input
                # - add a swich case on the corresponding substate
734 735
                taste_template.append(u'-- this is a state aggregation')
                for sub in aggregates[state]:
736 737 738 739 740 741 742 743
                    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():
744
                            case_state(par)
745 746 747 748
                        taste_template.append('when others =>')
                        taste_template.append('null;')
                        taste_template.append('end case;')
                        break
749 750
                else:
                    # Input is not managed in the state aggregation
751 752 753
                    if input_def:
                        # check if it is managed one level above
                        execute_transition(state)
754
                    taste_template.append('null;')
Maxime Perrotin's avatar
Maxime Perrotin committed
755 756
            else:
                execute_transition(state)
757

Maxime Perrotin's avatar
Maxime Perrotin committed
758 759 760 761 762 763 764 765 766 767
        if not instance:
            map(case_state, reduced_statelist) # XXX update C generator
            taste_template.append('when others =>')
            taste_template.append('runTransition(CS_Only);')
            taste_template.append('end case;')
        else:
            inst_call = u"{}_Instance.{}".format(process_name, signame)
            if 'type' in signal:
                inst_call += u"({})".format(param_name)
            taste_template.append(inst_call + ";")
768 769

        taste_template.append(u'end {};'.format(signame))
Maxime Perrotin's avatar
Maxime Perrotin committed
770 771 772 773 774
        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:
775

776 777
        param_name = signal.get('param_name') \
                                or u'{}_param'.format(signal['name'])
Maxime Perrotin's avatar
Maxime Perrotin committed
778
        # Add (optional) RI parameter
779 780 781
        # 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
782
        param_spec = '' if not simu else "(tm: chars_ptr)"
Maxime Perrotin's avatar
Maxime Perrotin committed
783
        if 'type' in signal:
Maxime Perrotin's avatar
Maxime Perrotin committed
784
            typename = type_name(signal['type'])
785 786 787 788 789
            param_spec = u'({pName}: access {sort}{shared})' \
                         .format(pName=param_name,
                                 sort=typename,
                                 shared=u'; Size: Integer'
                                        if SHARED_LIB else '')
790 791 792 793
        if not generic:
            ads_template.append(u'--  {}equired interface "{}"'
                                .format("Paramless r" if not 'type' in signal
                                    else "R", signal['name']))
794 795 796 797
        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
798 799 800 801 802
            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);'
803
                                .format(sig=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
804
            ads_template.append(u'pragma Export(C, Register_{sig},'
805 806
                                ' "register_{sig}");'
                                .format(sig=signal['name']))
807 808 809 810

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

Maxime Perrotin's avatar
Maxime Perrotin committed
813 814
            taste_template.append(u'procedure Register_{sig}'
                                  u'(Callback:{sig}_T) is'
815
                                  .format(sig=signal['name']))
Maxime Perrotin's avatar
Maxime Perrotin committed
816 817 818 819 820
            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'')
821
        elif not generic:
Maxime Perrotin's avatar
Maxime Perrotin committed
822 823 824 825
            ads_template.append(u'procedure RI{}{}{};'
                                .format(UNICODE_SEP,
                                        signal['name'],
                                        param_spec))
Maxime Perrotin's avatar
Maxime Perrotin committed
826 827
            signame = signal['name'].lower() if taste else signal['name']
            procname = process_name.lower() if taste else process_name
Maxime Perrotin's avatar
Maxime Perrotin committed
828 829 830
            ads_template.append(u'pragma import(C, RI{sep}{sig},'
                                u' "{proc}_RI_{sig}");'
                                .format(sep=UNICODE_SEP,
831 832
                                        sig=signame,
                                        proc=procname))
Maxime Perrotin's avatar
Maxime Perrotin committed
833 834

    # for the .ads file, generate the declaration of the external procedures
835
    for proc in (proc for proc in process.procedures if proc.external):
Maxime Perrotin's avatar
Maxime Perrotin committed
836 837 838
        ri_header = u'procedure RI{sep}{sig_name}'.format(
                                                     sep=UNICODE_SEP,
                                                     sig_name=proc.inputString)
Maxime Perrotin's avatar
Maxime Perrotin committed
839
        params = []
840 841 842 843
        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
844
        for param in proc.fpar:
Maxime Perrotin's avatar
Maxime Perrotin committed
845
            typename = type_name(param['type'])
846
            params.append(u'{par[name]}: access {sort}{shared}'
Maxime Perrotin's avatar
Maxime Perrotin committed
847
                          .format(par=param,
848 849 850 851
                                  sort=typename,
                                  shared=u"; {}_Size: Integer"
                                         .format(param['name'])
                                         if SHARED_LIB else ""))
Maxime Perrotin's avatar
Maxime Perrotin committed
852
        if params:
853 854
            params_spec = "({})".format("; ".join(params))
            ri_header += params_spec
855 856
        ads_template.append(u'--  Sync required interface "{}"'
                            .format(proc.inputString))
857 858 859 860
        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
861 862 863 864 865
            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);'
866
                                .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
867 868
            ads_template.append(u'pragma Export(C, Register_{sig},'
                                u' "register_{sig}");'
869
                                .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
870
            taste_template.append(u'procedure Register_{sig}'
871 872
                                  '(Callback:{sig}_T) is'
                                  .format(sig=proc.inputString))
Maxime Perrotin's avatar
Maxime Perrotin committed
873 874 875 876 877 878
            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'')
879

880
        elif not generic:
881
            ads_template.append(ri_header + u';')
Maxime Perrotin's avatar
Maxime Perrotin committed
882 883
            signame = proc.inputString.lower() if taste else proc.inputString
            procname = process_name.lower() if taste else process_name
Maxime Perrotin's avatar
Maxime Perrotin committed
884 885 886
            ads_template.append(u'pragma import(C, RI{sep}{sig},'
                                u' "{proc}_RI_{sig}");'
                                .format(sep=UNICODE_SEP,
887 888
                                        sig=signame,
                                        proc=procname))
Maxime Perrotin's avatar
Maxime Perrotin committed
889 890 891

    # for the .ads file, generate the declaration of timers set/reset functions
    for timer in process.timers:
892 893 894 895 896
        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'
897
                                 '(name: chars_ptr; duration: Asn1Int);'
898
                                .format(timer))
Maxime Perrotin's avatar
Maxime Perrotin committed
899 900
            ads_template.append(u'type RESET_{}_T is access procedure'
                                '(name: chars_ptr);'.format(timer))
901
            for each in ('', 'RE'):
902 903
                ads_template.append(u'pragma Convention(Convention => C,'
                                    u' Entity => {re}SET_{t}_T);'
904
                                    .format(re=each, t=timer))
905
                ads_template.append(u'{re}SET_{t} : {re}SET_{t}_T;'
906
                                    .format(re=each, t=timer))
907 908
                ads_template.append(u'procedure Register_{re}SET_{t}'
                                    u'(Callback: {re}SET_{t}_T);'
909
                                    .format(re=each, t=timer))
910 911
                ads_template.append(u'pragma Export(C, Register_{re}SET_{t},'
                                    u' "register_{re}SET_{t}");'
912 913 914
                                    .format(re=each, t=timer))
            # Code for the SET/RESET timer callback registration
            for each in ('', 'RE'):
915 916
                taste_template.append(u'procedure Register_{re}SET_{t}'
                                      u'(Callback:{re}SET_{t}_T) is'
917
                                      .format(re=each, t=timer))
918 919
                taste_template.append(u'begin')
                taste_template.append(u'{re}SET_{t} := Callback;'
920
                                      .format(re=each, t=timer))
921
                taste_template.append(u'end Register_{re}SET_{t};'
922 923 924
                                      .format(re=each, t=timer))
                taste_template.append('')

925 926 927 928
        elif not generic:
            ads_template.append(
               u'procedure SET_{}(val: access asn1SccT_UInt32);'.format(timer))
            ads_template.append(
929 930
                    u'pragma import(C, SET_{timer}, "{proc}_RI_set_{timer}");'
                    .format(timer=timer, proc=process_name))
931
            ads_template.append(u'procedure RESET_{};'.format(timer))
932
            ads_template.append(
933 934
                 u'pragma import(C, RESET_{timer}, "{proc}_RI_reset_{timer}");'
                 .format(timer=timer, proc=process_name))
935 936 937 938
        else:
            # Generic functions get the SET and RESET from template
            pass

Maxime Perrotin's avatar
Maxime Perrotin committed
939

940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956
    if instance:
        # Instance of a process type, all the RIs (including timers) must
        # be gathered to instantiate the package
        pkg_decl = (u"package {}_Instance is new {}"
                    .format(process_name, process.instance_of_name))
        ri_list = [u"RI{sep}{name}".format(sep=UNICODE_SEP, name=sig['name'])
                   for sig in process.output_signals]
        ri_list.extend ([u"RI{sep}{name}".format(sep=UNICODE_SEP,
                                                 name=proc.inputString)
                        for proc in process.procedures if proc.external])
        ri_list.extend([u"set_{}".format(timer) for timer in process.timers])
        ri_list.extend([u"reset_{}".format(timer) for timer in process.timers])
        ri_inst = [u"{ri} => {ri}".format(ri=ri) for ri in ri_list]
        if ri_inst:
            pkg_decl += u" ({})".format(u", ".join(ri_inst))
        ads_template.append(pkg_decl + u";")

957 958 959 960 961 962 963 964 965
    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'')

966 967 968 969 970 971
    # 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;')

972 973
    # Transform inner labels to floating labels
    Helper.inner_labels_to_floating(process)
Maxime Perrotin's avatar
Maxime Perrotin committed
974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989

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

990
    # Generate the code of the runTransition procedure, if needed
Maxime Perrotin's avatar
Maxime Perrotin committed
991
    if process.transitions and not instance:
992 993
        taste_template.append('procedure runTransition(Id: Integer) is')
        taste_template.append('trId : Integer := Id;')
994 995
        if process.cs_mapping:
            taste_template.append(
996
                              'msgPending : aliased Asn1Boolean := True;')
Maxime Perrotin's avatar
Maxime Perrotin committed
997

998 999 1000
        # Declare the local variables needed by the transitions in the template
        taste_template.extend(set(local_decl_transitions))
        taste_template.append('begin')
1001

1002 1003 1004
        # 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
1005

1006 1007
        # Generate the switch-case on the transition id
        taste_template.append('case trId is')
Maxime Perrotin's avatar
Maxime Perrotin committed
1008

1009 1010 1011 1012 1013 1014 1015
        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
1016

1017 1018 1019 1020
        taste_template.append('when CS_Only =>')
        taste_template.append('trId := -1;')
        taste_template.append('goto next_transition;')

1021 1022 1023 1024 1025 1026 1027 1028
        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
1029

1030 1031
        # Add the code for the floating labels
        taste_template.extend(code_labels)
Maxime Perrotin's avatar
Maxime Perrotin committed
1032

1033
        taste_template.append('<<next_transition>>')
1034 1035 1036 1037 1038

        # 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