vim-gutentags: autoload/gutentags.vim annotate

annotate autoload/gutentags.vim @ 254:52be4cf89810

Don't complain when the job gets killed when Vim exits. This happens on Neovim, where the jobs seem to get killed before Vim exits, and so Gutentags has enough time to print a warning.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sat, 26 Oct 2019 00:40:18 -0700
parents	e61d20280c6c
children	74a71a5499c9

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
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	9 let chdir = haslocaldir() ? 'lcd' : 'cd'
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	10 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	11 execute chdir 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
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	106 return join(a:cmd, ' ')
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	107 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	108 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	109 function! gutentags#make_args(cmd) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	110 let l:outcmd = []
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	111 for cmdarg in a:cmd
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	112 " 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	113 " 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	114 let l:arglen = strlen(cmdarg)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	115 if (cmdarg[0] == '"' && cmdarg[l:arglen - 1] == '"') \|\|
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	116 \(cmdarg[0] == "'" && cmdarg[l:arglen - 1] == "'")
251 e61d20280c6c Fix some more spaces-in-paths issues. Ludovic Chabant <ludovic@chabant.com> parents: 250 diff changeset	117 " 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	118 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	119 call add(l:outcmd, l:escapedarg)
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	120 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	121 call add(l:outcmd, cmdarg)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	122 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	123 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	124 return l:outcmd
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	125 endfunction
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
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	128 " 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	129 if has('win32') \|\| has('win64')
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	130 function! gutentags#is_path_rooted(path) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	131 return len(a:path) >= 2 && (
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	132 \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	133 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	134 else
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	135 function! gutentags#is_path_rooted(path) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	136 return !empty(a:path) && a:path[0] == '/'
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 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	139
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	140 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	141
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142 " Gutentags Setup {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	143
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144 let s:known_files = []
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	145 let s:known_projects = {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	146
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	147 function! s:cache_project_root(path) abort
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	148 let l:result = {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	149
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	150 for proj_info in g:gutentags_project_info
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	151 let l:filematch = get(proj_info, 'file', '')
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	152 if l:filematch != '' && filereadable(a:path . '/'. l:filematch)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	153 let l:result = copy(proj_info)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	154 break
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	155 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	156
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	157 let l:globmatch = get(proj_info, 'glob', '')
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	158 if l:globmatch != '' && glob(a:path . '/' . l:globmatch) != ''
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	159 let l:result = copy(proj_info)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	160 break
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	161 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	162 endfor
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	163
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	164 let s:known_projects[a:path] = l:result
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	165 endfunction
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	166
136 286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	167 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	168 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	169 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	170 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	171 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	172 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	173 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	174 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	175 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	176 endif
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	177 endfor
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	178 endif
157 6b00f4383708 Support project root markers that are wildcard patterns. Ludovic Chabant <ludovic@chabant.com> parents: 148 diff changeset	179 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	180 endif
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	181 return ""
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	182 endfunction
286e5b3095d0 Allow restricting tag generation to files listed by custom commands Stephen Kent <smkent@smkent.net> parents: 134 diff changeset	183
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	184 " 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	185 " file path.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	186 function! gutentags#get_project_root(path) abort
146 3459a2522a3b Enable Project Root Finder thecontinium <thecontinium@outlook.com> parents: 136 diff changeset	187 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	188 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	189 endif
244 d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	190 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	191 endfunction
132 a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 131 diff changeset	192
244 d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	193 " 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	194 " 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	195 " behaviour.
d3f9a92399d1 Separate the default project marker finder into a function. Ludovic Chabant <ludovic@chabant.com> parents: 243 diff changeset	196 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	197 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	198 let l:previous_path = ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	199 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	200 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	201 for crm in g:ctrlp_root_markers
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	202 if index(l:markers, crm) < 0
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	203 call add(l:markers, crm)
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	204 endif
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	205 endfor
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	206 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	207 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	208 for root in l:markers
174 721cba3cd20d Don't apply `wildignore` when looking for markers Rafael Bodill <justrafi@gmail.com> parents: 173 diff changeset	209 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	210 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	211 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	212 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	213 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	214 \"' 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	215 \" 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	216 \"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	217 \1)
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	218 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	219 endif
118 2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	220 for ign in g:gutentags_exclude_project_root
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	221 if l:proj_dir == ign
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	222 call gutentags#trace(
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	223 \"Ignoring project root '" . l:proj_dir .
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	224 \"' because it is in the list of ignored" .
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	225 \" projects.")
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	226 call gutentags#throw("Ignore project: " . l:proj_dir)
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	227 endif
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	228 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	229 return l:proj_dir
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	230 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	231 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	232 let l:previous_path = l:path
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	233 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	234 endwhile
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	235 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	236 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	237
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	238 " Get info on the project we're inside of.
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	239 function! gutentags#get_project_info(path) abort
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	240 return get(s:known_projects, a:path, {})
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	241 endfunction
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	242
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	243 " Setup gutentags for the current buffer.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	244 function! gutentags#setup_gutentags() abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	245 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	246 " This buffer already has gutentags support.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	247 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	248 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	249
63 0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	250 " 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	251 " (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	252 " 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	253 " 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	254 " after starting Vim.
182 2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 180 diff changeset	255 if &buftype != '' \|\|
2489b4b54d5c Add `g:gutentags_generate_on_empty_buffer` setting. Ludovic Chabant <ludovic@chabant.com> parents: 180 diff changeset	256 \(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	257 return
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	258 endif
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	259
229 34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	260 " 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	261 " cause problems.
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	262 if index(g:gutentags_exclude_filetypes, &filetype) >= 0
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	263 return
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	264 endif
34bee0477b51 Add `g:gutentags_exclude_filetypes` setting. Ludovic Chabant <ludovic@chabant.com> parents: 227 diff changeset	265
88 073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	266 " 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	267 if g:gutentags_init_user_func != '' &&
7bc4df0225d1 Add support for specifying buffer-specific tagfiles. Ludovic Chabant <ludovic@chabant.com> parents: 136 diff changeset	268 \!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	269 call gutentags#trace("Ignoring '" . bufname('%') . "' because of " .
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	270 \"custom user function.")
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	271 return
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	272 endif
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	273
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	274 " 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	275 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	276 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	277 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	278 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	279 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	280 endif
123 76a4822aab76 Use existing b:gutentags_root Daniel Hahler <git@thequod.de> parents: 102 diff changeset	281 if !exists('b:gutentags_root')
76a4822aab76 Use existing b:gutentags_root Daniel Hahler <git@thequod.de> parents: 102 diff changeset	282 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	283 endif
236 a77c3eb4ce34 Handle custom project root finder functions returning no value. Ludovic Chabant <ludovic@chabant.com> parents: 229 diff changeset	284 if !len(b:gutentags_root)
a77c3eb4ce34 Handle custom project root finder functions returning no value. Ludovic Chabant <ludovic@chabant.com> parents: 229 diff changeset	285 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	286 return
a77c3eb4ce34 Handle custom project root finder functions returning no value. Ludovic Chabant <ludovic@chabant.com> parents: 229 diff changeset	287 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	288 if filereadable(b:gutentags_root . '/.notags')
121 8310e4602de9 minor: fix typos / unbalanced quotes Daniel Hahler <git@thequod.de> parents: 102 diff changeset	289 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	290 return
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	291 endif
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	292
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	293 if !has_key(s:known_projects, b:gutentags_root)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	294 call s:cache_project_root(b:gutentags_root)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	295 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	296 if g:gutentags_trace
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	297 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	298 if l:projnfo != {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	299 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	300 else
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	301 call gutentags#trace("No specific project type.")
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	302 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	303 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	304
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	305 let b:gutentags_files = {}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	306 for module in g:gutentags_modules
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	307 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	308 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	309 catch /^gutentags\:/
118 2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	310 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	311 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	312 endtry
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	313
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	314 " 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	315 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	316
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	317 " 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	318 " 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	319 " 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	320 " 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	321 " errors.
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	322 let l:bn = bufnr('%')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	323 execute 'augroup gutentags_buffer_' . l:bn
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	324 execute ' autocmd!'
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	325 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	326 execute 'augroup end'
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	327
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	328 " Miscellaneous commands.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	329 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	330
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	331 " 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	332 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	333 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	334 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	335 if l:found < 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	336 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	337
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	338 " 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	339 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	340 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	341 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	342 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	343 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	344 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	345 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	346 endif
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	347 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	348 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	349 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	350 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	351
254 52be4cf89810 Don't complain when the job gets killed when Vim exits. Ludovic Chabant <ludovic@chabant.com> parents: 251 diff changeset	352 " 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	353 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	354 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	355 endfunction
52be4cf89810 Don't complain when the job gets killed when Vim exits. Ludovic Chabant <ludovic@chabant.com> parents: 251 diff changeset	356
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	357 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	358
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	359 " Job Management {{{
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	360
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	361 " 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	362 let s:update_queue = {}
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	363 let s:update_in_progress = {}
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	364 for module in g:gutentags_modules
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	365 let s:update_queue[module] = []
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	366 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	367 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	368
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	369 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	370 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	371 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	372
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	373 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	374 let l:idx = -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	375 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	376 let l:idx += 1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	377 if upd_info[0] == a:tags_file
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	378 return l:idx
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	379 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	380 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	381 return -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	382 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	383
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	384 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	385 let l:idx = -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	386 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	387 let l:idx += 1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	388 if upd_info[1] == a:data
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	389 return l:idx
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	390 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	391 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	392 return -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	393 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	394
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	395 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	396 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	397 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	398
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	399 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	400 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	401 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	402
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	403 function! gutentags#remove_job(module, job_idx) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	404 let l:tags_file = s:update_in_progress[a:module][a:job_idx][0]
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	405 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	406
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	407 " Run the user callback for finished jobs.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	408 silent doautocmd User GutentagsUpdated
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	409
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	410 " 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	411 let l:qu_idx = -1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	412 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	413 let l:qu_idx += 1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	414 if qu_info[0] == l:tags_file
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	415 break
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	416 endif
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	417 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	418 if l:qu_idx >= 0
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	419 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	420 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	421
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	422 if bufexists(l:qu_info[1])
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	423 call gutentags#trace("Finished ".a:module." job, ".
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	424 \"running queued update for '".l:tags_file."'.")
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	425 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	426 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	427 call gutentags#trace("Finished ".a:module." job, ".
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	428 \"but skipping queued update for '".l:tags_file."' ".
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	429 \"because originating buffer doesn't exist anymore.")
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	430 endif
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	431 else
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	432 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	433 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	434 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	435
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	436 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	437 let l:idx = gutentags#find_job_index_by_data(a:module, a:data)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	438 call 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	439 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	440
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	441 " }}}
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	442
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	443 " Tags File Management {{{
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	444
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	445 " (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	446 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	447 let l:restore_prev_trace = 0
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	448 let l:prev_trace = g:gutentags_trace
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	449 if &verbose > 0
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	450 let g:gutentags_trace = 1
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	451 let l:restore_prev_trace = 1
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	452 endif
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	453
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	454 try
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	455 let l:bn = bufnr('%')
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	456 for module in g:gutentags_modules
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	457 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	458 endfor
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	459 silent doautocmd User GutentagsUpdating
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	460 finally
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	461 if l:restore_prev_trace
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	462 let g:gutentags_trace = l:prev_trace
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	463 endif
93c492ed3d62 Add support for using `:verbose` with `:GutentagsUpdate`. Ludovic Chabant <ludovic@chabant.com> parents: 220 diff changeset	464 endtry
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	465 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	466
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	467 " (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	468 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	469 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	470 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	471 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	472 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	473 endif
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	474 silent doautocmd User GutentagsUpdating
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	475 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	476
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	477 " 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	478 " write_mode:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	479 " 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	480 " 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	481 "
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	482 " queue_mode:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	483 " 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	484 " 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	485 " 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	486 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	487 " Figure out where to save.
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	488 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	489 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	490 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	491
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	492 " 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	493 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	494 \a:module, l:tags_file)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	495 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	496 if a:queue_mode == 2
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	497 let l:needs_queuing = 1
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	498 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	499 if qu_info[0] == l:tags_file
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	500 let l:needs_queuing = 0
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	501 break
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	502 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	503 endfor
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	504 if l:needs_queuing
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	505 call add(s:update_queue[a:module],
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	506 \[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	507 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	508 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	509 \"' 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	510 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	511 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	512 \"' 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	513 elseif a:queue_mode == 0
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	514 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	515 \"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	516 else
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	517 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	518 endif
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	519
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	520 " 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	521 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	522 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	523
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	524 " 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	525 " 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	526 " doing an incremental update.
179 411f3fa915f5 Back to getcwd() Henry Kupty <hkupty@gmail.com> parents: 178 diff changeset	527 let l:prev_cwd = getcwd()
168 e59321cbaff7 Use scope-local functions Henry Kupty <hkupty@gmail.com> parents: 136 diff changeset	528 call gutentags#chdir(fnameescape(l:proj_dir))
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	529 try
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	530 call call("gutentags#".a:module."#generate",
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	531 \[l:proj_dir, l:tags_file,
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	532 \ {
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	533 \ 'write_mode': a:write_mode,
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	534 \ }])
84 96bfe5c37f37 Error and abort if we'll be overwriting a non-ctags file. Ludovic Chabant <ludovic@chabant.com> parents: 83 diff changeset	535 catch /^gutentags\:/
96bfe5c37f37 Error and abort if we'll be overwriting a non-ctags file. Ludovic Chabant <ludovic@chabant.com> parents: 83 diff changeset	536 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	537 echom v:exception
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	538 finally
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	539 " Restore the current directory...
168 e59321cbaff7 Use scope-local functions Henry Kupty <hkupty@gmail.com> parents: 136 diff changeset	540 call gutentags#chdir(fnameescape(l:prev_cwd))
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	541 endtry
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	542 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	543
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	544 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	545
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	546 " Utility Functions {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	547
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	548 function! gutentags#rescan(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	549 if exists('b:gutentags_files')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	550 unlet b:gutentags_files
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	551 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	552 if a:0 && a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	553 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	554 let l:gutentags_trace = 1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	555 endif
82 a837021a2388 Fix broken call debug function. Ludovic Chabant <ludovic@chabant.com> parents: 80 diff changeset	556 call gutentags#setup_gutentags()
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	557 if a:0 && a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	558 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	559 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	560 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	561
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	562 function! gutentags#toggletrace(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	563 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	564 if a:0 > 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	565 let g:gutentags_trace = a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	566 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	567 if g:gutentags_trace
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	568 echom "gutentags: Tracing is enabled."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	569 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	570 echom "gutentags: Tracing is disabled."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	571 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	572 echom ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	573 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	574
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	575 function! gutentags#fake(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	576 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	577 if a:0 > 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	578 let g:gutentags_fake = a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	579 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	580 if g:gutentags_fake
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	581 echom "gutentags: Now faking gutentags."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	582 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	583 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	584 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	585 echom ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	586 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	587
250 d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	588 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	589 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	590 endfunction
d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	591
d264db0126c2 Print jobs' stdout and stderr separately to help troubleshooting. Ludovic Chabant <ludovic@chabant.com> parents: 246 diff changeset	592 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	593 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	594 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	595
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	596 if has('nvim')
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	597 " Neovim job API.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	598 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	599 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	600 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	601
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	602 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	603 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	604 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	605
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	606 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	607 " 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	608 let l:job_opts = {
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	609 \'on_exit': function(
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	610 \ '<SID>nvim_job_exit_wrapper',
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	611 \ ['gutentags#'.a:module.'#on_job_exit']),
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	612 \'on_stdout': function(
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	613 \ '<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	614 \ ['gutentags#default_stdout_cb']),
211 011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	615 \'on_stderr': function(
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	616 \ '<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	617 \ ['gutentags#default_stderr_cb'])
211 011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	618 \}
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	619 return l:job_opts
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	620 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	621
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	622 function! gutentags#start_job(cmd, opts) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	623 return jobstart(a:cmd, a:opts)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	624 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	625 else
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	626 " Vim8 job API.
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	627 function! gutentags#build_default_job_options(module) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	628 let l:job_opts = {
211 011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	629 \'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	630 \'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	631 \'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	632 \'stoponexit': 'term'
011d855724bf Make Vim8 terminate the background job on exit. Ludovic Chabant <ludovic@chabant.com> parents: 209 diff changeset	633 \}
202 b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	634 return l:job_opts
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	635 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	636
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	637 function! gutentags#start_job(cmd, opts) abort
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	638 return job_start(a:cmd, a:opts)
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	639 endfunction
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	640 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	641
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	642 " Returns which modules are currently generating something for the
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	643 " current buffer.
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	644 function! gutentags#inprogress()
220 60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	645 " Does this buffer have gutentags enabled?
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	646 if !exists('b:gutentags_files')
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	647 return []
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	648 endif
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	649
220 60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	650 " 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	651 " tags files.
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	652 let l:modules_in_progress = []
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	653 for [module, tags_file] in items(b:gutentags_files)
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	654 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	655 if l:jobidx >= 0
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	656 call add(l:modules_in_progress, module)
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	657 endif
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	658 endfor
60229a0ea17d Fix indenting. Ludovic Chabant <ludovic@chabant.com> parents: 211 diff changeset	659 return l:modules_in_progress
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	660 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	661
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	662 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	663
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	664 " Statusline Functions {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	665
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	666 " 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	667 " buffer in the status line.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	668 "
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	669 " Arguments can be passed:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	670 " - 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	671 " 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	672 " (defaults to empty strings)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	673 " - 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	674 " (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	675
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	676 function! gutentags#statusline(...) abort
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	677 let l:modules_in_progress = gutentags#inprogress()
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	678 if empty(l:modules_in_progress)
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	679 return ''
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	680 endif
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	681
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	682 let l:prefix = ''
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	683 let l:suffix = ''
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	684 if a:0 > 0
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	685 let l:prefix = a:1
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	686 endif
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	687 if a:0 > 1
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	688 let l:suffix = a:2
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	689 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	690
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	691 if a:0 > 2
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	692 let l:genmsg = a:3
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	693 else
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	694 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	695 endif
b50b6d0f82dd Refactor for Vim8/Neovim job support. Ludovic Chabant <ludovic@chabant.com> parents: 199 diff changeset	696
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	697 return l:prefix.l:genmsg.l:suffix
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	698 endfunction
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	699
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	700 " 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	701 " 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	702 " something. This formatter function should return the string to display in
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	703 " the status line.
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	704
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	705 function! gutentags#statusline_cb(fmt_cb, ...) abort
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	706 let l:modules_in_progress = gutentags#inprogress()
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	707
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	708 if (a:0 == 0 \|\| !a:1) && empty(l:modules_in_progress)
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	709 return ''
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	710 endif
207 20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	711
20bfab5b054f Status-line improvements. Ludovic Chabant <ludovic@chabant.com> parents: 205 diff changeset	712 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	713 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	714
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	715 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	716

Mercurial > vim-gutentags

annotate autoload/gutentags.vim @ 254:52be4cf89810