Developer Documentation

iriverter is a  Java program with an  SWT user interface. It's source is controlled in a  Subversion repository and built using  Apache Ant. Being Java, SWT, and Ant based makes iriverter easy to modify in  Eclipse.

Command-line Instructions

To fetch, build, and run iriverter on the command-line, all you need is Subversion and Apache Ant to run the following commands. The repository contains all of the required libraries, so you don't need to worry about them.

$ svn co http://iriverter.thestaticvoid.org/svn/trunk iriverter
$ cd iriverter
$ ant (to build)
$ ant run (convenience function to run iriverter instead of typing out the long classpath each time)

Ant will take care of recompiling whatever is necessary when you modify any part of the source. If you are paranoid, you can run ant clean && ant to clean and rebuild the project. Patches should be generated like:

$ svn diff > something.patch

where "something" is a brief description of your changes.

Eclipse Instructions

Check-out a copy of iriverter from SVN, either using the command-line version like above, or using a graphical tool like  TortoiseSVN. Next open Eclipse and go to File->New->Project to begin the import. Select Java Project from Existing Ant Buildfile, then select the build.xml file from the source that you downloaded

and click Finish.

Before running the project, you need to build it using the Ant file. This should only have to be done once. Right-click the build.xml in the package explorer and select Run As->Ant Build.

When this completes, you can edit and run the source as you wish. Eclipse will automatically recompile whatever is necessary when you save the Java files that you are editing. Note that if you change non-Java sources such as the documentation or icons, the whole project will have to be rebuilt again.

To run iriverter from within Eclipse, right-click the package name in the package explorer and select Run As->SWT Application.

Files of Interest

All source files are contained in the org.thestaticvoid.iriverter package.

ConverterUI.java

The "main" class. The program begins here. All of the code to build the main window, menus, and toolbar and their corresponding event handlers are here.

SingleVideo.java

SingleVideoInfo.java

SingleVideoAdapter.java

The code to build the single video job UI, and the interface through which to access its data.

More to come later.