【COCOS2DX-LUA 脚本开发之十一】C/C++与Lua之间进行数据函数交互

在使用Cocos2d-x 时候，难免需要C/C++调用Lua函数、数据或Lua调用C/C++函数，那么本篇讲详细介绍C/C++与Lua之间的数据、函数交互。

首先让我们来简单了解几个Lua API函数：

int   luaL_dofile (lua_State *L, const char *filename)  :

加载并运行指定文件,没有错误返回0

void  lua_settop (lua_State *L, int index)：

参数允许传入任何可接受的索引以及 0 。 它将把堆栈的栈顶设为这个索引。 如果新的栈顶比原来的大，超出部分的新元素将被填为 nil 。 如果 index 为 0 ，把栈上所有元素移除。

void   lua_getglobal (lua_State *L, const char *name)：

把全局变量 name 里的值压入堆栈。

void   lua_pop (lua_State *L, int n):

从堆栈中弹出 n 个元素。相当于清除!

void   lua_pushstring (lua_State *L, const char *s)：

把指针 s 指向的以零结尾的字符串压栈。 Lua 对这个字符串做一次内存拷贝（或是复用一个拷贝）， 因此 s 处的内存在函数返回后，可以释放掉或是重用于其它用途。 字符串中不能包含有零字符；第一个碰到的零字符会认为是字符串的结束。

更多的API请参考：http://www.codingnow.com/2000/download/lua_manual.html

了解了以上几个函数，为了方便童鞋们使用，Himi直接贴出封装好的类 HclcData，其中主要包括如下几个功能：

1. C/C++ 调用 Lua 全局变量

2. C/C++ 调用 Lua 全局Table 某元素

3. C/C++ 调用 Lua 全局Table

4. C/C++ 调用 Lua 函数

5. Lua 调用C/C++ 函数

下面直接贴出代码：HclcData.h

1. // 
2. //  HclcData.h 
3. //  CppLua 
4. // 
5. //  Created by Himi on 13-4-17. 
6. // 
7. // 
8.   
9. #ifndef __CppLua__HclcData__ 
10. #define __CppLua__HclcData__ 
11.   
12. #include "cocos2d.h" 
13. using namespace cocos2d; 
14. using namespace std; 
15.   
16. extern "C" { 
17. #include "lua.h" 
18. #include "lualib.h" 
19. #include "lauxlib.h" 
20. }; 
21.   
22. class HclcData{ 
23. public: 
24.     static HclcData* sharedHD(); 
25.   
26.         //------------  c++ -> lua ------------// 
27.   
28.     /* 
29.         getLuaVarString : 调用lua全局string 
30.   
31.         luaFileName  = lua文件名 
32.         varName = 所要取Lua中的变量名 
33.      */ 
34.     const char* getLuaVarString(const char* luaFileName,const char* varName); 
35.   
36.     /* 
37.      getLuaVarOneOfTable : 调用lua全局table中的一个元素 
38.   
39.      luaFileName  = lua文件名 
40.      varName = 所要取Lua中的table变量名 
41.      keyName = 所要取Lua中的table中某一个元素的Key 
42.      */ 
43.     const char* getLuaVarOneOfTable(const char* luaFileName,const char* varName,const char* keyName); 
44.   
45.     /* 
46.      getLuaVarTable : 调用lua全局table 
47.   
48.      luaFileName  = lua文件名 
49.      varName = 所要取的table变量名 
50.   
51.      （注：返回的是所有的数据，童鞋们可以自己使用Map等处理） 
52.      */ 
53.     const char* getLuaVarTable(const char* luaFileName,const char* varName); 
54.   
55.     /* 
56.      callLuaFunction : 调用lua函数 
57.   
58.      luaFileName  = lua文件名 
59.      functionName = 所要调用Lua中的的函数名 
60.      */ 
61.     const char* callLuaFunction(const char* luaFileName,const char* functionName); 
62.   
63.       //------------  lua -> c++ ------------// 
64.   
65.     void callCppFunction(const char* luaFileName); 
66.   
67. private: 
68.     static int cppFunction(lua_State* ls); 
69.   
70.     static bool _isFirst; 
71.     static HclcData* _shared; 
72.     const char* getFileFullPath(const char* fileName); 
73.     ~HclcData(); 
74. }; 
75.   
76. #endif /* defined(__CppLua__HclcData__) */ 

HclcData.cpp

