11827188491

Committed 13 Nov 2024 10:24PM UTC coverage: 33.179% (-27.8%) from 61.013%

Build # 11827188491

Build Type

push

github

Committed by

alerque

Commit Message

chore(deps): Bump Nix flake dependencies

Run Details

5947 of 17924 relevant lines covered (33.18%)

1920.63 hits per line

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

81.82

/core/settings.lua

--- core settings instance
--- @module SILE.settings

local deprecator = function ()
   SU.deprecated("SILE.settings.*", "SILE.settings:*", "0.13.0", "0.15.0")
end

--- @type settings
local settings = pl.class()

function settings:_init ()
   self.state = {}
   self.declarations = {}
   self.stateQueue = {}
   self.defaults = {}
   self.hooks = {}

   self:declare({
      parameter = "document.language",
      type = "string",
      default = "en",
      hook = function (language)
         if SILE.scratch.loaded_languages and not SILE.scratch.loaded_languages[language] then
            SU.warn(([[
               Setting document.language to '%s', but support for '%s' has not been loaded

               Consider invoking \language[main=%s] which loads language support before
               setting it or manually calling SILE.languageSupport.loadLanguage("%s").
            ]]):format(language, language, language, language))
         end
         fluent:set_locale(language)
      end,
      help = "Locale for localized language support",
   })

   self:declare({
      parameter = "document.parindent",
      type = "glue",
      default = SILE.types.node.glue("1bs"),
      help = "Glue at start of paragraph",
   })

   self:declare({
      parameter = "document.baselineskip",
      type = "vglue",
      default = SILE.types.node.vglue("1.2em plus 1pt"),
      help = "Leading",
   })

   self:declare({
      parameter = "document.lineskip",
      type = "vglue",
      default = SILE.types.node.vglue("1pt"),
      help = "Leading",
   })

   self:declare({
      parameter = "document.parskip",
      type = "vglue",
      default = SILE.types.node.vglue("0pt plus 1pt"),
      help = "Leading",
   })

   self:declare({
      parameter = "document.spaceskip",
      type = "length or nil",
      default = nil,
      help = "The length of a space (if nil, then measured from the font)",
   })

   self:declare({
      parameter = "document.rskip",
      type = "glue or nil",
      default = nil,
      help = "Skip to be added to right side of line",
   })

   self:declare({
      parameter = "document.lskip",
      type = "glue or nil",
      default = nil,
      help = "Skip to be added to left side of line",
   })

   self:declare({
      parameter = "document.zenkakuchar",
      default = "あ",
      type = "string",
      help = "The character measured to determine the length of a zenkaku width (全角幅)",
   })

   SILE.registerCommand(
      "set",
      function (options, content)
         local makedefault = SU.boolean(options.makedefault, false)
         local reset = SU.boolean(options.reset, false)
         local value = options.value
         if content and (type(content) == "function" or content[1]) then
            if makedefault then
               SU.warn(
                  "Are you sure meant to set default settings *and* pass content to ostensibly apply them to temporarily?"
               )
            end
            self:temporarily(function ()
               if options.parameter then
                  local parameter = SU.required(options, "parameter", "\\set command")
                  self:set(parameter, value, makedefault, reset)
               end
               SILE.process(content)
            end)
         else
            local parameter = SU.required(options, "parameter", "\\set command")
            self:set(parameter, value, makedefault, reset)
         end
      end,
      "Set a SILE parameter <parameter> to value <value> (restoring the value afterwards if <content> is provided)",
      nil,
      true
   )
end

--- Stash the current values of all settings in a stack to be returned to later
function settings:pushState ()
   if not self then
      return deprecator()
   end
   table.insert(self.stateQueue, self.state)
   self.state = pl.tablex.copy(self.state)
end

--- Return the most recently pushed set of values in the setting stack
function settings:popState ()
   if not self then
      return deprecator()
   end
   local previous = self.state
   self.state = table.remove(self.stateQueue)
   for parameter, oldvalue in pairs(previous) do
      if self.hooks[parameter] then
         local newvalue = self.state[parameter]
         if oldvalue ~= newvalue then
            self:runHooks(parameter, newvalue)
         end
      end
   end
end

