Changes for page SCCharts Development

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

From version < 37.1 >

edited by ssm
on 2016/04/22 16:59

To version < 14.1 >

edited by ssm
on 2016/04/21 17:01

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -1,7 +1,7 @@
  {{layout}}
  {{layout-section ac:type="single"}}
  {{layout-cell}}
--is is a light-weight tutorial for developing transformations/additions for SCCharts in KIELER. It will use Eclipse, EMF, and Xtend and therefore, finishing the corresponding tutorials could prove useful. However, they are not a strict requirement for this tutorial.
++This is a light-weight tutorial for developing additions for SCCharts in KIELER. It will use Eclipse, EMF, and Xtend and therefore, finishing the corresponding tutorials could prove useful. However, they are not a strict requirement for this tutorial.
@@ -13,7 +13,7 @@
  == Required Software ==
--As you're going to develop for KIELER SCCharts, we recommend to use the Oomph setup as described in [[doc:KIELER.Getting Eclipse]] (Oomph Setup). However, you could also install all componentes by yourself. Please consult the other tutorials if you want to do that. You would need to install the Modeling Tools and the Xtext SDK.
++As you're going to develop for KIELER SCCharts we recommend to use the semantic Oomph setup as described in [[doc:KIELER.Getting Eclipse]] (Oomph Setup). However, you could also install all componentes by yourself. Please consult the other tutorials if you want to do that. You would need to install the Modeling Tools and the Xtext SDK.
  {{/layout-cell}}
  {{/layout-section}}
@@ -96,48 +96,47 @@
  To see all class information check //Attributes/Literals// in the Diagram Options on the right.
--EcoreViz gives you an overview over the selected Ecore diagram. However, Ecore model definitions may depend on other Ecore definitions that are not displayed in the diagram. You can open new diagrams for these Ecore files as described before or use the Ecore tree editor to inspect all classes.
--
  Try to understand most parts of the metamodel. You don't have to understand every detail but you should get the idea.
  ==== Model Task ====
--{{task-list}}
--{{task id="1" status="incomplete"}}
--(% style="line-height: 1.42857;" %)Answer the following questions
++1. Answer the following questions
++11. Name the class of the root element of an SCChart
++11. How do you describe a superstate in the model?
++11. What is a valued object?
++11. How do you get the type of an interface variable?
++11. Outline the relationship between states, regions, transitions, and valued objects
++11. What other metamodels are needed for the SCCharts metamodel and write down which one is needed for what?
++1. Write down (on paper, text editor, etc) how the following SCChart models look like
++11. Open the wiki page that explains the [[doc:KIELER.Textual SCCharts Language SCT]].
++11. Search the //SCChart, Initial State, State, Transition and Immediate Transition //example and ...
++111. write down (on paper or text editor, etc) how the model of that SCChart looks like.
++111. The user now marks C as final. What has to be changed in the model? What semantic problem do you see?
++11. Now, navigate to the //Super State: Strong Abort Transition //example. Write down (on paper) how the model of that SCCharts looks like.
++11. And finally a more sophisticated model: Write down the model of ABO (from [[doc:KIELER.Examples]]).
--1. How do you describe a superstate in the model?
--1. Outline the relationship between states, regions, transitions, and valued objects.\\
--1. Name the class of the root element of an SCChart.
--1. What is a valued object?
--1. How do you get the type of an interface variable?
--1. What other metamodels are needed for the SCCharts metamodel and write down which one is needed for what?
--{{/task}}
--
--{{task id="2" status="incomplete"}}
--Write down (on paper, text editor, etc) how the following SCChart models look like
--
--1. Open the wiki page that explains the [[doc:KIELER.Textual SCCharts Language SCT]].
--1. Search the //SCChart, Initial State, State, Transition and Immediate Transition //example and ...
--11. write down (on paper or text editor, etc) how the model of that SCChart looks like.
--11. The user now marks C as final. What has to be changed in the model? What semantic problem do you see?
--1. Now, navigate to the //Super State: Strong Abort Transition //example. Write down (on paper) how the model of that SCCharts looks like.
--1. And finally a more sophisticated model: Write down the model of ABO (from [[doc:KIELER.Examples]]).
--{{/task}}
--{{/task-list}}
--
  {{info title="KLighD Screenshots"}}