1. // 
2. //  HclcData.cpp 
3. //  CppLua 
4. // 
5. //  Created by Himi on 13-4-17. 
6. // 
7. // 
8.   
9. #include "HclcData.h" 
10. #include "CCLuaEngine.h" 
11.   
12. bool HclcData::_isFirst; 
13. HclcData* HclcData::_shared; 
14.   
15. HclcData* HclcData::sharedHD(){ 
16.     if(!_isFirst){ 
17.         _shared = new HclcData(); 
18.     } 
19.     return _shared; 
20. } 
21.   
22. const char* HclcData::getLuaVarString(const char* luaFileName,const char* varName){ 
23.   
24.     lua_State*  ls = CCLuaEngine::defaultEngine()->getLuaStack()->getLuaState(); 
25.   
26.     int isOpen = luaL_dofile(ls, getFileFullPath(luaFileName)); 
27.     if(isOpen!=0){ 
28.         CCLOG("Open Lua Error: %i", isOpen); 
29.         return NULL; 
30.     } 
31.   
32.     lua_settop(ls, 0); 
33.     lua_getglobal(ls, varName); 
34.   
35.     int statesCode = lua_isstring(ls, 1); 
36.     if(statesCode!=1){ 
37.         CCLOG("Open Lua Error: %i", statesCode); 
38.         return NULL; 
39.     } 
40.   
41.     const char* str = lua_tostring(ls, 1); 
42.     lua_pop(ls, 1); 
43.   
44.     return str; 
45. } 
46.   
47. const char* HclcData::getLuaVarOneOfTable(const char* luaFileName,const char* varName,const char* keyName){ 
48.   
49.     lua_State*  ls = CCLuaEngine::defaultEngine()->getLuaStack()->getLuaState(); 
50.   
51.     int isOpen = luaL_dofile(ls, getFileFullPath(luaFileName)); 
52.     if(isOpen!=0){ 
53.         CCLOG("Open Lua Error: %i", isOpen); 
54.         return NULL; 
55.     } 
56.   
57.     lua_getglobal(ls, varName); 
58.   
59.     int statesCode = lua_istable(ls, -1); 
60.     if(statesCode!=1){ 
61.         CCLOG("Open Lua Error: %i", statesCode); 
62.         return NULL; 
63.     } 
64.   
65.     lua_pushstring(ls, keyName); 
66.     lua_gettable(ls, -2); 
67.     const char* valueString = lua_tostring(ls, -1); 
68.   
69.     lua_pop(ls, -1); 
70.   
71.     return valueString; 
72. } 
73.   
74. const char* HclcData::getLuaVarTable(const char* luaFileName,const char* varName){ 
75.     lua_State*  ls = CCLuaEngine::defaultEngine()->getLuaStack()->getLuaState(); 
76.   
77.     int isOpen = luaL_dofile(ls, getFileFullPath(luaFileName)); 
78.     if(isOpen!=0){ 
79.         CCLOG("Open Lua Error: %i", isOpen); 
80.         return NULL; 
81.     } 
82.   
83.     lua_getglobal(ls, varName); 
84.   
85.     int it = lua_gettop(ls); 
86.     lua_pushnil(ls); 
87.   
88.     string result=""; 
89.   
90.     while(lua_next(ls, it)) 
91.     { 
92.         string key = lua_tostring(ls, -2); 
93.         string value = lua_tostring(ls, -1); 
94.   
95.         result=result+key+":"+value+"\t"; 
96.   
97.         lua_pop(ls, 1); 
98.     } 
99.     lua_pop(ls, 1); 
100.   
101.     return result.c_str(); 
102. } 
103.   
104. const char* HclcData::callLuaFunction(const char* luaFileName,const char* functionName){ 
105.     lua_State*  ls = CCLuaEngine::defaultEngine()->getLuaStack()->getLuaState(); 
106.   
107.     int isOpen = luaL_dofile(ls, getFileFullPath(luaFileName)); 
108.     if(isOpen!=0){ 
109.         CCLOG("Open Lua Error: %i", isOpen); 
110.         return NULL; 
111.     } 
112.   
113.     lua_getglobal(ls, functionName); 
114.   
115.     lua_pushstring(ls, "Himi"); 
116.     lua_pushnumber(ls, 23); 
117.     lua_pushboolean(ls, true); 
118.   
119.     /* 
120.      lua_call 
121.      第一个参数:函数的参数个数 
122.      第二个参数:函数返回值个数 
123.      */ 
124.     lua_call(ls, 3, 1); 
125.   
126.     const char* iResult = lua_tostring(ls, -1); 
127.   
128.     return iResult; 
129. } 
130.   
131. void  HclcData::callCppFunction(const char* luaFileName){ 
132.   
133.     lua_State*  ls = CCLuaEngine::defaultEngine()->getLuaStack()->getLuaState(); 
134.   
135.     /* 
136.      Lua调用的C++的函数必须是静态的 
137.      */ 
138.     lua_register(ls, "cppFunction", cppFunction); 
139.   
140.     int isOpen = luaL_dofile(ls, getFileFullPath(luaFileName)); 
141.     if(isOpen!=0){ 
142.         CCLOG("Open Lua Error: %i", isOpen); 
143.         return; 
144.     } 
145. } 
146.   
147. int HclcData::cppFunction(lua_State* ls){ 
148.     int luaNum = (int)lua_tonumber(ls, 1); 
149.     int luaStr = (int)lua_tostring(ls, 2); 
150.     CCLOG("Lua调用cpp函数时传来的两个参数： %i  %s",luaNum,luaStr); 
151.   
152.     /* 
153.      返给Lua的值 
154.      */ 
155.     lua_pushnumber(ls, 321); 
156.     lua_pushstring(ls, "Himi"); 
157.   
158.     /* 
159.      返给Lua值个数 
160.      */ 
161.     return 2; 
162. } 
163.   
164. const char* HclcData::getFileFullPath(const char* fileName){ 
165.     return CCFileUtils::sharedFileUtils()->fullPathForFilename(fileName).c_str(); 
166. } 
167.   
168. HclcData::~HclcData(){ 
169.   
170.     CC_SAFE_DELETE(_shared); 
171.     _shared=NULL; 
172. } 

