VariableList Class Reference

A list of user defined variables. More...

#include <values.h>

Collaboration diagram for VariableList:

Public Member Functions
	VariableList ()
	~VariableList ()
void	Clear ()
bool	Delete (const char *name)
Variable *	GetFirstVariable () const
Variable *	GetVariable (const char *name) const
Variable *	CreateVariable (const char *name)
Variable *	InsertTemporaryVariable (Variable *variable)
void	RemoveTemporaryVariable ()
char *	List () const
char *	ListDefinitions () const

Private Member Functions
char *	ListContent (bool cmdFormat) const

Private Attributes
CharBuffer *	buf
Variable *	first

Detailed Description

A list of user defined variables.

Definition at line 49 of file values.h.

Constructor & Destructor Documentation

VariableList()

VariableList::VariableList

(

)

Definition at line 93 of file values.cpp.

References buf, CharBuffer::CharBuffer(), and first.

Referenced by Program::Program().

{
    first = nullptr;
    buf = new CharBuffer();
}

Here is the call graph for this function:

Here is the caller graph for this function:

~VariableList()

VariableList::~VariableList

(

)

Definition at line 99 of file values.cpp.

References buf, and first.

{
    if (first != nullptr)
    {
        delete first;
    }

    delete buf;
}

Member Function Documentation

Clear()

void VariableList::Clear

(

)

Definition at line 109 of file values.cpp.

References buf, CharBuffer::ClearBuffer(), and first.

Referenced by DeleteStatement::Execute().

{
    if (first != nullptr)
    {
        delete first;
        first = nullptr;
    }

    buf->ClearBuffer();
}

Here is the call graph for this function:

Here is the caller graph for this function:

CreateVariable()

Variable * VariableList::CreateVariable

(

const char *

name

)

Definition at line 172 of file values.cpp.

References first, Variable::GetName(), Variable::Next, StrIsEqual(), and Variable::Variable().

Referenced by Parser::ParseIdent().

{
    if (first == nullptr)
    {
        first = new Variable(name);
        return first;
    }

    Variable* current = first;
    Variable* last = nullptr;

    while (current != nullptr)
    {
        if (StrIsEqual(name, current->GetName()))
        {
            return current;
        }

        last = current;
        current = current->Next;
    }

    current = new Variable(name);
    last->Next = current;

    return current;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Delete()

bool VariableList::Delete

(

const char *

name

)

Definition at line 120 of file values.cpp.

References Variable::chainDelete, first, GetVariable(), and Variable::Next.

{
    Variable* var = GetVariable(name);

    if (var == nullptr)
    {
        return false;
    }

    if (var == first)
    {
        first = var->Next;
        var->chainDelete = false;
        delete var;
        return true;
    }

    Variable* current = first->Next;
    Variable* last = first;

    while (current != var)
    {
        current = current->Next;
        last = last->Next;
    }

    last->Next = var->Next;

    // Only delete this variable. Not the whole chain.
    var->chainDelete = false;
    delete var;

    return true;
}

Here is the call graph for this function:

GetFirstVariable()

Variable * VariableList::GetFirstVariable

(

)

const

Definition at line 155 of file values.cpp.

References first.

Referenced by ListContent().

{
    return first;
}

Here is the caller graph for this function:

GetVariable()

Variable * VariableList::GetVariable

(

const char *

name

)

const

Definition at line 160 of file values.cpp.

References first, Variable::GetName(), Variable::Next, and StrIsEqual().

Referenced by Delete(), and Parser::ParseIdent().

{
    Variable* current = first;

    while (current != nullptr && !StrIsEqual(current->GetName(), name))
    {
        current = current->Next;
    }

    return current;
}

Here is the call graph for this function:

Here is the caller graph for this function:

InsertTemporaryVariable()

Variable * VariableList::InsertTemporaryVariable

(

Variable *

variable

)

Definition at line 200 of file values.cpp.

References first, and Variable::Next.

Referenced by Parser::ParseFunctionDef().

{
    // Temporary variables are always inserted at the beginning of the list.
    Variable* oldFirst = first;
    first = variable;
    variable->Next = oldFirst;

    return variable;
}

Here is the caller graph for this function:

List()

char * VariableList::List

(

)

const

Definition at line 218 of file values.cpp.

References ListContent().

Referenced by ListVariablesStatement::Execute().

{
    return ListContent(false);
}

Here is the call graph for this function:

Here is the caller graph for this function:

ListContent()

char * VariableList::ListContent ( bool  cmdFormat ) const

private

Definition at line 228 of file values.cpp.

References CharBuffer::Append(), buf, CharBuffer::Empty(), CharBuffer::EnsureSize(), GetFirstVariable(), Variable::GetName(), CharBuffer::GetString(), NumeralSystem::GetText(), Variable::GetValue(), Variable::Next, Program::Output, and StrLen().

Referenced by List(), and ListDefinitions().

{
    buf->Empty();

    if (GetFirstVariable() == nullptr)
    {
        return static_cast<char*>(cmdFormat ? nullptr : HELPVARSNDEF);
    }

    int len = 0;
    Variable* current = GetFirstVariable();

    while (current != nullptr)
    {
        len += StrLen(current->GetName());
        len += 3;
        len += 32; // Max length of value
        len += cmdFormat ? 2 : 1;
        current = current->Next;
    }

    current = GetFirstVariable();

    buf->EnsureSize(len);

    while (current != nullptr)
    {
        buf->Append(current->GetName());
        buf->Append(" = ");

        Number* num = current->GetValue();
        const char* val = Program->Output->GetText(num);
        buf->Append(val);
        delete num;

        if (cmdFormat)
        {
            buf->Append(';');
        }

        buf->Append(NEWLINE);
        current = current->Next;
    }

    return buf->GetString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

ListDefinitions()

char * VariableList::ListDefinitions

(

)

const

Definition at line 223 of file values.cpp.

References ListContent().

Referenced by SaveStatement::Execute().

{
    return ListContent(true);
}

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveTemporaryVariable()

void VariableList::RemoveTemporaryVariable

(

)

Definition at line 210 of file values.cpp.

References first, and Variable::Next.

Referenced by Parser::ParseFunctionDef().

{
    // Temporary variables are not owned by the variable list. Do not free memory.
    Variable* newFirst = first->Next;
    first->Next = nullptr;
    first = newFirst;
}

Here is the caller graph for this function:

Member Data Documentation

buf

CharBuffer* VariableList::buf

private

Definition at line 68 of file values.h.

Referenced by Clear(), ListContent(), VariableList(), and ~VariableList().

first

Variable* VariableList::first

private

Definition at line 69 of file values.h.

Referenced by Clear(), CreateVariable(), Delete(), GetFirstVariable(), GetVariable(), InsertTemporaryVariable(), RemoveTemporaryVariable(), VariableList(), and ~VariableList().

---

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

• src/main/values.h
• src/main/values.cpp