Add <Leader>rh command to show class hierarchy

Displays the class hierarchy in a new window where pressing return on a
line opens that location in the other window.

Author: flackr

README.md

@@ -67,6 +67,7 @@ It is possible to set its maximum size (number of entries), default is 100:
 | <Leader>rp | -U --symbol-info-include-parents | Jump to parent                             |
 | <Leader>rc | --class-hierarchy                | Find subclasses                            |
 | <Leader>rC | --class-hierarchy                | Find superclasses                          |
+| <Leader>rh | --class-hierarchy                | List full class hierarchy                  |
 | <Leader>rf | -e -r                            | Find references                            |
 | <Leader>rF | -r --containing-function-location| Call tree (o - open node, Enter - jump)    |
 | <Leader>rn | -ae -R                           | Find references by name                    |

plugin/rtags.vim

@@ -93,6 +93,7 @@ if g:rtagsUseDefaultMappings == 1
     noremap <Leader>rw :call rtags#RenameSymbolUnderCursor()<CR>
     noremap <Leader>rv :call rtags#FindVirtuals()<CR>
     noremap <Leader>rb :call rtags#JumpBack()<CR>
+    noremap <Leader>rh :call rtags#ShowHierarchy()<CR>
     noremap <Leader>rC :call rtags#FindSuperClasses()<CR>
     noremap <Leader>rc :call rtags#FindSubClasses()<CR>
     noremap <Leader>rd :call rtags#Diagnostics()<CR>
@@ -419,6 +420,57 @@ function! rtags#AddReferences(results, i)
     exec (":" . ln)
 endfunction
 
+" Creates a viewer for hierarachy results
+"
+" param[in] results - List of class hierarchy
+"
+" Hierarchy references have format: <type> <name> <file>:<line>:<col>: <text>
+"
+function! rtags#ViewHierarchy(results)
+    let cmd = g:rtagsMaxSearchResultWindowHeight . "new Hierarchy"
+    silent execute cmd
+    setlocal noswapfile
+    setlocal buftype=nowrite
+    setlocal bufhidden=delete
+    setlocal nowrap
+    setlocal tw=0
+
+    iabc <buffer>
+
+    setlocal modifiable
+    silent normal ggdG
+    for record in a:results
+        silent execute "normal! A\<cr>\<esc>i".record."\<esc>"
+    endfor
+    silent normal ggdd
+    setlocal nomodifiable
+
+    let cpo_save = &cpo
+    set cpo&vim
+    nnoremap <buffer> <cr> :call <SID>OpenHierarchyLocation()<cr>
+    let &cpo = cpo_save
+endfunction
+
+"
+" Opens the location on the current line.
+"
+" Hierarchy references have format: <type> <name> <file>:<line>:<col>: <text>
+"
+function! s:OpenHierarchyLocation() " <<<
+    let ln = line(".")
+    let l = getline(ln)
+    if l[0] == ' '
+        let [type, name, location; rest] = split(l, '\s\+')
+        let [jump_file, lnum, col; rest] = split(location, ':')
+        wincmd j
+        " Add location to the jumplist
+        normal m'
+        if rtags#jumpToLocation(jump_file, lnum, col)
+            normal zz
+        endif
+    endif
+endfunction " >>>
+
 function! rtags#getRcCmd()
     let cmd = g:rtagsRcCmd
     let cmd .= " --absolute-path "
@@ -747,6 +799,12 @@ function! rtags#FindRefs()
     call rtags#ExecuteThen(args, [function('rtags#DisplayResults')])
 endfunction
 
+function! rtags#ShowHierarchy()
+    let args = {'--class-hierarchy' : rtags#getCurrentLocation() }
+
+    call rtags#ExecuteThen(args, [function('rtags#ViewHierarchy')])
+endfunction
+
 function! rtags#FindRefsCallTree()
     let args = {
                 \ '--containing-function-location' : '',