CmdLineParser.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/


#ifndef BLOCXX_CMD_LINE_PARSER_HPP_INCLUDE_GUARD_
#define BLOCXX_CMD_LINE_PARSER_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/String.hpp"
#include "blocxx/SortedVectorMap.hpp"
#include "blocxx/Array.hpp"
#include "blocxx/Exception.hpp"

namespace BLOCXX_NAMESPACE
{

BLOCXX_DECLARE_APIEXCEPTION(CmdLineParser, BLOCXX_COMMON_API)


class BLOCXX_COMMON_API CmdLineParser
{
public:
   enum EArgumentTypeFlag
   {
      E_NO_ARG,       
      E_REQUIRED_ARG, 
      E_OPTIONAL_ARG  
   };

   // errors codes that may be specified when a CmdLineParserException is thrown
   enum EErrorCodes
   {
      E_INVALID_OPTION,         
      E_MISSING_ARGUMENT,       
      E_INVALID_NON_OPTION_ARG, 
      E_MISSING_OPTION          
   };

   struct Option
   {
      int id;                    
      char shortopt;             
      const char* longopt;       
      EArgumentTypeFlag argtype; 
      const char* defaultValue;  
      const char* description;   
   };

   enum EAllowNonOptionArgsFlag
   {
      E_NON_OPTION_ARGS_ALLOWED, 
      E_NON_OPTION_ARGS_INVALID  
   };

   CmdLineParser(int argc, char const* const* const argv, const Option* options, EAllowNonOptionArgsFlag allowNonOptionArgs);

   String getOptionValue(int id, const char* defaultValue = "") const;
   
   String mustGetOptionValue(int id, const char* exceptionMessage = "") const;
   
   StringArray getOptionValueList(int id) const;
   
   StringArray mustGetOptionValueList(int id, const char* exceptionMessage = "") const;
   
   bool isSet(int id) const;
   
   size_t getNonOptionCount () const;
   
   String getNonOptionArg(size_t n) const;

   StringArray getNonOptionArgs() const;
   
   static String getUsage(const Option* options, unsigned int maxColumns = 80);


private:

#ifdef BLOCXX_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   // key is Option::id, value is the value(s) specified by the user
   typedef SortedVectorMap<int, StringArray> optionsMap_t;
   optionsMap_t m_parsedOptions;
   StringArray m_nonOptionArgs;

#ifdef BLOCXX_WIN32
#pragma warning (pop)
#endif

};

} // end namespace BLOCXX_NAMESPACE

#endif