MAKLogger::DtLgrConsole Class Reference

The console input interface. More...

Inheritance diagram for MAKLogger::DtLgrConsole:

Collaboration diagram for MAKLogger::DtLgrConsole:

Public Member Functions
	DtLgrConsole (DtLogger &)
virtual	~DtLgrConsole ()
virtual void	stop ()
virtual void	run ()
virtual void	setInputHistorySize (int size)
virtual int	inputHistorySize () const

Static Public Member Functions
static void	allocateConsole ()
static void	deallocateConsole ()
static void	shutdown ()

Protected Types
typedef std::list< DtString >	StringList

Protected Member Functions
virtual void	printMessage (const DtString &message)
	Prints a message to the console, and restores current input. More...
virtual void	printFileDoesNotExistMessage (const DtString &filename)
	Prints a file does not exist error message to the console. More...
virtual void	printFileInvalidMessage (const DtString &filename)
	Prints a file invalid error message to the console. More...
virtual void	printInput (const DtString &input)
	Prints a message to the console as input. More...
virtual void	clearInput ()
	Overwrites the message on console and set input to empty string. More...
bool	nonBlockingGetLine (DtString &input, bool &changed)
	Tokenize the input and return an array of words. More...
virtual void	processInput (const DtString &input)
	Process the completed input line. More...
virtual void	addInputToHistory (const DtString &input)
	Called once input is entered. More...
virtual DtString	getPreviousInput ()
	Gets the previous input in history and stores the current index. More...
virtual DtString	getNextInput ()
	Gets the next input in history and stores the current index. More...
void	sendShutdown ()

Static Protected Member Functions
static DtString	dequote (const DtString &input)
	Remove leading and trailing double quotes. More...

Protected Attributes
volatile bool	myRunningFlag
DtString	myCurrentInput
int	myMaxInputHistorySize
StringList	myInputHistory
StringList::iterator	myCurrentHistoryInput
DtLgrFullInterface *	myInterface

Static Protected Attributes
static volatile bool	myHasConsole
static volatile DtLgrConsole *	theConsole

Detailed Description

The console input interface.

Member Typedef Documentation

typedef std::list<DtString> MAKLogger::DtLgrConsole::StringList

protected

Constructor & Destructor Documentation

MAKLogger::DtLgrConsole::DtLgrConsole

(

DtLogger &

)

virtual MAKLogger::DtLgrConsole::~DtLgrConsole ( )

virtual

Member Function Documentation

virtual void MAKLogger::DtLgrConsole::addInputToHistory ( const DtString &  input )

protectedvirtual

Called once input is entered.

Pushes input to end of history and resets the current history index to the end.

static void MAKLogger::DtLgrConsole::allocateConsole ( )

static

Referenced by MAKLogger::DtLgrCmdLine::parseInput().

virtual void MAKLogger::DtLgrConsole::clearInput ( )

protectedvirtual

Overwrites the message on console and set input to empty string.

static void MAKLogger::DtLgrConsole::deallocateConsole ( )

static

static DtString MAKLogger::DtLgrConsole::dequote ( const DtString &  input )

staticprotected

Remove leading and trailing double quotes.

virtual DtString MAKLogger::DtLgrConsole::getNextInput ( )

protectedvirtual

Gets the next input in history and stores the current index.

virtual DtString MAKLogger::DtLgrConsole::getPreviousInput ( )

protectedvirtual

Gets the previous input in history and stores the current index.

virtual int MAKLogger::DtLgrConsole::inputHistorySize ( ) const

virtual

bool MAKLogger::DtLgrConsole::nonBlockingGetLine ( DtString &  input, bool &  changed  )

protected

Tokenize the input and return an array of words.

virtual DtString* tokenize(const DtString& input,int& size_out); Get input appended to the string and return true if it has been terminated.

virtual void MAKLogger::DtLgrConsole::printFileDoesNotExistMessage ( const DtString &  filename )

protectedvirtual

Prints a file does not exist error message to the console.

virtual void MAKLogger::DtLgrConsole::printFileInvalidMessage ( const DtString &  filename )

protectedvirtual

Prints a file invalid error message to the console.

virtual void MAKLogger::DtLgrConsole::printInput ( const DtString &  input )

protectedvirtual

Prints a message to the console as input.

virtual void MAKLogger::DtLgrConsole::printMessage ( const DtString &  message )

protectedvirtual

Prints a message to the console, and restores current input.

virtual void MAKLogger::DtLgrConsole::processInput ( const DtString &  input )

protectedvirtual

Process the completed input line.

virtual void MAKLogger::DtLgrConsole::run ( )

virtual

void MAKLogger::DtLgrConsole::sendShutdown ( )

protected

virtual void MAKLogger::DtLgrConsole::setInputHistorySize ( int  size )

virtual

static void MAKLogger::DtLgrConsole::shutdown ( )

static

virtual void MAKLogger::DtLgrConsole::stop ( )

virtual

Member Data Documentation

StringList::iterator MAKLogger::DtLgrConsole::myCurrentHistoryInput

protected

DtString MAKLogger::DtLgrConsole::myCurrentInput

protected

volatile bool MAKLogger::DtLgrConsole::myHasConsole

staticprotected

StringList MAKLogger::DtLgrConsole::myInputHistory

protected

DtLgrFullInterface* MAKLogger::DtLgrConsole::myInterface

protected

int MAKLogger::DtLgrConsole::myMaxInputHistorySize

protected

volatile bool MAKLogger::DtLgrConsole::myRunningFlag

protected

volatile DtLgrConsole* MAKLogger::DtLgrConsole::theConsole

staticprotected

---

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

• lgrConsole.h