tagbar/plugin/tagbar.vim
2011-01-26 19:17:09 +13:00

1328 lines
38 KiB
VimL

" ============================================================================
" File: tagbar.vim
" Description: List the current file's tags in a sidebar, ordered by class etc
" Maintainer: Jan Larres <jan@majutsushi.net>
" Licence: Vim licence
" Website: http://github.com/majutsushi/tagbar
" Note: This plugin was heavily inspired by the 'Taglist' plugin by
" Yegappan Lakshmanan and uses some small portions of code from
" it.
" ============================================================================
if &cp || exists('g:loaded_tagbar')
finish
endif
" Initialization {{{1
if !exists('*system')
echomsg 'Tagbar: No system() function available, skipping plugin'
finish
endif
if !exists('g:tagbar_ctags_bin')
if executable('ctags-exuberant')
let g:tagbar_ctags_bin = 'ctags-exuberant'
elseif executable('exctags')
let g:tagbar_ctags_bin = 'exctags'
elseif executable('ctags')
let g:tagbar_ctags_bin = 'ctags'
elseif executable('ctags.exe')
let g:tagbar_ctags_bin = 'ctags.exe'
elseif executable('tags')
let g:tagbar_ctags_bin = 'tags'
else
echomsg 'Tagbar: Exuberant ctags not found, skipping plugin'
finish
endif
endif
let g:loaded_tagbar = 1
if !exists('g:tagbar_left')
let g:tagbar_left = 0
endif
if !exists('g:tagbar_width')
let g:tagbar_width = 40
endif
if !exists('g:tagbar_types')
let g:tagbar_types = {}
endif
if !exists('g:tagbar_autoclose')
let g:tagbar_autoclose = 0
endif
if !exists('g:tagbar_sort')
let g:tagbar_sort = 1
endif
let s:type_init_done = 0
" s:InitTypes() {{{1
function! s:InitTypes()
" Dictionary of the already processed files, indexed by file name with
" complete path.
" The entries are again dictionaries with the following fields:
" - mtime: File modification time
" - ftype: The vim file type
" - tags: List of the tags that are present in the file, sorted
" according to the value of 'g:tagbar_sort'
" - fline: Dictionary of the tags, indexed by line number in the file
" - tline: Dictionary of the tags, indexed by line number in the tagbar
let s:known_files = {}
let s:known_types = {}
" Ant {{{2
let type_ant = {}
let type_ant.ctagstype = 'ant'
let type_ant.kinds = [
\ 'p:projects',
\ 't:targets'
\ ]
let s:known_types.ant = type_ant
" Asm {{{2
let type_asm = {}
let type_asm.ctagstype = 'asm'
let type_asm.kinds = [
\ 'm:macros',
\ 't:types',
\ 'd:defines',
\ 'l:labels'
\ ]
let s:known_types.asm = type_asm
" ASP {{{2
let type_aspvbs = {}
let type_aspvbs.ctagstype = 'asp'
let type_aspvbs.kinds = [
\ 'd:constants',
\ 'c:classes',
\ 'f:functions',
\ 's:subroutines',
\ 'v:variables'
\ ]
let s:known_types.aspvbs = type_aspvbs
" Awk {{{2
let type_awk = {}
let type_awk.ctagstype = 'awk'
let type_awk.kinds = [
\ 'f:functions'
\ ]
let s:known_types.awk = type_awk
" Basic {{{2
let type_basic = {}
let type_basic.ctagstype = 'basic'
let type_basic.kinds = [
\ 'c:constants',
\ 'g:enumerations',
\ 'f:functions',
\ 'l:labels',
\ 't:types',
\ 'v:variables'
\ ]
let s:known_types.basic = type_basic
" BETA {{{2
let type_beta = {}
let type_beta.ctagstype = 'beta'
let type_beta.kinds = [
\ 'f:fragments',
\ 's:slots',
\ 'v:patterns'
\ ]
let s:known_types.beta = type_beta
" C {{{2
let type_c = {}
let type_c.ctagstype = 'c'
let type_c.scopes = ['enum', 'struct', 'union']
let type_c.sro = '::'
let type_c.kinds = [
\ 'd:macros',
\ 'p:prototypes',
\ 'g:enums',
\ 'e:enumerators',
\ 't:typedefs',
\ 's:structs',
\ 'u:unions',
\ 'm:members',
\ 'v:variables',
\ 'f:functions'
\ ]
let type_c.kind2scope = {
\ 'g' : 'enum',
\ 's' : 'struct',
\ 'u' : 'union'
\ }
let type_c.scope2kind = {
\ 'enum' : 'g',
\ 'struct' : 's',
\ 'union' : 'u'
\ }
let s:known_types.c = type_c
" C++ {{{2
let type_cpp = {}
let type_cpp.ctagstype = 'c++'
let type_cpp.scopes = [
\ 'namespace',
\ 'class',
\ 'struct',
\ 'enum',
\ 'union'
\ ]
let type_cpp.sro = '::'
let type_cpp.kinds = [
\ 'd:macros',
\ 'p:prototypes',
\ 'g:enums',
\ 'e:enumerators',
\ 't:typedefs',
\ 'n:namespaces',
\ 'c:classes',
\ 's:structs',
\ 'u:unions',
\ 'f:functions',
\ 'm:members',
\ 'v:variables'
\ ]
let type_cpp.kind2scope = {
\ 'g' : 'enum',
\ 'n' : 'namespace',
\ 'c' : 'class',
\ 's' : 'struct',
\ 'u' : 'union'
\ }
let type_cpp.scope2kind = {
\ 'enum' : 'g',
\ 'namespace' : 'n',
\ 'class' : 'c',
\ 'struct' : 's',
\ 'union' : 'u'
\ }
let s:known_types.cpp = type_cpp
" C# {{{2
let type_cs = {}
let type_cs.ctagstype = 'c#'
let type_cs.scopes = [
\ 'namespace',
\ 'interface',
\ 'class',
\ 'struct',
\ 'enum'
\ ]
let type_cs.sro = '.'
let type_cs.kinds = [
\ 'd:macros',
\ 'f:fields',
\ 'g:enums',
\ 'e:enumerators',
\ 't:typedefs',
\ 'n:namespaces',
\ 'i:interfaces',
\ 'c:classes',
\ 's:structs',
\ 'E:events',
\ 'm:methods',
\ 'p:properties'
\ ]
let type_cs.kind2scope = {
\ 'n' : 'namespace',
\ 'i' : 'interface',
\ 'c' : 'class',
\ 's' : 'struct',
\ 'g' : 'enum'
\ }
let type_cs.scope2kind = {
\ 'namespace' : 'n',
\ 'interface' : 'i',
\ 'class' : 'c',
\ 'struct' : 's',
\ 'enum' : 'g'
\ }
let s:known_types.cs = type_cs
" COBOL {{{2
let type_cobol = {}
let type_cobol.ctagstype = 'cobol'
let type_cobol.kinds = [
\ 'd:data items',
\ 'f:file descriptions',
\ 'g:group items',
\ 'p:paragraphs',
\ 'P:program ids',
\ 's:sections'
\ ]
let s:known_types.cobol = type_cobol
" DOS Batch {{{2
let type_dosbatch = {}
let type_dosbatch.ctagstype = 'dosbatch'
let type_dosbatch.kinds = [
\ 'l:labels',
\ 'v:variables'
\ ]
let s:known_types.dosbatch = type_dosbatch
" Eiffel {{{2
let type_eiffel = {}
let type_eiffel.ctagstype = 'eiffel'
let type_eiffel.scopes = ['class', 'feature']
let type_eiffel.sro = '.' " Not sure, is nesting even possible?
let type_eiffel.kinds = [
\ 'c:classes',
\ 'f:features'
\ ]
let type_eiffel.kind2scope = {
\ 'c' : 'class',
\ 'f' : 'feature'
\ }
let type_eiffel.scope2kind = {
\ 'class' : 'c',
\ 'feature' : 'f'
\ }
let s:known_types.eiffel = type_eiffel
" Java {{{2
let type_java = {}
let type_java.ctagstype = 'java'
let type_java.scopes = ['enum', 'interface', 'class']
let type_java.sro = '.'
let type_java.kinds = [
\ 'p:packages',
\ 'f:fields',
\ 'g:enum types',
\ 'e:enum constants',
\ 'i:interfaces',
\ 'c:classes',
\ 'm:methods'
\ ]
let type_java.kind2scope = {
\ 'g' : 'enum',
\ 'i' : 'interface',
\ 'c' : 'class'
\ }
let type_java.scope2kind = {
\ 'enum' : 'g',
\ 'interface' : 'i',
\ 'class' : 'c'
\ }
let s:known_types.java = type_java
" Python {{{2
let type_python = {}
let type_python.ctagstype = 'python'
let type_python.scopes = ['class', 'function']
let type_python.sro = '.'
let type_python.kinds = [
\ 'i:imports',
\ 'c:classes',
\ 'f:functions',
\ 'm:members',
\ 'v:variables'
\ ]
let type_python.kind2scope = {
\ 'c' : 'class',
\ 'f' : 'function',
\ 'm' : 'function'
\ }
let type_python.scope2kind = {
\ 'class' : 'c',
\ 'function' : 'f'
\ }
let s:known_types.python = type_python
" }}}2
call extend(s:known_types, g:tagbar_types)
" Create a dictionary of the kind order for fast
" access in sorting functions
for type in values(s:known_types)
let i = 0
let type.kinddict = {}
for kind in type.kinds
let type.kinddict[kind[0]] = i
let i += 1
endfor
endfor
let s:access_symbols = {}
let s:access_symbols.public = '+'
let s:access_symbols.protected = '#'
let s:access_symbols.private = '-'
let s:type_init_done = 1
endfunction
" s:ToggleWindow() {{{1
function! s:ToggleWindow()
let tagbarwinnr = bufwinnr("__Tagbar__")
if tagbarwinnr != -1
call s:CloseWindow()
return
endif
call s:OpenWindow()
endfunction
" s:OpenWindow() {{{1
function! s:OpenWindow()
if !s:type_init_done
call s:InitTypes()
endif
" If the tagbar window is already open jump to it
let tagbarwinnr = bufwinnr('__Tagbar__')
if tagbarwinnr != -1 && winnr() != tagbarwinnr
execute tagbarwinnr . 'wincmd w'
return
endif
let openpos = g:tagbar_left ? 'topleft vertical ' : 'botright vertical '
exe 'silent! keepalt ' . openpos . g:tagbar_width . 'split ' . '__Tagbar__'
setlocal noreadonly " in case the "view" mode is used
setlocal buftype=nofile
setlocal bufhidden=hide
setlocal noswapfile
setlocal nobuflisted
setlocal nomodifiable
setlocal filetype=tagbar
setlocal nolist
setlocal nonumber
setlocal nowrap
setlocal winfixwidth
if exists('+relativenumber')
setlocal norelativenumber
endif
setlocal foldenable
setlocal foldminlines=0
setlocal foldmethod=manual
setlocal foldlevel=9999
setlocal foldcolumn=1
setlocal foldtext=v:folddashes.getline(v:foldstart)
" Variable for saving the current file for functions that are called from
" the tagbar window
let s:current_file = ''
" Script-local variable needed since compare functions can't
" take extra arguments
let s:compare_typeinfo = {}
let s:is_maximized = 0
let s:short_help = 1
syntax match Comment '^" .*' " Comments
syntax match Identifier '^ [^: ]\+[^:]\+$' " Non-scoped kinds
syntax match Title '[^:(* ]\+\ze\*\? :' " Scope names
syntax match Type ': \zs.*' " Scope types
syntax match SpecialKey '(.*)' " Signatures
syntax match NonText '\*\ze :' " Pseudo-tag identifiers
highlight default TagbarAccessPublic guifg=Green ctermfg=Green
highlight default TagbarAccessProtected guifg=Blue ctermfg=Blue
highlight default TagbarAccessPrivate guifg=Red ctermfg=Red
syntax match TagbarAccessPublic '^\s*+\ze[^ ]'
syntax match TagbarAccessProtected '^\s*#\ze[^ ]'
syntax match TagbarAccessPrivate '^\s*-\ze[^ ]'
if has('balloon_eval')
setlocal balloonexpr=TagbarBalloonExpr()
set ballooneval
endif
let cpoptions_save = &cpoptions
set cpoptions&vim
nnoremap <script> <silent> <buffer> s :call <SID>ToggleSort()<CR>
nnoremap <script> <silent> <buffer> <CR> :call <SID>JumpToTag()<CR>
nnoremap <script> <silent> <buffer> <2-LeftMouse>
\ :call <SID>JumpToTag()<CR>
nnoremap <script> <silent> <buffer> <Space> :call <SID>ShowPrototype()<CR>
nnoremap <script> <silent> <buffer> x :call <SID>ZoomWindow()<CR>
nnoremap <script> <silent> <buffer> q :close<CR>
nnoremap <script> <silent> <buffer> <F1> :call <SID>ToggleHelp()<CR>
augroup TagbarAutoCmds
autocmd!
autocmd BufEnter __Tagbar__ nested call s:QuitIfOnlyWindow()
autocmd BufUnload __Tagbar__ call s:CleanUp()
autocmd CursorHold __Tagbar__ call s:ShowPrototype()
" autocmd TabEnter * silent call s:Tlist_Refresh_Folds()
autocmd BufEnter,CursorHold * silent call s:AutoUpdate(
\ fnamemodify(bufname('%'), ':p'))
augroup END
let &cpoptions = cpoptions_save
execute 'wincmd p'
" Jump back to the tagbar window if autoclose is set. Can't just stay in
" it since it wouldn't trigger the update event
if g:tagbar_autoclose
let tagbarwinnr = bufwinnr('__Tagbar__')
execute tagbarwinnr . 'wincmd w'
endif
endfunction
" s:CloseWindow() {{{1
function! s:CloseWindow()
let tagbarwinnr = bufwinnr('__Tagbar__')
if tagbarwinnr == -1
return
endif
if winnr() == tagbarwinnr
if winbufnr(2) != -1
" Other windows are open, only close the tagbar one
close
endif
else
" Go to the tagbar window, close it and then come back to the
" original window
let curbufnr = bufnr('%')
execute tagbarwinnr . 'wincmd w'
close
" Need to jump back to the original window only if we are not
" already in that window
let winnum = bufwinnr(curbufnr)
if winnr() != winnum
exe winnum . 'wincmd w'
endif
endif
endfunction
" s:ZoomWindow() {{{1
function! s:ZoomWindow()
if s:is_maximized
execute 'vert resize ' . g:tagbar_width
let s:is_maximized = 0
else
vert resize
let s:is_maximized = 1
endif
endfunction
" s:CleanUp() {{{1
function! s:CleanUp()
silent! autocmd! TagbarAutoCmds
unlet s:current_file
unlet s:is_maximized
unlet s:compare_typeinfo
unlet s:short_help
endfunction
" s:QuitIfOnlyWindow() {{{1
function! s:QuitIfOnlyWindow()
" Before quitting Vim, delete the tagbar buffer so that
" the '0 mark is correctly set to the previous buffer.
if winbufnr(2) == -1
" Check if there is more than one tab page
if tabpagenr('$') == 1
bdelete
quit
else
close
endif
endif
endfunction
" s:AutoUpdate() {{{1
function! s:AutoUpdate(fname)
call s:RefreshContent(a:fname)
let tagbarwinnr = bufwinnr('__Tagbar__')
if tagbarwinnr == -1 || &filetype == 'tagbar'
return
endif
if !has_key(s:known_files, a:fname)
return
endif
let s:current_file = a:fname
call s:HighlightTag(a:fname)
endfunction
" s:RefreshContent() {{{1
function! s:RefreshContent(fname)
" Don't do anything if we're in the tagbar window
if &filetype == 'tagbar'
return
endif
if has_key(s:known_files, a:fname)
if s:known_files[a:fname].mtime != getftime(a:fname)
call s:ProcessFile(a:fname, &filetype)
endif
else
call s:ProcessFile(a:fname, &filetype)
endif
let tagbarwinnr = bufwinnr('__Tagbar__')
if tagbarwinnr != -1
call s:RenderContent(a:fname, &filetype)
endif
endfunction
" s:IsValidFile() {{{1
function! s:IsValidFile(fname, ftype)
if a:fname == '' || a:ftype == ''
return 0
endif
if !filereadable(a:fname)
return 0
endif
if !has_key(s:known_types, a:ftype)
return 0
endif
return 1
endfunction
" s:ProcessFile() {{{1
function! s:ProcessFile(fname, ftype)
if !s:IsValidFile(a:fname, a:ftype)
return
endif
let typeinfo = s:known_types[a:ftype]
let ctags_args = ' -f - '
let ctags_args .= ' --format=2 '
let ctags_args .= ' --excmd=pattern '
let ctags_args .= ' --fields=nksSaz '
let ctags_args .= ' --extra= '
let ctags_args .= ' --sort=yes '
let ctags_type = typeinfo.ctagstype
let ctags_kinds = ""
for kind in typeinfo.kinds
let [short, full] = split(kind, ':')
let ctags_kinds .= short
endfor
let ctags_args .= ' --language-force=' . ctags_type .
\ ' --' . ctags_type . '-kinds=' . ctags_kinds . ' '
let ctags_cmd = g:tagbar_ctags_bin . ctags_args . shellescape(a:fname)
let ctags_output = system(ctags_cmd)
if v:shell_error
let msg = 'Tagbar: Could not generate tags for ' . a:fname
call s:PrintWarningMsg(msg)
if !empty(ctags_output)
call s:PrintWarningMsg(ctags_output)
endif
return
endif
let fileinfo = {}
let fileinfo.mtime = getftime(a:fname)
let rawtaglist = split(ctags_output, '\n\+')
let fileinfo.ftype = a:ftype
let fileinfo.tags = []
let fileinfo.fline = {}
let fileinfo.tline = {}
for line in rawtaglist
let parts = split(line, ';"')
if len(parts) == 2 " Is a valid tag line
let taginfo = s:ParseTagline(parts[0], parts[1], typeinfo)
let fileinfo.fline[taginfo.fields.line] = taginfo
call add(fileinfo.tags, taginfo)
endif
endfor
if has_key(typeinfo, 'scopes') && !empty(typeinfo.scopes)
let scopedtags = []
for scope in typeinfo.scopes
let is_scoped = 'has_key(typeinfo.kind2scope, v:val.fields.kind) ||
\ has_key(v:val.fields, scope)'
let scopedtags += filter(copy(fileinfo.tags), is_scoped)
call filter(fileinfo.tags, '!(' . is_scoped . ')')
endfor
let processedtags = []
call s:AddChildren(scopedtags, processedtags, '', '', 1, typeinfo)
" 'scopedtags' can still contain some tags that don't have any
" children
call extend(fileinfo.tags, scopedtags)
call extend(fileinfo.tags, processedtags)
endif
let s:compare_typeinfo = typeinfo
if g:tagbar_sort
call s:SortTags(fileinfo.tags, 's:CompareByKind')
else
call s:SortTags(fileinfo.tags, 's:CompareByLine')
endif
let s:known_files[a:fname] = fileinfo
endfunction
" s:ParseTagline() {{{1
" Structure of a tag line:
" tagname<TAB>filename<TAB>expattern;"fields
" fields: <TAB>name:value
" fields that are always present: kind, line
function! s:ParseTagline(part1, part2, typeinfo)
let taginfo = {}
let basic_info = split(a:part1, '\t')
let taginfo.name = basic_info[0]
let taginfo.file = basic_info[1]
" 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")
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 = strpart(pattern, start, end - start)
let taginfo.pattern = '\V\^' . pattern . dollar
let prototype = substitute(pattern, '^[[:space:]]\+', '', '')
let prototype = substitute(prototype, '[[:space:]]\+$', '', '')
let taginfo.prototype = prototype
let taginfo.fields = {}
let fields = split(a:part2, '\t')
for field in fields
" can't use split() since the value can contain ':'
let delimit = stridx(field, ':')
let key = strpart(field, 0, delimit)
let val = strpart(field, delimit + 1)
let taginfo.fields[key] = val
endfor
" Make some information easier accessible
let taginfo.path = ''
let taginfo.fullpath = taginfo.name
if has_key(a:typeinfo, 'scopes')
for scope in a:typeinfo.scopes
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
let index = strridx(taginfo.fields[scope], a:typeinfo.sro)
let taginfo.parentpath = strpart(taginfo.fields[scope],
\ 0, index)
break
endif
endfor
endif
return taginfo
endfunction
" s:AddChildren() {{{1
" Extract children from the tag list and correctly add it to their parents.
" Unfortunately the parents aren't necessarily actually there -- for example,
" in C++ a class can be defined in a header file and implemented in a .cpp
" file (so the class itself doesn't appear in the .cpp file and thus doesn't
" genereate a tag). Another example are anonymous
" namespaces/structs/enums/unions that also don't get a tag themselves. These
" tags are thus called 'pseudo-tags' in Tagbar.
" This (in conjunction with ProcessPseudoTag) is probably the most cryptic
" function since it has to deal with things that aren't actually there and
" several corner cases. Try not to think about it too much.
function! s:AddChildren(tags, processedtags, curpath, pscope, depth, typeinfo)
if empty(a:curpath)
let is_child = ''
else
let is_child = ' && v:val.parentpath == a:curpath'
endif
let v_sro = '\V' . a:typeinfo.sro
let is_cur_child = 'len(split(v:val.path, v_sro)) == a:depth' . is_child
let curchildren = filter(copy(a:tags), is_cur_child)
" 'curchildren' are children at the current depth
if !empty(curchildren)
call filter(a:tags, '!(' . is_cur_child . ')')
for child in curchildren
let parentlist = s:ExtractParentList(a:tags, a:processedtags,
\ child.path, child.scope, a:typeinfo)
if empty(parentlist)
" If we don't have a parent at this point it must be a
" new pseudo-tag, so create an entry for it
call s:ProcessPseudoTag(a:tags, a:processedtags, child,
\ a:curpath, a:pscope, a:typeinfo)
else
let parent = parentlist[0]
if has_key(parent, 'children')
call add(parent.children, child)
else
let parent.children = [child]
endif
call add(a:processedtags, parent)
endif
endfor
" Recursively add children
for tag in a:processedtags
if !has_key(tag, 'children')
continue
endif
if empty(a:curpath)
let fullpath = tag.name
else
let fullpath = a:curpath . a:typeinfo.sro . tag.name
endif
let parentscope = a:typeinfo.kind2scope[tag.fields.kind]
call s:AddChildren(a:tags, tag.children, fullpath,
\ parentscope, a:depth + 1, a:typeinfo)
endfor
endif
" Grandchildren are children that are not direct ancestors of a tag. This
" can happen when pseudo-tags are in between.
let is_grandchild = 'len(split(v:val.path, v_sro)) > a:depth' . is_child
let grandchildren = filter(copy(a:tags), is_grandchild)
if !empty(grandchildren)
call s:AddChildren(a:tags, a:processedtags, a:curpath,
\ a:pscope, a:depth + 1, a:typeinfo)
endif
endfunction
" s:ProcessPseudoTag() {{{1
function! s:ProcessPseudoTag(tags, processedtags, child, curpath,
\ pscope, typeinfo)
" First check if the pseudo-tag is child of an existing tag.
let parentname = substitute(a:child.path, a:curpath, '', '')
let parentname = substitute(parentname, '\V\^' . a:typeinfo.sro, '', '')
let curpathlist = split(a:curpath, '\V' . a:typeinfo.sro)
let childpathlist = split(a:child.path, '\V' . a:typeinfo.sro)
let pseudoparentlist = []
for i in range(len(childpathlist) - 2, len(curpathlist), -1)
let pseudoparentpath = childpathlist[:i]
for scope in a:typeinfo.scopes
let pseudoparentlist = s:ExtractParentList(a:tags, a:processedtags,
\ join(pseudoparentpath, a:typeinfo.sro),
\ scope, a:typeinfo)
if !empty(pseudoparentlist)
break
endif
endfor
if !empty(pseudoparentlist)
break
endif
endfor
if !empty(pseudoparentlist)
" The pseudo-tag is child of an existing (real) tag -- so we have to
" add the real tag to the list of processed tags, create a pseudo-tag,
" add the pseudo-tag to the children of the real tag and add the
" /current/ tag ('child') to the children of the pseudo-tag. Yuck.
let pseudoparent = pseudoparentlist[0]
let parentname = substitute(parentname, pseudoparent.name, '', '')
let parentname = substitute(parentname, '\V\^' . a:typeinfo.sro,
\ '', '')
if has_key(pseudoparent, 'children')
let is_existingparent = 'v:val.name == parentname &&
\ v:val.fields.kind == a:typeinfo.scope2kind[a:child.scope]'
let existingparent = filter(copy(pseudoparent.children),
\ is_existingparent)
if !empty(existingparent)
call filter(pseudoparent.children,
\ '!(' . is_existingparent . ')')
let parent = existingparent[0]
call add(parent.children, a:child)
else
let parent = s:CreatePseudoTag(parentname, a:curpath, a:pscope,
\ a:child.scope, a:typeinfo)
let parent.children = [a:child]
endif
call add(pseudoparent.children, parent)
else
let parent = s:CreatePseudoTag(parentname, a:curpath, a:pscope,
\ a:child.scope, a:typeinfo)
let parent.children = [a:child]
let pseudoparent.children = [parent]
endif
call add(a:processedtags, pseudoparent)
else
let parent = s:CreatePseudoTag(parentname, a:curpath, a:pscope,
\ a:child.scope, a:typeinfo)
let parent.children = [a:child]
call add(a:processedtags, parent)
endif
endfunction
" s:ExtractParentList() {{{1
function! s:ExtractParentList(tags, processedtags, path, scope, typeinfo)
let is_parent = 'has_key(a:typeinfo.kind2scope, v:val.fields.kind) &&
\ a:typeinfo.kind2scope[v:val.fields.kind] == a:scope &&
\ v:val.fullpath == a:path'
let parentlist = filter(copy(a:processedtags), is_parent)
if !empty(parentlist)
call filter(a:processedtags, '!(' . is_parent . ')')
else
let parentlist = filter(copy(a:tags), is_parent)
if !empty(parentlist)
call filter(a:tags, '!(' . is_parent . ')')
endif
endif
return parentlist
endfunction
" s:CreatePseudoTag() {{{1
function! s:CreatePseudoTag(name, curpath, pscope, scope, typeinfo)
let pseudotag = {}
let pseudotag.name = a:name
let pseudotag.fields = {}
let pseudotag.fields.kind = a:typeinfo.scope2kind[a:scope]
let pseudotag.fields.line = 0
let parentscope = substitute(a:curpath, a:name . '$', '', '')
let parentscope = substitute(parentscope,
\ '\V\^' . a:typeinfo.sro . '\$', '', '')
let pseudotag.path = ''
let pseudotag.fullpath = pseudotag.name
if a:pscope != ''
let pseudotag.fields[a:pscope] = parentscope
let pseudotag.scope = a:pscope
let pseudotag.path = parentscope
let pseudotag.fullpath =
\ pseudotag.path . a:typeinfo.sro . pseudotag.name
endif
let index = strridx(parentscope, a:typeinfo.sro)
let pseudotag.parentpath = strpart(parentscope, 0, index)
return pseudotag
endfunction
" s:SortTags() {{{1
function! s:SortTags(tags, comparemethod)
call sort(a:tags, a:comparemethod)
for tag in a:tags
if has_key(tag, 'children')
call s:SortTags(tag.children, a:comparemethod)
endif
endfor
endfunction
" s:CompareByKind() {{{1
function! s:CompareByKind(tag1, tag2)
let typeinfo = s:compare_typeinfo
if typeinfo.kinddict[a:tag1.fields.kind] <
\ typeinfo.kinddict[a:tag2.fields.kind]
return -1
elseif typeinfo.kinddict[a:tag1.fields.kind] >
\ typeinfo.kinddict[a:tag2.fields.kind]
return 1
else
if a:tag1.name <= a:tag2.name
return -1
else
return 1
endif
endif
endfunction
" s:CompareByLine() {{{1
function! s:CompareByLine(tag1, tag2)
return a:tag1.fields.line - a:tag2.fields.line
endfunction
" s:RenderContent() {{{1
function! s:RenderContent(fname, ftype)
let tagbarwinnr = bufwinnr('__Tagbar__')
if &filetype == 'tagbar'
let in_tagbar = 1
else
let in_tagbar = 0
execute tagbarwinnr . 'wincmd w'
endif
let lazyredraw_save = &lazyredraw
set lazyredraw
setlocal modifiable
silent! %delete _
call s:PrintHelp()
if !s:IsValidFile(a:fname, a:ftype)
silent! put ='- File type not supported -'
let s:current_file = ''
setlocal nomodifiable
let &lazyredraw = lazyredraw_save
if !in_tagbar
execute 'wincmd p'
endif
return
endif
let typeinfo = s:known_types[a:ftype]
let fileinfo = s:known_files[a:fname]
" Print tags
for kind in typeinfo.kinds
let curtags = filter(copy(fileinfo.tags),
\ 'v:val.fields.kind == kind[0]')
if empty(curtags)
continue
endif
if has_key(typeinfo, 'kind2scope') &&
\ has_key(typeinfo.kind2scope, kind[0])
" Scoped tags
for tag in curtags
let taginfo = ''
if tag.fields.line == 0 " Tag is a pseudo-tag
let taginfo .= '*'
endif
if has_key(tag.fields, 'signature')
let taginfo .= tag.fields.signature
endif
let taginfo .= ' : ' . typeinfo.kind2scope[kind[0]]
let prefix = s:GetPrefix(tag)
silent! put =prefix . tag.name . taginfo
" Save the current tagbar line in the tag for easy
" highlighting access
let curline = line('.')
let tag.tline = curline
let fileinfo.tline[curline] = tag
if has_key(tag, 'children')
for childtag in tag.children
call s:PrintTag(childtag, 1, fileinfo, typeinfo)
endfor
endif
silent! put _
endfor
else
" Non-scoped tags
silent! put =' ' . strpart(kind, 2)
for tag in curtags
let taginfo = ''
if has_key(tag.fields, 'signature')
let taginfo .= tag.fields.signature
endif
let prefix = s:GetPrefix(tag)
silent! put =' ' . prefix . tag.name . taginfo
" Save the current tagbar line in the tag for easy
" highlighting access
let curline = line('.')
let tag.tline = curline
let fileinfo.tline[curline] = tag
endfor
silent! put _
endif
endfor
setlocal nomodifiable
let &lazyredraw = lazyredraw_save
if !in_tagbar
execute 'wincmd p'
endif
endfunction
" s:PrintHelp() {{{1
function! s:PrintHelp()
if s:short_help
call append(0, '" Press F1 for help')
else
call append(0, '" <Enter> : Jump to tag definition')
call append(1, '" <Space> : Display tag prototype')
call append(2, '" s : Toggle sort')
call append(3, '" x : Zoom window in/out')
call append(4, '" q : Close window')
call append(5, '" <F1> : Remove help')
endif
endfunction
" s:PrintTag() {{{1
function! s:PrintTag(tag, depth, fileinfo, typeinfo)
let taginfo = ''
if a:tag.fields.line == 0 " Tag is a pseudo-tag
let taginfo .= '*'
endif
if has_key(a:tag.fields, 'signature')
let taginfo .= a:tag.fields.signature
endif
if has_key(a:typeinfo.kind2scope, a:tag.fields.kind)
let taginfo .= ' : ' . a:typeinfo.kind2scope[a:tag.fields.kind]
endif
let prefix = s:GetPrefix(a:tag)
" Print tag indented according to depth
silent! put =repeat(' ', a:depth * 2) . prefix . a:tag.name . taginfo
" Save the current tagbar line in the tag for easy
" highlighting access
let curline = line('.')
let a:tag.tline = curline
let a:fileinfo.tline[curline] = a:tag
" Recursively print children
if has_key(a:tag, 'children')
for childtag in a:tag.children
call s:PrintTag(childtag, a:depth + 1, a:fileinfo, a:typeinfo)
endfor
endif
endfunction
" s:GetPrefix() {{{1
function! s:GetPrefix(tag)
if has_key(a:tag.fields, 'access') &&
\ has_key(s:access_symbols, a:tag.fields.access)
let prefix = s:access_symbols[a:tag.fields.access]
else
let prefix = ' '
endif
return prefix
endfunction
" s:HighlightTag() {{{1
function! s:HighlightTag(fname)
let fileinfo = s:known_files[a:fname]
let curline = line('.')
let tagline = 0
" 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) &&
\ has_key(fileinfo.fline[line], 'tline')
let tagline = fileinfo.fline[line].tline
break
endif
endfor
let eventignore_save = &eventignore
set eventignore=all
let tagbarwinnr = bufwinnr('__Tagbar__')
execute tagbarwinnr . 'wincmd w'
match none
if tagline == 0
execute 1
call winline()
execute 'wincmd p'
let &eventignore = eventignore_save
return
endif
" Go to the line containing the tag
execute tagline
if foldclosed('.') != -1
.foldopen!
endif
" Make sure the tag is visible in the window
call winline()
let pattern = '/^\%' . tagline . 'l\s*[-+#]\?\zs[^( ]\+\ze/'
execute 'match Search ' . pattern
execute 'wincmd p'
let &eventignore = eventignore_save
endfunction
" s:JumpToTag() {{{1
function! s:JumpToTag()
let taginfo = s:GetTagInfo(line('.'))
if empty(taginfo)
return
endif
execute 'wincmd p'
" 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)
execute taginfo.fields.line
" Center the tag in the window
normal! z.
if foldclosed('.') != -1
.foldopen!
endif
if g:tagbar_autoclose
call s:CloseWindow()
else
call s:HighlightTag(s:current_file)
endif
endfunction
" s:ShowPrototype() {{{1
function! s:ShowPrototype()
let taginfo = s:GetTagInfo(line('.'))
if empty(taginfo)
return
endif
echo taginfo.prototype
endfunction
" TagbarBalloonExpr() {{{1
function! TagbarBalloonExpr()
let taginfo = s:GetTagInfo(v:beval_lnum)
if empty(taginfo)
return
endif
return taginfo.prototype
endfunction
" s:GetTagInfo() {{{1
" 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.
function! s:GetTagInfo(linenr)
if !has_key(s:known_files, s:current_file)
return {}
endif
" Don't do anything in empty and comment lines
let curline = getline(a:linenr)
if curline =~ '^\s*$' || curline[0] == '"'
return {}
endif
let fileinfo = s:known_files[s:current_file]
" 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 taginfo.fields.line == 0
return {}
endif
return taginfo
endfunction
" s:ToggleSort() {{{1
function! s:ToggleSort()
if !has_key(s:known_files, s:current_file)
return
endif
let curline = line('.')
let fileinfo = s:known_files[s:current_file]
match none
let g:tagbar_sort = !g:tagbar_sort
let s:compare_typeinfo = s:known_types[fileinfo.ftype]
if g:tagbar_sort
call s:SortTags(fileinfo.tags, 's:CompareByKind')
else
call s:SortTags(fileinfo.tags, 's:CompareByLine')
endif
call s:RenderContent(s:current_file, fileinfo.ftype)
execute curline
endfunction
" s:ToggleHelp() {{{1
function! s:ToggleHelp()
let s:short_help = !s:short_help
" Prevent highlighting from being off after adding/removing the help text
match none
if s:current_file == ''
call s:RenderContent(s:current_file, '')
else
let fileinfo = s:known_files[s:current_file]
call s:RenderContent(s:current_file, fileinfo.ftype)
endif
execute 1
endfunction
" s:PrintWarningMsg() {{{1
function! s:PrintWarningMsg(msg)
echohl WarningMsg
echomsg a:msg
echohl None
endfunction
" Commands {{{1
command! -nargs=0 TagbarToggle call s:ToggleWindow()
command! -nargs=0 TagbarOpen call s:OpenWindow()
command! -nargs=0 TagbarClose call s:CloseWindow()
" Modeline {{{1
" vim: ts=8 sw=4 sts=4 et foldenable foldmethod=marker foldcolumn=1