texlive[52011] trunk: checkcites (1sep19)
commits+karl at tug.org
commits+karl at tug.org
Sun Sep 1 23:37:15 CEST 2019
Revision: 52011
http://tug.org/svn/texlive?view=revision&revision=52011
Author: karl
Date: 2019-09-01 23:37:14 +0200 (Sun, 01 Sep 2019)
Log Message:
-----------
checkcites (1sep19)
Modified Paths:
--------------
trunk/Build/source/texk/texlive/linked_scripts/checkcites/checkcites.lua
trunk/Master/texmf-dist/doc/support/checkcites/README
trunk/Master/texmf-dist/doc/support/checkcites/checkcites-doc.pdf
trunk/Master/texmf-dist/doc/support/checkcites/checkcites-doc.tex
trunk/Master/texmf-dist/scripts/checkcites/checkcites.lua
Modified: trunk/Build/source/texk/texlive/linked_scripts/checkcites/checkcites.lua
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/checkcites/checkcites.lua 2019-09-01 21:36:30 UTC (rev 52010)
+++ trunk/Build/source/texk/texlive/linked_scripts/checkcites/checkcites.lua 2019-09-01 21:37:14 UTC (rev 52011)
@@ -211,6 +211,36 @@
return result
end
+-- Extracts the cross-references found
+-- in lines of the bibligraphy file.
+-- @param lines Line of a file.
+-- @return Table containing cross-references.
+local function crossref(lines)
+ local result, lookup, key, hit = {}, ''
+ for _, line in ipairs(lines) do
+ key, hit = string.match(line,
+ '^%s*%@(%w+%s*){%s*(.+),')
+ if key and allowed(key) then
+ lookup = normalize(hit)
+ else
+ key, hit = string.match(line,
+ '^%s*(%w+)%s*=%s*(.+)$')
+ if key then
+ key = string.lower(key)
+ if key == 'crossref' then
+ if string.sub(hit, -1) == ',' then
+ hit = string.sub(hit, 2, -3)
+ else
+ hit = string.sub(hit, 2, -2)
+ end
+ result[lookup] = hit
+ end
+ end
+ end
+ end
+ return result
+end
+
-- Adds the extension if the file does not have it.
-- @param file File.
-- @param extension Extension.
@@ -411,6 +441,21 @@
return result
end
+-- Organizes a key/value table of tables into only one table.
+-- @param t Table.
+-- @return Flattened key/value table.
+local function organize(t)
+ local result = {}
+ for _, v in ipairs(t) do
+ for j, k in pairs(v) do
+ if not result[j] then
+ result[j] = k
+ end
+ end
+ end
+ return result
+end
+
-- Applies a function to elements of a table.
-- @param c Table.
-- @param f Function.
@@ -453,7 +498,7 @@
-- @param citations Citations.
-- @param references References.
-- @return Integer representing the status.
-operations.unused = function(citations, references)
+operations.unused = function(citations, references, crossrefs)
print()
print(pad('-', 74))
print(wrap('Report of unused references in your TeX ' ..
@@ -461,6 +506,20 @@
'bibliography files, but not cited in ' ..
'the TeX source file)', 74))
print(pad('-', 74))
+
+ local z = {}
+ for _, citation in ipairs(citations) do
+ if crossrefs[citation] then
+ table.insert(z, crossrefs[citation])
+ end
+ end
+
+ for _, i in ipairs(z) do
+ if not exists(i, citations) then
+ table.insert(citations, i)
+ end
+ end
+
local r = difference(references, citations)
print()
print(wrap('Unused references in your TeX document: ' ..
@@ -479,7 +538,7 @@
-- @param citations Citations.
-- @param references References.
-- @return Integer value indicating the status.
-operations.undefined = function(citations, references)
+operations.undefined = function(citations, references, crossrefs)
print()
print(pad('-', 74))
print(wrap('Report of undefined references in your TeX ' ..
@@ -487,6 +546,20 @@
'TeX source file, but not present in the ' ..
'bibliography files)', 74))
print(pad('-', 74))
+
+ local z = {}
+ for _, citation in ipairs(citations) do
+ if crossrefs[citation] then
+ table.insert(z, crossrefs[citation])
+ end
+ end
+
+ for _, i in ipairs(z) do
+ if not exists(i, citations) then
+ table.insert(citations, i)
+ end
+ end
+
local r = difference(citations, references)
print()
print(wrap('Undefined references in your TeX document: ' ..
@@ -505,10 +578,10 @@
-- @param citations Citations.
-- @param references References.
-- @return Integer value indicating the status.
-operations.all = function(citations, references)
+operations.all = function(citations, references, crossrefs)
local x, y
- x = operations.unused(citations, references)
- y = operations.undefined(citations, references)
+ x = operations.unused(citations, references, crossrefs)
+ y = operations.undefined(citations, references, crossrefs)
if x + y > 0 then
return 1
else
@@ -555,6 +628,7 @@
{ short = 'U', long = 'undefined', argument = false },
{ short = 'v', long = 'version', argument = false },
{ short = 'h', long = 'help', argument = false },
+ { short = 'c', long = 'crossrefs', argument = false },
{ short = 'b', long = 'backend', argument = true }
}
@@ -596,8 +670,8 @@
if keys['version'] or keys['help'] then
if keys['version'] then
print()
- print(wrap('checkcites.lua, version 2.1 (dated July ' ..
- '26, 2019)', 74))
+ print(wrap('checkcites.lua, version 2.3 (dated September ' ..
+ '1, 2019)', 74))
print(pad('-', 74))
print(wrap('You can find more details about this ' ..
@@ -623,6 +697,7 @@
print('-a,--all list all unused and undefined references')
print('-u,--unused list only unused references in your bibliography files')
print('-U,--undefined list only undefined references in your TeX source file')
+ print('-c,--crossrefs enable cross-reference checks (disabled by default)')
print('-b,--backend <arg> set the backend-based file lookup policy')
print('-h,--help print the help message')
print('-v,--version print the script version')
@@ -773,6 +848,9 @@
local references = flatten(apply(bibliography, function(a)
return extract(read(a)) end))
+ local crossrefs = (keys['crossrefs'] and organize(apply(bibliography,
+ function(a) return crossref(read(a)) end))) or {}
+
print()
print(wrap('Fantastic, I found ' .. tostring(#references) ..
' ' .. plural(#references, 'reference',
@@ -782,7 +860,7 @@
plural(((check == 'all' and 2) or 1), 'report is',
'reports are') .. ' generated.', 74))
- return operations[check](citations, references)
+ return operations[check](citations, references, crossrefs)
end
-- Call and exit
Modified: trunk/Master/texmf-dist/doc/support/checkcites/README
===================================================================
--- trunk/Master/texmf-dist/doc/support/checkcites/README 2019-09-01 21:36:30 UTC (rev 52010)
+++ trunk/Master/texmf-dist/doc/support/checkcites/README 2019-09-01 21:37:14 UTC (rev 52011)
@@ -1,5 +1,5 @@
-checkcites.lua -- Version 2.1 from July 26, 2019.
-=================================================
+checkcites.lua -- Version 2.3 from September 1, 2019.
+=====================================================
License
-------
Modified: trunk/Master/texmf-dist/doc/support/checkcites/checkcites-doc.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/support/checkcites/checkcites-doc.tex
===================================================================
--- trunk/Master/texmf-dist/doc/support/checkcites/checkcites-doc.tex 2019-09-01 21:36:30 UTC (rev 52010)
+++ trunk/Master/texmf-dist/doc/support/checkcites/checkcites-doc.tex 2019-09-01 21:37:14 UTC (rev 52011)
@@ -20,7 +20,7 @@
\newcommand{\checkcites}{\texttt{checkcites}}
\newcommand{\email}[1]{\small\texttt{#1}}
-\newcommand{\version}{Version 2.1 from July 26, 2019.}
+\newcommand{\version}{Version 2.3 from September 1, 2019.}
\newenvironment{infoblock}[1]
{\par\addvspace{\medskipamount}
@@ -66,9 +66,10 @@
modern \TeX\ distribution.
\begin{infoblock}{Attention!}
-\checkcites\ is known to run with the most recent \verb|texlua| and
-\verb|lua| interpreters. Unfortunately, the code is incompatible with
-interpreters prior to the Lua 5.1 language specification.
+From version 2.1 on, \checkcites\ relies on specific libraries available
+in the \verb|texlua| ecosystem and thus is not be supported in vanilla
+\verb|lua| interpreters. Please make sure to use this script with an
+updated \verb|texlua| interpreter in order to ensure the correct behaviour.
\end{infoblock}
\section{How the script works}
@@ -226,7 +227,7 @@
| _| | -_| _| '_| _| | _| -_|_ -|
|___|_|_|___|___|_,_|___|_|_| |___|___|
-checkcites.lua -- a reference checker script (v2.1)
+checkcites.lua -- a reference checker script (v2.3)
Copyright (c) 2012, 2019, Enrico Gregorio, Paulo Roberto Massa Cereda
--------------------------------------------------------------------------
@@ -271,6 +272,7 @@
-a,--all list all unused and undefined references
-u,--unused list only unused references in your bibliography files
-U,--undefined list only undefined references in your TeX source file
+-c,--crossrefs enable cross-reference checks (disabled by default)
-b,--backend <arg> set the backend-based file lookup policy
-h,--help print the help message
-v,--version print the script version
@@ -322,7 +324,7 @@
| _| | -_| _| '_| _| | _| -_|_ -|
|___|_|_|___|___|_,_|___|_|_| |___|___|
-checkcites.lua -- a reference checker script (v2.1)
+checkcites.lua -- a reference checker script (v2.3)
Copyright (c) 2012, 2019, Enrico Gregorio, Paulo Roberto Massa Cereda
Great, I found 4 citations in 1 file. I also found 1 bibliography file. Let
@@ -463,7 +465,7 @@
| _| | -_| _| '_| _| | _| -_|_ -|
|___|_|_|___|___|_,_|___|_|_| |___|___|
-checkcites.lua -- a reference checker script (v2.1)
+checkcites.lua -- a reference checker script (v2.3)
Copyright (c) 2012, 2019, Enrico Gregorio, Paulo Roberto Massa Cereda
Great, I found 4 citations in 1 file. I also found 1 bibliography file. Let
@@ -491,8 +493,19 @@
\end{verbatim}
\end{terminal}
-That is all, folks!
+If you rely on cross-references in your bibliography file, \checkcites\ might complain about
+unused entries. We can try the experimental feature available from version 2.3 on that attempts
+to check cross-references through the \verb|--crossrefs| command line flag:
+\begin{terminal}
+\begin{verbatim}
+$ checkcites --crossrefs document.aux
+\end{verbatim}
+\end{terminal}
+
+This feature is disabled by default and it is known to work with both \verb|bibtex| and \verb|biber|
+backends. Please report if you find an issue. That is all, folks!
+
\section{License}
\label{sec:license}
@@ -502,8 +515,4 @@
donation, the best way to do this is donating to the
\href{http://www.tug.org/}{TeX Users Group}.
-\begin{infoblock}{Official code repository}
-\url{http://github.com/cereda/checkcites}
-\end{infoblock}
-
\end{document}
Modified: trunk/Master/texmf-dist/scripts/checkcites/checkcites.lua
===================================================================
--- trunk/Master/texmf-dist/scripts/checkcites/checkcites.lua 2019-09-01 21:36:30 UTC (rev 52010)
+++ trunk/Master/texmf-dist/scripts/checkcites/checkcites.lua 2019-09-01 21:37:14 UTC (rev 52011)
@@ -211,6 +211,36 @@
return result
end
+-- Extracts the cross-references found
+-- in lines of the bibligraphy file.
+-- @param lines Line of a file.
+-- @return Table containing cross-references.
+local function crossref(lines)
+ local result, lookup, key, hit = {}, ''
+ for _, line in ipairs(lines) do
+ key, hit = string.match(line,
+ '^%s*%@(%w+%s*){%s*(.+),')
+ if key and allowed(key) then
+ lookup = normalize(hit)
+ else
+ key, hit = string.match(line,
+ '^%s*(%w+)%s*=%s*(.+)$')
+ if key then
+ key = string.lower(key)
+ if key == 'crossref' then
+ if string.sub(hit, -1) == ',' then
+ hit = string.sub(hit, 2, -3)
+ else
+ hit = string.sub(hit, 2, -2)
+ end
+ result[lookup] = hit
+ end
+ end
+ end
+ end
+ return result
+end
+
-- Adds the extension if the file does not have it.
-- @param file File.
-- @param extension Extension.
@@ -411,6 +441,21 @@
return result
end
+-- Organizes a key/value table of tables into only one table.
+-- @param t Table.
+-- @return Flattened key/value table.
+local function organize(t)
+ local result = {}
+ for _, v in ipairs(t) do
+ for j, k in pairs(v) do
+ if not result[j] then
+ result[j] = k
+ end
+ end
+ end
+ return result
+end
+
-- Applies a function to elements of a table.
-- @param c Table.
-- @param f Function.
@@ -453,7 +498,7 @@
-- @param citations Citations.
-- @param references References.
-- @return Integer representing the status.
-operations.unused = function(citations, references)
+operations.unused = function(citations, references, crossrefs)
print()
print(pad('-', 74))
print(wrap('Report of unused references in your TeX ' ..
@@ -461,6 +506,20 @@
'bibliography files, but not cited in ' ..
'the TeX source file)', 74))
print(pad('-', 74))
+
+ local z = {}
+ for _, citation in ipairs(citations) do
+ if crossrefs[citation] then
+ table.insert(z, crossrefs[citation])
+ end
+ end
+
+ for _, i in ipairs(z) do
+ if not exists(i, citations) then
+ table.insert(citations, i)
+ end
+ end
+
local r = difference(references, citations)
print()
print(wrap('Unused references in your TeX document: ' ..
@@ -479,7 +538,7 @@
-- @param citations Citations.
-- @param references References.
-- @return Integer value indicating the status.
-operations.undefined = function(citations, references)
+operations.undefined = function(citations, references, crossrefs)
print()
print(pad('-', 74))
print(wrap('Report of undefined references in your TeX ' ..
@@ -487,6 +546,20 @@
'TeX source file, but not present in the ' ..
'bibliography files)', 74))
print(pad('-', 74))
+
+ local z = {}
+ for _, citation in ipairs(citations) do
+ if crossrefs[citation] then
+ table.insert(z, crossrefs[citation])
+ end
+ end
+
+ for _, i in ipairs(z) do
+ if not exists(i, citations) then
+ table.insert(citations, i)
+ end
+ end
+
local r = difference(citations, references)
print()
print(wrap('Undefined references in your TeX document: ' ..
@@ -505,10 +578,10 @@
-- @param citations Citations.
-- @param references References.
-- @return Integer value indicating the status.
-operations.all = function(citations, references)
+operations.all = function(citations, references, crossrefs)
local x, y
- x = operations.unused(citations, references)
- y = operations.undefined(citations, references)
+ x = operations.unused(citations, references, crossrefs)
+ y = operations.undefined(citations, references, crossrefs)
if x + y > 0 then
return 1
else
@@ -555,6 +628,7 @@
{ short = 'U', long = 'undefined', argument = false },
{ short = 'v', long = 'version', argument = false },
{ short = 'h', long = 'help', argument = false },
+ { short = 'c', long = 'crossrefs', argument = false },
{ short = 'b', long = 'backend', argument = true }
}
@@ -596,8 +670,8 @@
if keys['version'] or keys['help'] then
if keys['version'] then
print()
- print(wrap('checkcites.lua, version 2.1 (dated July ' ..
- '26, 2019)', 74))
+ print(wrap('checkcites.lua, version 2.3 (dated September ' ..
+ '1, 2019)', 74))
print(pad('-', 74))
print(wrap('You can find more details about this ' ..
@@ -623,6 +697,7 @@
print('-a,--all list all unused and undefined references')
print('-u,--unused list only unused references in your bibliography files')
print('-U,--undefined list only undefined references in your TeX source file')
+ print('-c,--crossrefs enable cross-reference checks (disabled by default)')
print('-b,--backend <arg> set the backend-based file lookup policy')
print('-h,--help print the help message')
print('-v,--version print the script version')
@@ -773,6 +848,9 @@
local references = flatten(apply(bibliography, function(a)
return extract(read(a)) end))
+ local crossrefs = (keys['crossrefs'] and organize(apply(bibliography,
+ function(a) return crossref(read(a)) end))) or {}
+
print()
print(wrap('Fantastic, I found ' .. tostring(#references) ..
' ' .. plural(#references, 'reference',
@@ -782,7 +860,7 @@
plural(((check == 'all' and 2) or 1), 'report is',
'reports are') .. ' generated.', 74))
- return operations[check](citations, references)
+ return operations[check](citations, references, crossrefs)
end
-- Call and exit
More information about the tex-live-commits
mailing list