CharBuffer Class Reference

Encapsulate an character array which can be used as a string. More...

#include <charbuf.h>

Public Member Functions
	CharBuffer ()
	Initialize without allocating memory. More...
	CharBuffer (unsigned int size)
	Initialize while allocating specified amount of memory. More...
	~CharBuffer ()
void	ClearBuffer ()
	Release memory in buffer. More...
void	ClearAndCopy (const char *source)
	Release memory, allocate and copy source. More...
void	ClearAndAlloc (unsigned int size)
	Release memory and allocate new size. More...
void	EnsureSize (unsigned int size)
	Ensure a memory block of specified size is allocated. More...
void	EnsureSize (unsigned int blocksize, unsigned int blocks)
void	EnsureMinimumSize ()
void	EnsureGrowth (unsigned int size)
void	Empty ()
bool	IsEmpty () const
bool	Is (const char *string) const
	Compare content of CharBuffer with string) More...
bool	Contains (const char c) const
void	Copy (CharBuffer *buf)
void	Append (const char *source)
void	Append (const char c)
void	Append (const char c, unsigned int count)
void	DeleteLastChar ()
bool	RemoveTrailing (const char c)
bool	RemoveTrailing (const char *string)
char *	GetString () const

Private Attributes
char *	buf
char *	ptr
unsigned int	cursize

Static Private Attributes
static const unsigned int	minimumSize = 64

Friends
class	AnsiConoleEngine

Detailed Description

Encapsulate an character array which can be used as a string.

The CharBuffer class eases the task of allocating a releasing memory.

Definition at line 44 of file charbuf.h.

Constructor & Destructor Documentation

CharBuffer() [1/2]

CharBuffer::CharBuffer

(

)

Initialize without allocating memory.

Definition at line 38 of file charbuf.cpp.

References buf, cursize, and ptr.

Referenced by AnsiConoleEngine::AnsiConoleEngine(), ErrorNode::ErrorNode(), Evaluator::Evaluator(), PromptStatement::Execute(), FunctionList::FunctionList(), StandardProgram::Initialize(), StandardFilesystem::ListDirectory(), StandardFilesystem::LoadTextFile(), NumeralSystem::NumeralSystem(), PreferencesBase::PreferencesBase(), SyntaxNode::SyntaxNode(), UserFunction::UserFunction(), and VariableList::VariableList().

{
    buf = nullptr;
    ptr = buf;
    cursize = 0;
}

Here is the caller graph for this function:

CharBuffer() [2/2]

CharBuffer::CharBuffer ( unsigned int  size )

explicit

Initialize while allocating specified amount of memory.

Definition at line 49 of file charbuf.cpp.

References buf, cursize, minimumSize, and ptr.

Referenced by SaveStatement::Execute(), and PositionalNumeralSystem::GetText().

{
    cursize = (size < minimumSize ? minimumSize : size);
    buf = new char[cursize];
    ptr = buf;
}

Here is the caller graph for this function:

~CharBuffer()

CharBuffer::~CharBuffer

(

)

Definition at line 56 of file charbuf.cpp.

References ClearBuffer().

{
    ClearBuffer();
}

Here is the call graph for this function:

Member Function Documentation

Append() [1/3]

void CharBuffer::Append

(

const char *

source

)

Definition at line 262 of file charbuf.cpp.

References ptr.

Referenced by ErrorNode::ErrorNode(), SaveStatement::Execute(), PlotStatement::Execute(), MemoryStatement::Execute(), EvalStatement::Execute(), InputStatement::Execute(), DigitsStatement::Execute(), OutputStatement::Execute(), DeleteStatement::Execute(), ErrorNode::Execute(), StatementBlockNode::Execute(), PreferencesBase::GetDescription(), PositionalNumeralSystem::GetName(), PositionalNumeralSystem::GetSpecialCase(), DecimalSystem::GetText(), UnaryNode::GetText(), PositionalNumeralSystem::GetText(), FunctionNode::GetText(), AbsoluteNode::GetText(), FactorialNode::GetText(), NumericOperator::GetText(), StandardProgram::Initialize(), UserFunction::InitializeTexts(), FunctionList::ListContent(), VariableList::ListContent(), StandardFilesystem::ListDirectory(), AnsiConoleEngine::ProcessChar(), AnsiConoleEngine::ShowLast(), and AnsiConoleEngine::ShowNext().

{
    // ReSharper disable once CppPossiblyErroneousEmptyStatements
    while ((*ptr++ = *source++));

    ptr--;
}

Here is the caller graph for this function:

Append() [2/3]

void CharBuffer::Append

(

const char

c

)

Definition at line 245 of file charbuf.cpp.

References ptr.

Referenced by PlotStatement::Execute(), PromptStatement::Execute(), ErrorNode::Execute(), PreferencesBase::GetDescription(), DecimalSystem::GetText(), PositionalNumeralSystem::GetText(), StandardProgram::Initialize(), UserFunction::InitializeTexts(), PositionalNumeralSystem::IntegerToBuffer(), FunctionList::ListContent(), VariableList::ListContent(), StandardFilesystem::LoadTextFile(), and AnsiConoleEngine::ProcessChar().

{
    *ptr++ = c;
}

Here is the caller graph for this function:

Append() [3/3]

void CharBuffer::Append	(	const char	c,
		unsigned int	count
	)

Definition at line 250 of file charbuf.cpp.

References ptr.

Referenced by ErrorNode::Execute(), and StandardFilesystem::ListDirectory().

{
    if (count == 0)
    {
        return;
    }

    unsigned int n = count;
    while (n--)
        *ptr++ = c;
}

Here is the caller graph for this function:

ClearAndAlloc()

void CharBuffer::ClearAndAlloc

(

unsigned int

size

)

Release memory and allocate new size.

Definition at line 92 of file charbuf.cpp.

References buf, ClearBuffer(), cursize, minimumSize, and ptr.

Referenced by ErrorNode::Execute(), and AnsiConoleEngine::StartInput().

{
    ClearBuffer();
    cursize = (size < minimumSize ? minimumSize : size);
    buf = new char[cursize];
    ptr = buf;
}

Here is the call graph for this function:

Here is the caller graph for this function:

ClearAndCopy()

void CharBuffer::ClearAndCopy

(

const char *

source

)

Release memory, allocate and copy source.

Definition at line 81 of file charbuf.cpp.

References AllocAndCopy(), buf, ClearBuffer(), cursize, and ptr.

Referenced by Evaluator::Evaluate(), ExecuteStatement::Execute(), PromptStatement::Execute(), HelpStatement::Execute(), and NumericValueNode::GetNodeText().

{
    ClearBuffer();
    cursize = AllocAndCopy(&buf, source);
    ptr = buf + cursize - sizeof(char);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ClearBuffer()

void CharBuffer::ClearBuffer

(

)

Release memory in buffer.

Definition at line 65 of file charbuf.cpp.

References buf, cursize, and ptr.

Referenced by FunctionList::Clear(), VariableList::Clear(), ClearAndAlloc(), ClearAndCopy(), Evaluator::Evaluate(), StatementBlockNode::Execute(), HelpStatement::StatementHelp(), and ~CharBuffer().

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

    buf = nullptr;
    ptr = buf;
    cursize = 0;
}

Here is the caller graph for this function:

Contains()

bool CharBuffer::Contains

(

const char

c

)

const

Definition at line 199 of file charbuf.cpp.

References buf, and ptr.

Referenced by DecimalSystem::GetText().

{
    char* i = buf;

    if (i == nullptr || buf == ptr)
        return false;

    do
    {
        if (*i == c)
            return true;

        i++;
    }
    while (i != ptr);

    return false;
}

Here is the caller graph for this function:

Copy()

void CharBuffer::Copy

(

CharBuffer *

buf

)

Definition at line 233 of file charbuf.cpp.

References buf, cursize, EnsureSize(), GetString(), and ptr.

Referenced by PositionalNumeralSystem::GetText().

{
    EnsureSize(source->cursize);
    const char* s = source->GetString();

    ptr = buf;
    // ReSharper disable once CppPossiblyErroneousEmptyStatements
    while ((*ptr++ = *s++));

    ptr--;
}

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteLastChar()

void CharBuffer::DeleteLastChar

(

)

Definition at line 228 of file charbuf.cpp.

References ptr.

Referenced by StandardProgram::Initialize().

{
    ptr--;
}

Here is the caller graph for this function:

Empty()

void CharBuffer::Empty

(

)

Definition at line 218 of file charbuf.cpp.

References buf, EnsureMinimumSize(), and ptr.

Referenced by SaveStatement::Execute(), PlotStatement::Execute(), MemoryStatement::Execute(), DigitsStatement::Execute(), EvalStatement::Execute(), InputStatement::Execute(), OutputStatement::Execute(), DeleteStatement::Execute(), ErrorNode::Execute(), StatementBlockNode::Execute(), FunctionDefinitionNode::FunctionDefinitionNode(), PreferencesBase::GetDescription(), PositionalNumeralSystem::GetName(), PositionalNumeralSystem::GetSpecialCase(), DecimalSystem::GetText(), UnaryNode::GetText(), PositionalNumeralSystem::GetText(), FunctionNode::GetText(), AbsoluteNode::GetText(), FactorialNode::GetText(), NumericOperator::GetText(), StandardProgram::Initialize(), UserFunction::InitializeTexts(), FunctionList::ListContent(), VariableList::ListContent(), StandardFilesystem::ListDirectory(), StandardFilesystem::LoadTextFile(), NumeralSystem::NumeralSystem(), AnsiConoleEngine::ProcessChar(), AnsiConoleEngine::ShowLast(), and AnsiConoleEngine::ShowNext().

