ANTLR3_VECTOR_FACTORY_struct man page

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

Synopsis

#include <antlr3collections.h>

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.

Detailed Description

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

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().

pANTLR3_VECTOR(* ANTLR3_VECTOR_FACTORY_struct::newVector) (struct ANTLR3_VECTOR_FACTORY_struct *factory)

Function to supply a new vector.

Referenced by add(), and antlr3VectorFactoryNew().

ANTLR3_UINT32 ANTLR3_VECTOR_FACTORY_struct::nextVector

The next vector available in the pool.

Referenced by closeVectorFactory(), newPool(), and newVector().

pANTLR3_VECTOR* ANTLR3_VECTOR_FACTORY_struct::pools

List of all vector pools allocated so far.

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

void(* ANTLR3_VECTOR_FACTORY_struct::returnVector) (struct ANTLR3_VECTOR_FACTORY_struct *factory, pANTLR3_VECTOR vector)

Function to return a vector to the factory for reuse.

Referenced by antlr3VectorFactoryNew(), freeNodeRS(), and freeRS().

ANTLR3_INT32 ANTLR3_VECTOR_FACTORY_struct::thisPool

Count of the vector pools allocated so far (current active pool)

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

ANTLR3_VECTOR ANTLR3_VECTOR_FACTORY_struct::unTruc

Trick to quickly initialize a new vector via memcpy and not a function call.

Referenced by antlr3VectorFactoryNew().

Author

Generated automatically by Doxygen for ANTLR3C from the source code.

Referenced By

antlr3-freeStack(3) and antlr3-nextVector(3) are aliases of ANTLR3_VECTOR_FACTORY_struct(3).

Tue Oct 4 2016 Version 3.3.1 ANTLR3C