Wiki source code of Kieler Compiler

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

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage