CBotStack Class Reference

Management of the execution stack. More...

#include <CBot.h>

Public Member Functions
	CBotStack (CBotStack *ppapa)
	CBotStack Constructor of the stack.
	~CBotStack ()
	~CBotStack Destructor
bool	StackOver ()
	StackOver Check if end of stack is reached.
int	GetError (int &start, int &end)
	GetError Get error number of the stack.
int	GetError ()
	GetError Get error number.
void	Reset (void *pUser)
	Reset Reset error at and set user.
void	SetType (CBotTypResult &type)
	SetType Determines the type.
int	GetType (int mode=0)
	GetType Get the type of value on the stack.
CBotTypResult	GetTypResult (int mode=0)
	Getes the type of complete value on the stack.
void	AddVar (CBotVar *p)
	Adds a local variable.
CBotVar *	FindVar (CBotToken *&pToken, bool bUpdate=false, bool bModif=false)
	Fetch a variable by its token.
CBotVar *	FindVar (CBotToken &Token, bool bUpdate=false, bool bModif=false)
	Fetch a variable by its token.
CBotVar *	FindVar (const char *name)
	Fetch variable by its name.
CBotVar *	FindVar (long ident, bool bUpdate=false, bool bModif=false)
	Fetch a variable on the stack according to its identification number.
CBotVar *	CopyVar (CBotToken &Token, bool bUpdate=false)
	Find variable by its token and returns a copy of it.
CBotStack *	AddStack (CBotInstr *instr=NULL, bool bBlock=false)
CBotStack *	AddStackEOX (CBotCall *instr=NULL, bool bBlock=false)
CBotStack *	RestoreStack (CBotInstr *instr=NULL)
CBotStack *	RestoreStackEOX (CBotCall *instr=NULL)
CBotStack *	AddStack2 (bool bBlock=false)
bool	Return (CBotStack *pFils)
bool	ReturnKeep (CBotStack *pFils)
bool	BreakReturn (CBotStack *pfils, const char *name=NULL)
bool	IfContinue (int state, const char *name)
bool	IsOk ()
bool	SetState (int n, int lim=-10)
int	GetState ()
bool	IncState (int lim=-10)
bool	IfStep ()
bool	Execute ()
void	SetVar (CBotVar *var)
void	SetCopyVar (CBotVar *var)
CBotVar *	GetVar ()
CBotVar *	GetCopyVar ()
CBotVar *	GetPtVar ()
bool	GetRetVar (bool bRet)
long	GetVal ()
void	SetStartError (int pos)
void	SetError (int n, CBotToken *token=NULL)
void	SetPosError (CBotToken *token)
void	ResetError (int n, int start, int end)
void	SetBreak (int val, const char *name)
void	SetBotCall (CBotProgram *p)
CBotProgram *	GetBotCall (bool bFirst=false)
void *	GetPUser ()
bool	GetBlock ()
bool	ExecuteCall (long &nIdent, CBotToken *token, CBotVar **ppVar, CBotTypResult &rettype)
void	RestoreCall (long &nIdent, CBotToken *token, CBotVar **ppVar)
bool	SaveState (FILE *pf)
bool	RestoreState (FILE *pf, CBotStack *&pStack)
void	GetRunPos (const char *&FunctionName, int &start, int &end)
CBotVar *	GetStackVars (const char *&FunctionName, int level)

Static Public Member Functions
static void	SetTimer (int n)

Public Attributes
int	m_temp

Friends
class	CBotInstArray
class	CBotTry

Detailed Description

Management of the execution stack.

Actually the only thing it can do is to create an instance of a stack to use for routine CBotProgram :: Execute(CBotStack)

Constructor & Destructor Documentation

CBotStack::CBotStack

(

CBotStack *

ppapa

)

CBotStack Constructor of the stack.

Parameters

ppapa

Not used.

Member Function Documentation

void CBotStack::AddVar

(

CBotVar *

p

)

Adds a local variable.

Parameters

[in]

p

Variable to be added.

p->m_bDontDelete = bDontDelete;

CBotVar * CBotStack::CopyVar	(	CBotToken &	Token,
		bool	bUpdate = false
	)

Find variable by its token and returns a copy of it.

Parameters

Token	Token upon which search is performed
bUpdate	Not used.

Returns

Found variable, NULL if not found

CBotVar * CBotStack::FindVar	(	CBotToken *&	pToken,
		bool	bUpdate = false,
		bool	bModif = false
	)

Fetch a variable by its token.

This may be a composite variable

Parameters

[in]	pToken	Token upon which search is performed
[in]	bUpdate	Not used. Probably need to be removed
[in]	bModif	Not used. Probably need to be removed

Returns

Found variable

CBotVar * CBotStack::FindVar	(	CBotToken &	Token,
		bool	bUpdate = false,
		bool	bModif = false
	)

Fetch a variable by its token.

This may be a composite variable

Parameters

[in]	pToken	Token upon which search is performed
[in]	bUpdate	Not used. Probably need to be removed
[in]	bModif	Not used. Probably need to be removed

Returns

Found variable

CBotVar * CBotStack::FindVar

(

const char *

name

)

Fetch variable by its name.

Parameters

[in]

name

Name of variable to find

Returns

Found variable

CBotVar * CBotStack::FindVar	(	long	ident,
		bool	bUpdate = false,
		bool	bModif = false
	)

Fetch a variable on the stack according to its identification number.

This is faster than comparing names

Parameters

[in]	ident	Identifier of a variable
[in]	bUpdate	Not used. Probably need to be removed
[in]	bModif	Not used. Probably need to be removed

Returns

Found variable

int CBotStack::GetError	(	int &	start,
		int &	end
	)

GetError Get error number of the stack.

Parameters

[out]	start	beginning of the stack
[out]	end	end of stack

Returns

error number

int CBotStack::GetError ( )

inline

GetError Get error number.

Returns

eror number

int CBotStack::GetType

(

int

mode = 0

)

GetType Get the type of value on the stack.

Parameters

[in]

mode

Used when getting class type (1 gives pointer, 2 gives intrinsic).

Returns

Type number.

CBotTypResult CBotStack::GetTypResult

(

int

mode = 0

)

Getes the type of complete value on the stack.

Parameters

[in]

mode

Used when getting class type (1 gives pointer, 2 gives intrinsic).

Returns

Type of an element.

void CBotStack::Reset

(

void *

pUser

)

Reset Reset error at and set user.

Parameters

[in]

pUser

User of stack

void CBotStack::SetType

(

CBotTypResult &

type

)

SetType Determines the type.

Parameters

type	Type of instruction on the stack.

bool CBotStack::StackOver

(

)

StackOver Check if end of stack is reached.

Returns

true if end of stack

---

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

• /build/colobot-T0lCmu/colobot-0.1.3/src/CBot/CBot.h
• /build/colobot-T0lCmu/colobot-0.1.3/src/CBot/CBotStack.cpp