vim-gutentags: autoload/gutentags.vim annotate

annotate autoload/gutentags.vim @ 135:4c9e2de7d46a

Rename ctags.options to ctags_recursive.options According to https://github.com/ludovicchabant/vim-gutentags/issues/33, ctags' --recursive option was moved to an option file to allow it to be overridden by user options files. This change makes it clear what the purpose of this options file is.

author	Stephen Kent <smkent@smkent.net>
date	Fri, 22 Jul 2016 19:25:01 -0700
parents	04288637e595
children	286e5b3095d0

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
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	5 " Throw an exception message.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	6 function! gutentags#throw(message)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	7 let v:errmsg = "gutentags: " . a:message
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	8 throw v:errmsg
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	9 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	10
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	11 " 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	12 function! gutentags#trace(message, ...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	13 if g:gutentags_trace \|\| (a:0 && a:1)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	14 let l:message = "gutentags: " . a:message
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	15 echom l:message
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	16 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	17 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	18
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	19 " 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	20 function! gutentags#stripslash(path)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	21 return fnamemodify(a:path, ':s?[/\\]$??')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	22 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	23
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	24 " Normalizes the slashes in a path.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	25 function! gutentags#normalizepath(path)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	26 if exists('+shellslash') && &shellslash
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	27 return substitute(a:path, '\v/', '\\', 'g')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	28 elseif has('win32')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	29 return substitute(a:path, '\v/', '\\', 'g')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	30 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	31 return a:path
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	32 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	33 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	34
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	35 " 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	36 function! gutentags#shellslash(path)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	37 if exists('+shellslash') && !&shellslash
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	38 return substitute(a:path, '\v\\', '/', 'g')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	39 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	40 return a:path
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	41 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	42 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	43
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	44 " 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	45 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	46 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	47 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	48
75 d12543f11eb9 Move the default `-R` option to an overridable "global" options file. Ludovic Chabant <ludovic@chabant.com> parents: 70 diff changeset	49 " 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	50 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	51 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	52 endfunction
d12543f11eb9 Move the default `-R` option to an overridable "global" options file. Ludovic Chabant <ludovic@chabant.com> parents: 70 diff changeset	53
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	54 " }}}
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 " Gutentags Setup {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	57
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	58 let s:known_files = []
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	59 let s:known_projects = {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	60
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	61 function! s:cache_project_root(path) abort
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	62 let l:result = {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	63
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	64 for proj_info in g:gutentags_project_info
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	65 let l:filematch = get(proj_info, 'file', '')
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	66 if l:filematch != '' && filereadable(a:path . '/'. l:filematch)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	67 let l:result = copy(proj_info)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	68 break
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	69 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	70
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	71 let l:globmatch = get(proj_info, 'glob', '')
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	72 if l:globmatch != '' && glob(a:path . '/' . l:globmatch) != ''
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	73 let l:result = copy(proj_info)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	74 break
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	75 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	76 endfor
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	77
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	78 let s:known_projects[a:path] = l:result
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	79 endfunction
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	80
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	81 " 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	82 " file path.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	83 function! gutentags#get_project_root(path) abort
132 a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 131 diff changeset	84 if g:gutentags_project_root_finder
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 131 diff changeset	85 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	86 endif
a6ef1c860d07 Add support for custom root finders like `vim-projectroot`. Ludovic Chabant <ludovic@chabant.com> parents: 131 diff changeset	87
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	88 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	89 let l:previous_path = ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	90 let l:markers = g:gutentags_project_root[:]
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	91 if exists('g:ctrlp_root_markers')
134 04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	92 for crm in g:ctrlp_root_markers
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	93 if index(l:markers, crm) < 0
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	94 call add(l:markers, crm)
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	95 endif
04288637e595 Don't use `uniq`. Ludovic Chabant <ludovic@chabant.com> parents: 132 diff changeset	96 endfor
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	97 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	98 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	99 for root in l:markers
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	100 if getftype(l:path . '/' . root) != ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	101 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	102 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	103 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	104 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	105 \"' 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	106 \" 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	107 \"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	108 \1)
b9965d1288c3 Don't enable Gutentags for markers at the root of the file-system. Ludovic Chabant <ludovic@chabant.com> parents: 89 diff changeset	109 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	110 endif
118 2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	111 for ign in g:gutentags_exclude_project_root
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	112 if l:proj_dir == ign
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	113 call gutentags#trace(
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	114 \"Ignoring project root '" . l:proj_dir .
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	115 \"' because it is in the list of ignored" .
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	116 \" projects.")
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	117 call gutentags#throw("Ignore project: " . l:proj_dir)
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	118 endif
2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	119 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	120 return l:proj_dir
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	121 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	122 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	123 let l:previous_path = l:path
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	124 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	125 endwhile
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	126 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	127 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	128
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	129 " Get info on the project we're inside of.
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	130 function! gutentags#get_project_info(path) abort
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	131 return get(s:known_projects, a:path, {})
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	132 endfunction
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	133
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	134 " Generate a path for a given filename in the cache directory.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	135 function! gutentags#get_cachefile(root_dir, filename) abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	136 let l:tag_path = gutentags#stripslash(a:root_dir) . '/' . a:filename
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	137 if g:gutentags_cache_dir != ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	138 " Put the tag file in the cache dir instead of inside the
121 8310e4602de9 minor: fix typos / unbalanced quotes Daniel Hahler <git@thequod.de> parents: 102 diff changeset	139 " project root.
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	140 let l:tag_path = g:gutentags_cache_dir . '/' .
98 d645125192aa Fix more problems with paths and spaces in them. Ludovic Chabant <ludovic@chabant.com> parents: 90 diff changeset	141 \tr(l:tag_path, '\/: ', '---_')
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	142 let l:tag_path = substitute(l:tag_path, '/\-', '/', '')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	143 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	144 let l:tag_path = gutentags#normalizepath(l:tag_path)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	145 return l:tag_path
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	146 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	147
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	148 " Setup gutentags for the current buffer.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	149 function! gutentags#setup_gutentags() abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	150 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	151 " This buffer already has gutentags support.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	152 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	153 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	154
63 0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	155 " 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	156 " (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	157 " other such things)
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	158 if &buftype != ''
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	159 return
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	160 endif
0f5b4a36c920 Don't try to setup Gutentags for non normal buffers. Ludovic Chabant <ludovic@chabant.com> parents: 59 diff changeset	161
88 073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	162 " Let the user specify custom ways to disable Gutentags.
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	163 if g:gutentags_enabled_user_func != '' &&
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	164 \!call(g:gutentags_enabled_user_func, [expand('%:p')])
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	165 call gutentags#trace("Ignoring '" . bufname('%') . "' because of " .
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	166 \"custom user function.")
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	167 return
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	168 endif
073e63cc0456 Add `gutentags_enabled_user_func` callback. Ludovic Chabant <ludovic@chabant.com> parents: 87 diff changeset	169
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	170 " 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	171 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	172 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	173 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	174 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	175 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	176 endif
123 76a4822aab76 Use existing b:gutentags_root Daniel Hahler <git@thequod.de> parents: 102 diff changeset	177 if !exists('b:gutentags_root')
76a4822aab76 Use existing b:gutentags_root Daniel Hahler <git@thequod.de> parents: 102 diff changeset	178 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	179 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	180 if filereadable(b:gutentags_root . '/.notags')
121 8310e4602de9 minor: fix typos / unbalanced quotes Daniel Hahler <git@thequod.de> parents: 102 diff changeset	181 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	182 return
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	183 endif
7b419abf7fba Add ability to disable Gutentags if a `.notags` file is at the root. Ludovic Chabant <ludovic@chabant.com> parents: 46 diff changeset	184
89 8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	185 if !has_key(s:known_projects, b:gutentags_root)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	186 call s:cache_project_root(b:gutentags_root)
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	187 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	188 if g:gutentags_trace
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	189 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	190 if l:projnfo != {}
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	191 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	192 else
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	193 call gutentags#trace("No specific project type.")
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	194 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	195 endif
8bf96f9f649c Add support for project types. Ludovic Chabant <ludovic@chabant.com> parents: 88 diff changeset	196
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	197 let b:gutentags_files = {}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	198 for module in g:gutentags_modules
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	199 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	200 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	201 catch /^gutentags\:/
118 2838af9ff980 Add `g:gutentags_exclude_project_root`. Ludovic Chabant <ludovic@chabant.com> parents: 102 diff changeset	202 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	203 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	204 endtry
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	205
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	206 " 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	207 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	208
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	209 " 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	210 " 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	211 " 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	212 " 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	213 " errors.
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	214 let l:bn = bufnr('%')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	215 execute 'augroup gutentags_buffer_' . l:bn
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	216 execute ' autocmd!'
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	217 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	218 execute 'augroup end'
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	219
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	220 " Miscellaneous commands.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	221 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	222
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	223 " 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	224 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	225 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	226 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	227 if l:found < 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	228 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	229
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	230 " 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	231 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	232 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	233 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	234 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	235 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	236 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	237 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	238 endif
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	239 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	240 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	241 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	242 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	243
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	244 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	245
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	246 " Tags File Management {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	247
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	248 " 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	249 let s:update_queue = {}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	250 let s:maybe_in_progress = {}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	251 for module in g:gutentags_modules
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	252 let s:update_queue[module] = []
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	253 let s:maybe_in_progress[module] = {}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	254 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	255
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	256 " Make a given file known as being currently generated or updated.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	257 function! gutentags#add_progress(module, file) abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	258 let s:maybe_in_progress[a:module][a:file] = localtime()
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	259 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	260
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	261 " Get how to execute an external command depending on debug settings.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	262 function! gutentags#get_execute_cmd() abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	263 if has('win32')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	264 let l:cmd = '!start '
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	265 if g:gutentags_background_update
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	266 let l:cmd .= '/b '
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	267 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	268 return l:cmd
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	269 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	270 return '!'
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	271 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	272 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	273
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	274 " Get the suffix for how to execute an external command.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	275 function! gutentags#get_execute_cmd_suffix() abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	276 if has('win32')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	277 return ''
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	278 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	279 return ' &'
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	280 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	281 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	282
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	283 " (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	284 function! s:manual_update_tags(bang) abort
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	285 let l:bn = bufnr('%')
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	286 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	287 call s:update_tags(l:bn, module, a:bang, 0)
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	288 endfor
101 32e3d047e54e add user autocmds for after tags updated David O'Trakoun <me@davidosomething.com> parents: 90 diff changeset	289 silent doautocmd User GutentagsUpdated
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	290 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	291
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	292 " (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	293 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	294 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	295 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	296 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	297 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	298 endif
101 32e3d047e54e add user autocmds for after tags updated David O'Trakoun <me@davidosomething.com> parents: 90 diff changeset	299 silent doautocmd User GutentagsUpdated
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	300 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	301
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	302 " 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	303 " write_mode:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	304 " 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	305 " 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	306 "
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	307 " queue_mode:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	308 " 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	309 " 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	310 " 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	311 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	312 " Figure out where to save.
130 b6ec4caa22ff Remember the buffer number in the `BufWritePost` callback. Ludovic Chabant <ludovic@chabant.com> parents: 124 diff changeset	313 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	314 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	315 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	316
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	317 " Check that there's not already an update in progress.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	318 let l:lock_file = l:tags_file . '.lock'
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	319 if filereadable(l:lock_file)
83 e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	320 if a:queue_mode == 2
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	321 let l:idx = index(s:update_queue[a:module], l:tags_file)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	322 if l:idx < 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	323 call add(s:update_queue[a:module], l:tags_file)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	324 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	325 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	326 \"' 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	327 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	328 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	329 \"' 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	330 elseif a:queue_mode == 0
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	331 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	332 \"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	333 else
e7e392be4141 Only show message about an existing update job for user-initiated actions. Ludovic Chabant <ludovic@chabant.com> parents: 82 diff changeset	334 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	335 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	336 return
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	337 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	338
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	339 " 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	340 " 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	341 " doing an incremental update.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	342 let l:prev_cwd = getcwd()
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	343 execute "chdir " . fnameescape(l:proj_dir)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	344 try
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	345 call call("gutentags#".a:module."#generate",
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	346 \[l:proj_dir, l:tags_file, a:write_mode])
84 96bfe5c37f37 Error and abort if we'll be overwriting a non-ctags file. Ludovic Chabant <ludovic@chabant.com> parents: 83 diff changeset	347 catch /^gutentags\:/
96bfe5c37f37 Error and abort if we'll be overwriting a non-ctags file. Ludovic Chabant <ludovic@chabant.com> parents: 83 diff changeset	348 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	349 echom v:exception
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	350 finally
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	351 " Restore the current directory...
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	352 execute "chdir " . fnameescape(l:prev_cwd)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	353 endtry
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	354 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	355
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	356 " }}}
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 " Utility Functions {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	359
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	360 function! gutentags#rescan(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	361 if exists('b:gutentags_files')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	362 unlet b:gutentags_files
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	363 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	364 if a:0 && a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	365 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	366 let l:gutentags_trace = 1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	367 endif
82 a837021a2388 Fix broken call debug function. Ludovic Chabant <ludovic@chabant.com> parents: 80 diff changeset	368 call gutentags#setup_gutentags()
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	369 if a:0 && a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	370 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	371 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	372 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	373
46 c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 41 diff changeset	374 function! gutentags#delete_lock_files() abort
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 41 diff changeset	375 if exists('b:gutentags_files')
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 41 diff changeset	376 for tagfile in values(b:gutentags_files)
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 41 diff changeset	377 silent call delete(tagfile.'.lock')
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 41 diff changeset	378 endfor
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 41 diff changeset	379 endif
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 41 diff changeset	380 endfunction
c0f56e4d52bd Make a bunch of advanced commands opt-in only. Ludovic Chabant <ludovic@chabant.com> parents: 41 diff changeset	381
41 99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	382 function! gutentags#toggletrace(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	383 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	384 if a:0 > 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	385 let g:gutentags_trace = a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	386 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	387 if g:gutentags_trace
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	388 echom "gutentags: Tracing is enabled."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	389 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	390 echom "gutentags: Tracing is disabled."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	391 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	392 echom ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	393 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	394
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	395 function! gutentags#fake(...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	396 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	397 if a:0 > 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	398 let g:gutentags_fake = a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	399 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	400 if g:gutentags_fake
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	401 echom "gutentags: Now faking gutentags."
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	402 else
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	403 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	404 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	405 echom ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	406 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	407
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	408 function! gutentags#inprogress()
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	409 echom "gutentags: generations in progress:"
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	410 for mip in keys(s:maybe_in_progress)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	411 echom mip
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	412 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	413 echom ""
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	414 endfunction
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	415
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	416 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	417
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	418 " Statusline Functions {{{
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	419
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	420 " 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	421 " buffer in the status line.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	422 "
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	423 " Arguments can be passed:
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	424 " - 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	425 " 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	426 " (defaults to empty strings)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	427 " - arg 3 is the text to be shown if tags are currently being generated.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	428 " (defaults to 'TAGS')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	429
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	430 function! gutentags#statusline(...) abort
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	431 if !exists('b:gutentags_files')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	432 " This buffer doesn't have gutentags.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	433 return ''
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	434 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	435
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	436 " Figure out what the user is customizing.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	437 let l:gen_msg = 'TAGS'
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	438 if a:0 > 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	439 let l:gen_msg = a:1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	440 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	441
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	442 " To make this function as fast as possible, we first check whether the
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	443 " current buffer's tags file is 'maybe' being generated. This provides a
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	444 " nice and quick bail out for 99.9% of cases before we need to this the
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	445 " file-system to check the lock file.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	446 let l:modules_in_progress = []
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	447 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	448 let l:abs_tag_file = fnamemodify(b:gutentags_files[module], ':p')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	449 let l:progress_queue = s:maybe_in_progress[module]
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	450 let l:timestamp = get(l:progress_queue, l:abs_tag_file)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	451 if l:timestamp == 0
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	452 return ''
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	453 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	454 " It's maybe generating! Check if the lock file is still there... but
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	455 " don't do it too soon after the script was originally launched, because
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	456 " there can be a race condition where we get here just before the script
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	457 " had a chance to write the lock file.
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	458 if (localtime() - l:timestamp) > 1 &&
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	459 \!filereadable(l:abs_tag_file . '.lock')
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	460 call remove(l:progress_queue, l:abs_tag_file)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	461 return ''
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	462 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	463 call add(l:modules_in_progress, module)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	464 endfor
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	465
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	466 " It's still there! So probably `ctags` is still running...
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	467 " (although there's a chance it crashed, or the script had a problem, and
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	468 " the lock file has been left behind... we could try and run some
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	469 " additional checks here to see if it's legitimately running, and
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	470 " otherwise delete the lock file... maybe in the future...)
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	471 if len(g:gutentags_modules) > 1
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	472 let l:gen_msg .= '['.join(l:modules_in_progress, ',').']'
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	473 endif
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	474 return l:gen_msg
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 " }}}
99328cb71e75 Refactor Gutentags so functionality can be implemented in "modules". Ludovic Chabant <ludovic@chabant.com> parents: diff changeset	478

Mercurial > vim-gutentags

annotate autoload/gutentags.vim @ 135:4c9e2de7d46a