從 C 呼叫 Lua 函式

故事是這樣子的，小弟在公司裡面，主要是負責維護一個沒人在用的產品，遠觀來說這個產品滿複雜的，內建兩種不同的演算法實作，為的是要應對不同的狀況，有些狀況用第一種演算法比較快，有些用第二種。
那故事是這樣子的，我們的程式裡面有一個函式會在每筆資料結束之後，用上筆資料的結果來判斷下一次要選哪個演算法，問題是這個函式目前是直接寫在整個引擎的 C code 裡面，於是如果想要改變一下判斷的標準……sorry 重新 build，雖然公司弄了套分散編譯可以編很快但還是要幾分鐘。
上星期自己試了一下，成功把 Lua 編到公司的 code 裡面，就能把判斷邏輯寫在 Lua script 裡面，要改判斷標準只要改 Lua 就可以了；我一般聽到會這樣用的是遊戲公司，因為遊戲一樣涉及大量的邏輯判斷，例如血要扣多少之類的，而遊戲又會大量的去變動這些參數，使得彈性變得非常重要，總不能要改參數就把整個遊戲引擎全部重建構一次……說是這麼說我也不曾證實哪家公司真的這麼做就是，如果我的讀者真的是這樣搞的麻煩留個言讓我知道一下。

總之自己試過之後其實非常簡單，難怪大家都說 Lua 最厲害的就是嵌入到 C 程式當 Sup 角 ，我主要是參考這個網頁（看來是舊金山大學 CS 的課程頁面）；下載 Lua 就從官網下載即可，哪一版應該是無所謂，或者是 Linux 的話安裝開發套件也 OK。
不愧是以輕量著稱的腳本語言，連 Makefile 看起來都是手寫的，直接下 Make 讓它編譯完成，雖然說我在這步被環境變數 TARGET_VAR 卡了很久，makefile 不知道為什麼自己把它加到編譯參數裡了。
再來做下面幾件事就能呼叫 Lua 函式了：

1. 引入 Lua 的標頭檔：

#include "lua.h"
#include "lualib.h"
#include "lauxlib.h"

然後在編譯的時候記得給一下 lua 標頭檔的位置，以及在連結的時候 -llua。

2. 生成 Lua state：

Lua 的 state 包含核心的函式，後面所有的函式都會需要這個 state；在 open 和 close 中間就能呼叫 Lua 函式了：

lua_State* L = luaL_newstate();
luaL_openlibs(L);
// write lua_call ... code here
lua_close(L);

3. 載入檔案，呼叫函式：

使用 luaL_dofile 打開 lua 檔案，等於是呼叫 lua 直譯器執行這個檔案，如果有直接執行的東西這時候就會有效果，像是 print("hello world") ，我們這裡只是定義變數 "add" 對應到相加的函式。
要呼叫 lua 函式，我們以函式 add 為例：

-- add.lua add function
add = function(a, b)
  return 42
end

那麼在 C 裡面就是：

luaL_dofile(L, "add.lua");
lua_getglobal(L, "add");
lua_pushnumber(L, a);
lua_pushnumber(L, b);
lua_call(L, 2, 1);  // 2 parameter, 1 return value
int sum = (int)lua_tointeger(L, -1);
lua_pop(L, 1)

簡單來說就是先用 lua_getglobal 拿到存在 global 裡面的函式 add（在 luaL_dofile 的時候建立的）；把參數推到堆疊上；執行 lua_call，指定兩個參數跟一個回傳值，取出回傳值，把回傳值彈出堆疊。
如果函式有多個回傳值的話，會依序放在堆疊的 -1, -2 … 上；lua_pop 也要彈出更多值；Lua 的有一系列的函式來把東西推到堆疊上/彈出堆疊，簡單的應用，通常就是 lua_pushinteger/lua_tointeger, lua_pushnumber/lua_tonumber 來推/彈整數跟浮點數到堆疊上，詳情請參考文件。

這裡只記錄最基礎的應用，實際上應該還有更複雜的應用，例如我要做決策的參數如果很多的時候該怎麼辦？或者其實我想要直接推一個 struct 進到 lua 是可以的嗎？
這兩個問題我目前都沒有答案，還有待研究，目前只知道 luajit 這個看起來好像停擺的專案有提供類似的東西，可以準備好 C 的 struct 來吃。
如果有大大們有答案的話麻煩教一下小弟，小弟現在很需要。

Rust 裡面那些 String 們

故事是這樣子的，最近把小弟自幹的編譯器加上 rust 的 llvm wrapper llvm-sys，經過一陣猛烈的攪動之後，自幹的編譯器終於可以 dump LLVM IR 了，雖然只會輸出一個空殼子…但有第一步總是好的。
不過小弟在綁定的時候遇到一個大問題，也就是 Rust 裡面的 String，到底怎麼會有這麼多種，因為寫的時候一直沒搞清楚，然後就會被編譯器噴上一臉的錯誤，覺得痛苦，於是決定來打篇整理文。
簡單來說，Rust 的 std 有四種 String，每個 String 都有動態記憶體模式跟沒有 size 資訊（不是 Sized）的靜態模式，他們是：

