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): ______________________________________.
 *
 * $Revision: 32238 $
 * $Author: rjongbloed $
 * $Date: 2014-06-27 14:23:17 +1000 (Fri, 27 Jun 2014) $
 */

#ifndef PTLIB_ARGLIST_H
#define PTLIB_ARGLIST_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

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

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

    virtual void PrintOn(
      ostream & strm  
    ) const;

    virtual void ReadFrom(
      istream & strm  
    );

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

    void SetCommandName(
       const PString & name
    ) { m_commandName = name; }

    const PString & GetCommandName() const { return m_commandName; }

    virtual bool Parse(
      const char * theArgumentSpec = NULL, 
      PBoolean optionsBeforeParams = true  
    );
    virtual bool Parse(
      const PString & theArgumentStr,  
      PBoolean optionsBeforeParams = true  
    );

    bool IsParsed() const { return m_parsed; }

    const PString & GetParseError() const { return m_parseError; }

    ostream & Usage(
      ostream & strm,                   
      const char * usage = NULL,        
      const char * prefix = "Usage: "   
    ) const;
    PString Usage(
      const char * usage = NULL,        
      const char * prefix = "Usage: "   
    ) const;

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

    PBoolean HasOption(
      char optionChar             
    ) const;
    PBoolean HasOption(
      const char * optionStr     
    ) const;
    PBoolean 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;

    template <typename ValueType, typename OptionType>
    ValueType GetOptionAs(
      OptionType option,   
      ValueType value = 0   
    ) const {
      PStringStream strm(GetOptionString(option));
      if (!strm.IsEmpty())
        strm >> value;
      return value;
    }

    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 
    );

  protected:
    PString m_commandName;
    bool    m_parsed;
    PString m_parseError;         // An error was detected during parsing of arguments
    PStringArray m_argumentArray; // The original program arguments.

    enum OptionType {
      NoString,
      HasString,
      OptionalString
    };
    struct OptionSpec {
      OptionSpec() : m_letter('\0'), m_type(NoString), m_count(0) { }
      char       m_letter;
      PString    m_name;
      PString    m_usage;
      PString    m_section;
      OptionType m_type;

      unsigned   m_count;
      PString    m_string;
    };
    vector<OptionSpec> m_options;

    PIntArray m_parameterIndex;

    int m_shift;
    int m_argsParsed;

    // Internal stuff
    bool InternalSpecificationError(bool isError, const PString & msg);
    size_t InternalFindOption(const PString & name) const;
    int InternalParseOption(const PString & opt, PINDEX offset, PINDEX & arg);
    PINDEX InternalGetOptionCountByIndex(size_t idx) const;
    PString InternalGetOptionStringByIndex(size_t idx, const char * dflt) const;
};


#ifdef P_CONFIG_FILE

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

    ~PConfigArgs();

    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 
    ) { m_sectionName = section; }

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

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

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


  protected:
    PString CharToString(char ch) const;

    PConfig * m_config;
    PString   m_sectionName;
    PString   m_negationPrefix;
};

#endif // P_CONFIG_FILE


#endif // PTLIB_ARGLIST_H


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