generic/settings.hpp

   1 #ifndef _settings__hpp__included__
   2 #define _settings__hpp__included__
   3
   4 #include <string>
   5 #include <set>
   6 #include <stdexcept>
   7 #include <iostream>
   8
   9 /**
  10  * A setting.
  11  */
  12 class setting
  13 {
  14 public:
  15 /**
  16  * Create new setting.
  17  *
  18  * parameter name: Name of the setting.
  19  * throws std::bad_alloc: Not enough memory.
  20  */
  21         setting(const std::string& name) throw(std::bad_alloc);
  22
  23 /**
  24  * Remove the setting.
  25  */
  26         ~setting() throw();
  27
  28 /**
  29  * Set the setting to special blank state. Not all settings can be blanked.
  30  *
  31  * throws std::bad_alloc: Not enough memory.
  32  * throws std::runtime_error: Blanking this setting is not allowed (currently).
  33  */
  34         virtual void blank() throw(std::bad_alloc, std::runtime_error) = 0;
  35
  36 /**
  37  * Look up setting and try to blank it.
  38  *
  39  * parameter name: Name of setting to blank.
  40  * throws std::bad_alloc: Not enough memory.
  41  * throws std::runtime_error: Blanking this setting is not allowed (currently). Or setting does not exist.
  42  */
  43         static void blank(const std::string& name) throw(std::bad_alloc, std::runtime_error);
  44
  45 /**
  46  * Is this setting set (not blanked)?
  47  *
  48  * returns: True if setting is not blanked, false if it is blanked.
  49  */
  50         virtual bool is_set() throw() = 0;
  51
  52 /**
  53  * Look up a setting and see if it is set (not blanked)?
  54  *
  55  * parameter name: Name of setting to check.
  56  * returns: True if setting is not blanked, false if it is blanked.
  57  * throws std::bad_alloc: Not enough memory.
  58  * throws std::runtime_error: Setting does not exist.
  59  */
  60         static bool is_set(const std::string& name) throw(std::bad_alloc, std::runtime_error);
  61
  62 /**
  63  * Set value of setting.
  64  *
  65  * parameter value: New value for setting.
  66  * throws std::bad_alloc: Not enough memory.
  67  * throws std::runtime_error: Setting the setting to this value is not allowed (currently).
  68  */
  69         virtual void set(const std::string& value) throw(std::bad_alloc, std::runtime_error) = 0;
  70
  71 /**
  72  * Look up setting and set it.
  73  *
  74  * parameter name: Name of the setting.
  75  * parameter value: New value for setting.
  76  * throws std::bad_alloc: Not enough memory.
  77  * throws std::runtime_error: Setting the setting to this value is not allowed (currently). Or setting does not exist.
  78  */
  79         static void set(const std::string& name, const std::string& value) throw(std::bad_alloc, std::runtime_error);
  80
  81 /**
  82  * Get the value of setting.
  83  *
  84  * returns: The setting value.
  85  * throws std::bad_alloc: Not enough memory.
  86  */
  87         virtual std::string get() throw(std::bad_alloc) = 0;
  88
  89 /**
  90  * Look up setting an get value of it.
  91  *
  92  * returns: The setting value.
  93  * throws std::bad_alloc: Not enough memory.
  94  * throws std::runtime_error: Setting does not exist.
  95  */
  96         static std::string get(const std::string& name) throw(std::bad_alloc, std::runtime_error);
  97
  98 /**
  99  * Print all settings and values.
 100  *
 101  * throws std::bad_alloc: Not enough memory.
 102  */
 103         static void print_all() throw(std::bad_alloc);
 104
 105 /**
 106  * Get set of all settings.
 107  */
 108         static std::set<std::string> get_settings_set() throw(std::bad_alloc);
 109 protected:
 110         std::string settingname;
 111 };
 112
 113 /**
 114  * Setting having numeric value.
 115  */
 116 class numeric_setting : public setting
 117 {
 118 public:
 119 /**
 120  * Create a new numeric setting.
 121  *
 122  * parameter sname: Name of the setting.
 123  * parameter minv: Minimum value for the setting.
 124  * parameter maxv: Maximum value for the setting.
 125  * parameter dflt: Default (initial) value for the setting.
 126  * throws std::bad_alloc: Not enough memory.
 127  */
 128         numeric_setting(const std::string& sname, int32_t minv, int32_t maxv, int32_t dflt) throw(std::bad_alloc);
 129 /**
 130  * Raises std::runtime_error as these settings can't be blanked.
 131  */
 132         void blank() throw(std::bad_alloc, std::runtime_error);
 133 /**
 134  * Returns true (these settings are always set).
 135  */
 136         bool is_set() throw();
 137 /**
 138  * Set the value of setting. Accepts only numeric values.
 139  *
 140  * parameter value: New value.
 141  * throws std::bad_alloc: Not enough memory.
 142  * throws std::runtime_error: Invalid value.
 143  */
 144         void set(const std::string& value) throw(std::bad_alloc, std::runtime_error);
 145 /**
 146  * Gets the value of the setting.
 147  *
 148  * returns: Value of setting as string.
 149  * throws std::bad_alloc: Not enough memory.
 150  */
 151         std::string get() throw(std::bad_alloc);
 152 /**
 153  * Get the value of setting as numeric.
 154  *
 155  * returns: Value of the setting as numeric.
 156  */
 157         operator int32_t() throw();
 158 private:
 159         int32_t value;
 160         int32_t minimum;
 161         int32_t maximum;
 162 };
 163
 164 /**
 165  * Setting having boolean value.
 166  */
 167 class boolean_setting : public setting
 168 {
 169 public:
 170 /**
 171  * Create a new boolean setting.
 172  *
 173  * parameter sname: Name of the setting.
 174  * parameter dflt: Default (initial) value for the setting.
 175  * throws std::bad_alloc: Not enough memory.
 176  */
 177         boolean_setting(const std::string& sname, bool dflt) throw(std::bad_alloc);
 178 /**
 179  * Raises std::runtime_error as these settings can't be blanked.
 180  */
 181         void blank() throw(std::bad_alloc, std::runtime_error);
 182 /**
 183  * Returns true (these settings are always set).
 184  */
 185         bool is_set() throw();
 186 /**
 187  * Set the value of setting.
 188  *
 189  * The following values are accepted as true: true, yes, on, 1, enable and enabled.
 190  * The following values are accepted as false: false, no, off, 0, disable and disabled.
 191  *
 192  * parameter value: New value.
 193  * throws std::bad_alloc: Not enough memory.
 194  * throws std::runtime_error: Invalid value.
 195  */
 196         void set(const std::string& value) throw(std::bad_alloc, std::runtime_error);
 197 /**
 198  * Gets the value of the setting.
 199  *
 200  * returns: Value of setting as string.
 201  * throws std::bad_alloc: Not enough memory.
 202  */
 203         std::string get() throw(std::bad_alloc);
 204 /**
 205  * Get the value of setting as boolean.
 206  *
 207  * returns: Value of the setting as boolean.
 208  */
 209         operator bool() throw();
 210 private:
 211         bool value;
 212 };
 213
 214 #endif