9688261573

Committed 26 Jun 2024 11:43PM UTC coverage: 69.955% (-1.4%) from 71.339%

Build # 9688261573

Build Type

push

github

Committed by

web-flow

Commit Message

Merge 115d95e3f into 8c5a2a2ba

Run Details

12182 of 17414 relevant lines covered (69.96%)

4406.38 hits per line

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

83.33

/shapers/base.lua

--- SILE shaper class.
-- @interfaces shapers

-- local smallTokenSize = 20 -- Small words will be cached
-- local shapeCache = {}
-- local _key = function (options)
--   return table.concat({ options.family;options.language;options.script;options.size;("%d"):format(options.weight);options.style;options.variant;options.features;options.variations;options.direction;options.filename }, ";")
-- end

SILE.settings:declare({ parameter = "shaper.variablespaces", type = "boolean", default = true })
SILE.settings:declare({ parameter = "shaper.spaceenlargementfactor", type = "number or integer", default = 1 })
SILE.settings:declare({ parameter = "shaper.spacestretchfactor", type = "number or integer", default = 1 / 2 })
SILE.settings:declare({ parameter = "shaper.spaceshrinkfactor", type = "number or integer", default = 1 / 3 })

SILE.settings:declare({
   parameter = "shaper.tracking",
   type = "number or nil",
   default = nil,
})

-- Function for testing shaping in the repl
-- luacheck: ignore makenodes
-- TODO, figure out a way to explicitly register things in the repl env
makenodes = function (token, options)
   return SILE.shaper:createNnodes(token, SILE.font.loadDefaults(options or {}))
end

local function shapespace (spacewidth)
   spacewidth = SU.cast("measurement", spacewidth)
   -- In some scripts with word-level kerning, glue can be negative.
   -- Use absolute value to ensure stretch and shrink work as expected.
   local absoluteSpaceWidth = math.abs(spacewidth:tonumber())
   local length = spacewidth * SILE.settings:get("shaper.spaceenlargementfactor")
   local stretch = absoluteSpaceWidth * SILE.settings:get("shaper.spacestretchfactor")
   local shrink = absoluteSpaceWidth * SILE.settings:get("shaper.spaceshrinkfactor")
   return SILE.types.length(length, stretch, shrink)
end

local shaper = pl.class()
shaper.type = "shaper"
shaper._name = "base"

-- Return the length of a space character
-- with a particular set of font options,
-- giving preference to document.spaceskip
-- Caching this has no significant speedup
function shaper:measureSpace (options)
   local ss = SILE.settings:get("document.spaceskip")
   if ss then
      SILE.settings:temporarily(function ()
         SILE.settings:set("font.size", options.size)
         SILE.settings:set("font.family", options.family)
         SILE.settings:set("font.filename", options.filename)
         ss = ss:absolute()
      end)
      return ss
   end
   local items, width = self:shapeToken(" ", options)
   if not width and not items[1] then
      SU.warn("Could not measure the width of a space")
      return SILE.types.length()
   end
   return shapespace(width and width.length or items[1].width)
end

function shaper:measureChar (char)
   local options = SILE.font.loadDefaults({})
   options.tracking = SILE.settings:get("shaper.tracking")
   local items = self:shapeToken(char, options)
   if #items > 0 then
      return { height = items[1].height, width = items[1].width }
   else
      SU.error("Unable to measure character", char)
   end
end

-- Given a text and some font options, return a bunch of boxes
function shaper.shapeToken (_, _, _)
   SU.error("Abstract function shapeToken called", true)
end

-- Given font options, select a font. We will handle
-- caching here. Returns an arbitrary, implementation-specific
-- object (ie a PAL for Pango, font number for libtexpdf, ...)
function shaper.getFace (_)
   SU.error("Abstract function getFace called", true)
end

function shaper.addShapedGlyphToNnodeValue (_, _, _)
   SU.error("Abstract function addShapedGlyphToNnodeValue called", true)
end

function shaper.preAddNodes (_, _, _) end

function shaper:createNnodes (token, options)
   options.tracking = SILE.settings:get("shaper.tracking")
   local items, _ = self:shapeToken(token, options)
   if #items < 1 then
      return {}
   end
   local lang = options.language
   SILE.languageSupport.loadLanguage(lang)
   local nodeMaker = SILE.nodeMakers[lang] or SILE.nodeMakers.unicode
   local nodes = {}
   for node in nodeMaker(options):iterator(items, token) do
      table.insert(nodes, node)
   end
   return nodes
end

