[latex3-commits] [git/LaTeX3-latex3-l3build] master: Support for a TDS map for file install (f101781)
Joseph Wright
joseph.wright at morningstar2.co.uk
Tue Jul 30 16:48:00 CEST 2019
Repository : https://github.com/latex3/l3build
On branch : master
Link : https://github.com/latex3/l3build/commit/f101781f23ef1d36d1e98c410f6ba7ff8ffa8501
>---------------------------------------------------------------
commit f101781f23ef1d36d1e98c410f6ba7ff8ffa8501
Author: Joseph Wright <joseph.wright at morningstar2.co.uk>
Date: Tue Jul 30 15:47:34 2019 +0100
Support for a TDS map for file install
I
>---------------------------------------------------------------
f101781f23ef1d36d1e98c410f6ba7ff8ffa8501
CHANGELOG.md | 4 +++
l3build-file-functions.lua | 4 +--
l3build-install.lua | 70 ++++++++++++++++++++++++++++++++++------------
l3build-variables.lua | 5 +++-
l3build.dtx | 50 +++++++++++++++++++++++++++++++++
5 files changed, 112 insertions(+), 21 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index b05453a..72fd974 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ this project uses date-based 'snapshot' version identifiers.
## [Unreleased]
+### Added
+
+- Support for non-standard file layouts via `tdslocations` table
+
### Changed
- Only write (x)dvipdfmx specials for XeTeX and (u)pTeX (see #94)
diff --git a/l3build-file-functions.lua b/l3build-file-functions.lua
index cc1bef6..9c7ac1f 100644
--- a/l3build-file-functions.lua
+++ b/l3build-file-functions.lua
@@ -1,6 +1,6 @@
--[[
-File l3build-file-functions.lua Copyright (C) 2018 The LaTeX3 Project
+File l3build-file-functions.lua Copyright (C) 2018,2019 The LaTeX3 Project
It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this
@@ -80,7 +80,7 @@ local insert = table.insert
(end license)
--]]
-local function glob_to_pattern(glob)
+function glob_to_pattern(glob)
local pattern = "^" -- pattern being built
local i = 0 -- index in glob
diff --git a/l3build-install.lua b/l3build-install.lua
index a97a24e..d2222c8 100644
--- a/l3build-install.lua
+++ b/l3build-install.lua
@@ -1,6 +1,6 @@
--[[
-File l3build-install.lua Copyright (C) 2018 The LaTeX3 Project
+File l3build-install.lua Copyright (C) 2018,2019 The LaTeX3 Project
It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this
@@ -22,8 +22,9 @@ for those people who are interested.
--]]
-local pairs = pairs
-local print = print
+local ipairs = ipairs
+local pairs = pairs
+local print = print
local set_program = kpse.set_program_name
local var_value = kpse.var_value
@@ -40,9 +41,7 @@ local function gethome()
end
function uninstall()
- local function uninstall_files(dir,subdir)
- subdir = subdir or moduledir
- dir = dir .. "/" .. subdir
+ local function zapdir(dir)
local installdir = gethome() .. "/" .. dir
if options["dry-run"] then
local files = filelist(installdir)
@@ -60,6 +59,11 @@ function uninstall()
end
return 0
end
+ local function uninstall_files(dir,subdir)
+ subdir = subdir or moduledir
+ dir = dir .. "/" .. subdir
+ return zapdir(dir)
+ end
local errorlevel = 0
-- Any script man files need special handling
local manfiles = { }
@@ -83,13 +87,21 @@ function uninstall()
print("- " .. v)
end
end
- return uninstall_files("doc")
+ errorlevel = uninstall_files("doc")
+ uninstall_files("source")
+ uninstall_files("tex")
+ uninstall_files("bibtex/bst",module)
+ uninstall_files("makeindex",module)
+ uninstall_files("scripts",module)
+ errorlevel
+ if errorlevel ~= 0 then return errorlevel end
+ -- Finally, clean up special locations
+ for _,location in ipairs(tdslocations) do
+ local path,glob = splitpath(location)
+ errorlevel = zapdir(path)
+ if errorlevel ~= 0 then return errorlevel end
+ end
+ return 0
end
function install_files(target,full,dry_run)
@@ -103,28 +115,47 @@ function install_files(target,full,dry_run)
end
dir = dir .. (subdir and ("/" .. subdir) or "")
local filenames = { }
+ local paths = { }
+ -- Generate a file list and include the directory
for _,glob_table in pairs(files) do
for _,glob in pairs(glob_table) do
for file,_ in pairs(tree(source,glob)) do
- insert(filenames,file)
+ -- Just want the name
+ local file = gsub(file,"^%./","")
+ local matched = false
+ for _,location in ipairs(tdslocations) do
+ local path,glob = splitpath(location)
+ local pattern = glob_to_pattern(glob)
+ if match(file,pattern) then
+ insert(paths,path)
+ insert(filenames,path .. "/" .. file)
+ matched = true
+ break
+ end
+ end
+ if not matched then
+ insert(paths,dir)
+ insert(filenames,dir .. "/" .. file)
+ end
end
end
end
+
local errorlevel = 0
-- The target is only created if there are actual files to install
if next(filenames) then
- local installdir = target .. "/" .. dir
- if dry_run then
- print("\n" .. "For installation in " .. installdir .. ":")
- else
- errorlevel = cleandir(installdir)
- if errorlevel ~= 0 then return errorlevel end
+ if not dry_run then
+ for _,path in pairs(paths) do
+ errorlevel = cleandir(target .. "/" .. path)
+ if errorlevel ~= 0 then return errorlevel end
+ end
end
for _,file in ipairs(filenames) do
if dry_run then
- print("- " .. select(2,splitpath(file)))
+ print("- " .. file)
else
- errorlevel = cp(file,source,installdir)
+ local path,file = splitpath(file)
+ errorlevel = cp(file,source,target .. "/" .. path)
if errorlevel ~= 0 then return errorlevel end
end
end
@@ -181,6 +212,10 @@ function install_files(target,full,dry_run)
sourcelist = excludelist(sourcefiledir,sourcefiles,
{bstfiles,installfiles,makeindexfiles,scriptfiles})
+ if dry_run then
+ print("\nFor installation inside " .. target .. ":")
+ end
+
errorlevel = install_files(sourcefiledir,"source",{sourcelist})
+ install_files(docfiledir,"doc",
{bibfiles,demofiles,docfiles,pdffiles,textfiles,typesetlist})
@@ -212,9 +247,8 @@ function install_files(target,full,dry_run)
end
end
if next(manfiles) then
- print("\n" .. "For installation in " .. target .. "/doc/man:")
for _,v in ipairs(manfiles) do
- print("- " .. v)
+ print("- doc/man/" .. v)
end
end
end
diff --git a/l3build-variables.lua b/l3build-variables.lua
index 1288a6b..0b3c9a2 100644
--- a/l3build-variables.lua
+++ b/l3build-variables.lua
@@ -1,6 +1,6 @@
--[[
-File l3build-variables.lua Copyright (C) 2018 The LaTeX3 Project
+File l3build-variables.lua Copyright (C) 2018,2019 The LaTeX3 Project
It may be distributed and/or modified under the conditions of the
LaTeX Project Public License (LPPL), either version 1.3c of this
@@ -197,6 +197,9 @@ tpfext = tpfext or ".tpf"
-- Manifest options
manifestfile = manifestfile or "MANIFEST.md"
+-- Non-standard installation locations
+tdslocations = tdslocations or { }
+
-- Upload settings
curlexe = curlexe or "curl"
uploadconfig = uploadconfig or {}
diff --git a/l3build.dtx b/l3build.dtx
index 8ce3828..ca4253b 100644
--- a/l3build.dtx
+++ b/l3build.dtx
@@ -153,6 +153,8 @@
\luavarset{recordstatus}{false} {Switch to include error level from test runs in \texttt{.tlg} files}
\luavarset{manifestfile} {"MANIFEST.md"} {Filename to use for the manifest file}
\luavarseparator
+\luavarset{tdslocations}{\{ \}}{Map for non-standard file installations}
+\luavarseparator
\luavarset{uploadconfig} {\meta{table}} {Metadata to describe the package for CTAN (see Table~\ref{tab:upload-setup})}
\luavarset{uploadconfig.pkg}{ctanpkg}{Name of the CTAN package}
\luavarseparator
@@ -1214,6 +1216,47 @@
%
% \section{Release-focussed features}
%
+% \subsection{Installation structure}
+%
+% With the standard settings, \pkg{l3build} will install files within
+% the \TeX{} directory structure (TDS) as follows
+% \begin{itemize}
+% \item \var{installfiles} within a \texttt{\meta{bundle}/\meta{module}}
+% (or \texttt{\meta{module}}) directory inside \texttt{tex/\meta{format}}
+% \item \var{sourcefiles} within a \texttt{\meta{bundle}/\meta{module}}
+% (or \texttt{\meta{module}}) directory inside \texttt{source/\meta{format}}
+% \item Typeset PDFs within a \texttt{\meta{bundle}/\meta{module}}
+% (or \texttt{\meta{module}}) directory inside \texttt{doc/\meta{format}}
+% \item \var{bstfiles} within a \texttt{\meta{bundle}/\meta{module}}
+% (or \texttt{\meta{module}}) directory inside \texttt{bibtex/bst}
+% \item \var{bibfiles} within a \texttt{\meta{bundle}/\meta{module}}
+% (or \texttt{\meta{module}}) directory inside \texttt{bibtex/bib}
+% \item \var{makeindexfiles} within a \texttt{\meta{bundle}/\meta{module}}
+% (or \texttt{\meta{module}}) directory inside \texttt{makeindex}
+% \end{itemize}
+%
+% For more complex set ups, this can be customised using the
+% \luavar{tdslocations} table. Each entry there should be a glob specifying the
+% TDS position of a file or files. Any files not specified in the table
+% will use the standard locations above. For example, to place some files
+% in the generic tree, some in the plain \TeX{} tree and some in the \LaTeX{}
+% tree, one might use the set up shown in Figure~\ref{fig:tds}.
+% \begin{figure}
+% \begin{lstlisting}[frame=single,language={[5.2]Lua},gobble = 6]
+% tdslocations =
+% {
+% "tex/generic/mypkg/*.generic.tex" ,
+% "tex/plain/mypkg/*.plain.tex" ,
+% "tex/latex/mypkg/*.latex.tex"
+% }
+% \end{lstlisting}
+% \caption{Example \texttt{tdslocations} table.}
+% \label{fig:tds}
+% \end{figure}
+%
+% The table is read in order, and thus specific file names should come before
+% potential wild-card matches.
+%
% \subsection{Automatic tagging}
% \label{sec:tagging}
%
@@ -1580,6 +1623,13 @@
% all files in the \meta{path}.
% \end{function}
%
+% \begin{function}{glob_to_pattern()}
+% \begin{syntax}
+% |glob_to_pattern(|\meta{glob}|)|
+% \end{syntax}
+% Returns the \meta{glob} converted to a Lua pattern.
+% \end{function}
+%
% \begin{function}{jobname()}
% \begin{syntax}
% |jobname(|\meta{file}|)|
More information about the latex3-commits
mailing list