" Vim plug-in " Author: Peter Odding " Last Change: May 2, 2011 " URL: http://peterodding.com/code/vim/easytags/ " Requires: Exuberant Ctags (http://ctags.sf.net) " License: MIT " Version: 2.2.6 " Support for automatic update using the GLVS plug-in. " GetLatestVimScripts: 3114 1 :AutoInstall: easytags.zip " Don't source the plug-in when its already been loaded or &compatible is set. if &cp || exists('g:loaded_easytags') finish endif let s:script = expand(':p:~') " Configuration defaults and initialization. {{{1 if !exists('g:easytags_file') if xolox#misc#os#is_win() let g:easytags_file = '~\_vimtags' else let g:easytags_file = '~/.vimtags' endif endif if !exists('g:easytags_dynamic_files') let g:easytags_dynamic_files = 0 endif if !exists('g:easytags_resolve_links') let g:easytags_resolve_links = 0 endif if !exists('g:easytags_always_enabled') let g:easytags_always_enabled = 0 endif if !exists('g:easytags_on_cursorhold') let g:easytags_on_cursorhold = 1 endif if !exists('g:easytags_ignored_filetypes') let g:easytags_ignored_filetypes = '^tex$' endif if !exists('g:easytags_autorecurse') let g:easytags_autorecurse = 0 endif if !exists('g:easytags_include_members') let g:easytags_include_members = 0 endif function! s:InitEasyTags(version) " Check that the location of Exuberant Ctags has been configured or that the " correct version of the program exists in one of its default locations. if exists('g:easytags_cmd') && s:CheckCtags(g:easytags_cmd, a:version) return 1 endif " On Ubuntu Linux, Exuberant Ctags is installed as `ctags'. On Debian Linux, " Exuberant Ctags is installed as `exuberant-ctags'. On Free-BSD, Exuberant " Ctags is installed as `exctags'. for name in ['ctags', 'exuberant-ctags', 'exctags'] if s:CheckCtags(name, a:version) let g:easytags_cmd = name return 1 endif endfor endfunction function! s:CheckCtags(name, version) " Not every executable out there named `ctags' is in fact Exuberant Ctags. " This function makes sure it is because the easytags plug-in requires the " --list-languages option. if executable(a:name) let command = a:name . ' --version' try let listing = join(xolox#shell#execute(command, 1), '\n') catch /^Vim\%((\a\+)\)\=:E117/ " Ignore missing shell.vim plug-in. let listing = system(command) catch " xolox#shell#execute() converts shell errors to exceptions and since " we're checking whether one of several executables exists we don't want " to throw an error when the first one doesn't! return endtry let pattern = 'Exuberant Ctags \zs\(\d\+\(\.\d\+\)*\|Development\)' let g:easytags_ctags_version = matchstr(listing, pattern) if g:easytags_ctags_version == 'Development' return 1 else return s:VersionToNumber(g:easytags_ctags_version) >= a:version endif endif endfunction function! s:VersionToNumber(s) let values = split(a:s, '\.') if len(values) == 1 return values[0] * 10 elseif len(values) >= 2 return values[0] * 10 + values[1][0] endif endfunction if !s:InitEasyTags(55) if exists('g:easytags_suppress_ctags_warning') && g:easytags_suppress_ctags_warning finish endif if !exists('g:easytags_ctags_version') || empty(g:easytags_ctags_version) let s:msg = "%s: Plug-in not loaded because Exuberant Ctags isn't installed!" if executable('apt-get') let s:msg .= " On Ubuntu & Debian you can install Exuberant Ctags by" let s:msg .= " installing the package named `exuberant-ctags':" let s:msg .= " sudo apt-get install exuberant-ctags" else let s:msg .= " Please download & install Exuberant Ctags from http://ctags.sf.net" endif echomsg printf(s:msg, s:script) else let s:msg = "%s: Plug-in not loaded because Exuberant Ctags 5.5" let s:msg .= " or newer is required while you have version %s installed!" echomsg printf(s:msg, s:script, g:easytags_ctags_version) endif unlet s:msg finish endif function! s:RegisterTagsFile() " Parse the &tags option and get a list of all tags files *including " non-existing files* (this is why we can't just call tagfiles()). let tagfiles = xolox#misc#option#split_tags(&tags) let expanded = map(copy(tagfiles), 'resolve(expand(v:val))') " Add the filename to the &tags option when the user hasn't done so already. if index(expanded, resolve(expand(g:easytags_file))) == -1 " This is a real mess because of bugs in Vim?! :let &tags = '...' doesn't " work on UNIX and Windows, :set tags=... doesn't work on Windows. What I " mean with "doesn't work" is that tagfiles() == [] after the :let/:set " command even though the tags file exists! One easy way to confirm that " this is a bug in Vim is to type :set tags= then press followed by " . Now you entered the exact same value that the code below also did " but suddenly Vim sees the tags file and tagfiles() != [] :-S call add(tagfiles, g:easytags_file) let value = xolox#misc#option#join_tags(tagfiles) let cmd = 'set tags=' . escape(value, '\ ') if xolox#misc#os#is_win() && v:version < 703 " TODO How to clear the expression from Vim's status line? call feedkeys(":" . cmd . "|let &ro=&ro\", 'n') else execute cmd endif endif endfunction " The plug-in initializes the &tags option as soon as possible so that the " global tags file is available when using "vim -t some_tag". If &tags is " reset, we'll try again on the "VimEnter" automatic command event (below). call s:RegisterTagsFile() " The :UpdateTags and :HighlightTags commands. {{{1 command! -bar -bang -nargs=* -complete=file UpdateTags call xolox#easytags#update(0, == '!', []) command! -bar HighlightTags call xolox#easytags#highlight() " Automatic commands. {{{1 augroup PluginEasyTags autocmd! " This is the alternative way of registering the global tags file using " the automatic command event "VimEnter". Apparently this makes the " plug-in behave better when used together with tplugin? autocmd VimEnter * call s:RegisterTagsFile() if g:easytags_always_enabled " TODO Also on FocusGained because tags files might be updated externally? autocmd BufReadPost,BufWritePost * call xolox#easytags#autoload() endif if g:easytags_on_cursorhold autocmd CursorHold,CursorHoldI * call xolox#easytags#autoload() autocmd BufReadPost * unlet! b:easytags_last_highlighted endif augroup END " }}}1 " Make sure the plug-in is only loaded once. let g:loaded_easytags = 1 " vim: ts=2 sw=2 et