Adapt the counter redefinitions to the changes in the next release (#358

) * avoid warning if theHfootnote is defined * keep previous value * adapt to new format * adapt to refstepcounter format change * restore theHHmpfootnote
latex3 · Oct 29, 2024 · c744dba · c744dba
1 parent f364992
commit c744dba
Show file tree

Hide file tree

Showing 9 changed files with 112 additions and 53 deletions.
diff --git a/ChangeLog.txt b/ChangeLog.txt
@@ -1,3 +1,11 @@
+Version: 2024-10-14 v7.01k
+
+2024-10-14 Ulrike Fischer
+	* hyperref.dtx: adapt to new format (predefined \theHcounter, sockets)
+
+2024-10-12 Ulrike Fischer
+	* hyperref.dtx: avoid warning if theHfootnote is predefined.
+
 2024-08-31 Ulrike Fischer
 	* hyperref-linktarget.dtx: correct a test, see test missing-theH 
 

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # README for hyperref bundle
 
-Version 2024-07-10 v7.01j
+Version 2024-10-12 v7.01k
 
 ## INTRODUCTION
 

diff --git a/doc/hyperref-doc.tex b/doc/hyperref-doc.tex
@@ -166,7 +166,7 @@
 }
 \makeatother
 \title{Hypertext marks in \hologo{LaTeX}: a manual for \xpackage{hyperref}}
-\date{2024-07-10 v7.01j}
+\date{2024-10-12 v7.01k}
 
 \begin{document}
 

diff --git a/hluatex.dtx b/hluatex.dtx
@@ -1,6 +1,6 @@
 % \iffalse
 % Source File: hluatex.dtx
-% 2024-07-10 v7.01j
+% 2024-10-12 v7.01k
 %
 % Copyright
 % 2016-2019 Oberdiek Package Support Group
@@ -31,7 +31,7 @@
 %
 %    \begin{macrocode}
 %<*luatex>
-%% 2024-07-10 v7.01j
+%% 2024-10-12 v7.01k
 %% force unicode encoding, see issue #101
 %% code mostly copied from hxetex.def
 \HyPsd@LoadUnicode

diff --git a/hyperref-linktarget.dtx b/hyperref-linktarget.dtx
@@ -52,7 +52,7 @@
 %    }^^A
 % }
 %
-% \date{Version 2024-07-10 v7.01j}
+% \date{Version 2024-10-12 v7.01k}
 %
 % \maketitle
 % \begin{documentation}

diff --git a/hyperref-patches.dtx b/hyperref-patches.dtx
@@ -50,7 +50,7 @@
 %    }^^A
 % }
 %
-% \date{Version 2024-07-10 v7.01j}
+% \date{Version 2024-10-12 v7.01k}
 %
 % \maketitle
 % \begin{documentation}

diff --git a/hyperref.dtx b/hyperref.dtx
@@ -51,7 +51,7 @@
 %<puvnenc>\ProvidesFile{puvnenc.def}
 %<puarenc>\ProvidesFile{puarenc.def}
 %<psdextra>\ProvidesFile{psdextra.def}
-%<!none&!packageEnd>  [2024-07-10 v7.01j %
+%<!none&!packageEnd>  [2024-10-12 v7.01k %
 %<package>  Hypertext links for LaTeX]
 %<nohyperref>  Dummy hyperref (SR)]
 %<driver>  Hyperref documentation driver file]
@@ -10293,29 +10293,35 @@
     \fi
   \fi
 }
