texlive[66743] Master: findpkg (2apr23)
commits+karl at tug.org
commits+karl at tug.org
Sun Apr 2 22:33:31 CEST 2023
Revision: 66743
http://tug.org/svn/texlive?view=revision&revision=66743
Author: karl
Date: 2023-04-02 22:33:31 +0200 (Sun, 02 Apr 2023)
Log Message:
-----------
findpkg (2apr23)
Modified Paths:
--------------
trunk/Master/tlpkg/bin/tlpkg-ctan-check
trunk/Master/tlpkg/libexec/ctan2tds
trunk/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc
Added Paths:
-----------
trunk/Master/texmf-dist/doc/support/findpkg/
trunk/Master/texmf-dist/doc/support/findpkg/README.md
trunk/Master/texmf-dist/tex/latex/findpkg/
trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.json.gz
trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.lua
trunk/Master/tlpkg/tlpsrc/findpkg.tlpsrc
Added: trunk/Master/texmf-dist/doc/support/findpkg/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/support/findpkg/README.md (rev 0)
+++ trunk/Master/texmf-dist/doc/support/findpkg/README.md 2023-04-02 20:33:31 UTC (rev 66743)
@@ -0,0 +1,28 @@
+# FindPkg tool for installing TeX packages
+
+```
+Description: Install TeX packages and their dependencies
+Copyright: 2023 (c) Jianrui Lyu <tolvjr at 163.com>
+Repository: https://github.com/lvjr/findpkg
+License: GNU General Public License v3.0
+```
+
+## Introduction
+
+FindPkg makes it easy to install TeX packages and their dependencies by file names, command names or environment names.
+
+- To install a package by its file name you can run `texlua findpkg.lua install array.sty`;
+- To install a package by some command name you can run `texlua findpkg.lua install \fakeverb`;
+- To install a package by some environment name you can run `texlua findpkg.lua install {frame}`.
+
+FindPkg supports both TeXLive and MiKTeX distributions. At present it focuses mainly on LaTeX packages, but may extend to ConTeXt packages if anyone would like to contribute.
+
+## Building
+
+FindPkg uses completion files of TeXstudio editor which are in `completion` folder of TeXstudio [repository](https://github.com/texstudio-org/texstudio).
+
+After putting `completion` folder into current folder, you can run `texlua findpkg.lua generate` to generate `findpkg.json` file.
+
+## Contributing
+
+Any updates of dependencies, commands or environments for packages should be contributed directly to TeXstudio project.
Property changes on: trunk/Master/texmf-dist/doc/support/findpkg/README.md
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.json.gz
===================================================================
(Binary files differ)
Index: trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.json.gz
===================================================================
--- trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.json.gz 2023-04-02 20:31:09 UTC (rev 66742)
+++ trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.json.gz 2023-04-02 20:33:31 UTC (rev 66743)
Property changes on: trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.json.gz
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+application/octet-stream
\ No newline at end of property
Added: trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.lua
===================================================================
--- trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.lua (rev 0)
+++ trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.lua 2023-04-02 20:33:31 UTC (rev 66743)
@@ -0,0 +1,465 @@
+#!/usr/bin/env texlua
+
+-- Description: Install TeX packages and their dependencies
+-- Copyright: 2023 (c) Jianrui Lyu <tolvjr at 163.com>
+-- Repository: https://github.com/lvjr/findpkg
+-- License: GNU General Public License v3.0
+
+local fpversion = "2023C"
+local fpdate = "2023-04-02"
+
+------------------------------------------------------------
+--> \section{Some variables and functions}
+------------------------------------------------------------
+
+local lfs = require("lfs")
+local insert = table.insert
+local match = string.match
+
+local lookup = kpse.lookup
+kpse.set_program_name("kpsewhich")
+
+require(lookup("lualibs.lua"))
+local json = utilities.json -- for json.tostring and json.tolua
+local gzip = gzip -- for gzip.compress and gzip.decompress
+
+local function fpPrint(msg)
+ print("[findpkg] " .. msg)
+end
+
+local showdbg = false
+
+local function dbgPrint(msg)
+ if showdbg then print("[debug] " .. msg) end
+end
+
+local function valueExists(tab, val)
+ for _, v in ipairs(tab) do
+ if v == val then return true end
+ end
+ return false
+end
+
+local function getFiles(path, pattern)
+ local files = { }
+ for entry in lfs.dir(path) do
+ if match(entry, pattern) then
+ insert(files, entry)
+ end
+ end
+ return files
+end
+
+local function fileRead(input)
+ local f = io.open(input, "rb")
+ local text
+ if f then -- file exists and is readable
+ text = f:read("*all")
+ f:close()
+ --print(#text)
+ return text
+ end
+ -- return nil if file doesn't exists or isn't readable
+end
+
+local function fileWrite(text, output)
+ -- using "wb" keeps unix eol characters
+ f = io.open(output, "wb")
+ f:write(text)
+ f:close()
+end
+
+local function testDistribution()
+ -- texlive returns "texmf-dist/web2c/updmap.cfg"
+ -- miktex returns nil although there is "texmfs/install/miktex/config/updmap.cfg"
+ local d = lookup("updmap.cfg")
+ if d then
+ return "texlive"
+ else
+ return "miktex"
+ end
+end
+
+------------------------------------------------------------
+--> \section{Handle TeX Live package database}
+------------------------------------------------------------
+
+local tlpkgtext
+
+local function tlReadPackageDB()
+ local tlroot = kpse.var_value("TEXMFROOT")
+ if tlroot then
+ tlroot = tlroot .. "/tlpkg"
+ else
+ fpPrint("error in finding texmf root!")
+ end
+ local list = getFiles(tlroot, "^texlive%.tlpdb%.main")
+ if #list > 0 then
+ tlpkgtext = fileRead(tlroot .. "/" .. list[1])
+ if not tlpkgtext then
+ fpPrint("error in reading texlive package database!")
+ end
+ else
+ -- no texlive.tlpdb.main file in a fresh TeX live
+ fpPrint("error in finding texlive package database!")
+ fpPrint("please run 'tlmgr update --self' first.")
+ end
+end
+
+local tlpkgdata = {}
+
+local function tlExtractFiles(name, desc)
+ -- ignore binary packages
+ -- also ignore latex-dev packages
+ if name:find("%.") or name:find("^latex%-[%a]-%-dev") then
+ --print(name)
+ return
+ end
+ -- ignore package files in doc folder
+ desc = desc:match("\nrunfiles .+") or ""
+ for base, ext in desc:gmatch("/([%a%d%-]+)%.([%a%d]+)\n") do
+ if ext == "sty" or ext == "cls" then
+ dbgPrint(name, base .. "." .. ext)
+ tlpkgdata[base .. "." .. ext] = name
+ end
+ end
+end
+
+local function tlParsePackageDB()
+ tlpkgtext:gsub("name (.-)\n(.-)\n\n", tlExtractFiles)
+end
+
+------------------------------------------------------------
+--> \section{Handle MiKTeX package database}
+------------------------------------------------------------
+
+local mtpkgtext
+
+local function mtReadPackageDB()
+ local mtvar = kpse.var_value("TEXMFVAR")
+ if mtvar then
+ mtpdb = mtvar .. "/miktex/cache/packages/miktex-zzdb3-2.9/package-manifests.ini"
+ else
+ fpPrint("error in finding texmf root!")
+ end
+ mtpkgtext = fileRead(mtpdb)
+ if not mtpkgtext then
+ fpPrint("error in reading miktex package database!")
+ end
+end
+
+local mtpkgdata = {}
+
+local function mtExtractFiles(name, desc)
+ -- ignore package files in source or doc folders
+ -- also ignore latex-dev packages
+ if name:find("_") or name:find("^latex%-[%a]-%-dev") then
+ --print(name)
+ return
+ end
+ for base, ext in desc:gmatch("/([%a%d%-]+)%.([%a%d]+)\r?\n") do
+ if ext == "sty" or ext == "cls" then
+ dbgPrint(name, base .. "." .. ext)
+ mtpkgdata[base .. "." .. ext] = name
+ end
+ end
+end
+
+local function mtParsePackageDB()
+ -- package-manifests.ini might use different eol characters
+ mtpkgtext:gsub("%[(.-)%]\r?\n(.-)\r?\n\r?\n", mtExtractFiles)
+end
+
+------------------------------------------------------------
+--> \section{Compare TeX Live and MiKTeX packages}
+------------------------------------------------------------
+
+local tlpkgname = "download/texlive.tlpdb"
+local mtpkgname = "download/package-manifests.ini"
+
+local function compareDistributions()
+ tlpkgtext = fileRead(tlpkgname)
+ if tlpkgtext then
+ tlParsePackageDB()
+ else
+ fpPrint("error in reading texlive package database!")
+ end
+ mtpkgtext = fileRead(mtpkgname)
+ if mtpkgtext then
+ mtParsePackageDB()
+ else
+ fpPrint("error in reading miktex package database!")
+ end
+ local tlmissing, mkmissing = {}, {}
+ for k, vt in pairs(tlpkgdata) do
+ local vm = mtpkgdata[k] -- or "[none]"
+ if vm then
+ mtpkgdata[k] = nil -- remove it
+ if vm ~= vt then
+ print("texlive->" .. vt, "miktex->" .. vm, k)
+ end
+ else
+ insert(mkmissing, {vt, k})
+ end
+ end
+ for k, v in pairs(mtpkgdata) do
+ print("texlive doesn't include " .. v .. " -> " .. k)
+ end
+ for _, v in ipairs(mkmissing) do
+ print("miktex doesn't include " .. v[1] .. " -> " .. v[2])
+ end
+end
+
+------------------------------------------------------------
+--> \section{Generate json file from cwl files}
+------------------------------------------------------------
+
+local function insertNewValue(tbl, val)
+ if not valueExists(tbl, val) then
+ insert(tbl, val)
+ end
+end
+
+local function extractFileData(cwl)
+ -- the cwl files have different eol characters
+ local deps = {}
+ for d in cwl:gmatch("\n#include:(.-)[\r\n]") do
+ --dbgPrint(d)
+ n = d:match("^class-(.+)$")
+ if n then
+ insertNewValue(deps, n .. ".cls")
+ else
+ insertNewValue(deps, d .. ".sty")
+ end
+ end
+ local envs = {}
+ for b, e in cwl:gmatch("\n\\begin{(.-)}.-\n\\end{(.-)}") do
+ if b == e then
+ --dbgPrint("{" .. e .. "}")
+ insert(envs, e)
+ end
+ end
+ local cmds = {}
+ for c in cwl:gmatch("\n\\(%a+)") do
+ if c ~= "begin" and c ~= "end" then
+ --dbgPrint("\\" .. c)
+ if not valueExists(cmds, c) then
+ insert(cmds, c)
+ end
+ end
+ end
+ --return {deps, envs, cmds}
+ return {deps = deps, envs = envs, cmds = cmds}
+end
+
+local function writeJson(cwldata)
+ fpPrint("writing json database to file...")
+ local tbl1 = {}
+ for k, v in pairs(cwldata) do
+ table.insert(tbl1, {k, v})
+ end
+ table.sort(tbl1, function(a, b)
+ if a[1] < b[1] then return true end
+ end)
+ local tbl2 = {}
+ for _, v in ipairs(tbl1) do
+ local item = '"' .. v[1] .. '":' .. json.tostring(v[2])
+ table.insert(tbl2, item)
+ end
+ local text = "{\n" .. table.concat(tbl2, "\n,\n") .. "\n}"
+ fileWrite(text, "findpkg.json")
+ fileWrite(gzip.compress(text), "findpkg.json.gz")
+end
+
+local cwlpath = "completion"
+
+local function generateJsonData()
+ local list = getFiles(cwlpath, "%.cwl$")
+ local fname
+ local cwldata = {}
+ for _, v in ipairs(list) do
+ local a, b = match(v, "^([^%-]-)%-(.+)%.cwl")
+ if a == "class" then
+ fname = b .. ".cls"
+ else
+ b = match(v, "^(.+)%.cwl")
+ fname = b .. ".sty"
+ end
+ --print(fname)
+ local cwl = fileRead(cwlpath .. "/" .. v)
+ --print(cwl)
+ if cwl then
+ local item = extractFileData(cwl)
+ dbgPrint(item)
+ cwldata[fname] = item
+ else
+ fpPrint("error in reading " .. v)
+ end
+ end
+ writeJson(cwldata)
+end
+
+------------------------------------------------------------
+--> \section{Install packages in current TeX distribution}
+------------------------------------------------------------
+
+local dist -- name of current tex distribution
+
+local function initPackageDB()
+ dist = testDistribution()
+ fpPrint("you are using " .. dist)
+ if dist == "texlive" then
+ tlReadPackageDB()
+ tlParsePackageDB()
+ else
+ mtReadPackageDB()
+ mtParsePackageDB()
+ end
+end
+
+local function findOnePackage(fname)
+ if dist == "texlive" then
+ return tlpkgdata[fname]
+ else
+ return mtpkgdata[fname]
+ end
+end
+
+local function installSomePackages(list)
+ if dist == "texlive" then
+ local p = table.concat(list, " ")
+ fpPrint("installing package " .. p)
+ os.execute("tlmgr install " .. p)
+ else
+ for _, p in ipairs(list) do
+ fpPrint("installing package " .. p)
+ os.execute("miktex packages install " .. p)
+ end
+ end
+end
+
+------------------------------------------------------------
+--> \section{Find dependencies of package files}
+------------------------------------------------------------
+
+local fptext = "" -- the json text
+local fpdata = {} -- the lua object
+local fnlist = {} -- file name list
+
+local function findDependencies(fname)
+ --print(fname)
+ if valueExists(fnlist, fname) then return end
+ local item = fpdata[fname]
+ if not item then
+ fpPrint("could not find package file " .. fname)
+ return
+ end
+ fpPrint("finding dependencies for " .. fname)
+ table.insert(fnlist, fname)
+ local deps = item.deps
+ if deps then
+ for _, dname in ipairs(deps) do
+ findDependencies(dname)
+ end
+ end
+end
+
+local function installByFileName(fname)
+ fnlist = {} -- reset the list
+ findDependencies(fname)
+ if #fnlist == 0 then
+ fpPrint("error in finding package file")
+ return
+ end
+ local pkglist = {}
+ for _, fn in ipairs(fnlist) do
+ local pkg = findOnePackage(fn)
+ --print(fn, pkg)
+ if pkg then
+ table.insert(pkglist, pkg)
+ end
+ end
+ if not pkglist then
+ fpPrint("error in finding package in " .. dist)
+ return
+ end
+ installSomePackages(pkglist)
+end
+
+local function getFileNameFromCmdEnvName(cmdenv, name)
+ --print(name)
+ for line in fptext:gmatch("(.-)\n[,}]") do
+ if line:find('"' .. name .. '"') then
+ --print(line)
+ local fname, fspec = line:match('"(.-)":(.+)')
+ --print(fname, fspec)
+ local item = json.tolua(fspec)
+ if valueExists(item[cmdenv], name) then
+ fpPrint("found package file " .. fname)
+ return fname
+ end
+ end
+ end
+ fpPrint("could not find any package file with " .. name)
+end
+
+local function installByCommandName(cname)
+ --print(cname)
+ local fname = getFileNameFromCmdEnvName("cmds", cname)
+ if fname then
+ installByFileName(fname)
+ end
+end
+
+local function installByEnvironmentName(ename)
+ --print(ename)
+ local fname = getFileNameFromCmdEnvName("envs", ename)
+ if fname then
+ installByFileName(fname)
+ end
+end
+
+local function install(name)
+ local h = name:sub(1,1)
+ if h == "\\" then
+ local b = name:sub(2)
+ installByCommandName(b)
+ elseif h == "{" then
+ if name:sub(-1) == "}" then
+ local b = name:sub(2,-2)
+ installByEnvironmentName(b)
+ else
+ fpPrint("invalid input " .. name)
+ end
+ else
+ installByFileName(name)
+ end
+end
+
+------------------------------------------------------------
+--> \section{Respond to user input}
+------------------------------------------------------------
+
+local function main()
+ if arg[1] == nil then return end
+ initPackageDB()
+ if arg[1] == "install" then
+ local ziptext = fileRead(lookup("findpkg.json.gz"))
+ fptext = gzip.decompress(ziptext)
+ if fptext then
+ --print(fptext)
+ fpdata = json.tolua(fptext)
+ install(arg[2])
+ else
+ fpPrint("error in reading findpkg.json!")
+ end
+ elseif arg[1] == "generate" then
+ generateJsonData()
+ elseif arg[1] == "compare" then
+ compareDistributions()
+ else
+ fpPrint("unknown option " .. arg[1])
+ end
+end
+
+main()
Property changes on: trunk/Master/texmf-dist/tex/latex/findpkg/findpkg.lua
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/tlpkg/bin/tlpkg-ctan-check
===================================================================
--- trunk/Master/tlpkg/bin/tlpkg-ctan-check 2023-04-02 20:31:09 UTC (rev 66742)
+++ trunk/Master/tlpkg/bin/tlpkg-ctan-check 2023-04-02 20:33:31 UTC (rev 66743)
@@ -327,7 +327,7 @@
fifinddo-info fifo-stack
fig4latex figbas figbib figchild figflow figput figsize
filecontents filecontentsdef filedate filehook fileinfo filemod
- findhyph fink finstrut fira firamath firamath-otf
+ findhyph findpkg fink finstrut fira firamath firamath-otf
first-latex-doc firstaid fistrum fitbox fithesis
fix2col fixcmex fixdif fixfoot fixjfm fixlatvian
fixltxhyph fixmath fixme fixmetodonotes fixpdfmag fiziko
Modified: trunk/Master/tlpkg/libexec/ctan2tds
===================================================================
--- trunk/Master/tlpkg/libexec/ctan2tds 2023-04-02 20:31:09 UTC (rev 66742)
+++ trunk/Master/tlpkg/libexec/ctan2tds 2023-04-02 20:33:31 UTC (rev 66743)
@@ -2090,6 +2090,7 @@
'fancytooltips', 'fancytipmark\..*|' . $standardtex,
'fewerfloatpages', '\.sty$', # not l3doc-TUB.cls
'figflow', '\.tex',
+ 'findpkg', '\.json.gz|' . $standardtex,
'fjodor', 'fjodor\.sty', # not srbook-mem.sty
'flashmovie', '\.swf|' . $standardtex,
'fltpoint', '\.sty|\.tex',
Modified: trunk/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc
===================================================================
--- trunk/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc 2023-04-02 20:31:09 UTC (rev 66742)
+++ trunk/Master/tlpkg/tlpsrc/collection-luatex.tlpsrc 2023-04-02 20:33:31 UTC (rev 66743)
@@ -23,6 +23,7 @@
depend emoji
depend emojicite
depend enigma
+depend findpkg
depend innerscript
depend interpreter
depend kanaparser
Added: trunk/Master/tlpkg/tlpsrc/findpkg.tlpsrc
===================================================================
More information about the tex-live-commits
mailing list.