horok/virtualbox
1
0
Fork 0
Code Activity

Adding upstream version 7.0.20-dfsg.

Browse source 
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
This commit is contained in:
Daniel Baumann 2025-06-22 09:56:04 +02:00
parent d0c7daf57c
commit df1bda4fe9
Signed by: daniel.baumann
GPG key ID: BCC918A2ABD66424
26643 changed files with 10005219 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

463
include/iprt/cpp/restarray.h Normal file
View file

@ -0,0 +1,463 @@
/** @file
* IPRT - C++ Representational State Transfer (REST) Array Template Class.
*/
/*
* Copyright (C) 2008-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.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, in version 3 of the
* License.
*
* 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, see <https://www.gnu.org/licenses>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
#ifndef IPRT_INCLUDED_cpp_restarray_h
#define IPRT_INCLUDED_cpp_restarray_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/cpp/restbase.h>
/** @defgroup grp_rt_cpp_restarray C++ Representational State Transfer (REST) Array Template Class.
* @ingroup grp_rt_cpp
* @{
*/
/**
* Abstract base class for the RTCRestArray template.
*/
class RT_DECL_CLASS RTCRestArrayBase : public RTCRestObjectBase
{
public:
/** Default destructor. */
RTCRestArrayBase() RT_NOEXCEPT;
/** Destructor. */
virtual ~RTCRestArrayBase();
/* Overridden methods: */
virtual RTCRestObjectBase *baseClone() const RT_NOEXCEPT RT_OVERRIDE;
virtual int resetToDefault() RT_NOEXCEPT RT_OVERRIDE;
virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) const RT_NOEXCEPT RT_OVERRIDE;
virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_NOEXCEPT RT_OVERRIDE;
virtual int toString(RTCString *a_pDst, uint32_t a_fFlags = kCollectionFormat_Unspecified) const RT_NOEXCEPT RT_OVERRIDE;
virtual int fromString(RTCString const &a_rValue, const char *a_pszName, PRTERRINFO a_pErrInfo = NULL,
uint32_t a_fFlags = kCollectionFormat_Unspecified) RT_NOEXCEPT RT_OVERRIDE;
virtual kTypeClass typeClass(void) const RT_NOEXCEPT RT_OVERRIDE;
virtual const char *typeName(void) const RT_NOEXCEPT RT_OVERRIDE;
/**
* Clear the content of the map.
*/
void clear() RT_NOEXCEPT;
/**
* Check if an list contains any items.
*
* @return True if there is more than zero items, false otherwise.
*/
inline bool isEmpty() const RT_NOEXCEPT
{
return m_cElements == 0;
}
/**
* Gets the number of entries in the map.
*/
inline size_t size() const RT_NOEXCEPT
{
return m_cElements;
}
/**
* Returns the base object pointer at a given index.
*
* @returns The base object at @a a_idx, NULL if out of range.
* @param a_idx The array index.
*/
inline RTCRestObjectBase *atBase(size_t a_idx) RT_NOEXCEPT
{
if (a_idx < m_cElements)
return m_papElements[a_idx];
return NULL;
}
/**
* Returns the const base object pointer at a given index.
*
* @returns The base object at @a a_idx, NULL if out of range.
* @param a_idx The array index.
*/
inline RTCRestObjectBase const *atBase(size_t a_idx) const RT_NOEXCEPT
{
if (a_idx < m_cElements)
return m_papElements[a_idx];
return NULL;
}
/**
* Removes the element at @a a_idx.
* @returns true if @a a_idx is valid, false if out of range.
* @param a_idx The index of the element to remove.
* The value ~(size_t)0 is an alias for the final element.
*/
bool removeAt(size_t a_idx) RT_NOEXCEPT;
/**
* Makes sure the array can hold at the given number of entries.
*
* @returns VINF_SUCCESS or VERR_NO_MEMORY.
* @param a_cEnsureCapacity The number of elements to ensure capacity to hold.
*/
int ensureCapacity(size_t a_cEnsureCapacity) RT_NOEXCEPT;
protected:
/** The array. */
RTCRestObjectBase **m_papElements;
/** Number of elements in the array. */
size_t m_cElements;
/** The number of elements m_papElements can hold.
* The difference between m_cCapacity and m_cElements are all NULLs. */
size_t m_cCapacity;
/**
* Helper for creating a clone.
*
* @returns Pointer to new array on success, NULL if out of memory.
*/
virtual RTCRestArrayBase *createClone(void) const RT_NOEXCEPT = 0;
/**
* Wrapper around the value constructor.
*
* @returns Pointer to new value object on success, NULL if out of memory.
*/
virtual RTCRestObjectBase *createValue(void) RT_NOEXCEPT = 0;
/**
* For accessing the static deserializeInstanceFromJson() method of the value.
*/
virtual int deserializeValueInstanceFromJson(RTCRestJsonCursor const &a_rCursor, RTCRestObjectBase **a_ppInstance) RT_NOEXCEPT = 0;
/**
* Worker for the copy assignment method and copyArrayWorkerMayThrow().
*
* This will use createEntryCopy to do the copying.
*
* @returns VINF_SUCCESS on success, VERR_NO_MEMORY or VERR_NO_STR_MEMORY on failure.
* @param a_rThat The array to copy. Caller makes 100% sure the it has
* the same type as the destination.
*/
int copyArrayWorkerNoThrow(RTCRestArrayBase const &a_rThat) RT_NOEXCEPT;
/**
* Wrapper around copyArrayWorkerNoThrow for the copy constructor and the
* assignment operator.
*/
void copyArrayWorkerMayThrow(RTCRestArrayBase const &a_rThat);
/**
* Worker for performing inserts.
*
* @returns VINF_SUCCESS or VWRN_ALREADY_EXISTS on success.
* VERR_ALREADY_EXISTS, VERR_NO_MEMORY or VERR_NO_STR_MEMORY on failure.
* @param a_idx Where to insert it. The value ~(size_t)0 is an alias for m_cElements.
* @param a_pValue The value to insert. Ownership is transferred to the map on success.
* @param a_fReplace Whether to replace existing entry rather than insert.
*/
int insertWorker(size_t a_idx, RTCRestObjectBase *a_pValue, bool a_fReplace) RT_NOEXCEPT;
/**
* Worker for performing inserts.
*
* @returns VINF_SUCCESS or VWRN_ALREADY_EXISTS on success.
* VERR_ALREADY_EXISTS, VERR_NO_MEMORY or VERR_NO_STR_MEMORY on failure.
* @param a_idx Where to insert it. The value ~(size_t)0 is an alias for m_cElements.
* @param a_rValue The value to copy into the map.
* @param a_fReplace Whether to replace existing key-value pair with matching key.
*/
int insertCopyWorker(size_t a_idx, RTCRestObjectBase const &a_rValue, bool a_fReplace) RT_NOEXCEPT;
private:
/** Copy constructor on this class should never be used. */
RTCRestArrayBase(RTCRestArrayBase const &a_rThat);
/** Copy assignment operator on this class should never be used. */
RTCRestArrayBase &operator=(RTCRestArrayBase const &a_rThat);
};
/**
* Limited array class.
*/
template<class ElementType> class RTCRestArray : public RTCRestArrayBase
{
public:
/** Default constructor - empty array. */
RTCRestArray() RT_NOEXCEPT
: RTCRestArrayBase()
{
}
/** Destructor. */
~RTCRestArray()
{
}
/** Copy constructor. */
RTCRestArray(RTCRestArray const &a_rThat)
: RTCRestArrayBase()
{
copyArrayWorkerMayThrow(a_rThat);
}
/** Copy assignment operator. */
inline RTCRestArray &operator=(RTCRestArray const &a_rThat)
{
copyArrayWorkerMayThrow(a_rThat);
return *this;
}
/** Safe copy assignment method. */
inline int assignCopy(RTCRestArray const &a_rThat) RT_NOEXCEPT
{
return copyArrayWorkerNoThrow(a_rThat);
}
/** Make a clone of this object. */
inline RTCRestArray *clone() const RT_NOEXCEPT
{
return (RTCRestArray *)baseClone();
}
/** Factory method. */
static DECLCALLBACK(RTCRestObjectBase *) createInstance(void) RT_NOEXCEPT
{
return new (std::nothrow) RTCRestArray<ElementType>();
}
/** Factory method for elements. */
static DECLCALLBACK(RTCRestObjectBase *) createElementInstance(void) RT_NOEXCEPT
{
return new (std::nothrow) ElementType();
}
/** @copydoc RTCRestObjectBase::FNDESERIALIZEINSTANCEFROMJSON */
static DECLCALLBACK(int) deserializeInstanceFromJson(RTCRestJsonCursor const &a_rCursor, RTCRestObjectBase **a_ppInstance) RT_NOEXCEPT
{
*a_ppInstance = new (std::nothrow) RTCRestArray<ElementType>();
if (*a_ppInstance)
return (*a_ppInstance)->deserializeFromJson(a_rCursor);
return a_rCursor.m_pPrimary->addError(a_rCursor, VERR_NO_MEMORY, "Out of memory");
}
/**
* Insert the given object at the specified index.
*
* @returns VINF_SUCCESS on success.
* VERR_INVALID_POINTER, VERR_NO_MEMORY, VERR_NO_STR_MEMORY or VERR_OUT_OF_RANGE on failure.
* @param a_idx The insertion index. ~(size_t)0 is an alias for the end.
* @param a_pThat The object to insert. The array takes ownership of the object on success.
*/
inline int insert(size_t a_idx, ElementType *a_pThat) RT_NOEXCEPT
{
return insertWorker(a_idx, a_pThat, false /*a_fReplace*/);
}
/**
* Insert a copy of the object at the specified index.
*
* @returns VINF_SUCCESS on success.
* VERR_NO_MEMORY, VERR_NO_STR_MEMORY or VERR_OUT_OF_RANGE on failure.
* @param a_idx The insertion index. ~(size_t)0 is an alias for the end.
* @param a_rThat The object to insert a copy of.
*/
inline int insertCopy(size_t a_idx, ElementType const &a_rThat) RT_NOEXCEPT
{
return insertCopyWorker(a_idx, a_rThat, false /*a_fReplace*/);
}
/**
* Appends the given object to the array.
*
* @returns VINF_SUCCESS on success.
* VERR_INVALID_POINTER, VERR_NO_MEMORY, VERR_NO_STR_MEMORY or VERR_OUT_OF_RANGE on failure.
* @param a_pThat The object to insert. The array takes ownership of the object on success.
*/
inline int append(ElementType *a_pThat) RT_NOEXCEPT
{
return insertWorker(~(size_t)0, a_pThat, false /*a_fReplace*/);
}
/**
* Appends a copy of the object at the specified index.
*
* @returns VINF_SUCCESS on success.
* VERR_NO_MEMORY, VERR_NO_STR_MEMORY or VERR_OUT_OF_RANGE on failure.
* @param a_rThat The object to insert a copy of.
*/
inline int appendCopy(ElementType const &a_rThat) RT_NOEXCEPT
{
return insertCopyWorker(~(size_t)0, a_rThat, false /*a_fReplace*/);
}
/**
* Prepends the given object to the array.
*
* @returns VINF_SUCCESS on success.
* VERR_INVALID_POINTER, VERR_NO_MEMORY, VERR_NO_STR_MEMORY or VERR_OUT_OF_RANGE on failure.
* @param a_pThat The object to insert. The array takes ownership of the object on success.
*/
inline int prepend(ElementType *a_pThat) RT_NOEXCEPT
{
return insertWorker(0, a_pThat, false /*a_fReplace*/);
}
/**
* Prepends a copy of the object at the specified index.
*
* @returns VINF_SUCCESS on success.
* VERR_NO_MEMORY, VERR_NO_STR_MEMORY or VERR_OUT_OF_RANGE on failure.
* @param a_rThat The object to insert a copy of.
*/
inline int prependCopy(ElementType const &a_rThat) RT_NOEXCEPT
{
return insertCopyWorker(0, a_rThat, false /*a_fReplace*/);
}
/**
* Insert the given object at the specified index.
*
* @returns VINF_SUCCESS on success.
* VERR_INVALID_POINTER, VERR_NO_MEMORY, VERR_NO_STR_MEMORY or VERR_OUT_OF_RANGE on failure.
* @param a_idx The index of the existing object to replace.
* @param a_pThat The replacement object. The array takes ownership of the object on success.
*/
inline int replace(size_t a_idx, ElementType *a_pThat) RT_NOEXCEPT
{
return insertWorker(a_idx, a_pThat, true /*a_fReplace*/);
}
/**
* Insert a copy of the object at the specified index.
*
* @returns VINF_SUCCESS on success.
* VERR_NO_MEMORY, VERR_NO_STR_MEMORY or VERR_OUT_OF_RANGE on failure.
* @param a_idx The index of the existing object to replace.
* @param a_rThat The object to insert a copy of.
*/
inline int replaceCopy(size_t a_idx, ElementType const &a_rThat) RT_NOEXCEPT
{
return insertCopyWorker(a_idx, a_rThat, true /*a_fReplace*/);
}
/**
* Returns the object at a given index.
*
* @returns The object at @a a_idx, NULL if out of range.
* @param a_idx The array index.
*/
inline ElementType *at(size_t a_idx) RT_NOEXCEPT
{
if (a_idx < m_cElements)
return (ElementType *)m_papElements[a_idx];
return NULL;
}
/**
* Returns the object at a given index, const variant.
*
* @returns The object at @a a_idx, NULL if out of range.
* @param a_idx The array index.
*/
inline ElementType const *at(size_t a_idx) const RT_NOEXCEPT
{
if (a_idx < m_cElements)
return (ElementType const *)m_papElements[a_idx];
return NULL;
}
/**
* Returns the first object in the array.
* @returns The first object, NULL if empty.
*/
inline ElementType *first() RT_NOEXCEPT
{
return at(0);
}
/**
* Returns the first object in the array, const variant.
* @returns The first object, NULL if empty.
*/
inline ElementType const *first() const RT_NOEXCEPT
{
return at(0);
}
/**
* Returns the last object in the array.
* @returns The last object, NULL if empty.
*/
inline ElementType *last() RT_NOEXCEPT
{
return at(m_cElements - 1);
}
/**
* Returns the last object in the array, const variant.
* @returns The last object, NULL if empty.
*/
inline ElementType const *last() const RT_NOEXCEPT
{
return at(m_cElements - 1);
}
protected:
virtual RTCRestArrayBase *createClone(void) const RT_NOEXCEPT RT_OVERRIDE
{
return new (std::nothrow) RTCRestArray();
}
virtual RTCRestObjectBase *createValue(void) RT_NOEXCEPT RT_OVERRIDE
{
return new (std::nothrow) ElementType();
}
virtual int deserializeValueInstanceFromJson(RTCRestJsonCursor const &a_rCursor, RTCRestObjectBase **a_ppInstance) RT_NOEXCEPT RT_OVERRIDE
{
return ElementType::deserializeInstanceFromJson(a_rCursor, a_ppInstance);
}
};
/** @} */
#endif /* !IPRT_INCLUDED_cpp_restarray_h */