Wiki source code of Kieler Compiler

Last modified by Richard Kreissig on 2023/09/14 10:52

version	line-number	content
41.1	1	Deprecated since 0.13
29.1	2	This article is deprecated. The described features are no longer available in current releases.
	3
41.1	4	== Project Overview ==
	5
10.1	6	Responsible:
	7
11.1	8	* [[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"]]
10.1	9
	10	Related Theses:
	11
	12	* none yet
26.1	13
40.1	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]].
10.1	15
11.1	16	= Kieler Compiler (KiCo) =
	17
28.1	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"]].
1.1	19
	20
	21
	22	{{toc/}}
	23
	24	== General ==
	25
	26	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.
	27
28.1	28	(% class="wrapped" %)
16.1	29	\|=(((
28.1	30	(% class="content-wrapper" %)
	31	(((
25.1	32	[[image:attach:IMAG4642.jpg]]
28.1	33	)))
16.1	34	)))\|=(((
28.1	35	(% class="content-wrapper" %)
	36	(((
24.1	37	[[image:attach:KiCo.jpg]]
16.1	38	)))
28.1	39	)))
1.1	40
	41	== Extension Point ==
	42
3.1	43	In order to add a transformation to KiCo you must follow these steps:
1.1	44
3.1	45	1. (((
	46	Add dependency to
	47
	48	{{{de.cau.cs.kieler.kico}}}
	49
41.1	50
3.1	51	)))
	52	1. Add the extension
	53
31.3	54	{{{de.cau.cs.kieler.kico.transformation}}}
3.1	55
31.3	56	(((
41.1	57
8.1	58	)))
31.3	59
8.1	60	1. (((
9.1	61	Add one of the following extension element
3.1	62
	63	[[image:attach:KiCo2.jpg]]
8.1	64	)))
3.1	65
28.1	66	(% class="wrapped" %)
3.1	67	\|=(((
	68	Extension Element
	69	)))\|=(((
	70	Description
	71	)))
	72	\|(((
	73	transformationClass
	74	)))\|(((
	75	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
	76
	77	* getId(): Returns a unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
	78	* getName(): Optionally return a String name for this transformation. If null is returned here the ID will be used as a name.
	79	* 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.
	80	* transform(EObject): Returns an EObject and does the central transformation.
	81	)))
	82	\|(((
	83	transformationMethod
	84	)))\|(((
	85	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:
	86
	87	* class: The class where the transform method is implemented in
	88	* 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.
	89	* id: The unique String ID for this transformation. This is the ID the transformation will be referenced throughout KiCo.
	90	* name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
19.1	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.
3.1	92	)))
	93	\|(((
	94	transformationGroup
	95	)))\|(((
	96	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:
	97
	98	* 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!
15.1	99	* 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.
3.1	100	* name: An optional String name for this transformation. If nothing is entered here the ID will be used as a name.
14.1	101	* 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.
3.1	102	)))
	103
4.1	104	=== Example ===
	105
	106	{{code title="plugin.xml"}}
	107	<extension
	108	point="de.cau.cs.kieler.kico.transformation">
	109	<transformationGroup
	110	id="NORMALIZE"
	111	dependencies="TRIGGEREFFECT, SURFACEDEPTH"
	112	name="Transform All Normalize">
	113	</transformationGroup>
20.1	114
4.1	115	<transformationMethod
	116	class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
	117	id="TRIGGEREFFECT"
	118	method="transformTriggerEffect"
	119	name="Transform Trigger and Effect">
	120	</transformationMethod>
20.1	121
4.1	122	<transformationMethod
	123	class="de.cau.cs.kieler.sccharts.extensions.SCChartsCoreTransformation"
	124	id="SURFACEDEPTH"
	125	method="transformSurfaceDepth"
	126	name="Transform Surface Depth">
	127	</transformationMethod>
20.1	128
4.1	129	<transformationGroup
	130	id="ALL"
	131	dependencies="CORE NORMALIZE"
	132	name="Transform All">
	133	</transformationGroup>
	134	</extension>
	135	{{/code}}
	136
