13926883392

Committed 18 Mar 2025 03:18PM UTC coverage: 53.713% (+22.2%) from 31.52%

Build # 13926883392

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #2193 from alerque/measure-char

Warn when asked to measure a character not shaped in a font

Run Details

11 of 14 new or added lines in 4 files covered. (78.57%)

542 existing lines in 23 files now uncovered.

11473 of 21360 relevant lines covered (53.71%)

580.88 hits per line

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

82.55

/core/font.lua

--- font
-- @module SILE.font
local icu = require("justenoughicu")

local lastshaper

local bits = require("core.parserbits")
local lpeg = require("lpeg")
local Ct, Cg, P = lpeg.Ct, lpeg.Cg, lpeg.P
local adjust_metric = P("ex-height") + P("cap-height")
-- stylua: ignore start
local adjustment = Ct(Cg(bits.number, "amount")^-1 * bits.ws * Cg(adjust_metric, "unit"))
-- stylua: ignore end

local function measureFontAdjustment (metric)
   if metric == "ex-height" then
      -- Uses the height of lowercase letters.
      -- This is used to normalize lowercase letters across fonts.
      -- The height of the lowercase letter "x" is used as the reference.
      -- Another option would be to use the OS/2 font table sxHeight value when available.
      return SILE.shaper:measureChar("x").height
   end
   if metric == "cap-height" then
      -- Uses the the height of uppercase letters.
      -- This is used to normalize uppercase letters across fonts.
      -- The height of the uppercase letter "H" is used as the reference.
      -- Another option would be to use the OS/2 font table sCapHeight value when available.
      return SILE.shaper:measureChar("H").height
   end
   SU.error("Unknown font adjust metric " .. metric)
end

local function adjustedFontSize (options)
   local adjust = options.adjust
   local parsed = adjustment:match(adjust)
   if not parsed then
      SU.error("Couldn't parse font adjust value " .. adjust)
   end
   -- Shallow copy: we don't want to modify the original AST as content may be reused
   -- in other contexts (e.g. running headers) and may need to adapt to different font sizes.
   local baseOpts = pl.tablex.copy(options)
   baseOpts.adjust = nil -- cancel for target font size calculation
   local currentMeasure = measureFontAdjustment(parsed.unit)
   local ratio = parsed.amount or 1
   local newMeasure
   -- Apply the target font size to measure the new font
   SILE.call("font", baseOpts, function ()
      newMeasure = measureFontAdjustment(parsed.unit)
   end)
   return SILE.settings:get("font.size") * ratio * (currentMeasure / newMeasure)
end

SILE.registerCommand("font", function (options, content)
   if SU.ast.hasContent(content) then
      SILE.settings:pushState()
   end
   if options.adjust then
      if options.size then
         SU.error("Can't specify both 'size' and 'adjust' in a \\font command")
      end
      SILE.settings:set("font.size", adjustedFontSize(options))
   end
   if options.filename then
      SILE.settings:set("font.filename", options.filename)
   end
   if options.family then
      SILE.settings:set("font.family", options.family)
      SILE.settings:set("font.filename", "")
   end
   if options.size then
      local size = SU.cast("measurement", options.size)
      if not size then
         SU.error("Couldn't parse font size " .. options.size)
      end
      SILE.settings:set("font.size", size:absolute())
   end
   if options.weight then
      SILE.settings:set("font.weight", 0 + options.weight)
   end
   if options.style then
      SILE.settings:set("font.style", options.style)
   end
   if options.variant then
      SILE.settings:set("font.variant", options.variant)
   end
   if options.features then
      SILE.settings:set("font.features", options.features)
   end
   if options.variations then
      SILE.settings:set("font.variations", options.variations)
   end
   if options.direction then
      SILE.settings:set("font.direction", options.direction)
   end
   if options.language then
      if options.language ~= "und" and icu and icu.canonicalize_language then
         local newlang = icu.canonicalize_language(options.language)
         -- if newlang ~= options.language then
         -- SU.warn("Language '"..options.language.."' not canonical, '"..newlang.."' will be used instead")
         -- end
         options.language = newlang
      end
      SILE.languageSupport.loadLanguage(options.language)
      SILE.settings:set("document.language", options.language)
   end
   if options.script then
      SILE.settings:set("font.script", options.script)
   elseif SILE.settings:get("document.language") then
      local lang = SILE.languageSupport.languages[SILE.settings:get("document.language")]
      if lang and lang.defaultScript then
         SILE.settings:set("font.script", lang.defaultScript)
      end
   end
   if options.hyphenchar then
      -- must be in the form of, for example, "-" or "U+2010" or "0x2010" (Unicode hex codepoint)
      SILE.settings:set("font.hyphenchar", SU.utf8charfromcodepoint(options.hyphenchar))
   end

   -- We must *actually* load the font here, because by the time we're inside
   -- SILE.shaper.shapeToken, it's too late to respond appropriately to things
   -- that the post-load hook might want to do.
   SILE.font.cache(SILE.font.loadDefaults(options), SILE.shaper.getFace)

   if SU.ast.hasContent(content) then
      SILE.process(content)
      SILE.settings:popState()
      if SILE.shaper._name == "harfbuzzWithColor" and lastshaper then
         SU.debug("color-fonts", "Switching from color fonts shaper back to previous shaper")
         SILE.typesetter:leaveHmode(true)
         lastshaper, SILE.shaper = nil, lastshaper
      end
   end
end, "Set current font family, size, weight, style, variant, script, direction and language", nil, true)

