From 086cac171c683caf6fa19aa9e4c3bbbaa06ceeb4 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Wed, 27 Mar 2013 21:42:12 +0000 Subject: filedate (27mar13) git-svn-id: svn://tug.org/texlive/trunk@29529 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/tex/latex/filedate/filedate.RLS | 1 + Master/texmf-dist/tex/latex/filedate/filedate.sty | 242 +++++++++++++++++----- 2 files changed, 191 insertions(+), 52 deletions(-) (limited to 'Master/texmf-dist/tex/latex/filedate') diff --git a/Master/texmf-dist/tex/latex/filedate/filedate.RLS b/Master/texmf-dist/tex/latex/filedate/filedate.RLS index 5f48a2845f2..54aac127d66 100644 --- a/Master/texmf-dist/tex/latex/filedate/filedate.RLS +++ b/Master/texmf-dist/tex/latex/filedate/filedate.RLS @@ -1,4 +1,5 @@ \ProvidesFile{filedate.RLS} %% RELEASE INFO\ + [2013/03/27 v0.41 restricted auto-checks] [{2012/11/11 v0.4 \string\[No]FileDateAutoChecks}] [2012/11/06 r0.3a `fdatechk.tex'] [2012/11/06 v0.3 \DatesDiffWarning] diff --git a/Master/texmf-dist/tex/latex/filedate/filedate.sty b/Master/texmf-dist/tex/latex/filedate/filedate.sty index 0fd44cbc674..f518cb3339b 100644 --- a/Master/texmf-dist/tex/latex/filedate/filedate.sty +++ b/Master/texmf-dist/tex/latex/filedate/filedate.sty @@ -1,7 +1,7 @@ \NeedsTeXFormat{LaTeX2e}[1994/12/01] -\ProvidesPackage{filedate}[2012/11/11 v0.4 check file dates (UL)] +\ProvidesPackage{filedate}[2013/03/26 v0.41 check file dates (UL)] -%% Copyright (C) 2012 Uwe Lueck, +%% Copyright (C) 2012 2013 Uwe Lueck, %% http://www.contact-ednotes.sty.de.vu %% -- author-maintained in the sense of LPPL below -- %% @@ -16,8 +16,8 @@ %% %% http://www.contact-ednotes.sty.de.vu %% -%% \filbreak %% 2012/11/10 -%% === The \ctanpkgref{readprov} Package === +%% % \filbreak %% 2012/11/10 rm. 2013/03/25 +%% === The 'readprov' Package === %% \label{sec:readprov} % \RequirePackage{readprov} %% ---is required for \[|\ReadInfoDate{}|\quad @@ -27,9 +27,11 @@ %% (sections~\ref{sec:readinfo} and \ref{sec:readcheck}) %% % below %% only. -%% Please care for providing it on your own if you need that. +%% Please care for providing \ctanpkgdref{readprov} %% href 2013/03/25 +%% on your own if you need that. %% -%% === Accessing ``Info Date" === +%% === Providing Dates for Comparisons === %% 2013/03/24 +%% ==== Accessing ``Info Date" ==== %% \label{sec:readinfo} %% |\theinfodateof{}| will expand to the first ``word" of the %% `\Provides'\code{...} entry, provided that has been read before: @@ -53,18 +55,22 @@ \ReadFileInfos{#1}\LoadInfoDateOf{#1}} %% TODO provide automatically. %% -%% === Accessing \cs{pdffilemoddate} === +%% ==== Accessing \cs{pdffilemoddate} ==== +%% \label{sec:pdfmod} %% |\pdffilemoddate{}| in the first instance is a \ctanpkgref{pdftex} -%% primitive. With \LuaTeX, \ctanpkgref{pdftexcmds} provides it. +%% primitive. With \LuaTeX, +%% \ctanpkgdref{pdftexcmds} provides it. %% d 2013/03/25 %% Currently, you must care for this yourself before loading the -%% present package. I recommend the \ctanpkgref{filemod} documentation for +%% present package. I recommend the +%% \ctanpkgdref{filemod} documentation for %% d 2013/03/25 %% details about \cs{pdffilemoddate}. %% -%% Otherwise, (with \XeLaTeX) the modification date may be obtained -%% by a (shell) script---the next definitions do \emph{not} deal with -%% the latter situation. Testing against ``today" -%% (|\rawtoday| in Section~\ref{sec:rawtoday}) -%% may be another alternative. +%% %% rm. 2013/03/24: +%% % Otherwise, (with \XeLaTeX) the modification date may be obtained +%% % by a (shell) script---the next definitions do \emph{not} deal with +%% % the latter situation. Testing against ``today" +%% % (|\rawtoday| in Section~\ref{sec:rawtoday}) +%% % may be another alternative. %% %% |\thepdfmoddateof{}| expands to the modification date %% (eight digits separated by two slashes) if `\pdffilemoddate' @@ -83,11 +89,15 @@ %% \httpref{stackoverflow.com/questions/2118972/latex-command-for-last-modified}{% %% \urlfmt{stackoverflow.com}} in another discussion of accessing modification dates, %% including use of scripts. -%% `\string D' deals with the fact that `\pdffilemoddate' returns in ``other" -%% character tokens. +%% `\string D' deals with the fact that `\pdffilemoddate' returns +%% % in %% rm. 2013/03/24 +%% ``other" character tokens. \fi +%% The modification date of according to `\pdffilemoddate' +%% will be available as `\thepdffilemoddate' after +%% `ReadPDFfileModDateOf{}', see \secref{short-refdates}. %% -%% === \cs{rawtoday} === +%% ==== \cs{rawtoday} ==== %% \label{sec:rawtoday} %% % Enabling `\CheckDateOf{}{\rawtoday}': %% |\rawtoday| accesses ``today"'s date as eight digits separated @@ -95,12 +105,13 @@ \newcommand*{\rawtoday}{% \the\year/\two@digits{\the\month}/\two@digits{\the\day}} %% -%% === Comparing === +%% === Comparing Basically === %% \label{sec:readcheck} -%% |\CheckDateOf{}{}| compares 's info date with -%% : +%% |\CheckDateOf{}{}| compares 's \strong{info} date with +%% the \strong{reference} date : \newcommand*{\CheckDateOf}[2]{% -%% We provide a check that does not affect the order with \ctanpkgref{myfilist}. +%% We provide a check that does not affect the order with +%% \ctanpkgdref{myfilist}. %% 2013/03/25 % \ReadFileInfos{#1}% %% The date according to `\Provides' will be accessible as |\theinfodate|: \LoadInfoDateOf{#1}% @@ -113,15 +124,22 @@ \else \FD@datesdiff{#1}% \fi} -%% |\ReadCheckDateOf{}{}| prepends |\ReadFileInfos{}| -%% from the \ctanpkgref{readprov} package (cf. Section~\ref{sec:readprov}): +%% The \strong{reference} date may be either (i)~\emph{today} as accessed +%% by `\rawtoday' (\secref{rawtoday}), (ii)~the \emph{modification} date as accessed +%% by `\pdffilemoddate' (\secref{pdfmod}), (iii)~something \emph{else} relevant, +%% e.g., a modification date determined and inserted by a shell script. +%% %% <- added 2013/03/24 +%% +%% |\ReadCheckDateOf{}{}| \ prepends \ |\ReadFileInfos{}| +%% from the \ctanpkgref{readprov} package (cf. Section~\ref{sec:readprov}), +%% in order to ensure that the \strong{info} date is known: \newcommand*{\ReadCheckDateOf}[1]{% \ReadFileInfos{#1}\CheckDateOf{#1}} %% TODO provide automatically. %% -%% \filbreak -%% === Reporting Styles === -%% By default, there is no report about comparisons finding equality. +%% === Reporting Styles === %% subsections 2013/03/24 +%% ==== Same Dates ==== +%% By default, there is no report about comparisons finding \strong{equality}. \let\FD@datesequal\@gobble %% % We do not want to disturb `\listfiles' with \ctanpkgref{myfilist}. %% %% <- rm. 2012/10/25 @@ -140,8 +158,9 @@ %% |\theinfodateof{#1}|, there is no essential application of %% `\theinfodate' currently. %% -%% After |\DatesDiffErrors|, date differences are reportet ``drastically" -%% by `\PackageError': +%% ==== Differing Dates ==== +%% After |\DatesDiffErrors|, date \strong{differences} +%% are reportet ``drastically" by `\PackageError': \newcommand*{\DatesDiffErrors}{\let\FD@datesdiff\FD@errdatesdiff} %% This is the default: \DatesDiffErrors @@ -158,6 +177,13 @@ \def\FD@warndatesdiff#1{% \PackageWarningNoLine{filedate}% {\FD@infodate{#1}\FD@refdate}} +%% ==== Kinds of Reference Dates ==== +%% When the reference date is `\pdffilemoddate', the report about +%% a comparison may call it a ``modification date". +%% But when the reference date is ``today", it may not be a +%% ``modification date". Otherwise, it depends ... +%% (See \secref{readcheck} for kinds of reference dates.) +%% %% After |\ModDates|, reference dates are called ``modification'' dates: \newcommand*{\ModDates}{\let\FD@refdate\FD@moddate} \def\FD@moddate{\MessageBreak vs. modification date \FD@therefdate} @@ -168,7 +194,32 @@ %% That's the default: \SomeDates %% -%% === Reference Date ``Types" === +%% === Shorthands === +%% %% mod. again 2013/03/25 +%% We may want to compare \emph{info} with \emph{reference} dates for +%% many files. But when the \emph{reference} date is `\pdffilemoddate' +%% for many files +%% (probably the most frequent application, see \secref{pdfmod}), +%% we don't want to state this explicitly for each +%% file---\secref{short-refdates}---neither +%% for other kinds of reference dates. +%% +%% As to enumerating \emph{file names}, the 'filesdo' package +%% from the \ctanpkgdref{commado} bundle should help +%% (combinations of base names and extensions, +%% see \secref{demo-here}; %% 2013/03/25 +%% TODO: shorthands using 'filesdo' could be defined +%% in the present package). +%% +%% The files whose dates we want to check may be just +%% the same that some tries to `\input'. +%% It may me helpful if those input commands trigger the +%% file consistency check without a need to demand this explicitly +%% for each file---the section on ``automatic immediate checking" +%% (\secref{auto-check}) aims at this. +%% +%% ==== Kinds of Reference Dates ==== +%% \label{sec:short-refdates} %% |\ReadPDFmodDateOf{}| enables %% \[|\CheckDateOf{}{\thepdfmoddate}|\] %% by setting |\thepdfmoddate|: @@ -189,7 +240,7 @@ %% \[<4-digits>/<2-digits>/<2-digits>\quad %% (`yyyy/mm/dd')\]---a script might insert it---, %% `\rawtoday', or `\thepdfmoddate'. -%% \ctanpkgref{adhocfilelist} v0.7 (with option \strong{\code{-c}}) +%% \ctanpkgdref{adhocfilelist} v0.7 (with option \strong{\code{-c}}) %% is such a script, a shell script generating a ``\TeX\ script", %% providing the file modification date according to Unix/Linux. \newcommand*{\UseReferenceDate}{\def\thedategiven} @@ -217,7 +268,8 @@ \CheckDateOf{#1}{\rawtoday}% \endgroup} %% -%% === Automatical Immediate Checking === +%% ==== Automatic Immediate Checking ==== +%% \label{sec:auto-check} %% |\FileDateAutoChecks| modifies the \qtdcode{&\Provides...} %% commands internally so that they check their date with %% with the file's modification date according to @@ -231,34 +283,114 @@ %% `\@profidesfile' are used as hooks. Their original meanings %% are stored so they can be regained by \qtd{&\NoFile...}: \let\FD@@provpkg\@pr@videpackage -\def\FD@provpkg[#1]{% - \FD@@provpkg[#1]% - \CheckDateOfPDFmod{\@currname.\@currext}} +\def\FD@provpkg[#1]{\FD@@provpkg[#1]% + \CheckDateOfPDFmod{\@currname.\@currext}} \let\FD@@provfile\@providesfile -\def\FD@provfile#1[#2]{% - \FD@@provfile{#1}[#2]% - \CheckDateOfPDFmod{#1}} +\def\FD@provfile#1[#2]{\FD@@provfile{#1}[#2]% + \CheckDateOfPDFmod{#1}} %% |\FileDateAutoChecks*| in addition to `\FileDateAutoChecks' %% checks the main file's info date, -%% assuming the main file is `\jobname.tex': +%% assuming the main file is `\jobname.tex' +%% (TODO): %% 2013/03/25 cf. \@iinput \newcommand*{\FileDateAutoChecks}{% - \@ifstar{\CheckDateOfPDFmod{\jobname.tex}% - \FD@autochecks}% - {\FD@autochecks}} -\newcommand*{\FD@autochecks}{% - \let\@pr@videpackage\FD@provpkg - \let\@providesfile\FD@provfile} -\newcommand*{\NoFileDateAutoChecks}{% - \let\@pr@videpackage\FD@@provpkg - \let\@providesfile\FD@@provfile} + \@ifstar{{\FD@check@pdf@job\FD@autochecks}\FD@autochecks}% + \FD@autochecks} +%% |\FD@check@pdf@job| is introduced in v0.41 for the +%% ``restricted" automatic checks below. +\newcommand*{\FD@check@pdf@job}{\CheckDateOfPDFmod{\jobname.tex}} +\newcommand*{\FD@autochecks}{\let\@pr@videpackage\FD@provpkg + \let\@providesfile\FD@provfile} +\newcommand*{\NoFileDateAutoChecks}{\let\@pr@videpackage\FD@@provpkg + \let\@providesfile \FD@@provfile} %% -%% TODO single check commands for comma-separated list of files, -%% (\ctanpkgref{dowith}) +%% However, see \secref{auto-level} for \strong{problems} +%% of the previous idea +%% (unless using \ctanpkgdref{fileinfo}, i.e., 'readprov' or even 'myfilist'). %% -%% === Leaving the Package File === -\endinput +%% \pagebreak %% 2013/03/25 +%% ==== Level-Restricted Automatic Checking ==== %% 2013/03/25 +%% \label{sec:auto-level} +%% The present package is made to ensure ``date consistency" +%% of files that the user maintains/edits. By contrast, +%% date consistency cannot be expected for \LaTeX\ package +%% files that were generated by \ctanpkgdref{docstrip} +%% (many days after the `.dtx' source was released). +%% No date consistency checks should be applied to such files. +%% (The ``criticism" of the present section does not apply to +%% usage with \ctanpkgref{fileinfo}, and the commands presented +%% here \emph{disable} 'fileinfo', so don't use them with 'fileinfo'.) +%% +%% The problem with `\FileDateAutoChecks' (\secref{auto-check}) is, +%% e.g., that a chapter file for a book that is `\include'd by +%% the master file may trigger loading a font definition file +%% (`.fd')---that is not date-consistent, though the test is +%% applied to it. We now aim at checking only those files +%% that are input by the file that contains the call, +%% not to files that are input indirectly. +%% We use `\InputIfFileExists' as a hook for this. +%% This should affect \emph{\LaTeX} user commands for file inclusion, +%% even for (the user's) packages and class files. +%% It does \emph{not} affect the version of `\input' without braces. +%% The commands for this purpose are |\FileDateLevelChecks|, +%% |\FileDateLevelChecks*|, and |\NoFileDateLevelChecks| +%% (replacing `Auto' by `Level' for analogy to the commands +%% of \secref{auto-check}). +%% +%% The implementation is somewhat recursive, or ``counter-recursive"? +\def\FD@level@provpkg [#1]{\FD@provpkg[#1]% + \NoFileDateLevelChecks} +\def\FD@level@provfile#1[#2]{\FD@provfile{#1}[#2]% + \NoFileDateLevelChecks} +%% |\FD@userchecks@| is introduced for \secref{auto-user}: +\newcommand*{\FD@userchecks@}{\let\@pr@videpackage\FD@level@provpkg + \let\@providesfile\FD@level@provfile} +\newcommand*{\FD@levelchecks}{\FD@userchecks@ + \let\InputIfFileExists\FD@input@if@f@ex} +\let\FD@@input@if@f@ex\InputIfFileExists +\newcommand{\FD@input@if@f@ex}[3]{\FD@@input@if@f@ex{#1}{#2}{#3}% + \FD@levelchecks} +\newcommand*{\FileDateLevelChecks}{% + \@ifstar{\CheckDateOfPDFmod{\jobname.tex}\FD@levelchecks}% + \FD@levelchecks} +\newcommand*{\NoFileDateLevelChecks}{% + \NoFileDateAutoChecks \let\InputIfFileExists\FD@@input@if@f@ex} +%% Section \ref{sec:auto-user} introduces another idea +%% to avoid checking of \LaTeX\ package files. %% -%% === VERSION HISTORY === +%% ==== User-Restricted Automatic Checking ==== %% 2013/03/26 +%% \label{sec:auto-user} +%% Another idea to avoid checking of \LaTeX\ package files +%% while checking `\input' files automatically are +%% |\FileDateUserChecks| and |\FileDateUserChecks*| +%% only affecting user transclusion commands %%% such as +%% `\include{}' and `\input{}' while allowing +%% nesting, i.e., e.g., even an `\input{}' in an +%% `\include'd file is checked automatically. +%% (See \secref{auto-level} if you do not remember what is +%% bad with \secref{auto-check}.) +\let\FD@@iinput\@iinput \let\FD@@include\@include +%% Using definitions from above: +\newcommand*{\FD@userchecks}{% +%% `\@iinput' is \LaTeX's internal behind `\input': + \def\@iinput##1{% + \FD@userchecks@\FD@@iinput{##1}\NoFileDateAutoChecks}% +%% `\@include' is \LaTeX's internal behind `\include'. +%% Its argument is limited by a space: + \def\@include##1 {% + \FD@userchecks@\FD@@include##1 \NoFileDateAutoChecks}} +%% Temporary switching off `\FD@provpkg' and `\FD@provfile' +%% is doubled to deal with files that don't have a +%% `\Provides' entry. +\newcommand*{\FileDateUserChecks}{% + \@ifstar{\FD@check@pdf@job\FD@userchecks}\FD@userchecks} +\newcommand*{\NoFileDateUserChecks}{% + \let\@iinput\FD@@iinput \let\@include\FD@@include} +%% TODO `\usepackage', `\documentclass'? +%% +%% === Leaving the Package File === +\endinput +%% \pagebreak %% 2013/03/25 +%% === VERSION HISTORY === v0.1 2012/10/15 core try, bad v0.2 2012/10/16 code for first release @@ -275,3 +407,9 @@ v0.4 2012/11/10 \fd@ -> \FD@, doc. v0.7 -> v0.3, v0.21, \filbreak; code for \...AutoChecks 2012/11/11 doc. another \filbreak, documenenting \...AutoChecks, \...AutoChecks* +v0.41 2013/03/24 doc. restructured and extended + 2013/03/25 ... continued; section with \FileDateLevelChecks + etc., \@ifstar without braces; + doc. automatical ("archaic") -> automatic, + reducing numbers of lines + 2013/03/26 \FileDateUserChecks etc., \FD@check@pdf@job -- cgit v1.2.3