-\Hy@CounterExists{section}{%
-  \providecommand\theHequation{\theHsection.\arabic{equation}}%
-}
-\providecommand\theHequation{\arabic{equation}}%
-\Hy@CounterExists{part}{%
-  \providecommand\theHpart{\arabic{part}}%
-}
-\@ifundefined{thechapter}{%
-  \providecommand\theHsection    {\arabic{section}}%
-  \providecommand\theHfigure     {\arabic{figure}}%
-  \providecommand\theHtable      {\arabic{table}}%
-}{%
-  \providecommand\theHchapter    {\arabic{chapter}}%
-  \providecommand\theHfigure     {\theHchapter.\arabic{figure}}%
-  \providecommand\theHtable      {\theHchapter.\arabic{table}}%
-  \providecommand\theHsection    {\theHchapter.\arabic{section}}%
-}
-\providecommand\theHsubsection   {\theHsection.\arabic{subsection}}
-\providecommand\theHsubsubsection{\theHsubsection.\arabic{subsubsection}}
-\providecommand\theHparagraph    {\theHsubsubsection.\arabic{paragraph}}
-\providecommand\theHsubparagraph {\theHparagraph.\arabic{subparagraph}}
-\providecommand\theHtheorem      {\theHsection.\arabic{theorem}}
-\providecommand\theHthm          {\theHsection.\arabic{thm}}
+%    \end{macrocode}
+% change 2024-10-13: do not define if format is new enough.
+%    \begin{macrocode}
+\IfFormatAtLeastTF{2024-11-01}{}
+ {
+    \Hy@CounterExists{section}{%
+      \providecommand\theHequation{\theHsection.\arabic{equation}}%
+    }
+    \providecommand\theHequation{\arabic{equation}}%
+    \Hy@CounterExists{part}{%
+      \providecommand\theHpart{\arabic{part}}%
+    }
+    \@ifundefined{thechapter}{%
+      \providecommand\theHsection    {\arabic{section}}%
+      \providecommand\theHfigure     {\arabic{figure}}%
+      \providecommand\theHtable      {\arabic{table}}%
+    }{%
+      \providecommand\theHchapter    {\arabic{chapter}}%
+      \providecommand\theHfigure     {\theHchapter.\arabic{figure}}%
+      \providecommand\theHtable      {\theHchapter.\arabic{table}}%
+      \providecommand\theHsection    {\theHchapter.\arabic{section}}%
+    }
+    \providecommand\theHsubsection   {\theHsection.\arabic{subsection}}
+    \providecommand\theHsubsubsection{\theHsubsection.\arabic{subsubsection}}
+    \providecommand\theHparagraph    {\theHsubsubsection.\arabic{paragraph}}
+    \providecommand\theHsubparagraph {\theHparagraph.\arabic{subparagraph}}
+    \providecommand\theHtheorem      {\theHsection.\arabic{theorem}}
+    \providecommand\theHthm          {\theHsection.\arabic{thm}}
+  }  
 %    \end{macrocode}
 % Thanks to Greta Meyer ([email protected]) for making me realize
 % that enumeration starts at 0 for every list! But |\item|
@@ -10324,7 +10330,8 @@
 %    \begin{macrocode}
 \let\H@item\item
 \newcounter{Item}
