Lua和C++互動總結（很詳細）
阿新 • • 發佈：2019-02-06
一不小心又標題黨了？不好意思哈～
翻看了以前的部落格，發下廢話太多了自己都看不下去啊，恩，以後儘量寫得簡潔一些。
一.lua堆疊
要理解lua和c++互動，首先要理解lua堆疊。
簡單來說，Lua和C/c++語言通訊的主要方法是一個無處不在的虛擬棧。棧的特點是先進後出。
在lua中，lua堆疊就是一個struct，堆疊索引的方式可是是正數也可以是負數，區別是：正數索引1永遠表示棧底，負數索引-1永遠表示棧頂。如圖：
二.堆疊的操作
因為lua與c/c++是通過棧來通訊，lua提供了C API對棧進行操作。
我們先來看一個最簡單的例子：
#include <iostream> #include <string.h> using namespace std; extern "C" { #include "lua.h" #include "lauxlib.h" #include "lualib.h" } void main() { //1.建立一個state lua_State *L = luaL_newstate(); //2.入棧操作 lua_pushstring(L, "I am so cool~"); lua_pushnumber(L,20); //3.取值操作 if( lua_isstring(L,1)){ //判斷是否可以轉為string cout<<lua_tostring(L,1)<<endl; //轉為string並返回 } if( lua_isnumber(L,2)){ cout<<lua_tonumber(L,2)<<endl; } //4.關閉state lua_close(L); return ; }
可以簡單理解為luaL_newstate返回一個指向堆疊的指標，其它看註釋應該能懂了吧。
其他一些棧操作：
int lua_gettop (lua_State *L); //返回棧頂索引（即棧長度） void lua_settop (lua_State *L, int idx); // void lua_pushvalue (lua_State *L, int idx);//將idx索引上的值的副本壓入棧頂 void lua_remove (lua_State *L, int idx); //移除idx索引上的值 void lua_insert (lua_State *L, int idx); //彈出棧頂元素，並插入索引idx位置 void lua_replace (lua_State *L, int idx); //彈出棧頂元素，並替換索引idx位置的值
lua_settop將棧頂設定為一個指定的位置，即修改棧中元素的數量。如果值比原棧頂高，則高的部分nil補足，如果值比原棧低，則原棧高出的部分捨棄。
所以可以用lua_settop(0)來清空棧。三.c++呼叫lua
我們經常可以使用lua檔案來作配置檔案。類似ini，xml等檔案配置資訊。
現在我們來使用c++來讀取lua檔案中的變數，table，函式。
現在有這樣一個hello.lua 檔案：
我們寫一個test.cpp來讀取它：str = "I am so cool" tbl = {name = "shun", id = 20114442} function add(a,b) return a + b end
#include <iostream>
#include <string.h>
using namespace std;
extern "C"
{
#include "lua.h"
#include "lauxlib.h"
#include "lualib.h"
}
void main()
{
//1.建立Lua狀態
lua_State *L = luaL_newstate();
if (L == NULL)
{
return ;
}
//2.載入lua檔案
int bRet = luaL_loadfile(L,"hello.lua");
if(bRet)
{
cout<<"load file error"<<endl;
return ;
}
//3.執行lua檔案
bRet = lua_pcall(L,0,0,0);
if(bRet)
{
cout<<"pcall error"<<endl;
return ;
}
//4.讀取變數
lua_getglobal(L,"str");
string str = lua_tostring(L,-1);
cout<<"str = "<<str.c_str()<<endl; //str = I am so cool~
//5.讀取table
lua_getglobal(L,"tbl");
lua_getfield(L,-1,"name");
str = lua_tostring(L,-1);
cout<<"tbl:name = "<<str.c_str()<<endl; //tbl:name = shun
//6.讀取函式
lua_getglobal(L, "add"); // 獲取函式，壓入棧中
lua_pushnumber(L, 10); // 壓入第一個引數
lua_pushnumber(L, 20); // 壓入第二個引數
int iRet= lua_pcall(L, 2, 1, 0);// 呼叫函式，呼叫完成以後，會將返回值壓入棧中，2表示引數個數，1表示返回結果個數。
if (iRet) // 調用出錯
{
const char *pErrorMsg = lua_tostring(L, -1);
cout << pErrorMsg << endl;
lua_close(L);
return ;
}
if (lua_isnumber(L, -1)) //取值輸出
{
double fValue = lua_tonumber(L, -1);
cout << "Result is " << fValue << endl;
}
//至此，棧中的情況是：
//=================== 棧頂 ===================
// 索引 型別 值
// 4 int： 30
// 3 string： shun
// 2 table: tbl
// 1 string: I am so cool~
//=================== 棧底 ===================
//7.關閉state
lua_close(L);
return ;
}// 將需要設定的值設定到棧中
lua_pushstring(L, "我是一個大帥鍋～");
// 將這個值設定到table中（此時tbl在棧的位置為2）
lua_setfield(L, 2, "name");// 建立一個新的table，並壓入棧
lua_newtable(L);
// 往table中設定值
lua_pushstring(L, "Give me a girl friend !"); //將值壓入棧
lua_setfield(L, -2, "str"); //將值設定到table中，並將Give me a girl friend 出棧
舉個比較簡單的例子，函式呼叫流程是先將函式入棧，引數入棧，然後用lua_pcall呼叫函式，此時棧頂為引數，棧底為函式，所以棧過程大致會是：引數出棧->儲存引數->引數出棧->儲存引數->函數出棧->呼叫函式->返回結果入棧。
類似的還有lua_setfield，設定一個表的值，肯定要先將值出棧，儲存，再去找表的位置。
再不理解可看如下例子：
lua_getglobal(L, "add"); // 獲取函式，壓入棧中
lua_pushnumber(L, 10); // 壓入第一個引數
lua_pushnumber(L, 20); // 壓入第二個引數
int iRet= lua_pcall(L, 2, 1, 0);// 將2個引數出棧，函數出棧，壓入函式返回結果
lua_pushstring(L, "我是一個大帥鍋～"); //
lua_setfield(L, 2, "name"); // 會將"我是一個大帥鍋～"出棧另外補充一下：
lua_getglobal(L,"var")會執行兩步操作：1.將var放入棧中，2.由lua去尋找變數var的值，並將變數var的值返回棧頂（替換var）。
lua_getfield(L,-1,"name") 的作用等價於 lua_pushstring(L,"name") + lua_gettable(L,-2)
四.lua呼叫c++
我們分三個方法實現它。
方法一：直接將模組寫入lua原始碼中
編譯好後是這樣子的：（如圖）
然後我們可以在lua.c中加入我們自己的函式。函式要遵循規範（可在lua.h中檢視）如下：
typedef int (*lua_CFunction) (lua_State *L);然後我們在lua.c中加入如下函式：
// This is my function
static int getTwoVar(lua_State *L)
{
// 向函式棧中壓入2個值
lua_pushnumber(L, 10);
lua_pushstring(L,"hello");
return 2;
}//註冊函式
lua_pushcfunction(L, getTwoVar); //將函式放入棧中
lua_setglobal(L, "getTwoVar"); //設定lua全域性變數getTwoVar通過查詢lua.h
/#define lua_register(L,n,f) (lua_pushcfunction(L, (f)), lua_setglobal(L, (n)))我們發現之前的註冊函式可以這樣子寫：
lua_register(L,"getTwoVar",getTwoVar);
當然，一般我們不建議去修改別人的程式碼，更傾向於自己編寫獨立的c/c++模組，供lua呼叫，下面來講講如何實現。
方法二：使用靜態依賴的方式
1.新建一個空的win32控制檯工程，記得在vc++目錄中，把lua中的標頭檔案和lib檔案的目錄包含進來，然後->連結器->附加依賴項->將lua51.lib和lua5.1.lib也包含進來。
2.在目錄下新建一個avg.lua如下：
avg, sum = average(10, 20, 30, 40, 50)
print("The average is ", avg)
print("The sum is ", sum)#include <stdio.h>
extern "C" {
#include "lua.h"
#include "lualib.h"
#include "lauxlib.h"
}
/* 指向Lua直譯器的指標 */
lua_State* L;
static int average(lua_State *L)
{
/* 得到引數個數 */
int n = lua_gettop(L);
double sum = 0;
int i;
/* 迴圈求引數之和 */
for (i = 1; i <= n; i++)
{
/* 求和 */
sum += lua_tonumber(L, i);
}
/* 壓入平均值 */
lua_pushnumber(L, sum / n);
/* 壓入和 */
lua_pushnumber(L, sum);
/* 返回返回值的個數 */
return 2;
}
int main ( int argc, char *argv[] )
{
/* 初始化Lua */
L = lua_open();
/* 載入Lua基本庫 */
luaL_openlibs(L);
/* 註冊函式 */
lua_register(L, "average", average);
/* 執行指令碼 */
luaL_dofile(L, "avg.lua");
/* 清除Lua */
lua_close(L);
/* 暫停 */
printf( "Press enter to exit…" );
getchar();
return 0;
}
大概順序就是：我們在c++中寫一個模組函式，將函式註冊到lua直譯器中，然後由c++去執行我們的lua檔案，然後在lua中呼叫剛剛註冊的函式。
看上去很彆扭啊有木有。。。接下來介紹一下dll呼叫方式。
方法三：使用dll動態連結的方式
我們先新建一個dll工程，工程名為mLualib。（因此最後匯出的dll也為mLualib.dll）
然後編寫我們的c++模組，以函式為例，我們先新建一個.h檔案和.cpp檔案。
#pragma once
extern "C" {
#include "lua.h"
#include "lualib.h"
#include "lauxlib.h"
}
#ifdef LUA_EXPORTS
#define LUA_API __declspec(dllexport)
#else
#define LUA_API __declspec(dllimport)
#endif
extern "C" LUA_API int luaopen_mLualib(lua_State *L);//定義匯出函式.cpp檔案如下：
#include <stdio.h>
#include "mLualib.h"
static int averageFunc(lua_State *L)
{
int n = lua_gettop(L);
double sum = 0;
int i;
/* 迴圈求引數之和 */
for (i = 1; i <= n; i++)
sum += lua_tonumber(L, i);
lua_pushnumber(L, sum / n); //壓入平均值
lua_pushnumber(L, sum); //壓入和
return 2; //返回兩個結果
}
static int sayHelloFunc(lua_State* L)
{
printf("hello world!");
return 0;
}
static const struct luaL_Reg myLib[] =
{
{"average", averageFunc},
{"sayHello", sayHelloFunc},
{NULL, NULL} //陣列中最後一對必須是{NULL, NULL}，用來表示結束
};
int luaopen_mLualib(lua_State *L)
{
luaL_register(L, "ss", myLib);
return 1; // 把myLib表壓入了棧中，所以就需要返回1
}不理解沒關係，我們先編譯它，然後新建一個lua檔案，在lua中我們這樣子來呼叫：（呼叫之前記得把dll檔案複製到lua檔案目錄下）
require "mLualib"
local ave,sum = ss.average(1,2,3,4,5)//引數對應堆疊中的資料
print(ave,sum) -- 3 15
ss.sayHello() -- hello world!成功呼叫了有木有？我們看到了輸出資訊。（木有成功你留言，我教你！）
至此都發生了什麼呢？梳理一下：
1.我們編寫了averageFunc求平均值和sayHelloFunc函式，
2.然後把函式封裝myLib數組裡面，型別必須是luaL_Reg
3.由luaopen_mLualib函式匯出並在lua中註冊這兩個函式。
那麼為什麼要這樣子寫呢？實際上當我們在lua中：
require "mLualib"local path = "mLualib.dll"
local f = package.loadlib(path,"luaopen_mLualib") -- 返回luaopen_mLualib函式
f() -- 執行
所以當我們在編寫一個這樣的模組的時候，編寫luaopen_xxx匯出函式的時候，xxx最好是和專案名一樣（因為專案名和dll一樣）。
需要注意的是：函式引數裡的lua_State是私有的，每一個函式都有自己的棧。當一個c/c++函式把返回值壓入Lua棧以後，該棧會自動被清空。
五.總結
這篇文章花了好幾天才整理的，最後總結一下就是：
lua和c++是通過一個虛擬棧來互動的。
c++呼叫lua實際上是：由c++先把資料放入棧中，由lua去棧中取資料，然後返回資料對應的值到棧頂，再由棧頂返回c++。
lua調c++也一樣：先編寫自己的c模組，然後註冊函式到lua直譯器中，然後由lua去呼叫這個模組的函式。