# FFI #### 調用C函數 `ffi.C`使用默認的C標準庫命名空間，這使得我們可以簡單地調用C標準庫中的函數。同時，FFI庫還會自動檢測到`sdfcall`函數，所以我們也不用去聲明那些函數。當Lua中基本數值類型與被調用的C函數參數不一致時，FFI庫會自動完成數值類型的轉換。 > 我們來看一個調用FFI庫的示例 ~~~ local ffi = require("ffi") ffi.cdef[[ unsigned long compressBound(unsigned long sourceLen); int compress2(uint8_t *dest, unsigned long *destLen, const uint8_t *source, unsigned long sourceLen, int level); int uncompress(uint8_t *dest, unsigned long *destLen, const uint8_t *source, unsigned long sourceLen); ]] local zlib = ffi.load(ffi.os == "Windows" and "zlib1" or "z") local function compress(txt) local n = zlib.compressBound(#txt) local buf = ffi.new("uint8_t[?]", n) local buflen = ffi.new("unsigned long[1]", n) local res = zlib.compress2(buf, buflen, txt, #txt, 9) assert(res == 0) return ffi.string(buf, buflen[0]) end local function uncompress(comp, n) local buf = ffi.new("uint8_t[?]", n) local buflen = ffi.new("unsigned long[1]", n) local res = zlib.uncompress(buf, buflen, comp, #comp) assert(res == 0) return ffi.string(buf, buflen[0]) end -- Simple test code. local txt = string.rep("abcd", 1000) print("Uncompressed size: ", #txt) local c = compress(txt) print("Compressed size: ", #c) local txt2 = uncompress(c, #txt) assert(txt2 == txt) ~~~ 解釋一下這段代碼。 我們首先使用`ffi.cdef`聲明了一些被zlib庫提供的C函數。然后加載zlib共享庫，在Windows系統上，則需要我們手動從網上下載zlib1.dll文件，而在POSIX系統上libz庫一般都會被預安裝。因為`ffi.load`函數會自動填補前綴和后綴，所以我們簡單地使用z這個字母就可以加載了。我們檢查`ffi.os`，以確保我們傳遞給`ffi.load`函數正確的名字。 一開始，壓縮緩沖區的最大值被傳遞給`compressBound`函數，下一行代碼分配了一個要壓縮字符串長度的字節緩沖區。`[?]`意味著他是一個變長數組。它的實際長度由`ffi.new`函數的第二個參數指定。 我們仔細審視一下`compress2`函數的聲明就會發現，目標長度是用指針傳遞的！這是因為我們要傳遞進去緩沖區的最大值，并且得到緩沖區實際被使用的大小。 在C語言中，我們可以傳遞變量地址。但因為在Lua中并沒有地址相關的操作符，所以我們使用只有一個元素的數組來代替。我們先用最大緩沖區大小初始化這唯一一個元素，接下來就是很直觀地調用`zlib.compress2`函數了。使用`ffi.string`函數得到一個存儲著壓縮數據的Lua字符串，這個函數需要一個指向數據起始區的指針和實際長度。實際長度將會在`buflen`這個數組中返回。因為壓縮數據并不包括原始字符串的長度，所以我們要顯式地傳遞進去。 #### 使用C數據結構 userdata 類型用來將任意 C 數據保存在 Lua 變量中。這個類型相當于一塊原生的內存，除了賦值和相同性判斷，Lua 沒有為之預定義任何操作。 然而，通過使用 metatable （元表） ，程序員可以為 userdata自定義一組操作。 userdata 不能在 Lua 中創建出來，也不能在 Lua 中修改。這樣的操作只能通過 C API。這一點保證了宿主程序完全掌管其中的數據。 我們將C語言類型與 metamethod （元方法）關聯起來，這個操作只用做一次。`ffi.metatype`會返回一個該類型的構造函數。原始C類型也可以被用來創建數組，元方法會被自動地應用到每個元素。 尤其需要指出的是，metatable與C類型的關聯是永久的，而且不允許被修改，__index元方法也是。 > 下面是一個使用C數據結構的實例 ~~~ local ffi = require("ffi") ffi.cdef[[ typedef struct { double x, y; } point_t; ]] local point local mt = { __add = function(a, b) return point(a.x+b.x, a.y+b.y) end, __len = function(a) return math.sqrt(a.x*a.x + a.y*a.y) end, __index = { area = function(a) return a.x*a.x + a.y*a.y end, }, } point = ffi.metatype("point_t", mt) local a = point(3, 4) print(a.x, a.y) --> 3 4 print(#a) --> 5 print(a:area()) --> 25 local b = a + point(0.5, 8) print(#b) --> 12.5 ~~~ > 附表：Lua 與 C語言語法對應關系 | Idiom | C code | Lua code | |-----|-----|-----| | Pointer dereference | x = *p; | x = p[0] | | int *p; | *p = y; | p[0] = y | | Pointer indexing | x = p[i]; | x = p[i] | | int i, *p; | p[i+1] = y; | p[i+1] = y | | Array indexing | x = a[i]; | x = a[i] | | int i, a[]; | a[i+1] = y; | a[i+1] = y | | struct/union dereference | x = s.field; | x = s.field | | struct foo s; | s.field = y; | s.field = y | | struct/union pointer deref. | x = sp->field; | x = s.field | | struct foo *sp; | sp->field = y; | s.field = y | | int i, *p; | y = p - i; | y = p - i | | Pointer difference | x = p1 - p2; | x = p1 - p2 | | Array element pointer | x = &a[i]; | x = a+i |