include/interface/setting.hpp

   1 #ifndef _interface__setting__hpp__included__
   2 #define _interface__setting__hpp__included__
   3
   4 #include <string>
   5 #include <stdexcept>
   6 #include <vector>
   7 #include <map>
   8 #include <set>
   9
  10 struct core_setting;
  11 struct core_setting_group;
  12
  13 /**
  14  * A value for setting (structure).
  15  */
  16 struct core_setting_value_param
  17 {
  18         const char* iname;
  19         const char* hname;
  20         signed index;
  21 };
  22
  23 /**
  24  * A setting (structure)
  25  */
  26 struct core_setting_param
  27 {
  28         const char* iname;
  29         const char* hname;
  30         const char* dflt;
  31         std::vector<core_setting_value_param> values;
  32         const char* regex;
  33 };
  34
  35 /**
  36  * A value for setting.
  37  */
  38 struct core_setting_value
  39 {
  40 /**
  41  * Create a new setting value.
  42  */
  43         core_setting_value(const core_setting_value_param& p) throw(std::bad_alloc);
  44 /**
  45  * Internal value.
  46  */
  47         const std::string iname;
  48 /**
  49  * Human-readable value.
  50  */
  51         const std::string hname;
  52 /**
  53  * Index.
  54  */
  55         signed index;
  56 };
  57
  58 /**
  59  * A setting.
  60  */
  61 struct core_setting
  62 {
  63 /**
  64  * Create a new setting.
  65  */
  66         core_setting(const core_setting_param& p);
  67 /**
  68  * Internal name.
  69  */
  70         const std::string iname;
  71 /**
  72  * Human-readable name.
  73  */
  74         const std::string hname;
  75 /**
  76  * Regular expression for validation of fretext setting.
  77  */
  78         const std::string regex;
  79 /**
  80  * The default value.
  81  */
  82         const std::string dflt;
  83 /**
  84  * The values.
  85  */
  86         std::vector<core_setting_value> values;
  87 /**
  88  * Is this setting a boolean?
  89  */
  90         bool is_boolean() const throw();
  91 /**
  92  * Is this setting a freetext setting?
  93  */
  94         bool is_freetext() const throw();
  95 /**
  96  * Get set of human-readable strings.
  97  */
  98         std::vector<std::string> hvalues() const throw(std::runtime_error);
  99 /**
 100  * Translate hvalue to ivalue.
 101  */
 102         std::string hvalue_to_ivalue(const std::string& hvalue) const throw(std::runtime_error);
 103 /**
 104  * Translate ivalue to index.
 105  */
 106         signed ivalue_to_index(const std::string& ivalue) const throw(std::runtime_error);
 107 /**
 108  * Validate a value.
 109  *
 110  * Parameter value: The value to validate.
 111  */
 112         bool validate(const std::string& value) const;
 113 };
 114
 115 /**
 116  * A group of settings.
 117  */
 118 struct core_setting_group
 119 {
 120         core_setting_group();
 121 /**
 122  * Create a new group of settings.
 123  */
 124         core_setting_group(std::initializer_list<core_setting_param> settings);
 125 /**
 126  * Create a new group of settings.
 127  */
 128         core_setting_group(std::vector<core_setting_param> settings);
 129 /**
 130  * The settings.
 131  */
 132         std::map<std::string, core_setting> settings;
 133 /**
 134  * Get specified setting.
 135  */
 136         core_setting& operator[](const std::string& name) { return settings.find(name)->second; }
 137 /**
 138  * Translate ivalue to index.
 139  */
 140         signed ivalue_to_index(std::map<std::string, std::string>& values, const std::string& name) const
 141                 throw(std::runtime_error)
 142         {
 143                 return settings.find(name)->second.ivalue_to_index(values[name]);
 144         }
 145 /**
 146  * Fill a map of settings with defaults.
 147  */
 148         void fill_defaults(std::map<std::string, std::string>& values) throw(std::bad_alloc);
 149 /**
 150  * Get set of settings.
 151  */
 152         std::set<std::string> get_setting_set();
 153 };
 154
 155 #endif