icinga2/lib/base/dictionary.hpp

108 lines
3.0 KiB
C++
Raw Normal View History

/******************************************************************************
* Icinga 2 *
2015-01-22 12:00:23 +01:00
* Copyright (C) 2012-2015 Icinga Development Team (http://www.icinga.org) *
* *
* 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 *
2012-05-11 13:33:57 +02:00
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
2012-04-18 15:22:25 +02:00
#ifndef DICTIONARY_H
#define DICTIONARY_H
2014-05-25 16:23:35 +02:00
#include "base/i2-base.hpp"
#include "base/object.hpp"
#include "base/value.hpp"
2014-08-25 15:12:39 +02:00
#include <boost/range/iterator.hpp>
2013-03-16 21:18:53 +01:00
#include <map>
#include <vector>
2013-03-16 21:18:53 +01:00
2012-04-18 15:22:25 +02:00
namespace icinga
{
/**
* A container that holds key-value pairs.
2012-05-18 22:21:28 +02:00
*
* @ingroup base
*/
2012-04-18 15:22:25 +02:00
class I2_BASE_API Dictionary : public Object
{
public:
2014-11-03 00:44:04 +01:00
DECLARE_OBJECT(Dictionary);
2012-04-18 15:22:25 +02:00
2012-09-19 12:32:39 +02:00
/**
* An iterator that can be used to iterate over dictionary elements.
*/
2013-03-16 21:18:53 +01:00
typedef std::map<String, Value>::iterator Iterator;
2014-05-11 06:00:34 +02:00
typedef std::map<String, Value>::size_type SizeType;
typedef std::pair<String, Value> Pair;
Value Get(const char *key) const;
Value Get(const String& key) const;
void Set(const String& key, const Value& value);
bool Contains(const String& key) const;
2013-03-01 12:07:52 +01:00
Iterator Begin(void);
Iterator End(void);
2012-04-20 13:49:04 +02:00
2012-08-08 08:34:15 +02:00
size_t GetLength(void) const;
void Remove(const String& key);
void Remove(Iterator it);
2012-07-09 10:09:53 +02:00
void Clear(void);
void CopyTo(const Dictionary::Ptr& dest) const;
Dictionary::Ptr ShallowClone(void) const;
std::vector<String> GetKeys(void) const;
static Object::Ptr GetPrototype(void);
private:
2013-03-16 21:18:53 +01:00
std::map<String, Value> m_Data; /**< The data for the dictionary. */
2012-04-18 15:22:25 +02:00
};
2012-07-16 22:00:50 +02:00
inline Dictionary::Iterator range_begin(Dictionary::Ptr x)
{
return x->Begin();
}
inline Dictionary::Iterator range_end(Dictionary::Ptr x)
{
return x->End();
}
}
namespace boost
{
template<>
struct range_mutable_iterator<icinga::Dictionary::Ptr>
{
typedef icinga::Dictionary::Iterator type;
};
template<>
struct range_const_iterator<icinga::Dictionary::Ptr>
{
typedef icinga::Dictionary::Iterator type;
};
2012-04-18 15:22:25 +02:00
}
#endif /* DICTIONARY_H */