--- Declare a new setting
--- @tparam table specs { parameter, type, default, help, hook, ... } declaration specification
function settings:declare (spec)
   if not spec then
      return deprecator()
   end
   if spec.name then
      SU.deprecated(
         "'name' argument of SILE.settings:declare",
         "'parameter' argument of SILE.settings:declare",
         "0.10.10",
         "0.11.0"
      )
   end
   if self.declarations[spec.parameter] then
      SU.debug("settings", "Attempt to re-declare setting:", spec.parameter)
      return
   end
   self.declarations[spec.parameter] = spec
   self.hooks[spec.parameter] = {}
   if spec.hook then
      self:registerHook(spec.parameter, spec.hook)
   end
   self:set(spec.parameter, spec.default, true)
end

--- Reset all settings to their registered default values.
function settings:reset ()
   if not self then
      return deprecator()
   end
   for k, _ in pairs(self.state) do
      self:set(k, self.defaults[k])
   end
end

--- Restore all settings to the value they had in the top-level state,
-- that is at the tap of the settings stack (normally the document level).
function settings:toplevelState ()
   if not self then
      return deprecator()
   end
   if #self.stateQueue ~= 0 then
      for parameter, _ in pairs(self.state) do
         -- Bypass self:set() as the latter performs some tests and a cast,
         -- but the setting might not have been defined in the top level state
         -- (in which case, assume the default value).
         self.state[parameter] = self.stateQueue[1][parameter] or self.defaults[parameter]
      end
   end
end

--- Get the value of a setting
-- @tparam string parameter The full name of the setting to fetch.
-- @return Value of setting
function settings:get (parameter)
   -- HACK FIXME https://github.com/sile-typesetter/sile/issues/1699
   -- See comment on set() below.
   if parameter == "current.parindent" then
      return SILE.typesetter and SILE.typesetter.state.parindent
   end
   if not parameter then
      return deprecator()
   end
   if not self.declarations[parameter] then
      SU.error("Undefined setting '" .. parameter .. "'")
   end
   if type(self.state[parameter]) ~= "nil" then
      return self.state[parameter]
   else
      return self.defaults[parameter]
   end
end

--- Set the value of a setting
-- @tparam string parameter The full name of the setting to change.
-- @param value The new value to change it to.
-- @tparam[opt=false] boolean makedefault Whether to make this the new default value.
-- @tparam[opt=false] boolean reset Whether to reset the value to the current default value.
function settings:set (parameter, value, makedefault, reset)
   -- HACK FIXME https://github.com/sile-typesetter/sile/issues/1699
   -- Anything dubbed current.xxx should likely NOT be a "setting" (subject
   -- to being pushed/popped via temporary stacking) and actually has its
   -- own lifecycle (e.g. reset for the next paragraph).
   -- These should be rather typesetter states, or something to that extent
   -- yet to clarify. Notably, current.parindent falls in that category,
   -- BUT probably current.hangAfter and current.hangIndent too.
   -- To avoid breaking too much code yet without being sure of the solution,
   -- we implement a hack of sorts for current.parindent only.
   -- Note moreover that current.parindent is currently probably a bad concept
   -- anyway:
   --   - It can be nil (= document.parindent applies)
   --   - It can be a zero-glue (\noindent, ragged environments, etc.)
   --   - It can be a valued glue set to document.parindent
   --     (e.g. from \indent, and document.parindent thus applies)
   --   - It could be another valued glue (uh, use case to ascertain)
   -- What we would _likely_ only need to track is whether document.parindent
   -- applies or not on the paragraph just composed afterwards...
   if parameter == "current.parindent" then
      if SILE.typesetter and not SILE.typesetter.state.hmodeOnly then
         SILE.typesetter.state.parindent = SU.cast("glue or nil", value)
      end
      return
   end
   if type(self) ~= "table" then
      return deprecator()
   end
   if not self.declarations[parameter] then
      SU.error("Undefined setting '" .. parameter .. "'")
   end
   if reset then
      if makedefault then
         SU.error("Can't set a new default and revert to and old default setting at the same time")
      end
      value = self.defaults[parameter]
   else
      value = SU.cast(self.declarations[parameter].type, value)
   end
   self.state[parameter] = value
   if makedefault then
      self.defaults[parameter] = value
   end
   self:runHooks(parameter, value)
end

--- Register a callback hook to be run when a setting changes.
-- @tparam string parameter Name of the setting to add a hook to.
-- @tparam function func Callback function accepting one argument (the new value).
function settings:registerHook (parameter, func)
   table.insert(self.hooks[parameter], func)
end

