tConsole Class Reference

#include <tConsole.h>

Inheritance diagram for tConsole:

[legend]

Collaboration diagram for tConsole:

[legend]

List of all members.

Public Member Functions
typedef bool	MessageCallback (const tOutput &message, const tOutput &interpretation, REAL timeout)
typedef bool	IdleCallback ()
virtual	~tConsole ()
tConsole &	Print (tString s)
template<class T>
tConsole &	operator<< (const T &x)
void	CenterDisplay (tString s, REAL timeout=5, REAL r=1, REAL g=1, REAL b=1)
virtual tString	ColorString (REAL r, REAL g, REAL b) const
Static Public Member Functions
static bool	Message (const tOutput &message, const tOutput &interpetation, REAL timeout=-1)
static bool	Idle ()
static void	RegisterMessageCallback (MessageCallback *callback)
static void	RegisterIdleCallback (IdleCallback *callback)
Static Protected Member Functions
static void	RegisterBetterConsole (tConsole *better)
Private Member Functions
virtual tConsole &	DoPrint (const tString &s)
virtual void	DoCenterDisplay (const tString &s, REAL timeout=5, REAL r=1, REAL g=1, REAL b=1)
Static Private Attributes
static tConsole *	s_betterConsole = NULL

---

Detailed Description

Definition at line 69 of file tConsole.h.

---

Constructor & Destructor Documentation

tConsole::~tConsole

(

)

[virtual]

Definition at line 158 of file tConsole.cpp.

References NULL, and s_betterConsole.

                   {
    if (s_betterConsole == this)
        s_betterConsole = NULL;
}

---

Member Function Documentation

typedef bool tConsole::MessageCallback	(	const tOutput &	message,
		const tOutput &	interpretation,
		REAL	timeout
	)

typedef bool tConsole::IdleCallback

(

)

tConsole & tConsole::Print

(

tString

s

)

Definition at line 166 of file tConsole.cpp.

References DoPrint(), FilterLine(), line_, s_betterConsole, and tString::Size().

Referenced by operator<<().

{
    // append to line
    line_ += s;

    // determine if a newline was received
    bool newline = false;
    for ( int i = s.Size()-1; i>=0; --i )
        if ( s(i) == '\n' )
            newline = true;

    if ( newline )
    {
        // filter
        FilterLine( line_ );

        // print
        if (s_betterConsole)
            s_betterConsole->DoPrint( line_ );
        else
            DoPrint( line_ );

        line_ = "";
    }

    return *this;
}

Here is the call graph for this function:

Here is the caller graph for this function:

template<class T>

tConsole& tConsole::operator<<

(

const T &

x

)

[inline]

Definition at line 83 of file tConsole.h.

References Print().

                                                      {
        tColoredString s;
        s << x;
        return Print(s);
    }

Here is the call graph for this function:

void tConsole::CenterDisplay	(	tString	s,
		REAL	timeout = 5,
		REAL	r = 1,
		REAL	g = 1,
		REAL	b = 1
	)

Definition at line 194 of file tConsole.cpp.

References DoCenterDisplay(), FilterLine(), and s_betterConsole.

Referenced by gGame::GameLoop().

{
    FilterLine(s);

    if (s_betterConsole)
        s_betterConsole->DoCenterDisplay(s,timeout,r,g,b);
    else
        DoCenterDisplay(s,timeout,r,g,b);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool tConsole::Message	(	const tOutput &	message,
		const tOutput &	interpetation,
		REAL	timeout = -1
	)			[static]

Definition at line 233 of file tConsole.cpp.

References con, and s_messageCallback.

Referenced by nServerInfo::GetFromMaster(), uMenu::HandleEvent(), main(), se_DeletePasswords(), and sg_NetworkError().

                                                                                         {
    if (s_messageCallback)
        return (*s_messageCallback)(message, interpretation, timeout);
    else
    {
        con << tString(message) << ":\n";
        con << tString(interpretation) << '\n';
        return true;
    }
}

Here is the caller graph for this function:

bool tConsole::Idle

(

)

[static]

Definition at line 250 of file tConsole.cpp.

References s_idleCallback.

                   {
    if (s_idleCallback)
    {
        return (*s_idleCallback)();
    }
    else
    {
        return false;
    }
}

tString tConsole::ColorString	(	REAL	r,
		REAL	g,
		REAL	b
	)			const [virtual]

Reimplemented in rConsole.

Definition at line 219 of file tConsole.cpp.

References ColorString(), and s_betterConsole.

Referenced by ColorString(), and nConfItem< tString >::NetReadVal().

                                                         {
    if (s_betterConsole)
        return s_betterConsole->ColorString(r,g,b);
    else
        return tString("");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void tConsole::RegisterMessageCallback

(

MessageCallback *

callback

)

[static]

Definition at line 228 of file tConsole.cpp.

References s_messageCallback.

Referenced by main().

{
    s_messageCallback = a_callback;
}

Here is the caller graph for this function:

void tConsole::RegisterIdleCallback

(

IdleCallback *

callback

)

[static]

Definition at line 245 of file tConsole.cpp.

References s_idleCallback.

Referenced by main().

{
    s_idleCallback = a_callback;
}

Here is the caller graph for this function:

void tConsole::RegisterBetterConsole

(

tConsole *

better

)

[static, protected]

Definition at line 215 of file tConsole.cpp.

References s_betterConsole.

Referenced by nCon::nCon(), and rConsole::rConsole().

                                                    {
    s_betterConsole = better;
}

Here is the caller graph for this function:

tConsole & tConsole::DoPrint

(

const tString &

s

)

[private, virtual]

Reimplemented in rConsole.

Definition at line 204 of file tConsole.cpp.

Referenced by Print().

                                            {
    std::cout << s;
    std::cout.flush();
    return *this;
}

Here is the caller graph for this function:

void tConsole::DoCenterDisplay	(	const tString &	s,
		REAL	timeout = 5,
		REAL	r = 1,
		REAL	g = 1,
		REAL	b = 1
	)			[private, virtual]

Reimplemented in rConsole.

Definition at line 210 of file tConsole.cpp.

Referenced by CenterDisplay().

                                                                                {
    std::cout << s;
    std::cout.flush();
}

Here is the caller graph for this function:

---

Member Data Documentation

tConsole * tConsole::s_betterConsole = NULL [static, private]

Definition at line 106 of file tConsole.h.

Referenced by CenterDisplay(), ColorString(), Print(), RegisterBetterConsole(), and ~tConsole().

---

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

• src/tools/tConsole.h
• src/tools/tConsole.cpp

---