12272864087

Committed 11 Dec 2024 08:55AM UTC coverage: 29.607% (-41.0%) from 70.614%

Build # 12272864087

Build Type

push

github

Committed by

web-flow

Commit Message

Merge 95cccf286 into f394f608c

Run Details

5834 of 19705 relevant lines covered (29.61%)

429.05 hits per line

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

73.45

/core/frame.lua

SILE.frames = {}

-- Buggy, relies on side effects
-- luacheck: ignore solver frame
-- See https://github.com/sile-typesetter/sile/issues/694

local cassowary = require("cassowary")
local solver = cassowary.SimplexSolver()
local solverNeedsReloading = true

local widthdims = pl.Set({ "left", "right", "width" })
local heightdims = pl.Set({ "top", "bottom", "height" })
local alldims = widthdims + heightdims

SILE.framePrototype = pl.class({
   direction = "LTR-TTB",
   enterHooks = {},
   leaveHooks = {},

   -- This gets called by Penlght when creating the frame instance
   _init = function (self, spec, dummy)
      local direction = SILE.documentState.direction
      if direction then
         self.direction = direction
      end
      self.constraints = {}
      self.variables = {}
      self.id = spec.id
      for k, v in pairs(spec) do
         if not alldims[k] then
            self[k] = v
         end
      end
      self.balanced = SU.boolean(self.balanced, false)
      if not dummy then
         for method in pairs(alldims) do
            self.variables[method] = cassowary.Variable({ name = spec.id .. "_" .. method })
            self[method] = function (instance_self)
               instance_self:solve()
               return SILE.types.measurement(instance_self.variables[method].value)
            end
         end
         -- Add definitions of width and height
         for method in pairs(alldims) do
            if spec[method] then
               self:constrain(method, spec[method])
            end
         end
      end
   end,

   -- This gets called by us in typesetter before we start to use the frame
   init = function (self, typesetter)
      self.state = { totals = { height = SILE.types.measurement(0) } }
      self:enter(typesetter)
      self:newLine(typesetter)
      if self:pageAdvanceDirection() == "TTB" then
         self.state.cursorY = self:top()
      elseif self:pageAdvanceDirection() == "LTR" then
         self.state.cursorX = self:left()
      elseif self:pageAdvanceDirection() == "RTL" then
         self.state.cursorX = self:right()
      elseif self:pageAdvanceDirection() == "BTT" then
         self.state.cursorY = self:bottom()
      end
   end,

   constrain = function (self, method, dimension)
      self.constraints[method] = tostring(dimension)
      self:invalidate()
   end,

   invalidate = function ()
      solverNeedsReloading = true
   end,

   relax = function (self, method)
      self.constraints[method] = nil
   end,

   reifyConstraint = function (self, solver, method, stay)
      local constraint = self.constraints[method]
      if not constraint then
         return
      end
      constraint = SU.type(constraint) == "measurement" and constraint:tonumber() or SILE.frameParser:match(constraint)
      SU.debug("frames", "Adding constraint", self.id, function ()
         return "(" .. method .. ") = " .. tostring(constraint)
      end)
      local eq = cassowary.Equation(self.variables[method], constraint)
      solver:addConstraint(eq)
      if stay then
         solver:addStay(eq)
      end
   end,

   addWidthHeightDefinitions = function (self, solver)
      local vars = self.variables
      solver:addConstraint(cassowary.Equation(vars.width, cassowary.minus(vars.right, vars.left)))
      solver:addConstraint(cassowary.Equation(vars.height, cassowary.minus(vars.bottom, vars.top)))
   end,

   -- This is hideously inefficient,
   -- but it's the easiest way to allow users to reconfigure frames at runtime.
   solve = function (_)
      if not solverNeedsReloading then
         return
      end
      SU.debug("frames", "Solving...")
      solver = cassowary.SimplexSolver()
      if SILE.frames.page then
         for method, _ in pairs(SILE.frames.page.constraints) do
            SILE.frames.page:reifyConstraint(solver, method, true)
         end
         SILE.frames.page:addWidthHeightDefinitions(solver)
      end
      for id, frame in pairs(SILE.frames) do
         if not (id == "page") then
            for method, _ in pairs(frame.constraints) do
               frame:reifyConstraint(solver, method)
            end
            frame:addWidthHeightDefinitions(solver)
         end
      end
      solver:solve()
      solverNeedsReloading = false
   end,

   writingDirection = function (self)
      return self.direction:match("^(%a+)") or "LTR"
   end,

   pageAdvanceDirection = function (self)
      return self.direction:match("-(%a+)$") or "TTB"
   end,

   advanceWritingDirection = function (self, length)
      local amount = SU.cast("number", length)
      if amount == 0 then
         return
      end
      if self:writingDirection() == "RTL" then
         self.state.cursorX = self.state.cursorX - amount
      elseif self:writingDirection() == "LTR" then
         self.state.cursorX = self.state.cursorX + amount
      elseif self:writingDirection() == "TTB" then
         self.state.cursorY = self.state.cursorY + amount
      elseif self:writingDirection() == "BTT" then
         self.state.cursorY = self.state.cursorY - amount
      end
   end,

   advancePageDirection = function (self, length)
      local amount = SU.cast("number", length)
      if amount == 0 then
         return
      end
      if self:pageAdvanceDirection() == "TTB" then
         self.state.cursorY = self.state.cursorY + amount
      elseif self:pageAdvanceDirection() == "RTL" then
         self.state.cursorX = self.state.cursorX - amount
      elseif self:pageAdvanceDirection() == "LTR" then
         self.state.cursorX = self.state.cursorX + amount
      elseif self:pageAdvanceDirection() == "BTT" then
         self.state.cursorY = self.state.cursorY - amount
      end
   end,

   newLine = function (self, _)
      if self:writingDirection() == "LTR" then
         self.state.cursorX = self:left()
      elseif self:writingDirection() == "RTL" then
         self.state.cursorX = self:right()
      elseif self:writingDirection() == "TTB" then
         self.state.cursorY = self:top()
      elseif self:writingDirection() == "BTT" then
         self.state.cursorY = self:bottom()
      end
   end,

   lineWidth = function (self)
      SU.warn("Method :lineWidth() is deprecated, please use :getLineWidth()")
      return self:getLineWidth()
   end,

   getLineWidth = function (self)
      if self:writingDirection() == "LTR" or self:writingDirection() == "RTL" then
         return self:width()
      else
         return self:height()
      end
   end,

   pageTarget = function (self)
      SU.warn("Method :pageTarget() is deprecated, please use :getTargetLength()")
      return self:getTargetLength()
   end,

   getTargetLength = function (self)
      local direction = self:pageAdvanceDirection()
      if direction == "TTB" or direction == "BTT" then
         return self:height()
      else
         return self:width()
      end
   end,

   enter = function (self, typesetter)
      for i = 1, #self.enterHooks do
         self.enterHooks[i](self, typesetter)
      end
   end,

   leave = function (self, typesetter)
      for i = 1, #self.leaveHooks do
         self.leaveHooks[i](self, typesetter)
      end
   end,

   isAbsoluteConstraint = function (self, method)
      if not self.constraints[method] then
         return false
      end
      local constraint = SILE.frameParser:match(self.constraints[method])
      if type(constraint) ~= "table" then
         return true
      end
      if not constraint.terms then
         return false
      end
      for clv, _ in pairs(constraint.terms) do
         if clv.name and not clv.name:match("^page_") then
            return false
         end
      end
      return true
   end,

   isMainContentFrame = function (self)
      local tpt = SILE.documentState.thisPageTemplate
      local frame = tpt.firstContentFrame
      while frame do
         if frame == self then
            return true
         end
         if frame.next then
            frame = SILE.getFrame(frame.next)
         else
            return false
         end
      end
      return false
   end,

   __tostring = function (self)
      local str = "<Frame: " .. self.id .. ": "
      str = str .. " next=" .. (self.next or "nil") .. " "
      for method, dimension in pairs(self.constraints) do
         str = str .. method .. "=" .. dimension .. "; "
      end
      if self.hanmen then
         str = str .. "tate=" .. (self.tate and "true" or "false") .. "; "
         str = str .. "gridsize=" .. self.gridsize .. "; "
         str = str .. "linegap=" .. self.linegap .. "; "
         str = str .. "linelength=" .. self.linelength .. "; "
         str = str .. "linecount=" .. self.linecount .. "; "
      end
      str = str .. ">"
      return str
   end,
})

