ConsoleBase Class Reference

Abstract base class encapsulating console logic. More...

#include <console.h>

Inheritance diagram for ConsoleBase:

Public Member Functions
	ConsoleBase (const char *prompt)
virtual	~ConsoleBase ()
const char *	GetName ()
virtual bool	Open ()
virtual void	Close ()
virtual void	Start ()=0
virtual void	Exit ()=0
virtual void	Clear ()
virtual void	ShowHelp ()
virtual void	ShowAbout ()
virtual void	ShowLicense ()
virtual void	ShowVersion ()
virtual void	SetPrompt (const char *string)
virtual void	WriteString (const char *string)=0
virtual bool	SetAnsiMode (bool value)
virtual void	ResetConsole ()

Protected Member Functions
virtual void	StartMessage ()
void	Prompt ()
const char *	GetVersionText ()
const char *	GetCompilerText ()

Protected Attributes
char *	prompt
bool	ansiMode

Private Member Functions
void	AnsiItalics ()
void	AnsiBold ()

Detailed Description

Abstract base class encapsulating console logic.

Definition at line 43 of file console.h.

Constructor & Destructor Documentation

ConsoleBase()

ConsoleBase::ConsoleBase ( const char *  prompt )

explicit

Definition at line 75 of file console.cpp.

References AllocAndCopy(), and prompt.

{
    AllocAndCopy(&this->prompt, prompt);
}

Here is the call graph for this function:

~ConsoleBase()

ConsoleBase::~ConsoleBase ( )

virtual

Definition at line 80 of file console.cpp.

References prompt.

{
    delete prompt;
}

Member Function Documentation

AnsiBold()

void ConsoleBase::AnsiBold ( )

private

Definition at line 124 of file console.cpp.

References ansiMode, and WriteString().

Referenced by ShowAbout(), ShowLicense(), and ShowVersion().

