imported>Laurent |
imported>Andy |
| Line 1: |
Line 1: |
| − | The UI in Rodin 2.x contains an extension point <tt>org.eventb.ui.editorItems</tt> that groups the both following information: | + | == The Theory Plug-in == |
| − | *the definition of elements and attributes and their hierarchy, and the way they are created
| + | The theory plug-in is used to add mathematical extensions to Rodin. The theories are created, and deployed, and can then be used in any models in the workspace. When dealing with implementation level models, such as in Tasking Event-B, we need to consider how to translate newly added types and operators into code. We have augmented the theory interface with a Translation Rules section. This enables a user to define translation rules that map Event-B formulas to code. |
| − | *the information needed to correctly display and edit these elements in the various editors and UI components
| + | === Translation Rules=== |
| | + | Figure 1 shows the interface, and some translations rules of the mapping to Ada. |
| | | | |
| − | It appears obvious that the first information should be defined from an extension that belongs to the Database.
| + | <div id="fig:Translation Rules"> |
| − | To fullfil the above statement, the current extension point <tt>org.eventb.ui.editorItems</tt> should be split in two.
| + | <br/> |
| − | The existing extension point was also heterogenous. Indeed, whereas the element relationships were concerning element types, the attribute relationship were concerning element types and references to UI defined attributes (referring to core attributes).<br>
| + | [[Image:TheoryCGRules.png|center||caption text]] |
| − | There is no need for such an indirection.
| + | <center>'''Figure 1''': Translation Rules</center> |
| | + | <br/> |
| | + | </div> |
| | | | |
| − | ----
| + | The translation rules are templates used for pattern matching. The meta-variables are defined and typed, and used in the rules. Event-B expressions and predicates are defined on the left hand side of the rule, and the code to be output (as text) appears on the right hand side of the matching rule. |
| − | The proposal should concern : | |
| − | A - Relationship declaration (new extension point)
| |
| − | B - API to test these relations and traverse them
| |
| − | C - Enforcement of the authorized relations when modifying the DB
| |
| − | D - Behaviour while loading a file (including a file with invalid parent-child relations occurrences)
| |
| − | E- What about the compatibilty with the file upgrade mechanism?
| |
| − | ----
| |
| − | | |
| − | = Some identified difficulties =
| |
| − | | |
| − | == Initialization of elements from non UI components ==
| |
| − | | |
| − | The following ElementDescRegistry method, shows the dependency between an element creation and the initialization of its attributes with default values.
| |
| − | | |
| − | public <T extends IInternalElement> T createElement(
| |
| − | final IInternalElement root, IInternalElement parent,
| |
| − | final IInternalElementType<T> type, final IInternalElement sibling)
| |
| − | throws RodinDBException {
| |
| − | final T newElement = parent.createChild(type, sibling, null);
| |
| − | final IAttributeDesc[] attrDesc = getAttributes(type);
| |
| − | for (IAttributeDesc desc : attrDesc) {
| |
| − | desc.getManipulation().setDefaultValue(newElement, null); // <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
| |
| − | }
| |
| − | return newElement;
| |
| − | }
| |
| − | | |
| − | The protocol shall be changed to take into account this initialization outside from the graphical manipulation. | |
| − | Doing the initialization at org.eventb.core level is possible by registering a special "attribute initializer". <br>
| |
| − | WARNING : Only "choice" attributes can be marked as mandatory ({{ident|required}} attribute of the extension). Can't it be available for all kind of attributes?
| |
| − | | |
| − | == Correspondence between UI manipulation and "core" elements ==
| |
| − | If some element or attribute relationship is declared at the database level, but there is no corresponding {{ident|editorItem}} for it, it will be ignored by the UI. This is similar to the previous situation where some elements or attributes could be present in the database but not in the user interface hierarchy.
| |
| − | | |
| − | == Operation on elements shall be enforced ==
| |
| − |
| |
| − | private <T extends IInternalElement> OperationCreateElement getCreateElement(
| |
| − | IInternalElement parent, IInternalElementType<T> type,
| |
| − | IInternalElement sibling, IAttributeValue[] values) {
| |
| − | OperationCreateElement op = new OperationCreateElement(
| |
| − | createDefaultElement(parent, type, sibling));
| |
| − | op.addSubCommande(new ChangeAttribute(values));
| |
| − | return op;
| |
| − | }
| |
| − | | |
| − | ''The Operation model similar to a kind of transaction mechanism, should be made available from the DB layer.''<br>
| |
| − | ''The relations when using such layer shall be enforced and any invalid operation could be rejected.''
| |
| − | | |
| − | = Proposal =
| |
| − | | |
| − | == Hierarchy between elements ==
| |
| − | | |
| − | The part concerning element definition and hierarchy will go to a dedicated extension point in the database.
| |
| − | | |
| − | === A - hierarchy definition ===
| |
| − | | |
| − | Here is the definition of the new extension point : org.rodinp.core.itemRelations which describes the possible children and attributes of internal elements.
| |
| − | | |
| − | Configuration Markup:
| |
| − | <!ELEMENT extension (relationship+)>
| |
| − | <!ATTLIST extension
| |
| − | point CDATA #REQUIRED
| |
| − | id CDATA #IMPLIED
| |
| − | name CDATA #IMPLIED
| |
| − | >
| |
| − |
| |
| − | <!ELEMENT relationship ((childType | attributeType)+)>
| |
| − | <!ATTLIST elementRelationship
| |
| − | parentTypeId CDATA #REQUIRED
| |
| − | >
| |
| − | parentTypeId - Element type of the parent, must be the unique ID of a Rodin internal element type (see extension point org.rodinp.core.internalElementTypes).
| |
| − |
| |
| − | <!ELEMENT childType EMPTY>
| |
| − | <!ATTLIST childType
| |
| − | typeId CDATA #REQUIRED
| |
| − | >
| |
| − | typeId - Element type of the child, must be the unique ID of a Rodin internal element type (see extension point org.rodinp.core.internalElementTypes).
| |
| − |
| |
| − | <!ELEMENT attributeType EMPTY>
| |
| − | <!ATTLIST attributeType
| |
| − | typeId CDATA #REQUIRED
| |
| − | >
| |
| − | attributeTypeId - Id of the Rodin attribute type to which this description applies (see extension point org.rodinp.core.attributeTypes).
| |
| − |
| |
| − | The use of such extension point is obvious in org.eventb.core plug-in, as it would complement the extensions of org.rodinp.core.attributeTypes and org.rodinp.core.internalElementTypes.
| |
| − | | |
| − | === B - API to declare and test the element/attribute relations and traverse them ===
| |
| − | | |
| − | The API of the Rodin database is extended as follows:
| |
| − | | |
| − | * interface IInternalElementType is extended with methods
| |
| − | | |
| − | IInternalElementType<?>[] getParentTypes();
| |
| − | IInternalElementType<?>[] getChildTypes();
| |
| − | IAttributeType[] getAttributeTypes();
| |
| − | | |
| − | boolean canParent(IInternalElementType<?> childType);
| |
| − | boolean isElementOf(IAttributeType attrType);
| |
| − | | |
| − | * interface IAttributeType is extended with methods
| |
| − | | |
| − | IInternalElementType<?>[] getElementTypes();
| |
| − | | |
| − | boolean isAttributeOf(IInternalElementType<?> elementType);
| |
| − | | |
| − | This list might be later extended with new methods such as
| |
| − | {{ident|isAncestorOf}} if this proves useful.
| |
| − | | |
| − | === C - Data model operations (enforced) ===
| |
| − | The ElementManipulationFacade, support for modifications over the Database, should be provided by the Event-B Core plug-in.<br>
| |
| − | The IAttributeManipulation interface should be also provided by the Event-B Core plug-in as it concerns the manipulation done on the attribute in the DB.
| |
| − | | |
| − | The information about the rendering of an element or an attribute, should not be deduced from the attribute itself (e.g. choiceAttribute vs. toggleAttribute vs. textAttribute), it should be given in the UI.
| |
| − | | |
| − | It seems that the ElementManipulationFacade can be used as protocol, but hiercharchy between elements and elements, or between elements and attributes shall be enforced.
| |
| − | ''Proposition : add Exceptions to methods of the protocol.''
| |
| − | | |
| − | == UI related information ==
| |
| − | The part concerning how to display elements and UI related info will stay in the editorItems extension point and shall point to an element definition and hierachy.<br>
| |
| − | Relationships will disappear from the editorItems extension point.
| |
| − | | |
| − | The interfaces are refactored to become the following :
| |
| − | | |
| − | ''NB. IITemDesc disappears as it is cumbersome to provide such interface for a sole method getPrefix(). ''
| |
| − | | |
| − | public interface IUIElementDesc extends IItemDesc {
| |
| − |
| |
| − | public String getPrefix();
| |
| − |
| |
| − | public String getChildrenSuffix();
| |
| − |
| |
| − | public IImageProvider getImageProvider();
| |
| − |
| |
| − | public IAttributeDesc atColumn(int i);
| |
| − |
| |
| − | public int getDefaultColumn();
| |
| − |
| |
| − | public boolean isSelectable(int i);
| |
| − |
| |
| − | public String getAutoNamePrefix();
| |
| − |
| |
| − | public IElementPrettyPrinter getPrettyPrinter();
| |
| − |
| |
| − | }
| |
| − | | |
| − | public interface IUIAttributeDesc extends IItemDesc {
| |
| − |
| |
| − | public String getPrefix();
| |
| − |
| |
| − | public String getSuffix();
| |
| − |
| |
| − | public IEditComposite createWidget();
| |
| − |
| |
| − | public boolean isHorizontalExpand();
| |
| − |
| |
| − | }
| |
| − | | |
| − | === D - Behaviour while loading a file ===
| |
| − | This is including a file with invalid parent-child relations occurrences.
| |
| − | | |
| − | The elements or attributes shall be let in place, and not be displayed.
| |
| − | | |
| − | The test wether a child as an incorrect parent shall be provided, <br>
| |
| − | or if a parent is valid for a given child :<br>
| |
| − | HOW?
| |
| − | | |
| − | > One possibility : checking the relationship from the element desc:
| |
| − | | |
| − | ElementDescRegistry.getElementDesc(element).isValidChildOf(IInternalElement parent);
| |
| − | | |
| − | ElementDescRegistry.getElementDesc(element).isValidParentOf(IInternalElement child);
| |
| − | | |
| − | === E - Compatibility with the upgrade mechanism ===
| |
| − | | |
| − | Things start with the org.rodinp.core.conversion extensions point.<br>
| |
| − | The hierarchy (element/element and element/attributes) is implicit in the extensions,
| |
| − | but does not appear in code.
| |
| − | | |
| − | [[Category:Design_proposal]]
| |
