*** empty log message ***

[h316.git] / pc-tools / ldc2 / src / configuration_manager.hh

#ifndef ARGUMENT_READER_H
#define ARGUMENT_READER_H

#include <vector>
#include <string>

using namespace std;

/*!
 *\brief Hachti's even more wonderful configuration manager.
 *
 * This class is designed to do all the work with the parameters passed to 
 * the main() routine of a program.\n
 * Additionally, it is able to interpret configuration files.
 * Usage:\n
 *   - Create an instance.
 *   - Add Parameters/switches with add_param().
 *   - Add Arguments with add_argument().
 *   - Call read_args() with your main routine's arguments.
 *     The vector returned by read_args() contains all error
 *     messages. When it's empty, everything is fine!
 *   - Call get_help() if you want nice formatted help output.
 *     (You want!!!)
 * Sould be easy to use..... Enjoy.
 */
class configuration_manager{
  
public:
  configuration_manager(string name);

  void add_option_switch (string  shortname,
		   string  longname, 
		   string  description, 
		   int    *status, 
		   bool    allow_commandline=true,
		   bool    allow_config_file=true
		   );

  void add_option_value (string  shortname,
		   string  longname, 
		   string  description, 
		   int    *status, 
		   bool    allow_commandline=true,
		   bool    allow_config_file=true,
		   string *target=NULL, 
		   string  placeholder=string("<string>")
		   );
  
  void add_argument (string  longname, 
		     string  description, 
		     int    *status, 
     		     string *target=NULL, 
		     string  placeholder=string("<string>")
		     );

  vector<string> read_args(int argc, char ** args);
  vector<string> read_file(string filename);
 
  void get_help (vector<string> & target);
  vector<string> get_help();

private:
  /*!
   *\brief Container for an option switch
   */
   class opt_switch_t{
  public:
    opt_switch_t (string shortname, string longname,string description, int * status 
	       string * target=NULL, string placeholder=string("<string>"));
    string shortname;
    string longname;
    int * status;
    string * target;    
    string description;
    string placeholder;
  };
  /*!
   *\brief Container for an option value
   */
class opt_value_t{
  public:
  switch_t (string shortname, string longname,string description, int * status 
	    string * target=NULL, string placeholder=string("<string>"));
  string shortname;
  string longname;
  int * status;
  string * target;    
  string description;
  string placeholder;
  bool allow_conffile;
  bool allow_cmdline;
};

  /*!
   *\brief Container for a commandline argument
   */
  class cmd_arg_t{
  public:
    arg_t (string placeholder,string description,
		    int * status, string * target);
    int * status;
    string * target;    
    string description;
    string placeholder;
  };
  
  vector<opt_switch_t>option_switches;
  vector<opt_value_t>option_values;
  vector<cmd_arg_t>cmd_args;
  string app_name;

}; // class configuration_manager


#endif