Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 31.2
edited by Alexander Schulz-Rosengarten
on 2023/07/06 14:36
Change comment: Update document after refactoring.
To version 16.1
edited by cmot
on 2014/03/17 14:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -KIELER.Home.SCCharts.Previous Versions (Deprecated Documentation).WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.als
1 +XWiki.cmot
Content
... ... @@ -1,8 +1,4 @@
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"}}
1 +{{panel title="Project Overview" borderStyle="dashed"}}
6 6  Responsible:
7 7  
8 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"]]
... ... @@ -10,13 +10,11 @@
10 10  Related Theses:
11 11  
12 12  * none yet
13 -
14 -**To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:Online Compiler]].**
15 15  {{/panel}}
16 16  
17 17  = Kieler Compiler (KiCo) =
18 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"]].**
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.
20 20  
21 21  
22 22  
... ... @@ -26,19 +26,18 @@
26 26  
27 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 28  
29 -(% class="wrapped" %)
30 30  |=(((
31 -(% class="content-wrapper" %)
32 -(((
33 -[[image:attach:IMAG4642.jpg]]
34 -)))
35 -)))|=(((
36 -(% class="content-wrapper" %)
37 -(((
38 38  [[image:attach:KiCo.jpg]]
25 +)))|=(((
26 +[[image:attach:KiCo3.jpg]]
39 39  )))
40 -)))
41 41  
29 +
30 +
31 +
32 +
33 +
34 +
42 42  == Extension Point ==
43 43  
44 44  In order to add a transformation to KiCo you must follow these steps:
... ... @@ -48,13 +48,13 @@
48 48  
49 49  {{{de.cau.cs.kieler.kico}}}
50 50  
51 -\\
44 +
52 52  )))
53 53  1. Add the extension
54 54  
55 55  
56 56  {{{de.cau.cs.kieler.kico.transformation}}}(((
57 -\\
50 +
58 58  )))
59 59  1. (((
60 60  Add one of the following extension element
... ... @@ -62,7 +62,6 @@
62 62  [[image:attach:KiCo2.jpg]]
63 63  )))
64 64  
65 -(% class="wrapped" %)
66 66  |=(((
67 67  Extension Element
68 68  )))|=(((
... ... @@ -87,7 +87,7 @@
87 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 88  * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
89 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.
82 +* 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.
91 91  )))
92 92  |(((
93 93  transformationGroup
... ... @@ -110,7 +110,9 @@
110 110   dependencies="TRIGGEREFFECT, SURFACEDEPTH"
111 111   name="Transform All Normalize">
112 112   </transformationGroup>
113 -
105 + </extension>
106 + <extension
107 + point="de.cau.cs.kieler.kico.transformation">
114 114   <transformationMethod
115 115   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
116 116   id="TRIGGEREFFECT"
... ... @@ -117,7 +117,10 @@
117 117   method="transformTriggerEffect"
118 118   name="Transform Trigger and Effect">
119 119   </transformationMethod>
120 -
114 + </extension>
115 +
116 + <extension
117 + point="de.cau.cs.kieler.kico.transformation">
121 121   <transformationMethod
122 122   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
123 123   id="SURFACEDEPTH"
... ... @@ -124,7 +124,10 @@
124 124   method="transformSurfaceDepth"
125 125   name="Transform Surface Depth">
126 126   </transformationMethod>
127 -
124 + </extension>
125 +
126 + <extension
127 + point="de.cau.cs.kieler.kico.transformation">
128 128   <transformationGroup
129 129   id="ALL"
130 130   dependencies="CORE NORMALIZE"
... ... @@ -133,13 +133,12 @@
133 133   </extension>
134 134  {{/code}}
135 135  
136 -\\
136 +
137 137  
138 138  == Compilation ==
139 139  
140 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 141  
142 -(% class="wrapped" %)
143 143  |=(((
144 144  Method
145 145  )))|=(((
... ... @@ -197,153 +197,10 @@
197 197  
198 198  {{/code}}
199 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 342  == Help / Problems / FAQs ==
343 343  
344 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 345  
346 -(% class="wrapped" %)
347 347  |=(((
348 348  Symptom
349 349  )))|=(((
... ... @@ -372,7 +372,7 @@
372 372  Maybe the plugin declaring "ABORT2" was not loaded
373 373  or the ID is misspelled.
374 374  
375 -\\
231 +
376 376  )))|(((
377 377  Check why "ABORT2" may not be found
378 378  by KiCo, more specifically, check if the
IMAG4642.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -1.5 MB
Content
KiCo.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -138.2 KB
Content
KiCo2.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -5.0 KB
Content
KiCo3.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -166.2 KB
Content
dependencies2.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -170.9 KB
Content
dependencies2.pdf
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -18.5 KB
Content
dependencies3.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -242.8 KB
Content
dependencies4.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -252.6 KB
Content
dependencies4b.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -260.5 KB
Content
dependencies5.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -249.6 KB
Content
dependencies5b.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -281.7 KB
Content
dependencies6.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -258.3 KB
Content
dependencies6b.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -283.2 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470057
1 +9470087
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470087/Kieler Compiler