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

                       Copyright  2007 Allen Baker

---------------------------------------------------------------------------
Class:         SubsHardCode
Originator:    Allen Baker (2007.09.11 13:14)
---------------------------------------------------------------------------
$RCSfile$
$Revision$
$Date$
===========================================================================
*/



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



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


import cosmicabyss.com.lib.*;



/*
=========================================================================== *//**
Description<PRE>
   This program makes string substitutions in each file specified by the
   command line arguments.
</PRE>

Usage<PRE>
   java cosmicabyss.com.app.SubsHardCode [-h -q -r] [-l [logFile]] {-x fileSpec} [-i] [-o oldString -n newString] {-ifile fileName} {-xfile fileName} fileSpecs+
      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.

   -r means RECURSE.
      It causes the program to recurse down through the trees of
      subdirectories that are rooted at the directories specified in the
      file specifiers that are on the command line.

   -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.

   -x means EXCLUDE.
      It requires a fileSpec, and causes the program to not process any
      files that match the fileSpec. This control may be put on the command
      line as many times as needed to specify all the files that should be
      excluded from processing.

      Enclosing the fileSpec in quotes is REQUIRED for any fileSpec that
      contains embedded spaces or wildcard characters.

   -xfile means EXCLUDE FILE.
      It takes a required file name parameter, and causes the program to
      read each non-empty line in the named file and treat it as the
      filespec argument to a -x control. This control may be put on the
      command line as many times as needed to specify all the files that
      contain filespecs for files that should be excluded from processing.

   -i means IGNORE CASE.
      It causes the program to ignore the case of the strings being
      matched.

   -ifile means INCLUDE FILE.
      It takes a required file name parameter, and causes the program to
      read each non-empty line in the named file and treat it as a fileSpec
      that identifies files to include in processing. This control may be
      put on the command line as many times as needed to specify all the
      files that contain filespecs for files that should be included in the
      processing.

   fileSpecs identifies the files to process.
      It is a required parameter and is one or more file specifiers that
      identify the files that the program will process.

      As many fileSpecs may be put on the command line as needed to specify
      all the files that should be included in processing.

      Enclosing the fileSpec in quotes is required for any file specifier
      that contains embedded spaces.

      Enclosing the fileSpec in quotes prevents the command line
      interpreter from trying to replace wildcard characters itself instead
      of letting SubsHardCode do it.

      The quotes surrounding the fileSpec are not needed if it contains no
      wildcard characters or spaces.
</PRE>

<P>
<DL>
   <DT>
      <B>Example usage:</B>
      <DD>
         <PRE>
            *java cosmicabyss.com.app.SubsHardCode -o"out with the old" -n"in with the new" revolution.txt
         </PRE>
      </DD>
   </DT>
   <DT>
      <B>View Source:</B>
      <DD>
         <A href="SubsHardCode.java.html">
            SubsHardCode.java
         </A>
      </DD>
   </DT>
   <DT>
      <B>Author:</B>
      <DD>
         <A href="mailto:sourcecode.v01@cosmicabyss.com">
            Allen Baker
         </A>
      </DD>
   </DT>
</DL>
*//*
=========================================================================== */
public class SubsHardCode
   {



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

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

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

      successCode = initialize(pArgs);
//
// ---------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------
//      iStrPairs = new XString[19][] =
//         {
//            { new XString("SHA-512"),           new XString("SHA512Digest")     },
//            { new XString("SHA512"),            new XString("SHA512Digest")     },
//            { new XString("Whirlpool"),         new XString("WhirlpoolDigest")  },
//            { new XString("SHA-384"),           new XString("SHA384Digest")     },
//            { new XString("SHA384"),            new XString("SHA384Digest")     },
//            { new XString("GOST3411"),          new XString("GOST3411Digest")   },
//            { new XString("SHA-256"),           new XString("SHA256Digest")     },
//            { new XString("SHA256"),            new XString("SHA256Digest")     },
//            { new XString("SHA-224"),           new XString("SHA224Digest")     },
//            { new XString("SHA224"),            new XString("SHA224Digest")     },
//            { new XString("Tiger"),             new XString("TigerDigest")      },
//            { new XString("RipeMD160"),         new XString("RipeMD160Digest")  },
//            { new XString("SHA-1"),             new XString("SHA1Digest")       },
//            { new XString("SHA1"),              new XString("SHA1Digest")       },
//            { new XString("SHA"),               new XString("SHADigest")        },
//            { new XString("MD2"),               new XString("MD2Digest")        },
//            { new XString("MD4"),               new XString("MD4Digest")        },
//            { new XString("MD5"),               new XString("MD5Digest")        },
//            { new XString("RipeMD128")          new XString("RipeMD128Digest")  }
//         };
// ---------------------------------------------------------------------------------------------------------------------
//
// ---------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------
//      iStrPairs = new XString[1][2];
//      iStrPairs[0][0]  = new XString("\"SHA\"");     iStrPairs[0][1]  = new XString("\"SHA1\"");
//      if (successCode)
//         {
//         successCode = processAllFiles();
//         }
//
//      iStrPairs = new XString[18][2];
//      iStrPairs[0][0]  = new XString("SHA512");            iStrPairs[0][1]  = new XString("SHA512Digest");
//      iStrPairs[1][0]  = new XString("SHA-512");           iStrPairs[1][1]  = new XString("SHA512Digest");
//      iStrPairs[2][0]  = new XString("Whirlpool");         iStrPairs[2][1]  = new XString("WhirlpoolDigest");
//      iStrPairs[3][0]  = new XString("SHA384");            iStrPairs[3][1]  = new XString("SHA384Digest");
//      iStrPairs[4][0]  = new XString("SHA-384");           iStrPairs[4][1]  = new XString("SHA384Digest");
//      iStrPairs[5][0]  = new XString("GOST3411");          iStrPairs[5][1]  = new XString("GOST3411Digest");
//      iStrPairs[6][0]  = new XString("SHA256");            iStrPairs[6][1]  = new XString("SHA256Digest");
//      iStrPairs[7][0]  = new XString("SHA-256");           iStrPairs[7][1]  = new XString("SHA256Digest");
//      iStrPairs[8][0]  = new XString("SHA224");            iStrPairs[8][1]  = new XString("SHA224Digest");
//      iStrPairs[9][0]  = new XString("SHA-224");           iStrPairs[9][1]  = new XString("SHA224Digest");
//      iStrPairs[10][0] = new XString("Tiger");             iStrPairs[10][1] = new XString("TigerDigest");
//      iStrPairs[11][0] = new XString("RipeMD160");         iStrPairs[11][1] = new XString("RipeMD160Digest");
//      iStrPairs[12][0] = new XString("SHA1");              iStrPairs[12][1] = new XString("SHA1Digest");
//      iStrPairs[13][0] = new XString("SHA-1");             iStrPairs[13][1] = new XString("SHA1Digest");
//      iStrPairs[14][0] = new XString("MD2");               iStrPairs[14][1] = new XString("MD2Digest");
//      iStrPairs[15][0] = new XString("MD4");               iStrPairs[15][1] = new XString("MD4Digest");
//      iStrPairs[16][0] = new XString("MD5");               iStrPairs[16][1] = new XString("MD5Digest");
//      iStrPairs[17][0] = new XString("RipeMD128");         iStrPairs[17][1] = new XString("RipeMD128Digest");
//      if (successCode)
//         {
//         successCode = processAllFiles();
//         }
//
//      iStrPairs = new XString[1][2];
//      iStrPairs[0][0]  = new XString("RipeMD2Digest56Digest");     iStrPairs[0][1]  = new XString("RipeMD256Digest");
//      if (successCode)
//         {
//         successCode = processAllFiles();
//         }
//
//      iStrPairs = new XString[1][2];
//      iStrPairs[0][0]  = new XString("DigestDigest");     iStrPairs[0][1]  = new XString("Digest");
//      if (successCode)
//         {
//         successCode = processAllFiles();
//         }
//      if (successCode)
//         {
//         successCode = processAllFiles();
//         }
//      if (successCode)
//         {
//         successCode = processAllFiles();
//         }
//
//      iStrPairs = new XString[10][2];
//      iStrPairs[0][0]  = new XString("PBEwithSHA256Digestand256bitAES-CBC-BC"   );     iStrPairs[0][1]  = new XString("PBEwithSHA256and256bitAES-CBC-BC"   );
//      iStrPairs[1][0]  = new XString("PBEwithMD5Digestand256bitAES-CBC-OPENSSL" );     iStrPairs[1][1]  = new XString("PBEwithMD5and256bitAES-CBC-OPENSSL" );
//      iStrPairs[2][0]  = new XString("PBEwithSHA256Digestand192bitAES-CBC-BC"   );     iStrPairs[2][1]  = new XString("PBEwithSHA256and192bitAES-CBC-BC"   );
//      iStrPairs[3][0]  = new XString("PBEwithMD5Digestand192bitAES-CBC-OPENSSL" );     iStrPairs[3][1]  = new XString("PBEwithMD5and192bitAES-CBC-OPENSSL" );
//      iStrPairs[4][0]  = new XString("PBEwithSHA256Digestand128bitAES-CBC-BC"   );     iStrPairs[4][1]  = new XString("PBEwithSHA256and128bitAES-CBC-BC"   );
//      iStrPairs[5][0]  = new XString("PBEwithMD5Digestand128bitAES-CBC-OPENSSL" );     iStrPairs[5][1]  = new XString("PBEwithMD5and128bitAES-CBC-OPENSSL" );
//      iStrPairs[6][0]  = new XString("PBEwithSHA1DigestandRC2"                  );     iStrPairs[6][1]  = new XString("PBEwithSHA1andRC2"                  );
//      iStrPairs[7][0]  = new XString("PBEwithSHA1DigestandDES"                  );     iStrPairs[7][1]  = new XString("PBEwithSHA1andDES"                  );
//      iStrPairs[8][0]  = new XString("PBEwithMD5DigestandRC2"                   );     iStrPairs[8][1]  = new XString("PBEwithMD5andRC2"                   );
//      iStrPairs[9][0]  = new XString("PBEwithMD5DigestandDES"                   );     iStrPairs[9][1]  = new XString("PBEwithMD5andDES"                   );
//      if (successCode)
//         {
//         successCode = processAllFiles();
//         }
// ---------------------------------------------------------------------------------------------------------------------
//
// ---------------------------------------------------------------------------------------------------------------------
// ---------------------------------------------------------------------------------------------------------------------
      iStrPairs = new XString[3][2];
      iStrPairs[0][0]  = new XString("      return\n");     iStrPairs[0][1]  = new XString("      @return\n");
      iStrPairs[1][0]  = new XString("      param\n");      iStrPairs[1][1]  = new XString("      @param\n");
      iStrPairs[2][0]  = new XString("      exception\n");  iStrPairs[2][1]  = new XString("      @exception\n");
//      iStrPairs[3][0]  = new XString("      @return ");   iStrPairs[3][1]  = new XString("      return ");
      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="SubsHardCode.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 SubsHardCode 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="SubsHardCode.java.html#002">View source</A>

   @return
      a reference to this object
   *//*
   -------------------------------------------------------------- */
   public SubsHardCode 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(SubsHardCode.class.getName());
   private static final XString  DESCRIPTION = new XString
      (
      // <Description>  Preprocessor generated String definition, Don't mess with it.
      "This program makes string substitutions in each file specified by the                                                \n" +
      "command line arguments.                                                                                              \n" +
      ""// </Description>
      );
   private static final XString  USAGE       = new XString
      (
      // <Usage>        Preprocessor generated String definition, Don't mess with it.
      "java cosmicabyss.com.app.SubsHardCode [-h -q -r] [-l [logFile]] {-x fileSpec} [-i] [-o oldString -n newString] {-ifile fileName} {-xfile fileName} fileSpecs+\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" +
      "-r means RECURSE.                                                                                                    \n" +
      "   It causes the program to recurse down through the trees of                                                        \n" +
      "   subdirectories that are rooted at the directories specified in the                                                \n" +
      "   file specifiers that are on the command line.                                                                     \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" +
      "                                                                                                                     \n" +
      "-x means EXCLUDE.                                                                                                    \n" +
      "   It requires a fileSpec, and causes the program to not process any                                                 \n" +
      "   files that match the fileSpec. This control may be put on the command                                             \n" +
      "   line as many times as needed to specify all the files that should be                                              \n" +
      "   excluded from processing.                                                                                         \n" +
      "                                                                                                                     \n" +
      "   Enclosing the fileSpec in quotes is REQUIRED for any fileSpec that                                                \n" +
      "   contains embedded spaces or wildcard characters.                                                                  \n" +
      "                                                                                                                     \n" +
      "-xfile means EXCLUDE FILE.                                                                                           \n" +
      "   It takes a required file name parameter, and causes the program to                                                \n" +
      "   read each non-empty line in the named file and treat it as the                                                    \n" +
      "   filespec argument to a -x control. This control may be put on the                                                 \n" +
      "   command line as many times as needed to specify all the files that                                                \n" +
      "   contain filespecs for files that should be excluded from processing.                                              \n" +
      "                                                                                                                     \n" +
      "-i means IGNORE CASE.                                                                                                \n" +
      "   It causes the program to ignore the case of the strings being                                                     \n" +
      "   matched.                                                                                                          \n" +
      "                                                                                                                     \n" +
      "-ifile means INCLUDE FILE.                                                                                           \n" +
      "   It takes a required file name parameter, and causes the program to                                                \n" +
      "   read each non-empty line in the named file and treat it as a fileSpec                                             \n" +
      "   that identifies files to include in processing. This control may be                                               \n" +
      "   put on the command line as many times as needed to specify all the                                                \n" +
      "   files that contain filespecs for files that should be included in the                                             \n" +
      "   processing.                                                                                                       \n" +
      "                                                                                                                     \n" +
      "fileSpecs identifies the files to process.                                                                           \n" +
      "   It is a required parameter and is one or more file specifiers that                                                \n" +
      "   identify the files that the program will process.                                                                 \n" +
      "                                                                                                                     \n" +
      "   As many fileSpecs may be put on the command line as needed to specify                                             \n" +
      "   all the files that should be included in processing.                                                              \n" +
      "                                                                                                                     \n" +
      "   Enclosing the fileSpec in quotes is required for any file specifier                                               \n" +
      "   that contains embedded spaces.                                                                                    \n" +
      "                                                                                                                     \n" +
      "   Enclosing the fileSpec in quotes prevents the command line                                                        \n" +
      "   interpreter from trying to replace wildcard characters itself instead                                             \n" +
      "   of letting SubsHardCode do it.                                                                                    \n" +
      "                                                                                                                     \n" +
      "   The quotes surrounding the fileSpec are not needed if it contains no                                              \n" +
      "   wildcard characters or spaces.                                                                                    \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;
   private XString           iNew              = null;
   private XString           iOld              = null;
   private boolean           iCaseSensitive    = true;
   private XString[][]       iStrPairs         = null;



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

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

   @return
      a success code of true if all goes well, false otherwise.
   *//*
   -------------------------------------------------------------- */
   private boolean processAllFiles() throws Exception
      {
      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";
      /*
      ===============================================
      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);
         }
      /*
      ===============================================
      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="SubsHardCode.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;
      TextFile  inFile      = new TextFile(pFileName);
      /*
      ===============================================
      this method makes no sense on directory files, this must be a normal
      file
      ----------------------------------------------- */
      if (inFile.isDirectory()) return successCode;
      /*
      ===============================================
      do the string replacement.
      ----------------------------------------------- */
      if (iStrPairs != null)                inFile.replace(iStrPairs,iCaseSensitive);
      if ((iOld != null) && (iNew != null)) inFile.replace(iOld,iNew,iCaseSensitive);
      /*
      ===============================================
      ----------------------------------------------- */
      TextReaderIterator  inIter = inFile.iterator();
      /*
      ===============================================
      ----------------------------------------------- */
      while (inIter.hasNext())
         {
         XString  line = inIter.next();
         }
      /*
      ===============================================
      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="SubsHardCode.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="SubsHardCode.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(":hqrsl::x:i");
      cmdLn.addControl("-xfile","required");
      cmdLn.addControl("-ifile","required");
      /*
      ===============================================
      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 (includedFileSpecs.isEmpty())
         {
         cOut.println("COMMAND LINE ERROR: MANDATORY control NOT on command line:  fileSpecs");
         }
      if ((result == false) || (includedFileSpecs.isEmpty()))
         {
         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 (ctl.equals("-i"))
            {
            iCaseSensitive = false;
            }
         }
      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 (ctl.equals("-n"))
            {
            iNew = argStr;
            }
         if (ctl.equals("-o"))
            {
            iOld = argStr;
            }
         if (ctl.equals("-f"))
            {
            iStrPairs = UStringPairs.readStrings(argStr);
            }
         }
      if (controlsWithArgs.size() > 0) cOut.println();
      /*
      ===============================================
      get a list of all the files names that will be processed
      ----------------------------------------------- */
      for (XString  fileSpec : includedFileSpecs)
         {
         cOut.println("Files matching this fileSpec will be INcluded: " + fileSpec);
         }
      if (includedFileSpecs.size() > 0) cOut.println();
      for (XString  fileSpec : excludedFileSpecs)
         {
         cOut.println("Files matching this fileSpec will be EXcluded: " + fileSpec);
         }
      if (excludedFileSpecs.size() > 0) cOut.println();
      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="SubsHardCode.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 SubsHardCode 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.SubsHardCode [-h -q -r] [-l [logFile]] {-x fileSpec} [-i] [-o oldString -n newString] {-ifile fileName} {-xfile fileName} fileSpecs+
      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.

   -r means RECURSE.
      It causes the program to recurse down through the trees of
      subdirectories that are rooted at the directories specified in the
      file specifiers that are on the command line.

   -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.

   -x means EXCLUDE.
      It requires a fileSpec, and causes the program to not process any
      files that match the fileSpec. This control may be put on the command
      line as many times as needed to specify all the files that should be
      excluded from processing.

      Enclosing the fileSpec in quotes is REQUIRED for any fileSpec that
      contains embedded spaces or wildcard characters.

   -xfile means EXCLUDE FILE.
      It takes a required file name parameter, and causes the program to
      read each non-empty line in the named file and treat it as the
      filespec argument to a -x control. This control may be put on the
      command line as many times as needed to specify all the files that
      contain filespecs for files that should be excluded from processing.

   -i means IGNORE CASE.
      It causes the program to ignore the case of the strings being
      matched.

   -ifile means INCLUDE FILE.
      It takes a required file name parameter, and causes the program to
      read each non-empty line in the named file and treat it as a fileSpec
      that identifies files to include in processing. This control may be
      put on the command line as many times as needed to specify all the
      files that contain filespecs for files that should be included in the
      processing.

   fileSpecs identifies the files to process.
      It is a required parameter and is one or more file specifiers that
      identify the files that the program will process.

      As many fileSpecs may be put on the command line as needed to specify
      all the files that should be included in processing.

      Enclosing the fileSpec in quotes is required for any file specifier
      that contains embedded spaces.

      Enclosing the fileSpec in quotes prevents the command line
      interpreter from trying to replace wildcard characters itself instead
      of letting SubsHardCode do it.

      The quotes surrounding the fileSpec are not needed if it contains no
      wildcard characters or spaces.
   </PRE>

   <P><B>Implementation: </B><A HREF="SubsHardCode.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
      {
      SubsHardCode  thisSubs = new SubsHardCode(pArgs);
      }



   }  // class SubsHardCode



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