Base smart pointer with reference counting. More...

#include <autoPtr.h>

Inheritance diagram for original::autoPtr< TYPE, DERIVED, DELETER >:

Collaboration diagram for original::autoPtr< TYPE, DERIVED, DELETER >:

Public Member Functions
u_integer	strongRefs () const
	Get strong reference count.

u_integer	weakRefs () const
	Get weak reference count.

bool	exist () const
	Check active ownership.

bool	expired () const
	Check resource validity.

	operator bool () const
	Boolean conversion operator.

const TYPE *	get () const
	Get managed pointer const version.

TYPE *	get ()
	Get managed pointer.

virtual const TYPE &	operator* () const
	Const dereference operator.

virtual const TYPE *	operator-> () const
	Const member access operator.

virtual const TYPE &	operator[] (u_integer index) const
	Const array access operator.

virtual TYPE &	operator* ()
	Mutable dereference operator.

virtual TYPE *	operator-> ()
	Mutable member access operator.

virtual TYPE &	operator[] (u_integer index)
	Mutable array access operator.

void	swap (autoPtr &other) noexcept
	Swaps the reference counters between two autoPtr instances.

integer	compareTo (const autoPtr &other) const override
	Compare reference counters.

std::string	className () const override
	Get class name string.

std::string	toString (bool enter) const override
	String representation formatter.

	~autoPtr () override
	Destructor triggers reference cleanup.

Public Member Functions inherited from original::printable
	operator std::string () const
	Explicit conversion to std::string.

	operator const char * () const
	Explicit conversion to C-style string.

const char *	toCString (bool enter) const
	Direct C-string access with formatting control.

template<typename TYPE>
auto	formatString (const TYPE &t) -> std::string

template<typename TYPE>
auto	formatCString (const TYPE &t) -> const char *

template<typename TYPE>
auto	formatEnum (const TYPE &t) -> std::string

template<typename TYPE>
auto	formatString (TYPE *const &ptr) -> std::string

Public Member Functions inherited from original::comparable< autoPtr< TYPE, DERIVED, DELETER > >
virtual integer	compareTo (const DERIVED &other) const=0
	Compares the current object with another of the same type.

bool	operator== (const DERIVED &other) const
	Checks if the current object is equal to another.

bool	operator!= (const DERIVED &other) const
	Checks if the current object is not equal to another.

bool	operator< (const DERIVED &other) const
	Checks if the current object is less than another.

bool	operator> (const DERIVED &other) const
	Checks if the current object is greater than another.

bool	operator<= (const DERIVED &other) const
	Checks if the current object is less than or equal to another.

bool	operator>= (const DERIVED &other) const
	Checks if the current object is greater than or equal to another.

virtual	~comparable ()=default
	Virtual destructor for proper cleanup of derived objects.

Protected Member Functions
	autoPtr (TYPE *p)
	Construct from raw pointer.

void	setPtr (TYPE *p)
	Replace managed pointer.

void	addStrongRef ()
	Increment strong reference count.

void	addWeakRef ()
	Increment weak reference count.

void	removeStrongRef ()
	Decrement strong reference count.

void	removeWeakRef ()
	Decrement weak reference count.

void	destroyRefCnt () noexcept
	Destroy reference counter.

void	clean () noexcept
	Cleanup resources when expired.

Static Protected Member Functions
static refCount< TYPE, DELETER > *	newRefCount (TYPE *p=nullptr)
	Create new reference counter.

Protected Attributes
refCount< TYPE, DELETER > *	ref_count
	Reference counter object.

Friends
template<typename T, typename DER, typename DEL>
bool	operator== (const autoPtr< T, DER, DEL > &ptr, const std::nullptr_t &null)
	Equality comparison with nullptr.

template<typename T, typename DER, typename DEL>
bool	operator!= (const autoPtr< T, DER, DEL > &ptr, const std::nullptr_t &null)
	Inequality comparison with nullptr.

