1
0
mirror of https://github.com/golang/go synced 2024-11-18 13:34:41 -07:00
go/cmd/oracle/oracle.vim
Alan Donovan 3a4c0462d8 go.tools/oracle: change -mode argument into subcommand.
e.g. "oracle callgraph <package>"

Also: simplified error handling.
Eliminated oracle.errorf because it prepends "file:line:col: "
to the error message so the main function can't safely prepend "Error: ".
The position wasn't interesting though: it was just -pos, more or less.

R=crawshaw, dominik.honnef, r
CC=golang-dev
https://golang.org/cl/13864044
2013-09-25 14:34:39 -04:00

108 lines
3.3 KiB
VimL

" -*- text -*-
" oracle.vim -- Vim integration for the Go oracle.
"
" Load with (e.g.) :source oracle.vim
" Call with (e.g.) :GoOracleDescribe
" while cursor or selection is over syntax of interest.
" Run :copen to show the quick-fix file.
"
" This is an absolutely rudimentary integration of the Go Oracle into
" Vim's quickfix mechanism and it needs a number of usability
" improvements before it can be practically useful to Vim users.
" Voluntary contributions welcomed!
"
" TODO(adonovan):
" - reject buffers with no filename.
" - hide all filenames in quickfix buffer.
" Get the path to the Go oracle executable.
func! s:go_oracle_bin()
let [ext, sep] = (has('win32') || has('win64') ? ['.exe', ';'] : ['', ':'])
let go_oracle = globpath(join(split($GOPATH, sep), ','), '/bin/oracle' . ext)
if go_oracle == ''
let go_oracle = globpath($GOROOT, '/bin/oracle' . ext)
endif
return go_oracle
endfunction
let s:go_oracle = s:go_oracle_bin()
func! s:qflist(output)
let qflist = []
" Parse GNU-style 'file:line.col-line.col: message' format.
let mx = '^\(\a:[\\/][^:]\+\|[^:]\+\):\(\d\+\):\(\d\+\):\(.*\)$'
for line in split(a:output, "\n")
let ml = matchlist(line, mx)
" Ignore non-match lines or warnings
if ml == [] || ml[4] =~ '^ warning:'
continue
endif
let item = {
\ 'filename': ml[1],
\ 'text': ml[4],
\ 'lnum': ml[2],
\ 'col': ml[3],
\}
let bnr = bufnr(fnameescape(ml[1]))
if bnr != -1
let item['bufnr'] = bnr
endif
call add(qflist, item)
endfor
call setqflist(qflist)
cwindow
endfun
func! s:getpos(l, c)
if &encoding != 'utf-8'
let buf = a:l == 1 ? '' : (join(getline(1, a:l-1), "\n") . "\n")
let buf .= a:c == 1 ? '' : getline('.')[:a:c-2]
return len(iconv(buf, &encoding, 'utf-8'))
endif
return line2byte(a:l) + (a:c-2)
endfun
func! s:RunOracle(mode, selected) range abort
let fname = expand('%:p')
let sname = get(g:, 'go_oracle_scope_file', fname)
if a:selected != -1
let pos1 = s:getpos(line("'<"), col("'<"))
let pos2 = s:getpos(line("'>"), col("'>"))
let cmd = printf('%s -pos=%s:#%d,#%d %s %s',
\ s:go_oracle,
\ shellescape(fname), pos1, pos2, a:mode, shellescape(sname))
else
let pos = s:getpos(line('.'), col('.'))
let cmd = printf('%s -pos=%s:#%d %s %s',
\ s:go_oracle,
\ shellescape(fname), pos, a:mode, shellescape(sname))
endif
call s:qflist(system(cmd))
endfun
" Describe the expression at the current point.
command! -range=% GoOracleDescribe
\ call s:RunOracle('describe', <count>)
" Show possible callees of the function call at the current point.
command! -range=% GoOracleCallees
\ call s:RunOracle('callees', <count>)
" Show the set of callers of the function containing the current point.
command! -range=% GoOracleCallers
\ call s:RunOracle('callers', <count>)
" Show the callgraph of the current program.
command! -range=% GoOracleCallgraph
\ call s:RunOracle('callgraph', <count>)
" Describe the 'implements' relation for types in the
" package containing the current point.
command! -range=% GoOracleImplements
\ call s:RunOracle('implements', <count>)
" Enumerate the set of possible corresponding sends/receives for
" this channel receive/send operation.
command! -range=% GoOracleChannelPeers
\ call s:RunOracle('peers', <count>)