Wiki source code of Kieler Compiler

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

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage