11534409649

Committed 26 Oct 2024 07:27PM UTC coverage: 33.196% (-28.7%) from 61.897%

Build # 11534409649

Build Type

push

github

Committed by

alerque

Commit Message

chore(tooling): Update editor-config key for stylua as accepted upstream

Our setting addition is still not in a tagged release, but the PR was
accepted into the default branch of stylua. This means you no longer
need to run my fork of Stylua to get this project's style, you just nead
any build from the main development branch. However the config key was
renamed as part of the acceptance, so this is the relevant adjustment.

Run Details

5810 of 17502 relevant lines covered (33.2%)

1300.57 hits per line

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

0.0

/packages/balanced-frames/init.lua

local base = require("packages.base")

local package = pl.class(base)
package._name = "balanced-frames"

local BALANCE_PENALTY = -17777

local unbalanced_buildPage

local function buildPage (typesetter, independent)
   local frame = typesetter.frame
   if not (frame.balanced == true) then
      return unbalanced_buildPage(typesetter, independent)
   end

   local colCount = 0
   local target = SILE.types.length()
   while frame and frame.balanced == true do
      target = target + frame:height()
      colCount = colCount + 1
      if frame.next then
         frame = SILE.getFrame(frame.next)
      else
         break
      end
   end

   -- Really, try and avoid doing anything, where possible.
   if colCount == 1 then
      return unbalanced_buildPage(typesetter, independent)
   end
   -- If the total amount of stuff on the output list is greater then the total
   -- of frame space on the page, and there are no magic requests to balance the
   -- columns, then we have a full page. Just send it out normally.
   local q = typesetter.state.outputQueue
   local totalHeight = SILE.types.length()
   local mustBalance = 0
   for i = 1, #q do
      totalHeight = totalHeight + q[i].height + q[i].depth
      if q[i].is_penalty and q[i].penalty <= BALANCE_PENALTY then
         mustBalance = i
         break
      end
   end
   if totalHeight.length > target.length and mustBalance == 0 and not independent then
      return unbalanced_buildPage(typesetter, independent)
   end

   -- Have we been explicitly asked to find a pagebreak at this point?
   -- If not, don't bother
   if mustBalance == 0 and not independent then
      return false
   end
   SU.debug("balancer", "Balancing", totalHeight, "of material over", colCount, "frames (total of", target, ")")
   SU.debug("balancer", "Must balance because mustBalance =", mustBalance, "and independent =", independent)
   -- OK. Now we have to balance the frames. We are going to cheat and
   -- adjust the height of each frame to be an appropriate fraction of
   -- the content height
   frame = typesetter.frame
   SU.debug("balancer", "Each column is now", totalHeight.length / colCount)
   while frame and frame.balanced == true do
      frame:relax("bottom")
      frame:constrain("height", totalHeight.length / colCount)
      if frame.next then
         frame = SILE.getFrame(frame.next)
      else
         break
      end
   end
   typesetter.state.lastPenalty = 0
   local oldPageBuilder = SILE.pagebuilder
   SILE.pagebuilder = SILE.pagebuilders.base()
   while typesetter.frame and typesetter.frame.balanced do
      unbalanced_buildPage(typesetter, true)
      if typesetter.frame.next and SILE.getFrame(typesetter.frame.next).balanced == true then
         typesetter:initFrame(SILE.getFrame(typesetter.frame.next))
         typesetter:runHooks("newframe")
      else
         break -- Break early, because when we return
      end
   end
   SILE.pagebuilder = oldPageBuilder
   SU.debug("balancer", "Finished this balance, frame id is now", typesetter.frame)
   -- SILE.typesetter:debugState()
   -- We're done.
   return true
end

function package:_init (options)
   base._init(self, options)
   self.class:registerPostinit(function (_)
      if not unbalanced_buildPage then
         unbalanced_buildPage = SILE.typesetter.buildPage
         SILE.typesetter.buildPage = buildPage
         SILE.typesetters.base.buildPage = buildPage
      end
   end)
end

function package:registerCommands ()
   self:registerCommand("balancecolumns", function (_, _)
      SILE.typesetter:leaveHmode()
      SILE.call("penalty", { penalty = BALANCE_PENALTY })
   end)
end

package.documentation = [[
\begin{document}
This package attempts to ensure that the main content frames on a page are balanced; that is, that they have the same height.
In your frame definitions for the columns, you will need to ensure that they have the parameter \autodoc:parameter{balanced} set to \code{true}.
See the example in \code{tests/balanced.sil}.

The current algorithm does not work particularly well, and a better solution to the column problem is being developed.
\end{document}
]]

return package

