11658356834

Committed 04 Nov 2024 05:01AM UTC coverage: 36.974% (-29.4%) from 66.366%

Build # 11658356834

Build Type

push

github

Committed by

alerque

Commit Message

feat(cli): Catch missing required arguments at parse time

Run Details

6656 of 18002 relevant lines covered (36.97%)

1490.04 hits per line

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

83.2

/inputters/sil.lua

local base = require("inputters.base")

local _variant = "epnf"
local parser
local function load_parser ()
   parser = require("inputters.sil-" .. _variant)
end

local inputter = pl.class(base)
inputter._name = "sil"

inputter.order = 50

inputter.appropriate = function (round, filename, doc)
   if not parser then
      load_parser()
   end
   if round == 1 then
      return filename:match(".sil$")
   elseif round == 2 then
      local sniff = doc:sub(1, 100)
      local promising = sniff:match("\\begin") or sniff:match("\\document") or sniff:match("\\sile")
      return promising and inputter.appropriate(3, filename, doc) or false
   elseif round == 3 then
      local status, _ = pcall(parser, doc)
      return status
   end
end

function inputter:_init (options)
   options = options or {}
   if options.variant then
      _variant = options.variant
      load_parser()
   else
      if not parser then
         load_parser()
      end
   end
   -- Save time when parsing strings by only setting up the grammar once per
   -- instantiation then re-using it on every use.
   self._parser = parser
   base._init(self)
end

local linecache = {}
local lno, col, lastpos
local function resetCache ()
   lno = 1
   col = 1
   lastpos = 0
   linecache = { { lno = 1, pos = 1 } }
end

