summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/luatex/lutabulartools/lutabulartools.lua
blob: 92ce236715633a35f67df62ac19b90f592372607 (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
--% Kale Ewasiuk (kalekje@gmail.com)
--% 2023-07-22
--% Copyright (C) 2021-2023 Kale Ewasiuk
--%
--% Permission is hereby granted, free of charge, to any person obtaining a copy
--% of this software and associated documentation files (the "Software"), to deal
--% in the Software without restriction, including without limitation the rights
--% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
--% copies of the Software, and to permit persons to whom the Software is
--% furnished to do so, subject to the following conditions:
--%
--% The above copyright notice and this permission notice shall be included in
--% all copies or substantial portions of the Software.
--%
--% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
--% ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
--% TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
--% PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT
--% SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
--% ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
--% ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
--% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
--% OR OTHER DEALINGS IN THE SOFTWARE.




local lutabt = {}

local pl = penlight
local T = pl.tablex

lutabt.luakeys = require'luakeys'()  -- note: YAMLvars.sty will have checked existence of this already


lutabt.tablelevel = 0

lutabt.debug = false

lutabt.auto_topbot = false
lutabt.auto_topbot_old = false

lutabt.auto_crules = {} -- {{span,trim}, } appearance is like this, 'range|trim', -- auto_rules created by MC
lutabt.auto_midrules = {}

lutabt.col_spec1 = {} -- column spec if one column wide (since makcell nests a tabular, preserve col_spec below)
lutabt.col_spec = {} -- tab column spec if above 1
lutabt.col = '' -- current column spec, single char, only applies to tabular with more than 1 column
lutabt.col_num = 1 -- current column number
lutabt.row_num = 0 -- current row number

lutabt.actlvl = 1 -- 'active' level on which to apply midrules, normally 1

lutabt.col_ver_repl = {
m = 'm',
M = 'm',
b = 'b',
}

lutabt.col_hor_repl = { -- horizontal cell alignment that multicolumn should use if () or [hori] not passed to func
    l = 'l',
    c = 'c',
    r = 'r',
    p = 'l',
    P = 'c',
    X = 'l',
    Y = 'c',
    Z = 'l',
    N = 'c',
    L = 'l',
    R = 'r',
    C = 'c',
}

-- allow user to place their own replacements in for a table, say if they define a column that expands to multiple
lutabt.col_replaces = {
--x = 'lll'
}

lutabt.SI_cols = {'S', 'N', 'Q', 'L', 'R'}



-----
-----       utility funcs
-----


function lutabt.debugtalk(s, ss)
    ss = ss or ''
    if lutabt.debug then
        pl.tex.help_wrt(s, ss..' (lutabulartools)')
    end
end

function __lutabt__debugprtall()
    pl.help_wrt(lutabt, '(lutabulartools state)')
end


function lutabt.set_tabular(sett)
    sett = lutabt.luakeys.parse(sett)
    local trim = ''
    for k, v in pairs(sett) do
        if k == 'tbrule' then
            lutabt.auto_topbot = v
        elseif k == 'nopad' then
            if pl.hasval(v) then trim = '@{}' end -- set to trim
            tex.print('\\newcolumntype{\\lttltrim}{'..trim..'}')
            tex.print('\\newcolumntype{\\lttrtrim}{'..trim..'}')
        elseif k =='rowsep' then
            tex.print('\\gdef\\arraystretch{'..v..'}')
        elseif k =='colsep' then
            tex.print('\\global\\setlength{\\tabcolsep}{'..(v*6)..'pt'..'}')
        end
    end
end


-----
-----       tabular utility funcs
-----

function lutabt.reset_rows()
    if lutabt.isactlevel() then
        lutabt.row_num = 0
    end
end

function lutabt.set_col_num()
    -- register current column info (column number and specification)
    local nest
    for i = tex.nest.ptr, 1, -1 do
      local tail = tex.nest[i].tail
      if tail.id == node.id'glue' and tail.subtype == table.swapped(node.subtypes'glue').tabskip then
        nest = tex.nest[i]
        break
      end
    end
    if nest then
      local col = 1
      for _, sub in node.traverse_id(node.id'unset', nest.head) do
        col = col + sub + 1
      end
      lutabt.col_num = col
    else
      lutabt.col_num = 1
    end
    lutabt.col = lutabt.col_spec[lutabt.col_num]
    lutabt.debugtalk('col_num='..lutabt.col_num..'; col_spec='..lutabt.col,'set_col_num')
end


function lutabt.set_col_spec(zz)
    -- contents of string 'zz'
    -- register the table column specification
    zz = zz:gsub ( "%*%s-{(%d-)}%s-(%b{})" ,     -- expand expressions such as "*{5}{l}" to "lllll"
            function(y, z ) z = z:sub (2 , -2)  return string.rep (z, y) end ) --
    zz = zz:gsub ( "%b{}" , "" ) -- omit all stuff in curly braces and square
    zz = zz:gsub ( "%b[]" , "" )
    zz = zz:gsub ( "[@!|><%s%*\']" , "" )  -- some more characters to ignore
    zz = zz:gsub('%a', lutabt.col_replaces) -- sub extra column
    _col_spec = zz:totable() -- requires pl extras
    --help_wrt(_col_spec, 'helpme')
    if #_col_spec > 1 then
        lutabt.col_spec = _col_spec
    else
        lutabt.col_spec1 = _col_spec
    end
    lutabt.debugtalk(lutabt.col_spec,'set_col_spec')
end


--todo
-- if p{} column, and multirow is 1, use {=} instead of {*}
-- but note, makecell will not work. So you may want to skip it.multicolumn
-- this case should be considered in this code.
-- for example: \multirow{2}{=}


-----
-----       magic cell and helpers
-----

function lutabt.MagicCell(s0,spec,mcspec,pre,content,trim)
    -- todo delete trim!!!
    --
    lutabt.set_col_num() -- register current column number and column spec

    local STR = ''
    pl.tex.reset_bkt_cnt()

    local spec, iscmidrule, trim = lutabt.check_MC_cmidrule(spec) -- check for cmidrule and clean spec

    local v, h, r, c, mrowsym, skipmakecell = lutabt.parse_MagicCell_spec(spec) -- get v/h align, number rows/columns

    local mcspec = mcspec or ''

    h, mcspec, c = lutabt.get_HColSpec(h, mcspec, c)  -- infer horizontal alignment, num columns

    lutabt.debugtalk(pl.List{v, h, r, c, mcspec}:join'; ','v, h, r, c, mcspec')

    --help_wrt(_CurTabColAbv,'current column')
    if s0 == pl.tex._xTrue or (pl.List(lutabt.SI_cols):contains(lutabt.col) -- special columns for SI
            and c == '') then -- multicolumn cannot have {} around it
        STR = STR .. '{'                                       -- multirow and makcell must have {} around it S column is used
        pl.tex.add_bkt_cnt()
    end

    if c ~= '' then
        STR = STR .. "\\multicolumn{"..c.."}{"..mcspec.."}{"
        pl.tex.add_bkt_cnt()
    end

    if r ~= '' then
        STR = STR .."\\multirow["..v.."]{"..r.."}{"..mrowsym.."}{" -- optional arg here
        pl.tex.add_bkt_cnt()
    end

    if not skipmakecell then
        if pre ~= '' then
            STR = STR.."\\renewcommand{\\cellset}{"..pre.."}"
        end

        STR = STR.."\\makecell[{"..v.."}{"..h.."}]{"
        pl.tex.add_bkt_cnt()
    else
        content = content:gsub('\\\\', '\\newline')
    end

    STR = STR..content..pl.tex.close_bkt_cnt()
    --Troubleshooting
    --help_wrt(STR..' <<< magic cell string')
    lutabt.debugtalk(STR,'MagicCell')
    tex.sprint(STR)--tex print the STR

    if iscmidrule then
        local en
        if c == '' then en = lutabt.col_num else en = lutabt.col_num + c -1 end
        lutabt.add_auto_crule(lutabt.col_num, en, trim)
    end
end


function lutabt.check_MC_cmidrule(spec)
    local iscmidrule = false
    local trim = ''
    local st, en = spec:find('_')
    if st ~= nil then
        trim = spec:sub(st+1, #spec)
        spec = spec:sub(1,st-1)
        iscmidrule = true
    end
    return spec, iscmidrule, trim
end

function lutabt.parse_MagicCell_spec(spec)
    local mrowsym = '*' -- *  = natural width, = will match p{2cm} for example
    local skipmakecell = false
    if string.find(spec, '=')  then
        spec = spec:gsub('=', '')
        mrowsym = '='
        skipmakecell = true
    end

    spec = spec:lower():gsub('%s','')  -- take lower case and remove space
    local vh, rc = spec:gextract('%a')  -- extract characters
    local v = vh:gfirst({'t', 'm', 'b'}) or lutabt.col_ver_repl[lutabt.col] or 't'
    local h = vh:gfirst({'l', 'c', 'r'}) or ''
    v = v:gsub('m', 'c')

    local rc_ = (rc):split(',')
    local c = rc_[1] or ''  --num columns, width
    local r = rc_[2] or '' --num rows, height
    if c == '0' or c == '1' then c = '' end
    if r == '0' or r == '1' then r = '' end

    return v, h, r, c, mrowsym, skipmakecell
end


function lutabt.get_HColSpec(h, mcspec, c) -- take horizontal alignment
    -- c is num columns, h is horizontal alginment,
    --Assumes _TabColNum was calculated previosly
     if c == '+' then  -- fill row to end
        c =  tostring(#lutabt.col_spec -  lutabt.col_num + 1)
    end
    if h == '' then -- if horizontal not provided, use declared column
        h = lutabt.col_hor_repl[lutabt.col] or 'l'
    end
    if c ~= '' then -- only make new mcspec if column nums > 0
        if mcspec == '' then -- and if no mcspec was passed
            mcspec = h
            if lutabt.col_num == 1 then -- if first column, auto detect padding
                mcspec = '@{}'..mcspec
            end
            if (lutabt.col_num + tonumber(c) - 1) == #lutabt.col_spec then  -- if end on last column
                mcspec = mcspec..'@{}'
            end
        else -- if mcspec if given, extract the alignment
            lutabt.set_col_spec(mcspec)
            h = lutabt.col_spec1[1] -- get 1 character column spec from mcspec and override h
        end
    end
    return h, mcspec, c
end


-----
-----       autorules (with \MC() or auto top bot or midrule X, performed after \\
-----

function lutabt.add_auto_midrules(rows)
    lutabt.auto_midrules = rows:split(',')
end

function lutabt.add_auto_crule(st,en,trim)
    if trim ~= 'x' then
        lutabt.auto_crules[#lutabt.auto_crules + 1] = {math.floor(st)..'-'..math.floor(en), trim} -- append here
        -- {{span 1-2, trim}, ..}
    end
end

function lutabt.isactlevel()
    lutabt.tablelevel = tonumber(lutabt.tablelevel)
    lutabt.actlvl = tonumber(lutabt.actlvl)
    return lutabt.actlvl == lutabt.tablelevel
end


function lutabt.process_auto_rules()
    if lutabt.isactlevel() then
        lutabt.row_num = lutabt.row_num + 1
        if lutabt.auto_crules ~= {} then
            for _, v in ipairs(lutabt.auto_crules) do
                lutabt.make1cmidrule('', v[2], v[1], 'cmidrule')
            end
            for i, v in ipairs(lutabt.auto_midrules) do
                if tonumber(v) == lutabt.row_num then
                    _ = table.remove(lutabt.auto_midrules,i)
                    tex.print('\\midrule ')
                end
            end
        end
        if lutabt.mrX.settings.on then
            lutabt.mrX.midruleX()
        end
    end
    lutabt.auto_crules = {}
end




function lutabt.process_auto_topbot_rule(rule)
    if lutabt.isactlevel() then
        if lutabt.auto_topbot then
            tex.print('\\'..rule..'rule ')
        end
    end
end






-----
-----       extra midrule
-----



function lutabt.get_midrule_col(s)
    if string.find(s, '+')  then
        s = s:gsub('+', '')
        if (s == '') or (s == '0') then
            s = 1
        end
        s = tostring(#lutabt.col_spec - tonumber(s) + 1) -- use number of tabular columns above 0,
    end
    return s
end


function lutabt.make1cmidrule(s, r, c, cmd) -- s=square r=round c=curly
    cmd = '\\'..cmd
    if s ~= '' then
        cmd = cmd..'['..s..']'
    end
    if r ~= '' then
        cmd = cmd..'('..r..')'
    end
    t = string.split(c, '-')
    if t[2] == '' then
        t[2] = '+'
    end
    if t[2] == nil then
        t[2] = t[1]
    end
    c = lutabt.get_midrule_col(t[1])..'-'..lutabt.get_midrule_col(t[2])
    cmd = cmd..'{'..c..'}'
    lutabt.debugtalk(cmd,'make1cmidrule')
    tex.print(cmd)
end

function lutabt.makecmidrules(s, r, c, cmd)
    for k, c1 in pairs(string.split(c, ',')) do
        r1, c2 = c1:gextract('%a')
        if r1 == '' then -- if nothing passed in with the column
            r1 = r -- set to the global value passed in round brackets
        end
        lutabt.make1cmidrule(s, r1:strip(), c2:strip(), cmd)
    end
end


-----
-----         midruleX
-----

lutabt.mrX = {}
lutabt.mrX.resets = {long=false, cntr=0, head=nil, longx=false, on=true} -- settings that reset when \setmidruleX used
lutabt.mrX.resets['head*'] = nil
lutabt.mrX.settings = T.update(T.copy(lutabt.mrX.resets), {pgcntr=0, step=5, rule='midrule'}) -- current settings, not overwritten with each call
lutabt.mrX.settings.on = false

function lutabt.mrX.reset_midruleX(n)
    lutabt.mrX.settings.cntr = tonumber(n)
end

function lutabt.mrX.off()
    if lutabt.isactlevel() then
        lutabt.mrX.settings.on = false
    end
end

function lutabt.mrX.set_midruleX(new_sett, def)
    lutabt.mrX.settings = T.update(lutabt.mrX.settings, T.union(lutabt.mrX.resets, lutabt.luakeys.parse(new_sett)))
    lutabt.debugtalk(lutabt.mrX.settings, 'new midruleX settings')
    if lutabt.mrX.settings.head ~= nil then
        lutabt.mrX.settings.cntr = -1*tonumber(lutabt.mrX.settings.head)
    elseif lutabt.mrX.settings['head*'] ~= nil then
        lutabt.mrX.settings.cntr = -1*tonumber(lutabt.mrX.settings['head*'])
       lutabt.auto_midrules[#lutabt.auto_midrules + 1] =  lutabt.mrX.settings['head*']
        lutabt.mrX.settings['head*'] = nil -- for some reason need to do this to clear head*
    end
    if lutabt.mrX.settings.longx then -- longtable X messes with the tablelevel settings, hack to fix, use longx keyword
        lutabt.actlvl = 3
        lutabt.mrX.settings.long = true
    else
        lutabt.actlvl = 1
    end
end


function lutabt.mrX.midruleX(n)
    n = n or '' -- todo placeholder for noalign ?
    lutabt.debugtalk(lutabt.mrX.settings, 'midruleX here')
    local s = lutabt.mrX.settings
    local rule = s.rule
    if pl.hasval(s.long) and lutabt.mrX.add_label_and_check_page_change() then lutabt.mrX.settings.cntr = 0 end -- reset to number on page change --  longhead not used anymore
    lutabt.mrX.settings.cntr = lutabt.mrX.settings.cntr + 1
    if lutabt.mrX.settings.cntr == s.step then
        if not rule:startswith('\\') then  rule = '\\'..rule end -- todo consider allowing \gmidrule syntax, possible issue with expansion
        lutabt.debugtalk(rule, 'apply midruleX')
        tex.sprint(rule)
        lutabt.mrX.settings.cntr = 0
    end
end

function lutabt.mrX.add_label_and_check_page_change()
    lutabt.mrX.settings.pgcntr = lutabt.mrX.settings.pgcntr + 1
    tex.print('\\noalign{\\label{ltt@tabular@row@'..lutabt.mrX.settings.pgcntr..'}}')
    local rcurr = pl.tex.get_ref_info('ltt@tabular@row@'..lutabt.mrX.settings.pgcntr)
    local rprev = pl.tex.get_ref_info('ltt@tabular@row@'..lutabt.mrX.settings.pgcntr-1)
    --local rcurrc, _, _ = pl.tex.get_ref_info_all_cref('ltt@tabular@row@'..lutabt.mrX.settings.pgcntr)
    lutabt.debugtalk('curr: '..rcurr[2]..'   prev: '..rprev[2]..'   row: '..lutabt.mrX.settings.pgcntr, 'check midruleX page change')
    lutabt.debugtalk(rcurr, 'miduleX current reference info for row: '..lutabt.mrX.settings.pgcntr)
    --lutabt.debugtalk(rcurrc, 'miduleX current cleveref cref info')
    if  rcurr[2] ~= rprev[2] then  -- pg no is second element
        return true
    end
    return false
end


return lutabt -- lutabulartools



--http://ctan.mirror.rafal.ca/macros/latex/contrib/multirow/multirow.pdf
--http://ctan.mirror.colo-serv.net/macros/latex/contrib/makecell/makecell.pdf
-- https://tex.stackexchange.com/questions/331716/newline-in-multirow-environment