summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/coolstr/coolstr.dtx
blob: f2aec9554017c43ceb744727de6d1b877f41a5d5 (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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
% \iffalse
%
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{coolstr}
%<package> [2006/09/17 v1.0 COntent Oriented LaTeX Strings]
%<package>\RequirePackage{ifthen}
%<package>\RequirePackage{amsmath}
%<package>\RequirePackage{amssymb}
%
%
%<*driver>
\documentclass{ltxdoc}
\usepackage{coolstr}
\usepackage{url}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
\DocInput{coolstr.dtx}
\end{document}
%</driver>
% \fi
%
% \iffalse meta-comment
% remove this comment to get a checksum
% \CheckSum{0}
% \fi
%
%% \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         \~}
%
% \changes{v1.0}{2006/09/17}{Initial Release}
%
% \GetFileInfo{coolstr.sty}
%
% \DoNotIndex{\#,\$,\%,\&,\@,\\,\{,\},\^,\_,\~,\ ,\!,\(,\),\,}
% \DoNotIndex{\@ne,\expandafter}
% \DoNotIndex{\advance,\begingroup,\catcode,\closein}
% \DoNotIndex{\newcommand,\renewcommand,\providecommand}
% \DoNotIndex{\closeout,\day,\def,\edef,\gdef,\let,\empty,\endgroup}
% \DoNotIndex{\newcounter,\providecounter,\addtocounter,\setcounter,\stepcounter,\value,\arabic}
% \DoNotIndex{\if,\fi,\ifthenelse,\else,\setboolean,\boolean,\newboolean,\provideboolean,\equal,\AND,\OR,\NOT,\whiledo}
% \DoNotIndex{\ifcase,\ifcat,\or,\else}
% \DoNotIndex{\par,\parbox,\mbox,\hbox,\begin,\end,\nabla,\partial}
% \DoNotIndex{\overline,\bar,\small,\tiny,\mathchoice,\scriptsize,\textrm,\texttt}
% \DoNotIndex{\alpha,\beta,\gamma,\epsilon,\varepsilon,\delta,\zeta,\eta,\theta,\vartheta,\iota,\kappa,\lambda,\mu,\nu}
% \DoNotIndex{\xi,\omicron,\pi,\varpi,\rho,\varrho,\sigma,\tau,\upsilon,\phi,\varphi,\chi,\psi,\omega}
% \DoNotIndex{\Delta,\Gamma,\Theta,\Lambda,\Xi,\Pi,\Sigma,\Phi,\Psi,\Omega}
% \DoNotIndex{\digamma,\lceil,\rceil,\lfloor,\rfloor,\left,\right,\inp,\inb,\inbr,\inap,\nop}
% \DoNotIndex{\sum,\prod,\int,\log,\ln,\exp,\sin,\cos,\tan,\csc,\sec,\cot,\arcsin,\arccos,\arctan,\det}
% \DoNotIndex{\sinh,\cosh,\tanh,\csch,\sech,\coth,\arcsinh,\arccosh,\arctanh}
% \DoNotIndex{\mod,\max,\min,\gcd,\lcm,\wp,\arg,\dots,\infty,}
% \DoNotIndex{\frac,\binom,\braket,\@@atop}
% \DoNotIndex{\cdot,\ldots,\tilde,\times,\dagger,\relax}
% \DoNotIndex{\mathbb,\roman,\bf,\mathord,\cal,\DeclareMathOperator,\PackageError,\PackageWarning}
% \DoNotIndex{\csname,\endcsname,\ifx,\ifnum}
% \DoNotIndex{\COOL@Hypergeometric@pq,\COOL@Hypergeometric@pq@ab@value,\hideOnSF,\COOL@decide@paren}
% \DoNotIndex{\COOL@decide@indicies}
% \DoNotIndex{\mod,\bmod,\pmod,\pod,\operatorname}
%
% \title{The \textsf{coolstr} package\thanks{This document
% corresponds to \textsf{cool}~\fileversion,
% dated~\filedate.}}
% \author{nsetzer}
%
% \maketitle
%
% \setcounter{IndexColumns}{2}
% \StopEventually{\PrintChanges\PrintIndex}
%
% The \textsf{coolstr} package is a ``sub" package of the \textsf{cool} package that seemed appropriate to publish
% independently since it may occur that one wishes to include the ability to check strings without having to accept 
% all the overhead of the \textsf{cool} package itself.
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%\section{Basics}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Strings are defined as a sequence of characters (not \TeX{} tokens).  The main purpose behind treating strings as
% characters rather than tokens is that one can then do some text manipulation on them.
%
%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%\section{Implementation}
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% This is just an internal counter for dealing with the strings; most often used for the length
%
%    \begin{macrocode}
\newcounter{COOL@strlen}%
%    \end{macrocode}
%
% \begin{macro}{\setstrEnd}
%
% |\setstrEnd{|\meta{string}|}| allows the user to set the end of a string `character' 
% in the rare event that the default value actually appears in the string.
% The default value is
%
%    \begin{macrocode}
\newcommand{\COOL@strEnd}{\%\%\%}
\newcommand{\COOL@intEnd}{\%@\%@\%@}
%    \end{macrocode}
%
% and may be changed by the following command (which utilizes the |\renewcommand|):
%
%    \begin{macrocode}
\newcommand{\setstrEnd}[1]{\renewcommand{\COOL@strEnd}{#1}}
%    \end{macrocode}
%
% \end{macro}
%
%
% This area defines the core technology behind the \textsf{coolstr} package: the string ``gobbler".
%
%    \begin{macrocode}
\newcounter{COOL@strpointer}
%    \end{macrocode}
%
% Now we come to ``the gobbler"---a recursive function that eats up a string.  
% It must be written in \TeX{} primatives.
%
% The idea behind this is that ``the gobbler" eats up everything before the desired character and everything 
% after the desired character.
%
%    \begin{macrocode}
\def\COOL@strgobble[#1]#2#3{%
\ifthenelse{\equal{#3}{\COOL@strEnd}}
	{%
	\ifthenelse{\value{COOL@strpointer}=#1}
		{%
		#2
		}%
	% Else
		{%
		}%
	}%
% Else
	{%
	\ifthenelse{\value{COOL@strpointer}=#1}
		{%
		#2
		}%
	% Else
		{%
		}%
	\stepcounter{COOL@strpointer}%
	\COOL@strgobble[#1]#3
	}%
}
%    \end{macrocode}
%
% \begin{macro}{\strchar}
% |\strchar|\marg{index} gives the \meta{index} character of the string.  Strings start indexing at $1$.
%
%    \begin{macrocode}
\newcommand{\strchar}[2]{%
\setcounter{COOL@strpointer}{1}%
\COOL@strgobble[#2]#1\COOL@strEnd%
}
%    \end{macrocode}
%
% \end{macro}
%
% This ``gobbler" is used to determine if the string contains numeric data.  As it stands, not all numeric data is
% recognized
%
%    \begin{macrocode}
\newboolean{COOL@firstdecimalfound}
\newboolean{COOL@seconddecimalfound}
\newboolean{COOL@efound}
\newboolean{COOL@digitfound}

\def\COOL@numericgobbler#1#2{%
\ifthenelse{\equal{#2}{\COOL@strEnd}}%
	{%
	\ifthenelse{`#1 < `0 \OR `#1 > `9}%
		{%
		Not Numeric%
		}%
	% Else
		{%
		Is Numeric%
		}%
	}%
