Skip to main content
Jump to: navigation, search

Difference between revisions of "Papyrus/Papyrus Developer Guide"

(Papyrus extraplugin)
 
(145 intermediate revisions by 16 users not shown)
Line 1: Line 1:
 
== Development Environment  ==
 
== Development Environment  ==
  
To ease the development on Papyrus, each member of the team works with basically the same configuration.
+
To ease the development of Papyrus, each member of the team works with basically the same configuration.
 +
There are two ways to get your development environment:
 +
* downloading and installing Eclipse
 +
* using the [[Eclipse Installer]] (by Oomph) to manage your Papyrus development workbench.
  
By far the easiest way to manage this is using the [[Eclipse Oomph Installer]] to manage your Papyrus development workbench.
+
=== Java Version ===
 +
OpenJDK 11 (or higher) is recommended.
 +
 
 +
=== Downloading Eclipse ===
 +
You can download a fresh Eclipse Package release on this [https://www.eclipse.org/downloads/packages/ page].
 +
We advise you to download the Eclipse Committer version.
  
 
=== Papyrus Oomph Setup Model ===
 
=== Papyrus Oomph Setup Model ===
  
The [[Eclipse Oomph Installer]] provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code.  Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.
+
The [[Eclipse Installer]] provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code.  Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.
  
 
Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on.  For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse.  On the second page, expand '''Eclipse.org''' / '''Papyrus''' to see the various components that you can import to work on.  Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like.  In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform.  This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).
 
Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on.  For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse.  On the second page, expand '''Eclipse.org''' / '''Papyrus''' to see the various components that you can import to work on.  Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like.  In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform.  This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).
Line 23: Line 31:
 
* preferences enforcing the Papyrus standard compiler and code formatter/template settings
 
* preferences enforcing the Papyrus standard compiler and code formatter/template settings
  
Please raise bugs if you see any problems in the setup configuration.
+
Please report bugs if you see any problems in the setup configuration.
  
On the first page, the simplest option is to start with the Eclipse Standard package because the setup model will add everything else you need for working on Papyrus's various code and models:
+
Follow the following link for a step by step installation guide: [[Papyrus_Developer_Guide/Papyrus_With_Oomph | Oomph setup guide]]
  
[[Image:Papyrus_Oomph_page1.png]]
+
=== Installation Details ===
  
On the second page, pick whatever Papyrus components you need to import into the workspace:
+
Following is a description of the basic configuration:  
  
[[Image:Papyrus_Oomph_page2.png]]
+
*The latest Eclipse release pertinent to your use-cases (Modeling, Committer, java, etc)
 +
