" 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. " don't spam the user when Vim is started in Vi compatibility mode let s:cpo_save = &cpo set cpo&vim scriptencoding utf-8 let s:buf_nr = -1 function! go#doc#OpenBrowser(...) abort if len(a:000) == 0 let [l:out, l:err] = go#lsp#DocLink() if l:err call go#util#EchoError(l:out) return endif if len(l:out) == 0 call go#util#EchoWarning("could not path for doc URL") endif let l:godoc_url = printf('%s/%s', go#config#DocUrl(), l:out) call go#util#OpenBrowser(l:godoc_url) return endif let pkgs = s:godocWord(a:000) if empty(pkgs) return endif let pkg = pkgs[0] let exported_name = pkgs[1] " example url: https://godoc.org/github.com/fatih/set#Set let godoc_url = printf('%s/%s#%s', go#config#DocUrl(), pkg, exported_name) call go#util#OpenBrowser(godoc_url) endfunction function! go#doc#Open(newmode, mode, ...) abort " With argument: run "godoc [arg]". if len(a:000) let [l:out, l:err] = go#util#Exec(['go', 'doc'] + a:000) else " Without argument: use gopls to get documentation let [l:out, l:err] = go#lsp#Doc() endif if l:err call go#util#EchoError(out) return endif call s:GodocView(a:newmode, a:mode, l:out) endfunction function! s:GodocView(newposition, position, content) abort " popup window if go#config#DocPopupWindow() if exists('*popup_atcursor') && exists('*popup_clear') call popup_clear() let borderchars = ['-', '|', '-', '|', '+', '+', '+', '+'] if &encoding == "utf-8" let borderchars = ['─', '│', '─', '│', '┌', '┐', '┘', '└'] endif call popup_atcursor(split(a:content, '\n'), { \ 'padding': [1, 1, 1, 1], \ 'borderchars': borderchars, \ 'border': [1, 1, 1, 1], \ }) elseif has('nvim') && exists('*nvim_open_win') let lines = split(a:content, '\n') let height = 0 let width = 0 for line in lines let lw = strdisplaywidth(line) if lw > width let width = lw endif let height += 1 endfor let width += 1 " right margin let max_height = go#config#DocMaxHeight() if height > max_height let height = max_height endif let buf = nvim_create_buf(v:false, v:true) call nvim_buf_set_lines(buf, 0, -1, v:true, lines) let opts = { \ 'relative': 'cursor', \ 'row': 1, \ 'col': 0, \ 'width': width, \ 'height': height, \ 'style': 'minimal', \ } call nvim_open_win(buf, v:true, opts) setlocal nomodified nomodifiable filetype=godoc " close easily with CR, Esc and q noremap :close noremap :close noremap q :close endif return endif " reuse existing buffer window if it exists otherwise create a new one let is_visible = bufexists(s:buf_nr) && bufwinnr(s:buf_nr) != -1 if !bufexists(s:buf_nr) execute a:newposition sil file `="[Godoc]"` let s:buf_nr = bufnr('%') elseif bufwinnr(s:buf_nr) == -1 execute a:position execute s:buf_nr . 'buffer' elseif bufwinnr(s:buf_nr) != bufwinnr('%') execute bufwinnr(s:buf_nr) . 'wincmd w' endif " if window was not visible then resize it if !is_visible if a:position == "split" " cap window height to 20, but resize it for smaller contents let max_height = go#config#DocMaxHeight() let content_height = len(split(a:content, "\n")) if content_height > max_height exe 'resize ' . max_height else exe 'resize ' . content_height endif else " set a sane maximum width for vertical splits. In this case the minimum " that fits the godoc for package http without extra linebreaks and line " numbers on exe 'vertical resize 84' endif endif setlocal filetype=godoc setlocal bufhidden=delete setlocal buftype=nofile setlocal noswapfile setlocal nobuflisted setlocal nocursorline setlocal nocursorcolumn setlocal iskeyword+=: setlocal iskeyword-=- setlocal modifiable %delete _ call append(0, split(a:content, "\n")) sil $delete _ setlocal nomodifiable sil normal! gg " close easily with enter noremap :close noremap :close " make sure any key that sends an escape as a prefix (e.g. the arrow keys) " don't cause the window to close. nnoremap [ [ endfunction " returns the package and exported name. exported name might be empty. " ie: fmt and Println " ie: github.com/fatih/set and New function! s:godocWord(args) abort if !executable('godoc') let msg = "godoc command not found." let msg .= " install with: go get golang.org/x/tools/cmd/godoc" call go#util#EchoWarning(msg) return [] endif if !len(a:args) let oldiskeyword = &iskeyword setlocal iskeyword+=. let word = expand('') let &iskeyword = oldiskeyword let word = substitute(word, '[^a-zA-Z0-9\\/._~-]', '', 'g') let words = split(word, '\.\ze[^./]\+$') else let words = a:args endif if !len(words) return [] endif let pkg = words[0] if len(words) == 1 let exported_name = "" else let exported_name = words[1] endif let packages = go#tool#Imports() if has_key(packages, pkg) let pkg = packages[pkg] endif return [pkg, exported_name] endfunction " restore Vi compatibility settings let &cpo = s:cpo_save unlet s:cpo_save " vim: sw=2 ts=2 et