syncevolution/src/syncevo/PrefixConfigNode.h
Patrick Ohly 9b35062bb9 ConfigNode: use map with case-insensitive keys for properties
The case of property names does not matter. A map where the key
is case-insensitive is thus a better data structure for storing
a set of property key/value pairs.

Such a type was already used by FilterConfigNode. This patch
cleans up the config nodes so that all of them use the new ConfigProps
type. The previous typedefs inside ConfigNode and FilterConfigNode are
preserved to keep old source code working without changing it.

The intention is to use the result of readProperties() directly as
parameter for setConfigFilter().
2009-11-25 16:57:51 +01:00

76 lines
2.6 KiB
C++

/*
* 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_PREFIX_CONFIG_NODE
# define INCL_EVOLUTION_PREFIX_CONFIG_NODE
#include <syncevo/ConfigNode.h>
#include <boost/shared_ptr.hpp>
#include <map>
#include <utility>
#include <vector>
#include <string>
#include <syncevo/declarations.h>
SE_BEGIN_CXX
using namespace std;
/**
* This class acts as filter between a real config node and its user:
* a fixed prefix is added to each key when setting/getting a property.
* The list of properties only includes the key/value pairs with
* a matching prefix.
*
* The purpose is to have multiple users accessing the same underlying
* node without running into namespace conflicts.
*/
class PrefixConfigNode : public ConfigNode {
public:
/** read-write access to underlying node */
PrefixConfigNode(const string prefix,
const boost::shared_ptr<ConfigNode> &node);
/** read-only access to underlying node */
PrefixConfigNode(const string prefix,
const boost::shared_ptr<const ConfigNode> &node);
virtual string getName() const { return m_readOnlyNode->getName(); }
/* ConfigNode API */
virtual void flush();
virtual string readProperty(const string &property) const;
virtual void setProperty(const string &property,
const string &value,
const string &comment = "",
const string *defValue = NULL);
virtual void readProperties(ConfigProps &props) const;
virtual void removeProperty(const string &property);
virtual bool exists() const { return m_readOnlyNode->exists(); }
virtual void clear() { m_node->clear(); }
private:
string m_prefix;
boost::shared_ptr<ConfigNode> m_node;
boost::shared_ptr<const ConfigNode> m_readOnlyNode;
};
SE_END_CXX
#endif