{
    if (buf == nullptr)
    {
        EnsureMinimumSize();
    }

    ptr = buf;
}

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureGrowth()

void CharBuffer::EnsureGrowth

(

unsigned int

size

)

Definition at line 169 of file charbuf.cpp.

References buf, EnsureSize(), and ptr.

Referenced by PlotStatement::Execute(), StatementBlockNode::Execute(), DecimalSystem::GetText(), StandardFilesystem::ListDirectory(), AnsiConoleEngine::ProcessChar(), and AnsiConoleEngine::ShowNext().

{
    EnsureSize((unsigned int)((ptr - buf) + size));
}

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureMinimumSize()

void CharBuffer::EnsureMinimumSize

(

)

Definition at line 100 of file charbuf.cpp.

References buf, minimumSize, and ptr.

Referenced by Empty(), and FunctionDefinitionNode::FunctionDefinitionNode().

{
    if (buf == nullptr)
    {
        unsigned int size = minimumSize;
        buf = new char[size];
        ptr = buf;
    }
}

Here is the caller graph for this function:

EnsureSize() [1/2]

void CharBuffer::EnsureSize

(

unsigned int

size

)

Ensure a memory block of specified size is allocated.

Definition at line 114 of file charbuf.cpp.

References buf, cursize, MemCopy(), minimumSize, and ptr.

Referenced by Copy(), EnsureGrowth(), ErrorNode::ErrorNode(), MemoryStatement::Execute(), InputStatement::Execute(), OutputStatement::Execute(), DigitsStatement::Execute(), EvalStatement::Execute(), DeleteStatement::Execute(), PreferencesBase::GetDescription(), PositionalNumeralSystem::GetName(), UnaryNode::GetText(), FunctionNode::GetText(), AbsoluteNode::GetText(), FactorialNode::GetText(), NumericOperator::GetText(), StandardProgram::Initialize(), FunctionList::ListContent(), VariableList::ListContent(), StandardFilesystem::ListDirectory(), AnsiConoleEngine::ShowLast(), and AnsiConoleEngine::ShowNext().

