readme.txt

Standard Grammar Toolkit

***************************************************************
STDGRAM
readme.txt
Copyright (C) 2001 ClearJump, All Rights Reserved

http://www.clearjump.com
***************************************************************

Standard Grammar Interpreter
============================


I. Disclaimer
-------------
This software is provided for demonstration purposes only.

CLEARJUMP AND ITS SUPPLIERS DISCLAIM ALL OTHER WARRANTIES 
OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, 
BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.



II. Requirements
----------------
1. VC++ v5.0
2. ClearParse SDK v1.0


III. Purpose
------------
The package can be used to interpret a set of standard
syntatic elements such as strings, numbers, etc.

The elements are defined in STDGRAM.GDM file in GDML format.
The grammar is intended to be used as an addon to custom 
grammars.  Several grammars can be combined by the ClearParse
engine to build a final grammar (see the ClearParse SDK 
for more details).  The STDGRAM could be one of them.


IV. Content
-----------
1. The grammar definition STDGRAM.GDM.  The grammar defines
   strings with escape codes, several number formats, delimiters
   and identifiers.
2. A C++ class StdInterpreter.  The class has a set of
   methods to interpret the parsing tree nodes that
   contain the symbols defined by STDGRAM.GDM.
3. A sample program that uses StdInterpreter and STDGRAM.GDM.


V. Usage
--------
The sample program demonstrates how to use the StdInterpreter class.
STDGRAM.CPP is the main file in this sample.

StdInterpreter class source files are
	stdgram.h               - defines numeric identifiers for the grammar elements
	                          the values are defined by the grammar file STDGRAM.GDM.

	Interpreter.h           - defines Interpreter class, a base class for StdInterpreter
	Interpreter.cpp         - Interpreter implementation
	StdInterpreter.h        - StdInterpreter definition
	StdInterpreter.cpp      - StdInterpreter implementation

Include these files into your project to use the class.
If you'd like to change the numeric identifier for the grammar elements,
change them in STDGRAM.GDM first (see the ClearParse SDK for more details
on how to do that), then modify stdgram.h.
You can use GramEdit sample application included in the ClearParse SDK
to generate stdgram.h automatically.