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

86.36

/types/length.lua

--- SILE length type.
-- Lengths are composed of 3 `measurement`s: a length, a stretch, and a shrink. Each part internally is just
-- a measurement, but combined describe a flexible length that is allowed to grow up to the amout defined by stretch or
-- compress up to the amount defined by shrink.
-- @types length

local function _error_if_not_number (a)
   if type(a) ~= "number" then
      SU.error("We tried to do impossible arithmetic on a " .. SU.type(a) .. ". (That's a bug)", true)
   end
end

--- @type length
local length = pl.class()
length.type = "length"

length.length = nil
length.stretch = nil
length.shrink = nil

--- Constructor.
-- @tparam measurement spec A measurement or value that can be cast to a measurement.
-- @tparam[opt=0] measurement stretch A measurement describing how much the length is allowed to grow.
-- @tparam[opt=0] measurement shrink A measurement describing how much the length is allowed to grow.
-- @treturn length
-- @usage
-- SILE.types.length("6em", "4pt", "2pt")
-- SILE.types.length("6em plus 4pt minus 2pt")
-- SILE.types.length(30, 4, 2)
function length:_init (spec, stretch, shrink)
   if stretch or shrink then
      self.length = SILE.types.measurement(spec or 0)
      self.stretch = SILE.types.measurement(stretch or 0)
      self.shrink = SILE.types.measurement(shrink or 0)
   elseif type(spec) == "number" then
      self.length = SILE.types.measurement(spec)
   elseif SU.type(spec) == "measurement" then
      self.length = spec
   elseif SU.type(spec) == "glue" then
      self.length = SILE.types.measurement(spec.width.length or 0)
      self.stretch = SILE.types.measurement(spec.width.stretch or 0)
      self.shrink = SILE.types.measurement(spec.width.shrink or 0)
   elseif type(spec) == "table" then
      self.length = SILE.types.measurement(spec.length or 0)
      self.stretch = SILE.types.measurement(spec.stretch or 0)
      self.shrink = SILE.types.measurement(spec.shrink or 0)
   elseif type(spec) == "string" then
      local amount = tonumber(spec)
      if type(amount) == "number" then
         self:_init(amount)
      else
         local parsed = SILE.parserBits.length:match(spec)
         if not parsed then
            SU.error("Could not parse length '" .. spec .. "'")
         end
         self:_init(parsed)
      end
   end
   if not self.length then
      self.length = SILE.types.measurement()
   end
   if not self.stretch then
      self.stretch = SILE.types.measurement()
   end
   if not self.shrink then
      self.shrink = SILE.types.measurement()
   end
end

function length:absolute ()
   return SILE.types.length(self.length:tonumber(), self.stretch:tonumber(), self.shrink:tonumber())
end

function length:negate ()
   return self:__unm()
end

function length:tostring ()
   return self:__tostring()
end

function length:tonumber ()
   return self.length:tonumber()
end

function length:__tostring ()
   local str = tostring(self.length)
   if self.stretch.amount ~= 0 then
      str = str .. " plus " .. tostring(self.stretch)
   end
   if self.shrink.amount ~= 0 then
      str = str .. " minus " .. tostring(self.shrink)
   end
   return str
end

function length:__add (other)
   if type(self) == "number" then
      self, other = other, self
   end
   other = SU.cast("length", other)
   return SILE.types.length(self.length + other.length, self.stretch + other.stretch, self.shrink + other.shrink)
end

-- See usage comments on SILE.types.measurement:___add()
function length:___add (other)
   if SU.type(other) ~= "length" then
      self.length:___add(other)
   else
      self.length:___add(other.length)
      self.stretch:___add(other.stretch)
      self.shrink:___add(other.shrink)
   end
   return nil
end

function length:__sub (other)
   local result = SILE.types.length(self)
   other = SU.cast("length", other)
   result.length = result.length - other.length
   result.stretch = result.stretch - other.stretch
   result.shrink = result.shrink - other.shrink
   return result
end

-- See usage comments on SILE.types.measurement:___add()
function length:___sub (other)
   self.length:___sub(other.length)
   self.stretch:___sub(other.stretch)
   self.shrink:___sub(other.shrink)
   return nil
