9428907827

Committed 08 Jun 2024 12:56PM UTC coverage: 57.223% (-11.0%) from 68.206%

Build # 9428907827

Build Type

push

github

Committed by

alerque

Commit Message

chore(release): 0.15.1

Run Details

9741 of 17023 relevant lines covered (57.22%)

4415.41 hits per line

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

0.0

/packages/parallel/init.lua

local base = require("packages.base")

local package = pl.class(base)
package._name = "parallel"

local typesetterPool = {}
local calculations = {}
local folioOrder = {}

local allTypesetters = function (callback)
   local oldtypesetter = SILE.typesetter
   for frame, typesetter in pairs(typesetterPool) do
      SILE.typesetter = typesetter
      callback(frame, typesetter)
   end
   SILE.typesetter = oldtypesetter
end

local nulTypesetter = pl.class(SILE.typesetters.base) -- we ignore this
nulTypesetter.outputLinesToPage = function () end

local parallelPagebreak = function ()
   for i = 1, #folioOrder do
      local thisPageFrames = folioOrder[i]
      for j = 1, #thisPageFrames do
         local frame = thisPageFrames[j]
         local typesetter = typesetterPool[frame]
         local thispage = {}
         SU.debug("parallel", "Dumping lines for page on typesetter", typesetter.id)
         if #typesetter.state.outputQueue > 0 and calculations[frame].mark == 0 then
            -- More than one page worth of stuff here.
            -- Just ship out one page and hope for the best.
            SILE.typesetters.base.buildPage(typesetter)
         else
            for l = 1, calculations[frame].mark do
               thispage[l] = table.remove(typesetter.state.outputQueue, 1)
               SU.debug("parallel", thispage[l])
            end
            typesetter:outputLinesToPage(thispage)
         end
      end
      SILE.documentState.documentClass:endPage()
      for l = 1, #thisPageFrames do
         local frame = thisPageFrames[l]
         local typesetter = typesetterPool[frame]
         typesetter:initFrame(typesetter.frame)
      end
      SILE.documentState.documentClass:newPage()
   end
end

local addBalancingGlue = function (height)
   allTypesetters(function (frame, typesetter)
      local glue = height - calculations[frame].heightOfNewMaterial
      if glue.length:tonumber() > 0 then
         SU.debug("parallel", "Adding", glue, "to", frame)
         typesetter:pushVglue({ height = glue })
      end
      calculations[frame].mark = #typesetter.state.outputQueue
   end)
end

function package:_init (options)
   base._init(self, options)
   SILE.typesetter = nulTypesetter(SILE.getFrame("page"))
   if type(options.frames) ~= "table" then
      SU.error([[Package parallel must be initialized with a set of appropriately named frames.
This package is usually intended to be loaded from some supporting class or
from another package, responsible for correct initialization.]])
   end
   for frame, typesetter in pairs(options.frames) do
      typesetterPool[frame] = SILE.typesetters.base(SILE.getFrame(typesetter))
      typesetterPool[frame].id = typesetter
      typesetterPool[frame].buildPage = function ()
         -- No thank you, I will do that.
      end
      -- Fixed leading here is obviously a bug, but n-way leading calculations
      -- get very complicated...
      -- typesetterPool[frame].leadingFor = function() return SILE.types.node.vglue(SILE.settings:get("document.lineskip")) end
      local fontcommand = frame .. ":font"
      self:registerCommand(frame, function (_, _) -- \left ...
         SILE.typesetter = typesetterPool[frame]
         SILE.call(fontcommand)
      end)
      if not SILE.Commands[fontcommand] then
         self:registerCommand(fontcommand, function (_, _) end) -- to be overridden
      end
   end
   if not options.folios then
      folioOrder = { {} }
      -- Note output order doesn't matter for PDF, but for our test suite it is
      -- essential that the output order is deterministic, hence this sort()
      for frame, _ in pl.tablex.sort(options.frames) do
         table.insert(folioOrder[1], frame)
      end
   else
      folioOrder = options.folios -- As usual we trust the user knows what they're doing
   end
   self.class.newPage = function (self_)
      allTypesetters(function (frame, _)
         calculations[frame] = { mark = 0 }
      end)
      self.class._base.newPage(self_)
      SILE.call("sync")
   end
   allTypesetters(function (frame, _)
      calculations[frame] = { mark = 0 }
   end)
   local oldfinish = self.class.finish
   self.class.finish = function (self_)
      parallelPagebreak()
      oldfinish(self_)
   end
end

