9304060604

Committed 30 May 2024 02:07PM UTC coverage: 74.124% (-0.6%) from 74.707%

Build # 9304060604

Build Type

push

github

Committed by

alerque

Commit Message

style: Reformat Lua with stylua

Run Details

8104 of 11995 new or added lines in 184 files covered. (67.56%)

15 existing lines in 11 files now uncovered.

12444 of 16788 relevant lines covered (74.12%)

7175.1 hits per line

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

74.68

/packages/bibtex/init.lua

local base = require("packages.base")

local package = pl.class(base)
package._name = "bibtex"

local epnf = require("epnf")

local Bibliography

-- luacheck: push ignore
-- stylua: ignore start
---@diagnostic disable: undefined-global, unused-local, lowercase-global
local bibtexparser = epnf.define(function (_ENV)
   local identifier = (SILE.parserBits.identifier + S":-")^1
   local balanced = C{ "{" * P" "^0 * C(((1 - S"{}") + V(1))^0) * "}" } / function (...) local t={...}; return t[2] end
   local doubleq = C( P'"' * C(((1 - S'"\r\n\f\\') + (P'\\' * 1)) ^ 0) * '"' )
   local _ = WS^0
   local sep = S",;" * _
   local myID = C(identifier + P(1)) / function (t) return t end
   local myTag = C(identifier + P(1)) / function (t) return t:lower() end
   local value = balanced + doubleq + myID
   local pair = Cg(myTag * _ * "=" * _ * C(value)) * _ * sep^-1   / function (...) local t= {...}; return t[1], t[#t] end
   local list = Cf(Ct("") * pair^0, rawset)
   local commentKey = Cmt(R("az", "AZ")^1, function(_, _, a)
      return a:lower() == "comment"
   end)

   START "document"
   document = (V"comment" + V"entry")^1 -- order important: @comment must have precedence over @other
      * (-1 + E("Unexpected character at end of input"))
   comment  = WS +
      ( V"blockcomment" + (P"%" * (1-S"\r\n")^0 * S"\r\n") / function () return "" end) -- Don't bother telling me about comments
   blockcomment = (P("@") * commentKey) + balanced / function () return "" end -- Don't bother telling me about comments
   entry = Ct( P("@") * Cg(myTag, "type") * _ * P("{") * _ * Cg(myID, "label") * _ * sep * list * P("}") * _ )
end)
-- luacheck: pop
-- stylua: ignore end
---@diagnostic enable: undefined-global, unused-local, lowercase-global

local parseBibtex = function (fn)
   fn = SILE.resolveFile(fn) or SU.error("Unable to resolve Bibtex file " .. fn)
   local fh, e = io.open(fn)
   if e then
      SU.error("Error reading bibliography file: " .. e)
   end
   local doc = fh:read("*all")
   local t = epnf.parsestring(bibtexparser, doc)
   if not t or not t[1] or t.id ~= "document" then
      SU.error("Error parsing bibtex")
   end
   local entries = {}
   for i = 1, #t do
      if t[i].id == "entry" then
         local ent = t[i][1]
         entries[ent.label] = { type = ent.type, attributes = ent[1] }
      end
   end
   return entries
end

function package:_init ()
   base._init(self)
   SILE.scratch.bibtex = { bib = {} }
   Bibliography = require("packages.bibtex.bibliography")
end

function package.declareSettings (_)
   SILE.settings:declare({
      parameter = "bibtex.style",
      type = "string",
      default = "chicago",
      help = "BibTeX style",
   })
end

function package:registerCommands ()
   self:registerCommand("loadbibliography", function (options, _)
      local file = SU.required(options, "file", "loadbibliography")
      SILE.scratch.bibtex.bib = parseBibtex(file) -- Later we'll do multiple bibliogs, but not now
   end)

   self:registerCommand("bibstyle", function (_, content)
      SU.deprecated("\\bibstyle", "\\set[parameter=bibtex.style]", "0.13.2", "0.14.0")
      if type(content) == "table" then
         content = content[1]
      end
      if type(content) == "string" then
         SILE.settings:set("bibtex.style", content)
      end
   end)

   self:registerCommand("cite", function (options, content)
      if not options.key then
         options.key = SU.contentToString(content)
      end
      local style = SILE.settings:get("bibtex.style")
      local bibstyle = require("packages.bibtex.styles." .. style)
      local cite = Bibliography.produceCitation(options, SILE.scratch.bibtex.bib, bibstyle)
      if cite == Bibliography.Errors.UNKNOWN_REFERENCE then
         SU.warn("Unknown reference in citation " .. options.key)
         return
      end
      SILE.processString(("<sile>%s</sile>"):format(cite), "xml")
   end)

   self:registerCommand("reference", function (options, content)
      if not options.key then
         options.key = SU.contentToString(content)
      end
      local style = SILE.settings:get("bibtex.style")
      local bibstyle = require("packages.bibtex.styles." .. style)
      local cite, err = Bibliography.produceReference(options, SILE.scratch.bibtex.bib, bibstyle)
      if cite == Bibliography.Errors.UNKNOWN_REFERENCE then
         SU.warn("Unknown reference in citation " .. tostring(options.key))
         return
      end
      if cite == Bibliography.Errors.UNKNOWN_TYPE then
         SU.warn("Unknown type @" .. err .. " in citation for reference " .. options.key)
         return
      end
      SILE.processString(("<sile>%s</sile>"):format(cite), "xml")
   end)
end

package.documentation = [[
\begin{document}
BibTeX is a citation management system.
It was originally designed for TeX but has since been integrated into a variety of situations.

This experimental package allows SILE to read and process BibTeX \code{.bib} files and output citations and full text references.
(It doesn’t currently produce full bibliography listings.)

To load a BibTeX file, issue the command \autodoc:command{\loadbibliography[file=<whatever.bib>]}

To produce an inline citation, call \autodoc:command{\cite{<key>}}, which will typeset something like “Jones 1982”.
If you want to cite a particular page number, use \autodoc:command{\cite[page=22]{<key>}}.

To produce a full reference, use \autodoc:command{\reference{<key>}}.

Currently, the only supported bibliography style is Chicago referencing, but other styles should be easy to implement.
Adapt \code{packages/bibtex/styles/chicago.lua} as necessary.
\end{document}
]]

return package

1	local base = require("packages.base")	1✔
2
3	local package = pl.class(base)	1✔
4	package._name = "bibtex"	1✔
5
6	local epnf = require("epnf")	1✔
7
8	local Bibliography
9
10	-- luacheck: push ignore
11	-- stylua: ignore start
12	---@diagnostic disable: undefined-global, unused-local, lowercase-global
13	local bibtexparser = epnf.define(function (_ENV)	2✔
14	local identifier = (SILE.parserBits.identifier + S":-")^1	1✔
15	local balanced = C{ "{" * P" "^0 * C(((1 - S"{}") + V(1))^0) * "}" } / function (...) local t={...}; return t[2] end	3✔
16	local doubleq = C( P'"' * C(((1 - S'"\r\n\f\\') + (P'\\' * 1)) ^ 0) * '"' )	1✔
17	local _ = WS^0	1✔
18	local sep = S",;" * _	1✔
19	local myID = C(identifier + P(1)) / function (t) return t end	65✔
20	local myTag = C(identifier + P(1)) / function (t) return t:lower() end	198✔
21	local value = balanced + doubleq + myID	1✔
22	local pair = Cg(myTag * _ * "=" * _ * C(value)) * _ * sep^-1 / function (...) local t= {...}; return t[1], t[#t] end	174✔
23	local list = Cf(Ct("") * pair^0, rawset)	1✔
24	local commentKey = Cmt(R("az", "AZ")^1, function(_, _, a)	2✔
25	return a:lower() == "comment"	52✔
26	end)
27
28	START "document"	1✔
29	document = (V"comment" + V"entry")^1 -- order important: @comment must have precedence over @other	1✔
30	* (-1 + E("Unexpected character at end of input"))	2✔
31	comment = WS +	1✔
32	( V"blockcomment" + (P"%" * (1-S"\r\n")^0 * S"\r\n") / function () return "" end) -- Don't bother telling me about comments	76✔
33	blockcomment = (P("@") * commentKey) + balanced / function () return "" end -- Don't bother telling me about comments	3✔
34	entry = Ct( P("@") * Cg(myTag, "type") * _ * P("{") * _ * Cg(myID, "label") * _ * sep * list * P("}") * _ )	1✔
35	end)
36	-- luacheck: pop
37	-- stylua: ignore end
38	---@diagnostic enable: undefined-global, unused-local, lowercase-global
39
40	local parseBibtex = function (fn)
41	fn = SILE.resolveFile(fn) or SU.error("Unable to resolve Bibtex file " .. fn)	2✔
42	local fh, e = io.open(fn)	1✔
43	if e then	1✔
NEW 44	SU.error("Error reading bibliography file: " .. e)	×
45	end
46	local doc = fh:read("*all")	1✔
47	local t = epnf.parsestring(bibtexparser, doc)	1✔
48	if not t or not t[1] or t.id ~= "document" then	1✔
NEW 49	SU.error("Error parsing bibtex")	×
50	end
51	local entries = {}	1✔
52	for i = 1, #t do	121✔
53	if t[i].id == "entry" then	120✔
54	local ent = t[i][1]	24✔
55	entries[ent.label] = { type = ent.type, attributes = ent[1] }	24✔
56	end
57	end
58	return entries	1✔
59	end
60
61	function package:_init ()	1✔
62	base._init(self)	1✔
63	SILE.scratch.bibtex = { bib = {} }	1✔
64	Bibliography = require("packages.bibtex.bibliography")	1✔
65	end
66
67	function package.declareSettings (_)	1✔
68	SILE.settings:declare({	1✔
69	parameter = "bibtex.style",
70	type = "string",
71	default = "chicago",
72	help = "BibTeX style",
73	})
74	end
75
76	function package:registerCommands ()	1✔
77	self:registerCommand("loadbibliography", function (options, _)	2✔
78	local file = SU.required(options, "file", "loadbibliography")	1✔
79	SILE.scratch.bibtex.bib = parseBibtex(file) -- Later we'll do multiple bibliogs, but not now	2✔
80	end)
81
82	self:registerCommand("bibstyle", function (_, content)	2✔
NEW 83	SU.deprecated("\\bibstyle", "\\set[parameter=bibtex.style]", "0.13.2", "0.14.0")	×
NEW 84	if type(content) == "table" then	×
NEW 85	content = content[1]	×
86	end
NEW 87	if type(content) == "string" then	×
NEW 88	SILE.settings:set("bibtex.style", content)	×
89	end
90	end)
91
92	self:registerCommand("cite", function (options, content)	2✔
NEW 93	if not options.key then	×
NEW 94	options.key = SU.contentToString(content)	×
95	end
NEW 96	local style = SILE.settings:get("bibtex.style")	×
NEW 97	local bibstyle = require("packages.bibtex.styles." .. style)	×
NEW 98	local cite = Bibliography.produceCitation(options, SILE.scratch.bibtex.bib, bibstyle)	×
NEW 99	if cite == Bibliography.Errors.UNKNOWN_REFERENCE then	×
NEW 100	SU.warn("Unknown reference in citation " .. options.key)	×
NEW 101	return	×
102	end
NEW 103	SILE.processString(("<sile>%s</sile>"):format(cite), "xml")	×
104	end)
105
106	self:registerCommand("reference", function (options, content)	2✔
107	if not options.key then	24✔
108	options.key = SU.contentToString(content)	48✔
109	end
110	local style = SILE.settings:get("bibtex.style")	24✔
111	local bibstyle = require("packages.bibtex.styles." .. style)	24✔
112	local cite, err = Bibliography.produceReference(options, SILE.scratch.bibtex.bib, bibstyle)	24✔
113	if cite == Bibliography.Errors.UNKNOWN_REFERENCE then	24✔
NEW 114	SU.warn("Unknown reference in citation " .. tostring(options.key))	×
NEW 115	return	×
116	end
117	if cite == Bibliography.Errors.UNKNOWN_TYPE then	24✔
NEW 118	SU.warn("Unknown type @" .. err .. " in citation for reference " .. options.key)	×
NEW 119	return	×
120	end
121	SILE.processString(("<sile>%s</sile>"):format(cite), "xml")	24✔
122	end)
123	end
124
125	package.documentation = [[
126	\begin{document}
127	BibTeX is a citation management system.
128	It was originally designed for TeX but has since been integrated into a variety of situations.
129
130	This experimental package allows SILE to read and process BibTeX \code{.bib} files and output citations and full text references.
131	(It doesn’t currently produce full bibliography listings.)
132
133	To load a BibTeX file, issue the command \autodoc:command{\loadbibliography[file=<whatever.bib>]}
134
135	To produce an inline citation, call \autodoc:command{\cite{<key>}}, which will typeset something like “Jones 1982”.
136	If you want to cite a particular page number, use \autodoc:command{\cite[page=22]{<key>}}.
137
138	To produce a full reference, use \autodoc:command{\reference{<key>}}.
139
140	Currently, the only supported bibliography style is Chicago referencing, but other styles should be easy to implement.
141	Adapt \code{packages/bibtex/styles/chicago.lua} as necessary.
142	\end{document}
143	]]	1✔
144
145	return package	1✔

sile-typesetter / sile / 9304060604

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