script.cpp File Reference

#include <signal.h>
#include "stratagus.h"
#include "script.h"
#include "animation/animation_setplayervar.h"
#include "font.h"
#include "game.h"
#include "iocompat.h"
#include "iolib.h"
#include "map.h"
#include "parameters.h"
#include "translate.h"
#include "trigger.h"
#include "ui.h"
#include "unit.h"

Classes
struct	UStrInt

script.cpp - The configuration language.
enum	UStrIntType {   USTRINT_STR, USTRINT_INT, USTRINT_STR, USTRINT_INT,   USTRINT_STR, USTRINT_INT }
	Counter for lua function. More...
error Missing the< filesystem > header lua_State *	Lua
int	CclInConfigFile
	Structure to work with lua files. More...
NumberDesc *	Damage
	True while config file parsing. More...
static int	NumberCounter = 0
	Damage calculation for missile. More...
static int	StringCounter = 0
	Counter for lua function. More...
UStrInt	GetComponent (const CUnit &unit, int index, EnumVariable e, int t)
	Get component for unit variable. More...
UStrInt	GetComponent (const CUnitType &type, int index, EnumVariable e, int t)
	Get component for unit type variable. More...
static void	lstop (lua_State *l, lua_Debug *ar)
static void	laction (int i)
static int	report (int status, bool exitOnError)
static int	luatraceback (lua_State *L)
int	LuaCall (int narg, int clear, bool exitOnError)
int	LuaCall (lua_State *L, int narg, int nresults, int base, bool exitOnError)
static bool	GetFileContent (const std::string &file, std::string &content)
int	LuaLoadFile (const std::string &file, const std::string &strArg, bool exitOnError)
static int	CclSavePreferences (lua_State *l)
static int	CclLoad (lua_State *l)
static int	CclLoadBuffer (lua_State *l)
const char *	LuaToString (lua_State *l, int narg)
	True while config file parsing. More...
int	LuaToNumber (lua_State *l, int narg)
float	LuaToFloat (lua_State *l, int narg)
unsigned int	LuaToUnsignedNumber (lua_State *l, int narg)
bool	LuaToBoolean (lua_State *l, int narg)
const char *	LuaToString (lua_State *l, int index, int subIndex)
int	LuaToNumber (lua_State *l, int index, int subIndex)
unsigned int	LuaToUnsignedNumber (lua_State *l, int index, int subIndex)
bool	LuaToBoolean (lua_State *l, int index, int subIndex)
void	LuaGarbageCollect ()
static void	ParseBinOp (lua_State *l, BinOp *binop)
static CUnit **	Str2UnitRef (lua_State *l, const char *s)
static CUnitType **	Str2TypeRef (lua_State *l, const char *s)
UnitDesc *	CclParseUnitDesc (lua_State *l)
	Parse a number description. More...
CUnitType **	CclParseTypeDesc (lua_State *l)
	Parse a unit description. More...
static int	ParseLuaFunction (lua_State *l, const char *tablename, int *counter)
static int	CallLuaNumberFunction (unsigned int handler)
static std::string	CallLuaStringFunction (unsigned int handler)
NumberDesc *	CclParseNumberDesc (lua_State *l)
StringDesc *	CclParseStringDesc (lua_State *l)
	Parse a unit type description. More...
CUnit *	EvalUnit (const UnitDesc *unitdesc)
	Evaluate the number. More...
int	EvalNumber (const NumberDesc *number)
	Parse a string description. More...
std::string	EvalString (const StringDesc *s)
	Evaluate the unit. More...
void	FreeUnitDesc (UnitDesc *)
	Free number description content. (no pointer itself). More...
void	FreeNumberDesc (NumberDesc *number)
	Evaluate the string. More...
void	FreeStringDesc (StringDesc *s)
	Free unit description content. (no pointer itself). More...
