$Id: README,v 1.10 2006/03/17 19:55:32 obecker Exp $

This module contains Java source files for Joost.

The file build.xml is the Ant buildfile. Apache Ant is a Java-based build tool
and can be downloaded from http://ant.apache.org/
Required version: 1.6 or above

If you don't have Ant and just want to use your preferred Java IDE then
check out the section at the end of this README.

For compiling you need several jars in the lib subdirectory or in your
classpath respectively. The CVS contains only joostGen.jar, compiled from 
the sources in the helper module.

Additionally you have to install
- Commons Discovery from http://jakarta.apache.org/commons/discovery/
- Commons Logging from http://jakarta.apache.org/commons/logging/
  (Tested with 1.0.3 and 1.0.4)
- log4j from http://jakarta.apache.org/log4j/
  (Latest tested version: 1.2.9)
- junit.jar from http://junit.org/ (version 3.8.1) and
  xercesImpl.jar (version 2.6.0 or above) from http://xml.apache.org/xerces2-j/
  for compiling the src/test package
- fop.jar and avalon-framework-cvs-20020806.jar
  from http://xml.apache.org/fop/ 
  (Latest tested version: 0.20.5)
  for compiling sf.net.joost.emitter.FOPEmitter.java
  (avalon-framework-api-4.1.5.jar and avalon-framework-impl-4.1.5.jar work as well)
  If you don't want a FOP connection just remove this file and
  comment out some lines in sf.net.joost.Main.java
- Jakarta BSF from http://jakarta.apache.org/bsf/
- Some scripting engine which is to be used by the joost:script element.
  Check the BSF site for references which languages are supported and where to 
  get the libraries from.

In case you don't have at least Java 1.4 installed on your computer, you have to 
add manually a SAX2 compliant parser and the JAXP 1.1 interfaces, too.


This software is released under the Mozilla Public License Version 1.1,
see http://www.mozilla.org/MPL/



===========================================================================


Creating Java source files in the net.sf.joost.grammar package without Ant
--------------------------------------------------------------------------

Normally Ant calls some tools to create the missing source files. 
This section describes how to do these steps manually.
I assume that you are in a Unix environment. On a Windows platform 
just change the slashes to backslashes.

cd src/net/sf/joost/grammar
java -cp ../../../../../lib/joostGen.jar JLex.Main Yylex
java -cp ../../../../../lib/joostGen.jar net.sf.joost.helper.Preprocess Expr.cup ExprParser.cup
java -cp ../../../../../lib/joostGen.jar net.sf.joost.helper.Preprocess Pattern.cup PatternParser.cup
  in ExprParser.cup: replace manually "@@@START-NT@@@" with "Expr"
  in PatternParser.cup: replace manually "@@@START-NT@@@" with "Pattern"
java -cp ../../../../../lib/joostGen.jar java_cup.Main -parser PatternParser -symbols Sym -runtime net.sf.joost.grammar.cup -interface -compact_red -nowarn PatternParser.cup
java -cp ../../../../../lib/joostGen.jar java_cup.Main -parser ExprParser -symbols Sym -runtime net.sf.joost.grammar.cup -interface -compact_red -nowarn ExprParser.cup
cd ../../../../..

You only need to repeat these steps if you change one of the files Yylex,
Expr.cup, Pattern.cup, terminals.inc or expr.inc.