Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 21.1
edited by cmot
on 2014/03/21 14:33
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,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  
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 29  == Extension Point ==
30 30  
... ... @@ -39,10 +39,12 @@
39 39  )))
40 40  1. Add the extension
41 41  
54 +{{{de.cau.cs.kieler.kico.transformation}}}
42 42  
43 -{{{de.cau.cs.kieler.kico.transformation}}}(((
56 +(((
44 44  
45 45  )))
59 +
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  
66 +(% class="wrapped" %)
52 52  |=(((
53 53  Extension Element
54 54  )))|=(((
... ... @@ -119,12 +119,12 @@
119 119   </extension>
120 120  {{/code}}
121 121  
122 -
123 123  
124 124  == Compilation ==
125 125  
126 126  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:
127 127  
142 +(% class="wrapped" %)
128 128  |=(((
129 129  Method
130 130  )))|=(((
... ... @@ -131,9 +131,9 @@
131 131  Description
132 132  )))
133 133  |(((
134 -\\
149 +
135 135  
136 -{{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject)}}}
151 +{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject)}}}
137 137  )))|(((
138 138  * 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.
139 139  * eObject: The EObject that is the input to the compilation process.
... ... @@ -140,7 +140,7 @@
140 140  * Returns: The EObject returned from the last model transformation called by KiCo.
141 141  )))
142 142  |(((
143 -\\
158 +
144 144  
145 145  {{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
146 146  )))|(((
... ... @@ -147,10 +147,9 @@
147 147  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.
148 148  )))
149 149  |(((
165 +
150 150  
151 -\\
152 -
153 -{{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
167 +{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject, boolean autoexpand)}}}
154 154  )))|(((
155 155  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.
156 156  )))
... ... @@ -161,10 +161,10 @@
161 161  import de.cau.cs.kieler.kico.KielerCompiler;
162 162  ...
163 163  private MyEObjectClass myMethod(EObject eObject) {
164 - ...
165 - transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
166 - ...
167 - return transformed
178 + ...
179 + transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
180 + ...
181 + return transformed
168 168  }
169 169  {{/code}}
170 170  
... ... @@ -171,10 +171,10 @@
171 171  {{code title="Xtend Code"}}
172 172  import de.cau.cs.kieler.kico.KielerCompiler
173 173  ...
174 -def dispatch MyEObjectClass myMethod(EObject eObject) {
175 - transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
176 - ...
177 - transformed
188 +def dispatch MyEObjectClass myMethod(EObject eObject) {
189 + transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
190 + ...
191 + transformed
178 178  }
179 179  
180 180  
... ... @@ -184,21 +184,29 @@
184 184  
185 185  === Requirement Completion ===
186 186  
187 -
188 188  
202 +(% class="wrapped" %)
189 189  |=(((
204 +(% class="content-wrapper" %)
205 +(((
190 190  (% style="text-align: center;" %)
191 191  Original
192 192  
209 +(% class="wrapped" %)
193 193  |=(((
211 +(% class="content-wrapper" %)
212 +(((
194 194   [[image:attach:dependencies2.jpg]]
195 195  
196 196  (% style="text-align: center;" %)
197 197  Original Dependency
198 198  Graph
218 +)))
199 199  )))|=(((
220 +(% class="content-wrapper" %)
221 +(((
222 +(% style="text-align:center" %)
200 200  [[image:attach:dependencies3.jpg]]
201 -
202 202  
203 203  (% style="text-align: center;" %)
204 204  Two alternative
... ... @@ -206,19 +206,29 @@
206 206  implementations
207 207  for Abort
208 208  )))
231 +)))
209 209  
210 210  
211 -)))|=(((
234 +)))
235 +)))|=(% scope="row" %)(((
236 +(% class="content-wrapper" %)
237 +(((
212 212  (% style="text-align: center;" %)
213 213  Example 1
214 214  
241 +(% class="wrapped" %)
215 215  |=(((
243 +(% class="content-wrapper" %)
244 +(((
216 216   [[image:attach:dependencies4.jpg]]
217 217  
218 218  (% style="text-align: center;" %)
219 219  Selected for
220 220  transformation
250 +)))
221 221  )))|=(((
252 +(% class="content-wrapper" %)
253 +(((
222 222   [[image:attach:dependencies4b.jpg]]
223 223  
224 224  (% style="text-align: center;" %)
... ... @@ -225,45 +225,68 @@
225 225  Auto selected
226 226  requirements
227 227  )))
260 +)))
228 228  
229 229  
230 230  )))
264 +)))
231 231  
232 -
233 233  
234 -
235 235  
268 +(% class="wrapped" %)
236 236  |=(((
270 +(% class="content-wrapper" %)
271 +(((
272 +(% style="text-align: center;" %)
237 237  Example 2
238 238  
275 +(% class="wrapped" %)
239 239  |=(((
277 +(% class="content-wrapper" %)
278 +(((
240 240  [[image:attach:dependencies5.jpg]]
241 241  
242 242  (% style="text-align: center;" %)
243 243  Selected for
244 244  transformation
284 +)))
245 245  )))|=(% style="text-align: center;" %)(% style="text-align: center;" %)
246 246  (((
287 +(% class="content-wrapper" %)
288 +(((
247 247  [[image:attach:dependencies5b.jpg]]
248 -\\Auto selected
290 +
291 +Auto selected
249 249  requirements
250 250  using DEFAULT
251 -of alternative
294 +of alternative
252 252  group
296 +
297 +
253 253  )))
299 +)))
254 254  
255 255  
256 -)))|=(((
302 +)))
303 +)))|=(% scope="row" %)(((
304 +(% class="content-wrapper" %)
305 +(((
257 257  (% style="text-align: center;" %)
258 258  Example 3
259 259  
309 +(% class="wrapped" %)
260 260  |=(((
311 +(% class="content-wrapper" %)
312 +(((
261 261  [[image:attach:dependencies6.jpg]]
262 262  
263 263  (% style="text-align: center;" %)
264 264  Selected for
265 265  transformation
318 +)))
266 266  )))|=(((
320 +(% class="content-wrapper" %)
321 +(((
267 267  [[image:attach:dependencies6b.jpg]]
268 268  
269 269  (% style="text-align: center;" %)
... ... @@ -272,16 +272,18 @@
272 272  using selected
273 273  alternative
274 274  )))
330 +)))
275 275  
276 276  
277 277  )))
334 +)))
278 278  
279 -
280 280  
281 281  == Help / Problems / FAQs ==
282 282  
283 283  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).
284 284  
341 +(% class="wrapped" %)
285 285  |=(((
286 286  Symptom
287 287  )))|=(((
... ... @@ -293,11 +293,18 @@
293 293  You get the following run time error:
294 294  
295 295  
296 -\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
353 +
354 +
355 +
356 +
357 +
358 +
359 +
360 +\\[[java:102>>url:http://java:102||shape="rect"]]
297 297  [[java:136>>url:http://java:136||shape="rect"]]
298 -[[java:164>>url:http://java:164||shape="rect"]]\\
362 +[[java:164>>url:http://java:164||shape="rect"]]
299 299  
300 -{{{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.)...}}}
301 301  )))|(((
302 302  There is a transformation with ID "ABORT2" referenced
303 303  either by the initial call to KielerCompiler.compile() or
... ... @@ -314,7 +314,7 @@
314 314  )))|(((
315 315  Check why "ABORT2" may not be found
316 316  by KiCo, more specifically, check if the
317 -declaring can be loaded (sometimes
381 +declaring can be loaded (sometimes
318 318  compiler error prevent it from being loaded
319 319  or it has unsatisfied dependencies).
320 320  Also check the spelling of the ID, maybe
... ... @@ -326,7 +326,6 @@
326 326  
327 327  {{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
328 328  
329 -\\
330 330  
331 331  {{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}}
332 332  )))|(((
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 -9470115
1 +9470057
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470115/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler