OpenShot Library | libopenshot-audio  0.2.0
juce::ReferenceCountedObjectPtr< ObjectType > Class Template Reference

A smart-pointer class which points to a reference-counted object. More...

#include <juce_ReferenceCountedObject.h>

Public Types

using ReferencedType = ObjectType
 The class being referenced by this pointer.
 

Public Member Functions

 ReferenceCountedObjectPtr ()=default
 Creates a pointer to a null object.
 
 ReferenceCountedObjectPtr (decltype(nullptr)) noexcept
 Creates a pointer to a null object.
 
 ReferenceCountedObjectPtr (ReferencedType *refCountedObject) noexcept
 Creates a pointer to an object. More...
 
 ReferenceCountedObjectPtr (ReferencedType &refCountedObject) noexcept
 Creates a pointer to an object. More...
 
 ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr &other) noexcept
 Copies another pointer. More...
 
 ReferenceCountedObjectPtr (ReferenceCountedObjectPtr &&other) noexcept
 Takes-over the object from another pointer.
 
template<typename Convertible >
 ReferenceCountedObjectPtr (const ReferenceCountedObjectPtr< Convertible > &other) noexcept
 Copies another pointer. More...
 
ReferenceCountedObjectPtroperator= (const ReferenceCountedObjectPtr &other)
 Changes this pointer to point at a different object. More...
 
template<typename Convertible >
ReferenceCountedObjectPtroperator= (const ReferenceCountedObjectPtr< Convertible > &other)
 Changes this pointer to point at a different object. More...
 
ReferenceCountedObjectPtroperator= (ReferencedType *newObject)
 Changes this pointer to point at a different object. More...
 
ReferenceCountedObjectPtroperator= (ReferencedType &newObject)
 Changes this pointer to point at a different object. More...
 
ReferenceCountedObjectPtroperator= (decltype(nullptr))
 Resets this pointer to a null pointer.
 
ReferenceCountedObjectPtroperator= (ReferenceCountedObjectPtr &&other) noexcept
 Takes-over the object from another pointer.
 
 ~ReferenceCountedObjectPtr ()
 Destructor. More...
 
ReferencedTypeget () const noexcept
 Returns the object that this pointer references. More...
 
void reset () noexcept
 Resets this object to a null pointer.
 
ReferencedTypeoperator-> () const noexcept
 
ReferencedTypeoperator* () const noexcept
 Dereferences the object that this pointer references. More...
 
bool operator== (decltype(nullptr)) const noexcept
 Checks whether this pointer is null.
 
bool operator!= (decltype(nullptr)) const noexcept
 Checks whether this pointer is null.
 
bool operator== (const ObjectType *other) const noexcept
 Compares two ReferenceCountedObjectPtrs.
 
bool operator== (const ReferenceCountedObjectPtr &other) const noexcept
 Compares two ReferenceCountedObjectPtrs.
 
bool operator!= (const ObjectType *other) const noexcept
 Compares two ReferenceCountedObjectPtrs.
 
bool operator!= (const ReferenceCountedObjectPtr &other) const noexcept
 Compares two ReferenceCountedObjectPtrs.
 
 operator ReferencedType * () const noexcept
 Returns the object that this pointer references. More...
 

Static Public Member Functions

static void decIfNotNull (ReferencedType *o) noexcept
 

Static Public Attributes

static JUCE_DEPRECATED_WITH_BODY(ReferencedType *getObject() const, { return get();}) private voi incIfNotNull )(ReferencedType *o) noexcept
 

Detailed Description

template<class ObjectType>
class juce::ReferenceCountedObjectPtr< ObjectType >

A smart-pointer class which points to a reference-counted object.

The template parameter specifies the class of the object you want to point to - the easiest way to make a class reference-countable is to simply make it inherit from ReferenceCountedObject or SingleThreadedReferenceCountedObject, but if you need to, you can roll your own reference-countable class by implementing a set of methods called incReferenceCount(), decReferenceCount(), and decReferenceCountWithoutDeleting(). See ReferenceCountedObject for examples of how these methods should behave.

When using this class, you'll probably want to create a typedef to abbreviate the full templated name - e.g.

struct MyClass : public ReferenceCountedObject
{
using Ptr = ReferenceCountedObjectPtr<MyClass>;
...
}
See also
ReferenceCountedObject, ReferenceCountedObjectArray

