summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/xcntperchap/xcntperchap.sty
blob: 01bd26aff444270cc30fd525d25cd86f73882973 (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
%% LaTeX package xcntperchap - version 0.5 (2018/01/05 -- 22:04:12)
%% Source file for xcntperchap.sty
%%
%%
%% -------------------------------------------------------------------------------------------
%% Copyright (c) 2016 -- 2018 by Dr. Christian Hupfer <typography dot with dot latex at gmail dot com>
%% -------------------------------------------------------------------------------------------
%%
%% 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 `author-maintained`
%%
%%

\def\xcntperchappackageversion{0.5}
\NeedsTeXFormat{LaTeX2e}

\ProvidesPackage{xcntperchap}[2018/01/05 - v\xcntperchappackageversion]

\RequirePackage[counter]{zref}
\RequirePackage{l3keys2e}
\RequirePackage{xparse}
\RequirePackage{xassoccnt}


\ExplSyntaxOn


\cs_set_eq:NN \latex@@stepcounter \stepcounter
\cs_set_eq:NN \latex@@addtocounter \addtocounter
\cs_set_eq:NN \latex@@setcounter \setcounter


\cs_generate_variant:Nn \int_set:Nn {NV, Nx}
\cs_generate_variant:Nn \int_eval:n {V, x}
\cs_generate_variant:Nn \seq_gremove_all:Nn {NV,Nx,cV,cx}


\seq_new:N \g_xcntperchap_tracklevel_seq % This holds all counters which serve as a tracklevel


\ior_new:N \g_trackfile_storage_read
\iow_new:N \g_trackfile_storage_write


\int_new:N \l_tracklevelunit_int
\int_new:N \l_tracklevel_tracked_int


\cs_new:Nn \xcntperchap_add_tracklevel:n {% 
  \seq_if_in:NnF \g_xcntperchap_tracklevel_seq {#1} {%
    \seq_gput_right:Nn \g_xcntperchap_tracklevel_seq {#1}
    \seq_new:c {g_xcntperchap_tracklevel_#1_seq}% Creating a new container for the counter names to be tracked
    \prop_new:c {g_xcntperchap_tracklevel_#1_prop}% Creating a new property list for the counter names to be tracked
    \seq_new:c {g_xcntperchap_tracklevelstored_#1_seq}% Creating a new container for the stored counter values (used later on)
    \IfIsDocumentCounterF{cps@@#1trackleveltotal}{%
      \NewDocumentCounter{cps@@#1trackleveltotal}%
    }
    \DeclareAssociatedCounters{#1}{cps@@#1trackleveltotal}
    \zref@newprop{cps#1total}{\number\value{cps@@#1trackleveltotal}}
  }%
}



\NewDocumentCommand{\RegisterMultipleTrackCounters}{mm}{%
  \clist_set:Nn \l_tmpa_clist {#1}%
  \clist_map_inline:Nn \l_tmpa_clist {%
    \RegisterTrackCounter{##1}{#2}%
  }
}


\NewDocumentCommand{\RegisterTrackCounter}{mm}{%
  \xcntperchap_add_tracklevel:n {#1}
  \seq_set_from_clist:cn {g_xcntperchap_tracklevel_#1_seq} {#2}
  \seq_remove_duplicates:c {g_xcntperchap_tracklevel_#1_seq}
  \int_zero:N \l_tmpa_int
  \seq_map_inline:cn {g_xcntperchap_tracklevel_#1_seq} {%
    \int_incr:N \l_tmpa_int
    \IfIsDocumentCounterF{cps@@#1total##1}{%
      \NewDocumentCounter{cps@@#1total##1}%
      \AddAssociatedCounters{##1}{cps@@#1total##1}% Define associated counters 
    }
    \prop_put:cnV {g_xcntperchap_tracklevel_#1_prop} {##1} \l_tmpa_int % New Version 0.2
  }  
}



\cs_new:Nn \xcntperchap_storetracked_values:n{%
  \group_begin:
  \tl_clear:N \l_tmpa_tl
  \int_zero:N \l_tmpa_int
  \int_zero:N \l_tmpb_int
  \seq_if_exist:cT {g_xcntperchap_tracklevel_#1_seq} {
    \seq_if_in:NnT \g_xcntperchap_tracklevel_seq {#1} {%
      \tl_put_right:Nn \l_tmpa_tl {#1,}%
      \int_set:Nx \l_tmpb_int {\seq_count:c {g_xcntperchap_tracklevel_#1_seq} }
      \int_compare:nNnT { \number\value{#1} } > {0 }{%
        \int_zero:N \l_tmpa_int
        \seq_map_inline:cn {g_xcntperchap_tracklevel_#1_seq} {%
          \int_incr:N \l_tmpa_int
          \int_compare:nNnTF {\l_tmpa_int } < { \l_tmpb_int } 
          {  \tl_gput_right:Nx \l_tmpa_tl { \number\value{cps@@#1total##1}, } } {  \tl_gput_right:Nx \l_tmpa_tl { \number\value{cps@@#1total##1} } }
        }
        % Store the value list to the file
        \iow_now:Nx \g_trackfile_storage_write {\tl_use:N \l_tmpa_tl}%
      }
      \seq_map_inline:cn {g_xcntperchap_tracklevel_#1_seq} {
        \setcounter{cps@@#1total##1}{\c_zero}% Reset the total counter values
      }
    }
  }
  \group_end:
}


\NewDocumentCommand{\StoreCounterValues}{m}{%
  \xcntperchap_storetracked_values:n{#1}%
}


% Redefine again, to provide the storage feature

\cs_set:Npn \xcntperchap_internal_stepcounter #1 {%
  % Must get reset list first
  \__xassoccnt_getresetlist:n{#1}% 
  \seq_map_inline:Nn \g_xcntperchap_tracklevel_seq {%
     \seq_if_in:NnT \l__xassoccnt_counterreset_seq {##1} {%
     \StoreCounterValues{##1}%
   }
  }
  \StoreCounterValues{#1}%
  \latex@@stepcounter{#1}%
}


\cs_set:Npn \stepcounter #1{%
  \xcntperchap_internal_stepcounter{#1}%
}

% Added in Version 0.5 
\cs_set:Npn \setcounter #1#2{%
  % This might be necessary later on -> check in next updates
%  \__xassoccnt_getresetlist:n{#1}% 
%  \seq_map_inline:Nn \g_xcntperchap_tracklevel_seq {%
%    \seq_if_in:NnT \l__xassoccnt_counterreset_seq {##1} {%
%      \StoreCounterValues{##1}%
%    }
%  }	
  \StoreCounterValues{#1}%
  \latex@@setcounter{#1}{#2}%
}

\NewDocumentCommand{\AddToTrackedCounters}{mm}{%
  \seq_set_from_clist:Nn \l_tmpa_seq {#1} 
  \seq_map_inline:Nn \l_tmpa_seq {%
    \prg_replicate:nn {#2} {\stepcounter{##1}}
  }
}





\cs_new:Nn \xcntperchap_trackcounters: {%
  \seq_map_inline:cn {g_xcntperchap_tracklevel_seq} {%
    \xcntperchap_storetracked_values:n{##1}%
  }
}

\NewDocumentCommand{\TrackCounters}{}{%
  \xcntperchap_trackcounters:
}


\NewDocumentCommand{\cntperchapsetup}{}{%
% Unused so far  
}

\NewDocumentCommand{\LoadTrackedValues}{}{%
  \IfFileExists{\jobname.cpc}{%
    \xcntperchap_open_trackfile_for_read:n{\jobname.cpc}
    \GetStoredValues%
    \xcntperchap_close_trackfile_for_read:
  }{}
}


\cs_new:Nn \l_xcntperchap_numberoftracks:n {%
  \seq_if_exist:cTF { g_xcntperchap_tracklevelstored_#1_seq} {%
    \int_eval:n {\seq_count:c {g_xcntperchap_tracklevelstored_#1_seq} / \seq_count:c {g_xcntperchap_tracklevel_#1_seq}}
  }{
    \c_zero
  }
}  



\cs_new:Nn \xcntperchap_open_trackfile_for_read:n {%
  \ior_open:Nn \g_trackfile_storage_read {#1}
}

\cs_new_nopar:Nn \xcntperchap_close_trackfile_for_read: {%
  \ior_close:N \g_trackfile_storage_read
}

\cs_new:Nn \xcntperchap_open_trackfile_for_write:n {%
  \iow_open:Nn \g_trackfile_storage_write {#1}
}

\cs_new_nopar:Nn \xcntperchap_close_trackfile_for_write: {%
  \iow_close:N \g_trackfile_storage_write
}

\NewDocumentCommand{\CloseTrackFileForWrite}{}{%
  \xcntperchap_close_trackfile_for_write:%
}


\NewDocumentCommand{\OpenTrackFileForWrite}{m}{%
  \xcntperchap_open_trackfile_for_write:n{#1}%
}



\cs_new:Nn \l_xcntperchap_read_countervalues:n {%
  \clist_set:Nx \l_tmpa_clist {#1}%
  \tl_set:Nx \l_tmpa_tl {\clist_item:Nn \l_tmpa_clist {1}}
  \clist_map_inline:Nn \l_tmpa_clist {%
    \seq_gput_right:cn {g_xcntperchap_tracklevelstored_\l_tmpa_tl _seq} {##1} % Store the value in the tracklevel list for counter \l_tmpa_tl
  }
  % Kick the name of the tracklevel counter from the list
  \seq_gremove_all:cx {g_xcntperchap_tracklevelstored_\l_tmpa_tl _seq} {\tl_use:N \l_tmpa_tl}%
}

\cs_new_nopar:Nn \xcntperchap_gettrackedvalues_from_file:n {%
  \ior_map_inline:Nn #1 { \l_xcntperchap_read_countervalues:n{##1}  }
}


% Unexpandable version!
\cs_new:Nn \xcntperchap_obtaintrackedvalue:nnn {%
  \int_set:Nx \l_tracklevelunit_int {#1}
  \seq_if_in:cnTF {g_xcntperchap_tracklevel_#2_seq} {#3} 
  {
    \int_set:Nx \l_tracklevel_tracked_int {\seq_count:c {g_xcntperchap_tracklevel_#2_seq}}
    \int_zero:N \l_tmpa_int
    \seq_map_inline:cn {g_xcntperchap_tracklevel_#2_seq} {%
      \int_incr:N \l_tmpa_int
      \tl_if_eq:nnT { ##1 } {#3 } { 
        \seq_map_break:
      }
    }
    \int_set:NV \l_tmpb_int { \l_tmpa_int }
    \int_set:Nx \l_tmpa_int { \l_tracklevel_tracked_int * (\l_tracklevelunit_int -1) + \l_tmpb_int  }
  }{%
    % Perhaps some error message here, for the moment only a screen message
    \typeout{#3~is~not~under~track~control~of~#2}
  }
}  

\NewDocumentCommand{\ObtainTrackedValue}{omm}{%
  \IfValueTF{#1}{%
    \xcntperchap_obtaintrackedvalue:nnn {#1}{#2}{#3}%
  }{%
    \xcntperchap_obtaintrackedvalue:nnn {\number\value{#2}}{#2}{#3}%
  }%
}


%%%%% 0.2 Expandable Version

\cs_new:Nn \xcntperchap_obtaintrackedvalue_exp:nnn {% Needs some error checking!!!
  \seq_if_exist:cTF {g_xcntperchap_tracklevel_#2_seq} {
    \seq_item:cn {g_xcntperchap_tracklevelstored_#2_seq} { \seq_count:c {g_xcntperchap_tracklevel_#2_seq} * \int_eval:n{#1-1}+\prop_item:cn {g_xcntperchap_tracklevel_#2_prop} {#3}}
  }{
    \typeout{Error!}%
  }
}

\DeclareExpandableDocumentCommand{\ObtainTrackedValueExp}{omm}{%
  \IfValueTF{#1}{%
    \xcntperchap_obtaintrackedvalue_exp:nnn {#1}{#2}{#3}%
  }{%
    \xcntperchap_obtaintrackedvalue_exp:nnn {\number\value{#2}}{#2}{#3}
  }
}


\NewDocumentCommand{\GetStoredValues}{}{%
  \xcntperchap_gettrackedvalues_from_file:n {\g_trackfile_storage_read}
}




\ExplSyntaxOff

\newif\if@cpscleverefloaded

\AtBeginDocument{%
  \@ifpackageloaded{cleveref}{%
    \global\@cpscleverefloadedtrue
  }{%
    \global\@cpscleverefloadedfalse
  }
}


\NewDocumentCommand{\tracklabel}{som}{%
  \zref@labelbyprops{#3}{counter,cps\LastRefSteppedCounter total}% The counter property is for safety here!
  \IfBooleanF{#1}{% No starred version, generate the usual \label
    % Check first whether we're using cleveref
    \IfValueTF{#2}{%
      \@ifcleverefloadedtrue
      \label[#2]{#3}%
      \else
      % ignore the optional argument provided by tracklabel, it's of use since cleveref is not loaded.
      \label{#3}%
      \fi
    }{% No optional argument
      \label{#3}%
    }%
  }% End of checking for starred command
}



\DeclareExpandableDocumentCommand{\ObtainTrackedValueByLabel}{omm}{%
  \zref@ifrefundefined{#2}{??}{%
    \IfValueTF{#1}{%
      \ObtainTrackedValueExp[\zref@extract{#2}{cps#1total}]{#1}{#3}%
    }{%
      \ObtainTrackedValueExp[\zref@extract{#2}{cps\zref@extract{#2}{counter}total}]{\zref@extract{#2}{counter}}{#3}%
    }%
  }%
}


\NewDocumentCommand{\RegisterCounters}{mm}{%
  \RegisterTrackCounter{#1}{#2}%
}



\@onlypreamble\RegisterTrackCounter
\@onlypreamble\RegisterMultipleTrackCounters
\@onlypreamble\RegisterCounters

\makeatother


\AtBeginDocument{%
  \LoadTrackedValues%
  \OpenTrackFileForWrite{\jobname.cpc}%
}

\AtEndDocument{%
  \TrackCounters%
  \CloseTrackFileForWrite%
}
\endinput