template<typename T, typename DER, typename DEL>
bool	operator== (const std::nullptr_t &null, const autoPtr< T, DER, DEL > &ptr)
	Equality comparison with nullptr (reversed operands)

template<typename T, typename DER, typename DEL>
bool	operator!= (const std::nullptr_t &null, const autoPtr< T, DER, DEL > &ptr)
	Inequality comparison with nullptr (reversed operands)

Additional Inherited Members
Static Public Member Functions inherited from original::printable
template<typename TYPE>
static std::string	formatString (const TYPE &t)
	Universal value-to-string conversion.

template<typename TYPE>
static std::string	formatString (TYPE *const &ptr)
	Pointer-specific formatting.

template<typename TYPE>
static const char *	formatCString (const TYPE &t)
	C-string cache for temporary usage.

template<typename TYPE>
static std::string	formatEnum (const TYPE &t)
	Enum formatting utility.

template<>
auto	formatString (const char &t) -> std::string

template<>
auto	formatString (const bool &t) -> std::string

template<>
auto	formatString (const char *const &ptr) -> std::string

Detailed Description

template<typename TYPE, typename DERIVED, typename DELETER>
class original::autoPtr< TYPE, DERIVED, DELETER >

Base smart pointer with reference counting.

Template Parameters

TYPE	Managed object type
DERIVED	CRTP pattern parameter for inheritance
DELETER	Custom deleter policy type

Provides core resource management capabilities through:

Strong/weak reference tracking
Automatic cleanup when references reach zero
Custom deletion policies via template parameter

Constructor & Destructor Documentation

◆ autoPtr()

template<typename TYPE, typename DERIVED, typename DELETER>

original::autoPtr< TYPE, DERIVED, DELETER >::autoPtr ( TYPE * p )

explicitprotected

Construct from raw pointer.

Parameters

p	Raw pointer to manage

Warning: Ownership is transferred to autoPtr

Member Function Documentation

◆ className()

template<typename TYPE, typename DERIVED, typename DELETER>

std::string original::autoPtr< TYPE, DERIVED, DELETER >::className ( ) const

overridevirtual

Get class name string.

Returns: Name of autoPtr

Reimplemented from original::printable.

Reimplemented in original::ownerPtr< TYPE, DELETER >, original::refCntPtr< TYPE, DERIVED, DELETER >, original::refCntPtr< TYPE, strongPtr< TYPE, DELETER >, DELETER >, original::refCntPtr< TYPE, weakPtr< TYPE, DELETER >, DELETER >, original::strongPtr< TYPE, DELETER >, original::strongPtr< original::filter< TYPE > >, and original::weakPtr< TYPE, DELETER >.

◆ compareTo()

template<typename TYPE, typename DERIVED, typename DELETER>

original::integer original::autoPtr< TYPE, DERIVED, DELETER >::compareTo ( const autoPtr< TYPE, DERIVED, DELETER > & other ) const

override

Compare reference counters.

Parameters

other autoPtr to compare with

Returns: Difference between refcount addresses

◆ destroyRefCnt()

template<typename TYPE, typename DERIVED, typename DELETER>

void original::autoPtr< TYPE, DERIVED, DELETER >::destroyRefCnt ( )

protectednoexcept

Destroy reference counter.

Note: Only destroys counter when both ref counts reach zero

◆ exist()

template<typename TYPE, typename DERIVED, typename DELETER>

bool original::autoPtr< TYPE, DERIVED, DELETER >::exist ( ) const

Check active ownership.

Returns: True if it has active references

◆ expired()

template<typename TYPE, typename DERIVED, typename DELETER>

bool original::autoPtr< TYPE, DERIVED, DELETER >::expired ( ) const

Check resource validity.

Returns: True if strong references == 0

◆ get() [1/2]

template<typename TYPE, typename DERIVED, typename DELETER>

TYPE * original::autoPtr< TYPE, DERIVED, DELETER >::get ( )

Get managed pointer.

Returns: Raw pointer to managed object

Exceptions

nullPointerError if no active references

◆ get() [2/2]

template<typename TYPE, typename DERIVED, typename DELETER>

