Difference between pages "Camille Editor" and "Code Generation Activity"

From Event-B
(Difference between pages)
Jump to navigationJump to search
imported>Fabian
 
imported>Andy
 
Line 1: Line 1:
{| align="right"
+
Tasking Event-B is the extension of Event-B for defining concurrent systems sharing data, for details see the [[Tasking Event-B Overview]] page. For more information contact Andy Edmunds - University of Southampton - mailto:ae2@ecs.soton.ac.uk, or Chris Lovell mailto:cjl3@ecs.soton.ac.uk
| __TOC__
+
=== Code Generation Feature - Version 0.2.2 For Rodin 2.4===
|}
+
Interim Release
The first version of the Text Editor will be released in a few weeks, that means in second half of June and not before the Rodin release 1.0 has been published.
 
  
Until then we are going to release a few testing releases (beta) for interested users. You will find instructions how to install and use these beta releases on this page.
+
local update site soon available from:
 +
[https://sourceforge.net/projects/codegenerationd/files/?]
  
 +
=== Code Generation Feature - Version 0.2.1 For Rodin 2.3===
 +
Contains Bug Fixes for previous release. 14-12-2011
  
 +
=== Code Generation Feature - Version 0.2.0 For Rodin 2.3===
 +
We have release a new version of the code generator on 30-11-2011, and updated documentation.
 +
===== Changes to the Tooling and Approach =====
 +
The main changes are:
 +
* The code generators have been completely re-written. The translators are now implemented in Java, i.e. there is no longer a dependence on the Epsilon tool set. This was undertaken for code maintenance reasons.
 +
* Tasking Event-B is now integrated with the Event-B explorer.
 +
* The Rose Editor is used for editing the Tasking Event-B, and
 +
* a text-based editor is provided, using the Rose extension, for editing the TaskBody. This feature has been added to address some of the usability concerns. It also overcomes the 'problem' experienced with duplicate event names in a development, since the parser-builder that has been implemented automatically selects the correct event.
 +
* The EMF tree editor in Rose is only used minimally; we plan enhancements to further reduce its use.
 +
* Composed machines are used to store event 'synchronizations'; these are generated automatically during the decomposition process. This reduces the amount of typing in the TaskBody editor, since we no longer need to specify both local and remote (synchronizing) events.
 +
* The code generation approach is now extensible; new target language constructs can be added using the Eclipse extension mechanism.
 +
* The translation of target's mathematical language is now specified in the theory plug-in. This improves clarity since the the translation from source to target is achieved by specifying pattern matching rules. Extensibility is also improved; the theory plug-in is used to specify new data-types, and how they are implemented.
 +
* Translated code is deposited in a directory in the appropriate files. An Ada project file is generated for use with AdaCore's GPS workbench. Eventually this could be enabled/disabled in a preferences dialog box.
 +
* The Tasking Event-B to Event-B translator is now properly integrated. Control variable updates to the Event-B model are made in a similar way to the equivalent updates in the state-machine plug-in. The additional elements are added to the Event-B model and marked as 'generated'. This prevents users from manually modifying them, and allows them to be removed through a menu choice.
  
{| style="width:auto; background-color:#FFFF00; border:2px solid red;  padding:3px;"
+
===== Changes to the Documentation =====
|<b title="Usage warning"><font size="3"> Warning:</font size="3"></b><font size="1">
+
The following Pages have been updated:
Don't use the TextEditor yet with your production models!
+
* [http://wiki.event-b.org/index.php/Tasking_Event-B_Overview Tasking Event-B Overview]
* The TextEditor is still in development
+
* [http://wiki.event-b.org/index.php/Tasking_Event-B_Tutorial Tutorial]
* It is based on latest SVN Rodin version which uses a changed database model. Therefore its projects cannot be used in older Rodin versions.
 
  
|}
+
===== Downloads =====
 +
* The Code Generation feature is available by accessing the main Rodin Update Site. In Eclispe click on Help/Install new Software. Find the Rodin update site from the list. In Utilities add Code Generation.
 +
The approach makes use of the following:
 +
*Model Decomposition: Download from the main Rodin Update Site, in the Decomposition section.
 +
*Shared Event Composition: Download from the main Rodin Update Site, in the Decomposition section.
 +
*Theory Plug-in: Download from the main Rodin Update Site, in the Modelling Extensions section.
  
 +
 +
* Tutorial, and example, projects are available from the Examples directory: [https://codegenerationd.svn.sourceforge.net/svnroot/codegenerationd/Examples/v0.2.2/ SVN].
 +
* Test projects are also available from the Examples directory [https://codegenerationd.svn.sourceforge.net/svnroot/codegenerationd/Examples/v0.2.1/CG_v0.2.0_Tests SVN].
 +
* Sources at: [https://rodin-b-sharp.svn.sourceforge.net/svnroot/rodin-b-sharp/trunk/CodeGeneration SVN]
 +
* Example Theories at: [https://codegenerationd.svn.sourceforge.net/svnroot/codegenerationd/Examples/TheoriesForCG SVN]
  
  
==News ==
+
TODO
* ''27th May 2009'': Update the page due to syntax changes and new version on update-site ('''version 0.0.2''')
+
* Add addressed variables (for direct read/write access to memory)
* ''13th May 2009'': Creation of this page and publishing the beta update-site for the first time ('''version 0.0.1'''). Presentation at refocus meeting in Southampton.
+
* Flattening of composed machines/implementation machines.
 +
* Interrupts
  
 +
=== Sensing and Actuating for Tasking Event-B ===
 +
Version 0.1.5. Sensing and actuating events, and an Environ Machine have been added to allow simulation of the environment and implementation using memory mapped IO.
  
==Installing ==
+
* The new v0.1.5 feature is available from the Rodin Update Site, it resides in the Utilities Category.
The TextEditor relies on features of the Rodin release 1.0 which is not yet released. Therefore you will have to create a new Rodin installation. The following steps will guide you through this process:
 
  
# Download a build of Rodin from our [http://cruise.cs.uni-duesseldorf.de/dashboard/tab/builds CruiseControl server]:
+
* As in previous releases, the code generation plug-in relies on the Epsilon tool suite. Add the following Epsilon interim update site to the list of available update sites in the Eclipse menu ''help/install new software'': http://download.eclipse.org/modeling/gmt/epsilon/interim/
## Point your browser to http://cruise.cs.uni-duesseldorf.de/dashboard/tab/build/detail/org.rodinp.platform
 
## Download a zip file with a name starting with ''rodin-product'' and matching your platform. For example ''rodin-product-linux.gtk.x86.zip'' if you are working on a Linux system.
 
# Extract the downloaded zip file.
 
# Start Rodin from the folder where you extracted the zip file in the previous step.
 
# Install the TextEditor:
 
## In the menu choose ''Help'' -> ''Software Updates...''
 
## Select the tab ''Available Software'' and click ''Add Site...''
 
## Use the location URL: <tt>http://www.stups.uni-duesseldorf.de/update-beta/</tt>
 
## Back in ''Available Software'' open the update site you just added
 
## Select ''Event-B EMF Framework'' and ''Event-B TextEditor'' and click ''Install...''
 
# Restart Rodin as suggested.
 
  
 +
* Select 'the Epsilon Core (Incubation)' component, this is the only component that is required for Tasking Event-B.
  
Now you are ready to use the TextEditor.
+
A new [http://wiki.event-b.org/index.php?title=Tasking_Event-B_Tutorial Code Generation Tutorial] has been produced, that makes use of these new features. There is an explanation of the heating controller, upon which it is based, [http://wiki.event-b.org/index.php/Development_of_a_Heating_Controller_System here].
  
 +
The example/tutorial projects, and also and a Bundled Windows 7 version, are available in the [http://deploy-eprints.ecs.soton.ac.uk/304/ Deploy E-Prints archive] or [https://codegenerationd.svn.sourceforge.net/svnroot/codegenerationd/Examples/HeatingController_Tutorial_v0.1.4/ Examples SVN site].
  
==Updating ==
+
=== The Code Generation Demonstrator for Rodin 2.1.x ===
As often as possible we are going to publish updated beta releases. We recommend that you update your new Rodin installation with these updates for the TextEditor (and EMF Framework).
 
  
Although we will try to announce these updates on this site too, it is a lot easier if you setup Rodin to let you know when an update is available. The following steps guide you through this process:
+
Released 24 January 2011.
  
# In Rodin open the preferences (''Window'' -> ''Preferences'' or for Mac: ''Rodin'' -> ''Preferences'')
+
The Rodin 2.1.x compatible code generation demonstrator plug-ins have been released into the Rodin Sourceforge repository at:
# Find ''Install/Update'' -> ''Automatic Updates''
 
# Select ''Automatically find new updates and notify me''
 
  
As soon as Rodin finds a new update it will ask you if you would like to install it.
+
  https://rodin-b-sharp.svn.sourceforge.net/svnroot/rodin-b-sharp/trunk/CodeGeneration
  
 +
The update-site is available through the Rodin update site in the ''Utilities'' category.
  
==Usage ==
+
The code generation tutorial examples are available for download at:
This section should help you to get started with the TextEditor.
 
  
====Opening with the TextEditor ====
+
  https://sourceforge.net/projects/codegenerationd/files/DemoFiles/
At the moment the TextEditor competes with the current graphical Event-B editor when it comes to the selection of a default editor for the double click action to open a model file.
 
  
Thus from time to time you might experience that an unexpected editor opens. If this happens you can right-click on the model file and select ''Open with TextEditor'' to use the text editor. Usually you should be able to just use a double-click to open a machine or context with the TextEditor.
+
The code generation plug-in relies on the Epsilon tool suite. Install Epsilon manually, since the automatic install utility does not seem to work for this feature. We currently use the Epsilon interim update site available at:
  
====Syntax ====
+
  http://download.eclipse.org/modeling/gmt/epsilon/interim/
The text syntax for machines and contexts is closely related with the pretty-print you might know from the graphical Event-B editor. See the grammar's [[TextEditor_EBNF|EBNF]] for details.
 
  
As you might notice in the grammar it only describes the structure of machines and contexts. For the terminals ''predicate'', ''expression'' and ''action'' you can use the syntax for formulas which you already know from editing models with the graphical Event-B editor. You can use the ASCII representation of mathematical symbols or their unicode. See the Rodin help for details about the mathematical symbols and their ASCII counterparts.
+
Select 'the Epsilon Core (Incubation)' component, this is the only component that is required for Tasking Event-B.
  
====Editing ====
+
== Code Generation Status ==
The TextEditor currently offers the following features:
+
=== Latest Developments ===
* ''Syntax error marking'': Syntactical errors are highlighted in the input text.
+
* Demonstrator plug-in feature version 0.1.0
 +
** for Rodin 2.1.x version is available.
  
* ''Mathmatical language'': You can type formulas in ASCII syntax and the TextEditor will replace ASCII symbols with their unicode counterparts as soon as you stop typing for a short while.
+
* The Code Generation feature consists of,
 +
** a tasking Development Generator.
 +
** a tasking Development Editor (Based on an EMF Tree Editor).
 +
** a translator, from Tasking Development to Common Language Model (IL1).
 +
** a translator, from the Tasking Development to Event-B model of the implementation.
 +
** a pretty-printer for the Tasking Development.
 +
** a pretty-printer for Common Language Model, which generates Ada Source Code.
  
* ''Syntax highlighting'': Keywords (structural and in formulas), labels and comments are highlighted. This happends directly when typing
+
* A tutorial is available [[Code Generation Tutorial]]
 +
** Step 1 - Create the tasking development.
 +
** Step 2 - Add annotations.
 +
** Step 3 - Invoke translators.
  
* ''Semantic highlighting'': Identifiers are highlighted based on their semantic meaning, i.e., as variables, constants, parameters, sets, local variables. This highlighting is updated when you stop typing for a short while.
+
=== Ongoing Work ===
  
* ''Code completion'': The following elements are available for code completion (invoked by Ctrl+Space on the most computers)
+
* Full Rodin Integration
** ''Keywords''
+
* Sensed Variables
** ''Identifiers''
+
* Branching in Shared Machines
** ''Templates'' (very few so far, please let us know which templates you would like to add)
 
  
* ''Outline View'': An outline view gives you an overview of the model's structure.
+
=== Future Work ===
 +
* Support for Interrupts.
 +
* Richer DataTypes.
 +
* Accommodation of duplicate event names in tasking developments.
  
* ''Quick Navigation'': The outline view allows clicking on an element to jump to its position within the text.
+
== Metamodels ==
 +
* In the plug-in we define several meta-models:
 +
** CompositeControl: for the control flow (algorithmic) constructs such as branch, loop and sequence etc. These constructs may be used in the specification of either  sequential or concurrent systems.
 +
** Tasking Meta-model: defines the tasking model where we attach tasking specific details, such as task priority, task type. The tasking structures provide the ability to define single tasking or multi-tasking (concurrent) systems. We make use of the composite control plug-in to specify the flow of control.
 +
** Common Language (IL1) Meta-model: defines an abstraction of common programming language constructs for use in translations to implementations.
  
 +
== Translation Rules ==
 +
* Tasking to IL1/Event-B translation rules [[http://wiki.event-b.org/images/Translation.pdf]]
  
Of course the TextEditor offers the common features you know from other text editors, such as: copy, paste, moving of text (try Alt+Up or Alt+Down), undo, redo, ...
+
== Release History ==
 +
=== The Code Generation Demonstrator for Rodin 1.3.x ===
  
====Restrictions ====
 
Due to some design decisions and its combination with the Rodin platform the TextEditor comes with a few restrictions:
 
* Semantic analysis (for highlighting and code completion for example) can only performed if the overall structure of the input is parsable. Therefore you might experience situtions when the semantic highlighting or the code completion produces unexpected results because it is based on outdated parsing information.
 
  
* Parsing for formulas, i.e., predicates, actions and expressions can only be performed if the overall structure of the input is parsable. If the structure is not parsable ascii symbols will not be replaced until you correct the overall structure.
+
First release: 30 November 2010.
  
* Also see the [[TextEditor_EBNF|EBNF page]] for some restrictions in the syntax.
+
available from:
  
 +
https://sourceforge.net/projects/codegenerationd/files/
  
==Bugs and Features ==
+
The zip file contains a windows XP bundle, and a Windows V7 bundle. Alternatively, if you wish to build using an update-site, this is also included in the zip file, along with some notes on installation. However, note that the demonstrator tool is only compatible with Rodin 1.3.  
Please use this section to report any bugs you find and let us know about features you would like to see in the TextEditor.
 
  
Regarding feature requests: Any feature request is welcome! But please keep in mind that we are preparing for a first stable release of the TextEditor. So we might not start working on your feature request in the next weeks. ''The focus until the first release is on stability!''
+
A simple shared buffer example is provided. This will form the basis of a tutorial (which is work in progress). The WindowsBundles directory contains a Rodin 1.3.1 platform with the Code Generation plug-ins, together with a patch plug-in. The patch plug-in is required to correct an inconsistency in the org.eventb.emf.persistence plug-in. For the bundles, simply extract the appropriate zip file into a directory and run the rodin.exe. The plug-ins are pre-installed - the only configuration necessary may be to switch workspace to ''<installPath>\rodin1.3bWin7\workspace''. When using the update-site the example projects, and the project forming the basis of a simple tutorial, are provided in the accompanying zip file. These should be imported manually.
  
 +
Mac users - no bundled version available at present, but use the update site in the 'advanced' folder.
  
====Bugs ====
+
'''A step-by-step [[Code Generation Tutorial]] is available'''  
* ''please add it when you fine one''
 
  
====Feature Requests ====
+
==== About the Initial Release ====
* Make TextEditor an [http://en.wikipedia.org/wiki/Eierlegende_Wollmilchsau Eierlegende Wollmilchsau]... ;-)
+
The Code Generation (CG) Feature in the initial release is a demonstration tool; a proof of concept, rather than a prototype. The tool has no static checker and, therefore, there will be a heavy reliance on docs and dialogue to facilitate exploration of the tools and concepts.
  
====Comments ====
+
==== Source Code ====
Of course any other feedback is welcome too! We appreciate when you let us now what you think about the TextEditor.
+
 
 +
The sources are available from,
 +
 
 +
https://codegenerationd.svn.sourceforge.net/svnroot/codegenerationd
 +
 
 +
Note - I used Eclipse 3.5 Galileo, and you will need to install (or have sources from) Epsilon's interim update site. There is also dependency on Camille v2.0.0
 +
 
 +
 
 +
 
 +
[[Category:Work in progress]]

Revision as of 12:29, 13 March 2012

Tasking Event-B is the extension of Event-B for defining concurrent systems sharing data, for details see the Tasking Event-B Overview page. For more information contact Andy Edmunds - University of Southampton - mailto:ae2@ecs.soton.ac.uk, or Chris Lovell mailto:cjl3@ecs.soton.ac.uk

Code Generation Feature - Version 0.2.2 For Rodin 2.4

Interim Release

local update site soon available from: [1]

Code Generation Feature - Version 0.2.1 For Rodin 2.3

Contains Bug Fixes for previous release. 14-12-2011

Code Generation Feature - Version 0.2.0 For Rodin 2.3

We have release a new version of the code generator on 30-11-2011, and updated documentation.

Changes to the Tooling and Approach

The main changes are:

  • The code generators have been completely re-written. The translators are now implemented in Java, i.e. there is no longer a dependence on the Epsilon tool set. This was undertaken for code maintenance reasons.
  • Tasking Event-B is now integrated with the Event-B explorer.
  • The Rose Editor is used for editing the Tasking Event-B, and
  • a text-based editor is provided, using the Rose extension, for editing the TaskBody. This feature has been added to address some of the usability concerns. It also overcomes the 'problem' experienced with duplicate event names in a development, since the parser-builder that has been implemented automatically selects the correct event.
  • The EMF tree editor in Rose is only used minimally; we plan enhancements to further reduce its use.
  • Composed machines are used to store event 'synchronizations'; these are generated automatically during the decomposition process. This reduces the amount of typing in the TaskBody editor, since we no longer need to specify both local and remote (synchronizing) events.
  • The code generation approach is now extensible; new target language constructs can be added using the Eclipse extension mechanism.
  • The translation of target's mathematical language is now specified in the theory plug-in. This improves clarity since the the translation from source to target is achieved by specifying pattern matching rules. Extensibility is also improved; the theory plug-in is used to specify new data-types, and how they are implemented.
  • Translated code is deposited in a directory in the appropriate files. An Ada project file is generated for use with AdaCore's GPS workbench. Eventually this could be enabled/disabled in a preferences dialog box.
  • The Tasking Event-B to Event-B translator is now properly integrated. Control variable updates to the Event-B model are made in a similar way to the equivalent updates in the state-machine plug-in. The additional elements are added to the Event-B model and marked as 'generated'. This prevents users from manually modifying them, and allows them to be removed through a menu choice.
Changes to the Documentation

The following Pages have been updated:

Downloads
  • The Code Generation feature is available by accessing the main Rodin Update Site. In Eclispe click on Help/Install new Software. Find the Rodin update site from the list. In Utilities add Code Generation.

The approach makes use of the following:

  • Model Decomposition: Download from the main Rodin Update Site, in the Decomposition section.
  • Shared Event Composition: Download from the main Rodin Update Site, in the Decomposition section.
  • Theory Plug-in: Download from the main Rodin Update Site, in the Modelling Extensions section.


  • Tutorial, and example, projects are available from the Examples directory: SVN.
  • Test projects are also available from the Examples directory SVN.
  • Sources at: SVN
  • Example Theories at: SVN


TODO

  • Add addressed variables (for direct read/write access to memory)
  • Flattening of composed machines/implementation machines.
  • Interrupts

Sensing and Actuating for Tasking Event-B

Version 0.1.5. Sensing and actuating events, and an Environ Machine have been added to allow simulation of the environment and implementation using memory mapped IO.

  • The new v0.1.5 feature is available from the Rodin Update Site, it resides in the Utilities Category.
  • Select 'the Epsilon Core (Incubation)' component, this is the only component that is required for Tasking Event-B.

A new Code Generation Tutorial has been produced, that makes use of these new features. There is an explanation of the heating controller, upon which it is based, here.

The example/tutorial projects, and also and a Bundled Windows 7 version, are available in the Deploy E-Prints archive or Examples SVN site.

The Code Generation Demonstrator for Rodin 2.1.x

Released 24 January 2011.

The Rodin 2.1.x compatible code generation demonstrator plug-ins have been released into the Rodin Sourceforge repository at:

 https://rodin-b-sharp.svn.sourceforge.net/svnroot/rodin-b-sharp/trunk/CodeGeneration 

The update-site is available through the Rodin update site in the Utilities category.

The code generation tutorial examples are available for download at:

 https://sourceforge.net/projects/codegenerationd/files/DemoFiles/

The code generation plug-in relies on the Epsilon tool suite. Install Epsilon manually, since the automatic install utility does not seem to work for this feature. We currently use the Epsilon interim update site available at:

 http://download.eclipse.org/modeling/gmt/epsilon/interim/

Select 'the Epsilon Core (Incubation)' component, this is the only component that is required for Tasking Event-B.

Code Generation Status

Latest Developments

  • Demonstrator plug-in feature version 0.1.0
    • for Rodin 2.1.x version is available.
  • The Code Generation feature consists of,
    • a tasking Development Generator.
    • a tasking Development Editor (Based on an EMF Tree Editor).
    • a translator, from Tasking Development to Common Language Model (IL1).
    • a translator, from the Tasking Development to Event-B model of the implementation.
    • a pretty-printer for the Tasking Development.
    • a pretty-printer for Common Language Model, which generates Ada Source Code.
  • A tutorial is available Code Generation Tutorial
    • Step 1 - Create the tasking development.
    • Step 2 - Add annotations.
    • Step 3 - Invoke translators.

Ongoing Work

  • Full Rodin Integration
  • Sensed Variables
  • Branching in Shared Machines

Future Work

  • Support for Interrupts.
  • Richer DataTypes.
  • Accommodation of duplicate event names in tasking developments.

Metamodels

  • In the plug-in we define several meta-models:
    • CompositeControl: for the control flow (algorithmic) constructs such as branch, loop and sequence etc. These constructs may be used in the specification of either sequential or concurrent systems.
    • Tasking Meta-model: defines the tasking model where we attach tasking specific details, such as task priority, task type. The tasking structures provide the ability to define single tasking or multi-tasking (concurrent) systems. We make use of the composite control plug-in to specify the flow of control.
    • Common Language (IL1) Meta-model: defines an abstraction of common programming language constructs for use in translations to implementations.

Translation Rules

  • Tasking to IL1/Event-B translation rules [[2]]

Release History

The Code Generation Demonstrator for Rodin 1.3.x

First release: 30 November 2010.

available from:

https://sourceforge.net/projects/codegenerationd/files/

The zip file contains a windows XP bundle, and a Windows V7 bundle. Alternatively, if you wish to build using an update-site, this is also included in the zip file, along with some notes on installation. However, note that the demonstrator tool is only compatible with Rodin 1.3.

A simple shared buffer example is provided. This will form the basis of a tutorial (which is work in progress). The WindowsBundles directory contains a Rodin 1.3.1 platform with the Code Generation plug-ins, together with a patch plug-in. The patch plug-in is required to correct an inconsistency in the org.eventb.emf.persistence plug-in. For the bundles, simply extract the appropriate zip file into a directory and run the rodin.exe. The plug-ins are pre-installed - the only configuration necessary may be to switch workspace to <installPath>\rodin1.3bWin7\workspace. When using the update-site the example projects, and the project forming the basis of a simple tutorial, are provided in the accompanying zip file. These should be imported manually.

Mac users - no bundled version available at present, but use the update site in the 'advanced' folder.

A step-by-step Code Generation Tutorial is available

About the Initial Release

The Code Generation (CG) Feature in the initial release is a demonstration tool; a proof of concept, rather than a prototype. The tool has no static checker and, therefore, there will be a heavy reliance on docs and dialogue to facilitate exploration of the tools and concepts.

Source Code

The sources are available from,

https://codegenerationd.svn.sourceforge.net/svnroot/codegenerationd

Note - I used Eclipse 3.5 Galileo, and you will need to install (or have sources from) Epsilon's interim update site. There is also dependency on Camille v2.0.0