Open2Dprot Sofware Developer Environment

Open2Dprot Sofware Developer Environment

This describes the software environment we use for developing Open2Dprot. We typically run Eclipse on Windows 2000 or Windows XP Professional systems with about 1Gb of memory and 2+Ghz systems. Eclipse also runs under Linux, MacOS-X and most Unix platforms. The current Eclipse Workspace is C:\ED\. The name of the Open2Dprot workspace is O2P. We compile the Java code from within Eclipse. But documentation, distributions, and Web site preparation and uploads are handled by separate Ant scripts invoked by windows .bat files. All of these scripts are on the CVS server.

Tools in our software developer environment

We use a number of software tools and scripts to make our software development environment easier to use, share code, refactor code and automate the application building and documentation as well as generating updated Web site content automatically. We find this automation helps reduces the likelihood of human error in large projects.

SourceForge CVS server for software repository services (see SourceForge for more information on their use of CVS. Also, see the CVS information web site www.cvs.org
Eclipse (eclipse.org, Version 3.1.0) Integrated Development Environment which includes as standard builtin plugins: Java Development Toolkit (JDT), ANT, CVS. ANT includes Java compile, javadocs, zip as well as many other packages. The master build file available from our CVS server is build/build.xml. There are a number of Ant build scripts that are documented later in this web page. We have defined a Java Code Formatter available from our CVS server subProjects/O2PJavaCodeStyleFormatter.xml.
SUN JDK 1.5 (java.sun.com) that is used with all Java programs.
XMLbeans (xmlbeans.apache.org) (version 2.0.0) that is used to compile the XML xsd schemas. This includes ANT tasks invoked.
Additional Eclipse plugins
- The C/C++ Development Toolkit CDT (from eclipse.org). This requires Cygwin (www.cygwin.com (which we also use for other things).
- A HTML to PS ANT tool html2ps which is a PERL script from http://user.it.uu.se/~jan/html2ps.html. We package this in an Eclipse Project html2ps to access it from Eclipse. There are several other packages that you may need to install and these are described in their Web page. Some of these packages are already installed in Cygwin. If you do install these tools, it puts some of them in the Cygwin installation. We use html2ps (along with the ps2pdf Cygwin tool to help in the automatic generation of documentation).
- An Ant popup-query task query that is part of http://www.jera.com/tools/anttasks/. We package this in an Eclipse Project JeraAntTasks to access it from Eclipse. It is used for popup dialogs for querying user name, passwords for use with Ant <scp> tasks.
- An Ant jar Windows .exe file packager task launch4j from http://launch4j.sourceforge.net/. We use this in an Eclipse Project launch4j project. It is used from Eclipse to build the pipeline module .exe file applications for Windows. Note that the Unix .sh (as well as .bat) files are also available.
The Cygwin (www.cygwin.com tools is a Linux-like environment for Windows. It is used by several of the other packages including html2ps and launch4j. We also use the ps2pdf Cygwin tool to help in the automatic generation of documentation.
The filezilla file transfer program (filezilla.sourceforge.net) is very useful for updating the Web server.

Environment variables required

These are some of the additional (Windows) User Environment variables we use (in both Windows 2000 and Windows XP Professional). For Unix and MacOS-X systems, these of course should be edited to use the path delimiters for those systems. The current Eclipse Workspace path is declared in environment variable %IDE_WS% and some of the other environment variables are defined in terms of it. Our our systems this is defined as C:\ED\ and should be changed to where your Eclipse Workspace is defined.

ANT_HOME
C:\ant

CLASS_PATH
%XMLBEANS_HOME%\lib\xbean.jar

IDE_O2P
%IDE_WS%\O2P

IDE_WS
C:\ED

JAVA_HOME
C:\JDK\jdk1.5.0_04

LAUNCH4J
%IDE_WS%\launch4j

PATH
%JAVA_HOME%\bin;
%XMLBEANS_HOME%\bin;
%ANT_HOME%\bin;
C:\cygwin\bin;C:\cygwin\lib;C:\cygwin\usr\bin;

O2P_MIRROR
C:\Open2Dprot\subProjects

XMLBEANS_HOME
C:\xmlbeans\xmlbeans-2.0.0: C:\ant
CLASS_PATH
%XMLBEANS_HOME%\lib\xbean.jar

IDE_O2P
%IDE_WS%\O2P

IDE_WS
C:\ED

JAVA_HOME
C:\JDK\jdk1.5.0_04

LAUNCH4J
%IDE_WS%\launch4j

PATH
%JAVA_HOME%\bin;
%XMLBEANS_HOME%\bin;
%ANT_HOME%\bin;
C:\cygwin\bin;C:\cygwin\lib;C:\cygwin\usr\bin;

O2P_MIRROR
C:\Open2Dprot\subProjects

XMLBEANS_HOME
C:\xmlbeans\xmlbeans-2.0.0: %XMLBEANS_HOME%\lib\xbean.jar
IDE_O2P
%IDE_WS%\O2P

IDE_WS
C:\ED

JAVA_HOME
C:\JDK\jdk1.5.0_04

LAUNCH4J
%IDE_WS%\launch4j

PATH
%JAVA_HOME%\bin;
%XMLBEANS_HOME%\bin;
%ANT_HOME%\bin;
C:\cygwin\bin;C:\cygwin\lib;C:\cygwin\usr\bin;

O2P_MIRROR
C:\Open2Dprot\subProjects

XMLBEANS_HOME
C:\xmlbeans\xmlbeans-2.0.0: %IDE_WS%\O2P
IDE_WS
C:\ED

JAVA_HOME
C:\JDK\jdk1.5.0_04

LAUNCH4J
%IDE_WS%\launch4j

PATH
%JAVA_HOME%\bin;
%XMLBEANS_HOME%\bin;
%ANT_HOME%\bin;
C:\cygwin\bin;C:\cygwin\lib;C:\cygwin\usr\bin;

O2P_MIRROR
C:\Open2Dprot\subProjects

XMLBEANS_HOME
C:\xmlbeans\xmlbeans-2.0.0: C:\ED
JAVA_HOME C:\JDK\jdk1.5.0_04 LAUNCH4J %IDE_WS%\launch4j PATH %JAVA_HOME%\bin; %XMLBEANS_HOME%\bin; %ANT_HOME%\bin; C:\cygwin\bin;C:\cygwin\lib;C:\cygwin\usr\bin; O2P_MIRROR C:\Open2Dprot\subProjects XMLBEANS_HOME C:\xmlbeans\xmlbeans-2.0.0: C:\JDK\jdk1.5.0_04
LAUNCH4J %IDE_WS%\launch4j PATH %JAVA_HOME%\bin; %XMLBEANS_HOME%\bin; %ANT_HOME%\bin; C:\cygwin\bin;C:\cygwin\lib;C:\cygwin\usr\bin; O2P_MIRROR C:\Open2Dprot\subProjects XMLBEANS_HOME C:\xmlbeans\xmlbeans-2.0.0: %IDE_WS%\launch4j
PATH %JAVA_HOME%\bin; %XMLBEANS_HOME%\bin; %ANT_HOME%\bin; C:\cygwin\bin;C:\cygwin\lib;C:\cygwin\usr\bin; O2P_MIRROR C:\Open2Dprot\subProjects XMLBEANS_HOME C:\xmlbeans\xmlbeans-2.0.0: %JAVA_HOME%\bin;
%XMLBEANS_HOME%\bin;
%ANT_HOME%\bin;
C:\cygwin\bin;C:\cygwin\lib;C:\cygwin\usr\bin;
O2P_MIRROR C:\Open2Dprot\subProjects XMLBEANS_HOME C:\xmlbeans\xmlbeans-2.0.0: C:\Open2Dprot\subProjects
XMLBEANS_HOME C:\xmlbeans\xmlbeans-2.0.0: C:\xmlbeans\xmlbeans-2.0.0

12/09/2005