鹅厂实习周记（三）之Lua 使用C函数生成的so动态链接库

Lua是可以调用C函数的，将c函数生成so库就可以动态链接进lua中调用啦。但是觉得坑还是挺多的。主要原因：

生成so的函数用的是C++，而不是C语言
对lua的源码进行过更改，在so库生成中就要使用自己后期更改过的lua源码

主要出的问题是在第二步的时候，因为直接在shell 中使用GCC进行编译会很麻烦，涉及到了链接和依赖，而且不同的lua之间生成的so库也是没法通用的。所以要去添加自己后来更改过的lua源码作为依赖的库。所以上面很多的原因让我最后选择了使用CMake去生成C语言的so库

编写需要在Lua中调用的C函数

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

lua_State *L;

extern "C" {
static int l_add(lua_State *L);
int luaopen_libadd(lua_State* L);
}

static int l_add(lua_State *L) {
  double num1 = luaL_checknumber(L, 1);
  double num2 = luaL_checknumber(L, 2);

  lua_pushnumber(L, num1 + num2);
  return 1;
}

static const struct luaL_Reg libadd[] = {
        {"myadd", l_add},
        {NULL, NULL}
};

extern int luaopen_libadd(lua_State *L) {
  luaL_newlib(L, libadd);
  return 1;
}

因为是用C++写的，所以如果是Lua调用C函数的话，需要给文件中的两个函数加上extern "C",而且LuaL_Reg类型的常量的名字和luaopen_xxx还有你生成的so库的名字要一样，否则lua调用C函数时会报找不到符号的错误。举个例子，我生成的so库叫libadd，所以我LuaL_Reg类型的常量的名字也应该叫libadd，而我的luaopen_xxx函数也应该改成luaopen_libadd。

构建CMake文件

先上代码

cmake_minimum_required(VERSION 2.8)
# 这里填写你项目的名称
project(testdemo)
# 我这里选择了debug模式进行编译
set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build type (default Debug)" FORCE)

#加入Lua的源码路径
set(SRC src)
set(LUA_SRC ${SRC})

set(LUA_LIB_SRC_FILES
    ${LUA_SRC}/lapi.cpp
    ${LUA_SRC}/lauxlib.cpp
    ${LUA_SRC}/lbaselib.cpp
    ${LUA_SRC}/lcode.cpp
    ${LUA_SRC}/lcorolib.cpp
    ${LUA_SRC}/lctype.cpp
    ${LUA_SRC}/ldblib.cpp
    ${LUA_SRC}/ldebug.cpp
    ${LUA_SRC}/ldo.cpp
    ${LUA_SRC}/ldump.cpp
    ${LUA_SRC}/lfunc.cpp
    ${LUA_SRC}/lgc.cpp
    ${LUA_SRC}/linit.cpp
    ${LUA_SRC}/liolib.cpp
    ${LUA_SRC}/llex.cpp
    ${LUA_SRC}/lmathlib.cpp
    ${LUA_SRC}/lmem.cpp
    ${LUA_SRC}/loadlib.cpp
    ${LUA_SRC}/lobject.cpp
    ${LUA_SRC}/loslib.cpp
    ${LUA_SRC}/lparser.cpp
    ${LUA_SRC}/lstate.cpp
    ${LUA_SRC}/lstring.cpp
    ${LUA_SRC}/lstrlib.cpp
    ${LUA_SRC}/ltable.cpp
    ${LUA_SRC}/ltablib.cpp
    ${LUA_SRC}/ltm.cpp
    ${LUA_SRC}/lundump.cpp
    ${LUA_SRC}/lutf8lib.cpp
    ${LUA_SRC}/lvm.cpp
    ${LUA_SRC}/lzio.cpp
    ${LUA_SRC}/lgcthread.cpp

)
#将前面添加的lua源码文件生成静态库-libluapp
add_library(liblua STATIC
    ${LUA_LIB_SRC_FILES})

set_target_properties(liblua
    PROPERTIES OUTPUT_NAME lua)
#libadd文件生成so库，并加入libadd在编译时需要依赖的lua源码的静态库
#add是静态库名字的一部分，生成的so库文件会被CMake直接加上lib，也就是生成的so文件的名字叫libadd.so
add_library (add SHARED libadd.cpp)
target_link_libraries (add liblua)

在生成动态库是要用到add_library，其实设置的SHARED是生成动态库的标志（不同的系统生成的不一样，UNIX、Android是so，MACOSX是生成dylib，Windows是生成dll），如果设置成STATIC就是生成静态库的标志，MODULE是生成so库（不论什么系统都是so库），但是官方给的说明是不能进行链接使用的，但是由于我是MACOSX系统，所以用SHARED参数时会生成dylib，虽然可以在lua中成功链接使用，可是仍然想生成so库，所以我把SHARED改成了MODULE，生成的so库其实也是可以作为链接库调用的。

编写链接so库的lua代码

package.cpath = package.cpath .. "./?.so"  -- 如果你生成的是dylib文件，那么so要换成dylib
print(package.cpath)
local mylib = require "libadd"
local result =  mylib.myadd(2,1)
print("C func add : " .. result)

因为lua寻找库的时候是通过package.cpath里面的路径进行遍历的，所以要确定自己的库在路径中。

最后在terminal里面将路径切换到CMakeList.txt所在的文件夹下面，键入

cmake

因为我的terminal目前所在的目录在CMakeList文件所在文件夹的一个子文件夹，所以我在执行cmake指令时需要在cmake后面加上我CMakeList 所在文件夹的目录（即当前目录的上层目录 -> ../）

cmake ../

cmake执行完成，并且没有报错后，再执行 make指令，直接在terminal中输入make就可以,就算cmake后生成的MakeFile不在terminal所在的当前目录下面，也是只输入make指令。

make

因为这是一篇踩坑文，所以具体的方法的含义我就不详述了，网上很多方法定义的详述文章。大家可以自行搜索。