【走进Lua的世界之二】实战解析Lua和C++的通信

这篇文章将用实战来解析上一篇的场景：C++如何从Lua中获取一个全局变量的字符串。

1. 引入头文件

创建一个类，名为“HelloLua”，头文件如下：

extern "C"
{
#include<lua.h>
#include<lualib.h>
#include<luaxlib.h>
}

class HelloLua:public CCLayer
{
   CREATE_FUNC(HelloLua);
   virtual bool init();
   static CCScene* scene();
}

Lua是C语言库，所以在C++中使用必须用extern "C"声明，让编译器知道。因为cocos2d-x本来就支持Lua，所以我们就不用引入Lua的库了。

2. 开始使用

在cpp文件中添加如下代码：

#include "HelloLua.h"
CCScene* HelloLua::scene()
{
   CCScene* scene=CCScene::create();
   CCLayer* layer=CCLayer::create();
   scene->addChild(layer);
   return scene;
}

bool HelloLua::init()
{
   lua_State* pL=lua_open();
   luaopen_base(pL);
   luaopen_math(pL);
   luaopen_string(pL);

   /* 1.执行lua脚本，返回0代表成功 */
   /* 2.重置栈顶索引 */
   /* 3.判断栈顶的值的类型是否为String，返回非0值代表成功 */
   /* 4.获取栈顶的值 */

   lua_close(pL);
   return true;
}

要使用lua，首先得有一个lua_State。每一个运行的脚本文件都在一个动态分配的叫做lua_State的数据结构中运行。我们可以简单理解为：把lua_State当成一个lua的身体，lua在做任何事情的时候都不能没有身体。

luaopen_base(pL)，luaopen(pL)，luaopen_string(pL)，lua有一些标准库，要使用这些库，就要用luaopen_*去加载这些库。

lua_close(pL)用来释放内存。

3. 执行lua脚本

现在我们来一步步的完善我们的代码。

bool HelloLua::init()
{
   lua_State* pL=lua_open();
   luaopen_base(pL);
   luaopen_math(pL);
   luaopen_string(pL);

   /* 1.执行lua脚本，返回0代表成功 */
   int err=luaL_dofile(pL,"helloLua.lua");
   CCLOG("open: %d",err);

   /* 2.重置栈顶索引 */
   /* 3.判断栈顶的值的类型是否为String，返回非0值代表成功 */
   /* 4.获取栈顶的值 */

   lua_close(pL);
   return true;
}

我们还要新建一个lua文件，跟第一篇一样，只要新建一个文本文件，把后缀名改为lua就可以了。在项目的resources目录下新建一个helloLua.lua文件，添加如下代码：

-- helloLua.lua 文件
myName="beautiful girl"

此时，lua文件创建完成了，我们只要在C++中调用luaL_dofile就能执行lua脚本了。要注意的是，必须把lua_State也作为参数传给luaL_dofile，因为身体不能少。

4. 重置栈顶索引，将全局变量放到堆栈中

添加步骤2的代码：

bool HelloLua::init()
{
   lua_State* pL=lua_open();
   luaopen_base(pL);
   luaopen_math(pL);
   luaopen_string(pL);

   /* 1.执行lua脚本，返回0代表成功 */
   int err=luaL_dofile(pL,"helloLua.lua");
   CCLOG("open: %d",err);

   /* 2.重置栈顶索引 */
   lua_settop(pL,0);
   lua_getglobal(pL,"myName");

   /* 3.判断栈顶的值的类型是否为String，返回非0值代表成功 */
   /* 4.获取栈顶的值 */

   lua_close(pL);
   return true;
}

lua_settop(pL,0)是为了确认让栈顶的索引值为0，因为我们操作栈时是根据索引来操作的。置0之后，我们入栈的第一个元素的索引就是1。

lua_getglobal(pL,"myName")能实现一个过程：把myName放到栈中，然后lua会通过myName去全局表中寻找，找到myName对应的字符串"beautiful girl"，再放到栈中。

5. 最后一步：C++取得字符串

现在让我们来看看完整的代码：

bool HelloLua::init()
{
   lua_State* pL=lua_open();
   luaopen_base(pL);
   luaopen_math(pL);
   luaopen_string(pL);

   /* 1.执行lua脚本，返回0代表成功 */
   int err=luaL_dofile(pL,"helloLua.lua");
   CCLOG("open: %d",err);

   /* 2.重置栈顶索引 */
   lua_settop(pL,0);
   lua_getglobal(pL,"myName");

   /* 3.判断栈顶的值的类型是否为String，返回非0值代表成功 */
   int isstr=lua_isstring(pL,1);
   CCLOG("isstr= %d",isstr);

   /* 4.获取栈顶的值 */
   if(isstr!=0)
   {
      const char* str=lua_tostring(pL,1);
      CCLOG("getStr= %s",str);
   }
   
   lua_close(pL);
   return true;
}

lua_getglobal已经完成了很多工作了，现在堆栈上就放着“buatiful girl”字符串，我们只要去取就可以了。

获取堆栈的值有很多种方法，分别对应不同的变量类型：lua_toboolean、lua_toNumber、lua_tocfunction、lua_tostring。

最后别忘了在AppDelegate.cpp中将默认启动场景设为我们的HelloLua场景：

pDirector->runWithScene(HelloLua::scene());

用调试模式运行项目，可以看到如下日志：

open:0
isstr=1
getStr=beautiful girl

lua还提供了很多函数供我们判断堆栈中的变量类型，比如lua_isstring、lua_isnumber等等，与lua_tostring等函数是对应的。返回非0值表示类型正确。

一般在取值前都要判断一下，不然程序很可能意外崩溃。

另外，用lua_pop(pL,1)可以清除指定堆栈上的数据。