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
|
/*
* Copyright (C) 2008-2009 Patrick Ohly <patrick.ohly@gmx.de>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) version 3.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02110-1301 USA
*/
#ifndef INCL_EVOLUTION_FILTER_CONFIG_NODE
# define INCL_EVOLUTION_FILTER_CONFIG_NODE
#include <syncevo/ConfigNode.h>
#include <boost/shared_ptr.hpp>
#include <boost/algorithm/string/case_conv.hpp>
#include <boost/algorithm/string.hpp>
#include <map>
#include <utility>
#include <vector>
#include <string>
#include <syncevo/declarations.h>
SE_BEGIN_CXX
/**
* This class acts as filter between a real config node and its user:
* reads which match properties which are set in the filter will
* return the value set in the filter. Writes will go to the underlying
* node and future reads will return the written value.
*
* The purpose of this class is temporarily overriding saved values
* during one run without having to modify the saved values.
*/
class FilterConfigNode : public ConfigNode {
public:
/** config filters are the same case-insensitive string to string mapping as property sets */
typedef ConfigProps ConfigFilter;
/** read-write access to underlying node */
FilterConfigNode(const boost::shared_ptr<ConfigNode> &node,
const ConfigFilter &filter = ConfigFilter());
/** read-only access to underlying node */
FilterConfigNode(const boost::shared_ptr<const ConfigNode> &node,
const ConfigFilter &filter = ConfigFilter());
virtual std::string getName() const { return m_readOnlyNode->getName(); }
/** add another entry to the list of filter properties */
virtual void addFilter(const std::string &property,
const InitStateString &value);
/** replace current filter list with new one */
virtual void setFilter(const ConfigFilter &filter);
virtual const ConfigFilter &getFilter() const { return m_filter; }
/* ConfigNode API */
virtual void flush();
virtual InitStateString readProperty(const std::string &property) const;
virtual void writeProperty(const std::string &property,
const InitStateString &value,
const std::string &comment = "");
virtual void readProperties(ConfigProps &props) const;
virtual void removeProperty(const std::string &property);
virtual bool exists() const { return m_readOnlyNode->exists(); }
virtual bool isReadOnly() const { return !m_node || m_readOnlyNode->isReadOnly(); }
virtual void clear();
private:
ConfigFilter m_filter;
boost::shared_ptr<ConfigNode> m_node;
boost::shared_ptr<const ConfigNode> m_readOnlyNode;
};
SE_END_CXX
#endif
|
