ylib/tagbar
1
0
Fork 0
mirror of https://github.com/preservim/tagbar.git synced 2024-11-30 13:36:01 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
c876263e47
tagbar/autoload/tagbar.vim

3507 lines
109 KiB
VimL
Raw Normal View History

Move most of script to autoload
2011-06-29 04:59:49 +08:00
" ============================================================================
" File: tagbar.vim
" Description: List the current file's tags in a sidebar, ordered by class etc
" Author: Jan Larres <jan@majutsushi.net>
" Licence: Vim licence
" Website: http://majutsushi.github.com/tagbar/
Version 2.7
2017-01-09 12:26:17 +08:00
" Version: 2.7
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Note: This plugin was heavily inspired by the 'Taglist' plugin by
" Yegappan Lakshmanan and uses a small amount of code from it.
"
" Original taglist copyright notice:
" Permission is hereby granted to use and distribute this code,
" with or without modifications, provided that this copyright
" notice is copied with it. Like anything else that's free,
" taglist.vim is provided *as is* and comes with no warranty of
" any kind, either expressed or implied. In no event will the
" copyright holder be liable for any damamges resulting from the
" use of this software.
" ============================================================================
Move some tests to autoload
2011-07-15 13:34:47 +08:00
scriptencoding utf-8
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Initialization {{{1
Explicitly load plugin file if necessary
2012-06-19 12:49:55 +08:00
" If another plugin calls an autoloaded Tagbar function on startup before the
" plugin/tagbar.vim file got loaded, load it explicitly
if exists(':Tagbar') == 0
runtime plugin/tagbar.vim
endif
Handle wrong rtp more gracefully If the runtimepath has been set incorrectly and the autoload file is getting loaded by something, then the code won't be able to load the "plugin" file. Print a warning message and stop loading the file instead of throwing lots of errors.
2015-04-05 16:14:56 +08:00
if exists(':Tagbar') == 0
echomsg 'Tagbar: Could not load plugin code, check your runtimepath!'
finish
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Basic init {{{2
Move some tests to autoload
2011-07-15 13:34:47 +08:00
redir => s:ftype_out
silent filetype
redir END
if s:ftype_out !~# 'detection:ON'
echomsg 'Tagbar: Filetype detection is turned off, skipping plugin'
unlet s:ftype_out
finish
endif
unlet s:ftype_out
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let g:tagbar#icon_closed = g:tagbar_iconchars[0]
let g:tagbar#icon_open = g:tagbar_iconchars[1]
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Remove autocmds when not needed, closes #153 When the Tagbar window gets closed and the statusline functionality is not in use, remove the autocommands to prevent unnecessary ctags calls.
2013-07-30 07:38:46 +08:00
let s:type_init_done = 0
let s:autocommands_done = 0
let s:statusline_in_use = 0
Don't try to restore session on 'loadview', closes #382 The view files created with the 'mkview' command run the 'SessionLoadPost' autocommand at the end, which creates problems if Tagbar has alread been initialized. Add a new variable so that we can detect this situation.
2017-06-05 13:21:56 +08:00
let s:init_done = 0
Remove autocmds when not needed, closes #153 When the Tagbar window gets closed and the statusline functionality is not in use, remove the autocommands to prevent unnecessary ctags calls.
2013-07-30 07:38:46 +08:00
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
" 0: not checked yet; 1: checked and found; 2: checked and not found
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
let s:checked_ctags = 0
let s:checked_ctags_types = 0
Fix Python member functions with Universal Ctags, closes #306
2016-09-10 16:57:37 +08:00
let s:ctags_is_uctags = 0
Move some var inits outside of win init function
2012-09-04 20:29:28 +08:00
let s:new_window = 1
let s:is_maximized = 0
Restore windows properly after zooming
2013-05-20 11:18:57 +08:00
let s:winrestcmd = ''
Move some var inits outside of win init function
2012-09-04 20:29:28 +08:00
let s:short_help = 1
Better handling of switching to unsupported buffer
2013-02-18 19:02:32 +08:00
let s:nearby_disabled = 0
Rework pause functionality, closes #177 The current pause functionality simply removes all the autocommands to stop updating Tagbar. This has the problem that at the moment the statusline functions immediately restore the commands so pausing doesn't work, but even if that didn't happen it would stop the statusline functionality from working which is not desirable. The solution is to have a reference to the paused file which will get used by the Tagbar window, but not the statusline functions.
2013-11-06 17:33:27 +08:00
let s:paused = 0
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
let s:pwin_by_tagbar = 0
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let s:buffer_seqno = 0
Properly handle closing the last file window, closes #345 When a window that is displaying a normal file gets closed with a :quit, :bdelete or other command, Tagbar may end up as the only visible window left, which isn't very useful. Previously Tagbar would just quit in such a situation (unless there was more than one tab), but that is rather non-intuitive. The change in this commit introduces a mechanism that should hopefully handle such a case properly based on which command was executed, and do exactly what a user would expect: - In the ':quit' case, it will close the current tabpage including Tagbar unless it was the only tabpage, in which case it will quit Vim. - In the ':bdelete/:bwipeout' case, it will delete the Tagbar buffer and then reopen Tagbar once the buffer that Vim switched to is being displayed.
2016-10-09 16:01:24 +08:00
let s:vim_quitting = 0
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
let s:last_alt_bufnr = -1
Move some var inits outside of win init function
2012-09-04 20:29:28 +08:00
Don't restore window position if moved manually
2013-03-18 14:09:12 +08:00
let s:window_expanded = 0
Always properly shrink window, closes #172 Closing Tagbar with :q instead of the provided commands and mappings would bypass the Vim application window shrinking logic. Install an autocommand that checks for this situation.
2013-11-04 17:30:17 +08:00
let s:expand_bufnr = -1
Don't restore window position if moved manually
2013-03-18 14:09:12 +08:00
let s:window_pos = {
\ 'pre' : { 'x' : 0, 'y' : 0 },
\ 'post' : { 'x' : 0, 'y' : 0 }
\}
Save and restore window position when expanding, closes #129
2013-03-18 13:51:54 +08:00
Update tags on CursorHold after writing Currently the tags will always get updated immediately when writing a file. However, for large files that can slow down the writing process noticeably, leading to annoying pauses. This commit instead defers the updating process to the first CursorHold/CursorHoldI event after writing a file, which should make the process much less noticeable. Closes #289 Closes #381 References SpaceVim/SpaceVim#129
2017-02-05 13:51:28 +08:00
let s:delayed_update_files = []
Move some tests to autoload
2011-07-15 13:34:47 +08:00
let g:loaded_tagbar = 1
Don't highlight the same tag again, closes #36
2011-10-02 17:39:39 +08:00
let s:last_highlight_tline = 0
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
let s:warnings = {
\ 'type': [],
\ 'encoding': 0
\ }
Extract some init steps into function
2011-12-21 12:03:12 +08:00
" s:Init() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:Init(silent) abort
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
if s:checked_ctags == 2 && a:silent
return 0
elseif s:checked_ctags != 1
if !s:CheckForExCtags(a:silent)
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
return 0
Extract some init steps into function
2011-12-21 12:03:12 +08:00
endif
endif
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
if !s:type_init_done
call s:InitTypes()
endif
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
if !s:autocommands_done
call s:CreateAutocommands()
Don't use doautocmd
2012-09-09 18:55:57 +08:00
call s:AutoUpdate(fnamemodify(expand('%'), ':p'), 0)
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
endif
Don't try to restore session on 'loadview', closes #382 The view files created with the 'mkview' command run the 'SessionLoadPost' autocommand at the end, which creates problems if Tagbar has alread been initialized. Add a new variable so that we can detect this situation.
2017-06-05 13:21:56 +08:00
let s:init_done = 1
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
return 1
Extract some init steps into function
2011-12-21 12:03:12 +08:00
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:InitTypes() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:InitTypes() abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Initializing types')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Separate {ex,u}ctags definitions out into individual files
2017-08-14 17:13:50 +08:00
let supported_types = s:GetSupportedFiletypes()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Improve HTML support with Universal Ctags, closes #317
2016-10-23 15:31:35 +08:00
if s:ctags_is_uctags
Rename types autoload directory
2017-08-20 13:11:37 +08:00
let s:known_types = tagbar#types#uctags#init(supported_types)
Improve HTML support with Universal Ctags, closes #317
2016-10-23 15:31:35 +08:00
else
Rename types autoload directory
2017-08-20 13:11:37 +08:00
let s:known_types = tagbar#types#ctags#init(supported_types)
Improve HTML support with Universal Ctags, closes #317
2016-10-23 15:31:35 +08:00
endif
Separate {ex,u}ctags definitions out into individual files
2017-08-14 17:13:50 +08:00
feat(dart_ctags): Support dart if dart_ctags is installed (#581)
2020-01-06 21:29:08 +08:00
" Use dart_ctags if available
let dart_ctags = s:CheckFTCtags('dart_ctags', 'dart')
if dart_ctags !=# ''
let supported_types['dart'] = 1
call tagbar#debug#log('Detected dart_ctags, overriding typedef')
let type_dart = tagbar#prototypes#typeinfo#new()
let type_dart.ctagstype = 'dart'
let type_dart.kinds = [
\ {'short' : 'i', 'long' : 'imports', 'fold' : 1, 'stl' : 0},
\ {'short' : 'C', 'long' : 'consts', 'fold' : 0, 'stl' : 0},
\ {'short' : 'v', 'long' : 'variables', 'fold' : 0, 'stl' : 0},
\ {'short' : 'F', 'long' : 'functions', 'fold' : 0, 'stl' : 0},
\ {'short' : 'c', 'long' : 'classes', 'fold' : 0, 'stl' : 0},
\ {'short' : 'f', 'long' : 'fields', 'fold' : 0, 'stl' : 0},
\ {'short' : 'm', 'long' : 'methods', 'fold' : 0, 'stl' : 0},
\ {'short' : 'M', 'long' : 'static methods', 'fold' : 0, 'stl' : 0},
\ {'short' : 'r', 'long' : 'constructors', 'fold' : 0, 'stl' : 0},
\ {'short' : 'o', 'long' : 'operators', 'fold' : 0, 'stl' : 0},
\ {'short' : 'g', 'long' : 'getters', 'fold' : 0, 'stl' : 0},
\ {'short' : 's', 'long' : 'setters', 'fold' : 0, 'stl' : 0},
\ {'short' : 'a', 'long' : 'abstract functions', 'fold' : 0, 'stl' : 0},
\ ]
let type_dart.sro = ':'
let type_dart.kind2scope = {
\ 'c' : 'class'
\ }
let type_dart.scope2kind = {
\ 'class' : 'c'
\ }
let type_dart.ctagsbin = dart_ctags
let type_dart.ctagsargs = '-l'
let type_dart.ftype = 'dart'
call type_dart.createKinddict()
let s:known_types.dart = type_dart
endif
Separate {ex,u}ctags definitions out into individual files
2017-08-14 17:13:50 +08:00
" Use jsctags/doctorjs if available
Remove need to provide complete jsctags configuration if jsctags not in path
2011-12-21 15:33:31 +08:00
let jsctags = s:CheckFTCtags('jsctags', 'javascript')
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if jsctags !=# ''
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Detected jsctags, overriding typedef')
Separate {ex,u}ctags definitions out into individual files
2017-08-14 17:13:50 +08:00
let type_javascript = tagbar#prototypes#typeinfo#new()
let type_javascript.ctagstype = 'javascript'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let type_javascript.kinds = [
Allow types for tagbar#currenttag() to be configured
2012-03-04 15:52:15 +08:00
\ {'short' : 'v', 'long' : 'variables', 'fold' : 0, 'stl' : 0},
\ {'short' : 'f', 'long' : 'functions', 'fold' : 0, 'stl' : 1}
Move most of script to autoload
2011-06-29 04:59:49 +08:00
\ ]
let type_javascript.sro = '.'
let type_javascript.kind2scope = {
\ 'v' : 'namespace',
\ 'f' : 'namespace'
\ }
let type_javascript.scope2kind = {
Fix jsctags config, closes #421 This seems to be different for the tern-based jsctags, and the old one is deprecated anyway.
2017-06-15 13:24:32 +08:00
\ 'namespace' : 'f'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
\ }
Remove need to provide complete jsctags configuration if jsctags not in path
2011-12-21 15:33:31 +08:00
let type_javascript.ctagsbin = jsctags
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let type_javascript.ctagsargs = '-f -'
Add missing ftype field to jsctags type def
2017-08-21 05:54:37 +08:00
let type_javascript.ftype = 'javascript'
Create kinddict for jsctags type def Closes #431 Closes #432
2017-08-19 14:14:21 +08:00
call type_javascript.createKinddict()
Separate {ex,u}ctags definitions out into individual files
2017-08-14 17:13:50 +08:00
let s:known_types.javascript = type_javascript
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
feat(gotags): override ctags for go if gotags is installed
2020-01-04 06:48:19 +08:00
" Use gotags if available
let gotags = s:CheckFTCtags('gotags', 'go')
if gotags !=# ''
call tagbar#debug#log('Detected gotags, overriding typedef')
let type_go = tagbar#prototypes#typeinfo#new()
let type_go.ctagstype = 'go'
let type_go.kinds = [
\ {'short' : 'p', 'long' : 'package', 'fold' : 0, 'stl' : 0},
\ {'short' : 'i', 'long' : 'imports', 'fold' : 1, 'stl' : 0},
\ {'short' : 'c', 'long' : 'constants', 'fold' : 0, 'stl' : 0},
\ {'short' : 'v', 'long' : 'variables', 'fold' : 0, 'stl' : 0},
\ {'short' : 't', 'long' : 'types', 'fold' : 0, 'stl' : 0},
\ {'short' : 'n', 'long' : 'intefaces', 'fold' : 0, 'stl' : 0},
\ {'short' : 'm', 'long' : 'methods', 'fold' : 0, 'stl' : 0},
\ {'short' : 'r', 'long' : 'constructors', 'fold' : 0, 'stl' : 0},
\ {'short' : 'f', 'long' : 'functions', 'fold' : 0, 'stl' : 0},
\ ]
let type_go.sro = '.'
let type_go.kind2scope = {
\ 't' : 'ctype',
\ 'n' : 'ntype'
\ }
let type_go.scope2kind = {
\ 'ctype' : 't',
\ 'ntype' : 'n'
\ }
let type_go.ctagsbin = gotags
let type_go.ctagsargs = '-sort -silent'
let type_go.ftype = 'go'
call type_go.createKinddict()
let s:known_types.go = type_go
endif
Small code cleanup
2017-01-10 13:24:13 +08:00
call s:LoadUserTypeDefs()
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
" Add an 'unknown' kind to the types for pseudotags that we can't
" determine the correct kind for since they don't have any children that
" are not pseudotags and that therefore don't provide scope information
for typeinfo in values(s:known_types)
if has_key(typeinfo, 'kind2scope')
let unknown_kind =
\ {'short' : '?', 'long' : 'unknown', 'fold' : 0, 'stl' : 1}
" Check for existence first since some types exist under more than
" one name
if index(typeinfo.kinds, unknown_kind) == -1
call add(typeinfo.kinds, unknown_kind)
endif
let typeinfo.kind2scope['?'] = 'unknown'
endif
endfor
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let s:type_init_done = 1
endfunction
Allow loading type definitions from ftplugins, closes #62
2012-02-19 12:26:15 +08:00
" s:LoadUserTypeDefs() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:LoadUserTypeDefs(...) abort
Allow loading type definitions from ftplugins, closes #62
2012-02-19 12:26:15 +08:00
if a:0 > 0
let type = a:1
Add debugging functionality
2011-12-12 14:47:43 +08:00
Allow loading type definitions from ftplugins, closes #62
2012-02-19 12:26:15 +08:00
let defdict = {}
let defdict[type] = g:tagbar_type_{type}
else
Move parsing of user type defs into separate function
2012-03-08 13:06:51 +08:00
let defdict = tagbar#getusertypes()
Allow loading type definitions from ftplugins, closes #62
2012-02-19 12:26:15 +08:00
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Allow project-specific type config
2013-04-23 14:07:29 +08:00
let transformed = {}
for [type, def] in items(defdict)
let transformed[type] = s:TransformUserTypeDef(def)
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
let transformed[type].ftype = type
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfor
Allow project-specific type config
2013-04-23 14:07:29 +08:00
for [key, value] in items(transformed)
Log individual user types being loaded
2017-09-03 16:34:54 +08:00
call tagbar#debug#log("Initializing user type '" . key . "'")
Allow project-specific type config
2013-04-23 14:07:29 +08:00
if !has_key(s:known_types, key) || get(value, 'replace', 0)
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let s:known_types[key] = tagbar#prototypes#typeinfo#new(value)
Allow loading type definitions from ftplugins, closes #62
2012-02-19 12:26:15 +08:00
else
call extend(s:known_types[key], value)
endif
Small code cleanup
2017-01-10 13:24:13 +08:00
call s:known_types[key].createKinddict()
Allow loading type definitions from ftplugins, closes #62
2012-02-19 12:26:15 +08:00
endfor
endfunction
Allow project-specific type config
2013-04-23 14:07:29 +08:00
" s:TransformUserTypeDef() {{{2
" Transform the user definitions into the internal format
function! s:TransformUserTypeDef(def) abort
let newdef = copy(a:def)
if has_key(a:def, 'kinds')
let newdef.kinds = []
let kinds = a:def.kinds
for kind in kinds
let kindlist = split(kind, ':')
let kinddict = {'short' : kindlist[0], 'long' : kindlist[1]}
let kinddict.fold = get(kindlist, 2, 0)
let kinddict.stl = get(kindlist, 3, 1)
call add(newdef.kinds, kinddict)
endfor
endif
" If the user only specified one of kind2scope and scope2kind then use it
" to generate the respective other
if has_key(a:def, 'kind2scope') && !has_key(a:def, 'scope2kind')
let newdef.scope2kind = {}
for [key, value] in items(a:def.kind2scope)
let newdef.scope2kind[value] = key
endfor
elseif has_key(a:def, 'scope2kind') && !has_key(a:def, 'kind2scope')
let newdef.kind2scope = {}
for [key, value] in items(a:def.scope2kind)
let newdef.kind2scope[value] = key
endfor
endif
return newdef
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:RestoreSession() {{{2
" Properly restore Tagbar after a session got loaded
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:RestoreSession() abort
Don't try to restore session on 'loadview', closes #382 The view files created with the 'mkview' command run the 'SessionLoadPost' autocommand at the end, which creates problems if Tagbar has alread been initialized. Add a new variable so that we can detect this situation.
2017-06-05 13:21:56 +08:00
if s:init_done
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Tagbar already initialized; not restoring session')
Don't try to restore session on 'loadview', closes #382 The view files created with the 'mkview' command run the 'SessionLoadPost' autocommand at the end, which creates problems if Tagbar has alread been initialized. Add a new variable so that we can detect this situation.
2017-06-05 13:21:56 +08:00
return
endif
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Restoring session')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
let curfile = fnamemodify(bufname('%'), ':p')
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if tagbarwinnr == -1
" Tagbar wasn't open in the saved session, nothing to do
return
Don't try to restore session on 'loadview', closes #382 The view files created with the 'mkview' command run the 'SessionLoadPost' autocommand at the end, which creates problems if Tagbar has alread been initialized. Add a new variable so that we can detect this situation.
2017-06-05 13:21:56 +08:00
endif
let in_tagbar = 1
if winnr() != tagbarwinnr
call s:goto_win(tagbarwinnr, 1)
let in_tagbar = 0
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Fix small bug in RestoreSession
2012-04-15 19:10:58 +08:00
let s:last_autofocus = 0
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
call s:Init(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
call s:InitWindow(g:tagbar_autoclose)
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
call s:AutoUpdate(curfile, 0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if !in_tagbar
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win('p')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
endfunction
" s:MapKeys() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:MapKeys() abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Mapping keys')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
nnoremap <script> <silent> <buffer> <2-LeftMouse>
\ :call <SID>JumpToTag(0)<CR>
nnoremap <script> <silent> <buffer> <LeftRelease>
\ <LeftRelease>:call <SID>CheckMouseClick()<CR>
inoremap <script> <silent> <buffer> <2-LeftMouse>
\ <C-o>:call <SID>JumpToTag(0)<CR>
inoremap <script> <silent> <buffer> <LeftRelease>
\ <LeftRelease><C-o>:call <SID>CheckMouseClick()<CR>
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
let maps = [
Allow hiding non-public tags, closes #186
2014-02-05 13:08:04 +08:00
\ ['jump', 'JumpToTag(0)'],
\ ['preview', 'JumpToTag(1)'],
\ ['previewwin', 'ShowInPreviewWin()'],
\ ['nexttag', 'GotoNextToplevelTag(1)'],
\ ['prevtag', 'GotoNextToplevelTag(-1)'],
\ ['showproto', 'ShowPrototype(0)'],
\ ['hidenonpublic', 'ToggleHideNonPublicTags()'],
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
\
\ ['openfold', 'OpenFold()'],
\ ['closefold', 'CloseFold()'],
\ ['togglefold', 'ToggleFold()'],
\ ['openallfolds', 'SetFoldLevel(99, 1)'],
\ ['closeallfolds', 'SetFoldLevel(0, 1)'],
Add ability to open or close folds a single level
2017-07-26 22:18:18 +08:00
\ ['incrementfolds', 'ChangeFoldLevel(1, 1)'],
\ ['decrementfolds', 'ChangeFoldLevel(-1, 1)'],
Add mappings for moving through folds, closes #224
2014-11-09 12:33:42 +08:00
\ ['nextfold', 'GotoNextFold()'],
\ ['prevfold', 'GotoPrevFold()'],
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
\
Add case-insensitive sort option
2016-08-28 06:14:10 +08:00
\ ['togglesort', 'ToggleSort()'],
\ ['togglecaseinsensitive', 'ToggleCaseInsensitive()'],
\ ['toggleautoclose', 'ToggleAutoclose()'],
Add map to allow pausing/unpausing tagbar
2018-06-15 16:27:33 +08:00
\ ['togglepause', 'TogglePause()'],
Add case-insensitive sort option
2016-08-28 06:14:10 +08:00
\ ['zoomwin', 'ZoomWindow()'],
\ ['close', 'CloseWindow()'],
\ ['help', 'ToggleHelp()'],
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
\ ]
Define mappings with <nowait> if available, closes #299
2016-10-21 21:02:27 +08:00
let map_options = ' <script> <silent> <buffer> '
if v:version > 703 || (v:version == 703 && has('patch1261'))
let map_options .= ' <nowait> '
endif
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
for [map, func] in maps
let def = get(g:, 'tagbar_map_' . map)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if type(def) == type('')
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
let keys = [def]
else
let keys = def
endif
for key in keys
Define mappings with <nowait> if available, closes #299
2016-10-21 21:02:27 +08:00
execute 'nnoremap' . map_options . key .
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
\ ' :call <SID>' . func . '<CR>'
endfor
unlet def
endfor
Better mapping init, closes #203 If someone already has a function that includes "JumpToTag" in its name then the current method of detecting whether mappings should be initialized would fail. Use a buffer-local variable instead.
2014-04-05 14:08:54 +08:00
let b:tagbar_mapped_keys = 1
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" s:CreateAutocommands() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:CreateAutocommands() abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Creating autocommands')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
augroup TagbarAutoCmds
autocmd!
Silent option If the silent option is set, tagbar doesn't echo out information about the tag the cursor is on in the tagbar window.
2016-02-18 17:01:35 +08:00
if !g:tagbar_silent
autocmd CursorHold __Tagbar__.* call s:ShowPrototype(1)
endif
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
autocmd WinEnter __Tagbar__.* call s:SetStatusLine()
autocmd WinLeave __Tagbar__.* call s:SetStatusLine()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Add auto-previewing mode, closes #161
2013-11-11 13:23:22 +08:00
if g:tagbar_autopreview
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
autocmd CursorMoved __Tagbar__.* nested call s:ShowInPreviewWin()
Add auto-previewing mode, closes #161
2013-11-11 13:23:22 +08:00
endif
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
autocmd BufEnter * if expand('<amatch>') !~ '__Tagbar__.*' |
\ let s:last_alt_bufnr = bufnr('#') |
\ endif
Only use QuitPre functionality if supported, closes #350 The QuitPre autocommand was introduced in Vim version 7.3.544. If Vim is older than this then don't use the HandleOnlyWindow() functionality, so in the case of closing the last window in a tab a user will have to close the Tagbar window themselves.
2016-10-15 15:20:03 +08:00
if exists('##QuitPre')
autocmd QuitPre * let s:vim_quitting = 1
endif
Rename QuitIfOnlyWindow since it's no longer accurate
2016-10-10 16:51:14 +08:00
autocmd WinEnter * nested call s:HandleOnlyWindow()
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
autocmd WinEnter * if bufwinnr(s:TagbarBufName()) == -1 |
Always properly shrink window, closes #172 Closing Tagbar with :q instead of the provided commands and mappings would bypass the Vim application window shrinking logic. Install an autocommand that checks for this situation.
2013-11-04 17:30:17 +08:00
\ call s:ShrinkIfExpanded() |
\ endif
Update tags on CursorHold after writing Currently the tags will always get updated immediately when writing a file. However, for large files that can slow down the writing process noticeably, leading to annoying pauses. This commit instead defers the updating process to the first CursorHold/CursorHoldI event after writing a file, which should make the process much less noticeable. Closes #289 Closes #381 References SpaceVim/SpaceVim#129
2017-02-05 13:51:28 +08:00
autocmd BufWritePost *
\ call s:HandleBufWrite(fnamemodify(expand('<afile>'), ':p'))
autocmd CursorHold,CursorHoldI * call s:do_delayed_update()
Add comment why BufReadPost is needed
2013-11-05 04:16:58 +08:00
" BufReadPost is needed for reloading the current buffer if the file
" was changed by an external command; see commit 17d199f
Don't force processing on BufReadPost, closes #170 This prevents files being processed twice unnecessarily, once for FileType and once for BufReadPost. All cases where BufReadPost is called without FileType should be covered by the checks in AutoUpdate().
2013-09-18 13:44:52 +08:00
autocmd BufReadPost,BufEnter,CursorHold,FileType * call
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
\ s:AutoUpdate(fnamemodify(expand('<afile>'), ':p'), 0)
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
autocmd BufDelete,BufWipeout *
HandleBufDelete: Ignore apparent 'set nobuflisted' events
2016-12-17 05:08:28 +08:00
\ nested call s:HandleBufDelete(expand('<afile>'), expand('<abuf>'))
Correct focus on startup under certain circumstances, closes #60
2012-02-23 15:42:35 +08:00
Only suspend Tagbar during 'grep' qf commands, closes #347
2016-10-12 09:16:37 +08:00
" Suspend Tagbar while grep commands are running, since we don't want
" to process files that only get loaded temporarily to search them
autocmd QuickFixCmdPre *grep* let s:tagbar_qf_active = 1
autocmd QuickFixCmdPost *grep* if exists('s:tagbar_qf_active') |
\ unlet s:tagbar_qf_active |
\ endif
Don't process quickfix-loaded files, closes #176 Certain quickfix-commands like vimgrep have to load all searched files into Vim and will execute the BufReadPost autocmd for all of them. Since Tagbar doesn't need to generate tags for those files pause processing while the command is running. There doesn't seem to be a better way to find out whether vimgrep is running than to set a temporary variable with the QuickFixCmdPre/Post autocmds, see also https://groups.google.com/forum/#!topic/vim_use/sUj5MFGmwD8
2013-11-04 17:51:38 +08:00
Correct focus on startup under certain circumstances, closes #60
2012-02-23 15:42:35 +08:00
autocmd VimEnter * call s:CorrectFocusOnStartup()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
augroup END
let s:autocommands_done = 1
Pause autocmd functionality with :TagbarPause tagbar#PauseAutocommands :TagbarPause :TagbarPause pauses autocmds, effectively freezing Tagbar on the last file. Useful for keeping a tag reference for a file open whilst working in a different file.
2012-10-01 21:22:35 +08:00
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:CheckForExCtags() {{{2
Change mentions of GNU ctags to BSD ctags
2015-06-19 07:08:47 +08:00
" Test whether the ctags binary is actually Exuberant Ctags and not BSD ctags
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" (or something else)
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:CheckForExCtags(silent) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Checking for Exuberant Ctags')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Only check for ctags when a function is called If ctags isn't installed, then until now most of the autoload script would have been skipped, leaving functions like tagbar#currenttag() undefined. Move the ctags check to the exuberant-ctags checking function to prevent errors in this case.
2012-07-01 15:21:44 +08:00
if !exists('g:tagbar_ctags_bin')
let ctagsbins = []
let ctagsbins += ['ctags-exuberant'] " Debian
let ctagsbins += ['exuberant-ctags']
let ctagsbins += ['exctags'] " FreeBSD, NetBSD
let ctagsbins += ['/usr/local/bin/ctags'] " Homebrew
let ctagsbins += ['/opt/local/bin/ctags'] " Macports
let ctagsbins += ['ectags'] " OpenBSD
let ctagsbins += ['ctags']
let ctagsbins += ['ctags.exe']
let ctagsbins += ['tags']
Discover the universal-ctags binary At least in the openSUSE package for `universal-ctags` it is not installed as `ctags`
2019-03-28 23:36:39 +08:00
let ctagsbins += ['universal-ctags']
Only check for ctags when a function is called If ctags isn't installed, then until now most of the autoload script would have been skipped, leaving functions like tagbar#currenttag() undefined. Move the ctags check to the exuberant-ctags checking function to prevent errors in this case.
2012-07-01 15:21:44 +08:00
for ctags in ctagsbins
if executable(ctags)
let g:tagbar_ctags_bin = ctags
break
endif
endfor
if !exists('g:tagbar_ctags_bin')
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
let l:errmsg = 'Tagbar: Exuberant ctags not found!'
let l:infomsg = 'Please download Exuberant Ctags from' .
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
\ ' ctags.sourceforge.net and install it in a' .
\ ' directory in your $PATH or set g:tagbar_ctags_bin.'
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
call s:CtagsErrMsg(l:errmsg, l:infomsg, a:silent)
Only check for ctags when a function is called If ctags isn't installed, then until now most of the autoload script would have been skipped, leaving functions like tagbar#currenttag() undefined. Move the ctags check to the exuberant-ctags checking function to prevent errors in this case.
2012-07-01 15:21:44 +08:00
let s:checked_ctags = 2
return 0
endif
else
" reset 'wildignore' temporarily in case *.exe is included in it
let wildignore_save = &wildignore
set wildignore&
let g:tagbar_ctags_bin = expand(g:tagbar_ctags_bin)
let &wildignore = wildignore_save
if !executable(g:tagbar_ctags_bin)
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
let l:errmsg = 'Tagbar: Exuberant ctags not found at ' .
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
\ "'" . g:tagbar_ctags_bin . "'!"
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
let l:infomsg = 'Please check your g:tagbar_ctags_bin setting.'
call s:CtagsErrMsg(l:errmsg, l:infomsg, a:silent)
Only check for ctags when a function is called If ctags isn't installed, then until now most of the autoload script would have been skipped, leaving functions like tagbar#currenttag() undefined. Move the ctags check to the exuberant-ctags checking function to prevent errors in this case.
2012-07-01 15:21:44 +08:00
let s:checked_ctags = 2
return 0
endif
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let ctags_cmd = s:EscapeCtagsCmd(g:tagbar_ctags_bin, '--version')
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ctags_cmd ==# ''
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
let s:checked_ctags = 2
return 0
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
let ctags_output = s:ExecuteCtags(ctags_cmd)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log("Command output:\n" . ctags_output)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
call tagbar#debug#log('Exit code: ' . v:shell_error)
Always log the ctags version output
2016-12-17 13:01:49 +08:00
Fixed compatibility with Universal Ctags This commit fixes tagbar compatibility issues with the [universal-ctags](/universal-ctags/ctags), which is the most active and consistently updated fork of the old exuberant ctags.
2015-06-11 18:31:08 +08:00
if v:shell_error || ctags_output !~# '\(Exuberant\|Universal\) Ctags'
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
let l:errmsg = 'Tagbar: Ctags doesn''t seem to be Exuberant Ctags!'
let l:infomsg = 'BSD ctags will NOT WORK.' .
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
\ ' Please download Exuberant Ctags from ctags.sourceforge.net' .
\ ' and install it in a directory in your $PATH' .
\ ' or set g:tagbar_ctags_bin.'
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
call s:CtagsErrMsg(l:errmsg, l:infomsg, a:silent,
Print exit code when failing to run ctags
2016-10-21 12:43:35 +08:00
\ ctags_cmd, ctags_output, v:shell_error)
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
let s:checked_ctags = 2
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return 0
elseif !s:CheckExCtagsVersion(ctags_output)
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
let l:errmsg = 'Tagbar: Exuberant Ctags is too old!'
let l:infomsg = 'You need at least version 5.5 for Tagbar to work.' .
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
\ ' Please download a newer version from ctags.sourceforge.net.'
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
call s:CtagsErrMsg(l:errmsg, l:infomsg, a:silent, ctags_cmd, ctags_output)
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
let s:checked_ctags = 2
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return 0
else
let s:checked_ctags = 1
return 1
endif
endfunction
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
" s:CtagsErrMsg() {{{2
function! s:CtagsErrMsg(errmsg, infomsg, silent, ...) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log(a:errmsg)
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
let ctags_cmd = a:0 > 0 ? a:1 : ''
Print exit code when failing to run ctags
2016-10-21 12:43:35 +08:00
let ctags_output = a:0 > 1 ? a:2 : ''
let exit_code_set = a:0 > 2
if exit_code_set
let exit_code = a:3
endif
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
if !a:silent
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
call s:warning(a:errmsg)
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
echomsg a:infomsg
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ctags_cmd ==# ''
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
return
endif
echomsg 'Executed command: "' . ctags_cmd . '"'
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ctags_output !=# ''
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
echomsg 'Command output:'
for line in split(ctags_output, '\n')
echomsg line
endfor
Echo message if ctags output is empty
2013-08-24 13:40:12 +08:00
else
echomsg 'Command output is empty.'
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
endif
Print exit code when failing to run ctags
2016-10-21 12:43:35 +08:00
if exit_code_set
echomsg 'Exit code: ' . exit_code
endif
Log error messages with ctags output
2013-08-23 14:02:24 +08:00
endif
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:CheckExCtagsVersion() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:CheckExCtagsVersion(output) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Checking Exuberant Ctags version')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if a:output =~? 'Universal Ctags'
call tagbar#debug#log('Found Universal Ctags, assuming compatibility')
Fix Python member functions with Universal Ctags, closes #306
2016-09-10 16:57:37 +08:00
let s:ctags_is_uctags = 1
Accept ctags development versions
2011-10-15 13:40:27 +08:00
return 1
endif
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if a:output =~? 'Exuberant Ctags compatiable PHP enhancement'
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
call tagbar#debug#log('Found phpctags, assuming compatibility')
compatibility with phpctags
2017-06-27 21:15:46 +08:00
return 1
endif
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if a:output =~? 'Exuberant Ctags Development'
call tagbar#debug#log('Found development version, assuming compatibility')
Fixed compatibility with Universal Ctags This commit fixes tagbar compatibility issues with the [universal-ctags](/universal-ctags/ctags), which is the most active and consistently updated fork of the old exuberant ctags.
2015-06-11 18:31:08 +08:00
return 1
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let matchlist = matchlist(a:output, '\vExuberant Ctags (\d+)\.(\d+)')
let major = matchlist[1]
let minor = matchlist[2]
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log("Ctags version: major='" . major . "', minor='" . minor . "'")
Log ctags version
2013-08-24 14:38:04 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return major >= 6 || (major == 5 && minor >= 5)
endfunction
Remove need to provide complete jsctags configuration if jsctags not in path
2011-12-21 15:33:31 +08:00
" s:CheckFTCtags() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:CheckFTCtags(bin, ftype) abort
Remove need to provide complete jsctags configuration if jsctags not in path
2011-12-21 15:33:31 +08:00
if executable(a:bin)
return a:bin
endif
if exists('g:tagbar_type_' . a:ftype)
Small cleanups
2014-12-10 10:34:14 +08:00
let userdef = g:tagbar_type_{a:ftype}
Remove need to provide complete jsctags configuration if jsctags not in path
2011-12-21 15:33:31 +08:00
if has_key(userdef, 'ctagsbin')
return userdef.ctagsbin
else
return ''
endif
endif
return ''
endfunction
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
" s:GetSupportedFiletypes() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:GetSupportedFiletypes() abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Getting filetypes supported by Exuberant Ctags')
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
let ctags_cmd = s:EscapeCtagsCmd(g:tagbar_ctags_bin, '--list-languages')
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ctags_cmd ==# ''
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
return
endif
let ctags_output = s:ExecuteCtags(ctags_cmd)
if v:shell_error
" this shouldn't happen as potential problems would have already been
" caught by the previous ctags checking
return
endif
let types = split(ctags_output, '\n\+')
Separate {ex,u}ctags definitions out into individual files
2017-08-14 17:13:50 +08:00
let supported_types = {}
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
for type in types
Skip languages that are disabled in ctags
2017-01-05 12:12:33 +08:00
if match(type, '\[disabled\]') == -1
Separate {ex,u}ctags definitions out into individual files
2017-08-14 17:13:50 +08:00
let supported_types[tolower(type)] = 1
Skip languages that are disabled in ctags
2017-01-05 12:12:33 +08:00
endif
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
endfor
Separate {ex,u}ctags definitions out into individual files
2017-08-14 17:13:50 +08:00
return supported_types
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
endfunction
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
" Known files {{{1
Separate shared and per-tagbar instance data
2016-09-25 05:45:07 +08:00
let s:known_files = {
\ '_files' : {}
\ }
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
" s:known_files.get() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:known_files.get(fname) abort dict
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return get(self._files, a:fname, {})
endfunction
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
" s:known_files.put() {{{2
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Optional second argument is the filename
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:known_files.put(fileinfo, ...) abort dict
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if a:0 == 1
let self._files[a:1] = a:fileinfo
else
let fname = a:fileinfo.fpath
let self._files[fname] = a:fileinfo
endif
endfunction
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
" s:known_files.has() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:known_files.has(fname) abort dict
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return has_key(self._files, a:fname)
endfunction
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
" s:known_files.rm() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:known_files.rm(fname) abort dict
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if s:known_files.has(a:fname)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Removing fileinfo for [' . a:fname . ']')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
call remove(self._files, a:fname)
endif
endfunction
" Window management {{{1
" s:ToggleWindow() {{{2
flags argument added to functions responsible for window toggling
2016-10-11 15:41:01 +08:00
function! s:ToggleWindow(flags) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('ToggleWindow called')
Add some debug messages
2012-01-31 15:59:06 +08:00
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if tagbarwinnr != -1
call s:CloseWindow()
return
endif
flags argument added to functions responsible for window toggling
2016-10-11 15:41:01 +08:00
call s:OpenWindow(a:flags)
Add some debug messages
2012-01-31 15:59:06 +08:00
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('ToggleWindow finished')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" s:OpenWindow() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:OpenWindow(flags) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log("OpenWindow called with flags: '" . a:flags . "'")
Add some debug messages
2012-01-31 15:59:06 +08:00
Make TagbarOpen command more flexible
2011-11-23 14:56:31 +08:00
let autofocus = a:flags =~# 'f'
let jump = a:flags =~# 'j'
let autoclose = a:flags =~# 'c'
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
let curfile = fnamemodify(bufname('%'), ':p')
Highlight correct tag when opening tagbar
2012-04-22 00:28:28 +08:00
let curline = line('.')
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
Make TagbarOpen command more flexible
2011-11-23 14:56:31 +08:00
" If the tagbar window is already open check jump flag
" Also set the autoclose flag if requested
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if tagbarwinnr != -1
Make TagbarOpen command more flexible
2011-11-23 14:56:31 +08:00
if winnr() != tagbarwinnr && jump
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win(tagbarwinnr)
Make autoshowtag more flexible, closes #152
2013-06-25 12:32:33 +08:00
call s:HighlightTag(g:tagbar_autoshowtag != 2, 1, curline)
Make TagbarOpen command more flexible
2011-11-23 14:56:31 +08:00
endif
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
call tagbar#debug#log('OpenWindow finished, Tagbar already open')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
Use window ID functionality if available, ref #351 When opening the Tagbar window the window numbers can change so that restoring the window history is not possible. Use the new window ID functionality if it is available to make that possible.
2016-10-17 17:57:15 +08:00
" Use the window ID if the functionality exists, this is more reliable
" since the window number can change due to the Tagbar window opening
if exists('*win_getid')
let prevwinid = win_getid()
Only jump to previous window if there is one, closes #355
2016-10-29 12:29:40 +08:00
if winnr('$') > 1
call s:goto_win('p', 1)
let pprevwinid = win_getid()
call s:goto_win('p', 1)
endif
Use window ID functionality if available, ref #351 When opening the Tagbar window the window numbers can change so that restoring the window history is not possible. Use the new window ID functionality if it is available to make that possible.
2016-10-17 17:57:15 +08:00
else
let prevwinnr = winnr()
Only jump to previous window if there is one, closes #355
2016-10-29 12:29:40 +08:00
if winnr('$') > 1
call s:goto_win('p', 1)
let pprevwinnr = winnr()
call s:goto_win('p', 1)
endif
Use window ID functionality if available, ref #351 When opening the Tagbar window the window numbers can change so that restoring the window history is not possible. Use the new window ID functionality if it is available to make that possible.
2016-10-17 17:57:15 +08:00
endif
Also restore window history when opening Tagbar, ref #319
2016-10-16 18:19:42 +08:00
Correct focus on startup under certain circumstances, closes #60
2012-02-23 15:42:35 +08:00
" This is only needed for the CorrectFocusOnStartup() function
let s:last_autofocus = autofocus
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
if !s:Init(0)
Check filetypes supported by ctags during init
2012-02-12 13:36:45 +08:00
return 0
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Update tagbar.vim fix typo
2017-10-18 05:14:14 +08:00
" Expand the Vim window to accommodate for the Tagbar window if requested
Don't restore window position if moved manually
2013-03-18 14:09:12 +08:00
" and save the window positions to be able to restore them later.
Try expanding a terminal if configured
2013-08-30 12:57:27 +08:00
if g:tagbar_expand >= 1 && !s:window_expanded &&
\ (has('gui_running') || g:tagbar_expand == 2)
Don't restore window position if moved manually
2013-03-18 14:09:12 +08:00
let s:window_pos.pre.x = getwinposx()
let s:window_pos.pre.y = getwinposy()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let &columns += g:tagbar_width + 1
Don't restore window position if moved manually
2013-03-18 14:09:12 +08:00
let s:window_pos.post.x = getwinposx()
let s:window_pos.post.y = getwinposy()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let s:window_expanded = 1
endif
Don't update during window opening, closes #179 Plugins like MiniBufExplorer can trigger an update before window initialization has finished, leading to errors. Skip processing until that is done.
2013-11-06 12:06:39 +08:00
let s:window_opening = 1
Add option to arrange Tagbar window vertically
2014-11-08 16:30:17 +08:00
if g:tagbar_vertical == 0
Resize window after opening, ref #246 This prevents an incorrect window size from being used in some edge cases.
2016-11-05 14:20:22 +08:00
let mode = 'vertical '
let openpos = g:tagbar_left ? 'topleft ' : 'botright '
Add option to arrange Tagbar window vertically
2014-11-08 16:30:17 +08:00
let width = g:tagbar_width
else
Resize window after opening, ref #246 This prevents an incorrect window size from being used in some edge cases.
2016-11-05 14:20:22 +08:00
let mode = ''
Add option to arrange Tagbar window vertically
2014-11-08 16:30:17 +08:00
let openpos = g:tagbar_left ? 'leftabove ' : 'rightbelow '
let width = g:tagbar_vertical
endif
Resize window after opening, ref #246 This prevents an incorrect window size from being used in some edge cases.
2016-11-05 14:20:22 +08:00
exe 'silent keepalt ' . openpos . mode . width . 'split ' . s:TagbarBufName()
exe 'silent ' . mode . 'resize ' . width
Don't update during window opening, closes #179 Plugins like MiniBufExplorer can trigger an update before window initialization has finished, leading to errors. Skip processing until that is done.
2013-11-06 12:06:39 +08:00
unlet s:window_opening
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Make TagbarOpen command more flexible
2011-11-23 14:56:31 +08:00
call s:InitWindow(autoclose)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Don't disrupt the statusline if ctags fails
2013-03-23 14:46:14 +08:00
" If the current file exists, but is empty, it means that it had a
" processing error before opening the window, most likely due to a call to
" currenttag() in the statusline. Remove the entry so an error message
" will be shown if the processing still fails.
if empty(s:known_files.get(curfile))
call s:known_files.rm(curfile)
endif
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
call s:AutoUpdate(curfile, 0)
Make autoshowtag more flexible, closes #152
2013-06-25 12:32:33 +08:00
call s:HighlightTag(g:tagbar_autoshowtag != 2, 1, curline)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
if !(g:tagbar_autoclose || autofocus || g:tagbar_autofocus)
Use window ID functionality if available, ref #351 When opening the Tagbar window the window numbers can change so that restoring the window history is not possible. Use the new window ID functionality if it is available to make that possible.
2016-10-17 17:57:15 +08:00
if exists('*win_getid')
Only jump to previous window if there is one, closes #355
2016-10-29 12:29:40 +08:00
if exists('pprevwinid')
noautocmd call win_gotoid(pprevwinid)
endif
Use window ID functionality if available, ref #351 When opening the Tagbar window the window numbers can change so that restoring the window history is not possible. Use the new window ID functionality if it is available to make that possible.
2016-10-17 17:57:15 +08:00
call win_gotoid(prevwinid)
else
" If the Tagbar winnr is identical to one of the saved values
" then that means that the window numbers have changed.
" Just jump back to the previous window since we won't be able to
" restore the window history.
Check for nonexistent variable, closes #357
2016-10-31 04:59:20 +08:00
if winnr() == prevwinnr
\ || (exists('pprevwinnr') && winnr() == pprevwinnr)
Use window ID functionality if available, ref #351 When opening the Tagbar window the window numbers can change so that restoring the window history is not possible. Use the new window ID functionality if it is available to make that possible.
2016-10-17 17:57:15 +08:00
call s:goto_win('p')
else
Only jump to previous window if there is one, closes #355
2016-10-29 12:29:40 +08:00
if exists('pprevwinnr')
call s:goto_win(pprevwinnr, 1)
endif
Use window ID functionality if available, ref #351 When opening the Tagbar window the window numbers can change so that restoring the window history is not possible. Use the new window ID functionality if it is available to make that possible.
2016-10-17 17:57:15 +08:00
call s:goto_win(prevwinnr)
endif
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Add some debug messages
2012-01-31 15:59:06 +08:00
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('OpenWindow finished')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" s:InitWindow() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:InitWindow(autoclose) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('InitWindow called with autoclose: ' . a:autoclose)
Add some debug messages
2012-01-31 15:59:06 +08:00
Separate buffer- and window-local options
2016-10-09 14:02:26 +08:00
" Buffer-local options
Disable spellchecking in Tagbar window, closes #83
2012-06-23 12:39:07 +08:00
setlocal filetype=tagbar
Move most of script to autoload
2011-06-29 04:59:49 +08:00
setlocal noreadonly " in case the "view" mode is used
setlocal buftype=nofile
setlocal bufhidden=hide
setlocal noswapfile
setlocal nobuflisted
setlocal nomodifiable
Separate buffer- and window-local options
2016-10-09 14:02:26 +08:00
setlocal textwidth=0
Add g:tagbar_show_balloon option
2020-01-03 14:57:46 +08:00
if g:tagbar_show_balloon == 1 && has('balloon_eval')
Separate buffer- and window-local options
2016-10-09 14:02:26 +08:00
setlocal balloonexpr=TagbarBalloonExpr()
set ballooneval
endif
" Window-local options
Move most of script to autoload
2011-06-29 04:59:49 +08:00
setlocal nolist
setlocal nowrap
setlocal winfixwidth
Disable spellchecking in Tagbar window, closes #83
2012-06-23 12:39:07 +08:00
setlocal nospell
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Add option to show line numbers, closes #146
2013-08-24 17:45:10 +08:00
if g:tagbar_show_linenumbers == 0
setlocal nonumber
if exists('+relativenumber')
setlocal norelativenumber
endif
elseif g:tagbar_show_linenumbers == 1
setlocal number
elseif g:tagbar_show_linenumbers == 2
setlocal relativenumber
else
set number<
if exists('+relativenumber')
set relativenumber<
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
setlocal nofoldenable
Set foldcolumn to 0 locally, closes #46
2011-10-22 21:23:58 +08:00
setlocal foldcolumn=0
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Reset fold settings in case a plugin set them globally to something
" expensive. Apparently 'foldexpr' gets executed even if 'foldenable' is
" off, and then for every appended line (like with :put).
setlocal foldmethod&
setlocal foldexpr&
Separate buffer- and window-local options
2016-10-09 14:02:26 +08:00
Add mapping to toggle autoclose option The current tagbar_autoclose state will be displayed in the statusline. Also change the "hide nonpublic" flag to "v" to match the mapping and properly document the statusline flags.
2014-06-25 13:52:43 +08:00
let w:autoclose = a:autoclose
Remove redundant SetStatusLine argument, ref #335 Thank you to @jpmv27 for spotting this.
2016-09-19 19:10:10 +08:00
call s:SetStatusLine()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Move some var inits outside of win init function
2012-09-04 20:29:28 +08:00
let s:new_window = 1
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let cpoptions_save = &cpoptions
set cpoptions&vim
Better mapping init, closes #203 If someone already has a function that includes "JumpToTag" in its name then the current method of detecting whether mappings should be initialized would fail. Use a buffer-local variable instead.
2014-04-05 14:08:54 +08:00
if !exists('b:tagbar_mapped_keys')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
call s:MapKeys()
endif
let &cpoptions = cpoptions_save
Add some debug messages
2012-01-31 15:59:06 +08:00
Always properly shrink window, closes #172 Closing Tagbar with :q instead of the provided commands and mappings would bypass the Vim application window shrinking logic. Install an autocommand that checks for this situation.
2013-11-04 17:30:17 +08:00
if g:tagbar_expand
let s:expand_bufnr = bufnr('%')
endif
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('InitWindow finished')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" s:CloseWindow() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:CloseWindow() abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('CloseWindow called')
Add some debug messages
2012-01-31 15:59:06 +08:00
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if tagbarwinnr == -1
return
endif
Close preview window when closing Tagbar
2013-11-22 11:43:06 +08:00
" Close the preview window if it was opened by us
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
if s:pwin_by_tagbar
Close preview window when closing Tagbar
2013-11-22 11:43:06 +08:00
pclose
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Close preview window when closing Tagbar
2013-11-22 11:43:06 +08:00
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if winnr() == tagbarwinnr
if winbufnr(2) != -1
" Other windows are open, only close the tagbar one
Fix bug when closing window before a valid files was seen
2012-02-02 16:07:13 +08:00
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let curfile = tagbar#state#get_current_file(0)
Fix bug when closing window before a valid files was seen
2012-02-02 16:07:13 +08:00
Clean up window switching
2013-11-15 11:21:12 +08:00
close
Try to jump to the correct window after closing, closes #56
2012-01-20 10:56:50 +08:00
" Try to jump to the correct window after closing
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win('p')
Fix bug when closing window before a valid files was seen
2012-02-02 16:07:13 +08:00
if !empty(curfile)
let filebufnr = bufnr(curfile.fpath)
if bufnr('%') != filebufnr
let filewinnr = bufwinnr(filebufnr)
if filewinnr != -1
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win(filewinnr)
Fix bug when closing window before a valid files was seen
2012-02-02 16:07:13 +08:00
endif
Try to jump to the correct window after closing, closes #56
2012-01-20 10:56:50 +08:00
endif
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
else
Return to the correct window after closing Tagbar, closes #132 Since the window numbers can change when opening and closing windows Tagbar so far has used bufwinnr() to find the right window to jump back to. However, this fails if the same file is being displayed in more than one window. Save a window-local variable instead to detect the correct window to jump back to.
2013-03-24 09:16:56 +08:00
" Go to the tagbar window, close it and then come back to the original
" window. Save a win-local variable in the original window so we can
" jump back to it even if the window number changed.
Jump to correct window even after opening preview window
2014-02-01 16:17:00 +08:00
call s:mark_window()
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win(tagbarwinnr)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
close
Return to the correct window after closing Tagbar, closes #132 Since the window numbers can change when opening and closing windows Tagbar so far has used bufwinnr() to find the right window to jump back to. However, this fails if the same file is being displayed in more than one window. Save a window-local variable instead to detect the correct window to jump back to.
2013-03-24 09:16:56 +08:00
Jump to correct window even after opening preview window
2014-02-01 16:17:00 +08:00
call s:goto_markedwin()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Always properly shrink window, closes #172 Closing Tagbar with :q instead of the provided commands and mappings would bypass the Vim application window shrinking logic. Install an autocommand that checks for this situation.
2013-11-04 17:30:17 +08:00
call s:ShrinkIfExpanded()
Add some debug messages
2012-01-31 15:59:06 +08:00
Remove autocmds when not needed, closes #153 When the Tagbar window gets closed and the statusline functionality is not in use, remove the autocommands to prevent unnecessary ctags calls.
2013-07-30 07:38:46 +08:00
if s:autocommands_done && !s:statusline_in_use
Add tagbar#StopAutoUpdate This is useful to stop updating information, after using `tagbar#currenttag` manually/temporarily only.
2018-01-12 00:13:51 +08:00
call tagbar#StopAutoUpdate()
Remove autocmds when not needed, closes #153 When the Tagbar window gets closed and the statusline functionality is not in use, remove the autocommands to prevent unnecessary ctags calls.
2013-07-30 07:38:46 +08:00
endif
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('CloseWindow finished')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
Always properly shrink window, closes #172 Closing Tagbar with :q instead of the provided commands and mappings would bypass the Vim application window shrinking logic. Install an autocommand that checks for this situation.
2013-11-04 17:30:17 +08:00
" s:ShrinkIfExpanded() {{{2
" If the Vim window has been expanded, and Tagbar is not open in any other
" tabpages, shrink the window again
function! s:ShrinkIfExpanded() abort
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if !s:window_expanded || &filetype ==# 'tagbar' || s:expand_bufnr == -1
Always properly shrink window, closes #172 Closing Tagbar with :q instead of the provided commands and mappings would bypass the Vim application window shrinking logic. Install an autocommand that checks for this situation.
2013-11-04 17:30:17 +08:00
return
endif
let tablist = []
for i in range(tabpagenr('$'))
call extend(tablist, tabpagebuflist(i + 1))
endfor
if index(tablist, s:expand_bufnr) == -1
let &columns -= g:tagbar_width + 1
let s:window_expanded = 0
let s:expand_bufnr = -1
" Only restore window position if it is available and if the
" window hasn't been moved manually after the expanding
if getwinposx() != -1 &&
\ getwinposx() == s:window_pos.post.x &&
\ getwinposy() == s:window_pos.post.y
execute 'winpos ' . s:window_pos.pre.x .
\ ' ' . s:window_pos.pre.y
endif
endif
Only equalize windows after shrinking app window, closes #452
2017-12-03 11:20:52 +08:00
" The window sizes may have changed due to the shrinking happening after
" the window closing, so equalize them again.
if &equalalways
wincmd =
endif
Always properly shrink window, closes #172 Closing Tagbar with :q instead of the provided commands and mappings would bypass the Vim application window shrinking logic. Install an autocommand that checks for this situation.
2013-11-04 17:30:17 +08:00
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:ZoomWindow() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:ZoomWindow() abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if s:is_maximized
Allow configuring zoom, closes #189
2014-02-04 13:00:27 +08:00
execute 'vertical resize ' . g:tagbar_width
Restore windows properly after zooming
2013-05-20 11:18:57 +08:00
execute s:winrestcmd
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let s:is_maximized = 0
else
Restore windows properly after zooming
2013-05-20 11:18:57 +08:00
let s:winrestcmd = winrestcmd()
Allow configuring zoom, closes #189
2014-02-04 13:00:27 +08:00
if g:tagbar_zoomwidth == 1
vertical resize
elseif g:tagbar_zoomwidth == 0
let func = exists('*strdisplaywidth') ? 'strdisplaywidth' : 'strlen'
let maxline = max(map(getline(line('w0'), line('w$')),
\ func . '(v:val)'))
execute 'vertical resize ' . maxline
elseif g:tagbar_zoomwidth > 1
execute 'vertical resize ' . g:tagbar_zoomwidth
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let s:is_maximized = 1
endif
endfunction
Correct focus on startup under certain circumstances, closes #60
2012-02-23 15:42:35 +08:00
" s:CorrectFocusOnStartup() {{{2
" For whatever reason the focus will be on the Tagbar window if
" tagbar#autoopen is used with a FileType autocommand on startup and
" g:tagbar_left is set. This should work around it by jumping to the window of
" the current file after startup.
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:CorrectFocusOnStartup() abort
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
if bufwinnr(s:TagbarBufName()) != -1 && !g:tagbar_autofocus && !s:last_autofocus
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let curfile = tagbar#state#get_current_file(1)
Correct focus on startup under certain circumstances, closes #60
2012-02-23 15:42:35 +08:00
if !empty(curfile) && curfile.fpath != fnamemodify(bufname('%'), ':p')
let winnr = bufwinnr(curfile.fpath)
if winnr != -1
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win(winnr)
Correct focus on startup under certain circumstances, closes #60
2012-02-23 15:42:35 +08:00
endif
endif
endif
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Tag processing {{{1
" s:ProcessFile() {{{2
" Execute ctags and put the information into a 'FileInfo' object
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:ProcessFile(fname, ftype) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('ProcessFile called [' . a:fname . ']')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if !s:IsValidFile(a:fname, a:ftype)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Not a valid file, returning')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
Allow project-specific type config
2013-04-23 14:07:29 +08:00
let typeinfo = s:known_types[a:ftype]
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
" If the file has only been updated preserve the fold states, otherwise
" create a new entry
Reprocess files if filetype changes, closes #228
2014-11-02 12:44:25 +08:00
if s:known_files.has(a:fname) && !empty(s:known_files.get(a:fname)) &&
\ s:known_files.get(a:fname).ftype == a:ftype
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
let fileinfo = s:known_files.get(a:fname)
Allow project-specific type config
2013-04-23 14:07:29 +08:00
let typeinfo = fileinfo.typeinfo
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
call fileinfo.reset()
else
Handle non-existent project autocmds properly, closes #145
2013-05-06 14:49:19 +08:00
if exists('#TagbarProjects#User')
execute 'doautocmd <nomodeline> TagbarProjects User ' . a:fname
if exists('b:tagbar_type')
let typeinfo = extend(copy(typeinfo),
\ s:TransformUserTypeDef(b:tagbar_type))
call typeinfo.createKinddict()
endif
Allow project-specific type config
2013-04-23 14:07:29 +08:00
endif
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#prototypes#fileinfo#new(a:fname, a:ftype, typeinfo)
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
endif
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('typeinfo for file to process: ' . string(typeinfo))
Log typeinfo of newly processed file
2014-04-04 13:37:47 +08:00
Run ctags even if previous run produced erros, closes #125 If a ctags-compatible program returns an error status code on a parsing failure then it would never be run again on the same file, even if later invocations would have returned normally (for example after fixing an error in the current file). Therefore we need to execute the program on updates as usual, but do not repeat error messages if the previous run already did.
2013-02-26 16:56:12 +08:00
" Use a temporary files for ctags processing instead of the original one.
" This allows using Tagbar for files accessed with netrw, and also doesn't
" slow down Tagbar for files that sit on slow network drives.
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
let tempfile = tempname()
Only determine extension once
2012-08-01 17:08:49 +08:00
let ext = fnamemodify(fileinfo.fpath, ':e')
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ext !=# ''
Only determine extension once
2012-08-01 17:08:49 +08:00
let tempfile .= '.' . ext
Add extension to temporary files
2012-07-31 12:50:55 +08:00
endif
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
Ease debuggin When debug is enabled - add verbose flag to ctags - don't remove temp files - log the temporary file created
2017-09-21 21:17:41 +08:00
call tagbar#debug#log('Caching file into: ' . tempfile)
let templines = getbufline(fileinfo.bufnr, 1, '$')
let res = writefile(templines, tempfile)
if res != 0
call tagbar#debug#log('Could not create copy '.tempfile)
return
endif
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
let fileinfo.mtime = getftime(tempfile)
Allow project-specific type config
2013-04-23 14:07:29 +08:00
let ctags_output = s:ExecuteCtagsOnFile(tempfile, a:fname, typeinfo)
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
Ease debuggin When debug is enabled - add verbose flag to ctags - don't remove temp files - log the temporary file created
2017-09-21 21:17:41 +08:00
if !tagbar#debug#enabled()
call delete(tempfile)
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if ctags_output == -1
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Ctags error when processing file')
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
" Put an empty entry into known_files so the error message is only
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" shown once
call s:known_files.put({}, a:fname)
return
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
elseif ctags_output ==# ''
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Ctags output empty')
Save new empty object for file if ctags output is empty, closes #57
2012-01-31 19:21:28 +08:00
" No need to go through the tag processing if there are no tags, and
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
" preserving the old fold state isn't necessary either
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call s:known_files.put(tagbar#prototypes#fileinfo#new(a:fname, a:ftype,
Allow project-specific type config
2013-04-23 14:07:29 +08:00
\ s:known_types[a:ftype]), a:fname)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Filetype tag kinds: ' . string(keys(typeinfo.kinddict)))
Improve out-of-sync error reporting
2013-02-04 10:10:06 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Parse the ctags output lines
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Parsing ctags output')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let rawtaglist = split(ctags_output, '\n\+')
Fix issue where --regex based file types can output duplicate lines when --sort=no (#471) Fix issue where --regex based filetypes can output duplicate lines when --sort=no Co-authored-by: Flemming Madsen <flemming@themadsens.dk>
2019-10-21 21:19:45 +08:00
let seen = {}
Move most of script to autoload
2011-06-29 04:59:49 +08:00
for line in rawtaglist
Fix issue where --regex based file types can output duplicate lines when --sort=no (#471) Fix issue where --regex based filetypes can output duplicate lines when --sort=no Co-authored-by: Flemming Madsen <flemming@themadsens.dk>
2019-10-21 21:19:45 +08:00
" skip comments and duplicates (can happen when --sort=no)
if line =~# '^!_TAG_' || has_key(seen, line)
Skip comments in ctags output
2011-12-12 14:47:59 +08:00
continue
endif
Fix issue where --regex based file types can output duplicate lines when --sort=no (#471) Fix issue where --regex based filetypes can output duplicate lines when --sort=no Co-authored-by: Flemming Madsen <flemming@themadsens.dk>
2019-10-21 21:19:45 +08:00
let seen[line] = 1
Skip comments in ctags output
2011-12-12 14:47:59 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let parts = split(line, ';"')
if len(parts) == 2 " Is a valid tag line
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
call s:ParseTagline(parts[0], parts[1], typeinfo, fileinfo)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
endfor
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
" Create a placeholder tag for the 'kind' header for folding purposes, but
" only for non-scoped tags
Move most of script to autoload
2011-06-29 04:59:49 +08:00
for kind in typeinfo.kinds
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
if has_key(get(typeinfo, 'kind2scope', {}), kind.short)
continue
endif
Add debugging functionality
2011-12-12 14:47:43 +08:00
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
let curtags = filter(copy(fileinfo.getTags()),
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
\ 'v:val.fields.kind ==# kind.short && ' .
\ '!has_key(v:val, "scope")')
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Processing kind: ' . kind.short .
Rename debug log function
2014-04-03 19:39:26 +08:00
\ ', number of tags: ' . len(curtags))
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if empty(curtags)
continue
endif
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let kindtag = tagbar#prototypes#kindheadertag#new(kind.long)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let kindtag.short = kind.short
let kindtag.numtags = len(curtags)
let kindtag.fileinfo = fileinfo
for tag in curtags
let tag.parent = kindtag
endfor
endfor
Add debugging functionality
2011-12-12 14:47:43 +08:00
" Clear old folding information from previous file version to prevent leaks
Move most of script to autoload
2011-06-29 04:59:49 +08:00
call fileinfo.clearOldFolds()
" Sort the tags
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call fileinfo.sortTags(typeinfo)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
call s:known_files.put(fileinfo)
endfunction
" s:ExecuteCtagsOnFile() {{{2
Allow project-specific type config
2013-04-23 14:07:29 +08:00
function! s:ExecuteCtagsOnFile(fname, realfname, typeinfo) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('ExecuteCtagsOnFile called [' . a:fname . ']')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Allow project-specific type config
2013-04-23 14:07:29 +08:00
if has_key(a:typeinfo, 'ctagsargs') && type(a:typeinfo.ctagsargs) == type('')
" if ctagsargs is a string, prepend and append space separators
let ctags_args = ' ' . a:typeinfo.ctagsargs . ' '
elseif has_key(a:typeinfo, 'ctagsargs') && type(a:typeinfo.ctagsargs) == type([])
let ctags_args = a:typeinfo.ctagsargs
" otherwise ctagsargs is not defined or not defined as a valid type
Move most of script to autoload
2011-06-29 04:59:49 +08:00
else
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
"Prefer constructing ctags_args as a list rather than a string
"See s:EscapeCtagsCmd() - It's a best practice to shellescape()
"each arg separately because in special cases where space is
"intended to be in an argument, spaces in a single ctag_args
"string would be ambiguous. Is the space an argument separator
"or to be included in the argument
Accept a list, allowing 'NONE' to avoid duplicates
2018-02-04 09:14:37 +08:00
let ctags_args = []
if exists('g:tagbar_ctags_options')
for value in g:tagbar_ctags_options
Revert emergency fix, not actually broken; closes #550 There is no spoon. My testing last night was flawed because I had a typo in my RC file that was complicating matters. In seems the syntax fix was all this needed to work okay, not disabling the feature
2019-10-22 15:15:27 +08:00
call add(ctags_args, '--options='.value)
Accept a list, allowing 'NONE' to avoid duplicates
2018-02-04 09:14:37 +08:00
endfor
Fix syntax bug introduced in merged PR #476 and emergency backtrack
2019-10-22 00:53:56 +08:00
endif
Arrange (u)ctag argument order to not clobber others (#560)
2019-10-26 02:44:37 +08:00
" universal-ctags deprecated this argument name
if s:ctags_is_uctags
let ctags_args += [ '--extras=' ]
else
let ctags_args += [ '--extra=' ]
endif
Accept a list, allowing 'NONE' to avoid duplicates
2018-02-04 09:14:37 +08:00
let ctags_args = ctags_args + [
\ '-f',
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
\ '-',
\ '--format=2',
\ '--excmd=pattern',
add '-' flag before static functions in c
2014-12-20 14:08:39 +08:00
\ '--fields=nksSaf',
Fix file-scope tags in uctags, closes #314
2016-09-12 08:37:19 +08:00
\ '--file-scope=yes',
specify a option is disable append mode Because append mode is not allow that to output result on stdout.
2014-05-01 13:33:31 +08:00
\ '--sort=no',
\ '--append=no'
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
\ ]
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Ease debuggin When debug is enabled - add verbose flag to ctags - don't remove temp files - log the temporary file created
2017-09-21 21:17:41 +08:00
" verbose if debug enabled
if tagbar#debug#enabled()
let ctags_args += [ '-V' ]
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Include extra type definitions
Allow project-specific type config
2013-04-23 14:07:29 +08:00
if has_key(a:typeinfo, 'deffile')
Expand deffile path
2013-04-30 06:12:02 +08:00
let ctags_args += ['--options=' . expand(a:typeinfo.deffile)]
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Don't assume all types define 'ctagstype'
2014-10-27 17:37:17 +08:00
" Third-party programs may not necessarily make use of this
if has_key(a:typeinfo, 'ctagstype')
let ctags_type = a:typeinfo.ctagstype
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Don't assume all types define 'ctagstype'
2014-10-27 17:37:17 +08:00
let ctags_kinds = ''
for kind in a:typeinfo.kinds
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
if kind.short !=# '?'
let ctags_kinds .= kind.short
endif
Don't assume all types define 'ctagstype'
2014-10-27 17:37:17 +08:00
endfor
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Don't assume all types define 'ctagstype'
2014-10-27 17:37:17 +08:00
let ctags_args += ['--language-force=' . ctags_type]
let ctags_args += ['--' . ctags_type . '-kinds=' . ctags_kinds]
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Allow project-specific type config
2013-04-23 14:07:29 +08:00
if has_key(a:typeinfo, 'ctagsbin')
Temporarily reset 'wildignore' when calling expand()
2011-10-15 13:48:29 +08:00
" reset 'wildignore' temporarily in case *.exe is included in it
let wildignore_save = &wildignore
set wildignore&
Allow project-specific type config
2013-04-23 14:07:29 +08:00
let ctags_bin = expand(a:typeinfo.ctagsbin)
Temporarily reset 'wildignore' when calling expand()
2011-10-15 13:48:29 +08:00
let &wildignore = wildignore_save
Move most of script to autoload
2011-06-29 04:59:49 +08:00
else
let ctags_bin = g:tagbar_ctags_bin
endif
let ctags_cmd = s:EscapeCtagsCmd(ctags_bin, ctags_args, a:fname)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ctags_cmd ==# ''
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return ''
endif
let ctags_output = s:ExecuteCtags(ctags_cmd)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if v:shell_error || ctags_output =~? 'Warning: cannot open source file'
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Command output:')
call tagbar#debug#log(ctags_output)
call tagbar#debug#log('Exit code: ' . v:shell_error)
Don't disrupt the statusline if ctags fails
2013-03-23 14:46:14 +08:00
" Only display an error message if the Tagbar window is open and we
" haven't seen the error before.
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
if bufwinnr(s:TagbarBufName()) != -1 &&
Don't disrupt the statusline if ctags fails
2013-03-23 14:46:14 +08:00
\ (!s:known_files.has(a:realfname) ||
\ !empty(s:known_files.get(a:realfname)))
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
call s:warning('Tagbar: Could not execute ctags for ' . a:realfname . '!')
Run ctags even if previous run produced erros, closes #125 If a ctags-compatible program returns an error status code on a parsing failure then it would never be run again on the same file, even if later invocations would have returned normally (for example after fixing an error in the current file). Therefore we need to execute the program on updates as usual, but do not repeat error messages if the previous run already did.
2013-02-26 16:56:12 +08:00
echomsg 'Executed command: "' . ctags_cmd . '"'
if !empty(ctags_output)
echomsg 'Command output:'
for line in split(ctags_output, '\n')
echomsg line
endfor
endif
Print exit code when failing to run ctags
2016-10-21 12:43:35 +08:00
echomsg 'Exit code: ' . v:shell_error
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
return -1
endif
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Ctags executed successfully')
call tagbar#debug#log_ctags_output(ctags_output)
Save ctags output in separate file when debugging
2017-02-11 12:40:24 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return ctags_output
endfunction
" s:ParseTagline() {{{2
" Structure of a tag line:
" tagname<TAB>filename<TAB>expattern;"fields
" fields: <TAB>name:value
" fields that are always present: kind, line
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:ParseTagline(part1, part2, typeinfo, fileinfo) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let basic_info = split(a:part1, '\t')
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let tagname = basic_info[0]
let filename = basic_info[1]
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" the pattern can contain tabs and thus may have been split up, so join
" the rest of the items together again
let pattern = join(basic_info[2:], "\t")
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if pattern[0] ==# '/'
Fix tag jumping if tag pattern is not actually a pattern Closes #439 References jstemmer/gotags#31
2017-09-03 16:36:07 +08:00
let start = 2 " skip the slash and the ^
let end = strlen(pattern) - 1
if pattern[end - 1] ==# '$'
let end -= 1
let dollar = '\$'
else
let dollar = ''
endif
let pattern = '\V\^\C' . strpart(pattern, start, end - start) . dollar
Move most of script to autoload
2011-06-29 04:59:49 +08:00
else
Fix tag jumping if tag pattern is not actually a pattern Closes #439 References jstemmer/gotags#31
2017-09-03 16:36:07 +08:00
let pattern = ''
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Handle invalid fields gracefully
2012-09-15 23:03:11 +08:00
" When splitting fields make sure not to create empty keys or values in
" case a value illegally contains tabs
let fields = split(a:part2, '^\t\|\t\ze\w\+:')
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let fielddict = {}
Support 'kind' field with name, ref #254
2015-03-17 14:35:42 +08:00
if fields[0] !~# ':'
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let fielddict.kind = remove(fields, 0)
Support 'kind' field with name, ref #254
2015-03-17 14:35:42 +08:00
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
for field in fields
" can't use split() since the value can contain ':'
Move default column definition into tag init function
2012-03-16 18:51:35 +08:00
let delimit = stridx(field, ':')
Handle invalid fields gracefully
2012-09-15 23:03:11 +08:00
let key = strpart(field, 0, delimit)
" Remove all tabs that may illegally be in the value
let val = substitute(strpart(field, delimit + 1), '\t', '', 'g')
add '-' flag before static functions in c
2014-12-20 14:08:39 +08:00
" File-restricted scoping
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if key ==# 'file'
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let fielddict[key] = 'yes'
add '-' flag before static functions in c
2014-12-20 14:08:39 +08:00
endif
Fix bug when scope field exists but is empty
2011-12-13 13:24:24 +08:00
if len(val) > 0
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if key ==# 'line' || key ==# 'column'
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let fielddict[key] = str2nr(val)
Try to distinguish between equal alternative tags, closes #139
2013-04-29 12:49:17 +08:00
else
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let fielddict[key] = val
Try to distinguish between equal alternative tags, closes #139
2013-04-29 12:49:17 +08:00
endif
Fix bug when scope field exists but is empty
2011-12-13 13:24:24 +08:00
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfor
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
" If the tag covers multiple scopes, split it up and create individual tags
" for each scope so that the hierarchy can be displayed correctly.
" This can happen with PHP's 'namespace' tags in uctags, for example.
if has_key(a:typeinfo, 'kind2scope') && has_key(a:typeinfo.kind2scope, fielddict.kind)
\ && tagname =~# '\V' . escape(a:typeinfo.sro, '\')
let tagparts = split(tagname, '\V' . escape(a:typeinfo.sro, '\'))
let scope = a:typeinfo.kind2scope[fielddict.kind]
if has_key(fielddict, scope)
let parent = fielddict[scope]
else
let parent = ''
endif
let curfielddict = fielddict
for i in range(len(tagparts))
let part = tagparts[i]
call s:ProcessTag(part, filename, pattern, curfielddict,
\ i != len(tagparts) - 1, a:typeinfo, a:fileinfo)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if parent !=# ''
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let parent = parent . a:typeinfo.sro . part
else
let parent = part
endif
let curfielddict = copy(fielddict)
let curfielddict[scope] = parent
endfor
else
call s:ProcessTag(tagname, filename, pattern, fielddict, 0,
\ a:typeinfo, a:fileinfo)
endif
endfunction
" s:ProcessTag() {{{2
Fix issue where --regex based file types can output duplicate lines when --sort=no (#471) Fix issue where --regex based filetypes can output duplicate lines when --sort=no Co-authored-by: Flemming Madsen <flemming@themadsens.dk>
2019-10-21 21:19:45 +08:00
function! s:ProcessTag(name, filename, pattern, fields, is_split, typeinfo, fileinfo) abort
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
if a:is_split
let taginfo = tagbar#prototypes#splittag#new(a:name)
else
let taginfo = tagbar#prototypes#normaltag#new(a:name)
endif
let taginfo.file = a:filename
let taginfo.pattern = a:pattern
call extend(taginfo.fields, a:fields)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Needed for jsctags
if has_key(taginfo.fields, 'lineno')
Try to distinguish between equal alternative tags, closes #139
2013-04-29 12:49:17 +08:00
let taginfo.fields.line = str2nr(taginfo.fields.lineno)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Handle invalid ctags line numbers, closes #119
2013-09-19 08:36:41 +08:00
" Do some sanity checking in case ctags reports invalid line numbers
if taginfo.fields.line < 0
let taginfo.fields.line = 0
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Support 'kind' field with name, ref #254
2015-03-17 14:35:42 +08:00
if !has_key(taginfo.fields, 'kind')
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
call tagbar#debug#log(
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
\ "Warning: No 'kind' field found for tag " . a:name[0] . '!')
Support 'kind' field with name, ref #254
2015-03-17 14:35:42 +08:00
if index(s:warnings.type, a:typeinfo.ftype) == -1
Fix variable scope issues revealed by vint
2019-10-22 22:58:37 +08:00
call s:warning("No 'kind' field found for tag " . a:name[0] . '!' .
Support 'kind' field with name, ref #254
2015-03-17 14:35:42 +08:00
\ " Please read the last section of ':help tagbar-extend'.")
call add(s:warnings.type, a:typeinfo.ftype)
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
return
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
let taginfo.fileinfo = a:fileinfo
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
let taginfo.typeinfo = a:typeinfo
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
let a:fileinfo.fline[taginfo.fields.line] = taginfo
" If this filetype doesn't have any scope information then we can stop
" here after adding the tag to the list
if !has_key(a:typeinfo, 'scope2kind')
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
call a:fileinfo.addTag(taginfo)
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
return
endif
" Make some information easier accessible
for scope in keys(a:typeinfo.scope2kind)
if has_key(taginfo.fields, scope)
let taginfo.scope = scope
let taginfo.path = taginfo.fields[scope]
let taginfo.fullpath = taginfo.path . a:typeinfo.sro .
\ taginfo.name
break
endif
endfor
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let pathlist = split(taginfo.path, '\V' . escape(a:typeinfo.sro, '\'))
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
let taginfo.depth = len(pathlist)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Needed for folding
try
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call taginfo.initFoldState(s:known_files)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
catch /^Vim(\a\+):E716:/ " 'Key not present in Dictionary'
" The tag has a 'kind' that doesn't exist in the type definition
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Warning: Unknown tag kind: ' . taginfo.fields.kind)
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
if index(s:warnings.type, a:typeinfo.ftype) == -1
call s:warning('Unknown tag kind encountered: ' .
\ '"' . taginfo.fields.kind . '".' .
\ ' Your ctags and Tagbar configurations are out of sync!' .
\ ' Please read '':help tagbar-extend''.')
call add(s:warnings.type, a:typeinfo.ftype)
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
return
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endtry
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
call s:add_tag_recursive({}, taginfo, pathlist)
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
endfunction
" s:add_tag_recursive() {{{2
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
" Add a tag recursively as a child of its parent, or if there is no parent, to
" the root tag list in the fileinfo object.
function! s:add_tag_recursive(parent, taginfo, pathlist) abort
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
" If the pathlist is empty we are at the correct scope for the current tag
if empty(a:pathlist)
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
" If a child tag got processed before a parent tag then there will
" be a pseudotag here as a placeholder. Copy the children over and
" then replace the pseudotag with the real one.
let pseudotags = []
if empty(a:parent)
let name_siblings = a:taginfo.fileinfo.getTagsByName(a:taginfo.name)
else
let name_siblings = a:parent.getChildrenByName(a:taginfo.name)
endif
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
" Consider a tag as replaceable if the current tag is considered to
" have more appropriate information
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
for tag in name_siblings
if (tag.fields.kind ==# '?'
\ || tag.fields.kind ==# a:taginfo.fields.kind)
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
\ && (tag.isPseudoTag()
\ || (!a:taginfo.isSplitTag() && tag.isSplitTag()))
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
call add(pseudotags, tag)
endif
endfor
if len(pseudotags) == 1
let pseudotag = pseudotags[0]
for child in pseudotag.getChildren()
call a:taginfo.addChild(child)
let child.parent = a:taginfo
endfor
if empty(a:parent)
call a:taginfo.fileinfo.removeTag(pseudotag)
else
call a:parent.removeChild(pseudotag)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
elseif len(pseudotags) > 1
echoerr 'Tagbar: Found duplicate pseudotag; this should never happen!'
\ 'Please contact the script maintainer with an example.'
\ 'Pseudotag name:' pseudotag.name
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
" If this is a tag that got created due to splitting up a tag name,
" don't replace existing tags of the same kind.
if a:taginfo.isSplitTag()
for tag in name_siblings
if tag.fields.kind ==# a:taginfo.fields.kind
return
endif
endfor
endif
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
if empty(a:parent)
call a:taginfo.fileinfo.addTag(a:taginfo)
else
call a:parent.addChild(a:taginfo)
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
let a:taginfo.parent = a:parent
endif
return
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
" There is still at least one more scope between the current one and the
" one of the current tag, so we have to either find or create the
" intermediate tags
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
let grandparent = a:parent
let parentname = remove(a:pathlist, 0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
if empty(grandparent)
let name_siblings = a:taginfo.fileinfo.getTagsByName(parentname)
else
let name_siblings = grandparent.getChildrenByName(parentname)
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
if empty(a:pathlist)
" If the current tag is a direct child of the parent we're looking for
" then we can also filter the parents based on the scope information
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
let parents = []
for tag in name_siblings
if tag.fields.kind ==# '?'
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
\ || get(a:taginfo.typeinfo.kind2scope, tag.fields.kind, '') ==# a:taginfo.scope
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
call add(parents, tag)
endif
endfor
else
let parents = name_siblings
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
if empty(parents)
" No parents found, so either the parent is a pseudotag or it hasn't
" been processed yet. Create a pseudotag as a placeholder; if the
" actual parent gets processed later it will get replaced.
if empty(a:pathlist)
let pseudokind = a:taginfo.typeinfo.scope2kind[a:taginfo.scope]
else
let pseudokind = '?'
endif
let parent = s:create_pseudotag(parentname, grandparent,
\ pseudokind, a:taginfo.typeinfo, a:taginfo.fileinfo)
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
if empty(grandparent)
call a:taginfo.fileinfo.addTag(parent)
else
call grandparent.addChild(parent)
endif
Handle cases where parent is below child tag, closes #396
2017-02-12 16:39:13 +08:00
elseif len(parents) == 1
let parent = parents[0]
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
else
" If there are multiple possible parents (c.f. issue #139, or tags
" with the same name but a different kind) then we will pick the one
" that is closest above the current tag as a heuristic.
" Start at line 0 so that pseudotags get included
let minline = 0
for candidate in parents
Short-circuit parent searches if tag doesn't have line number
2017-06-15 13:27:30 +08:00
" If the line number of the current tag is 0 then we have no way
" of determining the best candidate by comparing line numbers.
" Just use the first one we have.
if a:taginfo.fields.line == 0
let parent = candidate
break
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
if candidate.fields.line <= a:taginfo.fields.line &&
\ candidate.fields.line >= minline
let parent = candidate
let minline = candidate.fields.line
endif
endfor
Handle cases where parent is below child tag, closes #396
2017-02-12 16:39:13 +08:00
if !exists('parent')
" If we still haven't found a parent it must be below the current
" tag, so find the closest parent below the tag. This can happen
" for example in Go.
let maxline = line('$')
for candidate in parents
if candidate.fields.line >= a:taginfo.fields.line &&
\ candidate.fields.line <= maxline
let parent = candidate
let maxline = candidate.fields.line
endif
endfor
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
" If the parent is a pseudotag it may have gotten created as an in-between
" tag without proper information about its kind because all if its
" children are also pseudotags, so it may be incorrect. If the current tag
" is a direct child of a pseudotag then we can derive the correct kind, so
" replace it if necessary.
if parent.isPseudoTag() && empty(a:pathlist)
let parentkind = a:taginfo.typeinfo.scope2kind[a:taginfo.scope]
if parent.fields.kind ==# '?' || parentkind !=# parent.fields.kind
let parent.fields.kind = parentkind
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call parent.initFoldState(s:known_files)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
call s:add_tag_recursive(parent, a:taginfo, a:pathlist)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
" s:create_pseudotag() {{{2
function! s:create_pseudotag(name, parent, kind, typeinfo, fileinfo) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if !empty(a:parent)
let curpath = a:parent.fullpath
Don't error on incorrect ctags scope info, ref #397
2017-02-18 11:32:30 +08:00
" If the kind is not present in the kind2scope dictionary, return an
" empty scope. This can happen due to incorrect ctags output as in #397.
let pscope = get(a:typeinfo.kind2scope, a:parent.fields.kind, '')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
else
let curpath = ''
let pscope = ''
endif
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let pseudotag = tagbar#prototypes#pseudotag#new(a:name)
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
let pseudotag.fields.kind = a:kind
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Escape tag name when removing it from a pseudo tag's scope path
2017-06-15 13:28:33 +08:00
let parentscope = substitute(curpath, '\V' . a:name . '$', '', '')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let parentscope = substitute(parentscope,
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
\ '\V\^' . escape(a:typeinfo.sro, '\') . '\$', '', '')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if pscope !=# ''
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let pseudotag.fields[pscope] = parentscope
let pseudotag.scope = pscope
let pseudotag.path = parentscope
let pseudotag.fullpath =
\ pseudotag.path . a:typeinfo.sro . pseudotag.name
endif
Handle tags that cover multiple scopes correctly References: #430
2017-08-20 16:07:34 +08:00
let pseudotag.depth = len(split(pseudotag.path, '\V' . escape(a:typeinfo.sro, '\')))
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let pseudotag.parent = a:parent
let pseudotag.fileinfo = a:fileinfo
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
let pseudotag.typeinfo = a:typeinfo
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call pseudotag.initFoldState(s:known_files)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return pseudotag
endfunction
" s:ToggleSort() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:ToggleSort() abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if empty(fileinfo)
return
endif
Keep cursor on current tag when sorting, closes #200
2014-03-21 20:09:30 +08:00
" Save the tag the cursor is currently on
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let curline = line('.')
Keep cursor on current tag when sorting, closes #200
2014-03-21 20:09:30 +08:00
let taginfo = s:GetTagInfo(curline, 0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
match none
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let compare_typeinfo = s:known_types[fileinfo.ftype]
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
if has_key(compare_typeinfo, 'sort')
let compare_typeinfo.sort = !compare_typeinfo.sort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
else
let g:tagbar_sort = !g:tagbar_sort
endif
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call fileinfo.sortTags(compare_typeinfo)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
call s:RenderContent()
Remove redundant SetStatusLine argument, ref #335 Thank you to @jpmv27 for spotting this.
2016-09-19 19:10:10 +08:00
call s:SetStatusLine()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Keep cursor on current tag when sorting, closes #200
2014-03-21 20:09:30 +08:00
" If we were on a tag before sorting then jump to it, otherwise restore
" the cursor to the current line
if !empty(taginfo)
execute taginfo.tline
else
execute curline
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" Display {{{1
" s:RenderContent() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:RenderContent(...) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('RenderContent called')
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
let s:new_window = 0
Add debugging functionality
2011-12-12 14:47:43 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if a:0 == 1
let fileinfo = a:1
else
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
if empty(fileinfo)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Empty fileinfo, returning')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if &filetype ==# 'tagbar'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let in_tagbar = 1
else
let in_tagbar = 0
Small cleanup of last patch
2013-02-06 12:07:27 +08:00
let prevwinnr = winnr()
Do not interfere window switching history Many plugins rely on 'wincmd p' to work properly, we need to preserve at least one-level backwards window switching history.
2012-11-10 03:52:04 +08:00
" Get the previous window number, so that we can reproduce
" the window entering history later. Do not run autocmd on
" this command, make sure nothing is interfering.
Clean up window switching
2013-11-15 11:21:12 +08:00
" let pprevwinnr = winnr('#') " Messes up windows for some reason
call s:goto_win('p', 1)
Small cleanup of last patch
2013-02-06 12:07:27 +08:00
let pprevwinnr = winnr()
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win(tagbarwinnr, 1)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
if !empty(tagbar#state#get_current_file(0)) &&
\ fileinfo.fpath ==# tagbar#state#get_current_file(0).fpath
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" We're redisplaying the same file, so save the view
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Redisplaying file [' . fileinfo.fpath . ']')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let saveline = line('.')
let savecol = col('.')
let topline = line('w0')
endif
let lazyredraw_save = &lazyredraw
set lazyredraw
let eventignore_save = &eventignore
set eventignore=all
setlocal modifiable
silent %delete _
call s:PrintHelp()
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
let typeinfo = fileinfo.typeinfo
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
if !empty(fileinfo.getTags())
Print message if no tags have been found in file
2013-08-24 13:57:33 +08:00
" Print tags
call s:PrintKinds(typeinfo, fileinfo)
else
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('No tags found, skipping printing.')
Print message if no tags have been found in file
2013-08-24 13:57:33 +08:00
if g:tagbar_compact && s:short_help
silent 0put ='\" No tags found.'
else
silent put ='\" No tags found.'
endif
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Delete empty lines at the end of the buffer
for linenr in range(line('$'), 1, -1)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if getline(linenr) =~# '^$'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
execute 'silent ' . linenr . 'delete _'
else
break
endif
endfor
setlocal nomodifiable
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
if !empty(tagbar#state#get_current_file(0)) &&
\ fileinfo.fpath ==# tagbar#state#get_current_file(0).fpath
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let scrolloff_save = &scrolloff
set scrolloff=0
call cursor(topline, 1)
normal! zt
call cursor(saveline, savecol)
let &scrolloff = scrolloff_save
else
" Make sure as much of the Tagbar content as possible is shown in the
" window by jumping to the top after drawing
execute 1
call winline()
Don't highlight the same tag again, closes #36
2011-10-02 17:39:39 +08:00
" Invalidate highlight cache from old file
let s:last_highlight_tline = 0
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
let &lazyredraw = lazyredraw_save
let &eventignore = eventignore_save
if !in_tagbar
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win(pprevwinnr, 1)
call s:goto_win(prevwinnr, 1)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
endfunction
" s:PrintKinds() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:PrintKinds(typeinfo, fileinfo) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('PrintKinds called')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
" If the short or long help is being displayed then the line numbers don't
" match up with the length of the output list
let offset = g:tagbar_compact && s:short_help ? 0 : line('.')
let output = []
Move most of script to autoload
2011-06-29 04:59:49 +08:00
for kind in a:typeinfo.kinds
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
let curtags = filter(copy(a:fileinfo.getTags()),
Move most of script to autoload
2011-06-29 04:59:49 +08:00
\ 'v:val.fields.kind ==# kind.short')
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Printing kind: ' . kind.short .
Rename debug log function
2014-04-03 19:39:26 +08:00
\ ', number of (top-level) tags: ' . len(curtags))
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if empty(curtags)
continue
endif
Rewrite tree construction algorithm The current algorithm for contructing the tag tree works pretty well even when pseudo-tags are encountered, but is quite complex, hard to understand, and hard to tweak and optimize. This commit rewrites the algorithm to a relatively straight-forward recursive algorithm that makes use of placeholder pseudo-tags if required that will get replaced if the actual tag is encountered later.
2017-01-29 13:22:41 +08:00
if has_key(get(a:typeinfo, 'kind2scope', {}), kind.short)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Scoped tags
for tag in curtags
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
call s:PrintTag(tag, 0, output, a:fileinfo, a:typeinfo)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if !g:tagbar_compact
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
call add(output, '')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
endfor
else
" Non-scoped tags
let kindtag = curtags[0].parent
if kindtag.isFolded()
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let foldmarker = g:tagbar#icon_closed
Move most of script to autoload
2011-06-29 04:59:49 +08:00
else
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let foldmarker = g:tagbar#icon_open
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Make visibility symbols optional
2012-11-22 13:42:14 +08:00
let padding = g:tagbar_show_visibility ? ' ' : ''
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
call add(output, foldmarker . padding . kind.long)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
let curline = len(output) + offset
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let kindtag.tline = curline
let a:fileinfo.tline[curline] = kindtag
if !kindtag.isFolded()
for tag in curtags
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
let str = tag.strfmt()
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
call add(output, repeat(' ', g:tagbar_indent) . str)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Save the current tagbar line in the tag for easy
" highlighting access
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
let curline = len(output) + offset
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let tag.tline = curline
let a:fileinfo.tline[curline] = tag
let tag.depth = 1
endfor
endif
if !g:tagbar_compact
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
call add(output, '')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
endif
endfor
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
let outstr = join(output, "\n")
if g:tagbar_compact && s:short_help
silent 0put =outstr
else
silent put =outstr
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" s:PrintTag() {{{2
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
function! s:PrintTag(tag, depth, output, fileinfo, typeinfo) abort
Allow hiding non-public tags, closes #186
2014-02-05 13:08:04 +08:00
if g:tagbar_hide_nonpublic &&
\ get(a:tag.fields, 'access', 'public') !=# 'public'
let a:tag.tline = -1
return
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Print tag indented according to depth
Allow hiding non-public tags, closes #186
2014-02-05 13:08:04 +08:00
let tagstr = repeat(' ', a:depth * g:tagbar_indent) . a:tag.strfmt()
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
call add(a:output, tagstr)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Allow hiding non-public tags, closes #186
2014-02-05 13:08:04 +08:00
" Save the current tagbar line in the tag for easy highlighting access
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
let offset = g:tagbar_compact && s:short_help ? 0 : line('.')
let curline = len(a:output) + offset
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let a:tag.tline = curline
let a:fileinfo.tline[curline] = a:tag
" Recursively print children
if a:tag.isFoldable() && !a:tag.isFolded()
Display 'kind' headers inside of scopes
2011-11-24 14:22:31 +08:00
for ckind in a:typeinfo.kinds
Allow hiding non-public tags, closes #186
2014-02-05 13:08:04 +08:00
let childfilter = 'v:val.fields.kind ==# ckind.short'
if g:tagbar_hide_nonpublic
let childfilter .=
\ ' && get(v:val.fields, "access", "public") ==# "public"'
endif
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
let childtags = filter(copy(a:tag.getChildren()), childfilter)
Display 'kind' headers inside of scopes
2011-11-24 14:22:31 +08:00
if len(childtags) > 0
Don't handle sub-kind headers as tags
2012-02-28 17:10:16 +08:00
" Print 'kind' header of following children, but only if they
" are not scope-defining tags (since those already have an
" identifier)
Display 'kind' headers inside of scopes
2011-11-24 14:22:31 +08:00
if !has_key(a:typeinfo.kind2scope, ckind.short)
Fix header indentation
2013-02-13 18:34:17 +08:00
let indent = (a:depth + 1) * g:tagbar_indent
Make visibility symbols optional
2012-11-22 13:42:14 +08:00
let indent += g:tagbar_show_visibility
let indent += 1 " fold symbol
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
call add(a:output, repeat(' ', indent) . '[' . ckind.long . ']')
Create sub-kind headers as base tags to allow folding of parents
2012-02-28 17:45:11 +08:00
" Add basic tag to allow folding when on the header line
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let headertag = tagbar#prototypes#basetag#new(ckind.long)
Create sub-kind headers as base tags to allow folding of parents
2012-02-28 17:45:11 +08:00
let headertag.parent = a:tag
let headertag.fileinfo = a:tag.fileinfo
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
let a:fileinfo.tline[len(a:output) + offset] = headertag
Display 'kind' headers inside of scopes
2011-11-24 14:22:31 +08:00
endif
for childtag in childtags
Print tags in one go to improve performance Assembling the tag information in a list and then printing it with one ":put" command is more efficient then calling :put for every line.
2017-01-14 13:35:04 +08:00
call s:PrintTag(childtag, a:depth + 1, a:output,
Display 'kind' headers inside of scopes
2011-11-24 14:22:31 +08:00
\ a:fileinfo, a:typeinfo)
endfor
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfor
endif
endfunction
" s:PrintHelp() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:PrintHelp() abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if !g:tagbar_compact && s:short_help
Replace help mapping in short help, closes #245
2015-01-26 07:37:53 +08:00
silent 0put ='\" Press ' . s:get_map_str('help') . ' for help'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
silent put _
elseif !s:short_help
silent 0put ='\" Tagbar keybindings'
silent put ='\"'
silent put ='\" --------- General ---------'
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
silent put ='\" ' . s:get_map_str('jump') . ': Jump to tag definition'
silent put ='\" ' . s:get_map_str('preview') . ': As above, but stay in'
silent put ='\" Tagbar window'
Add key to show tag in preview window
2013-11-10 19:53:45 +08:00
silent put ='\" ' . s:get_map_str('previewwin') . ': Show tag in preview window'
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
silent put ='\" ' . s:get_map_str('nexttag') . ': Go to next top-level tag'
silent put ='\" ' . s:get_map_str('prevtag') . ': Go to previous top-level tag'
silent put ='\" ' . s:get_map_str('showproto') . ': Display tag prototype'
Add documentation for hide_nonpublic Also indicate in the statusline if non-public tags are currently hidden.
2014-02-10 12:10:43 +08:00
silent put ='\" ' . s:get_map_str('hidenonpublic') . ': Hide non-public tags'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
silent put ='\"'
silent put ='\" ---------- Folds ----------'
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
silent put ='\" ' . s:get_map_str('openfold') . ': Open fold'
silent put ='\" ' . s:get_map_str('closefold') . ': Close fold'
silent put ='\" ' . s:get_map_str('togglefold') . ': Toggle fold'
silent put ='\" ' . s:get_map_str('openallfolds') . ': Open all folds'
silent put ='\" ' . s:get_map_str('closeallfolds') . ': Close all folds'
Add ability to open or close folds a single level
2017-07-26 22:18:18 +08:00
silent put ='\" ' . s:get_map_str('incrementfolds') . ': Increment fold level by 1'
silent put ='\" ' . s:get_map_str('decrementfolds') . ': Decrement fold level by 1'
Add mappings for moving through folds, closes #224
2014-11-09 12:33:42 +08:00
silent put ='\" ' . s:get_map_str('nextfold') . ': Go to next fold'
silent put ='\" ' . s:get_map_str('prevfold') . ': Go to previous fold'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
silent put ='\"'
silent put ='\" ---------- Misc -----------'
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
silent put ='\" ' . s:get_map_str('togglesort') . ': Toggle sort'
Add case-insensitive sort option
2016-08-28 06:14:10 +08:00
silent put ='\" ' . s:get_map_str('togglecaseinsensitive') . ': Toggle case insensitive sort option'
Add inline help for toggleautoclose mapping
2014-06-25 13:58:36 +08:00
silent put ='\" ' . s:get_map_str('toggleautoclose') . ': Toggle autoclose option'
Add map to allow pausing/unpausing tagbar
2018-06-15 16:27:33 +08:00
silent put ='\" ' . s:get_map_str('togglepause') . ': Toggle pause'
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
silent put ='\" ' . s:get_map_str('zoomwin') . ': Zoom window in/out'
silent put ='\" ' . s:get_map_str('close') . ': Close window'
silent put ='\" ' . s:get_map_str('help') . ': Toggle help'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
silent put _
endif
endfunction
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
function! s:get_map_str(map) abort
let def = get(g:, 'tagbar_map_' . a:map)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if type(def) ==# type('')
Make keybindings configurable, closes #159
2013-08-22 13:38:31 +08:00
return def
else
return join(def, ', ')
endif
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:RenderKeepView() {{{2
" The gist of this function was taken from NERDTree by Martin Grenfell.
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:RenderKeepView(...) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if a:0 == 1
let line = a:1
else
let line = line('.')
endif
let curcol = col('.')
let topline = line('w0')
call s:RenderContent()
let scrolloff_save = &scrolloff
set scrolloff=0
call cursor(topline, 1)
normal! zt
call cursor(line, curcol)
let &scrolloff = scrolloff_save
redraw
endfunction
" User actions {{{1
" s:HighlightTag() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:HighlightTag(openfolds, ...) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let tagline = 0
Fix some TagbarShowTag bugs, closes #108
2012-09-15 12:49:28 +08:00
let force = a:0 > 0 ? a:1 : 0
if a:0 > 1
Rework pause functionality, closes #177 The current pause functionality simply removes all the autocommands to stop updating Tagbar. This has the problem that at the moment the statusline functions immediately restore the commands so pausing doesn't work, but even if that didn't happen it would stop the statusline functionality from working which is not desirable. The solution is to have a reference to the paused file which will get used by the Tagbar window, but not the statusline functions.
2013-11-06 17:33:27 +08:00
let tag = s:GetNearbyTag(1, 0, a:2)
Highlight correct tag when opening tagbar
2012-04-22 00:28:28 +08:00
else
Rework pause functionality, closes #177 The current pause functionality simply removes all the autocommands to stop updating Tagbar. This has the problem that at the moment the statusline functions immediately restore the commands so pausing doesn't work, but even if that didn't happen it would stop the statusline functionality from working which is not desirable. The solution is to have a reference to the paused file which will get used by the Tagbar window, but not the statusline functions.
2013-11-06 17:33:27 +08:00
let tag = s:GetNearbyTag(1, 0)
Highlight correct tag when opening tagbar
2012-04-22 00:28:28 +08:00
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if !empty(tag)
let tagline = tag.tline
endif
Don't highlight the same tag again, closes #36
2011-10-02 17:39:39 +08:00
" Don't highlight the tag again if it's the same one as last time.
" This prevents the Tagbar window from jumping back after scrolling with
" the mouse.
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if !force && tagline ==# s:last_highlight_tline
Don't highlight the same tag again, closes #36
2011-10-02 17:39:39 +08:00
return
else
let s:last_highlight_tline = tagline
endif
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
if tagbarwinnr == -1
return
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
if tagbarwinnr == winnr()
let in_tagbar = 1
else
let in_tagbar = 0
let prevwinnr = winnr()
call s:goto_win('p', 1)
let pprevwinnr = winnr()
call s:goto_win(tagbarwinnr, 1)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
try
match none
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
" No tag above cursor position so don't do anything
if tagline == 0
return
endif
Handle invalid ctags line numbers, closes #119
2013-09-19 08:36:41 +08:00
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
if g:tagbar_autoshowtag == 1 || a:openfolds
call s:OpenParents(tag)
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
" Check whether the tag is inside a closed fold and highlight the parent
" instead in that case
let tagline = tag.getClosedParentTline()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
" Parent tag line number is invalid, better don't do anything
if tagline <= 0
return
endif
Use standard highlight group if syntax is disabled This prevents an error message about a non-existent highlighting group when trying to match the tag pattern.
2013-11-02 16:51:15 +08:00
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
" Go to the line containing the tag
execute tagline
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
" Make sure the tag is visible in the window
call winline()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let foldpat = '[' . g:tagbar#icon_open . g:tagbar#icon_closed . ' ]'
Highlight correctly if visibility disabled The highlight pattern for the current tag didn't account for the fact that the visibility symbol is optional. Closes #463
2017-12-17 11:14:51 +08:00
let pattern = '/^\%' . tagline . 'l\s*' . foldpat . '[-+# ]\?\zs[^( ]\+\ze/'
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log("Highlight pattern: '" . pattern . "'")
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
if hlexists('TagbarHighlight') " Safeguard in case syntax highlighting is disabled
execute 'match TagbarHighlight ' . pattern
else
execute 'match Search ' . pattern
endif
finally
if !in_tagbar
call s:goto_win(pprevwinnr, 1)
call s:goto_win(prevwinnr, 1)
endif
redraw
endtry
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" s:JumpToTag() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:JumpToTag(stay_in_tagbar) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let taginfo = s:GetTagInfo(line('.'), 1)
let autoclose = w:autoclose
Create sub-kind headers as base tags to allow folding of parents
2012-02-28 17:45:11 +08:00
if empty(taginfo) || !taginfo.isNormalTag()
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
let tagbarwinnr = winnr()
Skip preview window when jumping to tag
2013-11-11 12:12:40 +08:00
call s:GotoFileWindow(taginfo.fileinfo)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Mark current position so it can be jumped back to
mark '
" Jump to the line where the tag is defined. Don't use the search pattern
" since it doesn't take the scope into account and thus can fail if tags
" with the same name are defined in different scopes (e.g. classes)
Fix tag jumping if tag pattern is not actually a pattern Closes #439 References jstemmer/gotags#31
2017-09-03 16:36:07 +08:00
call tagbar#debug#log('Jumping to line ' . taginfo.fields.line)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
execute taginfo.fields.line
" If the file has been changed but not saved, the tag may not be on the
" saved line anymore, so search for it in the vicinity of the saved line
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if taginfo.pattern !=# ''
Fix tag jumping if tag pattern is not actually a pattern Closes #439 References jstemmer/gotags#31
2017-09-03 16:36:07 +08:00
call tagbar#debug#log('Searching for pattern "' . taginfo.pattern . '"')
if match(getline('.'), taginfo.pattern) == -1
let interval = 1
let forward = 1
while search(taginfo.pattern, 'W' . forward ? '' : 'b') == 0
if !forward
if interval > line('$')
break
else
let interval = interval * 2
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Fix tag jumping if tag pattern is not actually a pattern Closes #439 References jstemmer/gotags#31
2017-09-03 16:36:07 +08:00
let forward = !forward
endwhile
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Update line info when jumping to a tag, closes #26
2011-08-14 14:11:54 +08:00
" If the tag is on a different line after unsaved changes update the tag
" and file infos/objects
let curline = line('.')
if taginfo.fields.line != curline
let taginfo.fields.line = curline
let taginfo.fileinfo.fline[curline] = taginfo
endif
Try to jump to the right tag column, closes #326
2016-09-24 20:24:04 +08:00
" Center the tag in the window and jump to the correct column if
" available, otherwise try to find it in the line
Move most of script to autoload
2011-06-29 04:59:49 +08:00
normal! z.
Try to jump to the right tag column, closes #326
2016-09-24 20:24:04 +08:00
if taginfo.fields.column > 0
call cursor(taginfo.fields.line, taginfo.fields.column)
else
call cursor(taginfo.fields.line, 1)
call search(taginfo.name, 'c', line('.'))
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Properly open fold when jumping to tag
2013-11-29 22:18:39 +08:00
normal! zv
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if a:stay_in_tagbar
Always highlight current tag when using TagbarOpen, closes #73
2012-05-12 16:07:04 +08:00
call s:HighlightTag(0)
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win(tagbarwinnr)
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
redraw
Move most of script to autoload
2011-06-29 04:59:49 +08:00
elseif g:tagbar_autoclose || autoclose
Close prevwin when jumping to tag, closes #184
2013-12-19 06:54:59 +08:00
" Also closes preview window
Move most of script to autoload
2011-06-29 04:59:49 +08:00
call s:CloseWindow()
else
Close prevwin when jumping to tag, closes #184
2013-12-19 06:54:59 +08:00
" Close the preview window if it was opened by us
if s:pwin_by_tagbar
pclose
endif
Always highlight current tag when using TagbarOpen, closes #73
2012-05-12 16:07:04 +08:00
call s:HighlightTag(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
endfunction
Add key to show tag in preview window
2013-11-10 19:53:45 +08:00
" s:ShowInPreviewWin() {{{2
function! s:ShowInPreviewWin() abort
Small preview window improvements, ref #161
2014-10-14 10:59:29 +08:00
let pos = getpos('.')
let taginfo = s:GetTagInfo(pos[1], 1)
Add key to show tag in preview window
2013-11-10 19:53:45 +08:00
if empty(taginfo) || !taginfo.isNormalTag()
return
endif
Open previewwin relative to Tagbar win
2013-11-30 14:28:18 +08:00
let pwin_open = 0
for win in range(1, winnr('$'))
if getwinvar(win, '&previewwindow')
let pwin_open = 1
break
endif
endfor
Add option to arrange Tagbar window vertically
2014-11-08 16:30:17 +08:00
" We want the preview window to be relative to the file window in normal
" (horizontal) mode, and relative to the Tagbar window in vertical mode,
" to make the best use of space.
if g:tagbar_vertical == 0
call s:GotoFileWindow(taginfo.fileinfo, 1)
call s:mark_window()
endif
" Open the preview window if it is not already open. This has to be done
" explicitly before the :psearch below to better control its positioning.
Open previewwin relative to Tagbar win
2013-11-30 14:28:18 +08:00
if !pwin_open
Small preview window improvements, ref #161
2014-10-14 10:59:29 +08:00
silent execute
Escape filename in ShowInPreviewWin()
2016-11-04 00:57:26 +08:00
\ g:tagbar_previewwin_pos . ' pedit ' .
\ fnameescape(taginfo.fileinfo.fpath)
Add option to arrange Tagbar window vertically
2014-11-08 16:30:17 +08:00
if g:tagbar_vertical != 0
silent execute 'vertical resize ' . g:tagbar_width
endif
Open previewwin relative to Tagbar win
2013-11-30 14:28:18 +08:00
" Remember that the preview window was opened by Tagbar so we can
" safely close it by ourselves
let s:pwin_by_tagbar = 1
endif
Add option to arrange Tagbar window vertically
2014-11-08 16:30:17 +08:00
if g:tagbar_vertical != 0
call s:GotoFileWindow(taginfo.fileinfo, 1)
call s:mark_window()
endif
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
" Use psearch instead of pedit since pedit essentially reloads the file
" and creates an empty undo entry. psearch has to be called from the file
" window, and since we only want matches in the current file we disable
" the 'include' option. Also start searching at the correct line number to
" find the correct tag in case of tags with the same name and to speed up
" the searching. Unfortunately the /\%l pattern doesn't seem to work with
" psearch.
Fix tag jumping if tag pattern is not actually a pattern Closes #439 References jstemmer/gotags#31
2017-09-03 16:36:07 +08:00
let pattern = taginfo.pattern
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if pattern ==# ''
Fix tag jumping if tag pattern is not actually a pattern Closes #439 References jstemmer/gotags#31
2017-09-03 16:36:07 +08:00
let pattern = '\V\^' . escape(getline(taginfo.fields.line), '\') . '\$'
endif
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
let include_save = &include
set include=
Fix tag jumping if tag pattern is not actually a pattern Closes #439 References jstemmer/gotags#31
2017-09-03 16:36:07 +08:00
silent! execute taginfo.fields.line . ',$psearch! /' . pattern . '/'
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
let &include = include_save
call s:goto_win('P', 1)
Automatically open folds in preview window
2013-11-22 11:36:54 +08:00
normal! zv
Always centre preview window
2013-11-29 22:31:31 +08:00
normal! zz
Small preview window improvements, ref #161
2014-10-14 10:59:29 +08:00
call s:goto_markedwin(1)
Jump to correct window even after opening preview window
2014-02-01 16:17:00 +08:00
call s:goto_tagbar(1)
Small preview window improvements, ref #161
2014-10-14 10:59:29 +08:00
call cursor(pos[1], pos[2])
Add key to show tag in preview window
2013-11-10 19:53:45 +08:00
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:ShowPrototype() {{{2
Only generate prototypes on-demand
2012-08-26 21:57:56 +08:00
function! s:ShowPrototype(short) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let taginfo = s:GetTagInfo(line('.'), 1)
if empty(taginfo)
Only generate prototypes on-demand
2012-08-26 21:57:56 +08:00
return ''
Improve prototype handling
2012-08-26 15:25:02 +08:00
endif
Only generate prototypes on-demand
2012-08-26 21:57:56 +08:00
echo taginfo.getPrototype(a:short)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" s:ToggleHelp() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:ToggleHelp() abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let s:short_help = !s:short_help
" Prevent highlighting from being off after adding/removing the help text
match none
call s:RenderContent()
execute 1
redraw
endfunction
" s:GotoNextToplevelTag() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:GotoNextToplevelTag(direction) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let curlinenr = line('.')
let newlinenr = line('.')
if a:direction == 1
let range = range(line('.') + 1, line('$'))
else
let range = range(line('.') - 1, 1, -1)
endif
for tmplinenr in range
let taginfo = s:GetTagInfo(tmplinenr, 0)
if empty(taginfo)
continue
elseif empty(taginfo.parent)
let newlinenr = tmplinenr
break
endif
endfor
if curlinenr != newlinenr
execute newlinenr
call winline()
endif
redraw
endfunction
" Folding {{{1
" s:OpenFold() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:OpenFold() abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if empty(fileinfo)
return
endif
let curline = line('.')
let tag = s:GetTagInfo(curline, 0)
if empty(tag)
return
endif
call tag.openFold()
call s:RenderKeepView()
endfunction
" s:CloseFold() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:CloseFold() abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if empty(fileinfo)
return
endif
match none
let curline = line('.')
let curtag = s:GetTagInfo(curline, 0)
if empty(curtag)
return
endif
let newline = curtag.closeFold()
call s:RenderKeepView(newline)
endfunction
" s:ToggleFold() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:ToggleFold() abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if empty(fileinfo)
return
endif
match none
let curtag = s:GetTagInfo(line('.'), 0)
if empty(curtag)
return
endif
let newline = line('.')
if curtag.isKindheader()
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call curtag.toggleFold(tagbar#state#get_current_file(0))
Move most of script to autoload
2011-06-29 04:59:49 +08:00
elseif curtag.isFoldable()
if curtag.isFolded()
call curtag.openFold()
else
let newline = curtag.closeFold()
endif
else
let newline = curtag.closeFold()
endif
call s:RenderKeepView(newline)
endfunction
Add ability to open or close folds a single level
2017-07-26 22:18:18 +08:00
" s:ChangeFoldLevel() {{{2
function! s:ChangeFoldLevel(diff, force) abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Add ability to open or close folds a single level
2017-07-26 22:18:18 +08:00
if empty(fileinfo)
return
endif
if fileinfo.foldlevel == 99
call s:MinimizeMaxFoldLevel(fileinfo, fileinfo.getTags())
endif
let level = fileinfo.foldlevel
let level = level + a:diff
Reduce code dupication in ChangeFoldLevel
2017-07-31 00:11:31 +08:00
call s:SetFoldLevel(level, a:force)
Add ability to open or close folds a single level
2017-07-26 22:18:18 +08:00
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:SetFoldLevel() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:SetFoldLevel(level, force) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if a:level < 0
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
call s:warning('Foldlevel can''t be negative')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if empty(fileinfo)
return
endif
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
call s:SetFoldLevelRecursive(fileinfo, fileinfo.getTags(), a:level)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
let typeinfo = fileinfo.typeinfo
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Apply foldlevel to 'kind's
if a:level == 0
for kind in typeinfo.kinds
call fileinfo.closeKindFold(kind)
endfor
else
for kind in typeinfo.kinds
Make SetFoldlevel respect default-closed folds without '!', closes #61
2012-03-14 17:41:39 +08:00
if a:force || !kind.fold
call fileinfo.openKindFold(kind)
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfor
endif
let fileinfo.foldlevel = a:level
call s:RenderContent()
endfunction
" s:SetFoldLevelRecursive() {{{2
" Apply foldlevel to normal tags
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:SetFoldLevelRecursive(fileinfo, tags, level) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
for tag in a:tags
if tag.depth >= a:level
call tag.setFolded(1)
else
call tag.setFolded(0)
endif
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
if !empty(tag.getChildren())
call s:SetFoldLevelRecursive(a:fileinfo, tag.getChildren(), a:level)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
endfor
endfunction
Add ability to open or close folds a single level
2017-07-26 22:18:18 +08:00
" s:MinimizeMaxFoldLevel() {{{2
" Set the file's fold level to the lowest value that still shows all tags
function! s:MinimizeMaxFoldLevel(fileinfo, tags) abort
let maxlvl = 0
let tags = copy(a:tags)
for tag in tags
if maxlvl < tag.depth
let maxlvl = tag.depth
endif
call tag.setFolded(0)
call extend(tags, tag.getChildren())
endfor
let a:fileinfo.foldlevel = maxlvl
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:OpenParents() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:OpenParents(...) abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if a:0 == 1
let tag = a:1
else
Rework pause functionality, closes #177 The current pause functionality simply removes all the autocommands to stop updating Tagbar. This has the problem that at the moment the statusline functions immediately restore the commands so pausing doesn't work, but even if that didn't happen it would stop the statusline functionality from working which is not desirable. The solution is to have a reference to the paused file which will get used by the Tagbar window, but not the statusline functions.
2013-11-06 17:33:27 +08:00
let tag = s:GetNearbyTag(1, 0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Fix some TagbarShowTag bugs, closes #108
2012-09-15 12:49:28 +08:00
if !empty(tag)
call tag.openParents()
call s:RenderKeepView()
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
Add mappings for moving through folds, closes #224
2014-11-09 12:33:42 +08:00
" s:GotoNextFold() {{{2
function! s:GotoNextFold() abort
let curlinenr = line('.')
let newlinenr = line('.')
let range = range(line('.') + 1, line('$'))
for linenr in range
let taginfo = s:GetTagInfo(linenr, 0)
if empty(taginfo)
continue
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
elseif !empty(taginfo.getChildren()) || taginfo.isKindheader()
Add mappings for moving through folds, closes #224
2014-11-09 12:33:42 +08:00
let newlinenr = linenr
break
endif
endfor
if curlinenr != newlinenr
execute linenr
call winline()
endif
redraw
endfunction
" s:GotoPrevFold() {{{2
function! s:GotoPrevFold() abort
let curlinenr = line('.')
let newlinenr = line('.')
let curtag = s:GetTagInfo(curlinenr, 0)
let curparent = get(curtag, 'parent', {})
let range = range(line('.') - 1, 1, -1)
for linenr in range
let taginfo = s:GetTagInfo(linenr, 0)
if empty(taginfo)
continue
Don't skip over closed folds with zk
2014-11-26 09:52:54 +08:00
" Check for the first tag that is either:
" - the last tag in an open fold, that is skip all tags that have the
" same parent as the current one, or
" - a closed parent fold.
elseif (!empty(taginfo.parent) && taginfo.parent != curparent &&
Add name-indexed dicts of tags alongside lists When constructing the tag tree it is often necessary to look up tags with a certain name and other attributes at the current depth. This was previously done with the filter() function on the list of all the relevant tags. However, this filtering is very slow. This commit changes the FileInfo and TagInfo objects to save added tags in a dictionary indexed by the name of the tag in addition to the list (which is still maintained in parallel since it is necessary for things like sorting). This significatly speeds up tag lookup since most tags have unique names.
2017-02-04 12:52:05 +08:00
\ empty(taginfo.getChildren())) ||
\ ((!empty(taginfo.getChildren()) || taginfo.isKindheader()) &&
Don't skip over closed folds with zk
2014-11-26 09:52:54 +08:00
\ taginfo.isFolded())
Add mappings for moving through folds, closes #224
2014-11-09 12:33:42 +08:00
let newlinenr = linenr
break
endif
endfor
if curlinenr != newlinenr
execute linenr
call winline()
endif
redraw
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Helper functions {{{1
" s:AutoUpdate() {{{2
Update tags on CursorHold after writing Currently the tags will always get updated immediately when writing a file. However, for large files that can slow down the writing process noticeably, leading to annoying pauses. This commit instead defers the updating process to the first CursorHold/CursorHoldI event after writing a file, which should make the process much less noticeable. Closes #289 Closes #381 References SpaceVim/SpaceVim#129
2017-02-05 13:51:28 +08:00
function! s:AutoUpdate(fname, force, ...) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('AutoUpdate called [' . a:fname . ']')
Add debugging functionality
2011-12-12 14:47:43 +08:00
Update tags on CursorHold after writing Currently the tags will always get updated immediately when writing a file. However, for large files that can slow down the writing process noticeably, leading to annoying pauses. This commit instead defers the updating process to the first CursorHold/CursorHoldI event after writing a file, which should make the process much less noticeable. Closes #289 Closes #381 References SpaceVim/SpaceVim#129
2017-02-05 13:51:28 +08:00
" Whether we want to skip actually displaying the tags in Tagbar and only
" update the fileinfo
let no_display = a:0 > 0 ? a:1 : 0
Don't process quickfix-loaded files, closes #176 Certain quickfix-commands like vimgrep have to load all searched files into Vim and will execute the BufReadPost autocmd for all of them. Since Tagbar doesn't need to generate tags for those files pause processing while the command is running. There doesn't seem to be a better way to find out whether vimgrep is running than to set a temporary variable with the QuickFixCmdPre/Post autocmds, see also https://groups.google.com/forum/#!topic/vim_use/sUj5MFGmwD8
2013-11-04 17:51:38 +08:00
" This file is being loaded due to a quickfix command like vimgrep, so
" don't process it
if exists('s:tagbar_qf_active')
return
Don't update during window opening, closes #179 Plugins like MiniBufExplorer can trigger an update before window initialization has finished, leading to errors. Skip processing until that is done.
2013-11-06 12:06:39 +08:00
elseif exists('s:window_opening')
" This can happen if another plugin causes the active window to change
" with an autocmd during the initial Tagbar window creation. In that
" case InitWindow() hasn't had a chance to run yet and things can
" break. MiniBufExplorer does this, for example. Completely disabling
" autocmds at that point is also not ideal since for example
" statusline plugins won't be able to update.
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Still opening window, stopping processing')
Don't update during window opening, closes #179 Plugins like MiniBufExplorer can trigger an update before window initialization has finished, leading to errors. Skip processing until that is done.
2013-11-06 12:06:39 +08:00
return
Don't process quickfix-loaded files, closes #176 Certain quickfix-commands like vimgrep have to load all searched files into Vim and will execute the BufReadPost autocmd for all of them. Since Tagbar doesn't need to generate tags for those files pause processing while the command is running. There doesn't seem to be a better way to find out whether vimgrep is running than to set a temporary variable with the QuickFixCmdPre/Post autocmds, see also https://groups.google.com/forum/#!topic/vim_use/sUj5MFGmwD8
2013-11-04 17:51:38 +08:00
endif
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
" Get the filetype of the file we're about to process
let bufnr = bufnr(a:fname)
let ftype = getbufvar(bufnr, '&filetype')
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
" Don't do anything if we're in the tagbar window
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ftype ==# 'tagbar'
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('In Tagbar window, stopping processing')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
" Only consider the main filetype in cases like 'python.django'
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
let sftype = get(split(ftype, '\.'), 0, '')
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log("Vim filetype: '" . ftype . "', " .
Rename debug log function
2014-04-03 19:39:26 +08:00
\ "sanitized filetype: '" . sftype . "'")
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Don't do anything if the file isn't supported
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
if !s:IsValidFile(a:fname, sftype)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Not a valid file, stopping processing')
Better handling of switching to unsupported buffer
2013-02-18 19:02:32 +08:00
let s:nearby_disabled = 1
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
Save some unnecessary redrawings
2012-02-28 17:46:04 +08:00
let updated = 0
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
" Process the file if it's unknown or the information is outdated.
" Testing the mtime of the file is necessary in case it got changed
" outside of Vim, for example by checking out a different version from a
" VCS.
Run ctags even if previous run produced erros, closes #125 If a ctags-compatible program returns an error status code on a parsing failure then it would never be run again on the same file, even if later invocations would have returned normally (for example after fixing an error in the current file). Therefore we need to execute the program on updates as usual, but do not repeat error messages if the previous run already did.
2013-02-26 16:56:12 +08:00
if s:known_files.has(a:fname)
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
let curfile = s:known_files.get(a:fname)
" if a:force || getbufvar(curfile.bufnr, '&modified') ||
Reprocess files if filetype changes, closes #228
2014-11-02 12:44:25 +08:00
if a:force || empty(curfile) || curfile.ftype != sftype ||
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
\ (filereadable(a:fname) && getftime(a:fname) > curfile.mtime)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('File data outdated, updating [' . a:fname . ']')
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
call s:ProcessFile(a:fname, sftype)
Save some unnecessary redrawings
2012-02-28 17:46:04 +08:00
let updated = 1
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
else
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('File data seems up to date [' . a:fname . ']')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
elseif !s:known_files.has(a:fname)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('New file, processing [' . a:fname . ']')
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
call s:ProcessFile(a:fname, sftype)
Save some unnecessary redrawings
2012-02-28 17:46:04 +08:00
let updated = 1
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Update tags on CursorHold after writing Currently the tags will always get updated immediately when writing a file. However, for large files that can slow down the writing process noticeably, leading to annoying pauses. This commit instead defers the updating process to the first CursorHold/CursorHoldI event after writing a file, which should make the process much less noticeable. Closes #289 Closes #381 References SpaceVim/SpaceVim#129
2017-02-05 13:51:28 +08:00
if no_display
return
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let fileinfo = s:known_files.get(a:fname)
" If we don't have an entry for the file by now something must have gone
" wrong, so don't change the tagbar content
if empty(fileinfo)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('fileinfo empty after processing [' . a:fname . ']')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return
endif
Save some unnecessary redrawings
2012-02-28 17:46:04 +08:00
" Display the tagbar content if the tags have been updated or a different
" file is being displayed
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
if bufwinnr(s:TagbarBufName()) != -1 && !s:paused &&
Prevent update error when current file is empty
2013-02-18 16:51:16 +08:00
\ (s:new_window || updated ||
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
\ (!empty(tagbar#state#get_current_file(0)) &&
\ a:fname != tagbar#state#get_current_file(0).fpath))
Save some unnecessary redrawings
2012-02-28 17:46:04 +08:00
call s:RenderContent(fileinfo)
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Call setCurrent after rendering so RenderContent can check whether the
Cache files locally for parsing Files are now cached locally in a temporary file, and the parsing happens on that file. This allows displaying tags for remote (Netrw) files, and it will also make access to files on remote filesystems like NFS and sshfs faster. Additionally, tags are now always updated when the files are saved, deprecating the tagbar_updateonsave_maxlines option. Otherwise checking for changes in remote files would not have been possible.
2012-07-22 17:49:17 +08:00
" same file is being redisplayed
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if !empty(fileinfo)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Setting current file [' . a:fname . ']')
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call tagbar#state#set_current_file(fileinfo)
Better handling of switching to unsupported buffer
2013-02-18 19:02:32 +08:00
let s:nearby_disabled = 0
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Always highlight current tag when using TagbarOpen, closes #73
2012-05-12 16:07:04 +08:00
call s:HighlightTag(0)
Remove redundant SetStatusLine argument, ref #335 Thank you to @jpmv27 for spotting this.
2016-09-19 19:10:10 +08:00
call s:SetStatusLine()
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('AutoUpdate finished successfully')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
Reorder some functions
2012-02-27 21:34:01 +08:00
" s:CheckMouseClick() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:CheckMouseClick() abort
Reorder some functions
2012-02-27 21:34:01 +08:00
let line = getline('.')
let curcol = col('.')
Allow loading type definitions from ftplugins, closes #62
2012-02-19 12:26:15 +08:00
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
if (match(line, g:tagbar#icon_open . '[-+ ]') + 1) == curcol
Reorder some functions
2012-02-27 21:34:01 +08:00
call s:CloseFold()
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
elseif (match(line, g:tagbar#icon_closed . '[-+ ]') + 1) == curcol
Reorder some functions
2012-02-27 21:34:01 +08:00
call s:OpenFold()
elseif g:tagbar_singleclick
call s:JumpToTag(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Reorder some functions
2012-02-27 21:34:01 +08:00
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Reorder some functions
2012-02-27 21:34:01 +08:00
" s:DetectFiletype() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:DetectFiletype(bufnr) abort
Reorder some functions
2012-02-27 21:34:01 +08:00
" Filetype has already been detected for loaded buffers, but not
" necessarily for unloaded ones
let ftype = getbufvar(a:bufnr, '&filetype')
if bufloaded(a:bufnr)
return ftype
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ftype !=# ''
Reorder some functions
2012-02-27 21:34:01 +08:00
return ftype
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Reorder some functions
2012-02-27 21:34:01 +08:00
" Unloaded buffer with non-detected filetype, need to detect filetype
" manually
let bufname = bufname(a:bufnr)
let eventignore_save = &eventignore
set eventignore=FileType
let filetype_save = &filetype
exe 'doautocmd filetypedetect BufRead ' . bufname
let ftype = &filetype
let &filetype = filetype_save
let &eventignore = eventignore_save
return ftype
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" s:EscapeCtagsCmd() {{{2
" Assemble the ctags command line in a way that all problematic characters are
" properly escaped and converted to the system's encoding
" Optional third parameter is a file name to run ctags on
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
" Note: The second parameter (a:args) can be a list of args or
" a single string of the args.
" When a:args is a list, each argument in the list will be escaped for the
" current &shell type.
" When a:args is a string, all arguments should be escaped appropriately
" (if required). In most use cases no escaping is required so a string
" is acceptable. But in cases where arguments may need to be escaped
" differently for each &shell type, then pass a list of arguments.
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:EscapeCtagsCmd(ctags_bin, args, ...) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('EscapeCtagsCmd called')
call tagbar#debug#log('ctags_bin: ' . a:ctags_bin)
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
if type(a:args)==type('')
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('ctags_args (is a string): ' . a:args)
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
elseif type(a:args)==type([])
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('ctags_args (is a list): ' . string(a:args))
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
endif
Add debugging functionality
2011-12-12 14:47:43 +08:00
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if exists('+shellslash')
let shellslash_save = &shellslash
set noshellslash
endif
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
"Set up 0th argument of ctags_cmd
"a:ctags_bin may have special characters that require escaping.
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if &shell =~? 'cmd\.exe$' && a:ctags_bin !~# '\s'
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
"For windows cmd.exe, escaping the 0th argument can cause
"problems if it references a batch file and the batch file uses %~dp0.
"So for windows cmd.exe, only escape the 0th argument iff necessary.
"Only known necessary case is when ctags_bin executable filename has
"whitespace character(s).
" Example: If 0th argument is wrapped in double quotes AND it is not
" an absolute path to ctags_bin, but rather an executable in %PATH%,
" then %~dp0 resolves to the current working directory rather than
" the batch file's directory. Batch files like this generally exepect
" and depend on %~dp0 to resolve the batch file's directory.
" Note: Documentation such as `help cmd.exe` and
" http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/cmd.mspx?mfr=true
" suggest other special characters that require escaping for command
" line completion. But tagbar.vim does not use the command line
" completion feature of cmd.exe and testing shows that the only special
" character that needs to be escaped for tagbar.vim is <space> for
" windows cmd.exe.
let ctags_cmd = a:ctags_bin
Move most of script to autoload
2011-06-29 04:59:49 +08:00
else
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
let ctags_cmd = shellescape(a:ctags_bin)
endif
"Add additional arguments to ctags_cmd
if type(a:args)==type('')
"When a:args is a string, append the arguments
"Note: In this case, do not attempt to shell escape a:args string.
"This function expects the string to already be escaped properly for
"the shell type. Why not escape? Because it could be ambiguous about
"whether a space is an argument separator or included in the argument.
"Since escaping rules vary from shell to shell, it is better to pass a
"list of arguments to a:args. With a list, each argument is clearly
"separated, so shellescape() can calculate the appropriate escaping
"for each argument for the current &shell.
let ctags_cmd .= ' ' . a:args
elseif type(a:args)==type([])
"When a:args is a list, shellescape() each argument and append ctags_cmd
"Note: It's a better practice to shellescape() each argument separately so that
"spaces used as a separator between arguments can be distinguished with
"spaces used inside a single argument.
for arg in a:args
let ctags_cmd .= ' ' . shellescape(arg)
endfor
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Improved s:EscapeCtagsCmd() for windows cmd.exe to eliminate issues when a:ctags_bin calls a batch file that uses %~dp0. Changes include: - Enable ctags_args to be a list - Changed default ctags_args to be a list to improve robustness of s:EscapeCtagsCmd() - Do not escape 0th argument of ctags_cmd for cmd.exe when it is not necessary because otherwise batch files may not return expected value for %~dp0 - Updated tagbar documentation about string and list value types for ctags_args See https://github.com/majutsushi/tagbar/issues/133
2013-04-03 05:57:30 +08:00
"if a filename was specified, add filename as final argument to ctags_cmd.
if a:0 == 1
let ctags_cmd .= ' ' . shellescape(a:1)
Escape some special characters for cmd.exe
2012-04-30 12:40:28 +08:00
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if exists('+shellslash')
let &shellslash = shellslash_save
endif
" Needed for cases where 'encoding' is different from the system's
" encoding
Only attempt encoding conversion if compiled with +multi_byte
2012-07-21 16:59:23 +08:00
if has('multi_byte')
if g:tagbar_systemenc != &encoding
let ctags_cmd = iconv(ctags_cmd, &encoding, g:tagbar_systemenc)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
elseif $LANG !=# ''
Only attempt encoding conversion if compiled with +multi_byte
2012-07-21 16:59:23 +08:00
let ctags_cmd = iconv(ctags_cmd, &encoding, $LANG)
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Escaped ctags command: ' . ctags_cmd)
Add debugging functionality
2011-12-12 14:47:43 +08:00
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if ctags_cmd ==# ''
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
if !s:warnings.encoding
call s:warning('Tagbar: Ctags command encoding conversion failed!' .
\ ' Please read ":h g:tagbar_systemenc".')
let s:warnings.encoding = 1
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
return ctags_cmd
endfunction
" s:ExecuteCtags() {{{2
" Execute ctags with necessary shell settings
" Partially based on the discussion at
" http://vim.1045645.n5.nabble.com/bad-default-shellxquote-in-Widows-td1208284.html
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:ExecuteCtags(ctags_cmd) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Executing ctags command: ' . a:ctags_cmd)
Print debug message when executing ctags
2012-08-22 20:59:41 +08:00
Check for fish instead of resetting shell unconditionally
2015-02-23 10:14:35 +08:00
if &shell =~# 'fish$'
" Reset shell since fish isn't really compatible
Reset 'shell' to improve compatibility
2014-10-09 06:31:19 +08:00
let shell_save = &shell
set shell=sh
endif
Fall back to using bourne shell if $SHELL is Elvish (#571) If vim is launched from the Elvish shell, then fall back to using the bourne shell (sh) or a bourne compatible shell when calling {universal/exuberant-}ctags. Signed-off-by: Adam Jimerson <vendion@gmail.com>
2019-12-22 13:28:44 +08:00
if &shell =~# 'elvish'
" Reset shell since Elvish isn't really compatible
let shell_save = &shell
set shell=sh
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if exists('+shellslash')
let shellslash_save = &shellslash
set noshellslash
endif
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if &shell =~? 'cmd\.exe'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let shellxquote_save = &shellxquote
set shellxquote=\"
let shellcmdflag_save = &shellcmdflag
set shellcmdflag=/s\ /c
endif
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
if tagbar#debug#enabled()
Log exact shell command for debug
2013-08-20 22:44:22 +08:00
silent 5verbose let ctags_output = system(a:ctags_cmd)
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log(v:statusmsg)
call tagbar#debug#log('Exit code: ' . v:shell_error)
Log exact shell command for debug
2013-08-20 22:44:22 +08:00
redraw!
else
Suppress status-line output when executing shell Failing to suppress output can cause problems in some environments, especially if the shell command fails or does something else spooky. Example where failing to suppress the shell command causes issues with [vim-airline](https://github.com/bling/vim-airline) with the tagbar extension enabled: ![](http://i.imgur.com/ciigs8C.png) Here's another example: ![](http://i.imgur.com/cl96sI8.png) Both were taken using uxterm in Linux.
2015-04-25 06:44:58 +08:00
silent let ctags_output = system(a:ctags_cmd)
Log exact shell command for debug
2013-08-20 22:44:22 +08:00
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if &shell =~? 'cmd\.exe'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let &shellxquote = shellxquote_save
let &shellcmdflag = shellcmdflag_save
endif
if exists('+shellslash')
let &shellslash = shellslash_save
endif
Check for fish instead of resetting shell unconditionally
2015-02-23 10:14:35 +08:00
if exists('shell_save')
Reset 'shell' to improve compatibility
2014-10-09 06:31:19 +08:00
let &shell = shell_save
endif
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return ctags_output
endfunction
Reorder some functions
2012-02-27 21:34:01 +08:00
" s:GetNearbyTag() {{{2
" Get the tag info for a file near the cursor in the current file
Rework pause functionality, closes #177 The current pause functionality simply removes all the autocommands to stop updating Tagbar. This has the problem that at the moment the statusline functions immediately restore the commands so pausing doesn't work, but even if that didn't happen it would stop the statusline functionality from working which is not desirable. The solution is to have a reference to the paused file which will get used by the Tagbar window, but not the statusline functions.
2013-11-06 17:33:27 +08:00
function! s:GetNearbyTag(all, forcecurrent, ...) abort
Better handling of switching to unsupported buffer
2013-02-18 19:02:32 +08:00
if s:nearby_disabled
return {}
endif
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(a:forcecurrent)
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
if empty(fileinfo)
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
return {}
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
endif
Reorder some functions
2012-02-27 21:34:01 +08:00
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
let typeinfo = fileinfo.typeinfo
Highlight correct tag when opening tagbar
2012-04-22 00:28:28 +08:00
if a:0 > 0
let curline = a:1
else
let curline = line('.')
endif
Reorder some functions
2012-02-27 21:34:01 +08:00
let tag = {}
" If a tag appears in a file more than once (for example namespaces in
" C++) only one of them has a 'tline' entry and can thus be highlighted.
" The only way to solve this would be to go over the whole tag list again,
" making everything slower. Since this should be a rare occurence and
" highlighting isn't /that/ important ignore it for now.
for line in range(curline, 1, -1)
if has_key(fileinfo.fline, line)
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
let curtag = fileinfo.fline[line]
if a:all || typeinfo.getKind(curtag.fields.kind).stl
let tag = curtag
Allow types for tagbar#currenttag() to be configured
2012-03-04 15:52:15 +08:00
break
endif
Reorder some functions
2012-02-27 21:34:01 +08:00
endif
endfor
return tag
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" s:GetTagInfo() {{{2
" Return the info dictionary of the tag on the specified line. If the line
" does not contain a valid tag (for example because it is empty or only
" contains a pseudo-tag) return an empty dictionary.
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:GetTagInfo(linenr, ignorepseudo) abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
if empty(fileinfo)
return {}
endif
" Don't do anything in empty and comment lines
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let curline = getbufline(bufnr(s:TagbarBufName()), a:linenr)[0]
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if curline =~# '^\s*$' || curline[0] ==# '"'
Move most of script to autoload
2011-06-29 04:59:49 +08:00
return {}
endif
" Check if there is a tag on the current line
if !has_key(fileinfo.tline, a:linenr)
return {}
endif
let taginfo = fileinfo.tline[a:linenr]
" Check if the current tag is not a pseudo-tag
if a:ignorepseudo && taginfo.isPseudoTag()
return {}
endif
return taginfo
endfunction
Extract GetFileWinnr() function
2014-02-01 15:49:11 +08:00
" s:GetFileWinnr() {{{2
" Get the number of the window that has Tagbar's current file loaded into it,
" or 0 if no window has loaded it. It tries the previous window first, if that
" does not have the correct buffer loaded it will look for the first one with
" the correct buffer in it.
function! s:GetFileWinnr(fileinfo) abort
let filewinnr = 0
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
let prevwinnr = winnr('#')
Extract GetFileWinnr() function
2014-02-01 15:49:11 +08:00
if winbufnr(prevwinnr) == a:fileinfo.bufnr &&
\ !getwinvar(prevwinnr, '&previewwindow')
let filewinnr = prevwinnr
else
" Search for the first real window that has the correct buffer loaded
" in it. Similar to bufwinnr() but skips the previewwindow.
for i in range(1, winnr('$'))
call s:goto_win(i, 1)
if bufnr('%') == a:fileinfo.bufnr && !&previewwindow
let filewinnr = winnr()
break
endif
endfor
call s:goto_tagbar(1)
endif
return filewinnr
endfunction
Skip preview window when jumping to tag
2013-11-11 12:12:40 +08:00
" s:GotoFileWindow() {{{2
" Try to switch to the window that has Tagbar's current file loaded in it, or
Extract GetFileWinnr() function
2014-02-01 15:49:11 +08:00
" open the file in an existing window otherwise.
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
function! s:GotoFileWindow(fileinfo, ...) abort
let noauto = a:0 > 0 ? a:1 : 0
Extract GetFileWinnr() function
2014-02-01 15:49:11 +08:00
let filewinnr = s:GetFileWinnr(a:fileinfo)
Return to the correct window after closing Tagbar, closes #132 Since the window numbers can change when opening and closing windows Tagbar so far has used bufwinnr() to find the right window to jump back to. However, this fails if the same file is being displayed in more than one window. Save a window-local variable instead to detect the correct window to jump back to.
2013-03-24 09:16:56 +08:00
Extract GetFileWinnr() function
2014-02-01 15:49:11 +08:00
" If there is no window with the correct buffer loaded then load it
" into the first window that has a non-special buffer in it.
if filewinnr == 0
Skip preview window when jumping to tag
2013-11-11 12:12:40 +08:00
for i in range(1, winnr('$'))
Clean up window switching
2013-11-15 11:21:12 +08:00
call s:goto_win(i, 1)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if &buftype ==# '' && !&previewwindow
Extract GetFileWinnr() function
2014-02-01 15:49:11 +08:00
execute 'buffer ' . a:fileinfo.bufnr
Skip preview window when jumping to tag
2013-11-11 12:12:40 +08:00
break
endif
endfor
Extract GetFileWinnr() function
2014-02-01 15:49:11 +08:00
else
call s:goto_win(filewinnr, 1)
Return to the correct window after closing Tagbar, closes #132 Since the window numbers can change when opening and closing windows Tagbar so far has used bufwinnr() to find the right window to jump back to. However, this fails if the same file is being displayed in more than one window. Save a window-local variable instead to detect the correct window to jump back to.
2013-03-24 09:16:56 +08:00
endif
Extract GetFileWinnr() function
2014-02-01 15:49:11 +08:00
" To make ctrl-w_p work we switch between the Tagbar window and the
" correct window once
call s:goto_tagbar(noauto)
call s:goto_win('p', noauto)
Return to the correct window after closing Tagbar, closes #132 Since the window numbers can change when opening and closing windows Tagbar so far has used bufwinnr() to find the right window to jump back to. However, this fails if the same file is being displayed in more than one window. Save a window-local variable instead to detect the correct window to jump back to.
2013-03-24 09:16:56 +08:00
endfunction
Allow hiding non-public tags, closes #186
2014-02-05 13:08:04 +08:00
" s:ToggleHideNonPublicTags() {{{2
function! s:ToggleHideNonPublicTags() abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Keep cursor on same tag when toggle hide non-public
2016-08-28 06:21:06 +08:00
if empty(fileinfo)
return
endif
" Save the tag the cursor is currently on
let curline = line('.')
let taginfo = s:GetTagInfo(curline, 0)
match none
Allow hiding non-public tags, closes #186
2014-02-05 13:08:04 +08:00
let g:tagbar_hide_nonpublic = !g:tagbar_hide_nonpublic
call s:RenderKeepView()
Remove redundant SetStatusLine argument, ref #335 Thank you to @jpmv27 for spotting this.
2016-09-19 19:10:10 +08:00
call s:SetStatusLine()
Keep cursor on same tag when toggle hide non-public
2016-08-28 06:21:06 +08:00
" If we were on a tag before sorting then jump to it, otherwise restore
" the cursor to the current line
if !empty(taginfo)
execute taginfo.tline
else
execute curline
endif
Allow hiding non-public tags, closes #186
2014-02-05 13:08:04 +08:00
endfunction
Add case-insensitive sort option
2016-08-28 06:14:10 +08:00
" s:ToggleCaseInsensitive() {{{2
function! s:ToggleCaseInsensitive() abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let fileinfo = tagbar#state#get_current_file(0)
Add case-insensitive sort option
2016-08-28 06:14:10 +08:00
if empty(fileinfo)
return
endif
" Save the tag the cursor is currently on
let curline = line('.')
let taginfo = s:GetTagInfo(curline, 0)
match none
let g:tagbar_case_insensitive = !g:tagbar_case_insensitive
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call fileinfo.sortTags(fileinfo.typeinfo)
Add case-insensitive sort option
2016-08-28 06:14:10 +08:00
call s:RenderKeepView()
Remove redundant SetStatusLine argument, ref #335 Thank you to @jpmv27 for spotting this.
2016-09-19 19:10:10 +08:00
call s:SetStatusLine()
Add case-insensitive sort option
2016-08-28 06:14:10 +08:00
" If we were on a tag before sorting then jump to it, otherwise restore
" the cursor to the current line
if !empty(taginfo)
execute taginfo.tline
else
execute curline
endif
endfunction
Add mapping to toggle autoclose option The current tagbar_autoclose state will be displayed in the statusline. Also change the "hide nonpublic" flag to "v" to match the mapping and properly document the statusline flags.
2014-06-25 13:52:43 +08:00
" s:ToggleAutoclose() {{{2
function! s:ToggleAutoclose() abort
let g:tagbar_autoclose = !g:tagbar_autoclose
Remove redundant SetStatusLine argument, ref #335 Thank you to @jpmv27 for spotting this.
2016-09-19 19:10:10 +08:00
call s:SetStatusLine()
Add mapping to toggle autoclose option The current tagbar_autoclose state will be displayed in the statusline. Also change the "hide nonpublic" flag to "v" to match the mapping and properly document the statusline flags.
2014-06-25 13:52:43 +08:00
endfunction
Reorder some functions
2012-02-27 21:34:01 +08:00
" s:IsValidFile() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! s:IsValidFile(fname, ftype) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Checking if file is valid [' . a:fname . ']')
Move most of script to autoload
2011-06-29 04:59:49 +08:00
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if a:fname ==# '' || a:ftype ==# ''
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Empty filename or type')
Reorder some functions
2012-02-27 21:34:01 +08:00
return 0
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if !filereadable(a:fname) && getbufvar(a:fname, 'netrw_tmpfile') ==# ''
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('File not readable')
Reorder some functions
2012-02-27 21:34:01 +08:00
return 0
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
endif
Allow ignoring specific files, closes #169
2013-11-08 12:27:34 +08:00
if getbufvar(a:fname, 'tagbar_ignore') == 1
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('File is marked as ignored')
Allow ignoring specific files, closes #169
2013-11-08 12:27:34 +08:00
return 0
endif
Don't consider file as valid if its window is in diff mode
2016-10-23 15:09:46 +08:00
let winnr = bufwinnr(a:fname)
if winnr != -1 && getwinvar(winnr, '&diff')
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Window is in diff mode')
Don't consider file as valid if its window is in diff mode
2016-10-23 15:09:46 +08:00
return 0
endif
Don't update when in previewwindow, closes #112
2013-02-06 16:21:18 +08:00
if &previewwindow
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('In preview window')
Don't update when in previewwindow, closes #112
2013-02-06 16:21:18 +08:00
return 0
endif
Reorder some functions
2012-02-27 21:34:01 +08:00
if !has_key(s:known_types, a:ftype)
if exists('g:tagbar_type_' . a:ftype)
" Filetype definition must have been specified in an 'ftplugin'
" file, so load it now
call s:LoadUserTypeDefs(a:ftype)
else
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('Unsupported filetype: ' . a:ftype)
Reorder some functions
2012-02-27 21:34:01 +08:00
return 0
endif
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
endif
Reorder some functions
2012-02-27 21:34:01 +08:00
return 1
endfunction
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
" s:SetStatusLine() {{{2
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
function! s:SetStatusLine() abort
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
if tagbarwinnr == -1
return
endif
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
" Make sure we're actually in the Tagbar window
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
if tagbarwinnr != winnr()
let in_tagbar = 0
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
let prevwinnr = winnr()
call s:goto_win('p', 1)
let pprevwinnr = winnr()
call s:goto_win(tagbarwinnr, 1)
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
else
let in_tagbar = 1
endif
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
if !empty(tagbar#state#get_current_file(0))
let fileinfo = tagbar#state#get_current_file(0)
Display filetype-specific sort in statusline, closes #292
2016-10-31 12:52:36 +08:00
let fname = fnamemodify(fileinfo.fpath, ':t')
let sorted = get(fileinfo.typeinfo, 'sort', g:tagbar_sort)
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
else
let fname = ''
Display filetype-specific sort in statusline, closes #292
2016-10-31 12:52:36 +08:00
let sorted = g:tagbar_sort
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
endif
Display filetype-specific sort in statusline, closes #292
2016-10-31 12:52:36 +08:00
let sortstr = sorted ? 'Name' : 'Order'
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
Add mapping to toggle autoclose option The current tagbar_autoclose state will be displayed in the statusline. Also change the "hide nonpublic" flag to "v" to match the mapping and properly document the statusline flags.
2014-06-25 13:52:43 +08:00
let flags = []
let flags += exists('w:autoclose') && w:autoclose ? ['c'] : []
let flags += g:tagbar_autoclose ? ['C'] : []
Display filetype-specific sort in statusline, closes #292
2016-10-31 12:52:36 +08:00
let flags += (sorted && g:tagbar_case_insensitive) ? ['i'] : []
Add mapping to toggle autoclose option The current tagbar_autoclose state will be displayed in the statusline. Also change the "hide nonpublic" flag to "v" to match the mapping and properly document the statusline flags.
2014-06-25 13:52:43 +08:00
let flags += g:tagbar_hide_nonpublic ? ['v'] : []
Statusline tweaks
2013-08-21 14:28:40 +08:00
if exists('g:tagbar_status_func')
Display filetype-specific sort in statusline, closes #292
2016-10-31 12:52:36 +08:00
let args = [in_tagbar, sortstr, fname, flags]
Statusline tweaks
2013-08-21 14:28:40 +08:00
let &l:statusline = call(g:tagbar_status_func, args)
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
else
Remove redundant SetStatusLine argument, ref #335 Thank you to @jpmv27 for spotting this.
2016-09-19 19:10:10 +08:00
let colour = in_tagbar ? '%#StatusLine#' : '%#StatusLineNC#'
Add mapping to toggle autoclose option The current tagbar_autoclose state will be displayed in the statusline. Also change the "hide nonpublic" flag to "v" to match the mapping and properly document the statusline flags.
2014-06-25 13:52:43 +08:00
let flagstr = join(flags, '')
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if flagstr !=# ''
Add mapping to toggle autoclose option The current tagbar_autoclose state will be displayed in the statusline. Also change the "hide nonpublic" flag to "v" to match the mapping and properly document the statusline flags.
2014-06-25 13:52:43 +08:00
let flagstr = '[' . flagstr . '] '
endif
Display filetype-specific sort in statusline, closes #292
2016-10-31 12:52:36 +08:00
let text = colour . '[' . sortstr . '] ' . flagstr . fname
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
let &l:statusline = text
endif
if !in_tagbar
Always restore the window history, closes #319 When we have to go to the Tagbar window to update it the knowledge of the previous window to the one we're coming from gets lost. Save it before switching windows so we can restore it after returning from the Tagbar window.
2016-10-16 18:02:18 +08:00
call s:goto_win(pprevwinnr, 1)
call s:goto_win(prevwinnr, 1)
Allow customizing the statusline
2012-03-26 14:42:12 +08:00
endif
endfunction
Rename QuitIfOnlyWindow since it's no longer accurate
2016-10-10 16:51:14 +08:00
" s:HandleOnlyWindow() {{{2
function! s:HandleOnlyWindow() abort
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
if tagbarwinnr == -1
Make sure QuitIfOnlyWindow also works with prevwin open
2013-11-13 11:53:52 +08:00
return
endif
Properly handle closing the last file window, closes #345 When a window that is displaying a normal file gets closed with a :quit, :bdelete or other command, Tagbar may end up as the only visible window left, which isn't very useful. Previously Tagbar would just quit in such a situation (unless there was more than one tab), but that is rather non-intuitive. The change in this commit introduces a mechanism that should hopefully handle such a case properly based on which command was executed, and do exactly what a user would expect: - In the ':quit' case, it will close the current tabpage including Tagbar unless it was the only tabpage, in which case it will quit Vim. - In the ':bdelete/:bwipeout' case, it will delete the Tagbar buffer and then reopen Tagbar once the buffer that Vim switched to is being displayed.
2016-10-09 16:01:24 +08:00
let vim_quitting = s:vim_quitting
let s:vim_quitting = 0
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
if vim_quitting && !s:HasOpenFileWindows()
Log message when closing Tagbar due to QuitPre
2017-09-03 15:07:10 +08:00
call tagbar#debug#log('Closing Tagbar window due to QuitPre event')
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
if winnr('$') >= 1
call s:goto_win(tagbarwinnr, 1)
endif
" Before quitting Vim, delete the tagbar buffer so that the '0 mark is
" correctly set to the previous buffer.
if tabpagenr('$') == 1
Disable autocommands when deleting Tagbar buffer in HandleOnlyWindow This prevents infinite recursion with nested autocommands when using a BufEnter autocommand that calls autoopen().
2016-11-07 07:45:17 +08:00
noautocmd keepalt bdelete
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
endif
try
try
quit
catch /.*/ " This can be E173 and maybe others
call s:OpenWindow('')
echoerr v:exception
endtry
catch /.*/
echohl ErrorMsg
echo v:exception
echohl None
endtry
endif
endfunction
" s:HandleBufDelete() {{{2
HandleBufDelete: Ignore apparent 'set nobuflisted' events
2016-12-17 05:08:28 +08:00
function! s:HandleBufDelete(bufname, bufnr) abort
" Ignore autocmd events generated for "set nobuflisted",
HandleBufDelete: Use str2nr for conversion
2016-12-27 21:05:35 +08:00
let nr = str2nr(a:bufnr)
HandleBufDelete: Ignore apparent 'set nobuflisted' events
2016-12-17 05:08:28 +08:00
if bufexists(nr) && !buflisted(nr)
return
endif
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if tagbarwinnr == -1 || a:bufname =~# '__Tagbar__.*'
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
return
endif
call s:known_files.rm(fnamemodify(a:bufname, ':p'))
if !s:HasOpenFileWindows()
if tabpagenr('$') == 1 && exists('t:tagbar_buf_name')
Properly handle closing the last file window, closes #345 When a window that is displaying a normal file gets closed with a :quit, :bdelete or other command, Tagbar may end up as the only visible window left, which isn't very useful. Previously Tagbar would just quit in such a situation (unless there was more than one tab), but that is rather non-intuitive. The change in this commit introduces a mechanism that should hopefully handle such a case properly based on which command was executed, and do exactly what a user would expect: - In the ':quit' case, it will close the current tabpage including Tagbar unless it was the only tabpage, in which case it will quit Vim. - In the ':bdelete/:bwipeout' case, it will delete the Tagbar buffer and then reopen Tagbar once the buffer that Vim switched to is being displayed.
2016-10-09 16:01:24 +08:00
" The last normal window closed due to a :bdelete/:bwipeout.
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
" In order to get a normal file window back switch to the last
" alternative buffer (or a new one if there is no alternative
" buffer), reset the Tagbar-set window options, and then re-open
" the Tagbar window.
" Ignore the buffer to be deleted, just in case
call setbufvar(a:bufname, 'tagbar_ignore', 1)
if s:last_alt_bufnr == -1 || s:last_alt_bufnr == expand('<abuf>')
if argc() > 1 && argidx() < argc() - 1
" We don't have an alternative buffer, but there are still
" files left in the argument list
next
else
enew
endif
else
Save last alt bufnr before switching buffers, closes #385 When switching buffers during the handling of the BufDelete event the saved buffer number of the last alternate buffer will change, so we have to save a local copy to be able to properly unset the 'tagbar_ignore' buffer variable.
2017-01-03 10:21:10 +08:00
" Save a local copy as the global value will change
" during buffer switching
let last_alt_bufnr = s:last_alt_bufnr
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
" Ignore the buffer we're switching to for now, it will get
" processed due to the OpenWindow() call anyway
Save last alt bufnr before switching buffers, closes #385 When switching buffers during the handling of the BufDelete event the saved buffer number of the last alternate buffer will change, so we have to save a local copy to be able to properly unset the 'tagbar_ignore' buffer variable.
2017-01-03 10:21:10 +08:00
call setbufvar(last_alt_bufnr, 'tagbar_ignore', 1)
execute 'keepalt buffer' last_alt_bufnr
call setbufvar(last_alt_bufnr, 'tagbar_ignore', 0)
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
endif
" Reset Tagbar window-local options
Properly handle closing the last file window, closes #345 When a window that is displaying a normal file gets closed with a :quit, :bdelete or other command, Tagbar may end up as the only visible window left, which isn't very useful. Previously Tagbar would just quit in such a situation (unless there was more than one tab), but that is rather non-intuitive. The change in this commit introduces a mechanism that should hopefully handle such a case properly based on which command was executed, and do exactly what a user would expect: - In the ':quit' case, it will close the current tabpage including Tagbar unless it was the only tabpage, in which case it will quit Vim. - In the ':bdelete/:bwipeout' case, it will delete the Tagbar buffer and then reopen Tagbar once the buffer that Vim switched to is being displayed.
2016-10-09 16:01:24 +08:00
set winfixwidth<
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
call s:OpenWindow('')
Don't close new tab
2016-09-28 18:20:25 +08:00
elseif exists('t:tagbar_buf_name')
Reorder some functions
2012-02-27 21:34:01 +08:00
close
endif
endif
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
endfunction
Make sure QuitIfOnlyWindow also works with prevwin open
2013-11-13 11:53:52 +08:00
Update tags on CursorHold after writing Currently the tags will always get updated immediately when writing a file. However, for large files that can slow down the writing process noticeably, leading to annoying pauses. This commit instead defers the updating process to the first CursorHold/CursorHoldI event after writing a file, which should make the process much less noticeable. Closes #289 Closes #381 References SpaceVim/SpaceVim#129
2017-02-05 13:51:28 +08:00
" s:HandleBufWrite() {{{2
function! s:HandleBufWrite(fname) abort
if index(s:delayed_update_files, a:fname) == -1
call add(s:delayed_update_files, a:fname)
endif
endfunction
" s:do_delayed_update() {{{2
function! s:do_delayed_update() abort
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
let curfile = tagbar#state#get_current_file(0)
Update tags on CursorHold after writing Currently the tags will always get updated immediately when writing a file. However, for large files that can slow down the writing process noticeably, leading to annoying pauses. This commit instead defers the updating process to the first CursorHold/CursorHoldI event after writing a file, which should make the process much less noticeable. Closes #289 Closes #381 References SpaceVim/SpaceVim#129
2017-02-05 13:51:28 +08:00
if empty(curfile)
let curfname = ''
else
let curfname = curfile.fpath
endif
while !empty(s:delayed_update_files)
let fname = remove(s:delayed_update_files, 0)
let no_display = curfname !=# fname
call s:AutoUpdate(fname, 1, no_display)
endwhile
endfunction
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
" s:ReopenWindow() {{{2
function! s:ReopenWindow(delbufname) abort
if expand('<amatch>') == a:delbufname
return
Don't choke when run from netrw, closes #291
2016-09-20 19:30:18 +08:00
endif
Verify that window number is valid before switching to it
2016-02-25 03:19:45 +08:00
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
autocmd! TagbarAutoCmds BufWinEnter
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
call s:OpenWindow('')
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
endfunction
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
" s:HasOpenFileWindows() {{{2
function! s:HasOpenFileWindows() abort
Small patch cleanup
2013-02-06 13:43:51 +08:00
for i in range(1, winnr('$'))
let buf = winbufnr(i)
Quit if no more normal window exists There might be other plugin windows but no normal file window open, we need to make sure tagbar window is closed at this situation.
2012-11-10 04:17:27 +08:00
Don't choke when run from netrw, closes #291
2016-09-20 19:30:18 +08:00
" skip unlisted buffers, except for netrw
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if !buflisted(buf) && getbufvar(buf, '&filetype') !=# 'netrw'
Quit if no more normal window exists There might be other plugin windows but no normal file window open, we need to make sure tagbar window is closed at this situation.
2012-11-10 04:17:27 +08:00
continue
endif
" skip temporary buffers with buftype set
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
if getbufvar(buf, '&buftype') !=# ''
Quit if no more normal window exists There might be other plugin windows but no normal file window open, we need to make sure tagbar window is closed at this situation.
2012-11-10 04:17:27 +08:00
continue
endif
Ignore preview window when quitting
2013-11-11 12:39:48 +08:00
" skip the preview window
if getwinvar(i, '&previewwindow')
continue
endif
Quit if no more normal window exists There might be other plugin windows but no normal file window open, we need to make sure tagbar window is closed at this situation.
2012-11-10 04:17:27 +08:00
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
return 1
Small patch cleanup
2013-02-06 13:43:51 +08:00
endfor
Fix quit/bdelete cases properly This commit should (hopefully) finally fix the case of users calling ':bdelete/:bwipeout' or ':quit' while Tagbar is open and just do the right thing. See commit e4cfe8a for a more thorough description of how it's supposed to work.
2016-10-15 15:08:10 +08:00
return 0
Small patch cleanup
2013-02-06 13:43:51 +08:00
endfunction
Quit if no more normal window exists There might be other plugin windows but no normal file window open, we need to make sure tagbar window is closed at this situation.
2012-11-10 04:17:27 +08:00
Give each tab its own tagbar instance data
2016-09-25 05:49:35 +08:00
" s:TagbarBufName() {{{2
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
function! s:TagbarBufName() abort
if !exists('t:tagbar_buf_name')
let s:buffer_seqno += 1
let t:tagbar_buf_name = '__Tagbar__.' . s:buffer_seqno
endif
return t:tagbar_buf_name
endfunction
Clean up window switching
2013-11-15 11:21:12 +08:00
" s:goto_win() {{{2
function! s:goto_win(winnr, ...) abort
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
let cmd = type(a:winnr) == type(0) ? a:winnr . 'wincmd w'
\ : 'wincmd ' . a:winnr
Clean up window switching
2013-11-15 11:21:12 +08:00
let noauto = a:0 > 0 ? a:1 : 0
Add some more debugging messages
2012-02-23 15:41:31 +08:00
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
call tagbar#debug#log('goto_win(): ' . cmd . ', ' . noauto)
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
Clean up window switching
2013-11-15 11:21:12 +08:00
if noauto
noautocmd execute cmd
else
execute cmd
endif
Abstract out window commands without autocommands
2012-01-31 15:58:49 +08:00
endfunction
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
" s:goto_tagbar() {{{2
function! s:goto_tagbar(...) abort
let noauto = a:0 > 0 ? a:1 : 0
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
call s:goto_win(bufwinnr(s:TagbarBufName()), noauto)
Improve preview window handling Use psearch instead of pedit since pedit essentially reloads the file and creates an empty undo entry. This also makes it faster.
2013-11-29 13:40:09 +08:00
endfunction
Jump to correct window even after opening preview window
2014-02-01 16:17:00 +08:00
" s:mark_window() {{{2
" Mark window with a window-local variable so we can jump back to it even if
" the window numbers have changed.
function! s:mark_window() abort
let w:tagbar_mark = 1
endfunction
" s:goto_markedwin() {{{2
" Go to a previously marked window and delete the mark.
Small preview window improvements, ref #161
2014-10-14 10:59:29 +08:00
function! s:goto_markedwin(...) abort
let noauto = a:0 > 0 ? a:1 : 0
Jump to correct window even after opening preview window
2014-02-01 16:17:00 +08:00
for window in range(1, winnr('$'))
Small preview window improvements, ref #161
2014-10-14 10:59:29 +08:00
call s:goto_win(window, noauto)
Jump to correct window even after opening preview window
2014-02-01 16:17:00 +08:00
if exists('w:tagbar_mark')
unlet w:tagbar_mark
break
endif
endfor
endfunction
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
" s:warning() {{{2
function! s:warning(msg) abort
echohl WarningMsg
echomsg a:msg
echohl None
endfunction
Add map to allow pausing/unpausing tagbar
2018-06-15 16:27:33 +08:00
" s:TogglePause() {{{2
function! s:TogglePause() abort
let s:paused = !s:paused
if s:paused
call tagbar#state#set_paused()
else
let fileinfo = tagbar#state#get_current_file(0)
let taginfo = fileinfo.getTags()[0]
call s:GotoFileWindow(taginfo.fileinfo)
call s:AutoUpdate(taginfo.fileinfo.fpath, 1)
endif
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" TagbarBalloonExpr() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! TagbarBalloonExpr() abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
let taginfo = s:GetTagInfo(v:beval_lnum, 1)
if empty(taginfo)
Only generate prototypes on-demand
2012-08-26 21:57:56 +08:00
return ''
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endif
fixed encoding bug of balloon
2017-09-18 14:53:48 +08:00
let prototype = taginfo.getPrototype(0)
if has('multi_byte')
if g:tagbar_systemenc != &encoding
let prototype = iconv(prototype, &encoding, g:tagbar_systemenc)
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
elseif $LANG !=# ''
fixed encoding bug of balloon
2017-09-18 14:53:48 +08:00
let prototype = iconv(prototype, &encoding, $LANG)
endif
endif
return prototype
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
" Autoload functions {{{1
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
" Wrappers {{{2
flags argument added to functions responsible for window toggling
2016-10-11 15:41:01 +08:00
function! tagbar#ToggleWindow(...) abort
let flags = a:0 > 0 ? a:1 : ''
call s:ToggleWindow(flags)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! tagbar#OpenWindow(...) abort
Make TagbarOpen command more flexible
2011-11-23 14:56:31 +08:00
let flags = a:0 > 0 ? a:1 : ''
call s:OpenWindow(flags)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! tagbar#CloseWindow() abort
Move most of script to autoload
2011-06-29 04:59:49 +08:00
call s:CloseWindow()
endfunction
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! tagbar#SetFoldLevel(level, force) abort
Make SetFoldlevel respect default-closed folds without '!', closes #61
2012-03-14 17:41:39 +08:00
call s:SetFoldLevel(a:level, a:force)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
Fix some TagbarShowTag bugs, closes #108
2012-09-15 12:49:28 +08:00
function! tagbar#highlighttag(openfolds, force) abort
Give each tab its own tagbar buffer
2016-09-25 05:48:52 +08:00
let tagbarwinnr = bufwinnr(s:TagbarBufName())
Fix some TagbarShowTag bugs, closes #108
2012-09-15 12:49:28 +08:00
if tagbarwinnr == -1
echohl WarningMsg
echomsg "Warning: Can't highlight tag, Tagbar window not open"
echohl None
return
endif
call s:HighlightTag(a:openfolds, a:force)
Move most of script to autoload
2011-06-29 04:59:49 +08:00
endfunction
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! tagbar#RestoreSession() abort
move basic init & autocmd back to plugin/
2011-07-03 17:14:56 +08:00
call s:RestoreSession()
endfunction
Pause autocmd functionality with :TagbarPause tagbar#PauseAutocommands :TagbarPause :TagbarPause pauses autocmds, effectively freezing Tagbar on the last file. Useful for keeping a tag reference for a file open whilst working in a different file.
2012-10-01 21:22:35 +08:00
Add tagbar#StopAutoUpdate This is useful to stop updating information, after using `tagbar#currenttag` manually/temporarily only.
2018-01-12 00:13:51 +08:00
function! tagbar#StopAutoUpdate() abort
autocmd! TagbarAutoCmds
let s:autocommands_done = 0
endfunction
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
" }}}2
move basic init & autocmd back to plugin/
2011-07-03 17:14:56 +08:00
Rework pause functionality, closes #177 The current pause functionality simply removes all the autocommands to stop updating Tagbar. This has the problem that at the moment the statusline functions immediately restore the commands so pausing doesn't work, but even if that didn't happen it would stop the statusline functionality from working which is not desirable. The solution is to have a reference to the paused file which will get used by the Tagbar window, but not the statusline functions.
2013-11-06 17:33:27 +08:00
" tagbar#toggle_pause() {{{2
function! tagbar#toggle_pause() abort
let s:paused = !s:paused
if s:paused
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
call tagbar#state#set_paused()
Rework pause functionality, closes #177 The current pause functionality simply removes all the autocommands to stop updating Tagbar. This has the problem that at the moment the statusline functions immediately restore the commands so pausing doesn't work, but even if that didn't happen it would stop the statusline functionality from working which is not desirable. The solution is to have a reference to the paused file which will get used by the Tagbar window, but not the statusline functions.
2013-11-06 17:33:27 +08:00
else
call s:AutoUpdate(fnamemodify(expand('%'), ':p'), 1)
endif
endfunction
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
function! tagbar#is_paused() abort
return s:paused
endfunction
Move parsing of user type defs into separate function
2012-03-08 13:06:51 +08:00
" tagbar#getusertypes() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! tagbar#getusertypes() abort
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
let userdefs = filter(copy(g:), 'v:key =~? "^tagbar_type_"')
Move parsing of user type defs into separate function
2012-03-08 13:06:51 +08:00
Simplify getusertypes() function
2013-04-05 06:57:57 +08:00
let typedict = {}
for [key, val] in items(userdefs)
let type = substitute(key, '^tagbar_type_', '', '')
let typedict[type] = val
Move parsing of user type defs into separate function
2012-03-08 13:06:51 +08:00
endfor
Simplify getusertypes() function
2013-04-05 06:57:57 +08:00
return typedict
Move parsing of user type defs into separate function
2012-03-08 13:06:51 +08:00
endfunction
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
" tagbar#autoopen() {{{2
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
" Automatically open Tagbar if one of the open buffers contains a supported
" file
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! tagbar#autoopen(...) abort
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('tagbar#autoopen called [' . bufname('%') . ']')
Add 'always' parameter to autoopen()
2012-01-14 14:35:01 +08:00
let always = a:0 > 0 ? a:1 : 1
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
call s:Init(0)
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
for bufnr in range(1, bufnr('$'))
Add 'always' parameter to autoopen()
2012-01-14 14:35:01 +08:00
if buflisted(bufnr) && (always || bufwinnr(bufnr) != -1)
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
let ftype = s:DetectFiletype(bufnr)
if s:IsValidFile(bufname(bufnr), ftype)
call s:OpenWindow('')
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('tagbar#autoopen finished after finding valid ' .
Rename debug log function
2014-04-03 19:39:26 +08:00
\ 'file [' . bufname(bufnr) . ']')
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
return
endif
endif
endfor
Add some more debugging messages
2012-02-23 15:41:31 +08:00
Extract debug functionality into separate file
2017-08-20 13:02:36 +08:00
call tagbar#debug#log('tagbar#autoopen finished without finding valid file')
Add convenience function for automatically opening Tagbar
2011-12-21 14:28:34 +08:00
endfunction
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
" tagbar#currenttag() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! tagbar#currenttag(fmt, default, ...) abort
Remove autocmds when not needed, closes #153 When the Tagbar window gets closed and the statusline functionality is not in use, remove the autocommands to prevent unnecessary ctags calls.
2013-07-30 07:38:46 +08:00
" Indicate that the statusline functionality is being used. This prevents
" the CloseWindow() function from removing the autocommands.
let s:statusline_in_use = 1
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
if a:0 > 0
" also test for non-zero value for backwards compatibility
Allow prototype to be shown with currenttag
2012-09-09 16:17:44 +08:00
let longsig = a:1 =~# 's' || (type(a:1) == type(0) && a:1 != 0)
let fullpath = a:1 =~# 'f'
let prototype = a:1 =~# 'p'
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
else
Allow prototype to be shown with currenttag
2012-09-09 16:17:44 +08:00
let longsig = 0
let fullpath = 0
let prototype = 0
Allow the full hierarchy to be displayed in currenttag()
2012-04-15 19:10:34 +08:00
endif
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
if !s:Init(1)
return a:default
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
endif
Rework pause functionality, closes #177 The current pause functionality simply removes all the autocommands to stop updating Tagbar. This has the problem that at the moment the statusline functions immediately restore the commands so pausing doesn't work, but even if that didn't happen it would stop the statusline functionality from working which is not desirable. The solution is to have a reference to the paused file which will get used by the Tagbar window, but not the statusline functions.
2013-11-06 17:33:27 +08:00
let tag = s:GetNearbyTag(0, 1)
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
if !empty(tag)
Allow prototype to be shown with currenttag
2012-09-09 16:17:44 +08:00
if prototype
return tag.getPrototype(1)
else
return printf(a:fmt, tag.str(longsig, fullpath))
endif
Add function that returns the current tag, closes #59
2012-02-28 19:21:50 +08:00
else
return a:default
endif
endfunction
Export tagbar#currentfile() function
2013-05-15 20:00:08 +08:00
" tagbar#currentfile() {{{2
function! tagbar#currentfile() abort
let filename = ''
Extract prototypes to separate autoload files
2017-08-13 14:55:28 +08:00
if !empty(tagbar#state#get_current_file(1))
let filename = fnamemodify(tagbar#state#get_current_file(1).fpath, ':t')
Export tagbar#currentfile() function
2013-05-15 20:00:08 +08:00
endif
return filename
endfunction
Add command for easy type customization
2012-06-16 17:46:54 +08:00
" tagbar#gettypeconfig() {{{2
Add 'abort' keyword to all functions
2012-07-19 21:12:00 +08:00
function! tagbar#gettypeconfig(type) abort
Handle missing ctags more gracefully in currenttag If tagbar#currenttag() was used in a statusline on a system that had Tagbar installed, but not ctags, then an error was reported on every statusline update. Change the ctags checking so that errors in currenttag() fail silently while still reporting an error message if Tagbar is opened normally.
2012-07-01 14:48:00 +08:00
if !s:Init(1)
Add command for easy type customization
2012-06-16 17:46:54 +08:00
return ''
endif
let typeinfo = get(s:known_types, a:type, {})
if empty(typeinfo)
Make errors less fatal, closes #215 Instead of using 'echoerr' and essentially breaking the plugin after that problems are now reported as warnings with 'echomsg'. They will also only be shown once for a particular problem.
2014-10-27 17:35:19 +08:00
call s:warning('Unknown type ' . a:type . '!')
Add command for easy type customization
2012-06-16 17:46:54 +08:00
return
endif
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
let output = 'let g:tagbar_type_' . a:type . " = {\n"
Add command for easy type customization
2012-06-16 17:46:54 +08:00
let output .= " \\ 'kinds' : [\n"
for kind in typeinfo.kinds
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
let output .= " \\ '" . kind.short . ':' . kind.long
Add command for easy type customization
2012-06-16 17:46:54 +08:00
if kind.fold || !kind.stl
if kind.fold
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
let output .= ':1'
Add command for easy type customization
2012-06-16 17:46:54 +08:00
else
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
let output .= ':0'
Add command for easy type customization
2012-06-16 17:46:54 +08:00
endif
endif
if !kind.stl
Fix syntax issues that are lint warnings
2019-10-22 22:08:25 +08:00
let output .= ':0'
Add command for easy type customization
2012-06-16 17:46:54 +08:00
endif
let output .= "',\n"
endfor
let output .= " \\ ],\n"
let output .= "\\ }"
silent put =output
endfunction
Add simple inspect() debug function
2014-10-27 17:38:59 +08:00
" tagbar#inspect() {{{2
function! tagbar#inspect(var) abort
return get(s:, a:var)
endfunction
Move most of script to autoload
2011-06-29 04:59:49 +08:00
" Modeline {{{1
Move some tests to autoload
2011-07-15 13:34:47 +08:00
" vim: ts=8 sw=4 sts=4 et foldenable foldmethod=marker foldcolumn=1
Reference in New Issue Copy Permalink