end

function length:__mul (other)
   if type(self) == "number" then
      self, other = other, self
   end
   _error_if_not_number(other)
   local result = SILE.types.length(self)
   result.length = result.length * other
   result.stretch = result.stretch * other
   result.shrink = result.shrink * other
   return result
end

function length:__div (other)
   local result = SILE.types.length(self)
   _error_if_not_number(other)
   result.length = result.length / other
   result.stretch = result.stretch / other
   result.shrink = result.shrink / other
   return result
end

function length:__unm ()
   local result = SILE.types.length(self)
   result.length = result.length:__unm()
   return result
end

function length:__lt (other)
   local a = SU.cast("number", self)
   local b = SU.cast("number", other)
   return a - b < 0
end

function length:__le (other)
   local a = SU.cast("number", self)
   local b = SU.cast("number", other)
   return a - b <= 0
end

function length:__eq (other)
   local a = SU.cast("length", self)
   local b = SU.cast("length", other)
   return a.length == b.length and a.stretch == b.stretch and a.shrink == b.shrink
end

return length

1	--- SILE length type.
2	-- Lengths are composed of 3 `measurement`s: a length, a stretch, and a shrink. Each part internally is just
3	-- a measurement, but combined describe a flexible length that is allowed to grow up to the amout defined by stretch or
4	-- compress up to the amount defined by shrink.
5	-- @types length
6
7	local function _error_if_not_number (a)
8	if type(a) ~= "number" then	899✔
9	SU.error("We tried to do impossible arithmetic on a " .. SU.type(a) .. ". (That's a bug)", true)	×
10	end
11	end
12
13	--- @type length
14	local length = pl.class()	39✔
15	length.type = "length"	39✔
16
17	length.length = nil	39✔
18	length.stretch = nil	39✔
19	length.shrink = nil	39✔
20
21	--- Constructor.
22	-- @tparam measurement spec A measurement or value that can be cast to a measurement.
23	-- @tparam[opt=0] measurement stretch A measurement describing how much the length is allowed to grow.
24	-- @tparam[opt=0] measurement shrink A measurement describing how much the length is allowed to grow.
25	-- @treturn length
26	-- @usage
27	-- SILE.types.length("6em", "4pt", "2pt")
28	-- SILE.types.length("6em plus 4pt minus 2pt")
29	-- SILE.types.length(30, 4, 2)
30	function length:_init (spec, stretch, shrink)	39✔
31	if stretch or shrink then	66,825✔
32	self.length = SILE.types.measurement(spec or 0)	27,732✔
33	self.stretch = SILE.types.measurement(stretch or 0)	27,732✔
34	self.shrink = SILE.types.measurement(shrink or 0)	27,732✔
35	elseif type(spec) == "number" then	52,959✔
36	self.length = SILE.types.measurement(spec)	43,228✔
37	elseif SU.type(spec) == "measurement" then	62,690✔
38	self.length = spec	812✔
39	elseif SU.type(spec) == "glue" then	61,066✔
40	self.length = SILE.types.measurement(spec.width.length or 0)	×
41	self.stretch = SILE.types.measurement(spec.width.stretch or 0)	×
42	self.shrink = SILE.types.measurement(spec.width.shrink or 0)	×
43	elseif type(spec) == "table" then	30,533✔
44	self.length = SILE.types.measurement(spec.length or 0)	20,746✔
45	self.stretch = SILE.types.measurement(spec.stretch or 0)	20,746✔
46	self.shrink = SILE.types.measurement(spec.shrink or 0)	20,746✔
47	elseif type(spec) == "string" then	20,160✔
48	local amount = tonumber(spec)	576✔
49	if type(amount) == "number" then	576✔
50	self:_init(amount)	4✔
51	else
52	local parsed = SILE.parserBits.length:match(spec)	574✔
53	if not parsed then	574✔
54	SU.error("Could not parse length '" .. spec .. "'")	×
55	end
56	self:_init(parsed)	574✔
57	end
58	end
59	if not self.length then	66,825✔
60	self.length = SILE.types.measurement()	39,168✔
61	end
62	if not self.stretch then	66,825✔
63	self.stretch = SILE.types.measurement()	84,020✔
64	end
65	if not self.shrink then	66,825✔
66	self.shrink = SILE.types.measurement()	84,020✔
67	end
68	end
69
70	function length:absolute ()	39✔
71	return SILE.types.length(self.length:tonumber(), self.stretch:tonumber(), self.shrink:tonumber())	20,884✔
72	end
73
74	function length:negate ()	39✔
75	return self:__unm()	×
76	end
77
78	function length:tostring ()	39✔
79	return self:__tostring()	×
80	end
81
82	function length:tonumber ()	39✔
83	return self.length:tonumber()	37,965✔
84	end
85
86	function length:__tostring ()	39✔
87	local str = tostring(self.length)	2✔
88	if self.stretch.amount ~= 0 then	2✔
89	str = str .. " plus " .. tostring(self.stretch)	2✔
90	end
91	if self.shrink.amount ~= 0 then	2✔
92	str = str .. " minus " .. tostring(self.shrink)	×
93	end
94	return str	2✔
95	end
96
97	function length:__add (other)	39✔
98	if type(self) == "number" then	7,666✔
99	self, other = other, self	1,965✔
100	end
101	other = SU.cast("length", other)	15,332✔
102	return SILE.types.length(self.length + other.length, self.stretch + other.stretch, self.shrink + other.shrink)	30,664✔
103	end
104
105	-- See usage comments on SILE.types.measurement:___add()
106	function length:___add (other)	39✔
107	if SU.type(other) ~= "length" then	36,598✔
108	self.length:___add(other)	1,688✔
109	else
110	self.length:___add(other.length)	17,455✔
111	self.stretch:___add(other.stretch)	17,455✔
112	self.shrink:___add(other.shrink)	17,455✔
113	end
114	return nil	18,299✔
115	end
116
117	function length:__sub (other)	39✔
118	local result = SILE.types.length(self)	6,053✔
119	other = SU.cast("length", other)	12,106✔
120	result.length = result.length - other.length	12,106✔
121	result.stretch = result.stretch - other.stretch	12,106✔
122	result.shrink = result.shrink - other.shrink	12,106✔
123	return result	6,053✔
124	end
125
126	-- See usage comments on SILE.types.measurement:___add()
127	function length:___sub (other)	39✔
128	self.length:___sub(other.length)	1,142✔
129	self.stretch:___sub(other.stretch)	1,142✔
130	self.shrink:___sub(other.shrink)	1,142✔
131	return nil	1,142✔
132	end
133
134	function length:__mul (other)	39✔
135	if type(self) == "number" then	796✔
136	self, other = other, self	×
137	end
138	_error_if_not_number(other)	796✔
139	local result = SILE.types.length(self)	796✔
140	result.length = result.length * other	1,592✔
141	result.stretch = result.stretch * other	1,592✔
142	result.shrink = result.shrink * other	1,592✔
143	return result	796✔
144	end
145
146	function length:__div (other)	39✔
147	local result = SILE.types.length(self)	103✔
148	_error_if_not_number(other)	103✔
149	result.length = result.length / other	206✔
150	result.stretch = result.stretch / other	206✔
151	result.shrink = result.shrink / other	206✔
152	return result	103✔
153	end
154
155	function length:__unm ()	39✔
156	local result = SILE.types.length(self)	×
157	result.length = result.length:__unm()	×
158	return result	×
159	end
160
161	function length:__lt (other)	39✔
162	local a = SU.cast("number", self)	11,068✔
163	local b = SU.cast("number", other)	11,068✔
164	return a - b < 0	11,068✔
165	end
166
167	function length:__le (other)	39✔
168	local a = SU.cast("number", self)	3✔
169	local b = SU.cast("number", other)	3✔
170	return a - b <= 0	3✔
171	end
172
173	function length:__eq (other)	39✔
174	local a = SU.cast("length", self)	×
175	local b = SU.cast("length", other)	×
176	return a.length == b.length and a.stretch == b.stretch and a.shrink == b.shrink	×
177	end
178
179	return length	39✔

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