Difference between pages "Extending the Pretty Print Page" and "Extending the Rodin Pretty Print Page (How to extend Rodin Tutorial)"

From Event-B
(Difference between pages)
Jump to navigationJump to search
imported>Tommy
m
 
imported>Tommy
m
 
Line 1: Line 1:
{{TOCright}}
+
{{Navigation|Previous= [[Extending_the_Rodin_Event-B_Explorer_(How_to_extend_Rodin_Tutorial)]] | Up= [[Plug-in_Tutorial|How to extend Rodin Tutorial (Index)]] | Next= }}
The Petty Print Page of the [[Modelling User Interface|Event-B Editor]] provides a rendered view of an edited machine or context, for an quicker and easier reading.
 
  
[[Image:PrettyPrintPage.png|480px|center|An example of pretty print page]]
+
=== In this part ===
  
As a mechanism is available to extend Rodin's Structured Editor, such a mechanism also exists in order to extend the Pretty Print Page. For each element to be displayed, a "pretty printer" is defined within the element extension of the structured editor.
+
As this extension mechanism is detailed on a dedicated page of the wiki, we will here comment the implementation of a pretty printer for the bound elements. Unfortunately, it is not yet possible to act on the pretty print of events, so the probabilistic will not be displayed here.
  
We will have a look at :
+
See here for the detailed documentation : [[Extending_the_Pretty_Print_Page| Extending the Pretty print Page]]
  
* how the extensions can contribute to the pretty print page,
+
=== Step1 ===
 +
Go back to the element extension for the bound element <tt>fr.systerel.rodinextension.sample.bound</tt> that we previously created from the <tt>org.eventb.ui.editorItems</tt> extension point.
 +
Create a new class that will implement the pretty printer for the bound element, using the eclipse new class wizard as in the picture below.
  
* how the pretty print page is created,
+
[[Image:Extend_Rodin_Tuto_1_11_Add_PrettyPrinter.png]]
  
* how to implement pretty printers.
+
=== Step2 ===
  
== How to contribute to the Pretty Print Page ==
+
Edit this class as following :
  
When contributing to the Event-B Editor, one uses the extension point <tt>org.eventb.ui.editorItems</tt>.
+
public class BoundPrettyPrinter extends DefaultPrettyPrinter {
This extension point defines extensions from which two of them have been updated in order to contribute to the pretty print page.
+
 
+
private static final String BOUND_EXPRESSION = "variantExpression";
Those updated extensions are :
+
private static final String BOUND_EXPRESSION_SEPARATOR_BEGIN = null;
* <tt>element</tt>
+
private static final String BOUND_EXPRESSION_SEPARATOR_END = null;
:<tt>element</tt> has been extended with a child called <tt>prettyPrinter</tt> where the name of the class that will be used to pretty print the element in the pretty print view shall be given. This class must moreover implement <tt>org.eventb.ui.IElementPrettyPrinter</tt>.
+
   
 
+
@Override
* <tt>childRelation</tt>
+
public void prettyPrint(IInternalElement elt, IInternalElement parent, IPrettyPrintStream ps) {
:the child element <tt>childType</tt> of a <tt>childRelation</tt> has been extended with <tt>implicitChildProvider</tt> where the name of the class that will be used to retrieve implicit children of this type in the pretty print view shall be given. The class must moreover implement <tt>org.eventb.ui.IImplicitChildProvider</tt>.
+
if (elt instanceof IBound) {
 
+
IBound bound = (IBound) elt;
Hence, one that wants to contribute to the pretty print page for added items, must at least provide a <tt>prettyPrinter</tt> for each of those added items, and if needed, an <tt>implicitChildProvider</tt>, that will harvest the implicit children of the given type that should also be displayed.
+
try {
 
+
appendBoundExpression(ps,wrapString(bound.getExpressionString()));
Note: if editor items are defined without such extensions, the added items will simply not appear on the pretty print page.
+
} catch (RodinDBException e) {
 
+
System.err.println("Cannot get the expression string for the bound element."+ e.getMessage());
== How the Pretty Print Page is created ==
+
}
 
+
}
In this part, we will discribe the core algorithm for pretty printing (we will use the term "core pretty printer" to refer to this piece of code in the pretty print process).
+
}
The core algorithm starts on the root element (such as a context or a machine) and displays its related informations. Then in a recursive loop, it traverses all sub-elements and pretty print them.
+
 
+
private static void appendBoundExpression(IPrettyPrintStream ps, String expression) {
Here is the corresponding algorithm in charge of sub-elements pretty print:
+
    ps.appendString(expression, //
 
+
      getHTMLBeginForCSSClass(BOUND_EXPRESSION, //
<tt>
+
                              HorizontalAlignment.LEFT, //
''traverse(Element parent)''
+
                              VerticalAlignement.MIDDLE),//
  begin
+
      getHTMLEndForCSSClass(BOUND_EXPRESSION, //
  for all ContributionType c in parent.getChildTypes()
+
                              HorizontalAlignment.LEFT, //
  do
+
                              VerticalAlignement.MIDDLE),//
    appendPrefixOrSpecialPrefix(c)
+
                              BOUND_EXPRESSION_SEPARATOR_BEGIN, //
    for each Element e in parent.elementsOfType(c)
+
                              BOUND_EXPRESSION_SEPARATOR_END);
    do
+
}
        '''IElementPrettyPrinter p = e.getPrettyPrinter();'''
+
        '''p.prettyPrint(e, parent);'''
 