function package:registerCommands ()
   self:registerCommand("sync", function (_, _)
      local anybreak = false
      local maxheight = SILE.types.length()
      SU.debug("parallel", "Trying a sync")
      allTypesetters(function (_, typesetter)
         SU.debug("parallel", "Leaving hmode on", typesetter.id)
         typesetter:leaveHmode(true)
         -- Now we have each typesetter's content boxed up onto the output stream
         -- but page breaking has not been run. See if page breaking would cause a
         -- break
         local lines = pl.tablex.copy(typesetter.state.outputQueue)
         if SILE.pagebuilder:findBestBreak({ vboxlist = lines, target = typesetter:getTargetLength() }) then
            anybreak = true
         end
      end)

      if anybreak then
         parallelPagebreak()
         return
      end

      allTypesetters(function (frame, typesetter)
         calculations[frame].heightOfNewMaterial = SILE.types.length()
         for i = calculations[frame].mark + 1, #typesetter.state.outputQueue do
            local thisHeight = typesetter.state.outputQueue[i].height + typesetter.state.outputQueue[i].depth
            calculations[frame].heightOfNewMaterial = calculations[frame].heightOfNewMaterial + thisHeight
         end
         if maxheight < calculations[frame].heightOfNewMaterial then
            maxheight = calculations[frame].heightOfNewMaterial
         end
         SU.debug(
            "parallel",
            frame,
            ": pre-sync content=",
            calculations[frame].mark,
            ", now",
            #typesetter.state.outputQueue,
            ", height of material:",
            calculations[frame].heightOfNewMaterial
         )
      end)
      addBalancingGlue(maxheight)
   end)
end

