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
|
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#doc#init_buffer() abort " {{{1
command! -buffer -nargs=? VimtexDocPackage call vimtex#doc#package(<q-args>)
nnoremap <buffer> <plug>(vimtex-doc-package) :VimtexDocPackage<cr>
endfunction
" }}}1
function! vimtex#doc#package(word) abort " {{{1
let l:context = empty(a:word)
\ ? s:packages_get_from_cursor()
\ : {
\ 'type': 'word',
\ 'candidates': [a:word],
\ }
if empty(l:context) | return | endif
call s:packages_remove_invalid(l:context)
for l:handler in g:vimtex_doc_handlers
if exists('*' . l:handler)
if call(l:handler, [l:context]) | return | endif
endif
endfor
call s:packages_open(l:context)
endfunction
" }}}1
function! vimtex#doc#make_selection(context) abort " {{{1
if has_key(a:context, 'selected') | return | endif
if len(a:context.candidates) == 0
if exists('a:context.name')
echohl ErrorMsg
echo 'Sorry, no doc for '.a:context.name
echohl NONE
endif
let a:context.selected = ''
return
endif
if len(a:context.candidates) == 1
let a:context.selected = a:context.candidates[0]
return
endif
call vimtex#echo#echo('Multiple candidates detected, please select one:')
let l:count = 0
for l:package in a:context.candidates
let l:count += 1
call vimtex#echo#formatted([
\ ' [' . string(l:count) . '] ',
\ ['VimtexSuccess', l:package]
\])
endfor
call vimtex#echo#echo('Type number (everything else cancels): ')
let l:choice = nr2char(getchar())
if l:choice !~# '\d'
\ || l:choice == 0
\ || l:choice > len(a:context.candidates)
echohl VimtexWarning
echon l:choice =~# '\d' ? l:choice : '-'
echohl NONE
let a:context.selected = ''
else
echon l:choice
let a:context.selected = a:context.candidates[l:choice-1]
let a:context.ask_before_open = 0
endif
endfunction
" }}}1
function! s:packages_get_from_cursor() abort " {{{1
let l:cmd = vimtex#cmd#get_current()
if empty(l:cmd) | return {} | endif
if l:cmd.name ==# '\usepackage'
return s:packages_from_usepackage(l:cmd)
elseif l:cmd.name ==# '\documentclass'
return s:packages_from_documentclass(l:cmd)
else
return s:packages_from_command(strpart(l:cmd.name, 1))
endif
endfunction
" }}}1
function! s:packages_from_usepackage(cmd) abort " {{{1
try
" Gather and clean up candidate list
let l:candidates = substitute(a:cmd.args[0].text, '%.\{-}\n', '', 'g')
let l:candidates = substitute(l:candidates, '\s*', '', 'g')
let l:candidates = split(l:candidates, ',')
let l:context = {
\ 'type': 'usepackage',
\ 'candidates': l:candidates,
\}
let l:cword = expand('<cword>')
if len(l:context.candidates) > 1 && index(l:context.candidates, l:cword) >= 0
let l:context.selected = l:cword
endif
return l:context
catch
call vimtex#log#warning('Could not parse the package from \usepackage!')
return {}
endtry
endfunction
" }}}1
function! s:packages_from_documentclass(cmd) abort " {{{1
try
return {
\ 'type': 'documentclass',
\ 'candidates': [a:cmd.args[0].text],
\}
catch
call vimtex#log#warning('Could not parse the package from \documentclass!')
return {}
endtry
endfunction
" }}}1
function! s:packages_from_command(cmd) abort " {{{1
let l:packages = [
\ 'default',
\ 'class-' . get(b:vimtex, 'documentclass', ''),
\] + keys(b:vimtex.packages)
call filter(l:packages, 'filereadable(s:complete_dir . v:val)')
let l:queue = copy(l:packages)
while !empty(l:queue)
let l:current = remove(l:queue, 0)
let l:includes = filter(readfile(s:complete_dir . l:current), 'v:val =~# ''^\#\s*include:''')
if empty(l:includes) | continue | endif
call map(l:includes, 'matchstr(v:val, ''include:\s*\zs.*\ze\s*$'')')
call filter(l:includes, 'filereadable(s:complete_dir . v:val)')
call filter(l:includes, 'index(l:packages, v:val) < 0')
let l:packages += l:includes
let l:queue += l:includes
endwhile
let l:candidates = []
let l:filter = 'v:val =~# ''^' . a:cmd . '\>'''
for l:package in l:packages
let l:cmds = filter(readfile(s:complete_dir . l:package), l:filter)
if empty(l:cmds) | continue | endif
if l:package ==# 'default'
call extend(l:candidates, ['latex2e', 'lshort'])
else
call add(l:candidates, substitute(l:package, '^class-', '', ''))
endif
endfor
return {
\ 'type': 'command',
\ 'name': a:cmd,
\ 'candidates': l:candidates,
\}
endfunction
" }}}1
function! s:packages_remove_invalid(context) abort " {{{1
let l:invalid_packages = filter(copy(a:context.candidates),
\ 'empty(vimtex#kpsewhich#find(v:val . ''.sty'')) && '
\ . 'empty(vimtex#kpsewhich#find(v:val . ''.cls''))')
call filter(l:invalid_packages,
\ 'index([''latex2e'', ''lshort''], v:val) < 0')
" Warn about invalid candidates
if !empty(l:invalid_packages)
if len(l:invalid_packages) == 1
call vimtex#log#warning(
\ 'Package not recognized: ' . l:invalid_packages[0])
else
call vimtex#log#warning(
\ 'Packages not recognized:',
\ map(copy(l:invalid_packages), "'- ' . v:val"))
endif
endif
" Remove invalid candidates
call filter(a:context.candidates, 'index(l:invalid_packages, v:val) < 0')
" Reset the selection if the selected candidate is not valid
if has_key(a:context, 'selected')
\ && index(a:context.candidates, a:context.selected) < 0
unlet a:context.selected
endif
endfunction
" }}}1
function! s:packages_open(context) abort " {{{1
if !has_key(a:context, 'selected')
call vimtex#doc#make_selection(a:context)
endif
if empty(a:context.selected) | return | endif
if get(a:context, 'ask_before_open', 1)
call vimtex#echo#formatted([
\ 'Open documentation for ',
\ ['VimtexSuccess', a:context.selected], ' [y/N]? '
\])
let l:choice = nr2char(getchar())
if l:choice ==# 'y'
echon 'y'
else
echohl VimtexWarning
echon l:choice =~# '\w' ? l:choice : 'N'
echohl NONE
return
endif
endif
let l:os = vimtex#util#get_os()
let l:url = 'http://texdoc.net/pkg/' . a:context.selected
silent execute (l:os ==# 'linux'
\ ? '!xdg-open'
\ : (l:os ==# 'mac'
\ ? '!open'
\ : '!start'))
\ . ' ' . l:url
\ . (l:os ==# 'win' ? '' : ' &')
redraw!
endfunction
" }}}1
let s:complete_dir = fnamemodify(expand('<sfile>'), ':h') . '/complete/'
endif
|
