args.h

Go to the documentation of this file.

/*
 * args.h
 *
 * Program Argument Parsing class
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Log: args.h,v $
 * Revision 1.28  2005/11/30 12:47:37  csoutheren
 * Removed tabs, reformatted some code, and changed tags for Doxygen
 *
 * Revision 1.27  2005/11/25 03:43:47  csoutheren
 * Fixed function argument comments to be compatible with Doxygen
 *
 * Revision 1.26  2005/11/20 22:02:59  dereksmithies
 * Fix tags so they work with doxygen.
 *
 * Revision 1.25  2005/01/26 05:37:43  csoutheren
 * Added ability to remove config file support
 *
 * Revision 1.24  2003/09/17 01:18:01  csoutheren
 * Removed recursive include file system and removed all references
 * to deprecated coooperative threading support
 *
 * Revision 1.23  2003/03/27 07:27:07  robertj
 * Added function to get a bunch of arguments as a string array.
 *
 * Revision 1.22  2002/09/16 01:08:59  robertj
 * Added #define so can select if #pragma interface/implementation is used on
 *   platform basis (eg MacOS) rather than compiler, thanks Robert Monaghan.
 *
 * Revision 1.21  2001/12/15 04:49:06  robertj
 * Added stream I/O functions for argument list.
 *
 * Revision 1.20  2000/05/25 11:05:31  robertj
 * Added PConfigArgs class so can save program arguments to config files.
 *
 * Revision 1.19  1999/03/09 02:59:49  robertj
 * Changed comments to doc++ compatible documentation.
 *
 * Revision 1.18  1999/02/16 08:07:10  robertj
 * MSVC 6.0 compatibility changes.
 *
 * Revision 1.17  1998/11/01 04:56:51  robertj
 * Added BOOl return value to Parse() to indicate there are parameters available.
 *
 * Revision 1.16  1998/10/30 11:22:14  robertj
 * Added constructors that take strings as well as const char *'s.
 *
 * Revision 1.15  1998/10/30 05:24:29  robertj
 * Added return value to << and >> operators for shifting arguments.
 *
 * Revision 1.14  1998/10/29 05:35:14  robertj
 * Fixed porblem with GetCount() == 0 if do not call Parse() function.
 *
 * Revision 1.13  1998/10/28 03:26:41  robertj
 * Added multi character arguments (-abc style) and options precede parameters mode.
 *
 * Revision 1.12  1998/10/28 00:59:46  robertj
 * New improved argument parsing.
 *
 * Revision 1.11  1998/09/23 06:20:14  robertj
 * Added open source copyright license.
 *
 * Revision 1.10  1995/12/10 11:26:38  robertj
 * Fixed signed/unsigned bug in shift count.
 *
 * Revision 1.9  1995/06/17 11:12:17  robertj
 * Documentation update.
 *
 * Revision 1.8  1995/03/14 12:40:58  robertj
 * Updated documentation to use HTML codes.
 *
 * Revision 1.7  1994/12/05  11:15:13  robertj
 * Documentation.
 *
 * Revision 1.6  1994/11/26  03:44:19  robertj
 * Documentation.
 *
 * Revision 1.6  1994/11/24  11:48:26  robertj
 * Documentation.
 *
 * Revision 1.5  1994/08/23  11:32:52  robertj
 * Oops
 *
 * Revision 1.4  1994/08/22  00:46:48  robertj
 * Added pragma fro GNU C++ compiler.
 *
 * Revision 1.3  1994/07/27  05:58:07  robertj
 * Synchronisation.
 *
 * Revision 1.2  1994/07/17  10:46:06  robertj
 * Changed to use container classes to plug memory leak.
 *
 * Revision 1.1  1994/04/01  14:08:52  robertj
 * Initial revision
 *
 */

#ifndef _PARGLIST
#define _PARGLIST

#ifdef P_USE_PRAGMA
#pragma interface
#endif

class PArgList : public PObject
{
  PCLASSINFO(PArgList, PObject);