static int	AliasTypeVar (lua_State *l, const char *s)
static int	AliasUnitVar (lua_State *l, const char *s)
static int	CclUnitAttackerVar (lua_State *l)
static int	CclUnitDefenderVar (lua_State *l)
static int	CclActiveUnitVar (lua_State *l)
static int	CclActiveTypeVar (lua_State *l)
static int	Alias (lua_State *l, const char *s)
static int	CclAdd (lua_State *l)
static int	CclSub (lua_State *l)
static int	CclMul (lua_State *l)
static int	CclDiv (lua_State *l)
static int	CclMin (lua_State *l)
static int	CclMax (lua_State *l)
static int	CclRand (lua_State *l)
static int	CclGreaterThan (lua_State *l)
static int	CclGreaterThanOrEq (lua_State *l)
static int	CclLessThan (lua_State *l)
static int	CclLessThanOrEq (lua_State *l)
static int	CclEqual (lua_State *l)
static int	CclNotEqual (lua_State *l)
static int	CclConcat (lua_State *l)
static int	CclString (lua_State *l)
static int	CclInverseVideo (lua_State *l)
static int	CclUnitName (lua_State *l)
static int	CclIf (lua_State *l)
static int	CclSubString (lua_State *l)
static int	CclLine (lua_State *l)
static int	CclGameInfo (lua_State *l)
static int	CclVideoTextLength (lua_State *l)
static int	CclStringFind (lua_State *l)
static int	CclNumIf (lua_State *l)
static int	CclPlayerData (lua_State *l)
static int	CclPlayerName (lua_State *l)
static void	AliasRegister ()
static int	CclStratagusLibraryPath (lua_State *l)
static int	CclFilteredListDirectory (lua_State *l, int type, int mask)
static int	CclListDirectory (lua_State *l)
static int	CclListFilesInDirectory (lua_State *l)
static int	CclListDirsInDirectory (lua_State *l)
static int	CclSetDamageFormula (lua_State *l)
static int	CclDebugPrint (lua_State *l)
static int	CclRestartStratagus (lua_State *l)
int	CclCommand (const std::string &command, bool exitOnError)
	Save user preferences. More...
int	tolua_stratagus_open (lua_State *tolua_S)
void	InitLua ()
	Perform garbage collection. More...
static std::string	ConcatTableString (const std::vector< std::string > &blockTableNames)
static bool	IsAValidTableName (const std::string &key)
static bool	ShouldGlobalTableBeSaved (const std::string &key)
static bool	ShouldLocalTableBeSaved (const std::string &key)
static bool	LuaValueToString (lua_State *l, std::string &value)

Enumeration Type Documentation

UStrIntType

enum UStrIntType

Counter for lua function.

Useful for getComponent.

Enumerator
USTRINT_STR
USTRINT_INT
USTRINT_STR
USTRINT_INT
USTRINT_STR
USTRINT_INT

Function Documentation

Alias()

static int Alias ( lua_State *  l, const char *  s  )

static

Make alias for some function.

Parameters

l	lua State.
s	FIXME: docu

Returns

the lua table {s, {arg1, arg2, ..., argn}} or {s, arg1}

AliasRegister()

static void AliasRegister ( )

static

AliasTypeVar()

static int AliasTypeVar ( lua_State *  l, const char *  s  )

static

Make alias for some unit type Variable function.

Parameters

l	lua State.
s	FIXME: docu

Returns

