Skip to Content

Wiki source code of Kieler Compiler

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