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
|
if not modules then modules = { } end modules ['strc-lst'] = {
version = 1.001,
comment = "companion to strc-lst.mkiv",
author = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
copyright = "PRAGMA ADE / ConTeXt Development Team",
license = "see context related readme files"
}
-- when all datastructures are stable a packer will be added which will
-- bring down memory consumption a bit; we can use for instance a pagenumber,
-- section, metadata cache (internal then has to move up one level) or a
-- shared cache [we can use a fast and stupid serializer]
local format, gmatch, gsub = string.format, string.gmatch, string.gsub
local tonumber = tonumber
local texsprint, texprint, texwrite, texcount = tex.sprint, tex.print, tex.write, tex.count
local concat, insert, remove = table.concat, table.insert, table.remove
local lpegmatch = lpeg.match
local trace_lists = false trackers.register("structure.lists", function(v) trace_lists = v end)
local ctxcatcodes = tex.ctxcatcodes
structure.lists = structure.lists or { }
structure.sections = structure.sections or { }
structure.helpers = structure.helpers or { }
structure.documents = structure.documents or { }
structure.pages = structure.pages or { }
local lists = structure.lists
local sections = structure.sections
local helpers = structure.helpers
local documents = structure.documents
local pages = structure.pages
lists.collected = lists.collected or { }
lists.tobesaved = lists.tobesaved or { }
lists.enhancers = lists.enhancers or { }
lists.internals = lists.internals or { }
lists.ordered = lists.ordered or { }
local variables = interfaces.variables
local matching_till_depth, number_at_depth = sections.matching_till_depth, sections.number_at_depth
local function initializer()
-- create a cross reference between internal references
-- and list entries
local collected = lists.collected
local internals = jobreferences.internals
local ordered = lists.ordered
for i=1,#collected do
local c = collected[i]
local m = c.metadata
local r = c.references
if m then
-- access by internal reference
local internal = r and r.internal
if internal then
internals[internal] = c
end
-- access by order in list
local kind, name = m.kind, m.name
if kind and name then
local ok = ordered[kind]
if ok then
local on = ok[name]
if on then
on[#on+1] = c
else
ok[name] = { c }
end
else
ordered[kind] = { [name] = { c } }
end
end
end
end
end
if job then
job.register('structure.lists.collected', structure.lists.tobesaved, initializer)
end
local cached, pushed = { }, { }
function lists.push(t)
local r = t.references
local i = (r and r.internal) or 0 -- brrr
local p = pushed[i]
if not p then
p = #cached + 1
cached[p] = helpers.simplify(t)
pushed[i] = p
end
texwrite(p)
end
function lists.doifstoredelse(n)
commands.doifelse(cached[tonumber(n)])
end
-- this is the main pagenumber enhancer
function lists.enhance(n)
-- todo: symbolic names for counters
local l = cached[n]
if l then
--
l.directives = nil -- might change
-- save in the right order (happens at shipout)
lists.tobesaved[#lists.tobesaved+1] = l
-- default enhancer (cross referencing)
l.references.realpage = texcount.realpageno
-- specific enhancer (kind of obsolete)
local kind = l.metadata.kind
local enhancer = kind and lists.enhancers[kind]
if enhancer then
enhancer(l)
end
end
end
-- we can use level instead but we can also decide to remove level from the metadata
local nesting = { }
function lists.pushnesting(i)
local r = lists.result[i]
local name = r.metadata.name
local numberdata = r and r.numberdata
local n = (numberdata and numberdata.numbers[sections.getlevel(name)]) or 0
insert(nesting, { number = n, name = name, result = lists.result, parent = r })
end
function lists.popnesting()
local old = remove(nesting)
lists.result = old.result
end
-- will be split
local function filter_collected(names, criterium, number, collected, nested)
local numbers, depth = documents.data.numbers, documents.data.depth
local hash, result, all, detail = { }, { }, not names or names == "" or names == variables.all, nil
names, criterium = gsub(names," ",""), gsub(criterium," ","")
if trace_lists then
logs.report("lists","filtering names: %s, criterium: %s, number: %s",names,criterium,number or "-")
end
if not all then
for s in gmatch(names,"[^, ]+") do -- sort of settings to hash
hash[s] = true
end
end
if criterium == variables.intro then
-- special case, no structure yet
for i=1,#collected do
local v = collected[i]
local r = v.references
if r and r.section == 0 then
result[#result+1] = v
end
end
elseif criterium == variables.all or criterium == variables.text then
for i=1,#collected do
local v = collected[i]
local r = v.references
if r then
local sectionnumber = (r.section == 0) or jobsections.collected[r.section]
if sectionnumber then -- and not sectionnumber.hidenumber then
local metadata = v.metadata
if metadata and not metadata.nolist and (all or hash[metadata.name or false]) then
result[#result+1] = v
end
end
end
end
elseif criterium == variables.current then
if depth == 0 then
return filter_collected(names,variables.intro,number,collected)
else
for i=1,#collected do
local v = collected[i]
local r = v.references
if r then
local sectionnumber = jobsections.collected[r.section]
if sectionnumber then -- and not sectionnumber.hidenumber then
local cnumbers = sectionnumber.numbers
local metadata = v.metadata
if cnumbers then
if metadata and not metadata.nolist and (all or hash[metadata.name or false]) and #cnumbers > depth then
local ok = true
for d=1,depth do
local cnd = cnumbers[d]
if not (cnd == 0 or cnd == numbers[d]) then
ok = false
break
end
end
if ok then
result[#result+1] = v
end
end
end
end
end
end
end
elseif criterium == variables.here then
-- this is quite dirty ... as cnumbers is not sparse we can misuse #cnumbers
if depth == 0 then
return filter_collected(names,variables.intro,number,collected)
else
for i=1,#collected do
local v = collected[i]
local r = v.references
if r then
local sectionnumber = jobsections.collected[r.section]
if sectionnumber then -- and not sectionnumber.hidenumber then
local cnumbers = sectionnumber.numbers
local metadata = v.metadata
if cnumbers then
--~ print(#cnumbers, depth, table.concat(cnumbers))
if metadata and not metadata.nolist and (all or hash[metadata.name or false]) and #cnumbers >= depth then
local ok = true
for d=1,depth do
local cnd = cnumbers[d]
if not (cnd == 0 or cnd == numbers[d]) then
ok = false
break
end
end
if ok then
result[#result+1] = v
end
end
end
end
end
end
end
elseif criterium == variables.previous then
if depth == 0 then
return filter_collected(names,variables.intro,number,collected)
else
for i=1,#collected do
local v = collected[i]
local r = v.references
if r then
local sectionnumber = jobsections.collected[r.section]
if sectionnumber then -- and not sectionnumber.hidenumber then
local cnumbers = sectionnumber.numbers
local metadata = v.metadata
if cnumbers then
if metadata and not metadata.nolist and (all or hash[metadata.name or false]) and #cnumbers >= depth then
local ok = true
for d=1,depth-1 do
local cnd = cnumbers[d]
if not (cnd == 0 or cnd == numbers[d]) then
ok = false
break
end
end
if ok then
result[#result+1] = v
end
end
end
end
end
end
end
elseif criterium == variables["local"] then -- not yet ok
local nested = nesting[#nesting]
if nested then
return filter_collected(names,nested.name,nested.number,collected,nested)
elseif sections.autodepth(documents.data.numbers) == 0 then
return filter_collected(names,variables.all,number,collected)
else
return filter_collected(names,variables.current,number,collected)
end
else -- sectionname, number
-- not the same as register
local depth = sections.getlevel(criterium)
local number = tonumber(number) or number_at_depth(depth) or 0
if trace_lists then
local t = sections.numbers()
detail = format("depth: %s, number: %s, numbers: %s, startset: %s",depth,number,(#t>0 and concat(t,".",1,depth)) or "?",#collected)
end
if number > 0 then
local parent = nested and nested.parent and nested.parent.numberdata.numbers -- so local as well as nested
for i=1,#collected do
local v = collected[i]
local r = v.references
if r then
local sectionnumber = jobsections.collected[r.section]
if sectionnumber then
local metadata = v.metadata
local cnumbers = sectionnumber.numbers
if cnumbers then
if (all or hash[metadata.name or false]) and #cnumbers >= depth and matching_till_depth(depth,cnumbers,parent) then
result[#result+1] = v
end
end
end
end
end
end
end
if trace_lists then
if detail then
logs.report("lists","criterium: %s, %s, found: %s",criterium,detail,#result)
else
logs.report("lists","criterium: %s, found: %s",criterium,#result)
end
end
return result
end
lists.filter_collected = filter_collected
function lists.filter(names, criterium, number)
return filter_collected(names, criterium, number, lists.collected)
end
lists.result = { }
function lists.process(...)
lists.result = lists.filter(...)
for i=1,#lists.result do
local r = lists.result[i]
local m = r.metadata
texsprint(ctxcatcodes,format("\\processlistofstructure{%s}{%s}{%i}",m.name,m.kind,i))
end
end
function lists.analyze(...)
lists.result = lists.filter(...)
end
function lists.userdata(name,r,tag) -- to tex
local str = lists.result[r]
str = str and str.userdata
str = str and str[tag]
if str then
texsprint(ctxcatcodes,str)
end
end
function lists.uservalue(name,r,tag,default) -- to lua
local str = lists.result[r]
str = str and str.userdata
str = str and str[tag]
return str or default
end
function lists.size()
texprint(#lists.result)
end
function lists.location(n)
local l = lists.result[n]
texsprint(l.references.internal or n)
end
function lists.sectionnumber(name,n,spec)
local data = lists.result[n]
local sectiondata = jobsections.collected[data.references.section]
-- hm, prefixnumber?
sections.typesetnumber(sectiondata,"prefix",spec,sectiondata) -- data happens to contain the spec too
end
-- some basics (todo: helpers for pages)
function lists.title(name,n,tag) -- tag becomes obsolete
local data = lists.result[n]
if data then
local titledata = data.titledata
if titledata then
helpers.title(titledata[tag] or titledata.list or titledata.title or "",data.metadata)
end
end
end
function lists.savedtitle(name,n,tag)
local data = cached[tonumber(n)]
if data then
local titledata = data.titledata
if titledata then
helpers.title(titledata[tag] or titledata.title or "",data.metadata)
--~ texsprint(ctxcatcodes,titledata[tag] or titledata.title or "")
end
end
end
function lists.savednumber(name,n)
local data = cached[tonumber(n)]
if data then
local numberdata = data.numberdata
if numberdata then
sections.typesetnumber(numberdata,"number",numberdata or false)
end
end
end
function lists.savedprefixednumber(name,n)
local data = cached[tonumber(n)]
if data then
helpers.prefix(data,data.prefixdata)
local numberdata = data.numberdata
if numberdata then
--~ print(name,n,table.serialize(numberdata))
sections.typesetnumber(numberdata,"number",numberdata or false)
end
end
end
function lists.prefix(name,n,spec)
helpers.prefix(lists.result[n],spec)
end
function lists.page(name,n,pagespec)
helpers.page(lists.result[n],pagespec)
end
function lists.prefixedpage(name,n,prefixspec,pagespec)
helpers.prefixpage(lists.result[n],prefixspec,pagespec)
end
function lists.realpage(name,n)
local data = lists.result[n]
if data then
local references = data.references
texsprint(references and references.realpage or 0)
else
texsprint(0)
end
end
-- numbers stored in entry.numberdata + entry.numberprefix
function lists.number(name,n,spec)
local data = lists.result[n]
if data then
local numberdata = data.numberdata
if numberdata then
sections.typesetnumber(numberdata,"number",spec or false,numberdata or false)
end
end
end
function lists.prefixednumber(name,n,prefixspec,numberspec)
local data = lists.result[n]
if data then
helpers.prefix(data,prefixspec)
local numberdata = data.numberdata
if numberdata then
sections.typesetnumber(numberdata,"number",spec or false,numberdata or false)
end
end
end
-- todo, do this in references namespace ordered instead (this is an experiment)
--
-- also see lpdf-ano (maybe move this there)
local splitter = lpeg.splitat(":")
function jobreferences.specials.order(var,actions) -- jobreferences.specials !
local operation = var.operation
if operation then
local kind, name, n = lpegmatch(splitter,operation)
local order = lists.ordered[kind]
order = order and order[name]
local v = order[tonumber(n)]
local r = v and v.references.realpage
if r then
actions.realpage = r
var.operation = r -- brrr, but test anyway
return jobreferences.specials.page(var,actions)
end
end
end
|