summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/sauerj/processkv.dtx
blob: 520853917f963ae996414bd68c64736ff08f7d41 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
% \iffalse meta-comment
% Line endings: UNIX
% Tab size:     4
%
% Copyright 2004 Jonathan Sauer
%
% 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 2003/12/01 or later.
%
% This work has the LPPL maintenance status "maintained".
%
% The Current Maintainer of this work is Jonathan Sauer
% (<jonathan.sauer@gmx.de>).
%
% This work consists of the files processkv.dtx and processkv.ins and
% the derived file processkv.sty.
%
% This work is based on the package keyval.
%
% \fi
%
% \iffalse
%
%<*driver>
\documentclass{ltxdoc}
\IfFileExists{processkv.sty}{\usepackage{processkv}}{}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
% Modification of verbatim for tabs in listings
\makeatletter
{\catcode`\ =\active%
\catcode`\^^I=\active%
\gdef\@vobeyspaces{%
\catcode`\ \active\let \@xobeysp%
\catcode`\^^I\active\def^^I{~~}%
}}%
\makeatother
\begin{document}
	\DocInput{\jobname.dtx}
\end{document}
%</driver>
%
%<package>\NeedsTeXFormat{LaTeX2e}
%<package>\ProvidesPackage{processkv}
%<package>   [2004/08/09 v1.0.1 process key=value lists]
%<package>\RequirePackage{keyval}[1999/03/16]
%
% \fi
%
% \CheckSum{41}
% \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         \~}
%
% \DoNotIndex{\@empty,\@tempa,\@tempb,\def,\else,\empty,\expandafter}
% \DoNotIndex{\fi,\ifx,\relax}
%
% \changes{1.0.1}{2004/08/09}{Mangled macronames corrected.}
%
% \GetFileInfo{\jobname.sty}
%
% \title{The \textsf{processkv} package\thanks{This document
% corresponds to \textsf{\filename}~\fileversion, dated \filedate.}}
%
% \author{Jonathan Sauer \\ \texttt{jonathan.sauer@gmx.de}}
%
% \date{\filedate}
%
% \maketitle
%
% \begin{abstract}
% This file describes the \textsf{processkv} package that provides
% macros for processing of key-value-lists by calling a user-defined
% macro for each key-value-pair.
%
% \end{abstract}
%
% \tableofcontents
%
% \section{Introduction}
%
% The \textsf{keyval} package provides the possibility of specifying
% macro arguments as |key=value|, where |key| is one of previously
% defined keys. Sometimes it is necessary not to have to define the
% keys in advance, but to specify arbitrary keys which are then
% processed.
%
% This package provides the macro |\processkeyvalues| that calls a
% user-defined macro for each key-value-pair.
%
% This package makes use of some internal macros of the package
% \textsf{keyval}. I hope this will not break someday \ldots
%
%
% \section{Using the package}
%
% \DescribeMacro{\processkeyvalues} Usage: |\processkeyvalues|
% \marg{keyvalue-list} \marg{macro}.
%
% The main macro of this package. It calls \meta{macro} for each
% key-value-pair in \meta{keyvalue-list}. Macros in the list are not
% expanded.
%
% \meta{macro} can be any macro with two parameters, i.e:
%
% \begin{verbatim}
% \def\testmacro#1#2{%
% 	\message{Key = `#1', value = `#2'}%
% }
% \end{verbatim}
% Or
%
% \begin{verbatim}
% \newcommand{\testmacro}[2]{%
% 	\message{Key = `#1', value = `#2'}%
% }
% \end{verbatim}
%
%
% \StopEventually{}
%
% \section{Implementation}
%
% \subsection{Main macros}
%
% \begin{macro}{\processkeyvalues}
%
% Usage: |\processkeyvalues| \marg{keyvalue-list} \marg{macro}.
%
% Calls \meta{macro} for each key-value-pair in the list. \meta{macro}
% must have two parameters, \meta{key} and \meta{value}.
%
%    \begin{macrocode}
\def\processkeyvalues#1#2{%
	\def\PKV@process{#2}%
	\PKV@do#1,\relax,%
}
%    \end{macrocode}
% \end{macro}
%
%
% \subsection{Internal macros}
%
% \begin{macro}{\PKV@do}
%
% Processes the list.
%
%    \begin{macrocode}
\def\PKV@do#1,{%
	\ifx\relax#1\empty\else%
	\PKV@split#1==\relax%
	\expandafter\PKV@do\fi%
}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\PKV@split}
%
% Processes a key-value-pair of the list. Uses some macros of the
% \textsf{keyval} package.
%
%    \begin{macrocode}
\def\PKV@split#1=#2=#3\relax{%
	\KV@@sp@def\@tempa{#1}%
	\ifx\@tempa\@empty\else%
		\KV@@sp@def\@tempb{#2}%
		\expandafter\expandafter\expandafter\PKV@process%
			\expandafter\expandafter\expandafter{\expandafter\@tempa%
			\expandafter}\expandafter{\@tempb}%
	\fi%
}
%    \end{macrocode}
% \end{macro}
%
% \Finale
% \PrintChanges
% \PrintIndex
\endinput