#include <evo/ptr.h>

Inheritance diagram for Ptr< T >:

[legend]

Detailed Description

template<class T>
class evo::Ptr< T >

Dumb pointer to single object.

Useful for making it clear the pointer is not owned here, and is freed elsewhere
- Does not take ownership of any pointer, does not automatically free anything
Also useful for distinguishing between a static immutable data pointer (ex: string literal) and a dumb managed pointer
- Evo containers always copy from a dumb pointer, but may reference a raw pointer (assuming static immutable data)
Overrides pointer operators so dumb pointer can be used like a raw pointer/array
Copying a dumb pointer makes a copy of the pointer itself, referencing the same object(s) – only safe with containers if pointer outlives the container
Ptr<T[]> is specialized for arrays for consistency with other managed pointers
Caution: Not thread safe

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>
using namespace evo;
// It's clear here that this function does not take ownership of ptr
void func(Ptr<int> ptr) {
    // Use dumb ptr
}
int main() {
    // Create and set a smart pointer
    SmartPtr<int> ptr(new int);
    *ptr = 1;
    // Call function that uses the pointer
    func(ptr);
    return 0;
}

Public Types
typedef PtrBase< T >	Base
	Base type. More...

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

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

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

Public Member Functions
	Ptr ()
	Default constructor sets as NULL. More...

	Ptr (T *ptr)
	Constructor. More...

	Ptr (const T *ptr)
	Constructor. More...

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

	Ptr (const Base &src)
	Copy constructor to reference pointer. More...

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

This &	clear ()
	Clear pointer, setting 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= (const Base &src)
	Assignment operator to reference pointer. More...

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

This &	operator= (const T *ptr)
	Assignment operator for raw 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...

Member Typedef Documentation

◆ Base

typedef PtrBase<T> Base

Base type.

◆ EvoNullableType

typedef void EvoNullableType

inherited

Identify as nullable type.

◆ Item

typedef T Item

Item type dereferenced to.

◆ This

typedef Ptr<T> This

This pointer type.

Constructor & Destructor Documentation

◆ Ptr() [1/6]

Ptr ( )

inline

Default constructor sets as NULL.

◆ Ptr() [2/6]

Ptr ( T * ptr )

inline

Constructor.

Parameters

ptr	Pointer to set, NULL for none

◆ Ptr() [3/6]

Ptr ( const T * ptr )

inline

Constructor.

Parameters

ptr	Pointer to set, NULL for none

◆ Ptr() [4/6]

Ptr ( const This & src )

inline

Copy constructor.

Parameters

src	Source pointer

◆ Ptr() [5/6]

Ptr ( const Base & src )

inline

Copy constructor to reference pointer.

Parameters

src	Source pointer

◆ Ptr() [6/6]

Ptr ( This && src )

inline

Move constructor (C++11).

Parameters

src	Source to move

Member Function Documentation

◆ clear()

This& clear ( )

inline

Clear pointer, setting as null.

Returns: This

◆ detach()

T* detach ( )

inline

Detach and return pointer.

This returns current pointer and sets to null

Returns: Pointer

◆ 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/5]

This& operator= ( const This & src )

inline

Copy/Assignment operator.

Parameters

src	Source pointer

Returns: This

◆ operator=() [2/5]

This& operator= ( const Base & src )

inline

Assignment operator to reference pointer.

Parameters

src	Source pointer

Returns: This

◆ operator=() [3/5]

This& operator= ( T * ptr )

inline

Assignment operator for raw pointer.

Parameters

ptr	Pointer to set

Returns: This

◆ operator=() [4/5]

This& operator= ( const T * ptr )

inline

Assignment operator for raw pointer.

Parameters

ptr	Pointer to set

Returns: This

◆ operator=() [5/5]

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::Ptr< T >

Public Types

Public Member Functions

Public Attributes

Member Typedef Documentation

◆ Base

◆ EvoNullableType

◆ Item

◆ This

Constructor & Destructor Documentation

◆ Ptr() [1/6]

◆ Ptr() [2/6]

◆ Ptr() [3/6]

◆ Ptr() [4/6]

◆ Ptr() [5/6]

◆ Ptr() [6/6]

Member Function Documentation

◆ clear()

◆ detach()

◆ 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/5]

◆ operator=() [2/5]

◆ operator=() [3/5]

◆ operator=() [4/5]

◆ operator=() [5/5]

◆ 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::Ptr< T >