SILE.settings:declare({ parameter = "font.family", type = "string or nil", default = "Gentium Plus" })
SILE.settings:declare({ parameter = "font.size", type = "number or integer", default = 10 })
SILE.settings:declare({ parameter = "font.weight", type = "integer", default = 400 })
SILE.settings:declare({ parameter = "font.variant", type = "string", default = "normal" })
SILE.settings:declare({ parameter = "font.script", type = "string", default = "" })
SILE.settings:declare({ parameter = "font.style", type = "string", default = "" })
SILE.settings:declare({ parameter = "font.direction", type = "string", default = "" })
SILE.settings:declare({ parameter = "font.filename", type = "string or nil", default = "" })
SILE.settings:declare({ parameter = "font.features", type = "string", default = "" })
SILE.settings:declare({ parameter = "font.variations", type = "string", default = "" })
SILE.settings:declare({ parameter = "font.hyphenchar", type = "string", default = "-" })

SILE.fontCache = {}

local _key = function (options)
   return table.concat({
      options.family,
      ("%g"):format(SILE.types.measurement(options.size):tonumber()),
      ("%d"):format(options.weight or 0),
      options.style,
      options.variant,
      options.features,
      options.variations,
      options.direction,
      options.filename,
   }, ";")
end

local font = {

   loadDefaults = function (options)
      if not options.family then
         options.family = SILE.settings:get("font.family")
      end
      if not options.size then
         options.size = SILE.settings:get("font.size")
      end
      if not options.weight then
         options.weight = SILE.settings:get("font.weight")
      end
      if not options.style then
         options.style = SILE.settings:get("font.style")
      end
      if not options.variant then
         options.variant = SILE.settings:get("font.variant")
      end
      if SILE.settings:get("font.filename") ~= "" then
         options.filename = SILE.settings:get("font.filename")
         options.family = ""
      end
      if not options.language then
         options.language = SILE.settings:get("document.language")
      end
      if not options.script then
         options.script = SILE.settings:get("font.script")
      end
      if not options.direction then
         options.direction = SILE.settings:get("font.direction")
         if not options.direction or options.direction == "" then
            options.direction = SILE.typesetter and SILE.typesetter.frame and SILE.typesetter.frame:writingDirection()
               or "LTR"
         end
      end
      if not options.features then
         options.features = SILE.settings:get("font.features")
      end
      if not options.variations then
         options.variations = SILE.settings:get("font.variations")
      end
      if not options.hyphenchar then
         options.hyphenchar = SILE.settings:get("font.hyphenchar")
      end
      return options
   end,

   cache = function (options, callback)
      local key = _key(options)
      if not SILE.fontCache[key] then
         SU.debug("fonts", "Looking for", key)
         local face = callback(options)
         SILE.fontCache[key] = face
      end
      local cached = SILE.fontCache[key]
      SILE.font.postLoadHook(cached)
      return cached
   end,

   finish = function ()
      for key, font in pairs(SILE.fontCache) do
         if font.tempfilename ~= font.filename then
            SU.debug("fonts", "Removing temporary file of", key, ":", font.tempfilename)
            os.remove(font.tempfilename)
         end
      end
   end,

   postLoadHook = function (face)
      local ot = require("core.opentype-parser")
      local font = ot.parseFont(face)
      if font.cpal then
         SILE.require("packages.color-fonts")
         if SILE.shaper._name ~= "harfbuzzWithColor" then
            SU.debug("color-fonts", "Switching to color font Shaper")
            SILE.typesetter:leaveHmode(true)
            lastshaper, SILE.shaper = SILE.shaper, SILE.shapers.harfbuzzWithColor()
         end
      end
   end,

   _key = _key,
}

