Changes for page SCCharts Development

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

From version < 19.1 >

edited by ssm
on 2016/04/21 19:55

To version < 22.1 >

edited by ssm
on 2016/04/22 15:39

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

@@ -225,6 +225,10 @@
      /* 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}}
@@ -238,9 +238,20 @@
 . 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.
 . Run the {{code language="none"}}main(){{/code}} method by right-clicking its class and selecting (% style="line-height: 1.42857;" %)//Run as//(%%) -> (% style="line-height: 1.42857;" %)//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.
--11. Inspect your SCT file. (Press F5 to refresh your file view.)
++11. (((
++Inspect your SCT file. (Press F5 to refresh your file view.)
++
++{{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}}
++)))
 . Now, create a new Java class and proceed as before to generate a model of ABO in the {{code language="none"}}main(){{/code}} method.
 . Start your SCChart Editor Eclipse instance and load your SCT file. KLighD should now be able to visualize your ABO correctly.
++11. For this, open tab //Run// and select// Run Configurations...//
++11. Create a new //Eclipse Application// and name it appropriately.
++11. As product select {{code language="none"}}de.cau.cs.kieler.core.product.product{{/code}}.
++11. Click //Run// (or //Debug// if you opened// Debug Configuration...//)
++11. Create a new project and add you generated model.
  {{/layout-cell}}
@@ -252,254 +252,255 @@
    --> Init with true;
  }
  {{/code}}
++
++[[image:attach:RunConfiguration.png]]
  {{/layout-cell}}
  {{/layout-section}}
  {{layout-section ac:type="two_right_sidebar"}}
  {{layout-cell}}
--
--{{/layout-cell}}
++= Model-to-Model Transformations with KiCo =
--{{layout-cell}}
++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.
++
++== Creating a new Transformation ==
++
++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}}
--{{/layout-section}}
--{{layout-section ac:type="single"}}
--{{layout-cell}}
--= Transforming SCCharts =
++==== Transformation Creation Task ====
--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.
++1. Therefore, 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//.
++1. (((
++Now, you should have a class similar to the following one.
--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 language="java"}}
++package tutorial.transformation
--|(((
--{{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;
++import de.cau.cs.kieler.kico.transformation.AbstractProductionTransformation
++
++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}}
--)))|(((
--[[image:attach:abo_norm_HandleA.png]]
--)))|(% colspan="1" %)(% colspan="1" %)
--(((
--[[image:attach:abo_scg_HandleA.png]]
++
++{{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}}
  )))
++1. (((
++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**.
--The next figure depicts the direct mapping from normalized SCCharts to their corresponding SCG.
++{{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}}
++)))
++1. KiCo must know about the new feature and also about your new transformation.
++11. Add a new Xtend class with Feature as superclass. Add all unimplemented methods. Also set** sccharts.doubleStates** as Id.
++11. Go to the Extension tab inside your plugin configuration.
++111. Add a new Extension Point de.cau.cs.kieler.kico.feature. Create a new  featureClass and point it to your new feature class.
++111. Also add a new Extension Point de.cau.cs.kieler.kico.transformation. Create a new productionTransformationClass and point it to your transformation class.
++111. 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:
++1111. editor: de.cau.cs.kieler.sccharts.text.sct.Sct
++1111. features: sccharts.doubleStates
++1111. label: Tutorial Compilation
++1111. priority: 101
++1111. preferred: (leave it blank)
++11. {{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.
++1. If you want to rename your feature in the Compiler Selection (without changing its Id), override the getName method and return a new name. Rename your feature appropriately.
++1. Now, fill your transformation with life:
++11. Inside your transformation class, add a new method with the following signature: def State transform(State rootState, KielerCompilerContext context). This transformation will be executed if the feature is selected in the Compiler Selection.
++11. (((
++Add thew following body to the function and try to understand the Xtend code. Import unknown class via code assist.
--[[image:attach:sccharts-scg.png]]
++{{code language="java" title="transform"}}
++    def State transform(State rootState, KielerCompilerContext context) {
++         val newState = SCChartsFactory.eINSTANCE.createState => [
++             id = "ololo"
++             label = "ololo"
++         ]
--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,
++         rootState.regions.filter(ControlflowRegion).head.states += newState
--==== Transformation Task ====
++         rootState
++    }
++{{/code}}
++)))
++11. When selecting your transformation, the SCChart gets transformed and looks like the version on the right.
++1. 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.
++1. (((
++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.
--Write a transformation that transforms your normalized version of ABO's HandleA into its corresponding SCG.
++{{code language="java" title="Code injection"}}
++    @Inject
++    extension SCChartsExtension
++{{/code}}
--1. (((
--**Writing a Model Transformation**
++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}}.
--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;" %)\\
++{{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}}
++)))
++1. 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.
--1. Add a new package
++== The existing Compilation Chain ==
--{{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
++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.
--{{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.
++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!
--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:
++//We will add more content to this subsection in the future...//
--(((
--(% class="syntaxhighlighter sh-confluence nogutter  java" %)
--(((
++{{/layout-cell}}
--|(((
--(% class="container" title="Hint: double-click to select code" %)
--(((
--(% class="line number1 index0 alt2" %)
--(((
--{{code language="none"}}
--/**
--{{/code}}
--)))
++{{layout-cell}}
++[[image:attach:KielerSCTEditor.png]]
--(% class="line number2 index1 alt1" %)
--(((
--{{code language="none"}}
--
--{{/code}}
++
--{{code language="none"}}
--* Transforms a given SCCharts program into an SCG.
--{{/code}}
--)))
++
--(% class="line number3 index2 alt2" %)
--(((
--{{code language="none"}}
--
--{{/code}}
++
--{{code language="none"}}
--*
--{{/code}}
--)))
++
--(% class="line number4 index3 alt1" %)
--(((
--{{code language="none"}}
--*/
--{{/code}}
--)))
++
--(% class="line number8 index7 alt1" %)
--(((
--{{code language="none"}}
--def SCGraph transform(State rootState) {
--{{/code}}
--)))
++
--(% class="line number9 index8 alt2" %)
--(((
--{{code language="none"}}
--
--{{/code}}
++
--{{code language="none"}}
--// Create the SCG
--{{/code}}
--)))
++
--(% class="line number10 index9 alt1" %)
--(((
--{{code language="none"}}
--
--{{/code}}
++
--{{code language="none"}}
--val scg = SCGraphFactory::eINSTANCE.createSCGraph()
--{{/code}}
--)))
++
--(% class="line number11 index10 alt2" %)
--(((
--{{code language="none"}}
--
--{{/code}}
--)))
++
--(% class="line number12 index11 alt1" %)
--(((
--{{code language="none"}}
--
--{{/code}}
++
--{{code language="none"}}
--// TODO: Your transformation code
--{{/code}}
--)))
++
--(% class="line number13 index12 alt2" %)
--(((
--{{code language="none"}}
--
--{{/code}}
--)))
++
--(% class="line number14 index13 alt1" %)
--(((
--{{code language="none"}}
--
--{{/code}}
++
--{{code language="none"}}
--// Return the transformed program
--{{/code}}
--)))
++
--(% class="line number15 index14 alt2" %)
--(((
--{{code language="none"}}
--    scg
--{{/code}}
--)))
++
--(% class="line number16 index15 alt1" %)
--(((
--{{code language="none"}}
--}
--{{/code}}
--)))
--)))
--)))
++
--)))
--)))
++
++
++
++
++
++
++
++
++[[image:attach:KielerSCTEditorOwnTransformation.png]]
++
++[[image:attach:KielerSCTEditorOwnTransformationOlolo.png]]
++
++
++
++
++
++
++
++
++
++
++
++
++
++[[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" %)
  (((
--(% class="syntaxhighlighter nogutter  java" %)
--(((
--There's a few points to note here:
++[[image:attach:abo_scg_HandleA.png]]
  )))
--)))
++{{/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.
--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
++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}}
--{{code language="none"}}
--val
--{{/code}} declares a constant, while
++{{layout-cell}}
++[[image:attach:sccharts-scg.png]]
++{{/layout-cell}}
++{{/layout-section}}
--{{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
++{{layout-section ac:type="two_right_sidebar"}}
++{{layout-cell}}
++==== Transformation Creation Task 2 ====
--{{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,
++Write a transformation that transforms your normalized version of ABO's HandleA into its corresponding SCG.
--{{code language="none"}}
--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. 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.
++1. Write a transformation that is able to transform {{code language="none"}}ABO_norm_HandleA{{/code}} into its corresponding SCG.
 . **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.
 . Check your SCG semantically. Is there anything you could improve/optimize?
 . Write a second transformation (just as before) and add it to the transformation chain right after the transformation you already added.
@@ -510,5 +510,9 @@
  {{/layout-cell}}
++
++{{layout-cell}}
++
++{{/layout-cell}}
  {{/layout-section}}
  {{/layout}}

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--16810366
++16810374

URL

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

Changes for page SCCharts Development

Summary

Details

Navigation

Quick Links