Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 17.1
edited by cmot
on 2014/03/17 14:48
Change comment: There is no comment for this version
To version 41.1
edited by Richard Kreissig
on 2023/09/14 10:52
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +KIELER.SCCharts (DeprecatedHistorical Documentation & Features).WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cmot
1 +XWiki.stu230980
Content
... ... @@ -1,4 +1,8 @@
1 -{{panel title="Project Overview" borderStyle="dashed"}}
1 +Deprecated since 0.13
2 +This article is deprecated. The described features are no longer available in current releases.
3 +
4 +== Project Overview ==
5 +
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,12 @@
6 6  Related Theses:
7 7  
8 8  * none yet
9 -{{/panel}}
10 10  
14 +**To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:KIELER.SCCharts (DeprecatedHistorical Documentation & Features).SCCharts (pre 1\.0).Online Compiler.WebHome]].**
15 +
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.
18 +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  
28 +(% class="wrapped" %)
23 23  |=(((
24 -[[image:attach:KiCo.jpg]]
30 +(% class="content-wrapper" %)
31 +(((
32 +[[image:attach:IMAG4642.jpg]]
33 +)))
25 25  )))|=(((
26 -[[image:attach:KiCo3.jpg]]
35 +(% class="content-wrapper" %)
36 +(((
37 +[[image:attach:KiCo.jpg]]
27 27  )))
39 +)))
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:
... ... @@ -45,10 +45,12 @@
45 45  )))
46 46  1. Add the extension
47 47  
54 +{{{de.cau.cs.kieler.kico.transformation}}}
48 48  
49 -{{{de.cau.cs.kieler.kico.transformation}}}(((
56 +(((
50 50  
51 51  )))
59 +
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  
66 +(% 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.
91 +* 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">
114 +
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">
121 +
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">
128 +
128 128   <transformationGroup
129 129   id="ALL"
130 130   dependencies="CORE NORMALIZE"
... ... @@ -133,12 +133,12 @@
133 133   </extension>
134 134  {{/code}}
135 135  
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" %)
142 142  |=(((
143 143  Method
144 144  )))|=(((
... ... @@ -145,9 +145,9 @@
145 145  Description
146 146  )))
147 147  |(((
148 -\\
149 +
149 149  
150 -{{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject)}}}
151 +{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject)}}}
151 151  )))|(((
152 152  * transformationIDs: List of Strings representing the transformation IDs and a pre-ordering. Note that KiCo may automatically modify the order to meet the dependencies of the referenced transformation IDs or transformation group IDs.
153 153  * eObject: The EObject that is the input to the compilation process.
... ... @@ -154,7 +154,7 @@
154 154  * Returns: The EObject returned from the last model transformation called by KiCo.
155 155  )))
156 156  |(((
157 -\\
158 +
158 158  
159 159  {{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
160 160  )))|(((
... ... @@ -161,10 +161,9 @@
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  |(((
165 +
164 164  
165 -\\
166 -
167 -{{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
167 +{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject, boolean autoexpand)}}}
168 168  )))|(((
169 169  This is an advanced compile method which can turn of auto-expansion with the last parameter. Use this with care! Note that if switching autoexpand off you cannot use transformation group IDs any more. Also no dependencies will be considered. The transformations will be applied straight forward in the order defined by the transformationIDs list.
170 170  )))
... ... @@ -175,10 +175,10 @@
175 175  import de.cau.cs.kieler.kico.KielerCompiler;
176 176  ...
177 177  private MyEObjectClass myMethod(EObject eObject) {
178 - ...
179 - transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
180 - ...
181 - return transformed
178 + ...
179 + transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
180 + ...
181 + return transformed
182 182  }
183 183  {{/code}}
184 184  
... ... @@ -185,10 +185,10 @@
185 185  {{code title="Xtend Code"}}
186 186  import de.cau.cs.kieler.kico.KielerCompiler
187 187  ...
188 -def dispatch MyEObjectClass myMethod(EObject eObject) {
189 - transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
190 - ...
191 - transformed
188 +def dispatch MyEObjectClass myMethod(EObject eObject) {
189 + transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
190 + ...
191 + transformed
192 192  }
193 193  
194 194  
... ... @@ -196,10 +196,149 @@
196 196  
197 197  {{/code}}
198 198  
199 +=== Requirement Completion ===
200 +
201 +
202 +(% class="wrapped" %)
203 +|=(((
204 +(% class="content-wrapper" %)
205 +(((
206 +(% style="text-align: center;" %)
207 +Original
208 +
209 +(% class="wrapped" %)
210 +|=(((
211 +(% class="content-wrapper" %)
212 +(((
213 + [[image:attach:dependencies2.jpg]]
214 +
215 +(% style="text-align: center;" %)
216 +Original Dependency
217 +Graph
218 +)))
219 +)))|=(((
220 +(% class="content-wrapper" %)
221 +(((
222 +(% style="text-align:center" %)
223 +[[image:attach:dependencies3.jpg]]
224 +
225 +(% style="text-align: center;" %)
226 +Two alternative
227 +transformation
228 +implementations
229 +for Abort
230 +)))
231 +)))
232 +
233 +
234 +)))
235 +)))|=(% scope="row" %)(((
236 +(% class="content-wrapper" %)
237 +(((
238 +(% style="text-align: center;" %)
239 +Example 1
240 +
241 +(% class="wrapped" %)
242 +|=(((
243 +(% class="content-wrapper" %)
244 +(((
245 + [[image:attach:dependencies4.jpg]]
246 +
247 +(% style="text-align: center;" %)
248 +Selected for
249 +transformation
250 +)))
251 +)))|=(((
252 +(% class="content-wrapper" %)
253 +(((
254 + [[image:attach:dependencies4b.jpg]]
255 +
256 +(% style="text-align: center;" %)
257 +Auto selected
258 +requirements
259 +)))
260 +)))
261 +
262 +
263 +)))
264 +)))
265 +
266 +
267 +
268 +(% class="wrapped" %)
269 +|=(((
270 +(% class="content-wrapper" %)
271 +(((
272 +(% style="text-align: center;" %)
273 +Example 2
274 +
275 +(% class="wrapped" %)
276 +|=(((
277 +(% class="content-wrapper" %)
278 +(((
279 +[[image:attach:dependencies5.jpg]]
280 +
281 +(% style="text-align: center;" %)
282 +Selected for
283 +transformation
284 +)))
285 +)))|=(% style="text-align: center;" %)(% style="text-align: center;" %)
286 +(((
287 +(% class="content-wrapper" %)
288 +(((
289 +[[image:attach:dependencies5b.jpg]]
290 +
291 +Auto selected
292 +requirements
293 +using DEFAULT
294 +of alternative
295 +group
296 +
297 +
298 +)))
299 +)))
300 +
301 +
302 +)))
303 +)))|=(% scope="row" %)(((
304 +(% class="content-wrapper" %)
305 +(((
306 +(% style="text-align: center;" %)
307 +Example 3
308 +
309 +(% class="wrapped" %)
310 +|=(((
311 +(% class="content-wrapper" %)
312 +(((
313 +[[image:attach:dependencies6.jpg]]
314 +
315 +(% style="text-align: center;" %)
316 +Selected for
317 +transformation
318 +)))
319 +)))|=(((
320 +(% class="content-wrapper" %)
321 +(((
322 +[[image:attach:dependencies6b.jpg]]
323 +
324 +(% style="text-align: center;" %)
325 +Auto selected
326 +requirements
327 +using selected
328 +alternative
329 +)))
330 +)))
331 +
332 +
333 +)))
334 +)))
335 +
336 +
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  
341 +(% class="wrapped" %)
203 203  |=(((
204 204  Symptom
205 205  )))|=(((
... ... @@ -211,11 +211,18 @@
211 211  You get the following run time error:
212 212  
213 213  
214 -\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
353 +
354 +
355 +
356 +
357 +
358 +
359 +
360 +\\[[java:102>>url:http://java:102||shape="rect"]]
215 215  [[java:136>>url:http://java:136||shape="rect"]]
216 -[[java:164>>url:http://java:164||shape="rect"]]\\
362 +[[java:164>>url:http://java:164||shape="rect"]]
217 217  
218 -{{{ENTRY de.cau.cs.kieler.klighd 4 0 2014-03-17 11:08:46.009!MESSAGE !STACK 0java.lang.RuntimeException: Cannot find a transformation with the ID 'ABORT2'. Make sure that the transformation with this ID is registered and its declaring plugin is loaded. Make sure that the ID does exactly match (case sensitive). Maybe you forgot to separate multiple ID's by a comma.    at de.cau.cs.kieler.kico.KielerCompiler.getTransformation(KielerCompiler.java:61)    at de.cau.cs.kieler.kico.KielerCompiler.getDependencies(KielerCompiler.java:82)    at de.cau.cs.kieler.kico.KielerCompiler.isDependingOn(KielerCompiler.)    at de.cau.cs.kieler.kico.KielerCompiler.insertTransformationID(KielerCompiler.)    at de.cau.cs.kieler.kico.KielerCompiler.expandDependencies(KielerCompiler.)...}}}
364 +{{{ENTRY de.cau.cs.kieler.klighd 4 0 2014-03-17 11:08:46.009!MESSAGE !STACK 0java.lang.RuntimeException: Cannot find a transformation with the ID 'ABORT2'. Make sure that the transformation with this ID is registered and its declaring plugin is loaded. Make sure that the ID does exactly match (case sensitive). Maybe you forgot to separate multiple ID's by a comma.   at de.cau.cs.kieler.kico.KielerCompiler.getTransformation(KielerCompiler.java:61)   at de.cau.cs.kieler.kico.KielerCompiler.getDependencies(KielerCompiler.java:82)   at de.cau.cs.kieler.kico.KielerCompiler.isDependingOn(KielerCompiler.)   at de.cau.cs.kieler.kico.KielerCompiler.insertTransformationID(KielerCompiler.)   at de.cau.cs.kieler.kico.KielerCompiler.expandDependencies(KielerCompiler.)...}}}
219 219  )))|(((
220 220  There is a transformation with ID "ABORT2" referenced
221 221  either by the initial call to KielerCompiler.compile() or
... ... @@ -232,7 +232,7 @@
232 232  )))|(((
233 233  Check why "ABORT2" may not be found
234 234  by KiCo, more specifically, check if the
235 -declaring can be loaded (sometimes
381 +declaring can be loaded (sometimes
236 236  compiler error prevent it from being loaded
237 237  or it has unsatisfied dependencies).
238 238  Also check the spelling of the ID, maybe
... ... @@ -244,7 +244,6 @@
244 244  
245 245  {{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
246 246  
247 -\\
248 248  
249 249  {{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}}
250 250  )))|(((
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 -9470088
1 +9470057
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470088/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler