vim-gutentags: autoload/gutentags.vim annotate

annotate autoload/gutentags.vim @ 277:f75a8cddf174

Support powershell * Powershell takes double quoted "arguments" literally and just errors out on a gutentags call * You could unquote all the strings and try to deal with the mess that is * Or you can just prepend '& ' to the whole thing and it automagically works

author	Leonardo Valeri Manera <l.valerimanera@gmail.com>
date	Sat, 15 Oct 2022 03:21:13 +0200
parents	6030953258fe
children

rev	line source
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	1 " gutentags.vim - Automatic ctags management for Vim
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	2
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	3 " Utilities {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	4
168 e59321cbaff7 Use scope-local functions Henry Kupty <hkupty@gmail.com> parents: 136 diff changeset	5 function! gutentags#chdir(path)
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	6 if has('nvim')
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	7 let chdir = haslocaldir() ? 'lcd' : haslocaldir(-1, 0) ? 'tcd' : 'cd'
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	8 else
262 dc9216fc0c0f escape the file name in a right way, handle `tcd` in vim skywind3000 <skywind3000@163.com> parents: 260 diff changeset	9 let chdir = haslocaldir() ? ((haslocaldir() == 1) ? 'lcd' : 'tcd') : 'cd'
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	10 endif
262 dc9216fc0c0f escape the file name in a right way, handle `tcd` in vim skywind3000 <skywind3000@163.com> parents: 260 diff changeset	11 execute chdir fnameescape(a:path)
168 e59321cbaff7 Use scope-local functions Henry Kupty <hkupty@gmail.com> parents: 136 diff changeset	12 endfunction
e59321cbaff7 Use scope-local functions Henry Kupty <hkupty@gmail.com> parents: 136 diff changeset	13
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	14 " Throw an exception message.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	15 function! gutentags#throw(message)
148 b178f2251982 Only set `v:errmsg` when we throw an actual error. Ludovic Chabant <ludovic@chabant.com> parents: 147 diff changeset	16 throw "gutentags: " . a:message
b178f2251982 Only set `v:errmsg` when we throw an actual error. Ludovic Chabant <ludovic@chabant.com> parents: 147 diff changeset	17 endfunction
b178f2251982 Only set `v:errmsg` when we throw an actual error. Ludovic Chabant <ludovic@chabant.com> parents: 147 diff changeset	18
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	19 " Show an error message.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	20 function! gutentags#error(message)
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	21 let v:errmsg = "gutentags: " . a:message
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	22 echoerr v:errmsg
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	23 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	24
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	25 " Show a warning message.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	26 function! gutentags#warning(message)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	27 echohl WarningMsg
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	28 echom "gutentags: " . a:message
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	29 echohl None
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	30 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	31
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	32 " Prints a message if debug tracing is enabled.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	33 function! gutentags#trace(message, ...)
220 60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	34 if g:gutentags_trace \|\| (a:0 && a:1)
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	35 let l:message = "gutentags: " . a:message
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	36 echom l:message
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	37 endif
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	38 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	39
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	40 " Strips the ending slash in a path.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	41 function! gutentags#stripslash(path)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	42 return fnamemodify(a:path, ':s?[/\\]$??')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	43 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	44
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	45 " Normalizes the slashes in a path.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	46 function! gutentags#normalizepath(path)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	47 if exists('+shellslash') && &shellslash
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	48 return substitute(a:path, '\v/', '\\', 'g')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	49 elseif has('win32')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	50 return substitute(a:path, '\v/', '\\', 'g')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	51 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	52 return a:path
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	53 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	54 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	55
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	56 " Shell-slashes the path (opposite of `normalizepath`).
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	57 function! gutentags#shellslash(path)
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	58 if exists('+shellslash') && !&shellslash
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	59 return substitute(a:path, '\v\\', '/', 'g')
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	60 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	61 return a:path
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	62 endif
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	63 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	64
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	65 " Gets a file path in the correct `plat` folder.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	66 function! gutentags#get_plat_file(filename) abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	67 return g:gutentags_plat_dir . a:filename . g:gutentags_script_ext
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	68 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	69
75 d12543f11eb9 Move the default `-R` option to an overridable "global" options file. Ludovic Chabant <ludovic@chabant.com> parents: 70 diff changeset	70 " Gets a file path in the resource folder.
d12543f11eb9 Move the default `-R` option to an overridable "global" options file. Ludovic Chabant <ludovic@chabant.com> parents: 70 diff changeset	71 function! gutentags#get_res_file(filename) abort
d12543f11eb9 Move the default `-R` option to an overridable "global" options file. Ludovic Chabant <ludovic@chabant.com> parents: 70 diff changeset	72 return g:gutentags_res_dir . a:filename
d12543f11eb9 Move the default `-R` option to an overridable "global" options file. Ludovic Chabant <ludovic@chabant.com> parents: 70 diff changeset	73 endfunction
d12543f11eb9 Move the default `-R` option to an overridable "global" options file. Ludovic Chabant <ludovic@chabant.com> parents: 70 diff changeset	74
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	75 " Generate a path for a given filename in the cache directory.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	76 function! gutentags#get_cachefile(root_dir, filename) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	77 if gutentags#is_path_rooted(a:filename)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	78 return a:filename
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	79 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	80 let l:tag_path = gutentags#stripslash(a:root_dir) . '/' . a:filename
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	81 if g:gutentags_cache_dir != ""
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	82 " Put the tag file in the cache dir instead of inside the
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	83 " project root.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	84 let l:tag_path = g:gutentags_cache_dir . '/' .
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	85 \tr(l:tag_path, '\/: ', '---_')
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	86 let l:tag_path = substitute(l:tag_path, '/\-', '/', '')
246 97723c1818e0 Strip any `-` characters left at the end of a tag-file path. Ludovic Chabant <ludovic@chabant.com> parents: 244 diff changeset	87 let l:tag_path = substitute(l:tag_path, '[\-_]*$', '', '')
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	88 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	89 let l:tag_path = gutentags#normalizepath(l:tag_path)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	90 return l:tag_path
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	91 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	92
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	93 " Makes sure a given command starts with an executable that's in the PATH.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	94 function! gutentags#validate_cmd(cmd) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	95 if !empty(a:cmd) && executable(split(a:cmd)[0])
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	96 return a:cmd
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	97 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	98 return ""
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	99 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	100
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	101 " Makes an appropriate command line for use with `job_start` by converting
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	102 " a list of possibly quoted arguments into a single string on Windows, or
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	103 " into a list of unquoted arguments on Unix/Mac.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	104 if has('win32') \|\| has('win64')
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	105 function! gutentags#make_args(cmd) abort
277 f75a8cddf174 Support powershell Leonardo Valeri Manera <l.valerimanera@gmail.com> parents: 267 diff changeset	106 if &shell == 'pwsh' \|\| &shell == 'powershell'
f75a8cddf174 Support powershell Leonardo Valeri Manera <l.valerimanera@gmail.com> parents: 267 diff changeset	107 return '& ' . join(a:cmd, ' ')
f75a8cddf174 Support powershell Leonardo Valeri Manera <l.valerimanera@gmail.com> parents: 267 diff changeset	108 else
f75a8cddf174 Support powershell Leonardo Valeri Manera <l.valerimanera@gmail.com> parents: 267 diff changeset	109 return join(a:cmd, ' ')
f75a8cddf174 Support powershell Leonardo Valeri Manera <l.valerimanera@gmail.com> parents: 267 diff changeset	110 endif
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	111 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	112 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	113 function! gutentags#make_args(cmd) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	114 let l:outcmd = []
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	115 for cmdarg in a:cmd
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	116 " Thanks Vimscript... you can use negative integers for strings
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	117 " in the slice notation, but not for indexing characters :(
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	118 let l:arglen = strlen(cmdarg)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	119 if (cmdarg[0] == '"' && cmdarg[l:arglen - 1] == '"') \|\|
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	120 \(cmdarg[0] == "'" && cmdarg[l:arglen - 1] == "'")
251 e61d20280c6c Fix some more spaces-in-paths issues. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	121 " This was quoted, so there are probably things to escape.
e61d20280c6c Fix some more spaces-in-paths issues. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	122 let l:escapedarg = cmdarg[1:-2] " substitute(cmdarg[1:-2], '\ ', '\\ ', 'g')
e61d20280c6c Fix some more spaces-in-paths issues. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	123 call add(l:outcmd, l:escapedarg)
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	124 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	125 call add(l:outcmd, cmdarg)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	126 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	127 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	128 return l:outcmd
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	129 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	130 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	131
164 28d4dae03f2a If a user init function specified an absolute path, don't mess with it. Ludovic Chabant <ludovic@chabant.com> parents: 157 diff changeset	132 " Returns whether a path is rooted.
28d4dae03f2a If a user init function specified an absolute path, don't mess with it. Ludovic Chabant <ludovic@chabant.com> parents: 157 diff changeset	133 if has('win32') \|\| has('win64')
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	134 function! gutentags#is_path_rooted(path) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	135 return len(a:path) >= 2 && (
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	136 \a:path[0] == '/' \|\| a:path[0] == '\' \|\| a:path[1] == ':')
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	137 endfunction
164 28d4dae03f2a If a user init function specified an absolute path, don't mess with it. Ludovic Chabant <ludovic@chabant.com> parents: 157 diff changeset	138 else
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	139 function! gutentags#is_path_rooted(path) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	140 return !empty(a:path) && a:path[0] == '/'
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	141 endfunction
164 28d4dae03f2a If a user init function specified an absolute path, don't mess with it. Ludovic Chabant <ludovic@chabant.com> parents: 157 diff changeset	142 endif
28d4dae03f2a If a user init function specified an absolute path, don't mess with it. Ludovic Chabant <ludovic@chabant.com> parents: 157 diff changeset	143
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	145
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	146 " Gutentags Setup {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	147
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	148 let s:known_files = []
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	149 let s:known_projects = {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	150
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	151 function! s:cache_project_root(path) abort
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	152 let l:result = {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	153
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	154 for proj_info in g:gutentags_project_info
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	155 let l:filematch = get(proj_info, 'file', '')
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	156 if l:filematch != '' && filereadable(a:path . '/'. l:filematch)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	157 let l:result = copy(proj_info)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	158 break
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	159 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	160
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	161 let l:globmatch = get(proj_info, 'glob', '')
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	162 if l:globmatch != '' && glob(a:path . '/' . l:globmatch) != ''
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	163 let l:result = copy(proj_info)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	164 break
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	165 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	166 endfor
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	167
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	168 let s:known_projects[a:path] = l:result
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	169 endfunction
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	170
136 286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	171 function! gutentags#get_project_file_list_cmd(path) abort
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	172 if type(g:gutentags_file_list_command) == type("")
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	173 return gutentags#validate_cmd(g:gutentags_file_list_command)
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	174 elseif type(g:gutentags_file_list_command) == type({})
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	175 let l:markers = get(g:gutentags_file_list_command, 'markers', [])
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	176 if type(l:markers) == type({})
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	177 for [marker, file_list_cmd] in items(l:markers)
157 6b00f4383708 Support project root markers that are wildcard patterns. Ludovic Chabant <ludovic@chabant.com> parents: 148 diff changeset	178 if !empty(globpath(a:path, marker, 1))
136 286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	179 return gutentags#validate_cmd(file_list_cmd)
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	180 endif
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	181 endfor
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	182 endif
157 6b00f4383708 Support project root markers that are wildcard patterns. Ludovic Chabant <ludovic@chabant.com> parents: 148 diff changeset	183 return get(g:gutentags_file_list_command, 'default', "")
136 286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	184 endif
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	185 return ""
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	186 endfunction
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	187
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	188 " Finds the first directory with a project marker by walking up from the given
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	189 " file path.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	190 function! gutentags#get_project_root(path) abort
146 3459a2522a3b Enable Project Root Finder thecontinium <thecontinium@outlook.com> parents: 136 diff changeset	191 if g:gutentags_project_root_finder != ''
132 a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 131 diff changeset	192 return call(g:gutentags_project_root_finder, [a:path])
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 131 diff changeset	193 endif
244 d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	194 return gutentags#default_get_project_root(a:path)
d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	195 endfunction
132 a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 131 diff changeset	196
244 d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	197 " Default implementation for finding project markers... useful when a custom
d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	198 " finder (`g:gutentags_project_root_finder`) wants to fallback to the default
d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	199 " behaviour.
d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	200 function! gutentags#default_get_project_root(path) abort
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	201 let l:path = gutentags#stripslash(a:path)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	202 let l:previous_path = ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	203 let l:markers = g:gutentags_project_root[:]
243 050d0549ecf3 Add `g:gutentags_add_ctrlp_root_markers` option. Ludovic Chabant <ludovic@chabant.com> parents: 236 diff changeset	204 if g:gutentags_add_ctrlp_root_markers && exists('g:ctrlp_root_markers')
134 04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	205 for crm in g:ctrlp_root_markers
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	206 if index(l:markers, crm) < 0
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	207 call add(l:markers, crm)
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	208 endif
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	209 endfor
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	210 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	211 while l:path != l:previous_path
80 51c1a57811b3 Use full list of root markers in get_project_root. Greg Hensley <greg.hensley@gmail.com> parents: 75 diff changeset	212 for root in l:markers
174 721cba3cd20d Don't apply `wildignore` when looking for markers Rafael Bodill <justrafi@gmail.com> parents: 173 diff changeset	213 if !empty(globpath(l:path, root, 1))
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	214 let l:proj_dir = simplify(fnamemodify(l:path, ':p'))
90 b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	215 let l:proj_dir = gutentags#stripslash(l:proj_dir)
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	216 if l:proj_dir == ''
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	217 call gutentags#trace("Found project marker '" . root .
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	218 \"' at the root of your file-system! " .
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	219 \" That's probably wrong, disabling " .
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	220 \"gutentags for this file...",
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	221 \1)
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	222 call gutentags#throw("Marker found at root, aborting.")
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	223 endif
118 2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	224 for ign in g:gutentags_exclude_project_root
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	225 if l:proj_dir == ign
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	226 call gutentags#trace(
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	227 \"Ignoring project root '" . l:proj_dir .
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	228 \"' because it is in the list of ignored" .
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	229 \" projects.")
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	230 call gutentags#throw("Ignore project: " . l:proj_dir)
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	231 endif
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	232 endfor
90 b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	233 return l:proj_dir
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	234 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	235 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	236 let l:previous_path = l:path
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	237 let l:path = fnamemodify(l:path, ':h')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	238 endwhile
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	239 call gutentags#throw("Can't figure out what tag file to use for: " . a:path)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	240 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	241
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	242 " Get info on the project we're inside of.
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	243 function! gutentags#get_project_info(path) abort
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	244 return get(s:known_projects, a:path, {})
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	245 endfunction
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	246
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	247 " Setup gutentags for the current buffer.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	248 function! gutentags#setup_gutentags() abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	249 if exists('b:gutentags_files') && !g:gutentags_debug
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	250 " This buffer already has gutentags support.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	251 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	252 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	253
63 0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	254 " Don't setup gutentags for anything that's not a normal buffer
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	255 " (so don't do anything for help buffers and quickfix windows and
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	256 " other such things)
166 1fe62e7f1fae Don't trigger a tags generation for the empty startup buffer. Ludovic Chabant <ludovic@chabant.com> parents: 164 diff changeset	257 " Also don't do anything for the default `[No Name]` buffer you get
1fe62e7f1fae Don't trigger a tags generation for the empty startup buffer. Ludovic Chabant <ludovic@chabant.com> parents: 164 diff changeset	258 " after starting Vim.
182 2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 180 diff changeset	259 if &buftype != '' \|\|
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 180 diff changeset	260 \(bufname('%') == '' && !g:gutentags_generate_on_empty_buffer)
63 0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	261 return
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	262 endif
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	263
229 34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	264 " Don't setup gutentags for things that don't need it, or that could
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	265 " cause problems.
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	266 if index(g:gutentags_exclude_filetypes, &filetype) >= 0
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	267 return
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	268 endif
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	269
88 073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	270 " Let the user specify custom ways to disable Gutentags.
141 7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 136 diff changeset	271 if g:gutentags_init_user_func != '' &&
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 136 diff changeset	272 \!call(g:gutentags_init_user_func, [expand('%:p')])
88 073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	273 call gutentags#trace("Ignoring '" . bufname('%') . "' because of " .
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	274 \"custom user function.")
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	275 return
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	276 endif
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	277
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	278 " Try and find what tags file we should manage.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	279 call gutentags#trace("Scanning buffer '" . bufname('%') . "' for gutentags setup...")
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	280 try
85 0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	281 let l:buf_dir = expand('%:p:h', 1)
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	282 if g:gutentags_resolve_symlinks
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	283 let l:buf_dir = fnamemodify(resolve(expand('%:p', 1)), ':p:h')
0424970d81f8 Add a `g:gutentags_resolve_symlinks` option to resolve symlinks at setup time. Ludovic Chabant <ludovic@chabant.com> parents: 84 diff changeset	284 endif
123 76a4822aab76 Use existing b:gutentags_root Daniel Hahler <git@thequod.de> parents: 102 diff changeset	285 if !exists('b:gutentags_root')
76a4822aab76 Use existing b:gutentags_root Daniel Hahler <git@thequod.de> parents: 102 diff changeset	286 let b:gutentags_root = gutentags#get_project_root(l:buf_dir)
76a4822aab76 Use existing b:gutentags_root Daniel Hahler <git@thequod.de> parents: 102 diff changeset	287 endif
236 a77c3eb4ce34 Handle custom project root finder functions returning no value. Ludovic Chabant <ludovic@chabant.com> parents: 229 diff changeset	288 if !len(b:gutentags_root)
a77c3eb4ce34 Handle custom project root finder functions returning no value. Ludovic Chabant <ludovic@chabant.com> parents: 229 diff changeset	289 call gutentags#trace("no valid project root.. no gutentags support.")
a77c3eb4ce34 Handle custom project root finder functions returning no value. Ludovic Chabant <ludovic@chabant.com> parents: 229 diff changeset	290 return
a77c3eb4ce34 Handle custom project root finder functions returning no value. Ludovic Chabant <ludovic@chabant.com> parents: 229 diff changeset	291 endif
47 7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	292 if filereadable(b:gutentags_root . '/.notags')
121 8310e4602de9 minor: fix typos / unbalanced quotes Daniel Hahler <git@thequod.de> parents: 102 diff changeset	293 call gutentags#trace("'.notags' file found... no gutentags support.")
47 7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	294 return
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	295 endif
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	296
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	297 if !has_key(s:known_projects, b:gutentags_root)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	298 call s:cache_project_root(b:gutentags_root)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	299 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	300 if g:gutentags_trace
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	301 let l:projnfo = gutentags#get_project_info(b:gutentags_root)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	302 if l:projnfo != {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	303 call gutentags#trace("Setting project type to ".l:projnfo['type'])
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	304 else
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	305 call gutentags#trace("No specific project type.")
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	306 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	307 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	308
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	309 let b:gutentags_files = {}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	310 for module in g:gutentags_modules
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	311 call call("gutentags#".module."#init", [b:gutentags_root])
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	312 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	313 catch /^gutentags\:/
118 2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	314 call gutentags#trace("No gutentags support for this buffer.")
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	315 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	316 endtry
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	317
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	318 " We know what tags file to manage! Now set things up.
121 8310e4602de9 minor: fix typos / unbalanced quotes Daniel Hahler <git@thequod.de> parents: 102 diff changeset	319 call gutentags#trace("Setting gutentags for buffer '".bufname('%')."'")
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	320
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	321 " Autocommands for updating the tags on save.
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	322 " We need to pass the buffer number to the callback function in the rare
b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	323 " case that the current buffer is changed by another `BufWritePost`
b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	324 " callback. This will let us get that buffer's variables without causing
b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	325 " errors.
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	326 let l:bn = bufnr('%')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	327 execute 'augroup gutentags_buffer_' . l:bn
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	328 execute ' autocmd!'
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	329 execute ' autocmd BufWritePost <buffer=' . l:bn . '> call s:write_triggered_update_tags(' . l:bn . ')'
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	330 execute 'augroup end'
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	331
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	332 " Miscellaneous commands.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	333 command! -buffer -bang GutentagsUpdate :call s:manual_update_tags(<bang>0)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	334
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	335 " Add these tags files to the known tags files.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	336 for module in keys(b:gutentags_files)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	337 let l:tagfile = b:gutentags_files[module]
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	338 let l:found = index(s:known_files, l:tagfile)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	339 if l:found < 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	340 call add(s:known_files, l:tagfile)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	341
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	342 " Generate this new file depending on settings and stuff.
87 afe113047204 Don't generate tags on file opened if `gutentags_enabled` is false. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	343 if g:gutentags_enabled
afe113047204 Don't generate tags on file opened if `gutentags_enabled` is false. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	344 if g:gutentags_generate_on_missing && !filereadable(l:tagfile)
afe113047204 Don't generate tags on file opened if `gutentags_enabled` is false. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	345 call gutentags#trace("Generating missing tags file: " . l:tagfile)
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	346 call s:update_tags(l:bn, module, 1, 1)
87 afe113047204 Don't generate tags on file opened if `gutentags_enabled` is false. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	347 elseif g:gutentags_generate_on_new
afe113047204 Don't generate tags on file opened if `gutentags_enabled` is false. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	348 call gutentags#trace("Generating tags file: " . l:tagfile)
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	349 call s:update_tags(l:bn, module, 1, 1)
87 afe113047204 Don't generate tags on file opened if `gutentags_enabled` is false. Ludovic Chabant <ludovic@chabant.com> parents: 85 diff changeset	350 endif
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	351 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	352 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	353 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	354 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	355
254 52be4cf89810 Don't complain when the job gets killed when Vim exits. Ludovic Chabant <ludovic@chabant.com> parents: 251 diff changeset	356 " Set a variable on exit so that we don't complain when a job gets killed.
52be4cf89810 Don't complain when the job gets killed when Vim exits. Ludovic Chabant <ludovic@chabant.com> parents: 251 diff changeset	357 function! gutentags#on_vim_leave_pre() abort
52be4cf89810 Don't complain when the job gets killed when Vim exits. Ludovic Chabant <ludovic@chabant.com> parents: 251 diff changeset	358 let g:__gutentags_vim_is_leaving = 1
52be4cf89810 Don't complain when the job gets killed when Vim exits. Ludovic Chabant <ludovic@chabant.com> parents: 251 diff changeset	359 endfunction
52be4cf89810 Don't complain when the job gets killed when Vim exits. Ludovic Chabant <ludovic@chabant.com> parents: 251 diff changeset	360
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	361 function! gutentags#on_vim_leave() abort
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	362 if has('win32') && !has('nvim')
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	363 " Vim8 doesn't seem to be killing child processes soon enough for
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	364 " us to clean things up inside this plugin, so do it ourselves.
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	365 " TODO: test other platforms and other vims
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	366 for module in g:gutentags_modules
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	367 for upd_info in s:update_in_progress[module]
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	368 let l:job = upd_info[1]
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	369 call job_stop(l:job, "term")
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	370 let l:status = job_status(l:job)
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	371 if l:status == "run"
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	372 call job_stop(l:job, "kill")
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	373 endif
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	374 endfor
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	375 endfor
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	376 endif
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	377 endfunction
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	378
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	379 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	380
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	381 " Job Management {{{
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	382
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	383 " List of queued-up jobs, and in-progress jobs, per module.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	384 let s:update_queue = {}
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	385 let s:update_in_progress = {}
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	386 for module in g:gutentags_modules
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	387 let s:update_queue[module] = []
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	388 let s:update_in_progress[module] = []
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	389 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	390
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	391 " Adds a started job to the list of ongoing updates.
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	392 " Must pass the tags file being created/updated, and the job data as
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	393 " returned by the gutentags#start_job function
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	394 function! gutentags#add_job(module, tags_file, data) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	395 call add(s:update_in_progress[a:module], [a:tags_file, a:data])
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	396 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	397
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	398 " Finds an ongoing job by tags file
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	399 function! gutentags#find_job_index_by_tags_file(module, tags_file) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	400 let l:idx = -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	401 for upd_info in s:update_in_progress[a:module]
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	402 let l:idx += 1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	403 if upd_info[0] == a:tags_file
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	404 return l:idx
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	405 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	406 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	407 return -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	408 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	409
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	410 " Finds an ongoing job by job data
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	411 function! gutentags#find_job_index_by_data(module, data) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	412 let l:idx = -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	413 for upd_info in s:update_in_progress[a:module]
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	414 let l:idx += 1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	415 if upd_info[1] == a:data
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	416 return l:idx
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	417 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	418 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	419 return -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	420 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	421
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	422 " Gets the tags file of a given job
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	423 function! gutentags#get_job_tags_file(module, job_idx) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	424 return s:update_in_progress[a:module][a:job_idx][0]
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	425 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	426
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	427 " Gets the job data of the i-th job
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	428 function! gutentags#get_job_data(module, job_idx) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	429 return s:update_in_progress[a:module][a:job_idx][1]
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	430 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	431
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	432 " Removes the i-th job from the ongoing jobs
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	433 function! gutentags#remove_job(module, job_idx) abort
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	434 let [l:tags_file, l:job_data] = s:update_in_progress[a:module][a:job_idx]
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	435 call remove(s:update_in_progress[a:module], a:job_idx)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	436
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	437 " Run the user callback for finished jobs.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	438 silent doautocmd User GutentagsUpdated
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	439
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	440 " See if we had any more updates queued up for this.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	441 let l:qu_idx = -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	442 for qu_info in s:update_queue[a:module]
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	443 let l:qu_idx += 1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	444 if qu_info[0] == l:tags_file
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	445 break
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	446 endif
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	447 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	448 if l:qu_idx >= 0
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	449 let l:qu_info = s:update_queue[a:module][l:qu_idx]
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	450 call remove(s:update_queue[a:module], l:qu_idx)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	451
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	452 if bufexists(l:qu_info[1])
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	453 call gutentags#trace("Finished ".a:module." job, ".
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	454 \"running queued update for '".l:tags_file."'.")
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	455 call s:update_tags(l:qu_info[1], a:module, l:qu_info[2], 2)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	456 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	457 call gutentags#trace("Finished ".a:module." job, ".
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	458 \"but skipping queued update for '".l:tags_file."' ".
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	459 \"because originating buffer doesn't exist anymore.")
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	460 endif
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	461 else
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	462 call gutentags#trace("Finished ".a:module." job.")
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	463 endif
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	464
6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	465 return [l:tags_file, l:job_data]
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	466 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	467
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	468 " Removes the job from the ongoing jobs given its job data
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	469 function! gutentags#remove_job_by_data(module, data) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	470 let l:idx = gutentags#find_job_index_by_data(a:module, a:data)
267 6030953258fe On Windows, kill ongoing jobs before leaving so we can clean-up temp files Ludovic Chabant <ludovic@chabant.com> parents: 265 diff changeset	471 return gutentags#remove_job(a:module, l:idx)
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	472 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	473
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	474 " }}}
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	475
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	476 " Tags File Management {{{
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	477
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	478 " (Re)Generate the tags file for the current buffer's file.
48 c1b33dc55b1c Fix bug with `GutentagsUpdate` command. Ludovic Chabant <ludovic@chabant.com> parents: 47 diff changeset	479 function! s:manual_update_tags(bang) abort
221 93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	480 let l:restore_prev_trace = 0
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	481 let l:prev_trace = g:gutentags_trace
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	482 if &verbose > 0
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	483 let g:gutentags_trace = 1
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	484 let l:restore_prev_trace = 1
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	485 endif
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	486
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	487 try
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	488 let l:bn = bufnr('%')
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	489 for module in g:gutentags_modules
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	490 call s:update_tags(l:bn, module, a:bang, 0)
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	491 endfor
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	492 silent doautocmd User GutentagsUpdating
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	493 finally
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	494 if l:restore_prev_trace
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	495 let g:gutentags_trace = l:prev_trace
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	496 endif
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	497 endtry
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	498 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	499
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	500 " (Re)Generate the tags file for a buffer that just go saved.
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	501 function! s:write_triggered_update_tags(bufno) abort
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	502 if g:gutentags_enabled && g:gutentags_generate_on_write
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	503 for module in g:gutentags_modules
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	504 call s:update_tags(a:bufno, module, 0, 2)
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	505 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	506 endif
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	507 silent doautocmd User GutentagsUpdating
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	508 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	509
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	510 " Update the tags file for the current buffer's file.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	511 " write_mode:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	512 " 0: update the tags file if it exists, generate it otherwise.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	513 " 1: always generate (overwrite) the tags file.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	514 "
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	515 " queue_mode:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	516 " 0: if an update is already in progress, report it and abort.
83 e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	517 " 1: if an update is already in progress, abort silently.
e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	518 " 2: if an update is already in progress, queue another one.
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	519 function! s:update_tags(bufno, module, write_mode, queue_mode) abort
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	520 " Figure out where to save.
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	521 let l:buf_gutentags_files = getbufvar(a:bufno, 'gutentags_files')
b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	522 let l:tags_file = l:buf_gutentags_files[a:module]
b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	523 let l:proj_dir = getbufvar(a:bufno, 'gutentags_root')
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	524
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	525 " Check that there's not already an update in progress.
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	526 let l:in_progress_idx = gutentags#find_job_index_by_tags_file(
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	527 \a:module, l:tags_file)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	528 if l:in_progress_idx >= 0
83 e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	529 if a:queue_mode == 2
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	530 let l:needs_queuing = 1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	531 for qu_info in s:update_queue[a:module]
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	532 if qu_info[0] == l:tags_file
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	533 let l:needs_queuing = 0
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	534 break
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	535 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	536 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	537 if l:needs_queuing
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	538 call add(s:update_queue[a:module],
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	539 \[l:tags_file, a:bufno, a:write_mode])
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	540 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	541 call gutentags#trace("Tag file '" . l:tags_file .
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	542 \"' is already being updated. Queuing it up...")
83 e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	543 elseif a:queue_mode == 1
e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	544 call gutentags#trace("Tag file '" . l:tags_file .
e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	545 \"' is already being updated. Skipping...")
e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	546 elseif a:queue_mode == 0
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	547 echom "gutentags: The tags file is already being updated, " .
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	548 \"please try again later."
83 e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	549 else
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	550 call gutentags#throw("Unknown queue mode: " . a:queue_mode)
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	551 endif
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	552
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	553 " Don't update the tags right now.
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	554 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	555 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	556
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	557 " Switch to the project root to make the command line smaller, and make
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	558 " it possible to get the relative path of the filename to parse if we're
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	559 " doing an incremental update.
179 411f3fa915f5 Back to getcwd() Henry Kupty <hkupty@gmail.com> parents: 178 diff changeset	560 let l:prev_cwd = getcwd()
265 cbe7ffc327a4 Remove fnameescape call in chdir function Darren Kavanagh <dkav@users.noreply.github.com> parents: 262 diff changeset	561 call gutentags#chdir(l:proj_dir)
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	562 try
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	563 call call("gutentags#".a:module."#generate",
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	564 \[l:proj_dir, l:tags_file,
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	565 \ {
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	566 \ 'write_mode': a:write_mode,
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	567 \ }])
84 96bfe5c37f37 Error and abort if we'll be overwriting a non-ctags file. Ludovic Chabant <ludovic@chabant.com> parents: 83 diff changeset	568 catch /^gutentags\:/
96bfe5c37f37 Error and abort if we'll be overwriting a non-ctags file. Ludovic Chabant <ludovic@chabant.com> parents: 83 diff changeset	569 echom "Error while generating ".a:module." file:"
96bfe5c37f37 Error and abort if we'll be overwriting a non-ctags file. Ludovic Chabant <ludovic@chabant.com> parents: 83 diff changeset	570 echom v:exception
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	571 finally
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	572 " Restore the current directory...
265 cbe7ffc327a4 Remove fnameescape call in chdir function Darren Kavanagh <dkav@users.noreply.github.com> parents: 262 diff changeset	573 call gutentags#chdir(l:prev_cwd)
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	574 endtry
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	575 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	576
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	577 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	578
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	579 " Utility Functions {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	580
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	581 function! gutentags#rescan(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	582 if exists('b:gutentags_files')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	583 unlet b:gutentags_files
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	584 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	585 if a:0 && a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	586 let l:trace_backup = g:gutentags_trace
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	587 let l:gutentags_trace = 1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	588 endif
82 a837021a2388 Fix broken call debug function. Ludovic Chabant <ludovic@chabant.com> parents: 80 diff changeset	589 call gutentags#setup_gutentags()
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	590 if a:0 && a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	591 let g:gutentags_trace = l:trace_backup
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	592 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	593 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	594
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	595 function! gutentags#toggletrace(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	596 let g:gutentags_trace = !g:gutentags_trace
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	597 if a:0 > 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	598 let g:gutentags_trace = a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	599 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	600 if g:gutentags_trace
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	601 echom "gutentags: Tracing is enabled."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	602 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	603 echom "gutentags: Tracing is disabled."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	604 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	605 echom ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	606 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	607
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	608 function! gutentags#fake(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	609 let g:gutentags_fake = !g:gutentags_fake
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	610 if a:0 > 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	611 let g:gutentags_fake = a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	612 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	613 if g:gutentags_fake
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	614 echom "gutentags: Now faking gutentags."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	615 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	616 echom "gutentags: Now running gutentags for real."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	617 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	618 echom ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	619 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	620
250 d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	621 function! gutentags#default_stdout_cb(chan, msg) abort
d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	622 call gutentags#trace('[job stdout]: '.string(a:msg))
d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	623 endfunction
d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	624
d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	625 function! gutentags#default_stderr_cb(chan, msg) abort
d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	626 call gutentags#trace('[job stderr]: '.string(a:msg))
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	627 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	628
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	629 if has('nvim')
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	630 " Neovim job API.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	631 function! s:nvim_job_exit_wrapper(real_cb, job, exit_code, event_type) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	632 call call(a:real_cb, [a:job, a:exit_code])
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	633 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	634
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	635 function! s:nvim_job_out_wrapper(real_cb, job, lines, event_type) abort
205 485a347152fe Fix arguments to gutentags#default_io_cb() Justin M. Keyes <justinkz@gmail.com> parents: 203 diff changeset	636 call call(a:real_cb, [a:job, a:lines])
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	637 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	638
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	639 function! gutentags#build_default_job_options(module) abort
211 011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	640 " Neovim kills jobs on exit, which is what we want.
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	641 let l:job_opts = {
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	642 \'on_exit': function(
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	643 \ '<SID>nvim_job_exit_wrapper',
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	644 \ ['gutentags#'.a:module.'#on_job_exit']),
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	645 \'on_stdout': function(
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	646 \ '<SID>nvim_job_out_wrapper',
250 d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	647 \ ['gutentags#default_stdout_cb']),
211 011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	648 \'on_stderr': function(
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	649 \ '<SID>nvim_job_out_wrapper',
250 d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	650 \ ['gutentags#default_stderr_cb'])
211 011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	651 \}
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	652 return l:job_opts
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	653 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	654
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	655 function! gutentags#start_job(cmd, opts) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	656 return jobstart(a:cmd, a:opts)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	657 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	658 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	659 " Vim8 job API.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	660 function! gutentags#build_default_job_options(module) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	661 let l:job_opts = {
211 011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	662 \'exit_cb': 'gutentags#'.a:module.'#on_job_exit',
250 d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	663 \'out_cb': 'gutentags#default_stdout_cb',
d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	664 \'err_cb': 'gutentags#default_stderr_cb',
211 011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	665 \'stoponexit': 'term'
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	666 \}
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	667 return l:job_opts
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	668 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	669
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	670 function! gutentags#start_job(cmd, opts) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	671 return job_start(a:cmd, a:opts)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	672 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	673 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	674
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	675 " Returns which modules are currently generating something for the
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	676 " current buffer.
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	677 function! gutentags#inprogress()
220 60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	678 " Does this buffer have gutentags enabled?
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	679 if !exists('b:gutentags_files')
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	680 return []
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	681 endif
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	682
220 60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	683 " Find any module that has a job in progress for any of this buffer's
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	684 " tags files.
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	685 let l:modules_in_progress = []
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	686 for [module, tags_file] in items(b:gutentags_files)
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	687 let l:jobidx = gutentags#find_job_index_by_tags_file(module, tags_file)
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	688 if l:jobidx >= 0
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	689 call add(l:modules_in_progress, module)
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	690 endif
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	691 endfor
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	692 return l:modules_in_progress
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	693 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	694
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	695 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	696
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	697 " Statusline Functions {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	698
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	699 " Prints whether a tag file is being generated right now for the current
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	700 " buffer in the status line.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	701 "
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	702 " Arguments can be passed:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	703 " - args 1 and 2 are the prefix and suffix, respectively, of whatever output,
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	704 " if any, is going to be produced.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	705 " (defaults to empty strings)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	706 " - arg 3 is the text to be shown if tags are currently being generated.
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	707 " (defaults to the name(s) of the modules currently generating).
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	708
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	709 function! gutentags#statusline(...) abort
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	710 let l:modules_in_progress = gutentags#inprogress()
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	711 if empty(l:modules_in_progress)
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	712 return ''
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	713 endif
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	714
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	715 let l:prefix = ''
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	716 let l:suffix = ''
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	717 if a:0 > 0
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	718 let l:prefix = a:1
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	719 endif
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	720 if a:0 > 1
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	721 let l:suffix = a:2
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	722 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	723
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	724 if a:0 > 2
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	725 let l:genmsg = a:3
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	726 else
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	727 let l:genmsg = join(l:modules_in_progress, ',')
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	728 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	729
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	730 return l:prefix.l:genmsg.l:suffix
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	731 endfunction
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	732
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	733 " Same as `gutentags#statusline`, but the only parameter is a `Funcref` or
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	734 " function name that will get passed the list of modules currently generating
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	735 " something. This formatter function should return the string to display in
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	736 " the status line.
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	737
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	738 function! gutentags#statusline_cb(fmt_cb, ...) abort
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	739 let l:modules_in_progress = gutentags#inprogress()
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	740
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	741 if (a:0 == 0 \|\| !a:1) && empty(l:modules_in_progress)
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	742 return ''
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	743 endif
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	744
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	745 return call(a:fmt_cb, [l:modules_in_progress])
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	746 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	747
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	748 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	749

Mercurial > vim-gutentags

annotate autoload/gutentags.vim @ 277:f75a8cddf174