*the Papyrus release (matching your Eclipse version), installed from the relevant [https://www.eclipse.org/papyrus/download.html#main Papyrus update site]  
 +
** Papyrus SDK
 +
** Papyrus Toolsmiths
 +
** Papyrus Releng Tools
 +
** Papyrus User Examples
  
=== Common Environment  ===
+
===Additional Useful Tools===
 +
*[http://jautodoc.sourceforge.net/ JAutoDoc]
 +
* install the source version of the Papyrus dependencies (EMF, GMF, MWE2, XTEND, XTEXT, UML2, UML2 Extender SDK) (relevant to your usecases)
  
Following is a description of the basic configuration:
+
==Configuration==
 
+
*Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc  
*The latest Eclipse Modeling (Or Standard) release
+
*Configure your Eclipse.ini file adding this line in the ''vmargs'':
*EGit
+
<pre>-Duser.name=FirstName LastName (Company) <user@email></pre>
*[http://jautodoc.sourceforge.net/] JAutoDoc
+
*Java 11:  
**Configure the header template according to your company: Eclipse Preferences -&gt; Java -&gt; JAutodoc  
+
*Java 1.6:  
+
 
**Eclipse Preferences -&gt; Java -&gt; Compiler  
 
**Eclipse Preferences -&gt; Java -&gt; Compiler  
 
**Eclipse Preferences -&gt; Java -&gt; Installed JREs  
 
**Eclipse Preferences -&gt; Java -&gt; Installed JREs  
 
**VM Arguments for debug mode:
 
**VM Arguments for debug mode:
<pre>-Dosgi.requiredJavaVersion=1.6 -Xms768m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=384m -XX:+CMSClassUnloadingEnabled
+
<pre>-Dosgi.requiredJavaVersion=11 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled
</pre>  
+
</pre>
=== Required External Plugins  ===
+
  
Papyrus requires some external plugins in order to compile. <br> The following page maintain a list of [[Papyrus Required External Plugins|Papyrus Required External Plugins]]
+
=== Gerrit Configuration  ===
 +
*[[Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit | How to configure Gerrit]]
  
== Development Plan  ==
+
=== API Management Configuration ===
 +
There are two way to manage your code version:
 +
*define yourself the API baseline for Papyrus using [https://help.eclipse.org/2020-06/index.jsp?nav=%2F4_2_3 Eclipse Preference API Baseline]
 +
*Oomph includes a way to manage the version changes between two releases as illustrated [[Papyrus_Developer_Guide/Oomph_Version_Management |here]]
  
=== Specifications  ===
+
*API Rules:
 +
**[[Evolving_Java-based_APIs]]
 +
**[[Evolving_Java-based_APIs_2]]
 +
**[[Evolving_Java-based_APIs_3]]
  
The specifications are available here: [http://www.eclipse.org/projects/project-plan.php?planurl=http://www.eclipse.org/papyrus/project-info/plan_luna.xml Luna plan]
+
=== Apply Papyrus Configuration Files  ===
 +
Papyrus provides configuration files for Template, CleanUp, and Format for java code.
 +
Register these files into your Eclipse Preferences.
 +
The Papyrus [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/Papyrus%20Code%20templates.xml Code Templates], [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/papyrus_cleanup.xml Java Cleanup] and [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/papyrus_formatter.xml Java Formatter] files are available under the Papyrus repository in the folder '''releng/templates/''' and should be used for all your development on Papyrus.
  
== Getting the code  ==
+
[[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]
  
=== Connecting to the git repository ===
+
[[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]
  
The code is available under git at this location ssh://committer_id@git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git or http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git
+
[https://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/releng/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment.
See the [https://projects.eclipse.org/projects/modeling.mdt.papyrus/developer Papyrus project developer resources] page for more details
+
  
=== Retrieve code ===
+
== How To ... ==
  
To know if a downloaded plugin should compile, you can have a look to a Papyrus installation. If the plugin comes with the installation, it should compile!
+
Each developer must follow the following rule in addition to the aforementioned [[MDT/Papyrus/Developer Guide/Charter | Developer Charter]].
  
 +
=== Clone Papyrus Git Repository ===
  
*The following plugins are not distributed and could be closed (deprecated, not yet provided in the Papyrus distribution or for developpers only):
+
The Papyrus code and its documentations are located in a Git repository. In the website [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git] you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).
<pre>all plugins of the layer 'developer', except if you need to generate diagrams (in this case you should install GMF Tooling as well)
+
oep.infra.emf.editor
+
oep.infra.emf.embeddededitor
+
oep.infra.emf.newchild
+
oep.team.svn
+
</pre>
+
*Only the follwing projects are currently provided by the Papyrus extra-plugins update site. The others projects can be closed.(They are deprecated, not yet provided in the Papyrus distribution or for developpers only):
+
<pre>
+
org.eclipse.papyrus.compare.report.ui
+
org.eclipse.papyrus.compare.report
+
org.eclipse.papyrus.diagramtemplate.edit
+
org.eclipse.papyrus.diagramtemplate.editor
+
org.eclipse.papyrus.diagramtemplate
+
org.eclipse.papyrus.eclipse.project.editors
+
org.eclipse.papyrus.infra.gmfdiag.css.configuration
+
org.eclipse.papyrus.infra.gmfdiag.css.properties
+
org.eclipse.papyrus.infra.gmfdiag.css.theme
+
org.eclipse.papyrus.infra.gmfdiag.css.xtext.ui
+
org.eclipse.papyrus.infra.gmfdiag.css.xtext
+
org.eclipse.papyrus.infra.gmfdiag.css
+
org.eclipse.papyrus.layout.algorithms.gridAlgorithm
+
org.eclipse.papyrus.layout.algorithms.horizontalAlgorithm
+
org.eclipse.papyrus.layout.algorithms.horizontalSymmetryAlgorithm
+
org.eclipse.papyrus.layout.algorithms.horizontalTreeAlgorithm
+
org.eclipse.papyrus.layout.algorithms.radialAlgorithm
+
org.eclipse.papyrus.layout.algorithms.springAlgorithm
+
org.eclipse.papyrus.layout.algorithms.treeAlgorithm
+
org.eclipse.papyrus.layout.algorithms.verticalAlgorithm
+
org.eclipse.papyrus.layout.algorithms.verticalSymmetryAlgorithm
+
org.eclipse.papyrus.layout.subeditor.gmf
+
org.eclipse.papyrus.layout
+
org.eclipse.papyrus.marte.properties
+
org.eclipse.papyrus.marte.static.profile
+
org.eclipse.papyrus.marte.vsl
+
org.eclipse.papyrus.migration.properties.model
+
org.eclipse.papyrus.uml.export
+
</pre>
+
*The tests plug-ins are located under tests/junit/plugins or tests/junit/extraplugins. Other test projects are not necessarily maintained
+
  
 +
Follow this [[Papyrus_Developer_Guide/Papyrus_Git_Tutorial | quick tutorial]] if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.
  
=== Retrieve configuration files  ===
+
=== Code Contributions and Reviews ===
  
The Papyrus [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/templates/Papyrus%20Code%20templates.xml Code Templates] and [http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/templates/Papyrus%20Formatter%20profile.xml Java Formatter] files are available under the Papyrus repository in the folder doc/DeveloperDocuments/templates/<br> [[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]<br> [[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]<br>
+
*[[Papyrus Developer Guide/How To- Code Contributing | Guidelines for a new contribution to papyrus]]
 
+
[http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/templates/HowToUseTemplates.txt The note] explains how to install the templates in your environment.
+
 
+
== Papyrus Architecture ==
+
 
+
*Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture|Papyrus Architecture ]]
+
 
+
== Papyrus Generation  ==
+
 
+
*Papyrus generation mechanism is explained here: [[Papyrus Developer Guide/Papyrus diagram generation]]
+
 
+
== Papyrus Code Standards  ==
+
 
+
*Java Doc - every class, method and field including private ones should be documented with Java Doc
+
*No abbreviations - the class, methods and variables should have meaningful names
+
*Formatting - the code should be formatted in accordance with format templates
+
*Always use brackets in conditions, loops, ...
+
*Compile - the modified code and other plugins should be compilable. Be sure to use '''Java 1.5 code compatibility'''. Check other plugins that could be influenced before commiting!
+
*Standard Java Rules coding - Unless specified differently, the Java Standard Coding rules should be applied: no abbreviations, variables starting with lower case; class and types with upper case; Composed name separated with upper case; no underscore in names; ...
+
*In case of doubt - check existing code from those following the rules&nbsp;:-)
+
  
 
=== Papyrus Plug-ins and Features  ===
 
=== Papyrus Plug-ins and Features  ===
  
See [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]]  
+
* [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]]
 
+
== Papyrus Coding guidelines  ==
+
 
+
A few points may be a little tricky when coding for Papyrus. Among them:
+
 
+
=== Papyrus Plugin Naming Scheme and Folders Structure<br>  ===
+
 
+
*Papyrus plugins naming scheme and folder structure used to locate and name plugins is described here: [[Papyrus Plugin Naming Scheme|Papyrus_Plugin_Naming_Scheme]]
+
 
+
=== Structure and behavior of papyrus  ===
+
 
+
*Presentation of the papyrus stucture and the behavior of some parts [[Papyrus Developer Guide/Papyrus Structure Behavior]]
+
 
+
=== Papyrus Command Execution, History, Undo/Redo  ===
+
 
+
*This first document describes the usage of editing domains and gmf/gef/emf commands. See this detailed article [[Papyrus Developer Guide/Editing Domains and Commands]].
+
 
+
*This second document tries to explain how the differents Eclipse Command frameworks work and how they are related. It also explains how commands should be executed in Papyrus, in order to have correct undo/redo.
+
**http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/commandExecution.doc
+
**Following UML model with code reverse can also be useful:
+
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.di
+
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.notation
+
***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.uml
+
 
+
=== Papyrus ServiceRegistry<br>  ===
+
 
+
The ServiceRegistry is one of the main Papyrus component. The idea is that each Papyrus feature should be a service registered to the ServiceRegistry.
+
 
+
The ServiceRegistry should be accessible from any code. It allows to retrieve the components you need to perform your task. <br> A new implementation of the ServiceRegistry is submitted. The new ServiceRegistry is discused here [[Papyrus Developer Guide/Service Registry]]
+
 
+
 
+
== How To ...  ==
+
 
+
=== Commit, Report Bugs, patchs (Code Contributing)  ===
+
 
+
*How To - related to reporting bugs, patching, commit, ... [[Papyrus Developer Guide/How To- Code Contributing]]
+
 
+
=== Papyrus Code Examples  ===
+
 
+
*How to - Related to Papyrus code,[[Papyrus Developer Guide/How To Code Examples]]<br>
+
 
+
=== Papyrus Log  ===
+
 
+
*Papyrus Log is explained here [[Papyrus Developer Guide/Papyrus Log]]
+
 
+
=== Papyrus Editors  ===
+
 
+
Currently Papyrus provides 2 editors kinds&nbsp;: Diagrams and Table. How to add your own editor kind is explained here [[Papyrus Developper Guide/How to - Add your own editor in Papyrus]]
+
 
+
=== JUnit Tests  ===
+
 
+
How to add JUnit tests to the build: [[Papyrus Developer Guide/Add JUnit Test Bundle]]
+
 
+
Useful utilities for JUnit tests:  [[Papyrus Developer Guide/JUnit Test Framework]]
+
 
+
=== Write Documentation for Papyrus  ===
+
 
+
How to - Related to documentation [[Papyrus Developer Guide/Writing Documentation]]
+
 
+
=== Papyrus Discovery  ===
+
 
+
==== Papyrus additional components  ====
+
 
+
To add extra features to the Papyrus Discover, you should edit the files located here: ssh://USER_ID@git.eclipse.org/gitroot/www.eclipse.org/papyrus.git
+
 
+
==== Papyrus as a Modeling component  ====
+
 
+
Papyrus is available from the Modeling Package, using the discovery UI of this package. This contribution is made by the project located here:&nbsp;git://git.eclipse.org/gitroot/www.eclipse.org/modeling/amalgam.git,
+
 
+
the file is located in the folders discovery/downloads/RELEASE_NAME
+
  
== Papyrus (Nat)Table Developper Documentation  ==
+
== Release Engineering ==
* The documentation for developpers is available here [[Table Developper Documentation]]
+
  
== Papyrus Diagram Developper Documentation  ==
+
=== Contributing To The Plan For The Release ===
* The documentation for developpers is available here [[Diagram Developper Documentation]]
+
  
== Papyrus Embedded Editors Documentation  ==
+
* [[Papyrus Developer Guide/Contribution Questionaire | Create a Contribution Questionaire]]
* The documentation for developers is available here [[Embedded Editors Developer Documentation]]
+
  
== Papyrus Build Process ==
+
=== Release Process ===
  
*Papyrus build process on Athena is explained here [[Papyrus Developer Guide/Build Process]].
+
*[[Papyrus Developer Guide/Release Process: How To | How to release Papyrus]].
  
== New plugin Submition Process  ==
+
=== API Evolution ===
  
New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]]
+
*Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]]  
  
 
[[Category:Papyrus]]
 
[[Category:Papyrus]]

Latest revision as of 11:09, 19 November 2020

Development Environment

To ease the development of Papyrus, each member of the team works with basically the same configuration. There are two ways to get your development environment:

  • downloading and installing Eclipse
  • using the Eclipse Installer (by Oomph) to manage your Papyrus development workbench.

Java Version

OpenJDK 11 (or higher) is recommended.

Downloading Eclipse

You can download a fresh Eclipse Package release on this page. We advise you to download the Eclipse Committer version.

Papyrus Oomph Setup Model

The Eclipse Installer provides a set-up model for Papyrus, making it easier than ever to get a complete Eclipse workbench up and running for development on the Papyrus source code. Just download the Oomph Installer from the linked wiki page and follow the simple wizard to create your IDE and import the Papyrus source projects that you want to work on.

Pick any product you like on the first page, but be sure it's the latest release of that product for the Papyrus stream you're working on. For example, if you're working on the Luna service stream of Papyrus, you need the Luna release of Eclipse. On the second page, expand Eclipse.org / Papyrus to see the various components that you can import to work on. Pick any combination of the leaf-level sub-(sub-)projects, even all of them if you like. In the third page where you specify variables such as install location, workspace location, git clone, etc. be sure to choose "Luna" for the Target Platform. This ensures that you will be set up to work on Papyrus Luna (SR1), which is the only development stream currently supported by the setup model (until Mars development gets under way).

Contributing your changes is easy because Oomph will clone the Papyrus Git repository for you and configure Gerrit push.

Amongst possibly other details, the setup model configures:

  • your IDE with all of the tools needed to edit and build the source projects you choose
  • your workspace with a Git clone and the source projects imported from it that you choose
  • a PDE target that includes all of the dependencies required by Papyrus plus the latest nightly build of Papyrus, itself, so that you can import only a subset of the (many) source projects but still run the complete Papyrus toolset in a run-time workbench
  • Mylyn queries for current open bugs and enhancements in the Papyrus bugzilla database
  • Mylyn queries for the status of the latest Papyrus automated builds, including tests
  • Mylyn queries for open Gerrit reviews
  • preferences enforcing the Papyrus standard compiler and code formatter/template settings

Please report bugs if you see any problems in the setup configuration.

Follow the following link for a step by step installation guide: Oomph setup guide

Installation Details

Following is a description of the basic configuration:

  • The latest Eclipse release pertinent to your use-cases (Modeling, Committer, java, etc)
  • the Papyrus release (matching your Eclipse version), installed from the relevant Papyrus update site
    • Papyrus SDK
    • Papyrus Toolsmiths
    • Papyrus Releng Tools
    • Papyrus User Examples

Additional Useful Tools

  • JAutoDoc
  • install the source version of the Papyrus dependencies (EMF, GMF, MWE2, XTEND, XTEXT, UML2, UML2 Extender SDK) (relevant to your usecases)

Configuration

  • Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc
  • Configure your Eclipse.ini file adding this line in the vmargs:
-Duser.name=FirstName LastName (Company) <user@email>
  • Java 11:
    • Eclipse Preferences -> Java -> Compiler
    • Eclipse Preferences -> Java -> Installed JREs
    • VM Arguments for debug mode:
-Dosgi.requiredJavaVersion=11 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled

Gerrit Configuration

API Management Configuration

There are two way to manage your code version:

Apply Papyrus Configuration Files

Papyrus provides configuration files for Template, CleanUp, and Format for java code. Register these files into your Eclipse Preferences. The Papyrus Code Templates, Java Cleanup and Java Formatter files are available under the Papyrus repository in the folder releng/templates/ and should be used for all your development on Papyrus.

FAQ How do I control the Java formatter

FAQ How can templates make me the fastest coder ever

The note explains how to install the templates in your environment.

How To ...

Each developer must follow the following rule in addition to the aforementioned Developer Charter.

Clone Papyrus Git Repository

The Papyrus code and its documentations are located in a Git repository. In the website http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git you will find the most recent activity information of the repository and, at the bottom of the page, you will find the URIs of the Git repository (e.g., http://git.eclipse.org/gitroot/papyrus/org.eclipse.papyrus.git).

Follow this quick tutorial if you never used Git before and want to know how to import the source files of one or more Papyrus plugins in your Eclipse workspace.

Code Contributions and Reviews

Papyrus Plug-ins and Features

Release Engineering

Contributing To The Plan For The Release

Release Process

API Evolution

Back to the top