Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 5.1
edited by cmot
on 2014/03/16 22:19
Change comment: There is no comment for this version
To version 19.1
edited by cmot
on 2014/03/21 12:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Kieler Compiler (KiCo)
1 +Kieler Compiler
Content
... ... @@ -1,3 +1,13 @@
1 +{{panel title="Project Overview" borderStyle="dashed"}}
2 +Responsible:
3 +
4 +* [[Christian Motika>>url:http://www.informatik.uni-kiel.de/rtsys/kontakt/cmot/||shape="rect"]], [[Steven Smyth>>url:http://www.informatik.uni-kiel.de/rtsys/kontakt/ssm/||shape="rect"]]
5 +
6 +Related Theses:
7 +
8 +* none yet
9 +{{/panel}}
10 +
1 1  = Kieler Compiler (KiCo) =
2 2  
3 3  In order to integrate and be able to evaluate our compiler chain from SCCharts to C or VHDL code we use the KiCo project as a generic framework that allows to register setp-by-step transformations on EObjects. These can then be handled by the generic KIEM KiCo DataComponent.
... ... @@ -10,7 +10,11 @@
10 10  
11 11  The KIELER Compiler (KiCo) project allows to register step-by-step model transformations on EObjects that could be written in Xtend or Java. These transformations are registered using an extension point provided (see below). After registering transformations these can be used by simply call the KielerCompiler compilation method as also explained further below.
12 12  
23 +|=(((
13 13  [[image:attach:KiCo.jpg]]
25 +)))|=(((
26 +[[image:attach:KiCo3.jpg]]
27 +)))
14 14  
15 15  == Extension Point ==
16 16  
... ... @@ -26,11 +26,14 @@
26 26  1. Add the extension
27 27  
28 28  
29 -{{{de.cau.cs.kieler.kico.transformation}}}
43 +{{{de.cau.cs.kieler.kico.transformation}}}(((
44 +
45 +)))
46 +1. (((
47 +Add one of the following extension element
30 30  
31 -Add one of the following
32 -
33 33  [[image:attach:KiCo2.jpg]]
50 +)))
34 34  
35 35  |=(((
36 36  Extension Element
... ... @@ -56,7 +56,7 @@
56 56  * method: The name of the transformation method. Its signature must ensure that it returns an EObject an only take an EObject argument. Otherwise it cannot be found by KiCo.
57 57  * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
58 58  * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
59 -* dependencies: An optional String as comma separated list of other transformation IDs that must run BEFORE this transformation. If nothing is entered here then this means there are no dependencies.
76 +* dependencies: An optional String as comma separated list of other transformation IDs that must run AFTER this transformation down the compile-chain. This means if the current transformation is selected to run, all transformations that have dependencies on this will be run BEFORE. If nothing is entered here then this means there are no dependencies.
60 60  )))
61 61  |(((
62 62  transformationGroup
... ... @@ -64,8 +64,9 @@
64 64  Sometimes you may want to group other transformations and give this group a specific transformation ID as a kind of shortcut. You can do this by using the transformationGroup element giving the following information:
65 65  
66 66  * id: The unique String ID for this transformation group. This is the ID the transformation group will be referenced throughout KiCo. It may also again be referenced by other transformation groups!
67 -* dependencies: These are NOT optional for groups. Groups must specify their transformations as dependencies. Use a String as comma separated list of other transformation IDs or transformation group IDs that should represent this group. Note that the order will be implied by the referenced transformations itself although if there is a free degree of order it can be influenced by the order specified here in the group.
84 +* transformations: Groups must specify their transformations. Use a String as comma separated list of other transformation IDs or transformation group IDs that should represent this group. Note that the order will be implied by the referenced transformations itself although if there is a free degree of order it can be influenced by the order specified here in the group.
68 68  * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
86 +* alternatives: When selected this group specifies alternatives only. When this group is referenced, the first transformation is selected if not any other transformation from this group is already in the list of selected transformations. This is an advanced feature.
69 69  )))
70 70  
71 71  === Example ===
... ... @@ -121,7 +121,9 @@
121 121  Description
122 122  )))
123 123  |(((
124 -{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject)}}}
142 +\\
143 +
144 +{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject)}}}
125 125  )))|(((
126 126  * transformationIDs: List of Strings representing the transformation IDs and a pre-ordering. Note that KiCo may automatically modify the order to meet the dependencies of the referenced transformation IDs or transformation group IDs.
127 127  * eObject: The EObject that is the input to the compilation process.
... ... @@ -128,12 +128,17 @@
128 128  * Returns: The EObject returned from the last model transformation called by KiCo.
129 129  )))
130 130  |(((
131 -{{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
151 +\\
152 +
153 +{{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
132 132  )))|(((
133 133  This is a convenient method only which can be used to give transformation IDs or transformation group IDs as a comma separated String. For eObject and the return value see above.
134 134  )))
135 135  |(((
136 -{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject, boolean autoexpand)}}}
158 +
159 +\\
160 +
161 +{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject, boolean autoexpand)}}}
137 137  )))|(((
138 138  This is an advanced compile method which can turn of auto-expansion with the last parameter. Use this with care! Note that if switching autoexpand off you cannot use transformation group IDs any more. Also no dependencies will be considered. The transformations will be applied straight forward in the order defined by the transformationIDs list.
139 139  )))
... ... @@ -164,3 +164,65 @@
164 164  
165 165  
166 166  {{/code}}
192 +
193 +== Help / Problems / FAQs ==
194 +
195 +Maybe you get into problems when using KiCo. The following list should give you hints to solve these. If you have a problem not considered here please write us an e-mail (see above for contact information of the persons in charge of KiCo).
196 +
197 +|=(((
198 +Symptom
199 +)))|=(((
200 +Reason
201 +)))|=(((
202 +Solution
203 +)))
204 +|(((
205 +You get the following run time error:
206 +
207 +
208 +\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
209 +[[java:136>>url:http://java:136||shape="rect"]]
210 +[[java:164>>url:http://java:164||shape="rect"]]\\
211 +
212 +{{{ENTRY de.cau.cs.kieler.klighd 4 0 2014-03-17 11:08:46.009!MESSAGE !STACK 0java.lang.RuntimeException: Cannot find a transformation with the ID 'ABORT2'. Make sure that the transformation with this ID is registered and its declaring plugin is loaded. Make sure that the ID does exactly match (case sensitive). Maybe you forgot to separate multiple ID's by a comma.    at de.cau.cs.kieler.kico.KielerCompiler.getTransformation(KielerCompiler.java:61)    at de.cau.cs.kieler.kico.KielerCompiler.getDependencies(KielerCompiler.java:82)    at de.cau.cs.kieler.kico.KielerCompiler.isDependingOn(KielerCompiler.)    at de.cau.cs.kieler.kico.KielerCompiler.insertTransformationID(KielerCompiler.)    at de.cau.cs.kieler.kico.KielerCompiler.expandDependencies(KielerCompiler.)...}}}
213 +)))|(((
214 +There is a transformation with ID "ABORT2" referenced
215 +either by the initial call to KielerCompiler.compile() or
216 +by some of the dependent transformations /
217 +transformation group.
218 +
219 +But KiCo could not find any registered transformation
220 +with ID "ABORT2".
221 +
222 +Maybe the plugin declaring "ABORT2" was not loaded
223 +or the ID is misspelled.
224 +
225 +
226 +)))|(((
227 +Check why "ABORT2" may not be found
228 +by KiCo, more specifically, check if the
229 +declaring can be loaded (sometimes
230 +compiler error prevent it from being loaded
231 +or it has unsatisfied dependencies).
232 +Also check the spelling of the ID, maybe
233 +the declaring plugin defines the transformation
234 +with the ID "abort2".
235 +)))
236 +|(((
237 +You get the following error:
238 +
239 +{{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
240 +
241 +\\
242 +
243 +{{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}}
244 +)))|(((
245 +The trasformation with ID "TERMINATION" is already
246 + registered and this ID cannot be used a second time.
247 +The component "de.cau...sccharts" tries to register
248 +a transformation with this ID while this ID is already
249 +taken.
250 +)))|(((
251 +Rename one of the IDs or form a group of
252 + transformations.
253 +)))
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470065
1 +9470111
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470065/Kieler Compiler (KiCo)
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470111/Kieler Compiler