--- Trigger execution of callback hooks for a given setting.
-- @tparam string parameter The name of the parameter changes.
-- @param value The new value of the setting, passed as the first argument to the hook function.
function settings:runHooks (parameter, value)
   if self.hooks[parameter] then
      for _, func in ipairs(self.hooks[parameter]) do
         SU.debug("classhooks", "Running setting hook for", parameter)
         func(value)
      end
   end
end

--- Isolate a block of processing so that setting changes made during the block don't last past the block.
-- (Under the hood this just uses `:pushState()`, the processes the function, then runs `:popState()`)
-- @tparam function func A function wrapping the actions to take without affecting settings for future use.
function settings:temporarily (func)
   if not func then
      return deprecator()
   end
   self:pushState()
   func()
   self:popState()
end

--- Create a settings wrapper function that applies current settings to later content processing.
--- @treturn function a closure function accepting one argument (content) to process using
--- typesetter settings as they are at the time of closure creation.
function settings:wrap ()
   if not self then
      return deprecator()
   end
   local clSettings = pl.tablex.copy(self.state)
   return function (content)
      table.insert(self.stateQueue, self.state)
      self.state = clSettings
      SILE.process(content)
      self:popState()
   end
end

return settings

1	--- core settings instance
2	--- @module SILE.settings
3
4	local deprecator = function ()
5	SU.deprecated("SILE.settings.", "SILE.settings:", "0.13.0", "0.15.0")	×
6	end
7
8	--- @type settings
9	local settings = pl.class()	124✔
10
11	function settings:_init ()	124✔
12	self.state = {}	124✔
13	self.declarations = {}	124✔
14	self.stateQueue = {}	124✔
15	self.defaults = {}	124✔
16	self.hooks = {}	124✔
17
18	self:declare({	248✔
19	parameter = "document.language",
20	type = "string",
21	default = "en",
22	hook = function (language)
23	if SILE.scratch.loaded_languages and not SILE.scratch.loaded_languages[language] then	573✔
24	SU.warn(([[	18✔
25	Setting document.language to '%s', but support for '%s' has not been loaded
26
27	Consider invoking \language[main=%s] which loads language support before
28	setting it or manually calling SILE.languageSupport.loadLanguage("%s").
29	]]):format(language, language, language, language))	9✔
30	end
31	fluent:set_locale(language)	573✔
32	end,
33	help = "Locale for localized language support",
34	})
35
36	self:declare({	248✔
37	parameter = "document.parindent",
38	type = "glue",
39	default = SILE.types.node.glue("1bs"),	372✔
40	help = "Glue at start of paragraph",
41	})
42
43	self:declare({	248✔
44	parameter = "document.baselineskip",
45	type = "vglue",
46	default = SILE.types.node.vglue("1.2em plus 1pt"),	248✔
47	help = "Leading",
48	})
49
50	self:declare({	248✔
51	parameter = "document.lineskip",
52	type = "vglue",
53	default = SILE.types.node.vglue("1pt"),	248✔
54	help = "Leading",
55	})
56
57	self:declare({	248✔
58	parameter = "document.parskip",
59	type = "vglue",
60	default = SILE.types.node.vglue("0pt plus 1pt"),	248✔
61	help = "Leading",
62	})
63
64	self:declare({	124✔
65	parameter = "document.spaceskip",
66	type = "length or nil",
67	default = nil,
68	help = "The length of a space (if nil, then measured from the font)",
69	})
70
71	self:declare({	124✔
72	parameter = "document.rskip",
73	type = "glue or nil",
74	default = nil,
75	help = "Skip to be added to right side of line",
76	})
77
78	self:declare({	124✔
79	parameter = "document.lskip",
80	type = "glue or nil",
81	default = nil,
82	help = "Skip to be added to left side of line",
83	})
84
85	self:declare({	124✔
86	parameter = "document.zenkakuchar",
87	default = "あ",
88	type = "string",
89	help = "The character measured to determine the length of a zenkaku width (全角幅)",
90	})
91
92	SILE.registerCommand(	248✔
93	"set",	124✔
94	function (options, content)
95	local makedefault = SU.boolean(options.makedefault, false)	46✔
96	local reset = SU.boolean(options.reset, false)	46✔
97	local value = options.value	46✔
98	if content and (type(content) == "function" or content[1]) then	46✔
99	if makedefault then	8✔
100	SU.warn(	×
101	"Are you sure meant to set default settings and pass content to ostensibly apply them to temporarily?"
102	)
103	end
104	self:temporarily(function ()	16✔
105	if options.parameter then	8✔
106	local parameter = SU.required(options, "parameter", "\\set command")	8✔
107	self:set(parameter, value, makedefault, reset)	8✔
108	end
109	SILE.process(content)	8✔
110	end)
111	else
112	local parameter = SU.required(options, "parameter", "\\set command")	38✔
113	self:set(parameter, value, makedefault, reset)	38✔
114	end
115	end,
116	"Set a SILE parameter <parameter> to value <value> (restoring the value afterwards if <content> is provided)",	124✔
117	nil,	124✔
118	true
119	)	124✔
120	end
121
122	--- Stash the current values of all settings in a stack to be returned to later
123	function settings:pushState ()	124✔
124	if not self then	673✔
125	return deprecator()	×
126	end
127	table.insert(self.stateQueue, self.state)	673✔
128	self.state = pl.tablex.copy(self.state)	1,346✔
129	end
130
131	--- Return the most recently pushed set of values in the setting stack
132	function settings:popState ()	124✔
133	if not self then	673✔
134	return deprecator()	×
135	end
136	local previous = self.state	673✔
137	self.state = table.remove(self.stateQueue)	1,346✔
138	for parameter, oldvalue in pairs(previous) do	37,119✔
139	if self.hooks[parameter] then	36,446✔
140	local newvalue = self.state[parameter]	36,446✔
141	if oldvalue ~= newvalue then	36,446✔
142	self:runHooks(parameter, newvalue)	972✔
143	end
144	end
145	end
146	end
147
148	--- Declare a new setting
149	--- @tparam table specs { parameter, type, default, help, hook, ... } declaration specification
150	function settings:declare (spec)	124✔
151	if not spec then	6,728✔
152	return deprecator()	×
153	end
154	if spec.name then	6,728✔
155	SU.deprecated(	×
156	"'name' argument of SILE.settings:declare",
157	"'parameter' argument of SILE.settings:declare",
158	"0.10.10",
159	"0.11.0"
160	)
161	end
162	if self.declarations[spec.parameter] then	6,728✔
163	SU.debug("settings", "Attempt to re-declare setting:", spec.parameter)	676✔
164	return	676✔
165	end
166	self.declarations[spec.parameter] = spec	6,052✔
167	self.hooks[spec.parameter] = {}	6,052✔
168	if spec.hook then	6,052✔
169	self:registerHook(spec.parameter, spec.hook)	124✔
170	end
171	self:set(spec.parameter, spec.default, true)	6,052✔
172	end
173
174	--- Reset all settings to their registered default values.
175	function settings:reset ()	124✔
176	if not self then	×
177	return deprecator()	×
178	end
179	for k, _ in pairs(self.state) do	×
180	self:set(k, self.defaults[k])	×
181	end
182	end
183
184	--- Restore all settings to the value they had in the top-level state,
185	-- that is at the tap of the settings stack (normally the document level).
186	function settings:toplevelState ()	124✔
187	if not self then	54✔
188	return deprecator()	×
189	end
190	if #self.stateQueue ~= 0 then	54✔
191	for parameter, _ in pairs(self.state) do	2,826✔
192	-- Bypass self:set() as the latter performs some tests and a cast,
193	-- but the setting might not have been defined in the top level state
194	-- (in which case, assume the default value).
195	self.state[parameter] = self.stateQueue[1][parameter] or self.defaults[parameter]	2,772✔
196	end
197	end
198	end
199
200	--- Get the value of a setting
201	-- @tparam string parameter The full name of the setting to fetch.
202	-- @return Value of setting
203	function settings:get (parameter)	124✔
204	-- HACK FIXME https://github.com/sile-typesetter/sile/issues/1699
205	-- See comment on set() below.
206	if parameter == "current.parindent" then	122,200✔
207	return SILE.typesetter and SILE.typesetter.state.parindent	640✔
208	end
209	if not parameter then	121,560✔
210	return deprecator()	×
211	end
212	if not self.declarations[parameter] then	121,560✔
213	SU.error("Undefined setting '" .. parameter .. "'")	×
214	end
215	if type(self.state[parameter]) ~= "nil" then	121,560✔
216	return self.state[parameter]	86,297✔
217	else
218	return self.defaults[parameter]	35,263✔
219	end
220	end
221
222	--- Set the value of a setting
223	-- @tparam string parameter The full name of the setting to change.
224	-- @param value The new value to change it to.
225	-- @tparam[opt=false] boolean makedefault Whether to make this the new default value.
226	-- @tparam[opt=false] boolean reset Whether to reset the value to the current default value.
227	function settings:set (parameter, value, makedefault, reset)	124✔
228	-- HACK FIXME https://github.com/sile-typesetter/sile/issues/1699
229	-- Anything dubbed current.xxx should likely NOT be a "setting" (subject
230	-- to being pushed/popped via temporary stacking) and actually has its
231	-- own lifecycle (e.g. reset for the next paragraph).
232	-- These should be rather typesetter states, or something to that extent
233	-- yet to clarify. Notably, current.parindent falls in that category,
234	-- BUT probably current.hangAfter and current.hangIndent too.
235	-- To avoid breaking too much code yet without being sure of the solution,
236	-- we implement a hack of sorts for current.parindent only.
237	-- Note moreover that current.parindent is currently probably a bad concept
238	-- anyway:
239	-- - It can be nil (= document.parindent applies)
240	-- - It can be a zero-glue (\noindent, ragged environments, etc.)
241	-- - It can be a valued glue set to document.parindent
242	-- (e.g. from \indent, and document.parindent thus applies)
243	-- - It could be another valued glue (uh, use case to ascertain)
244	-- What we would _likely_ only need to track is whether document.parindent
245	-- applies or not on the paragraph just composed afterwards...
246	if parameter == "current.parindent" then	12,318✔
247	if SILE.typesetter and not SILE.typesetter.state.hmodeOnly then	977✔
248	SILE.typesetter.state.parindent = SU.cast("glue or nil", value)	1,828✔
249	end
250	return	977✔
251	end
252	if type(self) ~= "table" then	11,341✔
253	return deprecator()	×
254	end
255	if not self.declarations[parameter] then	11,341✔
256	SU.error("Undefined setting '" .. parameter .. "'")	×
257	end
258	if reset then	11,341✔
259	if makedefault then	4✔
260	SU.error("Can't set a new default and revert to and old default setting at the same time")	×
261	end
262	value = self.defaults[parameter]	4✔
263	else
264	value = SU.cast(self.declarations[parameter].type, value)	22,674✔
265	end
266	self.state[parameter] = value	11,341✔
267	if makedefault then	11,341✔
268	self.defaults[parameter] = value	6,075✔
269	end
270	self:runHooks(parameter, value)	11,341✔
271	end
272
273	--- Register a callback hook to be run when a setting changes.
274	-- @tparam string parameter Name of the setting to add a hook to.
275	-- @tparam function func Callback function accepting one argument (the new value).
276	function settings:registerHook (parameter, func)	124✔
277	table.insert(self.hooks[parameter], func)	124✔
278	end
279
280	--- Trigger execution of callback hooks for a given setting.
281	-- @tparam string parameter The name of the parameter changes.
282	-- @param value The new value of the setting, passed as the first argument to the hook function.
283	function settings:runHooks (parameter, value)	124✔
284	if self.hooks[parameter] then	12,313✔
285	for _, func in ipairs(self.hooks[parameter]) do	12,886✔
286	SU.debug("classhooks", "Running setting hook for", parameter)	573✔
287	func(value)	573✔
288	end
289	end
290	end
291
292	--- Isolate a block of processing so that setting changes made during the block don't last past the block.
293	-- (Under the hood this just uses `:pushState()`, the processes the function, then runs `:popState()`)
294	-- @tparam function func A function wrapping the actions to take without affecting settings for future use.
295	function settings:temporarily (func)	124✔
296	if not func then	561✔
297	return deprecator()	×
298	end
299	self:pushState()	561✔
300	func()	561✔
301	self:popState()	561✔
302	end
303
304	--- Create a settings wrapper function that applies current settings to later content processing.
305	--- @treturn function a closure function accepting one argument (content) to process using
306	--- typesetter settings as they are at the time of closure creation.
307	function settings:wrap ()	124✔
308	if not self then	×
309	return deprecator()	×
310	end
311	local clSettings = pl.tablex.copy(self.state)	×
312	return function (content)
313	table.insert(self.stateQueue, self.state)	×
314	self.state = clSettings	×
315	SILE.process(content)	×
316	self:popState()	×
317	end
318	end
319
320	return settings	124✔

sile-typesetter / sile / 11827188491

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