Skip to Content

Wiki source code of Kieler Compiler

Version 29.1 by Alexander Schulz-Rosengarten on 2018/11/22 14:54
Show last authors
1 {{panel bgColor="orange" title="Deprecated since 0.12"}}
2 This article is deprecated. The described features are no longer available in current releases.
3 {{/panel}}
4
5 {{panel borderStyle="dashed" title="Project Overview"}}
6 Responsible:
7
8 * [[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"]]
9
10 Related Theses:
11
12 * none yet
13
14 **To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:Online Compiler]].**
15 {{/panel}}
16
17 = Kieler Compiler (KiCo) =
18
19 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>>url:http://www.sccharts.com/||shape="rect"]].**
20
21
22
23 {{toc/}}
24
25 == General ==
26
27 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.
28
29 (% class="wrapped" %)
30 |=(((
31 (% class="content-wrapper" %)
32 (((
33 [[image:attach:IMAG4642.jpg]]
34 )))
35 )))|=(((
36 (% class="content-wrapper" %)
37 (((
38 [[image:attach:KiCo.jpg]]
39 )))
40 )))
41
42 == Extension Point ==
43
44 In order to add a transformation to KiCo you must follow these steps:
45
46 1. (((
47 Add dependency to
48
49 {{{de.cau.cs.kieler.kico}}}
50
51 \\
52 )))
53 1. Add the extension
54
55
56 {{{de.cau.cs.kieler.kico.transformation}}}(((
57 \\
58 )))
59 1. (((
60 Add one of the following extension element
61
62 [[image:attach:KiCo2.jpg]]
63 )))
64
65 (% class="wrapped" %)
66 |=(((
67 Extension Element
68 )))|=(((
69 Description
70 )))
71 |(((
72 transformationClass
73 )))|(((
74 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
75
76 * getId(): Returns a unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
77 * getName(): Optionally return a String name for this transformation. If null is returned here the ID will be used as a name.
78 * 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.
79 * transform(EObject): Returns an EObject and does the central transformation.
80 )))
81 |(((
82 transformationMethod
83 )))|(((
84 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:
85
86 * class: The class where the transform method is implemented in
87 * 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.
88 * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
89 * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
90 * 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.
91 )))
92 |(((
93 transformationGroup
94 )))|(((
95 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:
96
97 * 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!
98 * 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.
99 * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
100 * 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.
101 )))
102
103 === Example ===
104
105 {{code title="plugin.xml"}}
106 <extension
107 point="de.cau.cs.kieler.kico.transformation">
108 <transformationGroup
109 id="NORMALIZE"
110 dependencies="TRIGGEREFFECT, SURFACEDEPTH"
111 name="Transform All Normalize">
112 </transformationGroup>
113
114 <transformationMethod
115 class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
116 id="TRIGGEREFFECT"
117 method="transformTriggerEffect"
118 name="Transform Trigger and Effect">
119 </transformationMethod>
120
121 <transformationMethod
122 class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
123 id="SURFACEDEPTH"
124 method="transformSurfaceDepth"
125 name="Transform Surface Depth">
126 </transformationMethod>
127
128 <transformationGroup
129 id="ALL"
130 dependencies="CORE NORMALIZE"
131 name="Transform All">
132 </transformationGroup>
133 </extension>
134 {{/code}}
135
136 \\
137
138 == Compilation ==
139
140 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:
141
142 (% class="wrapped" %)
143 |=(((
144 Method
145 )))|=(((
146 Description
147 )))
148 |(((
149 \\
150
151 {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject)}}}
152 )))|(((
153 * 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.
154 * eObject: The EObject that is the input to the compilation process.
155 * Returns: The EObject returned from the last model transformation called by KiCo.
156 )))
157 |(((
158 \\
159
160 {{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
161 )))|(((
162 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.
163 )))
164 |(((
165
166 \\
167
168 {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
169 )))|(((
170 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.
171 )))
172
173 === Examples ===
174
175 {{code title="Java Code"}}
176 import de.cau.cs.kieler.kico.KielerCompiler;
177 ...
178 private MyEObjectClass myMethod(EObject eObject) {
179 ...
180 transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
181 ...
182 return transformed
183 }
184 {{/code}}
185
186 {{code title="Xtend Code"}}
187 import de.cau.cs.kieler.kico.KielerCompiler
188 ...
189 def dispatch MyEObjectClass myMethod(EObject eObject) {
190 transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
191 ...
192 transformed
193 }
194
195
196
197
198 {{/code}}
199
200 === Requirement Completion ===
201
202 \\
203
204 (% class="wrapped" %)
205 |=(((
206 (% class="content-wrapper" %)
207 (((
208 (% style="text-align: center;" %)
209 Original
210
211 (% class="wrapped" %)
212 |=(((
213 (% class="content-wrapper" %)
214 (((
215 [[image:attach:dependencies2.jpg]]
216
217 (% style="text-align: center;" %)
218 Original Dependency
219 Graph
220 )))
221 )))|=(((
222 (% class="content-wrapper" %)
223 (((
224 (% style="text-align: center;" %)
225 [[image:attach:dependencies3.jpg]]
226
227 (% style="text-align: center;" %)
228 Two alternative
229 transformation
230 implementations
231 for Abort
232 )))
233 )))
234
235 \\
236 )))
237 )))|=(((
238 (% class="content-wrapper" %)
239 (((
240 (% style="text-align: center;" %)
241 Example 1
242
243 (% class="wrapped" %)
244 |=(((
245 (% class="content-wrapper" %)
246 (((
247 [[image:attach:dependencies4.jpg]]
248
249 (% style="text-align: center;" %)
250 Selected for
251 transformation
252 )))
253 )))|=(((
254 (% class="content-wrapper" %)
255 (((
256 [[image:attach:dependencies4b.jpg]]
257
258 (% style="text-align: center;" %)
259 Auto selected
260 requirements
261 )))
262 )))
263
264 \\
265 )))
266 )))
267
268 \\
269
270 \\
271
272 (% class="wrapped" %)
273 |=(((
274 (% class="content-wrapper" %)
275 (((
276 (% style="text-align: center;" %)
277 Example 2
278
279 (% class="wrapped" %)
280 |=(((
281 (% class="content-wrapper" %)
282 (((
283 [[image:attach:dependencies5.jpg]]
284
285 (% style="text-align: center;" %)
286 Selected for
287 transformation
288 )))
289 )))|=(% style="text-align: center;" %)(% style="text-align: center;" %)
290 (((
291 (% class="content-wrapper" %)
292 (((
293 [[image:attach:dependencies5b.jpg]]
294
295 Auto selected
296 requirements
297 using DEFAULT
298 of alternative
299 group
300
301 \\
302 )))
303 )))
304
305 \\
306 )))
307 )))|=(((
308 (% class="content-wrapper" %)
309 (((
310 (% style="text-align: center;" %)
311 Example 3
312
313 (% class="wrapped" %)
314 |=(((
315 (% class="content-wrapper" %)
316 (((
317 [[image:attach:dependencies6.jpg]]
318
319 (% style="text-align: center;" %)
320 Selected for
321 transformation
322 )))
323 )))|=(((
324 (% class="content-wrapper" %)
325 (((
326 [[image:attach:dependencies6b.jpg]]
327
328 (% style="text-align: center;" %)
329 Auto selected
330 requirements
331 using selected
332 alternative
333 )))
334 )))
335
336 \\
337 )))
338 )))
339
340 \\
341
342 == Help / Problems / FAQs ==
343
344 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).
345
346 (% class="wrapped" %)
347 |=(((
348 Symptom
349 )))|=(((
350 Reason
351 )))|=(((
352 Solution
353 )))
354 |(((
355 You get the following run time error:
356
357
358 \\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
359 [[java:136>>url:http://java:136||shape="rect"]]
360 [[java:164>>url:http://java:164||shape="rect"]]\\
361
362 {{{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.)...}}}
363 )))|(((
364 There is a transformation with ID "ABORT2" referenced
365 either by the initial call to KielerCompiler.compile() or
366 by some of the dependent transformations /
367 transformation group.
368
369 But KiCo could not find any registered transformation
370 with ID "ABORT2".
371
372 Maybe the plugin declaring "ABORT2" was not loaded
373 or the ID is misspelled.
374
375 \\
376 )))|(((
377 Check why "ABORT2" may not be found
378 by KiCo, more specifically, check if the
379 declaring can be loaded (sometimes
380 compiler error prevent it from being loaded
381 or it has unsatisfied dependencies).
382 Also check the spelling of the ID, maybe
383 the declaring plugin defines the transformation
384 with the ID "abort2".
385 )))
386 |(((
387 You get the following error:
388
389 {{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
390
391 \\
392
393 {{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}}
394 )))|(((
395 The trasformation with ID "TERMINATION" is already
396 registered and this ID cannot be used a second time.
397 The component "de.cau...sccharts" tries to register
398 a transformation with this ID while this ID is already
399 taken.
400 )))|(((
401 Rename one of the IDs or form a group of
402 transformations.
403 )))