3634014241

Build Type

push

github

Committed by GitHub

Commit Message

<a href="https://github.com/sile-typesetter/sile/commit/<a class=hub.com/sile-typesetter/sile/commit/<a class="double-link" href="https://git"><a class=hub.com/sile-typesetter/sile/commit/<a class="double-link" href="https://git"><a class=hub.com/sile-typesetter/sile/commit/cf723ee1b203760740e9c29bb7671366df89b177">cf723ee1b<a href="https://github.com/sile-typesetter/sile/commit/cf723ee1b203760740e9c29bb7671366df89b177">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/sile-typesetter/sile/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/sile-typesetter/sile/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/sile-typesetter/sile/commit/cf723ee1b203760740e9c29bb7671366df89b177&quot;&gt;cf723ee1b&lt;/a&gt;&lt;a href=&quot;https://github.com/sile-typesetter/sile/commit/cf723ee1b203760740e9c29bb7671366df89b177&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/sile-typesetter/sile/commit/cf723ee1b203760740e9c29bb7671366&lt;/a&gt;df89b177">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/sile-typesetter/sile/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/sile-typesetter/sile/commit/<a class="double-link" href="https://github.com/sile-typesetter/sile/commit/fbaa4dcb4326aa2075a4c9c129e4e2a27b49ec83">fbaa4dcb4</a><a href="https://github.com/sile-typesetter/sile/commit/cf723ee1b203760740e9c29bb7671366df89b177">&amp;quot;&amp;gt;fbaa4dcb4&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;fbaa4dcb4&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/sile-typesetter/sile/commit/cf723ee1b203760740e9c29bb7671366df89b&lt;/a&gt;177&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/sile-typesetter/sile/commit/<a class="double-link" href="https://github.com/sile-typesetter/sile/commit/9ee9dcddc">9ee9dcddc">9ee9dcddc</a>

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

64501 of 66695 relevant lines covered (96.71%)

1427.69 hits per line

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

73.67

/core/utilities.lua

local bitshim = require("bitshim")
local luautf8 = require("lua-utf8")

local utilities = {}

local epsilon = 1E-12

utilities.required = function (options, name, context, required_type)
  if not options[name] then utilities.error(context.." needs a "..name.." parameter") end
  if required_type then
    return utilities.cast(required_type, options[name])
  end
  return options[name]
end

local function preferbool ()
  utilities.warn("Please use boolean values or strings such as 'true' and 'false' instead of 'yes' and 'no'.")
end

utilities.boolean = function (value, default)
  if value == false then return false end
  if value == true then return true end
  if value == "false" then return false end
  if value == "true" then return true end
  if value == "no" then preferbool(); return false end
  if value == "yes" then preferbool(); return true end
  return default
end

local _skip_traceback_levels = 2

utilities.error = function(message, bug)
  _skip_traceback_levels = 3
  utilities.warn(message, bug)
  _skip_traceback_levels = 2
  io.stderr:flush()
  SILE.outputter:finish() -- Only really useful from the REPL but no harm in trying
  SILE.scratch.caughterror = true
  error(message, 2)
end

utilities.warn = function(message, bug)
  io.stderr:write("\n! " .. message)
  if SILE.traceback or bug then
    io.stderr:write(" at:\n" .. SILE.traceStack:locationTrace())
    if _skip_traceback_levels == 2 then
      io.stderr:write(debug.traceback("", _skip_traceback_levels) or "\t! debug.traceback() did not identify code location")
    end
  else
    io.stderr:write(" at " .. SILE.traceStack:locationHead())
  end
  io.stderr:write("\n")
end

utilities.debugging = function (category)
  return SILE.debugFlags.all and category ~= "profile" or SILE.debugFlags[category]
end

utilities.feq = function (lhs, rhs) -- Float point equal
  lhs = SU.cast("number", lhs)
  rhs = SU.cast("number", rhs)
  local abs = math.abs
  return abs(lhs - rhs) <= epsilon * (abs(lhs) + abs(rhs))
end

utilities.gtoke = function (string, pattern)
  string = string and tostring(string) or ''
  pattern = pattern and tostring(pattern) or "%s+"
  local length = #string
  return coroutine.wrap(function()
    local index = 1
    repeat
      local first, last = string:find(pattern, index)
      if last then
        if index < first then coroutine.yield({ string = string:sub(index, first - 1) }) end
        coroutine.yield({ separator = string:sub(first, last) })
        index = last + 1
      else
        if index <= length then
          coroutine.yield({ string = string:sub(index) })
        end
        break
      end
    until index > length
  end)
end

utilities.deprecated = function (old, new, warnat, errorat, extra)
  -- SILE.version is defined *after* most of SILE loads. It’s available at
  -- runtime but not useful if we encounter deprecated code in core code. Users
  -- will never encounter this failure, but as a developer it’s hard to test a
  -- deprecation when core code refactoring is an all-or-nothing proposition.
  -- Hence we fake it ‘till we make it, all deprecations internally are warings.
  local brackets = old:sub(1,1) == '\\' and "" or "()"
  local _semver = SILE.version and SILE.version:match("v([0-9]*.[0-9]*.[0-9]*)") or warnat
  local _new = new and "Please use " .. (new .. brackets) .. " instead." or "Plase don't use it."
  local msg = (old .. brackets) .. " was deprecated in SILE v" .. warnat .. ". " .. _new ..  (extra and "\n" .. extra .. "\n\n" or "")
  if errorat and _semver >= errorat then
    SU.error(msg)
  elseif warnat and _semver >= warnat then
    SU.warn(msg)
  end