3.1	137
1.1	138	== Compilation ==
	139
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
28.1	142	(% class="wrapped" %)
5.1	143	\|=(((
	144	Method
	145	)))\|=(((
	146	Description
	147	)))
	148	\|(((
41.1	149
6.1	150
41.1	151	{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject)}}}
5.1	152	)))\|(((
	153	* 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.
	154	* eObject: The EObject that is the input to the compilation process.
	155	* Returns: The EObject returned from the last model transformation called by KiCo.
	156	)))
	157	\|(((
41.1	158
6.1	159
	160	{{{EObject KielerCompiler.compile(String transformationIDs, EObject eObject)}}}
5.1	161	)))\|(((
	162	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.
	163	)))
	164	\|(((
41.1	165
6.1	166
41.1	167	{{{EObject KielerCompiler.compile(List<String> transformationIDs, EObject eObject, boolean autoexpand)}}}
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) {
41.1	178	...
	179	transformed = (MyEObjectClass) KielerCompiler.compile("ABORT, SIGNAL", eObject);
	180	...
	181	return transformed
5.1	182	}
	183	{{/code}}
	184
	185	{{code title="Xtend Code"}}
	186	import de.cau.cs.kieler.kico.KielerCompiler
	187	...
41.1	188	def dispatch MyEObjectClass myMethod(EObject eObject) {
	189	transformed = KielerCompiler.compile("ABORT, SIGNAL", eObject) as MyEObjectClass
	190	...
	191	transformed
5.1	192	}
	193
	194
	195
	196
	197	{{/code}}
12.1	198
20.1	199	=== Requirement Completion ===
	200
	201
28.1	202	(% class="wrapped" %)
20.1	203	\|=(((
28.1	204	(% class="content-wrapper" %)
	205	(((
20.1	206	(% style="text-align: center;" %)
	207	Original
	208
28.1	209	(% class="wrapped" %)
20.1	210	\|=(((
28.1	211	(% class="content-wrapper" %)
	212	(((
20.1	213	[[image:attach:dependencies2.jpg]]
21.1	214
	215	(% style="text-align: center;" %)
	216	Original Dependency
	217	Graph
28.1	218	)))
20.1	219	)))\|=(((
28.1	220	(% class="content-wrapper" %)
	221	(((
41.1	222	(% style="text-align:center" %)
21.1	223	[[image:attach:dependencies3.jpg]]
	224
	225	(% style="text-align: center;" %)
	226	Two alternative
	227	transformation
	228	implementations
	229	for Abort
20.1	230	)))
28.1	231	)))
20.1	232
41.1	233
28.1	234	)))
41.1	235	)))\|=(% scope="row" %)(((
28.1	236	(% class="content-wrapper" %)
	237	(((
20.1	238	(% style="text-align: center;" %)
	239	Example 1
	240
28.1	241	(% class="wrapped" %)
20.1	242	\|=(((
28.1	243	(% class="content-wrapper" %)
	244	(((
20.1	245	[[image:attach:dependencies4.jpg]]
21.1	246
	247	(% style="text-align: center;" %)
	248	Selected for
	249	transformation
28.1	250	)))
20.1	251	)))\|=(((
28.1	252	(% class="content-wrapper" %)
	253	(((
20.1	254	[[image:attach:dependencies4b.jpg]]
21.1	255
	256	(% style="text-align: center;" %)
	257	Auto selected
	258	requirements
20.1	259	)))
28.1	260	)))
20.1	261
41.1	262
20.1	263	)))
28.1	264	)))
20.1	265
	266
	267
28.1	268	(% class="wrapped" %)
20.1	269	\|=(((
28.1	270	(% class="content-wrapper" %)
	271	(((
23.1	272	(% style="text-align: center;" %)
20.1	273	Example 2
	274
28.1	275	(% class="wrapped" %)
20.1	276	\|=(((
28.1	277	(% class="content-wrapper" %)
	278	(((
20.1	279	[[image:attach:dependencies5.jpg]]
21.1	280
	281	(% style="text-align: center;" %)
	282	Selected for
	283	transformation
28.1	284	)))
21.1	285	)))\|=(% style="text-align: center;" %)(% style="text-align: center;" %)
	286	(((
28.1	287	(% class="content-wrapper" %)
	288	(((
20.1	289	[[image:attach:dependencies5b.jpg]]
22.1	290
	291	Auto selected
21.1	292	requirements
	293	using DEFAULT
41.1	294	of alternative
21.1	295	group
22.1	296
41.1	297
20.1	298	)))
28.1	299	)))
20.1	300
41.1	301
28.1	302	)))
41.1	303	)))\|=(% scope="row" %)(((
28.1	304	(% class="content-wrapper" %)
	305	(((
20.1	306	(% style="text-align: center;" %)
	307	Example 3
	308
28.1	309	(% class="wrapped" %)
20.1	310	\|=(((
28.1	311	(% class="content-wrapper" %)
	312	(((
20.1	313	[[image:attach:dependencies6.jpg]]
21.1	314
	315	(% style="text-align: center;" %)
	316	Selected for
	317	transformation
28.1	318	)))
20.1	319	)))\|=(((
28.1	320	(% class="content-wrapper" %)
	321	(((
20.1	322	[[image:attach:dependencies6b.jpg]]
21.1	323
	324	(% style="text-align: center;" %)
	325	Auto selected
	326	requirements
	327	using selected
	328	alternative
20.1	329	)))
28.1	330	)))
20.1	331
41.1	332
20.1	333	)))
28.1	334	)))
20.1	335
	336
12.1	337	== Help / Problems / FAQs ==
	338
	339	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).
	340
28.1	341	(% class="wrapped" %)
12.1	342	\|=(((
	343	Symptom
	344	)))\|=(((
	345	Reason
	346	)))\|=(((
	347	Solution
	348	)))
	349	\|(((
	350	You get the following run time error:
	351
	352
31.3	353
32.1	354
34.1	355
36.1	356
38.1	357
40.1	358
41.1	359
	360	\\[[java:102>>url:http://java:102\|\|shape="rect"]]
12.1	361	[[java:136>>url:http://java:136\|\|shape="rect"]]
41.1	362	[[java:164>>url:http://java:164\|\|shape="rect"]]
12.1	363
41.1	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.)...}}}
12.1	365	)))\|(((
	366	There is a transformation with ID "ABORT2" referenced
	367	either by the initial call to KielerCompiler.compile() or
	368	by some of the dependent transformations /
	369	transformation group.
	370
	371	But KiCo could not find any registered transformation
	372	with ID "ABORT2".
	373
	374	Maybe the plugin declaring "ABORT2" was not loaded
	375	or the ID is misspelled.
	376
41.1	377
12.1	378	)))\|(((
	379	Check why "ABORT2" may not be found
	380	by KiCo, more specifically, check if the
41.1	381	declaring can be loaded (sometimes
12.1	382	compiler error prevent it from being loaded
	383	or it has unsatisfied dependencies).
	384	Also check the spelling of the ID, maybe
	385	the declaring plugin defines the transformation
	386	with the ID "abort2".
	387	)))
	388	\|(((
13.1	389	You get the following error:
	390
	391	{{{!ENTRY de.cau.cs.kieler.kico 2 2 2014-03-17 11:26:13.818}}}
	392
	393
	394	{{{!MESSAGE Extension 'TERMINATION' from component: de.cau.cs.kieler.sccharts cannot beloaded becaus this ID is already taken. (de.cau.cs.kieler.kico)}}}
12.1	395	)))\|(((
13.1	396	The trasformation with ID "TERMINATION" is already
	397	registered and this ID cannot be used a second time.
	398	The component "de.cau...sccharts" tries to register
	399	a transformation with this ID while this ID is already
	400	taken.
12.1	401	)))\|(((
13.1	402	Rename one of the IDs or form a group of
	403	transformations.
12.1	404	)))

Wiki source code of Kieler Compiler

Navigation

Quick Links