在上一节中,讲述了如何产生一个lua的静态链接库,在这一节,将讲述简单使用lua5.1.lib的过程。
首先先建立一个新的win32 Console Application,在新工程里,为了美观,我将默认生成的文件夹删除,建立了include和src两个文件夹。在根目录下建立了三个文件夹:lib,script,include。
将上节生成的lua5.1.lib放入lib文件夹,将lua源码中的lauxlib.h,lua.h,luaconf.h,lualib.h拷贝到include文件夹。
在VS上,将根目录中include中的四个头文件加载到include中。在src中建立AMLua.h,AMLua.cpp,AMMain.cpp三个文件。
下面在项目属性页进行一些必要设置,包含依赖项,库路径等。
C/C++ -- General -- Additional Include Directories:..\include
Linker -- General -- Additional Library Directories:..\lib
Linker -- Input -- Additional Dependencies:lua5.1.lib
另外,检查C/C++ -- General -- Code Generation -- Runtime Library,是否与第一节编译时所记录的Multi-threaded Debug Dll(/MDd)相同,如果不同,请修改成相同的模式。
-----------------------------------------------分割线-----------------------------------------------
使用lua的配置以及好了,下面开始写代码试试。
首先写一个简单的脚本,在script文件夹中建立sample.lua,里边填上:
- <span style="font-size:18px;">function luaAdd(x, y)
- return x + y
- end</span>
(吐槽下,居然没有lua的模板,只好使用C++的)
在AMMain.cpp中填上以下代码:
- <span style="font-size:18px;">#include <iostream>
- extern "C"
- {
- #include "lua.h"
- #include "lualib.h"
- #include "lauxlib.h"
- };
- int main(int argc, char** argv)
- {
- // 初始化一个栈
- lua_State* L = luaL_newstate();
- // 加载lua库
- luaL_openlibs(L);
- // 加载lua文件
- luaL_dofile(L, "..\\script\\sample.lua");
- // 加载函数
- lua_getglobal(L, "luaAdd");
- // 传入参数
- lua_pushnumber(L, 20);
- lua_pushnumber(L, 40);
- // 调用函数,运行
- lua_pcall(L, 2, 1, 0);
- int nSum = 0;
- if(lua_isnumber(L, -1) == 1)
- {
- nSum = lua_tonumber(L, -1);
- }
- std::cout<< "The Sum:\t"<< nSum << std::endl;
- std::cout<< "please wait..." << std::endl;
- getchar();
- return 0;
- }</span>
运行查看结果:输出60;
下面对AMMain.cpp进行修改,对lua提供的函数进行简单封装:
- <span style="font-size:18px;">#include <iostream>
- extern "C"
- {
- #include "lua.h"
- #include "lualib.h"
- #include "lauxlib.h"
- };
- lua_State* L;
- int luaAdd(int x, int y);
- int main(int argc, char** argv)
- {
- // 初始化一个栈
- L = luaL_newstate();
- // 加载lua库
- luaL_openlibs(L);
- // 加载lua文件
- luaL_dofile(L, "..\\script\\sample.lua");
- int nSum = luaAdd(20, 60);
- std::cout<< "The Sum:\t"<< nSum << std::endl;
- std::cout<< "please wait..." << std::endl;
- getchar();
- return 0;
- }
- int luaAdd(int x, int y)
- {
- // 加载函数
- lua_getglobal(L, "luaAdd");
- // 传入参数
- lua_pushnumber(L, x);
- lua_pushnumber(L, y);
- // 调用函数,运行
- lua_pcall(L, 2, 1, 0);
- int nSum = 0;
- if(lua_isnumber(L, -1) == 1)
- {
- nSum = lua_tonumber(L, -1);
- }
- return nSum;
- }</span>
在本节展示了用在C++上调用lua脚本函数。在下一节,将介绍一个第三方库,我们现在C++上写函数,然后在lua中调用此函数,最后在C++中调用这个lua函数。(感觉挺绕的)
-------------------------------------------------------------------------------------------------------------------------
lua_call,和该函数相似的函数分别是lua_pcall和lua_cpcall.这些函数的目的就是让我们能够执行压入栈中的函数,该函数可能是lua中定义的函数,可能是C++重定义的函数,当然我们一般是用来执行lua中执行的函数,C++中定义的基本上可以直接调用的。函数原型:
void lua_call (lua_State *L, int nargs, int nresults);
L是执行环境,可以理解为当前栈,nargs参数个数,nresults返回值个数。lua_pcall和该函数区别是多一个参数,用于发生错误处理时的代码返回。
void lua_pcall(lua_State *L,int nargs, int nresults,int nerrfunc);lua_cpcall则又多一个用于传递用户自定义的数据结构的指针
void lua_pcall(lua_State *L,int nargs, int nresults,int nerrfunc,void* ud)
对于函数的使用场景,在网上有一个网友的说明是这样的:
lua_call的运行是无保护的,他与lua_pcall相似,但是在错误发生的时候她抛出错误而不是返回错误代码。当你在应用程序中写主流程的代码时,不应该使用lua_call,因为你应该捕捉任何可能发生的错误。当你写一个函数的代码时,使用lua_call是比较好的想法,如果有错误发生,把错误留给关心她的人去处理.
结论: 写应用程序主流程代码用lua_pcall 写C Native Function代码时用lua_call,与之类似的还有luaL_checkxxx
下面是一个在文档中列举的一个例子:
The following example shows how the host program can do the equivalent to this Lua code:
a = f("how", t.x, 14)Here it is in C:
在上面的例子除了描述了lua_call的使用外,还对lua_getfield的使用有一定的参考价值。特别是学习如何在一个表中获取他的值。
- lua_getfield(L, LUA_GLOBALSINDEX, "f"); /* function to be called */
- lua_pushstring(L, "how"); /* 1st argument */
- lua_getfield(L, LUA_GLOBALSINDEX, "t"); /* table to be indexed */
- lua_getfield(L, -1, "x"); /* push result of t.x (2nd arg) */
- lua_remove(L, -2); /* remove 't' from the stack */
- lua_pushinteger(L, 14); /* 3rd argument */
- lua_call(L, 3, 1); /* call 'f' with 3 arguments and 1 result */
- lua_setfield(L, LUA_GLOBALSINDEX, "a"); /* set global 'a' */
在上面的例子中,可能再调用lua_getfield时就会忘记调用lua_remove,当然这是我想象自己使用时会犯下的错。lua_getfield函数功能是从指定表中取出指定元素的值并压栈。上面获取t.x的值的过程就是先调用lua_getfield(L, LUA_GLOBALSINDEX, "t"); 从全局表中获取t的值,然而t本身是一个表,现在栈顶的值是t表。于是再一次lua_getfield(L, -1, "x"); 从t中取出x的值放到栈上,-1表示栈顶。那该函数执行完成后t的位置由-1就变成-2了,所以下面一句lua_remove索引的是-2,必须把t给remove掉,否则栈中就是4个参数了。上面的最后一句lua_setfield的目的是把返回值取回赋给全局变量a,因为在lua_call执行完成后,栈顶的就是返回值了。