end

utilities.debug = function (category, ...)
  if utilities.debugging(category) then
    local inputs = table.pack(...)
    for i, input in ipairs(inputs) do
      if type(input) == "function" then
        local status, output = pcall(input)
        inputs[i] = status and output or SU.warn(("Output of %s debug function was an error: %s"):format(category, output))
      end
    end
    local message = utilities.concat(inputs, " ")
    if message then io.stderr:write(("\n[%s] %s"):format(category, message)) end
  end
end

utilities.debugAST = function (ast, level)
  if not ast then
    SU.error("debugAST called with nil", true)
  end
  local out = string.rep("  ", 1+level)
  if level == 0 then
    SU.debug("ast", function ()
      return "[" .. SILE.currentlyProcessingFile
    end)
  end
  if type(ast) == "function" then
    SU.debug("ast", function ()
      return out .. tostring(ast)
    end)
  elseif type(ast) == "table" then
    for _, content in ipairs(ast) do
      if type(content) == "string" then
        SU.debug("ast", function ()
          return out .. "[" .. content .. "]"
        end)
      elseif type(content) == "table" then
        if SILE.Commands[content.command] then
          SU.debug("ast", function ()
            return out .. "\\" .. content.command .. " " .. pl.pretty.write(content.options, "")
          end)
          if (#content>=1) then utilities.debugAST(content, level+1) end
        elseif content.id == "texlike_stuff" or (not content.command and not content.id) then
          utilities.debugAST(content, level+1)
        else
          SU.debug("ast", function ()
            return out .. "?\\" .. (content.command or content.id)
          end)
        end
      end
    end
  end
  if level == 0 then SU.debug("ast", "]") end
end

utilities.dump = function (...)
  local arg = { ... } -- Avoid things that Lua stuffs in arg like args to self()
  pl.pretty.dump(#arg == 1 and arg[1] or arg, "/dev/stderr")
end

utilities.concat = function (array, separator)
  return table.concat(utilities.map(tostring, array), separator)
end

utilities.inherit = function (orig, spec)
  local new = pl.tablex.deepcopy(orig)
  if spec then
    for k,v in pairs(spec) do new[k] = v end
  end
  if new.init then new:init() end
  return new
end

utilities.map = function (func, array)
  local new_array = {}
  local last = #array
  for i = 1, last do
    new_array[i] = func(array[i])
  end
  return new_array
end

utilities.sortedpairs = function (input)
  local keys = {}
  for k, _ in pairs(input) do
    keys[#keys+1] = k
  end
  table.sort(keys, function(a, b)
    if type(a) == type(b) then return a < b
    elseif type(a) == "number" then return true
    else return false
    end
  end)
  return coroutine.wrap(function()
    for i = 1, #keys do
      coroutine.yield(keys[i], input[keys[i]])
    end
  end)
end

utilities.splice = function (array, start, stop, replacement)
  local ptr = start
  local room = stop - start + 1
  local last = replacement and #replacement or 0
  for i = 1, last do
    if room > 0 then
      room = room - 1
      array[ptr] = replacement[i]
    else
      table.insert(array, ptr, replacement[i])
    end
    ptr = ptr + 1
  end

  for _ = 1, room do
      table.remove(array, ptr)
  end
  return array
end

utilities.sum = function (array)
  local total = 0
  local last = #array
  for i = 1, last do
    total = total + array[i]
  end
  return total
end

-- Lua <= 5.2 can't handle objects in math functions
utilities.max = function (...)
  local input = pl.utils.pack(...)
  local max = table.remove(input, 1)
  for _, val in ipairs(input) do
    if val > max then max = val end
  end
  return max
end

utilities.min = function (...)
  local input = pl.utils.pack(...)
  local min = input[1]
  for _, val in ipairs(input) do
    if val < min then min = val end
  end
  return min
end

utilities.compress = function (items)
  local rv = {}
  local max = math.max(table.unpack(pl.tablex.keys(items)))
  for i = 1, max do if items[i] then rv[#rv+1] = items[i] end end
  return rv
end

utilities.flip_in_place = function (tbl)
  local tmp, j
  for i = 1, math.floor(#tbl / 2) do
    tmp = tbl[i]
    j = #tbl - i + 1
    tbl[i] = tbl[j]
    tbl[j] = tmp
  end
end

utilities.allCombinations = function (options)
  local count = 1
  for i=1,#options do count = count * options[i] end
  return coroutine.wrap(function()
    for i=0,count-1 do
      local this = i
      local rv = {}
      for j = 1,#options do
        local base = options[j]
        rv[#rv+1] = this % base + 1
        this = (this - this % base )/ base
      end
      coroutine.yield(rv)
    end
  end)
end

utilities.type = function(value)
  if type(value) == "number" then
    return math.floor(value) == value and "integer" or "number"
  elseif type(value) == "table" and value.prototype then
    return value:prototype()
  elseif type(value) == "table" and value.is_a then
    return value.type
  else
    return type(value)
  end
end

utilities.cast = function (wantedType, value)
  local actualType = SU.type(value)
  wantedType = string.lower(wantedType)
  if wantedType:match(actualType)     then return value
  elseif actualType == "nil" and wantedType:match("nil") then return nil
  elseif wantedType:match("integer") or wantedType:match("number") then
    if type(value) == "table" and type(value.tonumber) == "function" then
      return value:tonumber()
    end
    return tonumber(value)
  elseif wantedType:match("length")      then return SILE.length(value)
  elseif wantedType:match("measurement") then return SILE.measurement(value)
  elseif wantedType:match("vglue")       then return SILE.nodefactory.vglue(value)
  elseif wantedType:match("glue")        then return SILE.nodefactory.glue(value)
  elseif wantedType:match("kern")        then return SILE.nodefactory.kern(value)
  elseif actualType == "nil" then SU.error("Cannot cast nil to " .. wantedType)
  elseif wantedType:match("boolean")     then return SU.boolean(value)
  elseif wantedType:match("string")      then return tostring(value)
  else SU.error("Cannot cast to unrecognized type " .. wantedType)
  end
end

utilities.hasContent = function(content)
  return type(content) == "function" or type(content) == "table" and #content > 0
end

-- Flatten content trees into just the string components (allows passing
-- objects with complex structures to functions that need plain strings)
utilities.contentToString = function (content)
  local string = ""
  for i = 1, #content do
    if type(content[i]) == "table" and type(content[i][1]) == "string" then
      string = string .. content[i][1]
    elseif type(content[i]) == "string" then
      -- Work around PEG parser returning env tags as content
      -- TODO: refactor capture groups in PEG parser
      if content.command == content[i] and content[i] == content[i+1] then
        break
      end
      string = string .. content[i]
    end
  end
  return string
end

-- Strip the top level command off a content object and keep only the child
-- items — assuming that the current command is taking care of itself
utilities.subContent = function (content)
  local out = { id="stuff" }
  for key, val in utilities.sortedpairs(content) do
    if type(key) == "number" then
      out[#out+1] = val
    end
  end
  return out
end

-- Call `action` on each content AST node, recursively, including `content` itself.
-- Not called on leaves, i.e. strings.
utilities.walkContent = function (content, action)
  if type(content) ~= "table" then
    return
  end
  action(content)
  for i = 1, #content do
    utilities.walkContent(content[i], action)
  end
end

utilities.rateBadness = function(inf_bad, shortfall, spring)
  if spring == 0 then return inf_bad end
  local bad = math.floor(100 * math.abs(shortfall / spring) ^ 3)
  return math.min(inf_bad, bad)
end

utilities.rationWidth = function (target, width, ratio)
  if ratio < 0 and width.shrink:tonumber() > 0 then
    target:___add(width.shrink:tonumber() * ratio)
  elseif ratio > 0 and width.stretch:tonumber() > 0 then
    target:___add(width.stretch:tonumber() * ratio)
  end
  return target
end

-- Unicode-related utilities
utilities.utf8char = function (c)
  utilities.deprecated("SU.utf8char", "luautf8.char", "0.11.0", "0.12.0")
  return luautf8.char(c)
end

utilities.codepoint = function (uchar)
  local seq = 0
  local val = -1
  for i = 1, #uchar do
    local c = string.byte(uchar, i)
    if seq == 0 then
      if val > -1 then return val end
      seq = c < 0x80 and 1 or c < 0xE0 and 2 or c < 0xF0 and 3 or
            c < 0xF8 and 4 or --c < 0xFC and 5 or c < 0xFE and 6 or
          error("invalid UTF-8 character sequence")
      val = bitshim.band(c, 2^(8-seq) - 1)
    else
      val = bitshim.bor(bitshim.lshift(val, 6), bitshim.band(c, 0x3F))
    end
    seq = seq - 1
  end
  return val
end

utilities.utf8charfromcodepoint = function (codepoint)
  local val = codepoint
  local cp = val
  local hex = (cp:match("[Uu]%+(%x+)") or cp:match("0[xX](%x+)"))
  if hex then
    cp = tonumber("0x"..hex)
  elseif tonumber(cp) then
    cp = tonumber(cp)
  end

  if type(cp) == "number" then
    val = luautf8.char(cp)
  end
  return val
end

utilities.utf8codes = function (ustr)
  utilities.deprecated("SU.utf8codes", "luautf8.codes", "0.11.0", "0.12.0")
  return luautf8.codes(ustr)
end

utilities.utf16codes = function (ustr, endian)
  local pos = 1
  return function()
    if pos > #ustr then
      return nil
    else
      local c1, c2, c3, c4, wchar, lowchar
      c1 = string.byte(ustr, pos, pos+1)
      pos = pos + 1
      c2 = string.byte(ustr, pos, pos+1)
      pos = pos + 1
      if endian == "be" then
        wchar = c1 * 256 + c2
      else
        wchar = c2 * 256 + c1
      end
      if not (wchar >= 0xD800 and wchar <= 0xDBFF) then
        return wchar
      end
      c3 = string.byte(ustr, pos, pos+1)
      pos = pos + 1
      c4 = string.byte(ustr, pos, pos+1)
      pos = pos + 1
      if endian == "be" then
        lowchar = c3 * 256 + c4
      else
        lowchar = c4 * 256 + c3
      end
      return 0x10000 + bitshim.lshift(bitshim.band(wchar, 0x03FF), 10) + bitshim.band(lowchar, 0x03FF)
    end
  end
end

utilities.splitUtf8 = function (str) -- Return an array of UTF8 strings each representing a Unicode char
  local rv = {}
  for _, cp in luautf8.next, str do
    table.insert(rv, luautf8.char(cp))
  end
  return rv
end

utilities.lastChar = function (str)
  local chars = utilities.splitUtf8(str)
  return chars[#chars]
end

utilities.firstChar = function (str)
  local chars = utilities.splitUtf8(str)
  return chars[1]
end

local byte, floor, reverse = string.byte, math.floor, string.reverse

utilities.utf8charat = function (str, index)
  return str:sub(index):match("([%z\1-\127\194-\244][\128-\191]*)")
end

local utf16bom = function(endianness)
  return endianness == "be" and "\254\255" or endianness == "le" and "\255\254" or SU.error("Unrecognized endianness")
end

utilities.hexencoded = function (str)
  local ustr = ""
  for i = 1, #str do
    ustr = ustr..string.format("%02x", byte(str, i, i+1))
  end
  return ustr
end

utilities.hexdecoded = function (str)
  if #str % 2 == 1 then SU.error("Cannot decode hex string with odd len") end
  local ustr = ""
  for i = 1, #str, 2 do
    ustr = ustr..string.char(tonumber(string.sub(str, i, i+1), 16))
  end
  return ustr
end

local uchr_to_surrogate_pair = function(uchr, endianness)
  local hi, lo = floor((uchr - 0x10000) / 0x400) + 0xd800, (uchr - 0x10000) % 0x400 + 0xdc00
  local s_hi, s_lo = string.char(floor(hi / 256)) .. string.char(hi % 256), string.char(floor(lo / 256)) .. string.char(lo % 256)
  return endianness == "le" and (reverse(s_hi) .. reverse(s_lo)) or s_hi .. s_lo
end

local uchr_to_utf16_double_byte = function(uchr, endianness)
  local ustr = string.char(floor(uchr / 256)) .. string.char(uchr % 256)
  return endianness == "le" and reverse(ustr) or ustr
end

local utf8_to_utf16 = function(str, endianness)
  local ustr = utf16bom(endianness)
  for _, uchr in luautf8.codes(str) do
    ustr = ustr..(uchr < 0x10000 and uchr_to_utf16_double_byte(uchr, endianness)
                  or uchr_to_surrogate_pair(uchr, endianness))
  end
  return ustr
end

utilities.utf8_to_utf16be = function (str) return utf8_to_utf16(str, "be") end
utilities.utf8_to_utf16le = function (str) return utf8_to_utf16(str, "le") end
utilities.utf8_to_utf16be_hexencoded = function (str) return utilities.hexencoded(utilities.utf8_to_utf16be(str)) end
utilities.utf8_to_utf16le_hexencoded = function (str) return utilities.hexencoded(utilities.utf8_to_utf16le(str)) end

local utf16_to_utf8 = function (str, endianness)
  local bom = utf16bom(endianness)

  if str:find(bom) == 1 then str = string.sub(str, 3, #str) end
  local ustr = ""
  for uchr in utilities.utf16codes(str, endianness) do
    ustr = ustr..luautf8.char(uchr)
  end
  return ustr
end

utilities.utf16be_to_utf8 = function (str) return utf16_to_utf8(str, "be") end
utilities.utf16le_to_utf8 = function (str) return utf16_to_utf8(str, "le") end

utilities.breadcrumbs = function ()
  local breadcrumbs = {}

  setmetatable (breadcrumbs, {
      __index = function(_, key)
        local frame = SILE.traceStack[key]
        return frame and frame.command or nil
      end,
      __len = function(_)
        return #SILE.traceStack
      end,
      __tostring = function (self)
        return "B»" .. table.concat(self, "»")
      end
    })

  function breadcrumbs:dump ()
    SU.dump(self)
  end

  function breadcrumbs:parent (count)
    return self[#self-(count or 1)]
  end

  function breadcrumbs:contains (needle)
    for i, command in ipairs(self) do
      if command == needle then return true, #self - i end
    end
    return false, -1
  end

  return breadcrumbs
end

utilities.formatNumber = require("core.utilities-numbers")

utilities.collatedSort = require("core.utilities-sorting")

return utilities

1	local bitshim = require("bitshim")	158✔
2	local luautf8 = require("lua-utf8")	158✔
3
4	local utilities = {}	158✔
5
6	local epsilon = 1E-12	158✔
7
8	utilities.required = function (options, name, context, required_type)
9	if not options[name] then utilities.error(context.." needs a "..name.." parameter") end	8,257✔
10	if required_type then	8,257✔
11	return utilities.cast(required_type, options[name])	1,587✔
12	end
13	return options[name]	6,670✔
14	end
15
16	local function preferbool ()
17	utilities.warn("Please use boolean values or strings such as 'true' and 'false' instead of 'yes' and 'no'.")	×
18	end
19
20	utilities.boolean = function (value, default)
21	if value == false then return false end	5,007✔
22	if value == true then return true end	5,001✔
23	if value == "false" then return false end	2,198✔
24	if value == "true" then return true end	2,196✔
25	if value == "no" then preferbool(); return false end	2,191✔
26	if value == "yes" then preferbool(); return true end	2,191✔
27	return default	2,191✔
28	end
29
30	local _skip_traceback_levels = 2	158✔
31
32	utilities.error = function(message, bug)
33	_skip_traceback_levels = 3	×
34	utilities.warn(message, bug)	×
35	_skip_traceback_levels = 2	×
36	io.stderr:flush()	×
37	SILE.outputter:finish() -- Only really useful from the REPL but no harm in trying	×
38	SILE.scratch.caughterror = true	×
39	error(message, 2)	×
40	end
41
42	utilities.warn = function(message, bug)
43	io.stderr:write("\n! " .. message)	98✔
44	if SILE.traceback or bug then	98✔
45	io.stderr:write(" at:\n" .. SILE.traceStack:locationTrace())	2✔
46	if _skip_traceback_levels == 2 then	1✔
47	io.stderr:write(debug.traceback("", _skip_traceback_levels) or "\t! debug.traceback() did not identify code location")	1✔
48	end
49	else
50	io.stderr:write(" at " .. SILE.traceStack:locationHead())	194✔
51	end
52	io.stderr:write("\n")	98✔
53	end
54
55	utilities.debugging = function (category)
56	return SILE.debugFlags.all and category ~= "profile" or SILE.debugFlags[category]	147,384✔
57	end
58
59	utilities.feq = function (lhs, rhs) -- Float point equal
60	lhs = SU.cast("number", lhs)	164✔
61	rhs = SU.cast("number", rhs)	164✔
62	local abs = math.abs	82✔
63	return abs(lhs - rhs) <= epsilon * (abs(lhs) + abs(rhs))	82✔
64	end
65
66	utilities.gtoke = function (string, pattern)
67	string = string and tostring(string) or ''	1,576✔
68	pattern = pattern and tostring(pattern) or "%s+"	1,576✔
69	local length = #string	1,576✔
70	return coroutine.wrap(function()	1,576✔
71	local index = 1	1,576✔
72	repeat
73	local first, last = string:find(pattern, index)	1,894✔
74	if last then	1,894✔
75	if index < first then coroutine.yield({ string = string:sub(index, first - 1) }) end	900✔
76	coroutine.yield({ separator = string:sub(first, last) })	1,152✔
77	index = last + 1	576✔
78	else
79	if index <= length then	1,318✔
80	coroutine.yield({ string = string:sub(index) })	2,438✔
81	end
82	break	1,219✔
83	end
84	until index > length	576✔
85	end)
86	end
87
88	utilities.deprecated = function (old, new, warnat, errorat, extra)
89	-- SILE.version is defined after most of SILE loads. It’s available at
90	-- runtime but not useful if we encounter deprecated code in core code. Users
91	-- will never encounter this failure, but as a developer it’s hard to test a
92	-- deprecation when core code refactoring is an all-or-nothing proposition.
93	-- Hence we fake it ‘till we make it, all deprecations internally are warings.
94	local brackets = old:sub(1,1) == '\\' and "" or "()"	58✔
95	local _semver = SILE.version and SILE.version:match("v([0-9].[0-9].[0-9]*)") or warnat	29✔
96	local _new = new and "Please use " .. (new .. brackets) .. " instead." or "Plase don't use it."	29✔
97	local msg = (old .. brackets) .. " was deprecated in SILE v" .. warnat .. ". " .. _new .. (extra and "\n" .. extra .. "\n\n" or "")	29✔
98	if errorat and _semver >= errorat then	29✔
99	SU.error(msg)	×
100	elseif warnat and _semver >= warnat then	29✔
101	SU.warn(msg)	29✔
102	end
103	end
104
105	utilities.debug = function (category, ...)
106	if utilities.debugging(category) then	281,508✔
107	local inputs = table.pack(...)	×
108	for i, input in ipairs(inputs) do	×
109	if type(input) == "function" then	×
110	local status, output = pcall(input)	×
111	inputs[i] = status and output or SU.warn(("Output of %s debug function was an error: %s"):format(category, output))	×
112	end
113	end
114	local message = utilities.concat(inputs, " ")	×
115	if message then io.stderr:write(("\n[%s] %s"):format(category, message)) end	×
116	end
117	end
118
119	utilities.debugAST = function (ast, level)
120	if not ast then	×
121	SU.error("debugAST called with nil", true)	×
122	end
123	local out = string.rep(" ", 1+level)	×
124	if level == 0 then	×
125	SU.debug("ast", function ()	×
126	return "[" .. SILE.currentlyProcessingFile	×
127	end)
128	end
129	if type(ast) == "function" then	×
130	SU.debug("ast", function ()	×
131	return out .. tostring(ast)	×
132	end)
133	elseif type(ast) == "table" then	×
134	for _, content in ipairs(ast) do	×
135	if type(content) == "string" then	×
136	SU.debug("ast", function ()	×
137	return out .. "[" .. content .. "]"	×
138	end)
139	elseif type(content) == "table" then	×
140	if SILE.Commands[content.command] then	×
141	SU.debug("ast", function ()	×
142	return out .. "\\" .. content.command .. " " .. pl.pretty.write(content.options, "")	×
143	end)
144	if (#content>=1) then utilities.debugAST(content, level+1) end	×
145	elseif content.id == "texlike_stuff" or (not content.command and not content.id) then	×
146	utilities.debugAST(content, level+1)	×
147	else
148	SU.debug("ast", function ()	×
149	return out .. "?\\" .. (content.command or content.id)	×
150	end)
151	end
152	end
153	end
154	end
155	if level == 0 then SU.debug("ast", "]") end	×
156	end
157
158	utilities.dump = function (...)
159	local arg = { ... } -- Avoid things that Lua stuffs in arg like args to self()	1✔
160	pl.pretty.dump(#arg == 1 and arg[1] or arg, "/dev/stderr")	2✔
161	end
162
163	utilities.concat = function (array, separator)
164	return table.concat(utilities.map(tostring, array), separator)	120✔
165	end
166
167	utilities.inherit = function (orig, spec)
168	local new = pl.tablex.deepcopy(orig)	×
169	if spec then	×
170	for k,v in pairs(spec) do new[k] = v end	×
171	end
172	if new.init then new:init() end	×
173	return new	×
174	end
175
176	utilities.map = function (func, array)
177	local new_array = {}	51,565✔
178	local last = #array	51,565✔
179	for i = 1, last do	176,345✔
180	new_array[i] = func(array[i])	249,265✔
181	end
182	return new_array	51,565✔
183	end
184
185	utilities.sortedpairs = function (input)
186	local keys = {}	6✔
187	for k, _ in pairs(input) do	48✔
188	keys[#keys+1] = k	42✔
189	end
190	table.sort(keys, function(a, b)	12✔
191	if type(a) == type(b) then return a < b	102✔
192	elseif type(a) == "number" then return true	18✔
193	else return false	18✔
194	end
195	end)
196	return coroutine.wrap(function()	6✔
197	for i = 1, #keys do	48✔
198	coroutine.yield(keys[i], input[keys[i]])	42✔
199	end
200	end)
201	end
202
203	utilities.splice = function (array, start, stop, replacement)
204	local ptr = start	519✔
205	local room = stop - start + 1	519✔
206	local last = replacement and #replacement or 0	519✔
207	for i = 1, last do	3,408✔
208	if room > 0 then	2,889✔
209	room = room - 1	468✔
210	array[ptr] = replacement[i]	468✔
211	else
212	table.insert(array, ptr, replacement[i])	2,421✔
213	end
214	ptr = ptr + 1	2,889✔
215	end
216
217	for _ = 1, room do	570✔
218	table.remove(array, ptr)	51✔
219	end
220	return array	519✔
221	end
222
223	utilities.sum = function (array)
224	local total = 0	14,885✔
225	local last = #array	14,885✔
226	for i = 1, last do	28,511✔
227	total = total + array[i]	13,626✔
228	end
229	return total	14,885✔
230	end
231
232	-- Lua <= 5.2 can't handle objects in math functions
233	utilities.max = function (...)
234	local input = pl.utils.pack(...)	32,956✔
235	local max = table.remove(input, 1)	32,956✔
236	for _, val in ipairs(input) do	116,217✔
237	if val > max then max = val end	112,423✔
238	end
239	return max	32,956✔
240	end
241
242	utilities.min = function (...)
243	local input = pl.utils.pack(...)	12✔
244	local min = input[1]	12✔
245	for _, val in ipairs(input) do	36✔
246	if val < min then min = val end	24✔
247	end
248	return min	12✔
249	end
250
251	utilities.compress = function (items)
252	local rv = {}	1,281✔
253	local max = math.max(table.unpack(pl.tablex.keys(items)))	2,562✔
254	for i = 1, max do if items[i] then rv[#rv+1] = items[i] end end	27,447✔
255	return rv	1,281✔
256	end
257
258	utilities.flip_in_place = function (tbl)
259	local tmp, j
260	for i = 1, math.floor(#tbl / 2) do	590✔
261	tmp = tbl[i]	302✔
262	j = #tbl - i + 1	302✔
263	tbl[i] = tbl[j]	302✔
264	tbl[j] = tmp	302✔
265	end
266	end
267
268	utilities.allCombinations = function (options)
269	local count = 1	×
270	for i=1,#options do count = count * options[i] end	×
271	return coroutine.wrap(function()	×
272	for i=0,count-1 do	×
273	local this = i	×
274	local rv = {}	×
275	for j = 1,#options do	×
276	local base = options[j]	×
277	rv[#rv+1] = this % base + 1	×
278	this = (this - this % base )/ base	×
279	end
280	coroutine.yield(rv)	×
281	end
282	end)
283	end
284
285	utilities.type = function(value)
286	if type(value) == "number" then	2,517,363✔
287	return math.floor(value) == value and "integer" or "number"	610,027✔
288	elseif type(value) == "table" and value.prototype then	1,907,336✔
289	return value:prototype()	×
290	elseif type(value) == "table" and value.is_a then	1,907,336✔
291	return value.type	940,989✔
292	else
293	return type(value)	966,347✔
294	end
295	end
296
297	utilities.cast = function (wantedType, value)
298	local actualType = SU.type(value)	571,297✔
299	wantedType = string.lower(wantedType)	1,142,594✔
300	if wantedType:match(actualType) then return value	571,297✔
301	elseif actualType == "nil" and wantedType:match("nil") then return nil	401,393✔
302	elseif wantedType:match("integer") or wantedType:match("number") then	401,393✔
303	if type(value) == "table" and type(value.tonumber) == "function" then	343,250✔
304	return value:tonumber()	338,025✔
305	end
306	return tonumber(value)	5,225✔
307	elseif wantedType:match("length") then return SILE.length(value)	58,143✔
308	elseif wantedType:match("measurement") then return SILE.measurement(value)	7,218✔
309	elseif wantedType:match("vglue") then return SILE.nodefactory.vglue(value)	288✔
310	elseif wantedType:match("glue") then return SILE.nodefactory.glue(value)	276✔
311	elseif wantedType:match("kern") then return SILE.nodefactory.kern(value)	×
312	elseif actualType == "nil" then SU.error("Cannot cast nil to " .. wantedType)	×
313	elseif wantedType:match("boolean") then return SU.boolean(value)	×
314	elseif wantedType:match("string") then return tostring(value)	×
315	else SU.error("Cannot cast to unrecognized type " .. wantedType)	×
316	end
317	end
318
319	utilities.hasContent = function(content)
320	return type(content) == "function" or type(content) == "table" and #content > 0	1,905✔
321	end
322
323	-- Flatten content trees into just the string components (allows passing
324	-- objects with complex structures to functions that need plain strings)
325	utilities.contentToString = function (content)
326	local string = ""	26✔
327	for i = 1, #content do	52✔
328	if type(content[i]) == "table" and type(content[i][1]) == "string" then	27✔
329	string = string .. content[i][1]	×
330	elseif type(content[i]) == "string" then	27✔
331	-- Work around PEG parser returning env tags as content
332	-- TODO: refactor capture groups in PEG parser
333	if content.command == content[i] and content[i] == content[i+1] then	27✔
334	break	1✔
335	end
336	string = string .. content[i]	26✔
337	end
338	end
339	return string	26✔
340	end
341
342	-- Strip the top level command off a content object and keep only the child
343	-- items — assuming that the current command is taking care of itself
344	utilities.subContent = function (content)
345	local out = { id="stuff" }	6✔
346	for key, val in utilities.sortedpairs(content) do	54✔
347	if type(key) == "number" then	42✔
348	out[#out+1] = val	6✔
349	end
350	end
351	return out	6✔
352	end
353
354	-- Call `action` on each content AST node, recursively, including `content` itself.
355	-- Not called on leaves, i.e. strings.
356	utilities.walkContent = function (content, action)
357	if type(content) ~= "table" then	×
358	return	×
359	end
360	action(content)	×
361	for i = 1, #content do	×
362	utilities.walkContent(content[i], action)	×
363	end
364	end
365
366	utilities.rateBadness = function(inf_bad, shortfall, spring)
367	if spring == 0 then return inf_bad end	20,673✔
368	local bad = math.floor(100 * math.abs(shortfall / spring) ^ 3)	19,988✔
369	return math.min(inf_bad, bad)	19,988✔
370	end
371
372	utilities.rationWidth = function (target, width, ratio)
373	if ratio < 0 and width.shrink:tonumber() > 0 then	27,819✔
374	target:___add(width.shrink:tonumber() * ratio)	4,857✔
375	elseif ratio > 0 and width.stretch:tonumber() > 0 then	40,123✔
376	target:___add(width.stretch:tonumber() * ratio)	10,008✔
377	end
378	return target	23,187✔
379	end
380
381	-- Unicode-related utilities
382	utilities.utf8char = function (c)
383	utilities.deprecated("SU.utf8char", "luautf8.char", "0.11.0", "0.12.0")	×
384	return luautf8.char(c)	×
385	end
386
387	utilities.codepoint = function (uchar)
388	local seq = 0	190,233✔
389	local val = -1	190,233✔
390	for i = 1, #uchar do	388,841✔
391	local c = string.byte(uchar, i)	199,243✔
392	if seq == 0 then	199,243✔
393	if val > -1 then return val end	190,450✔
394	seq = c < 0x80 and 1 or c < 0xE0 and 2 or c < 0xF0 and 3 or	189,815✔
395	c < 0xF8 and 4 or --c < 0xFC and 5 or c < 0xFE and 6 or	12✔
396	error("invalid UTF-8 character sequence")	×
397	val = bitshim.band(c, 2^(8-seq) - 1)	189,815✔
398	else
399	val = bitshim.bor(bitshim.lshift(val, 6), bitshim.band(c, 0x3F))	8,793✔
400	end
401	seq = seq - 1	198,608✔
402	end
403	return val	189,598✔
404	end
405
406	utilities.utf8charfromcodepoint = function (codepoint)
407	local val = codepoint	667✔
408	local cp = val	667✔
409	local hex = (cp:match("[Uu]%+(%x+)") or cp:match("0[xX](%x+)"))	667✔
410	if hex then	667✔
411	cp = tonumber("0x"..hex)	6✔
412	elseif tonumber(cp) then	661✔
413	cp = tonumber(cp)	×
414	end
415
416	if type(cp) == "number" then	667✔
417	val = luautf8.char(cp)	6✔
418	end
419	return val	667✔
420	end
421
422	utilities.utf8codes = function (ustr)
423	utilities.deprecated("SU.utf8codes", "luautf8.codes", "0.11.0", "0.12.0")	×
424	return luautf8.codes(ustr)	×
425	end
426
427	utilities.utf16codes = function (ustr, endian)
428	local pos = 1	55,728✔
429	return function()
430	if pos > #ustr then	1,706,558✔
431	return nil	55,728✔
432	else
433	local c1, c2, c3, c4, wchar, lowchar
434	c1 = string.byte(ustr, pos, pos+1)	1,650,830✔
435	pos = pos + 1	1,650,830✔
436	c2 = string.byte(ustr, pos, pos+1)	1,650,830✔
437	pos = pos + 1	1,650,830✔
438	if endian == "be" then	1,650,830✔
439	wchar = c1 * 256 + c2	1,650,788✔
440	else
441	wchar = c2 * 256 + c1	42✔
442	end
443	if not (wchar >= 0xD800 and wchar <= 0xDBFF) then	1,650,830✔
444	return wchar	1,650,824✔
445	end
446	c3 = string.byte(ustr, pos, pos+1)	6✔
447	pos = pos + 1	6✔
448	c4 = string.byte(ustr, pos, pos+1)	6✔
449	pos = pos + 1	6✔
450	if endian == "be" then	6✔
451	lowchar = c3 * 256 + c4	3✔
452	else
453	lowchar = c4 * 256 + c3	3✔
454	end
455	return 0x10000 + bitshim.lshift(bitshim.band(wchar, 0x03FF), 10) + bitshim.band(lowchar, 0x03FF)	6✔
456	end
457	end
458	end
459
460	utilities.splitUtf8 = function (str) -- Return an array of UTF8 strings each representing a Unicode char
461	local rv = {}	126,074✔
462	for _, cp in luautf8.next, str do	818,749✔
463	table.insert(rv, luautf8.char(cp))	692,675✔
464	end
465	return rv	126,074✔
466	end
467
468	utilities.lastChar = function (str)
469	local chars = utilities.splitUtf8(str)	4✔
470	return chars[#chars]	4✔
471	end
472
473	utilities.firstChar = function (str)
474	local chars = utilities.splitUtf8(str)	10✔
475	return chars[1]	10✔
476	end
477
478	local byte, floor, reverse = string.byte, math.floor, string.reverse	158✔
479
480	utilities.utf8charat = function (str, index)
481	return str:sub(index):match("([%z\1-\127\194-\244][\128-\191]*)")	×
482	end
483
484	local utf16bom = function(endianness)
485	return endianness == "be" and "\254\255" or endianness == "le" and "\255\254" or SU.error("Unrecognized endianness")	55,738✔
486	end
487
488	utilities.hexencoded = function (str)
489	local ustr = ""	8✔
490	for i = 1, #str do	158✔
491	ustr = ustr..string.format("%02x", byte(str, i, i+1))	150✔
492	end
493	return ustr	8✔
494	end
495
496	utilities.hexdecoded = function (str)
497	if #str % 2 == 1 then SU.error("Cannot decode hex string with odd len") end	12✔
498	local ustr = ""	12✔
499	for i = 1, #str, 2 do	200✔
500	ustr = ustr..string.char(tonumber(string.sub(str, i, i+1), 16))	564✔
501	end
502	return ustr	12✔
503	end
504
505	local uchr_to_surrogate_pair = function(uchr, endianness)
506	local hi, lo = floor((uchr - 0x10000) / 0x400) + 0xd800, (uchr - 0x10000) % 0x400 + 0xdc00	3✔
507	local s_hi, s_lo = string.char(floor(hi / 256)) .. string.char(hi % 256), string.char(floor(lo / 256)) .. string.char(lo % 256)	15✔
508	return endianness == "le" and (reverse(s_hi) .. reverse(s_lo)) or s_hi .. s_lo	5✔
509	end
510
511	local uchr_to_utf16_double_byte = function(uchr, endianness)
512	local ustr = string.char(floor(uchr / 256)) .. string.char(uchr % 256)	303✔
513	return endianness == "le" and reverse(ustr) or ustr	114✔
514	end
515
516	local utf8_to_utf16 = function(str, endianness)
517	local ustr = utf16bom(endianness)	10✔
518	for _, uchr in luautf8.codes(str) do	114✔
519	ustr = ustr..(uchr < 0x10000 and uchr_to_utf16_double_byte(uchr, endianness)	104✔
520	or uchr_to_surrogate_pair(uchr, endianness))	107✔
521	end
522	return ustr	10✔
523	end
524
525	utilities.utf8_to_utf16be = function (str) return utf8_to_utf16(str, "be") end	166✔
526	utilities.utf8_to_utf16le = function (str) return utf8_to_utf16(str, "le") end	160✔
527	utilities.utf8_to_utf16be_hexencoded = function (str) return utilities.hexencoded(utilities.utf8_to_utf16be(str)) end	170✔
528	utilities.utf8_to_utf16le_hexencoded = function (str) return utilities.hexencoded(utilities.utf8_to_utf16le(str)) end	162✔
529
530	local utf16_to_utf8 = function (str, endianness)
531	local bom = utf16bom(endianness)	55,728✔
532
533	if str:find(bom) == 1 then str = string.sub(str, 3, #str) end	55,732✔
534	local ustr = ""	55,728✔
535	for uchr in utilities.utf16codes(str, endianness) do	3,468,844✔
536	ustr = ustr..luautf8.char(uchr)	1,650,830✔
537	end
538	return ustr	55,728✔
539	end
540
541	utilities.utf16be_to_utf8 = function (str) return utf16_to_utf8(str, "be") end	55,880✔
542	utilities.utf16le_to_utf8 = function (str) return utf16_to_utf8(str, "le") end	164✔
543
544	utilities.breadcrumbs = function ()
545	local breadcrumbs = {}	158✔
546
547	setmetatable (breadcrumbs, {	316✔
548	__index = function(_, key)
549	local frame = SILE.traceStack[key]	×
550	return frame and frame.command or nil	×
551	end,
552	__len = function(_)
553	return #SILE.traceStack	×
554	end,
555	__tostring = function (self)
556	return "B»" .. table.concat(self, "»")	×
557	end
558	})
559
560	function breadcrumbs:dump ()	158✔
561	SU.dump(self)	×
562	end
563
564	function breadcrumbs:parent (count)	158✔
565	return self[#self-(count or 1)]	×
566	end
567
568	function breadcrumbs:contains (needle)	158✔
569	for i, command in ipairs(self) do	×
570	if command == needle then return true, #self - i end	×
571	end
572	return false, -1	×
573	end
574
575	return breadcrumbs	158✔
576	end
577
578	utilities.formatNumber = require("core.utilities-numbers")	158✔
579
580	utilities.collatedSort = require("core.utilities-sorting")	158✔
581
582	return utilities	158✔

sile-typesetter / sile / 3634014241

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