function shaper:formNnode (contents, token, options)
   local nnodeContents = {}
   -- local glyphs = {}
   local totalWidth = 0
   local totalDepth = 0
   local totalHeight = 0
   -- local glyphNames = {}
   local nnodeValue = { text = token, options = options, glyphString = {} }
   SILE.shaper:preAddNodes(contents, nnodeValue)
   local misfit = false
   if SILE.typesetter.frame and SILE.typesetter.frame:writingDirection() == "TTB" then
      if options.direction == "LTR" then
         misfit = true
      end
   else
      if options.direction == "TTB" then
         misfit = true
      end
   end
   for i = 1, #contents do
      local glyph = contents[i]
      if (options.direction == "TTB") ~= misfit then
         if glyph.width > totalHeight then
            totalHeight = glyph.width
         end
         totalWidth = totalWidth + glyph.height
      else
         if glyph.depth > totalDepth then
            totalDepth = glyph.depth
         end
         if glyph.height > totalHeight then
            totalHeight = glyph.height
         end
         totalWidth = totalWidth + glyph.width
      end
      self:addShapedGlyphToNnodeValue(nnodeValue, glyph)
   end
   table.insert(
      nnodeContents,
      SILE.types.node.hbox({
         depth = totalDepth,
         height = totalHeight,
         misfit = misfit,
         width = SILE.types.length(totalWidth),
         value = nnodeValue,
      })
   )
   return SILE.types.node.nnode({
      nodes = nnodeContents,
      text = token,
      misfit = misfit,
      options = options,
      language = options.language,
   })
end

function shaper.makeSpaceNode (_, options, item)
   local width
   if SILE.settings:get("shaper.variablespaces") then
      width = shapespace(item.width)
   else
      width = SILE.shaper:measureSpace(options)
   end
   return SILE.types.node.glue(width)
end

function shaper.debugVersions (_) end

return shaper

