AnsiConoleEngine Class Reference

ANSI console controller. More...

#include <aengine.h>

Collaboration diagram for AnsiConoleEngine:

Public Member Functions
	AnsiConoleEngine (const char *prompt, CharValidator *validator)
	~AnsiConoleEngine ()
void	StartInput ()
bool	InputDone () const
const char *	GetLine () const
void	SetPrompt (const char *string)
const char *	ProcessChar (const unsigned char character)
void	Enable ()
void	Disable ()

Private Member Functions
void	CopyLine ()
void	ShowLast ()
void	ShowNext ()

Private Attributes
char *	prompt
bool	enabled
char **	lines
CharBuffer *	linebuf
CharValidator *	validator
unsigned int	len
char *	cursor
char *	endpos
int	curline
int	showline
bool	lineswap
char *	editline
bool	escmode
bool	csimode
bool	delmode
bool	linedone
CharBuffer *	out

Static Private Attributes
static const int	maxLines = 100
static const int	lineSize = 1024

Detailed Description

ANSI console controller.

More info on the ANSI console is available at Wikipedia: https://wikipedia.org/wiki/ANSI_escape_code

Definition at line 47 of file aengine.h.

Constructor & Destructor Documentation

AnsiConoleEngine()

AnsiConoleEngine::AnsiConoleEngine	(	const char *	prompt,
		CharValidator *	validator
	)

Definition at line 44 of file aengine.cpp.

References AllocAndCopy(), CharBuffer::CharBuffer(), curline, editline, enabled, linebuf, lines, maxLines, out, prompt, and validator.

{
    this->validator = validator;
    AllocAndCopy(&this->prompt, prompt);
    linebuf = new CharBuffer();
    out = new CharBuffer();

    lines = new char*[maxLines];

    for (int i = 0; i < maxLines; i++)
    {
        lines[i] = nullptr;
    }

    editline = nullptr;
    curline = -1;
    enabled = true;
}

Here is the call graph for this function:

~AnsiConoleEngine()

AnsiConoleEngine::~AnsiConoleEngine

(

)

Definition at line 63 of file aengine.cpp.

References linebuf, lines, maxLines, out, and prompt.

{
    for (int i = 0; i < maxLines; i++)
    {
        if (lines[i] != nullptr)
        {
            delete [] lines[i];
        }
    }

    delete [] lines;
    delete linebuf;
    delete out;
    delete prompt;
}

Member Function Documentation

CopyLine()

void AnsiConoleEngine::CopyLine ( )

private

Definition at line 268 of file aengine.cpp.

References AllocAndCopy(), curline, editline, CharBuffer::GetString(), linebuf, lines, and maxLines.

Referenced by ProcessChar().

