Skip to Content

Changes for page Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52
From version 18.1
edited by cmot
on 2014/03/17 14:48
Change comment: There is no comment for this version
To version 41.1
edited by Richard Kreissig
on 2023/09/14 10:52
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +KIELER.SCCharts (DeprecatedHistorical Documentation & Features).WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cmot
1 +XWiki.stu230980
Content
... ... @@ -1,4 +1,8 @@
1 -{{panel title="Project Overview" borderStyle="dashed"}}
1 +Deprecated since 0.13
2 +This article is deprecated. The described features are no longer available in current releases.
3 +
4 +== Project Overview ==
5 +
2 2  Responsible:
3 3  
4 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"]]
... ... @@ -6,11 +6,12 @@
6 6  Related Theses:
7 7  
8 8  * none yet
9 -{{/panel}}
10 10  
14 +**To see the KielerCompiler in action, we provide an Online SCCharts Compiler [[here>>doc:KIELER.SCCharts (DeprecatedHistorical Documentation & Features).SCCharts (pre 1\.0).Online Compiler.WebHome]].**
15 +
11 11  = Kieler Compiler (KiCo) =
12 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.
18 +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"]].**
14 14  
15 15  
16 16  
... ... @@ -20,11 +20,18 @@
20 20  
21 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 22  
28 +(% class="wrapped" %)
23 23  |=(((
24 -[[image:attach:KiCo.jpg]]
30 +(% class="content-wrapper" %)
31 +(((
32 +[[image:attach:IMAG4642.jpg]]
33 +)))
25 25  )))|=(((
26 -[[image:attach:KiCo3.jpg]]
35 +(% class="content-wrapper" %)
36 +(((
37 +[[image:attach:KiCo.jpg]]
27 27  )))
39 +)))
28 28  
29 29  == Extension Point ==
30 30  
... ... @@ -39,10 +39,12 @@
39 39  )))
40 40  1. Add the extension
41 41  
54 +{{{de.cau.cs.kieler.kico.transformation}}}
42 42  
43 -{{{de.cau.cs.kieler.kico.transformation}}}(((
56 +(((
44 44  
45 45  )))
59 +
46 46  1. (((
47 47  Add one of the following extension element
48 48  
... ... @@ -49,6 +49,7 @@
49 49  [[image:attach:KiCo2.jpg]]
50 50  )))
51 51  
66 +(% class="wrapped" %)
52 52  |=(((
53 53  Extension Element
54 54  )))|=(((
... ... @@ -73,7 +73,7 @@
73 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 74  * id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
75 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 BEFORE this transformation. If nothing is entered here then this means there are no dependencies.
91 +* 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 77  )))
78 78  |(((
79 79  transformationGroup
... ... @@ -96,9 +96,7 @@
96 96   dependencies="TRIGGEREFFECT, SURFACEDEPTH"
97 97   name="Transform All Normalize">
98 98   </transformationGroup>
99 - </extension>
100 - <extension
101 - point="de.cau.cs.kieler.kico.transformation">
114 +
102 102   <transformationMethod
103 103   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
104 104   id="TRIGGEREFFECT"
... ... @@ -105,10 +105,7 @@
105 105   method="transformTriggerEffect"
106 106   name="Transform Trigger and Effect">
107 107   </transformationMethod>
108 - </extension>
109 -
110 - <extension
111 - point="de.cau.cs.kieler.kico.transformation">
121 +
112 112   <transformationMethod
113 113   class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
114 114   id="SURFACEDEPTH"
... ... @@ -115,10 +115,7 @@
115 115   method="transformSurfaceDepth"
116 116   name="Transform Surface Depth">
117 117   </transformationMethod>
118 - </extension>
119 -
120 - <extension
121 - point="de.cau.cs.kieler.kico.transformation">
128 +
122 122   <transformationGroup
123 123   id="ALL"
124 124   dependencies="CORE NORMALIZE"
... ... @@ -127,12 +127,12 @@
127 127   </extension>
128 128  {{/code}}
129 129  
130 -
131 131  
132 132  == Compilation ==
133 133  
134 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 135  
142 +(% class="wrapped" %)
136 136  |=(((
137 137  Method
138 138  )))|=(((
... ... @@ -139,9 +139,9 @@
139 139  Description
140 140  )))
141 141  |(((
142 -\\
149 +
143 143  
144 -{{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject)}}}
151 +{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject)}}}
145 145  )))|(((
146 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 147  * eObject: The EObject that is the input to the compilation process.
... ... @@ -148,7 +148,7 @@
148 148  * Returns: The EObject returned from the last model transformation called by KiCo.
149 149  )))
150 150  |(((
151 -\\
158 +
152 152  
153 153  {{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
154 154  )))|(((
... ... @@ -155,10 +155,9 @@
155 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 156  )))
157 157  |(((
165 +
158 158  
159 -\\
160 -
161 -{{{EObject KielerCompiler.compile(List&#x3c;String&#x3e; transformationIDs, EObject eObject, boolean autoexpand)}}}
167 +{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject, boolean autoexpand)}}}
162 162  )))|(((
163 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 164  )))
... ... @@ -169,10 +169,10 @@
169 169  import de.cau.cs.kieler.kico.KielerCompiler;
170 170  ...
171 171  private MyEObjectClass myMethod(EObject eObject) {
172 - ...
173 - transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
174 - ...
175 - return transformed
178 + ...
179 + transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
180 + ...
181 + return transformed
176 176  }
177 177  {{/code}}
178 178  
... ... @@ -179,10 +179,10 @@
179 179  {{code title="Xtend Code"}}
180 180  import de.cau.cs.kieler.kico.KielerCompiler
181 181  ...
182 -def dispatch MyEObjectClass myMethod(EObject eObject) {
183 - transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
184 - ...
185 - transformed
188 +def dispatch MyEObjectClass myMethod(EObject eObject) {
189 + transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
190 + ...
191 + transformed
186 186  }
187 187  
188 188  
... ... @@ -190,10 +190,149 @@
190 190  
191 191  {{/code}}
192 192  
199 +=== Requirement Completion ===
200 +
201 +
202 +(% class="wrapped" %)
203 +|=(((
204 +(% class="content-wrapper" %)
205 +(((
206 +(% style="text-align: center;" %)
207 +Original
208 +
209 +(% class="wrapped" %)
210 +|=(((
211 +(% class="content-wrapper" %)
212 +(((
213 + [[image:attach:dependencies2.jpg]]
214 +
215 +(% style="text-align: center;" %)
216 +Original Dependency
217 +Graph
218 +)))
219 +)))|=(((
220 +(% class="content-wrapper" %)
221 +(((
222 +(% style="text-align:center" %)
223 +[[image:attach:dependencies3.jpg]]
224 +
225 +(% style="text-align: center;" %)
226 +Two alternative
227 +transformation
228 +implementations
229 +for Abort
230 +)))
231 +)))
232 +
233 +
234 +)))
235 +)))|=(% scope="row" %)(((
236 +(% class="content-wrapper" %)
237 +(((
238 +(% style="text-align: center;" %)
239 +Example 1
240 +
241 +(% class="wrapped" %)
242 +|=(((
243 +(% class="content-wrapper" %)
244 +(((
245 + [[image:attach:dependencies4.jpg]]
246 +
247 +(% style="text-align: center;" %)
248 +Selected for
249 +transformation
250 +)))
251 +)))|=(((
252 +(% class="content-wrapper" %)
253 +(((
254 + [[image:attach:dependencies4b.jpg]]
255 +
256 +(% style="text-align: center;" %)
257 +Auto selected
258 +requirements
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 +)))|=(% scope="row" %)(((
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 +
193 193  == Help / Problems / FAQs ==
194 194  
195 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 196  
341 +(% class="wrapped" %)
197 197  |=(((
198 198  Symptom
199 199  )))|=(((
... ... @@ -205,11 +205,18 @@
205 205  You get the following run time error:
206 206  
207 207  
208 -\\\\\\\\\\\\\\\\[[java:102>>url:http://java:102||shape="rect"]]
353 +
354 +
355 +
356 +
357 +
358 +
359 +
360 +\\[[java:102>>url:http://java:102||shape="rect"]]
209 209  [[java:136>>url:http://java:136||shape="rect"]]
210 -[[java:164>>url:http://java:164||shape="rect"]]\\
362 +[[java:164>>url:http://java:164||shape="rect"]]
211 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.)...}}}
364 +{{{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 213  )))|(((
214 214  There is a transformation with ID "ABORT2" referenced
215 215  either by the initial call to KielerCompiler.compile() or
... ... @@ -226,7 +226,7 @@
226 226  )))|(((
227 227  Check why "ABORT2" may not be found
228 228  by KiCo, more specifically, check if the
229 -declaring can be loaded (sometimes
381 +declaring can be loaded (sometimes
230 230  compiler error prevent it from being loaded
231 231  or it has unsatisfied dependencies).
232 232  Also check the spelling of the ID, maybe
... ... @@ -238,7 +238,6 @@
238 238  
239 239  {{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
240 240  
241 -\\
242 242  
243 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 244  )))|(((
IMAG4642.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +1.5 MB
Content
KiCo.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +138.2 KB
Content
KiCo2.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +5.0 KB
Content
KiCo3.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +166.2 KB
Content
dependencies2.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +170.9 KB
Content
dependencies2.pdf
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +18.5 KB
Content
dependencies3.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +242.8 KB
Content
dependencies4.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +252.6 KB
Content
dependencies4b.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +260.5 KB
Content
dependencies5.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +249.6 KB
Content
dependencies5b.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +281.7 KB
Content
dependencies6.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +258.3 KB
Content
dependencies6b.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +283.2 KB
Content
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -9470109
1 +9470057
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470109/Kieler Compiler
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/9470057/Kieler Compiler