383 lines
9.7 KiB
VimL
383 lines
9.7 KiB
VimL
" vimtex - LaTeX plugin for Vim
|
|
"
|
|
" Maintainer: Karl Yngve Lervåg
|
|
" Email: karl.yngve@gmail.com
|
|
"
|
|
|
|
" vimtex is not initialized until vimtex#init() has been run once
|
|
if !exists('s:initialized')
|
|
let s:initialized = 0
|
|
endif
|
|
|
|
function! vimtex#init() " {{{1
|
|
call s:init_options()
|
|
call s:init_environment()
|
|
|
|
call vimtex#toc#init(s:initialized)
|
|
call vimtex#echo#init(s:initialized)
|
|
call vimtex#fold#init(s:initialized)
|
|
call vimtex#view#init(s:initialized)
|
|
call vimtex#index#init(s:initialized)
|
|
call vimtex#motion#init(s:initialized)
|
|
call vimtex#labels#init(s:initialized)
|
|
call vimtex#change#init(s:initialized)
|
|
call vimtex#latexmk#init(s:initialized)
|
|
call vimtex#complete#init(s:initialized)
|
|
call vimtex#mappings#init(s:initialized)
|
|
|
|
"
|
|
" This variable is used to allow a distinction between global and buffer
|
|
" initialization
|
|
"
|
|
let s:initialized = 1
|
|
endfunction
|
|
|
|
" }}}1
|
|
function! vimtex#info(global) " {{{1
|
|
if !s:initialized
|
|
echoerr 'Error: vimtex has not been initialized!'
|
|
return
|
|
endif
|
|
|
|
if a:global
|
|
let n = 0
|
|
for data in g:vimtex_data
|
|
let d = deepcopy(data)
|
|
for f in ['aux', 'out', 'log']
|
|
silent execute 'let d.' . f . ' = data.' . f . '()'
|
|
endfor
|
|
|
|
call vimtex#echo#formatted([
|
|
\ "\n\ng:vimtex_data[", ['VimtexSuccess', n], '] : ',
|
|
\ ['VimtexSuccess', remove(d, 'name') . "\n"]])
|
|
call s:print_dict(d)
|
|
let n += 1
|
|
endfor
|
|
else
|
|
let d = deepcopy(b:vimtex)
|
|
for f in ['aux', 'out', 'log']
|
|
silent execute 'let d.' . f . ' = b:vimtex.' . f . '()'
|
|
endfor
|
|
call vimtex#echo#formatted([
|
|
\ 'b:vimtex : ',
|
|
\ ['VimtexSuccess', remove(d, 'name') . "\n"]])
|
|
call s:print_dict(d)
|
|
endif
|
|
endfunction
|
|
|
|
" }}}1
|
|
function! vimtex#wordcount(detailed) " {{{1
|
|
" Run texcount, save output to lines variable
|
|
let cmd = 'cd ' . vimtex#util#fnameescape(b:vimtex.root)
|
|
let cmd .= '; texcount -nosub -sum '
|
|
let cmd .= a:detailed > 0 ? '-inc ' : '-merge '
|
|
let cmd .= vimtex#util#fnameescape(b:vimtex.base)
|
|
let lines = split(system(cmd), '\n')
|
|
|
|
" Create wordcount window
|
|
if bufnr('TeXcount') >= 0
|
|
bwipeout TeXcount
|
|
endif
|
|
split TeXcount
|
|
|
|
" Add lines to buffer
|
|
for line in lines
|
|
call append('$', printf('%s', line))
|
|
endfor
|
|
0delete _
|
|
|
|
" Set mappings
|
|
nnoremap <buffer> <silent> q :bwipeout<cr>
|
|
|
|
" Set buffer options
|
|
setlocal bufhidden=wipe
|
|
setlocal buftype=nofile
|
|
setlocal cursorline
|
|
setlocal listchars=
|
|
setlocal nobuflisted
|
|
setlocal nolist
|
|
setlocal nospell
|
|
setlocal noswapfile
|
|
setlocal nowrap
|
|
setlocal tabstop=8
|
|
setlocal nomodifiable
|
|
|
|
" Set highlighting
|
|
syntax match TexcountText /^.*:.*/ contains=TexcountValue
|
|
syntax match TexcountValue /.*:\zs.*/
|
|
highlight link TexcountText VimtexMsg
|
|
highlight link TexcountValue Constant
|
|
endfunction
|
|
|
|
" }}}1
|
|
|
|
function! s:init_environment() " {{{1
|
|
" Initialize container for data blobs if it does not exist
|
|
let g:vimtex_data = get(g:, 'vimtex_data', [])
|
|
|
|
" Get main file number and check if data blob already exists
|
|
let main = s:get_main()
|
|
let id = s:get_id(main)
|
|
|
|
if id >= 0
|
|
" Link to existing blob
|
|
let b:vimtex_id = id
|
|
let b:vimtex = g:vimtex_data[id]
|
|
else
|
|
" Create new blob
|
|
let b:vimtex = {}
|
|
let b:vimtex.tex = main
|
|
let b:vimtex.root = fnamemodify(b:vimtex.tex, ':h')
|
|
let b:vimtex.base = fnamemodify(b:vimtex.tex, ':t')
|
|
let b:vimtex.name = fnamemodify(b:vimtex.tex, ':t:r')
|
|
function b:vimtex.aux() dict
|
|
return s:get_main_ext(self, 'aux')
|
|
endfunction
|
|
function b:vimtex.log() dict
|
|
return s:get_main_ext(self, 'log')
|
|
endfunction
|
|
function b:vimtex.out() dict
|
|
return s:get_main_ext(self, 'pdf')
|
|
endfunction
|
|
|
|
call add(g:vimtex_data, b:vimtex)
|
|
let b:vimtex_id = len(g:vimtex_data) - 1
|
|
endif
|
|
|
|
" Define commands
|
|
command! -buffer -bang VimtexInfo call vimtex#info(<q-bang> == "!")
|
|
command! -buffer -bang VimtexWordCount call vimtex#wordcount(<q-bang> == "!")
|
|
|
|
" Define mappings
|
|
nnoremap <buffer> <plug>(vimtex-info) :call vimtex#info(0)<cr>
|
|
endfunction
|
|
|
|
function! s:init_options() " {{{1
|
|
let s:save_cpo = &cpo
|
|
set cpo&vim
|
|
|
|
" Ensure tex files are prioritized when listing files
|
|
for suf in [
|
|
\ '.log',
|
|
\ '.aux',
|
|
\ '.bbl',
|
|
\ '.out',
|
|
\ '.blg',
|
|
\ '.brf',
|
|
\ '.cb',
|
|
\ '.dvi',
|
|
\ '.fdb_latexmk',
|
|
\ '.fls',
|
|
\ '.idx',
|
|
\ '.ilg',
|
|
\ '.ind',
|
|
\ '.inx',
|
|
\ '.pdf',
|
|
\ '.synctex.gz',
|
|
\ '.toc',
|
|
\ ]
|
|
execute 'set suffixes+=' . suf
|
|
endfor
|
|
|
|
setlocal suffixesadd=.tex
|
|
setlocal comments=sO:%\ -,mO:%\ \ ,eO:%%,:%
|
|
setlocal commentstring=%%s
|
|
|
|
let &l:define = '\\\([egx]\|char\|mathchar\|count\|dimen\|muskip\|skip'
|
|
let &l:define .= '\|toks\)\=def\|\\font\|\\\(future\)\=let'
|
|
let &l:define .= '\|\\new\(count\|dimen\|skip'
|
|
let &l:define .= '\|muskip\|box\|toks\|read\|write\|fam\|insert\)'
|
|
let &l:define .= '\|\\\(re\)\=new\(boolean\|command\|counter\|environment'
|
|
let &l:define .= '\|font\|if\|length\|savebox'
|
|
let &l:define .= '\|theorem\(style\)\=\)\s*\*\=\s*{\='
|
|
let &l:define .= '\|DeclareMathOperator\s*{\=\s*'
|
|
|
|
let &l:include = '\\\(input\|include\){'
|
|
let &l:includeexpr = 'substitute('
|
|
let &l:includeexpr .= "substitute(v:fname, '\\\\space', '', 'g'),"
|
|
let &l:includeexpr .= "'^.\\{-}{\"\\?\\|\"\\?}.*', '', 'g')"
|
|
|
|
let &cpo = s:save_cpo
|
|
unlet s:save_cpo
|
|
endfunction
|
|
|
|
" }}}1
|
|
|
|
function! s:get_id(main) " {{{1
|
|
if exists('g:vimtex_data') && !empty(g:vimtex_data)
|
|
let id = 0
|
|
while id < len(g:vimtex_data)
|
|
if g:vimtex_data[id].tex == a:main
|
|
return id
|
|
endif
|
|
let id += 1
|
|
endwhile
|
|
endif
|
|
|
|
return -1
|
|
endfunction
|
|
|
|
function! s:get_main() " {{{1
|
|
"
|
|
" Use buffer variable if it exists
|
|
"
|
|
if exists('b:vimtex_main') && filereadable(b:vimtex_main)
|
|
return fnamemodify(b:vimtex_main, ':p')
|
|
endif
|
|
|
|
"
|
|
" Search for main file specifier at the beginning of file. Recognized
|
|
" specifiers are:
|
|
"
|
|
" 1. The TEX root specifier, which is used by by several other plugins and
|
|
" editors.
|
|
" 2. Subfiles package specifier. This parses the main tex file option in the
|
|
" \documentclass line for the subfiles package.
|
|
"
|
|
for regexp in [
|
|
\ '^\c\s*%\s*!\?\s*tex\s\+root\s*=\s*\zs.*\ze\s*$',
|
|
\ '^\C\s*\\documentclass\[\zs.*\ze\]{subfiles}',
|
|
\ ]
|
|
for line in getline(1, 5)
|
|
let filename = matchstr(line, regexp)
|
|
if len(filename) > 0
|
|
if filename[0] !=# '/'
|
|
let candidates = [
|
|
\ expand('%:h') . '/' . filename,
|
|
\ getcwd() . '/' . filename,
|
|
\ ]
|
|
else
|
|
let candidates = [fnamemodify(filename, ':p')]
|
|
endif
|
|
for main in candidates
|
|
if filereadable(main)
|
|
return main
|
|
endif
|
|
endfor
|
|
endif
|
|
endfor
|
|
endfor
|
|
|
|
"
|
|
" Search for main file recursively through \input and \include specifiers
|
|
"
|
|
let main = s:get_main_recurse(expand('%:p'))
|
|
if filereadable(main)
|
|
return main
|
|
endif
|
|
|
|
"
|
|
" If not found, use current file
|
|
"
|
|
return expand('%:p')
|
|
endfunction
|
|
|
|
function! s:get_main_recurse(file) " {{{1
|
|
"
|
|
" Check if file is readable
|
|
"
|
|
if !filereadable(a:file)
|
|
return 0
|
|
endif
|
|
|
|
"
|
|
" Check if current file is a main file
|
|
"
|
|
if len(filter(readfile(a:file),
|
|
\ 'v:val =~# ''\C\\begin\_\s*{document}''')) > 0
|
|
return fnamemodify(a:file, ':p')
|
|
endif
|
|
|
|
"
|
|
" Gather candidate files
|
|
"
|
|
let l:path = expand('%:p:h')
|
|
let l:dirs = l:path
|
|
while l:path != fnamemodify(l:path, ':h')
|
|
let l:path = fnamemodify(l:path, ':h')
|
|
let l:dirs .= ',' . l:path
|
|
endwhile
|
|
let l:candidates = split(globpath(l:dirs, '*.tex'), '\n')
|
|
|
|
"
|
|
" Search through candidates for \include{current file}
|
|
"
|
|
for l:file in l:candidates
|
|
" Avoid infinite recursion (checking the same file repeatedly)
|
|
if l:file == a:file | continue | endif
|
|
|
|
if len(filter(readfile(l:file), 'v:val =~ ''\v\\(input|include)\{'
|
|
\ . '\s*((.*)\/)?'
|
|
\ . fnamemodify(a:file, ':t:r') . '(\.tex)?\s*''')) > 0
|
|
return s:get_main_recurse(l:file)
|
|
endif
|
|
endfor
|
|
|
|
"
|
|
" If not found, return 0
|
|
"
|
|
return 0
|
|
endfunction
|
|
|
|
function! s:get_main_ext(self, ext) " {{{1
|
|
" First check build dir (latexmk -output_directory option)
|
|
if g:vimtex_latexmk_build_dir !=# ''
|
|
let cand = g:vimtex_latexmk_build_dir . '/' . a:self.name . '.' . a:ext
|
|
if g:vimtex_latexmk_build_dir[0] !=# '/'
|
|
let cand = a:self.root . '/' . cand
|
|
endif
|
|
if filereadable(cand)
|
|
return fnamemodify(cand, ':p')
|
|
endif
|
|
endif
|
|
|
|
" Next check for file in project root folder
|
|
let cand = a:self.root . '/' . a:self.name . '.' . a:ext
|
|
if filereadable(cand)
|
|
return fnamemodify(cand, ':p')
|
|
endif
|
|
|
|
" Finally return empty string if no entry is found
|
|
return ''
|
|
endfunction
|
|
|
|
" }}}1
|
|
|
|
function! s:print_dict(dict, ...) " {{{1
|
|
let level = a:0 > 0 ? a:1 : 0
|
|
|
|
for entry in sort(sort(items(a:dict),
|
|
\ 's:print_dict_sort_2'),
|
|
\ 's:print_dict_sort_1')
|
|
let title = repeat(' ', 2 + 2*level) . entry[0]
|
|
if type(entry[1]) == type([])
|
|
call vimtex#echo#echo(title)
|
|
for val in entry[1]
|
|
call vimtex#echo#echo(repeat(' ', 4 + 2*level) . string(val), 'None')
|
|
endfor
|
|
elseif type(entry[1]) == type({})
|
|
call vimtex#echo#echo(title . "\n")
|
|
call s:print_dict(entry[1], level + 1)
|
|
else
|
|
call vimtex#echo#formatted([title . ' : ',
|
|
\ ['None', string(entry[1]) . "\n"]])
|
|
endif
|
|
endfor
|
|
endfunction
|
|
|
|
" }}}1
|
|
function! s:print_dict_sort_1(i1, i2) " {{{1
|
|
return type(a:i1[1]) - type(a:i2[1])
|
|
endfunction
|
|
|
|
" }}}1
|
|
function! s:print_dict_sort_2(i1, i2) " {{{1
|
|
return string(a:i1[1]) == string(a:i2[1]) ? 0
|
|
\ : string(a:i1[1]) > string(a:i2[1]) ? 1
|
|
\ : -1
|
|
endfunction
|
|
|
|
" }}}1
|
|
|
|
" vim: fdm=marker sw=2
|