e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
81 lines
2.5 KiB
C++
81 lines
2.5 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup freestyle
|
|
* \brief Simple RAII wrappers for std:: sequential containers
|
|
*
|
|
* PointerSequence
|
|
*
|
|
* Produces a wrapped version of a sequence type (std::vector, std::deque, std::list) that will
|
|
* take ownership of pointers that it stores. Those pointers will be deleted in its destructor.
|
|
*
|
|
* Because the contained pointers are wholly owned by the sequence, you cannot make a copy of the
|
|
* sequence. Making a copy would result in a double free.
|
|
*
|
|
* This is a no-frills class that provides no additional facilities. The user is responsible for
|
|
* managing any pointers that are removed from the list, and for making sure that any pointers
|
|
* contained in the class are not deleted elsewhere. Because this class does no reference
|
|
* counting, the user must also make sure that any pointer appears only once in the sequence.
|
|
*
|
|
* If more sophisticated facilities are needed, use tr1::shared_ptr or boost::shared_ptr.
|
|
* This class is only intended to allow one to eke by in projects where tr1 or boost are not
|
|
* available.
|
|
*
|
|
* Usage: The template takes two parameters, the standard container, and the class held in the
|
|
* container. This is a limitation of C++ templates, where T::iterator is not a type when T is a
|
|
* template parameter. If anyone knows a way around this limitation, then the second parameter can
|
|
* be eliminated.
|
|
*
|
|
* Example:
|
|
* PointerSequence<vector<Widget*>, Widget*> v;
|
|
* v.push_back(new Widget);
|
|
* cout << v[0] << endl; // operator[] is provided by std::vector, not by PointerSequence
|
|
* v.destroy(); // Deletes all pointers in sequence and sets them to nullptr.
|
|
*
|
|
* The idiom for removing a pointer from a sequence is:
|
|
* Widget* w = v[3];
|
|
* v.erase(v.begin() + 3); // or v[3] = 0;
|
|
* The user is now responsible for disposing of w properly.
|
|
*/
|
|
|
|
#include <algorithm>
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
# include "MEM_guardedalloc.h"
|
|
#endif
|
|
|
|
namespace Freestyle {
|
|
|
|
template<typename C, typename T> class PointerSequence : public C {
|
|
PointerSequence(PointerSequence &other);
|
|
PointerSequence &operator=(PointerSequence &other);
|
|
|
|
static void destroyer(T t)
|
|
{
|
|
delete t;
|
|
}
|
|
|
|
public:
|
|
PointerSequence(){};
|
|
|
|
~PointerSequence()
|
|
{
|
|
destroy();
|
|
}
|
|
|
|
void destroy()
|
|
{
|
|
for_each(this->begin(), this->end(), destroyer);
|
|
}
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("Freestyle:PointerSequence")
|
|
#endif
|
|
};
|
|
|
|
} /* namespace Freestyle */
|