Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 3.18 KB

README_CN.md

File metadata and controls

86 lines (55 loc) · 3.18 KB

call-graph.nvim

受Sourcetrail 和 trails.nvim 启发，开发的 interactive ascii call graph插件，用于辅助阅读源码。

个人的第一款插件，插件仍处于非常早期的阶段，bug expected，欢迎feedback。

仅在clangd server上测试通过（因为个人主语言是c++), 理论上所有支持callHierarchy/incomingCalls的lsp server均可使用。

  • pyright server 测试可用，但性能不佳，很不建议使用。
2025-02-18.12.49.35.mp4

安装

lazy.nvim

  {
    "ravenxrz/call-graph.nvim",
     dependencies = {
       "nvim-treesitter/nvim-treesitter",
     },
    opts = {
      log_level = "info",
      reuse_buf = true,  -- 多次生成的call graph是否复用同一个buf
      auto_toggle_hl = true, -- 是否自动高亮
      hl_delay_ms = 200, -- 自动高亮间隔时间
      in_call_max_depth = 4, -- incoming call 最大搜索深度 
      ref_call_max_depth = 4, -- ref call 最大搜索深度
      export_mermaid_graph = false, -- 是否导出mermaid graph
    }
  }

支持的cmd:

  • CallGraphI: 使用incoming call生成call graph(快，但是不一定全)
  • CallGraphR: 使用references + treesitter生成call graph(慢，且会打开很多文件，但是call graph更全, 当前仅支持c++)
  • CallGraphO: 使用treesitter生成outcoming call graph(当前仅支持c++)
  • CallGraphLog: 打开call graph的log
  • CallGraphOpenMermaidGraph: 打开mermaid graph

Highlight group:

  • CallGraphLine, 默认值link到了Search，可自行修改。

功能

以开源项目muduo展示：

图像说明：

  1. 每个节点命名格式 function_name@file_name:line_number
  2. 每个节点入边为callee, 出边为caller
  3. 光标移动到一个节点上，会自动高亮它的所有入边和出边
  4. 光标移动到边上，会自动高亮所有和当前光标有重叠边（可能会有多个）
  5. 每个节点和边都可以通过快捷键gd,跳转到对应位置
  6. 每个节点可以通过快捷键K，显示文件全路径, 如：

image-20250217212652672

  1. 多边重合想要跳转时，提供可选窗口：

如下，foo1被foo2和foo3同时调用，光标与两条边都有重叠：

image-20250217213038893

此时跳转会提供选择：

image-20250217213125179

FAQ

1. 从call graph跳转到buffer的地方不对或报column out of range

这可能是neovim或者lsp server的bug，vim.lsp.buf.incoming_calls 函数返回值不准，可调用 :lua vim.lsp.buf.incoming_calls()确认位置信息返回值。

2.调用链图不全

根据 issue 所说，lsp incomingCalls仅支持分析打开了的文件，所以对于没有打开的文件，可能会缺分析。

解决方案：自行在图上跳转（用于打开文件），然后重新从root node生成调用图; 或者使用CallGraphR.