std::string::String <-> std::str
std::ffi:OsString <-> std::ffi::OsStr
std::path::PathBuf <-> std::path::Path
std::ffi::CString <-> std::ffi::CStr

還有一個比較少用，只能表示 ascii 128 字元組成的字串的 std::ascii::asciiExt，這裡就不介紹了。

一般的程式語言在數字型態通常都很固定，Rust 就很明確的分為 i8, i16, i32, i64 …，就偏偏字串是個大坑，因為從 ASCII 到 unicode，字串實在有太多分岐，儘管有 unicode 也不是到處適用。Rust 從設計上一開始就直接採用 utf-8 作為設計標準，原生的 String/str 就是 utf 8 字串。
可是呢，並不是所有作業系統都玩 utf8 這套，因此 Rust 有另一個使用 wtf8 的 OsString，wtf8 跟 utf8 的差異在於 wtf8 算是<格式比較差>的 utf8，會出現一些 utf8 不允許的位元組，偏偏規格沒有要求一定要完美格式，造成 windows 或 javascript 有時會出現這種格式不良的 wtf8 字串，因此 OsString ，跟專門用來表示路徑的 PathBuf 就是使用 wtf8。
有關 wtf8 請參考：https://simonsapin.github.io/wtf-8/

上面的字串都是在型態中記錄字串長度，結尾不會有 \0 字元，CString 則是最傳統的 null-terminated 字串，在呼叫 C 函式的時候，一定要用 CString 傳遞才行。
順帶一提，一般寫在 code 裡面的 let hello = "hello world" 的型態是 &'static str：生命週期為 static 的靜態字串。

知道了以上幾個區別之後，就來看看要怎麼使用它們：
String 最簡單，裡面一定要是 utf8，產生就是從 static str 產生，或者是 new 之後慢慢 push 進去：

let hello : String = String::from("hello");
let mut world : String = String::new();
world.push_str("world");
world.push('!');

OsString 是類似的，但只能從 String 轉過來（注意 String 的所有權會轉給 OsString），或者一樣 new 之後 push String 進去：

use std::ffi::{OsString, OsStr};
let oshello : OsString = OsString::from(hello);
let mut world : OsString = OsString::new();
world.push("world!");

PathBuf 其實就想成 OsString 就好，兩者也可以互相用 from 轉換：

use std::path::{PathBuf, Path};
let p1 : PathBuf = PathBuf::from(oshello)
let mut p2 = PathBuf::new();
p2.push("/dev");

上面說了，OsString 跟 PathBuf 用的是 wtf8，是 utf8 的超集，因此一般只能單向從 String 到 OsString，反向是不行的，呼叫 OsString::into_string() 得到的是 Result<String, OsString>，也就是有可能會轉失敗；或者就是用 into_lossy_string 把編碼不完整的地方變成 U+FFFD，utf8 的 replacement character。
PathBuf 則是沒有 into_string 可以用，只能先轉換成 OsString 再轉過去，我也不知道為什麼 core team 要這樣設計。

剩下的就是函式了，很有趣的是 String, OsString, PathBuf 都是動態容器，操作內容都要轉換到 str, OsStr, Path 上面去：
str 有操作字串用的 split_whitespace, starts_with 等等
OsStr 沒有任何特殊的函式XD。
Path 有很多對路徑的操作：is_absolute, parent, with_extension 等等，很多函式操作後都會得到 Path 或是 OsStr 讓你做接下來的操作。

CString 比較棘手一點，它要在 new 的時候代入 Vec<u8> （或者有實作 Into<Vec<u8>> 的型態）來建立 CString，new 會自動在後面加上 \0 ，因此這個 Vec 裡面不應該有 \0。
其實我覺得把 CString 想得 Vec<u8> 的另一種型態就好了，它本身也提供 into_bytes, as_bytes 等函式轉換成 Vec<u8> 的型態。
如果要從 String 跟 OsString 轉換過來的話，String 要用 as_bytes() 轉成 Vec<u8>，OsString 因為 unix 跟 windows 會有不同的 OsString 實作，不一定都能轉成 Vec<u8>，在 unix 要引入 std::os::unix::ffi::OsStrExt 就可以將 OsString 用 as_bytes() 轉成 Vec<u8>；Windows 則建議轉成 String 再轉成 bytes ，請參考這個網址。

用上了 CString，最重要的就是要交給外部的 C 函式去用，要用 as_ptr() 取出字串部分的 pointer，得到的就是 * u8 了，有必要的話再加上 as *const i8 轉型一下。
例如我要呼叫這個函式：

LLVMPrintModuleToFile (LLVMModuleRef M, const char *Filename, char **ErrorMessage)

這個函式，我的檔案名稱是一個 OsString：

use std::ffi::{CString, CStr};
use std::os::unix::ffi::OsStrExt;
llvm::core::LLVMPrintModuleToFile(
           self.module,
            path.as_bytes().as_ptr() as *const i8,
            ptr::null_mut());

看了這麼多，簡單整理一下大概是這樣：

老實說每次只要在 Rust 裡面弄到 Path 都會弄到懷疑人生……