SpringScriptEngine.cpp ファイル

#include "CScriptEngine.h"
#include "CVariableMan.h"
#include "SpringScriptEngine.h"

マクロ定義
#define	_DLLEXPORT
#define	HANDLECHECK(p)   if (p == NULL) { return FALSE; }
#define	SS(p)   ((CScriptEngine*)p)
#define	VM(p)   ((CVariableMan*)p)

関数
DLLFUNC HSPRINGSCRIPT	SpringScript_CreateInstance ()
	SpringScriptEngineのインスタンスを作成 [詳解]
DLLFUNC BOOL	SpringScript_DestroyInstance (HSPRINGSCRIPT hSpringScript)
	SpringScriptEngineのインスタンスを破棄 [詳解]
DLLFUNC BOOL	SpringScript_SetErrorCallbk (HSPRINGSCRIPT hSpringScript, HWND hWnd, ErrorCallbk pFunc, void *pUserData)
	エラー発生の呼び出すコールバック関数を設定 [詳解]
DLLFUNC BOOL	SpringScript_Load (HSPRINGSCRIPT hSpringScript, const char *pszFileName)
	スクリプトファイルを読み込む [詳解]
DLLFUNC BOOL	SpringScript_LoadFromMem (HSPRINGSCRIPT hSpringScript, const char *buf)
	スクリプトファイルをメモリから読み込む [詳解]
DLLFUNC BOOL	SpringScript_Run (HSPRINGSCRIPT hSpringScript)
	スクリプトを実行 [詳解]
DLLFUNC BOOL	SpringScript_Break (HSPRINGSCRIPT hSpringScript)
	スクリプトの実行を中止 スクリプト実行中にSpringScript_Run関数を呼び出した場合は、最後に呼び出したSpringScript_Run関数の実行を中止します。 [詳解]
DLLFUNC BOOL	SpringScript_Exit (HSPRINGSCRIPT hSpringScript)
	スクリプトの実行をすべて中止 スクリプト実行中に呼び出したSpringScript_Run関数を含め、すべての実行を中止します。 [詳解]
DLLFUNC BOOL	SpringScript_RegisterCommand (HSPRINGSCRIPT hSpringScript, const char *pszName, const char *pszPrm, CommandCallbk pFunc, void *pUserData)
	命令を登録 [詳解]
DLLFUNC BOOL	SpringScript_UnregisterCommand (HSPRINGSCRIPT hSpringScript, const char *pszName)
	命令を削除 [詳解]
DLLFUNC BOOL	SpringScript_GoTo (HSPRINGSCRIPT hSpringScript, const char *pszLabel)
	ラベルへジャンプ [詳解]
DLLFUNC BOOL	SpringScript_GoTo_Event (HSPRINGSCRIPT hSpringScript, const char *pszLabel)
	ラベルへジャンプ2 SpringScript_Run()を呼び出す前にラベルにジャンプしておきたい場合はこちらを使用します。 [詳解]
DLLFUNC BOOL	SpringScript_GetPostion (HSPRINGSCRIPT hSpringScript, PostionInfo *pi)
	解析中のスクリプトの位置を取得 [詳解]
DLLFUNC BOOL	SpringScript_GetPostionLH (HSPRINGSCRIPT hSpringScript, PostionInfo *pi)
	解析中のスクリプトの位置を取得2 SpringScript_GetPostion関数と違い、先頭からのバッファ位置を示すPostionInfo.uPosに行の頭の位置を格納します。 [詳解]
DLLFUNC BOOL	SpringScript_SetPostion (HSPRINGSCRIPT hSpringScript, const PostionInfo *pi)
	解析中のスクリプトの位置を移動 サブルーチンジャンプの復帰などに使用します。 [詳解]
DLLFUNC BOOL	SpringScript_SetPostionForce (HSPRINGSCRIPT hSpringScript, const PostionInfo *pi)
	解析中のスクリプトの位置を移動 SpringScript_SetPostion関数と違い、飛んだ先の行を無視して次の行から開始します。 (PostionInfo構造体の値がそのまま使われる) [詳解]
DLLFUNC BOOL	SpringScript_GetLineNum (HSPRINGSCRIPT hSpringScript, size_t *pVal)
	行位置を取得 [詳解]
DLLFUNC BOOL	SpringScript_Eval (HSPRINGSCRIPT hSpringScript, const char *pszExpression, int *out)
	数式を計算 [詳解]
DLLFUNC BOOL	SpringScript_Evalf (HSPRINGSCRIPT hSpringScript, const char *pszExpression, float *out)
	数式を計算(float) SpringScript_Eval関数と違い、結果をfloatで出力します。 [詳解]
