|
DISTRHO Plugin Framework
|
#include <ScopedPointer.hpp>
Public Member Functions | |
| ScopedPointer () noexcept | |
| ScopedPointer (ObjectType *const objectToTakePossessionOf) noexcept | |
| ScopedPointer (ScopedPointer &objectToTransferFrom) noexcept | |
| ~ScopedPointer () | |
| ScopedPointer & | operator= (ScopedPointer &objectToTransferFrom) |
| ScopedPointer & | operator= (ObjectType *const newObjectToTakePossessionOf) |
| operator ObjectType * () const noexcept | |
| ObjectType * | get () const noexcept |
| ObjectType & | getObject () const noexcept |
| ObjectType & | operator* () const noexcept |
| ObjectType * | operator-> () const noexcept |
| ObjectType * | release () noexcept |
| void | swapWith (ScopedPointer< ObjectType > &other) noexcept |
Copyright (C) 2013 Raw Material Software Ltd.
Permission is granted to use this software under the terms of the ISC license http://www.isc.org/downloads/software-support-policy/isc-license/
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. This class holds a pointer which is automatically deleted when this object goes out of scope.
Once a pointer has been passed to a ScopedPointer, it will make sure that the pointer gets deleted when the ScopedPointer is deleted. Using the ScopedPointer on the stack or as member variables is a good way to use RAII to avoid accidentally leaking dynamically created objects.
A ScopedPointer can be used in pretty much the same way that you'd use a normal pointer to an object. If you use the assignment operator to assign a different object to a ScopedPointer, the old one will be automatically deleted.
A const ScopedPointer is guaranteed not to lose ownership of its object or change the object to which it points during its lifetime. This means that making a copy of a const ScopedPointer is impossible, as that would involve the new copy taking ownership from the old one.
If you need to get a pointer out of a ScopedPointer without it being deleted, you can use the release() method.
Something to note is the main difference between this class and the std::auto_ptr class, which is that ScopedPointer provides a cast-to-object operator, wheras std::auto_ptr requires that you always call get() to retrieve the pointer. The advantages of providing the cast is that you don't need to call get(), so can use the ScopedPointer in pretty much exactly the same way as a raw pointer. The disadvantage is that the compiler is free to use the cast in unexpected and sometimes dangerous ways - in particular, it becomes difficult to return a ScopedPointer as the result of a function. To avoid this causing errors, ScopedPointer contains an overloaded constructor that should cause a syntax error in these circumstances, but it does mean that instead of returning a ScopedPointer from a function, you'd need to return a raw pointer (or use a std::auto_ptr instead).
|
inlinenoexcept |
Creates a ScopedPointer containing a null pointer.
|
inlinenoexcept |
Creates a ScopedPointer that owns the specified object.
|
inlinenoexcept |
Creates a ScopedPointer that takes its pointer from another ScopedPointer.
Because a pointer can only belong to one ScopedPointer, this transfers the pointer from the other object to this one, and the other object is reset to be a null pointer.
|
inline |
Destructor. This will delete the object that this ScopedPointer currently refers to.
|
inline |
Changes this ScopedPointer to point to a new object.
Because a pointer can only belong to one ScopedPointer, this transfers the pointer from the other object to this one, and the other object is reset to be a null pointer.
If this ScopedPointer already points to an object, that object will first be deleted.
|
inline |
Changes this ScopedPointer to point to a new object.
If this ScopedPointer already points to an object, that object will first be deleted.
The pointer that you pass in may be a nullptr.
|
inlinenoexcept |
Returns the object that this ScopedPointer refers to.
|
inlinenoexcept |
Returns the object that this ScopedPointer refers to.
|
inlinenoexcept |
Returns the object that this ScopedPointer refers to.
|
inlinenoexcept |
Returns the object that this ScopedPointer refers to.
|
inlinenoexcept |
Lets you access methods and properties of the object that this ScopedPointer refers to.
|
inlinenoexcept |
Removes the current object from this ScopedPointer without deleting it. This will return the current object, and set the ScopedPointer to a null pointer.
|
inlinenoexcept |
Swaps this object with that of another ScopedPointer. The two objects simply exchange their pointers.
1.9.1