Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52

From version 41.1
edited by Richard Kreissig
on 2023/09/14 10:52
Change comment: There is no comment for this version
To version 27.1
edited by cmot
on 2014/06/26 15:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -KIELER.SCCharts (DeprecatedHistorical Documentation & Features).WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.stu230980
1 +XWiki.cmot
Content
... ... @@ -1,8 +1,4 @@
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 -
1 +{{panel title="Project Overview" borderStyle="dashed"}}
6 6  Responsible:
7 7  
8 8  * [[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"]]
... ... @@ -11,11 +11,12 @@
11 11  
12 12  * none yet
13 13  
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]].**
10 +**To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:Online Compiler]].**
11 +{{/panel}}
15 15  
16 16  = Kieler Compiler (KiCo) =
17 17  
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"]].**
15 +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>>doc:Online Compiler]].**
19 19  
20 20  
21 21  
... ... @@ -25,18 +25,11 @@
25 25  
26 26  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.
27 27  
28 -(% class="wrapped" %)
29 29  |=(((
30 -(% class="content-wrapper" %)
31 -(((
32 32  [[image:attach:IMAG4642.jpg]]
33 -)))
34 34  )))|=(((
35 -(% class="content-wrapper" %)
36 -(((
37 37  [[image:attach:KiCo.jpg]]
38 38  )))
39 -)))
40 40  
41 41  == Extension Point ==
42 42  
... ... @@ -51,12 +51,10 @@
51 51  )))
52 52  1. Add the extension
53 53  
54 -{{{de.cau.cs.kieler.kico.transformation}}}
55 55  
56 -(((
45 +{{{de.cau.cs.kieler.kico.transformation}}}(((
57 57  
58 58  )))
59 -
60 60  1. (((
61 61  Add one of the following extension element
62 62  
... ... @@ -63,7 +63,6 @@
63 63  [[image:attach:KiCo2.jpg]]
64 64  )))
65 65  
66 -(% class="wrapped" %)
67 67  |=(((
68 68  Extension Element
69 69  )))|=(((
... ... @@ -134,12 +134,12 @@
134 134   </extension>
135 135  {{/code}}
136 136  
124 +
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" %)
143 143  |=(((
144 144  Method
145 145  )))|=(((
... ... @@ -146,9 +146,9 @@
146 146  Description
147 147  )))
148 148  |(((
149 -
136 +\\
150 150  
151 -{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject)}}}
138 +{{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject)}}}
152 152  )))|(((
153 153  * 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.
154 154  * eObject: The EObject that is the input to the compilation process.
... ... @@ -155,7 +155,7 @@
155 155  * Returns: The EObject returned from the last model transformation called by KiCo.
156 156  )))
157 157  |(((
158 -
145 +\\
159 159  
160 160  {{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
161 161  )))|(((
... ... @@ -162,9 +162,10 @@
162 162  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.
163 163  )))
164 164  |(((
165 -
166 166  
167 -{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject, boolean autoexpand)}}}
153 +\\
154 +
155 +{{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; 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
166 + ...
167 + transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
168 + ...
169 + 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
176 +def dispatch MyEObjectClass myMethod(EObject eObject) {
177 + transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
178 + ...
179 + transformed
192 192  }
193 193  
194 194  
... ... @@ -198,28 +198,20 @@
198 198  
199 199  === Requirement Completion ===
200 200  
189 +
201 201  
202 -(% class="wrapped" %)
203 203  |=(((
204 -(% class="content-wrapper" %)
205 -(((
206 206  (% style="text-align: center;" %)
207 207  Original
208 208  
209 -(% class="wrapped" %)
210 210  |=(((
211 -(% class="content-wrapper" %)
212 -(((
213 213   [[image:attach:dependencies2.jpg]]
214 214  
215 215  (% style="text-align: center;" %)
216 216  Original Dependency
217 217  Graph
218 -)))
219 219  )))|=(((
220 -(% class="content-wrapper" %)
221 -(((
222 -(% style="text-align:center" %)
202 +(% style="text-align: center;" %)
223 223  [[image:attach:dependencies3.jpg]]
224 224  
225 225  (% style="text-align: center;" %)
... ... @@ -228,29 +228,19 @@
228 228  implementations
229 229  for Abort
230 230  )))
231 -)))
232 232  
233 233  
234 -)))
235 -)))|=(% scope="row" %)(((
236 -(% class="content-wrapper" %)
237 -(((
213 +)))|=(((
238 238  (% style="text-align: center;" %)
239 239  Example 1
240 240  
241 -(% class="wrapped" %)
242 242  |=(((
243 -(% class="content-wrapper" %)
244 -(((
245 245   [[image:attach:dependencies4.jpg]]
246 246  
247 247  (% style="text-align: center;" %)
248 248  Selected for
249 249  transformation
250 -)))
251 251  )))|=(((
252 -(% class="content-wrapper" %)
253 -(((
254 254   [[image:attach:dependencies4b.jpg]]
255 255  
256 256  (% style="text-align: center;" %)
... ... @@ -257,68 +257,49 @@
257 257  Auto selected
258 258  requirements
259 259  )))
260 -)))
261 261  
262 262  
263 263  )))
264 -)))
265 265  
234 +
266 266  
236 +
267 267  
268 -(% class="wrapped" %)
269 269  |=(((
270 -(% class="content-wrapper" %)
271 -(((
272 272  (% style="text-align: center;" %)
273 273  Example 2
274 274  
275 -(% class="wrapped" %)
276 276  |=(((
277 -(% class="content-wrapper" %)
278 -(((
279 279  [[image:attach:dependencies5.jpg]]
280 280  
281 281  (% style="text-align: center;" %)
282 282  Selected for
283 283  transformation
284 -)))
285 285  )))|=(% style="text-align: center;" %)(% style="text-align: center;" %)
286 286  (((
287 -(% class="content-wrapper" %)
288 -(((
289 289  [[image:attach:dependencies5b.jpg]]
290 290  
291 291  Auto selected
292 292  requirements
293 293  using DEFAULT
294 -of alternative
255 +of alternative
295 295  group
296 296  
297 297  
298 298  )))
299 -)))
300 300  
301 301  
302 -)))
303 -)))|=(% scope="row" %)(((
304 -(% class="content-wrapper" %)
305 -(((
262 +)))|=(((
306 306  (% style="text-align: center;" %)
307 307  Example 3
308 308  
309 -(% class="wrapped" %)
310 310  |=(((
311 -(% class="content-wrapper" %)
312 -(((
313 313  [[image:attach:dependencies6.jpg]]
314 314  
315 315  (% style="text-align: center;" %)
316 316  Selected for
317 317  transformation
318 -)))
319 319  )))|=(((
320 -(% class="content-wrapper" %)
321 -(((
322 322  [[image:attach:dependencies6b.jpg]]
323 323  
324 324  (% style="text-align: center;" %)
... ... @@ -327,18 +327,16 @@
327 327  using selected
328 328  alternative
329 329  )))
330 -)))
331 331  
332 332  
333 333  )))
334 -)))
335 335  
285 +
336 336  
337 337  == Help / Problems / FAQs ==
338 338  
339 339  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).
340 340  
341 -(% class="wrapped" %)
342 342  |=(((
343 343  Symptom
344 344  )))|=(((
... ... @@ -350,18 +350,11 @@
350 350  You get the following run time error:
351 351  
352 352  
353 -
354 -
355 -
356 -
357 -
358 -
359 -
360 -\\[[java:102>>url:http://java:102||shape="rect"]]
302 +\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
361 361  [[java:136>>url:http://java:136||shape="rect"]]
362 -[[java:164>>url:http://java:164||shape="rect"]]
304 +[[java:164>>url:http://java:164||shape="rect"]]\\
363 363  
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.)...}}}
306 +{{{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.)...}}}
365 365  )))|(((
366 366  There is a transformation with ID "ABORT2" referenced
367 367  either by the initial call to KielerCompiler.compile() or
... ... @@ -378,7 +378,7 @@
378 378  )))|(((
379 379  Check why "ABORT2" may not be found
380 380  by KiCo, more specifically, check if the
381 -declaring can be loaded (sometimes
323 +declaring can be loaded (sometimes
382 382  compiler error prevent it from being loaded
383 383  or it has unsatisfied dependencies).
384 384  Also check the spelling of the ID, maybe
... ... @@ -390,6 +390,7 @@
390 390  
391 391  {{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
392 392  
335 +\\
393 393  
394 394  {{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}}
395 395  )))|(((
IMAG4642.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -1.5 MB
Content
KiCo.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -138.2 KB
Content
KiCo2.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -5.0 KB
Content
KiCo3.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -166.2 KB
Content
dependencies2.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -170.9 KB
Content
dependencies2.pdf
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -18.5 KB
Content
dependencies3.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -242.8 KB
Content
dependencies4.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -252.6 KB
Content
dependencies4b.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -260.5 KB
Content
dependencies5.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -249.6 KB
Content
dependencies5b.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -281.7 KB
Content
dependencies6.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -258.3 KB
Content
dependencies6b.jpg
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.XWikiGuest
Size
... ... @@ -1,1 +1,0 @@
1 -283.2 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470057
1 +25952291
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/25952291/Kieler Compiler