summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/configuration_variable.h
blob: c9b9890c81a30745c43c73bab11a4ca0721bcef8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
/*
    Copyright (C) 2000-2007 Paul Davis 

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_configuration_variable_h__
#define __ardour_configuration_variable_h__

#include <sstream>
#include <ostream>

#include <pbd/xml++.h>

#include "ardour/utils.h"

namespace ARDOUR {

class ConfigVariableBase {
  public:
	enum Owner {
		Default = 0x1,
		System = 0x2,
		Config = 0x4,
		Session = 0x8,
		Interface = 0x10
	};

	ConfigVariableBase (std::string str) : _name (str), _owner (Default) {}
	virtual ~ConfigVariableBase() {}

	std::string name() const { return _name; }
	Owner owner() const { return _owner; }

	virtual void add_to_node (XMLNode& node) = 0;
	virtual bool set_from_node (const XMLNode& node, Owner owner) = 0;

	void show_stored_value (const std::string&);
	static void set_show_stored_values (bool yn);

  protected:
	std::string _name;
	Owner _owner;
	static bool show_stores;

	void notify ();
	void miss ();
};

template<class T>
class ConfigVariable : public ConfigVariableBase
{
  public:
	ConfigVariable (std::string str) : ConfigVariableBase (str) {}
	ConfigVariable (std::string str, T val) : ConfigVariableBase (str), value (val) {}

	virtual bool set (T val, Owner owner) {
		if (val == value) {
			miss ();
			return false;
		}
		value = val;
		_owner = (ConfigVariableBase::Owner)(_owner |owner);
		notify ();
		return true;
	}

	T get() const {
		return value;
	}

	void add_to_node (XMLNode& node) {
		std::stringstream ss;
		ss << value;
		show_stored_value (ss.str());
		XMLNode* child = new XMLNode ("Option");
		child->add_property ("name", _name);
		child->add_property ("value", ss.str());
		node.add_child_nocopy (*child);
	}

	bool set_from_node (const XMLNode& node, Owner owner) {

		if (node.name() == "Config") {

			/* ardour.rc */

			const XMLProperty* prop;
			XMLNodeList nlist;
			XMLNodeConstIterator niter;
			XMLNode* child;
			
			nlist = node.children();
			
			for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
				
				child = *niter;
				
				if (child->name() == "Option") {
					if ((prop = child->property ("name")) != 0) {
						if (prop->value() == _name) {
							if ((prop = child->property ("value")) != 0) {
								std::stringstream ss;
								ss << prop->value();
								ss >> value;
								_owner = (ConfigVariableBase::Owner)(_owner |owner);
								return true;
							}
						}
					}
				}
			}
			
		} else if (node.name() == "Options") {

			/* session file */

			XMLNodeList olist;
			XMLNodeConstIterator oiter;
			XMLNode* option;
			const XMLProperty* opt_prop;
			
			olist = node.children();
			
			for (oiter = olist.begin(); oiter != olist.end(); ++oiter) {
				
				option = *oiter;
				
				if (option->name() == _name) {
					if ((opt_prop = option->property ("val")) != 0) {
						std::stringstream ss;
						ss << opt_prop->value();
						ss >> value;
						_owner = (ConfigVariableBase::Owner)(_owner |owner);
						return true;
					}
				}
			}
		}

		return false;
	}

  protected:
	virtual T get_for_save() { return value; }
	T value;
};

/* full specialization for bool, required because ::set_from_node() needs
   special handling.
*/

template<>
class ConfigVariable<bool> : public ConfigVariableBase
{
  public:
	ConfigVariable (std::string str) : ConfigVariableBase (str), value (false) {}
	ConfigVariable (std::string str, bool val) : ConfigVariableBase (str), value (val) {}

	virtual bool set (bool val, Owner owner) {
		if (val == value) {
			miss ();
			return false;
		}
		value = val;
		_owner = (ConfigVariableBase::Owner)(_owner |owner);
		notify ();
		return true;
	}

	bool get() const {
		return value;
	}

	void add_to_node (XMLNode& node) {
		XMLNode* child = new XMLNode ("Option");
		child->add_property ("name", _name);
		child->add_property ("value", (value ? "yes" : "no"));
		node.add_child_nocopy (*child);
	}

	bool set_from_node (const XMLNode& node, Owner owner) {

		if (node.name() == "Config") {

			/* ardour.rc */

			const XMLProperty* prop;
			XMLNodeList nlist;
			XMLNodeConstIterator niter;
			XMLNode* child;
			
			nlist = node.children();
			
			for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
				
				child = *niter;
				
				if (child->name() == "Option") {
					if ((prop = child->property ("name")) != 0) {
						if (prop->value() == _name) {
							if ((prop = child->property ("value")) != 0) {
                                                                value = ::string_is_affirmative (prop->value());
								_owner = (ConfigVariableBase::Owner)(_owner |owner);
								return true;
							}
						}
					}
				}
			}
			
		} else if (node.name() == "Options") {

			/* session file */

			XMLNodeList olist;
			XMLNodeConstIterator oiter;
			XMLNode* option;
			const XMLProperty* opt_prop;
			
			olist = node.children();
			
			for (oiter = olist.begin(); oiter != olist.end(); ++oiter) {
				
				option = *oiter;
				
				if (option->name() == _name) {
					if ((opt_prop = option->property ("val")) != 0) {
                                                value = ::string_is_affirmative (opt_prop->value());
						_owner = (ConfigVariableBase::Owner)(_owner |owner);
						return true;
					}
				}
			}
		}

		return false;
	}

  protected:
	virtual bool get_for_save() { return value; }
	bool value;
};

template<class T>
class ConfigVariableWithMutation : public ConfigVariable<T>
{
  public:
	ConfigVariableWithMutation (std::string name, T val, T (*m)(T)) 
		: ConfigVariable<T> (name, val), mutator (m) {}

	bool set (T val, ConfigVariableBase::Owner owner) {
		if (unmutated_value != val) {
			unmutated_value = val;
			return ConfigVariable<T>::set (mutator (val), owner);
		} 
		return false;
	}

  protected:
	virtual T get_for_save() { return unmutated_value; }
	T unmutated_value;
	T (*mutator)(T);
};

}

#endif /* __ardour_configuration_variable_h__ */