Kazoo skeletons and glue templates

From TASTE
Revision as of 14:37, 13 December 2019 by Kgrochowski (talk | contribs)
Jump to: navigation, search

This page lists all files present in each code skeleton and glue templates. For each file it's parameters are described. Templates are processed according to code skeletons and glue code generation algorithms.

Skeleton code templates are stored in templates/skeletons kazoo subdirectory, glue code templates are stored in templates/glue/language_wrappers kazoo subdirectory.

makefile.tmplt

This template is present only in code skeleton templates directory. This template is evaluated only once per system. The output is saved to the Makefile within output directory.

context-parameters.tmplt

This template is present only in code skeleton templates directory. This template is evaluated once for every function which has context parameters. The output is saved to the file Context-<function name>.asn

Parameter name Description
Name Function name
Sort_Set Set of types used for this Context Parameter file
Module_Set ... corresponding module (needed for ASN.1 "IMPORTS")
CP_Name Table of context parameter names
CP_Sort ... corresponding ASN.1 type
CP_ASN1_Module ... in ASN.1 module
CP_Value ... with default value

<template-subdir>/makefile.tmplt

This template is processed when Makefile file name returned by Makefile name template is not empty. The output of this template is saved using selected file name in directory <functionname>/<languagename>

Parameter name Description
Function_Names Combined table: list of function names...
Language ... and corresponding implementation language
Is_Type ... and flag if it is a function type
Has_Context_Param ... and flag to indicate if function has context parameters
CP_Files List of all context parameters ASN.1 files
Unique_Languages List of all languages used in the system
ASN1_Files List of all ASN.1 files
ACN_Files List of all ACN files
ASN1_Modules List of all ASN.1 modules

<template-subdir>/trigger.tmplt

This template is evaluated to check if other files from given directory should be processed. If the result of evaluation is equal to "TRUE", then other files will be processed. This template is identical for Skeleton and Glue subfolders.

Parameter name Description
Name The name of the function
Is_Type True if function type
Instance_Of Name of instance or empty string
Language Implementation language for the function
Filename_Is_Present True if target function output already exists
Makefile_Is_Present True if target build script already exists
Zip_File Optional path to zip file
Use_POHIC Command line configuration
Deployment_View DOCUMENTATION MISSING
Interface_View DOCUMENTATION MISSING
Binary_Path DOCUMENTATION MISSING
Output_Dir DOCUMENTATION MISSING
Skeletons DOCUMENTATION MISSING
List_Of_PIs DOCUMENTATION MISSING
ASync_PI_Param_Name DOCUMENTATION MISSING
Data_View DOCUMENTATION MISSING
List_Of_ASync_PIs DOCUMENTATION MISSING
List_Of_RIs DOCUMENTATION MISSING
ASync_RI_Param_Type DOCUMENTATION MISSING
Property_Values DOCUMENTATION MISSING
CP_Names DOCUMENTATION MISSING
Timers DOCUMENTATION MISSING
List_Of_ASync_RIs DOCUMENTATION MISSING
RIs_Have_Params DOCUMENTATION MISSING
CP_Types DOCUMENTATION MISSING
CP_Asn1Modules DOCUMENTATION MISSING
Async_RIs_Parent DOCUMENTATION MISSING
Sync_RIs_Parent DOCUMENTATION MISSING
Other_Files DOCUMENTATION MISSING
ASync_RI_Param_Name DOCUMENTATION MISSING
Debug_Flag DOCUMENTATION MISSING
Timer_Resolution DOCUMENTATION MISSING
List_Of_Sync_RIs DOCUMENTATION MISSING
Glue DOCUMENTATION MISSING
CP_Values DOCUMENTATION MISSING
Property_Names DOCUMENTATION MISSING
List_Of_Sync_PIs DOCUMENTATION MISSING
Has_Context DOCUMENTATION MISSING
Check_Data_View DOCUMENTATION MISSING
PIs_Have_Params DOCUMENTATION MISSING
CP_Asn1Filenames DOCUMENTATION MISSING
ASync_PI_Param_Type DOCUMENTATION MISSING
No_Stdlib_Flag DOCUMENTATION MISSING

<template-subdir>/makefile-filename.tmplt

This file is optional, if it exists the result of processing is a file name for the output of Makefile template, otherwise file name will be empty.

Parameter name Description
Name The name of the function

<template-subdir>/function-filename.tmplt

This file is optional, if it exists the result of processing is a file name for the output of function template, otherwise file name will be empty.

Parameter name Description
Name The name of the function

<template-subdir>/interface.tmplt

This file is processed for each required and provided interfaces of the function. Results of processing are passed to function template.

Parameter name Description
Name The name of the interface
Direction "PI" or "RI"
Kind The RCM Kind
Parent_Function The name of the function
Language The implementation language of the function
Property_Names All AADL properties (names) associated to the function
Property_Values ... and corresponding values
Param_Names List of parameter names
Param_Types _ Corresponding parameter types
Param_Directions _ Corresponding direction
Param_Encodings _ Corresponding ASN.1 encoding
Is_Timer Flag set to true if this is a timer interface
Period Property of the interface
WCET Property of the interface
Queue_Size Property of the interface
IF_Property_Names and Values User-defined properties (vector tag)
Remote_Languages DOCUMENTATION MISSING
Param_ASN1_Modules DOCUMENTATION MISSING
IF_Property_Values DOCUMENTATION MISSING
Remote_Interface_Names DOCUMENTATION MISSING
Remote_Function_Names DOCUMENTATION MISSING

<template-subdir>/function.tmplt