{
    if (ansiMode)
    {
        static const char *bold = "\x1B[1m";
        WriteString(bold);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

AnsiItalics()

void ConsoleBase::AnsiItalics ( )

private

Definition at line 133 of file console.cpp.

References ansiMode, and WriteString().

Referenced by ShowLicense().

{
    if (ansiMode)
    {
        static const char *italics = "\x1B[3m";
        WriteString(italics);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void ConsoleBase::Clear ( )

virtual

Definition at line 142 of file console.cpp.

References ansiMode, ResetConsole(), and WriteString().

Referenced by ClearStatement::Execute().

{
    if (ansiMode)
    {
        static const char *clear = "\x1B[1;1H\x1B[J";
        WriteString(clear);
        ResetConsole();
    }
    else
    {
        static const char *msg = "Screen can only be cleared in ANSI mode.";
        WriteString(msg);
        WriteString(NEWLINE);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Close()

void ConsoleBase::Close ( )

virtual

Definition at line 105 of file console.cpp.

Referenced by StandardProgram::~StandardProgram().

{
}

Here is the caller graph for this function:

Exit()

virtual void ConsoleBase::Exit ( )

pure virtual

Implemented in StandardConsole.

Referenced by Program::Exit().

Here is the caller graph for this function:

GetCompilerText()

const char * ConsoleBase::GetCompilerText ( )

protected

Definition at line 95 of file console.cpp.

References compiler.

{
    return compiler;
}

GetName()

const char * ConsoleBase::GetName

(

)

Definition at line 85 of file console.cpp.

{
    return CPROCNAME;
}

GetVersionText()

const char * ConsoleBase::GetVersionText ( )

protected

Definition at line 90 of file console.cpp.

References version.

{
    return version;
}

Open()

bool ConsoleBase::Open ( )

virtual

Definition at line 100 of file console.cpp.

Referenced by StandardProgram::Start().

{
    return true;
}

Here is the caller graph for this function:

Prompt()

void ConsoleBase::Prompt ( )

protected

Definition at line 207 of file console.cpp.

References prompt, ResetConsole(), and WriteString().

{
    ResetConsole();
    WriteString(prompt);
    ResetConsole();
}

Here is the call graph for this function:

ResetConsole()

void ConsoleBase::ResetConsole ( )

virtual

Definition at line 115 of file console.cpp.

References ansiMode, and WriteString().

Referenced by Clear(), Prompt(), ShowAbout(), ShowLicense(), ShowVersion(), StandardProgram::Start(), and StartMessage().

{
    if (ansiMode)
    {
        static const char *normal = "\x1B[0m";
        WriteString(normal);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetAnsiMode()

bool ConsoleBase::SetAnsiMode ( bool  value )

virtual

Reimplemented in StandardConsole.

Definition at line 109 of file console.cpp.

References ansiMode.

Referenced by Program::SetAnsiMode().

{
    ansiMode = value;
    return true;
}

Here is the caller graph for this function:

SetPrompt()

void ConsoleBase::SetPrompt ( const char *  string )

virtual

Reimplemented in StandardConsole.

Definition at line 214 of file console.cpp.

References AllocAndCopy(), and prompt.

Referenced by PrefsStatement::Execute(), and Program::SetPrompt().

{
    delete prompt;
    AllocAndCopy(&prompt, string);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ShowAbout()

void ConsoleBase::ShowAbout ( )

virtual

Definition at line 174 of file console.cpp.

References about, AnsiBold(), compiler, ResetConsole(), version, and WriteString().

Referenced by AboutStatement::Execute().

{
    AnsiBold();
    WriteString(version);
    ResetConsole();
    WriteString(NEWLINE);
    WriteString(compiler);
    ResetConsole();
    WriteString(about);
    ResetConsole();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ShowHelp()

void ConsoleBase::ShowHelp ( )

virtual

Definition at line 158 of file console.cpp.

References help, and WriteString().

Referenced by StandardProgram::Start().

{
    WriteString(help);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ShowLicense()

void ConsoleBase::ShowLicense ( )

virtual

Definition at line 186 of file console.cpp.

References AnsiBold(), AnsiItalics(), copyright, footer, license, ResetConsole(), and WriteString().

Referenced by LicenseStatement::Execute().

{
    WriteString(NEWLINE);
    AnsiBold();
    WriteString(copyright);
    ResetConsole();
    WriteString(NEWLINE);
    WriteString(license);
    AnsiItalics();
    WriteString(footer);
    ResetConsole();
    WriteString(NEWLINE);
    WriteString(NEWLINE);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ShowVersion()

void ConsoleBase::ShowVersion ( )

virtual

Definition at line 163 of file console.cpp.

References AnsiBold(), compiler, ResetConsole(), version, and WriteString().

Referenced by VersionStatement::Execute().

{
    AnsiBold();
    WriteString(version);
    ResetConsole();
    WriteString(NEWLINE);
    WriteString(compiler);
    WriteString(NEWLINE);
    ResetConsole();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Start()

virtual void ConsoleBase::Start ( )

pure virtual

Implemented in StandardConsole.

Referenced by StandardProgram::Start().

Here is the caller graph for this function:

StartMessage()

void ConsoleBase::StartMessage ( )

protectedvirtual

Definition at line 201 of file console.cpp.

References ResetConsole(), and WriteString().

{
    WriteString(INTROMSG);
    ResetConsole();
}

Here is the call graph for this function:

WriteString()

virtual void ConsoleBase::WriteString ( const char *  string )

pure virtual

Implemented in StandardConsole.

Referenced by AnsiBold(), AnsiItalics(), Clear(), Prompt(), ResetConsole(), ShowAbout(), ShowHelp(), ShowLicense(), ShowVersion(), StandardProgram::Start(), and StartMessage().

Here is the caller graph for this function:

Member Data Documentation

ansiMode

bool ConsoleBase::ansiMode

protected

Definition at line 69 of file console.h.

Referenced by AnsiBold(), AnsiItalics(), Clear(), ResetConsole(), and SetAnsiMode().

prompt

char* ConsoleBase::prompt

protected

Definition at line 68 of file console.h.

Referenced by ConsoleBase(), Prompt(), SetPrompt(), and ~ConsoleBase().

---

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

• src/system/console.h
• src/system/console.cpp