AlcFreeStack

Files
file	AlcFreeStack.c
	A general purpose free stack which allows a single pointer to be used to keep a list of data to be free'd.

Functions
void *	AlcFreeStackPush (void *prev, void *data, AlcErrno *dstErr)
	Push's the given pointer onto the free stack on top of the previous free stack pointer. More...
void *	AlcFreeStackPop (void *prev, void **dstData, AlcErrno *dstErr)
	Pop's the top entry from the free stack. Returns a free stack pointer and set's the given destination pointer to the entry's data. The entry's data is NOT free'd. More...
AlcErrno	AlcFreeStackFree (void *stack)
	Free's all entries on the given free stack. More...

Detailed Description

Function Documentation

AlcFreeStackPush()

void* AlcFreeStackPush	(	void *	prev,
		void *	data,
		AlcErrno *	dstErr
	)

Push's the given pointer onto the free stack on top of the previous free stack pointer.

Returns

New free stack pointer or NULL on error.

Parameters

prev	Previous free stack pointer.
data	New pointer to push onto the free stack.
dstErr	Destination error pointer, may be NULL

References ALC_ER_ALLOC, ALC_ER_NONE, AlcMalloc(), _AlcFreeStack::data, and _AlcFreeStack::prev.

Referenced by AlcVectorExtend(), AlcVectorNew(), AlgMatrixLLRExpand(), Wlz3DSectionSegmentObject(), Wlz3DViewStructSetupTransformLuts(), WlzChangeEMAPProperty(), WlzClipObjToBox2D(), WlzDiffDomain(), WlzDynItvAdd(), WlzEffReadObjJpeg(), WlzErosion4(), WlzFromArray1D(), WlzIntersectN(), WlzLBTDomain2DFromIDomain(), WlzLBTDomain3DFromPDomain(), WlzMakeCircleObject(), WlzMakeCuboid(), WlzMakeEMAPProperty(), WlzMakeGreyProperty(), WlzMakeHistogramDomain(), WlzMakeIntervalValues(), WlzMakeLUTValues(), WlzMakeNameProperty(), WlzMakeQuadrilateral(), WlzMakeSimpleProperty(), WlzMakeTextProperty(), WlzNewIDomain(), WlzNewValueTb(), WlzProfileLineIDom(), and WlzUnionN().

AlcFreeStackPop()

void* AlcFreeStackPop	(	void *	prev,
		void **	dstData,
		AlcErrno *	dstErr
	)

Pop's the top entry from the free stack. Returns a free stack pointer and set's the given destination pointer to the entry's data. The entry's data is NOT free'd.

Returns

New free stack pointer or NULL on error.

Parameters

prev	The free stack.
dstData	Destination data pointer, may be NULL.
dstErr	Destination error pointer, may be NULL.

References ALC_ER_NONE, ALC_ER_NULLPTR, AlcFree(), _AlcFreeStack::data, and _AlcFreeStack::prev.

AlcFreeStackFree()

AlcErrno AlcFreeStackFree

(

void *

stack

)

Free's all entries on the given free stack.

Returns

Error code.

Parameters

stack

The stack of pointers to be free'd.

References ALC_ER_NONE, ALC_ER_NULLPTR, AlcFree(), _AlcFreeStack::data, and _AlcFreeStack::prev.

Referenced by AlcVectorFree(), AlgMatrixLLRFree(), WlzFree3DViewStruct(), WlzFreeDomain(), WlzFreeEMAPProperty(), WlzFreeLUTValues(), WlzFreeProperty(), WlzFreePropertyListEntry(), WlzFreeSimpleProperty(), WlzFreeValues(), WlzFreeVoxelValueTb(), and WlzInit3DViewStruct().