/*----------------------------------------------------------------

  * $Id: All.java,v 1.1.1.1 2005/06/08 02:39:52 pkb Exp $

  * 

  * (c)2001 - Paul Blankenbaker */

 //----------------------------------------------------------------

 package com.ccg.macros.at;

 import com.ccg.util.*;

 import com.ccg.io.*;

 import com.ccg.macros.*;

 import java.io.*;

 //----------------------------------------------------------------

 /** A simple command line utility that can be used to test all {@link

  * Base Base} classes in the package.

  * 

  * <p>This simple test utility creates a {@link AtMacros AtMacros}

  * object, registers and installs ALL ({@link Core Core}, {@link Html

  * Html}, etc) of the {@link Base Base} derived macro handlers defined

  * in the package. And then processes the standard input out to the

  * standard output.</p>

  *

  * <p>The end result is a fairly powerful macro processing language (I

  * use it all the time to generate/tweak HTML code).</p>

  *

  * <p>The following command line options are recognized:</p>

  *

  * <p>You can use many of the standard command line options which the

  * {@link CommandLineUtility CommandLineUtility} class recognizes. In

  * addtion, the following command line options are recognized:

  *

  * <dl>

  *

  * <dt><b>-Dname=val</b></dt><dd>This allows one to define macros on

  * the command line. You may include zero or more definitions. For

  * example "-Dfirst=Paul -Dlast=Blankenbaker" on the command line is

  * equivalent to

  * '@define("first","Paul")@define("last","Blankenbaker")' in a source

  * file. This allows one to pass/define values outside of the source

  * files.</dd>

  *

  * <dt><b>-nodefaults [true|false]</b></dt><dd>Specify this option to

  * turn off the loading of the user's default macro definitions. By

  * default, this application first tries to load the file

  * "$HOME/.etc/com/ccg/macros/default.At" (discarding all output) to

  * allow one to load a set of custom definitions (if this file isn't

  * found, it isn't loaded). Use the "-nodefaults" option to disable

  * this feature.</dd>

  *

  * </dl>

  * 

  * <p>To get a rough idea of ALL of the available macros, try running

  * it in the following manner:

  *

  * <pre>

  * echo "@htmlDumpDefinitions()" | java com.ccg.macros.at.All > defs.html

  * </pre>

  * 

  * @version $Revision: 1.1.1.1 $

  * 

  * @since 1.0

  * 

  * @author $Author: pkb $

  * 

  * @see AtMacros

  * @see Base */

 //----------------------------------------------------------------

 public class All extends CommandLineUtility {

   //----------------------------------------------------------------

   /** Initializes object with a set of command line arguments.

    * 

    * <p>This constructor initializes the object with the set of

    * command line arguments to use when its {@link #run}. However,

    * this is about all that is done (we don't actually verify the

    * arguments at this point).</p>

    * 

    * @since        1.0 */

   //----------------------------------------------------------------

   public All(final String[] args) {

     super(args);

     _RawArgs = args;

   }

   //----------------------------------------------------------------

   /** Runs the macro processor.

    * 

    * <p>This method checks the command line arguments, and then runs

    * the source file through the macro processor writing the results

    * to the standard output device.</p>

    * 

    * @since        1.0 */

   //----------------------------------------------------------------

   public void run() {

     OutputWriter o = null;

     try {

       AtMacros am = new AtMacros();

       All.installAll(am);

     //----------------------------------------------------------------  

     // See if any -Dmacro=val values on command line

     //----------------------------------------------------------------

       String[] args = _RawArgs;

       for (int i = 0; i < args.length; i++) {

         String a = args[i];

         if ((a.length() > 2) && a.startsWith("-D")) {

           int epos = a.indexOf('=');

           if (epos < 0) {

             am.addMacro(a.substring(2),"");

           }

           else {

             String mname = a.substring(2,epos);

             String mval = a.substring(epos+1);

             am.addMacro(mname,mval);

           }

         }

       }

       //----------------------------------------------------------------  

       // Load default at macros (if user has any)

       //----------------------------------------------------------------

       File ifile = null;

       if (!getBoolean("nodefaults",Boolean.FALSE).booleanValue()) try {

         ConfigSource cs = new ConfigSource(At.class);

         ifile = cs.getFile();

         if (ifile.exists()) {

           am.interpret(new InputReader(ifile),OutputNull.getInstance());

         }

       } catch (Exception e) {

         Log.error("problem processing \""+ifile+"\"",e);

       }

       //----------------------------------------------------------------  

       // Now, interpret input file

       //----------------------------------------------------------------

       o = new OutputWriter(getOutputStream());

       am.interpret(new InputReader(getInputStream()),o);

     } catch (Exception e) {

       e.printStackTrace();

     } finally {

       if (o != null) try { o.close(); } catch (Throwable ignore) { }

     }

   }

   //----------------------------------------------------------------

   /** Global static method to install ALL of the macro handler objects

    * available in this package.

    * 

    * <p>This method installs ALL of the {@link Base Base} derived

    * macro handlers which one can find in this class. This is an easy

    * way to make sure that ALL of the macros defined in the {@link

    * com.ccg.macros.at} package are loaded and available to your

    * interpreter.

    *

    * @param        am

    * 

    *         The {@link AtMacros AtMacros} object to register all of the

    *         macros with. Must not be null.

    * 

    * @since        1.0 */

   //----------------------------------------------------------------

   public static void installAll(AtMacros am) {

     (new Core()).install(am);

     (new Html()).install(am);

     (new Script()).install(am);

     (new Strings()).install(am);

   }

   //----------------------------------------------------------------

   /** Create a new {@link AtMacros AtMacros} object and {@link

    * #installAll install all} standard macros.

    * 

    * <p>This is a convenience method. It constructs and initializes a

    * {@link AtMacros AtMacros} object for you in one shot.

    * 

    * @return

    * 

    *         A newly created {@link AtMacros AtMacros} object with ALL of

    *         the standard macros installed.

    * 

    * @since        1.0

    * 

    * @see AtMacros */

   //----------------------------------------------------------------

   public static AtMacros createAtMacros() {

     AtMacros macros = new AtMacros();

     installAll(macros);

     return macros;

   }

   //----------------------------------------------------------------

   /** Main entry point into the application.

    * 

    * @param        args

    * 

    *         Array of command line arguments. */

   //----------------------------------------------------------------

   static public void main(String args[]) {

     All all = new All(args);

     all.run();

   }

   //----------------------------------------------------------------  

   // private data

   //----------------------------------------------------------------

   private String[] _RawArgs;

 }