Lua的棧及基本棧操作
https://blog.csdn.net/mydriverc2/article/details/51134737
https://blog.csdn.net/mydriverc2/article/details/51134810
理解Lua棧
Lua通過一個“虛擬棧”與C/C++程序進行數據交互，所有的Lua C API都是通過操作這個棧來完成相應的數據通信。
Lua的這個“虛擬棧”解決了C/C++程序與Lua程序通信的兩大問題：
-
Lua使用垃圾回收，而C/C++需要手動管理內存。
-
Lua使用動態類型，而C/C++使用的是靜態類型。
因 為這個棧在Lua虛擬機內部，當一個Lua的變量放在棧里面的時候，虛擬機可以知道它有沒有被宿主程序所使用，從而決定是否采用GC。另外Lua采用結構 體封裝了類似“Lua_Value”的類型，讓它可以存儲任何C的類型。從而在數據交換的時候，任何類型都可以被放入棧的一個slot中。
由於棧是FILO的，所以，當我們在Lua里面操作這個棧的時候，每次操作的都是棧的頂部。而Lua的C API則有更多的控制權，它可以非常靈活地操縱這個棧的任意位置的元素。
基本Lua棧操作
-
往棧里面壓入一個值
|
1
2
3
4
5
6
7
|
void
lua_pushnil (lua_State *L);
void
lua_pushboolean (lua_State *L,
int
bool
);
void
lua_pushnumber (lua_State *L, lua_Number n);
void
lua_pushinteger (lua_State *L, lua_Integer n);
void
lua_pushunsigned (lua_State *L, lua_Unsigned n);
void
lua_pushlstring (lua_State *L,
const
char
*s,
size_t
len);
void
lua_pushstring (lua_State *L,
const
char
*s);
|
-
查詢棧里面的元素
|
1
|
int
lua_is* (lua_State * L,
int
index);
|
-
獲取棧內給定位置的元素值
|
1
|
xxx lua_toXXX(lua_State * L,
int
index);
|
這里面的xxx可以是nil, boolean, string,integer等等。
-
其它棧操作
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
//取得棧中元素個數
int
lua_gettop (lua_State *L);
//設置棧的大小為一個指定的值，而lua_settop(L,0)會把當前棧清空
//如果指定的index大於之前棧的大小，那么空余的空間會被nil填充
//如果index小於之前的棧中元素個數，則多余的元素會被丟棄
void
lua_settop (lua_State *L,
int
index);
//把棧中index所在位置的元素壓入棧
void
lua_pushvalue (lua_State *L,
int
index);
//移除棧中index所在位置的元素
void
lua_remove(lua_State *L,
int
index);
//在棧的頂部的元素移動至index處
void
lua_insert(lua_State *L,
int
index);
//從棧頂彈出一個值，並把它設置到給定的index處
void
lua_replace(lua_State *L,
int
index);
//把fromidx處的元素copy一份插入到toidx，這操作不會修改fromidx處的元素
void
lua_copy(lua_State *L,
int
fromidx,
int
toidx);
|
另外，根據《Programming In Lua》一書中的所講，我們可以定義一個函數stackDump來打印當前棧的情況：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
static
void
stackDump(lua_State* L){
cout<<
"\nbegin dump lua stack"
<<endl;
int
i = 0;
int
top = lua_gettop(L);
for
(i = 1; i <= top; ++i) {
int
t = lua_type(L, i);
switch
(t) {
case
LUA_TSTRING:
{
printf
(
"'%s' "
, lua_tostring(L, i));
}
break
;
case
LUA_TBOOLEAN:
{
printf
(lua_toboolean(L, i) ?
"true "
:
"false "
);
}
break
;
case
LUA_TNUMBER:
{
printf
(
"%g "
, lua_tonumber(L, i));
}
break
;
default
:
{
printf
(
"%s "
, lua_typename(L, t));
}
break
;
}
}
cout<<
"\nend dump lua stack"
<<endl;
}
|
C/C++訪問Lua的Table
假設我們的Lua文件中有一個Table為:
|
1
|
me = { name =
"zilongshanren"
, age = 27}
|
我們可以通過以下C代碼來訪問它的元素:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
//從Lua里面取得me這個table，並壓入棧
lua_getglobal(L,
"me"
);
if
(!lua_istable(L, -1)) {
CCLOG(
"error! me is not a table"
);
}
//往棧里面壓入一個key:name
lua_pushstring(L,
"name"
);
//取得-2位置的table，然后把棧頂元素彈出，取出table[name]的值並壓入棧
lua_gettable(L, -2);
//輸出棧頂的name
CCLOG(
"name = %s"
, lua_tostring(L, -1));
stackDump(L);
//把棧頂元素彈出去
lua_pop(L, 1);
//壓入另一個key:age
lua_pushstring(L,
"age"
);
//取出-2位置的table,把table[age]的值壓入棧
lua_gettable(L, -2);
stackDump(L);
CCLOG(
"age = %td"
, lua_tointeger(L, -1));
|
Lua5.1還引入了一個新方法：
|
1
|
lua_getfield(L, -1,
"age"
);
|
它可以取代：
|
1
2
3
4
|
//壓入另一個key:age
lua_pushstring(L,
"age"
);
//取出-2位置的table,把table[age]的值壓入棧
lua_gettable(L, -2);
|
下篇文章，我們將介紹Lua如何調用C/C++里面的函數。
本篇文章主要介紹C++和Lua相互傳遞數據。如果你還不知道怎么在C/C++里面調用Lua腳本的話，請參考這篇文章。本文主要介紹基本數據類型的傳遞，比如整型(int)，字符串(string)、數字(number)及bool值。
加載並運行Lua腳本
由於在上一個教程里面已經介紹過如何在C/C++里面嵌入Lua，所以這一節就簡單的介紹一下程序怎么用，配置就略過啦。
創建Lua虛擬機
|
1
|
lua_State *lua_state = luaL_newstate();
|
加載Lua庫
|
1
2
3
4
5
6
7
8
9
10
11
12
|
static
const
luaL_Reg lualibs[] =
{
{
"base"
, luaopen_base},
{
"io"
, luaopen_io},
{NULL, NULL}
};
const
luaL_Reg *lib = lualibs;
for
(; lib->func != NULL; lib++)
{
luaL_requiref(lua_state, lib->name, lib->func, 1);
lua_settop(lua_state, 0);
}
|
運行Lua腳本
|
1
2
3
4
5
6
7
8
9
10
11
12
|
std::string scriptPath = FileUtils::getInstance()->fullPathForFilename(
"hello.lua"
);
int
status = luaL_loadfile(lua_state, scriptPath.c_str());
std::cout <<
" return: "
<< status << std::endl;
int
result = 0;
if
(status == LUA_OK)
{
result = lua_pcall(lua_state, 0, LUA_MULTRET, 0);
}
else
{
std::cout <<
" Could not load the script."
<< std::endl;
}
|
這里我們使用的是luaL_loadfile而不是之前的luaL_dofile，其實luaL_dofile只是一個宏定義：
|
1
2
|
#define luaL_dofile(L, fn) \
(luaL_loadfile(L, fn) || lua_pcall(L, 0, LUA_MULTRET, 0))
|
我們先調用luaL_loadfile可以判斷Lua腳本是否加載成功，然后再調用lua_pcall來執行Lua腳本。
C/C++調用Lua函數
首先，我們在hello.lua里面定義一個Lua函數：
|
1
2
3
4
|
-- add two numbers
function add ( x, y )
return
x + y
end
|
Lua的函數定義是以function為keyword，然后以end結尾，同時它的參數是沒有形參類型的，另外，Lua的函數可以返回多個值。不過我們這里只返回了一個值。
接下來，讓我們看看如果在C++程序里面調用這個函數：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
int
luaAdd(lua_State *lua_state ,
int
x,
int
y)
{
int
sum;
//獲取lua里面的add函數並把它放到lua的棧頂
lua_getglobal(lua_state,
"add"
);
//往lua棧里面壓入兩個參數
lua_pushnumber(lua_state, x);
lua_pushnumber(lua_state, y);
//調用lua函數,這里的2是參數的個數，1是返回值的個數
lua_call(lua_state, 2, 1);
//從棧頂讀取返回值,注意這里的參數是-1
sum = lua_tointeger(lua_state, -1);
//最后我們把返回值從棧頂拿掉
lua_pop(lua_state, 1);
return
sum;
}
|
然后，我們就可以在程序里面調用它了：
|
1
|
std::cout<<
"2 + 1= "
<< luaAdd(lua_state,4,1)<<std::endl;
|
注意，這個方法調用要在lua_pcall調用之后。
操作Lua全局變量
C++里面獲取Lua全局變量的值
首先，我們在hello.lua里面定義一個全局變量
|
1
|
myname =
"子龍山人"
|
然后我們在C++里面訪問它：
|
1
2
3
4
|
lua_getglobal(lua_state,
"myname"
);
std::string myname = lua_tostring(lua_state, -1);
lua_pop(lua_state, 1);
std::cout<<
"Hello: "
<<myname<<std::endl;
|
這一次我們又是通過lua_getglobal來把myname這個全局變量壓到lua棧，然后用lua_tostring來取這個值。
C++里面修改Lua全局變量的值
這次我們使用的是lua_setglobal來傳遞數據給Lua：
|
1
2
|
lua_pushstring(lua_state,
"World"
);
lua_setglobal(lua_state,
"myname"
);
|
這時，我們只要在hello.lua的最開始部分，調用print(myname)就可以打印傳遞進來的值了。
C++傳遞Table給Lua
|
1
2
3
4
5
6
7
8
9
10
|
lua_createtable(lua_state, 2, 0);
lua_pushnumber(lua_state, 1);
lua_pushnumber(lua_state, 49);
// lua_settable(lua_state, -3);
lua_rawset(lua_state, -3);
lua_pushnumber(lua_state, 2);
lua_pushstring(lua_state,
"Life is a beach"
);
// lua_settable(lua_state, -3);
lua_rawset(lua_state, -3);
lua_setglobal(lua_state,
"arg"
);
|
這里我們傳遞了一個table給lua，這個table為{49,"Life is a beach"}。Lua table的索引是從1開始的，然后我們在lua腳本里面可以這樣子來訪問這個table:
|
1
2
3
|
for
i=1,#arg
do
print(
" "
, i, arg[i])
end
|
這里的#arg是獲得table的長度，然后使用arg[i]來獲取table的索引i處的value。
Lua返回多個值給C++
首先是Lua代碼：
|
1
2
3
4
|
local temp = {9,
"hehehej"
}
-- temp[1]=9
-- temp[2]=
"See you space cowboy!"
return
temp,9,1
|
然后是C++代碼：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
std::stringstream str_buf;
while
(lua_gettop(lua_state))
{
str_buf.str(std::string());
str_buf <<
" "
;
switch
(lua_type(lua_state, lua_gettop(lua_state)))
{
case
LUA_TNUMBER:
str_buf <<
"script returned the number: "
<< lua_tonumber(lua_state, lua_gettop(lua_state));
break
;
case
LUA_TTABLE:
str_buf <<
"script returned a table"
;
break
;
case
LUA_TSTRING:
str_buf <<
"script returned the string: "
<< lua_tostring(lua_state, lua_gettop(lua_state));
break
;
case
LUA_TBOOLEAN:
str_buf <<
"script returned the boolean: "
<< lua_toboolean(lua_state, lua_gettop(lua_state));
break
;
default
:
str_buf <<
"script returned an unknown-type value"
;
}
lua_pop(lua_state, 1);
std::cout << str_buf.str() << std::endl;
}
|
最后輸出結果為:
|
1
2
3
4
5
|
[C++] Values returned from the script:
script returned the number: 1
script returned the number: 9
script returned a table
[C++] Closing the Lua state
|
在Lua里面return值的順序是table,9,1，而在C++里面是倒過來的。因為我們是使用棧作為數據結構來傳遞數據，而棧是先進后出的。
=========== End