大家可以直接拿来用的，使用简单，测试如下：

首先C++测试代码：

1. #include "HclcData.h" 
2.   
3.     CCLOG("Str = %s",HclcData::sharedHD()->getLuaVarString("Test.lua","luaStr")); 
4.     CCLOG("Str2 %s",HclcData::sharedHD()->getLuaVarString("Test.lua","luaStr2")); 
5.     CCLOG("age = %s",HclcData::sharedHD()->getLuaVarOneOfTable("Test.lua", "luaTable","age")); 
6.     CCLOG("name = %s",HclcData::sharedHD()->getLuaVarOneOfTable("Test.lua", "luaTable","name")); 
7.     CCLOG("sex = %s",HclcData::sharedHD()->getLuaVarOneOfTable("Test.lua", "luaTable","sex")); 
8.     CCLOG("Table = %s",HclcData::sharedHD()->getLuaVarTable("Test.lua", "luaTable")); 
9.     CCLOG("Call Lua Function Back: %s",HclcData::sharedHD()->callLuaFunction("Test.lua", "luaLogString")); 
10.       
11.     HclcData::sharedHD()->callCppFunction("Test.lua"); 
12.     HclcData::sharedHD()->callLuaFunction("Test.lua", "call_Cpp"); 

对应测试的Test.Lua文件：

1. luaStr  = "I' m Himi" 
2.   
3. luaStr2 = "are you ok!" 
4.   
5. luaTable={age = 23,name="Himi",sex="男"} 
6.   
7. function luaLogString(_logStr,_logNum,_logBool) 
8.   
9.     print("Lua 脚本打印从C传来的字符串：",_logStr,_logNum,_logBool) 
10.     return "call lua function OK" 
11. end 
12.   
13. function call_Cpp(_logStr,_logNum,_logBool) 
14.     num,str = cppFunction(999,"I'm a lua string") 
15.     print("从cpp函数中获得两个返回值：",num,str) 
16. end 

运行测试结果如下：

1. Cocos2d: Str = I' m Himi 
2. Cocos2d: Str2 are you ok! 
3. Cocos2d: age = 23 
4. Cocos2d: name = Himi 
5. Cocos2d: sex = 男 
6. Cocos2d: Table = name:Himi  age:23  sex:男    
7. Lua 脚本打印从C传来的字符串：   Himi    23  true 
8. Cocos2d: Call Lua Function Back: call lua function OK 
9. Cocos2d: Lua调用cpp函数时传来的两个参数： 999  I'm a lua string 
10. 从cpp函数中获得两个返回值： 321 Himi 

在Himi做这些交互时出现了如下错误： 

1. “PANIC: unprotected error in call to Lua API (attempt to index a nil value) 

如下图:

最后Himi发现造成此问题的原因有两种：

1. 是你的lua文件位置路径！

      细心的童鞋应该看到，每次我使用 luaL_dofile 函数时传入的都是调用了一个getFileFullPath的函数进行获取文件的完整路径！

在HclcData中包装了一个函数：

1. const char* HclcData::getFileFullPath(const char* fileName){ 
2.     return CCFileUtils::sharedFileUtils()->fullPathForFilename(fileName).c_str(); 
3. } 

2. 如果你是cpp调用lua函数，那么你的这个lua函数不能是local的！

    反之，如果你lua调用cpp函数，同理，cpp函数肯定是static的！

另外，如果你cpp调用lua，等同于重新加载了这个lua文件，是不同的对象！因此你应该建立一个新的lua文件，主要用于交互所用！

     例如你a.lua中有一个tab的成员变量，那么你使用cpp调用lua函数后，这个tab是新的对象！

最后附上HclcData和Test.lua 下载地址：http://vdisk.weibo.com/s/y0zws

OK，本篇就到这里，有什么问题及时联系Himi！