-\def\theHItem{\arabic{Item}}
+\IfFormatAtLeastTF{2024-11-01}{}
+ {\def\theHItem{\arabic{Item}}}
 \def\item{%
   \@hyper@itemfalse
   \if@nmbrlist\@hyper@itemtrue\fi
@@ -10333,23 +10340,23 @@
 %    \end{macrocode}
 %
 %    \begin{macrocode}
-\providecommand\theHenumi     {\theHItem}
-\providecommand\theHenumii    {\theHItem}
-\providecommand\theHenumiii   {\theHItem}
-\providecommand\theHenumiv    {\theHItem}
-\providecommand\theHHfootnote {\arabic{Hfootnote}}
-\providecommand\theHmpfootnote{\arabic{mpfootnote}}
-\@ifundefined{theHHmpfootnote}{%
-  \let\theHHmpfootnote\theHHfootnote
-}{}
+\IfFormatAtLeastTF{2024-11-01}{}
+ {
+   \providecommand\theHenumi     {\theHItem}
+   \providecommand\theHenumii    {\theHItem}
+   \providecommand\theHenumiii   {\theHItem}
+   \providecommand\theHenumiv    {\theHItem}
+   \providecommand\theHHfootnote {\arabic{Hfootnote}}
+   \providecommand\theHmpfootnote{\arabic{mpfootnote}}
+ }  
 %    \end{macrocode}
 % Tanmoy asked for this default handling of undefined |\theH<name>|
 % situations. It really isn't clear what would be ideal, whether to
 % turn off hyperizing of unknown elements, to pick up the textual
 % definition of the counter, or to default it to something like
 % |\arabic{name}|. We take the latter course, slightly worriedly.
 %    \begin{macrocode}
-\let\H@refstepcounter\refstepcounter
+\let\H@refstepcounter\@kernel@refstepcounter
 \edef\name@of@eq{equation}%
 %    \end{macrocode}
 % We do not want the handler for |\refstepcounter| to cut in
@@ -10366,11 +10373,13 @@
 \@hyper@itemfalse
 \@skiphyperreffalse
 \ExplSyntaxOn
-\def\refstepcounter#1{%
-  \legacy_if:nF {Hy@pdfstring}
-   {
-    \H@refstepcounter{#1}%
-    \bool_lazy_and:nnT
+\IfFormatAtLeastTF{2024-11-01}
+ {
+  \NewSocketPlug{refstepcounter}{hyperref}{\ifHy@pdfstring\else#1\fi}
+  \AssignSocketPlug{refstepcounter}{hyperref}
+  \NewSocketPlug{refstepcounter/target}{hyperref}
+    {   
+      \bool_lazy_and:nnT
       { \l__hyp_target_create_bool }
       { ! \legacy_if_p:n{@skiphyperref} }
       {
@@ -10381,11 +10390,34 @@
             \@hyper@itemfalse
           }
           {
-            \hyper@refstepcounter{#1}%
+            \hyper@refstepcounter{\@currentcounter}%
           }
-      }
-   }
-}
+       }
+     }
+    \AssignSocketPlug{refstepcounter/target}{hyperref} 
+  }
+  {
+    \def\refstepcounter#1{%
+      \legacy_if:nF {Hy@pdfstring}
+       {
+        \H@refstepcounter{#1}%
+        \bool_lazy_and:nnT
+          { \l__hyp_target_create_bool }
+          { ! \legacy_if_p:n{@skiphyperref} }
+          {
+            \legacy_if:nTF {@hyper@item}
+              {
+                \stepcounter{Item}%
+                \hyper@refstepcounter{Item}%
+                \@hyper@itemfalse
+              }
+              {
+                \hyper@refstepcounter{#1}%
+              }
+          }
+       }
+     }
+  }
 \ExplSyntaxOff
 \let\Hy@saved@refstepcounter\refstepcounter
 %    \end{macrocode}
@@ -11031,7 +11063,19 @@
 %    \begin{macrocode}
 \@ifundefined{hyper@nopatch@footnote}{%
 \ifHy@hyperfootnotes
-  \newcounter{Hfootnote}%
+  \@ifundefined{theHfootnote}
+   {\newcounter{Hfootnote}}
+   {\let\H@@theHfootnote\theHfootnote
+    \let\theHfootnote\undefined
+    \newcounter{Hfootnote}
+    \let\theHfootnote\H@@theHfootnote
+   }% 
+%    \end{macrocode}
+% where is this used?
+%    \begin{macrocode}
+  \@ifundefined{theHHmpfootnote}{%
+   \let\theHHmpfootnote\theHHfootnote
+   }{}    
   \let\H@@footnotetext\@footnotetext
   \let\H@@footnotemark\@footnotemark
   \def\@xfootnotenext[#1]{%
@@ -11383,6 +11427,11 @@
           }%
           #3%
         \fi
+%    \end{macrocode}
+% as the anchor are set manually here, we have to update the tagging info.
+% For now we test for the format but this should go again in 2025.
+%    \begin{macrocode}
+        \IfFormatAtLeastTF{2024-11-01}{\UseTaggingSocket{recordtarget}}{}%        
       }%
     \fi
     \par
@@ -12017,7 +12066,9 @@
 % new counters are defined.
 % change 2024-02-14: use a csname to handle counter names with commands,
 % see issue \#330
+% change 2024-10-13: disable patches in new format 2024-11-01.
 %    \begin{macrocode}
+\IfFormatAtLeastTF{2024-11-01}{\def\hyper@nopatch@counter{}}{}
 \@ifundefined{hyper@nopatch@counter}
   {
    \let\H@definecounter\@definecounter

diff --git a/testfiles-pdftex/patch.tlg b/testfiles-pdftex/patch.tlg
@@ -33,7 +33,7 @@ l. ...\ShowCommand\@footnotetext
 <argument> \caption 
 l. ...\ShowCommand\caption
 > \@caption=\long macro:
-#1[#2]#3->\expandafter \ifx \csname if@capstart\expandafter \endcsname \csname iftrue\endcsname \global \let \@currentHref \hc@currentHref \else \hyper@makecurrent {\@captype }\fi \@ifundefined {NR@gettitle}{\def \@currentlabelname {#2}}{\NR@gettitle {#2}}\par \addcontentsline {\csname ext@#1\endcsname }{#1}{\protect \numberline {\csname the#1\endcsname }{\ignorespaces #2}}\begingroup \@parboxrestore \if@minipage \@setminipage \fi \normalsize \expandafter \ifx \csname if@capstart\expandafter \endcsname \csname iftrue\endcsname \global \@capstartfalse \@makecaption {\csname fnum@#1\endcsname }{\ignorespaces #3}\else \@makecaption {\csname fnum@#1\endcsname }{\ignorespaces \ifHy@nesting \expandafter \hyper@@anchor \expandafter {\@currentHref }{#3}\else \Hy@raisedlink {\expandafter \hyper@@anchor \expandafter {\@currentHref }{\relax }}#3\fi }\fi \par \endgroup .
+#1[#2]#3->\expandafter \ifx \csname if@capstart\expandafter \endcsname \csname iftrue\endcsname \global \let \@currentHref \hc@currentHref \else \hyper@makecurrent {\@captype }\fi \@ifundefined {NR@gettitle}{\def \@currentlabelname {#2}}{\NR@gettitle {#2}}\par \addcontentsline {\csname ext@#1\endcsname }{#1}{\protect \numberline {\csname the#1\endcsname }{\ignorespaces #2}}\begingroup \@parboxrestore \if@minipage \@setminipage \fi \normalsize \expandafter \ifx \csname if@capstart\expandafter \endcsname \csname iftrue\endcsname \global \@capstartfalse \@makecaption {\csname fnum@#1\endcsname }{\ignorespaces #3}\else \@makecaption {\csname fnum@#1\endcsname }{\ignorespaces \ifHy@nesting \expandafter \hyper@@anchor \expandafter {\@currentHref }{#3}\else \Hy@raisedlink {\expandafter \hyper@@anchor \expandafter {\@currentHref }{\relax }}#3\fi \IfFormatAtLeastTF {....-..-..}{\UseTaggingSocket {recordtarget}}{}}\fi \par \endgroup .
 <argument> \@caption 
 l. ...\ShowCommand\@caption
 > \addcontentsline=macro:

diff --git a/xr-hyper.dtx b/xr-hyper.dtx
@@ -26,7 +26,7 @@
 %
 %<package>\NeedsTeXFormat{LaTeX2e}
 %<package>\ProvidesPackage{xr-hyper}
-%<package>         [2024-07-10 v7.01j eXternal References (DPC)]
+%<package>         [2024-10-12 v7.01k eXternal References (DPC)]
 %
 %<*driver>
 \documentclass{l3doc}