1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
|
--
-- Copyright (c) 2021-2023 Zeping Lee
-- Released under the MIT license.
-- Repository: https://github.com/zepinglee/citeproc-lua
--
local core = {}
local citeproc = require("citeproc")
local bibtex2csl -- = require("citeproc-bibtex-parser") -- load on demand
local unicode = require("citeproc-unicode")
local util = citeproc.util
require("lualibs")
local latex_parser = require("citeproc-latex-parser")
core.locale_file_format = "csl-locales-%s.xml"
core.uncited_ids = {}
core.uncite_all_items = false
core.item_list = {}
core.item_dict = {}
function core.read_file(file_name, ftype, file_info)
if file_info then
file_info = unicode.capitalize(file_info)
else
file_info = "File"
end
local path = kpse.find_file(file_name, ftype)
if not path then
if ftype and not util.endswith(file_name, ftype) then
file_name = file_name .. ftype
end
util.error(string.format('%s "%s" not found', file_info, file_name))
return nil
end
local file = io.open(path, "r")
if not file then
util.error(string.format('Cannot open %s "%s"', file_info, path))
return nil
end
local contents = file:read("*a")
contents = util.remove_bom(contents)
file:close()
return contents
end
local function read_data_file(data_file)
local file_name = data_file
local extension = nil
local contents = nil
if util.endswith(data_file, ".json") then
extension = ".json"
contents = core.read_file(data_file, nil, "database file")
elseif util.endswith(data_file, ".bib") then
extension = ".bib"
contents = core.read_file(data_file, "bib", "database file")
else
local path = kpse.find_file(data_file .. ".json")
if path then
file_name = data_file .. ".json"
extension = ".json"
contents = core.read_file(data_file .. ".json", nil, "database file")
else
path = kpse.find_file(data_file, "bib")
if path then
file_name = data_file .. ".bib"
extension = ".bib"
contents = core.read_file(data_file, "bib", "database file")
else
util.error(string.format('Cannot find database file "%s"', data_file .. ".json"))
end
end
end
local csl_items = nil
if extension == ".json" then
local status, res = pcall(utilities.json.tolua, contents)
if status and res then
csl_items = res
for _, item in ipairs(csl_items) do
-- Jounal abbreviations
if item.type == "article-journal" or item.type == "article-magazine"
or item.type == "article-newspaper" then
util.check_journal_abbreviations(item)
end
end
else
util.error(string.format('JSON decoding error in file "%s"', data_file))
csl_items = {}
end
elseif extension == ".bib" then
bibtex2csl = bibtex2csl or require("citeproc-bibtex2csl")
csl_items = bibtex2csl.parse_bibtex_to_csl(contents, true, true, true, true)
end
return file_name, csl_items
end
local function read_data_files(data_files)
local item_list = {}
local item_dict = {}
for _, data_file in ipairs(data_files) do
local file_name, csl_items = read_data_file(data_file)
-- TODO: parse item_dict entries on demand
for _, item in ipairs(csl_items) do
local id = item.id
if item_dict[id] then
util.warning(string.format('Duplicate entry key "%s" in "%s".', id, file_name))
else
item_dict[id] = item
table.insert(item_list, item)
end
end
end
return item_list, item_dict
end
function core.make_citeproc_sys(data_files)
core.item_list, core.item_dict = read_data_files(data_files)
local citeproc_sys = {
retrieveLocale = function (lang)
local locale_file_format = core.locale_file_format or "locales-%s.xml"
local filename = string.format(locale_file_format, lang)
return core.read_file(filename)
end,
retrieveItem = function (id)
local res = core.item_dict[id]
return res
end
}
return citeproc_sys
end
---comment
---@param style_name string
---@param data_files string[]
---@param lang string?
---@return CiteProc?
function core.init(style_name, data_files, lang)
if style_name == "" or #data_files == 0 then
return nil
end
local style = core.read_file(style_name .. ".csl", nil, "style")
if not style then
util.error(string.format('Failed to load style "%s.csl"', style_name))
return nil
end
local force_lang = nil
if lang and lang ~= "" then
force_lang = true
else
lang = nil
end
local citeproc_sys = core.make_citeproc_sys(data_files)
local engine = citeproc.new(citeproc_sys, style, lang, force_lang)
return engine
end
local function parse_latex_seq(s)
local t = {}
for item in string.gmatch(s, "(%b{})") do
item = string.sub(item, 2, -2)
table.insert(t, item)
end
return t
end
local function parse_latex_prop(s)
local t = {}
for key, value in string.gmatch(s, "([%w%-]+)%s*=%s*(%b{})") do
value = string.sub(value, 2, -2)
if value == "true" then
value = true
elseif value == "false" then
value = false
end
t[key] = value
end
return t
end
function core.make_citation(citation_info)
-- `citation_info`: "citationID={ITEM-1@2},citationItems={{id={ITEM-1},label={page},locator={6}}},properties={noteIndex={3}}"
local citation = parse_latex_prop(citation_info)
-- assert(citation.citationID)
-- assert(citation.citationItems)
-- assert(citation.properties)
citation.citationItems = parse_latex_seq(citation.citationItems)
for i, item in ipairs(citation.citationItems) do
local citation_item = parse_latex_prop(item)
if citation_item.prefix then
-- util.debug(citation_item.prefix)
citation_item.prefix = latex_parser.latex_to_pseudo_html(citation_item.prefix, true, false)
-- util.debug(citation_item.prefix)
end
if citation_item.suffix then
citation_item.suffix = latex_parser.latex_to_pseudo_html(citation_item.suffix, true, false)
end
citation.citationItems[i] = citation_item
end
citation.properties = parse_latex_prop(citation.properties)
local note_index = citation.properties.noteIndex
if not note_index or note_index == "" then
citation.properties.noteIndex = 0
elseif type(note_index) == "string" and string.match(note_index, "^%d+$") then
citation.properties.noteIndex = tonumber(note_index)
else
util.error(string.format('Invalid note index "%s".', note_index))
end
return citation
end
function core.process_citations(engine, citations)
local citations_pre = {}
local citation_strings = {}
core.update_cited_and_uncited_ids(engine, citations)
for _, citation in ipairs(citations) do
if citation.citationID ~= "@nocite" then
-- local res = engine:processCitationCluster(citation, citations_pre, {})
-- for _, tuple in ipairs(res[2]) do
-- local citation_str = tuple[2]
-- local citation_id = tuple[3]
-- citation_strings[citation_id] = citation_str
-- util.debug(citation_str)
-- end
local citation_str = engine:process_citation(citation)
citation_strings[citation.citationID] = citation_str
table.insert(citations_pre, {citation.citationID, citation.properties.noteIndex})
end
end
return citation_strings
end
function core.update_cited_and_uncited_ids(engine, citations)
local id_list = {}
local id_map = {} -- Boolean map for checking if id in list
local uncited_id_list = {}
local uncited_id_map = {}
for _, citation in ipairs(citations) do
if citation.citationID == "@nocite" then
for _, cite_item in ipairs(citation.citationItems) do
if cite_item.id == "*" then
if not core.uncite_all_items then
for _, item in ipairs(core.item_list) do
if not uncited_id_map[item.id] then
table.insert(uncited_id_list, item.id)
uncited_id_map[item.id] = true
end
end
core.uncite_all_items = true
end
elseif not uncited_id_map[cite_item.id] then
table.insert(uncited_id_list, cite_item.id)
uncited_id_map[cite_item.id] = true
end
end
else -- Real citation
for _, cite_item in ipairs(citation.citationItems) do
if not id_map[cite_item.id] then
table.insert(id_list, cite_item.id)
id_map[cite_item.id] = true
end
end
end
end
engine:updateItems(id_list)
engine:updateUncitedItems(uncited_id_list)
end
---Convert to a filter object described in
--- <https://citeproc-js.readthedocs.io/en/latest/running.html#selective-output-with-makebibliography>
---@param filter_str string e.g., "type={book},notcategory={csl},notcategory={tex}"
---@return table
function core.parser_filter(filter_str)
local conditions = {}
for i, condition in ipairs(latex_parser.parse_seq(filter_str)) do
local negative
local field, value = string.match(condition, "(%w+)%s*=%s*{([^}]+)}")
if field then
if string.match(field, "^not") then
negative = true
field = string.gsub(field, "^not", "")
end
if field == "category" then
field = "categories"
end
if field == "keyword" or field == "type" or field == "categories" then
table.insert(conditions, {
field = field,
value = value,
negative = negative,
})
end
end
end
-- util.debug(conditions)
return {select = conditions}
end
---comment
---@param engine CiteProc
---@param option_str string
---@return unknown
function core.make_bibliography(engine, option_str)
local filter
local options = {}
if option_str and option_str ~= "" then
options = latex_parser.parse_prop(option_str)
filter = core.parser_filter(option_str)
end
local result = engine:makeBibliography(filter)
local params = result[1]
local bib_items = result[2]
local res = ""
---@type table<string, any>
local bib_options = {
index = options.index or "1"
}
local bib_option_map = {
["hanging-indent"] = "hangingindent",
["entry-spacing"] = "entryspacing",
["line-spacing"] = "linespacing",
["widest-label"] = "widest_label",
}
local bib_option_order = {
"index",
"hanging-indent",
"line-spacing",
"entry-spacing",
"widest-label",
}
for option, param in pairs(bib_option_map) do
if params[param] then
bib_options[option] = params[param]
end
end
local bib_option_list = {}
for _, option in ipairs(bib_option_order) do
local value = bib_options[option]
if value and value ~= "" then
table.insert(bib_option_list, string.format("%s = %s", option, tostring(value)))
end
end
local bib_options_str = table.concat(bib_option_list, ", ")
-- util.debug(params.bibstart)
-- if params.bibstart then
-- res = res .. params.bibstart
-- end
local bibstart = string.format("\\begin{thebibliography}{%s}\n", bib_options_str)
res = res .. bibstart
for _, bib_item in ipairs(bib_items) do
res = res .. "\n" .. bib_item
end
if params.bibend then
res = res .. "\n" .. params.bibend
end
return res
end
function core.set_categories(engine, categories_str)
-- util.debug(categories_str)
local category_dict = latex_parser.parse_prop(categories_str)
for category, keys in pairs(category_dict) do
category_dict[category] = latex_parser.parse_seq(keys)
end
for category, keys in pairs(category_dict) do
for _, key in ipairs(keys) do
local item = engine.registry.registry[key]
if item then
if not item.categories then
item.categories = {}
end
if not util.in_list(category, item.categories) then
table.insert(item.categories, category)
end
else
util.error(string.format("Invalid citation key '%s'.", key))
end
end
end
-- for id, item in pairs(csl.engine.registry.registry) do
-- util.debug(id)
-- util.debug(item.categories)
-- end
end
return core
|