|
From: Colin B. <col...@bi...> - 2001-11-18 10:08:04
|
Squirrel uses the Ant build tool from Apache http://jakarta.apache.org/ant/index.html and the IzPack installer from http://www.izforge.com/izpack/ You need to use at least version 1.4 of Ant. The scripts supplied with Squirrel for these tools are oriented towards building the distribution, not towards development. Personally I load the source into an IDE and let it work out the dependencies. If you're not familiar with Ant take at look at this JavaWorld article http://www.javaworld.com/javaworld/jw-10-2000/jw-1020-ant.html In the build directory there is an Ant build script called build.xml. If you run it with the "help" target it will give a brief description of the different targets in the file. ======================= compile_fw The classes in the module squirrel-sql/fw are basic framework classes. They don't know anything about the Squirrel SQL client and could be used for other applications (if they were more robust). Ant compiles them into a fw.jar file. To compile these classes you will need the NanoXML jar which can be found in CVS at squirrel-sql/fw/lib. As the framework is enhanced it may be that other third party jars will be required, in which case they will also be kept here. ======================= compile_app The classes in the module squirrel-sql/fw are the actual SQL client application itself. They rely on the classes and libraries from squirrel-sql/fw in order to compile. ======================= compile_plugins This target will compile all the plugins. For this to work each plugin must supply an Ant build file called plugin_build.xml. This file must have a target called "build". Three parameters are passed to the build target: p_plugin.work_dir - defines a work directory that you can use for work files, E.G. .class files etc. p_plugin.dist_dir - direcory to place the plugins jar file and other files for the plugin. p_plugin.core_libs_dir - directory that contains the framework library jars and the SQuirreL client jar that you will need to compile your plugin. For an example plugin_build.xml take a look at the one for the Look and Feel plugin at /squirrel-sql/plugins/laf/plugin_build.xml ================================================== The IzPack build process runs from the Windows batch file izpack.bat. Currently it (and the IzPack config files) have a lot of hardcoding. I really need to write an Ant task for IzPack. The IzPack config file izpack-basic.xml builds a basic installer that only includes the SQL Client. The IzPack file izpack-complete.xml builds an installer which includes all the plugins as well. ================================================== I'm going to take this email, enhance it and add it as a section in the Programmers Guide. |
