9710003952

Committed 28 Jun 2024 08:24AM UTC coverage: 61.779% (-8.6%) from 70.4%

Build # 9710003952

Build Type

push

github

Committed by

alerque

Commit Message

chore(tooling): Update Git ignore list and sort for easier review

Run Details

10631 of 17208 relevant lines covered (61.78%)

2071.36 hits per line

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

84.69

/pagebuilders/base.lua

--- SILE pagebuilder class.
-- @interfaces pagebuilders

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

sile-typesetter / sile / 9710003952

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