Changes for page Kieler Compiler
Last modified by Richard Kreissig on 2023/09/14 10:52
Summary
-
Page properties (2 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. cmot1 +XWiki.aas2 - Content
-
... ... @@ -1,6 +1,18 @@ 1 +{{panel borderStyle="dashed" title="Project Overview"}} 2 +Responsible: 3 + 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"]] 5 + 6 +Related Theses: 7 + 8 +* none yet 9 + 10 +**To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:Online Compiler]].** 11 +{{/panel}} 12 + 1 1 = Kieler Compiler (KiCo) = 2 2 3 -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. 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>>url:http://www.sccharts.com/||shape="rect"]].** 4 4 5 5 6 6 ... ... @@ -10,7 +10,18 @@ 10 10 11 11 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. 12 12 25 +(% class="wrapped" %) 26 +|=((( 27 +(% class="content-wrapper" %) 28 +((( 29 +[[image:attach:IMAG4642.jpg]] 30 +))) 31 +)))|=((( 32 +(% class="content-wrapper" %) 33 +((( 13 13 [[image:attach:KiCo.jpg]] 35 +))) 36 +))) 14 14 15 15 == Extension Point == 16 16 ... ... @@ -21,17 +21,21 @@ 21 21 22 22 {{{de.cau.cs.kieler.kico}}} 23 23 24 - 47 +\\ 25 25 ))) 26 26 1. Add the extension 27 27 28 28 29 -{{{de.cau.cs.kieler.kico.transformation}}} 52 +{{{de.cau.cs.kieler.kico.transformation}}}((( 53 +\\ 54 +))) 55 +1. ((( 56 +Add one of the following extension element 30 30 31 -Add one of the following 32 - 33 33 [[image:attach:KiCo2.jpg]] 59 +))) 34 34 61 +(% class="wrapped" %) 35 35 |=((( 36 36 Extension Element 37 37 )))|=((( ... ... @@ -56,7 +56,7 @@ 56 56 * 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. 57 57 * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo. 58 58 * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name. 59 -* 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.86 +* 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. 60 60 ))) 61 61 |((( 62 62 transformationGroup ... ... @@ -64,8 +64,9 @@ 64 64 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: 65 65 66 66 * 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! 67 -* dependencies: These are NOToptional for groups.Groups must specify their transformationsas 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.94 +* 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. 68 68 * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name. 96 +* 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. 69 69 ))) 70 70 71 71 === Example === ... ... @@ -78,9 +78,7 @@ 78 78 dependencies="TRIGGEREFFECT, SURFACEDEPTH" 79 79 name="Transform All Normalize"> 80 80 </transformationGroup> 81 - </extension> 82 - <extension 83 - point="de.cau.cs.kieler.kico.transformation"> 109 + 84 84 <transformationMethod 85 85 class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation" 86 86 id="TRIGGEREFFECT" ... ... @@ -87,10 +87,7 @@ 87 87 method="transformTriggerEffect" 88 88 name="Transform Trigger and Effect"> 89 89 </transformationMethod> 90 - </extension> 91 - 92 - <extension 93 - point="de.cau.cs.kieler.kico.transformation"> 116 + 94 94 <transformationMethod 95 95 class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation" 96 96 id="SURFACEDEPTH" ... ... @@ -97,10 +97,7 @@ 97 97 method="transformSurfaceDepth" 98 98 name="Transform Surface Depth"> 99 99 </transformationMethod> 100 - </extension> 101 - 102 - <extension 103 - point="de.cau.cs.kieler.kico.transformation"> 123 + 104 104 <transformationGroup 105 105 id="ALL" 106 106 dependencies="CORE NORMALIZE" ... ... @@ -109,12 +109,13 @@ 109 109 </extension> 110 110 {{/code}} 111 111 112 - 132 +\\ 113 113 114 114 == Compilation == 115 115 116 116 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: 117 117 138 +(% class="wrapped" %) 118 118 |=((( 119 119 Method 120 120 )))|=((( ... ... @@ -171,3 +171,208 @@ 171 171 172 172 173 173 {{/code}} 195 + 196 +=== Requirement Completion === 197 + 198 +\\ 199 + 200 +(% class="wrapped" %) 201 +|=((( 202 +(% class="content-wrapper" %) 203 +((( 204 +(% style="text-align: center;" %) 205 +Original 206 + 207 +(% class="wrapped" %) 208 +|=((( 209 +(% class="content-wrapper" %) 210 +((( 211 + [[image:attach:dependencies2.jpg]] 212 + 213 +(% style="text-align: center;" %) 214 +Original Dependency 215 +Graph 216 +))) 217 +)))|=((( 218 +(% class="content-wrapper" %) 219 +((( 220 +(% style="text-align: center;" %) 221 +[[image:attach:dependencies3.jpg]] 222 + 223 +(% style="text-align: center;" %) 224 +Two alternative 225 +transformation 226 +implementations 227 +for Abort 228 +))) 229 +))) 230 + 231 +\\ 232 +))) 233 +)))|=((( 234 +(% class="content-wrapper" %) 235 +((( 236 +(% style="text-align: center;" %) 237 +Example 1 238 + 239 +(% class="wrapped" %) 240 +|=((( 241 +(% class="content-wrapper" %) 242 +((( 243 + [[image:attach:dependencies4.jpg]] 244 + 245 +(% style="text-align: center;" %) 246 +Selected for 247 +transformation 248 +))) 249 +)))|=((( 250 +(% class="content-wrapper" %) 251 +((( 252 + [[image:attach:dependencies4b.jpg]] 253 + 254 +(% style="text-align: center;" %) 255 +Auto selected 256 +requirements 257 +))) 258 +))) 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 +)))|=((( 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 +\\ 337 + 338 +== Help / Problems / FAQs == 339 + 340 +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). 341 + 342 +(% class="wrapped" %) 343 +|=((( 344 +Symptom 345 +)))|=((( 346 +Reason 347 +)))|=((( 348 +Solution 349 +))) 350 +|((( 351 +You get the following run time error: 352 + 353 + 354 +\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]] 355 +[[java:136>>url:http://java:136||shape="rect"]] 356 +[[java:164>>url:http://java:164||shape="rect"]]\\ 357 + 358 +{{{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.)...}}} 359 +)))|((( 360 +There is a transformation with ID "ABORT2" referenced 361 +either by the initial call to KielerCompiler.compile() or 362 +by some of the dependent transformations / 363 +transformation group. 364 + 365 +But KiCo could not find any registered transformation 366 +with ID "ABORT2". 367 + 368 +Maybe the plugin declaring "ABORT2" was not loaded 369 +or the ID is misspelled. 370 + 371 +\\ 372 +)))|((( 373 +Check why "ABORT2" may not be found 374 +by KiCo, more specifically, check if the 375 +declaring can be loaded (sometimes 376 +compiler error prevent it from being loaded 377 +or it has unsatisfied dependencies). 378 +Also check the spelling of the ID, maybe 379 +the declaring plugin defines the transformation 380 +with the ID "abort2". 381 +))) 382 +|((( 383 +You get the following error: 384 + 385 +{{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}} 386 + 387 +\\ 388 + 389 +{{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}} 390 +)))|((( 391 +The trasformation with ID "TERMINATION" is already 392 + registered and this ID cannot be used a second time. 393 +The component "de.cau...sccharts" tries to register 394 +a transformation with this ID while this ID is already 395 +taken. 396 +)))|((( 397 +Rename one of the IDs or form a group of 398 + transformations. 399 +)))
- Confluence.Code.ConfluencePageClass[0]
-
- Id
-
... ... @@ -1,1 +1,1 @@ 1 - 94700681 +50823224 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/ 9470068/Kieler Compiler1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/50823224/Kieler Compiler