the lua table {"TypeVar", {Variable = arg1, Component = "Value" or arg2}

AliasUnitVar()

static int AliasUnitVar ( lua_State *  l, const char *  s  )

static

Make alias for some unit Variable function.

Parameters

l	lua State.
s	FIXME: docu

Returns

the lua table {"UnitVar", {Unit = s, Variable = arg1, Component = "Value" or arg2, Loc = [012]}

CallLuaNumberFunction()

static int CallLuaNumberFunction ( unsigned int  handler )

static

Call a Lua handler

Parameters

handler

handler of the lua function to call.

Returns

lua function result.

CallLuaStringFunction()

static std::string CallLuaStringFunction ( unsigned int  handler )

static

Call a Lua handler

Parameters

handler

handler of the lua function to call.

Returns

lua function result.

CclActiveTypeVar()

static int CclActiveTypeVar ( lua_State *  l )

static

Return equivalent lua table for . {"Type", {Type = "Active", Variable = arg1, Component = "Value" or arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclActiveUnitVar()

static int CclActiveUnitVar ( lua_State *  l )

static

Return equivalent lua table for . {"Unit", {Unit = "Active", Variable = arg1, Component = "Value" or arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclAdd()

static int CclAdd ( lua_State *  l )

static

Return equivalent lua table for add. {"Add", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclCommand()

int CclCommand	(	const std::string &	command,
		bool	exitOnError
	)

Save user preferences.

Send command to ccl.

Parameters

command

Zero terminated command string.

CclConcat()

static int CclConcat ( lua_State *  l )

static

Return equivalent lua table for Concat. {"Concat", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclDebugPrint()

static int CclDebugPrint ( lua_State *  l )

static

Print debug message with info about current script name, line number and function.

See also

DebugPrint

Parameters

l	Lua state.

CclDiv()

static int CclDiv ( lua_State *  l )

static

Return equivalent lua table for add. {"Div", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclEqual()

static int CclEqual ( lua_State *  l )

static

Return equivalent lua table for Equal. {"Equal", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclFilteredListDirectory()

static int CclFilteredListDirectory ( lua_State *  l, int  type, int  mask  )

static

Return a table with the filtered items found in the subdirectory.

CclGameInfo()

static int CclGameInfo ( lua_State *  l )

static

Return equivalent lua table for Line. {"Line", "arg1"}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclGreaterThan()

static int CclGreaterThan ( lua_State *  l )

static

Return equivalent lua table for GreaterThan. {"GreaterThan", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclGreaterThanOrEq()

static int CclGreaterThanOrEq ( lua_State *  l )

static

Return equivalent lua table for GreaterThanOrEq. {"GreaterThanOrEq", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclIf()

static int CclIf ( lua_State *  l )

static

Return equivalent lua table for If. {"If", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclInverseVideo()

static int CclInverseVideo ( lua_State *  l )

static

Return equivalent lua table for InverseVideo. {"InverseVideo", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclLessThan()

static int CclLessThan ( lua_State *  l )

static

Return equivalent lua table for LessThan. {"LessThan", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclLessThanOrEq()

static int CclLessThanOrEq ( lua_State *  l )

static

Return equivalent lua table for LessThanOrEq. {"LessThanOrEq", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclLine()

static int CclLine ( lua_State *  l )

static

Return equivalent lua table for Line. {"Line", {arg1, arg2[, arg3]}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclListDirectory()

static int CclListDirectory ( lua_State *  l )

static

Return a table with the files or directories found in the subdirectory.

CclListDirsInDirectory()

static int CclListDirsInDirectory ( lua_State *  l )

static

Return a table with the files found in the subdirectory.

CclListFilesInDirectory()

static int CclListFilesInDirectory ( lua_State *  l )

static

Return a table with the files found in the subdirectory.

CclLoad()

static int CclLoad ( lua_State *  l )

static

Load a file and execute it.

Parameters

l	Lua state.

Returns

0 in success, else exit.

CclLoadBuffer()

static int CclLoadBuffer ( lua_State *  l )

static

Load a file into a buffer and return it.

Parameters

l	Lua state.

Returns

buffer or nil on failure

CclMax()

static int CclMax ( lua_State *  l )

static

Return equivalent lua table for add. {"Max", {arg1, arg2, argn}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclMin()

static int CclMin ( lua_State *  l )

static

Return equivalent lua table for add. {"Min", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclMul()

static int CclMul ( lua_State *  l )

static

Return equivalent lua table for add. {"Mul", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclNotEqual()

static int CclNotEqual ( lua_State *  l )

static

Return equivalent lua table for NotEqual. {"NotEqual", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclNumIf()

static int CclNumIf ( lua_State *  l )

static

Return equivalent lua table for NumIf. {"NumIf", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclParseNumberDesc()

NumberDesc* CclParseNumberDesc

(

lua_State *

l

)

Return number.

Parameters

l	lua state.

Returns

number.

CclParseStringDesc()

StringDesc* CclParseStringDesc

(

lua_State *

l

)

Parse a unit type description.

Return String description.

Parameters

l	lua state.

Returns

String description.

CclParseTypeDesc()

CUnitType** CclParseTypeDesc

(

lua_State *

l

)

Parse a unit description.

Return unit type referernce definition.

Parameters

l	lua state.

Returns

unit type referernce definition.

CclParseUnitDesc()

UnitDesc* CclParseUnitDesc

(

lua_State *

l

)

Parse a number description.

Return unit referernce definition.

Parameters

l	lua state.

Returns

unit referernce definition.

CclPlayerData()

static int CclPlayerData ( lua_State *  l )

static

Return equivalent lua table for PlayerData. {"PlayerData", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclPlayerName()

static int CclPlayerName ( lua_State *  l )

static

Return equivalent lua table for PlayerName. {"PlayerName", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclRand()

static int CclRand ( lua_State *  l )

static

Return equivalent lua table for add. {"Rand", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclRestartStratagus()

static int CclRestartStratagus ( lua_State *  l )

static

Restart the entire game. This function only returns when an error happens.

CclSavePreferences()

static int CclSavePreferences ( lua_State *  l )

static

Save preferences

Parameters

l	Lua state.

CclSetDamageFormula()

static int CclSetDamageFormula ( lua_State *  l )

static

Set damage computation method.

Parameters

l	Lua state.

CclStratagusLibraryPath()

static int CclStratagusLibraryPath ( lua_State *  l )

static

Return the stratagus library path.

Parameters

l	Lua state.

Returns

Current libray path.

CclString()

static int CclString ( lua_State *  l )

static

Return equivalent lua table for String. {"String", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclStringFind()

static int CclStringFind ( lua_State *  l )

static

Return equivalent lua table for StringFind. {"StringFind", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclSub()

static int CclSub ( lua_State *  l )

static

Return equivalent lua table for add. {"Div", {arg1, arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclSubString()

static int CclSubString ( lua_State *  l )

static

Return equivalent lua table for SubString. {"SubString", {arg1, arg2, arg3}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclUnitAttackerVar()

static int CclUnitAttackerVar ( lua_State *  l )

static

Return equivalent lua table for . {"Unit", {Unit = "Attacker", Variable = arg1, Component = "Value" or arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclUnitDefenderVar()

static int CclUnitDefenderVar ( lua_State *  l )

static

Return equivalent lua table for . {"Unit", {Unit = "Defender", Variable = arg1, Component = "Value" or arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

CclUnitName()

static int CclUnitName ( lua_State *  l )

static

Return equivalent lua table for UnitName. {"UnitName", {arg1}}

Parameters

l	Lua state.

Returns

equivalent lua table.

Example:

u_data = UnitType("unit-footman")

CclVideoTextLength()

static int CclVideoTextLength ( lua_State *  l )

static

Return equivalent lua table for VideoTextLength. {"VideoTextLength", {Text = arg1, Font = arg2}}

Parameters

l	Lua state.

Returns

equivalent lua table.

ConcatTableString()

static std::string ConcatTableString ( const std::vector< std::string > &  blockTableNames )

static

EvalNumber()

int EvalNumber

(

const NumberDesc *

number

)

Parse a string description.

compute the number expression

Parameters

number

struct with definition of the calculation.

Returns

the result number.

Todo:

Manage better the error (div/0, unit==NULL, ...).

EvalString()

std::string EvalString

(

const StringDesc *

s

)

Evaluate the unit.

compute the string expression

Parameters

s	struct with definition of the calculation.

Returns

the result string.

Todo:

Manage better the error.

EvalUnit()

CUnit* EvalUnit

(

const UnitDesc *

unitdesc

)

Evaluate the number.

compute the Unit expression

Parameters

unitdesc

struct with definition of the calculation.

Returns

the result unit.

FreeNumberDesc()

void FreeNumberDesc

(

NumberDesc *

number

)

Evaluate the string.

Free the number expression content. (not the pointer itself).

Parameters

number

struct to free

FreeStringDesc()

void FreeStringDesc

(

StringDesc *

s

)

Free unit description content. (no pointer itself).

Free the String expression content. (not the pointer itself).

Parameters

s	struct to free

FreeUnitDesc()

void FreeUnitDesc

(

UnitDesc *

)

Free number description content. (no pointer itself).

Free the unit expression content. (not the pointer itself).

Parameters

unitdesc

struct to free

GetComponent() [1/2]

UStrInt GetComponent	(	const CUnit &	unit,
		int	index,
		EnumVariable	e,
		int	t
	)

Get component for unit variable.

Return the value corresponding.

Parameters

unit	Unit.
index	Index of the variable.
e	Component of the variable.
t	Which var use (0:unit, 1:Type, 2:Stats)

Returns

Value corresponding

GetComponent() [2/2]

UStrInt GetComponent	(	const CUnitType &	type,
		int	index,
		EnumVariable	e,
		int	t
	)

Get component for unit type variable.

GetFileContent()

static bool GetFileContent ( const std::string &  file, std::string &  content  )

static

Get the (uncompressed) content of the file into a string

InitLua()

void InitLua

(

)

Perform garbage collection.

Initialize Lua

IsAValidTableName()

static bool IsAValidTableName ( const std::string &  key )

static

laction()

static void laction ( int  i )

static

FIXME: docu

lstop()

static void lstop ( lua_State *  l, lua_Debug *  ar  )

static

FIXME: docu

LuaCall() [1/2]

int LuaCall	(	int	narg,
		int	clear,
		bool	exitOnError
	)

Call a lua function

Parameters

narg	Number of arguments
clear	Clear the return value(s)
exitOnError	Exit the program when an error occurs

Returns

0 in success, else exit.

LuaCall() [2/2]

int LuaCall	(	lua_State *	L,
		int	narg,
		int	nresults,
		int	base,
		bool	exitOnError
	)

Call a lua function

Parameters

L	Pointer to Lua state
narg	Number of arguments
nresults	Number of return values
base	Stack index of the function to call
exitOnError	Exit the program when an error occurs

Returns

0 in success, else exit.

LuaGarbageCollect()

void LuaGarbageCollect

(

)

Perform lua garbage collection

LuaLoadFile()

int LuaLoadFile	(	const std::string &	file,
		const std::string &	strArg,
		bool	exitOnError
	)

Load a file and execute it

Parameters

file	File to load and execute
nargs	Number of arguments that caller has put on the stack

Returns

0 for success, -1 if the file was not found, else exit.

LuaToBoolean() [1/2]

bool LuaToBoolean	(	lua_State *	l,
		int	index,
		int	subIndex
	)

LuaToBoolean() [2/2]

bool LuaToBoolean	(	lua_State *	l,
		int	narg
	)

Convert lua boolean to bool. It also checks type and exits in case of error.

Parameters

l	Lua state.
narg	Argument number.

Returns

1 for true, 0 for false from lua.

LuaToFloat()

float LuaToFloat	(	lua_State *	l,
		int	narg
	)

Convert lua number in C float. It checks also type and exit in case of error.

Parameters

l	Lua state.
narg	Argument number.

Returns

C number from lua.

LuaToNumber() [1/2]

int LuaToNumber	(	lua_State *	l,
		int	index,
		int	subIndex
	)

LuaToNumber() [2/2]

int LuaToNumber	(	lua_State *	l,
		int	narg
	)

Convert lua number in C number. It checks also type and exit in case of error.

Parameters

l	Lua state.
narg	Argument number.

Returns

C number from lua.

LuaToString() [1/2]

const char* LuaToString	(	lua_State *	l,
		int	index,
		int	subIndex
	)

LuaToString() [2/2]

const char* LuaToString	(	lua_State *	l,
		int	narg
	)

True while config file parsing.

Convert lua string in char*. It checks also type and exit in case of error.

Note

char* could be invalidated with lua garbage collector.

Parameters

l	Lua state.
narg	Argument number.

Returns

char* from lua.

LuaToUnsignedNumber() [1/2]

unsigned int LuaToUnsignedNumber	(	lua_State *	l,
		int	index,
		int	subIndex
	)

LuaToUnsignedNumber() [2/2]

unsigned int LuaToUnsignedNumber	(	lua_State *	l,
		int	narg
	)

Convert lua number in C unsigned int. It checks also type and exit in case of error.

Parameters

l	Lua state.
narg	Argument number.

Returns

C number from lua.

luatraceback()

static int luatraceback ( lua_State *  L )

static

LuaValueToString()

static bool LuaValueToString ( lua_State *  l, std::string &  value  )

static

ParseBinOp()

static void ParseBinOp ( lua_State *  l, BinOp *  binop  )

static

Parse binary operation with number.

Parameters

l	lua state.
binop	Where to stock info (must be malloced)

ParseLuaFunction()

static int ParseLuaFunction ( lua_State *  l, const char *  tablename, int *  counter  )

static

Add a Lua handler

Parameters

l	lua state.
tablename	name of the lua table.
counter	Counter for the handler

Returns

handle of the function.

report()

static int report ( int  status, bool  exitOnError  )

static

Check error status, and print error message and exit if status is different of 0.

Parameters

status	status of the last lua call. (0: success)
exitOnError	exit the program on error

Returns

0 in success, else exit.

ShouldGlobalTableBeSaved()

static bool ShouldGlobalTableBeSaved ( const std::string &  key )

static

ShouldLocalTableBeSaved()

static bool ShouldLocalTableBeSaved ( const std::string &  key )

static

Str2TypeRef()

static CUnitType** Str2TypeRef ( lua_State *  l, const char *  s  )

static

Convert the string to the corresponding data (which is a unit type).

Parameters

l	lua state.
s	Ident.

Returns

The reference of the unit type.

Todo:

better check for error (restrict param).

Str2UnitRef()

static CUnit** Str2UnitRef ( lua_State *  l, const char *  s  )

static

Convert the string to the corresponding data (which is a unit).

Parameters

l	lua state.
s	Ident.

Returns

The reference of the unit.

Todo:

better check for error (restrict param).

tolua_stratagus_open()

TOLUA_API int tolua_stratagus_open

(

lua_State *

tolua_S

)

Variable Documentation

CclInConfigFile

int CclInConfigFile

Structure to work with lua files.

Damage

NumberDesc* Damage

True while config file parsing.

Burning building frames.

Lua

error Missing the<filesystem> header lua_State* Lua

NumberCounter

int NumberCounter = 0

static

Damage calculation for missile.

StringCounter

int StringCounter = 0

static

Counter for lua function.