{
    curline++;

    if (curline == maxLines)
    {
        curline--;

        delete [] lines[0];
        for (int i = 0; i < maxLines - 1; i++)
        {
            lines[i] = lines[i + 1];
        }
    }

    AllocAndCopy(&(lines[curline]), linebuf->GetString());

    if (editline != nullptr)
    {
        delete [] editline;
        editline = nullptr;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Disable()

void AnsiConoleEngine::Disable

(

)

Definition at line 84 of file aengine.cpp.

References enabled.

{
    enabled = false;
}

Enable()

void AnsiConoleEngine::Enable

(

)

Definition at line 79 of file aengine.cpp.

References enabled.

{
    enabled = true;
}

GetLine()

const char * AnsiConoleEngine::GetLine

(

)

const

Definition at line 385 of file aengine.cpp.

References CharBuffer::GetString(), and linebuf.

{
    return linebuf->GetString();
}

Here is the call graph for this function:

InputDone()

bool AnsiConoleEngine::InputDone

(

)

const

Definition at line 380 of file aengine.cpp.

References linedone.

{
    return linedone;
}

ProcessChar()

const char * AnsiConoleEngine::ProcessChar

(

const unsigned char

character

)

Definition at line 104 of file aengine.cpp.

References CharBuffer::Append(), CharBuffer::buf, CopyLine(), csimode, cursor, delmode, CharBuffer::Empty(), enabled, endpos, CharBuffer::EnsureGrowth(), escmode, CharBuffer::GetString(), len, linebuf, linedone, lineSize, out, CharBuffer::ptr, ShowLast(), ShowNext(), CharValidator::Validate(), and validator.

{
    unsigned char ch = character;
    out->Empty();

    if (len == 0)
    {
        out->EnsureGrowth(lineSize);
        len = lineSize;
    }

    bool processed = false;

    if (ch == 0)
    {
        processed = true;
    }
    else if (ch == 27)
    {
        escmode = true;
        processed = true;
    }
    else if (ch == 155 || (escmode && ch == 79) || (escmode && ch == 91))
    {
        csimode = true;
        processed = true;
    }
    else if (csimode)
    {
        switch (ch)
        {
        case 65: // Arrow up (27 91 65)
            ShowLast();
            break;
        case 66: // Arrow down (27 91 66)
            ShowNext();
            break;
        case 67: // Arrow right (27 91 67)
            if (cursor != endpos)
            {
                cursor++;
                out->Append(CURSORFORWARD);
            }
            break;
        case 68: // Arrow left (27 91 68)
            if (cursor != linebuf->buf)
            {
                cursor--;
                out->Append(CURSORBACKWARD);
            }
            break;
        case 51: // DEL         27 91 51 126
            delmode = true;
        default:
            // F1          27 79 80
            // F2          27 79 81
            break;
        }

        escmode = false;
        csimode = false;
        processed = true;
    }
    else
    {
        escmode = false;
        csimode = false;
    }

    // Delete one character to the right
    if (delmode && ch == 126)
    {
        if (cursor != endpos)
        {
            char* i = cursor;
            do
            {
                *i = *(i + 1);
                i++;
            }
            while (i != endpos);

            len++;
            if (enabled)
            {
                out->Append(DELETE1CHAR);
            }
            else
            {
                out->Append(DELETE1CHARASC);                
            }
            endpos--;
            linebuf->ptr = endpos;
        }

        processed = true;
        delmode = false;
    }

    if (processed)
    {
        return out->GetString();
    }

    if (ch == 13 || ch == 10)
    {
        out->Append(NEWLINE);
        linebuf->ptr = endpos;
        CopyLine();
        linedone = true;
    }
    else if (cursor != linebuf->buf && (ch == 8 || ch == 127))
    {
        // Deleting in middle of line
        if (cursor != endpos)
        {
            char* i = cursor - 1;
            do
            {
                *i = *(i + 1);
                i++;
            }
            while (i != endpos);
        }

        len++;
        if (enabled)
        {
            out->Append(CURSORBACKWARD);
            out->Append(DELETE1CHAR);
        }
        else
        {
            out->Append(DELETE1CHARASC);                
        }
        cursor--;
        endpos--;
        linebuf->ptr = endpos;
    }
    else if (validator->Validate(ch))
    {
        // Insert in middle of line
        if (cursor != endpos)
        {
            char* i = endpos;
            do
            {
                *i = *(i - 1);
                i--;
            }
            while (i != cursor);
            out->Append(INSERT1CHAR);
        }

        len--;
        out->Append(ch);
        *cursor++ = ch;
        endpos++;
        linebuf->ptr = endpos;
    }

    return out->GetString();
}

Here is the call graph for this function:

SetPrompt()

void AnsiConoleEngine::SetPrompt

(

const char *

string

)

Definition at line 390 of file aengine.cpp.

References AllocAndCopy(), and prompt.

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

Here is the call graph for this function:

ShowLast()

void AnsiConoleEngine::ShowLast ( )

private

Definition at line 292 of file aengine.cpp.

References AllocAndCopy(), CharBuffer::Append(), CharBuffer::buf, curline, cursor, editline, CharBuffer::Empty(), endpos, CharBuffer::EnsureSize(), CharBuffer::GetString(), len, linebuf, lines, lineSize, lineswap, out, prompt, showline, and StrLen().

Referenced by ProcessChar().

{
    if (curline == -1)
    {
        return;
    }

    if (!lineswap)
    {
        AllocAndCopy(&editline, linebuf->GetString());
        lineswap = true;
        showline = curline + 1;
    }
    else if (showline == curline + 1)
    {
        delete editline;
        AllocAndCopy(&editline, linebuf->GetString());
    }

    showline--;
    if (showline < 0)
    {
        showline = 0;
    }

    out->Empty();
    out->EnsureSize(
        StrLen(DELETELINE) +
        StrLen(prompt) +
        StrLen(lines[showline]) + 1);

    out->Append(DELETELINE);
    out->Append(prompt);
    out->Append(lines[showline]);

    linebuf->Empty();
    linebuf->EnsureSize(StrLen(lines[showline]));
    linebuf->Append(lines[showline]);

    unsigned int linelen = StrLen(linebuf->GetString());
    cursor = linebuf->buf + linelen;
    endpos = cursor;
    len = lineSize - linelen;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ShowNext()

void AnsiConoleEngine::ShowNext ( )

private

Definition at line 337 of file aengine.cpp.

References CharBuffer::Append(), CharBuffer::buf, curline, cursor, editline, CharBuffer::Empty(), endpos, CharBuffer::EnsureGrowth(), CharBuffer::EnsureSize(), CharBuffer::GetString(), len, linebuf, lines, lineSize, lineswap, out, prompt, showline, and StrLen().

Referenced by ProcessChar().

{
    if (!lineswap)
    {
        return;
    }

    showline++;
    if (showline > curline + 1)
    {
        showline = curline + 1;
        return;
    }

    out->Empty();
    out->Append(DELETELINE);
    out->Append(prompt);

    if (showline > curline)
    {
        out->EnsureGrowth(StrLen(editline) + 1);
        out->Append(editline);

        linebuf->Empty();
        linebuf->EnsureSize(StrLen(editline));
        linebuf->Append(editline);
    }
    else
    {
        out->EnsureGrowth(StrLen(lines[showline]) + 1);
        out->Append(lines[showline]);

        linebuf->Empty();
        linebuf->EnsureSize(StrLen(lines[showline]));
        linebuf->Append(lines[showline]);
    }

    unsigned int linelen = StrLen(linebuf->GetString());
    cursor = linebuf->buf + linelen;
    endpos = cursor;
    len = lineSize - linelen;
}

Here is the call graph for this function:

Here is the caller graph for this function:

StartInput()

void AnsiConoleEngine::StartInput

(

)

Definition at line 89 of file aengine.cpp.

References CharBuffer::buf, CharBuffer::ClearAndAlloc(), csimode, cursor, delmode, endpos, escmode, len, linebuf, linedone, lineSize, and lineswap.

{
    linebuf->ClearAndAlloc(lineSize + 1);
    len = lineSize;
    cursor = linebuf->buf;
    endpos = cursor;
    *endpos = '\0';

    lineswap = false;
    escmode = false;
    csimode = false;
    delmode = false;
    linedone = false;
}

Here is the call graph for this function:

Member Data Documentation

csimode

bool AnsiConoleEngine::csimode

private

Definition at line 84 of file aengine.h.

Referenced by ProcessChar(), and StartInput().

curline

int AnsiConoleEngine::curline

private

Definition at line 78 of file aengine.h.

Referenced by AnsiConoleEngine(), CopyLine(), ShowLast(), and ShowNext().

cursor

char* AnsiConoleEngine::cursor

private

Definition at line 75 of file aengine.h.

Referenced by ProcessChar(), ShowLast(), ShowNext(), and StartInput().

delmode

bool AnsiConoleEngine::delmode

private

Definition at line 85 of file aengine.h.

Referenced by ProcessChar(), and StartInput().

editline

char* AnsiConoleEngine::editline

private

Definition at line 81 of file aengine.h.

Referenced by AnsiConoleEngine(), CopyLine(), ShowLast(), and ShowNext().

enabled

bool AnsiConoleEngine::enabled

private

Definition at line 67 of file aengine.h.

Referenced by AnsiConoleEngine(), Disable(), Enable(), and ProcessChar().

endpos

char* AnsiConoleEngine::endpos

private

Definition at line 76 of file aengine.h.

Referenced by ProcessChar(), ShowLast(), ShowNext(), and StartInput().

escmode

bool AnsiConoleEngine::escmode

private

Definition at line 83 of file aengine.h.

Referenced by ProcessChar(), and StartInput().

len

unsigned int AnsiConoleEngine::len

private

Definition at line 74 of file aengine.h.

Referenced by ProcessChar(), ShowLast(), ShowNext(), and StartInput().

linebuf

CharBuffer* AnsiConoleEngine::linebuf

private

Definition at line 72 of file aengine.h.

Referenced by AnsiConoleEngine(), CopyLine(), GetLine(), ProcessChar(), ShowLast(), ShowNext(), StartInput(), and ~AnsiConoleEngine().

linedone

bool AnsiConoleEngine::linedone

private

Definition at line 86 of file aengine.h.

Referenced by InputDone(), ProcessChar(), and StartInput().

lines

char** AnsiConoleEngine::lines

private

Definition at line 71 of file aengine.h.

Referenced by AnsiConoleEngine(), CopyLine(), ShowLast(), ShowNext(), and ~AnsiConoleEngine().

lineSize

const int AnsiConoleEngine::lineSize = 1024

staticprivate

Definition at line 70 of file aengine.h.

Referenced by ProcessChar(), ShowLast(), ShowNext(), and StartInput().

lineswap

bool AnsiConoleEngine::lineswap

private

Definition at line 80 of file aengine.h.

Referenced by ShowLast(), ShowNext(), and StartInput().

maxLines

const int AnsiConoleEngine::maxLines = 100

staticprivate

Definition at line 69 of file aengine.h.

Referenced by AnsiConoleEngine(), CopyLine(), and ~AnsiConoleEngine().

out

CharBuffer* AnsiConoleEngine::out

private

Definition at line 87 of file aengine.h.

Referenced by AnsiConoleEngine(), ProcessChar(), ShowLast(), ShowNext(), and ~AnsiConoleEngine().

prompt

char* AnsiConoleEngine::prompt

private

Definition at line 66 of file aengine.h.

Referenced by AnsiConoleEngine(), SetPrompt(), ShowLast(), ShowNext(), and ~AnsiConoleEngine().

showline

int AnsiConoleEngine::showline

private

Definition at line 79 of file aengine.h.

Referenced by ShowLast(), and ShowNext().

validator

CharValidator* AnsiConoleEngine::validator

private

Definition at line 73 of file aengine.h.

Referenced by AnsiConoleEngine(), and ProcessChar().

---

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

• src/lib/aengine.h
• src/lib/aengine.cpp