mirror of
https://github.com/neovim/neovim.git
synced 2024-12-20 11:15:14 -07:00
a346cb1d58
The comment is incorrect, s:error does need to be called. I thought the call was unnecessary because it didn't show any message for me but I had shortmess+=F which was hiding the message.
351 lines
10 KiB
VimL
351 lines
10 KiB
VimL
" Maintainer: Anmol Sethi <anmol@aubble.com>
|
|
|
|
let s:man_find_arg = "-w"
|
|
|
|
" TODO(nhooyr) Completion may work on SunOS; I'm not sure if `man -l` displays
|
|
" the list of searched directories.
|
|
try
|
|
if !has('win32') && $OSTYPE !~? 'cygwin\|linux' && system('uname -s') =~? 'SunOS' && system('uname -r') =~# '^5'
|
|
let s:man_find_arg = '-l'
|
|
endif
|
|
catch /E145:/
|
|
" Ignore the error in restricted mode
|
|
endtry
|
|
|
|
function! man#open_page(count, count1, mods, ...) abort
|
|
if a:0 > 2
|
|
call s:error('too many arguments')
|
|
return
|
|
elseif a:0 == 0
|
|
let ref = &filetype ==# 'man' ? expand('<cWORD>') : expand('<cword>')
|
|
if empty(ref)
|
|
call s:error('no identifier under cursor')
|
|
return
|
|
endif
|
|
elseif a:0 ==# 1
|
|
let ref = a:1
|
|
else
|
|
" Combine the name and sect into a manpage reference so that all
|
|
" verification/extraction can be kept in a single function.
|
|
" If a:2 is a reference as well, that is fine because it is the only
|
|
" reference that will match.
|
|
let ref = a:2.'('.a:1.')'
|
|
endif
|
|
try
|
|
let [sect, name] = man#extract_sect_and_name_ref(ref)
|
|
if a:count ==# a:count1
|
|
" v:count defaults to 0 which is a valid section, and v:count1 defaults to
|
|
" 1, also a valid section. If they are equal, count explicitly set.
|
|
let sect = string(a:count)
|
|
endif
|
|
let [sect, name, path] = s:verify_exists(sect, name)
|
|
catch
|
|
call s:error(v:exception)
|
|
return
|
|
endtry
|
|
|
|
call s:push_tag()
|
|
let bufname = 'man://'.name.(empty(sect)?'':'('.sect.')')
|
|
|
|
try
|
|
set eventignore+=BufReadCmd
|
|
if a:mods !~# 'tab' && s:find_man()
|
|
execute 'silent edit' fnameescape(bufname)
|
|
else
|
|
execute 'silent' a:mods 'split' fnameescape(bufname)
|
|
endif
|
|
finally
|
|
set eventignore-=BufReadCmd
|
|
endtry
|
|
|
|
try
|
|
let page = s:get_page(path)
|
|
catch
|
|
if a:mods =~# 'tab' || !s:find_man()
|
|
" a new window was opened
|
|
close
|
|
endif
|
|
call s:error(v:exception)
|
|
return
|
|
endtry
|
|
|
|
let b:man_sect = sect
|
|
call s:put_page(page)
|
|
endfunction
|
|
|
|
function! man#read_page(ref) abort
|
|
try
|
|
let [sect, name] = man#extract_sect_and_name_ref(a:ref)
|
|
let [sect, name, path] = s:verify_exists(sect, name)
|
|
let page = s:get_page(path)
|
|
catch
|
|
call s:error(v:exception)
|
|
return
|
|
endtry
|
|
let b:man_sect = sect
|
|
call s:put_page(page)
|
|
endfunction
|
|
|
|
" Handler for s:system() function.
|
|
function! s:system_handler(jobid, data, event) dict abort
|
|
if a:event == 'stdout'
|
|
let self.stdout .= join(a:data, "\n")
|
|
elseif a:event == 'stderr'
|
|
let self.stderr .= join(a:data, "\n")
|
|
else
|
|
let self.exit_code = a:data
|
|
endif
|
|
endfunction
|
|
|
|
" Run a system command and timeout after 30 seconds.
|
|
function! s:system(cmd, ...) abort
|
|
let opts = {
|
|
\ 'stdout': '',
|
|
\ 'stderr': '',
|
|
\ 'exit_code': 0,
|
|
\ 'on_stdout': function('s:system_handler'),
|
|
\ 'on_stderr': function('s:system_handler'),
|
|
\ 'on_exit': function('s:system_handler'),
|
|
\ }
|
|
let jobid = jobstart(a:cmd, opts)
|
|
|
|
if jobid < 1
|
|
throw printf('command error %d: %s', jobid, join(a:cmd))
|
|
endif
|
|
|
|
let res = jobwait([jobid], 30000)
|
|
if res[0] == -1
|
|
try
|
|
call jobstop(jobid)
|
|
throw printf('command timed out: %s', join(a:cmd))
|
|
catch /^Vim\%((\a\+)\)\=:E900/
|
|
endtry
|
|
elseif res[0] == -2
|
|
throw printf('command interrupted: %s', join(a:cmd))
|
|
endif
|
|
if opts.exit_code != 0
|
|
throw printf("command error (%d) %s: %s", jobid, join(a:cmd), substitute(opts.stderr, '\_s\+$', '', &gdefault ? '' : 'g'))
|
|
endif
|
|
|
|
return opts.stdout
|
|
endfunction
|
|
|
|
function! s:get_page(path) abort
|
|
" Respect $MANWIDTH or default to window width.
|
|
let manwidth = empty($MANWIDTH) ? winwidth(0) : $MANWIDTH
|
|
" Force MANPAGER=cat to ensure Vim is not recursively invoked (by man-db).
|
|
" http://comments.gmane.org/gmane.editors.vim.devel/29085
|
|
return s:system(['env', 'MANPAGER=cat', 'MANWIDTH='.manwidth, 'man', a:path])
|
|
endfunction
|
|
|
|
function! s:put_page(page) abort
|
|
setlocal modifiable
|
|
setlocal noreadonly
|
|
silent keepjumps %delete _
|
|
silent put =a:page
|
|
" Remove all backspaced/escape characters.
|
|
execute 'silent keeppatterns keepjumps %substitute,.\b\|\e\[\d\+m,,e'.(&gdefault?'':'g')
|
|
while getline(1) =~# '^\s*$'
|
|
silent keepjumps 1delete _
|
|
endwhile
|
|
setlocal filetype=man
|
|
endfunction
|
|
|
|
" attempt to extract the name and sect out of 'name(sect)'
|
|
" otherwise just return the largest string of valid characters in ref
|
|
function! man#extract_sect_and_name_ref(ref) abort
|
|
if a:ref[0] ==# '-' " try ':Man -pandoc' with this disabled.
|
|
throw 'manpage name cannot start with ''-'''
|
|
endif
|
|
let ref = matchstr(a:ref, '[^()]\+([^()]\+)')
|
|
if empty(ref)
|
|
let name = matchstr(a:ref, '[^()]\+')
|
|
if empty(name)
|
|
throw 'manpage reference cannot contain only parentheses'
|
|
endif
|
|
return [get(b:, 'man_default_sects', ''), name]
|
|
endif
|
|
let left = split(ref, '(')
|
|
" see ':Man 3X curses' on why tolower.
|
|
" TODO(nhooyr) Not sure if this is portable across OSs
|
|
" but I have not seen a single uppercase section.
|
|
return [tolower(split(left[1], ')')[0]), left[0]]
|
|
endfunction
|
|
|
|
function! s:get_path(sect, name) abort
|
|
if empty(a:sect)
|
|
return s:system(['man', s:man_find_arg, a:name])
|
|
endif
|
|
" '-s' flag handles:
|
|
" - tokens like 'printf(echo)'
|
|
" - sections starting with '-'
|
|
" - 3pcap section (found on macOS)
|
|
" - commas between sections (for section priority)
|
|
return s:system(['man', s:man_find_arg, '-s', a:sect, a:name])
|
|
endfunction
|
|
|
|
function! s:verify_exists(sect, name) abort
|
|
try
|
|
let path = s:get_path(a:sect, a:name)
|
|
catch /^command error (/
|
|
try
|
|
let path = s:get_path(get(b:, 'man_default_sects', ''), a:name)
|
|
catch /^command error (/
|
|
let path = s:get_path('', a:name)
|
|
endtry
|
|
endtry
|
|
" We need to extract the section from the path because sometimes
|
|
" the actual section of the manpage is more specific than the section
|
|
" we provided to `man`. Try ':Man 3 App::CLI'.
|
|
" Also on linux, it seems that the name is case insensitive. So if one does
|
|
" ':Man PRIntf', we still want the name of the buffer to be 'printf' or
|
|
" whatever the correct capitilization is.
|
|
let path = path[:len(path)-2]
|
|
return s:extract_sect_and_name_path(path) + [path]
|
|
endfunction
|
|
|
|
let s:tag_stack = []
|
|
|
|
function! s:push_tag() abort
|
|
let s:tag_stack += [{
|
|
\ 'buf': bufnr('%'),
|
|
\ 'lnum': line('.'),
|
|
\ 'col': col('.'),
|
|
\ }]
|
|
endfunction
|
|
|
|
function! man#pop_tag() abort
|
|
if !empty(s:tag_stack)
|
|
let tag = remove(s:tag_stack, -1)
|
|
execute 'silent' tag['buf'].'buffer'
|
|
call cursor(tag['lnum'], tag['col'])
|
|
endif
|
|
endfunction
|
|
|
|
" extracts the name and sect out of 'path/name.sect'
|
|
function! s:extract_sect_and_name_path(path) abort
|
|
let tail = fnamemodify(a:path, ':t')
|
|
if a:path =~# '\.\%([glx]z\|bz2\|lzma\|Z\)$' " valid extensions
|
|
let tail = fnamemodify(tail, ':r')
|
|
endif
|
|
let sect = matchstr(tail, '\.\zs[^.]\+$')
|
|
let name = matchstr(tail, '^.\+\ze\.')
|
|
return [sect, name]
|
|
endfunction
|
|
|
|
function! s:find_man() abort
|
|
if &filetype ==# 'man'
|
|
return 1
|
|
elseif winnr('$') ==# 1
|
|
return 0
|
|
endif
|
|
let thiswin = winnr()
|
|
while 1
|
|
wincmd w
|
|
if &filetype ==# 'man'
|
|
return 1
|
|
elseif thiswin ==# winnr()
|
|
return 0
|
|
endif
|
|
endwhile
|
|
endfunction
|
|
|
|
function! s:error(msg) abort
|
|
redraw
|
|
echohl ErrorMsg
|
|
echon 'man.vim: ' a:msg
|
|
echohl None
|
|
endfunction
|
|
|
|
" see man#extract_sect_and_name_ref on why tolower(sect)
|
|
function! man#complete(arg_lead, cmd_line, cursor_pos) abort
|
|
let args = split(a:cmd_line)
|
|
let l = len(args)
|
|
if l > 3
|
|
return
|
|
elseif l ==# 1
|
|
let name = ''
|
|
let sect = ''
|
|
elseif a:arg_lead =~# '^[^()]\+([^()]*$'
|
|
" cursor (|) is at ':Man printf(|' or ':Man 1 printf(|'
|
|
" The later is is allowed because of ':Man pri<TAB>'.
|
|
" It will offer 'priclass.d(1m)' even though section is specified as 1.
|
|
let tmp = split(a:arg_lead, '(')
|
|
let name = tmp[0]
|
|
let sect = tolower(get(tmp, 1, ''))
|
|
return s:complete(sect, '', name)
|
|
elseif args[1] !~# '^[^()]\+$'
|
|
" cursor (|) is at ':Man 3() |' or ':Man (3|' or ':Man 3() pri|'
|
|
" or ':Man 3() pri |'
|
|
return
|
|
elseif l ==# 2
|
|
if empty(a:arg_lead)
|
|
" cursor (|) is at ':Man 1 |'
|
|
let name = ''
|
|
let sect = tolower(args[1])
|
|
else
|
|
" cursor (|) is at ':Man pri|'
|
|
if a:arg_lead =~# '\/'
|
|
" if the name is a path, complete files
|
|
" TODO(nhooyr) why does this complete the last one automatically
|
|
return glob(a:arg_lead.'*', 0, 1)
|
|
endif
|
|
let name = a:arg_lead
|
|
let sect = ''
|
|
endif
|
|
elseif a:arg_lead !~# '^[^()]\+$'
|
|
" cursor (|) is at ':Man 3 printf |' or ':Man 3 (pr)i|'
|
|
return
|
|
else
|
|
" cursor (|) is at ':Man 3 pri|'
|
|
let name = a:arg_lead
|
|
let sect = tolower(args[1])
|
|
endif
|
|
return s:complete(sect, sect, name)
|
|
endfunction
|
|
|
|
function! s:complete(sect, psect, name) abort
|
|
try
|
|
let mandirs = join(split(s:system(['man', s:man_find_arg]), ':\|\n'), ',')
|
|
catch
|
|
call s:error(v:exception)
|
|
return
|
|
endtry
|
|
let pages = globpath(mandirs,'man?/'.a:name.'*.'.a:sect.'*', 0, 1)
|
|
" We remove duplicates in case the same manpage in different languages was found.
|
|
return uniq(sort(map(pages, 's:format_candidate(v:val, a:psect)'), 'i'))
|
|
endfunction
|
|
|
|
function! s:format_candidate(path, psect) abort
|
|
if a:path =~# '\.\%(pdf\|in\)$' " invalid extensions
|
|
return
|
|
endif
|
|
let [sect, name] = s:extract_sect_and_name_path(a:path)
|
|
if sect ==# a:psect
|
|
return name
|
|
elseif sect =~# a:psect.'.\+$'
|
|
" We include the section if the user provided section is a prefix
|
|
" of the actual section.
|
|
return name.'('.sect.')'
|
|
endif
|
|
endfunction
|
|
|
|
function! man#init_pager() abort
|
|
" Remove all backspaced/escape characters.
|
|
execute 'silent keeppatterns keepjumps %substitute,.\b\|\e\[\d\+m,,e'.(&gdefault?'':'g')
|
|
if getline(1) =~# '^\s*$'
|
|
silent keepjumps 1delete _
|
|
else
|
|
keepjumps 1
|
|
endif
|
|
" This is not perfect. See `man glDrawArraysInstanced`. Since the title is
|
|
" all caps it is impossible to tell what the original capitilization was.
|
|
let ref = substitute(matchstr(getline(1), '^[^)]\+)'), ' ', '_', 'g')
|
|
try
|
|
let b:man_sect = man#extract_sect_and_name_ref(ref)[0]
|
|
catch
|
|
let b:man_sect = ''
|
|
endtry
|
|
execute 'silent file man://'.fnameescape(ref)
|
|
endfunction
|