2 Copyright (C) 2000-2007 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_configuration_variable_h__
21 #define __ardour_configuration_variable_h__
26 #include "pbd/xml++.h"
27 #include "ardour/types.h"
28 #include "ardour/utils.h"
32 class ConfigVariableBase {
35 ConfigVariableBase (std::string str) : _name (str) {}
36 virtual ~ConfigVariableBase() {}
38 std::string name () const { return _name; }
39 void add_to_node (XMLNode&);
40 bool set_from_node (XMLNode const &);
42 virtual std::string get_as_string () const = 0;
43 virtual void set_from_string (std::string const &) = 0;
53 class ConfigVariable : public ConfigVariableBase
57 ConfigVariable (std::string str) : ConfigVariableBase (str) {}
58 ConfigVariable (std::string str, T val) : ConfigVariableBase (str), value (val) {}
64 std::string get_as_string () const {
65 std::ostringstream ss;
70 virtual bool set (T val) {
80 virtual void set_from_string (std::string const & s) {
87 virtual T get_for_save() { return value; }
91 /** Specialisation of ConfigVariable for std::string to cope with whitespace properly */
93 class ConfigVariable<std::string> : public ConfigVariableBase
97 ConfigVariable (std::string str) : ConfigVariableBase (str) {}
98 ConfigVariable (std::string str, std::string val) : ConfigVariableBase (str), value (val) {}
100 std::string get() const {
104 std::string get_as_string () const {
108 virtual bool set (std::string val) {
118 virtual void set_from_string (std::string const & s) {
123 virtual std::string get_for_save() { return value; }
128 class ConfigVariable<bool> : public ConfigVariableBase
132 ConfigVariable (std::string str) : ConfigVariableBase (str), value (false) {}
133 ConfigVariable (std::string str, bool val) : ConfigVariableBase (str), value (val) {}
139 std::string get_as_string () const {
140 std::ostringstream ss;
145 virtual bool set (bool val) {
155 void set_from_string (std::string const & s) {
156 value = string_is_affirmative (s);
160 virtual bool get_for_save() { return value; }
165 class ConfigVariableWithMutation : public ConfigVariable<T>
168 ConfigVariableWithMutation (std::string name, T val, T (*m)(T))
169 : ConfigVariable<T> (name, val), mutator (m) {}
172 if (unmutated_value != val) {
173 unmutated_value = val;
174 return ConfigVariable<T>::set (mutator (val));
179 void set_from_string (std::string const & s) {
181 std::stringstream ss;
188 virtual T get_for_save() { return unmutated_value; }
194 class ConfigVariableWithMutation<std::string> : public ConfigVariable<std::string>
197 ConfigVariableWithMutation (std::string name, std::string val, std::string (*m)(std::string))
198 : ConfigVariable<std::string> (name, val), mutator (m) {}
200 bool set (std::string val) {
201 if (unmutated_value != val) {
202 unmutated_value = val;
203 return ConfigVariable<std::string>::set (mutator (val));
208 void set_from_string (std::string const & s) {
213 virtual std::string get_for_save() { return unmutated_value; }
214 std::string unmutated_value;
215 std::string (*mutator)(std::string);
220 #endif /* __ardour_configuration_variable_h__ */