summaryrefslogtreecommitdiffstats
blob: 1e62d2ec363fb102277ffc2afdd79481f2cc26a8 (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
/*
 * Copyright (c) 2010-2012 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */

#pragma once

#include <Swiften/Base/boost_bsignals.h>

#include <string>
#include <vector>

namespace Swift {

class SettingsProvider {

	public:
		template <typename T>
		class Setting {
			public:
				Setting(const std::string& key, const T& defaultValue) : key(key), defaultValue(defaultValue) {

				}

				const std::string& getKey() const {
					return key;
				}

				const T& getDefaultValue() const {
					return defaultValue;
				}

			private:
				std::string key;
				T defaultValue;
		};

	public:
		virtual ~SettingsProvider() {}
		virtual std::string getSetting(const Setting<std::string>& setting) = 0;
		virtual void storeSetting(const Setting<std::string>& setting, const std::string& value) = 0;
		virtual bool getSetting(const Setting<bool>& setting) = 0;
		virtual void storeSetting(const Setting<bool>& setting, const bool& value) = 0;
		virtual int getSetting(const Setting<int>& setting) = 0;
		virtual void storeSetting(const Setting<int>& setting, const int& value) = 0;

		virtual std::vector<std::string> getAvailableProfiles() = 0;
		virtual void createProfile(const std::string& profile) = 0;
		virtual void removeProfile(const std::string& profile) = 0;
		/** A final setting is one that this settings provider says may not be overriden by lower priority profiles.
		 * e.g. An Administrator-set configuration to disallow saving user passwords could not be overridden by the user.
		 */
		template<typename T>
		bool getIsSettingFinal(const Setting<T>& setting) {
			return getIsSettingFinal(setting.getKey());
		}
		virtual bool hasSetting(const std::string& key) = 0;

		friend class SettingsProviderHierachy;
	protected:
		virtual bool getIsSettingFinal(const std::string& settingPath) = 0;

	public:
		/**
		 * Emitted when a setting is changed.
		 */
		boost::signal<void (const std::string& /*Setting's Path*/)> onSettingChanged;
};

}