% Else
	{%
	\ifthenelse{ `#1 < `0 \OR `#1 > `9 }%
		{%
%    \end{macrocode}
% at this point it can only be a decimal point or an 'e' if it is to remain numeric
%    \begin{macrocode}
		\ifthenelse{ `#1 = `. }%
			{%
			\ifthenelse{ \boolean{COOL@seconddecimalfound} }%
				{%
%    \end{macrocode}
% this is the THIRD decimal
%    \begin{macrocode}
				Not numeric%
				}%
			% else
				{%
				\ifthenelse{ \boolean{COOL@firstdecimalfound} }%
					{%
%    \end{macrocode}
% this is the SECOND decimal
%    \begin{macrocode}
					\ifthenelse{ \boolean{COOL@efound} }%
						{%
						\setboolean{COOL@seconddecimalfound}{true}%
						\COOL@numericgobbler#2%
						}%
					% else
						{%
						Not numeric%
						}%
					}%
				% else
					{%
%    \end{macrocode}
% this is the FIRST decimal
%    \begin{macrocode}
					\setboolean{COOL@firstdecimalfound}{true}%
					\COOL@numericgobbler#2%
					}%
				}%
			}%
		% else
			{%
			\ifthenelse{ \(`#1 = `E\) \OR \(`#1 = `e\) }%
				{%
				\ifthenelse{ \boolean{COOL@efound} \OR \NOT \boolean{COOL@digitfound} }%
					{%
					Not numeric%
					}%
				% else
					{%
					\setboolean{COOL@efound}{true}%
					\COOL@numericgobbler#2%
					}%
				}%
			% else
				{%
				Not Numeric
				}%
			}%
		}%
	% Else
		{%
		\setboolean{COOL@digitfound}{true}%
		\COOL@numericgobbler#2%
		}%
	}%
} 
%    \end{macrocode}
%
% \begin{macro}{\isnumeric}
% |\isnumeric|\marg{string} returns some text stating whether or not \meta{string} contains numeric data.
%
%    \begin{macrocode}
\newcommand{\isnumeric}[1]{%
\setboolean{COOL@firstdecimalfound}{false}%
\setboolean{COOL@seconddecimalfound}{false}%
\setboolean{COOL@efound}{false}%
\setboolean{COOL@digitfound}{false}%
\COOL@numericgobbler#1\COOL@strEnd%
}
%    \end{macrocode}
%
% \end{macro}
%
% In addition to identifying numeric data, it is useful to know if integers are present, thus another ``gobbler" is 
% needed
%
%    \begin{macrocode}
\let\COOL@strStop=\relax
\newboolean{COOL@isint}
\def\COOL@intgobbler#1#2\COOL@strEnd{%
\ifcat#11
\ifthenelse{\equal{#2}{\COOL@strStop}}%
	{%
	\ifthenelse{`#1 < `0 \OR `#1 > `9}%
		{%
		\setboolean{COOL@isint}{false}%
		}%
	% Else
		{%
		\setboolean{COOL@isint}{true}%
		}%
	}%
% Else
	{%
	\ifthenelse{ `#1 < `0 \OR `#1 > `9 }%
		{%
		\setboolean{COOL@isint}{false}%
		}%
	% Else
		{%
		\setboolean{COOL@digitfound}{true}%
		\COOL@intgobbler#2\COOL@strEnd%
		}%
	}%
\else
	\setboolean{COOL@isint}{false}%
\fi
}
%    \end{macrocode}
%
% \begin{macro}{\isint}
% |\isint|\marg{string} doesn't actually return anything, but sets the boolean |COOL@isint| to true or false
% depending on whether or not \meta{string} contains an integer
%
%    \begin{macrocode}
\newcommand{\isint}[1]{\COOL@intgobbler#1\COOL@strStop\COOL@strEnd}
%    \end{macrocode}
%
% \end{macro}
%
%
%
%
% \Finale
\endinput