Using Eclipse

From AzureusWiki

(Redirected from UsingEclipse)

This page gives a step by step description of running the Azureus BitTorrent client in the Eclipse IDE. This has been tested with Azureus2.3.0.5 CVS and Eclipse 3.2M2 but should work with Eclipse 3.1.1, too.

Note: If you're familiar with Eclipse and want to do everything your own way the Project and Run chapters will be interesting for you

1 Installing Eclipse
2 Set up a CVS Repository and import Azureus sources
3 Configure the Project
- 3.1 Configure the Run dialog
4 Synchronizing with the CVS
5 Building an Azureus2.jar
6 Developing Plugins
7 Additional source files

[edit]

Installing Eclipse

Download Eclipse and extract the archive to a directory of your choice
Start the Eclipse launcher (the actual file name depends on the OS) and choose a location for the workspace (the default path should be ok)
Under Window > Preferences, tweak the following settings:
- Java > Build Path: select Folders and clear the source folder box and make sure "bin" is in the output folder box.
- Team > CVS > Connection set the timeout to 200 since the sourceforge CVS servers tend to be slow
click on OK and go to the Project Menu and unselect Build Automatically (Eclipse will build the project anyway when you use the Run option)

[edit]

Set up a CVS Repository and import Azureus sources

To load Azureus into Eclipse for editing, the first thing you should do is set up a CVS repository. That way you can easily get the latest code. Lets walk through those steps.

Open up the CVS Repository perspective in Eclipse. You can do that by going to Window > Open Perspective > CVS Repository Exploring. If the CVS Repositories view is not showing, click on Window > Show View > CVS Repositories.
Right click in the CVS perspective, and choose New > Repository Location. You will be presented with the Add a new CVS Repository dialog. There are three fields you need to fill in:
- Host: azureus.cvs.sourceforge.net
- Repository Path: /cvsroot/azureus
- User: anonymous
- Password: <leave blank>
- Connnection type: pserver
When the repository is included open the HEAD branch (that might take a while since the sourceforge servers can be quite slow). Right-click on azureus2 and select Check Out As...
Select Check out as a new project using New Project Wizard and click on Finish
In the new popup window select Java > Java Project, continue, enter a Project name, i.e. "azureus2" and select create seperate source and output folders (the .class files will be placed in a different output folder instead in the same folders as the sourcecode)
Finish both wizards

When the download of the sources is done you can change to the Java Perspective (Window > Open Perspective > Java), adding the Navigator view could be useful to explore the project's file structure.

[edit]

Configure the Project

Once you're in the java perspective you should do the following things:

Go to the Navigator tab
Right-click on the project > Properties > Java Build Path > Libraries
Now Add JARs..., select your project and go to build > libs, then select all .jar files
Go to the 1st Tab (Source), select the Excluded element and edit it. Then add the bin and build folders to the source exclusion paths
Have a short look at the output folder stated on the bottom, it should be "project_name/bin"
Save everything and and close the popups

Eclipse should be able to compile your project now, you can manually start a build process via Right-click > Build Project'

[edit]

Configure the Run dialog

Go to the Navigator tab
Right-click on the project > Run AS... > Run
Select Java application, click on New and give it a name (i.e. the same as the project name)
Put "org.gudy.azureus2.ui.swt.Main" into the Main class box.
Go to the Arguments tab and deselect the checkbox on the bottom and put the path of your installed Azureus version in there as the working directory if you want to reuse the installed plugins and/or sub-directories created by plugins.
- Note: If you don't have a pre-built version of Azureus you'll need to download the swt-libs for your OS from the Eclipse website and put them into the specified working directory. It might be a good idea to create the working directory outside the workspace since the core plugins will be installed in it.
Go to the Classpath tab and remove all user entries
Add the output folder through Advanced > Add Folder to the User Entries (see step 4 of the project configuration)
Add the swt.jar from your installed Azureus version/working directory through Add External JARs... to the User Entries
Go to the Environment tab and add Variable LD_LIBRARY_PATH with the Value of your output folder (see step 4 of the project configuration)
Apply and run Azureus

[edit]

Synchronizing with the CVS

Go to the Navigator tab
Right-click on the project > Team > Synchronize with Repository... (it should change to the Team perspective now or open the Synchronize tab)
Wait until Eclipse has found all differences (the sourceforge CVS server can be very slow sometimes or even timeout, then you should try again later)
Click on the Incoming Mode button if you want to see what has changed
Click on the Update all incoming changes... button to update
In case you have modified files and the same files have been changed in the CVS too continue with the following steps:
Click on the Conflicts Mode button
Double-click on the conflicting file(s) to open the Compare Editor
Now you can what differs on both sides, since you don't have CVS write access you can only import incoming changes, either do that manually by clicking on the square in the middle bar for each incoming change or simply click on the Copy all non-conflicting changes from the right to the left button, of course that only works for differences on that don't conflict with your own changes. If there are such differences you have to rewrite your code manually.
after you have imported the changes from CVS or modified your own code in a way that matches the CVS changes right-click on the file in the Synchronize tab and select Mark as Merged

[edit]

Building an Azureus2.jar

Go to the Navigator tab
If you haven't built the project yet: Right-click on the project > Build Project
Right-click on the project > Import/Export
Go to the export tab and select Java > JAR file
In the next step select your Project and in the Select resources to export field
Only these checkboxes should be checked: Export all output folders for checked projects, compress the contents of the jar file and add directory entries (make sure you excluded the right folders from the source tree, see #Configure the Project)
choose a output folder for your Azureus2.jar, i.e. your azureus program/working directory (see #Configure the Run dialog)
If you have to build .jar files frequently you can go to the next page and overwrite the Azureus2.jardesc in your project root folder
To rebuild the .jar file Right-click on the Azureus2.jarfile in the Package Explorer and select Create jar
Go to the last page and add org.gudy.azureus2.ui.swt.Main as main class
Finish the dialog and wait until the .jar file is build