author : Kevin Lynx
需求
受WOW的影響，LUA越來越多地被應(yīng)用于游戲中。腳本被用于游戲中主要用于策劃編寫游戲規(guī)則相關(guān)。實(shí)際運(yùn)用中，
我們會(huì)將很多宿主語言函數(shù)綁定到LUA腳本中，使腳本可以更多地控制程序運(yùn)行。例如我們可以綁定NPCDialog之類的函數(shù)
到LUA中，然后策劃便可以在腳本里控制游戲中彈出的NPC對(duì)話框。
我們現(xiàn)在面臨這樣的需求：對(duì)于宿主程序而言，某些功能是不能阻塞程序邏輯的（對(duì)于游戲程序尤其如此），但是為
了方便策劃，我們又需要讓腳本看起來被阻塞了。用NPCDialog舉個(gè)例子，在腳本中有如下代碼 ：
ret = NPCDialog( "Hello bitch" )
if ret == OK then print("OK") end
對(duì)于策劃而言，NPCDialog應(yīng)該是阻塞的，除非玩家操作此對(duì)話框，點(diǎn)擊OK或者關(guān)閉，不然該函數(shù)不會(huì)返回。而對(duì)于
宿主程序C++而言，我們?nèi)绾螌?shí)現(xiàn)這個(gè)函數(shù)呢：
static int do_npc_dialog( lua_State *L )
{
const char *content = lua_tostring( L, -1 );
lua_pushnumber( ret );
return 1;
}
顯然，該函數(shù)不能阻塞，否則它會(huì)阻塞整個(gè)游戲線程，這對(duì)于服務(wù)器而言是不可行的。但是如果該函數(shù)立即返回，那
么它并沒有收集到玩家對(duì)于那個(gè)對(duì)話框的操作。
綜上，我們要做的是，讓腳本感覺某個(gè)操作阻塞，但事實(shí)上宿主程序并沒有阻塞。
事件機(jī)制
一個(gè)最簡單的實(shí)現(xiàn)（對(duì)于C程序員而言也許也是優(yōu)美的），就是使用事件機(jī)制。我們將對(duì)話框的操作結(jié)果作為一個(gè)事件。
腳本里事實(shí)上沒有哪個(gè)函數(shù)是阻塞的。為了處理一些“阻塞”函數(shù)的處理結(jié)果，腳本向宿主程序注冊(cè)事件處理器（同GUI事件
處理其實(shí)是一樣的），例如腳本可以這樣：
function onEvent( ret )
if ret == OK then print("OK") end
end
-- register event handler
SetEventHandler( "onEvent" )
NPCDialog("Hello bitch")
宿主程序保存事件處理器onEvent函數(shù)名，當(dāng)玩家操作了對(duì)話框后，宿主程序回調(diào)腳本中的onEvent，完成操作。
事實(shí)上我相信有很多人確實(shí)是這么做的。這樣做其實(shí)就是把一個(gè)順序執(zhí)行的代碼流，分成了很多塊。但是對(duì)于sleep
這樣的腳本調(diào)用呢？例如：
--do job A
sleep(10)
--do job B
sleep(10)
--do job C
那么采用事件機(jī)制將可能會(huì)把代碼分解為：
function onJobA
--do job A
SetEventHandlerB("onJobB")
sleep(10)
end
function onJobB
--do job B
SetEventHandlerC("onJobC")
end
function onJobC
--do job C
end
-- script starts here
SetEventHandlerA( "onJobA" )
sleep(10)
代碼看起來似乎有點(diǎn)難看了，最重要的是它不易編寫，策劃估計(jì)會(huì)抓狂的。我想，對(duì)于非專業(yè)程序員而言，程序的
順序執(zhí)行可能理解起來更為容易。
SOLVE IT
我們的解決方案，其實(shí)只有一句話：當(dāng)腳本執(zhí)行到阻塞操作時(shí)（如NPCDialog），掛起腳本，當(dāng)宿主程序某個(gè)操作完
成時(shí)，讓腳本從之前的掛起點(diǎn)繼續(xù)執(zhí)行。
這不是一種假想的功能。我在剛開始實(shí)現(xiàn)這個(gè)功能之前，以為LUA不支持這個(gè)功能。我臆想著如下的操作：
腳本：
ret = NPCDialog("Hello bitch")
if ret == 0 then print("OK") end
宿主程序：
static int do_npc_dialog( lua_State *L )
{
lua_suspend_script( L );
}
某個(gè)地方某個(gè)操作完成了：
lua_resume_script( L );
當(dāng)我實(shí)現(xiàn)了這個(gè)功能后，我猛然發(fā)現(xiàn)，實(shí)際情況和我這里想的差不多（有點(diǎn)汗顏）。
認(rèn)識(shí)Coroutine
coroutine是LUA中類似線程的東西，但是它其實(shí)和fiber更相似。也就是說，它是一種非搶占式的線程，它的切換取決
于任務(wù)本身，也就是取決你，你決定它們什么時(shí)候發(fā)生切換。建議你閱讀lua manual了解更多。
coroutine支持的典型操作有：lua_yield, lua_resume，也就是我們需要的掛起和繼續(xù)執(zhí)行。
lua_State似乎就是一個(gè)coroutine，或者按照LUA文檔中的另一種說法，就是一個(gè)thread。我這里之所以用’似乎‘是
因?yàn)槲易约阂矡o法確定，我只能說，lua_State看起來就是一個(gè)coroutine。
LUA提供lua_newthread用于手工創(chuàng)建一個(gè)coroutine，然后將新創(chuàng)建的coroutine放置于堆棧頂，如同其他new出來的
對(duì)象一樣。網(wǎng)上有帖子說lua_newthread創(chuàng)建的東西與腳本里調(diào)用coroutine.create創(chuàng)建出來的東西不一樣，但是根據(jù)我
的觀察來看，他們是一樣的。lua_newthread返回一個(gè)lua_State對(duì)象，所以從這里可以看出，“lua_State看起來就是一個(gè)
coroutine”。另外，網(wǎng)上也有人說創(chuàng)建新的coroutine代價(jià)很大，但是，一個(gè)lua_State的代價(jià)能有多大？當(dāng)然，我沒做過
測(cè)試，不敢多言。
lua_yield用于掛起一個(gè)coroutine，不過該函數(shù)只能用于coroutine內(nèi)部，看看它的參數(shù)就知道了。
lua_resume用于啟動(dòng)一個(gè)coroutine，它可以用于coroutine沒有運(yùn)行時(shí)啟動(dòng)之，也可以用于coroutine掛起時(shí)重新啟動(dòng)
之。lua_resume在兩種情況下返回：coroutine掛起或者執(zhí)行完畢，否則lua_resume不返回。
lua_yield和lua_resume對(duì)應(yīng)于腳本函數(shù)：coroutine.yield和coroutine.resume，建議你寫寫腳本程序感受下coroutine，
例如：
function main()
print("main start")
coroutine.yield()
print("main end")
end
co=coroutine.create( main );
coroutine.resume(co)
REALLY SOLVE IT
你可能會(huì)想到，我們?yōu)槟_本定義一個(gè)main，然后在宿主程序里lua_newthread創(chuàng)建一個(gè)coroutine，然后將main放進(jìn)去，
當(dāng)腳本調(diào)用宿主程序的某個(gè)’阻塞‘操作時(shí)，宿主程序獲取到之前創(chuàng)建的coroutine，然后yield之。當(dāng)操作完成時(shí)，再resume
之。
事實(shí)上方法是對(duì)的，但是沒有必要再創(chuàng)建一個(gè)coroutine。如之前所說，一個(gè)lua_State看上去就是一個(gè)coroutine，
而恰好，我們始終都會(huì)有一個(gè)lua_State。感覺上，這個(gè)lua_State就像是main coroutine。（就像你的主線程）
思路就是這樣，因?yàn)榫唧w實(shí)現(xiàn)時(shí)，還是有些問題，所以我羅列每個(gè)步驟的代碼。
初始lua_State時(shí)如你平時(shí)所做：
lua_State *L = lua_open();
luaopen_base( L );
注冊(cè)腳本需要的宿主程序函數(shù)到L里：
lua_pushcfunction( L, sleep );
lua_setglobal( L, "my_sleep" );
載入腳本文件并執(zhí)行時(shí)稍微有點(diǎn)不同：
luaL_loadfile( L, "test.lua" );
lua_resume( L, 0 ); /**//* 調(diào)用resume */
在你的’阻塞‘函數(shù)里需要掛起coroutine：
return lua_yield( L, 0 );
注意，lua_yield函數(shù)非常特別，它必須作為return語句被調(diào)用，否則會(huì)調(diào)用失敗，具體原因我也不清楚。而在這里，
它作為lua_CFunction的返回值，會(huì)不會(huì)引發(fā)錯(cuò)誤？因?yàn)閘ua_CFunction約定返回值為該函數(shù)對(duì)于腳本而言的返回值個(gè)數(shù)。
實(shí)際情況是，我看到的一些例子里都這樣安排lua_yield，所以i do what they do。
在這個(gè)操作完成后（如玩家操作了那個(gè)對(duì)話框），宿主程序需要喚醒coroutine：
lua_resume( L, 0 );
大致步驟就這些。如果你要單獨(dú)創(chuàng)建新的lua_State，反而會(huì)搞得很麻煩，我開始就是那樣的做的，總是實(shí)現(xiàn)不了自己
預(yù)想中的效果。
相關(guān)下載：
例子程序中，我給了一個(gè)sleep實(shí)現(xiàn)。腳本程序調(diào)用sleep時(shí)將被掛起，宿主程序不斷檢查當(dāng)前時(shí)間，當(dāng)時(shí)間到時(shí)，resume
掛起的coroutine。下載例子
8.13補(bǔ)充
可能有時(shí)候，我們提供給腳本的函數(shù)需要返回一些值給腳本，例如NPCDialog返回操作結(jié)果，我們只需要在宿主程序里lua_resume
之前push返回值即可，當(dāng)然，需要設(shè)置lua_resume第二個(gè)參數(shù)為返回值個(gè)數(shù)。
2.9.2010
lua_yield( L, nResults )第二個(gè)參數(shù)指定返回給lua_resume的值個(gè)數(shù)。如下：
lua_pushnumber( L, 3 );
return lua_yield( L, 1 );
..
int ret = lua_resume( L, 0 );
if( ret == LUA_YIELD )
{
lua_Number r = luaL_checknumber( L, -1 );
}