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
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
|
if not modules then modules = { } end modules ['strc-doc'] = {
version = 1.001,
comment = "companion to strc-doc.mkiv",
author = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
copyright = "PRAGMA ADE / ConTeXt Development Team",
license = "see context related readme files"
}
-- todo: associate counter with head
-- we need to freeze and document this module
local next, type = next, type
local format, gsub, find, concat, gmatch, match = string.format, string.gsub, string.find, table.concat, string.gmatch, string.match
local texsprint, texwrite = tex.sprint, tex.write
local concat = table.concat
local max, min = math.max, math.min
local ctxcatcodes = tex.ctxcatcodes
local variables = interfaces.variables
--~ if not trackers then trackers = { register = function() end } end
local trace_sectioning = false trackers.register("structure.sectioning", function(v) trace_sectioning = v end)
local trace_detail = false trackers.register("structure.detail", function(v) trace_detail = v end)
local function report(...)
--~ print(...)
logs.report("sectioning:",...)
end
structure = structure or { }
structure.helpers = structure.helpers or { }
structure.documents = structure.documents or { }
structure.sections = structure.sections or { }
structure.sets = structure.sets or { }
structure.processors = structure.processors or { }
local helpers = structure.helpers
local documents = structure.documents
local sections = structure.sections
local sets = structure.sets
local processors = structure.processors
-- -- -- document -- -- --
local data
function documents.initialize()
data = {
numbers = { },
forced = { },
ownnumbers = { },
status = { },
checkers = { },
depth = 0,
blocks = { },
block = "",
}
documents.data = data
end
function documents.reset()
data.numbers = { }
data.forced = { }
data.ownnumbers = { }
data.status = { }
--~ data.checkers = { }
data.depth = 0
end
documents.initialize()
-- -- -- sections -- -- --
jobsections = jobsections or { }
jobsections.collected = jobsections.collected or { }
jobsections.tobesaved = jobsections.tobesaved or { }
local collected, tobesaved = jobsections.collected, jobsections.tobesaved
--~ local function initializer()
--~ collected, tobesaved = jobsections.collected, jobsections.tobesaved
--~ end
--~ job.register('jobsections.collected', jobsections.tobesaved, initializer)
function sections.currentid()
return #tobesaved
end
function sections.save(sectiondata)
-- local sectionnumber = helpers.simplify(section.sectiondata) -- maybe done earlier
local numberdata = sectiondata.numberdata
if not numberdata or sectiondata.metadata.nolist then
return #tobesaved
else
local n = #tobesaved + 1
tobesaved[n] = numberdata
if not collected[n] then
collected[n] = numberdata
end
return n
end
end
function sections.load()
setmetatable(collected,nil)
local l = structure.lists.collected
for i=1,#l do
local li = l[i]
local lm = li.metadata
if lm and lm.kind == "section" and not lm.nolist then
local ln = li.numberdata
if ln then
collected[#collected+1] = ln
end
end
end
sections.load = nil
end
setmetatable(collected, {
__index = function(t,i)
sections.load()
return t[i] or { }
end
})
--
structure.sections.levelmap = structure.sections.levelmap or { }
local levelmap = structure.sections.levelmap
storage.register("structure/sections/levelmap", structure.sections.levelmap, "structure.sections.levelmap")
sections.verbose = true
levelmap.block = -1
function sections.setlevel(name,level) -- level can be number or parent (=string)
local l = tonumber(level)
if not l then
l = levelmap[level]
end
if l and l > 0 then
levelmap[name] = l
else
-- error
end
end
function sections.getlevel(name)
return levelmap[name] or 0
end
function sections.way(way,by)
texsprint(ctxcatcodes,(gsub(way,"^"..by,"")))
end
function sections.setblock(name)
local block = name or data.block or "unknown" -- can be used to set the default
data.block = block
texwrite(block)
end
function sections.pushblock(name)
structure.counters.check(0) -- we assume sane usage of \page between blocks
local block = name or data.block
data.blocks[#data.blocks+1] = block
data.block = block
documents.reset()
texwrite(block)
end
function sections.popblock()
data.blocks[#data.blocks] = nil
local block = data.blocks[#data.blocks] or data.block
data.block = block
documents.reset()
texwrite(block)
end
function sections.currentblock()
return data.block or data.blocks[#data.blocks] or "unknown"
end
function sections.currentlevel()
return data.depth
end
function sections.getcurrentlevel()
texwrite(data.depth)
end
function sections.somelevel(given)
-- old number
local numbers, ownnumbers, forced, status, olddepth = data.numbers, data.ownnumbers, data.forced, data.status, data.depth
local givenname = given.metadata.name
local mappedlevel = levelmap[givenname]
local newdepth = tonumber(mappedlevel or (olddepth > 0 and olddepth) or 1) -- hm, levelmap only works for section-*
local directives = given.directives
local resetset = (directives and directives.resetset) or ""
-- local resetter = sets.getall("structure:resets",data.block,resetset)
-- a trick to permits userdata to overload title, ownnumber and reference
-- normally these are passed as argument but nowadays we provide several
-- interfaces (we need this because we want to be compatible)
if trace_detail then
logs.report("structure","name '%s', mapped level '%s', old depth '%s', new depth '%s', reset set '%s'",givenname,mappedlevel,olddepth,newdepth,resetset)
end
local u = given.userdata
if u then
-- kind of obsolete as we can pass them directly anyway
if u.reference and u.reference ~= "" then given.metadata.reference = u.reference ; u.reference = nil end
if u.ownnumber and u.ownnumber ~= "" then given.numberdata.ownnumber = u.ownnumber ; u.ownnumber = nil end
if u.title and u.title ~= "" then given.titledata.title = u.title ; u.title = nil end
if u.bookmark and u.bookmark ~= "" then given.titledata.bookmark = u.bookmark ; u.bookmark = nil end
if u.label and u.label ~= "" then given.titledata.label = u.label ; u.label = nil end
end
-- so far for the trick
if newdepth > olddepth then
for i=olddepth+1,newdepth do
local s = tonumber(sets.get("structure:resets",data.block,resetset,i))
if trace_detail then
logs.report("structure","new>old (%s>%s), reset set '%s', reset value '%s', current '%s'",olddepth,newdepth,resetset,s or "?",numbers[i] or "?")
end
if not s or s == 0 then
numbers[i] = numbers[i] or 0
ownnumbers[i] = ownnumbers[i] or ""
else
numbers[i] = s - 1
ownnumbers[i] = ""
end
status[i] = { }
end
elseif newdepth < olddepth then
for i=olddepth,newdepth+1,-1 do
local s = tonumber(sets.get("structure:resets",data.block,resetset,i))
if trace_detail then
logs.report("structure","new<old (%s<%s), reset set '%s', reset value '%s', current '%s'",olddepth,newdepth,resetset,s or "?",numbers[i] or "?")
end
if not s or s == 0 then
numbers[i] = numbers[i] or 0
ownnumbers[i] = ownnumbers[i] or ""
else
numbers[i] = s - 1
ownnumbers[i] = ""
end
status[i] = nil
end
end
structure.counters.check(newdepth)
ownnumbers[newdepth] = given.numberdata.ownnumber or ""
given.numberdata.ownnumber = nil
data.depth = newdepth
-- new number
olddepth = newdepth
if given.metadata.increment then
local oldn, newn = numbers[newdepth] or 0, 0
local fd = forced[newdepth]
if fd then
if fd[1] == "add" then
newn = oldn + fd[2] + 1
else
newn = fd[2] + 1
end
if newn < 0 then
newn = 1 -- maybe zero is nicer
end
forced[newdepth] = nil
if trace_detail then
logs.report("structure","old depth '%s', new depth '%s, old n '%s', new n '%s', forced '%s'",olddepth,newdepth,oldn,newn,concat(fd,""))
end
elseif newn then
newn = oldn + 1
if trace_detail then
logs.report("structure","old depth '%s', new depth '%s, old n '%s', new n '%s', increment",olddepth,newdepth,oldn,newn)
end
else
local s = tonumber(sets.get("structure:resets",data.block,resetset,newdepth))
if not s then
newn = oldn or 0
elseif s == 0 then
newn = oldn or 0
else
newn = s - 1
end
if trace_detail then
logs.report("structure","old depth '%s', new depth '%s, old n '%s', new n '%s', reset",olddepth,newdepth,oldn,newn)
end
end
numbers[newdepth] = newn
end
status[newdepth] = given or { }
for k, v in pairs(data.checkers) do
if v[1] == newdepth and v[2] then
v[2](k)
end
end
local numberdata= given.numberdata
if not numberdata then
-- probably simplified to nothing
numberdata = { }
given.numberdata = numberdata
end
local n = { }
for i=1,newdepth do
n[i] = numbers[i]
end
numberdata.numbers = n
if #ownnumbers > 0 then
numberdata.ownnumbers = table.fastcopy(ownnumbers)
end
if trace_detail then
logs.report("structure","name '%s', numbers '%s', own numbers '%s'",givenname,concat(numberdata.numbers, " "),concat(numberdata.ownnumbers, " "))
end
given.references.section = sections.save(given)
-- given.numberdata = nil
end
function sections.writestatus()
if sections.verbose then
local numbers, ownnumbers, status, depth = data.numbers, data.ownnumbers, data.status, data.depth
local d = status[depth]
local o = concat(ownnumbers,".",1,depth)
local n = (numbers and concat(numbers,".",1,min(depth,#numbers))) or 0
local l = d.titledata.title or ""
local t = (l ~= "" and l) or d.titledata.title or "[no title]"
local m = d.metadata.name
if o and not find(o,"^%.*$") then
commands.writestatus("structure","%s @ level %i : (%s) %s -> %s",m,depth,n,o,t)
elseif d.directives and d.directives.hidenumber then
commands.writestatus("structure","%s @ level %i : (%s) -> %s",m,depth,n,t)
else
commands.writestatus("structure","%s @ level %i : %s -> %s",m,depth,n,t)
end
end
end
function sections.setnumber(depth,n)
local forced, depth, new = data.forced, depth or data.depth, tonumber(n)
if type(n) == "string" then
if find(n,"^[%+%-]") then
forced[depth] = { "add", new }
else
forced[depth] = { "set", new }
end
else
forced[depth] = { "set", new }
end
end
function sections.number_at_depth(depth)
return data.numbers[tonumber(depth) or sections.getlevel(depth) or 0] or 0
end
function sections.numbers()
return data.numbers
end
function sections.matching_till_depth(depth,numbers,parentnumbers)
local dn = parentnumbers or data.numbers
local ok = false
for i=1,depth do
if dn[i] == numbers[i] then
ok = true
else
return false
end
end
return ok
end
function sections.getnumber(depth) -- redefined later ...
texwrite(data.numbers[depth] or 0)
end
function sections.set(key,value)
data.status[data.depth][key] = value -- may be nil for a reset
end
function sections.cct()
local metadata = data.status[data.depth].metadata
texsprint((metadata and metadata.catcodes) or ctxcatcodes)
end
function sections.structuredata(depth,key,default,honorcatcodetable) -- todo: spec table and then also depth
if not depth or depth == 0 then depth = data.depth end
local data = data.status[depth]
local d = data
for k in gmatch(key,"([^.]+)") do
if type(d) == "table" then
d = d[k]
if not d then
-- unknown key
break
end
end
if type(d) == "string" then
if honorcatcodetable == true or honorcatcodetable == variables.auto then
local metadata = data.metadata
texsprint((metadata and metadata.catcodes) or ctxcatcodes,d)
elseif not honorcatcodetable then
texsprint(ctxcatcodes,d)
elseif type(honorcatcodetable) == "number" then
texsprint(honorcatcodetable,d)
elseif type(honorcatcodetable) == "string" and honorcatcodetable ~= "" then
honorcatcodetable = tex[honorcatcodetable] or ctxcatcodes-- we should move ctxcatcodes to another table, ctx or so
texsprint(honorcatcodetable,d)
else
texsprint(ctxcatcodes,d)
end
return
end
end
if default then
texsprint(ctxcatcodes,default)
end
end
function sections.userdata(depth,key,default)
if not depth or depth == 0 then depth = data.depth end
if depth > 0 then
local userdata = data.status[depth]
userdata = userdata and userdata.userdata
userdata = (userdata and userdata[key]) or default
if userdata then
texsprint(ctxcatcodes,userdata)
end
end
end
function sections.setchecker(name,level,command) -- hm, checkers are not saved
data.checkers[name] = (name and command and level >= 0 and { level, command }) or nil
end
function sections.current()
return data.status[data.depth]
end
function sections.depthnumber(n)
local depth = data.depth
if not n or n == 0 then
n = depth
elseif n < 0 then
n = depth + n
end
return texwrite(data.numbers[n] or 0)
end
function sections.autodepth(numbers)
for i=#numbers,1,-1 do
if numbers[i] ~= 0 then
return i
end
end
return 0
end
--
function structure.currentsectionnumber() -- brr, namespace wrong
local sc = sections.current()
return sc and sc.numberdata
end
-- \dorecurse{3} {
-- \chapter{Blabla} \subsection{bla 1 1} \subsection{bla 1 2}
-- \section{bla 2} \subsection{bla 2 1} \subsection{bla 2 2}
-- }
-- sign=all => also zero and negative
-- sign=positive => also zero
-- sign=hang => llap sign
function sections.typesetnumber(entry,kind,...) -- kind='section','number','prefix'
if entry and entry.hidenumber ~= true then -- can be nil
local separatorset = ""
local conversionset = ""
local conversion = ""
local stopper = ""
local starter = ""
local connector = ""
local set = ""
local segments = ""
local criterium = ""
for _, data in ipairs { ... } do -- can be multiple parametersets
if data then
if separatorset == "" then separatorset = data.separatorset or "" end
if conversionset == "" then conversionset = data.conversionset or "" end
if conversion == "" then conversion = data.conversion or "" end
if stopper == "" then stopper = data.stopper or "" end
if starter == "" then starter = data.starter or "" end
if connector == "" then connector = data.connector or "" end
if set == "" then set = data.set or "" end
if segments == "" then segments = data.segments or "" end
if criterium == "" then criterium = data.criterium or "" end
end
end
if separatorset == "" then separatorset = "default" end
if conversionset == "" then conversionset = "default" end -- not used
if conversion == "" then conversion = nil end
if stopper == "" then stopper = nil end
if starter == "" then starter = nil end
if connector == "" then connector = nil end
if set == "" then set = "default" end
if segments == "" then segments = nil end
--
if criterium == variables.strict then
criterium = 0
elseif criterium == variables.positive then
criterium = -1
elseif criterium == variables.all then
criterium = -1000000
else
criterium = 0
end
--
local firstprefix, lastprefix = 0, 16
if segments then
local f, l = match(tostring(segments),"^(.-):(.+)$")
if f and l then
-- 0:100, chapter:subsubsection
firstprefix = tonumber(f) or sections.getlevel(f) or 0
lastprefix = tonumber(l) or sections.getlevel(l) or 100
else
-- 3, section
local fl = tonumber(segments) or sections.getlevel(segments) -- generalize
if fl then
firstprefix, lastprefix = fl, fl
end
end
end
--
local numbers, ownnumbers = entry.numbers, entry.ownnumbers
if numbers then
local done, preceding = false, false
local function process(index) -- move to outer
-- todo: too much (100 steps)
local number = numbers and (numbers[index] or 0)
local ownnumber = ownnumbers and ownnumbers[index] or ""
if number > criterium or (ownnumber ~= "") then
local block = (entry.block ~= "" and entry.block) or sections.currentblock() -- added
if preceding then
local separator = sets.get("structure:separators",block,separatorset,preceding,".")
if separator then
processors.sprint(ctxcatcodes,separator)
end
preceding = false
end
if ownnumber ~= "" then
processors.sprint(ctxcatcodes,ownnumber)
-- elseif conversion and conversion ~= "" then
-- texsprint(ctxcatcodes,format("\\convertnumber{%s}{%s}",conversion,number))
elseif conversion and conversion ~= "" then
-- traditional (e.g. used in itemgroups)
texsprint(ctxcatcodes,format("\\convertnumber{%s}{%s}",conversion,number))
else
local theconversion = sets.get("structure:conversions",block,conversionset,index,"numbers")
processors.sprint(ctxcatcodes,theconversion,function(str)
return format("\\convertnumber{%s}{%s}",str or "numbers",number)
end)
end
preceding, done = index, true
else
preceding = preceding or false
end
end
--
local prefixlist = set and sets.getall("structure:prefixes","",set) -- "" == block
if starter then
processors.sprint(ctxcatcodes,starter)
end
if prefixlist and (kind == 'section' or kind == 'prefix') then
-- find valid set (problem: for sectionnumber we should pass the level)
-- if kind == "section" then
-- no holes
local b, e, bb, ee = 1, #prefixlist, 0, 0
-- find last valid number
for k=e,b,-1 do
local prefix = prefixlist[k]
local index = sections.getlevel(prefix) or k
if index >= firstprefix and index <= lastprefix then
local number = numbers and numbers[index]
if number then
local ownnumber = ownnumbers and ownnumbers[index] or ""
if number > 0 or (ownnumber ~= "") then
break
else
e = k -1
end
end
end
end
-- find valid range
for k=b,e do
local prefix = prefixlist[k]
local index = sections.getlevel(prefix) or k
if index >= firstprefix and index <= lastprefix then
local number = numbers and numbers[index]
if number then
local ownnumber = ownnumbers and ownnumbers[index] or ""
if number > 0 or (ownnumber ~= "") then
if bb == 0 then bb = k end
ee = k
else
bb, ee = 0, 0
end
else
break
end
end
end
-- print valid range
for k=bb,ee do
local prefix = prefixlist[k]
local index = sections.getlevel(prefix) or k
if index >= firstprefix and index <= lastprefix then
process(index)
end
end
-- else
-- for k=1,#prefixlist do
-- local prefix = prefixlist[k]
-- local index = sections.getlevel(prefix) or k
-- if index >= firstprefix and index <= lastprefix then
-- process(index)
-- end
-- end
-- end
else
-- also holes check
for prefix=firstprefix,lastprefix do
process(prefix)
end
end
--
if done and connector and kind == 'prefix' then
processors.sprint(ctxcatcodes,connector)
elseif done and stopper then
processors.sprint(ctxcatcodes,stopper)
end
else
-- report("error: no numbers")
end
end
end
function sections.title()
local sc = sections.current()
if sc then
helpers.title(sc.titledata.title,sc.metadata)
end
end
function sections.findnumber(depth,what)
local data = data.status[depth or data.depth]
if data then
local index = data.references.section
local collected = jobsections.collected
local sectiondata = collected[index]
if sectiondata and sectiondata.hidenumber ~= true then -- can be nil
if what == variables.first then
for i=index,1,-1 do
local s = collected[i]
local n = s.numbers
if #n == depth and n[depth] and n[depth] ~= 0 then
sectiondata = s
elseif #n < depth then
break
end
end
elseif what == variables.last then
for i=index,#collected do
local s = collected[i]
local n = s.numbers
if #n == depth and n[depth] and n[depth] ~= 0 then
sectiondata = s
elseif #n < depth then
break
end
end
end
return sectiondata
end
end
end
function sections.fullnumber(depth,what,raw)
local sectiondata = sections.findnumber(depth,what)
if sectiondata then
sections.typesetnumber(sectiondata,'section',sectiondata)
end
end
function sections.getnumber(depth,what) -- redefined here
local sectiondata = sections.findnumber(depth,what)
texwrite((sectiondata and sectiondata.numbers[depth]) or 0)
end
|