syncevolution/src/FilterConfigNode.h

70 lines
2.4 KiB
C
Raw Normal View History

/*
* Copyright (C) 2003-2007 Funambol, Inc
* Copyright (C) 2008 Patrick Ohly
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY, TITLE, NONINFRINGEMENT 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., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307 USA
*/
#ifndef INCL_EVOLUTION_FILTER_CONFIG_NODE
# define INCL_EVOLUTION_FILTER_CONFIG_NODE
#include <ConfigNode.h>
#include <boost/shared_ptr.hpp>
#include <map>
#include <utility>
#include <string>
using namespace std;
/**
* 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:
typedef map<string, string> ConfigFilter_t;
FilterConfigNode(const boost::shared_ptr<ConfigNode> &node,
const ConfigFilter_t &filter = ConfigFilter_t() );
/** add another entry to the list of filter properties */
void addFilter(const string &property,
const string &value);
/** replace current filter list with new one */
void setFilters(const ConfigFilter_t &filter);
/* ConfigNode API */
virtual void flush() { m_node->flush(); }
virtual string readProperty(const string &property) const;
virtual void setProperty(const string &property,
const string &value,
const string &comment = "");
virtual map<string, string> readProperties();
virtual void removeProperty(const string &property);
virtual bool exists() { m_node->exists(); }
private:
ConfigFilter_t m_filter;
boost::shared_ptr<ConfigNode> m_node;
};
#endif