Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 1.1
edited by cmot
on 2014/03/16 21:25
Change comment: There is no comment for this version
To version 3.1
edited by cmot
on 2014/03/16 21:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -10,12 +10,66 @@
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  
13 -[[image:attach:IMAG4642.jpg]]
13 +[[image:attach:KiCo.jpg]]
14 14  
15 15  == Extension Point ==
16 16  
17 -text
17 +In order to add a transformation to KiCo you must follow these steps:
18 18  
19 +1. (((
20 +Add dependency to
21 +
22 +{{{de.cau.cs.kieler.kico}}}
23 +
24 +
25 +)))
26 +1. Add the extension
27 +
28 +
29 +{{{de.cau.cs.kieler.kico.transformation}}}
30 +
31 +Add one of the following
32 +
33 +[[image:attach:KiCo2.jpg]]
34 +
35 +|=(((
36 +Extension Element
37 +)))|=(((
38 +Description
39 +)))
40 +|(((
41 +transformationClass
42 +)))|(((
43 +The defined class must extend "de.cau.cs.kieler.kico.Transformation" and must implement the methods defined in "de.cau.cs.kieler.kico.ITransformation". These are
44 +
45 +* getId(): Returns a unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
46 +* getName(): Optionally return a String name for this transformation. If null is returned here the ID will be used as a name.
47 +* getDependencies(): Optionally return a List<String> of other transformation IDs that must run BEFORE this transformation. If null is returned then this means there are no dependencies.
48 +* transform(EObject): Returns an EObject and does the central transformation.
49 +)))
50 +|(((
51 +transformationMethod
52 +)))|(((
53 +The defined class can be freely chosen and does not need to extend or implement any other class or interface. Although you have to give more information in the extension element now:
54 +
55 +* class: The class where the transform method is implemented in
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 +* id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
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.
60 +)))
61 +|(((
62 +transformationGroup
63 +)))|(((
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 +
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 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.
68 +* name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
69 +)))
70 +
71 +
72 +
19 19  == Compilation ==
20 20  
21 21  text
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470059
1 +9470061
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470059/Kieler Compiler (KiCo)
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470061/Kieler Compiler (KiCo)