Package com.ccg.macros

Text Macro Processing Classes..

See:
Description

Interface Summary

Interpreter	This interface should be implemented by all macro processors.
MacroHandler	Describe...
Output	Interface defining what to do with text generated from output.

Class Summary

At	A command line implementation of "@macros".
AtMacros	Implementation of a "@macro" Interpreter.
Input	Describe...
InputReader	Describe...
MacroHandlerMethod
OutputNull	A "null" output device for interpreter output.
OutputStringBuffer	A Output implementation which uses a string buffer.
OutputWriter	Describe...
TableField
TableInsert

Exception Summary

InterpretException

Base exception class for errors which occur while processing macros.

Package com.ccg.macros Description

Text Macro Processing Classes..

NOTE: This package is not properly javadoc(ed) at this time!

Many more years ago than this programmer cares to count, the beauty of macro processing became apparent. This started with the exposure to power of some macros created for Microsoft's Macro Assembler which made assembly code resemble a structured language. It continued with text formatting packages (in particular Final Word).

Later, during a transition from a DOS environment (using Forth/Assembler) to a Unix environment (using C), the discovery of the m4 macro utility was made. While m4 is a very powerful macro processor, it is not very easy to master (or use in some cases). In addition, while versions of it can be found that run on non Unix environments, one can not depend upon finding it installed on a machine.

So, this package is dedicated to the purpose of making classes and functions which can serve as macro processers. These utilities can be used to translate text on any Java platform.

License/Use Information

The license text below the dashed line pertains to the "com/ccg" and
"com/include" libraries, documentation, executable binaries, and the
source code as distributed in this package by Paul Blankenbaker
(paul@mekwin.com).

------------------------------------------------------------------------------
This software is copyrighted by Paul Blankenbaker, Global
Atmospherics, Inc. and Unified Technologies, Inc., and other parties.
The following terms apply to all files associated with the software
unless explicitly disclaimed in individual files.

The authors hereby grant permission to use, copy, modify, distribute,
and license this software and its documentation for any purpose, provided
that existing copyright notices are retained in all copies and that this
notice is included verbatim in any distributions. No written agreement,
license, or royalty fee is required for any of the authorized uses.
Modifications to this software may be copyrighted by their authors
and need not follow the licensing terms described here, provided that
the new terms are clearly indicated on the first page of each file where
they apply.

IN NO EVENT SHALL THE AUTHORS OR DISTRIBUTORS BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE, ITS DOCUMENTATION, OR ANY
DERIVATIVES THEREOF, EVEN IF THE AUTHORS HAVE BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

THE AUTHORS AND DISTRIBUTORS SPECIFICALLY DISCLAIM ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.  THIS SOFTWARE
IS PROVIDED ON AN "AS IS" BASIS, AND THE AUTHORS AND DISTRIBUTORS HAVE
NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR
MODIFICATIONS.

RESTRICTED RIGHTS: Use, duplication or disclosure by the government
is subject to the restrictions as set forth in subparagraph (c) (1) (ii)
of the Rights in Technical Data and Computer Software Clause as DFARS
252.227-7013 and FAR 52.227-19.