Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 28.1
edited by aas2
on 2017/04/04 13:06
Change comment: There is no comment for this version
To version 14.1
edited by cmot
on 2014/03/17 11:37
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.aas2
1 +XWiki.cmot
Content
... ... @@ -1,4 +1,4 @@
1 -{{panel borderStyle="dashed" title="Project Overview"}}
1 +{{panel title="Project Overview" borderStyle="dashed"}}
2 2  Responsible:
3 3  
4 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"]]
... ... @@ -6,13 +6,11 @@
6 6  Related Theses:
7 7  
8 8  * none yet
9 -
10 -**To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:Online Compiler]].**
11 11  {{/panel}}
12 12  
13 13  = Kieler Compiler (KiCo) =
14 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>>url:http://www.sccharts.com/||shape="rect"]].**
13 +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.
16 16  
17 17  
18 18  
... ... @@ -22,18 +22,7 @@
22 22  
23 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 24  
25 -(% class="wrapped" %)
26 -|=(((
27 -(% class="content-wrapper" %)
28 -(((
29 -[[image:attach:IMAG4642.jpg]]
30 -)))
31 -)))|=(((
32 -(% class="content-wrapper" %)
33 -(((
34 34  [[image:attach:KiCo.jpg]]
35 -)))
36 -)))
37 37  
38 38  == Extension Point ==
39 39  
... ... @@ -44,13 +44,13 @@
44 44  
45 45  {{{de.cau.cs.kieler.kico}}}
46 46  
47 -\\
34 +
48 48  )))
49 49  1. Add the extension
50 50  
51 51  
52 52  {{{de.cau.cs.kieler.kico.transformation}}}(((
53 -\\
40 +
54 54  )))
55 55  1. (((
56 56  Add one of the following extension element
... ... @@ -58,7 +58,6 @@
58 58  [[image:attach:KiCo2.jpg]]
59 59  )))
60 60  
61 -(% class="wrapped" %)
62 62  |=(((
63 63  Extension Element
64 64  )))|=(((
... ... @@ -83,7 +83,7 @@
83 83  * 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.
84 84  * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
85 85  * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
86 -* 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.
72 +* 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.
87 87  )))
88 88  |(((
89 89  transformationGroup
... ... @@ -91,7 +91,7 @@
91 91  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:
92 92  
93 93  * 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!
94 -* 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.
80 +* 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.
95 95  * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
96 96  * 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.
97 97  )))
... ... @@ -106,7 +106,9 @@
106 106   dependencies="TRIGGEREFFECT, SURFACEDEPTH"
107 107   name="Transform All Normalize">
108 108   </transformationGroup>
109 -
95 + </extension>
96 + <extension
97 + point="de.cau.cs.kieler.kico.transformation">
110 110   <transformationMethod
111 111   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
112 112   id="TRIGGEREFFECT"
... ... @@ -113,7 +113,10 @@
113 113   method="transformTriggerEffect"
114 114   name="Transform Trigger and Effect">
115 115   </transformationMethod>
116 -
104 + </extension>
105 +
106 + <extension
107 + point="de.cau.cs.kieler.kico.transformation">
117 117   <transformationMethod
118 118   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
119 119   id="SURFACEDEPTH"
... ... @@ -120,7 +120,10 @@
120 120   method="transformSurfaceDepth"
121 121   name="Transform Surface Depth">
122 122   </transformationMethod>
123 -
114 + </extension>
115 +
116 + <extension
117 + point="de.cau.cs.kieler.kico.transformation">
124 124   <transformationGroup
125 125   id="ALL"
126 126   dependencies="CORE NORMALIZE"
... ... @@ -129,13 +129,12 @@
129 129   </extension>
130 130  {{/code}}
131 131  
132 -\\
126 +
133 133  
134 134  == Compilation ==
135 135  
136 136  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:
137 137  
138 -(% class="wrapped" %)
139 139  |=(((
140 140  Method
141 141  )))|=(((
... ... @@ -193,153 +193,10 @@
193 193  
194 194  {{/code}}
195 195  
196 -=== Requirement Completion ===
197 -
198 -\\
199 -
200 -(% class="wrapped" %)
201 -|=(((
202 -(% class="content-wrapper" %)
203 -(((
204 -(% style="text-align: center;" %)
205 -Original
206 -
207 -(% class="wrapped" %)
208 -|=(((
209 -(% class="content-wrapper" %)
210 -(((
211 - [[image:attach:dependencies2.jpg]]
212 -
213 -(% style="text-align: center;" %)
214 -Original Dependency
215 -Graph
216 -)))
217 -)))|=(((
218 -(% class="content-wrapper" %)
219 -(((
220 -(% style="text-align: center;" %)
221 -[[image:attach:dependencies3.jpg]]
222 -
223 -(% style="text-align: center;" %)
224 -Two alternative
225 -transformation
226 -implementations
227 -for Abort
228 -)))
229 -)))
230 -
231 -\\
232 -)))
233 -)))|=(((
234 -(% class="content-wrapper" %)
235 -(((
236 -(% style="text-align: center;" %)
237 -Example 1
238 -
239 -(% class="wrapped" %)
240 -|=(((
241 -(% class="content-wrapper" %)
242 -(((
243 - [[image:attach:dependencies4.jpg]]
244 -
245 -(% style="text-align: center;" %)
246 -Selected for
247 -transformation
248 -)))
249 -)))|=(((
250 -(% class="content-wrapper" %)
251 -(((
252 - [[image:attach:dependencies4b.jpg]]
253 -
254 -(% style="text-align: center;" %)
255 -Auto selected
256 -requirements
257 -)))
258 -)))
259 -
260 -\\
261 -)))
262 -)))
263 -
264 -\\
265 -
266 -\\
267 -
268 -(% class="wrapped" %)
269 -|=(((
270 -(% class="content-wrapper" %)
271 -(((
272 -(% style="text-align: center;" %)
273 -Example 2
274 -
275 -(% class="wrapped" %)
276 -|=(((
277 -(% class="content-wrapper" %)
278 -(((
279 -[[image:attach:dependencies5.jpg]]
280 -
281 -(% style="text-align: center;" %)
282 -Selected for
283 -transformation
284 -)))
285 -)))|=(% style="text-align: center;" %)(% style="text-align: center;" %)
286 -(((
287 -(% class="content-wrapper" %)
288 -(((
289 -[[image:attach:dependencies5b.jpg]]
290 -
291 -Auto selected
292 -requirements
293 -using DEFAULT
294 -of alternative
295 -group
296 -
297 -\\
298 -)))
299 -)))
300 -
301 -\\
302 -)))
303 -)))|=(((
304 -(% class="content-wrapper" %)
305 -(((
306 -(% style="text-align: center;" %)
307 -Example 3
308 -
309 -(% class="wrapped" %)
310 -|=(((
311 -(% class="content-wrapper" %)
312 -(((
313 -[[image:attach:dependencies6.jpg]]
314 -
315 -(% style="text-align: center;" %)
316 -Selected for
317 -transformation
318 -)))
319 -)))|=(((
320 -(% class="content-wrapper" %)
321 -(((
322 -[[image:attach:dependencies6b.jpg]]
323 -
324 -(% style="text-align: center;" %)
325 -Auto selected
326 -requirements
327 -using selected
328 -alternative
329 -)))
330 -)))
331 -
332 -\\
333 -)))
334 -)))
335 -
336 -\\
337 -
338 338  == Help / Problems / FAQs ==
339 339  
340 340  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).
341 341  
342 -(% class="wrapped" %)
343 343  |=(((
344 344  Symptom
345 345  )))|=(((
... ... @@ -368,7 +368,7 @@
368 368  Maybe the plugin declaring "ABORT2" was not loaded
369 369  or the ID is misspelled.
370 370  
371 -\\
221 +
372 372  )))|(((
373 373  Check why "ABORT2" may not be found
374 374  by KiCo, more specifically, check if the
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -50823224
1 +9470084
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/50823224/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470084/Kieler Compiler