主要翻譯自lua文檔,加上了programming lua中自己的一些理解
require(modname)
加載給定的模塊.函數首先檢查表package.loaded來判定modname是否已經存在.如果存在,則require返回package.loaded[modname]所存儲的值否則它嘗試為模塊找到一個加載器(loader).
要找到一個加載器,require首先查詢package.preloaded[modname].如果它有值,該值(應該是一個函數)就是加載器.如果沒值require使用package.path中存儲的路徑查找一個Lua的加載器.如果該查找也失敗,它使用package.cpath中存儲的路徑查找一個C語言加載器(C loader).如果還是失敗,它嘗試使用all-in-one加載器(如下)
當加載一個C庫的時候,require首先使用動態鏈接工具將應用程序與庫連接起來.之后它嘗試找到一個該庫中的C函數,該函數要被當做加載器使用.這個C函數的名稱是字符串"luaopen_"連接著復制的模塊名(模塊名稱中的每個點號"."都被替換為一個下劃線).此外,如果模塊名稱含有連字符"-",則第一個連字符的前綴(包括連字符)都被移除.比如,如果模塊名稱是a.v1-b.c,則函數名稱將是luaopen_b_c.
如果require即沒有為模塊找到一個Lua庫也沒有為模塊找到一個C庫,他將調用all-in-one加載器.該加載器為給定模塊的根名稱查找C路徑找到對應庫(原文:this loader searches the C path for a library for the root name of the given module).例如,當require a.b.c時,它將為a查找一個庫.如果找到,它查詢該庫內部為子模塊找到一個開放函數(open function);在我們這個例子中將會是luaopen_a_b_c.使用這個便利機制(facility),一個包可以將幾個子模塊打包進單個的庫中,同時每個子模塊保存著它本來的開放函數.
一旦找到一個加載器,require使用單個的參數modname調用加載器.如果加載器返回任何值,require將其賦值給package.loaded[modname].如果加載器沒有返回值且沒有給package.loaded[modname]賦與任何值,則require為該條目賦值為true.無論如何,require返回package.loaded[modname]的最終值.
如果加載或者運行模塊有任何錯誤,或者他不能為模塊找到一個加載器,則require發出一個錯誤信號.
require函數的實現原理如下:
- --require 函數的實現
- function require(name)
- if not package.loaded[name] then
- local loader = findloader(name) //這一步演示在代碼中以抽象函數findloader來表示
- if loader == nil then
- error("unable to load module" .. name)
- end
- package.loaded[name] = true
- local res = loader(name)
- if res ~= nil then
- package.loaded[name] = res
- end
- end
- return package.loaded[name]
- end
--require 函數的實現
function require(name)
if not package.loaded[name] then
local loader = findloader(name) //這一步演示在代碼中以抽象函數findloader來表示
if loader == nil then
error("unable to load module" .. name)
end
package.loaded[name] = true
local res = loader(name)
if res ~= nil then
package.loaded[name] = res
end
end
return package.loaded[name]
end
package.cpath
由require使用查找C加載器的路徑
Lua初始化C路徑package.cpath的方法與初始化Lua路徑package.path的相同,使用LUA_CPATH中的環境變量(另外一個默認的路徑在luaconf.h中定義)
package.loaded
一個用于控制哪些模塊已經加載的表,該表由require使用.當require一個模塊名為modname的模塊且package.loaded[modname]不為false時,require僅返回package.loaded[modname]存儲的值.
package.loadlib(libname,funcname)
使用C庫libname動態鏈接到宿主程序.在這個庫中,尋找函數funcname并將該函數作為一個C函數返回.(所以,funcname必須遵守協議(參見lua_CFunction)).
這是一個底層函數.它完全繞過了package和module系統.與require不同,它不執行任何路徑查找且不自動添加擴展名.libname必須是C庫中完整的文件名,如果必要的話還要包含路徑和擴展名.funcname必須是原封不動的C庫中導出的名字(這可能取決于使用的C編譯器和鏈接器).
這個函數不被ANSI C支持.就其本身而言,它只在一些平臺上才能使用(Windows,Linux,Mac OS X,Solaris,BSD,加上其他支持dlfcn標準的Unix系統)
package.path
require用于查找Lua加載器的路徑
在啟動時,Lua使用環境變量LUA_PATH或者如果環境變量未定義就使用luaconf.h中定義的默認值來初始化該值.環境變量中的任何"::"都被替換為默認路徑.
路徑是一系列由分號隔開的模板(templates).對于每個模板,require將每個模板中的問號替換為filename,filename是modname中每個點都被替換成"目錄分隔符"(比如Unix中的"/")(這句感覺翻譯不準確,原文:For each template,require will change each interrogation mark in the template by filename,which is modname with each dot replaced by a "directory separator"(such as "/" in Unix));之后他將加載產生的文件名.因此,舉個例子,如果Lua路徑是"./?.lua;./?.lc;/usr/local/?/init.lua",為模塊foo查找一個Lua加載器將會嘗試以如下順序加載文件./foo.lua,./foo.lc和/usr/local/foo/init.lua
package.preload
為特定模塊存儲加載器的一個表(參見require)
package.seeall(module)
為module設置一個元表,module的__index只想全局環境(global environment),以便該module繼承全局環境中的值.作為函數module中的一個選項來使用.
在Programming Lua中是這么講的:
默認情況下,module不提供外部訪問.必須在調用它之前,為需要訪問的外部函數或模塊聲明適當的局部變量.也可以通過繼承來實現外部訪問,只需在調用module時附加一個選項package.seeall.這個選項等價于如下代碼:
- setmetatable(M,{__index = _G})
setmetatable(M,{__index = _G})因而只需這么做:
- module(...,package.seeall)
module(...,package.seeall)
module(name,[,...])
創建一個模塊.如果在package.loaded[name]中有表,該表便是創建的模塊.否則,如果有一個全局表t其名稱與給定名稱相同,則該全局表便是創建的模塊.否則創建一個新的表t