libutil/Config.h

   1 #ifndef REMOTE_UTIL_CONFIG_H
   2 #define REMOTE_UTIL_CONFIG_H
   3
   4 #ifdef HAVE_CONFIG_H
   5 #include "config.h"
   6 #endif
   7 #undef VERSION
   8
   9 #include <list>
  10
  11 namespace remote { namespace util {
  12
  13 /** Configuration handling.
  14  *
  15  * This class reads options from the command line and from a
  16  * configuration file.
  17  */
  18 class Config
  19 {
  20 public:
  21         /** Option value type. */
  22         enum type {
  23                 ALIAS,  /**< Alias option type. */
  24                 BOOL,   /**< Boolean option type. */
  25                 STRING, /**< String option type. */
  26                 UINT16, /**< Unsigned 16-bit integer option type. */
  27                 UINT64, /**< Unsigned 64-bit integer option type. */
  28                 HELP,   /**< Special type for handling the --help option. */
  29                 VERSION /**< Special type for handling the --version option. */
  30         };
  31
  32         /** Initial the configuration module for a program
  33          *
  34          * @param program       The program name.
  35          * @param configFile    The default path to the configuration file.
  36          */
  37         Config(std::string program, std::string configFile);
  38
  39         /** Add boolean option.
  40          *
  41          * @param name  The option name.
  42          * @param value Reference to the option value.
  43          * @param help  A short option description.
  44          */
  45         void operator()(std::string name, bool *value, std::string help);
  46
  47         /** Add uint16 option.
  48          *
  49          * @param name  The option name.
  50          * @param value Reference to the option value.
  51          * @param help  A short option description.
  52          */
  53         void operator()(std::string name, uint16_t *value, std::string help);
  54
  55         /** Add uint64 option.
  56          *
  57          * @param name  The option name.
  58          * @param value Reference to the option value.
  59          * @param help  A short option description.
  60          */
  61         void operator()(std::string name, uint64_t *value, std::string help);
  62
  63         /** Add string option.
  64          *
  65          * @param name  The option name.
  66          * @param value Reference to the option value.
  67          * @param help  A short option description.
  68          */
  69         void operator()(std::string name, std::string *value, std::string help);
  70
  71         /** Add alias to an existing option.
  72          *
  73          * @param name  The name of the alias.
  74          * @param alias The name of the aliased option.
  75          */
  76         void operator()(std::string name, std::string alias);
  77
  78         /** Read options from command line and configuration file.
  79          *
  80          * @param argc  Number of command line arguments.
  81          * @param argv  String array of command line arguments.
  82          * @return      True if reading options succeeded.
  83          */
  84         bool read(int argc, char **argv);
  85
  86 private:
  87         class Option;
  88
  89         /** Read options from file.
  90          *
  91          * @param name  Name of configuration file.
  92          * @param fail  Whether to error out if opening the file fails.
  93          * @return      True if parsing the file succeeded.
  94          */
  95         bool parseFile(std::string name, bool fail);
  96
  97         /** Parse option name and value.
  98          *
  99          * @param name  The option name.
 100          * @param value The option value to parse.
 101          * @return      True if parsing the option succeeded.
 102          */
 103         bool parseOption(std::string name, std::string value);
 104
 105         /** Print usage help and option descriptions. */
 106         void printHelp();
 107
 108         /** Lookup an option by name.
 109          *
 110          * @param name  Name of the option to get.
 111          * @return      The matching option or NULL if no option matched.
 112          */
 113         Option *get(std::string name);
 114
 115         /** Lookup an option by name.
 116          *
 117          * @param name  Name of the option to add.
 118          * @param help  A short option description.
 119          * @param type  The type of the option.
 120          * @return      The newly added option or NULL.
 121          */
 122         Option *add(std::string name, std::string help, enum type type);
 123
 124         std::list<Option *> options;    /**< List of known options. */
 125         std::string program;            /**< The program name. */
 126         std::string configFile;         /**< The config file option string. */
 127 };
 128
 129 }}
 130
 131 #endif