package.documentation = [[
\begin{document}
The \autodoc:package{parallel} package provides the mechanism for typesetting diglot or other parallel documents.
When used by a class such as \code{classes/diglot.lua}, it registers a command for each parallel frame, to allow you to select which frame you’re typesetting into.
It also defines the \autodoc:command{\sync} command, which adds vertical spacing to each frame such that the \em{next} set of text is vertically aligned.
See \url{https://sile-typesetter.org/examples/parallel.sil} and the source of \code{classes/diglot.lua} for examples which make the operation clear.
\end{document}
]]

return package

1	local base = require("packages.base")	×
2
3	local package = pl.class(base)	×
4	package._name = "parallel"	×
5
6	local typesetterPool = {}	×
7	local calculations = {}	×
8	local folioOrder = {}	×
9
10	local allTypesetters = function (callback)
11	local oldtypesetter = SILE.typesetter	×
12	for frame, typesetter in pairs(typesetterPool) do	×
13	SILE.typesetter = typesetter	×
14	callback(frame, typesetter)	×
15	end
16	SILE.typesetter = oldtypesetter	×
17	end
18
19	local nulTypesetter = pl.class(SILE.typesetters.base) -- we ignore this	×
20	nulTypesetter.outputLinesToPage = function () end	×
21
22	local parallelPagebreak = function ()
23	for i = 1, #folioOrder do	×
24	local thisPageFrames = folioOrder[i]	×
25	for j = 1, #thisPageFrames do	×
26	local frame = thisPageFrames[j]	×
27	local typesetter = typesetterPool[frame]	×
28	local thispage = {}	×
29	SU.debug("parallel", "Dumping lines for page on typesetter", typesetter.id)	×
30	if #typesetter.state.outputQueue > 0 and calculations[frame].mark == 0 then	×
31	-- More than one page worth of stuff here.
32	-- Just ship out one page and hope for the best.
33	SILE.typesetters.base.buildPage(typesetter)	×
34	else
35	for l = 1, calculations[frame].mark do	×
36	thispage[l] = table.remove(typesetter.state.outputQueue, 1)	×
37	SU.debug("parallel", thispage[l])	×
38	end
39	typesetter:outputLinesToPage(thispage)	×
40	end
41	end
42	SILE.documentState.documentClass:endPage()	×
43	for l = 1, #thisPageFrames do	×
44	local frame = thisPageFrames[l]	×
45	local typesetter = typesetterPool[frame]	×
46	typesetter:initFrame(typesetter.frame)	×
47	end
48	SILE.documentState.documentClass:newPage()	×
49	end
50	end
51
52	local addBalancingGlue = function (height)
53	allTypesetters(function (frame, typesetter)	×
54	local glue = height - calculations[frame].heightOfNewMaterial	×
55	if glue.length:tonumber() > 0 then	×
56	SU.debug("parallel", "Adding", glue, "to", frame)	×
57	typesetter:pushVglue({ height = glue })	×
58	end
59	calculations[frame].mark = #typesetter.state.outputQueue	×
60	end)
61	end
62
63	function package:_init (options)	×
64	base._init(self, options)	×
65	SILE.typesetter = nulTypesetter(SILE.getFrame("page"))	×
66	if type(options.frames) ~= "table" then	×
67	SU.error([[Package parallel must be initialized with a set of appropriately named frames.	×
68	This package is usually intended to be loaded from some supporting class or
69	from another package, responsible for correct initialization.]])	×
70	end
71	for frame, typesetter in pairs(options.frames) do	×
72	typesetterPool[frame] = SILE.typesetters.base(SILE.getFrame(typesetter))	×
73	typesetterPool[frame].id = typesetter	×
74	typesetterPool[frame].buildPage = function ()	×
75	-- No thank you, I will do that.
76	end
77	-- Fixed leading here is obviously a bug, but n-way leading calculations
78	-- get very complicated...
79	-- typesetterPool[frame].leadingFor = function() return SILE.types.node.vglue(SILE.settings:get("document.lineskip")) end
80	local fontcommand = frame .. ":font"	×
81	self:registerCommand(frame, function (_, _) -- \left ...	×
82	SILE.typesetter = typesetterPool[frame]	×
83	SILE.call(fontcommand)	×
84	end)
85	if not SILE.Commands[fontcommand] then	×
86	self:registerCommand(fontcommand, function (_, _) end) -- to be overridden	×
87	end
88	end
89	if not options.folios then	×
90	folioOrder = { {} }	×
91	-- Note output order doesn't matter for PDF, but for our test suite it is
92	-- essential that the output order is deterministic, hence this sort()
93	for frame, _ in pl.tablex.sort(options.frames) do	×
94	table.insert(folioOrder[1], frame)	×
95	end
96	else
97	folioOrder = options.folios -- As usual we trust the user knows what they're doing	×
98	end
99	self.class.newPage = function (self_)	×
100	allTypesetters(function (frame, _)	×
101	calculations[frame] = { mark = 0 }	×
102	end)
103	self.class._base.newPage(self_)	×
104	SILE.call("sync")	×
105	end
106	allTypesetters(function (frame, _)	×
107	calculations[frame] = { mark = 0 }	×
108	end)
109	local oldfinish = self.class.finish	×
110	self.class.finish = function (self_)	×
111	parallelPagebreak()	×
112	oldfinish(self_)	×
113	end
114	end
115
116	function package:registerCommands ()	×
117	self:registerCommand("sync", function (_, _)	×
118	local anybreak = false	×
119	local maxheight = SILE.types.length()	×
120	SU.debug("parallel", "Trying a sync")	×
121	allTypesetters(function (_, typesetter)	×
122	SU.debug("parallel", "Leaving hmode on", typesetter.id)	×
123	typesetter:leaveHmode(true)	×
124	-- Now we have each typesetter's content boxed up onto the output stream
125	-- but page breaking has not been run. See if page breaking would cause a
126	-- break
127	local lines = pl.tablex.copy(typesetter.state.outputQueue)	×
128	if SILE.pagebuilder:findBestBreak({ vboxlist = lines, target = typesetter:getTargetLength() }) then	×
129	anybreak = true	×
130	end
131	end)
132
133	if anybreak then	×
134	parallelPagebreak()	×
135	return	×
136	end
137
138	allTypesetters(function (frame, typesetter)	×
139	calculations[frame].heightOfNewMaterial = SILE.types.length()	×
140	for i = calculations[frame].mark + 1, #typesetter.state.outputQueue do	×
141	local thisHeight = typesetter.state.outputQueue[i].height + typesetter.state.outputQueue[i].depth	×
142	calculations[frame].heightOfNewMaterial = calculations[frame].heightOfNewMaterial + thisHeight	×
143	end
144	if maxheight < calculations[frame].heightOfNewMaterial then	×
145	maxheight = calculations[frame].heightOfNewMaterial	×
146	end
147	SU.debug(	×
148	"parallel",
149	frame,
150	": pre-sync content=",
151	calculations[frame].mark,	×
152	", now",
153	#typesetter.state.outputQueue,	×
154	", height of material:",
155	calculations[frame].heightOfNewMaterial	×
156	)
157	end)
158	addBalancingGlue(maxheight)	×
159	end)
160	end
161
162	package.documentation = [[
163	\begin{document}
164	The \autodoc:package{parallel} package provides the mechanism for typesetting diglot or other parallel documents.
165	When used by a class such as \code{classes/diglot.lua}, it registers a command for each parallel frame, to allow you to select which frame you’re typesetting into.
166	It also defines the \autodoc:command{\sync} command, which adds vertical spacing to each frame such that the \em{next} set of text is vertically aligned.
167	See \url{https://sile-typesetter.org/examples/parallel.sil} and the source of \code{classes/diglot.lua} for examples which make the operation clear.
168	\end{document}
169	]]	×
170
171	return package	×

sile-typesetter / sile / 9428907827

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