imported>Pascal |
|
| Line 1: |
Line 1: |
| − | {{Navigation|Previous= [[Extend_Rodin_database_(How_to_extend_Rodin_Tutorial)|Extend the database]]| Next= [[Extend_Rodin_EventB_Explorer(How_to_extend_Rodin_Tutorial)|Adding elements to the Event-B explorer]]| Up= [[Plug-in_Tutorial|How to extend Rodin Tutorial (Index)]]}}
| |
| | | | |
| − | === In this part ===
| |
| − | We will use the extension points provided by the plug-in <tt>org.eventb.ui</tt> to add our Probabilistic attribute on events and the Bound element to the structured editor.
| |
| − |
| |
| − | === Step 1 ===
| |
| − | To structure a bit our development, we will separate the UI from the business layer.<br>
| |
| − | 1. Create a new plug-in (here <tt>fr.systerel.rodinextension.sample.ui</tt>, and this time, select "This plug-in will make contributions to the UI" as it will be indeed the case here.<br>
| |
| − | 2. Add our business plug-in (<tt>fr.systerel.rodinextension.sample</tt>) to the dependencies as well as <tt>org.eventb.ui</tt> that provides the extensions points we want to use.
| |
| − |
| |
| − | === Step 2 ===
| |
| − | 1. Add an extension to the extension point <tt>org.eventb.ui.editorItems</tt>.<br>
| |
| − | At this point, we start to extend the structured editor.<br>
| |
| − |
| |
| − | === Step 3 ===
| |
| − | First, let's add the probabilistic attribute to Event-B events.<br>
| |
| − | The probabilistic attribute can have two values : 'standard' (by default) and 'probabilistic'. Thus we need to create a 'choiceAttribute' extension.
| |
| − | Create a new 'choice attribute' extension:<br>
| |
| − | 1. Give a unique ID to identify this attribute in the UI plug-in (such as <tt>fr.systerel.rodinextension.sample.ui.probabilistic</tt>).<br>
| |
| − | 2. In typeID, give the ID reference of the probabilistic attribute in our business plug-in (here <tt>fr.systerel.rodinextension.sample.probabilistic</tt>).<br>
| |
| − | 3. Set the ''required'' attribute to <tt>true</tt> as we want this attribute to appear by default in the structured editor when editing events.<br>
| |
| − | 4. Create a class (using Eclipse assist, see [[Extend_Rodin_database_(How_to_extend_Rodin_Tutorial)|Extending the Rodin Database]]) to manipulate this attribute; this class should implements the interface <tt>org.eventb.ui.IAttributeManipulation</tt>.
| |
| − |
| |
| − | :Before doing any manipulation of the given <tt>IRodinElement</tt>, we have to cast this element as an <tt>IInternalElement</tt> (interface from <tt>org.rodinp.core</tt> providing access to element attributes). As we know that the element that will carry the probabilistic attribute is of type <tt>IEvent</tt>, and as <tt>IEvent</tt> implements the interface <tt>IInternalElement</tt>, let's create the following method.
| |
| − |
| |
| − | private IEvent asEvent(IRodinElement element) {
| |
| − | assert element instanceof IEvent;
| |
| − | return (IEvent) element;
| |
| − | }
| |
| − | :We also have to add the ID of the probabilistic attribute as a constant, as we will need it at various places in this class. We then add the following code:
| |
| − |
| |
| − | public static IAttributeType.Boolean PROB_ATTRIBUTE = RodinCore
| |
| − | .getBooleanAttrType(QualProbPlugin.PLUGIN_ID + ".probabilistic");
| |
| − |
| |
| − | :It is necessary to add the <tt>fr.systerel.rodinextension.sample.QualProbPlugin</tt> import clause. Then use the quick assist (while you go over QualProbPlugin underlined in red in the import clause) to export the <tt>fr.systerel.rodinextension.sample</tt> plug-in and make this class accessible.
| |
| − |
| |
| − | <tt>IAttributeType.Boolean</tt> defines that our probabilistic attribute is actually coded as a boolean. We will implement the probabilistic attribute as follows:
| |
| − | * If the event is probabilistic, the probabilistic attribute is set to <tt>true</tt>,
| |
| − | * Otherwise, the event is standard (e.g. non probabilistic), so the probabilistic attribute is set to <tt>false</tt>.
| |
| − | Note that there are several types for attributes. See [http://wiki.event-b.org/index.php/Extending_the_Rodin_Database#Getting_the_corresponding_Java_attribute_kind here] for more details.
| |
| − |
| |
| − | Now let's fill the methods required to implement <tt>IAttributeManipulation</tt> :
| |
| − | :1. <tt>getPossibleValues(IRodinElement element, IProgressMonitor monitor)</tt> should return an array of two constant values : "standard" and "probabilistic".<br>
| |
| − | :2. <tt>getValue(IRodinElement element, IProgressMonitor monitor)</tt> should 'convert' the given element as an event (using <tt>asEvent</tt>) and return the value corresponding to the state of the probabilistic attribute (retrieved by <tt>IInternalElement.getAttributeValue(PROB_ATTRIBUTE)</tt>). For example, it should return "probabilistic" if the attribute has value <tt>true</tt>, "standard" otherwise.<br>
| |
| − | :3. <tt>hasValue(IRodinElement element, IProgressMonitor monitor)</tt> should check if the given element converted as an event has a probabilistic attribute using the method <tt>IInternalElement.hasAttribute(PROB_ATTRIBUTE)</tt>.<br>
| |
| − | :4. <tt>removeAttribute(IRodinElement element, IProgressMonitor monitor)</tt> should convert the given element as an event, and use <tt>IInternalElement.removeAttribute(PROB_ATTRIBUTE, monitor)</tt>.<br>
| |
| − | :5. <tt>setDefaultValue(IRodinElement element, IProgressMonitor monitor)</tt> should convert the given element as an event, and do <tt>IInternalElement.setAttributeValue(PROB_ATTRIBUTE,</tt> '''false'''<tt>, monitor);</tt> as the default value for the probabilistic attribute is '''false'''.<br>
| |
| − | :6. finally, <tt>setValue(IRodinElement element, String value, IProgressMonitor monitor)</tt> should check that the given value correspond to the "probabilistic" string constant, and set the value of the element (previously converted as an event) to <tt>true</tt> if it is the case, or set the value to <tt>false</tt> otherwise.
| |
| − |
| |
| − | Now we will add this attribute to events. To do so, we need to create an attribute relation that will link our probabilistic attribute to events. Return to the MANIFEST.MF extensions page.<br>
| |
| − | 1. Create a new ''attributeRelation'' extension from the <tt>org.eventb.ui.editorItems</tt> extension point.<br>
| |
| − | 2. Enter <tt>org.eventb.core.event</tt> as ''elementTypeId'' in the attribute relation. This means that events will hold an attribute.<br>
| |
| − | 3. From this extension specify that the attribute held by events (among others) will be our probabilistic attribute by adding an ''attributeReference'' with the ID of our UI extension for the probabilistic attribute (here <tt>fr.systerel.rodinextension.sample.ui.probabilistic</tt>).
| |
| − |
| |
| − | === Step 4 ===
| |
| − | Finally, let's add the Bound element to Event-B machines.<br>
| |
| − | This step differs from the previous, as our element Bound is a new element (not an attribute). We want it to appear at top level in the structured editor, as invariants, events, etc.
| |
| − |
| |
| − | We will then:
| |
| − | # Register the Bound element as an UI element (i.e. a new type of element in the UI).
| |
| − | # Set this element to be a 'child' of machine elements (i.e. Bound will belong to machine files).
| |
| − | # Set up a link to edit expressions of the Bound element in the UI (Bound elements carry one expression [they extend <tt>IExpressionElement</tt>]).
| |
| − | # Set up a link to edit comments of the Bound element in the UI (Bound elements carry one comment [they extend <tt>ICommentedElement</tt>]).
| |
| − |
| |
| − | 1. To register the Bound element in the UI, create an extension 'element':
| |
| − | :- In typeId, specify the ID of the extension Bound in our business plug-in (here <tt>fr.systerel.rodinextension.sample.bound</tt>).
| |
| − | :- In imagePath, you can specify the icon to be displayed next to the element (we created here a folder 'icons' containing an default icon).
| |
| − | :- In prefix, type 'BOUND', this value will appear as the header of bound elements in the structured editor.
| |
| − | :- In 'defaultColumn' field, put the value '0' as to make the Bound element appear at top level in the outline of machines.
| |
| − |
| |
| − | 2. To set Bound element to be a child element of a machine:
| |
| − | :- Create an extension 'childRelation' using the extension point <tt>org.eventb.ui.editorItems</tt>.<br>
| |
| − | :- In ''parentTypeId'' field of this extension, enter "<tt>org.eventb.core.machineFile</tt>" to refer to machine files.<br>
| |
| − | :- Create a sub element for the child relation extension<br>
| |
| − | :- and refer to the ID of the bound in our business class (here <tt>fr.systerel.rodinextension.sample.bound</tt>).<br>
| |
| − | :- Put a priority of '65' to display Bound elements after ''variants'' but before ''events''. (Have a look at the ''childRelation'' for <tt>org.eventb.core.machineFile</tt> type in extension <tt>org.eventb.ui.editorItems</tt> of the package <tt>org.eventb.ui</tt> to view the priorities of other elements displayed in the structured editor).
| |
| − |
| |
| − | 3. To set up a link to edit the expression of a Bound element:
| |
| − | :- Create an extension ''attributeRelation'' for our elementTypeId <tt>fr.systerel.rodinextension.sample.bound</tt>.
| |
| − | :- Add one ''attributeReference'' to <tt>org.eventb.ui.expression</tt> (descriptionID).
| |
| − |
| |
| − | 4. To set up a link to edit the comment of a Bound element:
| |
| − | :- Repeat addition of an ''attributeReference'' to the above ''attributeRelation'' but specifying <tt>org.eventb.ui.expression</tt> as descriptionID.
| |
| − |
| |
| − | You can now launch a Rodin product with our plug-ins imported and see the result:
| |
| − |
| |
| − | [[Image:Extend_Rodin_Tuto_1_8_Used_ExtensionsExtended_UI.png]]
| |
| − |
| |
| − | Congratulations! You are now able to edit the elements you added in Rodin Database.
| |
| − |
| |
| − | {{Navigation|Previous= [[Extend_Rodin_database_(How_to_extend_Rodin_Tutorial)|Extending the database]] | Next= [[Extend_Rodin_EventB_Explorer(How_to_extend_Rodin_Tutorial)|Adding elements to the Event-B explorer]] | Up= [[Plug-in_Tutorial|How to extend Rodin Tutorial (Index)]]}}
| |
| − |
| |
| − | [[Category:Developer documentation|*Index]]
| |
| − | [[Category:Rodin Platform|*Index]]
| |
| − | [[Category:Tutorial|*Index]]
| |
