Git Product home page Git Product logo

call-graph's Introduction

call-graph - Generate call graph for c/c++ functions

MIT licensed MELPA MELPA Stable 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:

(add-to-list 'load-path "/path/to/repo")
(require 'call-graph)
(call-graph) ;; to launch it

Or install from melpa.

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.

    (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

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

call-graph-demo-1.gif call-graph-demo-2.gif

Limitations

Currently when parsing calling relations, header files is excluded. Lots more need to be improved.

Features

  • Navigate to caller file location.
  • Cache searching result.
  • Incremental searching.
  • Manual removing wrong callers.
  • Manual adding missing callers.
  • Show function name and args in call-graph.
  • Save cache data to survive emacs restart.
  • Support multiple backends, e.g: gnu global, git.

Contributing

Yes, please do! See CONTRIBUTING for guidelines.

License

See LICENSE. Copyright (c) 2018-2023 Huming Chen [email protected]

call-graph's People

Contributors

beacoder avatar brightchikudza avatar kjmatsuda avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.