Lua底层交互原理剖析

此篇文章就是为了探索究竟Lua底层是如何与C/C++，或者说是C#进行交互的。C/C++是如何调用Lua的变量和函数，Lua又是如何调用底层的代码。

准备环境

1.到官网上下载源码，此次试验我下载的是版本5.3.5

2.下载MingGW，自己可以网上下载，一方面是要编译C/C++代码，一方面用它自带的makefile对lua进行编译。

编写代码

1.Hello World代码

#include <iostream>
#include <stdio.h>
#include <cstdlib>
#include <lua.hpp>

int main()
{
	//Lua库中没有定义任何全局变量。它将所有的状态都保存在动态结构lua_State中，所有的C API都要求传入一个指向该结构的指针。
	//luaL_newstate函数用于创建一个新环境或状态,也就是所谓的lua虚拟机对象。
	lua_State* L = luaL_newstate();
	//将hello world 压入虚拟栈 
	lua_pushstring(L, "hello world");
	//将整数10压入虚拟栈
	lua_pushnumber(L, 10);
	if (lua_isnumber(L, -1) && lua_isstring(L, -2))
	{
		//虚拟栈对应位置的元素转换为对应类型 
		int num = lua_tonumber(L, -1);
		const char* str = lua_tostring(L, -2);
        lua_pop(L,2); // 出栈两个元素 
		printf("%d %s \n", num, str);
	}
	lua_close(L);
	system("pause");

	return 0;
}

Lua和C/C++相互调用方式主要是利用一个虚拟栈。虚拟栈结构本质还是一个struct，在lua_pushstring时，字符串压入栈底，lua_pushnumber继续入栈，如下图所示。堆栈索引的方式可是是正数也可以是负数，区别是：正数索引1永远表示栈底，负数索引-1永远表示栈顶。

2.C加载lua脚本，并调用变量

test.lua

width = 800;
height = 600;
people = {name = "YGH",age = 13,sex = true}

function f(x ,y)
  return x+y,x*y,x-y
end

function f2()
  local a, b = func(5,3); --调用C函数
  print("hello world")
  print(string.format("a=%d,b=%d", a, b))
end

 main.cpp

int main()
{
	int error;
	lua_State *L = luaL_newstate();
	luaL_openlibs(L);

	//加载test.lua文件 并进行编译
	error = luaL_loadfile(L, "test.lua") || lua_pcall(L, 0, 0, 0);
	if (error)
	{
		//如果test.lua文件发生错误，会将错误信息入栈，取出错误信息并输出
		fprintf(stderr, "%s", lua_tostring(L, -1));
		lua_pop(L, 1);
	}
	//将全局变量 width  height people分别 入栈
	lua_getglobal(L, "width");
	lua_getglobal(L, "height");

	// 按照固定索引取出对应的元素 ，此处应使用lua_is...函数进行判断，再取出
	int w = lua_tointeger(L, -3);
	int h = lua_tointeger(L, -2);

	printf("w=%d, h=%d \n", w, h);
	
	system("pause");
	return 0;
}

3.C与Lua互相调用函数

int CallFunc(lua_State *L, const char *key, int x, int y){
	//压入函数
	lua_getglobal(L, key);
	//压入参数 
	lua_pushnumber(L, x);
	lua_pushnumber(L, y);
	// 第二个参数是待调用函数的参数数量 第三个参数是 期望的返回结果数量 第四个参数是错误处理函数索引 
	//在获得结果之后 ，lua_pcall会先弹出栈中的函数 和 参数 然后将所得的结果按照返回顺序入栈
	if (lua_pcall(L, 2, 2, 0) != 0)
	{
		printf("function is error");
	}
	int result = lua_tonumber(L, -1); //获取存在栈顶的第一个返回结果 
	int result2 = lua_tonumber(L, -2); // 获取第二个返回结果
	printf("function result: result1=%d, result2=%d \n", result, result2);
	return result;
}

void CallFunc2(lua_State *L, const char *key)
{
	lua_getglobal(L, key);//压入函数
	if (lua_pcall(L, 0, 0, 0) != 0)
	{
		printf("error %s", lua_tostring(L, -1));
	}
}

static int TestFunc(lua_State* L)
{
	//从栈中获取函数的参数 
	int x = lua_tonumber(L, 1);
	int y = lua_tonumber(L, 2);
 
    //将函数的返回结果进行入栈 
	lua_pushnumber(L, x + y);
	lua_pushnumber(L, x - y);
	// 函数返回结果的数量
	return 2;
}

int main()
{
	int error;
	lua_State *L = luaL_newstate();
	luaL_openlibs(L);

	//加载test.lua文件 并进行编译
	error = luaL_loadfile(L, "test.lua") || lua_pcall(L, 0, 0, 0);
	if (error)
	{
		//如果test.lua文件发生错误，会将错误信息入栈，取出错误信息并输出
		fprintf(stderr, "%s", lua_tostring(L, -1));
		lua_pop(L, 1);
	}
  
	//C调用lua的函数
	printf("---------- C Call Lua Function ------------ \n");
	CallFunc(L, "f", 5, 3);
	//Lua调用C的函数
	printf("---------- Lua Call C Function ------------ \n");
	//将函数注册到Lua中 
	lua_pushcfunction(L, TestFunc);
	lua_setglobal(L, "func");
	CallFunc2(L, "f2");

	system("pause");
	return 0;
}

到这一步，其实C#与Lua的基本交互原理就已经讲述的差不多了，如果想更进一步的话，可以看看lua的源码，也许会更加精进。