Vim 之代碼跟蹤

這一篇聊聊咱們如何經過 vim 瀏覽代碼前端

代碼瀏覽最重要的就是跟蹤代碼, 跟蹤定義, 跟蹤聲明, 跟蹤調用, 跟蹤引用...python

vim 的跟蹤一般能夠經過兩種方式實現:c++

tags: 經過 ctags 工具生成 tags 文件
cscope 數據庫: 經過 cscope 或 gtags-cscope 生成 cscope 數據庫

兩種方法各有優缺點, 並且能夠搭配使用, 並不衝突. 下面逐個介紹.git

ctags

ctags 定義: 產生標記文件以幫助在源文件中定位對象. 包含如下對象:github

class names(類名)
macro definitions(宏定義)
enumeration names(枚舉名)
enumerators(枚舉變量)
function definitions(函數定義)
function prototypes/declarations(函數定義 / 聲明)
class, interface, struct, and union data members(類, 接口, 結構體, 聯合體)
structure names(結構體名)
typedefs(別名)
union names(聯合體名)
variables (definitions and external declarations) 變量

安裝 ctags

咱們通常所說的 ctags 分爲兩種數據庫

Exuberant Ctags: 這個是正統的 Ctags, 可是年久失修, 上一次更新仍是 2009 年
Universal Ctags: 是老 Exuberant Ctags 的一個 fork 版本, 繼承了其全部優勢, 而且直到如今還在活躍更新

綜上所述, 建議安裝 Universal Ctags, 使用以下方式安裝便可vim

brew install --HEAD universal-ctags/universal-ctags/universal-ctags
複製代碼

生成 tags

使用 ctags -R –c++-kinds=+px –fields=+iaS –extra=+q . 能夠將當前目錄下的全部文件內容進行處理生成 ./tags 文件, 這些選項的做用以下:bash

-R: ctags 循環生成子目錄的 tags
--c++-kinds=+pxl: ctags 記錄 c++ 文件中的函數聲明和各類外部和前向聲明 (l 表示記錄局部變量, 能夠認爲是 local 的縮寫)
--fields=+iaS: ctags 要求描述的信息, 其中 i 表示若是有繼承, 則標識出父類; a 表示若是元素是類成員的話, 要標明其調用權限 (便是 public 仍是 private); S 表示若是是函數, 則標識函數的 signature.
extra=+q: 強制要求 ctags 作以下操做: 若是某個語法元素是類的一個成員, ctags 默認會給其記錄一行, 能夠要求 ctags 對同一個語法元素再記一行, 這樣能夠保證在 VIM 中多個同名函數能夠經過路徑不一樣來區分.

配置 tags 路徑

生成了 tags 文件後, 咱們要讓 vim 找的到當前瀏覽的文件所對應的是哪一個 tags 文件, 咱們在 ~/.vimrc 中應該加上這樣的配置markdown

set tags=./tags;,tags
複製代碼

前半部分 ./.tags; 表明在文件的所在目錄下查找名字爲 .tags 的符號文件, 後面一個分號表明查找不到的話向上遞歸到父目錄, 直到找到 tags 文件或者遞歸到了根目錄還沒找到; 逗號分隔的後半部分 tags 是指同時在 vim 的當前目錄 (:pwd 命令返回的目錄, 能夠用 :cd .. 命令改變) 下面查找 tags 文件.函數

使用 tags

tags 的使用很是簡單, 把光標移動到某個元素上, CTRL+] 就會跳轉到對應的定義, CTRL+o 能夠回退到原來的地方.

另外也有一些其餘的 tags 相關命令可使用:

:tag func: 跳轉到 func 函數實現的地方
:tnext: 下一個標籤匹配處
:tprev: 上一個標籤匹配處
:tfirst: 第一個標籤匹配處
:tlast: 最後一個標籤匹配處
:tags: 全部匹配的標籤
:tselect: 顯示全部匹配的標籤並讓你選擇指定的

`cscope`

cscope 是相似於 ctags 同樣的工具, 但能夠認爲是 ctags 的加強版, 由於她比 ctags 可以作更多的事:

符號在哪裏使用的?
符號在哪裏定義的?
變量從哪裏獲得它的值的?
全局變量的定義?
這個函數在源代碼中的什麼文件中?
什麼函數調用了這個函數?
這個函數調用了什麼函數?
消息 out of space 來自哪裏?
這個源文件在目錄中的結構?
哪些文件包含了這個頭文件?

cscope 如何使用

在終端中的項目路徑中使用 cscope -Rbkq:

R: 表示把全部子目錄裏的文件也創建索引
b: 表示 cscope 不啓動自帶的用戶界面, 而僅僅創建符號數據庫
q: 生成 cscope.in.out 和 cscope.po.out 文件, 加快 cscope 的索引速度
k: 在生成索引文件時, 不搜索 /usr/include 目錄

一般咱們使用 cscope -Rb 能夠在當前路徑下獲得 cscope.out

cs 是 cscope 的簡寫命令, 後面也是如此.

而後在 vim 中使用 :cs add cscope.out: 添加一個新的 cscope 數據庫連接. 以後即可以在 vim 中使用 :cs ... 的一系列命令了

:cs show: 查看當前已經連接的 cscope 數據庫連接
:cs a ...: Find assignments to this symbol
:cs c ...: Find functions calling this function
:cs d ...: Find functions called by this function
:cs e ...: Find this egrep pattern
:cs f ...: Find this file
:cs g ...: Find this definition
:cs i ...: Find files #including this file
:cs s ...: Find this C symbol
:cs t ...: Find this text string

gtags

