summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/tex/context/base/node-shp.lua
blob: 42cc83b8f34474d790605b8e90d68dd0d7ef7ddd (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
if not modules then modules = { } end modules ['node-shp'] = {
    version   = 1.001,
    comment   = "companion to node-ini.mkiv",
    author    = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
    copyright = "PRAGMA ADE / ConTeXt Development Team",
    license   = "see context related readme files"
}

local nodes, node = nodes, node

local next, type = next, type
local format = string.format
local concat, sortedpairs = table.concat, table.sortedpairs
local setmetatableindex = table.setmetatableindex

local nodecodes      = nodes.nodecodes
local whatsitcodes   = nodes.whatsitcodes
local disccodes      = nodes.disccodes

local tasks          = nodes.tasks
local handlers       = nodes.handlers

local hlist_code     = nodecodes.hlist
local vlist_code     = nodecodes.vlist
local disc_code      = nodecodes.disc
local mark_code      = nodecodes.mark
local kern_code      = nodecodes.kern
local glue_code      = nodecodes.glue
local whatsit_code   = nodecodes.whatsit

local fulldisc_code  = disccodes.discretionary

local texgetbox      = tex.getbox

local implement      = interfaces.implement

local nuts           = nodes.nuts
local tonut          = nuts.tonut
local tonode         = nuts.tonode
local free_node      = nuts.free
local remove_node    = nuts.remove
local traverse_nodes = nuts.traverse
local find_tail      = nuts.tail

local getfield       = nuts.getfield
local setfield       = nuts.setfield
local getid          = nuts.getid
local getnext        = nuts.getnext
local getprev        = nuts.getprev
local getlist        = nuts.getlist
local getsubtype     = nuts.getsubtype

local removables     = {
    [whatsitcodes.open]       = true,
    [whatsitcodes.close]      = true,
    [whatsitcodes.write]      = true,
    [whatsitcodes.pdfdest]    = true,
    [whatsitcodes.pdfsavepos] = true,
    [whatsitcodes.latelua]    = true,
}

-- About 10% of the nodes make no sense for the backend. By (at least)
-- removing the replace disc nodes, we can omit extensive checking in
-- the finalizer code (e.g. colors in disc nodes). Removing more nodes
-- (like marks) is not saving much and removing empty boxes is even
-- dangerous because we can rely on dimensions (e.g. in references).

local wipedisc = false -- we can use them in the export ... can be option

local function cleanup_redundant(head) -- better name is: flatten_page
    local start = head
    while start do
        local id = getid(start)
        if id == disc_code then
            if getsubtype(start) == fulldisc_code then
                local replace = getfield(start,"replace")
                if replace then
                    local prev = getprev(start)
                    local next = getnext(start)
                    local tail = find_tail(replace)
                    setfield(start,"replace",nil)
                    if start == head then
                        remove_node(head,start,true)
                        head = replace
                    else
                        remove_node(head,start,true)
                    end
                    if next then
                        setfield(tail,"next",next)
                        setfield(next,"prev",tail)
                    end
                    if prev then
                        setfield(prev,"next",replace)
                        setfield(replace,"prev",prev)
                    else
                        setfield(replace,"prev",nil) -- to be sure
                    end
                    start = next
                elseif wipedisc then
                    -- pre and post can have values
                    head, start = remove_node(head,start,true)
                else
                    start = getnext(start)
                end
            else
                start = getnext(start)
            end
        elseif id == hlist_code or id == vlist_code then
            local sl = getlist(start)
            if sl then
                local rl = cleanup_redundant(sl)
                if rl ~= sl then
                    setfield(start,"list",rl)
                end
            end
            start = getnext(start)
        else
            start = getnext(start)
        end
    end
    return head
end

local function cleanup_flushed(head) -- rough
    local start = head
    while start do
        local id = getid(start)
        if id == whatsit_code then
            if removables[getsubtype(start)] then
                head, start = remove_node(head,start,true)
            else
                start = getnext(start)
            end
        elseif id == hlist_code or id == vlist_code then
            local sl = getlist(start)
            if sl then
                local rl = cleanup_flushed(sl)
                if rl ~= sl then
                    setfield(start,"list",rl)
                end
            end
            start = getnext(start)
        else
            start = getnext(start)
        end
    end
    return head
end

function handlers.cleanuppage(head)
    return tonode(cleanup_redundant(tonut(head))), true
end

function handlers.cleanupbox(head)
    return tonode(cleanup_flushed(tonut(head))), true
end

local actions = tasks.actions("shipouts")  -- no extra arguments

function handlers.finalize(head) -- problem, attr loaded before node, todo ...
    return actions(head)
end

-- handlers.finalize = actions

-- interface

implement { name = "cleanupbox",  actions = { texgetbox, cleanup_flushed }, arguments = "integer" }
implement { name = "finalizebox", actions = { texgetbox, actions },         arguments = "integer" }

-- just in case we want to optimize lookups:

local frequencies = { }

nodes.tracers.frequencies = frequencies

local data = { }
local done = false

setmetatableindex(data,function(t,k)
    local v = { }
    setmetatableindex(v,function(t,k)
        local v = { }
        t[k] = v
        setmetatableindex(v,function(t,k)
            t[k] = 0
            return 0
        end)
        return v
    end)
    t[k] = v
    return v
end)

local function count(head,data,subcategory)
    -- no components, pre, post, replace .. can maybe an option .. but
    -- we use this for optimization so it makes sense to look the the
    -- main node only
    for n in traverse_nodes(tonut(head)) do
        local id = getid(n)
        local dn = data[nodecodes[id]] -- we could use id and then later convert to nodecodes
        dn[subcategory] = dn[subcategory] + 1
        if id == hlist_code or id == vlist_code then
            count(getfield(n,"list"),data,subcategory)
        end
    end
end

local function register(category,subcategory)
    return function(head)
        done = true
        count(head,data[category],subcategory)
        return head, false
    end
end

frequencies.register = register
frequencies.filename = nil

trackers.register("nodes.frequencies",function(v)
    if type(v) == "string" then
        frequencies.filename = v
    end
    handlers.frequencies_shipouts_before   = register("shipouts",   "begin")
    handlers.frequencies_shipouts_after    = register("shipouts",   "end")
    handlers.frequencies_processors_before = register("processors", "begin")
    handlers.frequencies_processors_after  = register("processors", "end")
    tasks.prependaction("shipouts",   "before", "nodes.handlers.frequencies_shipouts_before")
    tasks.appendaction ("shipouts",   "after",  "nodes.handlers.frequencies_shipouts_after")
    tasks.prependaction("processors", "before", "nodes.handlers.frequencies_processors_before")
    tasks.appendaction ("processors", "after",  "nodes.handlers.frequencies_processors_after")
end)

statistics.register("node frequencies", function()
    if done then
        local filename = frequencies.filename or (tex.jobname .. "-frequencies.lua")
        io.savedata(filename,table.serialize(data,true))
        return format("saved in %q",filename)
    end
end)