Lua棧

要理解Lua和C++交互，首先要理解Lua堆棧。簡單來講，Lua和C/C++語言通訊的主要方法是一個無處不在的虛擬棧。棧的特色是先進後出數組

在Lua中，Lua堆棧就是一個struct，堆棧索引的方式但是是正數也能夠是負數，區別是：正數索引1永遠表示棧底，負數索引-1永遠表示棧頂,如圖： markdown

入棧的數據類型包括數值, 字符串, 指針, talbe, 閉包等, 下面是一個棧的例子: 數據結構

執行下面的代碼就可讓你的lua棧上呈現圖中的狀況:閉包

// 建立並壓入一個閉包
lua_pushcclosure(L, func, 0);

// 新建並壓入一個表
lua_createtable(L, 0, 0);

// 壓入一個數字
lua_pushnumber(L, 100);

// 壓入一個字符串
lua_pushstring(L, "hello，lua");
複製代碼

這裏要說明的是, 你壓入的類型有數值, 字符串, 表和閉包[在c中看來是不一樣類型的值], 可是最後都是統一用TValue這種數據結構來保存的,下面用圖簡單的說明一下這種數據結構: 函數

TValue結構對應於lua中的全部數據類型, 是一個{值, 類型} 結構,這就lua中動態類型的實現, 它把值和類型綁在一塊兒, 用tt記錄value的類型, value是一個聯合結構, 由Value定義, 能夠看到這個聯合有四個域, 先說明簡單的oop

p -- 能夠存一個指針, 其實是lua中的light userdata結構
n -- 全部的數值存在這裏, 不過是int , 仍是float
b -- Boolean值存在這裏, 注意, lua_pushinteger不是存在這裏, 而是存在n中, b只存布爾
gc -- 其餘諸如table, thread, closure,string須要內存管理垃圾回收的類型都存在這裏,gc是一個指針, 它能夠指向的類型由聯合體GCObject定義, 從圖中能夠看出, 有string, userdata, closure, table, proto, upvalue, thread

能夠的得出以下結論:學習

lua中, number, boolean, nil, light userdata四種類型的值是直接存在棧上元素裏的, 和垃圾回收無關.
lua中, string, table, closure, userdata, thread存在棧上元素裏的只是指針, 他們都會在生命週期結束後被垃圾回收.

堆棧的操做

由於Lua與C/C++是經過棧來通訊，咱們先來看一個最簡單的例子:ui

#include <stdio.h>
#include "../lua/lauxlib.h"

int main(int argc, const char *argv[]) {

    //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)) { //這裏的index也能夠是-2
        printf("[line:%d] lua_tostring(L, 1):%s\n", __LINE__, lua_tostring(L, 1));
    }
    if (lua_isnumber(L, 2)) { //這裏的index也能夠是-1
        printf("[line:%d] lua_tonumber(L, 2):%f\n", __LINE__, lua_tonumber(L, 2));
    }

    //4.關閉state
    lua_close(L);
    return 0;
}
複製代碼

其餘一些棧操做：this

//返回棧頂索引（即棧長度） 
int lua_gettop (lua_State *L); 

//將棧頂設置爲一個指定的位置，即修改棧中元素的數量。若是值比原棧頂高，則高的部分nil補足，若是值比原棧低，則原棧高出的部分捨棄。因此能夠用lua_settop(0)來清空棧
void lua_settop (lua_State *L, int idx); 

//新增一個元素到棧頂，值與index位置的值相同
void lua_pushvalue(lua_State *L, int idx);

//移除idx索引上的值，高於index的元素的索引將所有-1 
void lua_remove(lua_State *L, int idx); 

//把棧頂元素挪到index位置，原index位置的元素往棧頂移動
void lua_insert(lua_State *L, int idx); 

//把棧頂元素挪到index位置，並刪除原index位置的元素
void lua_replace (lua_State *L, int idx);
複製代碼

C調用Lua

如今有這樣一個hello.lua 文件：lua

str = "Hello, Lua !"
table = {name = "hans", id = 123456}

function add(x, y)
	return x + y
end
複製代碼

咱們寫一個main.c來讀取它：

#include <stdio.h>
#include "../lua/lauxlib.h"

lua_State *load_lua(char *filename) {
    lua_State *L = luaL_newstate();
    luaL_openlibs(L);

    //加載腳本並運行
    if (luaL_loadfile(L, filename) || lua_pcall(L, 0, 0, 0)) {
        printf("load Lua script failed: %s\n", lua_tostring(L, -1));
        return NULL;
    }

    return L;
}

