blob: cd3e5eb08c7de3797a6d30610a1b401478ab937c (
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
|
% --------------------------------------------------------------------------
% the CNTFORMATS package
%
% A different way to read counters
%
% --------------------------------------------------------------------------
% Clemens Niederberger
% Web: https://github.com/cgnieder/cntformats/
% E-Mail: contact@mychemistry.eu
% --------------------------------------------------------------------------
% Copyright 2012-2014 Clemens Niederberger
%
% 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'.
%
% The Current Maintainer of this work is Clemens Niederberger.
% --------------------------------------------------------------------------
% If you have any ideas, questions, suggestions or bugs to report, please
% feel free to contact me.
% --------------------------------------------------------------------------
\def\@cntfmts@date{2014/07/20}
\def\@cntfmts@version{v0.7}
\ProvidesPackage{cntformats}[%
\@cntfmts@date\space
\@cntfmts@version\space
A different way to read counters. (CN)]
\RequirePackage{etoolbox,cnltx-base}
% --------------------------------------------------------------------------
% message handling
\newcommand*\@cntfmts@error@message{%
For details have a look at the `cntformats' manual.%
}
\cnltx@create@generic@message{@cntfmts}{cntformats}{Error}{\@cntfmts@error@message}
\cnltx@create@generic@message{@cntfmts}{cntformats}{Warning}{}
\cnltx@create@generic@message{@cntfmts}{cntformats}{WarningNoLine}{}
\cnltx@create@generic@message{@cntfmts}{cntformats}{Info}{}
\newrobustcmd*\@cntfmts@err@already@defined[1]{%
\@cntfmts@error{The counter `#1' already exists!}%
}
\newrobustcmd*\@cntfmts@err@unknown@counter[1]{%
\@cntfmts@error{The counter `#1' is undefined!}%
}
\newrobustcmd*\@cntfmts@err@pattern@defined[2]{%
\@cntfmts@error{The pattern `#2' for module `#1' is already defined!}%
}
\newrobustcmd*\@cntfmts@err@pattern@undefined[2]{%
\@cntfmts@error{The pattern `#2' for module `#1' is undefined!}%
}
% ----------------------------------------------------------------------------
% #1: module
% #2: counter
\newrobustcmd*\@cntfmts@def@counter@read[3]{%
\cnltx@expandargs(no)\csdef
{@#1@read@#3@counter}%
{\csname @#1@read@#2@counter\endcsname}%
}
% create pattern for an existing counter:
% #1: module
% #2: counter
% #3: id
\newrobustcmd*\@cntfmts@add@counter@pattern[3][cntfmts]{%
\ifcsdef{c@#2}
{}{\@cntfmts@err@unknown@counter{#2}}%
\ifcsdef{@#1@#2@counter}
{\@cntfmts@err@pattern@defined{#1}{#2}}
{\csdef{@#1@#2@counter}{}}%
\listcsadd{@#1@counter@ids}{#3}%
\@cntfmts@def@counter@read{#1}{#2}{#3}%
}
\newrobustcmd*\@cntfmts@add@counter@pattern@nostar[3][cntfmts]{%
\@cntfmts@add@counter@pattern[#1]{#2}{#3}%
\cnltx@expandargs(nno)\@cntfmts@create@read@counter{#1}{#2}{\csname c@#2\endcsname}%
}
\newrobustcmd*\AddCounterPattern{%
\@ifstar
{\@cntfmts@add@counter@pattern}
{\@cntfmts@add@counter@pattern@nostar}%
}
\@onlypreamble\AddCounterPattern
% create pattern for a new counter
% #1: counter
% #2: id
\newrobustcmd*\@cntfmts@new@counter@pattern[3][cntfmts]{%
\ifcsdef{the#2}
{\@cntfmts@err@counter@defined{#2}}{}%
\newcounter{#2}%
\listcsadd{@#1@counter@ids}{#3}%
\@cntfmts@def@counter@read{#1}{#2}{#3}%
\csdef{@#1@#2@counter}{}
}
\newrobustcmd*\@cntfmts@new@counter@pattern@nostar[3][cntfmts]{%
\@cntfmts@new@counter@pattern[#1]{#2}{#3}%
\cnltx@expandargs(nno)\@cntfmts@create@read@counter{#1}{#2}{\csname c@#2\endcsname}%
}
\newrobustcmd*\NewCounterPattern{%
\@ifstar
{\@cntfmts@new@counter@pattern}
{\@cntfmts@new@counter@pattern@nostar}%
}
\@onlypreamble\NewCounterPattern
% renew pattern:
\newrobustcmd*\@cntfmts@renew@counter@pattern[3][cntfmts]{%
\ifcsdef{the#2}
{}{\@cntfmts@err@unknown@counter{#2}}%
\ifcsdef{@#1@#2@counter}{}
{\@cntfmts@err@pattern@undefined{#1}{#2}}%
\ifinlistcs{@#1@counter@ids}{#3}
{}{\listcsadd{@#1@counter@ids}{#3}}%
\@cntfmts@def@counter@read{#1}{#2}{#3}%
}
\newrobustcmd*\@cntfmts@renew@counter@pattern@nostar[3][cntfmts]{%
\@cntfmts@renew@counter@pattern[#1]{#2}{#3}%
\cnltx@expandargs(nno)\@cntfmts@create@read@counter{#1}{#2}{\csname c@#2\endcsname}%
}
\newrobustcmd\RenewCounterPattern{%
\@ifstar
{\@cntfmts@renew@counter@pattern}
{\@cntfmts@renew@counter@pattern@nostar}%
}
\@onlypreamble\RenewCounterPattern
% ----------------------------------------------------------------------------
% assign a different internal command to <counter> than \c@<counter>
% can/must be used after a call from \AddCounterPattern* or
% \NewCounterPattern*
% #1: module
% #2: counter
% #3: internal command
\newrobustcmd*\@cntfmts@create@read@counter[3]{%
\expandafter\newexpandablecmd
\expandafter*\csname @#1@read@#2@counter\endcsname[1][]{%
\ifblank{##1}
{\@arabic{#3}}
{\csuse{@cntfmts@counter@type@##1}{#3}}%
}%
}
\newrobustcmd*\ReadCounterFrom[3][cntfmts]{%
\@cntfmts@create@read@counter{#1}{#2}{#3}%
}
% ----------------------------------------------------------------------------
% pattern formats
% #1: key
% #2: number presentation command like \@alph
\newrobustcmd*\@cntfmts@new@pattern@format[2]{%
\csdef{@cntfmts@counter@type@#1}{#2}%
}
\newrobustcmd*\NewPatternFormat[2]{%
\@cntfmts@new@pattern@format{#1}{#2}%
}
\@onlypreamble\NewPatternFormat
% ----------------------------------------------------------------------------
% interpret and print pattern:
% #1: module
% #2: list
% #3: pattern
\newrobustcmd*\@cntfmts@read@counter@pattern[3]{%
\def\@cntfmts@parsed@pattern{#3\@empty}%
\forlistcsloop{\@cntfmts@replace@pattern{#1}}{#2}%
}
% #1: module
% #2: pattern-key
\newrobustcmd*\@cntfmts@replace@pattern[2]{%
\cnltx@replace@all\@cntfmts@parsed@pattern
{#2}{\csuse{@#1@read@#2@counter}}%
}
\newrobustcmd*\ReadCounterPattern[2][cntfmts]{%
\@cntfmts@read@counter@pattern{#1}{@#1@counter@ids}{#2}\@cntfmts@parsed@pattern
}
\newrobustcmd*\ReadCounterPatternFrom[2][cntfmts]{%
\cnltx@expandargs(nno)\@cntfmts@read@counter@pattern{#1}{@#1@counter@ids}{#2}%
\@cntfmts@parsed@pattern
}
% #1: save pattern in
% #2: save interpretation in
% #3: pattern
% #4: module
\newrobustcmd*\@cntfmts@save@counter@pattern[4]{%
\@cntfmts@read@counter@pattern{#4}{@#4@counter@ids}{#3}%
\let#2\@cntfmts@parsed@pattern
\def#1{#3}%
}
\newrobustcmd*\@cntfmts@esave@counter@pattern[4]{%
\@cntfmts@read@counter@pattern{#4}{@#4@counter@ids}{#3}%
\edef#2{\@cntfmts@parsed@pattern}%
\def#1{#3}%
}
\newrobustcmd*\SaveCounterPattern[4][cntfmts]{%
\@cntfmts@save@counter@pattern{#2}{#3}{#4}{#1}%
}
\newrobustcmd*\SaveCounterPatternFrom[4][cntfmts]{%
\cnltx@expandargs(nno)\@cntfmts@save@counter@pattern{#2}{#3}{#4}{#1}%
}
\newrobustcmd*\eSaveCounterPattern[4][cntfmts]{%
\@cntfmts@esave@counter@pattern{#2}{#3}{#4}{#1}%
}
\newrobustcmd*\eSaveCounterPatternFrom[4][cntfmts]{%
\cnltx@expandargs(nno)\@cntfmts@esave@counter@pattern{#2}{#3}{#4}{#1}%
}
% ----------------------------------------------------------------------------
% predefined formats and pattern
\NewPatternFormat{a}{\@alph}
\NewPatternFormat{A}{\@Alph}
\NewPatternFormat{1}{\@arabic}
\NewPatternFormat{r}{\@roman}
\NewPatternFormat{R}{\@Roman}
\ifdef\c@paragraph
{\AddCounterPattern{paragraph}{pg}}{}
\ifdef\c@subsubsection
{\AddCounterPattern{subsubsection}{ssse}}{}
\ifdef\c@subsection
{\AddCounterPattern{subsection}{sse}}{}
\ifdef\c@section
{\AddCounterPattern{section}{se}}{}
\ifdef\c@chapter
{\AddCounterPattern{chapter}{ch}}{}
\endinput
% HISTORY:
2012/09/30 v0.2beta - first version (as part of the `exsheets' bundle)
2012/11/08 v0.4 - stepped number with `exsheets' until now; next stepping
won't synchronize but will step to whatever deems
appropriate
2012/04/23 v0.5 - changed tests for heading commands to test explicitly for
the associated counters
- change test for counter in \@cntfmts@add@counter@pattern
from \the<ounter> to \c@<ounter>
- rename tokenlist test macros to use cntformats'
namespace
2013/10/11 v0.6 - use my `cnltx-base' package for the programming tools it
provides; this allows to get rid of the artefacts in the
expanded patterns
2014/07/20 v0.7 - remove package from the `exsheets' bundle and distribute
it as package of its own
- robustify non-expandably commands that weren't defined
robust, yet
- replace \def with \newcommand or \newrobustcmd where
possible
|
