Difference between pages "Decomposition Plug-in User Guide" and "EMF framework for Event-B"

From Event-B
(Difference between pages)
Jump to navigationJump to search
imported>Pascal
 
imported>Colin
 
Line 1: Line 1:
 
{{TOCright}}
 
{{TOCright}}
 +
''This page is edited by Colin, Alexei and Fabian''
  
−
== Introduction ==
+
{| style="width:auto; background-color:#FFFF00; border:2px solid red;  padding:3px;"
−
The Decomposition plug-in allows to decompose a model into sub-models.
+
|<b title="Usage warning"><font size="3"> Warning:</font size="3"></b><font size="1">
  
−
See the [http://wiki.event-b.org/index.php/Event_Model_Decomposition Event-B Model Decomposition] page for technical details on ''shared variables'' (A-style) decomposition.
+
This page is being updated and is currently inconsistent and inaccurate in some areas
  
−
== Installing and Updating ==
+
|}
  
−
=== Setup ===
+
===The Eclipse Modeling Framework===
−
The following steps will guide you through the setup process:
 
−
# Download Rodin for your platform from [http://sourceforge.net/project/showfiles.php?group_id=108850&package_id=181714&release_id=687381 Sourceforge]:
 
−
# Extract the downloaded zip file.
 
−
# Start Rodin from the folder where you extracted the zip file in the previous step.
 
−
# Install the Decomposition plug-in:
 
−
## In the menu choose ''Help'' -> ''Software Updates...''
 
−
## Select the tab ''Available Software'' and click ''Add Site...''
 
−
## Use the location URL: <tt>http://rodin-b-sharp.sourceforge.net/updates</tt>
 
−
## Back in ''Available Software'' open the update site you just added
 
−
## Select ''Event-B Decomposition'' and click ''Install...''
 
−
# Restart Rodin as suggested.
 
  
−
Now you are ready to use the Decomposition plug-in.  
+
The EMF project is a modeling framework and code generation facility for building tools and other applications based on a structured data model. From a model specification described in XMI, EMF provides tools and runtime support to produce a set of Java classes for the model, along with a set of adapter classes that enable viewing and command-based editing of the model, and a basic editor.
  
−
=== Update ===
+
===An EMF Meta-Model of Event-B===
−
The following steps will guide you through the update process:
 
−
# In Rodin open the preferences (''Window'' -> ''Preferences'' or for Mac: ''Rodin'' -> ''Preferences'')
 
−
# 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.
+
The Event-B meta-model defines the structure of Event-B projects. The model is structured into three packages for clarity. The core package contains a structure of abstract meta-classes so that models can be treated generically as far as possible. The core package also contains mechanisms to handle extensions provided by other plug-ins and a meta-class to model entire projects. There are two sub-packages, contained with the core package, for Machine and Context.  Note, that the ''EventB'' prefix is used to indicate that a meta-class is abstract (i.e. cannot be instantiated except via one of its subclasses).
  
−
=== Release Notes ===
+
====Core abstract structure====
−
See the [http://wiki.event-b.org/index.php/Decomposition_Release_History Decomposition plug-in release history].
+
The root of all meta-classes in the Event-B EMF model is the abstract base class, ''EventBObject'' this provides some convenience methods to access containing or contained elements of a specified type and a method to obtain the URL of an element's package. EventBObject extends the EMF class, EModelElement, which provides a facility to store EAnnotations in any EventBObject. (EAnnotations give a flexible and efficient way to store information that is not part of the main model. For example this is used to store some information contained in the Rodin database, which must be preserved but is not of interest in the EMF modelling tools).
  
−
== Decomposing ==
+
''EventBElement'' provides a common abstract base class for all EventBObjects that are elements of the model. This meta-class provides extensibility features that are described later.
−
{{TODO}}
 
−
=== Selecting the Input Machine ===
 
−
=== Setting the Preferences ===
 
−
Decomposition style, decomposition of the contexts, etc.
 
−
=== Importing / Exporting the Configuration ===
 
  
−
== Reporting a Bug or Requesting a Feature ==
+
''EventBCommentedElement'' provides the ability to comment elements. It inherits a string attribute, ''comment'' from ''EventBCommented''. (The use of a separate meta-class, outside the main inheritance hierarchy gives more flexibility for future modifications if other elements need to be commented. Hence if client code refers to comments via ''EventBCommented'' rather than ''EventBCommentedElement'' they will not be affected if, in the future, other elements inherit ''EventBCommented'').
−
Please, use the SourceForge trackers to report a bug on existing features, or to request new features:
 
−
* [https://sourceforge.net/tracker/?atid=651669&group_id=108850&category=1259297 Bugs]
 
−
* [https://sourceforge.net/tracker/?atid=651672&group_id=108850&category=1259298 Feature Requests]
 
  
−
== Error Messages ==
+
Similarly, ''EventBNamedCommentedElement'' adds the ability to name elements by inheriting a string attribute, ''name'' from ''EventBNamed''. (Currently, a named but not commented element is not provided).  
−
The decomposition is forbidden if one of the following conditions applies:
 
−
* The built INITIALISATION events of the sub-machines would define an action modifying at the same time a ''private'' variable and a ''shared'' variable, when performing the ''shared variables'' (A-style) decomposition.
 
−
Action {0} of the INITIALISATION event modifies a private variable and a shared variable
 
−
* The sub-models shall be created in new Event-B projects, but one of the entered project names already exists.
 
−
The project {0} should not exist
 
−
* The same project name has been entered for two distinct sub-models.
 
−
Duplicate sub-model names: {0}
 
  
−
{{TODO}}
+
''EventBExpression'' provides a string attribute, ''expression'', for an Event-B mathematical expression. Note that this class extends ''EventBCommentedElement'' since our current need (Variant) is for expression elements not to be commented but not named.
−
decomposition_error_contextDecompositionKind=Chosen context decomposition kind is not available
 
−
decomposition_error_duplicateSubModelNames=Duplicate sub-model names: {0}
 
−
decomposition_error_existingmachine=The machine {0} should not exist
 
−
decomposition_error_existingcontext=The context {0} should not exist
 
−
decomposition_error_existingproject=The project {0} should not exist
 
  
−
database_VariableInvalidNatureFailure = Invalid nature value in {0}
+
''EventBPredicate'', provides a string attribute, ''predicate'' for an Event-B mathematical predicate. Note that this class extends ''EventBNamedCommentedElement'' since our current need is for all predicate elements to be commented and named.
−
scuser_VariableHasDisappearedError = Shared variable {0} has disappeared
 
−
scuser_VariableInvalidNatureError = Inconsistent nature of shared variable {0}, shared expected
 
−
scuser_EventHasDisappearedError = External event {0} has disappeared
 
−
scuser_EventInvalidStatusError = Inconsistent status of external event {0}, {1} expected
 
−
scuser_ParametersInExternalEventError = Parameters cannot be added in external events
 
−
scuser_GuardsInExternalEventError = Guards cannot be added in external events
 
−
scuser_ActionsInExternalEventError = Actions cannot be added in external events
 
−
scuser_ActionOnPrivateAndSharedError = Action {0} of the INITIALISATION event modifies a private variable and a shared variable
 
−
scuser_ActionOnSharedError = Action {0} of the INITIALISATION event has disappeared
 
  
−
== Tips and Tricks ==
+
''EventBDerivedPredicate'', extends ''EventBPredicate'' and provides a boolean attribute, ''theorem'' to indicate that the predicate is a theorem that should be derived (from previous predicates in the same container).
−
=== ''Shared variables'' (A-style) decomposition ===
 
−
<ol>
 
−
<li> '''An invariant is missing in a sub-machine, but I would like to have it copied.'''
 
−
:For example, an invariant between a concrete variable and some abstract variable may be useful.
 
−
:A solution is to add a theorem based on the missing predicate in the non-decomposed machine. See the last paragraph [[Event_Model_Decomposition#inv_distribution | about the invariants]] in the Event-B Model Decomposition page.
 
  
−
<li>'''An axiom is missing in a sub-context, but I would like to have it copied.'''
+
[[Image:EMFcore1abstract.gif|EMF model, abstract base elements]]
−
:Such a situation may be encountered if the "Decompose contexts" option is checked.
 
−
:The workaround proposed for the invariants applies to the axioms as well.
 
−
:For example, if the non-decomposed context defines the axiom <math>a \in S</math>, and this axiom is not copied in a sub-context which contains the <math>S</math> carrier set but does not contain the <math>a</math> constant, then the information <math>S \neq \emptyset</math> is lost. In order to keep it, it is possible to add the theorem <math>\exists x \qdot x \in S</math> in the non-decomposed context.
 
  
−
<li> '''A variable is tagged as ''private'' in a sub-machine, but I would like to have it tagged ''shared''.'''
+
====The Extension Mechanism====
−
:Such a behavior is suitable if you want to prevent this variable from being further refined.
 
−
:A solution for such a variable <math>v</math> of a sub-machine <math>M_i</math> is to add a fake action <math>v \bcmeq v</math> in a event of the non-decomposed machine which is associated to the sub-machine <math>M_j</math> (<math>M_i</math> and <math>M_j</math> are distinct sub-machines) when performing the decomposition.
 
−
:In the first example below, the <math>min</math> variable will become ''private'' when performing the decomposition:
 
−
[[Image:scenario1.png|center|500px|]]
 
−
:In the second example below, the <math>min</math> variable will become ''shared'' when performing the decomposition:
 
−
[[Image:scenario2.png|center|500px|]]
 
−
</ol>
 
  
−
[[Category:User documentation]]
+
The abstract root meta-class, ''BElement'', contains a collection, ''extensions'', of another abstract meta-class, ''BExtension''. ''BExtension'' can be specialised in other EMF models to define extensions of the model. Extension classes should override the abstract load and save methods of ''BExtension'' in order to define their specific requirements for serialisation.
−
[[Category:Work in progress]]
+
 
 +
[[Image:EMFcore2extensions.gif|EMF model, extension mechanism]]
 +
 
 +
====Project====
 +
 
 +
A Project contains a collection of components. Project extends EventBNamedCommentedElement. This allows it to contain Extensions and Attributes as well as providing it with a name and comment.
 +
 
 +
[[Image:EMFcore3project.gif|EMF model of an Event-B Project]]
 +
 
 +
====Machine package====
 +
 
 +
A Machine inherits from component (so that it can be used in the ''components'' collection of a Project). Machines, refine other machines (via a subtype of ''BReferenceElement'' which may be resolved), see contexts  (via a subtype of ''BReferenceElement'' which may be resolved), and may contain, variables, invariants, theorems, a single variant and events.
 +
 
 +
[[Image:EMFmachine.gif|EMF model of a Machine]]
 +
 
 +
'''Events'''
 +
 
 +
Events contain parameters, witnesses, refines relationships with other events, guards and actions. Witnesses, link with other parameters (via a subtype of ''BReferenceElement'' which may be resolved). Similarly, event refinement relationships link to other events (via a subtype of ''BReferenceElement'' which may be resolved). The enumerated type, ''BConvergence'',  provides the values for the convergence property of an event.
 +
 
 +
[[Image:EMFevent.gif|EMF model of an Event]]
 +
 
 +
====Context package====
 +
 
 +
A Context inherits from component. Contexts, extend other contexts  (via a subtype of ''BReferenceElement'' which may be resolved), and contain sets, constants, axioms and theorems. (Note that the ''BTheorem'' meta-class is the same one that appeared in the Machine package).
 +
 
 +
[[Image:EMFcontext.gif|EMF model of a Context]]
 +
 
 +
===Event-B Mathematical Language Extension===
 +
Using [[#The Extension mechanism|the Extension mechanism]] an EMF extension for the Mathmetical Language of EventB will be created. This means expressions, predicates and substitutions will be available as EMF models too.
 +
 
 +
As the RodinDB only saves these constructs as plain strings, their EMF representation will be recreated every time a model is loaded. The existing RodinParser in combination with a conversion component will be used for this task.
 +
To avoid unnecessary parsing the creation of these models will be postponed until the models are needed. For example, it will be up to the tool developers to decide when they need a fully resolved structure of predicates. API methods in the [[#Text Tools|Text Tools]] will ease parsing and model construction for tool developers.
 +
 
 +
===Persistence===
 +
The Persistence package will override the default EMF persistence so that models created with the Event-B EMF framework will be serialised into the Rodin Database. The serialisation will make use of the Rodin API so that it is decoupled from the serialisation of the Rodin database. Serialisation will synchronise changes with the Rodin Database so that only elements that have been altered are updated.
 +
The Persistence API will provide methods to open/create Rodin projects, load and unload components (from Rodin Database to cache), save changes, register listeners to projects and components and resolve references between elements.
 +
 
 +
===Text Tools===
 +
As several tools based on the EventB meta-model will deal with a textual representation of it, a component called 'Text Tools' will be created. Text Tools will offer an API for basic tasks such as:
 +
* Define a concrete syntax for the structure of machines and contexts
 +
* Conversion from an EventB meta-model to text, i.e., pretty-print with configurable layout
 +
* Parsing of text input which produces an EventB meta-model
 +
 
 +
 
 +
'''Structural parsing'''
 +
 
 +
The Rodin core already provides a parser for expressions, predicates and substitutions. Therefore Text Tools will only provide a parser for the structural parts of the text representation of EventB machines and contexts. This parser will treat expressions, predicates and substitutions as plain strings that are stored in attributes in the meta-model.
 +
As described in section [[#Event-B Mathematical Language Extension|Event-B Mathematical Language Extension]] the full mathematical language will be supported as an extension to the EventB meta-model. Tools that are interested in working on a fully parsed version of an expression, predicate or substitution will be able to use helper methods of the Text Tools API. These helper methods will make use of the existing Rodin parser and convert the resulting AST to the meta-model.
 +
 
 +
 
 +
'''Fallback strategy'''
 +
 
 +
When the user is editing the textual representation of a machine or context the input may contain syntactic errors which prevent converting the parse result into an EMF model. As the user might wish to save the text representation in this syntactically incorrect state, Text Tools will provide a fallback strategy for this case. API methods will be provided to store the plain text into the RodinDB. This plain text will be used as a basis for editing next time the model is loaded via Text Tools.
 +
 
 +
 
 +
'''Conflict resolution'''
 +
 
 +
When Text Tools loads an EventB meta-model from the Rodin Database it will detect any conflicts in the model. Conflicts will occur if other editors, that do not work via Text Tools, have changed the model in the RodinDB after Text Tools has stored a syntactically incorrect version as plain text. In this case the tool that is using Text Tools to load the model will be informed about the conflict and asked to resolve it. Strategies to solve these conflicts could be 'automatic overwriting based on time stamps' or using the editors described in the section [[#Compare/Merge Editor|Compare/Merge Editor]].
 +
 
 +
===Tools That Will Use the Framework===
 +
 
 +
The framework described above is not yet available. However, we already plan to use it in some tools.
 +
 
 +
====Compare/Merge Editor====
 +
In several situations conflicts between different versions of an Event-B model can occur. Often the responsible tool will not be able to resolve these conflicts automatically and user interaction is required. A compare and merge editor for Event-B models will help users to solve these conflicts. This editor will be based on the [http://wiki.eclipse.org/index.php/EMF_Compare EMF Compare] sub-project. It will compare the two conflicting versions and present the differences to the user. This visualization of the model will resemble the [[#Structure Editor|Structure Editor]].
 +
 
 +
If one of the two versions of the machine/context contains an invalid structure that means it is only available as text, the EMF based Compare/Merge editor cannot be used. A textual Compare/Merge editor will be available as an alternative view (integrated with the EMF Compare/Merge editor). The second view will be based on the [[#Text Editor|Text Editor]].
 +
 
 +
Usage scenarios are, for example:
 +
* Merging after a conflict between RodinDB and Text Editor (as described in [[#Text Tools|Text Tools]])
 +
* Team-based development, for example, using SVN or CVS
 +
* Comparison of an abstract and a refining machine, highlighting the differences
 +
 
 +
====Text Editor====
 +
Requests by several users have shown that there is demand for a text editor for EventB models. Based on the EventB meta-model and the [http://www2.informatik.hu-berlin.de/sam/meta-tools/tef/index.html Text Editor Framework], a state-of-the-art text editor will be created.
 +
The editor will make use of  [[#Text Tools|Text Tools]] and will provide an extensible set of features, such as (syntactical and semantical) highlighting, code completion, quick navigation and outline view.
 +
 
 +
The text editor will be available in two forms. A first class Eclipse editor will offer editing of full machines and contexts. In addition a pop-up editor will be created that can be used by other tools to allow their users text editing of sub-components in machines and contexts. An example is the [[#Structure Editor|Structure Editor]], which will offer a pop-up text editor allowing the user to edit a single expression or a compound sub-component such as an event.
 +
 
 +
====Structure Editor====
 +
EMF provides support to generate structured (e.g. tree, list, table based) editors for models. An adapted version of these editors will allow users to edit machine and context elements within a structure using menu-guided selections. To allow feature-rich editing of elements containing expressions, predicates and substitutions this editor will use the pop-up variant of the [[#Text Editor|Text Editor]].
 +
 
 +
====Project Diagram Editor====
 +
A diagrammatic editor will be produced that shows the structure of an Event-B Project in terms of it's Machines and Contexts with their refines, sees and extends relationships. (This will replace the current UML-B package diagram). The Project Diagram editor will be produced using the Graphical Modelling Framework (GMF). It will allow machines and contexts to be created/deleted and their relationships changed. A feature to create a 'starting point' refinement of a machine, will be included.
 +
 
 +
====[[UML-B]]====
 +
UML-B will be re-implemented as an extension to the Event-B meta-model. The UML-B meta-classes will extend and add to the meta-classes of Event-B. This will provide greater integration between the EMF based Event-B editors and the UML-B diagrammatic editors.
 +
 
 +
====Refinement Pattern Editor====
 +
The EMF framework will be used to implement the text editor for the Event-B pattern plugin. The syntax of facets - Event-B model templates used to describe patterns - is an extension of the Event-B syntax.
 +
 
 +
====[[Parallel Composition using Event-B|Shared Event Composition Tool]]====
 +
An editor for composing two machines based on shared events has been developed by Southampton. This tool will be re-implemented to utilise the Event-B EMF framework.
 +
 
 +
See [[Parallel Composition using Event-B]].
 +
 
 +
====[[Feature Composition Plug-in|Feature Composition Tool]]====
 +
An editor for composing two machines based on feature selection has been developed by Southampton. The tool (which is already based on EMF) will be re-implemented to utilise the Event-B EMF framework.
 +
See [[Feature Composition Plug-in]].
 +
 
 +
===Internal Documentation===
 +
The following pages contain documentation that we use internally only ('''not''' to be included in deliverable):
 +
* [[Tasklist for EventB meta model development|Tasklist]]
 +
 
 +
[[Category:Design proposal]]

Revision as of 14:10, 14 May 2009

This page is edited by Colin, Alexei and Fabian

Warning:

This page is being updated and is currently inconsistent and inaccurate in some areas

The Eclipse Modeling Framework

The EMF project is a modeling framework and code generation facility for building tools and other applications based on a structured data model. From a model specification described in XMI, EMF provides tools and runtime support to produce a set of Java classes for the model, along with a set of adapter classes that enable viewing and command-based editing of the model, and a basic editor.

An EMF Meta-Model of Event-B

The Event-B meta-model defines the structure of Event-B projects. The model is structured into three packages for clarity. The core package contains a structure of abstract meta-classes so that models can be treated generically as far as possible. The core package also contains mechanisms to handle extensions provided by other plug-ins and a meta-class to model entire projects. There are two sub-packages, contained with the core package, for Machine and Context. Note, that the EventB prefix is used to indicate that a meta-class is abstract (i.e. cannot be instantiated except via one of its subclasses).

Core abstract structure

The root of all meta-classes in the Event-B EMF model is the abstract base class, EventBObject this provides some convenience methods to access containing or contained elements of a specified type and a method to obtain the URL of an element's package. EventBObject extends the EMF class, EModelElement, which provides a facility to store EAnnotations in any EventBObject. (EAnnotations give a flexible and efficient way to store information that is not part of the main model. For example this is used to store some information contained in the Rodin database, which must be preserved but is not of interest in the EMF modelling tools).

EventBElement provides a common abstract base class for all EventBObjects that are elements of the model. This meta-class provides extensibility features that are described later.

EventBCommentedElement provides the ability to comment elements. It inherits a string attribute, comment from EventBCommented. (The use of a separate meta-class, outside the main inheritance hierarchy gives more flexibility for future modifications if other elements need to be commented. Hence if client code refers to comments via EventBCommented rather than EventBCommentedElement they will not be affected if, in the future, other elements inherit EventBCommented).

Similarly, EventBNamedCommentedElement adds the ability to name elements by inheriting a string attribute, name from EventBNamed. (Currently, a named but not commented element is not provided).

EventBExpression provides a string attribute, expression, for an Event-B mathematical expression. Note that this class extends EventBCommentedElement since our current need (Variant) is for expression elements not to be commented but not named.

EventBPredicate, provides a string attribute, predicate for an Event-B mathematical predicate. Note that this class extends EventBNamedCommentedElement since our current need is for all predicate elements to be commented and named.

EventBDerivedPredicate, extends EventBPredicate and provides a boolean attribute, theorem to indicate that the predicate is a theorem that should be derived (from previous predicates in the same container).

EMF model, abstract base elements

The Extension Mechanism

The abstract root meta-class, BElement, contains a collection, extensions, of another abstract meta-class, BExtension. BExtension can be specialised in other EMF models to define extensions of the model. Extension classes should override the abstract load and save methods of BExtension in order to define their specific requirements for serialisation.

EMF model, extension mechanism

Project

A Project contains a collection of components. Project extends EventBNamedCommentedElement. This allows it to contain Extensions and Attributes as well as providing it with a name and comment.

EMF model of an Event-B Project

Machine package

A Machine inherits from component (so that it can be used in the components collection of a Project). Machines, refine other machines (via a subtype of BReferenceElement which may be resolved), see contexts (via a subtype of BReferenceElement which may be resolved), and may contain, variables, invariants, theorems, a single variant and events.

EMF model of a Machine

Events

Events contain parameters, witnesses, refines relationships with other events, guards and actions. Witnesses, link with other parameters (via a subtype of BReferenceElement which may be resolved). Similarly, event refinement relationships link to other events (via a subtype of BReferenceElement which may be resolved). The enumerated type, BConvergence, provides the values for the convergence property of an event.

EMF model of an Event

Context package

A Context inherits from component. Contexts, extend other contexts (via a subtype of BReferenceElement which may be resolved), and contain sets, constants, axioms and theorems. (Note that the BTheorem meta-class is the same one that appeared in the Machine package).

EMF model of a Context

Event-B Mathematical Language Extension

Using the Extension mechanism an EMF extension for the Mathmetical Language of EventB will be created. This means expressions, predicates and substitutions will be available as EMF models too.

As the RodinDB only saves these constructs as plain strings, their EMF representation will be recreated every time a model is loaded. The existing RodinParser in combination with a conversion component will be used for this task. To avoid unnecessary parsing the creation of these models will be postponed until the models are needed. For example, it will be up to the tool developers to decide when they need a fully resolved structure of predicates. API methods in the Text Tools will ease parsing and model construction for tool developers.

Persistence

The Persistence package will override the default EMF persistence so that models created with the Event-B EMF framework will be serialised into the Rodin Database. The serialisation will make use of the Rodin API so that it is decoupled from the serialisation of the Rodin database. Serialisation will synchronise changes with the Rodin Database so that only elements that have been altered are updated. The Persistence API will provide methods to open/create Rodin projects, load and unload components (from Rodin Database to cache), save changes, register listeners to projects and components and resolve references between elements.

Text Tools

As several tools based on the EventB meta-model will deal with a textual representation of it, a component called 'Text Tools' will be created. Text Tools will offer an API for basic tasks such as:

  • Define a concrete syntax for the structure of machines and contexts
  • Conversion from an EventB meta-model to text, i.e., pretty-print with configurable layout
  • Parsing of text input which produces an EventB meta-model


Structural parsing

The Rodin core already provides a parser for expressions, predicates and substitutions. Therefore Text Tools will only provide a parser for the structural parts of the text representation of EventB machines and contexts. This parser will treat expressions, predicates and substitutions as plain strings that are stored in attributes in the meta-model. As described in section Event-B Mathematical Language Extension the full mathematical language will be supported as an extension to the EventB meta-model. Tools that are interested in working on a fully parsed version of an expression, predicate or substitution will be able to use helper methods of the Text Tools API. These helper methods will make use of the existing Rodin parser and convert the resulting AST to the meta-model.


Fallback strategy

When the user is editing the textual representation of a machine or context the input may contain syntactic errors which prevent converting the parse result into an EMF model. As the user might wish to save the text representation in this syntactically incorrect state, Text Tools will provide a fallback strategy for this case. API methods will be provided to store the plain text into the RodinDB. This plain text will be used as a basis for editing next time the model is loaded via Text Tools.


Conflict resolution

When Text Tools loads an EventB meta-model from the Rodin Database it will detect any conflicts in the model. Conflicts will occur if other editors, that do not work via Text Tools, have changed the model in the RodinDB after Text Tools has stored a syntactically incorrect version as plain text. In this case the tool that is using Text Tools to load the model will be informed about the conflict and asked to resolve it. Strategies to solve these conflicts could be 'automatic overwriting based on time stamps' or using the editors described in the section Compare/Merge Editor.

Tools That Will Use the Framework

The framework described above is not yet available. However, we already plan to use it in some tools.

Compare/Merge Editor

In several situations conflicts between different versions of an Event-B model can occur. Often the responsible tool will not be able to resolve these conflicts automatically and user interaction is required. A compare and merge editor for Event-B models will help users to solve these conflicts. This editor will be based on the EMF Compare sub-project. It will compare the two conflicting versions and present the differences to the user. This visualization of the model will resemble the Structure Editor.

If one of the two versions of the machine/context contains an invalid structure that means it is only available as text, the EMF based Compare/Merge editor cannot be used. A textual Compare/Merge editor will be available as an alternative view (integrated with the EMF Compare/Merge editor). The second view will be based on the Text Editor.

Usage scenarios are, for example:

  • Merging after a conflict between RodinDB and Text Editor (as described in Text Tools)
  • Team-based development, for example, using SVN or CVS
  • Comparison of an abstract and a refining machine, highlighting the differences

Text Editor

Requests by several users have shown that there is demand for a text editor for EventB models. Based on the EventB meta-model and the Text Editor Framework, a state-of-the-art text editor will be created. The editor will make use of Text Tools and will provide an extensible set of features, such as (syntactical and semantical) highlighting, code completion, quick navigation and outline view.

The text editor will be available in two forms. A first class Eclipse editor will offer editing of full machines and contexts. In addition a pop-up editor will be created that can be used by other tools to allow their users text editing of sub-components in machines and contexts. An example is the Structure Editor, which will offer a pop-up text editor allowing the user to edit a single expression or a compound sub-component such as an event.

Structure Editor

EMF provides support to generate structured (e.g. tree, list, table based) editors for models. An adapted version of these editors will allow users to edit machine and context elements within a structure using menu-guided selections. To allow feature-rich editing of elements containing expressions, predicates and substitutions this editor will use the pop-up variant of the Text Editor.

Project Diagram Editor

A diagrammatic editor will be produced that shows the structure of an Event-B Project in terms of it's Machines and Contexts with their refines, sees and extends relationships. (This will replace the current UML-B package diagram). The Project Diagram editor will be produced using the Graphical Modelling Framework (GMF). It will allow machines and contexts to be created/deleted and their relationships changed. A feature to create a 'starting point' refinement of a machine, will be included.

UML-B

UML-B will be re-implemented as an extension to the Event-B meta-model. The UML-B meta-classes will extend and add to the meta-classes of Event-B. This will provide greater integration between the EMF based Event-B editors and the UML-B diagrammatic editors.

Refinement Pattern Editor

The EMF framework will be used to implement the text editor for the Event-B pattern plugin. The syntax of facets - Event-B model templates used to describe patterns - is an extension of the Event-B syntax.

Shared Event Composition Tool

An editor for composing two machines based on shared events has been developed by Southampton. This tool will be re-implemented to utilise the Event-B EMF framework.

See Parallel Composition using Event-B.

Feature Composition Tool

An editor for composing two machines based on feature selection has been developed by Southampton. The tool (which is already based on EMF) will be re-implemented to utilise the Event-B EMF framework. See Feature Composition Plug-in.

Internal Documentation

The following pages contain documentation that we use internally only (not to be included in deliverable):

Retrieved from ‘https://wiki.event-b.org/index.php?title=Decomposition_Plug-in_User_Guide&oldid=3878’