% \iffalse meta-comment
%
% Copyright (C) 2007 by Heiko Oberdiek <oberdiek@uni-freiburg.de>
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.3 of this license or (at your option) any later
% version. The latest version of this license is in
%    http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of
% LaTeX version 2005/12/01 or later.
%
% This work has the LPPL maintenance status "maintained".
%
% This Current Maintainer of this work is Heiko Oberdiek.
%
% This work consists of the main source file pdfcolfoot.dtx
% and the derived files
%    pdfcolfoot.sty, pdfcolfoot.pdf, pdfcolfoot.ins, pdfcolfoot.drv.
%
% Distribution:
%    CTAN:macros/latex/contrib/oberdiek/pdfcolfoot.dtx
%    CTAN:macros/latex/contrib/oberdiek/pdfcolfoot.pdf
%
% Unpacking:
%    (a) If pdfcolfoot.ins is present:
%           tex pdfcolfoot.ins
%    (b) Without pdfcolfoot.ins:
%           tex pdfcolfoot.dtx
%    (c) If you insist on using LaTeX
%           latex \let\install=y\input{pdfcolfoot.dtx}
%        (quote the arguments according to the demands of your shell)
%
% Documentation:
%    (a) If pdfcolfoot.drv is present:
%           latex pdfcolfoot.drv
%    (b) Without pdfcolfoot.drv:
%           latex pdfcolfoot.dtx; ...
%    The class ltxdoc loads the configuration file ltxdoc.cfg
%    if available. Here you can specify further options, e.g.
%    use A4 as paper format:
%       \PassOptionsToClass{a4paper}{article}
%
%    Programm calls to get the documentation (example):
%       pdflatex pdfcolfoot.dtx
%       makeindex -s gind.ist pdfcolfoot.idx
%       pdflatex pdfcolfoot.dtx
%       makeindex -s gind.ist pdfcolfoot.idx
%       pdflatex pdfcolfoot.dtx
%
% Installation:
%    TDS:tex/latex/oberdiek/pdfcolfoot.sty
%    TDS:doc/latex/oberdiek/pdfcolfoot.pdf
%    TDS:source/latex/oberdiek/pdfcolfoot.dtx
%
%<*ignore>
\begingroup
  \def\x{LaTeX2e}
\expandafter\endgroup
\ifcase 0\ifx\install y1\fi\expandafter
         \ifx\csname processbatchFile\endcsname\relax\else1\fi
         \ifx\fmtname\x\else 1\fi\relax
