sub_diversion_stack Class Reference

#include <stack.h>

Public Member Functions
virtual	~sub_diversion_stack ()
	sub_diversion_stack ()
void	push_back (const wstring &s, bool resub)
void	pop_back ()
bool	resub_both () const
wchar_t	getch ()
void	ungetch (wchar_t c)
bool	empty () const
Private Member Functions
	sub_diversion_stack (const sub_diversion_stack &)
sub_diversion_stack &	operator= (const sub_diversion_stack &)
Private Attributes
size_t	top
size_t	max
sub_diversion *	stack

---

Detailed Description

The sub_diversion_stack class is used to represent a push-down stack of substitution diversions.

Definition at line 30 of file stack.h.

---

Constructor & Destructor Documentation

virtual sub_diversion_stack::~sub_diversion_stack

(

)

[virtual]

The destructor.

sub_diversion_stack::sub_diversion_stack

(

)

The default constructor.

sub_diversion_stack::sub_diversion_stack

(

const sub_diversion_stack &

)

[private]

The copy constructor. Do not use.

---

Member Function Documentation

void sub_diversion_stack::push_back	(	const wstring &	s,
		bool	resub
	)

The push_back method is sued to push another string onto the context stack.

Parameters:

	s	The wide string to be pushed onto the diversion stack.
	resub	Whether or nmot to resubstitute tinto the text of this diversion.

void sub_diversion_stack::pop_back

(

)

The pop_back method is used to discard to top element of the stack.

bool sub_diversion_stack::resub_both

(

)

const

The resub moth method is used to determine whether ot not to resubstitute into the text of the diversion on the top of the stack.

wchar_t sub_diversion_stack::getch

(

)

The getch method is used to get the next character from the top-most diversion on the stack.

void sub_diversion_stack::ungetch

(

wchar_t

c

)

The ungetch method is used to return a character to the top-most diversion on the stack.

bool sub_diversion_stack::empty

(

)

const [inline]

The empty method is used to determine whether or not the diversion stack is empty.

Definition at line 83 of file stack.h.

sub_diversion_stack& sub_diversion_stack::operator=

(

const sub_diversion_stack &

)

[private]

The assignment operator. Do not use.

---

Field Documentation

size_t sub_diversion_stack::top [private]

The top instance variable is used to remember the height of the diversion stack.

Definition at line 90 of file stack.h.

size_t sub_diversion_stack::max [private]

The max instance variable is used to remember the allocated size of the array holding the diversion stack.

Definition at line 96 of file stack.h.

sub_diversion* sub_diversion_stack::stack [private]

The stack instance variable is used to remember a pointer to the base of the dynamically allocated array representing the diversioon stack.

Definition at line 103 of file stack.h.

---

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

• libaegis/sub/diversion/stack.h