Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 18.1
edited by cmot
on 2014/03/17 14:48
Change comment: There is no comment for this version
To version 33.2
edited by cmot
on 2023/07/11 10:26
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Kieler.SCCharts.Previous Versions (Deprecated Documentation).WebHome
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.Home.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,11 +20,18 @@
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 29  == Extension Point ==
30 30  
... ... @@ -35,14 +35,16 @@
35 35  
36 36  {{{de.cau.cs.kieler.kico}}}
37 37  
38 -
51 +\\
39 39  )))
40 40  1. Add the extension
41 41  
55 +{{{de.cau.cs.kieler.kico.transformation}}}
42 42  
43 -{{{de.cau.cs.kieler.kico.transformation}}}(((
44 -
57 +(((
58 +\\
45 45  )))
60 +
46 46  1. (((
47 47  Add one of the following extension element
48 48  
... ... @@ -49,6 +49,7 @@
49 49  [[image:attach:KiCo2.jpg]]
50 50  )))
51 51  
67 +(% class="wrapped" %)
52 52  |=(((
53 53  Extension Element
54 54  )))|=(((
... ... @@ -73,7 +73,7 @@
73 73  * 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.
74 74  * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
75 75  * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
76 -* 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.
77 77  )))
78 78  |(((
79 79  transformationGroup
... ... @@ -96,9 +96,7 @@
96 96   dependencies="TRIGGEREFFECT, SURFACEDEPTH"
97 97   name="Transform All Normalize">
98 98   </transformationGroup>
99 - </extension>
100 - <extension
101 - point="de.cau.cs.kieler.kico.transformation">
115 +
102 102   <transformationMethod
103 103   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
104 104   id="TRIGGEREFFECT"
... ... @@ -105,10 +105,7 @@
105 105   method="transformTriggerEffect"
106 106   name="Transform Trigger and Effect">
107 107   </transformationMethod>
108 - </extension>
109 -
110 - <extension
111 - point="de.cau.cs.kieler.kico.transformation">
122 +
112 112   <transformationMethod
113 113   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
114 114   id="SURFACEDEPTH"
... ... @@ -115,10 +115,7 @@
115 115   method="transformSurfaceDepth"
116 116   name="Transform Surface Depth">
117 117   </transformationMethod>
118 - </extension>
119 -
120 - <extension
121 - point="de.cau.cs.kieler.kico.transformation">
129 +
122 122   <transformationGroup
123 123   id="ALL"
124 124   dependencies="CORE NORMALIZE"
... ... @@ -127,12 +127,13 @@
127 127   </extension>
128 128  {{/code}}
129 129  
130 -
138 +\\
131 131  
132 132  == Compilation ==
133 133  
134 134  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:
135 135  
144 +(% class="wrapped" %)
136 136  |=(((
137 137  Method
138 138  )))|=(((
... ... @@ -155,7 +155,6 @@
155 155  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.
156 156  )))
157 157  |(((
158 -
159 159  \\
160 160  
161 161  {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
... ... @@ -190,10 +190,153 @@
190 190  
191 191  {{/code}}
192 192  
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 +
193 193  == Help / Problems / FAQs ==
194 194  
195 195  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).
196 196  
347 +(% class="wrapped" %)
197 197  |=(((
198 198  Symptom
199 199  )))|=(((
... ... @@ -205,7 +205,9 @@
205 205  You get the following run time error:
206 206  
207 207  
208 -\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
359 +
360 +
361 +\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
209 209  [[java:136>>url:http://java:136||shape="rect"]]
210 210  [[java:164>>url:http://java:164||shape="rect"]]\\
211 211  
... ... @@ -222,7 +222,7 @@
222 222  Maybe the plugin declaring "ABORT2" was not loaded
223 223  or the ID is misspelled.
224 224  
225 -
378 +\\
226 226  )))|(((
227 227  Check why "ABORT2" may not be found
228 228  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 -9470109
1 +9470057
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470109/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler