summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/luapackageloader/luapackageloader.lua
blob: 93d9a3cd6be680b2c6a83c4103aef9db82a54933 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
-- Author: Deepak Jois
-- License: LPPL Version 1.3c or higher <http://www.latex-project.org/lppl.txt>
-- Date: 2019/12/21
-- Version: 0.2
local luapackageloader = {}

-- Cache the current kpse based searchers
local kpse_lua_searcher = package.searchers[2]
local kpse_clua_searcher = package.searchers[3]

-- Emulates the default package.searchers[2] searcher.
local function lua_searcher(name)
  local file, err = package.searchpath(name,package.path)
  if err then
    return string.format("[lua searcher]: module not found: '%s'%s", name, err)
  else
    return loadfile(file)
  end
end

-- Emulates the default package.searchers[3] searcher.
local function clua_searcher(name)
  local file, err = package.searchpath(name, package.cpath)
  if err then
    return string.format("[lua C searcher]: module not found: '%s'%s", name,err)
  else
    local symbol = name:gsub("%.","_")
    return package.loadlib(file, "luaopen_"..symbol)
  end
end

local function combine_searchers(searcher1, searcher2)
  return function(name)
    local loader1 = searcher1(name)
    if type(loader1) == "string" then -- Not found using searcher1. Try searcher2.
      local loader2 = searcher2(name)
      if type(loader2) == "string" then -- Not found using searcher2. Return error.
        return string.format("%s\n\t%s", loader1, loader2)
      end
      return loader2
    end
    return loader1
  end
end

--- Use package.path and package.cpath to find Lua modules,
-- in case kpse searching fails.
--
-- Package searching logic is overridden by default in LuaTeX to use kpse.
-- Calling this function reverts the searchers to use package.path and
-- package.cpath, if the kpse based searcher is not able to locate
-- a module.
--
-- Package Loading References:
-- 1. http://www.lua.org/manual/5.2/manual.html#pdf-package.searchers
-- 2. LuaTeX Manual, Section 3.2, Lua behavior
function luapackageloader.add_lua_searchers()
  package.searchers[2] = combine_searchers(kpse_lua_searcher, lua_searcher)
  package.searchers[3] = combine_searchers(kpse_clua_searcher, clua_searcher)
end

--- Restore the kpse package searchers that are used by default in LuaTeX.
--
-- Call this to restore the default LuaTeX behavior for searching packages,
-- if you had earlier overridden it using `luapackageloader.add_lua_searchers()`.
function luapackageloader.restore_kpse_searchers()
  package.searchers[2] = kpse_lua_searcher
  package.searchers[3] = kpse_clua_searcher
end

return luapackageloader