【C & Lua】C调用Lua | Lua调用C
文章目录
-
- 前言
- Lua与C的基本交互
-
- C 调用 Lua
- Lua 调用 C
- Lua与C之间的数据类型转换
前言
Lua与C交互是一种非常常见的技术，它可以让我们在C语言中调用Lua脚本，也可以让我们在Lua脚本中调用C语言函数。这种交互方式可以使得我们在不同的编程语言之间实现混合编程，从而达到更高的灵活性和效率。
Lua栈是Lua与C交互的核心数据结构，所有的数据交互都是通过Lua栈来完成的。无论是从Lua中调用C函数，还是从C中调用Lua函数，都需要使用Lua栈来传递参数和返回值。
Lua与C的基本交互
Lua与C的基本交互是通过Lua提供的C API来实现的。C API是一组C语言函数，它们可以让我们在C语言中直接操作Lua对象，包括创建Lua对象、读取和修改Lua对象的值、执行Lua代码等。
lua.h
lua.h是 Lua 解释器的核心头文件，包含了 Lua 解释器的基本数据类型和函数原型。在使用 Lua 解释器时，必须包含该头文件。
常用的数据类型包括：
lua_State：Lua 解释器状态，用于保存 Lua 程序的运行状态和数据栈。lua_Number：Lua 的数字类型，可以是整数或者浮点数。lua_Integer：Lua 的整数类型，通常用于表示数组下标或者计数器。lua_CFunction：C 函数指针类型，用于定义 Lua 扩展函数。lua_XXX：其他常用数据类型，如字符串、表、函数等。
常用的函数原型包括：
lua_newstate：创建一个 Lua 解释器状态。lua_close：关闭一个 Lua 解释器状态。lua_load：将 Lua 代码加载到解释器中。lua_pcall：调用 Lua 函数并处理异常。lua_pushXXX：将数据压入 Lua 数据栈中。lua_toXXX：从 Lua 数据栈中取出数据。
lualib.h
lualib.h是 Lua 标准库的头文件，包含了一些常用的函数和库的函数原型。在使用 Lua 标准库时，必须包含该头文件。
常用的库包括：
lua_math：数学库，提供了常用的数学函数。lua_string：字符串库，提供了字符串操作函数。lua_table：表库，提供了表操作函数。lua_io：I/O 库，提供了文件和网络操作函数。lua_os：操作系统库，提供了系统调用函数。
常用的函数原型包括：
luaL_newlib：创建一个 Lua 标准库扩展。luaL_loadfile：加载一个 Lua 脚本文件。luaL_dofile：加载并执行一个 Lua 脚本文件。luaL_checkXXX：从 Lua 数据栈中取出数据并检查类型。luaL_optXXX：从 Lua 数据栈中取出可选参数并设置默认值。luaL_error：抛出一个 Lua 异常。
lauxlib.h
lauxlib.h 是 Lua 辅助库的头文件，包含了一些辅助函数和库的函数原型。在编写 Lua 扩展模块或者使用 Lua 辅助库时，必须包含该头文件。
常用的函数包括：
luaL_checkversion：检查 Lua 版本是否兼容。luaL_checkstack：检查 Lua 数据栈是否有足够的空间。luaL_newmetatable：创建一个新的元表。luaL_setmetatable：将元表设置到一个 Lua 对象上。luaL_ref：将 Lua 对象的引用压入数据栈并返回引用索引。luaL_unref：释放一个 Lua 对象的引用。luaL_loadbuffer：将 Lua 代码加载到解释器中。luaL_typename：获取 Lua 对象的类型名称。luaL_argerror：抛出一个参数错误异常。
更多更详细的C API可参考（http://www.lua.org/manual/5.4/）。
C 调用 Lua
简单示例：
makefile：
这里用的是luajit，如果是lua就等价换为 -llua。
CC=gcc
CFLAGS=-Wall -g
LDFLAGS=-lluajit-5.1 -lm
LDFLAGS += -L/usr/local/lib
.PHONY: all clean
all: main
main: main.c
$(CC) $(CFLAGS) $< -o $@ $(LDFLAGS)
clean:
rm -f *.o main
main.c：
#include test.lua：
function add(a, b)
return a + b
end
function sub(a, b)
return a - b
end
更复杂的案例：
- 忽略LuaBridge，用于C++和Lua交互的一个C++库。
- 注释详细写了当前栈中的状态。
#includeLua 调用 C
简单示例：
main.c：
#include test.lua：
local res = add(10, 5)
print(res)
更复杂的案例：
#include大部分情况下，我们还是用模块的方式来提供一组函数，我们在Lua中可以加载这个模块。
注释中有拓展一些知识点
main.cpp：
#include test.lua：
local mylib = require "mylib"
local add = mylib.add
local div = mylib.div
local concat = mylib.concat
local newpoint = mylib.newpoint
local getpoint = mylib.getpoint
local newlight = mylib.newlight
local getlight = mylib.getlight
--[[
-- 在lua中，每个函数调用都会创建一个新的栈帧，栈帧是一个独立的空间，用于存储改函数执行时需要的数据。
--]]
print(add(1, 2))
print(div(1, 2))
local s1 = "Hello"
local s2 = "World"
print(concat(s1, s2))
local x, y = 3, 4
local p = newpoint(x, y)
getpoint(p)
local p1 = newlight(x + 1, y - 1)
getlight(p1)
该段代码执行的makefile文件：
CC=g++
CFLAGS=-Wall -g
LDFLAGS=-shared -fPIC -lluajit-5.1 -lm
LDFLAGS += -L/usr/local/lib
TARGET=mylib.so
SRC=main.cpp
all: $(TARGET)
$(TARGET): $(SRC)
$(CC) $(CFLAGS) -o $@ $^ $(LDFLAGS)
clean:
rm -f $(TARGET)
拓README：(只是用于记录)
[ 编译.o 文件 ]
- g++ *.cpp -c -I../include -L../lib -llua
----
- -llua : [ 我在 ../lib 中用 *.o 生成了一个 lua.a ]
- liblua.a 在lib、include都有，不用自己生成
[ 生成静态库 .a ]
- ar rs *.a *.o
[ 生成动态库 .so ]
- g++ *.cpp -I../include -fPIC -shared -o *.so
Lua与C之间的数据类型转换
-
数字类型转换：Lua中的数字类型为lua_Number，它可以是double或long long等类型。在C语言中，我们可以使用lua_Number类型来表示Lua中的数字类型。
-
字符串类型转换：Lua中的字符串类型为const char*，在C语言中也是使用char*类型表示。在Lua中，字符串可以包含任意的二进制数据，因此在C语言中读取Lua字符串时需要进行一些特殊处理。
-
表类型转换：Lua中的表类型可以使用lua_newtable函数创建，然后使用lua_settable或lua_rawset函数向表中添加元素。在C语言中，我们可以使用lua_gettable或lua_rawget函数获取表中的元素。
-
函数类型转换：Lua中的函数类型可以通过lua_pushcfunction函数将一个C函数压入Lua栈中。在C语言中，我们可以通过lua_isfunction和lua_tocfunction函数判断和获取Lua栈中的函数。
Lua中的数据类型可以通过lua_State结构体来访问，而C中的数据类型可以通过特定的函数来进行访问。
Lua中的数据类型可以通过压栈和弹栈的方式来进行传递，而C中的数据类型则需要通过参数传递或返回值来进行传递。
常见的数据类型转换方法：
- 将Lua中的整数转换为C中的整数
int lua_tointeger(lua_State *L, int index); //将指定位置的栈值转换为整数
long lua_tointegerx(lua_State *L, int index, int *isnum); //将指定位置的栈值转换为长整数
- 将Lua中的浮点数转换为C中的浮点数
double lua_tonumber(lua_State *L, int index); //将指定位置的栈值转换为浮点数
double lua_tonumberx(lua_State *L, int index, int *isnum); //将指定位置的栈值转换为浮点数
- 将Lua中的字符串转换为C中的字符串
const char *lua_tostring(lua_State *L, int index); //将指定位置的栈值转换为字符串
size_t lua_strlen(lua_State *L, int index); //获取指定位置的栈值的长度
- 将C中的整数转换为Lua中的整数
void lua_pushinteger(lua_State *L, lua_Integer n); //将整数压入栈中
- 将C中的浮点数转换为Lua中的浮点数
void lua_pushnumber(lua_State *L, lua_Number n); //将浮点数压入栈中
- 将C中的字符串转换为Lua中的字符串
void lua_pushstring(lua_State *L, const char *s); //将字符串压入栈中
- 将C中的指针转换为Lua中的light userdata
void lua_pushlightuserdata(lua_State *L, void *p); //将指针压入栈中
- 将Lua中的table转换为C中的数组或结构体
int lua_gettable(lua_State *L, int index); //从栈中获取指定位置的table，并将其压入栈中
int lua_getfield(lua_State *L, int index, const char *k); //从栈中获取指定位置的table的指定字段，并将其压入栈中
int lua_rawgeti(lua_State *L, int index, lua_Integer n); //从栈中获取指定位置的table的指定索引，并将其压入栈中
- 将C中的数组或结构体转换为Lua中的table
void lua_newtable(lua_State *L); //创建一个新的空table，并将其压入栈中
void lua_settable(lua_State *L, int index); //从栈中获取指定位置的table和key-value对，并将其设置到table中
void lua_setfield(lua_State *L, int index, const char *k); //从栈中获取指定位置的table和value，并将其设置到table的指定字段中
void lua_rawseti(lua_State *L, int index, lua_Integer n); //从栈中获取指定位置的table和value，并将其设置到table的指定索引中