在Lua中使用gettext實現多語言支援

GNU gettext 是一套優秀的國際化工具。在 linux 中被大量採用。wordpress 也使用 gettext 實現多語言支援。

本文介紹如何在 quick-cocos2d-x 中使用 gettext 做多語言支援。同時介紹多語言翻譯工具 poedit 對 Lua 語言的支援。

gettext 簡介

gettext 是一套工具集的名稱。這套工具集包含 xgettext/msginit/msgfmt 等一套建立模版(POT)、建立PO檔案和編譯MO檔案的工具。

gettext 包含的工具如下：

• xgettext 從原始碼中生成POT模版或直接生成PO檔案；
• msginit 基於POT檔案生成待翻譯的PO檔案；
• msgfmt 將PO檔案編譯成二進位制的MO檔案；
• msgunfmt 顧名思義，將MO檔案反編譯成PO檔案；
• msgmerge 將POT模版檔案與PO檔案合併。用於在原始碼更新之後將新的待翻譯內容更新到已經翻譯的PO檔案中；
• msgcat 將多個PO檔案合併在一起。

使用 gettext 需要涉及這樣幾個概念：

• 原始碼
  程式的原始碼，本文中是 lua 檔案；
• POT 檔案
  從原始碼中掃描得到的翻譯模版檔案，原始語言取決於原始碼字串中使用的自然語言，建議使用英文。純文字格式；
• PO 檔案
  根據 POT 檔案建立的各種語言版本的待翻譯檔案，其中包含原始語言和被翻譯的目標語言。純文字格式；
• MO 檔案
  供最終軟體實際使用的檔案，使用 PO 編譯而成。二進位制格式。

一般的工作流程是這樣的：

1. 在原始碼中使用約定的語法來書寫字串，C語言預設是gettext("my text")。在本文中，將使用 _("my text") ；
2. 使用 xgettext 從原始碼中掃描出需要翻譯的文字，建立 POT 檔案；
3. 使用 msginit 命令根據 POT 檔案建立 PO 檔案。或者直接在上一步也可以直接建立 PO 檔案；
4. 進行人工翻譯（當然也可以進行機器翻譯），翻譯的結果儲存在 PO 檔案中；
5. 使用 msgfmt 命令將 PO 檔案編譯成 MO 檔案；
6. 在程式中實現呼叫命令，本文中是 _ 函式，這個函式將讀取並解析 MO 檔案，根據呼叫的原始語言文字返回翻譯之後的文字。

Poedit 簡介

gettext 提供的工具集都是基於命令列的，有些程式設計師並不習慣命令列。它也沒有提供用於翻譯工作者的對照翻譯工具。

Poedit 可以從原始碼中提取文字生成 PO 檔案，也提供了一個GUI介面用於對照翻譯。它還可以直接生成最終的 MO 檔案。

當然，在GUI之後，它依然是使用 gettext 來處理的，但這些具體的細節被隱藏了。

使用 Poedit 生成和翻譯 PO 檔案

軟體設定

1.開啟 Poedit，執行 File – Preferences 命令，填入自己的個人資訊。

2.切換到 Editor tab，選中 Automatically compile .mo file on save 和 Show summary after catalog update 兩項。

3.切換到 Parsers tab，這裡提供了幾種原始碼解析器，但預設沒有Lua。我們下面將加入Lua原始碼解析。

4.點選 New 新建一個原始碼解析器，進行如下圖的設定。

xgettext -C --force-po -o %o %C %K %F

-k%k

--from-code=%c

這些設定基本上與 C/C++ 的設定一致，只是修改了副檔名支援以及 Parser command 欄位。在 xgettext 命令的引數中，-C 就是 –language=C 的簡寫。

接下來將新建一個專案進行設定。

專案設定

1.執行 File – New catelog… 命令，在 Translation properties tab 中加入自己的資訊。這裡的 Language 選項只是個顯示選項而已，並不能決定你使用的是何種語言，也不和剛才的軟體設定中的 Parsers 相關。

2.設定原始碼路徑，這個非常重要。

我採用 quick 預設的目錄風格，所有的原始碼放在 scripts 中。同時我建立了一個新的 i18n 目錄，這個目錄與 scripts 目錄同級。生成的 PO 檔案將儲存在這個目錄中。

那麼對於當前正在編輯的 PO 檔案來說， Base path 就應該設定成..\scripts ， 下面的 Paths 就應該加入 . 這個路徑。注意在 Windows 下， Base path 的路徑分隔符必須採用 Windows 的格式（反斜槓 \ ），而不應該使用 / 。

3.設定原始碼關鍵詞

前面我們已經確定了自己的關鍵詞，那就是 _ 。當然我們也可以使用 C 語言的預設關鍵詞 gettext ，但那樣未免長了一點。

4.設定完畢後，將專案儲存為 i18n/zh_CN.po ，請注意我上面強調過的第2步。

解析原始碼

一切設定成功之後，直接按下主介面上的 Update 按鈕即可解析原始碼。Poedit 會將原始碼中解析到的使用 _("my text") 格式的關鍵詞，將其中的字串提取處理顯示在主介面中。

我們可以在主介面中對關鍵詞進行翻譯。

如果原始碼有更新，再次單擊 Update 按鈕重新解析原始碼。這是如果解析到新的字串，或者有字串不再使用，Poedit都會進行提示。

需要注意的一點是，在 Lua 的註釋中不要包含半形的單引號。

這是由於 Lua 的註釋使用 — 符號，而 C 語言使用 // ，所以 gettext 會認為 Lua 中的註釋是程式碼的一部分而不會忽略解析。在一般情況沒有什麼問題，但如果在註釋中包含了半形的單引號（這是在 C 語言中代表字面值），gettext 就會認為語法錯誤因此產生解析錯誤。

生成 MO 檔案

在軟體設定中，我們設定了在儲存專案的時候自動生成 MO 檔案，所以這點不用操心了。生成的 MO 檔案與 PO 檔案在相同的目錄。

在 Lua 中解析 MO 檔案

MO 是個二進位制格式的檔案，我們的程式在讀取它的時候，需要分析它的結構 ，將它解析成 原始文字 - 翻譯文字 的鍵值對形式，供我們使用。

許多語言中已經包含了 MO 檔案的解析庫，但是 Lua 沒有。所以我們需要自己寫一個。

由於要支援跨平臺的原因，讀取 MO 檔案採用的是 CCFileUtils ，如果要在其他環境中使用，可以改用 io 庫。我在Gettext._getFileData 中保留了使用 io 庫的程式碼，只是將其註釋了。

綜合範例

使用這種方法，MO 檔案會被解析成功一個 table 返回：

local mo_data=assert(require("utils.Gettext").loadMOFromFile("res/zh_CN.mo"))
print(mo_data["Hello World!"])
-- 你好，世界
print(mo_data["Foobar"])
-- nil

_ = assert(require("utils.Gettext").gettextFromFile("res/zh_CN.mo"))
print(_("Hello World!"))

LANG = "res/zh_CN.mo"
function _(__text)
    return __text
end
if CCFileUtils:sharedFileUtils():isFileExist(LANG) then
    _ = assert(require("utils.Gettext").gettextFromFile(LANG))
end

• 本站文章除註明轉載外，均為本站原創或者翻譯。
• 本站文章歡迎各種形式的轉載，但請18歲以上的轉載者註明文章出處，尊重我的勞動，也尊重你的智商；
• 本站部分原創和翻譯文章提供markdown格式原始碼，歡迎使用文章原始碼進行轉載；
• 本文標題：在Lua中使用gettext實現多語言支援