  public:
    PArgList(
      const char * theArgPtr = NULL,        
      const char * argumentSpecPtr = NULL,  
      BOOL optionsBeforeParams = TRUE       
    );
    PArgList(
      const PString & theArgStr,             
      const char * argumentSpecPtr = NULL,   
      BOOL optionsBeforeParams = TRUE        
    );
    PArgList(
      const PString & theArgStr,             
      const PString & argumentSpecStr,       
      BOOL optionsBeforeParams = TRUE        
    );
    PArgList(
      int theArgc,                           
      char ** theArgv,                       
      const char * argumentSpecPtr = NULL,   
      BOOL optionsBeforeParams = TRUE        
    );
    PArgList(
      int theArgc,                           
      char ** theArgv,                       
      const PString & argumentSpecStr,       
      BOOL optionsBeforeParams = TRUE        
    );

    virtual void PrintOn(
      ostream & strm  
    ) const;

    virtual void ReadFrom(
      istream & strm  
    );

    void SetArgs(
      const PString & theArgStr 
    );
    void SetArgs(
      int theArgc,     
      char ** theArgv  
    );
    void SetArgs(
      const PStringArray & theArgs 
    );

    virtual BOOL Parse(
      const char * theArgumentSpec,    
      BOOL optionsBeforeParams = TRUE  
    );
    virtual BOOL Parse(
      const PString & theArgumentStr,  
      BOOL optionsBeforeParams = TRUE  
    );

    virtual PINDEX GetOptionCount(
      char optionChar        
    ) const;
    virtual PINDEX GetOptionCount(
      const char * optionStr 
    ) const;
    virtual PINDEX GetOptionCount(
      const PString & optionName 
    ) const;

    BOOL HasOption(
      char optionChar             
    ) const;
    BOOL HasOption(
      const char * optionStr     
    ) const;
    BOOL HasOption(
      const PString & optionName 
    ) const;

    virtual PString GetOptionString(
      char optionChar,          
      const char * dflt = NULL  
    ) const;
    virtual PString GetOptionString(
      const char * optionStr,   
      const char * dflt = NULL  
    ) const;
    virtual PString GetOptionString(
      const PString & optionName, 
      const char * dflt = NULL    
    ) const;

    PINDEX GetCount() const;

    PStringArray GetParameters(
      PINDEX first = 0,
      PINDEX last = P_MAX_INDEX
    ) const;

    PString GetParameter(
      PINDEX num   
    ) const;

    PString operator[](
      PINDEX num   
    ) const;

    void Shift(
      int sh 
    );

    PArgList & operator<<(
      int sh 
    );

    PArgList & operator>>(
      int sh 
    );

    virtual void IllegalArgumentIndex(
      PINDEX idx 
    ) const;

    virtual void UnknownOption(
      const PString & option   
    ) const;

    virtual void MissingArgument(
      const PString & option  
    ) const;

  protected:
    PStringArray argumentArray;
    PString      optionLetters;
    PStringArray optionNames;
    PIntArray    optionCount;
    PStringArray optionString;
    PIntArray    parameterIndex;
    int          shift;

  private:
    BOOL ParseOption(PINDEX idx, PINDEX offset, PINDEX & arg, const PIntArray & canHaveOptionString);
    PINDEX GetOptionCountByIndex(PINDEX idx) const;
    PString GetOptionStringByIndex(PINDEX idx, const char * dflt) const;
};


#ifdef P_CONFIG_FILE

class PConfigArgs : public PArgList
{
    PCLASSINFO(PConfigArgs, PArgList);
  public:
    PConfigArgs(
      const PArgList & args   
    );

    virtual PINDEX GetOptionCount(
      char optionChar  
    ) const;
    virtual PINDEX GetOptionCount(
      const char * optionStr 
    ) const;
    virtual PINDEX GetOptionCount(
      const PString & optionName 
    ) const;

    virtual PString GetOptionString(
      char optionChar,          
      const char * dflt = NULL  
    ) const;

    virtual PString GetOptionString(
      const char * optionStr,   
      const char * dflt = NULL  
    ) const;

    virtual PString GetOptionString(
      const PString & optionName, 
      const char * dflt = NULL    
    ) const;

    void Save(
      const PString & optionName   
    );

    void SetSectionName(
      const PString & section 
    ) { sectionName = section; }

    const PString & GetSectionName() const { return sectionName; }

    void SetNegationPrefix(
      const PString & prefix 
    ) { negationPrefix = prefix; }

    const PString & GetNegationPrefix() const { return negationPrefix; }


  protected:
    PString CharToString(char ch) const;
    PConfig config;
    PString sectionName;
    PString negationPrefix;
};

#endif // P_CONFIG_FILE

#endif

// End Of File ///////////////////////////////////////////////////////////////

---