Skip to Content

Wiki source code of Kieler Compiler

Version 17.1 by cmot on 2014/03/17 14:48
Hide last authors
cmot 10.1 1 {{panel title="Project Overview" borderStyle="dashed"}}
2 Responsible:
3
cmot 11.1 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"]]
cmot 10.1 5
6 Related Theses:
7
8 * none yet
9 {{/panel}}
10
cmot 11.1 11 = Kieler Compiler (KiCo) =
12
cmot 1.1 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.
14
15
16
17 {{toc/}}
18
19 == General ==
20
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
cmot 16.1 23 |=(((
cmot 3.1 24 [[image:attach:KiCo.jpg]]
cmot 16.1 25 )))|=(((
26 [[image:attach:KiCo3.jpg]]
27 )))
cmot 1.1 28
cmot 16.1 29
30
31
32
33
34
cmot 1.1 35 == Extension Point ==
36
cmot 3.1 37 In order to add a transformation to KiCo you must follow these steps:
cmot 1.1 38
cmot 3.1 39 1. (((
40 Add dependency to
41
42 {{{de.cau.cs.kieler.kico}}}
43
44
45 )))
46 1. Add the extension
47
48
cmot 8.1 49 {{{de.cau.cs.kieler.kico.transformation}}}(((
50
51 )))
52 1. (((
cmot 9.1 53 Add one of the following extension element
cmot 3.1 54
55 [[image:attach:KiCo2.jpg]]
cmot 8.1 56 )))
cmot 3.1 57
58 |=(((
59 Extension Element
60 )))|=(((
61 Description
62 )))
63 |(((
64 transformationClass
65 )))|(((
66 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
67
68 * getId(): Returns a unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
69 * getName(): Optionally return a String name for this transformation. If null is returned here the ID will be used as a name.
70 * 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.
71 * transform(EObject): Returns an EObject and does the central transformation.
72 )))
73 |(((
74 transformationMethod
75 )))|(((
76 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:
77
78 * class: The class where the transform method is implemented in
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 * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
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.
83 )))
84 |(((
85 transformationGroup
86 )))|(((
87 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:
88
89 * 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!
cmot 15.1 90 * 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.
cmot 3.1 91 * name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
cmot 14.1 92 * 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.
cmot 3.1 93 )))
94
cmot 4.1 95 === Example ===
96
97 {{code title="plugin.xml"}}
98 <extension
99 point="de.cau.cs.kieler.kico.transformation">
100 <transformationGroup
101 id="NORMALIZE"
102 dependencies="TRIGGEREFFECT, SURFACEDEPTH"
103 name="Transform All Normalize">
104 </transformationGroup>
105 </extension>
106 <extension
107 point="de.cau.cs.kieler.kico.transformation">
108 <transformationMethod
109 class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
110 id="TRIGGEREFFECT"
111 method="transformTriggerEffect"
112 name="Transform Trigger and Effect">
113 </transformationMethod>
114 </extension>
115
116 <extension
117 point="de.cau.cs.kieler.kico.transformation">
118 <transformationMethod
119 class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
120 id="SURFACEDEPTH"
121 method="transformSurfaceDepth"
122 name="Transform Surface Depth">
123 </transformationMethod>
124 </extension>
125
126 <extension
127 point="de.cau.cs.kieler.kico.transformation">
128 <transformationGroup
129 id="ALL"
130 dependencies="CORE NORMALIZE"
131 name="Transform All">
132 </transformationGroup>
133 </extension>
134 {{/code}}
135
cmot 3.1 136
137
cmot 1.1 138 == Compilation ==
139
cmot 5.1 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
142 |=(((
143 Method
144 )))|=(((
145 Description
146 )))
147 |(((
cmot 6.1 148 \\
149
150 {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject)}}}
cmot 5.1 151 )))|(((
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 * eObject: The EObject that is the input to the compilation process.
154 * Returns: The EObject returned from the last model transformation called by KiCo.
155 )))
156 |(((
cmot 6.1 157 \\
158
159 {{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
cmot 5.1 160 )))|(((
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 )))
163 |(((
cmot 6.1 164
165 \\
166
167 {{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
cmot 5.1 168 )))|(((
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 )))
171
172 === Examples ===
173
174 {{code title="Java Code"}}
175 import de.cau.cs.kieler.kico.KielerCompiler;
176 ...
177 private MyEObjectClass myMethod(EObject eObject) {
178 ...
179 transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
180 ...
181 return transformed
182 }
183 {{/code}}
184
185 {{code title="Xtend Code"}}
186 import de.cau.cs.kieler.kico.KielerCompiler
187 ...
188 def dispatch MyEObjectClass myMethod(EObject eObject) {
189 transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
190 ...
191 transformed
192 }
193
194
195
196
197 {{/code}}
cmot 12.1 198
199 == Help / Problems / FAQs ==
200
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
203 |=(((
204 Symptom
205 )))|=(((
206 Reason
207 )))|=(((
208 Solution
209 )))
210 |(((
211 You get the following run time error:
212
213
214 \\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
215 [[java:136>>url:http://java:136||shape="rect"]]
216 [[java:164>>url:http://java:164||shape="rect"]]\\
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.)...}}}
219 )))|(((
220 There is a transformation with ID "ABORT2" referenced
221 either by the initial call to KielerCompiler.compile() or
222 by some of the dependent transformations /
223 transformation group.
224
225 But KiCo could not find any registered transformation
226 with ID "ABORT2".
227
228 Maybe the plugin declaring "ABORT2" was not loaded
229 or the ID is misspelled.
230
231
232 )))|(((
233 Check why "ABORT2" may not be found
234 by KiCo, more specifically, check if the
235 declaring can be loaded (sometimes
236 compiler error prevent it from being loaded
237 or it has unsatisfied dependencies).
238 Also check the spelling of the ID, maybe
239 the declaring plugin defines the transformation
240 with the ID "abort2".
241 )))
242 |(((
cmot 13.1 243 You get the following error:
244
245 {{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
246
247 \\
248
249 {{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}}
cmot 12.1 250 )))|(((
cmot 13.1 251 The trasformation with ID "TERMINATION" is already
252 registered and this ID cannot be used a second time.
253 The component "de.cau...sccharts" tries to register
254 a transformation with this ID while this ID is already
255 taken.
cmot 12.1 256 )))|(((
cmot 13.1 257 Rename one of the IDs or form a group of
258 transformations.
cmot 12.1 259 )))