return font

1	--- font
2	-- @module SILE.font
3	local icu = require("justenoughicu")	28✔
4
5	local lastshaper
6
7	local bits = require("core.parserbits")	28✔
8	local lpeg = require("lpeg")	28✔
9	local Ct, Cg, P = lpeg.Ct, lpeg.Cg, lpeg.P	28✔
10	local adjust_metric = P("ex-height") + P("cap-height")	28✔
11	-- stylua: ignore start
12	local adjustment = Ct(Cg(bits.number, "amount")^-1 * bits.ws * Cg(adjust_metric, "unit"))	28✔
13	-- stylua: ignore end
14
15	local function measureFontAdjustment (metric)
16	if metric == "ex-height" then	6✔
17	-- Uses the height of lowercase letters.
18	-- This is used to normalize lowercase letters across fonts.
19	-- The height of the lowercase letter "x" is used as the reference.
20	-- Another option would be to use the OS/2 font table sxHeight value when available.
21	return SILE.shaper:measureChar("x").height	12✔
22	end
23	if metric == "cap-height" then	×
24	-- Uses the the height of uppercase letters.
25	-- This is used to normalize uppercase letters across fonts.
26	-- The height of the uppercase letter "H" is used as the reference.
27	-- Another option would be to use the OS/2 font table sCapHeight value when available.
28	return SILE.shaper:measureChar("H").height	×
29	end
30	SU.error("Unknown font adjust metric " .. metric)	×
31	end
32
33	local function adjustedFontSize (options)
34	local adjust = options.adjust	3✔
35	local parsed = adjustment:match(adjust)	3✔
36	if not parsed then	3✔
37	SU.error("Couldn't parse font adjust value " .. adjust)	×
38	end
39	-- Shallow copy: we don't want to modify the original AST as content may be reused
40	-- in other contexts (e.g. running headers) and may need to adapt to different font sizes.
41	local baseOpts = pl.tablex.copy(options)	3✔
42	baseOpts.adjust = nil -- cancel for target font size calculation	3✔
43	local currentMeasure = measureFontAdjustment(parsed.unit)	3✔
44	local ratio = parsed.amount or 1	3✔
45	local newMeasure
46	-- Apply the target font size to measure the new font
47	SILE.call("font", baseOpts, function ()	6✔
48	newMeasure = measureFontAdjustment(parsed.unit)	6✔
49	end)
50	return SILE.settings:get("font.size") * ratio * (currentMeasure / newMeasure)	6✔
51	end
52
53	SILE.registerCommand("font", function (options, content)	56✔
54	if SU.ast.hasContent(content) then	40✔
55	SILE.settings:pushState()	13✔
56	end
57	if options.adjust then	20✔
58	if options.size then	3✔
59	SU.error("Can't specify both 'size' and 'adjust' in a \\font command")	×
60	end
61	SILE.settings:set("font.size", adjustedFontSize(options))	6✔
62	end
63	if options.filename then	20✔
UNCOV 64	SILE.settings:set("font.filename", options.filename)	×
65	end
66	if options.family then	20✔
67	SILE.settings:set("font.family", options.family)	12✔
68	SILE.settings:set("font.filename", "")	12✔
69	end
70	if options.size then	20✔
71	local size = SU.cast("measurement", options.size)	9✔
72	if not size then	9✔
73	SU.error("Couldn't parse font size " .. options.size)	×
74	end
75	SILE.settings:set("font.size", size:absolute())	18✔
76	end
77	if options.weight then	20✔
78	SILE.settings:set("font.weight", 0 + options.weight)	2✔
79	end
80	if options.style then	20✔
81	SILE.settings:set("font.style", options.style)	1✔
82	end
83	if options.variant then	20✔
UNCOV 84	SILE.settings:set("font.variant", options.variant)	×
85	end
86	if options.features then	20✔
UNCOV 87	SILE.settings:set("font.features", options.features)	×
88	end
89	if options.variations then	20✔
UNCOV 90	SILE.settings:set("font.variations", options.variations)	×
91	end
92	if options.direction then	20✔
UNCOV 93	SILE.settings:set("font.direction", options.direction)	×
94	end
95	if options.language then	20✔
96	if options.language ~= "und" and icu and icu.canonicalize_language then	1✔
97	local newlang = icu.canonicalize_language(options.language)	1✔
98	-- if newlang ~= options.language then
99	-- SU.warn("Language '"..options.language.."' not canonical, '"..newlang.."' will be used instead")
100	-- end
101	options.language = newlang	1✔
102	end
103	SILE.languageSupport.loadLanguage(options.language)	1✔
104	SILE.settings:set("document.language", options.language)	1✔
105	end
106	if options.script then	20✔
UNCOV 107	SILE.settings:set("font.script", options.script)	×
108	elseif SILE.settings:get("document.language") then	40✔
109	local lang = SILE.languageSupport.languages[SILE.settings:get("document.language")]	40✔
110	if lang and lang.defaultScript then	20✔
UNCOV 111	SILE.settings:set("font.script", lang.defaultScript)	×
112	end
113	end
114	if options.hyphenchar then	20✔
115	-- must be in the form of, for example, "-" or "U+2010" or "0x2010" (Unicode hex codepoint)
UNCOV 116	SILE.settings:set("font.hyphenchar", SU.utf8charfromcodepoint(options.hyphenchar))	×
117	end
118
119	-- We must actually load the font here, because by the time we're inside
120	-- SILE.shaper.shapeToken, it's too late to respond appropriately to things
121	-- that the post-load hook might want to do.
122	SILE.font.cache(SILE.font.loadDefaults(options), SILE.shaper.getFace)	40✔
123
124	if SU.ast.hasContent(content) then	40✔
125	SILE.process(content)	13✔
126	SILE.settings:popState()	13✔
127	if SILE.shaper._name == "harfbuzzWithColor" and lastshaper then	13✔
UNCOV 128	SU.debug("color-fonts", "Switching from color fonts shaper back to previous shaper")	×
UNCOV 129	SILE.typesetter:leaveHmode(true)	×
UNCOV 130	lastshaper, SILE.shaper = nil, lastshaper	×
131	end
132	end
133	end, "Set current font family, size, weight, style, variant, script, direction and language", nil, true)	48✔
134
135	SILE.settings:declare({ parameter = "font.family", type = "string or nil", default = "Gentium Plus" })	28✔
136	SILE.settings:declare({ parameter = "font.size", type = "number or integer", default = 10 })	28✔
137	SILE.settings:declare({ parameter = "font.weight", type = "integer", default = 400 })	28✔
138	SILE.settings:declare({ parameter = "font.variant", type = "string", default = "normal" })	28✔
139	SILE.settings:declare({ parameter = "font.script", type = "string", default = "" })	28✔
140	SILE.settings:declare({ parameter = "font.style", type = "string", default = "" })	28✔
141	SILE.settings:declare({ parameter = "font.direction", type = "string", default = "" })	28✔
142	SILE.settings:declare({ parameter = "font.filename", type = "string or nil", default = "" })	28✔
143	SILE.settings:declare({ parameter = "font.features", type = "string", default = "" })	28✔
144	SILE.settings:declare({ parameter = "font.variations", type = "string", default = "" })	28✔
145	SILE.settings:declare({ parameter = "font.hyphenchar", type = "string", default = "-" })	28✔
146
147	SILE.fontCache = {}	28✔
148
149	local _key = function (options)
150	return table.concat({	3,658✔
151	options.family,	3,658✔
152	("%g"):format(SILE.types.measurement(options.size):tonumber()),	10,974✔
153	("%d"):format(options.weight or 0),	3,658✔
154	options.style,	3,658✔
155	options.variant,	3,658✔
156	options.features,	3,658✔
157	options.variations,	3,658✔
158	options.direction,	3,658✔
159	options.filename,	3,658✔
160	}, ";")	3,658✔
161	end
162
163	local font = {	28✔
164
165	loadDefaults = function (options)
166	if not options.family then	473✔
167	options.family = SILE.settings:get("font.family")	454✔
168	end
169	if not options.size then	473✔
170	options.size = SILE.settings:get("font.size")	460✔
171	end
172	if not options.weight then	473✔
173	options.weight = SILE.settings:get("font.weight")	506✔
174	end
175	if not options.style then	473✔
176	options.style = SILE.settings:get("font.style")	508✔
177	end
178	if not options.variant then	473✔
179	options.variant = SILE.settings:get("font.variant")	946✔
180	end
181	if SILE.settings:get("font.filename") ~= "" then	946✔
UNCOV 182	options.filename = SILE.settings:get("font.filename")	×
UNCOV 183	options.family = ""	×
184	end
185	if not options.language then	473✔
186	options.language = SILE.settings:get("document.language")	912✔
187	end
188	if not options.script then	473✔
189	options.script = SILE.settings:get("font.script")	510✔
190	end
191	if not options.direction then	473✔
192	options.direction = SILE.settings:get("font.direction")	946✔
193	if not options.direction or options.direction == "" then	473✔
194	options.direction = SILE.typesetter and SILE.typesetter.frame and SILE.typesetter.frame:writingDirection()	471✔
195	or "LTR"	471✔
196	end
197	end
198	if not options.features then	473✔
199	options.features = SILE.settings:get("font.features")	946✔
200	end
201	if not options.variations then	473✔
202	options.variations = SILE.settings:get("font.variations")	946✔
203	end
204	if not options.hyphenchar then	473✔
205	options.hyphenchar = SILE.settings:get("font.hyphenchar")	946✔
206	end
207	return options	473✔
208	end,
209
210	cache = function (options, callback)
211	local key = _key(options)	611✔
212	if not SILE.fontCache[key] then	611✔
213	SU.debug("fonts", "Looking for", key)	31✔
214	local face = callback(options)	31✔
215	SILE.fontCache[key] = face	31✔
216	end
217	local cached = SILE.fontCache[key]	611✔
218	SILE.font.postLoadHook(cached)	611✔
219	return cached	611✔
220	end,
221
222	finish = function ()
223	for key, font in pairs(SILE.fontCache) do	47✔
224	if font.tempfilename ~= font.filename then	31✔
225	SU.debug("fonts", "Removing temporary file of", key, ":", font.tempfilename)	×
226	os.remove(font.tempfilename)	×
227	end
228	end
229	end,
230
231	postLoadHook = function (face)
232	local ot = require("core.opentype-parser")	611✔
233	local font = ot.parseFont(face)	611✔
234	if font.cpal then	611✔
UNCOV 235	SILE.require("packages.color-fonts")	×
UNCOV 236	if SILE.shaper._name ~= "harfbuzzWithColor" then	×
UNCOV 237	SU.debug("color-fonts", "Switching to color font Shaper")	×
UNCOV 238	SILE.typesetter:leaveHmode(true)	×
UNCOV 239	lastshaper, SILE.shaper = SILE.shaper, SILE.shapers.harfbuzzWithColor()	×
240	end
241	end
242	end,
243
244	_key = _key,	28✔
245	}
246
247	return font	28✔

sile-typesetter / sile / 13926883392

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