UserFunction Class Reference

A user defined function. More...

#include <userfunction.h>

Collaboration diagram for UserFunction:

Public Member Functions
	UserFunction (const char *name, const char *variable, ExpressionNode *expression)
	UserFunction (const char *name)
	~UserFunction ()
char *	GetName () const
char *	GetDefinitionName () const
char *	GetDefinitionText () const
Variable *	GetVariable () const
Variable *	CreateVariable (const char *name)
ExpressionNode *	GetExpression () const
void	SetExpression (ExpressionNode *expression)

Public Attributes
UserFunction *	Next

Private Member Functions
void	InitializeTexts () const

Private Attributes
char *	name
Variable *	variable
ExpressionNode *	expression
bool	chainDelete
CharBuffer *	defname
CharBuffer *	definition

Friends
bool	FunctionList::Delete (const char *name, const char *argument)

Detailed Description

A user defined function.

Definition at line 44 of file userfunction.h.

Constructor & Destructor Documentation

UserFunction() [1/2]

UserFunction::UserFunction	(	const char *	name,
		const char *	variable,
		ExpressionNode *	expression
	)

Definition at line 34 of file userfunction.cpp.

References AllocAndCopy(), chainDelete, CharBuffer::CharBuffer(), definition, defname, expression, InitializeTexts(), name, Next, variable, and Variable::Variable().

{
    AllocAndCopy(&this->name, name);
    this->variable = new Variable(variable);
    this->expression = expression;
    this->Next = nullptr;

    defname = new CharBuffer();
    definition = new CharBuffer();
    InitializeTexts();

    chainDelete = true;
}

Here is the call graph for this function:

UserFunction() [2/2]

UserFunction::UserFunction ( const char *  name )

explicit

Definition at line 48 of file userfunction.cpp.

References AllocAndCopy(), chainDelete, CharBuffer::CharBuffer(), definition, defname, expression, name, Next, and variable.

Referenced by FunctionList::GetFunctionDef().

{
    AllocAndCopy(&this->name, name);
    this->variable = nullptr;
    this->expression = nullptr;
    this->Next = nullptr;

    defname = new CharBuffer();
    definition = new CharBuffer();

    chainDelete = true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

~UserFunction()

UserFunction::~UserFunction

(

)

Definition at line 61 of file userfunction.cpp.

References chainDelete, definition, defname, expression, name, Next, and variable.

{
    delete [] name;
    delete defname;
    delete definition;

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

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

    if (chainDelete && Next != nullptr)
    {
        delete Next;
    }
}

Member Function Documentation

CreateVariable()

Variable * UserFunction::CreateVariable

(

const char *

name

)

Definition at line 117 of file userfunction.cpp.

References InitializeTexts(), variable, and Variable::Variable().

Referenced by Parser::ParseFunctionDef().

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

    variable = new Variable(name);
    InitializeTexts();

    return variable;
}

Here is the call graph for this function:

Here is the caller graph for this function:

GetDefinitionName()

char * UserFunction::GetDefinitionName

(

)

const

Definition at line 102 of file userfunction.cpp.

References defname, and CharBuffer::GetString().

{
    return defname->GetString();
}

Here is the call graph for this function:

GetDefinitionText()

char * UserFunction::GetDefinitionText

(

)

const

Definition at line 107 of file userfunction.cpp.

References definition, and CharBuffer::GetString().

{
    return definition->GetString();
}

Here is the call graph for this function:

GetExpression()

ExpressionNode * UserFunction::GetExpression

(

)

const

Definition at line 130 of file userfunction.cpp.

References expression.

Referenced by UserFunctionNode::Evaluate(), Grid::FunctionValue(), UserFunctionNode::GetNext(), and FunctionList::ListContent().

{
    return expression;
}

Here is the caller graph for this function:

GetName()

char * UserFunction::GetName

(

)

const

Definition at line 97 of file userfunction.cpp.

References name.

Referenced by FunctionList::Delete(), FunctionList::GetFunctionCall(), FunctionList::GetFunctionDef(), UserFunctionNode::GetNodeText(), and FunctionList::ListContent().

{
    return name;
}

Here is the caller graph for this function:

GetVariable()

Variable * UserFunction::GetVariable

(

)

const

Definition at line 112 of file userfunction.cpp.

References variable.

Referenced by FunctionList::Delete(), UserFunctionNode::Evaluate(), Grid::FunctionValue(), FunctionList::GetFunctionDef(), and FunctionList::ListContent().

{
    return variable;
}

Here is the caller graph for this function:

InitializeTexts()

void UserFunction::InitializeTexts ( ) const

private

Definition at line 83 of file userfunction.cpp.

References CharBuffer::Append(), definition, defname, CharBuffer::Empty(), expression, Variable::GetName(), CharBuffer::GetString(), ExpressionNode::GetText(), name, and variable.

Referenced by CreateVariable(), SetExpression(), and UserFunction().

{
    defname->Empty();
    defname->Append(name);
    defname->Append('(');
    defname->Append(variable != nullptr ? variable->GetName() : EMPTYSTRING);
    defname->Append(')');

    definition->Empty();
    definition->Append(defname->GetString());
    definition->Append('=');
    definition->Append(expression != nullptr ? expression->GetText() : EMPTYSTRING);
}

Here is the call graph for this function:

Here is the caller graph for this function:

SetExpression()

void UserFunction::SetExpression

(

ExpressionNode *

expression

)

Definition at line 135 of file userfunction.cpp.

References expression, and InitializeTexts().

Referenced by Parser::ParseFunctionDef().

{
    delete this->expression;
    this->expression = expression;
    InitializeTexts();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

FunctionList::Delete

bool FunctionList::Delete ( const char *  name, const char *  argument  )

friend

Member Data Documentation

chainDelete

bool UserFunction::chainDelete

private

Definition at line 65 of file userfunction.h.

Referenced by FunctionList::Delete(), UserFunction(), and ~UserFunction().

definition

CharBuffer* UserFunction::definition

private

Definition at line 70 of file userfunction.h.

Referenced by GetDefinitionText(), InitializeTexts(), UserFunction(), and ~UserFunction().

defname

CharBuffer* UserFunction::defname

private

Definition at line 69 of file userfunction.h.

Referenced by GetDefinitionName(), InitializeTexts(), UserFunction(), and ~UserFunction().

expression

ExpressionNode* UserFunction::expression

private

Definition at line 64 of file userfunction.h.

Referenced by GetExpression(), InitializeTexts(), SetExpression(), UserFunction(), and ~UserFunction().

name

char* UserFunction::name

private

Definition at line 62 of file userfunction.h.

Referenced by GetName(), InitializeTexts(), UserFunction(), and ~UserFunction().

Next

UserFunction* UserFunction::Next

Definition at line 51 of file userfunction.h.

Referenced by FunctionList::Delete(), FunctionList::GetFunctionCall(), FunctionList::GetFunctionDef(), FunctionList::ListContent(), UserFunction(), and ~UserFunction().

variable

Variable* UserFunction::variable

private

Definition at line 63 of file userfunction.h.

Referenced by CreateVariable(), GetVariable(), InitializeTexts(), UserFunction(), and ~UserFunction().

---

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

• src/main/userfunction.h
• src/main/userfunction.cpp