@Name@ (@name@)  version @version@
README


Please read COPYING-LESSER before using this software.



This is a collection of free grammars for SableCC.


    1. List of grammars
    2. Building and testing
    3. More info



 1. The list of grammars:

   - Java 1.02
   - Java 1.1 (actually, full syntax for Java 2)
   - MiniBasic: A small, but fully functional BASIC interpreter. 
   - SableCC: The grammar of SableCC 2.x
   - SimpleC: A front-end for a SIMPLE C compiler (a three address
      code structured subset of C), along with an almost linear
      time points-to analysis.
   - IDL: IDL to C++ sytax for SableCC.
   - SmallPascal: This compiler reads Pascal source code and generates
      Jasmin source code
   - KIF (Knowledge Interchange Format)
   - OQL (Object query Language)
   - FIPA SL  (FIPA Semantic Language - http://www.fipa.org)
   - FIPA ACL (FIPA Agent Communication Language)


 2. Building and testing
 
  If you do not have ANT installed, you should install it. 
  ANT is a Java based general purpose building system and
  you can obtain the latest distro from http://jakarta.apache.org/ant/

  Once you have ANT installed, all is simple. To build all the subprojects
  go to the top level grammars directory, and execute ant
    
     > cd grammars
     > ant
     
  This will build all the necessary jar files for all the example grammars.
  To test all the generated parser on the example inputs, please type:
  
     > ant testall 
  

 2.1 Building the distributions
 
 
  Source distribution contains:
   - all the sources
   - building scripts
 
 
  Binary distribution contains:
   - all the sources
   - building scripts
   - binary executable jar files
   - all generated by SableCC files
   - generated (if any) help and developers docs
   - generated Javadocs API help  
   
   
  To build the binary and src distribution you need to get the whole 
  grammars source tree. In the top level grammars directory execute the following
  sequence:
  
  > ant 
  > ant dist
  
  or equivalently:
  
  > ant
  > ant dist-src
  > ant dist-bin
  
  
  Note: as KIF/doc and OQL/doc are empty the cvs update -dP will not create those two
  directories, you need to create them by hand, or do not use -P 
  
  Note: the process of building the distribution is time consuming. IT IS LONG! Here
  are the estimated execution times on middle class Linux PC with JDK 1.3: 
  
    ant            (8 minutes, building parsers and binary jars)
    ant dist-src   (5sec, copying, packing)
    ant dist-bin   (4 minutes, building Javadocs, copying, packing)
    
   

 3. More info
 
  If you you want to submit an additional grammar, a bug report or a 
  patch, please visit the SableCC Project web site: 
  
    http://sablecc.sourceforge.net/

  If you want to discuss these grammars, please subscribe to the
  SableCC mailing list.  You can find all the necessary information
  on the SableCC web site at: 
 
    http://sourceforge.net/mail/?group_id=5704