Skip to main content
Jump to: navigation, search

Difference between revisions of "Papyrus/Papyrus Developer Guide"

 
(70 intermediate revisions by 4 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.
  
One way to manage this is 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 [https://www.eclipse.org/downloads/packages/ page].
 +
We advise you to download the Eclipse Committer version.
  
 
=== Papyrus Oomph Setup Model ===
 
=== Papyrus Oomph Setup Model ===
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.
  
Follow this [[Papyrus_Developer_Guide/Papyrus_With_Oomph | link]] for a step by step installation guide.
+
Follow the following link for a step by step installation guide: [[Papyrus_Developer_Guide/Papyrus_With_Oomph | Oomph setup guide]]
  
=== Common Environment  ===
+
=== Installation Details ===
  
 
Following is a description of the basic configuration:  
 
Following is a description of the basic configuration:  
  
*The latest Eclipse Modeling (Or Standard) release
+
*The latest Eclipse release pertinent to your use-cases (Modeling, Committer, java, etc)
*EGit
+
*the Papyrus release (matching your Eclipse version), installed from the relevant [https://www.eclipse.org/papyrus/download.html#main Papyrus update site]
*[http://jautodoc.sourceforge.net/] JAutoDoc  
+
** Papyrus SDK
**Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc  
+
** Papyrus Toolsmiths
*Java 1.8:  
+
** Papyrus Releng Tools
 +
** Papyrus User Examples
 +
 
 +
===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)
 +
 
 +
==Configuration==
 +
*Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc  
 +
*Configure your Eclipse.ini file adding this line in the ''vmargs'':
 +
<pre>-Duser.name=FirstName LastName (Company) <user@email></pre>
 +
*Java 11:  
 
**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.8 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled
+
<pre>-Dosgi.requiredJavaVersion=11 -Xms768m -Xmx1024m -XX:+CMSClassUnloadingEnabled
 
</pre>
 
</pre>
  
=== Required External Plugins ===
+
=== Gerrit Configuration ===
 +
*[[Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit | How to configure Gerrit]]
  
Papyrus may require some external plugins to compile. <br> The following page maintain a list of [[Papyrus Required External Plugins|Papyrus Required External Plugins]]
+
=== 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]]
  
=== Version Management Tooling ===
+
*API Rules:
 +
**[[Evolving_Java-based_APIs]]
 +
**[[Evolving_Java-based_APIs_2]]
 +
**[[Evolving_Java-based_APIs_3]]
  
Oomph includes a way to manage the version changes between two releases as illustrated [[Papyrus_Developer_Guide/Oomph_Version_Management |here]]
+
=== Apply Papyrus Configuration Files ===
 
+
Papyrus provides configuration files for Template, CleanUp, and Format for java code.  
=== [Future] Maven Integration ===
+
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.
The Hudson builds are currently implemented with Maven, using Tycho to build Eclipse-compatible artifacts.  Therefore, all active plug-in and feature projects have Maven POM files describing them.  There is a proposal under consideration to implement Maven Nature provided by M2Eclipse in the Papyrus source projects, to more closely align the Hudson build environment with the developer's local build environment in the Eclipse workbench.
+
 
+
An initial analysis of what would be involved in this change, both in terms of actually implementing the Maven Nature and its impact on Papyrus developers' daily workflow, is captured in this document:
+
 
+
* [http://www.slideshare.net/cdamus/adopting-maven-nature-in-papyrus-source-projects Adopting Maven Nature] in the Papyrus source projects
+
 
+
 
+
 
+
== Getting the code ==
+
 
+
If you are not using Oomph to set your environment you will need to fetch the code manually.
+
 
+
=== Cloning the Git repository and importing the code ===
+
 
+
The Papyrus code and some documents 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).
+
 
+
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.
+
 
+
 
+
 
+
 
+
== Papyrus Architecture ==
+
 
+
*[[Dependencies to Eclipse components ]]
+
 
+
*Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture|Papyrus Architecture ]]
+
 
+
*Here are the [[MDT/Papyrus/Developer Guide/HighRequirements|Papyrus Requirements ]].
+
 
+
=== Papyrus Plugin Naming Scheme and Folders Structure  ===
+
 
+
*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 structure 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]].
+
 
+
=== Papyrus ServiceRegistry  ===
+
 
+
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 discussed here [[Papyrus Developer Guide/Service Registry]]
+
 
+
=== Manage Decorators On Papyrus ===
+
Papyrus provide services in order To manage decoration on Edit Parts from graphical editor or on icons from model explorer. An application example are describe here: [[Manage Decorators On Papyrus]]
+
 
+
=== 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]]
+
* A code generation framework has been developed to automatically generate JUnit tests for GMF-based editors:  [[Papyrus Developer Guide/Automatic Test Generation for Diagram Editors]]
+
* Useful utilities for JUnit tests:  [[Papyrus Developer Guide/JUnit Test Framework]]
+
 
+
=== Papyrus Table Developer Documentation  ===
+
* The documentation for developers is available here [[Table Developer Documentation]]
+
 
