diff options
Diffstat (limited to 'src/tsg_lua_interface.h')
| -rw-r--r-- | src/tsg_lua_interface.h | 279 |
1 files changed, 136 insertions, 143 deletions
diff --git a/src/tsg_lua_interface.h b/src/tsg_lua_interface.h index 9369036..5e97328 100644 --- a/src/tsg_lua_interface.h +++ b/src/tsg_lua_interface.h @@ -45,124 +45,117 @@ struct lua_data_t enum err_value { - ERR_LUAVM_ISNULL = -1, /* 输入虚拟机参数为空 */ - ERR_SCRIPT_ISNULL = -2, /* 输入脚本为空 */ - ERR_INPUT_ISNULL = -3, /* 输入数据为空 */ - ERR_IN_LEN_INVAILD = -4, /* 输入数据长度小于1 */ - ERR_SCRIPT_FUNCTION_INVAILD = -5, /* 脚本函数名无效 */ - ERR_SCRIPT_RETURN_LEN_INVAILD = -6, /* 脚本返回值长度为0 */ - ERR_SCRIPT_RETURN_TOO_MUCH = -7, /* 脚本返回值太多 */ - ERR_SCRIPT_RETURN_TOO_FEW = -8, /* 脚本返回值太少 */ - ERR_SCRIPT_RETURN_TYPE_INVAILD = -9, /* 脚本返回值类型错误 */ - ERR_SCRIPT_SYNTAX_ERROR = -10, /* 脚本语法错误 */ - ERR_SCRIPT_END_EXPECTED = -11, /* 脚本缺少end */ - ERR_SCRIPT_THEN_EXPECTED = -12, /* 脚本缺少then */ - ERR_SCRIPT_DO_EXPECTED = -13, /* 脚本缺少do */ - ERR_SCRIPT_EOF_EXPECTED = -14, /* 脚本缺少eof */ - ERR_SCRIPT_EQUAL_IN_EXPECTED = -15, /* 脚本缺少‘=’或者‘in’ */ - ERR_SCRIPT_UNEXPECTED_SYMBOL = -16, /* 脚本中出现不可预期的错误符号 */ - ERR_SCRIPT_NAME_EXPECTED = -17, /* 脚本中for后面没有表达式 */ - ERR_SCRIPT_RIGHT_CURVES_BRACKET_EXPECTED = -18, /* 脚本中缺少')' */ - ERR_SCRIPT_RIGHT_CURLY_BRACKET_EXPECTED = -19, /* 脚本中缺少'}' */ - ERR_SCRIPT_EXEC_ERROR = -20, /* 脚本运行错误 */ - ERR_SCRIPT_STRING_EXPECTED_BUT_NIL = -21, /* 脚本参数错误，尝试访问string类型变量，但该变量是nil类型 */ - ERR_SCRIPT_STRING_EXPECTED_BUT_BOOL = -22, /* 脚本参数错误，尝试访问string类型变量，但该变量是bool类型 */ - ERR_SCRIPT_STRING_EXPECTED_BUT_TABLE = -23, /* 脚本参数错误，尝试访问string类型变量，但该变量是table类型 */ - ERR_SCRIPT_CALL_GLOBAL_BUT_NIL = -24, /* 脚本尝试访问一个不存在的变量 */ - ERR_SCRIPT_NOT_EXIT = -25, /* 脚本不存在 */ - ERR_SCRIPT_BYTECODE_NO_HEADER = -26, /* 字节码脚本没有header */ - ERR_SCRIPT_BYTECODE_BAD_HEADER = -27, /* 字节码脚本header错误 */ - ERR_SCRIPT_BYTECODE_VERSION_UNSUPPORTED = -28, /* 字节码脚本的版本不支持 */ - ERR_SCRIPT_BYTECODE_ONLY_SUPPORT_LUAJIT = -29, /* 只支持luajit的字节码脚本 */ - ERR_SCRIPT_BYTECODE_NOT_SUPPORT_BIG_ENDIAN = -30, /* 不支持字节码脚本大端模式 */ - ERR_SCRIPT_BYTECODE_NOT_SUPPORT_DEBUG = -31, /* 不支持字节码脚本debug模式 */ - ERR_SCRIPT_IS_BAD = -32, /* 脚本错误 */ - ERR_SCRIPT_ID_INVAILD = -33, /* 脚本ID无效 */ - ERR_LUA_CACHE_FAILED = -34, /* 脚本缓存失败 */ - ERR_MEM_NOT_ENOUGH = -35, /* 空间不足 */ - ERR_LUA_ID = -36, /* lua id 错误*/ - ERR_EXPECT_TYPE_IS_NIL = -37, /* 预期脚本返回类型为空 */ - ERR_LUA_FUNCTION_ARGC = -38, /* lua 注册的C函数，调用时输入参数个数不匹配 */ - ERR_LUA_FUNCTION_ARGV = -39, /* lua 注册的C函数，调用时输入参数类型不匹配 */ - ERR_PARAMETER = -40, /* 参数错误 */ - ERR_LUA_PRIVATE_INFO_IS_NIL = -41, /* lua 私有信息为空 */ - ERR_LUA_SET_CONTEXT_FAILED = -42, /* lua 添加上下文失败 */ - ERR_UNKNOWN = -43, /* 未知错误 */ - ERR_RETUNR_NIL = 1, /* 脚本执行成功，但是返回空*/ - ERR_RETURN_TYPE_NOT_MATCH_EXPECT = 2, /* 脚本执行成功，但是返回值类型与预期不符 */ + ERR_LUAVM_ISNULL = -1, /*The lua vm is not existed */ + ERR_SCRIPT_ISNULL = -2, /* The entered script is null */ + ERR_INPUT_ISNULL = -3, /* The entered data is null */ + ERR_IN_LEN_INVAILD = -4, /* The length of entered data less then 1*/ + ERR_SCRIPT_RETURN_LEN_INVAILD = -5, /* The return value of the script has a length of 0 */ + ERR_SCRIPT_RETURN_TOO_MUCH = -6, /* Too many return values of the script */ + ERR_SCRIPT_RETURN_TOO_FEW = -7, /* Too few return values of the script */ + ERR_SCRIPT_RETURN_TYPE_INVAILD = -8, /* The script return a value which type is error */ + ERR_SCRIPT_SYNTAX_ERROR = -9, /* Script syntax error */ + ERR_SCRIPT_END_EXPECTED = -10, /* Script "end" expected */ + ERR_SCRIPT_THEN_EXPECTED = -11, /* Script "then" expected */ + ERR_SCRIPT_DO_EXPECTED = -12, /* Script "do" expected */ + ERR_SCRIPT_EOF_EXPECTED = -13, /* Script "eof" expected */ + ERR_SCRIPT_EQUAL_IN_EXPECTED = -14, /* Scprit "=" or "in" expected */ + ERR_SCRIPT_UNEXPECTED_SYMBOL = -15, /* Script funexpected symbol */ + ERR_SCRIPT_NAME_EXPECTED = -16, /* Script "<name>" expected */ + ERR_SCRIPT_RIGHT_CURVES_BRACKET_EXPECTED = -17, /* Script ")" expected */ + ERR_SCRIPT_RIGHT_CURLY_BRACKET_EXPECTED = -18, /* Script "}" expected */ + ERR_SCRIPT_EXEC_ERROR = -19, /* Script run error */ + ERR_SCRIPT_STRING_EXPECTED_BUT_NIL = -20, /* Script bad argument, string expected, got nil */ + ERR_SCRIPT_STRING_EXPECTED_BUT_BOOL = -21, /* Script bad argument, string expected, got boolean */ + ERR_SCRIPT_STRING_EXPECTED_BUT_TABLE = -22, /* Script bad argument, string expected, got table */ + ERR_SCRIPT_CALL_GLOBAL_BUT_NIL = -23, /* Script attempt to call global value which is a nil value */ + ERR_SCRIPT_NOT_EXIT = -24, /* The script is not existed */ + ERR_SCRIPT_BYTECODE_NO_HEADER = -25, /* The bytecode script has no header */ + ERR_SCRIPT_BYTECODE_BAD_HEADER = -26, /* The bytecode script has a bad header */ + ERR_SCRIPT_BYTECODE_VERSION_UNSUPPORTED = -27, /* Not support the bytecode version */ + ERR_SCRIPT_BYTECODE_ONLY_SUPPORT_LUAJIT = -28, /* Only support the bytecode script of luajit */ + ERR_SCRIPT_BYTECODE_NOT_SUPPORT_BIG_ENDIAN = -29, /* Not support the bytecoode script building with BIG ENDIAN */ + ERR_SCRIPT_BYTECODE_NOT_SUPPORT_DEBUG = -30, /* Not support the bytecode script building with Debug mode */ + ERR_SCRIPT_IS_BAD = -31, /* The script is bad */ + ERR_SCRIPT_ID_INVAILD = -32, /* The script id is invaild*/ + ERR_LUA_CACHE_FAILED = -33, /* Cache script failed */ + ERR_MEM_NOT_ENOUGH = -34, /* The memory of lua is not enough */ + ERR_EXPECT_TYPE_IS_NIL = -35, /* The caller expect script return a nil value */ + ERR_LUA_FUNCTION_ARGC = -36, /* lua cFunction, the number of input parameters does not match expection */ + ERR_LUA_FUNCTION_ARGV = -37, /* lua cFunction, the type of input paramters does not match expection */ + ERR_PARAMETER = -38, /* Paramter error */ + ERR_LUA_PRIVATE_INFO_IS_NIL = -39, /* The private info of lua is nil */ + ERR_LUA_SET_CONTEXT_FAILED = -40, /* lua malloc context failed */ + ERR_UNKNOWN = -41, /* Unkown */ + ERR_RETUNR_NIL = 1, /* Script run successed, but return a nil value*/ + ERR_RETURN_TYPE_NOT_MATCH_EXPECT = 2, /* Script run successed，but the type of return value does not match expection */ }; struct lua_State; typedef lua_State* tsg_lua_handle; -/* 函数名：tsg_lua_vm_create - * 返回值：tsg_lua_handle 成功,返回一个虚拟机， - * 失败,返回NULL */ +/* function name： tsg_lua_vm_create + * return value： tsg_lua_handle successed,return a virtual machine; failed, return NULL*/ tsg_lua_handle tsg_lua_vm_create(); -/* 函数名： tsg_lua_exec - * 输入参数： tsg_lua_handle L 指定虚拟机 - * char *script 待执行的lua脚本 - * size_t *script_len 待执行的lua脚本大小 - * char *in 输入待处理的数据 - * size_t in_len 输入待处理的数据的长度 - * 输出参数： - * char *out 输出结果 - * size_t *out_len 输出结果的长度 - * 输入输出参数： - * size_t *out_type 要求输入一个不为NIL的预期类型， 调用完成后会输出结果的类型 - * 返回值： int 成功，返回0；失败返回错误值err_value */ +/* function name: tsg_lua_exec + * input: tsg_lua_handle L a virtual machine + * char *script script waiting to be executed, which must be script`s content + * size_t *script_len the length of script waiting to be executed + * char *in data waiting to be handled + * size_t in_len the length of data waiting to be handled + * output: char *out out value + * size_t *out_len the length of out value + * input-output: size_t *out_type Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete + * return value: int successed return 0; failed return error code */ int tsg_lua_exec(tsg_lua_handle L, const char *script, size_t script_len, const char *in, size_t in_len, char *out, size_t *out_len, size_t *out_type); -/* 函数名： tsg_lua_exec_script - * 输入参数： tsg_lua_handle L 指定虚拟机 - * char *script 待执行的lua脚本 - * char *in 输入待处理的数据 - * size_t in_len 输入待处理的数据的长度 - * 输出参数： - * char *out 输出结果 - * size_t *out_len 输出结果的长度 - * 输入输出参数： - * size_t *out_type 要求输入一个不为NIL的预期类型， 调用完成后会输出结果的类型 - * 返回值： int 成功，返回0；失败返回错误值err_value */ +/* function name: tsg_lua_exec_file + * input: tsg_lua_handle L a virtual machine + * char *script script waiting to be executed, which mush be script`s path + * char *in data waiting to be handled + * size_t in_len the length of data waiting to be handled + * output: char *out out value + * size_t *out_len the length of out value + * input-output: size_t *out_type Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete + * return value: int successed return 0; failed return error code */ int tsg_lua_exec_file(tsg_lua_handle L, const char *script, const char *in, size_t in_len, char *out, size_t *out_len, size_t *out_type); -/* 函数名： tsg_lua_cache_script - * 输入参数： tsg_lua_handle L 指定虚拟机 - * char *script 待缓存的lua脚本 - * size_t *script_len 待缓存的lua脚本大小 +/* function name: tsg_lua_cache_script + * input: tsg_lua_handle L a virtual machine + * char *script script waiting to be cached, which must be script`s content + * size_t *script_len the length of script waiting to be cached * - * 返回值： int 成功，返回一个大于1的值，是脚本在当前虚拟机的唯一标识；失败，返回错误值err_value */ + * return value: int successed, return a script id which is bigger than 1; failed, return error code */ int tsg_lua_cache_script(tsg_lua_handle L, const char *script, size_t script_len); -/* 函数名： tsg_lua_cache_script_file - * 输入参数： tsg_lua_handle L 指定虚拟机 - * char *script 待缓存的lua脚本路径名 +/* function name: tsg_lua_cache_script_file + * input: tsg_lua_handle L a virtual machine + * char *script script waiting to be cached, which must be script`s path + * size_t *script_len the length of script waiting to be cached * - * 返回值： int 成功，返回一个大于1的值，是脚本在当前虚拟机的唯一标识；失败，返回错误值err_value */ + * return value: int successed, return a script id which is bigger than 1; failed, return error code */ int tsg_lua_cache_script_file(tsg_lua_handle L, const char *script); -/* 函数名： tsg_unchache_script - * 输入参数： tsg_lua_handle L 指定虚拟机 - * size_t script_id 当前虚拟机内指定脚本的唯一标识 - * 返回值： int 成功，返回0；失败，返回错误码err_value */ +/* function name: tsg_unchache_script + * input: tsg_lua_handle L a virtual machine + * size_t script_id a script id + * return value: int successed, return 0; failed, return error code */ int tsg_lua_uncache_script(tsg_lua_handle L, size_t script_id); -/* 函数名： tsg_cache_exec - * 输入参数： tsg_lua_handle L 指定虚拟机 - * size_t script_id 当前虚拟机内指定脚本的唯一标识 - * char *in 输入待处理的数据 - * size_t in_len 输入待处理的数据的长度 - * 输出参数： char *out 输出结果 - * size_t *out_len 输出结果的长度 - * 输入输出参数： - * size_t *out_type 要求输入一个不为NIL的预期类型， 调用完成后会输出结果的类型 - * 返回值： int 成功，返回0；失败,返回错误值err_value */ +/* function name: tsg_cache_exec + * input: tsg_lua_handle L a virtual machine + * size_t script_id a script id + * char *in data waiting to be handled + * size_t in_len the length of data waiting to be handled + * output: char *out out value + * size_t *out_len the length of out value + * input-output: size_t *out_type Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete + * return value: int successed, return 0; failed, return error code */ int tsg_lua_cache_exec(tsg_lua_handle L, size_t script_id, const char *in, size_t in_len, char *out, size_t *out_len, size_t *out_type); -/* 函数名： tsg_destory_lua - * 输入参数： tsg_lua_handle L 指定虚拟机 - * 返回值： int 成功，返回0；失败返回错误值err_value */ +/* function name: tsg_destory_lua + * input: tsg_lua_handle L a virtual machine + * return value: int successed, return 0; failed, return error code */ int tsg_destory_lua(tsg_lua_handle L); int c_pull_param_from_lua(tsg_lua_handle lua, int *argc, lua_arg_t **argv); @@ -173,69 +166,69 @@ int c_push_nil_into_lua(tsg_lua_handle lua); int c_push_string_into_lua(tsg_lua_handle lua, const char *str, size_t len); int c_push_table_into_lua(tsg_lua_handle lua, const char **key_list, const char **value_list, size_t list_len); -/* 函数名： lua_get_userdata - * 描述： 此函数用来获取exec系列函数设置的userdata - * 输入参数： tsg_lua_handle L 指定虚拟机 - * 返回值： int 成功，返回0；失败返回错误值err_value */ +/* function name: lua_get_userdata + * description: get C userdata + * input: tsg_lua_handle L a virtual machine + * return value: int successed, return 0; failed, return error code */ void *lua_get_userdata(tsg_lua_handle L); typedef int (*lua_function_ptr)(tsg_lua_handle L); -/* 函数名： lua_register_function - * 描述： 此函数用来注册函数给LUA使用 - * 输入参数： tsg_lua_handle L 指定虚拟机 - * 输入参数： const char *function_set 注册函数所属函数集 - * 输入参数： const char *function_name 注册函数的函数名 - * 输入参数： lua_function_ptr function 注册函数的函数指针 - * 返回值： int 成功，返回0；失败返回 -1。*/ +/* function name: lua_register_function + * description: Regist a c function to lua + * input: tsg_lua_handle L a virtual machine + * input: const char *function_set The function set to which the function belongs + * input: const char *function_name function name + * input: lua_function_ptr function function pointer + * return value: int successed, return 0; failed return 1 */ int lua_register_function(tsg_lua_handle L, const char *function_set, const char *function_name, lua_function_ptr function); struct lua_script_context_t; typedef lua_script_context_t * lua_script_context; -/* 函数名： lua_script_context_malloc - * 输入参数： tsg_lua_handle L - * 返回值： lua_script_context 失败返回 NULL,并设置error code*/ + +/* function name: lua_script_context_malloc + * input: tsg_lua_handle L + * return value: lua_script_context failed, return NULL; successed, return a context*/ lua_script_context lua_script_context_malloc(tsg_lua_handle L); -/* 函数名： lua_script_context_free - * 输入参数： tsg_lua_handle L - * 输出参数： lua_script_context *context_id 成功时回收lua context - * 返回值： int 成功，返回0；失败返回 -1*/ +/* function name: lua_script_context_free + * input: tsg_lua_handle L + * input: lua_script_context context context waiting to free + * return value: int successed, return 0; failed, return -1 */ int lua_script_context_free(tsg_lua_handle L, lua_script_context context); -/* 函数名： lua_cache_exec - * 输入参数： tsg_lua_handle L - size_t script_id 缓存的脚本id - struct lua_data_t in 待处理的数据 - void *userdata set_function的callpback 使用的userdata - struct lua_script_context *context lua上下文 - * 输出参数： struct lua_arg_t *outvalue 脚本执行成功返回的内容 - * 返回值： int 成功，返回0；失败返回 -1*/ +/* function name: lua_cache_exec + * input: tsg_lua_handle L a virtual machine + * size_t script_id a script id + * struct lua_data_t in data waiting to be handled + * void *userdata can get the userdata with lua_get_userdata(L) + * lua_script_context context Can accessed with lua-name.context in lua script + * output: struct lua_arg_t *outvalue Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete + * return value: int successed, return 0; failed, return error code */ int lua_cache_exec(tsg_lua_handle L, size_t script_id, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue); -/* 函数名： lua_exec - * 输入参数： tsg_lua_handle L - struct lua_data_t script lua脚本(lua脚本内容) - struct lua_data_t in 待处理的数据 - void *userdata set_function的callback 使用的userdata - struct lua_script_context *context lua上下文 - * 输出参数： struct lua_arg_t *outvalue 脚本执行成功返回的内容 - * 返回值： int 成功，返回0；失败返回 -1*/ +/* function name: lua_exec + * input: tsg_lua_handle L a virtual machine + * struct lua_data_t script script waiting to be executed, which must be script`s content + * struct lua_data_t in data waiting to be handled + * void *userdata can get the userdata with lua_get_userdata(L) + * lua_script_context context Can accessed with lua-name.context in lua script + * output: struct lua_arg_t *outvalue Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete + * return value: int successed, return 0; failed, return error code */ int lua_exec(tsg_lua_handle L, struct lua_data_t script, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue); -/* 函数名： lua_cache_exec - * 输入参数： tsg_lua_handle L - struct script lua脚本(lua脚本路径) - struct lua_data_t in 待处理的数据 - void *userdata set_function的callback 使用的userdata - struct lua_script_context *context lua上下文文 - * 输出参数： struct lua_arg_t *outvalue 脚本执行成功返回的内容 - * 返回值： int 成功，返回0；失败返回 -1*/ +/* function name: lua_exec_file + * input: tsg_lua_handle L a virtual machine + * struct lua_data_t script script waiting to be executed, which must be script`s path + * struct lua_data_t in data waiting to be handled + * void *userdata can get the userdata with lua_get_userdata(L) + * lua_script_context context Can accessed with lua-name.context in lua script + * output: struct lua_arg_t *outvalue Requires input of an expected type that is not NIL, the type of the result that will be output after the call is complete + * return value: int successed, return 0; failed, return error code */ int lua_exec_file(tsg_lua_handle L, const char *script, struct lua_data_t in, void *userdata, lua_script_context context, struct lua_arg_t *outvalue); -/* 函数名：tsg_lua_vm_create_with_name - * 返回值：tsg_lua_handle 成功,返回一个虚拟机， - * 输入参数： char *name 虚拟机名称，可以在lua中找到该名字的全局变量，建议大写字母开头。如果为空，默认填写"TSG" - * 失败,返回NULL */ +/* function name： tsg_lua_vm_create + * input: char *name the name of virtual machine, default: "TSG" + * return value： tsg_lua_handle successed,return a virtual machine; failed, return NULL*/ tsg_lua_handle tsg_lua_vm_create_with_name(const char *name); int lua_get_error_code(tsg_lua_handle L); |