xr-hyper.sty

%% xr-hyper package (beta release)

%% Copyright (C) 1993-2023 David Carlisle

%% This is a modified version of the xr package from the Standard LaTeX
%% tools distribution. It has some internal changes to cooperate with
%% the hyperref package, and one new user level argument, also mainly of
%% use for hyperref.
%% If no problems are reported the version in the tools distribution
%% will be updated to match this at the next LaTeX release.

%% \externaldocument[prefix][nocite]{document}[URL]

%% The `document' referred to by the main argument is the file
%% document.aux
%% which must be somewhere on TeX's input path.
%% Some packages (eg hyperref) really need to know the location of the
%% final document rather than the aux file. By default this is assumed
%% to be `document.pdf'. A package may redefine the command \XR@ext to
%% change this default extension. However sometimes the final
%% document may be in a position unrelated to the aux file, or the
%% browser may not be able to find files at an arbitrary point in
%% TeX's input path, so the new final optional argument allows a full
%% URL to the final document to be specified.
%%
%% \externaldocument{file}[http://here.xxx.edu/this/path/to/file.pdf]
%%
%% Version beta2 also added another improvement unrelated
%% to the hyperref support. Olivier Michel pointed out that
%% if the aux file was not on texinputs you could not always go
%% \externaldocument{/some/path/to/file}
%% specifically that worked if file.aux was a `simple'  document with
%% one aux file, but if \include had been used, the `sub' aux files
%% would not be found by xr in the remote directory.
%% This version calls \filename@parse to get the directory name of the
%% remote directory, which is then explicitly prepended to the names of
%% any included aux files.
%%
%%
%% Version 6.1 incorporates linking to citations in external documents
%% (originally from xcite package and now included in xr.
%%
%% Many packages have variant citation commands (natbib,
%% biblatex,....) and the external document may or may not have used
%% hyperref. Because of these differences the citation linking may not
%% always work, it can be disabled by specifying [nocite] after the
%% prefix:
%%
%%  \externaldocument[][nocite]{somefile}
%%
%% In the case of \ref, if the external document has not used
%% hyperref, this package will work like xr and produce the correct
%% text, but can not produce a well formed link as the target document
%% is not set up. In this case you may prefer to use \ref* rather than
%% \ref to avoid generating a hyperlink.
%%
%%
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{xr-hyper}
         [2023-07-08 v7.01b eXternal References (DPC)]

\def\externaldocument{\@testopt\XR@cite{}}
\let\externalcitedocument\externaldocument
\def\XR@cite[#1]{\@testopt{\XR@[#1]}{}}
\def\XR@[#1][#2]#3{\@testopt{\XR@@{#1}{#2}{#3}}{#3.\XR@ext}}

\def\XR@@#1#2#3[#4]{{%
  \makeatletter
  \def\XR@prefix{#1}%
   \def\XR@nocite{#2}%
   \ifx\XR@nocite\XR@@nocite
     \let\XR@bibcite\vadjust
   \else
     \let\XR@bibcite\bibcite
   \fi
  \def\XR@useURL{}%  
  \def\XR@URL{#4}%
  \filename@parse{#3}%
  \XR@next#3.aux\relax\\}}
\def\XR@@nocite{nocite}
\def\XR@next#1\relax#2\\{%
  \edef\XR@list{#2}%
  \XR@loop{#1}}
\def\XR@aux{%
  \ifx\XR@list\@empty\else\expandafter\XR@explist\fi}

\long\def\@gobblethree  #1#2#3{}
\long\def\@firstofthree #1#2#3{#1}
\long\def\@secondofthree#1#2#3{#2}
\long\def\@thirdofthree #1#2#3{#3}

% 2023-05-13 we need to handle \newlabel's with two arguments differently
% to \newlabel's with five argument. For this we make use of  
% XR@addURL:
\def\XR@addURL#1{\XR@@dURL#1{}{}{}{}\\}
\def\XR@@dURL#1#2#3#4#5\\{%
     {#1}{#2}%
     \if!#4!%
      {#3}{#4}{}% new perhaps this could use \XR@URL too?
     \else
      {#3}{#4}{\XR@useURL}%
    \fi
  }%

\def\XR@explist{\expandafter\XR@next\XR@list\\}
\def\XR@loop#1{%
\openin\@inputcheck#1\relax
  \ifeof\@inputcheck
    \PackageWarning{xr}{^^JNo file #1^^JLABELS NOT IMPORTED.^^J}%
    \expandafter\XR@aux
  \else
    \PackageInfo{xr}{IMPORTING LABELS FROM #1}%
    \let\XR@testnewlabel\XR@testnewlabel@aux
    \expandafter\XR@read\fi}
\def\XR@read{%
  \read\@inputcheck to\XR@line
  \expandafter\XR@test\XR@line...\XR@}
% 2019 update to match xr
\long\def\XR@test#1#2#3#4\XR@{%
  \let\XR@tempa\@gobblethree
% we set the file name only if the target has actually destinations.
% for this we test if hyperref has been used.  
  \ifx#1\HyperFirstAtBeginDocument
    \let\XR@useURL\XR@URL
  \fi
  \ifx#1\newlabel
    \let\XR@tempa\@firstofthree
  \else\ifx#1\XR@bibcite
    \let\XR@tempa\@secondofthree
  \else\ifx#1\@input
     \let\XR@tempa\@thirdofthree
  \fi\fi\fi
   \XR@tempa
    {%
     \expandafter\protected@xdef\csname r@\XR@prefix#2\endcsname{\XR@addURL{#3}}%     
    }%
    {\expandafter\bibcite\expandafter{\XR@prefix#2}{#3}}%
    {\edef\XR@list{\XR@list\filename@area#2\relax}}%
  \ifeof\@inputcheck\expandafter\XR@aux
  \else\expandafter\XR@read\fi}


\providecommand\XR@ext{pdf}

\endinput
%%
%% End of file `xr-hyper.sty'.


%% History
%%
%% 1997/10/06 v6.00 beta2
%%
%% 1999/09/01 v6.00 beta3
%%   Definitions of \XR@addURL corrected (Heiko Oberdiek).
%%
%% 2000/03/22 v6.00 beta4
%%   \xdef changed to \protected@xdef.
%%
%% 2019/10/03 v6.1
%%   Incorporate updates to xr (including citation support)
%%
%% 2020-05-14 v7.00e
%%   add additional braces to \r@ only if hyperref is not detected in the aux
%%   of the source document (https://github.com/latex3/hyperref/issues/118)
%% 
%% 2023-05-15 v.7.00z
%%  unified and simplified the brace handling: all defined references have now
%%  five brace groups. Together with the planed change in LaTeX 2023-06-01 this
%%  will improve the combination of hyperref/non-hyperref documents.