Lua教程（十九）：C调用Lua

1. 基础：

    lua的一项重要用途就是作为一种配置语言。现在从一个简单的示例开始吧。
 

    --这里是用lua代码定义的窗口大小的配置信息
    width = 200
    height = 300
 

    下面是读取配置信息的c/c++代码：  

#include <stdio.h>
#include <string.h>
#include <lua.hpp>
#include <lauxlib.h>
#include <lualib.h>

void load(lua_state* l, const char* fname, int* w, int* h) {
    if (lual_loadfile(l,fname) || lua_pcall(l,0,0,0)) {
        printf("error msg is %s.\n",lua_tostring(l,-1));
        return;
    }
    lua_getglobal(l,"width");
    lua_getglobal(l,"height");
    if (!lua_isnumber(l,-2)) {
        printf("'width' should be a number\n" );
        return;
    }
    if (!lua_isnumber(l,-1)) {
        printf("'height' should be a number\n" );
        return;
    }
    *w = lua_tointeger(l,-2);
    *h = lua_tointeger(l,-1);
}

int main()
{
    lua_state* l = lual_newstate();
    int w,h;
    load(l,"d:/test.lua",&w,&h);
    printf("width = %d, height = %d\n",w,h);
    lua_close(l);
    return 0;
}

下面是针对新函数的解释：

    lua_getglobal是宏，其原型为：#define lua_getglobal(l,s)  lua_getfield(l, lua_globalsindex, (s))。

    每次调用这个宏的时候，都会将lua代码中与之相应的全局变量值压入栈中，第一次调用时将全局变量"width"的值压入栈中，之后再次调用时再将"height"的值也压入栈中。

    2. table操作：

    我们可以在c语言的代码中操作lua中的table数据，这是一个非常非常方便且实用的功能。这样不仅可以使lua代码的结构更加清晰，也可以在c语言代码中定义等同的结构体与之对应，从而大大提高代码的可读性。见如下代码：

#include <stdio.h>
#include <string.h>
#include <lua.hpp>
#include <lauxlib.h>
#include <lualib.h>

void load(lua_state* l) {

    if (lual_loadstring(l,"background = { r = 0.30, g = 0.10, b = 0 }")
        || lua_pcall(l,0,0,0)) {
        printf("error msg is %s.\n",lua_tostring(l,-1));
        return;
    }
    lua_getglobal(l,"background");
    if (!lua_istable(l,-1)) {
        printf("'background' is not a table.\n" );
        return;
    }
    lua_getfield(l,-1,"r");
    if (!lua_isnumber(l,-1)) {
        printf("invalid component in background color.\n");
        return;
    }
    int r = (int)(lua_tonumber(l,-1) * 255);
    lua_pop(l,1);
    lua_getfield(l,-1,"g");
    if (!lua_isnumber(l,-1)) {
        printf("invalid component in background color.\n");
        return;
    }
    int g = (int)(lua_tonumber(l,-1) * 255);
    lua_pop(l,1);

    lua_pushnumber(l,0.4);
    lua_setfield(l,-2,"b");

    lua_getfield(l,-1,"b");
    if (!lua_isnumber(l,-1)) {
        printf("invalid component in background color.\n");
        return;
    }
    int b = (int)(lua_tonumber(l,-1) * 255);
    printf("r = %d, g = %d, b = %d\n",r,g,b);
    lua_pop(l,1);
    lua_pop(l,1);
    return;
}

int main()
{
    lua_state* l = lual_newstate();
    load(l);
    lua_close(l);
    return 0;
}

void lua_getfield(lua_state *l, int idx, const char *k); 第二个参数是table变量在栈中的索引值，最后一个参数是table的键值，该函数执行成功后会将字段值压入栈中。

void lua_setfield(lua_state *l, int idx, const char *k); 第二个参数是table变量在栈中的索引值，最后一个参数是table的键名称，而字段值是通过上一条命令lua_pushnumber(l,0.4)压入到栈中的，该函数在执行成功后会将刚刚压入的字段值弹出栈。
   
