https://github.com/beacoder/call-graph
Generate call graph for c/c++ functions
https://github.com/beacoder/call-graph
call-graph programming-tool
Last synced: 8 months ago
JSON representation
Generate call graph for c/c++ functions
- Host: GitHub
- URL: https://github.com/beacoder/call-graph
- Owner: beacoder
- License: mit
- Created: 2024-11-27T01:47:04.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-01-06T17:03:29.000Z (10 months ago)
- Last Synced: 2025-01-26T04:26:07.635Z (9 months ago)
- Topics: call-graph, programming-tool
- Language: Emacs Lisp
- Homepage:
- Size: 43 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# call-graph - Generate call graph for c/c++ functions
[](COPYING.md)
[](https://melpa.org/#/call-graph)
[](https://stable.melpa.org/#/call-graph)
[](https://996.icu)
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:
```lisp
(add-to-list 'load-path "/path/to/repo")
(require 'call-graph)
(call-graph) ;; to launch it
```
Or install from [melpa](https://melpa.org/#/call-graph).
## External dependency
You could choose either Global (default) or Git as search backend for call-graph to use.
* `GNU Global`
`call-graph` will recursively call `Global` to find caller of
current function and eventually build up a `call-graph` tree.
* `Git`
`call-graph` will recursively call `git grep` 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.
```lisp
(global-set-key (kbd "C-c g") 'call-graph)
```
# Keys
```lisp
(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 "") 'cg-goto-file-at-point)
```
# Customization
## Backend configuration: Gnu Global
```
(customize-set-variable 'cg-path-to-global "/home/huming/private/gtags-6.5.7/bin/")
```
## Backend configuration: Git
```
(customize-set-variable 'cg-search-backend "Git")
(customize-set-variable 'cg-path-to-git-repo "/workspace/git/$username/repo/")
```
## Common configuration
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))
```
## Sample configuration
```
(progn
(require 'call-graph)
(global-set-key (kbd "C-c g") #'call-graph)
(customize-set-variable 'cg-path-to-global "/home/$username/private/gtags-6.6.3/bin/")
(customize-set-variable 'imenu-max-item-length "Unlimited")
(customize-set-variable 'cg-display-func-args t)
(dolist (filter '("grep -v \"Test/\""
"grep -v \"Stub/\""
"grep -v \"_SUITE/\""
"grep -v \"/test-src/\""
"grep -v \"/TestPkg/\""
"grep -v \"/unittest/\""
"grep -v \"/test_src/\""
"grep -v \"/ct/\""))
(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.
- [x] Support multiple backends, e.g: gnu global, git.
# Contributing
Yes, please do! See [CONTRIBUTING](CONTRIBUTING.md) for guidelines.
# License
See [LICENSE](LICENSE). Copyright (c) 2018-2025 Huming Chen
# Donate
If you think that it's helpful for you, please consider paying a cup of coffee
for me. Thank you! :smile:
