Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 13.1
edited by cmot
on 2014/03/17 11:29
Change comment: There is no comment for this version
To version 34.1
edited by Alexander Schulz-Rosengarten
on 2023/07/11 10:26
Change comment: Renamed back-links.

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,7 +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" %)
30 +|=(((
31 +(% class="content-wrapper" %)
32 +(((
33 +[[image:attach:IMAG4642.jpg]]
34 +)))
35 +)))|=(((
36 +(% class="content-wrapper" %)
37 +(((
23 23  [[image:attach:KiCo.jpg]]
39 +)))
40 +)))
24 24  
25 25  == Extension Point ==
26 26  
... ... @@ -31,14 +31,16 @@
31 31  
32 32  {{{de.cau.cs.kieler.kico}}}
33 33  
34 -
51 +\\
35 35  )))
36 36  1. Add the extension
37 37  
55 +{{{de.cau.cs.kieler.kico.transformation}}}
38 38  
39 -{{{de.cau.cs.kieler.kico.transformation}}}(((
40 -
57 +(((
58 +\\
41 41  )))
60 +
42 42  1. (((
43 43  Add one of the following extension element
44 44  
... ... @@ -45,6 +45,7 @@
45 45  [[image:attach:KiCo2.jpg]]
46 46  )))
47 47  
67 +(% class="wrapped" %)
48 48  |=(((
49 49  Extension Element
50 50  )))|=(((
... ... @@ -69,7 +69,7 @@
69 69  * 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.
70 70  * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
71 71  * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
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.
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.
73 73  )))
74 74  |(((
75 75  transformationGroup
... ... @@ -77,8 +77,9 @@
77 77  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:
78 78  
79 79  * 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!
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.
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.
81 81  * 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.
82 82  )))
83 83  
84 84  === Example ===
... ... @@ -91,9 +91,7 @@
91 91   dependencies="TRIGGEREFFECT, SURFACEDEPTH"
92 92   name="Transform All Normalize">
93 93   </transformationGroup>
94 - </extension>
95 - <extension
96 - point="de.cau.cs.kieler.kico.transformation">
115 +
97 97   <transformationMethod
98 98   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
99 99   id="TRIGGEREFFECT"
... ... @@ -100,10 +100,7 @@
100 100   method="transformTriggerEffect"
101 101   name="Transform Trigger and Effect">
102 102   </transformationMethod>
103 - </extension>
104 -
105 - <extension
106 - point="de.cau.cs.kieler.kico.transformation">
122 +
107 107   <transformationMethod
108 108   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
109 109   id="SURFACEDEPTH"
... ... @@ -110,10 +110,7 @@
110 110   method="transformSurfaceDepth"
111 111   name="Transform Surface Depth">
112 112   </transformationMethod>
113 - </extension>
114 -
115 - <extension
116 - point="de.cau.cs.kieler.kico.transformation">
129 +
117 117   <transformationGroup
118 118   id="ALL"
119 119   dependencies="CORE NORMALIZE"
... ... @@ -122,12 +122,13 @@
122 122   </extension>
123 123  {{/code}}
124 124  
125 -
138 +\\
126 126  
127 127  == Compilation ==
128 128  
129 129  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:
130 130  
144 +(% class="wrapped" %)
131 131  |=(((
132 132  Method
133 133  )))|=(((
... ... @@ -150,7 +150,6 @@
150 150  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.
151 151  )))
152 152  |(((
153 -
154 154  \\
155 155  
156 156  {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
... ... @@ -185,10 +185,153 @@
185 185  
186 186  {{/code}}
187 187  
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 +
188 188  == Help / Problems / FAQs ==
189 189  
190 190  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).
191 191  
347 +(% class="wrapped" %)
192 192  |=(((
193 193  Symptom
194 194  )))|=(((
... ... @@ -200,7 +200,10 @@
200 200  You get the following run time error:
201 201  
202 202  
203 -\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
359 +
360 +
361 +
362 +\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
204 204  [[java:136>>url:http://java:136||shape="rect"]]
205 205  [[java:164>>url:http://java:164||shape="rect"]]\\
206 206  
... ... @@ -217,7 +217,7 @@
217 217  Maybe the plugin declaring "ABORT2" was not loaded
218 218  or the ID is misspelled.
219 219  
220 -
379 +\\
221 221  )))|(((
222 222  Check why "ABORT2" may not be found
223 223  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 -9470083
1 +9470057
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470083/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler