6713098919

Committed 31 Oct 2023 10:21PM UTC coverage: 52.831% (-21.8%) from 74.636%

Build # 6713098919

Build Type

push

github

Committed by

web-flow

Commit Message

Merge d0a2a1ee9 into b185d4972

Run Details

45 of 45 new or added lines in 3 files covered. (100.0%)

8173 of 15470 relevant lines covered (52.83%)

6562.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.41

/pagebuilders/base.lua

local pagebuilder = pl.class()
pagebuilder.type = "pagebuilder"
pagebuilder._name = "base"

function pagebuilder:_init ()
  self.awful_bad = 1073741823
  self.inf_bad = 10000
  self.eject_penalty = -self.inf_bad
  self.deplorable = 100000
end

function pagebuilder.collateVboxes (_, vboxlist)
  local output = SILE.nodefactory.vbox()
  output:append(vboxlist)
  return output
end

-- Note: Almost 1/3 of the time in a typical SILE in taken iterating through
-- this function. As a result there are some micro-optimizations here that
-- make it a-typical of preferred coding styles. In particular note that
-- we absolutize heavily iterated lengths as early as possible and make
-- make direct calls to their integer amounts, assumed to be in points by
-- the point they are called **without actually checking**!
function pagebuilder:findBestBreak (options)
  local vboxlist = SU.required(options, "vboxlist", "in findBestBreak")
  local target   = SU.required(options, "target", "in findBestBreak", "length")
  local restart  = options.restart or false
  local force    = options.force or false
  local i = 0
  local totalHeight = SILE.length()
  local bestBreak = nil
  local started = false
  if restart and restart.target == target then
    totalHeight = restart.totalHeight
    i = restart.i
    started = restart.started
  end
  local leastC = self.inf_bad
  SU.debug("pagebuilder", function ()
    return "Page builder for frame " .. SILE.typesetter.frame.id .. " called with " .. #vboxlist .. " nodes, " .. tostring(target)
  end)
  if SU.debugging("vboxes") then
    for j, box in ipairs(vboxlist) do
      SU.debug("vboxes", function ()
        return (j == i and " >" or "  ") .. j .. ": " .. box
      end)
    end
  end
  while not started and i < #vboxlist do
    i = i + 1
    if not vboxlist[i].is_vglue then
      started = true
      i = i - 1
      break
    end
  end
  local pi
  while i < #vboxlist do
    i = i + 1
    local vbox = vboxlist[i]
    SU.debug("pagebuilder", "Dealing with VBox", vbox)
    if vbox.is_vbox then
      totalHeight:___add(vbox.height)
      totalHeight:___add(vbox.depth)
    elseif vbox.is_vglue then
      totalHeight:___add(vbox.height)
    elseif vbox.is_insertion then
      -- TODO: refactor as hook and without side effects!
      target = SILE.insertions.processInsertion(vboxlist, i, totalHeight, target)
      vbox = vboxlist[i]
    end
    local left = target - totalHeight
    SU.debug("pagebuilder", "I have", left, "left")
    -- if left < -20 then SU.error("\nCatastrophic page breaking failure!"); end
    pi = 0
    if vbox.is_penalty then
      pi = vbox.penalty
    end
    if vbox.is_penalty and vbox.penalty < self.inf_bad
      or (vbox.is_vglue and i > 1 and not vboxlist[i-1].discardable) then
      local badness
      SU.debug("pagebuilder", "totalHeight", totalHeight, "with target", target)
      if totalHeight.length.amount < target.length.amount then -- TeX #1039
        -- Account for infinite stretch?
        badness = SU.rateBadness(self.inf_bad, left.length.amount, totalHeight.stretch.amount)
      elseif left.length.amount < totalHeight.shrink.amount then badness = self.awful_bad
      else badness = SU.rateBadness(self.inf_bad, -left.length.amount, totalHeight.shrink.amount)
      end

      local c
      if badness < self.awful_bad then
        if pi <= self.eject_penalty then c = pi
        elseif badness < self.inf_bad then c = badness + pi -- plus insert
        else c = self.deplorable
        end
      else c = badness end
      if c < leastC then
        leastC = c
        bestBreak = i
      else
        restart = { totalHeight = totalHeight, i = i, started = started, target = target}
      end

      SU.debug("pagebuilder", "Badness:", c)
      if c == self.awful_bad or pi <= self.eject_penalty then
        SU.debug("pagebuilder", "outputting")
        local onepage = {}
        if not bestBreak then bestBreak = i end
        for j=1,bestBreak do
          onepage[j] = table.remove(vboxlist,1)
        end
        while(#onepage > 1 and onepage[#onepage].discardable) do onepage[#onepage] = nil end
        return onepage, pi
      end
    end
  end
  SU.debug("pagebuilder", "No page break here")
  if force and bestBreak then
    local onepage = {}
    for j=1,bestBreak do
      onepage[j] = table.remove(vboxlist,1)
    end
    return onepage, pi
  end
  return false, restart
end

return pagebuilder

1	local pagebuilder = pl.class()	7✔
2	pagebuilder.type = "pagebuilder"	7✔
3	pagebuilder._name = "base"	7✔
4
5	function pagebuilder:_init ()	7✔
6	self.awful_bad = 1073741823	7✔
7	self.inf_bad = 10000	7✔
8	self.eject_penalty = -self.inf_bad	7✔
9	self.deplorable = 100000	7✔
10	end
11
12	function pagebuilder.collateVboxes (_, vboxlist)	7✔
13	local output = SILE.nodefactory.vbox()	×
14	output:append(vboxlist)	×
15	return output	×
16	end
17
18	-- Note: Almost 1/3 of the time in a typical SILE in taken iterating through
19	-- this function. As a result there are some micro-optimizations here that
20	-- make it a-typical of preferred coding styles. In particular note that
21	-- we absolutize heavily iterated lengths as early as possible and make
22	-- make direct calls to their integer amounts, assumed to be in points by
23	-- the point they are called without actually checking!
24	function pagebuilder:findBestBreak (options)	7✔
25	local vboxlist = SU.required(options, "vboxlist", "in findBestBreak")	85✔
26	local target = SU.required(options, "target", "in findBestBreak", "length")	85✔
27	local restart = options.restart or false	85✔
28	local force = options.force or false	85✔
29	local i = 0	85✔
30	local totalHeight = SILE.length()	85✔
31	local bestBreak = nil	85✔
32	local started = false	85✔
33	if restart and restart.target == target then	85✔
34	totalHeight = restart.totalHeight	×
35	i = restart.i	×
36	started = restart.started	×
37	end
38	local leastC = self.inf_bad	85✔
39	SU.debug("pagebuilder", function ()	170✔
40	return "Page builder for frame " .. SILE.typesetter.frame.id .. " called with " .. #vboxlist .. " nodes, " .. tostring(target)	×
41	end)
42	if SU.debugging("vboxes") then	170✔
43	for j, box in ipairs(vboxlist) do	×
44	SU.debug("vboxes", function ()	×
45	return (j == i and " >" or " ") .. j .. ": " .. box	×
46	end)
47	end
48	end
49	while not started and i < #vboxlist do	228✔
50	i = i + 1	228✔
51	if not vboxlist[i].is_vglue then	228✔
52	started = true	85✔
53	i = i - 1	85✔
54	break	85✔
55	end
56	end
57	local pi
58	while i < #vboxlist do	1,545✔
59	i = i + 1	1,467✔
60	local vbox = vboxlist[i]	1,467✔
61	SU.debug("pagebuilder", "Dealing with VBox", vbox)	1,467✔
62	if vbox.is_vbox then	1,467✔
63	totalHeight:___add(vbox.height)	459✔
64	totalHeight:___add(vbox.depth)	918✔
65	elseif vbox.is_vglue then	1,008✔
66	totalHeight:___add(vbox.height)	1,826✔
67	elseif vbox.is_insertion then	95✔
68	-- TODO: refactor as hook and without side effects!
69	target = SILE.insertions.processInsertion(vboxlist, i, totalHeight, target)	×
70	vbox = vboxlist[i]	×
71	end
72	local left = target - totalHeight	1,467✔
73	SU.debug("pagebuilder", "I have", left, "left")	1,467✔
74	-- if left < -20 then SU.error("\nCatastrophic page breaking failure!"); end
75	pi = 0	1,467✔
76	if vbox.is_penalty then	1,467✔
77	pi = vbox.penalty	95✔
78	end
79	if vbox.is_penalty and vbox.penalty < self.inf_bad	1,467✔
80	or (vbox.is_vglue and i > 1 and not vboxlist[i-1].discardable) then	1,372✔
81	local badness
82	SU.debug("pagebuilder", "totalHeight", totalHeight, "with target", target)	549✔
83	if totalHeight.length.amount < target.length.amount then -- TeX #1039	549✔
84	-- Account for infinite stretch?
85	badness = SU.rateBadness(self.inf_bad, left.length.amount, totalHeight.stretch.amount)	1,098✔
86	elseif left.length.amount < totalHeight.shrink.amount then badness = self.awful_bad	×
87	else badness = SU.rateBadness(self.inf_bad, -left.length.amount, totalHeight.shrink.amount)	×
88	end
89
90	local c
91	if badness < self.awful_bad then	549✔
92	if pi <= self.eject_penalty then c = pi	549✔
93	elseif badness < self.inf_bad then c = badness + pi -- plus insert	542✔
94	else c = self.deplorable	517✔
95	end
96	else c = badness end	×
97	if c < leastC then	549✔
98	leastC = c	29✔
99	bestBreak = i	29✔
100	else
101	restart = { totalHeight = totalHeight, i = i, started = started, target = target}	520✔
102	end
103
104	SU.debug("pagebuilder", "Badness:", c)	549✔
105	if c == self.awful_bad or pi <= self.eject_penalty then	549✔
106	SU.debug("pagebuilder", "outputting")	7✔
107	local onepage = {}	7✔
108	if not bestBreak then bestBreak = i end	7✔
109	for j=1,bestBreak do	186✔
110	onepage[j] = table.remove(vboxlist,1)	358✔
111	end
112	while(#onepage > 1 and onepage[#onepage].discardable) do onepage[#onepage] = nil end	14✔
113	return onepage, pi	7✔
114	end
115	end
116	end
117	SU.debug("pagebuilder", "No page break here")	78✔
118	if force and bestBreak then	78✔
119	local onepage = {}	×
120	for j=1,bestBreak do	×
121	onepage[j] = table.remove(vboxlist,1)	×
122	end
123	return onepage, pi	×
124	end
125	return false, restart	78✔
126	end
127
128	return pagebuilder	7✔

sile-typesetter / sile / 6713098919

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous