ProgOptions.hpp

Go to the documentation of this file.

#ifndef MOAB_PROGRAM_OPTIONS_H
#define MOAB_PROGRAM_OPTIONS_H

#include <vector>
#include <map>
#include <string>
#include <iostream>


class ProgOpt;


class ProgOptions{

public:



  static const int help_flag = 1<<0;

  static const int add_cancel_opt = 1<<1;

  static const int store_false = 1<<2 ;

  static const int int_flag = 1<<3 ;

  static const int rank_subst = 1<<4;

  static const int version_flag = 1<<5;
  
  //const static int accept_multiple;


  ProgOptions( const std::string& helptext = "",
               const std::string& briefdesc = "" );
  ~ProgOptions();

  void setVersion( const std::string& version_string, bool addFlag = true );

  template <typename T>
  void addOpt( const std::string& namestring, const std::string& helpstring,
           T* value, int flags = 0 );

  template <typename T>
  void addOpt( const std::string& namestring, const std::string& helpstring, int flags = 0 ){
    addOpt<T>( namestring, helpstring, NULL, flags );
  }

  void addOptionHelpHeading( const std::string& );


  template <typename T>
  void addRequiredArg( const std::string& helpname, const std::string& helpstring, T* value = NULL, int flags = 0 );

  template <typename T>
  void addOptionalArgs( unsigned max_count, const std::string& helpname, const std::string& helpstring, int flags = 0 );

  void printHelp( std::ostream& str = std::cout );

  void printUsage( std::ostream& str = std::cout );
  
  void printVersion( std::ostream& str = std::cout );

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

  template <typename T>
  bool getOpt( const std::string& namestring, T* value );

  template <typename T>
  void getOptAllArgs( const std::string& namestring, std::vector<T>& values );

  
  int numOptSet( const std::string& namestring );

  template <typename T>
  T getReqArg( const std::string& namestring );
  
  template <typename T>
  void getArgs( const std::string& namestring, std::vector<T>& values );

  void error( const std::string& message );

  void write_man_page( std::ostream& to_this_stream );
  
protected:

  std::string get_option_usage_prefix( const  ProgOpt& option );

  void get_namestrings( const std::string& input, std::string* l, std::string* s );

  ProgOpt* lookup( const std::map<std::string, ProgOpt* >&, const std::string& );
  ProgOpt* lookup_option( const std::string& );

  bool evaluate( const ProgOpt& opt, void* target, const std::string& option, unsigned* arg_idx = NULL);
  bool process_option( ProgOpt* opt, std::string arg, const char* value = 0 );
  
  std::map< std::string, ProgOpt* > long_names;
  std::map< std::string, ProgOpt* > short_names;
  std::map< std::string, ProgOpt* > required_args;

  typedef std::pair<ProgOpt*, std::string> help_line; 
  std::vector< help_line > option_help_strings;
  std::vector< help_line > arg_help_strings;
  std::vector< std::string > main_help;
  std::string brief_help;
  
  bool expect_optional_args;
  unsigned optional_args_position, max_optional_args;
  
  std::string progname;
  std::string progversion;
  
    // if an option was specified with the int_flag, this
    // will contain the long name of the option
  std::string number_option_name;
  
};

#endif /* MOAB_PROGRAM_OPTIONS_H */