使用sol Lua包装器获取函数参数数量、名称及可变参数信息

可以通过sol结合Lua原生的debug库实现需求——sol本身未提供直接的反射API，但能无缝调用Lua的debug接口来提取函数参数的相关信息。以下针对示例函数function foo(a, b, c) end给出具体实现：

实现代码（C++侧） #

#include <sol/sol.hpp>
#include <iostream>

int main() {
    sol::state lua;
    lua.script(R"(
        function foo(a, b, c) end
    )");

    sol::function foo_func = lua["foo"];
    lua_State* L = lua.lua_state();
    foo_func.push(L); // 将目标函数压入Lua栈

    lua_Debug debug_info;
    // 获取函数的调试信息，">u"表示获取函数的基本参数与可变参数标记
    lua_getinfo(L, ">u", &debug_info);

    // 1. 获取参数数量
    std::cout << "函数有" << debug_info.nparams << "个参数" << std::endl;

    // 2. 获取参数名称及位置
    std::cout << "参数名称依次为：";
    for (int pos = 1; pos <= debug_info.nparams; ++pos) {
        const char* param_name = lua_getlocal(L, &debug_info, pos);
        if (param_name) {
            std::cout << param_name << (pos == debug_info.nparams ? "" : "、");
            lua_pop(L, 1); // 弹出lua_getlocal返回的参数值
        }
    }
    std::cout << std::endl;

    // 3. 判断是否支持可变参数
    if (debug_info.isvararg) {
        std::cout << "该函数接受可变参数" << std::endl;
    } else {
        std::cout << "该函数不接受可变参数" << std::endl;
    }

    lua_pop(L, 1); // 弹出之前压入的函数对象
    return 0;
}

关键逻辑说明 #

• 通过sol::function获取Lua侧定义的函数对象，再将其压入Lua栈，为调用debug库做准备
• lua_getinfo返回的lua_Debug结构体中：
  • nparams字段对应函数的固定参数数量
  • isvararg字段标记函数是否支持可变参数（即是否使用...语法）
• 循环调用lua_getlocal，传入从1开始的索引值，即可依次获取每个参数的名称，索引值就是参数在列表中的位置

注意事项 #

• 仅Lua侧定义的函数能通过这种方式获取参数名称；若为C++绑定到Lua的函数，debug库无法提取参数名（无调试信息暴露）
• debug库操作存在一定性能开销，不适合在高频执行的代码路径中使用

内容的提问来源于stack exchange，提问作者Dess