icinga2/base/dictionary.h

142 lines
3.5 KiB
C
Raw Normal View History

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012 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
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:
typedef shared_ptr<Dictionary> Ptr;
typedef weak_ptr<Dictionary> WeakPtr;
typedef map<string, Variant>::iterator Iterator;
2012-05-17 19:14:03 +02:00
/**
* Retrieves a value from the dictionary.
*
* @param key The key.
2012-05-18 22:53:35 +02:00
* @param[out] value Pointer to the value.
2012-05-17 19:14:03 +02:00
* @returns true if the value was retrieved, false otherwise.
*/
2012-05-16 11:30:54 +02:00
template<typename T>
bool Get(const string& key, T *value) const
2012-05-16 11:30:54 +02:00
{
2012-07-16 22:00:50 +02:00
map<string, Variant>::const_iterator i = m_Data.find(key);
2012-04-18 15:22:25 +02:00
2012-05-17 19:14:03 +02:00
if (i == m_Data.end())
2012-05-16 11:30:54 +02:00
return false;
2012-04-18 15:22:25 +02:00
2012-05-18 10:27:41 +02:00
*value = static_cast<T>(i->second);
2012-04-18 15:22:25 +02:00
2012-05-16 11:30:54 +02:00
return true;
}
2012-05-17 19:14:03 +02:00
/**
* Sets a value in the dictionary.
*
* @param key The key.
* @param value The value.
*/
template<typename T>
void Set(const string& key, const T& value)
2012-05-17 19:14:03 +02:00
{
pair<typename map<string, Variant>::iterator, bool> ret;
ret = m_Data.insert(make_pair(key, value));
if (!ret.second)
ret.first->second = value;
2012-05-17 19:14:03 +02:00
}
/**
* Adds an unnamed value to the dictionary.
*
* @param value The value.
* @returns The key that was used to add the new item.
2012-05-17 19:14:03 +02:00
*/
template<typename T>
string Add(const T& value)
2012-05-17 19:14:03 +02:00
{
Iterator it;
2012-05-17 19:14:03 +02:00
string key;
long index = GetLength();
do {
stringstream s;
s << "_" << index;
index++;
key = s.str();
it = m_Data.find(key);
} while (it != m_Data.end());
Set(key, value);
return key;
2012-05-17 19:14:03 +02:00
}
2012-04-18 15:22:25 +02:00
bool Contains(const string& key) const;
Iterator Begin(void);
Iterator End(void);
2012-04-20 13:49:04 +02:00
long GetLength(void) const;
void Remove(const string& key);
2012-07-09 10:09:53 +02:00
private:
map<string, Variant> m_Data;
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 */