C/C++调用Lua接口封装技巧

作为一个轻量级、高性能的脚本语言，Lua绝对是C/C++首选的脚本语言。但由于为了保证语言层面的灵活性，C/C++调用Lua传递参数是基于堆栈实现的，使得调用过程比较繁琐，这给C/C++开发者带来比较大的维护成本。

本文分享一种我个人在实践中掌握的一种封装技巧——实现调用Lua函数像调用本地函数一样简单的调用方法。

原文章地址

常规调用流程

double test(lua_State * L, double x, double y) {
    double z;
    lua_getglobal(L, "f");    // 获取lua函数f
    lua_pushnumber(L, x);    // 压入参数x和y
    lua_pushnumber(L, y);

    if(lua_pcall(L, 2, 1, 0) != 0)
        LOG(LERROR, ("error running function 'f': ", lua_tostring(L, -1)));

    if(!lua_isnumber(L, -1))
        LOG(LERROR, ("function 'f' must return a number"));
    z = lua_tonumber(L, -1);
    lua_pop(L, 1);
    return z;
}

正常的调用流程，每一个Lua接口都需要编写以上代码来实现与C/C++的对接，一旦接口多起来，就会难以维护。

改进方案

---

限制返回参数类型

为使接口更加简化，我们限制Lua函数返回类型只能有一个，对不同的返回类型分别封装不同的接口：
（对于返回复杂的数据类型，建议采用Json传递）

string callLuaFuncStr();
double callLuaFuncNum();

接口封装

使用C/C++可变参数，模仿print()的方式传参，保持Lua传参的灵活性。同时需要传入Lua函数名，最终的接口封装如下：

string callLuaFuncStr(const string funcName, const string argsFormat, ...);
double callLuaFuncNum(const string funcName, const string argsFormat, ...);

可变参数的实现

通过 setLuaFuncArgs() 对传入的数据类型进行解析，并分别传递给Lua：

uint32_t LuaHelper::setLuaFuncArgs(const string argsFormat, va_list args) {
    uint32_t count = 0;
    const char *format = argsFormat.c_str();
    while (*format != '\0') {
        char type = *format;
        if (type == '%' && *(format + 1) != '\0') {
            type = *(format + 1);
            switch (type) {
            case 's': {
                const char *arg = va_arg(args, const char *);
                lua_pushstring(L, arg);
                break;
            }
            case 'd': {
                int arg = va_arg(args, int);
                lua_pushinteger(L, arg);
                break;
            }
            case 'f': {
                float arg = va_arg(args, double);
                lua_pushnumber(L, arg);
                break;
            }
            default:
                LOG(LERROR, ("type undefined!!!"));
                format++;
                continue;
            }
            count++;
        }
        format++;
    }
    return count;
}

通过函数名调用Lua接口：

// 返回String
string LuaHelper::callLuaFuncStr(const string funcName, const string argsFormat, ...) {
    lua_getglobal(L, funcName.c_str());

    va_list args;
    va_start(args, argsFormat);
    uint32_t count = setLuaFuncArgs(argsFormat, args);
    va_end(args);

    if(lua_pcall(L, count, 1, 0) != 0)
        LOG(LERROR, ("error running function '", funcName ,"': ", lua_tostring(L, -1)));

    if(!lua_isstring(L, -1))
        LOG(LERROR, ("function '", funcName ,"' must return a string"));

    string result = lua_tostring(L, -1);
    lua_pop(L, 1);
    return result;
}

// 返回double
double LuaHelper::callLuaFuncNum(const string funcName, const string argsFormat, ...) {
    lua_getglobal(L, funcName.c_str());

    va_list args;
    va_start(args, argsFormat);
    uint32_t count = setLuaFuncArgs(argsFormat, args);
    va_end(args);

    if(lua_pcall(L, count, 1, 0) != 0)
        LOG(LERROR, ("error running function '", funcName ,"': ", lua_tostring(L, -1)));

    if(!lua_isnumber(L, -1))
        LOG(LERROR, ("function '", funcName ,"' must return a number"));

    double result = lua_tonumber(L, -1);
    lua_pop(L, 1);
    return result;
}

使用示例

---

Lua:

function testLua(speak)
    print(speak)
    return "Hello Cpp!!"
end

C++:

string result = callLuaFuncStr("testLua", "%s", "Hello Lua!!");

---

参考
[1][https://blog.csdn.net/jackystudio/article/details/17523523]
[2][https://blog.csdn.net/arnozhang12/article/details/6848678]