Top | Web home | SourceForge home
$Id: //guest/julian_hyde/saffron/doc/install.html#3 $
(C) Copyright 2002, Julian Hyde
Author	Julian Hyde (julian.hyde@mail.com)
Created	February 15th, 2002

How to build and install Saffron

1. Contents

1. Contents
2. Modification history
3. Setup build environment
4. Build
5. Run the demo
6. Appendix A: Product installation instructions
7. Appendix B: Coding guidelines

2. Modification history

3. Setup build environment

Here are the steps to setup a build environment.

1. Install JDK 1.3.1.
2. Install Ant.
3. Install JUnit.
4. Install JavaCC.
5. Modify build.bat, setting JAVACC_HOME, ANT_HOME, JUNIT_HOME. (It may be sufficient to just change HOME_DRIVE.)

Optional:

1. Install Jikes.

4. Build

As follows:

cd ${project.location}
build

5. Run it

To run the JUnit regression test:

build test

Or you can run class saffron.test.Main using any JUnit test harness. You can control the behavior of the test by creating a file called saffron.properties. Here is an example:

saffron.Statement.printBeforeCompile=false
saffron.debug.level=0
saffron.package.name=saffron.runtime
saffron.java.dir=D:/saffron/src/examples
saffron.class.dir=D:/saffron/classes
saffron.java.compiler.args=-classpath D:/saffron/classes -d D:/saffron/classes -verbose
saffron.test.Class=sales.InMemorySalesTestCase
saffron.test.Name=testIteratorJoin
#saffron.test.Suite=saffron.runtime.ThreadIterator$Test

You'll need an ODBC datasource called empdept in order to run the JDBC flavor of the tests.

To generate Sales2.java from Sales2.oj and compile it to Sales2.class; and to compile Test.java to Test.class:

cd ${project.location}
build compile.examples

(There is a bug in the ojavac Ant task. If you get an IOException, remove Sales2.java and try again.)

To run Sales2:

build run.sales.Sales2

Appendix A. Product installation instructions

These are the products I used to build saffron. Install all of the products marked 'required'. (I use /-es in paths because I am run MKS on Windows 2000, and it makes things simpler.)

In the following, the symbol ${project.location} means the root of your source tree.

Where the instructions suggest setting an environment variable, it is often sufficient to edit the corresponding line in ${project.location}/build.bat.

Appendix B: Coding guidelines

• Indentation 4.
• Tab stop 4 (except openjava source code, whose tab stop is 8).
• Use tabs, not space.
• K&R bracing convention (that is, open braces on the same line as the preceding 'if', 'else', 'while' statement or 'class' declaration).
• Use braces even for single-line blocks.
• Declare variables as near to their first use as possible.
• Don't initialize variables with 'dummy' values just to shut up the compiler.
• Try to keep lines shorter than 80 characters.
• Javadoc comments on methods are written in the active ('Collects garbage.') not imperative ('Collect garbage.')
• When editing HTML documents, don't use an editor which reformats the HTML source (such as Word).