+
=== Papyrus Diagram Developer Documentation  ===
+
* The documentation for developpers is available here [[Diagram Developer Documentation]]
+
 
+
=== Papyrus Embedded Editors Documentation  ===
+
* The documentation for developers is available here [[Embedded Editors Developer Documentation]]
+
 
+
 
+
 
+
== Developer Charter==
+
This is the charter that all papyrus contrubitor must respect.[[MDT/Papyrus/Developer Guide/Charter|Papyrus Contributor charter ]]
+
 
+
 
+
 
+
== Contributing to Papyrus  ==
+
 
+
Each developer must follow the following rule in addition to the aforementioned [[MDT/Papyrus/Developer Guide/Charter | Developer Charter]].
+
 
+
=== Retrieve configuration files  ===
+
 
+
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.
+
  
 
[[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]
 
[[FAQ How do I control the Java formatter?|FAQ How do I control the Java formatter]]
Line 144: Line 83:
 
[[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]
 
[[FAQ How can templates make me the fastest coder ever?|FAQ How can templates make me the fastest coder ever]]
  
[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.
+
[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.
  
===String Externalization/Internalization===
+
== How To ...  ==
*the goal of the externalization process is to distinguish the string used as messages and visible by the final user and the string required in your code, but not visible for the user,
+
  
Follow this [[Papyrus_Developer_Guide/Externalize_Strings_In_Java | link]] for a guide on externalization in Eclipse.
+
Each developer must follow the following rule in addition to the aforementioned [[MDT/Papyrus/Developer Guide/Charter | Developer Charter]].
  
=== Papyrus Plug-ins and Features  ===
+
=== Clone Papyrus Git Repository ===
  
See [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]]
+
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).
  
New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]]
+
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.
 
+
=== Write Documentation for Papyrus  ===
+
 
+
How to - Related to documentation [[Papyrus Developer Guide/Writing Documentation]]
+
  
=== Code Contributions ===
+
=== Code Contributions and Reviews ===
  
 
*[[Papyrus Developer Guide/How To- Code Contributing | Guidelines for a new contribution to papyrus]]
 
*[[Papyrus Developer Guide/How To- Code Contributing | Guidelines for a new contribution to papyrus]]
  
=== Gerrit Contributions  ===
+
=== Papyrus Plug-ins and Features ===
 
+
*[[Papyrus_Developer_Guide/How_to_Contribute_to_Papyrus_with_Gerrit | How to contribute via Gerrit]]
+
 
+
 
+
 
+
 
+
== How To ...  ==
+
 
+
=== Papyrus Diagram Generation  ===
+
 
+
*Papyrus generation mechanism is explained here: [[Papyrus Developer Guide/Papyrus diagram generation]]
+
 
+
=== Model your papyrus development, and generate User doc ===
+
 
+
*How To - create your model (requirements, use cases, design, tests) ... [[Papyrus Developer Guide/Model your development]]
+
 
+
=== Papyrus Code Examples  ===
+
 
+
*How to - Related to Papyrus code,[[Papyrus Developer Guide/How To Code Examples]]<br>
+
 
+
===Rcptt Tests ===
+
 
+
Rcptt is under evaluation but a developer guide can be find [[Papyrus/RCPTT|here]].
+
 
+
  
 +
* [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]]
  
 
== Release Engineering ==
 
== Release Engineering ==
  
=== Release Plans  ===
+
=== Contributing To The Plan For The Release ===
 
+
The specifications are available here:
+
* [https://wiki.eclipse.org/Oxygen/Simultaneous_Release_Plan Oxygen release plan]
+
* [https://wiki.eclipse.org/Photon/Simultaneous_Release_Plan Photon release plan]
+
 
+
=== Contributing to the plan for the release ===
+
  
* [[Papyrus Developer Guide/Contributing To Release Plan | Contribute to the Release Plan]]
 
 
* [[Papyrus Developer Guide/Contribution Questionaire | Create a Contribution Questionaire]]
 
* [[Papyrus Developer Guide/Contribution Questionaire | Create a Contribution Questionaire]]
  
Line 208: Line 112:
  
 
*[[Papyrus Developer Guide/Release Process: How To | How to release Papyrus]].
 
*[[Papyrus Developer Guide/Release Process: How To | How to release Papyrus]].
*[[Papyrus Developer Guide/Release Process: Doc | Releng Documentation]].
 
*[[Papyrus Developer Guide/Release Standard Operating Procedure: Doc | Release Standard Operating Procedure]].
 
  
 
=== API Evolution ===
 
=== API Evolution ===
  
 
*Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]]  
 
*Papyrus API Evolution Reports: [[Papyrus Developer Guide/API Evolution Reports]]  
 
=== Hudson Instance ===
 
 
*Papyrus Hipp standard guide: [[Papyrus Developer Guide/How to use the Hipp and its functionalities]].
 
 
  
 
[[Category:Papyrus]]
 
[[Category:Papyrus]]

Latest revision as of 10: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

Copyright © Eclipse Foundation, Inc. All Rights Reserved.