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