Guarded pointers

Object to guard against direct copying of pointers. More...

Data Structures
struct	cstl_guarded_ptr
	Structure to hold a pointer and guard against its direct copying. More...

Macros
#define	CSTL_GUARDED_PTR_INITIALIZER(NAME)
	Initialize (at compile-time) a guarded pointer object.
#define	DECLARE_CSTL_GUARDED_PTR(NAME)
	Declare and initialize a guarded pointer.

Functions
static void	cstl_guarded_ptr_set (struct cstl_guarded_ptr *const gp, void *const ptr)
	Initialize a guarded pointer object to a specific pointer value.
static void	cstl_guarded_ptr_init (struct cstl_guarded_ptr *const gp)
	Initialize a guarded pointer object to NULL.
static const void *	cstl_guarded_ptr_get_const (const struct cstl_guarded_ptr *const gp)
	Retrieve the stored pointer value.
static void *	cstl_guarded_ptr_get (struct cstl_guarded_ptr *const gp)
	Retrieve the stored pointer value.
static void	cstl_guarded_ptr_copy (struct cstl_guarded_ptr *const dst, const struct cstl_guarded_ptr *const src)
	Copy the cstl_guarded_ptr object to a new location.
static void	cstl_guarded_ptr_swap (struct cstl_guarded_ptr *const a, struct cstl_guarded_ptr *const b)
	Swap the pointers pointed to by the objects.

Detailed Description

Object to guard against direct copying of pointers.

The smart pointer objects are defined in the header, and so the programmer may directly copy those data structures via the = operator. The cstl_guarded_ptr objects attempts to catch such uses, since the other smart pointers depend on the non-direct copyability of their structures.

Macro Definition Documentation

CSTL_GUARDED_PTR_INITIALIZER

#define CSTL_GUARDED_PTR_INITIALIZER

(

NAME

)

Value:

    {                                           \
        .ptr = NULL,                            \
        .self = &NAME,                          \
    }

Initialize (at compile-time) a guarded pointer object.

Parameters

[in]

NAME

The name of the object being initialized

Definition at line 74 of file memory.h.

DECLARE_CSTL_GUARDED_PTR

#define DECLARE_CSTL_GUARDED_PTR

(

NAME

)

Value:

    struct cstl_guarded_ptr NAME =              \
        CSTL_GUARDED_PTR_INITIALIZER(NAME)

Declare and initialize a guarded pointer.

Parameters

[in]

NAME

The name of the object being declared

Definition at line 84 of file memory.h.

Function Documentation

cstl_guarded_ptr_copy()

static void cstl_guarded_ptr_copy ( struct cstl_guarded_ptr *const  dst, const struct cstl_guarded_ptr *const  src  )

inlinestatic

Copy the cstl_guarded_ptr object to a new location.

The destination object is overwritten/(re)initialized, regardless of its current state. If the source object has previously been copied via the = operator, this function will cause an abort().

Parameters

[out]	dst	A pointer to the object to receive the copy
[in]	src	A pointer to the object to be copied

Definition at line 163 of file memory.h.

cstl_guarded_ptr_get()

static void * cstl_guarded_ptr_get ( struct cstl_guarded_ptr *const  gp )

inlinestatic

Retrieve the stored pointer value.

If the object has been copied via the = operator, the attempt to retrieve this function will cause an abort().

Parameters

[in]

gp

A pointer to the guarded pointer object

Returns

The value of the pointer being guarded

Definition at line 148 of file memory.h.

cstl_guarded_ptr_get_const()

static const void * cstl_guarded_ptr_get_const ( const struct cstl_guarded_ptr *const  gp )

inlinestatic

Retrieve the stored pointer value.

If the object has been copied via the = operator, the attempt to retrieve this function will cause an abort().

Parameters

[in]

gp

A pointer to the guarded pointer object

Returns

The value of the pointer being guarded

Definition at line 138 of file memory.h.

cstl_guarded_ptr_init()

static void cstl_guarded_ptr_init ( struct cstl_guarded_ptr *const  gp )

inlinestatic

Initialize a guarded pointer object to NULL.

Parameters

[out]

gp

The guarded pointer to initialize

Definition at line 123 of file memory.h.

cstl_guarded_ptr_set()

static void cstl_guarded_ptr_set ( struct cstl_guarded_ptr *const  gp, void *const  ptr  )

inlinestatic

Initialize a guarded pointer object to a specific pointer value.

Parameters

[out]	gp	The guarded pointer to initialize
[in]	ptr	The pointer to store within the object

The guarded pointer is (re)initialized regardless of its current state

Definition at line 110 of file memory.h.

cstl_guarded_ptr_swap()

static void cstl_guarded_ptr_swap ( struct cstl_guarded_ptr *const  a, struct cstl_guarded_ptr *const  b  )

inlinestatic

Swap the pointers pointed to by the objects.

Parameters

[in,out]	a	A pointer to a guarded pointer
[in,out]	b	A pointer to a(nother) guarded pointer

Definition at line 176 of file memory.h.