ultimate-vim/sources_non_forked/vim-go/autoload/go/oracle.vim

"  oracle.vim -- Vim integration for the Go oracle.
"
"  Part of this plugin was taken directly from the oracle repo, however it's
"  massively changed for a better integration into vim-go. Thanks Alan Donovan
"  for the first iteration based on quickfix!  - Fatih Arslan
"

if !exists("g:go_oracle_bin")
    let g:go_oracle_bin = "oracle"
endif

" Parses (via regex) Oracle's 'plain' format output and puts them into a
" location list
func! s:loclist(output)
    let llist = []
    " 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(llist, item)
    endfor
    call go#list#Populate("locationlist", llist)
    call go#list#Window("locationlist", len(llist))
endfun

" This uses Vim's errorformat to parse the output from Oracle's 'plain output
" and put it into location list. I believe using errorformat is much more
" easier to use. If we need more power we can always switch back to parse it
" via regex.
func! s:loclistSecond(output)
    " backup users errorformat, will be restored once we are finished
    let old_errorformat = &errorformat

    " match two possible styles of errorformats:
    "
    "   'file:line.col-line2.col2: message'
    "   'file:line:col: message'
    "
    " We discard line2 and col2 for the first errorformat, because it's not
    " useful and location only has the ability to show one line and column
    " number
    let errformat = "%f:%l.%c-%[%^:]%#:\ %m,%f:%l:%c:\ %m"
    call go#list#ParseFormat("locationlist", errformat, split(a:output, "\n"))

    let errors = go#list#Get("locationlist")
    call go#list#Window("locationlist", len(errors))
endfun

func! s:RunOracle(mode, selected, needs_package) range abort
    let fname = expand('%:p')
    let dname = expand('%:p:h')
    let pkg = go#package#ImportPath(dname)

    if exists('g:go_oracle_scope')
        " let the user defines the scope, must be a space separated string,
        " example: 'fmt math net/http'
        let scopes = split(get(g:, 'go_oracle_scope'))
    elseif a:needs_package || exists('g:go_oracle_include_tests') && pkg != -1
        " give import path so it includes all _test.go files too
        let scopes = [pkg]
    else
        " best usable way, only pass the package itself, without the test
        " files
        let scopes = go#tool#Files()
    endif

    "return with a warning if the bin doesn't exist
    let bin_path = go#path#CheckBinPath(g:go_oracle_bin) 
    if empty(bin_path) 
        return 
    endif
    
    if exists('g:go_oracle_tags')
        let tags = get(g:, 'go_oracle_tags')
    else
        let tags = ""
    endif

    if a:selected != -1
        let pos1 = go#util#Offset(line("'<"), col("'<"))
        let pos2 = go#util#Offset(line("'>"), col("'>"))
        let cmd = printf('%s -format plain -pos=%s:#%d,#%d -tags=%s %s',
                    \  bin_path,
                    \  shellescape(fname), pos1, pos2, tags, a:mode)
    else
        let pos = go#util#OffsetCursor()
        let cmd = printf('%s -format plain -pos=%s:#%d -tags=%s %s',
                    \  bin_path,
                    \  shellescape(fname), pos, tags, a:mode)
    endif

    " strip trailing slashes for each path in scoped. bug:
    " https://github.com/golang/go/issues/14584
    let scopes = go#util#StripTrailingSlash(scopes)

    " now append each scope to the end as Oracle's scope parameter. It can be
    " a packages or go files, dependent on the User's own choice. For more
    " info check Oracle's User Manual section about scopes:
    " https://docs.google.com/document/d/1SLk36YRjjMgKqe490mSRzOPYEDe0Y_WQNRv-EiFYUyw/view#heading=h.nwso96pj07q8
    let cmd .= ' ' . go#util#Shelljoin(scopes)

    echon "vim-go: " | echohl Identifier | echon "analysing ..." | echohl None

    let old_gopath = $GOPATH
    let $GOPATH = go#path#Detect()

    let out = system(cmd)

    let $GOPATH = old_gopath

    if v:shell_error
        " unfortunaly oracle outputs a very long stack trace that is not
        " parsable to show the real error. But the main issue is usually the
        " package which doesn't build. 
        redraw | echon "vim-go: " | echohl Statement | echon out | echohl None
        return ""
    endif

    return out
endfunc

function! go#oracle#Scope(...)
    if a:0
        if a:0 == 1 && a:1 == '""'
            unlet g:go_oracle_scope
            echon "vim-go: " | echohl Function | echon "oracle scope is cleared"| echohl None
        else
            let g:go_oracle_scope = join(a:000, ' ')
            echon "vim-go: " | echohl Function | echon "oracle scope changed to: '". g:go_oracle_scope ."'" | echohl None
        endif

        return
    endif

    if !exists('g:go_oracle_scope')
        echon "vim-go: " | echohl Function | echon "oracle scope is not set"| echohl None
    else
        echon "vim-go: " | echohl Function | echon "current oracle scope: '". g:go_oracle_scope ."'" | echohl None
    endif
endfunction

function! go#oracle#Tags(...)
    if a:0
        if a:0 == 1 && a:1 == '""'
            unlet g:go_oracle_tags
            echon "vim-go: " | echohl Function | echon "oracle tags is cleared"| echohl None
        else
            let g:go_oracle_tags = a:1
            echon "vim-go: " | echohl Function | echon "oracle tags changed to: '". g:go_oracle_tags ."'" | echohl None
        endif

        return
    endif

    if !exists('g:go_oracle_tags')
        echon "vim-go: " | echohl Function | echon "oracle tags is not set"| echohl None
    else
        echon "vim-go: " | echohl Function | echon "current oracle tags: '". g:go_oracle_tags ."'" | echohl None
    endif
endfunction

" Show 'implements' relation for selected package
function! go#oracle#Implements(selected)
    let out = s:RunOracle('implements', a:selected, 0)
    call s:loclistSecond(out)
endfunction

" Describe selected syntax: definition, methods, etc
function! go#oracle#Describe(selected)
    let out = s:RunOracle('describe', a:selected, 0)
    call s:loclistSecond(out)
endfunction

" Show possible targets of selected function call
function! go#oracle#Callees(selected)
    let out = s:RunOracle('callees', a:selected, 1)
    call s:loclistSecond(out)
endfunction

" Show possible callers of selected function
function! go#oracle#Callers(selected)
    let out = s:RunOracle('callers', a:selected, 1)
    call s:loclistSecond(out)
endfunction

" Show path from callgraph root to selected function
function! go#oracle#Callstack(selected)
    let out = s:RunOracle('callstack', a:selected, 1)
    call s:loclistSecond(out)
endfunction

" Show free variables of selection
function! go#oracle#Freevars(selected)
    " Freevars requires a selection
    if a:selected == -1
        echon "vim-go: " | echohl Statement | echon "GoFreevars requires a selection (range) of code "| echohl None
        return
    endif

    let out = s:RunOracle('freevars', a:selected, 0)
    call s:loclistSecond(out)
endfunction

" Show send/receive corresponding to selected channel op
function! go#oracle#ChannelPeers(selected)
    let out = s:RunOracle('peers', a:selected, 1)
    call s:loclistSecond(out)
endfunction

" Show all refs to entity denoted by selected identifier
function! go#oracle#Referrers(selected)
    let out = s:RunOracle('referrers', a:selected, 0)
    call s:loclistSecond(out)
endfunction

" vim:ts=4:sw=4:et
"