--By the way: You can //right-click// on the Diagram View surface and select //Save as image...// to create a screenshot!
++By the way: You can //right-click// on the Diagram View surface to select //Save as image...// to create a screenshot!
  {{/info}}
  {{/layout-cell}}
  {{layout-cell}}
++
++
++
++
  [[image:attach:sccharts_metamodel.png]]
--[[image:attach:sccharts_metamodel_treeEditor.png]]
++
++
++
++
++
++
++
  [[image:attach:KLighDSaveAsImage.png]]
  {{/layout-cell}}
  {{/layout-section}}
@@ -144,6 +144,18 @@
  {{layout-section ac:type="single"}}
  {{layout-cell}}
++
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
++
++{{/layout-cell}}
++{{/layout-section}}
++
++{{layout-section ac:type="single"}}
++{{layout-cell}}
  = Creating SCCharts Models Programmatically  =
  == Creating a Test Project ==
@@ -150,7 +150,6 @@
  We need a project for testing. Do the following:
--1. If you used the standard KIELER Oomph installation setup, create a new Working Set named Tutorial in the Package Explorer. Then...
 . Create a new empty //Plug-In Project//.
 . Add the project that contains the sccharts metamodel as a dependency of your new project through the //Plugin Manifest Editor//.
 . Create a simple Java class that implements a main method. Hint: In a new Java class, simply type main and hit Ctrl+Space. Eclipse content assist will create the method for you.
@@ -157,12 +157,12 @@
  == Creating a Model ==
--To create a model programmatically you cannot directly use the Java classes generated for the model. Instead, the main package contains interfaces for all of your model object classes. The {{code language="none"}}impl{{/code}} package contains the actual implementation and the {{code language="none"}}util{{/code}} package contains some helper classes. Do not instantiate objects directly by manually calling {{code language="none"}}new{{/code}}. EMF generates a Factory to create new objects. The factory itself uses the singleton pattern to get access to it:
++To create a model programmatically you cannot directly use the Java classes generated for the model. Instead, the main package contains interfaces for all of your model object classes. The {{code language="none"}}impl{{/code}} package contains the actual implementation and the {{code language="none"}}util{{/code}} package contains some helper classes. Do not instantiate objects directly by manually calling {{code language="none"}}new{{/code}}. EMF generates a Factory to create new objects. The factory itself uses the singleton pattern to get access to it:
  {{code language="java"}}
  SCChartsFactory sccFactory = SCChartsFactory.eINSTANCE;
--State state = sccFactory.createState();
--Transition transition = sccFactory.createTransition();
++State state = sccFactory .createState();
++Transition transition = sccFactory .createTransition();
  {{/code}}
  Important: The SCCharts grammar is build on top of several other grammars. Therefore, not all language objects can be found in the SCCharts factory. For example, all expression elements are part of the KExpressions grammar and hence, have their own factory. If you need other factories, don't forget to add the corresponding plugin to your plugin dependency list.
@@ -169,13 +169,13 @@
  {{code language="java"}}
  KExpressionsFactory kFactory = KExpressionsFactory.eINSTANCE;
--BoolValue boolValue = kFactory.createBoolValue();
++BooleanValue boolValue = kFactory.createBooleanValue();
  {{/code}}
  For all simple attributes, there are getter and setter methods:
  {{code language="java"}}
--state.setId("Init");
++state.setId("Root");
  boolValue.setValue(true);
  {{/code}}
@@ -188,25 +188,15 @@
  List references (multiplicity of > 1) have only a list getter, which is used to manipulate the list:
  {{code language="java"}}
--state.getOutgoingTransitions().add(transition);
++state.outgoingTransitions.add(transition);
  {{/code}}