下面的代码示例是在c语言代码中构造table对象，同时初始化table的字段值，最后再将table对象赋值给lua中的一个全局变量。

#include <stdio.h>
#include <string.h>
#include <lua.hpp>
#include <lauxlib.h>
#include <lualib.h>

void load(lua_state* l)
{
    lua_newtable(l);
    lua_pushnumber(l,0.3);
    lua_setfield(l,-2,"r");

    lua_pushnumber(l,0.1);
    lua_setfield(l,-2,"g");

    lua_pushnumber(l,0.4);
    lua_setfield(l,-2,"b");
    lua_setglobal(l,"background");

    lua_getglobal(l,"background");
    if (!lua_istable(l,-1)) {
        printf("'background' is not a table.\n" );
        return;
    }
    lua_getfield(l,-1,"r");
    if (!lua_isnumber(l,-1)) {
        printf("invalid component in background color.\n");
        return;
    }
    int r = (int)(lua_tonumber(l,-1) * 255);
    lua_pop(l,1);
    lua_getfield(l,-1,"g");
    if (!lua_isnumber(l,-1)) {
        printf("invalid component in background color.\n");
        return;
    }
    int g = (int)(lua_tonumber(l,-1) * 255);
    lua_pop(l,1);

    lua_getfield(l,-1,"b");
    if (!lua_isnumber(l,-1)) {
        printf("invalid component in background color.\n");
        return;
    }
    int b = (int)(lua_tonumber(l,-1) * 255);
    printf("r = %d, g = %d, b = %d\n",r,g,b);
    lua_pop(l,1);
    lua_pop(l,1);
    return;
}

int main()
{
    lua_state* l = lual_newstate();
    load(l);
    lua_close(l);
    return 0;
}

 上面的代码将输出和之前代码相同的结果。

    lua_newtable是宏，其原型为：#define lua_newtable(l) lua_createtable(l, 0, 0)。调用该宏后，lua会生成一个新的table对象并将其压入栈中。

    lua_setglobal是宏，其原型为：#define lua_setglobal(l,s) lua_setfield(l,lua_globalsindex,(s))。调用该宏后，lua会将当前栈顶的值赋值给第二个参数指定的全局变量名。该宏在执行成功后，会将刚刚赋值的值从栈顶弹出。

    3. 调用lua函数：

    调用函数的api也很简单。首先将待调用函数压入栈，再压入函数的参数，然后使用lua_pcall进行实际的调用，最后将调用结果从栈中弹出。见如下代码：
 

 #include <stdio.h>
#include <string.h>
#include <lua.hpp>
#include <lauxlib.h>
#include <lualib.h>

const char* lua_function_code = "function add(x,y) return x + y end";

void call_function(lua_state* l)
{
    //lual_dostring 等同于lual_loadstring() || lua_pcall()
    //注意：在能够调用lua函数之前必须执行lua脚本，否则在后面实际调用lua函数时会报错，
    //错误信息为:"attempt to call a nil value."
    if (lual_dostring(l,lua_function_code)) {
        printf("failed to run lua code.\n");
        return;
    }
    double x = 1.0, y = 2.3;
    lua_getglobal(l,"add");
    lua_pushnumber(l,x);
    lua_pushnumber(l,y);
    //下面的第二个参数表示带调用的lua函数存在两个参数。
    //第三个参数表示即使带调用的函数存在多个返回值，那么也只有一个在执行后会被压入栈中。
    //lua_pcall调用后，虚拟栈中的函数参数和函数名均被弹出。
    if (lua_pcall(l,2,1,0)) {
        printf("error is %s.\n",lua_tostring(l,-1));
        return;
    }
    //此时结果已经被压入栈中。
    if (!lua_isnumber(l,-1)) {
        printf("function 'add' must return a number.\n");
        return;
    }
    double ret = lua_tonumber(l,-1);
    lua_pop(l,-1); //弹出返回值。
    printf("the result of call function is %f.\n",ret);
}

int main()
{
    lua_state* l = lual_newstate();
    call_function(l);
    lua_close(l);
    return 0;
}