int main(int argc, const char *argv[]) {

    char* lua_filename = "E:\\work\\luaJni\\resource\\test.lua";
    lua_State *L = load_lua(lua_filename);
    if (NULL == L) {
        return -1;
    }

    //讀取變量
    lua_getglobal(L, "str");
    printf("[line:%d] luaV_tostring(L, -1):%s\n", __LINE__, lua_tostring(L, -1));

    //讀取table
    lua_getglobal(L, "table");
    lua_getfield(L, -1, "name");
    printf("[line:%d] lua_tostring(L,-1);:%s\n", __LINE__, lua_tostring(L, -1));

    //調用函數
    lua_getglobal(L, "add"); //讀取函數到棧頂
    lua_pushnumber(L, 10); //壓入參數
    lua_pushnumber(L, 20);

    if (lua_pcall(L, 2, 1, 0) != 0) {
        printf("lua_pcall failed: %s\n", lua_tostring(L, -1));
        return -1;
    }
    int result = lua_tonumber(L, -1);
    printf("[line:%d] result:%d\n", __LINE__, result);

    //至此，棧中的狀況是：
    //=================== 棧頂 ===================
    // 索引 類型 值
    // 4 int： 30
    // 3 string： hans
    // 2 table: table
    // 1 string: Hello, Lua !
    //=================== 棧底 ===================
    lua_close(L);
    return 0;
}
複製代碼

知道怎麼讀取後，咱們來看下如何修改上面代碼中table的值：

//將須要設置的值設置到棧中 
lua_pushstring(L, "Hello，hahaha");  
//將這個值設置到table中（此時table在棧的位置爲2） 
lua_setfield(L, 2, "name");
複製代碼

咱們還能夠新建一個table：

//建立一個新的table，並壓入棧 
lua_newtable(L);  
//往table中設置值 
lua_pushstring(L, "hello, new table !"); //將值壓入棧 
lua_setfield(L, -2, "str"); //將值設置到table中，並將hello, new table !出棧
複製代碼

須要注意的是：棧操做是基於棧頂的，就是說它只會去操做棧頂的值。舉個比較簡單的例子，函數調用流程是先將函數入棧，參數入棧，而後用lua_pcall調用函數，此時棧頂爲參數，棧底爲函數，因此棧過程大體會是：參數出棧->保存參數->函數出棧->調用函數->返回結果入棧

相似的還有lua_setfield，設置一個表的值，確定要先將值出棧，保存，再去找表的位置

Lua調用C

咱們能夠加入咱們本身的函數。函數要遵循規範（可在lua.h中查看）以下：

//全部的函數必須接收一個lua_State做爲參數，同時返回一個整數值。由於這個函數使用Lua棧做爲參數，因此它能夠從棧裏面讀取任意數量和任意類型的參數。而這個函數的返回值則表示函數返回時有多少返回值被壓入Lua棧
typedef int (*lua_CFunction) (lua_State *L);
複製代碼

--lua_call_c.lua
a, b = getTwoVar('hello, this string is from lua world', 123)
print(a, b)
複製代碼

/** * 定義在lua中可調用的函數，要遵循規範：返回值必須爲int，需傳入lua_State */
int getTwoVar(lua_State *L) {

    dumpStack(L);
    // =================== 棧頂 ===================
    // index type value
    // 2 number 123.000000
    // 1 string hello, this string is from lua world
    // =================== 棧底 ===================
    lua_pushnumber(L, 10);
    lua_pushstring(L, "hello");
    return 2;
}

void lua_call_c() {

    char* lua_filename = "E:\\work\\luaJni\\resource\\lua_call_c.lua";
    lua_State *L = load_lua(lua_filename, FALSE);
    if (NULL == L) {
        return;
    }
    lua_register(L, "getTwoVar", getTwoVar);
    lua_pcall(L, 0, 0, 0);
}
複製代碼

還能夠使用dll動態連接的方式，把c實現的代碼打包成dll h文件以下：

#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);//定義導出函數
複製代碼

C文件以下：

#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中咱們這樣子來調用（調用以前記得把dll文件複製到lua文件目錄下）：

require "mylib"  
local ave,sum = ss.average(1,2,3,4,5) -- 參數對應堆棧中的數據 
print(ave,sum)  -- 3 15 
ss.sayHello()   -- hello world!
複製代碼

至此都發生了什麼呢？梳理一下：

咱們編寫了averageFunc求平均值和sayHelloFunc函數
而後把函數封裝myLib數組裏面，類型必須是luaL_Reg
由luaopen_mLualib函數導出並在lua中註冊這兩個函數

實際上當咱們在Lua中：

require "mLualib"
複製代碼

這樣子寫的時候，Lua會這麼幹：

local path = "mLualib.dll"    
local f = package.loadlib(path,"luaopen_mLualib")   -- 返回luaopen_mLualib函數 
f() 
複製代碼

因此當咱們在編寫一個這樣的模塊的時候，編寫luaopen_xxx導出函數的時候，xxx最好是和項目名同樣

總結

Lua和C++是經過一個虛擬棧來交互的。
C調用Lua其實是：由C先把數據放入棧中，由Lua去棧中取數據，而後返回數據對應的值到棧頂，再由棧頂返回C
Lua調C也同樣：先編寫本身的C模塊，而後註冊函數到Lua解釋器中，而後由Lua去調用這個模塊的函數

本文不涉及lua語法學習，若是有須要，請移步：book.luaer.cn/

Lua和C交互的簡易教程

Lua棧

堆棧的操做

C調用Lua

Lua調用C

總結