summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/oberdiek/flags.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2007-02-21 23:54:19 +0000
committerKarl Berry <karl@freefriends.org>2007-02-21 23:54:19 +0000
commit038a5dc7d31591d03bb7dd2bee2ca5e89f0ff26a (patch)
tree0206f1532eaf8dea0c935a4e7b66a593f15ac1c4 /Master/texmf-dist/source/latex/oberdiek/flags.dtx
parentd13b89bc23ac3bf2bce2bd534b97ed97e0b091c1 (diff)
oberdiek bookmark0.2, hypcap1.6 (20feb07)
git-svn-id: svn://tug.org/texlive/trunk@3977 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/oberdiek/flags.dtx')
-rw-r--r--Master/texmf-dist/source/latex/oberdiek/flags.dtx434
1 files changed, 434 insertions, 0 deletions
diff --git a/Master/texmf-dist/source/latex/oberdiek/flags.dtx b/Master/texmf-dist/source/latex/oberdiek/flags.dtx
new file mode 100644
index 00000000000..68a354ea2c6
--- /dev/null
+++ b/Master/texmf-dist/source/latex/oberdiek/flags.dtx
@@ -0,0 +1,434 @@
+% \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 flags.dtx
+% and the derived files
+% flags.sty, flags.pdf, flags.ins, flags.drv.
+%
+% Distribution:
+% CTAN:macros/latex/contrib/oberdiek/flags.dtx
+% CTAN:macros/latex/contrib/oberdiek/flags.pdf
+%
+% Unpacking:
+% (a) If flags.ins is present:
+% tex flags.ins
+% (b) Without flags.ins:
+% tex flags.dtx
+% (c) If you insist on using LaTeX
+% latex \let\install=y\input{flags.dtx}
+% (quote the arguments according to the demands of your shell)
+%
+% Documentation:
+% (a) If flags.drv is present:
+% latex flags.drv
+% (b) Without flags.drv:
+% latex flags.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 flags.dtx
+% makeindex -s gind.ist flags.idx
+% pdflatex flags.dtx
+% makeindex -s gind.ist flags.idx
+% pdflatex flags.dtx
+%
+% Installation:
+% TDS:tex/latex/oberdiek/flags.sty
+% TDS:doc/latex/oberdiek/flags.pdf
+% TDS:source/latex/oberdiek/flags.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: flags 2007/02/18 v0.1 Flag setting in bit fields (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 flags.dtx
+and the derived files
+ flags.sty, flags.pdf, flags.ins, flags.drv.
+
+\endpreamble
+
+\generate{%
+ \file{flags.ins}{\from{flags.dtx}{install}}%
+ \file{flags.drv}{\from{flags.dtx}{driver}}%
+ \usedir{tex/latex/oberdiek}%
+ \file{flags.sty}{\from{flags.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{* flags.sty}
+\Msg{*}
+\Msg{* To produce the documentation run the file `flags.drv'}
+\Msg{* through LaTeX.}
+\Msg{*}
+\Msg{* Happy TeXing!}
+\Msg{*}
+\Msg{************************************************************************}
+
+\endbatchfile
+%</install>
+%<*ignore>
+\fi
+%</ignore>
+%<*driver>
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesFile{flags.drv}%
+ [2007/02/18 v0.1 Flag setting in bit fields (HO)]
+\documentclass{ltxdoc}
+\usepackage{holtxdoc}
+\begin{document}
+ \DocInput{flags.dtx}
+\end{document}
+%</driver>
+% \fi
+%
+% \CheckSum{156}
+%
+% \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{flags.drv}
+%
+% \title{The \xpackage{flags} package}
+% \date{2007/02/18 v0.1}
+% \author{Heiko Oberdiek\\\xemail{oberdiek@uni-freiburg.de}}
+%
+% \maketitle
+%
+% \begin{abstract}
+% Package \xpackage{flags} allows the setting and clearing
+% of flags in bit fields and converts the bit field into a
+% decimal number. Currently the bit field is limited to 31 bits.
+% \end{abstract}
+%
+% \tableofcontents
+%
+% \section{Documentation}
+%
+% \subsection{User interface}
+%
+% \begin{declcs}{resetflags} \M{fname}
+% \end{declcs}
+% The bit field \meta{fname} is cleared.
+% Currently is is also used for initialization,
+% because a \cs{newflags} macro is not implemented.
+%
+% \begin{declcs}{setflag} \M{fname} \M{position}
+% \end{declcs}
+% The flag at bit position \meta{position} is set in the
+% bit field \meta{fname}.
+%
+% \begin{declcs}{clearflag} \M{fname} \M{position}
+% \end{declcs}
+% The flag at bit position \meta{position} is cleared in the
+% bit field \meta{fname}.
+%
+% \begin{declcs}{printflags} \M{fname}
+% \end{declcs}
+% The bit field \meta{fname} is converted to a decimal number.
+% The macro is expandible.
+%
+% \paragraph{Example.} See package \xpackage{bookmark}.
+% It uses package \xpackage{flags} for its font style options.
+%
+% \subsection{ToDo}
+%
+% \begin{itemize}
+% \raggedright
+% \item Named positions.
+% \item Setting positions by a key-value interface.
+% \item Support for more than 31 bits while maintaining expandibility of
+% \cs{printflags}.
+% \item Eventually \cs{newflags}, \cs{newflagstype}.
+% \end{itemize}
+%
+%
+% \StopEventually{
+% }
+%
+% \section{Implementation}
+%
+% \begin{macrocode}
+%<*package>
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{flags}%
+ [2007/02/18 v0.1 Flag setting in bit fields (HO)]
+% \end{macrocode}
+%
+% \begin{macro}{\resetflags}
+% \begin{macrocode}
+\newcommand*{\resetflags}[1]{%
+ \expandafter\let\csname flags@#1\endcsname\@empty
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\printflags}
+% Macro \cs{printflags} converts the bit field into a decimal
+% number.
+% \begin{macrocode}
+\newcommand*{\printflags}[1]{%
+ \expandafter\@printflags\csname flags@#1\endcsname
+}
+\def\@printflags#1{%
+ \expandafter\@firstofone\expandafter{%
+ \number\numexpr
+ \ifx#1\@empty
+ 0%
+ \else
+ \expandafter\@@printflags#1%
+ \fi
+ }%
+}
+\def\@@printflags#1#2\fi{%
+ \fi
+ #1%
+ \ifx\\#2\\%
+ \else
+ +2*\numexpr\expandafter\@@printflags#2%
+ \fi
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\setflag}
+% \begin{macrocode}
+\newcommand*{\setflag}[2]{%
+ \expandafter\@setflag\csname flags@#1\expandafter\endcsname
+ \expandafter{\romannumeral\number\numexpr#2-1\relax000}%
+}
+\def\@setflag#1#2{%
+ \edef#1{%
+ \expandafter\@@setflag\expandafter{#1}{#2}%
+ }%
+}
+\def\@@setflag#1#2{%
+ \ifx\\#1\\%
+ \FLAGS@zero#2\relax
+ 1%
+ \else
+ \ifx\\#2\\%
+ 1\@gobble#1%
+ \else
+ \@car#1\@nil
+ \expandafter\@@@setflag\expandafter{\@gobble#2}{#1}%
+ \fi
+ \fi
+}
+\def\@@@setflag#1#2\fi\fi{%
+ \fi\fi
+ \expandafter\@@setflag\expandafter{\@cdr#2\@nil}{#1}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macro}{\clearflag}
+% \begin{macrocode}
+\newcommand*{\clearflag}[2]{%
+ \expandafter\@clearflag\csname flags@#1\expandafter\endcsname
+ \expandafter{\romannumeral\number\numexpr#2-1\relax000}%
+}
+\def\@clearflag#1#2{%
+ \edef#1{%
+ \expandafter\@@clearflag\expandafter{#1}{#2}%
+ }%
+}
+\def\@@clearflag#1#2{%
+ \ifx\\#1\\%
+ \else
+ \ifx\\#2\\%
+ 0\@gobble#1%
+ \else
+ \@car#1\@nil
+ \expandafter\@@@clearflag\expandafter{\@gobble#2}{#1}%
+ \fi
+ \fi
+}
+\def\@@@clearflag#1#2\fi\fi{%
+ \fi\fi
+ \expandafter\@@clearflag\expandafter{\@cdr#2\@nil}{#1}%
+}
+% \end{macrocode}
+% \end{macro}
+%
+% \begin{macrocode}
+\def\FLAGS@zero#1{%
+ \ifx#1\relax
+ \else
+ 0%
+ \expandafter\FLAGS@zero
+ \fi
+}
+% \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/flags.dtx}] The source file.
+% \item[\CTAN{macros/latex/contrib/oberdiek/flags.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 flags.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@{}}
+% flags.sty & tex/latex/oberdiek/flags.sty\\
+% flags.pdf & doc/latex/oberdiek/flags.pdf\\
+% flags.dtx & source/latex/oberdiek/flags.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 flags.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{flags.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 flags.dtx
+%makeindex -s gind.ist flags.idx
+%pdflatex flags.dtx
+%makeindex -s gind.ist flags.idx
+%pdflatex flags.dtx
+%\end{verbatim}
+% \end{quote}
+%
+% \begin{History}
+% \begin{Version}{2007/02/18 v1.0}
+% \item
+% First version.
+% \end{Version}
+% \end{History}
+%
+% \PrintIndex
+%
+% \Finale
+\endinput