{
    if (cursize < size)
    {
        unsigned int tempsize = cursize;
        cursize = (size < minimumSize ? minimumSize : size);

        if (buf == nullptr)
        { // Nothing allocated yet. Just allocate requested size.
            buf = new char[cursize];
            ptr = buf;
        }
        else if (buf == ptr)
        { // Already allocated but buffer is empty.
            delete [] buf;
            buf = new char[cursize];
            ptr = buf;
        }
        else
        { // Buffer already in use.
            // Make at least double size
            cursize = cursize < tempsize * 2 ? tempsize * 2 : cursize;
            unsigned int offset = (unsigned int)(ptr - buf);
            char* temp = new char[cursize];
            MemCopy(temp, buf, tempsize);
            delete [] buf;
            buf = temp;
            ptr = buf + offset;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

EnsureSize() [2/2]

void CharBuffer::EnsureSize	(	unsigned int	blocksize,
		unsigned int	blocks
	)

Definition at line 146 of file charbuf.cpp.

References buf, cursize, MemCopy(), and ptr.

Referenced by StandardFilesystem::LoadTextFile().

{
    if (cursize < blocksize * blocks)
    {
        if (buf == nullptr)
        {
            cursize = blocksize * blocks;
            buf = new char[cursize];
            ptr = buf;
        }
        else
        {
            unsigned int tptr = (unsigned int)(ptr - buf);
            char* temp = new char[blocksize * blocks];
            MemCopy(temp, buf, cursize);
            delete [] buf;
            cursize = blocksize * blocks;
            buf = temp;
            ptr = buf + tptr;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetString()

char * CharBuffer::GetString

(

)

const

Definition at line 306 of file charbuf.cpp.

References buf, and ptr.

Referenced by Copy(), AnsiConoleEngine::CopyLine(), ErrorNode::ErrorNode(), LoadStatement::Execute(), SaveStatement::Execute(), ShowStatement::Execute(), ExecuteStatement::Execute(), PlotStatement::Execute(), ListStatement::Execute(), MemoryStatement::Execute(), FunctionDefinitionNode::Execute(), DigitsStatement::Execute(), OutputStatement::Execute(), PromptStatement::Execute(), EvalStatement::Execute(), InputStatement::Execute(), DeleteStatement::Execute(), HelpStatement::Execute(), ErrorNode::Execute(), StatementBlockNode::Execute(), UserFunction::GetDefinitionName(), UserFunction::GetDefinitionText(), PreferencesBase::GetDescription(), AnsiConoleEngine::GetLine(), PositionalNumeralSystem::GetName(), NumericValueNode::GetNodeText(), Evaluator::GetResult(), PositionalNumeralSystem::GetSpecialCase(), DecimalSystem::GetText(), FunctionDefinitionNode::GetText(), UnaryNode::GetText(), PositionalNumeralSystem::GetText(), FunctionNode::GetText(), AbsoluteNode::GetText(), FactorialNode::GetText(), NumericOperator::GetText(), UserFunction::InitializeTexts(), Is(), FunctionList::ListContent(), VariableList::ListContent(), StandardFilesystem::ListDirectory(), StandardLanguage::LoadCatalog(), AnsiConoleEngine::ProcessChar(), AnsiConoleEngine::ShowLast(), AnsiConoleEngine::ShowNext(), StandardProgram::Start(), and HelpStatement::StatementHelp().

{
    *ptr = '\0';
    return buf;
}

Here is the caller graph for this function:

Is()

bool CharBuffer::Is

(

const char *

string

)

const

Compare content of CharBuffer with string)

Definition at line 194 of file charbuf.cpp.

References GetString(), and StrIsEqual().

Referenced by PositionalNumeralSystem::GetText().

{
    return StrIsEqual(GetString(), string);
}

Here is the call graph for this function:

Here is the caller graph for this function:

IsEmpty()

bool CharBuffer::IsEmpty

(

)

const

Definition at line 174 of file charbuf.cpp.

References buf, and ptr.

Referenced by StandardProgram::Start().

{
    char* i = buf;

    if (i == nullptr || buf == ptr)
        return true;

    do
    {
        // Blank space characters
        if (*i != ' ' && *i != '\t' && *i != '\r' && *i != '\n')
            return false;

        i++;
    }
    while (i != ptr);

    return true;
}

Here is the caller graph for this function:

RemoveTrailing() [1/2]

bool CharBuffer::RemoveTrailing

(

const char

c

)

Definition at line 270 of file charbuf.cpp.

References buf, and ptr.

Referenced by PromptStatement::Execute(), DecimalSystem::GetText(), and PositionalNumeralSystem::GetText().

{
    if (ptr == buf)
    {
        return false;
    }

    if (*(--ptr) == c)
    {
        return true;
    }

    ptr++;
    return false;
}

Here is the caller graph for this function:

RemoveTrailing() [2/2]

bool CharBuffer::RemoveTrailing

(

const char *

string

)

Definition at line 286 of file charbuf.cpp.

References buf, ptr, StrIsEqual(), and StrLen().

{
    int len = StrLen(string) * sizeof(char);
    char* s = ptr - len;
    if (s < buf)
    {
        return false;
    }

    *ptr = '\0';

    if (StrIsEqual(s, string))
    {
        ptr = s;
        return true;
    }

    return false;
}

Here is the call graph for this function:

Friends And Related Function Documentation

AnsiConoleEngine

friend class AnsiConoleEngine

friend

Definition at line 79 of file charbuf.h.

Member Data Documentation

buf

char* CharBuffer::buf

private

Definition at line 81 of file charbuf.h.

Referenced by CharBuffer(), ClearAndAlloc(), ClearAndCopy(), ClearBuffer(), Contains(), Copy(), Empty(), EnsureGrowth(), EnsureMinimumSize(), EnsureSize(), GetString(), IsEmpty(), AnsiConoleEngine::ProcessChar(), RemoveTrailing(), AnsiConoleEngine::ShowLast(), AnsiConoleEngine::ShowNext(), and AnsiConoleEngine::StartInput().

cursize

unsigned int CharBuffer::cursize

private

Definition at line 83 of file charbuf.h.

Referenced by CharBuffer(), ClearAndAlloc(), ClearAndCopy(), ClearBuffer(), Copy(), and EnsureSize().

minimumSize

const unsigned int CharBuffer::minimumSize = 64

staticprivate

Definition at line 84 of file charbuf.h.

Referenced by CharBuffer(), ClearAndAlloc(), EnsureMinimumSize(), and EnsureSize().

ptr

char* CharBuffer::ptr

private

Definition at line 82 of file charbuf.h.

Referenced by Append(), CharBuffer(), ClearAndAlloc(), ClearAndCopy(), ClearBuffer(), Contains(), Copy(), DeleteLastChar(), Empty(), EnsureGrowth(), EnsureMinimumSize(), EnsureSize(), GetString(), IsEmpty(), AnsiConoleEngine::ProcessChar(), and RemoveTrailing().

---

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

• src/lib/charbuf.h
• src/lib/charbuf.cpp