summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/oberdiek/flags.dtx
blob: 6a2d05c7b446828f028405686435e1c66f189515 (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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
% \iffalse meta-comment
%
% File: flags.dtx
% Version: 2016/05/16 v0.5
% Info: Setting/clearing of flags in bit fields
%
% Copyright (C)
%    2007 Heiko Oberdiek
%    2016-2019 Oberdiek Package Support Group
%    https://github.com/ho-tex/oberdiek/issues
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.3c of this license or (at your option) any later
% version. This version of this license is in
%    https://www.latex-project.org/lppl/lppl-1-3c.txt
% and the latest version of this license is in
%    https://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".
%
% The Current Maintainers of this work are
% Heiko Oberdiek and the Oberdiek Package Support Group
% https://github.com/ho-tex/oberdiek/issues
%
% 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
  \catcode123=1 %
  \catcode125=2 %
  \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 2016/05/16 v0.5 Setting/clearing of flags in bit fields (HO)}
\Msg{************************************************************************}

\keepsilent
\askforoverwritefalse

\let\MetaPrefix\relax
\preamble

This is a generated file.

Project: flags
Version: 2016/05/16 v0.5

Copyright (C)
   2007 Heiko Oberdiek
   2016-2019 Oberdiek Package Support Group

This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either
version 1.3c of this license or (at your option) any later
version. This version of this license is in
   https://www.latex-project.org/lppl/lppl-1-3c.txt
and the latest version of this license is in
   https://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".

The Current Maintainers of this work are
Heiko Oberdiek and the Oberdiek Package Support Group
https://github.com/ho-tex/oberdiek/issues


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

\endpreamble
\let\MetaPrefix\DoubleperCent

\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}}%
}

\catcode32=13\relax% active space
\let =\space%
\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}%
  [2016/05/16 v0.5 Setting/clearing of flags in bit fields (HO)]%
\documentclass{ltxdoc}
\usepackage{holtxdoc}[2011/11/22]
\begin{document}
  \DocInput{flags.dtx}%
