Wiki source code of Project Creation, Initialization and Launch (Prom)
Version 30.1 by aas2 on 2015/08/24 10:20
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | = Prom - Project Management in KIELER = |
| 2 | |||
| 3 | **Topics** | ||
| 4 | |||
| 5 | |||
| 6 | |||
| 7 | {{toc minLevel="2"/}} | ||
| 8 | |||
| 9 | ---- | ||
| 10 | |||
| 11 | == Overview == | ||
| 12 | |||
| 13 | The KIELER Compiler (KiCo) can generate different code targets from models. For example it is possible to generate C and Java code from an SCT file. As a result KIELER has to integrate with existing development tools and practices for the C and Java world. In the context of embedded systems, the target device also varies heavily. | ||
| 14 | |||
| |
12.1 | 15 | Therefore the KIELER Project Management (Prom) has been developed. It eases the creation, compilation and deployment of projects, when using models that can be compiled via KiCo (e.g. SCCharts, Esterel). Furthermore it eases the creation of wrapper code, which is used to initialize and run the model. To do so, there are mainly three components: An Eclipse //Launch Configuration//, so called //Environments//, and //Project Wizards,// which will be introduces in the following. |
| |
1.1 | 16 | |
| 17 | ---- | ||
| 18 | |||
| |
8.1 | 19 | == The KiCo Launch Configuration == |
| 20 | |||
| |
11.1 | 21 | Prom provides a launch configuration (launch config) to |
| |
8.1 | 22 | |
| |
11.1 | 23 | 1. compile code from models via KiCo |
| 24 | 1. at the same time, generate wrapper code for these model files | ||
| |
14.1 | 25 | 1. afterwards, execute arbitrary shell commands sequentially, if the KiCo compilation and wrapper code generation finished successfully |
| |
11.1 | 26 | |
| |
27.1 | 27 | KiCo launch configurations work per project basis, thus every project has to create its own launch config. This is done automatically when performing //Right Click > Run As > KiCo Compilation //(% style="color: rgb(0,51,102);" %)on a model file. |
| |
11.1 | 28 | |
| |
14.1 | 29 | The **Run As** command will search for a KiCo launch config for the project. If there is such a config, the selected file is only added to the list of model files which should be compiled. If there is none, a launch config is created by using the main file and environment the project has been created with. If the main file and environment information could not be found, dialogs will query it from the user. |
| |
12.1 | 30 | |
| |
15.1 | 31 | The **main file** of the launch config is used to set several file path variables, which can be used in several fields of the configuration, notably the shell commands to be executed, and wrapper code input. To use a variablethe syntax is **${**//variable_name//**}**. The variables that are set are |
| |
14.1 | 32 | |
| 33 | * //main_name// : The file name, including its file extension (e.g. //MyModel.sct//) | ||
| 34 | * //main_path// : The project relative path (e.g. //src/MyModel.sct//) | ||
| 35 | * //main_loc// : The absolute file system path (e.g. ///home/me/workspace/MyProject/src/MyModel.sct//) | ||
| 36 | * //main_name_no_ext// : The file name without its file extension (e.g. //MyModel//) | ||
| 37 | |||
| 38 | Further, similar variables for the compiled main path are set, that is, the main file in the directory of kieler generated files (see below) | ||
| 39 | |||
| 40 | * //compiled_main_name// : The file name, including its file extension (e.g. //MyModel.sct//) | ||
| 41 | * //compiled_//main_path : The project relative path (e.g. //kieler-gen/MyModel.sct//) | ||
| 42 | * //compiled_//main_loc : The absolute file system path (e.g. ///home/me/workspace/MyProject/kieler-gen/MyModel.sct//) | ||
| 43 | * //compiled_//main_name_no_ext : The file name without its file extension (e.g. //MyModel//) | ||
| 44 | |||
| |
27.1 | 45 | //**Note:**// The variables are created in the first KiCo launch. So if you want to select them in a variable selection dialog of Eclipse, you must have started at least one KiCo launch configuration. |
| |
14.1 | 46 | |
| |
27.1 | 47 | [[image:attach:variable_selection_dialog.png]] |
| 48 | |||
| |
15.1 | 49 | The values of the launch config can also be **(re)set to an environment**. This will revert the fields for the compilation target, wrapper code generation and command execution. |
| 50 | |||
| 51 | The **compilation via KiCo** is configured on the //Compilation// tab. Here you can add/remove files that should be compiled via KiCo and the target language as well as the file extension for the language (such as //.java// for Java). The files will be compiled sequentially in order of appearance in the list. Further, it is possible to add a file path to a template for the output. This is useful to add surrounding content to the KiCo output. The placeholder //${kico_code}// can be used in the template. | ||
| 52 | |||
| |
18.1 | 53 | On the //Execute// tab, a list of **shell commands** can be added. They are typically used to further compile the KiCo and wrapper code output and afterwards deploy the result to the target platform. The commands are executed sequentially in order as they appear in the list, after the KiCo compilation and wrapper code generation finished successfully. If a command fails (returns a non-zero exit code), following commands will not be excuted. The name of commands have to be unique and must not contain a comma. |
| |
15.1 | 54 | |
| |
27.1 | 55 | [[image:attach:launch_config_tabs.png]] |
| |
15.1 | 56 | |
| |
27.1 | 57 | The standard streams of executed shell commands (stdin, stderr, stdout), as well as errors from the KiCo compilation and wrapper code generation, are printed to the **Console View**. |
| 58 | |||
| 59 | [[image:attach:console_view.png]] | ||
| 60 | |||
| |
11.1 | 61 | === Launch Groups === |
| 62 | |||
| |
22.1 | 63 | The list of shell commands are a simple mechanism to further compile and deploy code via command line tools. However, there are cases in which command line tools are not available or reasonable to use, for example because a different Eclipse launch configuration does a better job. |
| |
15.1 | 64 | |
| |
27.1 | 65 | In this case it is desirable that the KiCo launch config only compiles the model and another Eclipse launch config does the rest. This can be achieved via //launch groups//. They let you define a launch configuration, which starts other launch configurations sequentially. To illustrate this, another use-case for launch groups is that you have a Client-Server application and wants to start the client right after the server for debugging. Then you can create a launch config for the server and a launch config for the client. Afterwards you create a launch group with aforesaid configurations. |
| |
22.1 | 66 | |
| |
27.1 | 67 | [[image:attach:launch_group.png]] |
| 68 | |||
| |
22.1 | 69 | Launch groups are a part of the C/C++ Development Tools (CDT), although they provide a general mechanism that could be a part of any Eclipse IDE. The CDT is available in the Eclipse Marketplace (//Help > Eclipse Marketplace//) |
| 70 | |||
| |
26.1 | 71 | ---- |
| 72 | |||
| |
1.1 | 73 | == Prom Environments == |
| 74 | |||
| |
30.1 | 75 | Environments are used to provide default settings for project creation and launch. They are configured in the **preferences** (//Window //>// Preferences > KIELER > Environments//). |
| |
1.1 | 76 | |
| |
30.1 | 77 | An environment consists of |
| |
5.1 | 78 | |
| |
6.1 | 79 | 1. a unique **name**, that does not contain a comma |
| 80 | 1. a **related project wizard** | ||
| |
7.1 | 81 | 1. information about a **main file** for the project |
| |
18.1 | 82 | 1. information about the **target code** KiCo should produce |
| |
6.1 | 83 | 1. information for **wrapper code generation** |
| 84 | 1. a list of **shell commands** which should be run as part of a project launch | ||
| |
5.1 | 85 | |
| |
6.1 | 86 | Besides the name, all of these are optional, but can improve the workflow. |
| |
5.1 | 87 | |
| 88 | The related project wizard is run as part of the Prom project wizard and takes care of the actual project creation. | ||
| 89 | |||
| |
18.1 | 90 | A main file typically contains the entry point of the program on the target environment. Its wrapper code initializes and runs the model and sets inputs and outputs to the physical components of the target device. To ease the project setup and because wrapper code for a specific target platform is often similar, it is possible to define default content for the main file. Therefore the field **main file origin** can contain an absolute file path to a file with the default contents of a newly created main file for this environment. Furthermore, predefined wrapper code snippets can be injected as part of a project launch, which is described below. |
| |
6.1 | 91 | |
| |
20.1 | 92 | The **snippets origin** is used to initialize the wrapper code snippet directory of a newly created project. |
| |
6.1 | 93 | |
| |
17.1 | 94 | The other fields are default settings for KiCo launch configurations. |
| |
1.1 | 95 | |
| |
27.1 | 96 | [[image:attach:environments_preferences.png]] |
| 97 | |||
| |
8.1 | 98 | === Paths for initial content === |
| |
1.1 | 99 | |
| |
20.1 | 100 | The paths for main file origin accept an **absolute** file **path** as well as an **URL** with the platform protocol of Eclipse. An URL for the field has the form //plaftorm:/plugin/a.plugin.name/folder/in/the/plugin/file.txt// |
| |
18.1 | 101 | |
| |
25.1 | 102 | The snippets origin works analog. It accepts an absolute directory path as well as an URL with the platform protocol which points to a directory. An URL for the field has the form //plaftorm:/plugin/a.plugin.name/folder/in/the/plugin// |
| |
19.1 | 103 | |
| |
26.1 | 104 | ---- |
| 105 | |||
| |
8.1 | 106 | == Project Wizards with Prom == |
| 107 | |||
| |
25.1 | 108 | Prom provides project wizards, which can **create and initialize a project** with a **model file**, a **main file** and wrapper code **snippets**. The wizards for different model file types (e.g. SCChart project vs Esterel project) differ only in the initial content for these. Other initial content is choosen from the environment, which is selected on the first page of a Prom wizard. The project creation itself is done by another wizard, that is started from within the Prom wizard. |
| |
3.1 | 109 | |
| |
25.1 | 110 | If the //snippets directory// of an environment is a project relative path, the contents from the //snippets origin// will be copied to this location. If it is an absolute path, it is not copied to the project. Keeping snippets in a single, project indepentent folder, makes it easier to maintain them. For example it is possible to set an absolute path to a directory outside any project as directory for wrapper code snippets. This directory can then be easily maintained using a version control system. Furthermore, if an issue occurs, it has to be addressed only once, because the snippets are not copied to every new project. |
| |
24.1 | 111 | |
| |
27.1 | 112 | For example to create a project to develop Minstorms running leJOS, one can choose the SCCharts project wizard. In this wizard, one can choose the Mindstorms NXJ environment and define what will be initialized in the project (model file, main file, snippets). Now when pressing the finish button, the related project wizard from the leJOS plugin will be started. When it finishes, the newly created project is initialized with an initial model file, main file and wrapper code snippets. |
| |
23.1 | 113 | |
| |
27.1 | 114 | [[image:attach:project_wizard.png]] |
| 115 | |||
| |
26.1 | 116 | ---- |
| 117 | |||
| |
3.1 | 118 | == Wrapper Code Generation == |
| |
4.1 | 119 | |
| |
25.1 | 120 | When modeling a program for an embedded system, it is necessary to set inputs and outputs of physical components (sensors/actuators) to inputs and outputs of the model. This is typically done using wrapper code. However, **wrapper code is often similar** for a specific device and programming language. |
| |
7.1 | 121 | |
| |
25.1 | 122 | Therefore one can write **wrapper code snippets** for a target device. These can then be injected to a **template file** as part of a KiCo launch. What snippets are injected is defined using **annotations on inputs and outputs** directly in the model file. |
| 123 | |||
| |
27.1 | 124 | [[image:attach:wrapper_code_generation_scheme.png]] |
| |
25.1 | 125 | |
| 126 | In the **template file** one can use special **placeholders**. | ||
| 127 | |||
| |
30.1 | 128 | **${model_name}** will be replaced with the name of the model. |
| 129 | |||
| |
25.1 | 130 | **${inits}** will be replaced with initialization code for components (<@init>...</@init> of a snippet definition). Initialization should occur before the tick loop of the model file. |
| 131 | |||
| 132 | **${inputs}** will be replaced with code to set inputs for the model (<@input>...</@input> of a snippet definition). Setting model inputs should occur in the tick loop, before the tick function call. | ||
| 133 | |||
| 134 | **${outputs}** will be replaced with code to read outputs of the model. (<@output>...</@output> of a snippet definition). Reading outputs of the model should occur in the tick loop, after the tick function call. | ||
| 135 | |||
| |
27.1 | 136 | [[image:attach:template_file_structure.png]] |
| |
25.1 | 137 | |
| 138 | === FreeMarker === | ||
| 139 | |||
| 140 | The wrapper code injection is done using the open source **template engine [[FreeMarker>>url:http://freemarker.org/||shape="rect"]]**. A wrapper code snippet is basically a [[Macro>>url:http://freemarker.org/docs/ref_directive_macro.html||shape="rect"]] definition of FreeMarker. The Macro is called when the corresponding annotation is found in the model file. The file extension of FreeMarker templates is **.ftl**. | ||
| 141 | |||
| 142 | (Image showing snippet definition, template file, annotated model file, template file with macro calls, output file) | ||
| 143 | |||
| 144 | There is an [[Eclipse plugin>>url:http://freemarker.org/editors.html||shape="rect"]] for FreeMarker as part of the JBoss Tools Project. It can be installed using the Eclipse Marketplace. | ||
| 145 | |||
| |
29.1 | 146 | [[image:attach:wrapper_code_generation_example.png]] |
| 147 | |||
| |
26.1 | 148 | ---- |
| 149 | |||
| |
7.1 | 150 | == Automatically generated files == |
| |
10.1 | 151 | |
| |
21.1 | 152 | Files created by Prom are saved in the directory **kieler-gen**. Thereby the directory structure of files is retained, but without a starting Java source folder. This is because //kieler-gen// itself is a Java source folder. |
| 153 | |||
| 154 | For example (if //code// is not a Java source folder) the file //code/subfolder/MyModel.sct//, will be save to //kieler-gen/code/subfolder/MyModel.sct.// | ||
| 155 | |||
| 156 | In contrast (if //src// is a Java source folder) the file //src/subfolder/MyModel.sct//, will be saved to //kieler-gen/subfolder/MyModel.sct.// |