const TYPE * original::autoPtr< TYPE, DERIVED, DELETER >::get ( ) const

Get managed pointer const version.

Returns: Raw pointer to managed object

Exceptions

nullPointerError if no active references

◆ newRefCount()

template<typename TYPE, typename DERIVED, typename DELETER>

original::refCount< TYPE, DELETER > * original::autoPtr< TYPE, DERIVED, DELETER >::newRefCount ( TYPE * p = nullptr )

staticprotected

Create new reference counter.

Parameters

p	Pointer to manage (nullptr allowed)

Returns: Newly created counter object

◆ operator bool()

template<typename TYPE, typename DERIVED, typename DELETER>

original::autoPtr< TYPE, DERIVED, DELETER >::operator bool ( ) const

explicit

Boolean conversion operator.

Returns: Equivalent to a non null managed pointer

◆ operator*() [1/2]

template<typename TYPE, typename DERIVED, typename DELETER>

TYPE & original::autoPtr< TYPE, DERIVED, DELETER >::operator* ( )

virtual

Mutable dereference operator.

Returns: Reference to managed object

Exceptions

nullPointerError if no managed object

Reimplemented in original::weakPtr< TYPE, DELETER >.

◆ operator*() [2/2]

template<typename TYPE, typename DERIVED, typename DELETER>

const TYPE & original::autoPtr< TYPE, DERIVED, DELETER >::operator* ( ) const

virtual

Const dereference operator.

Returns: Reference to managed object

Exceptions

nullPointerError if no managed object

Reimplemented in original::weakPtr< TYPE, DELETER >.

◆ operator->() [1/2]

template<typename TYPE, typename DERIVED, typename DELETER>

TYPE * original::autoPtr< TYPE, DERIVED, DELETER >::operator-> ( )

virtual

Mutable member access operator.

Returns: Pointer to managed object

Exceptions

nullPointerError if no managed object

Reimplemented in original::weakPtr< TYPE, DELETER >.

◆ operator->() [2/2]

template<typename TYPE, typename DERIVED, typename DELETER>

const TYPE * original::autoPtr< TYPE, DERIVED, DELETER >::operator-> ( ) const

virtual

Const member access operator.

Returns: Pointer to managed object

Exceptions

nullPointerError if no managed object

Reimplemented in original::weakPtr< TYPE, DELETER >.

◆ operator[]() [1/2]

template<typename TYPE, typename DERIVED, typename DELETER>

TYPE & original::autoPtr< TYPE, DERIVED, DELETER >::operator[] ( u_integer index )

virtual

Mutable array access operator.

Parameters

index Array index

Returns: Reference to element

Exceptions

nullPointerError if no managed array

Reimplemented in original::weakPtr< TYPE, DELETER >.

◆ operator[]() [2/2]

template<typename TYPE, typename DERIVED, typename DELETER>

const TYPE & original::autoPtr< TYPE, DERIVED, DELETER >::operator[] ( u_integer index ) const

virtual

Const array access operator.

Parameters

index Array index

Returns: Reference to element

Exceptions

nullPointerError if no managed array

Reimplemented in original::weakPtr< TYPE, DELETER >.

◆ setPtr()

template<typename TYPE, typename DERIVED, typename DELETER>

void original::autoPtr< TYPE, DERIVED, DELETER >::setPtr ( TYPE * p )

protected

Replace managed pointer.

Parameters

p	New pointer to manage

Exceptions

nullPointerError if no active references

◆ strongRefs()

template<typename TYPE, typename DERIVED, typename DELETER>

original::u_integer original::autoPtr< TYPE, DERIVED, DELETER >::strongRefs ( ) const

Get strong reference count.

Returns: Current number of strong references

◆ swap()

template<typename TYPE, typename DERIVED, typename DELETER>

void original::autoPtr< TYPE, DERIVED, DELETER >::swap ( autoPtr< TYPE, DERIVED, DELETER > & other )

noexcept

Swaps the reference counters between two autoPtr instances.

