Papyrus Developer Guide/Papyrus diagram generation

From Eclipsepedia

Jump to: navigation, search

Papyrus editor add some new features to GMF, and needs specific generation. Here is a little guide explaining how to deal with the Papyrus generation stuff.

Contents

How to generate a diagram for Papyrus

The generation has to be run in a runtime application.

Setup your runtime application

It is strongly recommended to setup your runtime application before running a generation in order to avoid Java Heap Space error.

In the Run configuration menu, you can

  • Add specific vm arguments (-Dosgi.requiredJavaVersion=1.5 -XX:MaxPermSize=256M -Xms40m -Xmx512m -XX:PermSize=64M):

Capture-Run Configurations.gif

  • Use the arguments define in a *.ini file (for instance the eclipse.ini of your Eclipse)

Capture-Run Configurations Configuration.gif

Import the required project

You will need to import from your workspace the following project into your runtime application (do not copy them) :

  • org.eclipse.papyrus.codegen
  • org.eclipse.papyrus.def
  • the plugin of the diagram you will generate (like org.eclipse.papyrus.diagram.clazz)

Update the GMFGen

In your GMFGen, you have to update two properties to take into account the specific Papyrus templates. In the node GenEditor of your gmfgen files, you have to setup the following properties :
Dynamic Templates to true
Template Directory to /org.eclipse.papyrus.def/dynamic-templates3.5/codegen

Run the generation

To run the transformation, rigth click on your gmfgen file and select the menu Generate Papyrus Diagram.

How to add your own template to the custom Papyrus generator

To add a new template to the mechanism of generation, you have to :

  1. Add your template xpt to the plugin org.eclipse.papyrus.def under a subfolder of "dynamic-templates3.5/codegen/xpt"
  2. In the plugin org.eclipse.papyrus.codegen, edit the class org.eclipse.papyrus.codegen.PapyrusCodegenEmitters by adding a get method for your template :
public TextEmitter getyourTemplateNameEmitter() {
return newXpandEmitter("xpt::yourTemplatePath::yourTemplateName::yourStartingDefine"); //$NON-NLS-1$
}

where
yourTemplateName is the name of your template
yourTemplatePath is the path to access to your template from the folder xpt. Subfolder has to be separated by ::
yourStartingDefine the define that will start the generation

  1. Edit the class org.eclipse.papyrus.codegen.PapyrusGenerator
  2. Add a method generateXXXPage() :
private void generateDiagramPreferencePage() throws InterruptedException, UnexpectedBehaviourException {
doGenerateJavaClass(emitters.getyourTemplateNameEmitter(), PackageName,
ClassName, Input);
}

where
getyourTemplateNameEmitter() : is the new TextEmitter defined before
PackageName : is the name of the package the class will be contained in. It has to match with the one specified in the template.
ClassName : is the name of the class. It has to match with the one defined in the template.
Input : is the input element. It has to match with the type defined with FOR in your first xpt define.

  1. Call this method in the method customRun().


You just now have to run your transformation as explained before in this page. Be careful to refresh your projects in your runtime application if you generate in this mode.

Papyrus Extension Root Node Description

TODO


Compartment Visibility Preference

Description : This extension allows to define the default visibility for the compartments. The compartments not referenced by this node are visible by default.

Fields for this node:

  • Comment : a comment
  • Visible By Default : true or false, allows to define the visibility preference for the compartments

Warning : Often you have the same preference page for Top Node and Child Node, in this case, you should define your preference for the top node. Currently, we generate in first the Child Node Preference Page, then the Top Node Preference Page erases the Child Node Preference Page.

Compartment Title Visibility Preference

Description : This extension allows to define the default visibility for the titles of compartments. The titles not referenced by this node are visible by default.

Fields for this node:

  • Comment : a comment
  • Visible By Default : true or false, allows to define the visibility preference for the compartments titles

Warning : Often you have the same preference page for Top Node and Child Node, in this case, you should define your preference for the top node. Currently, we generate in first the Child Node Preference Page, then the Top Node Preference Page erases the Child Node Preference Page.

Label Visibility Preference

Description : This extension is used to define the default visibility for the labels (Connection Labels and External Node Labels). The information provided by this node are used in two ways :

  • Define which label should be hidden after the element creation (Preference Page)
  • Provide the role of the label in the Manage Labels dialog.

Fields for this node:

  • Comment : a comment
  • External Node Label : the list of the external node labels which have the specified role
  • Icon Path Role : an icon to illustrate the role of the label
  • Link Labels : the list of the link labels which have the specified role
  • Role : the role of the referenced labels
  • Visible By Default : true or false, allows to define the preference for the labels

The LabelEditPart referenced by the Label Role Node implements the interface ILabelRoleProvider.


Warning with the Preferences Pages : for example, Association can be represented in 3 ways in the Class Diagram :

  • Association link
  • AssociationBranch link
  • Association node

Currently the value of the field "Display Name" of these nodes in the genModel, is "Association". Now, we need to have 2 preferences pages (one for link and one for node). Concerning AssociationBranch, it should have the same name as AssociationLink, but it should be located before AssociationLink in the genModel.


If you don't use this node :

  • you can't manage the display of the labels in the preferences pages and all labels are visible by default.
  • the dialog to manage the labels works (if you have the correct EditPolicy), but it doesn't display the role.

Examples of usage:

  • Labels Preferences for Association

Label Preferences for Association

  • Labels Manager (if you EditPart provides ShowHideLabelEditPolicy)

LabelManager

How to overwrite existing GMF template

TODO