summaryrefslogtreecommitdiff
path: root/misc/vim/plugin/godoc.vim
diff options
context:
space:
mode:
authorOndřej Surý <ondrej@sury.org>2011-08-10 15:05:15 +0200
committerOndřej Surý <ondrej@sury.org>2011-08-10 15:05:15 +0200
commit825e92f34920934f09dbf4c614dbd2913ba464cb (patch)
tree2af4eb446f544e17f65b34ad2b9668d2bb8ab78b /misc/vim/plugin/godoc.vim
parente6b380032482808aee5e4c5222b6d7390f468e74 (diff)
downloadgolang-825e92f34920934f09dbf4c614dbd2913ba464cb.tar.gz
Imported Upstream version 2011.08.10upstream-weekly/2011.08.10
Diffstat (limited to 'misc/vim/plugin/godoc.vim')
-rw-r--r--misc/vim/plugin/godoc.vim123
1 files changed, 123 insertions, 0 deletions
diff --git a/misc/vim/plugin/godoc.vim b/misc/vim/plugin/godoc.vim
new file mode 100644
index 000000000..5d7ce14ad
--- /dev/null
+++ b/misc/vim/plugin/godoc.vim
@@ -0,0 +1,123 @@
+" Copyright 2011 The Go Authors. All rights reserved.
+" Use of this source code is governed by a BSD-style
+" license that can be found in the LICENSE file.
+"
+" godoc.vim: Vim command to see godoc.
+
+if exists("g:loaded_godoc")
+ finish
+endif
+let g:loaded_godoc = 1
+
+let s:buf_nr = -1
+let s:last_word = ''
+let s:goos = $GOOS
+let s:goarch = $GOARCH
+
+function! s:GodocView()
+ if !bufexists(s:buf_nr)
+ leftabove new
+ file `="[Godoc]"`
+ let s:buf_nr = bufnr('%')
+ elseif bufwinnr(s:buf_nr) == -1
+ leftabove split
+ execute s:buf_nr . 'buffer'
+ delete _
+ elseif bufwinnr(s:buf_nr) != bufwinnr('%')
+ execute bufwinnr(s:buf_nr) . 'wincmd w'
+ endif
+
+ setlocal filetype=godoc
+ setlocal bufhidden=delete
+ setlocal buftype=nofile
+ setlocal noswapfile
+ setlocal nobuflisted
+ setlocal modifiable
+ setlocal nocursorline
+ setlocal nocursorcolumn
+ setlocal iskeyword+=:
+ setlocal iskeyword-=-
+
+ nnoremap <buffer> <silent> K :Godoc<cr>
+
+ au BufHidden <buffer> call let <SID>buf_nr = -1
+endfunction
+
+function! s:GodocWord(word)
+ let word = a:word
+ silent! let content = system('godoc ' . word)
+ if v:shell_error || !len(content)
+ if len(s:last_word)
+ silent! let content = system('godoc ' . s:last_word.'/'.word)
+ if v:shell_error || !len(content)
+ echo 'No documentation found for "' . word . '".'
+ return
+ endif
+ let word = s:last_word.'/'.word
+ else
+ echo 'No documentation found for "' . word . '".'
+ return
+ endif
+ endif
+ let s:last_word = word
+ silent! call s:GodocView()
+ setlocal modifiable
+ silent! %d _
+ silent! put! =content
+ silent! normal gg
+ setlocal nomodifiable
+ setfiletype godoc
+endfunction
+
+function! s:Godoc(...)
+ let word = join(a:000, ' ')
+ if !len(word)
+ let word = expand('<cword>')
+ endif
+ let word = substitute(word, '[^a-zA-Z0-9\/]', '', 'g')
+ if !len(word)
+ return
+ endif
+ call s:GodocWord(word)
+endfunction
+
+function! s:GodocComplete(ArgLead, CmdLine, CursorPos)
+ if len($GOROOT) == 0
+ return []
+ endif
+ if len(s:goos) == 0
+ if exists('g:godoc_goos')
+ let s:goos = g:godoc_goos
+ elseif has('win32') || has('win64')
+ let s:goos = 'windows'
+ elseif has('macunix')
+ let s:goos = 'darwin'
+ else
+ let s:goos = '*'
+ endif
+ endif
+ if len(s:goarch) == 0
+ if exists('g:godoc_goarch')
+ let s:goarch = g:godoc_goarch
+ else
+ let s:goarch = g:godoc_goarch
+ endif
+ endif
+ let ret = {}
+ let root = expand($GOROOT.'/pkg/'.s:goos.'_'.s:goarch)
+ for i in split(globpath(root, a:ArgLead.'*'), "\n")
+ if isdirectory(i)
+ let i .= '/'
+ elseif i !~ '\.a$'
+ continue
+ endif
+ let i = substitute(substitute(i[len(root)+1:], '[\\]', '/', 'g'), '\.a$', '', 'g')
+ let ret[i] = i
+ endfor
+ return sort(keys(ret))
+endfunction
+
+command! -nargs=* -range -complete=customlist,s:GodocComplete Godoc :call s:Godoc(<q-args>)
+nnoremap <silent> <Plug>(godoc-keyword) :<C-u>call <SID>Godoc('')<CR>
+
+" vim:ts=4:sw=4:et