Parameters

other Another autoPtr instance to swap with

Postcondition

After swapping:

Current object acquires other's reference counter
Other object acquires current object's reference counter
Managed object ownership transfers implicitly

◆ toString()

template<typename TYPE, typename DERIVED, typename DELETER>

std::string original::autoPtr< TYPE, DERIVED, DELETER >::toString ( bool enter ) const

overridevirtual

String representation formatter.

Parameters

enter Add newline if true

Returns: Formatted resource info

Reimplemented from original::printable.

Reimplemented in original::refCntPtr< TYPE, DERIVED, DELETER >, original::refCntPtr< TYPE, strongPtr< TYPE, DELETER >, DELETER >, and original::refCntPtr< TYPE, weakPtr< TYPE, DELETER >, DELETER >.

◆ weakRefs()

template<typename TYPE, typename DERIVED, typename DELETER>

original::u_integer original::autoPtr< TYPE, DERIVED, DELETER >::weakRefs ( ) const

Get weak reference count.

Returns: Current number of weak references

Friends And Related Symbol Documentation

◆ operator!= [1/2]

template<typename TYPE, typename DERIVED, typename DELETER>

template<typename T, typename DER, typename DEL>

bool operator!=	(	const autoPtr< T, DER, DEL > &	ptr,
		const std::nullptr_t &	null )

friend

Inequality comparison with nullptr.

Template Parameters

T	Managed object type
DER	CRTP derived class type
DEL	Deleter policy type

Parameters

ptr	autoPtr to compare
null	nullptr_t to compare against

Returns: true if the autoPtr is not empty (has a managed object)

Note: Equivalent to checking operator bool() of ptr

◆ operator!= [2/2]

template<typename TYPE, typename DERIVED, typename DELETER>

template<typename T, typename DER, typename DEL>

bool operator!=	(	const std::nullptr_t &	null,
		const autoPtr< T, DER, DEL > &	ptr )

friend

Inequality comparison with nullptr (reversed operands)

Template Parameters

T	Managed object type
DER	CRTP derived class type
DEL	Deleter policy type

Parameters

ptr	autoPtr to compare
null	nullptr_t to compare against

Returns: true if the autoPtr is not empty (has a managed object)

Note: Equivalent to checking operator bool() of ptr

◆ operator== [1/2]

template<typename TYPE, typename DERIVED, typename DELETER>

template<typename T, typename DER, typename DEL>

bool operator==	(	const autoPtr< T, DER, DEL > &	ptr,
		const std::nullptr_t &	null )

friend

Equality comparison with nullptr.

Template Parameters

T	Managed object type
DER	CRTP derived class type
DEL	Deleter policy type

Parameters

ptr	autoPtr to compare
null	nullptr_t to compare against

Returns: true if the autoPtr is empty (no managed object)

Note: Equivalent to checking !operator bool() of ptr

◆ operator== [2/2]

template<typename TYPE, typename DERIVED, typename DELETER>

template<typename T, typename DER, typename DEL>

bool operator==	(	const std::nullptr_t &	null,
		const autoPtr< T, DER, DEL > &	ptr )

friend

Equality comparison with nullptr (reversed operands)

Template Parameters

T	Managed object type
DER	CRTP derived class type
DEL	Deleter policy type

Parameters

ptr	autoPtr to compare
null	nullptr_t to compare against

Returns: true if the autoPtr is empty (no managed object)

Note: Equivalent to checking !operator bool() of ptr

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

src/core/autoPtr.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ autoPtr()

Member Function Documentation

◆ className()

◆ compareTo()

◆ destroyRefCnt()

◆ exist()

◆ expired()

◆ get() [1/2]

◆ get() [2/2]

◆ newRefCount()

◆ operator bool()

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ setPtr()

◆ strongRefs()

◆ swap()

◆ toString()

◆ weakRefs()

Friends And Related Symbol Documentation

◆ operator!= [1/2]

◆ operator!= [2/2]

◆ operator== [1/2]

◆ operator== [2/2]