-
Notifications
You must be signed in to change notification settings - Fork 367
/
latex_cite_completions.py
559 lines (481 loc) · 19.3 KB
/
latex_cite_completions.py
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
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
'''
This module implements the cite-completion behaviour, largely by relying on
implementations registered with latextools_plugin and configured using the
`bibliograph_plugins` configuration key.
At present, there is one supported method on custom plugins.
`get_entries`:
This method should take a sequence of bib_files and return a sequence of
Mapping-like objects where the key corresponds to a Bib(La)TeX key and
returns the matching value. We provide default fallbacks for any of the
quick panel formatting options that might not be automatically mapped to
a field, e.g., `author_short`, etc. or to deal with missing data, e.g.
entries that have no `journal` but use the `journaltitle` field. Plugins
can override this behaviour, however, by explicitly setting a value for
whatever key they like.
'''
import sublime
from . import getTeXRoot
from .kpsewhich import kpsewhich
from .latex_fill_all import FillAllHelper
from .latextools_utils import (
analysis, bibformat, cache, get_setting
)
from . import latextools_plugin
import os
import re
import traceback
class NoBibFilesError(Exception):
pass
class BibParsingError(Exception):
def __init__(self, filename=""):
self.filename = filename
class BibPluginError(Exception):
pass
OLD_STYLE_CITE_REGEX = re.compile(r"([^_]*_)?\*?([a-z]*?)etic\\")
# I apoligise profusely for this regex
# forward version with explanation:
# \\
# (?:
# (?#
# first branch matches \foreigntextquote,
# \hypentextquote, \foreignblockquote, \hyphenblockquote,
# \hybridblockquote and starred versions
# syntax is:
# \foreigntextquote{lang}[key][punct]{text}
# )
# (?:foreign|hyphen|hybrid(?=block))(?:text|block)quote\*?
# \{[^}]*\}\[(?:(?:[^[\],]*,)*)?|
# (?#
# second branch matches \textquote, \blockquote and
# starred versions
# syntax is:
# \textquote[key]{text}
# )
# (?:text|block)quote\*?\[(?:(?:[^[\],]*,)*)?|
# (?#
# third branch matches \foreigntextcquote,
# \hyphentextcquote, \foreignblockcquote, \hypenblockcquote,
# \hybridblockcquote and starred versions
# syntax is:
# \foreigntextcquote{lang}[prenote][postnote]{key}{text}
# )
# (?:foreign|hyphen|hybrid(?=block))(?:text|block)cquote\*?
# \{[^}]*\}(?:\[[^\]]*\]){0,2}\{(?:(?:[^{},]*,)*)?|
# (?#
# fourth branch matches \textcquote, \blockcquote and
# starred versions
# syntax is:
# \textcquote[prenote][postnote]{key}{text}
# )
# (?:text|block)cquote\*?(?:\[[^\]]*\]){0,2}\{(?:(?:[^{},]*,)*)?|
# (?#
# fifth branch matches \volcite and friends
# syntax is:
# \volcite[prenote]{volume}[page]{key}
# )
# (?:p|P|f|ft|s|S|t|T|a|A)?volcite
# (?:\[[^\]]*\])?\{[^}]*\}(?:\[[^\]]*\])?\{(?:(?:[^{},]*,)*)?|
# (?#
# sixth branch matches \volcites and friends
# syntax is:
# \volcites(multiprenote)(multipostnote)[prenote]{volume}[page]{key}
# ...[prenote]{volume}[page]{key}
# )
# (?:p|P|f|ft|s|S|t|T|a|A)?volcites
# (?:\([^)]*\)){0,2}
# (?:(?:\[[^\]]*\])?\{[^}]*\}
# (?:\[[^\]]*\])?\{(?:(?:[^{},]*,)*)?(?:\}(?=.*?\{))?){1,}|
# (?#
# seventh branch matches \cites and friends, excluding \volcite
# syntax is:
# \cites(multiprenote)(multipostnote)[prenote][postnote]{key}
# ...[prenote][postnote]{key}
# )
# (?:(?!(?:p|P|f|ft|s|S|t|T|a|A)?volcites)
# (?:[A-Z]?[a-z]*c)|C)ites(?!style)
# (?:\([^)]*\)){0,2}
# (?:(?:\[[^\]]*\]){0,2}\{(?:(?:[^{},]*,)*)?(?:\}(?=.*?\{))?){1,}|
# (?#
# eighth branch matches most everything else, excluding \volcite,
# \mcite, \citereset and \citestyle
# syntax is:
# \cite[<prenote>][<postnote>]{key}
# )
# (?:(?!(?:p|P|f|ft|s|S|t|T|a|A)?volcite|mcite)
# (?:[A-Z]?[a-z]*c)|C)ite(?!reset\*?|style)([a-zX*]*?)
# ([.*?]){0,2}(?:\[[^\]]*\]){0,2}\{(?:(?:[^{},]*,)*)?|
# (?#
# ninth branch matches apacite commands
# syntax is:
# \citeA<prenote>[postnote]{key}
# )
# (?:mask)?(?:full|short)cite
# (?:(?:author|year)(?:NP)?|NP|A)?
# (?:<[^>]*>)?(?:\[[^\]]*\])?\{(?:(?:[^{},]*,)*)?)$
NEW_STYLE_CITE_REGEX = re.compile(
r"""(?:
(?:(?P<prefix1>[^\[\],]*)(?:,[^\[\],]*)*\[\}[^\{]*\{
\*?etouq(?:kcolb|txet)(?:ngierof|nehpyh|(?<=kcolb)dirbyh))|
(?:(?P<prefix2>[^\[\],]*)(?:,[^\[\],]*)*\[\*?etouq(?:kcolb|txet))|
(?:(?P<prefix3>[^{},]*)(?:,[^{},]*)*\{(?:\][^\[]*\[){0,2}\}[^\{]*\{
\*?etouqc(?:kcolb|txet)(?:ngierof|nehpyh|(?<=kcolb)dirbyh))|
(?:(?P<prefix4>[^{},]*)(?:,[^{},]*)*\{(?:\][^\[]*\[){0,2}
\*?etouqc(?:kcolb|txet))|
(?:(?P<prefix5>[^{},]*)(?:,[^{},]*)*\{(?:\][^\[]*\[)?\}[^\{}]*\{(?:\][^\[]*\[)?
eticlov(?:p|P|f|ft|s|S|t|T|a|A)?)|
(?:(?P<prefix6>[^{},]*)(?:,[^{},]*)*\{(?:\][^\[]*\[)?\}[^\{}]*\{(?:\][^\[]*\[)?
(?:\}[^\{}]*\{(?:\][^\[]*\[)?\}[^\{}]*\{(?:\][^\[]*\[)?)*
(?:\)[^(]*\(){0,2}
seticlov(?:p|P|f|ft|s|S|t|T|a|A)?)|
(?:(?P<prefix7>[^{},]*)(?:,[^{},]*)*\{(?:\][^\[]*\[){0,2}
(?:\}[^\}]*\{(?:\][^\[]*\[){0,2})*
(?:[\.\*\?]){0,2}(?:\)[^(]*\(){0,2}
seti(?:C|c(?!lov)[a-z]*[A-Z]?))|
(?:(?P<prefix8>[^{},]*)(?:,[^{},]*)*\{(?:\][^\[]*\[){0,2}
(?:[\.\*\?]){0,2}(?!\*?teser|elyts)(?P<fancy_cite>[a-z\*]*?)
eti(?:C|c(?!lov|m\\)[a-z]*[A-Z]?))|
(?:(?P<prefix9>[^{},]*)(?:,[^{},]*)*\{(?:\][^\[]*\[)?
(?:>[^<]*<)?(?:(?:PN)?(?:raey|rohtua)|PN|A)?etic
(?:lluf|trohs)?(?:ksam)?)|
(?:(?P<prefix10>[^{},]*)\{yrtnebib)
)\\""", re.X)
def match(rex, str):
m = rex.match(str)
if m:
return m.group(0)
else:
return None
# find bib files
# recursively search all linked tex files to find all
# included bibliography tags in the document and extract
# the absolute filepaths of the bib files
# known bibliography commands
SINGLE_BIBCOMMANDS = set([
'addbibresource',
'addglobalbib',
'addsectionbib'
])
MULTI_BIBCOMMANDS = set([
'bibliography',
'nobibliography'
])
# filter for find_bib_files
def _bibfile_filter(c):
return (
c.command in SINGLE_BIBCOMMANDS or
c.command in MULTI_BIBCOMMANDS or
c.command == 'newrefsection' or
(
c.command == 'begin' and
c.args == 'refsection'
)
)
def find_bib_files(root):
def _find_bib_files():
# the final list of bib files
result = []
# a list of candidates bib files to check
resources = []
# load the analysis
doc = analysis.get_analysis(root)
# we use ALL_COMMANDS here as any flag will filter some command
# we want to support
flags = analysis.ALL_COMMANDS | analysis.ONLY_COMMANDS_WITH_ARGS
for c in doc.filter_commands(
_bibfile_filter, flags=flags
):
# process the matching commands
# \begin{refsection} / \newrefsection
# resource is specified as an optional argument argument
if (
c.command == 'begin' or c.command == 'newrefsection'
):
# NB if the resource doesn't end with .bib, assume its a label
# for a bibliography defined elsewhere or a non-.bib file
# which we don't handle
resources.extend([
s.strip() for s in (c.optargs or '').split(',')
if s.endswith('.bib')])
# \bibliography / \nobibliography
elif c.command in MULTI_BIBCOMMANDS:
for s in c.args.split(','):
s = s.strip()
if not s:
continue
if not s.endswith('.bib'):
s += '.bib'
resources.append(s)
# standard biblatex commands
else:
# bib file must be followed by .bib
if c.args.endswith('.bib'):
resources.append(c.args)
# extract absolute filepath for each bib file
rootdir = os.path.dirname(root)
for res in resources:
# We join with rootdir, the dir of the master file
candidate_file = os.path.normpath(os.path.join(rootdir, res))
# if the file doesn't exist, search the default tex paths
if not os.path.exists(candidate_file):
candidate_file = kpsewhich(res, 'mlbib')
if candidate_file is not None and os.path.exists(candidate_file):
result.append(candidate_file)
# remove duplicates
return list(set(result))
# since the processing can be a bit intensive, cache the results
result = cache.LocalCache(root).cache('bib_files', _find_bib_files)
# TODO temporary workaround to ensure the result is a sequence
if not hasattr(type(result), '__iter__'):
result = _find_bib_files()
try:
cache.LocalCache(root).set('bib_files', result)
except:
pass
# if a an additional_file is set append it to the result
additional_file = get_setting("additional_bibliography_file")
if additional_file:
def _make_abs_path(file_path):
if not file_path.endswith(".bib"):
file_path += ".bib"
if not os.path.isabs(file_path):
root_folder, _ = os.path.split(root)
file_path = os.path.join(root_folder, file_path)
return os.path.normpath(file_path)
if isinstance(additional_file, str):
additional_file = [additional_file]
additional_file = map(_make_abs_path, additional_file)
additional_file = filter(os.path.isfile, additional_file)
result = list(additional_file) + list(result)
return result
def run_plugin_command(command, *args, **kwargs):
'''
This function is intended to run a command against a user-configurable list
of bibliography plugins set using the `bibliography` setting.
Parameters:
`command`: a string representing the command to invoke, which should
generally be the name of a function to be called on the plugin
class.
`*args`: the args to pass to the function
`**kwargs`: the keyword args to pass to the function
Additionally, the following keyword parameters can be specified to control
how this function works:
`stop_on_first`: if True (default), no more attempts will be made to
run the command after the first plugin that returns a non-None
result
`expect_result`: if True (default), a BibPluginError will be raised if
no plugin returns a non-None result
Example:
run_plugin_command('get_entries', *bib_files)
This will attempt to invoke the `get_entries` method of any configured
plugin, passing in the discovered bib_files, and returning the result.
The general assumption of this function is that we only care about the
first valid result returned from a plugin and that plugins that should not
handle a request will either not implement the method or implement a
version of the method which raises a NotImplementedError if that plugin
should not handle the current situation.
'''
stop_on_first = kwargs.pop('stop_on_first', True)
expect_result = kwargs.pop('expect_result', True)
def _run_command(plugin_name):
plugin = None
try:
plugin = latextools_plugin.get_plugin(plugin_name)
except latextools_plugin.NoSuchPluginException:
pass
if not plugin:
error_message = (
'Could not find bibliography plugin named {0}. '
'Please ensure your LaTeXTools.sublime-settings is configured'
'correctly.'.format(plugin_name))
print(error_message)
raise BibPluginError(error_message)
# instantiate plugin
try:
plugin = plugin()
except:
error_message = (
'Could not instantiate {0}. {0} must have a no-args __init__ '
'method'.format(type(plugin).__name__,))
print(error_message)
raise BibPluginError(error_message)
try:
result = getattr(plugin, command)(*args, **kwargs)
except TypeError as e:
if "'{0}()'".format(command) in str(e):
error_message = (
'{1} is not properly implemented by {0}.'.format(
type(plugin).__name__,
command))
print(error_message)
raise BibPluginError(error_message)
else:
raise e
except AttributeError as e:
if "'{0}'".format(command) in str(e):
error_message = '{0} does not implement `{1}`'.format(
type(plugin).__name__, command)
print(error_message)
raise BibPluginError(error_message)
else:
raise e
except NotImplementedError:
return None
return result
plugins = get_setting('bibliography', ['traditional'])
if not plugins:
print('bibliography setting is blank. Loading traditional plugin.')
plugins = 'traditional'
result = None
if isinstance(plugins, str):
if not plugins.endswith('_bibliography'):
plugins = '{0}_bibliography'.format(plugins)
result = _run_command(plugins)
else:
for plugin_name in plugins:
if not plugin_name.endswith('_bibliography'):
plugin_name = '{0}_bibliography'.format(plugin_name)
try:
result = _run_command(plugin_name)
except BibPluginError:
continue
if stop_on_first and result is not None:
break
if expect_result and result is None:
raise BibPluginError(
"Could not find a plugin to handle '{0}'. "
"See the console for more details".format(command))
return result
def get_cite_completions(view):
root = getTeXRoot.get_tex_root(view)
if root is None:
# This is an unnamed, unsaved file
# FIXME: should probably search the buffer instead of giving up
raise NoBibFilesError()
print(u"TEX root: " + repr(root))
bib_files = find_bib_files(root)
print("Bib files found: ")
print(repr(bib_files))
if not bib_files:
# sublime.error_message("No bib files found!") # here we can!
raise NoBibFilesError()
completions = run_plugin_command('get_entries', *bib_files)
return completions
# called by LatextoolsFillAllCommand; provides citations for cite commands
class CiteFillAllHelper(FillAllHelper):
def get_auto_completions(self, view, prefix, line):
# Reverse, to simulate having the regex
# match backwards (cool trick jps btw!)
line = line[::-1]
# Check the first location looks like a cite_, but backward
old_style = OLD_STYLE_CITE_REGEX.match(line)
# Do not match on plain "cite[a-zX*]*?" when autocompleting,
# in case the user is typing something else
if old_style and not prefix:
return []
try:
completions = get_cite_completions(view)
except NoBibFilesError:
print("No bib files found!")
sublime.status_message("No bib files found!")
return []
except BibParsingError as e:
message = "Error occurred parsing {0}. {1}.".format(
e.filename, e.message)
print(message)
traceback.print_exc()
sublime.status_message(message)
return []
if prefix:
lower_prefix = prefix.lower()
completions = [
c for c in completions
if _is_prefix(lower_prefix, c)
]
if len(completions) == 0:
return []
cite_autocomplete_format = get_setting(
'cite_autocomplete_format', '{keyword}: {title}'
)
def formatted_entry(entry):
try:
return entry['<autocomplete_formatted>']
except:
return bibformat.format_entry(cite_autocomplete_format, entry)
completions = [
(
formatted_entry(c),
c['keyword']
) for c in completions
]
if old_style:
return completions, '{'
else:
return completions
def get_completions(self, view, prefix, line):
try:
completions = get_cite_completions(view)
except NoBibFilesError:
sublime.error_message("No bib files found!")
return
except BibParsingError as e:
traceback.print_exc()
sublime.error_message(
"Error occurred parsing {0}. {1}.".format(
e.filename, e.message
)
)
return
if prefix:
lower_prefix = prefix.lower()
completions = [
c for c in completions
if _is_prefix(lower_prefix, c)
]
completions_length = len(completions)
if completions_length == 0:
return
elif completions_length == 1:
return [completions[0]['keyword']]
cite_panel_format = get_setting(
'cite_panel_format',
["{title} ({keyword})", "{author}"]
)
def formatted_entry(entry):
try:
result = entry["<panel_formatted>"]
if isinstance(result, tuple):
result = list(result)
return result
except:
return [
bibformat.format_entry(s, entry)
for s in cite_panel_format
]
formatted_completions = []
result_completions = []
for completion in completions:
formatted_completions.append(formatted_entry(completion))
result_completions.append(completion['keyword'])
return formatted_completions, result_completions
def matches_line(self, line):
return bool(
OLD_STYLE_CITE_REGEX.match(line) or
NEW_STYLE_CITE_REGEX.match(line)
)
def matches_fancy_prefix(self, line):
return bool(OLD_STYLE_CITE_REGEX.match(line))
def is_enabled(self):
return get_setting('cite_auto_trigger', True)
def _is_prefix(lower_prefix, entry):
try:
return lower_prefix in entry["<prefix_match>"]
except:
return lower_prefix in bibformat.create_prefix_match_str(entry)
def plugin_loaded():
# load plugins from the bibliography_plugins dir of LaTeXTools if it exists
# this allows us to have pre-packaged plugins that won't require any user
# setup
os_path = os.path
latextools_plugin.add_plugin_path(
os_path.join(
sublime.packages_path(), 'LaTeXTools', 'bibliography_plugins'))