DLLFUNC UINT	SpringScript_GetCmdArgCount (HCOMMANDARG hArg)
	命令の引数の数を取得 [詳解]
DLLFUNC BOOL	SpringScript_GetCmdName (HCOMMANDARG hArg, char *lpString, int nMaxCount)
	呼び出された命令の名前を取得 [詳解]
DLLFUNC INT	SpringScript_GetCmdNameLen (HCOMMANDARG hArg)
	呼び出された命令の名前の長さを取得 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。 [詳解]
DLLFUNC VarType	SpringScript_GetCmdArgType (HCOMMANDARG hArg, int index)
	命令の引数の型を取得 [詳解]
DLLFUNC HSPRINGSCRIPTVAR	SpringScript_GetCmdArgPtr (HCOMMANDARG hArg, int index)
	命令の引数にアクセスるためのハンドルを取得 この関数を使用して、SpringScript_GetVarVal系とSpringScript_SetVarVal関数で引数を操作できるようになります。 [詳解]
DLLFUNC INT	SpringScript_GetVarValInt (HSPRINGSCRIPTVAR var)
	Integer型の変数の値を取得 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。 [詳解]
DLLFUNC BOOL	SpringScript_GetVarValStr (HSPRINGSCRIPTVAR var, char *lpString, int nMaxCount)
	String型の変数の内容を取得 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。 [詳解]
DLLFUNC INT	SpringScript_GetVarValStrLen (HSPRINGSCRIPTVAR var)
	String型の変数の内容の長さを取得 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。 [詳解]
DLLFUNC FLOAT	SpringScript_GetVarValFloat (HSPRINGSCRIPTVAR var)
	Float型の変数の値を取得 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。 [詳解]
DLLFUNC INT	SpringScript_GetVarValHnd (HSPRINGSCRIPTVAR var)
	Handle型の変数の値を取得 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。 [詳解]
DLLFUNC HSPRINGSCRIPTVAR	SpringScript_GetVarValRef (HSPRINGSCRIPTVAR var)
	Variable型(参照)の変数の値を取得 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。 [詳解]
DLLFUNC BOOL	SpringScript_SetVarVal (HSPRINGSCRIPTVAR var, const void *val, VarType type)
	変数の値を設定 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。 [詳解]

マクロ定義詳解

_DLLEXPORT

#define _DLLEXPORT

HANDLECHECK

#define HANDLECHECK

(

p

)

if (p == NULL) { return FALSE; }

SS

#define SS

(

p

)

((CScriptEngine*)p)

VM

#define VM

(

p

)

((CVariableMan*)p)

関数詳解

SpringScript_Break()

DLLFUNC BOOL SpringScript_Break

(

HSPRINGSCRIPT

hSpringScript

)

スクリプトの実行を中止
スクリプト実行中にSpringScript_Run関数を呼び出した場合は、最後に呼び出したSpringScript_Run関数の実行を中止します。

引数

[in]

hSpringScript

SpringScriptEngineのハンドル

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_CreateInstance()

DLLFUNC HSPRINGSCRIPT SpringScript_CreateInstance

(

)

SpringScriptEngineのインスタンスを作成

戻り値

成功したときはHSPRINGSCRIPT型のハンドル。失敗したときはNULL。

SpringScript_DestroyInstance()

DLLFUNC BOOL SpringScript_DestroyInstance

(

HSPRINGSCRIPT

hSpringScript

)

SpringScriptEngineのインスタンスを破棄

引数

[in]

hSpringScript

SpringScriptEngineのハンドル

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_Eval()

DLLFUNC BOOL SpringScript_Eval	(	HSPRINGSCRIPT	hSpringScript,
		const char *	pszExpression,
		int *	out
	)