1	local base = require("packages.base")	×
2
3	local package = pl.class(base)	×
4	package._name = "balanced-frames"	×
5
6	local BALANCE_PENALTY = -17777	×
7
8	local unbalanced_buildPage
9
10	local function buildPage (typesetter, independent)
11	local frame = typesetter.frame	×
12	if not (frame.balanced == true) then	×
13	return unbalanced_buildPage(typesetter, independent)	×
14	end
15
16	local colCount = 0	×
17	local target = SILE.types.length()	×
18	while frame and frame.balanced == true do	×
19	target = target + frame:height()	×
20	colCount = colCount + 1	×
21	if frame.next then	×
22	frame = SILE.getFrame(frame.next)	×
23	else
24	break
25	end
26	end
27
28	-- Really, try and avoid doing anything, where possible.
29	if colCount == 1 then	×
30	return unbalanced_buildPage(typesetter, independent)	×
31	end
32	-- If the total amount of stuff on the output list is greater then the total
33	-- of frame space on the page, and there are no magic requests to balance the
34	-- columns, then we have a full page. Just send it out normally.
35	local q = typesetter.state.outputQueue	×
36	local totalHeight = SILE.types.length()	×
37	local mustBalance = 0	×
38	for i = 1, #q do	×
39	totalHeight = totalHeight + q[i].height + q[i].depth	×
40	if q[i].is_penalty and q[i].penalty <= BALANCE_PENALTY then	×
41	mustBalance = i	×
42	break
43	end
44	end
45	if totalHeight.length > target.length and mustBalance == 0 and not independent then	×
46	return unbalanced_buildPage(typesetter, independent)	×
47	end
48
49	-- Have we been explicitly asked to find a pagebreak at this point?
50	-- If not, don't bother
51	if mustBalance == 0 and not independent then	×
52	return false	×
53	end
54	SU.debug("balancer", "Balancing", totalHeight, "of material over", colCount, "frames (total of", target, ")")	×
55	SU.debug("balancer", "Must balance because mustBalance =", mustBalance, "and independent =", independent)	×
56	-- OK. Now we have to balance the frames. We are going to cheat and
57	-- adjust the height of each frame to be an appropriate fraction of
58	-- the content height
59	frame = typesetter.frame	×
60	SU.debug("balancer", "Each column is now", totalHeight.length / colCount)	×
61	while frame and frame.balanced == true do	×
62	frame:relax("bottom")	×
63	frame:constrain("height", totalHeight.length / colCount)	×
64	if frame.next then	×
65	frame = SILE.getFrame(frame.next)	×
66	else
67	break
68	end
69	end
70	typesetter.state.lastPenalty = 0	×
71	local oldPageBuilder = SILE.pagebuilder	×
72	SILE.pagebuilder = SILE.pagebuilders.base()	×
73	while typesetter.frame and typesetter.frame.balanced do	×
74	unbalanced_buildPage(typesetter, true)	×
75	if typesetter.frame.next and SILE.getFrame(typesetter.frame.next).balanced == true then	×
76	typesetter:initFrame(SILE.getFrame(typesetter.frame.next))	×
77	typesetter:runHooks("newframe")	×
78	else
79	break -- Break early, because when we return
80	end
81	end
82	SILE.pagebuilder = oldPageBuilder	×
83	SU.debug("balancer", "Finished this balance, frame id is now", typesetter.frame)	×
84	-- SILE.typesetter:debugState()
85	-- We're done.
86	return true	×
87	end
88
89	function package:_init (options)	×
90	base._init(self, options)	×
91	self.class:registerPostinit(function (_)	×
92	if not unbalanced_buildPage then	×
93	unbalanced_buildPage = SILE.typesetter.buildPage	×
94	SILE.typesetter.buildPage = buildPage	×
95	SILE.typesetters.base.buildPage = buildPage	×
96	end
97	end)
98	end
99
100	function package:registerCommands ()	×
101	self:registerCommand("balancecolumns", function (_, _)	×
102	SILE.typesetter:leaveHmode()	×
103	SILE.call("penalty", { penalty = BALANCE_PENALTY })	×
104	end)
105	end
106
107	package.documentation = [[
108	\begin{document}
109	This package attempts to ensure that the main content frames on a page are balanced; that is, that they have the same height.
110	In your frame definitions for the columns, you will need to ensure that they have the parameter \autodoc:parameter{balanced} set to \code{true}.
111	See the example in \code{tests/balanced.sil}.
112
113	The current algorithm does not work particularly well, and a better solution to the column problem is being developed.
114	\end{document}
115	]]	×
116
117	return package	×

sile-typesetter / sile / 11534409649

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