icinga2/lib/base/array.hpp

131 lines
3.3 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 *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#ifndef ARRAY_H
#define ARRAY_H
2014-05-25 16:23:35 +02:00
#include "base/i2-base.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 <vector>
namespace icinga
{
/**
* An array of Value items.
*
* @ingroup base
*/
class I2_BASE_API Array : public Object
{
public:
2014-11-03 00:44:04 +01:00
DECLARE_OBJECT(Array);
/**
* An iterator that can be used to iterate over array elements.
*/
2013-03-16 21:18:53 +01:00
typedef std::vector<Value>::iterator Iterator;
2014-05-11 06:00:34 +02:00
typedef std::vector<Value>::size_type SizeType;
Value Get(unsigned int index) const;
void Set(unsigned int index, const Value& value);
void Add(const Value& value);
/**
* Returns an iterator to the beginning of the array.
*
* Note: Caller must hold the object lock while using the iterator.
*
* @returns An iterator.
*/
inline Iterator Begin(void)
{
ASSERT(OwnsLock());
return m_Data.begin();
}
/**
* Returns an iterator to the end of the array.
*
* Note: Caller must hold the object lock while using the iterator.
*
* @returns An iterator.
*/
inline Iterator End(void)
{
ASSERT(OwnsLock());
return m_Data.end();
}
size_t GetLength(void) const;
bool Contains(const Value& value) const;
void Insert(unsigned int index, const Value& value);
void Remove(unsigned int index);
void Remove(Iterator it);
void Resize(size_t new_size);
void Clear(void);
void Reserve(size_t new_size);
void CopyTo(const Array::Ptr& dest) const;
Array::Ptr ShallowClone(void) const;
static Object::Ptr GetPrototype(void);
private:
2013-03-16 21:18:53 +01:00
std::vector<Value> m_Data; /**< The data for the array. */
};
inline Array::Iterator range_begin(Array::Ptr x)
{
return x->Begin();
}
inline Array::Iterator range_end(Array::Ptr x)
{
return x->End();
}
}
namespace boost
{
template<>
struct range_mutable_iterator<icinga::Array::Ptr>
{
typedef icinga::Array::Iterator type;
};
template<>
struct range_const_iterator<icinga::Array::Ptr>
{
typedef icinga::Array::Iterator type;
};
}
#endif /* ARRAY_H */