        p.appendItemBeginning(e); // Used to print attributes or additional info
 
        //recursive traverse to continue pretty printing child elements
 
        ''traverse(e);''
 
        p.appendItemEnding(e); // Used to print attributes or additional info
 
    od
 
  od
 
  end
 
</tt>
 
 
 
As one can see, reading this algorithm, the main method that one should implement to pretty print added items is the <tt>prettyPrint</tt> method.
 
 
 
Once all defined items are contributed to the structured editor, they should normally have if needed :
 
* a prefix, that will be appended once for all elements of this type,
 
* a childrenSuffix, that will be appended at the end of all elements of this type.
 
 
 
The pretty printing algorithm will handle those values if no special prefix is defined by an element pretty printer.
 
 
 
In fact, one that implements the interface for pretty printing <tt>IElementPrettyPrinter</tt> will be able to define a pretty printing method, but also auxiliary methods to tune the way elements are displayed on the Pretty Print Page.
 
 
 
'''''There are 4 methods one can implement defining a pretty printer for an element :'''''
 
 
 
<tt>
 
void prettyPrint(IInternalElement elt, IInternalElement parent, IPrettyPrintStream ps);
 
::(Required)This method appends the string corresponding to the pretty print of the element elt.
 
 
 
boolean appendSpecialPrefix(IInternalElement parent, String defaultPrefix, IPrettyPrintStream ps, boolean empty);
 
::(Optional)This method appends a custom prefix, and should be used to replace the default prefix which is contributed, to be appended. It shall return true to tell the core pretty printer that a special prefix was appended, so it avoids to append the default one.
 
 
 
void appendBeginningDetails(IInternalElement elt, IPrettyPrintStream ps);
 
::(Optional)This methods appends some details that contributors can calculate on a given element, and for which there is not representation in the data model. This method appends details before traversing the children of the given element elt, but right after having pretty printed the element elt.
 
 
 
void appendEndingDetails(IInternalElement elt, IPrettyPrintStream ps);
 
::(Optional)This method appends some details that contributors can calculate on a given element, and for which there is no representation in the data model. This method appends details after having traversed the children of the given element elt (i.e. right after having pretty printed the children of element elt).
 
 
 
</tt>
 
 
 
NOTE : comments (viewed as attributes) are however displayed by the core pretty print algorithm, which is not the case for other attributes.(see [[#Append element attributes or details]])
 
 
 
== How to implement pretty printers (of Event-B Editor contributions) ==
 
 
 
In this part we will study concrete examples, to show how the core pretty printer is extended by contributions.
 
 
 
The pretty print page displays an HTML page. This page '''is dynamically built''' by the core pretty printer and constructed '''in a stream''' represented as an <tt>IPrettyPrintStream</tt>. As contributions define pretty printers for each element they want to display, it is needed for them to append their information in HTML language, to the stream that represents the HTML page.
 
Fortunately, the pretty printer extension mechanism comes out with a bunch of methods available from <tt>org.eventb.ui.prettyprint.PrettyPrintUtils</tt> and others from <tt>IPrettyPrintStream</tt> or <tt>PrettyPrintAlignments</tt> in the same package <tt>org.eventb.ui.prettyprint</tt>, in order to isolate and hide (to reduce complexity), the way the HTML page is produced.
 
In fact, '''contributors should not write any HTML code themselves,'''to prevent any page structure breackage.
 
 
 
Contributors have to :
 
* create one or more CSS class(es) for each element they want to pretty print, contributing to <tt>style.css</tt> file in the folder org.eventb.ui.html,
 
* use the utility methods from <tt>IPrettyPrintStream</tt> or <tt>org.eventb.ui.prettyprint.PrettyPrintUtils</tt> to access them.
 
----
 
=== Implementation of a simple pretty printer===
 
Let's study the implementation of the CarrierSetsPrettyPrinter.
 
This pretty printer is available in the package <tt>org.eventb.internal.ui.eventbeditor.prettyprinters</tt>.
 
 
 
[[Image:Variables prettyPrint.png]]
 
 
 
The display wanted is described by the picture above, and the corresponding implementation is the following :
 
 
 
First we want to define only the pretty print method, as no special prefix is wanted but the keyword "VARIABLES" which is already defined in the contribution for variables (see the <tt>element</tt> extension for variables using extension point <tt>org.eventb.ui.editorItems</tt>), as well as no details is needed at the beginning or ending of a displayed variable. That's why we choose here to extend the <tt>DefaultPrettyPrinter</tt>
 
  public class VariablesPrettyPrinter extends DefaultPrettyPrinter implements IElementPrettyPrinter {..}
 
and override only the <tt>prettyPrint</tt> method which is the following :
 
       
 
@Override
 
public void prettyPrint(IInternalElement elt, IInternalElement parent, IPrettyPrintStream ps) {
 
    if (elt instanceof IVariable) {
 
        IVariable var = (IVariable) elt;
 
        try {
 
          appendVariableIdentifier(ps, wrapString(var.getIdentifierString()));
 
        } catch (RodinDBException e) {
 
          EventBEditorUtils.debugAndLogError(e,"Cannot get the identifier string for variable "+var.getElementName());
 
        }
 
    }
 
}
 
 
 
where we build the HTML string in the static method <tt>appendVariableIdentifier(ps, wrapString(var.getIdentifierString()));</tt> defined below :
 
private static void appendVariableIdentifier(IPrettyPrintStream ps, String identifier) {
 
    ps.appendString(identifier, //
 
      getHTMLBeginForCSSClass(VARIABLE_IDENTIFIER, //
 
                              HorizontalAlignment.LEFT, //
 
                              VerticalAlignement.MIDDLE),//
 
      getHTMLEndForCSSClass(VARIABLE_IDENTIFIER, //
 
                              HorizontalAlignment.LEFT, //
 
                              VerticalAlignement.MIDDLE),//
 
      VARIABLE_IDENTIFIER_SEPARATOR_BEGIN, //
 
      VARIABLE_IDENTIFIER_SEPARATOR_END);
 
 
  }
 
  }
  
We can see here that the HTML is built with the <tt>IPrettyPrintStream</tt> method <tt>appendString()</tt> and that we retrieve the CSS class for variables by defining a constant
+
As we want only to display the expression hold by the Bound element, we extend here <tt>org.eventb.ui.prettyprint.DefaultPrettyPrinter</tt> to avoid implementing unsued methods from the <tt>IElementPrettyPrinter</tt> interface. In fact, what we need here is only to implement the method <tt>prettyPrint(IInternalElement elt, IInternalElement parent, IPrettyPrintStream ps)</tt>.
private static final String VARIABLE_IDENTIFIER = "variableIdentifier";
 
 
 
and using the methods <tt>getHTMLBeginForCSSClass()</tt> and <tt>getHTMLEndForCSSClass()</tt> to retrieve the HTML/CSS code
 
as the class is defined in the <tt>style.css</tt> file by :
 
.variableIdentifier {font-size:16px; color:black;font-family:"Brave Sans Mono";}
 
 
 
HTML alignments are retrieved using the enumerations from <tt>org.eventb.ui.prettyprint.PrettyPrintAlignments</tt> and <tt>VARIABLE_IDENTIFIER_SEPARATOR_BEGIN</tt> and <tt>VARIABLE_IDENTIFIER_SEPARATOR_END</tt> are constants which are set to <tt>null</tt> as there is no element information after a variable identifier to display.
 
----
 
===Overriding the contributed prefix===
 
 
 
Now let's look at a special case of prefix overriding to show how we can prevent the core pretty printer to append the default one to the Pretty Print Page.
 
 
 
[[Image:GuardWhereWhen.png]]
 
 
 
The figure above shows that we display the special keyword "WHEN" instead of "WHERE", the default one, when no parameters are bound to the event, and there are guards.
 
 
 
We will then implement the method <tt>appendSpecialPrefix()</tt> in the guard pretty printer class as the following :
 
@Override
 
  public boolean appendSpecialPrefix(IInternalElement parent, String defaultKeyword, IPrettyPrintStream ps, boolean empty) {
 
    if (empty) {
 
        return false;
 
    }
 
    try {
 
        final List<IParameter> params = UIUtils.getVisibleChildrenOfType(parent, IParameter.ELEMENT_TYPE);
 
          if (params.size() == 0) {
 
              ps.appendKeyword("WHEN");
 
          } else {
 
              ps.appendKeyword(defaultKeyword);
 
          }
 
    } catch (RodinDBException e) {
 
      EventBEditorUtils.debugAndLogError(e, "Cannot get all guards of " + parent.getElementName());
 
    }
 
    return true;
 
  }
 
 
 
This method implements a specific behaviour and prints the keyword WHEN as if the core pretty printer did, using the method <tt>appendKeyword()</tt> from IPrettyPrintStream.
 
It is important to note that if WHEN is appended, the '''method returns <tt>true</tt>''' to prevent the core pretty printer to append the keyword WHERE.
 
----
 
===Append element attributes or details===
 
 
 
This section explains how to append attribute or any other information to the HTML stream.
 
 
 
It has been chosen to not traverse element attributes the same way as elements. The main reason motivating this, is that contributor are free to define their one semantics for the presence or absence of attributes defined for an element. A contributor also might want to tune the pretty print its own way by displaying additional informations that could be calculated on the traversed element.
 
The responsability of pretty printing them, is then let to him.
 
Consequently, two methods are provided by the <tt>IElementPrettyPrinter</tt> interface, in order to display such informations :
 
 
 
void appendBeginningDetails(IInternalElement elt, IPrettyPrintStream ps);
 
void appendEndingDetails(IInternalElement elt, IPrettyPrintStream ps);
 
 
 
<tt>appendBeginningDetails()</tt> will be called by the core pretty printer, before invoking the <tt>prettyPrint()</tt> method (taking place in the core algorithm above in <tt>p.appendItemBeginning(e);</tt> [[#How the Pretty Print Page is created|see core pretty print algorithm]]).
 
 
 
<tt>appendEndingDetails()</tt> will be called by the core pretty printer, after invoking the <tt>prettyPrint()</tt> method (taking place in the core algorithm above in <tt>p.appendItemEnding(e);</tt>[[#How the Pretty Print Page is created|see core pretty print algorithm]]).
 
 
 
====Example of events pretty printer====
 
As an extension <tt>attributionRelation</tt> for events has been defined. The events contain attributes <tt>extended</tt> and <tt>convergence</tt> (see the picture below).
 
  
[[Image:EventsAttributes.png]]
+
This method has to check that the handled element is a bound (e.g. instanceof <tt>IBound</tt>) and then display the embedded expression string. We created a dedicated method to append the expression in the pretty print stream, and used the pretty print helpers methods that are provided by <tt>org.eventb.ui.prettyprint.PrettyPrintUtils</tt> using the following static imports :<br>
 
+
:<tt>import static org.eventb.ui.prettyprint.PrettyPrintUtils.getHTMLBeginForCSSClass;</tt>
We will then implement the method <tt>appendBeginningDetails()</tt> of the interface <tt>IElementPrettyPrinter</tt> to display those attributes before the children of an event are traversed.
+
:<tt>import static org.eventb.ui.prettyprint.PrettyPrintUtils.getHTMLEndForCSSClass;</tt>
+
:<tt>import static org.eventb.ui.prettyprint.PrettyPrintUtils.wrapString;</tt>
@Override
 
  public void appendBeginningDetails(IInternalElement elt, IPrettyPrintStream ps) {
 
  final IEvent evt = elt.getAncestor(IEvent.ELEMENT_TYPE);
 
    appendExtended(evt, ps);
 
    appendConvergence(evt, ps);
 
}
 
  
Where <tt>appendConvergence(IEvent evt, IPrettyPrintStream ps)</tt> is defined as :
+
The only trick here, was to use the same diplay as the one used by variants using <tt>private static final String BOUND_EXPRESSION = "variantExpression";</tt>. Doing so, we reuse the CSS class that is defined for variant expressions. There are many pre-defined CSS classes for the Event-B language elements. To review them, go to the file <tt>html/style.css</tt> in the plugin <tt>org.eventb.ui</tt>.
private static void appendConvergence(IEvent evt, IPrettyPrintStream ps) {
 
  try {
 
    Convergence convergence = evt.getConvergence();
 
    ps.appendLevelBegin();
 
    ps.appendKeyword("STATUS");
 
    appendConvergence(ps, convergence);
 
    ps.appendLevelEnd();
 
  } catch (RodinDBException e) {
 
    // Do nothing
 
  }
 
}
 
  
and where <tt>appendConvergence(ps, convergence)</tt> is defined as <tt>appendVariableIdentifier(IPrettyPrintStream ps, String identifier)</tt> described in the section [[#Implementation of a simple pretty printer]] above :
+
Here is the result you should get :
private static void appendConvergence(IPrettyPrintStream ps, Convergence convergence) {
 
  String string = "ordinary";
 
  if (convergence == Convergence.ORDINARY) {
 
    string = "ordinary";
 
  } else if (convergence == Convergence.ANTICIPATED) {
 
    string = "anticipated";
 
  } else if (convergence == Convergence.CONVERGENT) {
 
    string = "convergent";
 
  }
 
    ps.appendLevelBegin();
 
    ps.appendString(string, getHTMLBeginForCSSClass(CONVERGENCE, HorizontalAlignment.LEFT, VerticalAlignement.MIDDLE), //
 
                            getHTMLEndForCSSClass(CONVERGENCE, HorizontalAlignment.LEFT, VerticalAlignement.MIDDLE), //
 
                            BEGIN_CONVERGENCE_SEPARATOR, //
 
                            END_CONVERGENCE_SEPARATOR);
 
    ps.appendLevelEnd();
 
}
 
  
We use here the methods <tt>ps.appendLevelBegin()</tt> and <tt>ps.appendLevelEnd()</tt> for a finer grain control of the indentation in the HTML output.
+
[[Image:Extend_Rodin_Tuto_1_12_PrettyPrint_for_BoundElement.png|400px]]
Two additional methods from the <tt>IPrettyPrintStream</tt> interface, can be used to control the level of indentation :
 
*<tt>incrementLevel()</tt> : increments the level of indentation hold by the pretty print stream,
 
*<tt>decrementLevel()</tt> : decrements the level of indentation hold by the pretty print stream.
 
  
We finally obtain the following display, here for the initialisation of a sample refinement :
+
{{Navigation|Previous= [[Extending_the_Rodin_Event-B_Explorer_(How_to_extend_Rodin_Tutorial)]] | Up= [[Plug-in_Tutorial|How to extend Rodin Tutorial (Index)]] | Next= }}
  
[[Image:ExtendedConvergence.png]]
+
[[Category:Developer documentation|*Index]]
----
+
[[Category:Rodin Platform|*Index]]
 +
[[Category:Tutorial|*Index]]

Revision as of 09:53, 24 August 2010

In this part

As this extension mechanism is detailed on a dedicated page of the wiki, we will here comment the implementation of a pretty printer for the bound elements. Unfortunately, it is not yet possible to act on the pretty print of events, so the probabilistic will not be displayed here.

See here for the detailed documentation : Extending the Pretty print Page

Step1

Go back to the element extension for the bound element fr.systerel.rodinextension.sample.bound that we previously created from the org.eventb.ui.editorItems extension point. Create a new class that will implement the pretty printer for the bound element, using the eclipse new class wizard as in the picture below.

Extend Rodin Tuto 1 11 Add PrettyPrinter.png

Step2

Edit this class as following :

public class BoundPrettyPrinter extends DefaultPrettyPrinter {

	private static final String BOUND_EXPRESSION = "variantExpression";
	private static final String BOUND_EXPRESSION_SEPARATOR_BEGIN = null;
	private static final String BOUND_EXPRESSION_SEPARATOR_END = null;

	@Override
	public void prettyPrint(IInternalElement elt, IInternalElement parent, IPrettyPrintStream ps) {
		if (elt instanceof IBound) {
			IBound bound = (IBound) elt;
			try {
				appendBoundExpression(ps,wrapString(bound.getExpressionString()));
			} catch (RodinDBException e) {
				System.err.println("Cannot get the expression string for the bound element."+ e.getMessage());
			}
		}
	}
	
	private static void appendBoundExpression(IPrettyPrintStream ps, String expression) {
	    ps.appendString(expression, //
	      getHTMLBeginForCSSClass(BOUND_EXPRESSION, //
	                              HorizontalAlignment.LEFT, //
	                              VerticalAlignement.MIDDLE),//
	      getHTMLEndForCSSClass(BOUND_EXPRESSION, //
	                              HorizontalAlignment.LEFT, //
	                              VerticalAlignement.MIDDLE),//
	                              BOUND_EXPRESSION_SEPARATOR_BEGIN, //
	                              BOUND_EXPRESSION_SEPARATOR_END);
	}

}

As we want only to display the expression hold by the Bound element, we extend here org.eventb.ui.prettyprint.DefaultPrettyPrinter to avoid implementing unsued methods from the IElementPrettyPrinter interface. In fact, what we need here is only to implement the method prettyPrint(IInternalElement elt, IInternalElement parent, IPrettyPrintStream ps).

This method has to check that the handled element is a bound (e.g. instanceof IBound) and then display the embedded expression string. We created a dedicated method to append the expression in the pretty print stream, and used the pretty print helpers methods that are provided by org.eventb.ui.prettyprint.PrettyPrintUtils using the following static imports :

import static org.eventb.ui.prettyprint.PrettyPrintUtils.getHTMLBeginForCSSClass;
import static org.eventb.ui.prettyprint.PrettyPrintUtils.getHTMLEndForCSSClass;
import static org.eventb.ui.prettyprint.PrettyPrintUtils.wrapString;

The only trick here, was to use the same diplay as the one used by variants using private static final String BOUND_EXPRESSION = "variantExpression";. Doing so, we reuse the CSS class that is defined for variant expressions. There are many pre-defined CSS classes for the Event-B language elements. To review them, go to the file html/style.css in the plugin org.eventb.ui.

Here is the result you should get :

Extend Rodin Tuto 1 12 PrettyPrint for BoundElement.png