Proto: Proto::Stack< MEM > Class Template Reference

Proto 3.2

#include <Proto_Stack.H>

Public Member Functions
	Stack (size_t a_capacity)
	Constructor. More...

	~Stack ()
	Destructor. More...

void *	alloc (size_t a_sz)
	Public Allocate. More...

void	toggleStack (bool a_flag)
	Toggle Stack. More...

bool	enabled ()
	Query Stack Active. More...

size_t	unused ()
	Query Unused. More...

size_t	used ()
	Query Unused. More...

Static Public Member Functions
static Stack< MEM > &	getStack ()
	Get Stack Singleton. More...

Private Member Functions
void *	doAlloc (size_t a_increment)
	Private Allocate. More...

void	freeStack ()
	Free Stack. More...

Private Attributes
bool	m_useStack

char *	m_stack

char *	m_top

size_t	m_capacity

std::stack< size_t >	m_increments

int	m_bufferIndex

bool	m_hasOverflow

std::shared_ptr< Stack< MEM > >	m_overflow

Constructor & Destructor Documentation

◆ Stack()

template<MemType MEM = MEMTYPE_DEFAULT>

Proto::Stack< MEM >::Stack ( size_t a_capacity )

inline

Constructor.

References Proto::Stack< MEM >::m_capacity, Proto::Stack< MEM >::m_hasOverflow, Proto::Stack< MEM >::m_stack, Proto::Stack< MEM >::m_top, Proto::Stack< MEM >::m_useStack, and protoMalloc.

◆ ~Stack()

template<MemType MEM = MEMTYPE_DEFAULT>

Proto::Stack< MEM >::~Stack ( )

inline

Destructor.

References Proto::Stack< MEM >::m_stack, and protoFree.

Member Function Documentation

◆ getStack()

template<MemType MEM = MEMTYPE_DEFAULT>

static Stack<MEM>& Proto::Stack< MEM >::getStack ( )

inlinestatic

Get Stack Singleton.

References PR_STACK_ALLOC.

◆ alloc()

template<MemType MEM = MEMTYPE_DEFAULT>

void* Proto::Stack< MEM >::alloc ( size_t a_sz )

inline

Public Allocate.

References Proto::Stack< MEM >::doAlloc(), Proto::Stack< MEM >::m_useStack, and PROTO_ASSERT.

◆ toggleStack()

template<MemType MEM = MEMTYPE_DEFAULT>

void Proto::Stack< MEM >::toggleStack ( bool a_flag )

inline

Toggle Stack.

References Proto::Stack< MEM >::freeStack(), Proto::Stack< MEM >::m_useStack, and PROTO_ASSERT.

◆ enabled()

template<MemType MEM = MEMTYPE_DEFAULT>

bool Proto::Stack< MEM >::enabled ( )

inline

Query Stack Active.

References Proto::Stack< MEM >::m_useStack.

◆ unused()

template<MemType MEM = MEMTYPE_DEFAULT>

size_t Proto::Stack< MEM >::unused ( )

inline

Query Unused.

References Proto::Stack< MEM >::m_capacity, Proto::Stack< MEM >::m_hasOverflow, Proto::Stack< MEM >::m_overflow, Proto::Stack< MEM >::m_stack, and Proto::Stack< MEM >::m_top.

◆ used()

template<MemType MEM = MEMTYPE_DEFAULT>

size_t Proto::Stack< MEM >::used ( )

inline

Query Unused.

References Proto::Stack< MEM >::m_hasOverflow, Proto::Stack< MEM >::m_overflow, Proto::Stack< MEM >::m_stack, and Proto::Stack< MEM >::m_top.

◆ doAlloc()

template<MemType MEM = MEMTYPE_DEFAULT>

void* Proto::Stack< MEM >::doAlloc ( size_t a_increment )

inlineprivate

Private Allocate.

References Proto::Stack< MEM >::m_capacity, Proto::Stack< MEM >::m_hasOverflow, Proto::Stack< MEM >::m_increments, Proto::Stack< MEM >::m_overflow, Proto::Stack< MEM >::m_stack, Proto::Stack< MEM >::m_top, and PR_STACK_OVERFLOW.

Referenced by Proto::Stack< MEM >::alloc().

◆ freeStack()

template<MemType MEM = MEMTYPE_DEFAULT>

void Proto::Stack< MEM >::freeStack ( )

inlineprivate

Free Stack.

References Proto::Stack< MEM >::m_hasOverflow, Proto::Stack< MEM >::m_increments, Proto::Stack< MEM >::m_overflow, Proto::Stack< MEM >::m_stack, and Proto::Stack< MEM >::m_top.

Referenced by Proto::Stack< MEM >::toggleStack().

Member Data Documentation

◆ m_useStack

template<MemType MEM = MEMTYPE_DEFAULT>

bool Proto::Stack< MEM >::m_useStack

private

Referenced by Proto::Stack< MEM >::alloc(), Proto::Stack< MEM >::enabled(), Proto::Stack< MEM >::Stack(), and Proto::Stack< MEM >::toggleStack().

◆ m_stack

template<MemType MEM = MEMTYPE_DEFAULT>

char* Proto::Stack< MEM >::m_stack

private

Referenced by Proto::Stack< MEM >::doAlloc(), Proto::Stack< MEM >::freeStack(), Proto::Stack< MEM >::Stack(), Proto::Stack< MEM >::unused(), Proto::Stack< MEM >::used(), and Proto::Stack< MEM >::~Stack().

◆ m_top

template<MemType MEM = MEMTYPE_DEFAULT>

char* Proto::Stack< MEM >::m_top

private

Referenced by Proto::Stack< MEM >::doAlloc(), Proto::Stack< MEM >::freeStack(), Proto::Stack< MEM >::Stack(), Proto::Stack< MEM >::unused(), and Proto::Stack< MEM >::used().

◆ m_capacity

template<MemType MEM = MEMTYPE_DEFAULT>

size_t Proto::Stack< MEM >::m_capacity

private

Referenced by Proto::Stack< MEM >::doAlloc(), Proto::Stack< MEM >::Stack(), and Proto::Stack< MEM >::unused().

◆ m_increments

template<MemType MEM = MEMTYPE_DEFAULT>

std::stack<size_t> Proto::Stack< MEM >::m_increments

private

Referenced by Proto::Stack< MEM >::doAlloc(), and Proto::Stack< MEM >::freeStack().

◆ m_bufferIndex

template<MemType MEM = MEMTYPE_DEFAULT>

int Proto::Stack< MEM >::m_bufferIndex

private

◆ m_hasOverflow

template<MemType MEM = MEMTYPE_DEFAULT>

bool Proto::Stack< MEM >::m_hasOverflow

private

Referenced by Proto::Stack< MEM >::doAlloc(), Proto::Stack< MEM >::freeStack(), Proto::Stack< MEM >::Stack(), Proto::Stack< MEM >::unused(), and Proto::Stack< MEM >::used().

◆ m_overflow

template<MemType MEM = MEMTYPE_DEFAULT>

std::shared_ptr<Stack<MEM> > Proto::Stack< MEM >::m_overflow

private

Referenced by Proto::Stack< MEM >::doAlloc(), Proto::Stack< MEM >::freeStack(), Proto::Stack< MEM >::unused(), and Proto::Stack< MEM >::used().

The documentation for this class was generated from the following file:

Proto_Stack.H