ProgramOptions.h

Go to the documentation of this file.

// ProgramOptions.h

#ifndef PROGRAM_OPTIONS_H
#define PROGRAM_OPTIONS_H

#if _MSC_VER == 1200
#pragma warning(disable : 4786)
#endif // MSC ver 6.0

#include <string>
#include <iosfwd>
#include <vector>
#include "safe_assign.h"

class ProgramOption
{
protected:
  enum OptionType { opt_boolean, opt_string, opt_long };

  ProgramOption(char cShortOption, const char* pszLongOption, OptionType type, bool bHasParameter)
  {
    m_cShortOption = cShortOption;
    safe_assign(m_sLongOption, pszLongOption);
    m_bDefined = false;
    m_type = type;
    m_bHasParameter = bHasParameter;
    m_bValue = false;
    m_lValue = 0;
    m_lMinValue = LONG_MIN;
    m_lMaxValue = LONG_MAX;
  }
  
  bool IsOption(char c) const
  {
    if (IsCaseSensitive())
      return (_toupper(__toascii(GetShortOption())) == _toupper(__toascii(c)));
    else
      return (c == GetShortOption());
  }
  bool IsOption(const char* psz) const
  {
    return (stricmp(psz, GetLongOption().c_str()) == 0);
  }

  bool IsDefined() const { return m_bDefined; }
  char GetShortOption() const { return m_cShortOption; }
  const std::string& GetLongOption() const { return m_sLongOption; }
  bool HasParameter() const { return m_bHasParameter; }
  bool HasShortOption() const { return m_cShortOption != '\0'; }
  bool HasLongOption() const { return !m_sLongOption.empty(); }
  bool IsCaseSensitive() const { return m_bCaseSensitive; }
  const std::string& GetHelpText() const { return m_sHelpText; }
  const std::string& GetParameterHint() const { return m_sParameterHint; }
  OptionType GetType() const { return m_type; }

  bool GetBoolValue() const { return m_bValue; }
  void SetBoolValue() {
    m_bValue = true;
    m_bDefined = true;
  }
  long GetLongValue() const { return m_lValue; }
  bool SetLongValue(long l) {
    if (l >= GetLongValueMin() && l <= GetLongValueMax())
    {
      m_lValue = l;
      m_bDefined = true;
      return true;
    }
    return false;
  }
  const std::string& GetStringValue() const { return m_sValue; }
  void SetStringValue(const char* psz)
  {
    safe_assign(m_sValue, psz);
    m_bDefined = true;
  }

  long GetLongValueMin() const { return m_lMinValue; }
  long GetLongValueMax() const { return m_lMaxValue; }

  char m_cShortOption;
  std::string m_sLongOption;
  bool m_bDefined;
  bool m_bCaseSensitive;
  bool m_bHasParameter;
  std::string m_sParameterHint;
  std::string m_sHelpText;
  OptionType m_type;

  bool m_bValue;
  long m_lValue;
  long m_lMinValue;
  long m_lMaxValue;
  std::string m_sValue;

  friend class ProgramOptions;
  friend std::ostream& operator<< (std::ostream&, const ProgramOption &);
};

class ProgramOptions
{
public:
  ProgramOptions();
  ~ProgramOptions();
  void AddBoolean(
    char cShortOption, const char* pszLongOption=0, bool bDefault=false,
    bool bCaseSensitive=false, const char* pszHelpText=0
  );
  void AddString(
    char cShortOption, const char* pszLongOption=0, const char* pszDefault=0,
    bool bCaseSensitive=false,
    const char* pszParameterHint=0, const char* pszHelpText=0
  );
  void AddLong(
    char cShortOption, const char* pszLongOption=0, long lDefault=0,
    long lMin=LONG_MIN, long lMax=LONG_MAX,
    bool bCaseSensitive=false,
    const char* pszParameterHint=0, const char* pszHelpText=0
  );
  void PrintHelp(std::ostream& os, int width=79) const;
  bool IsOptionChar(char c) const;
  ProgramOption* GetOption(char c) const;
  ProgramOption* GetOption(const char* psz) const;
  bool Parse(int argc, char* argv[], std::locale loc=std::locale::classic());
  typedef std::vector<ProgramOption*>::const_iterator const_option_iterator;
  const_option_iterator options_begin() const { return m_options.begin(); }
  const_option_iterator options_end() const { return m_options.end(); }
  typedef std::vector<std::string>::const_iterator const_parameter_iterator;
  const_parameter_iterator parameter_begin() const { return m_parameters.begin(); }
  const_parameter_iterator parameter_end() const { return m_parameters.end(); }
  bool GetBoolValue(char option) const;
  bool GetBoolValue(const char* pszOption) const;
  long GetLongValue(char option) const;
  long GetLongValue(const char* pszOption) const;
  std::string GetStringValue(char option) const;
  std::string GetStringValue(const char* pszOption) const;
protected:
  typedef std::vector<ProgramOption*>::iterator option_iterator;
  void Add(ProgramOption* pOption);
  std::vector<ProgramOption*> m_options;
  void AddParameter(const char* psz);
  std::vector<std::string> m_parameters;

  std::string m_sOptionChars;

  std::string GetStringParameter(const char* psz) const;

  friend std::ostream& operator<< (std::ostream&, const ProgramOptions &);
};

#endif // PROGRAM_OPTIONS_H

---