#include <evo/ptr.h>

Inheritance diagram for SmartPtr< T >:

Detailed Description

template<class T>
class evo::SmartPtr< T >

Smart pointer to single object.

Takes ownership of a given pointer and frees the pointer automatically by calling delete
Overrides pointer operators so smart pointer can be used like a raw pointer
Copying a smart pointer makes a copy of the pointed object (raw pointer not shared) – ok for containers
- This requires T implement a proper copy-constructor
Call detach() to release (transfer) ownership of pointer without freeing it
- Note that it's often better to share ownership with SharedPtr rather than manually transfer ownership around
Caution: Not thread safe

SmartPtr<T[]> is specialized for arrays so the pointer is freed with delete[]. However an array SmartPtr<T[]> cannot be copied (array size isn't known) so that specialization isn't usable in containers, use List or Array instead.

See Managed Pointers

C++11:

Move semantics

Template Parameters

T	Type to use pointer to (not the raw pointer type)

Example

#include <evo/ptr.h>
#include <evo/string.h>
#include <evo/io.h>
using namespace evo;
static Console& c = con();
int main() {
    // Create smart pointer, set a value
    SmartPtr<String> ptr(new String);
    *ptr = "testing";    // use dereference operator* like normal pointer
    // Copying smart pointer makes a copy of the object
    {
        SmartPtr<String> ptr2(ptr);
        *ptr2 = "foo";   // dereference ptr2 and change value
    } // ptr2 automatically freed
    // Print ptr value as terminated string (just for example) -- use operator-> like normal pointer
    c.out << ptr->cstr() << NL;
    return 0;
} // ptr automatically freed

Output:

testing

Example transferring ownership

#include <evo/ptr.h>
using namespace evo;
// Function that takes ownership of a pointer (SmartPtr passed by value)
void take(SmartPtr<int> ptr) {
    // ptr owns the pointer, it will be freed at end of scope
};
int main() {
    // Create local pointer, set a value
    SmartPtr<int> local_ptr(new int);
    *local_ptr = 1;
    // Call function, release ownership with detach()
    take(local_ptr.detach());
}

Public Types
typedef PtrBase< T, T * >	Base
	This pointer base type. More...

typedef void	EvoNullableType
	Identify as nullable type. More...

typedef T	Item
	Item type dereferenced to. More...

typedef SmartPtr< T >	This
	This pointer type. More...

Public Member Functions
	SmartPtr (T *ptr=NULL)
	Constructor. More...

	SmartPtr (const This &src)
	Copy constructor. More...

	SmartPtr (This &&src)
	Move constructor (C++11). More...

	~SmartPtr ()
	Destructor. More...

This &	clear ()
	Clear (free) pointer and set as null. More...

T *	detach ()
	Detach and return pointer. More...

bool	null () const
	Get whether pointer is null. More...

	operator SafeBoolType () const
	Safe (explicit) evaluation as bool type. More...

bool	operator! () const
	Negation operator checks if NULL. More...

bool	operator!= (const Base &ptr) const
	Inequality operator. More...

bool	operator!= (void *ptr) const
	Inequality operator. More...

const T &	operator* () const
	Dereference operator (const). More...

T &	operator* ()
	Dereference operator (mutable). More...

const T *	operator-> () const
	Member access operator (const). More...

T *	operator-> ()
	Member access operator (mutable). More...

bool	operator< (const Base &ptr) const
	Less-than operator. More...

bool	operator< (void *ptr) const
	Less-than operator. More...

bool	operator<= (const Base &ptr) const
	Less-than-or-equals operator. More...

bool	operator<= (void *ptr) const
	Less-than-or-equals operator. More...

This &	operator= (const This &src)
	Copy/Assignment operator. More...

This &	operator= (T *ptr)
	Assignment operator for new pointer. More...

This &	operator= (This &&src)
	Move assignment operator (C++11). More...

bool	operator== (const Base &ptr) const
	Equality operator. More...

bool	operator== (void *ptr) const
	Equality operator. More...

bool	operator> (const Base &ptr) const
	Greater-than operator. More...

bool	operator> (void *ptr) const
	Greater-than operator. More...

bool	operator>= (const Base &ptr) const
	Greater-than-or-equals operator. More...

bool	operator>= (void *ptr) const
	Greater-than-or-equals operator. More...

const T &	operator[] (ulong index) const
	Array access operator (const). More...

T &	operator[] (ulong index)
	Array access operator (mutable). More...

const T *	ptr () const
	Get current pointer (const). More...

T *	ptr ()
	Get current pointer (mutable). More...

This &	set ()
	Set as null – same as clear(). More...

bool	valid () const
	Get whether pointer is valid (not null). More...

Public Attributes
T *	ptr_
	Pointer. More...

Protected Member Functions
void	free ()

Member Typedef Documentation

◆ Base

typedef PtrBase<T,T* > Base

inherited

This pointer base type.

◆ EvoNullableType

typedef void EvoNullableType

inherited

Identify as nullable type.

◆ Item

typedef T Item

Item type dereferenced to.

◆ This

typedef SmartPtr<T> This

This pointer type.

Constructor & Destructor Documentation

◆ SmartPtr() [1/3]

SmartPtr ( T * ptr = NULL )

inline

Constructor.

Parameters

ptr	Pointer to set, NULL for none

◆ SmartPtr() [2/3]

SmartPtr ( const This & src )

inline

Copy constructor.

This makes a copy of source object using T copy constructor
Disabled if array T[]

Parameters

src	Source pointer

◆ ~SmartPtr()

~SmartPtr ( )

inline

Destructor.

◆ SmartPtr() [3/3]

SmartPtr ( This && src )

inline

Move constructor (C++11).

Parameters

src	Source to move

Member Function Documentation

◆ clear()

This& clear ( )

inline

Clear (free) pointer and set as null.

Returns: This

◆ detach()

T* detach ( )

inline

Detach and return pointer.

This returns current pointer and sets to null, releasing ownership

Returns: Pointer

◆ free()

void free ( )

inlineprotected

◆ null()

bool null ( ) const

inlineinherited

Get whether pointer is null.

Returns: Whether null

◆ operator SafeBoolType()

operator SafeBoolType ( ) const

inlineinherited

Safe (explicit) evaluation as bool type.

This is called when object is directly evaluated as a bool, and is equivalent to: !operator!()
See SafeBool

◆ operator!()

bool operator! ( ) const

inlineinherited

Negation operator checks if NULL.

Returns: Whether NULL

◆ operator!=() [1/2]

bool operator!= ( const Base & ptr ) const

inlineinherited

Inequality operator.

Parameters

ptr	Pointer to compare to

Returns: Whether not equal

◆ operator!=() [2/2]

bool operator!= ( void * ptr ) const

inlineinherited

Inequality operator.

Parameters

ptr	Pointer to compare to

Returns: Whether not equal

◆ operator*() [1/2]

const T& operator* ( ) const

inlineinherited

Dereference operator (const).

Results are undefined if pointer is NULL

Returns: Dereferenced pointer

◆ operator*() [2/2]

T& operator* ( )

inlineinherited

Dereference operator (mutable).

Results are undefined if pointer is NULL

Returns: Dereferenced pointer

◆ operator->() [1/2]

const T* operator-> ( ) const

inlineinherited

Member access operator (const).

Results are undefined if pointer is NULL

Returns: Pointer

◆ operator->() [2/2]

T* operator-> ( )

inlineinherited

Member access operator (mutable).

Results are undefined if pointer is NULL

Returns: Pointer

◆ operator<() [1/2]

bool operator< ( const Base & ptr ) const

inlineinherited

Less-than operator.

Parameters

ptr	Pointer to compare to

Returns: Whether less than ptr

◆ operator<() [2/2]

bool operator< ( void * ptr ) const

inlineinherited

Less-than operator.

Parameters

ptr	Pointer to compare to

Returns: Whether less than ptr

◆ operator<=() [1/2]

bool operator<= ( const Base & ptr ) const

inlineinherited

Less-than-or-equals operator.

Parameters

ptr	Pointer to compare to

Returns: Whether less than or equal to ptr

◆ operator<=() [2/2]

bool operator<= ( void * ptr ) const

inlineinherited

Less-than-or-equals operator.

Parameters

ptr	Pointer to compare to

Returns: Whether less than or equal to ptr

◆ operator=() [1/3]

This& operator= ( const This & src )

inline

Copy/Assignment operator.

This makes a copy of source object using T copy constructor
Disabled if array T[]

Parameters

src	Source pointer

Returns: This

◆ operator=() [2/3]

This& operator= ( T * ptr )

inline

Assignment operator for new pointer.

Parameters

ptr	Pointer to set

Returns: This

◆ operator=() [3/3]

This& operator= ( This && src )

inline

Move assignment operator (C++11).

Parameters

src	Source to move

Returns: This

◆ operator==() [1/2]

bool operator== ( const Base & ptr ) const

inlineinherited

Equality operator.

Parameters

ptr	Pointer to compare to

Returns: Whether equal

◆ operator==() [2/2]

bool operator== ( void * ptr ) const

inlineinherited

Equality operator.

Parameters

ptr	Pointer to compare to

Returns: Whether equal

◆ operator>() [1/2]

bool operator> ( const Base & ptr ) const

inlineinherited

Greater-than operator.

Parameters

ptr	Pointer to compare to

Returns: Whether greater than ptr

◆ operator>() [2/2]

bool operator> ( void * ptr ) const

inlineinherited

Greater-than operator.

Parameters

ptr	Pointer to compare to

Returns: Whether greater than ptr

◆ operator>=() [1/2]

bool operator>= ( const Base & ptr ) const

inlineinherited

Greater-than-or-equals operator.

Parameters

ptr	Pointer to compare to

Returns: Whether greater than or equal to ptr

◆ operator>=() [2/2]

bool operator>= ( void * ptr ) const

inlineinherited

Greater-than-or-equals operator.

Parameters

ptr	Pointer to compare to

Returns: Whether greater than or equal to ptr

◆ operator[]() [1/2]

const T& operator[] ( ulong index ) const

inlineinherited

Array access operator (const).

Results are undefined if pointer is NULL or index is out of bounds

Returns: Item reference

◆ operator[]() [2/2]

T& operator[] ( ulong index )

inlineinherited

Array access operator (mutable).

Results are undefined if pointer is NULL or index is out of bounds

Returns: Item reference

◆ ptr() [1/2]

const T* ptr ( ) const

inlineinherited

Get current pointer (const).

Caution: This does not release ownership of the pointer

Returns: Current pointer, or NULL if none

◆ ptr() [2/2]

T* ptr ( )

inlineinherited

Get current pointer (mutable).

Caution: This does not release ownership of the pointer

Returns: Current pointer, or NULL if none

◆ set()

This& set ( )

inline

Set as null – same as clear().

Returns: This

◆ valid()

bool valid ( ) const

inlineinherited

Get whether pointer is valid (not null).

Returns: Whether valid

Member Data Documentation

◆ ptr_

T* ptr_

inherited

Pointer.

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

evo/ptr.h

Detailed Description

template<class T> class evo::SmartPtr< T >

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Member Typedef Documentation

◆ Base

◆ EvoNullableType

◆ Item

◆ This

Constructor & Destructor Documentation

◆ SmartPtr() [1/3]

◆ SmartPtr() [2/3]

◆ ~SmartPtr()

◆ SmartPtr() [3/3]

Member Function Documentation

◆ clear()

◆ detach()

◆ free()

◆ null()

◆ operator SafeBoolType()

◆ operator!()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator<() [1/2]

◆ operator<() [2/2]

◆ operator<=() [1/2]

◆ operator<=() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator>() [1/2]

◆ operator>() [2/2]

◆ operator>=() [1/2]

◆ operator>=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ ptr() [1/2]

◆ ptr() [2/2]

◆ set()

◆ valid()

Member Data Documentation

◆ ptr_

template<class T>
class evo::SmartPtr< T >