• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

sile-typesetter / sile / 10881107806

16 Sep 2024 09:29AM UTC coverage: 61.663% (-7.2%) from 68.912%
10881107806

push

github

web-flow
chore(deps): Bump DeterminateSystems/nix-installer-action from 13 to 14 (#2110)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

10751 of 17435 relevant lines covered (61.66%)

2338.25 hits per line

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

83.67
/pagebuilders/base.lua
1
--- SILE pagebuilder class.
2
-- @interfaces pagebuilders
3

4
local pagebuilder = pl.class()
42✔
5
pagebuilder.type = "pagebuilder"
42✔
6
pagebuilder._name = "base"
42✔
7

8
function pagebuilder:_init ()
42✔
9
   self.awful_bad = 1073741823
43✔
10
   self.inf_bad = 10000
43✔
11
   self.eject_penalty = -self.inf_bad
43✔
12
   self.deplorable = 100000
43✔
13
end
14

15
function pagebuilder.collateVboxes (_, vboxlist)
42✔
16
   local output = SILE.types.node.vbox()
4✔
17
   output:append(vboxlist)
4✔
18
   return output
4✔
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)
42✔
28
   local vboxlist = SU.required(options, "vboxlist", "in findBestBreak")
778✔
29
   local target = SU.required(options, "target", "in findBestBreak", "length")
778✔
30
   local restart = options.restart or false
778✔
31
   local force = options.force or false
778✔
32
   local i = 0
778✔
33
   local totalHeight = SILE.types.length()
778✔
34
   local bestBreak = nil
778✔
35
   local started = false
778✔
36
   if restart and restart.target == target then
778✔
37
      totalHeight = restart.totalHeight
×
38
      i = restart.i
×
39
      started = restart.started
×
40
   end
41
   local leastC = self.inf_bad
778✔
42
   SU.debug("pagebuilder", function ()
1,556✔
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
1,556✔
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
1,913✔
58
      i = i + 1
1,886✔
59
      if not vboxlist[i].is_vglue then
1,886✔
60
         started = true
751✔
61
         i = i - 1
751✔
62
         break
751✔
63
      end
64
   end
65
   local pi
66
   while i < #vboxlist do
11,819✔
67
      i = i + 1
11,118✔
68
      local vbox = vboxlist[i]
11,118✔
69
      SU.debug("pagebuilder", "Dealing with VBox", vbox)
11,118✔
70
      if vbox.is_vbox then
11,118✔
71
         totalHeight:___add(vbox.height)
3,515✔
72
         totalHeight:___add(vbox.depth)
7,030✔
73
      elseif vbox.is_vglue then
7,603✔
74
         totalHeight:___add(vbox.height)
14,106✔
75
      elseif vbox.is_insertion then
550✔
76
         -- TODO: refactor as hook and without side effects!
77
         target = SILE.insertions.processInsertion(vboxlist, i, totalHeight, target)
32✔
78
         vbox = vboxlist[i]
16✔
79
      end
80
      local left = target - totalHeight
11,118✔
81
      SU.debug("pagebuilder", "I have", left, "left")
11,118✔
82
      -- if left < -20 then SU.error("\nCatastrophic page breaking failure!"); end
83
      pi = 0
11,118✔
84
      if vbox.is_penalty then
11,118✔
85
         pi = vbox.penalty
535✔
86
      end
87
      if
88
         vbox.is_penalty and vbox.penalty < self.inf_bad
11,118✔
89
         or (vbox.is_vglue and i > 1 and not vboxlist[i - 1].discardable)
10,645✔
90
      then
91
         local badness
92
         SU.debug("pagebuilder", "totalHeight", totalHeight, "with target", target)
4,794✔
93
         if totalHeight.length.amount < target.length.amount then -- TeX #1039
4,794✔
94
            -- Account for infinite stretch?
95
            badness = SU.rateBadness(self.inf_bad, left.length.amount, totalHeight.stretch.amount)
9,546✔
96
         elseif left.length.amount < totalHeight.shrink.amount then
21✔
97
            badness = self.awful_bad
18✔
98
         else
99
            badness = SU.rateBadness(self.inf_bad, -left.length.amount, totalHeight.shrink.amount)
6✔
100
         end
101

102
         local c
103
         if badness < self.awful_bad then
4,794✔
104
            if pi <= self.eject_penalty then
4,776✔
105
               c = pi
59✔
106
            elseif badness < self.inf_bad then
4,717✔
107
               c = badness + pi -- plus insert
132✔
108
            else
109
               c = self.deplorable
4,585✔
110
            end
111
         else
112
            c = badness
18✔
113
         end
114
         if c < leastC then
4,794✔
115
            leastC = c
181✔
116
            bestBreak = i
181✔
117
         else
118
            restart = { totalHeight = totalHeight, i = i, started = started, target = target }
4,613✔
119
         end
120

121
         SU.debug("pagebuilder", "Badness:", c)
4,794✔
122
         if c == self.awful_bad or pi <= self.eject_penalty then
4,794✔
123
            SU.debug("pagebuilder", "outputting")
77✔
124
            local onepage = {}
77✔
125
            if not bestBreak then
77✔
126
               bestBreak = i
16✔
127
            end
128
            for j = 1, bestBreak do
1,277✔
129
               onepage[j] = table.remove(vboxlist, 1)
2,400✔
130
            end
131
            while #onepage > 1 and onepage[#onepage].discardable do
159✔
132
               onepage[#onepage] = nil
82✔
133
            end
134
            return onepage, pi
77✔
135
         end
136
      end
137
   end
138
   SU.debug("pagebuilder", "No page break here")
701✔
139
   if force and bestBreak then
701✔
140
      local onepage = {}
×
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
701✔
147
end
148

149
return pagebuilder
42✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc