Software Development Kit
Software Development Kit
Compiling plug-ins "by hand"
Use the following commands
to build a plug-in archive: javac -cp DLSim3.jar plugins/*.java
jar cf Plugins.jar plugins/*.class META-INF/dlsim.prop
This assumes that
- javac invokes Java 1.6 or later;
- DLSim3.jar is on the classpath;
- the root of your plug-in tree is plugins; and
- the subdirectory META-INF contains dlsim.prop.
Using Ant
The plug-in Software Development Kit (SDK) uses Apache Ant to manage
plug-in projects. An "ant" directory is provided to simplify the
process of building and deploying DLSim 3 with plug-ins. Ant is a
sophisticated extension to the Unix make program designed
especially for coping with the needs of Java. Ant uses an XML-based
language (usually contained in a file called build.xml) to describe
the make process.
Ant is written in Java and consequently available for download to any
platform from Apache. Installing ant is all you need to do in order to
be able to use this directory. See
http://ant.apache.org/manual/install.html. You should familiarize
yourself with ant through their tutorial or other easily found on-line
resources.
The contents of the ant directory are as follows:
| build |
|
Directory containing target files |
| build/classes |
|
Build subdirectory containing compiled java classes
(empty in the distribution zip file) |
| build/jar |
|
Build subdirectory containing jar files
(empty in the distribution zip file) |
| build.xml |
|
ant "makefile" |
| circuits |
|
Directory provided to contain user-designed circuits |
| lib |
|
Contains distributed versions of DLSim3.jar and dlsim.prop |
| src |
|
Directory containing plugin source files. In the SDK distribution it
contains the source code of the sample plug-ins. |
Commands
The following commands must be executed from the ant directory:
- ant clean
- deletes the build directory.
- ant compile
- compiles any out-of-date plugin source files
(to the build/classes directory).
- ant
ant jar - compiles any out-of-date plugin source files
and builds the jar file Plugins.jar (including lib/dlsim.prop) in
the build/jar directory. Also copies DLSim3.jar to the build/jar
directory.
- ant all
- rebuilds everything.
- ant run
- runs DLSim 3(including all plugins).
To Start
Run ant all to build the program.
Requirements
- All plugin source files must reside below src/plugins.
- Any auxiliary files should be placed in resource directories
below the plugin source directories (since these are included in the
plugin archive).
- Edit lib/dlsim.props to be your dlsim properties file.
- Keep the latest version of DLSim3.jar in the lib directory.
- You may have to edit build.xml to adjust the stack and
heap parameters passed to the JVM when invoking DLSim3.jar.