Skip to Content

Changes for page Kieler Compiler

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

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +KIELER.SCCharts.Previous Versions (Deprecated Documentation).WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cmot
1 +XWiki.als
Content
... ... @@ -1,4 +1,8 @@
1 -{{panel title="Project Overview" borderStyle="dashed"}}
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"}}
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,11 +6,13 @@
6 6  Related Theses:
7 7  
8 8  * none yet
13 +
14 +**To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:Kieler.SCCharts.Previous Versions (Deprecated Documentation).SCCharts (pre 1\.0).Online Compiler.WebHome]].**
9 9  {{/panel}}
10 10  
11 11  = Kieler Compiler (KiCo) =
12 12  
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.
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"]].**
14 14  
15 15  
16 16  
... ... @@ -20,18 +20,19 @@
20 20  
21 21  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.
22 22  
29 +(% class="wrapped" %)
23 23  |=(((
24 -[[image:attach:KiCo.jpg]]
31 +(% class="content-wrapper" %)
32 +(((
33 +[[image:attach:IMAG4642.jpg]]
34 +)))
25 25  )))|=(((
26 -[[image:attach:KiCo3.jpg]]
36 +(% class="content-wrapper" %)
37 +(((
38 +[[image:attach:KiCo.jpg]]
27 27  )))
40 +)))
28 28  
29 -
30 -
31 -
32 -
33 -
34 -
35 35  == Extension Point ==
36 36  
37 37  In order to add a transformation to KiCo you must follow these steps:
... ... @@ -41,14 +41,16 @@
41 41  
42 42  {{{de.cau.cs.kieler.kico}}}
43 43  
44 -
51 +\\
45 45  )))
46 46  1. Add the extension
47 47  
55 +{{{de.cau.cs.kieler.kico.transformation}}}
48 48  
49 -{{{de.cau.cs.kieler.kico.transformation}}}(((
50 -
57 +(((
58 +\\
51 51  )))
60 +
52 52  1. (((
53 53  Add one of the following extension element
54 54  
... ... @@ -55,6 +55,7 @@
55 55  [[image:attach:KiCo2.jpg]]
56 56  )))
57 57  
67 +(% class="wrapped" %)
58 58  |=(((
59 59  Extension Element
60 60  )))|=(((
... ... @@ -79,7 +79,7 @@
79 79  * 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.
80 80  * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
81 81  * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
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.
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.
83 83  )))
84 84  |(((
85 85  transformationGroup
... ... @@ -102,9 +102,7 @@
102 102   dependencies="TRIGGEREFFECT, SURFACEDEPTH"
103 103   name="Transform All Normalize">
104 104   </transformationGroup>
105 - </extension>
106 - <extension
107 - point="de.cau.cs.kieler.kico.transformation">
115 +
108 108   <transformationMethod
109 109   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
110 110   id="TRIGGEREFFECT"
... ... @@ -111,10 +111,7 @@
111 111   method="transformTriggerEffect"
112 112   name="Transform Trigger and Effect">
113 113   </transformationMethod>
114 - </extension>
115 -
116 - <extension
117 - point="de.cau.cs.kieler.kico.transformation">
122 +
118 118   <transformationMethod
119 119   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
120 120   id="SURFACEDEPTH"
... ... @@ -121,10 +121,7 @@
121 121   method="transformSurfaceDepth"
122 122   name="Transform Surface Depth">
123 123   </transformationMethod>
124 - </extension>
125 -
126 - <extension
127 - point="de.cau.cs.kieler.kico.transformation">
129 +
128 128   <transformationGroup
129 129   id="ALL"
130 130   dependencies="CORE NORMALIZE"
... ... @@ -133,12 +133,13 @@
133 133   </extension>
134 134  {{/code}}
135 135  
136 -
138 +\\
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  
144 +(% class="wrapped" %)
142 142  |=(((
143 143  Method
144 144  )))|=(((
... ... @@ -161,7 +161,6 @@
161 161  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.
162 162  )))
163 163  |(((
164 -
165 165  \\
166 166  
167 167  {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
... ... @@ -196,10 +196,153 @@
196 196  
197 197  {{/code}}
198 198  
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 +
199 199  == Help / Problems / FAQs ==
200 200  
201 201  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).
202 202  
347 +(% class="wrapped" %)
203 203  |=(((
204 204  Symptom
205 205  )))|=(((
... ... @@ -211,7 +211,10 @@
211 211  You get the following run time error:
212 212  
213 213  
214 -\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
359 +
360 +
361 +
362 +\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
215 215  [[java:136>>url:http://java:136||shape="rect"]]
216 216  [[java:164>>url:http://java:164||shape="rect"]]\\
217 217  
... ... @@ -228,7 +228,7 @@
228 228  Maybe the plugin declaring "ABORT2" was not loaded
229 229  or the ID is misspelled.
230 230  
231 -
379 +\\
232 232  )))|(((
233 233  Check why "ABORT2" may not be found
234 234  by KiCo, more specifically, check if the
IMAG4642.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +1.5 MB
Content
KiCo.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +138.2 KB
Content
KiCo2.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +5.0 KB
Content
KiCo3.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +166.2 KB
Content
dependencies2.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +170.9 KB
Content
dependencies2.pdf
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +18.5 KB
Content
dependencies3.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +242.8 KB
Content
dependencies4.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +252.6 KB
Content
dependencies4b.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +260.5 KB
Content
dependencies5.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +249.6 KB
Content
dependencies5b.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +281.7 KB
Content
dependencies6.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +258.3 KB
Content
dependencies6b.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +283.2 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470087
1 +9470057
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470087/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler