Wiki source code of Kieler Compiler

Version 27.1 by cmot on 2014/06/26 15:14
Show last authors
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
10 **To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:Online Compiler]].**
11 {{/panel}}
12
13 = Kieler Compiler (KiCo) =
14
15 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. **To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:Online Compiler]].**
16
17
18
19 {{toc/}}
20
21 == General ==
22
23 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.
24
25 |=(((
26 [[image:attach:IMAG4642.jpg]]
27 )))|=(((
28 [[image:attach:KiCo.jpg]]
29 )))
30
31 == Extension Point ==
32
33 In order to add a transformation to KiCo you must follow these steps:
34
35 1. (((
36 Add dependency to
37
38 {{{de.cau.cs.kieler.kico}}}
39
40
41 )))
42 1. Add the extension
43
44
45 {{{de.cau.cs.kieler.kico.transformation}}}(((
46
47 )))
48 1. (((
49 Add one of the following extension element
50
51 [[image:attach:KiCo2.jpg]]
52 )))
53
54 |=(((
55 Extension Element
56 )))|=(((
57 Description
58 )))
59 |(((
60 transformationClass
61 )))|(((
62 The defined class must extend "de.cau.cs.kieler.kico.Transformation" and must implement the methods defined in "de.cau.cs.kieler.kico.ITransformation". These are
63
64 * getId(): Returns a unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
65 * getName(): Optionally return a String name for this transformation. If null is returned here the ID will be used as a name.
66 * getDependencies(): Optionally return a List<String> of other transformation IDs that must run BEFORE this transformation. If null is returned then this means there are no dependencies.
67 * transform(EObject): Returns an EObject and does the central transformation.
68 )))
69 |(((
70 transformationMethod
71 )))|(((
72 The defined class can be freely chosen and does not need to extend or implement any other class or interface. Although you have to give more information in the extension element now:
73
74 * class: The class where the transform method is implemented in
75 * 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.
76 * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
77 * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
78 * 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.
79 )))
80 |(((
81 transformationGroup
82 )))|(((
83 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:
84
85 * 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!
86 * 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.
87 * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
88 * 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.
89 )))
90
91 === Example ===
92
93 {{code title="plugin.xml"}}
94 <extension
95 point="de.cau.cs.kieler.kico.transformation">
96 <transformationGroup
97 id="NORMALIZE"
98 dependencies="TRIGGEREFFECT, SURFACEDEPTH"
99 name="Transform All Normalize">
100 </transformationGroup>
101
102 <transformationMethod
103 class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
104 id="TRIGGEREFFECT"
105 method="transformTriggerEffect"
106 name="Transform Trigger and Effect">
107 </transformationMethod>
108
109 <transformationMethod
110 class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
111 id="SURFACEDEPTH"
112 method="transformSurfaceDepth"
113 name="Transform Surface Depth">
114 </transformationMethod>
115
116 <transformationGroup
117 id="ALL"
118 dependencies="CORE NORMALIZE"
119 name="Transform All">
120 </transformationGroup>
121 </extension>
122 {{/code}}
123
124
125
126 == Compilation ==
127
128 Once a bunch of model transformations are registered, these can simply be called using the KiCo central "KielerCompiler" class with its method compile(). This will be given a List<String> of transformation IDs or a comma separated String of transformation IDs as the first parameter. The second parameter is the EObject that is being transformed. It should meet the signature of the first model transformation called. Note that the actual model transformations that are done may vary because KiCo will automatically inspect the dependencies of each transformation requested (deep-recursively). If you do not like this to happen as an advanced user you can use a third parameter that will skip this autocompletion. Note that if you switch this off also NO transformation groups can be processed. Here is an overview and examples how to use the compile() method:
129
130 |=(((
131 Method
132 )))|=(((
133 Description
134 )))
135 |(((
136 \\
137
138 {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject)}}}
139 )))|(((
140 * 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.
141 * eObject: The EObject that is the input to the compilation process.
142 * Returns: The EObject returned from the last model transformation called by KiCo.
143 )))
144 |(((
145 \\
146
147 {{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
148 )))|(((
149 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.
150 )))
151 |(((
152
153 \\
154
155 {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
156 )))|(((
157 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.
158 )))
159
160 === Examples ===
161
162 {{code title="Java Code"}}
163 import de.cau.cs.kieler.kico.KielerCompiler;
164 ...
165 private MyEObjectClass myMethod(EObject eObject) {
166 ...
167 transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
168 ...
169 return transformed
170 }
171 {{/code}}
172
173 {{code title="Xtend Code"}}
174 import de.cau.cs.kieler.kico.KielerCompiler
175 ...
176 def dispatch MyEObjectClass myMethod(EObject eObject) {
177 transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
178 ...
179 transformed
180 }
181
182
183
184
185 {{/code}}
186
187 === Requirement Completion ===
188
189
190
191 |=(((
192 (% style="text-align: center;" %)
193 Original
194
195 |=(((
196 [[image:attach:dependencies2.jpg]]
197
198 (% style="text-align: center;" %)
199 Original Dependency
200 Graph
201 )))|=(((
202 (% style="text-align: center;" %)
203 [[image:attach:dependencies3.jpg]]
204
205 (% style="text-align: center;" %)
206 Two alternative
207 transformation
208 implementations
209 for Abort
210 )))
211
212
213 )))|=(((
214 (% style="text-align: center;" %)
215 Example 1
216
217 |=(((
218 [[image:attach:dependencies4.jpg]]
219
220 (% style="text-align: center;" %)
221 Selected for
222 transformation
223 )))|=(((
224 [[image:attach:dependencies4b.jpg]]
225
226 (% style="text-align: center;" %)
227 Auto selected
228 requirements
229 )))
230
231
232 )))
233
234
235
236
237
238 |=(((
239 (% style="text-align: center;" %)
240 Example 2
241
242 |=(((
243 [[image:attach:dependencies5.jpg]]
244
245 (% style="text-align: center;" %)
246 Selected for
247 transformation
248 )))|=(% style="text-align: center;" %)(% style="text-align: center;" %)
249 (((
250 [[image:attach:dependencies5b.jpg]]
251
252 Auto selected
253 requirements
254 using DEFAULT
255 of alternative
256 group
257
258
259 )))
260
261
262 )))|=(((
263 (% style="text-align: center;" %)
264 Example 3
265
266 |=(((
267 [[image:attach:dependencies6.jpg]]
268
269 (% style="text-align: center;" %)
270 Selected for
271 transformation
272 )))|=(((
273 [[image:attach:dependencies6b.jpg]]
274
275 (% style="text-align: center;" %)
276 Auto selected
277 requirements
278 using selected
279 alternative
280 )))
281
282
283 )))
284
285
286
287 == Help / Problems / FAQs ==
288
289 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).
290
291 |=(((
292 Symptom
293 )))|=(((
294 Reason
295 )))|=(((
296 Solution
297 )))
298 |(((
299 You get the following run time error:
300
301
302 \\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
303 [[java:136>>url:http://java:136||shape="rect"]]
304 [[java:164>>url:http://java:164||shape="rect"]]\\
305
306 {{{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.)...}}}
307 )))|(((
308 There is a transformation with ID "ABORT2" referenced
309 either by the initial call to KielerCompiler.compile() or
310 by some of the dependent transformations /
311 transformation group.
312
313 But KiCo could not find any registered transformation
314 with ID "ABORT2".
315
316 Maybe the plugin declaring "ABORT2" was not loaded
317 or the ID is misspelled.
318
319
320 )))|(((
321 Check why "ABORT2" may not be found
322 by KiCo, more specifically, check if the
323 declaring can be loaded (sometimes
324 compiler error prevent it from being loaded
325 or it has unsatisfied dependencies).
326 Also check the spelling of the ID, maybe
327 the declaring plugin defines the transformation
328 with the ID "abort2".
329 )))
330 |(((
331 You get the following error:
332
333 {{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
334
335 \\
336
337 {{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}}
338 )))|(((
339 The trasformation with ID "TERMINATION" is already
340 registered and this ID cannot be used a second time.
341 The component "de.cau...sccharts" tries to register
342 a transformation with this ID while this ID is already
343 taken.
344 )))|(((
345 Rename one of the IDs or form a group of
346 transformations.
347 )))

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage