ParseOptionsArguments.h

Go to the documentation of this file.

// -*- C++ -*-

#if !defined(__ads_utility_ParseOptionsArguments_h__)
#define __ads_utility_ParseOptionsArguments_h__

#include "../defs.h"

#include <set>
#include <map>
#include <list>
#include <string>
#include <sstream>

#include <cassert>

BEGIN_NAMESPACE_ADS

class ParseOptionsArguments {
  //
  // Public types.
  //

public:

  typedef std::string String;

  //
  // Private types.
  //

private:

  typedef std::set<String> OptionsContainer;
  typedef std::map<String,String> OptionsWithValuesContainer;
  typedef std::list<String> ArgumentsContainer;

  //
  // Member data.
  //

private:

  // The character that prefixes an option.
  char _optionPrefix;
  // The program name.
  String _programName;
  // The options (without values).
  OptionsContainer _options;
  // The options with values.
  OptionsWithValuesContainer _optionsWithValues;
  // The arguments.
  ArgumentsContainer _arguments;

  //
  // Not implemented.
  //

private:

  // Copy constructor not implemented.
  ParseOptionsArguments(const ParseOptionsArguments& other);
  
  // Assignment operator not implemented.
  ParseOptionsArguments&
  operator=(const ParseOptionsArguments& other);
  

public:

  //--------------------------------------------------------------------------


  ParseOptionsArguments() :
    // Default value.
    _optionPrefix('-'),
    // Empty string.
    _programName(),
    // Empty.
    _options(),
    // Empty.
    _optionsWithValues(),
    // Empty.
    _arguments()
  {}
  
  ParseOptionsArguments(const int argc, char* argv[], 
                        const char optionPrefix = '-') :
    // Default value.
    _optionPrefix(optionPrefix),
    // Empty string.
    _programName(),
    // Empty.
    _options(),
    // Empty.
    _optionsWithValues(),
    // Empty.
    _arguments() {
    // Parse the options and arguments.
    parse(argc, argv);
  }
 
  ~ParseOptionsArguments()
  {}

  //--------------------------------------------------------------------------


  const String&
  getProgramName() const {
    return _programName;
  }

  char
  getOptionPrefix() const {
    return _optionPrefix;
  }

  int
  getNumberOfOptions() const {
    return int(_options.size() + _optionsWithValues.size());
  }

  bool
  areOptionsEmpty() const {
    return getNumberOfOptions() == 0;
  }

  int
  getNumberOfArguments() const {
    return int(_arguments.size());
  }

  bool
  areArgumentsEmpty() const {
    return _arguments.empty();
  }

  //--------------------------------------------------------------------------


  void
  parse(int argc, char* argv[]);

  void
  setOptionPrefix(const char optionPrefix) {
    _optionPrefix = optionPrefix;
  }

  bool
  getOption(const String& key) {
    OptionsContainer::iterator i = _options.find(key);
    if (i == _options.end()) {
      return false;
    }
    _options.erase(i);
    return true;
  }


  bool
  getOption(const char key) {
    return getOption(String(1, key));
  }

  template<typename T>
  bool
  getOption(const String& key, T* value);


  template<typename T>
  bool
  getOption(const char key, T* value) {
    return getOption(String(1,key), value);
  }

  bool
  getOption(const String& key, String* value);


  String
  getArgument() {
    assert(! _arguments.empty());
    String argument = _arguments.front();
    _arguments.pop_front();
    return argument;
  }


  template<typename T>
  bool
  getArgument(T* x) {
    assert(! _arguments.empty());
    // Make an input string stream from the current argument.
    std::istringstream in(_arguments.front());
    // Pop the current argument.
    _arguments.pop_front();
    // Read from the input string stream.
    in >> *x;
    // Check the state of the stream.
    if (in) {
      return true;
    }
    return false;
  }

  //--------------------------------------------------------------------------


  void
  printOptions(std::ostream& out) const;

  void
  printArguments(std::ostream& out) const;

};

END_NAMESPACE_ADS

#define __ads_utility_ParseOptionsArguments_ipp__
#include "ParseOptionsArguments.ipp"
#undef __ads_utility_ParseOptionsArguments_ipp__

#endif

---