/*
===========================================================================

                       Copyright  2007 Allen Baker

---------------------------------------------------------------------------
Class:         CompileAll
Originator:    Allen Baker (2007.09.09 18:03)
---------------------------------------------------------------------------
$RCSfile$
$Revision$
$Date$
===========================================================================
*/



/*
===============================================
Package
----------------------------------------------- */
package cosmicabyss.com.app;



/*
===============================================
Imports
----------------------------------------------- */
import java.io.*;
import java.util.*;


import cosmicabyss.com.lib.*;



/*
=========================================================================== *//**
Description<PRE>
   This program preprocesses, compiles, and generates an HTML file of the
   source for all the java files in the current directory.
</PRE>

Usage<PRE>
   java cosmicabyss.com.app.CompileAll [-h -q] [-l [logFile]]
      Arguments can be placed in any order on the command line.

   -h means HELP.
      It causes this usage message to be displayed, and terminates the
      program.

   -q means QUIET.
      It stops the program from sending log messages to stdout. The program
      sends log messages to stdout by default; this option is the only way
      to stop it from doing that.

   -l means LOGFILE.
      It takes an optional file name parameter, and causes the program to
      send log messages to the named file. If the file name is not present,
      the program generates a default file name. If the environment
      variable LOGDIRECTORY is defined, the program places the file in that
      directory. If not, the program places the file in the current
      directory. The program continues to send log messages to stdout too,
      unless the -q option is used.
</PRE>

<P>
<DL>
   <DT>
      <B>Example usage:</B>
      <DD>
         <PRE>
            *java cosmicabyss.com.app.CompileAll
         </PRE>
      </DD>
   </DT>
   <DT>
      <B>View Source:</B>
      <DD>
         <A href="CompileAll.java.html">
            CompileAll.java
         </A>
      </DD>
   </DT>
   <DT>
      <B>Author:</B>
      <DD>
         <A href="mailto:sourcecode.v01@cosmicabyss.com">
            Allen Baker
         </A>
      </DD>
   </DT>
</DL>
*//*
=========================================================================== */
public class CompileAll
   {



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method creates a CompileAll class object and runs the
   application to completion.

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#000">View source</A>

   @param
      pArgs contains the command line arguments with which the class was
      invoked as an application.
   *//*
   -------------------------------------------------------------- */
   public <Type> CompileAll(Type[] pArgs) throws Exception
      {
      boolean  successCode = true;

      successCode = initialize(pArgs);
      if (successCode)
         {
         successCode = processAllFiles();
         }
      cOut.println
         (
         CLASS_NAME.string() +
         (successCode? " completed successfully." : " completed with problems.")
         );
      cOut.println();
      cOut.stopLog();
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method sets the ConsoleStream for this object.

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#001">View source</A>

   @return
      a reference to this object

   @param
      pConsole is a ConsoleStream through which this objects sends its
      output.
   *//*
   -------------------------------------------------------------- */
   public CompileAll setOut(ConsoleStream pConsole)
      {
      cOut = pConsole;
      return this;
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This boilerplate method is used for testing an instantiated object of
   this class and may include any code the developer chooses.

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#002">View source</A>

   @return
      a reference to this object
   *//*
   -------------------------------------------------------------- */
   public CompileAll test() throws Exception
      {
      cOut.titledPrintf
         (
         "\"HELLO WORLD!\"",
         "%s  %s  %s",
         "I'm an object of the", CLASS_NAME, "class, and I approved this message."
         );
      return this;
      }



   /*
   ===================================================================
   ===================================================================
                --------------- Protected ---------------
   =================================================================== */



   /*
   ===================================================================
   ===================================================================
                 --------------- Private ---------------
   =================================================================== */



   /*
   ===============================================
   Class Constants
      CLASS_NAME  : the name of this class
      DESCRIPTION : the man page description of this application
      USAGE       : the man page usage information for this application
   ----------------------------------------------- */
   private static final XString  CLASS_NAME  = new XString(CompileAll.class.getName());
   private static final XString  DESCRIPTION = new XString
      (
      // <Description>  Preprocessor generated String definition, Don't mess with it.
      "This program preprocesses, compiles, and generates an HTML file of the                                               \n" +
      "source for all the java files in the current directory.                                                              \n" +
      ""// </Description>
      );
   private static final XString  USAGE       = new XString
      (
      // <Usage>        Preprocessor generated String definition, Don't mess with it.
      "java cosmicabyss.com.app.CompileAll [-h -q] [-l [logFile]]                                                           \n" +
      "   Arguments can be placed in any order on the command line.                                                         \n" +
      "                                                                                                                     \n" +
      "-h means HELP.                                                                                                       \n" +
      "   It causes this usage message to be displayed, and terminates the                                                  \n" +
      "   program.                                                                                                          \n" +
      "                                                                                                                     \n" +
      "-q means QUIET.                                                                                                      \n" +
      "   It stops the program from sending log messages to stdout. The program                                             \n" +
      "   sends log messages to stdout by default; this option is the only way                                              \n" +
      "   to stop it from doing that.                                                                                       \n" +
      "                                                                                                                     \n" +
      "-l means LOGFILE.                                                                                                    \n" +
      "   It takes an optional file name parameter, and causes the program to                                               \n" +
      "   send log messages to the named file. If the file name is not present,                                             \n" +
      "   the program generates a default file name. If the environment                                                     \n" +
      "   variable LOGDIRECTORY is defined, the program places the file in that                                             \n" +
      "   directory. If not, the program places the file in the current                                                     \n" +
      "   directory. The program continues to send log messages to stdout too,                                              \n" +
      "   unless the -q option is used.                                                                                     \n" +
      ""// </Usage>
      );
   /*
   ===============================================
   Class variables
      cOut : console output.
   ----------------------------------------------- */
   private static ConsoleStream  cOut = ConsoleStream.getSingleton();
   /*
   ===============================================
   Instance variables
      iFileNameList     : the list of all file names that match the
                          filespecs given on the command line.
      iGlobalProperties : a copy of all the environment variables.
   ----------------------------------------------- */
   private FileNameList      iFileNameList     = null;
   private GlobalProperties  iGlobalProperties = null;



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method performs the core processing functions of this application.

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#003">View source</A>

   @return
      a success code of true if all goes well, false otherwise.
   *//*
   -------------------------------------------------------------- */
   private boolean processAllFiles() throws Exception
      {
      boolean  returnCode  = true;
      boolean  successCode = true;
      String   fmtStr;
      /*
      ===============================================
      tell 'em what we're gonna do
      ----------------------------------------------- */
      cOut.println("Plan","Will process " + iFileNameList.size() + " files.");
      if      (iFileNameList.size() > 99999) fmtStr = "%06d";
      else if (iFileNameList.size() >  9999) fmtStr = "%05d";
      else if (iFileNameList.size() >   999) fmtStr = "%04d";
      else if (iFileNameList.size() >    99) fmtStr = "%03d";
      else if (iFileNameList.size() >     9) fmtStr = "%02d";
      else                                   fmtStr = "%d";
      /*
      ===============================================
      make sure there's a tag file where we can find it for converting java
      to html.
      ----------------------------------------------- */
      XString  myJavaHome = iGlobalProperties.getProperty(new XString("MY_JAVA_HOME"));
      XFile    tagFile    = new XFile("tags.j2h");
      if ( ! tagFile.exists())
         {
         XString  copyCmd = new XString("copy " + myJavaHome + "/tools/bin/Java2Html/tags.j2h .");
         returnCode = (Util.runExternalProgram(copyCmd) == 0);
         if ( ! returnCode)
            {
            cOut.println(Const.WARNING,"Copy failed for: tags.j2h");
            successCode = false;
            }
         }
      /*
      ===============================================
      do it for each file in the FileNameList
      ----------------------------------------------- */
      int  filesProcessed = 0;
      for (XString  fileName : iFileNameList)
         {
         XFile    file          = new XFile(fileName);
         XString  canonicalPath = new XString(file.getCanonicalPath());
         /*
         ===============================================
         tell 'em which file is being processed next
         ----------------------------------------------- */
         filesProcessed++;
         cOut.printf("[" + fmtStr + "] Processing: %s\n",filesProcessed,canonicalPath);
         /*
         ===============================================
         process the file
         ----------------------------------------------- */
         successCode &= processThisFile(canonicalPath);
         }
      /*
      ===============================================
      compile all the java files in the current directory
      ----------------------------------------------- */
      XString  classDir   = iGlobalProperties.getProperty(new XString("CLASSDIR"));
      XString  compileCmd = new XString("javac -Xlint:unchecked -Xlint:deprecation -d " + classDir + " *.java");
      cOut.printf("Compiling [" + fmtStr + "] files ...\n",filesProcessed);
      returnCode = (Util.runExternalProgram(compileCmd) == 0);
      if ( ! returnCode)
         {
         cOut.println(Const.WARNING,"Compilation failed");
         successCode = false;
         }
      /*
      ===============================================
      tell 'em what we did
      ----------------------------------------------- */
      cOut.println("Result","Processed " + filesProcessed + " of an expected " + iFileNameList.size() + " files.");
      return successCode;
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method performs the core processing functions of this application
   on one file.

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#004">View source</A>

   @return
      a success code of true if all goes well, false otherwise.

   @param
      pFileName is the name of the file to process.
   *//*
   -------------------------------------------------------------- */
   private boolean processThisFile(XString pFileName) throws Exception
      {
      boolean   successCode = true;
      boolean   returnCode  = true;
      JavaFile  inFile      = new JavaFile(pFileName);
      /*
      ===============================================
      this method makes no sense on directory files, this must be a normal
      file
      ----------------------------------------------- */
      if (inFile.isDirectory()) return successCode;
      /*
      ===============================================
      preprocess the java source
      ----------------------------------------------- */
      inFile.preprocess();
      /*
      ===============================================
      make an html version of the source java
      ----------------------------------------------- */
      XString  htmlFileName = pFileName.concat(".html");
      JavaHtmlFile f = new JavaHtmlFile(htmlFileName);
      f.create();
      /*
      ===============================================
      tell 'em how it went
      ----------------------------------------------- */
      return successCode;
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method displays the command line arguments that this program was
   invoked with.

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#005">View source</A>

   @return
      nothing

   @param
      pArgs contains the command line arguments with which the class was
      invoked as an application.
   *//*
   -------------------------------------------------------------- */
   private <Type> void showArgs(Type[] pArgs) throws Exception
      {
      XString  str = new XString("");
      for (int i=0; i<pArgs.length; i++)
         {
         str = str.concat(UString.toString(pArgs[i]) + "   ");
         }
      cOut.println("Command Line Arguments",str);
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method processes the command line arguments and based on what it
   finds, sets the instance variables.

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#006">View source</A>

   @return
      a success code of true if all goes well, false otherwise.

   @param
      pArgs contains the command line arguments with which the class was
      invoked as an application.
   *//*
   -------------------------------------------------------------- */
   private <Type> boolean initialize(Type[] pArgs) throws Exception
      {
      boolean  successCode = true;
      /*
      ===============================================
      Greetings !
      ----------------------------------------------- */
      System.out.println();
      System.out.println();
      System.out.println();
      System.out.println();
      cOut.banner(CLASS_NAME);
      System.out.println();
      /*
      ===============================================
      tell the user what command line arges this program started with
      ----------------------------------------------- */
      showArgs(pArgs);
      /*
      ===============================================
      this cannot be done statically because it throws an exception.
      ----------------------------------------------- */
      iGlobalProperties = new GlobalProperties();
      /*
      ===============================================
      get ready to process the command line arguments
      ----------------------------------------------- */
      CommandLine  cmdLn = new CommandLine(CLASS_NAME,pArgs);
      /*
      ===============================================
      these are the valid command line controls
      ----------------------------------------------- */
      cmdLn.addControlsFromString(":hql::");
      cmdLn.makeControlNonMandatory("+");
      /*
      ===============================================
      list the valid controls
      ----------------------------------------------- */
      cmdLn.listControls();
      cOut.println();
      /*
      ===============================================
      interpret the arguments on the command line
      ----------------------------------------------- */
      HashSet<XString>          controlsWithoutArgs = new HashSet<XString>();
      HashMap<XString,XString>  controlsWithArgs    = new HashMap<XString,XString>();
      ArrayList<XString>        excludedFileSpecs   = new ArrayList<XString>();
      ArrayList<XString>        includedFileSpecs   = new ArrayList<XString>();
      boolean                   result              = cmdLn.commandLineArgs
         (
         iGlobalProperties  ,
         controlsWithoutArgs,
         controlsWithArgs   ,
         excludedFileSpecs  ,
         includedFileSpecs
         );
      /*
      ===============================================
      if the command line was messed up, abort the program
      ----------------------------------------------- */
      if (result == false)
         {
         usage();
         cOut.titledSeverityPrintf
            (
            Const.HALT,
            CLASS_NAME,
            "Command line error."
            );
         cOut.stopLog();
         System.exit(-1);
         }
      /*
      ===============================================
      arguments for the FileNameList with their default values.  Some of
      these arguments may be modified by commandline controls.
      ----------------------------------------------- */
      boolean  recurse             = false;
      boolean  fullyQualifiedNames = true;
      boolean  matchSubdirs        = false;
      boolean  sort                = true;
      boolean  collapse            = false;
      /*
      ===============================================
      process commandline controls without arguments
      ----------------------------------------------- */
      for (XString  ctl : controlsWithoutArgs)
         {
         cOut.println(ctl.string() + " control is present.");
         if (ctl.equals("-h"))
            {
            usage();
            cOut.stopLog();
            System.exit(-1);
            }
         recurse      |= ctl.equals("-r");
         matchSubdirs |= ctl.equals("-s");
         }
      if (controlsWithoutArgs.size() > 0) cOut.println();
      /*
      ===============================================
      process commandline controls with arguments
      ----------------------------------------------- */
      Set<XString>  set = controlsWithArgs.keySet();
      for (XString  ctl : set)
         {
         XString argStr = controlsWithArgs.get(ctl);
         cOut.println(ctl + " control is present with the argument: " + argStr);
         }
      if (controlsWithArgs.size() > 0) cOut.println();
      /*
      ===============================================
      get a list of all the files names that will be processed
      ----------------------------------------------- */
      cOut.println("Files matching this fileSpec will be INcluded: *.java");
      cOut.println();
      includedFileSpecs = new ArrayList<XString>();
      includedFileSpecs.add(new XString("*.java"));
      iFileNameList = new FileNameList
         (
         includedFileSpecs,excludedFileSpecs,recurse,fullyQualifiedNames,matchSubdirs,sort,collapse
         );
      /*
      ===============================================
      ----------------------------------------------- */
      return successCode;
      }



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method writes a usage message to the log

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#007">View source</A>

   @return
      nothing
   *//*
   -------------------------------------------------------------- */
   private void usage()
      {
      cOut.println("Program Description",DESCRIPTION);
      cOut.println("Usage",USAGE);
      }



   /*
   ===================================================================
   ===================================================================
              --------------- Inner Classes ---------------
   =================================================================== */



   /*
   ===================================================================
   ===================================================================
          --------------- Public Static Methods ---------------
   =================================================================== */



   /*:                 
   ==============================================================
   ============================================================== *//**
   This method runs the CompileAll class as a standalone application.
   It's the method that's called when the class is invoked from the command
   line by using the java application launcher - "java".

   Usage<PRE>
   java cosmicabyss.com.app.CompileAll [-h -q] [-l [logFile]]
      Arguments can be placed in any order on the command line.

   -h means HELP.
      It causes this usage message to be displayed, and terminates the
      program.

   -q means QUIET.
      It stops the program from sending log messages to stdout. The program
      sends log messages to stdout by default; this option is the only way
      to stop it from doing that.

   -l means LOGFILE.
      It takes an optional file name parameter, and causes the program to
      send log messages to the named file. If the file name is not present,
      the program generates a default file name. If the environment
      variable LOGDIRECTORY is defined, the program places the file in that
      directory. If not, the program places the file in the current
      directory. The program continues to send log messages to stdout too,
      unless the -q option is used.
   </PRE>

   <P><B>Implementation: </B><A HREF="CompileAll.java.html#008">View source</A>

   @return
      nothing

   @param
      pArgs contains the command line arguments with which the class was
      invoked as an application.
   *//*
   -------------------------------------------------------------- */
   public static void main(String[] pArgs) throws Exception
      {
      CompileAll  thisCompileAll = new CompileAll(pArgs);
      }



   }  // class CompileAll



   /*
   ===================================================================
   ===================================================================
              ------------------- Notes -------------------
   =================================================================== */