我在 Lua 电子设备模拟插件上工作。
我想让它在设计和可用性方面做得很好,因为很可能很多用户远离 IT 和调试。
用户在 Lua 中描述设备,插件通过 Lua C API 进行翻译。
用户可能会拼错函数名称、变量类型和参数顺序。
好的手册会有所帮助,但应用程序不应崩溃或提供错误描述的错误。我没有找到任何“最佳实践”并且想询问有经验的用户,因为我对 Lua 还很陌生。
参数的顺序和类型
目前 Lua 函数是这样声明的:
typedef struct lua_bind_func
{
int32_t ( *lua_c_api ) ( lua_State* );
const char* lua_func_name;
} lua_bind_func;
接着
{.lua_func_name="state_to_string", .lua_c_api=&lua_state_to_string},
为了检查参数顺序和类型是否正确传递:
创建宏:
#define STRING (&lua_isstring)
#define INT (&lua_isinteger)
#define USER (&lua_islightuserdata)
将数组添加到列表中:
int ( *args[16] ) ( lua_State*, int index );
更改功能列表:
{.lua_func_name="set_callback", .lua_c_api=&lua_set_callback, .args={INT, INT}}
参数列表检查器:
static void
SAFE_EXECUTE ( lua_State* L, void* curfunc )
{
int argnum = lua_gettop ( L );
for ( int i=0; lua_c_api_list[i].lua_func_name; i++ )
{
if ( curfunc == lua_c_api_list[i].lua_c_api )
{
for ( int argcount=0; lua_c_api_list[i].args[argcount]; argcount++ )
{
if ( argnum < argcount+1 )
{
IDSIMMODEL* model = ( IDSIMMODEL* ) lua_get_model_obj ( L );
print_error ( model, "Too few arguments passed to the function \"%s\"", lua_c_api_list[i].lua_func_name );
}
else if ( !lua_c_api_list[i].args[argcount] ( L, argcount+1 ) )
{
IDSIMMODEL* model = ( IDSIMMODEL* ) lua_get_model_obj ( L );
print_error ( model, "Argument %d is of wrong type", argcount+1 );
}
}
}
}
}
然后我可以检查参数顺序,它们的类型,并可以通过迷你帮助创建相应的错误消息:
SAFE_EXECUTE ( L, &lua_set_callback );
该代码不处理额外的参数,但很容易添加。
问题:它是好的场景还是可能有更好的场景?
拼写错误的函数名称
例如我有以下代码:
set_callback(time + 100 * MSEC, PC_EVENT)
set_calback(time + 200 * MSEC, PC_EVENT)
set_callback(time + 333 * MSEC, PC_EVENT)
第二个拼写错误,在这部分之后没有代码被执行。
我不明白如何在 C 中捕获对未定义函数的调用以引发足够的错误。
其他陷阱
也许还有更多我不知道的可能陷阱?