7299766145

Committed 22 Dec 2023 12:17PM UTC coverage: 73.971% (-0.8%) from 74.723%

Build # 7299766145

Build Type

push

github

Committed by

alerque

Commit Message

docs(readme): Freshed info and copy edit a bunch of sections

Run Details

11748 of 15882 relevant lines covered (73.97%)

7076.46 hits per line

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

84.21

/shapers/base.lua

-- 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.2 })
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.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.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.nodefactory.hbox({
        depth = totalDepth,
        height = totalHeight,
        misfit = misfit,
        width = SILE.length(totalWidth),
        value = nnodeValue
    }))
  return SILE.nodefactory.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.nodefactory.glue(width)
end

function shaper.debugVersions (_) end

return shaper

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

sile-typesetter / sile / 7299766145

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