local function getline (str, pos)
   local start = 1
   lno = 1
   if pos > lastpos then
      lno = linecache[#linecache].lno
      start = linecache[#linecache].pos + 1
      col = 1
   else
      for j = 1, #linecache - 1 do
         if linecache[j + 1].pos >= pos then
            lno = linecache[j].lno
            col = pos - linecache[j].pos
            return lno, col
         end
      end
   end
   for i = start, pos do
      if string.sub(str, i, i) == "\n" then
         lno = lno + 1
         col = 1
         linecache[#linecache + 1] = { pos = i, lno = lno }
         lastpos = i
      end
      col = col + 1
   end
   return lno, col
end

local function ast_from_parse_tree (tree, doc, depth)
   if type(tree) == "string" then
      return tree
   end

   if tree.pos then
      tree.lno, tree.col = getline(doc, tree.pos)
      tree.pos = nil
   end

   local sep -- luacheck: ignore 211
   if SU.debugging("inputter") then
      depth = depth + 1
      sep = ("   "):rep(depth)
   end
   SU.debug("inputter", sep and (sep .. "Processing ID:"), tree.id)

   local res
   if tree.id == "comment" then
      -- Drop comments
      SU.debug("inputter", sep and (sep .. "Discarding comment"))
      res = {}
   elseif
      false
      or tree.id == "document"
      or tree.id == "braced_content"
      or tree.id == "passthrough_content"
      or tree.id == "braced_passthrough_content"
      or tree.id == "env_passthrough_content"
      or tree.id == "text"
      or tree.id == "passthrough_text"
      or tree.id == "braced_passthrough_text"
      or tree.id == "env_passthrough_text"
   then
      -- These nodes have only one child, which needs recursion.
      SU.debug("inputter", sep and (sep .. "Massaging a node"))
      res = ast_from_parse_tree(tree[1], doc, depth)
      --res = #res > 1 and not res.id and res or res[1]
   elseif false or tree.id == "environment" or tree.id == "command" then
      -- These nodes have multiple children, which need recursion.
      SU.debug("inputter", sep and (sep .. "Processing command"), tree.command, #tree, "subtrees")
      local newtree = { -- I don't think we can avoid a shallow copy here
         command = tree.command,
         options = tree.options,
         id = tree.id,
         lno = tree.lno,
         col = tree.col,
      }
      for _, node in ipairs(tree) do
         if type(node) == "table" then
            SU.debug("inputter", sep and (sep .. " -"), node.id or "table")
            local ast_node = ast_from_parse_tree(node, doc, depth)
            if type(ast_node) == "table" and not ast_node.id then
               SU.debug("inputter", sep and (sep .. " -"), "Collapsing subtree")
               -- Comments can an empty table, skip them
               if #ast_node > 0 then
                  -- Simplify the tree if it's just a plain list
                  for _, child in ipairs(ast_node) do
                     if type(child) ~= "table" or child.id or #child > 0 then
                        table.insert(newtree, child)
                     end
                  end
               end
            else
               table.insert(newtree, ast_node)
            end
         end
         -- Non table nodes are skipped (e.g. extraneous text from 'raw' commands)
      end
      res = newtree
   elseif tree.id == "content" then
      -- This node has multiple children, which need recursion
      -- And the node itself needs to be replaced with its children
      SU.debug("inputter", sep and (sep .. "Massage content node"), #tree, "subtrees")
      local newtree = {} -- I don't think we can avoid a shallow copy here
      for i, node in ipairs(tree) do
         SU.debug("inputter", sep and (sep .. " -"), node.id)
         newtree[i] = ast_from_parse_tree(node, doc, depth)
      end
      -- Simplify the tree if it has only one child
      res = #newtree == 1 and not newtree.id and newtree[1] or newtree
   elseif tree.id then
      -- Shouldn't happen, or we missed something
      SU.error("Unknown node type: " .. tree.id)
   else
      SU.debug("inputter", sep and (sep .. "Table node"), #tree, "subtrees")
      res = #tree == 1 and tree[1] or tree
   end
   SU.debug("inputter", sep and (sep .. "Returning a"), type(res) == "table" and res.id or "string")
   return res
end

function inputter:parse (doc)
   local status, result = pcall(self._parser, doc)
   if not status then
      return SU.error(([[
         Unable to parse input document to an AST tree

         Parser error:

           %s

         thrown from document beginning.]]):format(pl.stringx.indent(result, 6)))
   end
   resetCache()
   local top = ast_from_parse_tree(result[1], doc, 0)
   local tree
   -- Content not part of a tagged command could either be part of a document
   -- fragment or junk (e.g. comments, whitespace) outside of a document tag. We
   -- need to either capture the document tag only or decide this is a fragment
   -- and wrap it in a document tag.
   if top.command == "document" or top.command == "sile" then
      tree = top
   elseif type(top) == "table" then
      for _, leaf in ipairs(top) do
         if leaf.command and (leaf.command == "document" or leaf.command == "sile") then
            tree = leaf
            break
         end
      end
   end
   -- In the event we didn't isolate a top level document tag above, assume this
   -- is a fragment and wrap it in one.
   if not tree then
      tree = { top, command = "document" }
   end
   return { tree }
end

return inputter

1	local base = require("inputters.base")	22✔
2
3	local _variant = "epnf"	22✔
4	local parser
5	local function load_parser ()
6	parser = require("inputters.sil-" .. _variant)	20✔
7	end
8
9	local inputter = pl.class(base)	22✔
10	inputter._name = "sil"	22✔
11
12	inputter.order = 50	22✔
13
14	inputter.appropriate = function (round, filename, doc)
15	if not parser then	20✔
16	load_parser()	20✔
17	end
18	if round == 1 then	20✔
19	return filename:match(".sil$")	20✔
20	elseif round == 2 then	×
21	local sniff = doc:sub(1, 100)	×
22	local promising = sniff:match("\\begin") or sniff:match("\\document") or sniff:match("\\sile")	×
23	return promising and inputter.appropriate(3, filename, doc) or false	×
24	elseif round == 3 then	×
25	local status, _ = pcall(parser, doc)	×
26	return status	×
27	end
28	end
29
30	function inputter:_init (options)	22✔
31	options = options or {}	20✔
32	if options.variant then	20✔
33	_variant = options.variant	×
34	load_parser()	×
35	else
36	if not parser then	20✔
37	load_parser()	×
38	end
39	end
40	-- Save time when parsing strings by only setting up the grammar once per
41	-- instantiation then re-using it on every use.
42	self._parser = parser	20✔
43	base._init(self)	20✔
44	end
45
46	local linecache = {}	22✔
47	local lno, col, lastpos
48	local function resetCache ()
49	lno = 1	20✔
50	col = 1	20✔
51	lastpos = 0	20✔
52	linecache = { { lno = 1, pos = 1 } }	20✔
53	end
54
55	local function getline (str, pos)
56	local start = 1	566✔
57	lno = 1	566✔
58	if pos > lastpos then	566✔
59	lno = linecache[#linecache].lno	525✔
60	start = linecache[#linecache].pos + 1	525✔
61	col = 1	525✔
62	else
63	for j = 1, #linecache - 1 do	798✔
64	if linecache[j + 1].pos >= pos then	798✔
65	lno = linecache[j].lno	41✔
66	col = pos - linecache[j].pos	41✔
67	return lno, col	41✔
68	end
69	end
70	end
71	for i = start, pos do	16,691✔
72	if string.sub(str, i, i) == "\n" then	32,332✔
73	lno = lno + 1	494✔
74	col = 1	494✔
75	linecache[#linecache + 1] = { pos = i, lno = lno }	494✔
76	lastpos = i	494✔
77	end
78	col = col + 1	16,166✔
79	end
80	return lno, col	525✔
81	end
82
83	local function ast_from_parse_tree (tree, doc, depth)
84	if type(tree) == "string" then	810✔
85	return tree	244✔
86	end
87
88	if tree.pos then	566✔
89	tree.lno, tree.col = getline(doc, tree.pos)	1,132✔
90	tree.pos = nil	566✔
91	end
92
93	local sep -- luacheck: ignore 211
94	if SU.debugging("inputter") then	1,132✔
95	depth = depth + 1	×
96	sep = (" "):rep(depth)	×
97	end
98	SU.debug("inputter", sep and (sep .. "Processing ID:"), tree.id)	566✔
99
100	local res
101	if tree.id == "comment" then	566✔
102	-- Drop comments
103	SU.debug("inputter", sep and (sep .. "Discarding comment"))	17✔
104	res = {}	17✔
105	elseif	×
106	false
107	or tree.id == "document"	549✔
108	or tree.id == "braced_content"	549✔
109	or tree.id == "passthrough_content"	526✔
110	or tree.id == "braced_passthrough_content"	522✔
111	or tree.id == "env_passthrough_content"	522✔
112	or tree.id == "text"	509✔
113	or tree.id == "passthrough_text"	282✔
114	or tree.id == "braced_passthrough_text"	282✔
115	or tree.id == "env_passthrough_text"	278✔
116	then
117	-- These nodes have only one child, which needs recursion.
118	SU.debug("inputter", sep and (sep .. "Massaging a node"))	284✔
119	res = ast_from_parse_tree(tree[1], doc, depth)	568✔
120	--res = #res > 1 and not res.id and res or res[1]
121	elseif false or tree.id == "environment" or tree.id == "command" then	265✔
122	-- These nodes have multiple children, which need recursion.
123	SU.debug("inputter", sep and (sep .. "Processing command"), tree.command, #tree, "subtrees")	194✔
124	local newtree = { -- I don't think we can avoid a shallow copy here	194✔
125	command = tree.command,	194✔
126	options = tree.options,	194✔
127	id = tree.id,	194✔
128	lno = tree.lno,	194✔
129	col = tree.col,	194✔
130	}
131	for _, node in ipairs(tree) do	287✔
132	if type(node) == "table" then	93✔
133	SU.debug("inputter", sep and (sep .. " -"), node.id or "table")	67✔
134	local ast_node = ast_from_parse_tree(node, doc, depth)	67✔
135	if type(ast_node) == "table" and not ast_node.id then	67✔
136	SU.debug("inputter", sep and (sep .. " -"), "Collapsing subtree")	27✔
137	-- Comments can an empty table, skip them
138	if #ast_node > 0 then	27✔
139	-- Simplify the tree if it's just a plain list
140	for _, child in ipairs(ast_node) do	401✔
141	if type(child) ~= "table" or child.id or #child > 0 then	375✔
142	table.insert(newtree, child)	358✔
143	end
144	end
145	end
146	else
147	table.insert(newtree, ast_node)	40✔
148	end
149	end
150	-- Non table nodes are skipped (e.g. extraneous text from 'raw' commands)
151	end
152	res = newtree	194✔
153	elseif tree.id == "content" then	71✔
154	-- This node has multiple children, which need recursion
155	-- And the node itself needs to be replaced with its children
156	SU.debug("inputter", sep and (sep .. "Massage content node"), #tree, "subtrees")	71✔
157	local newtree = {} -- I don't think we can avoid a shallow copy here	71✔
158	for i, node in ipairs(tree) do	510✔
159	SU.debug("inputter", sep and (sep .. " -"), node.id)	439✔
160	newtree[i] = ast_from_parse_tree(node, doc, depth)	878✔
161	end
162	-- Simplify the tree if it has only one child
163	res = #newtree == 1 and not newtree.id and newtree[1] or newtree	71✔
164	elseif tree.id then	×
165	-- Shouldn't happen, or we missed something
166	SU.error("Unknown node type: " .. tree.id)	×
167	else
168	SU.debug("inputter", sep and (sep .. "Table node"), #tree, "subtrees")	×
169	res = #tree == 1 and tree[1] or tree	×
170	end
171	SU.debug("inputter", sep and (sep .. "Returning a"), type(res) == "table" and res.id or "string")	566✔
172	return res	566✔
173	end
174
175	function inputter:parse (doc)	22✔
176	local status, result = pcall(self._parser, doc)	20✔
177	if not status then	20✔
178	return SU.error(([[	×
179	Unable to parse input document to an AST tree
180
181	Parser error:
182
183	%s
184
185	thrown from document beginning.]]):format(pl.stringx.indent(result, 6)))	×
186	end
187	resetCache()	20✔
188	local top = ast_from_parse_tree(result[1], doc, 0)	20✔
189	local tree
190	-- Content not part of a tagged command could either be part of a document
191	-- fragment or junk (e.g. comments, whitespace) outside of a document tag. We
192	-- need to either capture the document tag only or decide this is a fragment
193	-- and wrap it in a document tag.
194	if top.command == "document" or top.command == "sile" then	20✔
195	tree = top	×
196	elseif type(top) == "table" then	20✔
197	for _, leaf in ipairs(top) do	20✔
198	if leaf.command and (leaf.command == "document" or leaf.command == "sile") then	20✔
199	tree = leaf	20✔
200	break	20✔
201	end
202	end
203	end
204	-- In the event we didn't isolate a top level document tag above, assume this
205	-- is a fragment and wrap it in one.
206	if not tree then	20✔
207	tree = { top, command = "document" }	×
208	end
209	return { tree }	20✔
210	end
211
212	return inputter	22✔

sile-typesetter / sile / 11658356834

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