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]

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350