Skip to Content

Changes for page Kieler Compiler

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

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +KIELER.Home.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:Online Compiler]].**
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,13 +31,13 @@
31 31  
32 32  {{{de.cau.cs.kieler.kico}}}
33 33  
34 -
51 +\\
35 35  )))
36 36  1. Add the extension
37 37  
38 38  
39 39  {{{de.cau.cs.kieler.kico.transformation}}}(((
40 -
57 +\\
41 41  )))
42 42  1. (((
43 43  Add one of the following extension element
... ... @@ -45,6 +45,7 @@
45 45  [[image:attach:KiCo2.jpg]]
46 46  )))
47 47  
65 +(% 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.
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.
73 73  )))
74 74  |(((
75 75  transformationGroup
... ... @@ -77,7 +77,7 @@
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.
98 +* 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.
82 82  * 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.
83 83  )))
... ... @@ -92,9 +92,7 @@
92 92   dependencies="TRIGGEREFFECT, SURFACEDEPTH"
93 93   name="Transform All Normalize">
94 94   </transformationGroup>
95 - </extension>
96 - <extension
97 - point="de.cau.cs.kieler.kico.transformation">
113 +
98 98   <transformationMethod
99 99   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
100 100   id="TRIGGEREFFECT"
... ... @@ -101,10 +101,7 @@
101 101   method="transformTriggerEffect"
102 102   name="Transform Trigger and Effect">
103 103   </transformationMethod>
104 - </extension>
105 -
106 - <extension
107 - point="de.cau.cs.kieler.kico.transformation">
120 +
108 108   <transformationMethod
109 109   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
110 110   id="SURFACEDEPTH"
... ... @@ -111,10 +111,7 @@
111 111   method="transformSurfaceDepth"
112 112   name="Transform Surface Depth">
113 113   </transformationMethod>
114 - </extension>
115 -
116 - <extension
117 - point="de.cau.cs.kieler.kico.transformation">
127 +
118 118   <transformationGroup
119 119   id="ALL"
120 120   dependencies="CORE NORMALIZE"
... ... @@ -123,12 +123,13 @@
123 123   </extension>
124 124  {{/code}}
125 125  
126 -
136 +\\
127 127  
128 128  == Compilation ==
129 129  
130 130  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:
131 131  
142 +(% class="wrapped" %)
132 132  |=(((
133 133  Method
134 134  )))|=(((
... ... @@ -186,10 +186,153 @@
186 186  
187 187  {{/code}}
188 188  
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 +
189 189  == Help / Problems / FAQs ==
190 190  
191 191  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).
192 192  
346 +(% class="wrapped" %)
193 193  |=(((
194 194  Symptom
195 195  )))|=(((
... ... @@ -218,7 +218,7 @@
218 218  Maybe the plugin declaring "ABORT2" was not loaded
219 219  or the ID is misspelled.
220 220  
221 -
375 +\\
222 222  )))|(((
223 223  Check why "ABORT2" may not be found
224 224  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 -9470084
1 +9470057
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470084/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler