Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Papyrus/Papyrus Developer Guide"
< Papyrus
(→Retrieve code: update the path for the psf + add psf for branch 0.9.X) |
|||
| (28 intermediate revisions by 8 users not shown) | |||
| Line 7: | Line 7: | ||
Following is a description of the basic configuration: | Following is a description of the basic configuration: | ||
| − | *The latest Eclipse Modeling release | + | *The latest Eclipse Modeling (Or Standard) release |
| − | *[http:// | + | *EGit |
| − | * | + | *[http://jautodoc.sourceforge.net/] JAutoDoc |
| − | * | + | **Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc |
| − | + | *Java 1.6: | |
| + | **Eclipse Preferences -> Java -> Compiler | ||
| + | **Eclipse Preferences -> Java -> Installed JREs | ||
| + | **VM Arguments for debug mode: | ||
| + | <pre>-Dosgi.requiredJavaVersion=1.6 -Xms768m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=384m -XX:+CMSClassUnloadingEnabled | ||
| + | </pre> | ||
=== Required External Plugins === | === Required External Plugins === | ||
| Line 20: | Line 25: | ||
=== Specifications === | === Specifications === | ||
| − | The specifications are available here | + | 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] |
== Getting the code == | == Getting the code == | ||
| − | === Connecting to the | + | === Connecting to the git repository === |
| − | The code is available under | + | 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 |
| + | See the [https://projects.eclipse.org/projects/modeling.mdt.papyrus/developer Papyrus project developer resources] page for more details | ||
=== Retrieve code === | === Retrieve code === | ||
| − | + | 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! | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | *'' | + | *The following plugins are not distributed and could be closed (deprecated, not yet provided in the Papyrus distribution or for developpers only): |
| − | * | + | <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 | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Retrieve configuration files === | === Retrieve configuration files === | ||
| − | The Papyrus [http:// | + | 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> |
| − | [http:// | + | [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 == |
| − | *Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture| Papyrus Architecture ]] | + | *Papyrus architecture is explained here: [[MDT/Papyrus/Developer Guide/Architecture|Papyrus Architecture ]] |
== Papyrus Generation == | == Papyrus Generation == | ||
| − | *Papyrus generation mechanism is explained here | + | *Papyrus generation mechanism is explained here: [[Papyrus Developer Guide/Papyrus diagram generation]] |
== Papyrus Code Standards == | == Papyrus Code Standards == | ||
| Line 93: | Line 98: | ||
*Java Doc - every class, method and field including private ones should be documented with Java Doc | *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 | *No abbreviations - the class, methods and variables should have meaningful names | ||
| − | *Formatting - the code should be formatted in accordance with format templates | + | *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! | *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 | + | *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 :-) | *In case of doubt - check existing code from those following the rules :-) | ||
| + | |||
| + | === Papyrus Plug-ins and Features === | ||
| + | |||
| + | See [[Papyrus/Code Standards|Papyrus code standards for plug-ins and features]] | ||
== Papyrus Coding guidelines == | == Papyrus Coding guidelines == | ||
| − | A few points may be a little tricky when coding for Papyrus. Among them | + | A few points may be a little tricky when coding for Papyrus. Among them: |
=== Papyrus Plugin Naming Scheme and Folders Structure<br> === | === Papyrus Plugin Naming Scheme and Folders Structure<br> === | ||
| Line 115: | Line 125: | ||
*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. | *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:// | + | **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: | **Following UML model with code reverse can also be useful: | ||
| − | ***http:// | + | ***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.di |
| − | ***http:// | + | ***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.notation |
| − | ***http:// | + | ***http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/doc/DevelopperDocuments/architecture/CommandStackFramework.uml |
| − | <br> | + | === 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 ... == | == How To ... == | ||
| Line 137: | Line 151: | ||
*Papyrus Log is explained here [[Papyrus Developer Guide/Papyrus Log]] | *Papyrus Log is explained here [[Papyrus Developer Guide/Papyrus Log]] | ||
| − | === Papyrus Editors === | + | === Papyrus Editors === |
| − | + | ||
| − | + | Currently Papyrus provides 2 editors kinds : 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: 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 == | ||
| + | * The documentation for developpers is available here [[Table Developper Documentation]] | ||
| + | |||
| + | == Papyrus Diagram Developper Documentation == | ||
| + | * The documentation for developpers is available here [[Diagram Developper Documentation]] | ||
| + | |||
| + | == Papyrus Embedded Editors Documentation == | ||
| + | * The documentation for developers is available here [[Embedded Editors Developer Documentation]] | ||
| + | |||
| + | == Papyrus Build Process == | ||
| + | |||
| + | *Papyrus build process on Athena is explained here [[Papyrus Developer Guide/Build Process]]. | ||
== New plugin Submition Process == | == New plugin Submition Process == | ||
New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]] | New plugin should follow the submition process describe here: [[Papyrus New Plugin Submition Process|Papyrus New Plugin Submission Process]] | ||
| + | |||
| + | [[Category:Papyrus]] | ||
Revision as of 04:36, 12 June 2014
Contents
- 1 Development Environment
- 2 Development Plan
- 3 Getting the code
- 4 Papyrus Architecture
- 5 Papyrus Generation
- 6 Papyrus Code Standards
- 7 Papyrus Coding guidelines
- 8 How To ...
- 9 Papyrus (Nat)Table Developper Documentation
- 10 Papyrus Diagram Developper Documentation
- 11 Papyrus Embedded Editors Documentation
- 12 Papyrus Build Process
- 13 New plugin Submition Process
Development Environment
To ease the development on Papyrus, each member of the team works with basically the same configuration.
Common Environment
Following is a description of the basic configuration:
- The latest Eclipse Modeling (Or Standard) release
- EGit
- [1] JAutoDoc
- Configure the header template according to your company: Eclipse Preferences -> Java -> JAutodoc
- Java 1.6:
- Eclipse Preferences -> Java -> Compiler
- Eclipse Preferences -> Java -> Installed JREs
- VM Arguments for debug mode:
-Dosgi.requiredJavaVersion=1.6 -Xms768m -Xmx1024m -XX:PermSize=256m -XX:MaxPermSize=384m -XX:+CMSClassUnloadingEnabled
Required External Plugins
Papyrus requires some external plugins in order to compile.
The following page maintain a list of Papyrus Required External Plugins
Development Plan
Specifications
The specifications are available here: Luna plan
Getting the code
Connecting to the git repository
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 See the Papyrus project developer resources page for more details
Retrieve code
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!
- The following plugins are not distributed and could be closed (deprecated, not yet provided in the Papyrus distribution or for developpers only):
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
- 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):
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
- The tests plug-ins are located under tests/junit/plugins or tests/junit/extraplugins. Other test projects are not necessarily maintained
Retrieve configuration files
The Papyrus Code Templates and Java Formatter files are available under the Papyrus repository in the folder doc/DeveloperDocuments/templates/
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.
Papyrus Architecture
- Papyrus architecture is explained here: 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 :-)
Papyrus Plug-ins and Features
See 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
- Papyrus plugins naming scheme and folder structure used to locate and name plugins is described here: 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
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.
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
Papyrus Log
- Papyrus Log is explained here Papyrus Developer Guide/Papyrus Log
Papyrus Editors
Currently Papyrus provides 2 editors kinds : 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: 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
- The documentation for developpers is available here Table Developper Documentation
Papyrus Diagram Developper Documentation
- The documentation for developpers is available here Diagram Developper Documentation
Papyrus Embedded Editors Documentation
- The documentation for developers is available here Embedded Editors Developer Documentation
Papyrus Build Process
- Papyrus build process on Athena is explained here Papyrus Developer Guide/Build Process.
New plugin Submition Process
New plugin should follow the submition process describe here: Papyrus New Plugin Submission Process