call-graph
call-graph copied to clipboard
Generate call graph for c/cpp functions
call-graph - Generate call graph for c/c++ functions
Generate call graph for c/c++ functions.
Where does this library come from?
How many times do you have this feeling that why can't we have this in emacs when you see the fancy function call hierarchy in "modern" IDEs? I hope one day, with this library, we won't have to envy those "modern" IDEs for this again.
Installation
Clone the repo, then in your Emacs init file:
(add-to-list 'load-path "/path/to/repo")
(require 'call-graph)
(call-graph) ;; to launch it
Or install from melpa.
External dependency
-
GNU Global
call-graph
will recursively call Global
to find caller of
current function and eventually build up a call-graph
tree.
Usage
Place your cursor in the c/c++ function which you want to generate call-graph for and execute call-graph. You could bind it to C-c g.
(global-set-key (kbd "C-c g") 'call-graph)
Keys
(define-key map (kbd "e") 'cg-widget-expand-all)
(define-key map (kbd "c") 'cg-widget-collapse-all)
(define-key map (kbd "p") 'widget-backward)
(define-key map (kbd "n") 'widget-forward)
(define-key map (kbd "q") 'cg-quit)
(define-key map (kbd "+") 'cg-expand)
(define-key map (kbd "_") 'cg-collapse)
(define-key map (kbd "o") 'cg-goto-file-at-point)
(define-key map (kbd "d") 'cg-remove-caller)
(define-key map (kbd "l") 'cg-select-caller-location)
(define-key map (kbd "r") 'cg-reset-caller-cache)
(define-key map (kbd "?") 'cg-help)
(define-key map (kbd "<RET>") 'cg-goto-file-at-point)
Customization
Customize the location of the GNU GLOBAL binary
(customize-set-variable 'cg-path-to-global "/home/huming/private/gtags-6.5.7/bin/")
Specify the parse depth of the call-graph, default is 2, the more the depth is, the longer it takes
(customize-set-variable 'cg-initial-max-depth 3)
Ignore reference which has function name but no `(...)'
(customize-set-variable 'cg-ignore-invalid-reference t)
Display function together with its args
(customize-set-variable 'cg-display-func-args t)
Avoid truncating Imenu entries
(customize-set-variable 'imenu-max-item-length "Unlimited")
Exclude UT/CT directories like /Dummy_SUITE/ /Dummy_Test/
(dolist (filter '("grep -v \"Test/\""
"grep -v \"_SUITE/\""
"grep -v \"/test-src/\""
"grep -v \"/TestPkg/\""))
(add-to-list 'cg-search-filters filter))
Screenshots
Limitations
Currently when parsing calling relations, header files is excluded. Lots more need to be improved.
Features
- [x] Navigate to caller file location.
- [x] Cache searching result.
- [x] Incremental searching.
- [x] Manual removing wrong callers.
- [x] Manual adding missing callers.
- [x] Show function name and args in call-graph.
- [x] Save cache data to survive emacs restart.
Contributing
Yes, please do! See CONTRIBUTING for guidelines.
License
See LICENSE. Copyright (c) 2018-2022 Huming Chen [email protected]