Extending the Pretty Print Page

The Petty Print Page of the Event-B Editor provides a rendered view of an edited machine or context, for an quicker and easier reading.

An example of pretty print page

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.

We will have a look at :

• how the extensions can contribute to the pretty print page,

• how the pretty print page is created,

• how to implement pretty printers.

How to contribute to the Pretty Print Page

When contributing to the Event-B Editor, one uses the extension point org.eventb.ui.editorItems. This extension point defines extensions from which two of them have been updated in order to contribute to the pretty print page.

Those updated extensions are :

• element

element has been extended with a child called prettyPrinter 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 org.eventb.ui.IElementPrettyPrinter.

• childRelation

the child element childType of a childRelation has been extended with implicitChildProvider 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 org.eventb.ui.IImplicitChildProvider.(see #Display implicit children)

Hence, one that wants to contribute to the pretty print page for added items, must at least provide a prettyPrinter for each of those added items, and if needed, an implicitChildProvider, that will harvest the implicit children of the given type that should also be displayed.

Note: if editor items are defined without such extensions, the added items will simply not appear on the pretty print page.

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.

Here is the corresponding algorithm in charge of sub-elements pretty print:

traverse(Element parent)
 begin
  for all ContributionType c in parent.getChildTypes()
  do
    appendPrefixOrSpecialPrefix(c)
    for each Element e in parent.elementsOfType(c)
    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

As one can see, reading this algorithm, the main method that one should implement to pretty print added items is the prettyPrint 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 IElementPrettyPrinter 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 :

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).

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 IPrettyPrintStream. 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 org.eventb.ui.prettyprint.PrettyPrintUtils and others from IPrettyPrintStream or PrettyPrintAlignments in the same package org.eventb.ui.prettyprint, 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 style.css file in the folder org.eventb.ui.html,
• use the utility methods from IPrettyPrintStream or org.eventb.ui.prettyprint.PrettyPrintUtils 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 org.eventb.internal.ui.eventbeditor.prettyprinters.

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 element extension for variables using extension point org.eventb.ui.editorItems), 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 DefaultPrettyPrinter

public class VariablesPrettyPrinter extends DefaultPrettyPrinter implements IElementPrettyPrinter {..}

and override only the prettyPrint 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 appendVariableIdentifier(ps, wrapString(var.getIdentifierString())); 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 IPrettyPrintStream method appendString() and that we retrieve the CSS class for variables by defining a constant

private static final String VARIABLE_IDENTIFIER = "variableIdentifier";

and using the methods getHTMLBeginForCSSClass() and getHTMLEndForCSSClass() to retrieve the HTML/CSS code as the class is defined in the style.css file by :

.variableIdentifier {font-size:16px; color:black;font-family:"Brave Sans Mono";}

HTML alignments are retrieved using the enumerations from org.eventb.ui.prettyprint.PrettyPrintAlignments and VARIABLE_IDENTIFIER_SEPARATOR_BEGIN and VARIABLE_IDENTIFIER_SEPARATOR_END are constants which are set to null 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.

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 appendSpecialPrefix() 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 appendKeyword() from IPrettyPrintStream. It is important to note that if WHEN is appended, the method returns true 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 IElementPrettyPrinter interface, in order to display such informations :

void appendBeginningDetails(IInternalElement elt, IPrettyPrintStream ps);
void appendEndingDetails(IInternalElement elt, IPrettyPrintStream ps);

appendBeginningDetails() will be called by the core pretty printer, before invoking the prettyPrint() method (taking place in the core algorithm above in p.appendItemBeginning(e); see core pretty print algorithm).

appendEndingDetails() will be called by the core pretty printer, after invoking the prettyPrint() method (taking place in the core algorithm above in p.appendItemEnding(e);see core pretty print algorithm).

Example of events pretty printer

As an extension attributionRelation for events has been defined. The events contain attributes extended and convergence (see the picture below).

We will then implement the method appendBeginningDetails() of the interface IElementPrettyPrinter to display those attributes before the children of an event are traversed.

@Override
 public void appendBeginningDetails(IInternalElement elt, IPrettyPrintStream ps) {
  final IEvent evt = elt.getAncestor(IEvent.ELEMENT_TYPE);
   appendExtended(evt, ps);
   appendConvergence(evt, ps);
}

Where appendConvergence(IEvent evt, IPrettyPrintStream ps) is defined as :

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 appendConvergence(ps, convergence) is defined as appendVariableIdentifier(IPrettyPrintStream ps, String identifier) described in the section #Implementation of a simple pretty printer above :

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 ps.appendLevelBegin() and ps.appendLevelEnd() for a finer grain control of the indentation in the HTML output. Two additional methods from the IPrettyPrintStream interface, can be used to control the level of indentation :

• incrementLevel() : increments the level of indentation hold by the pretty print stream,
• decrementLevel() : 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 :

---

Display implicit children

Finally, one would like to display sometimes, inherited or implicit children. For example, in the pretty print page, we want to see for a given event which is refined, the guards of its abstraction. It is possible to do so, as the core pretty print algorithm define a way by parent.getChildTypes() to retrieve implicit children. An contributor has to define an implicitChildProvider implementing the interface org.eventb.ui.IImplicitChildProvider. This implicitChildProvider takes place in the child element childType of a childRelation defined in the extension point org.eventb.ui.eitorItems.

Let's look at the case of implicit guards. For an Event element extension, an extension childRelation is defined. This extension is used to set which types of elements are children of an Event element. In the guard child type, we defined an implicitChildProvider that will add implicit guards to the ones that are set for the current event implementing

public List<? extends IInternalElement> getImplicitChildren(IInternalElement parent);

where parent is the current IInternalElement owning this childType. In our case here, it is an event.

Some specific CSS classes can be added to display those implicit children (in the guard pretty printer class for our example), so that we obtain this kind of result :

where the CSS classes for implicit guards let them (the guard label and the guard predicate) be displayed in italic.