texlive-base 2009-15 / usr / share / texmf-texlive / scripts / texdoc / texdoc.tlu

#!/usr/bin/env texlua
--[[
Copyright 2008, 2009 Manuel Pégourié-Gonnard.

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with
this program.  If not, see <http://www.gnu.org/licenses/>.

Previous work in the public domain:
- Contributions from Reinhard Kotucha (2008).
- First texlua versions by Frank Küster (2007).
- Original shell script by Thomas Esser, David Aspinall, and Simon Wilkinson.
--]]

-- load a local environment, importing symbols from (this function's) _G
-- usage: local L = {} load_env(L, {'a', 'b'})
function load_env(l, symbols)
    local _, symb
    for _, symb in ipairs(symbols) do
        assert(_G[symb] ~= nil,
            'Internal error: trying to import undefined symbol '..symb..'.')
        l[symb] = _G[symb]
    end
    setfenv(2, l)
end

-- export symbols from a local environment to (this fonction's) _G
function export_symbols(l, symbols)
    local _, symb
    for _, symb in ipairs(symbols) do
        assert(l[symb] ~= nil,
            'Internal error: trying to export undefined symbol '..symb..'.')
        assert(_G[symb] == nil,
            'Internal error: trying to export existing symbol '..symb..'.')
        _G[symb] = l[symb]
    end
end

-- load a component of texdoc
function texdoc_load(name)
    local f = kpse.find_file('texdoc/'..name..'.tlu', 'texmfscripts')
    assert(f, 'Internal error: unable to find texdoc module '..name..'.')
    dofile(f)
end

-- initialize kpathsea
kpse.set_program_name(arg[-1], 'texdoc')

-- declare global variables;
-- they will be made read-only as soon as they are set
C = {}      -- constants
config = {} -- configuration settings

-- actually load the components now
texdoc_load('constants')
texdoc_load('functions')
texdoc_load('alias')
texdoc_load('score')
texdoc_load('config')
texdoc_load('search')
texdoc_load('view')

-- execute main()
texdoc_load('main')

-- the end
os.exit(0)