-
Notifications
You must be signed in to change notification settings - Fork 143
SWT Beginners
⚠️ THIS TOPIC CONTAINS PARTIALLY OUTDATED INFORMATION⚠️
The Eclipse Bugzilla and Gerrit are no longer used for SWT, instead GitHub is used!
This page is useful for beginners who would like to develop SWT. All of the information here is cross-platform, general knowledge. Please note the page is under construction.
Please note this article is still being written and is not final.
This guide assumes basic knowledge of Java, git, and general Eclipse development. Nothing in this guide covers any platform specific development knowledge -- for this documentation please see further reading.
Download and install SWT tools. Other than that, you may find the following plugins useful (not mandatory for SWT development):
SWT works using two code repositories:
- The source code, which contains Java and JNI source code for all widgets. This where 99% of all changes belong.
- The binaries, which contain the platform specific library objects. These allow the Java source code to call the operating system's toolkit.
Start by cloning both of git repos above. From the sources repo, import the following projects:
- org.eclipse.swt
- org.eclipse.swt.snippets
- org.eclipse.swt.examples
- org.eclipse.swt.tests
This will add the SWT source code, snippets, example applications, and test cases to your workspace.
Now import the binaries project. This will depend on your platform and architecture of your machine -- choose accordingly. For example, on 64-bit Linux GTK I would be importing:
- org.eclipse.swt.gtk.linux.x86_64
After importing the SWT sources and binaries, you will see lots of errors. This is normal, as the SWT sources have not yet been linked to the binary matching your platform and can be resolved by modifying the .classpath file.
- Open the "Navigator" view (not Package Explorer).
- In the org.eclipse.swt folder you will see a collection of .classpath files corresponding to various platforms (GTK, Win32, Cocoa, etc.).
- Copy the desired .classpath_* file.
- Paste it in the same folder, except rename it to .classpath
- Go to Project -> Clean, and clean the org.eclipse.swt project and the project matching your platform's binaries.
Eclipse/SWT uses a code review tool called Gerrit. It's quite easy to configure if you have the EGit plugin installed.
- Open the "Git Repositories" view
- Expand the "org.eclipse.swt" item (assuming you have the org.eclipse.platform.swt project in your EGit repositories view)
- Expand the "Remotes" item
- Right click the "origin" item, and select "Gerrit configuration"
- Fill in your information from Gerrit (username).
For more information about using Gerrit, see the more comprehensive SWT Gerrit page.
The goal of a commit message is to clarify any ambiguities for the reviewer(s) and any developer who may read the message later. It should be comprehensive and avoid skipping information that was exchanged verbally or via chat. Do not write empty commit messages.
All commit messages must be signed off by your first and last name. Please configure your git settings to reflect as such. Additionally when committing, ensure that EGit has generated a change ID, which goes at the bottom of the commit message. It can be generated by clicking one of the buttons at the top right area of the "Commit window".
An SWT commit message should follow this format:
Bug ID : The bug description should be the same as that in Bugzilla (maybe slightly trimmed)
Description of patch/fix
Test strategy *1
JUnit Tests performed *2
Change-ID: xxxxxxxxxxx (auto generated)
Signed-off-by: Firstname Lastname <[email protected]> (auto generated)
- Test strategy: steps outlining how to reproduce the issue. Link to a snippet, steps to follow, or a pointer to where to find such instructions.
- JUnit tests performed: you should mention if you ran the relevant SWT JUnit tests. For example "Ran AllNonBrowserTests on Wayland" and related results. If they don't need to be ran, mention why there is no need to run the tests.
Before writing an SWT patch, it's important to have a crash course on how SWT interacts with native code. Earlier we mentioned the SWT sources (org.eclipse.swt) and the binaries (such as org.eclipse.swt.gtk.linux.x86_64, as an example). The binaries project in your workspace contains library objects, such as .SO files on Linux, .dll on Windows, etc. Modifying the .classpath allows the SWT sources project to load these library objects and run the SWT from your workspace.
How does this work? Well the SWT sources use Java code to interact with native libraries through JNI. This is done by adding boilerplate JNI function signatures in files like OS.java, for example. SWT Tools then generates the JNI C code which links the Java JNI functions to the actual native calls. The generated code and the JNI function signatures (as well any other Java code) are then merged as one change under the org.eclipse.swt project. This type of patch is considered a native change.
After such a change is merged, the JNI C code does not need to be generated again. Changes that do not modify the JNI code are considered non-native changes, as no additional changes beyond "pure" Java code needs to be made. However SWT does not load every function possible from native libraries, only those that are actually called/needed by SWT. It is not uncommon that a bug fix will require a new native function to be available for use in SWT, in which case its method signature needs to be added to SWT. And thus the process repeats itself.
Non-native changes require no special action -- submit the patch by right clicking the org.eclipse.swt project in the "Git repositories" view and select "Push to Gerrit".
Native changes are trickier because they require you to rebuild the native bindings. The aforementioned library objects now have to be generated manually in order for SWT to run with local changes. While the library objects do not need to be submitted in your Gerrit change, they do have to be built for testing purposes (otherwise SWT won't run and will complain about library link errors). For instructions on building the library objects, check for a README file in binaries project folder for your platform.
After testing your patch, follow the steps below to submit a native change:
- Prepare all Java code, including function signatures in OS.java
- Go to Project -> Clean. Clean the SWT sources and binaries projects. Make sure "Build Automatically" is checked in the Project menu.
- After cleaning, some *.c and *.h files will show up in the Git staging area. Usually these are files like os.c, os_stats.c, os_stats.h, etc.
- Commit these, as well as the Java files (or any other changes relating to your patch) Submit the patch by right clicking the org.eclipse.swt project in the "Git repositories" view and select "Push to Gerrit".
Outside of the basics contained in this tutorial, there is additional documentation that provides further insight into development on each platform.
Additionally, there are some workflow tasks which are platform agnostic. You can find these at the SWT workflow documentation.