gtags, 全名爲 gnu global, 是一個相似 cscope 的工具(不是 ctags 的替代品!), 也能提供源文件之間的交叉索引. 其獨到之處在於, 當生成索引文件之後, 再修改整個項目裏的一個文件, 而後增量索引的過程很是快.

安裝

brew install global
複製代碼

安裝好之後, 有 global, gtags, gtags-cscope 三個命令. global 是查詢, gtags 是生成索引文件, gtags-cscope 是與 cscope 同樣的界面.

`gtags` 環境配置

gtags 是支持使用 ctags/universal-ctags 或者 pygments 來做爲分析前端支持 50+ 種語言. 使用 ctags/universal-ctags 做爲前端只能生成定義索引不能生成引用索引, 所以咱們要安裝 pygments , 保證你的 $PATH 裏面有 python, 接着:

pip install pygments
複製代碼

保證在環境裏裏要設置過以下兩個環境變量:

export $GTAGSLABEL = 'native-pygments'
export $GTAGSCONF = '/path/to/share/gtags/gtags.conf'
複製代碼

第一個 GTAGSLABEL 告訴 gtags 默認 C/C++/Java 等六種原生支持的代碼直接使用 gtags 本地分析器, 而其餘語言使用 pygments 模塊. 第二個環境變量必須設置, 不然會找不到 native-pygments 和 language map 的定義, Mac 下的路徑爲 /usr/local/share/gtags, 能夠把它拷貝成 ~/.globalrc

實際使用 pygments 時, gtags 會啓動 python 運行名爲 pygments_parser.py 的腳本, 經過管道和它通訊, 完成源代碼分析, 故需保證 gtags 能在 $PATH 裏調用 python, 且這個 python 安裝了 pygments 模塊.

`gtags` 使用

$ cd project/
$ gtags
複製代碼

gtags 遍歷子目錄, 從源碼文件中提取符號, 這樣就生成了整個目錄的索引文件, 包括 GTAGS, GRTAGS, GPATH 三個數據庫文件.

GTAGS: 定義數據庫
GRTAGS: 引用數據庫
GPATH: 路徑名數據庫

也能夠先用 find 命令生成一個文件列表, 叫 gtags.files, 而後再執行 gtags, 就會只索引 gtags.files 裏的文件.

$ cd project/
$ find . -name "*.[ch]" > gtags.files
$ gtags
複製代碼

`gtags-cscope` 在 `vim` 中的使用

查詢使用的命令是 global 和 gtags-cscope. 前者是命令行界面, 後者是與 cscope 兼容的 ncurses 界面. 這裏就很少介紹了, 重點是如何在 vim 裏查詢:

首先進入 vim, 而後:

:set cscopeprg=gtags-cscope
:cs add GTAGS
複製代碼

而後就能夠像 cscope 同樣, 用 cs find g 等命令進行查詢了.

gtags-cscope 還有一個優勢就是我後臺更新了 gtags 數據庫, 不須要像 cscope 同樣調用 cs reset 重啓 cscope 子進程, gtags-cscope 一旦連上永遠不用重啓, 無論你啥時候更新數據庫, gtags-cscope 進程都能隨時查找最新的符號.

當咱們更改了某個文件之後, 好比 project/subdir1/subdir2/file1.c, 想更新索引文件 (索引文件是 project/GTAGS), 只需這樣:

$ cd project/subdir1/subdir2/
$ vim file1.c
$ global -u
複製代碼

global -u 這個命令會自動向上找到 project/GTAGS, 並更新其內容. 而 gtags 相對於 cscope 的優點就在這裏: 增量更新單個文件的速度極快, 幾乎是瞬間完成. 有了這個優點, 咱們就能夠增長一個 autocmd, 每次 :w 的時候自動更新索引文件.

`gutentags` - 一個將 `ctags`, `cscope`, `gtags` 串起來的一個自動化工具

gutentags 能夠爲咱們生成數據庫並自動 cs add 添加 gtags 數據庫到 vim, 在你配置好它以後, 一切皆在後臺線程默默完成, 什麼都不須要再操心. 能夠參考個人 gutentags 配置

編輯一個項目還好, 若是同時編輯兩個以上的項目, gutentags 會把兩個數據庫都鏈接到 vim 裏, 因而你搜索一個符號, 兩個項目的結果都會同時出現, 基本無法用了.

這時, 咱們能夠搭配 skywind3000/gutentags_plus 一塊兒使用, 這個腳本讓已經加載過的數據庫不會重複加載, 非本項目的數據庫會獲得即時清理, 因此你根本感受不到 gtags 的存在, 只管始用 GscopeFind g 命令查找定義, GscopeFind s 命令查找引用, 既不用 care gtags 數據庫加載問題更不用關心什麼時候更新, 你只管寫你的代碼, 打開你要閱讀的項目, 隨時都能經過 GscopeFind 查詢最新結果, 並放入 quickfix 窗口中:

這個小腳本末尾還還定義了一系列快捷鍵:

<leader>cg: 查看光標下符號的定義
<leader>cs: 查看光標下符號的引用
<leader>cc: 查看有哪些函數調用了該函數
<leader>cf: 查找光標下的文件
<leader>ci: 查找哪些文件 include 了本文件
<leader>cd: Functions called by this function
<leader>ct: Find text string under cursor
<leader>ce: Find egrep pattern under cursor
<leader>ca: Find places where current symbol is assigned
<leader>cz: Find current word in ctags database

設置排除文件類型

ctags 排除與 gtags 排除不一致, 須要手動在 $GTAGSCONF 中設置 skip

最後

個人 vim 配置倉庫: HanleyLee/dotvim

本文做者 Hanley Lee, 首發於閃耀旅途, 若是對本文比較承認, 歡迎 Follow