8736205729

Committed 18 Apr 2024 10:16AM UTC coverage: 63.747% (-11.0%) from 74.718%

Build # 8736205729

Build Type

push

github

Committed by

alerque

Commit Message

chore(classes): Correct typos in user facing deprecation message

Run Details

10118 of 15872 relevant lines covered (63.75%)

6751.63 hits per line

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

87.5

/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()	50✔
2	pagebuilder.type = "pagebuilder"	50✔
3	pagebuilder._name = "base"	50✔
4
5	function pagebuilder:_init ()	50✔
6	self.awful_bad = 1073741823	51✔
7	self.inf_bad = 10000	51✔
8	self.eject_penalty = -self.inf_bad	51✔
9	self.deplorable = 100000	51✔
10	end
11
12	function pagebuilder.collateVboxes (_, vboxlist)	50✔
13	local output = SILE.nodefactory.vbox()	4✔
14	output:append(vboxlist)	4✔
15	return output	4✔
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)	50✔
25	local vboxlist = SU.required(options, "vboxlist", "in findBestBreak")	589✔
26	local target = SU.required(options, "target", "in findBestBreak", "length")	589✔
27	local restart = options.restart or false	589✔
28	local force = options.force or false	589✔
29	local i = 0	589✔
30	local totalHeight = SILE.length()	589✔
31	local bestBreak = nil	589✔
32	local started = false	589✔
33	if restart and restart.target == target then	589✔
34	totalHeight = restart.totalHeight	×
35	i = restart.i	×
36	started = restart.started	×
37	end
38	local leastC = self.inf_bad	589✔
39	SU.debug("pagebuilder", function ()	1,178✔
40	return "Page builder for frame " .. SILE.typesetter.frame.id .. " called with " .. #vboxlist .. " nodes, " .. tostring(target)	×
41	end)
42	if SU.debugging("vboxes") then	1,178✔
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	1,531✔
50	i = i + 1	1,519✔
51	if not vboxlist[i].is_vglue then	1,519✔
52	started = true	577✔
53	i = i - 1	577✔
54	break	577✔
55	end
56	end
57	local pi
58	while i < #vboxlist do	9,813✔
59	i = i + 1	9,309✔
60	local vbox = vboxlist[i]	9,309✔
61	SU.debug("pagebuilder", "Dealing with VBox", vbox)	9,309✔
62	if vbox.is_vbox then	9,309✔
63	totalHeight:___add(vbox.height)	2,648✔
64	totalHeight:___add(vbox.depth)	5,296✔
65	elseif vbox.is_vglue then	6,661✔
66	totalHeight:___add(vbox.height)	12,364✔
67	elseif vbox.is_insertion then	479✔
68	-- TODO: refactor as hook and without side effects!
69	target = SILE.insertions.processInsertion(vboxlist, i, totalHeight, target)	24✔
70	vbox = vboxlist[i]	12✔
71	end
72	local left = target - totalHeight	9,309✔
73	SU.debug("pagebuilder", "I have", left, "left")	9,309✔
74	-- if left < -20 then SU.error("\nCatastrophic page breaking failure!"); end
75	pi = 0	9,309✔
76	if vbox.is_penalty then	9,309✔
77	pi = vbox.penalty	468✔
78	end
79	if vbox.is_penalty and vbox.penalty < self.inf_bad	9,309✔
80	or (vbox.is_vglue and i > 1 and not vboxlist[i-1].discardable) then	8,875✔
81	local badness
82	SU.debug("pagebuilder", "totalHeight", totalHeight, "with target", target)	3,619✔
83	if totalHeight.length.amount < target.length.amount then -- TeX #1039	3,619✔
84	-- Account for infinite stretch?
85	badness = SU.rateBadness(self.inf_bad, left.length.amount, totalHeight.stretch.amount)	7,200✔
86	elseif left.length.amount < totalHeight.shrink.amount then badness = self.awful_bad	19✔
87	else badness = SU.rateBadness(self.inf_bad, -left.length.amount, totalHeight.shrink.amount)	2✔
88	end
89
90	local c
91	if badness < self.awful_bad then	3,619✔
92	if pi <= self.eject_penalty then c = pi	3,601✔
93	elseif badness < self.inf_bad then c = badness + pi -- plus insert	3,534✔
94	else c = self.deplorable	3,282✔
95	end
96	else c = badness end	18✔
97	if c < leastC then	3,619✔
98	leastC = c	288✔
99	bestBreak = i	288✔
100	else
101	restart = { totalHeight = totalHeight, i = i, started = started, target = target}	3,331✔
102	end
103
104	SU.debug("pagebuilder", "Badness:", c)	3,619✔
105	if c == self.awful_bad or pi <= self.eject_penalty then	3,619✔
106	SU.debug("pagebuilder", "outputting")	85✔
107	local onepage = {}	85✔
108	if not bestBreak then bestBreak = i end	85✔
109	for j=1,bestBreak do	1,425✔
110	onepage[j] = table.remove(vboxlist,1)	2,680✔
111	end
112	while(#onepage > 1 and onepage[#onepage].discardable) do onepage[#onepage] = nil end	177✔
113	return onepage, pi	85✔
114	end
115	end
116	end
117	SU.debug("pagebuilder", "No page break here")	504✔
118	if force and bestBreak then	504✔
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	504✔
126	end
127
128	return pagebuilder	50✔

sile-typesetter / sile / 8736205729

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