mirror of
https://github.com/Icinga/icinga2.git
synced 2025-09-19 07:47:44 +02:00
0ebcd2662d
The Array, Dictionary, and Namespace types provide a Freeze() method that makes them read-only. So far, there was the possibility to call some methods with `overrideFrozen=true` which would then bypass the corresponding check and allow modification of the data structures nonetheless. With 24b57f0d3a222835178e88489eabd595755ed883, this possibility was already removed from the Namespace type. However, for interface compatibility, it kept the parameter and just ignores it, throwing an exception on any modification on a frozen instance. The only place using `overrideFrozen` was processing of the `-D`/`--define` command line flag that allows setting additional variables in the DSL. At the time it is evaluated, there are no user-created data structures yet that could be frozen, so the only frozen objects that could be encountered are Namespaces (Icinga doesn't freeze other types by itself) and for these, `overrideFrozen` already has no effect. Hence, there is no harm in removing `overrideFrozen` altogether. This simplifies the code and also means that frozen objects are now indeed read-only without exceptions, allowing further optimizations regarding locking in the future.
118 lines
2.5 KiB
C++
118 lines
2.5 KiB
C++
/* Icinga 2 | (c) 2012 Icinga GmbH | GPLv2+ */
|
|
|
|
#ifndef ARRAY_H
|
|
#define ARRAY_H
|
|
|
|
#include "base/i2-base.hpp"
|
|
#include "base/objectlock.hpp"
|
|
#include "base/value.hpp"
|
|
#include <boost/range/iterator.hpp>
|
|
#include <vector>
|
|
#include <set>
|
|
|
|
namespace icinga
|
|
{
|
|
|
|
typedef std::vector<Value> ArrayData;
|
|
|
|
/**
|
|
* An array of Value items.
|
|
*
|
|
* @ingroup base
|
|
*/
|
|
class Array final : public Object
|
|
{
|
|
public:
|
|
DECLARE_OBJECT(Array);
|
|
|
|
/**
|
|
* An iterator that can be used to iterate over array elements.
|
|
*/
|
|
typedef std::vector<Value>::iterator Iterator;
|
|
|
|
typedef std::vector<Value>::size_type SizeType;
|
|
|
|
Array() = default;
|
|
Array(const ArrayData& other);
|
|
Array(ArrayData&& other);
|
|
Array(std::initializer_list<Value> init);
|
|
|
|
Value Get(SizeType index) const;
|
|
void Set(SizeType index, const Value& value);
|
|
void Set(SizeType index, Value&& value);
|
|
void Add(Value value);
|
|
|
|
Iterator Begin();
|
|
Iterator End();
|
|
|
|
size_t GetLength() const;
|
|
bool Contains(const Value& value) const;
|
|
|
|
void Insert(SizeType index, Value value);
|
|
void Remove(SizeType index);
|
|
void Remove(Iterator it);
|
|
|
|
void Resize(SizeType newSize);
|
|
void Clear();
|
|
|
|
void Reserve(SizeType newSize);
|
|
|
|
void CopyTo(const Array::Ptr& dest) const;
|
|
Array::Ptr ShallowClone() const;
|
|
|
|
static Object::Ptr GetPrototype();
|
|
|
|
template<typename T>
|
|
static Array::Ptr FromVector(const std::vector<T>& v)
|
|
{
|
|
Array::Ptr result = new Array();
|
|
ObjectLock olock(result);
|
|
std::copy(v.begin(), v.end(), std::back_inserter(result->m_Data));
|
|
return result;
|
|
}
|
|
|
|
template<typename T>
|
|
std::set<T> ToSet()
|
|
{
|
|
ObjectLock olock(this);
|
|
return std::set<T>(Begin(), End());
|
|
}
|
|
|
|
template<typename T>
|
|
static Array::Ptr FromSet(const std::set<T>& v)
|
|
{
|
|
Array::Ptr result = new Array();
|
|
ObjectLock olock(result);
|
|
std::copy(v.begin(), v.end(), std::back_inserter(result->m_Data));
|
|
return result;
|
|
}
|
|
|
|
Object::Ptr Clone() const override;
|
|
|
|
Array::Ptr Reverse() const;
|
|
|
|
void Sort();
|
|
|
|
String ToString() const override;
|
|
Value Join(const Value& separator) const;
|
|
|
|
Array::Ptr Unique() const;
|
|
void Freeze();
|
|
|
|
Value GetFieldByName(const String& field, bool sandboxed, const DebugInfo& debugInfo) const override;
|
|
void SetFieldByName(const String& field, const Value& value, const DebugInfo& debugInfo) override;
|
|
|
|
private:
|
|
std::vector<Value> m_Data; /**< The data for the array. */
|
|
bool m_Frozen{false};
|
|
};
|
|
|
|
Array::Iterator begin(const Array::Ptr& x);
|
|
Array::Iterator end(const Array::Ptr& x);
|
|
|
|
}
|
|
|
|
extern template class std::vector<icinga::Value>;
|
|
|
|
#endif /* ARRAY_H */
|