1	--- SILE shaper class.
2	-- @interfaces shapers
3
4	-- local smallTokenSize = 20 -- Small words will be cached
5	-- local shapeCache = {}
6	-- local _key = function (options)
7	-- return table.concat({ options.family;options.language;options.script;options.size;("%d"):format(options.weight);options.style;options.variant;options.features;options.variations;options.direction;options.filename }, ";")
8	-- end
9
10	SILE.settings:declare({ parameter = "shaper.variablespaces", type = "boolean", default = true })	95✔
11	SILE.settings:declare({ parameter = "shaper.spaceenlargementfactor", type = "number or integer", default = 1 })	95✔
12	SILE.settings:declare({ parameter = "shaper.spacestretchfactor", type = "number or integer", default = 1 / 2 })	95✔
13	SILE.settings:declare({ parameter = "shaper.spaceshrinkfactor", type = "number or integer", default = 1 / 3 })	95✔
14
15	SILE.settings:declare({	95✔
16	parameter = "shaper.tracking",
17	type = "number or nil",
18	default = nil,
19	})
20
21	-- Function for testing shaping in the repl
22	-- luacheck: ignore makenodes
23	-- TODO, figure out a way to explicitly register things in the repl env
24	makenodes = function (token, options)
25	return SILE.shaper:createNnodes(token, SILE.font.loadDefaults(options or {}))	×
26	end
27
28	local function shapespace (spacewidth)
29	spacewidth = SU.cast("measurement", spacewidth)	7,878✔
30	-- In some scripts with word-level kerning, glue can be negative.
31	-- Use absolute value to ensure stretch and shrink work as expected.
32	local absoluteSpaceWidth = math.abs(spacewidth:tonumber())	7,878✔
33	local length = spacewidth * SILE.settings:get("shaper.spaceenlargementfactor")	7,878✔
34	local stretch = absoluteSpaceWidth * SILE.settings:get("shaper.spacestretchfactor")	7,878✔
35	local shrink = absoluteSpaceWidth * SILE.settings:get("shaper.spaceshrinkfactor")	7,878✔
36	return SILE.types.length(length, stretch, shrink)	3,939✔
37	end
38
39	local shaper = pl.class()	95✔
40	shaper.type = "shaper"	95✔
41	shaper._name = "base"	95✔
42
43	-- Return the length of a space character
44	-- with a particular set of font options,
45	-- giving preference to document.spaceskip
46	-- Caching this has no significant speedup
47	function shaper:measureSpace (options)	95✔
48	local ss = SILE.settings:get("document.spaceskip")	31✔
49	if ss then	31✔
50	SILE.settings:temporarily(function ()	×
51	SILE.settings:set("font.size", options.size)	×
52	SILE.settings:set("font.family", options.family)	×
53	SILE.settings:set("font.filename", options.filename)	×
54	ss = ss:absolute()	×
55	end)
56	return ss	×
57	end
58	local items, width = self:shapeToken(" ", options)	31✔
59	if not width and not items[1] then	31✔
60	SU.warn("Could not measure the width of a space")	×
61	return SILE.types.length()	×
62	end
63	return shapespace(width and width.length or items[1].width)	31✔
64	end
65
66	function shaper:measureChar (char)	95✔
67	local options = SILE.font.loadDefaults({})	2,217✔
68	options.tracking = SILE.settings:get("shaper.tracking")	4,434✔
69	local items = self:shapeToken(char, options)	2,217✔
70	if #items > 0 then	2,217✔
71	return { height = items[1].height, width = items[1].width }	2,217✔
72	else
73	SU.error("Unable to measure character", char)	×
74	end
75	end
76
77	-- Given a text and some font options, return a bunch of boxes
78	function shaper.shapeToken (_, _, _)	95✔
79	SU.error("Abstract function shapeToken called", true)	×
80	end
81
82	-- Given font options, select a font. We will handle
83	-- caching here. Returns an arbitrary, implementation-specific
84	-- object (ie a PAL for Pango, font number for libtexpdf, ...)
85	function shaper.getFace (_)	95✔
86	SU.error("Abstract function getFace called", true)	×
87	end
88
89	function shaper.addShapedGlyphToNnodeValue (_, _, _)	95✔
90	SU.error("Abstract function addShapedGlyphToNnodeValue called", true)	×
91	end
92
93	function shaper.preAddNodes (_, _, _) end	95✔
94
95	function shaper:createNnodes (token, options)	95✔
96	options.tracking = SILE.settings:get("shaper.tracking")	12,700✔
97	local items, _ = self:shapeToken(token, options)	6,350✔
98	if #items < 1 then	6,350✔
99	return {}	×
100	end
101	local lang = options.language	6,350✔
102	SILE.languageSupport.loadLanguage(lang)	6,350✔
103	local nodeMaker = SILE.nodeMakers[lang] or SILE.nodeMakers.unicode	6,350✔
104	local nodes = {}	6,350✔
105	for node in nodeMaker(options):iterator(items, token) do	33,769✔
106	table.insert(nodes, node)	14,719✔
107	end
108	return nodes	6,350✔
109	end
110
111	function shaper:formNnode (contents, token, options)	95✔
112	local nnodeContents = {}	10,623✔
113	-- local glyphs = {}
114	local totalWidth = 0	10,623✔
115	local totalDepth = 0	10,623✔
116	local totalHeight = 0	10,623✔
117	-- local glyphNames = {}
118	local nnodeValue = { text = token, options = options, glyphString = {} }	10,623✔
119	SILE.shaper:preAddNodes(contents, nnodeValue)	10,623✔
120	local misfit = false	10,623✔
121	if SILE.typesetter.frame and SILE.typesetter.frame:writingDirection() == "TTB" then	21,246✔
122	if options.direction == "LTR" then	2✔
123	misfit = true	×
124	end
125	else
126	if options.direction == "TTB" then	10,621✔
127	misfit = true	×
128	end
129	end
130	for i = 1, #contents do	43,044✔
131	local glyph = contents[i]	32,421✔
132	if (options.direction == "TTB") ~= misfit then	32,421✔
133	if glyph.width > totalHeight then	2✔
134	totalHeight = glyph.width	2✔
135	end
136	totalWidth = totalWidth + glyph.height	2✔
137	else
138	if glyph.depth > totalDepth then	32,419✔
139	totalDepth = glyph.depth	9,351✔
140	end
141	if glyph.height > totalHeight then	32,419✔
142	totalHeight = glyph.height	13,932✔
143	end
144	totalWidth = totalWidth + glyph.width	32,419✔
145	end
146	self:addShapedGlyphToNnodeValue(nnodeValue, glyph)	32,421✔
147	end
148	table.insert(	21,246✔
149	nnodeContents,	10,623✔
150	SILE.types.node.hbox({	21,246✔
151	depth = totalDepth,	10,623✔
152	height = totalHeight,	10,623✔
153	misfit = misfit,	10,623✔
154	width = SILE.types.length(totalWidth),	21,246✔
155	value = nnodeValue,	10,623✔
156	})
157	)
158	return SILE.types.node.nnode({	10,623✔
159	nodes = nnodeContents,	10,623✔
160	text = token,	10,623✔
161	misfit = misfit,	10,623✔
162	options = options,	10,623✔
163	language = options.language,	10,623✔
164	})	10,623✔
165	end
166
167	function shaper.makeSpaceNode (_, options, item)	95✔
168	local width
169	if SILE.settings:get("shaper.variablespaces") then	7,816✔
170	width = shapespace(item.width)	7,816✔
171	else
172	width = SILE.shaper:measureSpace(options)	×
173	end
174	return SILE.types.node.glue(width)	3,908✔
175	end
176
177	function shaper.debugVersions (_) end	95✔
178
179	return shaper	95✔

sile-typesetter / sile / 9688261573

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