summaryrefslogtreecommitdiffstats
path: root/autoload/vimtex/qf/biblatex.vim
diff options
context:
space:
mode:
Diffstat (limited to 'autoload/vimtex/qf/biblatex.vim')
-rw-r--r--autoload/vimtex/qf/biblatex.vim250
1 files changed, 250 insertions, 0 deletions
diff --git a/autoload/vimtex/qf/biblatex.vim b/autoload/vimtex/qf/biblatex.vim
new file mode 100644
index 00000000..2e5e08a5
--- /dev/null
+++ b/autoload/vimtex/qf/biblatex.vim
@@ -0,0 +1,250 @@
+if !exists('g:polyglot_disabled') || index(g:polyglot_disabled, 'latex') == -1
+
+" vimtex - LaTeX plugin for Vim
+"
+" Maintainer: Karl Yngve LervÄg
+" Email: karl.yngve@gmail.com
+"
+
+function! vimtex#qf#biblatex#addqflist(blg) abort " {{{1
+ if get(g:vimtex_quickfix_blgparser, 'disable') | return | endif
+
+ try
+ call s:biblatex.addqflist(a:blg)
+ catch /biblatex Aborted/
+ endtry
+endfunction
+
+" }}}1
+
+let s:biblatex = {
+ \ 'file' : '',
+ \ 'types' : [],
+ \ 'db_files' : [],
+ \}
+function! s:biblatex.addqflist(blg) abort " {{{1
+ let self.file = a:blg
+ let self.root = fnamemodify(a:blg, ':h')
+ if empty(self.file) | throw 'biblatex Aborted' | endif
+
+ let self.types = map(
+ \ filter(items(s:), 'v:val[0] =~# ''^type_'''),
+ \ 'v:val[1]')
+ let self.db_files = []
+
+ let self.errorformat_saved = &l:errorformat
+ setlocal errorformat=%+E%.%#\>\ ERROR%m
+ setlocal errorformat+=%+W%.%#\>\ WARN\ -\ Duplicate\ entry%m
+ setlocal errorformat+=%+W%.%#\>\ WARN\ -\ The\ entry%.%#cannot\ be\ encoded%m
+ setlocal errorformat+=%-G%.%#
+ execute 'caddfile' fnameescape(self.file)
+ let &l:errorformat = self.errorformat_saved
+
+ call self.fix_paths()
+endfunction
+
+" }}}1
+function! s:biblatex.fix_paths() abort " {{{1
+ let l:qflist = getqflist()
+ try
+ let l:title = getqflist({'title': 1})
+ catch /E118/
+ let l:title = 'Vimtex errors'
+ endtry
+
+ for l:qf in l:qflist
+ for l:type in self.types
+ if l:type.fix(self, l:qf) | break | endif
+ endfor
+ endfor
+
+ call setqflist(l:qflist, 'r')
+
+ " Set title if supported
+ try
+ call setqflist([], 'r', l:title)
+ catch
+ endtry
+endfunction
+
+" }}}1
+function! s:biblatex.get_db_files() abort " {{{1
+ if empty(self.db_files)
+ let l:preamble = vimtex#parser#preamble(b:vimtex.tex, {
+ \ 'root' : b:vimtex.root,
+ \})
+ let l:files = map(
+ \ filter(l:preamble, 'v:val =~# ''\\addbibresource'''),
+ \ 'matchstr(v:val, ''{\zs.*\ze}'')')
+ let self.db_files = []
+ for l:file in l:files
+ if filereadable(l:file)
+ let self.db_files += [l:file]
+ elseif filereadable(expand(l:file))
+ let self.db_files += [expand(l:file)]
+ else
+ let l:cand = vimtex#kpsewhich#run(l:file)
+ if len(l:cand) == 1
+ let self.db_files += [l:cand[0]]
+ endif
+ endif
+ endfor
+ endif
+
+ return self.db_files
+endfunction
+
+" }}}1
+function! s:biblatex.get_filename(name) abort " {{{1
+ if !filereadable(a:name)
+ for l:root in [self.root, b:vimtex.root]
+ let l:candidate = fnamemodify(simplify(l:root . '/' . a:name), ':.')
+ if filereadable(l:candidate)
+ return l:candidate
+ endif
+ endfor
+ endif
+
+ return a:name
+endfunction
+
+" }}}1
+function! s:biblatex.get_key_pos(key) abort " {{{1
+ for l:file in self.get_db_files()
+ let l:lnum = self.get_key_lnum(a:key, l:file)
+ if l:lnum > 0
+ return [l:file, l:lnum]
+ endif
+ endfor
+
+ return []
+endfunction
+
+" }}}1
+function! s:biblatex.get_key_lnum(key, filename) abort " {{{1
+ if !filereadable(a:filename) | return 0 | endif
+
+ let l:lines = readfile(a:filename)
+ let l:lnums = range(len(l:lines))
+ let l:annotated_lines = map(l:lnums, '[v:val, l:lines[v:val]]')
+ let l:matches = filter(l:annotated_lines, 'v:val[1] =~# ''^\s*@\w*{\s*\V' . a:key . '''')
+
+ return len(l:matches) > 0 ? l:matches[-1][0]+1 : 0
+endfunction
+
+" }}}1
+function! s:biblatex.get_entry_key(filename, lnum) abort " {{{1
+ for l:file in self.get_db_files()
+ if fnamemodify(l:file, ':t') !=# a:filename | continue | endif
+
+ let l:entry = get(filter(readfile(l:file, 0, a:lnum), 'v:val =~# ''^@'''), -1)
+ if empty(l:entry) | continue | endif
+
+ return matchstr(l:entry, '{\v\zs.{-}\ze(,|$)')
+ endfor
+
+ return ''
+endfunction
+
+" }}}1
+
+"
+" Parsers for the various warning types
+"
+
+let s:type_parse_error = {}
+function! s:type_parse_error.fix(ctx, entry) abort " {{{1
+ if a:entry.text =~# 'ERROR - BibTeX subsystem.*expected end of entry'
+ let l:matches = matchlist(a:entry.text, '\v(\S*\.bib).*line (\d+)')
+ let a:entry.filename = a:ctx.get_filename(fnamemodify(l:matches[1], ':t'))
+ let a:entry.lnum = l:matches[2]
+
+ " Use filename and line number to get entry name
+ let l:key = a:ctx.get_entry_key(a:entry.filename, a:entry.lnum)
+ if !empty(l:key)
+ let a:entry.text = 'biblatex: Error parsing entry with key "' . l:key . '"'
+ endif
+ return 1
+ endif
+endfunction
+
+" }}}1
+
+let s:type_duplicate = {}
+function! s:type_duplicate.fix(ctx, entry) abort " {{{1
+ if a:entry.text =~# 'WARN - Duplicate entry'
+ let l:matches = matchlist(a:entry.text, '\v: ''(\S*)'' in file ''(.{-})''')
+ let l:key = l:matches[1]
+ let a:entry.filename = a:ctx.get_filename(l:matches[2])
+ let a:entry.lnum = a:ctx.get_key_lnum(l:key, a:entry.filename)
+ let a:entry.text = 'biblatex: Duplicate entry key "' . l:key . '"'
+ return 1
+ endif
+endfunction
+
+" }}}1
+
+let s:type_no_driver = {}
+function! s:type_no_driver.fix(ctx, entry) abort " {{{1
+ if a:entry.text =~# 'No driver for entry type'
+ let l:key = matchstr(a:entry.text, 'entry type ''\v\zs.{-}\ze''')
+ let a:entry.text = 'biblatex: Using fallback driver for ''' . l:key . ''''
+
+ let l:pos = a:ctx.get_key_pos(l:key)
+ if !empty(l:pos)
+ let a:entry.filename = a:ctx.get_filename(l:pos[0])
+ let a:entry.lnum = l:pos[1]
+ if has_key(a:entry, 'bufnr')
+ unlet a:entry.bufnr
+ endif
+ endif
+
+ return 1
+ endif
+endfunction
+
+" }}}1
+
+let s:type_not_found = {}
+function! s:type_not_found.fix(ctx, entry) abort " {{{1
+ if a:entry.text =~# 'The following entry could not be found'
+ let l:key = split(a:entry.text, ' ')[-1]
+ let a:entry.text = 'biblatex: Entry with key ''' . l:key . ''' not found'
+
+ for [l:file, l:lnum, l:line] in vimtex#parser#tex(b:vimtex.tex)
+ if l:line =~# g:vimtex#re#not_comment . '\\\S*\V' . l:key
+ let a:entry.lnum = l:lnum
+ let a:entry.filename = l:file
+ unlet a:entry.bufnr
+ break
+ endif
+ endfor
+
+ return 1
+ endif
+endfunction
+
+" }}}1
+
+let s:type_encoding = {}
+function! s:type_encoding.fix(ctx, entry) abort " {{{1
+ if a:entry.text =~# 'The entry .* has characters which cannot'
+ let l:key = matchstr(a:entry.text, 'The entry ''\v\zs.{-}\ze''')
+ let a:entry.text = 'biblatex: Entry with key ''' . l:key . ''' has non-ascii characters'
+
+ let l:pos = a:ctx.get_key_pos(l:key)
+ if !empty(l:pos)
+ let a:entry.filename = a:ctx.get_filename(l:pos[0])
+ let a:entry.lnum = l:pos[1]
+ if has_key(a:entry, 'bufnr')
+ unlet a:entry.bufnr
+ endif
+ endif
+
+ return 1
+ endif
+endfunction
+
+" }}}1
+
+endif