ANTLR3_VECTOR_FACTORY_struct Struct Reference

#include <antlr3collections.h>

Collaboration diagram for ANTLR3_VECTOR_FACTORY_struct:

Detailed Description

Structure that tracks vectors in a vector and auto deletes the vectors in the vector factory when closed.


Data Fields
void(*	close )(struct ANTLR3_VECTOR_FACTORY_struct *factory)
	Function to close the vector factory.
pANTLR3_STACK	freeStack
	Consumers from the factory can release a factory produced vector back to the factory so that it may be reused (and thus conserve memory) by another caller.
pANTLR3_VECTOR(*	newVector )(struct ANTLR3_VECTOR_FACTORY_struct *factory)
	Function to supply a new vector.
ANTLR3_UINT32	nextVector
	The next vector available in the pool.
pANTLR3_VECTOR *	pools
	List of all vector pools allocated so far.
void(*	returnVector )(struct ANTLR3_VECTOR_FACTORY_struct *factory, pANTLR3_VECTOR vector)
	Function to return a vector to the factory for reuse.
ANTLR3_INT32	thisPool
	Count of the vector pools allocated so far (current active pool).
ANTLR3_VECTOR	unTruc
	Trick to quickly initialize a new vector via memcpy and not a function call.

Field Documentation

void(* ANTLR3_VECTOR_FACTORY_struct::close)(struct ANTLR3_VECTOR_FACTORY_struct *factory)

Function to close the vector factory.

Referenced by antlr3VectorFactoryNew(), and factoryClose().

pANTLR3_STACK ANTLR3_VECTOR_FACTORY_struct::freeStack

Consumers from the factory can release a factory produced vector back to the factory so that it may be reused (and thus conserve memory) by another caller.

The available vectors are stored here. Note that the only vectors avaible in the free chain are produced by this factory, so they need not be explicitly freed when the factory is closed.

Referenced by antlr3VectorFactoryNew(), closeVectorFactory(), newVector(), and returnVector().