数式を計算

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pszExpression	計算式
[out]	out	結果を代入する変数のポインタ(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_Evalf()

DLLFUNC BOOL SpringScript_Evalf	(	HSPRINGSCRIPT	hSpringScript,
		const char *	pszExpression,
		float *	out
	)

数式を計算(float)
SpringScript_Eval関数と違い、結果をfloatで出力します。

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pszExpression	計算式
[out]	out	結果を代入する変数のポインタ(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_Exit()

DLLFUNC BOOL SpringScript_Exit

(

HSPRINGSCRIPT

hSpringScript

)

スクリプトの実行をすべて中止
スクリプト実行中に呼び出したSpringScript_Run関数を含め、すべての実行を中止します。

引数

[in]

hSpringScript

SpringScriptEngineのハンドル

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_GetCmdArgCount()

DLLFUNC UINT SpringScript_GetCmdArgCount

(

HCOMMANDARG

hArg

)

命令の引数の数を取得

引数

[in]

hArg

HCOMMANDARGハンドル

戻り値

引数の数

SpringScript_GetCmdArgPtr()

DLLFUNC HSPRINGSCRIPTVAR SpringScript_GetCmdArgPtr	(	HCOMMANDARG	hArg,
		int	index
	)

命令の引数にアクセスるためのハンドルを取得
この関数を使用して、SpringScript_GetVarVal系とSpringScript_SetVarVal関数で引数を操作できるようになります。

引数

[in]	hArg	HCOMMANDARGハンドル
[in]	index	引数の位置

戻り値

HSPRINGSCRIPTVARハンドル(失敗時:NULL)

SpringScript_GetCmdArgType()

DLLFUNC VarType SpringScript_GetCmdArgType	(	HCOMMANDARG	hArg,
		int	index
	)

命令の引数の型を取得

引数

[in]	hArg	HCOMMANDARGハンドル
[in]	index	引数の位置

戻り値

VarType列挙体で示される引数の型(失敗時:VARTYPE_UNKNOWN)

SpringScript_GetCmdName()

DLLFUNC BOOL SpringScript_GetCmdName	(	HCOMMANDARG	hArg,
		char *	lpString,
		int	nMaxCount
	)

呼び出された命令の名前を取得

引数

[in]	hArg	HCOMMANDARGハンドル
[out]	lpString	文字列を書き込むバッファのポインタ(NULL不可)
[in]	nMaxCount	バッファのサイズ

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_GetCmdNameLen()

DLLFUNC INT SpringScript_GetCmdNameLen

(

HCOMMANDARG

hArg

)

呼び出された命令の名前の長さを取得 SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。

引数

[in]

var

HSPRINGSCRIPTVARハンドル(NULL不可)

戻り値

文字列の長さ

SpringScript_GetLineNum()

DLLFUNC BOOL SpringScript_GetLineNum	(	HSPRINGSCRIPT	hSpringScript,
		size_t *	pVal
	)

行位置を取得

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[out]	val	値を代入する変数のポインタ(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_GetPostion()

DLLFUNC BOOL SpringScript_GetPostion	(	HSPRINGSCRIPT	hSpringScript,
		PostionInfo *	pi
	)

解析中のスクリプトの位置を取得

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[out]	pi	PostionInfo構造体のポインタ(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_GetPostionLH()

DLLFUNC BOOL SpringScript_GetPostionLH	(	HSPRINGSCRIPT	hSpringScript,
		PostionInfo *	pi
	)

解析中のスクリプトの位置を取得2
SpringScript_GetPostion関数と違い、先頭からのバッファ位置を示すPostionInfo.uPosに行の頭の位置を格納します。

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[out]	pi	PostionInfo構造体のポインタ(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_GetVarValFloat()

DLLFUNC FLOAT SpringScript_GetVarValFloat

(

HSPRINGSCRIPTVAR

var

)

Float型の変数の値を取得
SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。

引数

[in]

var

HSPRINGSCRIPTVARハンドル(NULL不可)

戻り値

取得した値

SpringScript_GetVarValHnd()

DLLFUNC INT SpringScript_GetVarValHnd

(

HSPRINGSCRIPTVAR

var

)

Handle型の変数の値を取得
SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。

引数

[in]

var

HSPRINGSCRIPTVARハンドル(NULL不可)

戻り値

取得した値

SpringScript_GetVarValInt()

DLLFUNC INT SpringScript_GetVarValInt

(

HSPRINGSCRIPTVAR

var

)

Integer型の変数の値を取得
SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。

引数

[in]

var

HSPRINGSCRIPTVARハンドル(NULL不可)

戻り値

取得した値

SpringScript_GetVarValRef()

DLLFUNC HSPRINGSCRIPTVAR SpringScript_GetVarValRef

(

HSPRINGSCRIPTVAR

var

)

Variable型(参照)の変数の値を取得
SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。

引数

[in]

var

HSPRINGSCRIPTVARハンドル(NULL不可)

戻り値

HSPRINGSCRIPTVARハンドル(失敗時:NULL)

SpringScript_GetVarValStr()

DLLFUNC BOOL SpringScript_GetVarValStr	(	HSPRINGSCRIPTVAR	var,
		char *	lpString,
		int	nMaxCount
	)

String型の変数の内容を取得
SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。

引数

[in]	var	HSPRINGSCRIPTVARハンドル(NULL不可)
[out]	lpString	文字列を書き込むバッファのポインタ(NULL不可)
[in]	nMaxCount	バッファのサイズ

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_GetVarValStrLen()

DLLFUNC INT SpringScript_GetVarValStrLen

(

HSPRINGSCRIPTVAR

var

)

String型の変数の内容の長さを取得
SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。

引数

[in]

var

HSPRINGSCRIPTVARハンドル(NULL不可)

戻り値

文字列の長さ

SpringScript_GoTo()

DLLFUNC BOOL SpringScript_GoTo	(	HSPRINGSCRIPT	hSpringScript,
		const char *	pszLabel
	)

ラベルへジャンプ

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pszName	ラベルの名前(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_GoTo_Event()

DLLFUNC BOOL SpringScript_GoTo_Event	(	HSPRINGSCRIPT	hSpringScript,
		const char *	pszLabel
	)

ラベルへジャンプ2
SpringScript_Run()を呼び出す前にラベルにジャンプしておきたい場合はこちらを使用します。

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pszName	ラベルの名前(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_Load()

DLLFUNC BOOL SpringScript_Load	(	HSPRINGSCRIPT	hSpringScript,
		const char *	pszFileName
	)

スクリプトファイルを読み込む

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pszFileName	スクリプトファイルへのパス

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_LoadFromMem()

DLLFUNC BOOL SpringScript_LoadFromMem	(	HSPRINGSCRIPT	hSpringScript,
		const char *	buf
	)

スクリプトファイルをメモリから読み込む

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	buf	文字列バッファ

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_RegisterCommand()

DLLFUNC BOOL SpringScript_RegisterCommand	(	HSPRINGSCRIPT	hSpringScript,
		const char *	pszName,
		const char *	pszPrm,
		CommandCallbk	pFunc,
		void *	pUserData
	)

命令を登録

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pszName	命令の名前(NULL不可)
[in]	pszPrm	命令の引数(NULL不可) 引数の型を示す記号[i = Integer / f = Float / s = String / v = Variable / . = 可変長引数] 例)「Integer, String, Float, Integer, ...」の可変長引数にしたい場合は、「isfi.」と設定します。
[in]	pFunc	呼び出すコールバック関数(NULL不可)
[in]	pUserData	コールバック関数の呼び出し時に渡されるユーザー定義の値(NULL可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_Run()

DLLFUNC BOOL SpringScript_Run

(

HSPRINGSCRIPT

hSpringScript

)

スクリプトを実行

引数

[in]

hSpringScript

SpringScriptEngineのハンドル

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_SetErrorCallbk()

DLLFUNC BOOL SpringScript_SetErrorCallbk	(	HSPRINGSCRIPT	hSpringScript,
		HWND	hWnd,
		ErrorCallbk	pFunc,
		void *	pUserData
	)

エラー発生の呼び出すコールバック関数を設定

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	hWnd	親ウィンドウハンドル(NULL可)
[in]	pFunc	コールバック関数へのポインタ(NULL可)
[in]	pUserData	コールバック関数の呼び出し時に渡されるユーザー定義の値(NULL可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_SetPostion()

DLLFUNC BOOL SpringScript_SetPostion	(	HSPRINGSCRIPT	hSpringScript,
		const PostionInfo *	pi
	)

解析中のスクリプトの位置を移動
サブルーチンジャンプの復帰などに使用します。

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pi	PostionInfo構造体のポインタ(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_SetPostionForce()

DLLFUNC BOOL SpringScript_SetPostionForce	(	HSPRINGSCRIPT	hSpringScript,
		const PostionInfo *	pi
	)

解析中のスクリプトの位置を移動
SpringScript_SetPostion関数と違い、飛んだ先の行を無視して次の行から開始します。
(PostionInfo構造体の値がそのまま使われる)

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pi	PostionInfo構造体のポインタ(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。

SpringScript_SetVarVal()

DLLFUNC BOOL SpringScript_SetVarVal	(	HSPRINGSCRIPTVAR	var,
		const void *	val,
		VarType	type
	)

変数の値を設定
SpringScript_GetCmdArgPtr関数で取得した引数の操作にも使用できます。

引数

[in]	var	HSPRINGSCRIPTVARハンドル(NULL不可)
[in]	val	値のポインタ
[in]	typeVarType::VARTYPE列挙体で示される変数の型

戻り値

HSPRINGSCRIPTVARハンドル(失敗時:NULL)

SpringScript_UnregisterCommand()

DLLFUNC BOOL SpringScript_UnregisterCommand	(	HSPRINGSCRIPT	hSpringScript,
		const char *	pszName
	)

命令を削除

引数

[in]	hSpringScript	SpringScriptEngineのハンドル
[in]	pszName	命令の名前(NULL不可)

戻り値

失敗したときFALSE、成功したときはFALSE以外。