icinga2/lib/base/dictionary.cpp

249 lines
5.8 KiB
C++

/******************************************************************************
* Icinga 2 *
* 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 *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#include "base/dictionary.hpp"
#include "base/objectlock.hpp"
#include "base/debug.hpp"
#include "base/primitivetype.hpp"
#include <boost/foreach.hpp>
using namespace icinga;
REGISTER_PRIMITIVE_TYPE(Dictionary, Dictionary::GetPrototype());
/**
* Compares dictionary keys using the less operator.
*/
struct DictionaryKeyLessComparer
{
/**
* Compares two keys.
*
* @param a The first key.
* @param b The second key.
* @returns true if the first key is less than the second key, false
* otherwise
*/
bool operator()(const std::pair<String, Value>& a, const char *b)
{
return a.first < b;
}
/**
* Compares two keys.
*
* @param a The first key.
* @param b The second key.
* @returns true if the first key is less than the second key, false
* otherwise
*/
bool operator()(const char *a, const std::pair<String, Value>& b)
{
return a < b.first;
}
};
/**
* Retrieves a value from a dictionary.
*
* @param key The key whose value should be retrieved.
* @returns The value of an empty value if the key was not found.
*/
Value Dictionary::Get(const char *key) const
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
std::map<String, Value>::const_iterator it;
it = std::lower_bound(m_Data.begin(), m_Data.end(), key, DictionaryKeyLessComparer());
if (it == m_Data.end() || DictionaryKeyLessComparer()(key, *it))
return Empty;
return it->second;
}
/**
* Retrieves a value from the dictionary.
*
* @param key The key whose value should be retrieved.
* @returns The value or an empty value if the key was not found.
*/
Value Dictionary::Get(const String& key) const
{
return Get(key.CStr());
}
/**
* Sets a value in the dictionary.
*
* @param key The key.
* @param value The value.
*/
void Dictionary::Set(const String& key, const Value& value)
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
std::pair<std::map<String, Value>::iterator, bool> ret;
ret = m_Data.insert(std::make_pair(key, value));
if (!ret.second)
ret.first->second = value;
}
/**
* Returns an iterator to the beginning of the dictionary.
*
* Note: Caller must hold the object lock while using the iterator.
*
* @returns An iterator.
*/
Dictionary::Iterator Dictionary::Begin(void)
{
ASSERT(OwnsLock());
return m_Data.begin();
}
/**
* Returns an iterator to the end of the dictionary.
*
* Note: Caller must hold the object lock while using the iterator.
*
* @returns An iterator.
*/
Dictionary::Iterator Dictionary::End(void)
{
ASSERT(OwnsLock());
return m_Data.end();
}
/**
* Returns the number of elements in the dictionary.
*
* @returns Number of elements.
*/
size_t Dictionary::GetLength(void) const
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
return m_Data.size();
}
/**
* Checks whether the dictionary contains the specified key.
*
* @param key The key.
* @returns true if the dictionary contains the key, false otherwise.
*/
bool Dictionary::Contains(const String& key) const
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
return (m_Data.find(key) != m_Data.end());
}
/**
* Removes the specified key from the dictionary.
*
* @param key The key.
*/
void Dictionary::Remove(const String& key)
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
Dictionary::Iterator it;
it = m_Data.find(key);
if (it == m_Data.end())
return;
m_Data.erase(it);
}
/**
* Removes the item specified by the iterator from the dictionary.
*
* @param it The iterator.
*/
void Dictionary::Remove(Dictionary::Iterator it)
{
ASSERT(OwnsLock());
m_Data.erase(it);
}
/**
* Removes all dictionary items.
*/
void Dictionary::Clear(void)
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
m_Data.clear();
}
void Dictionary::CopyTo(const Dictionary::Ptr& dest) const
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
BOOST_FOREACH(const Dictionary::Pair& kv, m_Data) {
dest->Set(kv.first, kv.second);
}
}
/**
* Makes a shallow copy of a dictionary.
*
* @returns a copy of the dictionary.
*/
Dictionary::Ptr Dictionary::ShallowClone(void) const
{
Dictionary::Ptr clone = new Dictionary();
CopyTo(clone);
return clone;
}
/**
* Returns an array containing all keys
* which are currently set in this directory.
*
* @returns an array of key names
*/
std::vector<String> Dictionary::GetKeys(void) const
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
std::vector<String> keys;
BOOST_FOREACH(const Dictionary::Pair& kv, m_Data) {
keys.push_back(kv.first);
}
return keys;
}