--{{info title="Plugin Dependencies"}}
--You may have noticed that is was not necessary to add a dependency for the kexpressions classes. The SCCharts plugin reexports the dependencies of the other EMF metamodels. Look at the plugin.xml in the SCCharts plugin in the dependency tab for more information.
--{{/info}}
--
  == Saving a Model ==
  EMF uses the [[Eclipse Resource concept>>url:http://help.eclipse.org/juno/topic/org.eclipse.platform.doc.isv/guide/resInt.htm?cp=2_0_10||rel="nofollow" shape="rect" class="external-link"]] to save models to files and load models from files. It can use different //Resource Factories// that determine how exactly models are serialized. We will use the [[XMIResourceFactoryImpl>>url:http://download.eclipse.org/modeling/emf/emf/javadoc/2.8.0/org/eclipse/emf/ecore/xmi/impl/XMIResourceFactoryImpl.html||rel="nofollow" shape="rect" class="external-link"]] to save our models to XML files:
++1. Add a dependency to the {{code language="none"}}org.eclipse.emf.ecore.xmi{{/code}} plug-in.
 . (((
--Add a dependency to the {{code language="none"}}com.google.inject, org.eclipse.core.resources, {{/code}}and{{code language="none"}} de.cau.cs.kieler.sccharts.text{{/code}} plug-ins.
--
--{{info title="Additional Dependencies"}}
--Don't worry. You will be experienced enough to add mandatory dependencies quickly in the future. However, for now just add the dependencies to proceed with the tutorial.
--{{/info}}
--)))
--1. (((
  Use something like the following code to save the model from above:
  {{code language="java"}}
@@ -213,10 +213,10 @@
  // Create a resource set.
  ResourceSet resourceSet = new ResourceSetImpl();
--// Register the resource factory -- only needed for stand-alone!
--SctStandaloneSetup.doSetup();
--
--
++// Register the default resource factory -- only needed for stand-alone!
++// this tells EMF to use XML to save the model
++resourceSet.getResourceFactoryRegistry().getExtensionToFactoryMap().put(
++    Resource.Factory.Registry.DEFAULT_EXTENSION, new SCTResourceFactoryImpl());
  // Get the URI of the model file.
  URI fileURI = URI.createFileURI(new File("myABO.sct").getAbsolutePath());
@@ -234,359 +234,260 @@
      /* error handling */
  }
  {{/code}}
--
--{{info title="File Extensions"}}
--File extensions are important! They define the parser/serializer that EMF uses. Always use the file extension that is defined for a particular model.
--{{/info}}
  )))
--{{/layout-cell}}
--{{/layout-section}}
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
  ==== Model Creation Task ====
--You are now equipped with the fundamentals you need to create models programmatically. Let's try it:
++With these information out of the way, on we go to some model creation:
--{{task-list}}
--{{task id="3" status="incomplete"}}
--(% style="line-height: 1.42857;" %)The code fragments listed above do not suffice to create a grammatically correct model. Try to generate a model that corresponds with the serialized model listed on the right side.
--
--1. (% style="line-height: 1.42857;" %)Run the {{code language="none"}}main(){{/code}} method by right-clicking its class and selecting //Run as// -> //Java Application//. Note that this runs your {{code language="none"}}main(){{/code}} method as a simple Java program, not a complete Eclipse application. EMF models can be used in any simple Java context, not just in Eclipse applications.
++1. Programmatically create a valid model of ABO in the {{code language="none"}}main(){{/code}} method.
++1. Run the {{code language="none"}}main(){{/code}} method by right-clicking its class and selecting //Run as// -> //Java Application//. Note that this runs your {{code language="none"}}main(){{/code}} method as a simple Java program, not a complete Eclipse application. EMF models can be used in any simple Java context, not just in Eclipse applications.
 . Execute the main method.
--1. (((
--(% style="line-height: 1.42857;" %)Inspect your SCT file. (Press F5 to refresh your file view.)
++1. Inspect your SCT file.
++1. Start your SCChart Editor Eclipse instance and load your SCT file. KLighD should now be able to visualize your ABO correctly.
--{{note title="Kext Warning"}}
--It is possible that kext generates a Null Pointer Exception when you save your model this way. This is a known issue. We're working on it. Just ignore it for now.
--{{/note}}
--)))
--{{/task}}
++= Transforming SCCharts =
--{{task id="4" status="incomplete"}}
--Now, create a new Java class and proceed as before to generate a model of ABO in the
++Transformations from one model to another may be performed within the same metamodel or from metamodel to a different metamodel. Both methods are used in KIELER and in principle they do not really differ in implementation. Nevertheless, if working within the same metamodel you should keep in mind that you're potentially changing the actual model instead of changing another instance (after copying). Both is possible. Just make sure that you know what you're doing.
--{{code language="none"}}
--main()
--{{/code}}
++Now, you're going to transform the normalized form of HandleA from ABO to an SCG. The Sequentially Constructive Graph is a control-flow graph which can be seen as another representation of the same program. The SCG of the normalized version of ABO's HandleA is depicted on the right.
-- method.
--{{/task}}
--
--{{task id="5" status="incomplete"}}
--(% style="line-height: 1.42857;" %)Start your SCChart Editor Eclipse instance and load your SCT file. KLighD should now be able to visualize your ABO correctly.(%%)\\
--
--1. For this, open tab //Run// and select// Run Configurations...//
--1. Create a new //Eclipse Application// and name it appropriately.
--1. As product select {{code language="none"}}de.cau.cs.kieler.core.product.product{{/code}}.
--1. Click //Run// (or //Debug// if you opened// Debug Configuration...//)
--1. Create a new project and add you generated model.
--{{/task}}
--{{/task-list}}
--
--
--{{/layout-cell}}
--
--{{layout-cell}}
--{{code language="java" title="Root.sct"}}
--scchart Root {
--  initial state Init
--  --> Init with true;
++|(((
++{{code}}
++scchart ABO_norm_HandleA {
++  input output bool A;
++  input output bool B;
++  output bool O1;
++  output bool O2;
++    region HandleA:
++    initial state WaitA
++    --> _S immediate with A
++    --> _Pause immediate;
++    final state DoneA;
++    state _S
++    --> _S2 immediate with / B = true;
++    state _S2
++    --> DoneA immediate with / O1 = true;
++    state _Pause
++    --> _Depth;
++    state _Depth
++    --> _S immediate with A
++    --> _Pause immediate;
  }
  {{/code}}
++)))|(((
++[[image:attach:abo_norm_HandleA.png]]
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++[[image:attach:abo_scg_HandleA.png]]
++)))
--[[image:attach:RunConfiguration.png]]
--{{/layout-cell}}
--{{/layout-section}}
++The next figure depicts the direct mapping from normalized SCCharts to their corresponding SCG.
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--= Model-to-Model Transformations with KiCo =
++[[image:attach:sccharts-scg.png]]
--You can use the [[Kieler Compiler>>url:http://rtsys.informatik.uni-kiel.de/confluence/display/KIELER/Kieler+Compiler||shape="rect"]] (KiCo) to handle all the model input/output tasks and concentrate on the actual transformation. If you executed the **Model Creation Task correctly**, you should now have a complete running SCT Editor instance that looks like the one on the right. You should see the //KIELER Compiler Selection// n the lower right part of the working space. Here you can select specific transformations that will be applied to the actual model. Simply select a transformation to test it.
++Inspect the metamodel of the SCGs in plugin de.cau.cs.kieler.scg. SCGs are used for analyses and optimization and include a lot of additional elements. However, for this tutorial it should be sufficient to look at the SCGraph class, its nodes attribute, the important node classes and the controlflow class. Important nodes for this SCG are entry, exit, assignment, conditional,
--== Creating a new Transformation ==
++==== Transformation Task ====
--Now, you're going to write your own transformation with **Xtend** *drumroll*, a programming language that looks very similar to Java, but which adds some very convenient features. Xtend code compiles to Java and and was developed using Xtext. In fact, once you gain experience working with Xtend you will probably appreciate the power of Xtext even more. Xtend is particularly useful to browse & modify EMF models. You get the point... we like it. :)
--{{/layout-cell}}
++Write a transformation that transforms your normalized version of ABO's HandleA into its corresponding SCG.
--{{layout-cell}}
--[[image:attach:KielerSCTEditor.png]]
--{{/layout-cell}}
--{{/layout-section}}
--
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--==== Transformation Creation Task ====
--
--{{task-list}}
--{{task id="6" status="incomplete"}}
--Create your first transformation...
--
--1. Create a new project within your tutorial working set as before.
--1. Add plugin dependencies to {{code language="none"}}de.cau.cs.kieler.kico{{/code}} and {{code language="none"}}de.cau.cs.kieler.sccharts{{/code}}.
--1. Create a new //Xtend class// in you package and name it "DoubleStates" and use {{code language="none"}}AbstractProductionTransformation{{/code}} as superclass.
--1. Here, you can automatically add the missing Xtend files by using the quickfix //Add Xtend lib to class path. //Alternatively you can simply add {{code language="none"}}com.google.guava{{/code}}, {{code language="none"}}org.eclipse.xtext.xbase.lib{{/code}}, {{code language="none"}}org.eclipse.xtend.lib{{/code}}, and {{code language="none"}}org.eclipse.xtend.lib.macro{{/code}} to you plugin dependencies.
--1. Click on //Add unimplemented methods//.
 . (((
--Now, you should have a class similar to the following one.
++**Writing a Model Transformation**
--{{code language="java"}}
--package tutorial.transformation
++This time we want you to integrate your transformation into your SCCharts Editor instance. Therefore,...
++(% style="color: rgb(51,51,51);line-height: 1.66667;" %)\\
--import de.cau.cs.kieler.kico.transformation.AbstractProductionTransformation
++1. Add a new package
--class DoubleStates extends AbstractProductionTransformation {
--
--    override getProducedFeatureId() {
--        throw new UnsupportedOperationException("TODO: auto-generated method stub")
--    }
--
--    override getId() {
--        throw new UnsupportedOperationException("TODO: auto-generated method stub")
--    }
--
--}
--{{/code}}
++{{code language="none"}}
++<project>.transformations
++{{/code}} to your project.
++1. Add an //Xtend Class// to the new package.
++1. If you notice that your new class is marked with an error marker because of a missing dependency of the new plug-in project to
--{{info title="Xtend Infos"}}
--* Lines in Xtend code don't have to and with a semicolon.
--* We have been explicit about the method's return type, but we could have easily omitted it, letting Xtend infer the return type.
--* The keyword {{code language="none"}}val{{/code}} declares a constant, while {{code language="none"}}var{{/code}} declares a variable. Try to make do with constants where possible.
--* The methods you call should be declared as {{code language="none"}}def private{{/code}} since they are implementation details and shouldn't be called by other classes.
--* You may be tempted to add a few global variables that hold things like a global input variable or a pointer to the current state. While you could to that, {{code language="none"}}def create {{/code}}methods might offer a better alternative...
--{{/info}}
--)))
--{{/task}}
++{{code language="none"}}
++org.eclipse.xtext.xbase.lib,
++{{/code}}you can hover over the error with your mouse and have Eclipse add all libraries required by Xtend to your project.
++1.
--{{task id="7" status="incomplete"}}
--As you can see, it is mandatory to add an id for the transformation and another id of the feature that this transformation produces. Name your transformation **tutorial.doubleStates **and the id of feature you want to produce is **sccharts.doubleStates**.
++Define an entry method for the transformation that takes an SCChart program instance as an argument and returns an SCG {{code language="none"}}Program{{/code}}. You can use the following (incomplete) method as a starting point:
--{{info title="Programming Guidelines"}}
--You should really think about some constants here. You can also look at the sccharts transformation and features constants in the sccharts plugin.
--{{/info}}
--{{/task}}
--{{/task-list}}
--{{/layout-cell}}
--
--{{layout-cell}}
++(((
++(% class="syntaxhighlighter sh-confluence nogutter  java" %)
++(((
--{{/layout-cell}}
--{{/layout-section}}
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--{{task-list}}
--{{task id="8" status="incomplete"}}
--KiCo must know about the new feature and also about your new transformation.
++|(((
++(% class="container" title="Hint: double-click to select code" %)
++(((
++(% class="line number1 index0 alt2" %)
++(((
++{{code language="none"}}
++/**
++{{/code}}
++)))
--1. Add a new Xtend class with Feature as superclass. Add all unimplemented methods. Also set** sccharts.doubleStates** as Id.
--1. Go to the Extension tab inside your plugin configuration.
--11. Add a new Extension Point de.cau.cs.kieler.kico.feature. Create a new  featureClass and point it to your new feature class.
--11. Also add a new Extension Point de.cau.cs.kieler.kico.transformation. Create a new productionTransformationClass and point it to your transformation class.
--11. Finally, you have to link your transformation to the SCT Editor. Add the Extension point de.cau.cs.kieler.kico.ui.transformation. Create an editor link and fill in the following values:
--111. editor: {{code language="none"}}de.cau.cs.kieler.sccharts.text.sct.Sct{{/code}}
--111. features: sccharts.doubleStates
--111. label: Tutorial Compilation
--111. priority: 101
--111. preferred: (leave it blank)
--1. {{note title="Plugin Tasks"}}In general it is bad to mix non-ui plugins/tasks with ui plugin/tasks because (in the context of KiCo) even if you're not working with an active UI your transformations should work (e.g. a command line compiler). To keep this tutorial simple, you can add this dependency to your plugin nevertheless. However, you shouldn't do this in real products. Always keep the UI separated.{{/note}}If you start your KIELER instance now, you should get a new compilation chain which has only one transformation: yours, which doesn't do anything.
--{{/task}}
++(% class="line number2 index1 alt1" %)
++(((
++{{code language="none"}}
++
++{{/code}}
--{{task id="9" status="incomplete"}}
--If you want to rename your feature in the Compiler Selection (without changing its Id), override the
++{{code language="none"}}
++* Transforms a given SCCharts program into an SCG.
++{{/code}}
++)))
++(% class="line number3 index2 alt2" %)
++(((
  {{code language="none"}}
--getName
++
  {{/code}}
-- method and return a new name. Rename your feature appropriately.
--{{/task}}
--{{/task-list}}
--{{/layout-cell}}
++{{code language="none"}}
++*
++{{/code}}
++)))
--{{layout-cell}}
--[[image:attach:KielerSCTEditorOwnTransformation.png]]
--{{/layout-cell}}
--{{/layout-section}}
++(% class="line number4 index3 alt1" %)
++(((
++{{code language="none"}}
++*/
++{{/code}}
++)))
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--{{task-list}}
--{{task id="10" status="incomplete"}}
--Now, fill your transformation with life:
++(% class="line number8 index7 alt1" %)
++(((
++{{code language="none"}}
++def SCGraph transform(State rootState) {
++{{/code}}
++)))
--1. Inside your transformation class, add a new method with the following signature: {{code language="none"}}def State transform(State rootState, KielerCompilerContext context){{/code}}. This transformation will be executed if the feature is selected in the Compiler Selection.
--1. (((
--Add thew following body to the function and try to understand the Xtend code. Import unknown class via code assist.
++(% class="line number9 index8 alt2" %)
++(((
++{{code language="none"}}
++
++{{/code}}
--{{code language="java" title="transform"}}
--    def State transform(State rootState, KielerCompilerContext context) {
--         val newState = SCChartsFactory.eINSTANCE.createState => [
--             id = "ololo"
--             label = "ololo"
--         ]
++{{code language="none"}}
++// Create the SCG
++{{/code}}
++)))
--         rootState.regions.filter(ControlflowRegion).head.states += newState
++(% class="line number10 index9 alt1" %)
++(((
++{{code language="none"}}
++
++{{/code}}
--         rootState
--    }
++{{code language="none"}}
++val scg = SCGraphFactory::eINSTANCE.createSCGraph()
  {{/code}}
  )))
--1. When selecting your transformation, the SCChart gets transformed and looks like the version on the right.
--{{/task}}
--{{task id="11" status="incomplete"}}
--Extend the transformation so that the transition is split up in two and connected via a transient state meaning that the original transformation should point to the new state and a new immediate transformation then points to the original target state. Try it out.
--{{/task}}
++(% class="line number11 index10 alt2" %)
++(((
++{{code language="none"}}
++
++{{/code}}
++)))
--{{task id="12" status="incomplete"}}
--Xtend supports extensions that can be used to extend the function set of you classes (i.e. models). Add {{code language="none"}}com.google.inject{{/code}} to the dependencies of your plugin. Now, add the following code fragment to the beginning of your class.
++(% class="line number12 index11 alt1" %)
++(((
++{{code language="none"}}
++
++{{/code}}
--{{code language="java" title="Code injection"}}
--    @Inject
--    extension SCChartsExtension
++{{code language="none"}}
++// TODO: Your transformation code
  {{/code}}
++)))
--There are several Extensions classes within the KIELER project that extend the functionality of various classes. Basically, there are one or more for each metamodel (e.g. SCCharts, SCG, KExpressions, etc). You don't want to invent the wheel again. Use these methods. For example: there is a method that gives you all contained states of a state in a list: {{code language="none"}}getAllContainedStatesList{{/code}}. You can use it on your {{code language="none"}}rootState{{/code}}: {{code language="none"}}rootState.allContainedStatesList{{/code}}. There are also several convenient methods for creating model elements so that you don't have to use the factories directly.
++(% class="line number13 index12 alt2" %)
++(((
++{{code language="none"}}
++
++{{/code}}
++)))
--{{note title="Extensions Naming Scheme"}}
--Extensions are also just classes. You can add your own to improve the structure of your own projects. In KIELER all extensions end with "Extensions"; except SCChartsExtension for legacy reasons. This will be renamed in after the next snapshot to SCChartsExtensions. So, if you're going to add new extensions to the project, please name them accordingly.
--{{/note}}
--{{/task}}
--{{/task-list}}
--{{/layout-cell}}
++(% class="line number14 index13 alt1" %)
++(((
++{{code language="none"}}
++
++{{/code}}
--{{layout-cell}}
--[[image:attach:KielerSCTEditorOwnTransformationOlolo.png]]
--{{/layout-cell}}
--{{/layout-section}}
++{{code language="none"}}
++// Return the transformed program
++{{/code}}
++)))
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--{{task-list}}
--{{task id="13" status="incomplete"}}
--Extend your transformation so that it is applied on all states (except the root state). Try your new transformation with ABO. The result should look like the example on the right.
--{{/task}}
--{{/task-list}}
++(% class="line number15 index14 alt2" %)
++(((
++{{code language="none"}}
++    scg
++{{/code}}
++)))
--== The existing Compilation Chain ==
++(% class="line number16 index15 alt1" %)
++(((
++{{code language="none"}}
++}
++{{/code}}
++)))
++)))
++)))
--Congratulations. You added and executed your own KiCo transformation. Nevertheless, often you want to extend the existing compilation chain. To do this, you proceed as before but instead of creating your own compilation chain, you must modify the existing chains (e.g. the netlist compilation in de.cau.cs.kieler.sccharts.ui). To add a specific transformation at a specific point in the chain, you must tell KiCo what features are required for the transformation. For that you must override the method getRequiredFeatureIds and return a set with all required features.
--
--Also, if you're developing for the master chain, you should obey the package structure. Look at the sccharts plugins. All features, transformation, extensions, the metamodel, ui elements, etc are separated from each other. You should always do the same!
--
--//We will add more content to this subsection in the future...//
--
--{{/layout-cell}}
++)))
++)))
--{{layout-cell}}
--[[image:attach:ABODoubleStates.png]]
--
--
--
--
--
--
--{{/layout-cell}}
--{{/layout-section}}
--
--{{layout-section ac:type="single"}}
--{{layout-cell}}
--= Model-to-Model Transformations between Metamodels =
--
--Transformations from one model to another may be performed within the same metamodel or from metamodel to a different metamodel. Both methods are used in KIELER and in principle they do not really differ in implementation. Nevertheless, if working within the same metamodel you should keep in mind that you're potentially changing the actual model instead of changing another instance (after copying). When transforming to another metamodel, you're always generating a new model. So there is no in-place transformation. Both is possible. Just make sure that you know what you're doing.
--
--Now, you're going to transform the normalized form of HandleA from ABO to an SCG. The Sequentially Constructive Graph is a control-flow graph which can be seen as another representation of the same program. The SCG of the normalized version of ABO's HandleA is depicted on the right.
--
--|(((
--{{code}}
--scchart ABO_norm_HandleA {
--  input output bool A;
--  input output bool B;
--  output bool O1;
--  output bool O2;
--    region HandleA:
--    initial state WaitA
--    --> _S immediate with A
--    --> _Pause immediate;
--    final state DoneA;
--    state _S
--    --> _S2 immediate with / B = true;
--    state _S2
--    --> DoneA immediate with / O1 = true;
--    state _Pause
--    --> _Depth;
--    state _Depth
--    --> _S immediate with A
--    --> _Pause immediate;
--}
--{{/code}}
--)))|(((
--[[image:attach:abo_norm_HandleA.png]]
--)))|(% colspan="1" %)(% colspan="1" %)
  (((
--[[image:attach:abo_scg_HandleA.png]]
++(% class="syntaxhighlighter nogutter  java" %)
++(((
++There's a few points to note here:
  )))
--{{/layout-cell}}
--{{/layout-section}}
++)))
--{{layout-section ac:type="two_equal"}}
--{{layout-cell}}
--The next figure depicts the direct mapping from normalized SCCharts to their corresponding SCG.
++\\
--Inspect the metamodel of the SCGs in plugin de.cau.cs.kieler.scg. SCGs are used for analyses and optimization and include a lot of additional elements. However, for this tutorial it should be sufficient to look at the SCGraph class, its nodes attribute, the important node classes and the controlflow class. Important nodes for this SCG are entry, exit, assignment, conditional,
--{{/layout-cell}}
++1.
++1*. Lines in Xtend code don't have to and with a semicolon.
++1*. We have been explicit about the method's return type, but we could have easily omitted it, letting Xtend infer the return type.
++1*. The keyword
--{{layout-cell}}
--[[image:attach:sccharts-scg.png]]
--{{/layout-cell}}
--{{/layout-section}}
++{{code language="none"}}
++val
++{{/code}} declares a constant, while
--{{layout-section ac:type="two_right_sidebar"}}
--{{layout-cell}}
--==== Transformation Creation Task 2 ====
++{{code language="none"}}
++var
++{{/code}} declares a variable. Try to make do with constants where possible.
++1*. The methods you call should be declared as
--Write a transformation that transforms your normalized version of ABO's HandleA into its corresponding SCG.
++{{code language="none"}}
++def private
++{{/code}} since they are implementation details and shouldn't be called by other classes.
++1*. You may be tempted to add a few global variables that hold things like a global input variable or a pointer to the current state. While you could to that,
--{{task-list}}
--{{task id="14" status="incomplete"}}
--Proceed as before. Create a new plugin (or copy your last one) Make sure, you also add de.cau.cs.kieler.scg to your dependencies.
--{{/task}}
--
--{{task id="15" status="incomplete"}}
--Write a transformation that is able to transform
--
  {{code language="none"}}
--ABO_norm_HandleA
--{{/code}}
++def create
++{{/code}}methods might offer a better alternative...
++\\
++1. Replace the TODO with an transformation code that takes an extended BF program and transforms it into an semantically equivalent BF program that only uses standard BF instructions.
++HINT: Some of the extended BF commands can only be expressed by standard operations if you can write to other cells. Therefore you are allowed to perform side effects on the tape.
++1. Open the //Plug-In Manifest Editor// and switch to the Runtime tab. Add the package containing your transformation to the list of exported packages. (You may have to check the //Show non-Java packages// option in the //Exported Packages// dialog to see the package.)
++\\
++)))
++1. **Verify your generated SCG**. If you added your transformation correctly, the SCG should be displayed automatically as soon as selected. If your SCG looks like the SCG depicted earlier, then everything is fine.
++1. Check your SCG semantically. Is there anything you could improve/optimize?
++11. Write a second transformation (just as before) and add it to the transformation chain right after the transformation you already added.
++11. Optimize the given SCG and compare the result with the previous one.
++11. Make sure that the two SCGs are still semantically identical.
-- into its corresponding SCG.
--{{/task}}
--
--{{task id="16" status="incomplete"}}
--**Verify your generated SCG**. If you added your transformation correctly, the SCG should be displayed automatically as soon as selected. If your SCG looks like the SCG depicted earlier, then everything is fine.
--{{/task}}
--
--{{task id="17" status="incomplete"}}
--Check your SCG semantically. Is there anything you could improve/optimize?
--
--1. Write a second transformation (just as before) and add it to the transformation chain right after the transformation you already added.
--1. Optimize the given SCG and compare the result with the previous one.
--1. Make sure that the two SCGs are still semantically identical.
--{{/task}}
--{{/task-list}}
--
--
--
  Congratulations! You finished the SCCharts Development Tutorial. Ask your supervisor for further instructions!
  {{/layout-cell}}
--
--{{layout-cell}}
--
--{{/layout-cell}}
  {{/layout-section}}
  {{/layout}}

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--16810391
++16810309

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/TUT/pages/16810391/SCCharts Development
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/TUT/pages/16810309/SCCharts Development

Changes for page SCCharts Development

Summary

Details

Navigation

Quick Links