// --------------------------------------------------------------------
// HybridSAL
// Copyright (C) 2006, SRI International.  All Rights Reserved.
// 
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
// --------------------------------------------------------------------

----------------------------------------------------
HybridSAL2Xml: (Last updated: 05/25/07)
----------------------------------------------------
----------------------------------------------------
Topics: 
1. Requirements
2. Install
3. Test
4. How this works
5. hybridsal2xml vs sal2xml
----------------------------------------------------
REQUIREMENTS:
- Java is installed and running
- antlr-2.7.1 
  (may work with other antlr v2, but not tested
   with antlr version 3 and beyond)

(*)If you wish to create the .java and .class files,
you will additionally need:
- jikes-1.22 
- jre/lib/rt.jar (usually part of JAVA distribution;
  required for java.lang)
----------------------------------------------------
INSTALL:
- tar -xzvf hybrisal2xml.tgz
- cd hybridsal2xml
- ./install <ANTLR_PATH>

(*) If you wish to create the .java and .class files
locally, then do the following:
- tar -xzvf hybridsal2xml.tgz
- cd hybridsal2xml
- make cleanall
- ./install <ANTLR_PATH> <RTJAR_PATH> <JIKES_PATH>

Example:
./install.sh /homes/tiwari/softwares/antlr-2.7.1/ /csl/java/current_version/jre/lib/rt.jar /homes/tiwari/softwares/jikes-1.22/src/jikes
Important:
 <ANTLR_PATH>/antlr.jar should exist
 <RTJAR_PATH> should exist as a .jar file
 <JIKES_PATH> should be the executable "jikes"
----------------------------------------------------
TEST:
- hybridsal2xml examples/SimpleThermo3.sal > examples/SimpleThermo3.xml
 This should create a new XML file corresponding to
 the hybridsal file SimpleThermo3.sal
----------------------------------------------------
(*) The way this works is:
Antler .g file is translated into .java files, which
are used to create the hybridsal2xml.class file.
----------------------------------------------------
DIFFERENCES: hybridsal2xml vs sal2xml
* HybridSal has INVARIANT declaration section
* HybridSal supports INITFORMULA for initialization
----------------------------------------------------
Author: Ashish Tiwari (tiwari@csl.sri.com)
----------------------------------------------------