\end{document}
%</driver>
% \fi
%
%
%
% \GetFileInfo{flags.drv}
%
% \title{The \xpackage{flags} package}
% \date{2016/05/16 v0.5}
% \author{Heiko Oberdiek\thanks
% {Please report any issues at \url{https://github.com/ho-tex/oberdiek/issues}}}
%
% \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}
%
% A new powerful package \xpackage{bitset} is written by me
% and supersedes this package:
% \begin{itemize}
% \item The bit range is not restricted to 31 bits, only index
% numbers are objected to \TeX's number limit.
% \item Many more operations are available.
% \item No dependency of \eTeX.
% \end{itemize}
% Therefore I consider this package as obsolete and
% have stopped the development of this package.
%
% \subsection{User interface}
%
% Flag positions are one-based, thus the flag position must be
% a positive integer. Currently supported range: |1..31|
%
% \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.
%
% \begin{declcs}{extractflag} \M{fname} \M{position}
% \end{declcs}
% Extracts the flag setting at bit position \meta{position}.
% \cs{extractflag} expands to |1| if the flag is set and |0| otherwise.
%
% \begin{declcs}{queryflag} \M{fname} \M{position}
%    \M{set part} \M{clear part}
% \end{declcs}
% It is a wrapper for \cs{extractflag}. \meta{set part} is called if
% \cs{extractflag} returns |1|. Otherwise \meta{clear part} is executed.
%
% \paragraph{Example.} See package \xpackage{bookmark}.
% It uses package \xpackage{flags} for its font style options.
%
% \subsection{Requirements}
%
% \begin{itemize}
% \item \eTeX\ (\cs{numexpr})
% \end{itemize}
%
% \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}%
  [2016/05/16 v0.5 Setting/clearing of flags in bit fields (HO)]%
%    \end{macrocode}
%
%    \begin{macrocode}
\begingroup\expandafter\expandafter\expandafter\endgroup
\expandafter\ifx\csname numexpr\endcsname\relax
  \PackageError{flags}{%
    Missing e-TeX, package loading aborted%
  }{%
    This packages makes heavy use of \string\numexpr.%
  }%
  \expandafter\endinput
\fi
%    \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]{%
  \ifnum#2>\z@
    \expandafter\@setflag\csname flags@#1\expandafter\endcsname
      \expandafter{\romannumeral\number\numexpr#2-1\relax000}%
  \else
    \PackageError{flags}{Position must be a positive number}\@ehc
  \fi
}
\def\@setflag#1#2{%
  \ifx#1\relax
    \let#1\@empty
  \fi
  \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
      \@@@setflag#1|#2%
    \fi
  \fi
}
\def\@@@setflag#1#2|#3#4\fi\fi{%
  \fi\fi
  #1%
  \@@setflag{#2}{#4}%
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\clearflag}
%    \begin{macrocode}
\newcommand*{\clearflag}[2]{%
  \ifnum#2>\z@
    \expandafter\@clearflag\csname flags@#1\expandafter\endcsname
      \expandafter{\romannumeral\number\numexpr#2-1\relax000}%
  \else
    \PackageError{flags}{Position must be a positive number}\@ehc
  \fi
}
\def\@clearflag#1#2{%
  \ifx#1\relax
    \let#1\@empty
  \fi
  \edef#1{%
    \expandafter\@@clearflag\expandafter{#1}{#2}%
  }%
}
\def\@@clearflag#1#2{%
  \ifx\\#1\\%
  \else
    \ifx\\#2\\%
      0\@gobble#1%
    \else
      \@@@clearflag#1|#2%
    \fi
  \fi
}
\def\@@@clearflag#1#2|#3#4\fi\fi{%
  \fi\fi
  #1%
  \@@clearflag{#2}{#4}%
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macrocode}
\def\FLAGS@zero#1{%
  \ifx#1\relax
  \else
    0%
    \expandafter\FLAGS@zero
  \fi
}
%    \end{macrocode}
%
%    \begin{macro}{\queryflag}
%    \begin{macrocode}
\newcommand*{\queryflag}[2]{%
  \ifnum\extractflag{#1}{#2}=\@ne
    \expandafter\@firstoftwo
  \else
    \expandafter\@secondoftwo
  \fi
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macro}{\extractflag}
%    \begin{macrocode}
\newcommand*{\extractflag}[1]{%
  \expandafter\@extractflag\csname flags@#1\endcsname
}
\def\@extractflag#1#2{%
  \ifx#1\@undefined
    0%
  \else
    \ifx#1\relax
      0%
    \else
      \ifx#1\@empty
        0%
      \else
        \expandafter\expandafter\expandafter\@@extractflag
        \expandafter\expandafter\expandafter{%
        \expandafter#1\expandafter
        }\expandafter{%
          \romannumeral\number\numexpr#2-1\relax000%
        }%
      \fi
    \fi
  \fi
}
\def\@@extractflag#1#2{%
  \ifx\\#1\\%
    0%
  \else
    \ifx\\#2\\%
      \@car#1\@nil
    \else
      \@@@extractflag#1|#2%
    \fi
  \fi
}
\def\@@@extractflag#1#2|#3#4\fi\fi{%
  \fi\fi
  \@@extractflag{#2}{#4}%
}
%    \end{macrocode}
%    \end{macro}
%
%    \begin{macrocode}
%</package>
%    \end{macrocode}
%
% \section{Installation}
%
% \subsection{Download}
%
% \paragraph{Package.} This package is available on
% CTAN\footnote{\CTANpkg{flags}}:
% \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{Bundle.} All the packages of the bundle `oberdiek'
% are also available in a TDS compliant ZIP archive. There
% the packages are already unpacked and the documentation files
% are generated. The files and directories obey the TDS standard.
% \begin{description}
% \item[\CTANinstall{install/macros/latex/contrib/oberdiek.tds.zip}]
% \end{description}
% \emph{TDS} refers to the standard ``A Directory Structure
% for \TeX\ Files'' (\CTANpkg{tds}). Directories
% with \xfile{texmf} in their name are usually organized this way.
%
% \subsection{Bundle installation}
%
% \paragraph{Unpacking.} Unpack the \xfile{oberdiek.tds.zip} in the
% TDS tree (also known as \xfile{texmf} tree) of your choice.
% Example (linux):
% \begin{quote}
%   |unzip oberdiek.tds.zip -d ~/texmf|
% \end{quote}
%
% \subsection{Package installation}
%
% \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}
% \def\t{^^A
% \begin{tabular}{@{}>{\ttfamily}l@{ $\rightarrow$ }>{\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
% }^^A
% \sbox0{\t}^^A
% \ifdim\wd0>\linewidth
%   \begingroup
%     \advance\linewidth by\leftmargin
%     \advance\linewidth by\rightmargin
%   \edef\x{\endgroup
%     \def\noexpand\lw{\the\linewidth}^^A
%   }\x
%   \def\lwbox{^^A
%     \leavevmode
%     \hbox to \linewidth{^^A
%       \kern-\leftmargin\relax
%       \hss
%       \usebox0
%       \hss
%       \kern-\rightmargin\relax
%     }^^A
%   }^^A
%   \ifdim\wd0>\lw
%     \sbox0{\small\t}^^A
%     \ifdim\wd0>\linewidth
%       \ifdim\wd0>\lw
%         \sbox0{\footnotesize\t}^^A
%         \ifdim\wd0>\linewidth
%           \ifdim\wd0>\lw
%             \sbox0{\scriptsize\t}^^A
%             \ifdim\wd0>\linewidth
%               \ifdim\wd0>\lw
%                 \sbox0{\tiny\t}^^A
%                 \ifdim\wd0>\linewidth
%                   \lwbox
%                 \else
%                   \usebox0
%                 \fi
%               \else
%                 \lwbox
%               \fi
%             \else
%               \usebox0
%             \fi
%           \else
%             \lwbox
%           \fi
%         \else
%           \usebox0
%         \fi
%       \else
%         \lwbox
%       \fi
%     \else
%       \usebox0
%     \fi
%   \else
%     \lwbox
%   \fi
% \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.
%
% \subsection{Refresh file name databases}
%
% If your \TeX~distribution
% (\TeX\,Live, \mikTeX, \dots) relies on file name databases, you must refresh
% these. For example, \TeX\,Live\ users run \verb|texhash| or
% \verb|mktexlsr|.
%
% \subsection{Some details for the interested}
%
% \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 v0.1}
%   \item
%     First version.
%   \end{Version}
%   \begin{Version}{2007/03/07 v0.2}
%   \item
%     Raise an error if \eTeX\ is not detected.
%   \end{Version}
%   \begin{Version}{2007/03/31 v0.3}
%   \item
%     \cs{queryflag} and \cs{extractflag} added.
%   \item
%     Raise an error if position is not positive in case of
%     \cs{setflag} and \cs{clearflag}.
%   \end{Version}
%   \begin{Version}{2007/09/30 v0.4}
%   \item
%     Package is deprecated because of new more powerful
%     package \xpackage{bitset}.
%   \end{Version}
%   \begin{Version}{2016/05/16 v0.5}
%   \item
%     Documentation updates.
%   \end{Version}
% \end{History}
%
% \PrintIndex
%
% \Finale
\endinput