\else\csname fi\endcsname
%</ignore>
%<*install>
\input docstrip.tex
\Msg{************************************************************************}
\Msg{* Installation}
\Msg{* Package: pdfcolfoot 2007/01/08 v1.0 pdfTeX's color stack for footnotes (HO)}
\Msg{************************************************************************}

\keepsilent
\askforoverwritefalse

\preamble

This is a generated file.

Copyright (C) 2007 by Heiko Oberdiek <oberdiek@uni-freiburg.de>

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.3 of this license or (at your option) any later
version. The latest version of this license is in
   http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of
LaTeX version 2005/12/01 or later.

This work has the LPPL maintenance status "maintained".

This Current Maintainer of this work is Heiko Oberdiek.

This work consists of the main source file pdfcolfoot.dtx
and the derived files
   pdfcolfoot.sty, pdfcolfoot.pdf, pdfcolfoot.ins, pdfcolfoot.drv.

\endpreamble

\generate{%
  \file{pdfcolfoot.ins}{\from{pdfcolfoot.dtx}{install}}%
  \file{pdfcolfoot.drv}{\from{pdfcolfoot.dtx}{driver}}%
  \usedir{tex/latex/oberdiek}%
  \file{pdfcolfoot.sty}{\from{pdfcolfoot.dtx}{package}}%
}

\obeyspaces
\Msg{************************************************************************}
\Msg{*}
\Msg{* To finish the installation you have to move the following}
\Msg{* file into a directory searched by TeX:}
\Msg{*}
\Msg{*     pdfcolfoot.sty}
\Msg{*}
\Msg{* To produce the documentation run the file `pdfcolfoot.drv'}
\Msg{* through LaTeX.}
\Msg{*}
\Msg{* Happy TeXing!}
\Msg{*}
\Msg{************************************************************************}

\endbatchfile
%</install>
%<*ignore>
\fi
%</ignore>
%<*driver>
\NeedsTeXFormat{LaTeX2e}
\ProvidesFile{pdfcolfoot.drv}%
  [2007/01/08 v1.0 pdfTeX's color stack for footnotes (HO)]
\documentclass{ltxdoc}
\usepackage{holtxdoc}
\begin{document}
  \DocInput{pdfcolfoot.dtx}
\end{document}
%</driver>
% \fi
%
% \CheckSum{249}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
% \GetFileInfo{pdfcolfoot.drv}
%
% \title{The \xpackage{pdfcolfoot} package}
% \date{2007/01/08 v1.0}
% \author{Heiko Oberdiek\\\xemail{oberdiek@uni-freiburg.de}}
%
% \maketitle
%
% \begin{abstract}
% Since version 1.40 \pdfTeX\ supports several color stacks. This
% package uses a separate color stack for footnotes that can break
% across pages.
% \end{abstract}
%
% \tableofcontents
%
% \section{User interface}
%
% Just load the package:
% \begin{quote}
% |\usepackage{pdfcolfoot}|
% \end{quote}
% The package assigns a color stack for footnotes and patches
% the appropriate internal macros to support this color stack.
%
% \subsection{Other packages or classes}
%
% This package \xpackage{pdfcolfoot} redefines \cs{@makecol}
% and \cs{@makefntext}.
% This can cause conflicts if other packages or classes also change
% these macro in an incompatible way. Sometimes it can help
% to change the package order.
%
% \section{Interface for package or class writers}
%
% Two macros \cs{pdfcolfoot@switch} and \cs{pdfcolfoot@current}
% need to be added to get support of the color stack for footnotes.
% This package \xpackage{pdfcolfoot} already patches many macros
% to add these two macros. If a package or class that deals
% with \cs{@makefntext} or \cs{@makecol} is not recognized by
% this package, the package/class author can add these two
% macros in his package/class.
%
% \subsection{Macro \cs{pdfcolfoot@switch}}
%
% Color commands inside footnotes should use the special
% color stack for footnotes. Macro \cs{pdfcolfoot@switch}
% sets this special color stack. (It can be called several
% times). But caution, footnotes for minipages should not
% be affected. This package patches \cs{@makefntext} for
% this purpose.
%
% \subsection{Macro \cs{pdfcolfoot@current}}
%
% In \LaTeX\ the footnote stuff goes into box \cs{footins}
% that is placed on the page (\cs{@makecol}).
% Two things need consideration:
% \begin{itemize}
% \item The footnote area should not interfere with the normal
%   color stack. Macro \cs{normalcolor} inside a group helps
%   it stores the current color of the normal stack and
%   restores it after the group.
% \item If a footnote is broken across a page boundary, we
%   need the latest color of the footnote area in the previous page.
%   This is set by macro \cs{pdfcolfoot@current}.
% \end{itemize}
% As example the changes for \cs{@makecol} are shown (however
% this macro is already patched by this package):
%\begin{quote}
%\begin{verbatim}
%\gdef\@makcol{%
%  ...
%  \setbox\@outputbox\vbox{% or similar
%    ...
%    \color@begingroup
%      \normalcolor
%      \footnoterule % using normal color (black)
%      \csname pdfcolfoot@current\endcsname
%      \unvbox\footins
%    \color@endgroup
%  }%
%  ...
%}
%\end{verbatim}
%\end{quote}
% We use \cs{csname} to call macro \cs{pdfcolfoot@current}.
% If package \xpackage{pdfcolfoot} is not loaded, \cs{pdfcolfoot@current}
% is not defined. In this case \cs{csname} defines the undefined
% macro with meaning \cs{relax} and we do not get an error because
% of undefined command.
%
% \StopEventually{
% }
%
% \section{Implementation}
%
% \subsection{Identification}
%
%    \begin{macrocode}
%<*package>
\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{pdfcolfoot}%
  [2007/01/08 v1.0 pdfTeX's color stack for footnotes (HO)]
%    \end{macrocode}
%
% \subsection{Initial checks}
%
% \subsubsection{Check for \pdfTeX\ in PDF mode}
%    \begin{macrocode}
\RequirePackage{ifpdf}
\ifpdf
\else
  \PackageWarningNoLine{pdfcolfoot}{%
    Loading aborted, because pdfTeX is not running in PDF mode%
  }%
  \expandafter\endinput
\fi
%    \end{macrocode}
%
% \subsubsection{Check \pdfTeX\ version}
%    \begin{macrocode}
\begingroup\expandafter\expandafter\expandafter\endgroup
\expandafter\ifx\csname pdfcolorstackinit\endcsname\relax
  \PackageWarningNoLine{pdfcolfoot}{%
    Your pdfTeX version does not support color stacks%
  }%
  \expandafter\endinput
\fi
%    \end{macrocode}
%
% \subsubsection{Check \xfile{pdftex.def} version}
%    Force loading of package color with \xfile{pdftex.def}, if this
%    is not already done.
%    \begin{macrocode}
\@ifpackageloaded{color}{}{\RequirePackage[pdftex]{color}}
%    \end{macrocode}
%    Now we can check the minimal version requirement of \xfile{pdftex.def}.
%    \begin{macrocode}
\begingroup\expandafter\expandafter\expandafter\endgroup
\expandafter\ifx\csname @pdfcolorstack\endcsname\relax
  \PackageWarningNoLine{pdfcolfoot}{%
    Your pdftex.def is too old, you need at least 2007/01/02 v0.04b%
  }%
  \expandafter\endinput
\fi
%    \end{macrocode}
%
% \subsection{Color stack for footnotes}
%
%    I do not know, why pdftex.def (or other drivers do not define
%    \cs{default@color}. Instead they are defining \cs{current@color}.
%    Therefore it is assumed that in the preamble this color for black
%    is still valid.
%    \begin{macrocode}
\newcommand{\pdfcolfoot@stack}{}
\edef\pdfcolfoot@stack{%
  \pdfcolorstackinit direct{\current@color}%
}
\begingroup
  \let\on@line\@empty
  \PackageInfo{pdfcolfoot}{%
    Color stack number: \pdfcolfoot@stack
  }%
\endgroup
%    \end{macrocode}
%
% \subsection{Patch \cs{@makefntext}}
%
%    \begin{macro}{\pdfcolfoot@switch}
%    Macro \cs{pdfcolfoot@switch} switches the color stack. Subsequent
%    color calls uses the color stack for footnotes.
%    \begin{macrocode}
\newcommand*{\pdfcolfoot@switch}{%
  \let\@pdfcolorstack\pdfcolfoot@stack
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macrocode}
\AtBeginDocument{%
  \newcommand*{\pdfcolfoot@makefntext}{}%
  \let\pdfcolfoot@makefntext\@makefntext
  \renewcommand{\@makefntext}[1]{%
    \pdfcolfoot@makefntext{%
      \if@minipage
      \else
        \pdfcolfoot@switch
      \fi
      #1%
    }%
  }%
}
%    \end{macrocode}
%
% \subsection{Patch \cs{@makecol}}
%
%    \begin{macro}{\pdfcolfoot@current}
%    When the footnote area starts, the color should continue with
%    the latest color value of the previous footnote area. This color
%    is available on the current top of the color stack.
%    \begin{macrocode}
\newcommand*{\pdfcolfoot@current}{%
  \pdfcolorstack\pdfcolfoot@stack current\relax
}
%    \end{macrocode}
%    \end{macro}
%
%    For convenience we use \cs{detokenize} for patching \cs{@makecol}
%    and related macros.
%    \begin{macrocode}
\begingroup\expandafter\expandafter\expandafter\endgroup
\expandafter\ifx\csname detokenize\endcsname\relax
  \PackageWarningNoLine{pdfcolfoot}{%
    Missing e-TeX for patching \string\@makecol
  }%
  \expandafter\endinput
\fi
%    \end{macrocode}
%
%    \begin{macrocode}
\newif\ifPCF@result
\def\pdfcolfoot@patch#1{%
  \ifx#1\@undefined
  \else
    \ifx#1\relax
    \else
      \begingroup
        \toks@{}%
        \let\on@line\@empty
        \expandafter\PCF@CheckPatched
            \detokenize\expandafter{#1pdfcolfoot@current}\@nil
        \ifPCF@result
          \PackageInfo{pdfcolfoot}{\string#1\space is already patched}%
        \else
          \expandafter\PCF@CanPatch
            \detokenize\expandafter{%
              #1\setbox\@outputbox\vbox{\footnoterule}%
            }%
            \@nil
          \ifPCF@result
            \PackageInfo{pdfcolfoot}{\string#1 is being patched}%
            \expandafter\PCF@PatchA#1\PCF@nil#1%
          \else
            \PackageInfo{pdfcolfoot}{%
              \string#1\space cannot be patched%
            }%
          \fi
        \fi
      \expandafter\endgroup
      \the\toks@
    \fi
  \fi
}
\expandafter\def\expandafter\PCF@CheckPatched
    \expandafter#\expandafter1\detokenize{pdfcolfoot@current}#2\@nil{%
  \ifx\\#2\\%
    \PCF@resultfalse
  \else
    \PCF@resulttrue
  \fi
}
\edef\PCF@BraceLeft{\string{}
\edef\PCF@BraceRight{\string}}
\begingroup
  \edef\x{\endgroup
    \def\noexpand\PCF@CanPatch
        ##1\detokenize{\setbox\@outputbox\vbox}\PCF@BraceLeft
        ##2\detokenize{\footnoterule}##3\PCF@BraceRight
  }%
\x#4\@nil{%
  \ifx\\#2#3#4\\%
    \PCF@resultfalse
  \else
    \PCF@resulttrue
  \fi
}
\def\PCF@PatchA#1\setbox\@outputbox\vbox#2#3\PCF@nil#4{%
  \PCF@PatchB{#1}#2\PCF@nil{#3}#4%
}
\def\PCF@PatchB#1#2\footnoterule#3\PCF@nil#4#5{%
  \toks@{%
    \def#5{%
      #1%
      \setbox\@outputbox\vbox{%
        #2%
        \footnoterule
        \pdfcolfoot@current
        #3%
      }%
      #4%
    }%
  }%
}
\def\pdfcolfoot@all#1{%
  \begingroup
    \let\on@line\@empty
    \PackageInfo{pdfcolfoot}{%
      Patching \string\@makecol\space macros (#1)%
    }%
  \endgroup
%    \end{macrocode}
%    \LaTeX\ base macro:
%    \begin{macrocode}
  \pdfcolfoot@patch\@makecol
%    \end{macrocode}
%    Class \xclass{aastex}:
%    \begin{macrocode}
  \pdfcolfoot@patch\@makecol@pptt
%    \end{macrocode}
%    Class \xclass{memoir}:
%    \begin{macrocode}
  \pdfcolfoot@patch\mem@makecol
  \pdfcolfoot@patch\mem@makecolbf
%    \end{macrocode}
%    Class \xclass{revtex4}:
%    \begin{macrocode}
  \pdfcolfoot@patch\@combineinserts
%    \end{macrocode}
%    Package \xpackage{changebar}:
%    \begin{macrocode}
  \pdfcolfoot@patch\ltx@makecol
%    \end{macrocode}
%    Package \xpackage{dblfnote}:
%    \begin{macrocode}
  \pdfcolfoot@patch\dfn@latex@makecol
%    \end{macrocode}
%    Package \xpackage{fancyhdr}:
%    \begin{macrocode}
  \pdfcolfoot@patch\latex@makecol
%    \end{macrocode}
%    Package \xpackage{lscape}:
%    \begin{macrocode}
  \pdfcolfoot@patch\LS@makecol
%    \end{macrocode}
%    Package \xpackage{lineno}:
%    \begin{macrocode}
  \pdfcolfoot@patch\@LN@orig@makecol
%    \end{macrocode}
%    Package \xpackage{stfloats}:
%    \begin{macrocode}
  \pdfcolfoot@patch\org@makecol
  \pdfcolfoot@patch\fn@makecol
%    \end{macrocode}
%    \begin{macrocode}
}
\AtBeginDocument{\pdfcolfoot@all{AtBeginDocument}}
\pdfcolfoot@all{AtEndOfPackage}
%    \end{macrocode}
%
%    \begin{macrocode}
%</package>
%    \end{macrocode}
% \section{Installation}
%
% \paragraph{CTAN.} This package is available on
% CTAN\footnote{\url{ftp://ftp.ctan.org/tex-archive/}}:
% \begin{description}
% \item[\CTAN{macros/latex/contrib/oberdiek/pdfcolfoot.dtx}] The source file.
% \item[\CTAN{macros/latex/contrib/oberdiek/pdfcolfoot.pdf}] Documentation.
% \end{description}
%
% \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting
% \docstrip\ archive. The files are extracted by running the
% \xfile{.dtx} through \plainTeX:
% \begin{quote}
%   \verb|tex pdfcolfoot.dtx|
% \end{quote}
%
% \paragraph{TDS.} Now the different files must be moved into
% the different directories in your installation TDS tree
% (also known as \xfile{texmf} tree):
% \begin{quote}
% \sbox0{^^A
% \begin{tabular}{@{}>{\ttfamily}l@{$\quad\rightarrow\quad$}>{\ttfamily}l@{}}
%   pdfcolfoot.sty & tex/latex/oberdiek/pdfcolfoot.sty\\
%   pdfcolfoot.pdf & doc/latex/oberdiek/pdfcolfoot.pdf\\
%   pdfcolfoot.dtx & source/latex/oberdiek/pdfcolfoot.dtx\\
% \end{tabular}^^A
% }%
% \ifdim\wd0>\linewidth
%   \mbox{}\nobreak\hskip0pt minus\leftmargin
%   \usebox0
%   \nobreak\hskip0pt minus\rightmargin
% \else
%   \usebox0
% \fi
% \end{quote}
% If you have a \xfile{docstrip.cfg} that configures and enables \docstrip's
% TDS installing feature, then some files can already be in the right
% place, see the documentation of \docstrip.
%
% \paragraph{Refresh file databases.} If your \TeX~distribution
% (\teTeX, \mikTeX, \dots) rely on file databases, you must refresh
% these. For example, \teTeX\ users run \verb|texhash| or
% \verb|mktexlsr|.
%
% \subsection{Some details for the interested}
%
% \paragraph{Attached source.}
%
% The PDF documentation on CTAN also includes the
% \xfile{.dtx} source file. It can be extracted by
% AcrobatReader 6 or higher. Another option is \textsf{pdftk},
% e.g. unpack the file into the current directory:
% \begin{quote}
%   \verb|pdftk pdfcolfoot.pdf unpack_files output .|
% \end{quote}
%
% \paragraph{Unpacking with \LaTeX.}
% The \xfile{.dtx} chooses its action depending on the format:
% \begin{description}
% \item[\plainTeX:] Run \docstrip\ and extract the files.
% \item[\LaTeX:] Generate the documentation.
% \end{description}
% If you insist on using \LaTeX\ for \docstrip\ (really,
% \docstrip\ does not need \LaTeX), then inform the autodetect routine
% about your intention:
% \begin{quote}
%   \verb|latex \let\install=y\input{pdfcolfoot.dtx}|
% \end{quote}
% Do not forget to quote the argument according to the demands
% of your shell.
%
% \paragraph{Generating the documentation.}
% You can use both the \xfile{.dtx} or the \xfile{.drv} to generate
% the documentation. The process can be configured by the
% configuration file \xfile{ltxdoc.cfg}. For instance, put this
% line into this file, if you want to have A4 as paper format:
% \begin{quote}
%   \verb|\PassOptionsToClass{a4paper}{article}|
% \end{quote}
% An example follows how to generate the
% documentation with pdf\LaTeX:
% \begin{quote}
%\begin{verbatim}
%pdflatex pdfcolfoot.dtx
%makeindex -s gind.ist pdfcolfoot.idx
%pdflatex pdfcolfoot.dtx
%makeindex -s gind.ist pdfcolfoot.idx
%pdflatex pdfcolfoot.dtx
%\end{verbatim}
% \end{quote}
%
% \begin{History}
%   \begin{Version}{2007/01/08 v1.0}
%   \item
%     First version.
%   \end{Version}
% \end{History}
%
% \PrintIndex
%
% \Finale
\endinput