Definition at line 245 of file juce_ReferenceCountedObject.h.

Constructor & Destructor Documentation

◆ ReferenceCountedObjectPtr() [1/4]

template<class ObjectType >
juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( ReferencedType refCountedObject)
inlinenoexcept

Creates a pointer to an object.

This will increment the object's reference-count.

Definition at line 261 of file juce_ReferenceCountedObject.h.

◆ ReferenceCountedObjectPtr() [2/4]

template<class ObjectType >
juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( ReferencedType refCountedObject)
inlinenoexcept

Creates a pointer to an object.

This will increment the object's reference-count.

Definition at line 270 of file juce_ReferenceCountedObject.h.

◆ ReferenceCountedObjectPtr() [3/4]

template<class ObjectType >
juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( const ReferenceCountedObjectPtr< ObjectType > &  other)
inlinenoexcept

Copies another pointer.

This will increment the object's reference-count.

Definition at line 279 of file juce_ReferenceCountedObject.h.

◆ ReferenceCountedObjectPtr() [4/4]

template<class ObjectType >
template<typename Convertible >
juce::ReferenceCountedObjectPtr< ObjectType >::ReferenceCountedObjectPtr ( const ReferenceCountedObjectPtr< Convertible > &  other)
inlinenoexcept

Copies another pointer.

This will increment the object's reference-count (if it is non-null).

Definition at line 296 of file juce_ReferenceCountedObject.h.

◆ ~ReferenceCountedObjectPtr()

template<class ObjectType >
juce::ReferenceCountedObjectPtr< ObjectType >::~ReferenceCountedObjectPtr ( )
inline

Destructor.

This will decrement the object's reference-count, which will cause the object to be deleted when the ref-count hits zero.

Definition at line 371 of file juce_ReferenceCountedObject.h.

Member Function Documentation

◆ operator=() [1/4]

template<class ObjectType >
ReferenceCountedObjectPtr& juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( const ReferenceCountedObjectPtr< ObjectType > &  other)
inline

Changes this pointer to point at a different object.

The reference count of the old object is decremented, and it might be deleted if it hits zero. The new object's count is incremented.

Definition at line 306 of file juce_ReferenceCountedObject.h.

Referenced by juce::ReferenceCountedObjectPtr< juce::Value::ValueSource >::operator=().

◆ operator=() [2/4]

template<class ObjectType >
template<typename Convertible >
ReferenceCountedObjectPtr& juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( const ReferenceCountedObjectPtr< Convertible > &  other)
inline

Changes this pointer to point at a different object.

The reference count of the old object is decremented, and it might be deleted if it hits zero. The new object's count is incremented.

Definition at line 316 of file juce_ReferenceCountedObject.h.

◆ operator=() [3/4]

template<class ObjectType >
ReferenceCountedObjectPtr& juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( ReferencedType newObject)
inline

Changes this pointer to point at a different object.

The reference count of the old object is decremented, and it might be deleted if it hits zero. The new object's count is incremented.

Definition at line 326 of file juce_ReferenceCountedObject.h.

◆ operator=() [4/4]

template<class ObjectType >
ReferenceCountedObjectPtr& juce::ReferenceCountedObjectPtr< ObjectType >::operator= ( ReferencedType newObject)
inline

Changes this pointer to point at a different object.

The reference count of the old object is decremented, and it might be deleted if it hits zero. The new object's count is incremented.

Definition at line 340 of file juce_ReferenceCountedObject.h.

◆ get()

◆ operator*()

template<class ObjectType >
ReferencedType& juce::ReferenceCountedObjectPtr< ObjectType >::operator* ( ) const
inlinenoexcept

Dereferences the object that this pointer references.

The pointer returned may be null, of course.

Definition at line 400 of file juce_ReferenceCountedObject.h.

◆ operator ReferencedType *()

template<class ObjectType >
juce::ReferenceCountedObjectPtr< ObjectType >::operator ReferencedType * ( ) const
inlinenoexcept

Returns the object that this pointer references.

The pointer returned may be null, of course. Note that this methods allows the compiler to be very lenient with what it allows you to do with the pointer, it's safer to disable this by setting JUCE_STRICT_REFCOUNTEDPOINTER=1, which increased type safety and can prevent some common slip-ups.

Definition at line 427 of file juce_ReferenceCountedObject.h.


The documentation for this class was generated from the following file: