GPL_Pointer

gpl

1998 12-05

CLASS

GPL_Pointer - C++ reference-counted pointer

SYNOPSIS

GPL_Pointer is a reference-counted pointer to a class. An instance of GPL_Pointer can be used in place of a native pointer, providing automatic deallocation of memory when the last reference disappears. The use of GPL_Pointer data members in classes in most cases obviates the need for copy constructors and assignment operators.

PARENTS

GPL_Reference

public

CONSTRUCTORS

GPL_Pointer(void)

DESTRUCTOR

~GPL_Pointer(void)

OPERATORS

GPL_Pointer<T> & operator=(T *p)

not

operator T *(void)
Return the address of the pointer or NULL if the pointer is null.

operator const T *(void) const
Return the address of the pointer or NULL if the pointer is null.

T * operator->(void)
Return the address of the pointer or NULL if the pointer is null.

const T * operator->(void) const
Return the address of the pointer or NULL if the pointer is null.

GPL_Boolean IsNull(void) const
Return TRUE if the pointer is null.

T *GetAddress(void)
Return the address of the pointer or NULL if the pointer is null.

const T *GetAddress(void) const
Return the address of the pointer or NULL if the pointer is null.

void ConvertUnsafely(GPL_Reference *r)
Convert the object of a different instantiation of GPL_Pointer, specified by the pointer r, into this object. This very dangerous operation is provided to allow up-casting of pointers to derived types into pointers to the base type.

NOTES

GPL_Pointer may not work for primitive data types (e.g., int, float) depending on the compiler's policy on instantiation of templates.

As class instances, GPL_Pointer object can not be used in unions.

For efficiency purposes, GPL_Pointer instances should be passed by reference.