HelpStatement Class Reference

Logic related to the help statement. More...

#include <help.h>

Inheritance diagram for HelpStatement:

Collaboration diagram for HelpStatement:

Public Member Functions
	HelpStatement ()
	HelpStatement (Symbol argument)
	HelpStatement (const char *ident)
	~HelpStatement ()
char *	Execute ()
Public Member Functions inherited from StatementNode
	StatementNode ()
	StatementNode (const char *text)
virtual	~StatementNode ()
NodeType	GetNodeType ()
virtual SyntaxNode *	GetNext ()
virtual char *	GetTextCode ()
void	Attach (SyntaxNode *node)
void	Detach (SyntaxNode *node)
void	Replace (SyntaxNode *n, SyntaxNode *x)
Public Member Functions inherited from SyntaxNode
	SyntaxNode ()
virtual	~SyntaxNode ()
void	SetFirstNode ()
bool	GetFirstNode () const
SyntaxNode *	GetParent () const
void	SetParent (SyntaxNode *node)
virtual ReductionType	GetReductionType ()
virtual void	ResetIterator ()

Private Member Functions
char *	StatementHelp () const

Private Attributes
Symbol	argument
char *	ident

Additional Inherited Members
Protected Attributes inherited from StatementNode
char *	statementText
Protected Attributes inherited from SyntaxNode
CharBuffer *	output
SyntaxNode *	parent
SyntaxNode *	iterator
bool	leftBottom

Detailed Description

Logic related to the help statement.

Definition at line 39 of file help.h.

Constructor & Destructor Documentation

HelpStatement() [1/3]

HelpStatement::HelpStatement

(

)

Definition at line 37 of file help.cpp.

References argument, ident, and StatementNode::StatementNode().

Referenced by Parser::ParseHelpStatement().

                             :
    StatementNode()
{
    argument = static_cast<Symbol>(0);
    ident = nullptr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

HelpStatement() [2/3]

HelpStatement::HelpStatement ( Symbol  argument )

explicit

Definition at line 44 of file help.cpp.

References argument, ident, and StatementNode::StatementNode().

Referenced by Parser::ParseHelpStatement().

                                            :
    StatementNode(), argument(argument)
{
    ident = nullptr;
}

Here is the call graph for this function:

Here is the caller graph for this function:

HelpStatement() [3/3]

HelpStatement::HelpStatement ( const char *  ident )

explicit

Definition at line 50 of file help.cpp.

References AllocAndCopy(), argument, ident, and symident.

Referenced by Parser::ParseHelpStatement().

{
    argument = symident;
    AllocAndCopy(&this->ident, ident);
}

Here is the call graph for this function:

Here is the caller graph for this function:

~HelpStatement()

HelpStatement::~HelpStatement

(

)

Definition at line 56 of file help.cpp.

References ident.

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

Member Function Documentation

Execute()

char * HelpStatement::Execute ( )

virtual

Implements StatementNode.

Definition at line 64 of file help.cpp.

References argument, CharBuffer::ClearAndCopy(), Language::GetHelpText(), CharBuffer::GetString(), ident, SyntaxNode::output, StatementHelp(), symident, and symstatement.

{
    if (argument == symstatement)
    {
        return StatementHelp();
    }
    else if (argument == symident)
    {
        char* text = Program->Language->GetHelpText(ident);
        output->ClearAndCopy(text);
        return output->GetString();
    }

    char* text = Program->Language->GetHelpText(argument);
    output->ClearAndCopy(text);
    return output->GetString();
}

Here is the call graph for this function:

StatementHelp()

char * HelpStatement::StatementHelp ( ) const

private

Definition at line 87 of file help.cpp.

References CharBuffer::ClearBuffer(), CharBuffer::GetString(), and SyntaxNode::output.

Referenced by Execute().

{
    char* text;
    output->ClearBuffer();

    APPENDHELP(STATEMENTLINE)
    APPENDHELP(STATEMENTABOUT)
#if defined(AMIGA) || defined(TERMIOS) || defined(WINDOWS)
    APPENDHELP(STATEMENTCLEAR)
#endif
    APPENDHELP(STATEMENTDEF)
    APPENDHELP(STATEMENTDELETE)
    APPENDHELP(STATEMENTDIGITS)
    APPENDHELP(STATEMENTEVAL)
    APPENDHELP(STATEMENTEXECUTE)
    APPENDHELP(STATEMENTFUNCS)
    APPENDHELP(STATEMENTINPUT)
    APPENDHELP(STATEMENTHELP)
    APPENDHELP(STATEMENTOUTPUT)
#if defined(UNIX) || defined(HAIKU) || defined(AMIGA)
    APPENDHELP(STATEMENTLIST)
#endif
    APPENDHELP(STATEMENTSHOW)
    APPENDHELP(STATEMENTLOAD)
    APPENDHELP(STATEMENTSAVE)
    APPENDHELP(STATEMENTVARS)
    APPENDHELP(STATEMENTVERSION)
    APPENDHELP(STATEMENTLICENSE)
    APPENDHELP(STATEMENTMEMORY)
    APPENDHELP(STATEMENTEXIT)
    APPENDHELP(STATEMENTLINE)
    APPENDHELP(STATEMENTFOOTER)

    return output->GetString();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

argument

Symbol HelpStatement::argument

private

Definition at line 51 of file help.h.

Referenced by Execute(), and HelpStatement().

ident

char* HelpStatement::ident

private

Definition at line 52 of file help.h.

Referenced by Execute(), HelpStatement(), and ~HelpStatement().

---

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

• src/main/statement/help.h
• src/main/statement/help.cpp