SILE.newFrame = function (spec, prototype)
   SU.required(spec, "id", "frame declaration")
   prototype = prototype or SILE.framePrototype
   local frame = prototype(spec)
   SILE.frames[spec.id] = frame
   return frame
end

SILE.getFrame = function (id)
   if type(id) == "table" then
      SU.error("Passed a table, expected a string", true)
   end
   local frame, last_attempt
   while not frame do
      frame = SILE.frames[id]
      id = id:gsub("_$", "")
      if id == last_attempt then
         break
      end
      last_attempt = id
   end
   return frame or SU.warn("Couldn't find frame ID " .. id, true)
end

SILE.parseComplexFrameDimension = function (dimension)
   local length = SILE.frameParser:match(SU.cast("string", dimension))
   if type(length) == "table" then
      local g = cassowary.Variable({ name = "t" })
      local eq = cassowary.Equation(g, length)
      solverNeedsReloading = true
      solver:addConstraint(eq)
      SILE.frames.page:solve()
      solverNeedsReloading = true
      return g.value
   end
   return length
end

1	SILE.frames = {}	20✔
2
3	-- Buggy, relies on side effects
4	-- luacheck: ignore solver frame
5	-- See https://github.com/sile-typesetter/sile/issues/694
6
7	local cassowary = require("cassowary")	20✔
8	local solver = cassowary.SimplexSolver()	20✔
9	local solverNeedsReloading = true	20✔
10
11	local widthdims = pl.Set({ "left", "right", "width" })	20✔
12	local heightdims = pl.Set({ "top", "bottom", "height" })	20✔
13	local alldims = widthdims + heightdims	20✔
14
15	SILE.framePrototype = pl.class({	40✔
16	direction = "LTR-TTB",
17	enterHooks = {},	20✔
18	leaveHooks = {},	20✔
19
20	-- This gets called by Penlght when creating the frame instance
21	_init = function (self, spec, dummy)
22	local direction = SILE.documentState.direction	55✔
23	if direction then	55✔
24	self.direction = direction	3✔
25	end
26	self.constraints = {}	55✔
27	self.variables = {}	55✔
28	self.id = spec.id	55✔
29	for k, v in pairs(spec) do	341✔
30	if not alldims[k] then	286✔
31	self[k] = v	68✔
32	end
33	end
34	self.balanced = SU.boolean(self.balanced, false)	110✔
35	if not dummy then	55✔
36	for method in pairs(alldims) do	385✔
37	self.variables[method] = cassowary.Variable({ name = spec.id .. "_" .. method })	660✔
38	self[method] = function (instance_self)
39	instance_self:solve()	620✔
40	return SILE.types.measurement(instance_self.variables[method].value)	620✔
41	end
42	end
43	-- Add definitions of width and height
44	for method in pairs(alldims) do	385✔
45	if spec[method] then	330✔
46	self:constrain(method, spec[method])	218✔
47	end
48	end
49	end
50	end,
51
52	-- This gets called by us in typesetter before we start to use the frame
53	init = function (self, typesetter)
54	self.state = { totals = { height = SILE.types.measurement(0) } }	120✔
55	self:enter(typesetter)	60✔
56	self:newLine(typesetter)	60✔
57	if self:pageAdvanceDirection() == "TTB" then	120✔
58	self.state.cursorY = self:top()	118✔
59	elseif self:pageAdvanceDirection() == "LTR" then	2✔
60	self.state.cursorX = self:left()	×
61	elseif self:pageAdvanceDirection() == "RTL" then	2✔
62	self.state.cursorX = self:right()	2✔
63	elseif self:pageAdvanceDirection() == "BTT" then	×
64	self.state.cursorY = self:bottom()	×
65	end
66	end,
67
68	constrain = function (self, method, dimension)
69	self.constraints[method] = tostring(dimension)	228✔
70	self:invalidate()	222✔
71	end,
72
73	invalidate = function ()
74	solverNeedsReloading = true	309✔
75	end,
76
77	relax = function (self, method)
78	self.constraints[method] = nil	4✔
79	end,
80
81	reifyConstraint = function (self, solver, method, stay)
82	local constraint = self.constraints[method]	880✔
83	if not constraint then	880✔
84	return	×
85	end
86	constraint = SU.type(constraint) == "measurement" and constraint:tonumber() or SILE.frameParser:match(constraint)	1,760✔
87	SU.debug("frames", "Adding constraint", self.id, function ()	1,760✔
88	return "(" .. method .. ") = " .. tostring(constraint)	×
89	end)
90	local eq = cassowary.Equation(self.variables[method], constraint)	880✔
91	solver:addConstraint(eq)	880✔
92	if stay then	880✔
93	solver:addStay(eq)	184✔
94	end
95	end,
96
97	addWidthHeightDefinitions = function (self, solver)
98	local vars = self.variables	220✔
99	solver:addConstraint(cassowary.Equation(vars.width, cassowary.minus(vars.right, vars.left)))	660✔
100	solver:addConstraint(cassowary.Equation(vars.height, cassowary.minus(vars.bottom, vars.top)))	660✔
101	end,
102
103	-- This is hideously inefficient,
104	-- but it's the easiest way to allow users to reconfigure frames at runtime.
105	solve = function (_)
106	if not solverNeedsReloading then	620✔
107	return	574✔
108	end
109	SU.debug("frames", "Solving...")	46✔
110	solver = cassowary.SimplexSolver()	92✔
111	if SILE.frames.page then	46✔
112	for method, _ in pairs(SILE.frames.page.constraints) do	230✔
113	SILE.frames.page:reifyConstraint(solver, method, true)	184✔
114	end
115	SILE.frames.page:addWidthHeightDefinitions(solver)	46✔
116	end
117	for id, frame in pairs(SILE.frames) do	266✔
118	if not (id == "page") then	220✔
119	for method, _ in pairs(frame.constraints) do	870✔
120	frame:reifyConstraint(solver, method)	696✔
121	end
122	frame:addWidthHeightDefinitions(solver)	174✔
123	end
124	end
125	solver:solve()	46✔
126	solverNeedsReloading = false	46✔
127	end,
128
129	writingDirection = function (self)
130	return self.direction:match("^(%a+)") or "LTR"	5,337✔
131	end,
132
133	pageAdvanceDirection = function (self)
134	return self.direction:match("-(%a+)$") or "TTB"	637✔
135	end,
136
137	advanceWritingDirection = function (self, length)
138	local amount = SU.cast("number", length)	1,378✔
139	if amount == 0 then	1,378✔
140	return	317✔
141	end
142	if self:writingDirection() == "RTL" then	2,122✔
143	self.state.cursorX = self.state.cursorX - amount	218✔
144	elseif self:writingDirection() == "LTR" then	1,904✔
145	self.state.cursorX = self.state.cursorX + amount	1,892✔
146	elseif self:writingDirection() == "TTB" then	12✔
147	self.state.cursorY = self.state.cursorY + amount	12✔
148	elseif self:writingDirection() == "BTT" then	×
149	self.state.cursorY = self.state.cursorY - amount	×
150	end
151	end,
152
153	advancePageDirection = function (self, length)
154	local amount = SU.cast("number", length)	407✔
155	if amount == 0 then	407✔
156	return	72✔
157	end
158	if self:pageAdvanceDirection() == "TTB" then	670✔
159	self.state.cursorY = self.state.cursorY + amount	664✔
160	elseif self:pageAdvanceDirection() == "RTL" then	6✔
161	self.state.cursorX = self.state.cursorX - amount	6✔
162	elseif self:pageAdvanceDirection() == "LTR" then	×
163	self.state.cursorX = self.state.cursorX + amount	×
164	elseif self:pageAdvanceDirection() == "BTT" then	×
165	self.state.cursorY = self.state.cursorY - amount	×
166	end
167	end,
168
169	newLine = function (self, _)
170	if self:writingDirection() == "LTR" then	358✔
171	self.state.cursorX = self:left()	334✔
172	elseif self:writingDirection() == "RTL" then	24✔
173	self.state.cursorX = self:right()	20✔
174	elseif self:writingDirection() == "TTB" then	4✔
175	self.state.cursorY = self:top()	4✔
176	elseif self:writingDirection() == "BTT" then	×
177	self.state.cursorY = self:bottom()	×
178	end
179	end,
180
181	lineWidth = function (self)
182	SU.warn("Method :lineWidth() is deprecated, please use :getLineWidth()")	×
183	return self:getLineWidth()	×
184	end,
185
186	getLineWidth = function (self)
187	if self:writingDirection() == "LTR" or self:writingDirection() == "RTL" then	280✔
188	return self:width()	137✔
189	else
190	return self:height()	1✔
191	end
192	end,
193
194	pageTarget = function (self)
195	SU.warn("Method :pageTarget() is deprecated, please use :getTargetLength()")	×
196	return self:getTargetLength()	×
197	end,
198
199	getTargetLength = function (self)
200	local direction = self:pageAdvanceDirection()	237✔
201	if direction == "TTB" or direction == "BTT" then	237✔
202	return self:height()	231✔
203	else
204	return self:width()	6✔
205	end
206	end,
207
208	enter = function (self, typesetter)
209	for i = 1, #self.enterHooks do	75✔
210	self.enterHooks[i](self, typesetter)	1✔
211	end
212	end,
213
214	leave = function (self, typesetter)
215	for i = 1, #self.leaveHooks do	84✔
216	self.leaveHooks[i](self, typesetter)	1✔
217	end
218	end,
219
220	isAbsoluteConstraint = function (self, method)
221	if not self.constraints[method] then	16✔
222	return false	×
223	end
224	local constraint = SILE.frameParser:match(self.constraints[method])	16✔
225	if type(constraint) ~= "table" then	16✔
226	return true	4✔
227	end
228	if not constraint.terms then	12✔
229	return false	12✔
230	end
231	for clv, _ in pairs(constraint.terms) do	×
232	if clv.name and not clv.name:match("^page_") then	×
233	return false	×
234	end
235	end
236	return true	×
237	end,
238
239	isMainContentFrame = function (self)
240	local tpt = SILE.documentState.thisPageTemplate	28✔
241	local frame = tpt.firstContentFrame	28✔
242	while frame do	28✔
243	if frame == self then	28✔
244	return true	16✔
245	end
246	if frame.next then	12✔
247	frame = SILE.getFrame(frame.next)	×
248	else
249	return false	12✔
250	end
251	end
252	return false	×
253	end,
254
255	__tostring = function (self)
256	local str = "<Frame: " .. self.id .. ": "	×
257	str = str .. " next=" .. (self.next or "nil") .. " "	×
258	for method, dimension in pairs(self.constraints) do	×
259	str = str .. method .. "=" .. dimension .. "; "	×
260	end
261	if self.hanmen then	×
262	str = str .. "tate=" .. (self.tate and "true" or "false") .. "; "	×
263	str = str .. "gridsize=" .. self.gridsize .. "; "	×
264	str = str .. "linegap=" .. self.linegap .. "; "	×
265	str = str .. "linelength=" .. self.linelength .. "; "	×
266	str = str .. "linecount=" .. self.linecount .. "; "	×
267	end
268	str = str .. ">"	×
269	return str	×
270	end,
271	})	20✔
272
273	SILE.newFrame = function (spec, prototype)	20✔
274	SU.required(spec, "id", "frame declaration")	55✔
275	prototype = prototype or SILE.framePrototype	55✔
276	local frame = prototype(spec)	55✔
277	SILE.frames[spec.id] = frame	55✔
278	return frame	55✔
279	end
280
281	SILE.getFrame = function (id)	20✔
282	if type(id) == "table" then	25✔
283	SU.error("Passed a table, expected a string", true)	×
284	end
285	local frame, last_attempt
286	while not frame do	50✔
287	frame = SILE.frames[id]	25✔
288	id = id:gsub("_$", "")	25✔
289	if id == last_attempt then	25✔
290	break
291	end
292	last_attempt = id	25✔
293	end
294	return frame or SU.warn("Couldn't find frame ID " .. id, true)	25✔
295	end
296
297	SILE.parseComplexFrameDimension = function (dimension)	20✔
298	local length = SILE.frameParser:match(SU.cast("string", dimension))	×
299	if type(length) == "table" then	×
300	local g = cassowary.Variable({ name = "t" })	×
301	local eq = cassowary.Equation(g, length)	×
302	solverNeedsReloading = true	×
303	solver:addConstraint(eq)	×
304	SILE.frames.page:solve()	×
305	solverNeedsReloading = true	×
306	return g.value	×
307	end
308	return length	×
309	end

sile-typesetter / sile / 12272864087

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