ctags的用法 vim ctags , linux ctags , ctags分析代碼

vim+ctags用法(轉載)

[/home/brimmer/src]$ ctags -R

"-R"表示遞迴建立，也就包括原始碼根目錄下的所有子目錄下的來源程式。"tags"檔案中包括這些對象的列表：

l 用#define定義的宏

l 枚舉型變數的值

l 函數的定義、原型和聲明

l 名字空間（namespace）

l 類型定義（typedefs）

l 變數（包括定義和聲明）

l 類（class）、結構（struct）、枚舉類型（enum）和聯合（union）

l 類、結構和聯合中成員變數或函數

VIM用這個"tags"檔案來定位上面這些做了標記的對象，下面介紹一下定位這些對象的方法：

1) 用命令列。在運行vim的時候加上"-t"參數，例如：

[/home/brimmer/src]$ vim -t foo_bar

這個命令將開啟定義"foo_bar"（變數或函數或其它）的檔案，並把游標定位到這一行。

2) 在vim編輯器內用":ta"命令，例如：

:ta foo_bar

3) 最方便的方法是把游標移到變數名或函數名上，然後按下"Ctrl-]"。用"Ctrl-o"退回原來的地方。

注意：運行vim的時候，必須在"tags"檔案所在的目錄下運行。否則，運行vim的時候還要用":set tags="命令設定"tags"檔案的路徑，這樣vim

才能找到"tags"檔案。

在函數中移動游標
[{ 轉到上一個位於第一列的"{"

}] 轉到下一個位於第一列的"{"

{ 轉到上一個空行

} 轉到下一個空行

gd 轉到當前游標所指的局部變數的定義

* 轉到當前游標所指的單詞下一次出現的地方

# 轉到當前游標所指的單詞上一次出現的地方

Vim 的創造者是一名電腦程式員，因此這就不奇怪 Vim 中有許多協助編寫程式的功能：
跳轉到標識符被定義和使用的地方；在另一個視窗中預覽有關的聲明等等。在下一章中還
會介紹更多的功能。

 

*29.1* 使用標籤什麼是標籤？
標籤就是一個標識符被定義的地方。一個例子就是 C 或者 C++ 程式中的函數定義。標籤列表可以儲存在一個標籤檔案中。Vim 可以通過它來

從任何地方跳轉到該標籤，也就是一個標識符被定義的地方。 在目前的目錄下為所有的 C 檔案產生標籤檔案，使用下面的這個命令： ctags

*.c"ctags" 是一個獨立的程式。大多數 Unix 系統上都已經安裝了它。如果你還沒有安裝，可以在這裡找到 "Exuberant ctags"：

http://ctags.sf.net 現在你可以使用下面的命令跳轉到一個函數定義的地方： :tag startlist這個命令會找到函數 "startlist"，即使該函

數是在另一個檔案中。 CTRL-] 命令會跳轉到當前游標下單詞的標籤。這樣瀏覽毫無頭緒的 C 代碼會變得更容些易。舉個例子，假設你在函數

"write_block" 中。你可以看到它調用了函數"write_line"。但 "write_line" 做了什麼呢？將游標置於調用 "write_line" 的地方然後按

CTRL-]，你就跳轉到了這個函數的定義的地方了。 "write_line" 函數調用了 "write_char"。
你需要知道它做了什麼。將游標定位到調用 "write_char" 的地方然後按 CTRL-]，你就到了定義"write_char" 的地方。
+--+ |
void write_block(char **s; int cnt) | |
{ | | int i; | | for (i = 0; i < cnt; ++i)
| | write_line(s[i]); | |} | | +----|----+ | CTRL-] | | +-------+ +-->
|void write_line(char *s) | |{ | | while (*s != 0) | | write_char(*s++); | |} | | +-|-----+ | CTRL-] | | +-+ +--> |void

write_char(char c) | |{ | | putchar((int)(unsigned char)c); | |} |
+-+":tags" 命令顯示你經過的標籤列表： :tags # TO tag FROM line in file/text 1 1 write_line 8 write_block.c 2 1 write_char 7

write_line.c >
現在介紹向回跳轉。 CTRL-T 命令跳轉到上一個標籤。在上例中，你會回到 "write_line"函數調用 "write_char" 的地方。 這個命令接受一

個計數參數，用來表示跳回去的標籤個數。你已經向前跳轉，現在又跳轉了回去。現在我們再一次向前跳轉。下面的命令跳轉到標籤列表中

最上面的標籤： :tag你可以在前面加上要向前跳轉的標籤個數。比如：":3tag"。 CTRL-T 同樣可以加上一個計數參數。 通過這些命令，你可

以用 CTRL-] 延著調用樹向前跳轉, 用 CTRL-T 向回跳轉，用":tags" 命令顯示當前位置。分 割 窗 口":tag" 命令會將當前視窗的檔案替換

為包含新函數的檔案。怎樣才能同時查看兩個檔案呢？你可以使用 ":split" 命令將視窗分開然後再用 ":tag" 命令。Vim 有個縮寫命令可以

做到這些： :stag tagname使用下面的命令可以分割當前視窗並跳轉到游標下的標籤: CTRL-W ]如果指定了計數參數，新視窗將包含指定的那

麼多行。多 個 標 記 文 件如果在多個目錄中都有檔案，你可以在每一個目錄下建立一個標籤檔案。Vim 只能跳轉到那個目錄下的標籤。 通

過設定 'tags' 選項，你可以使用多個相關的標籤檔案。 比如： :set tags=./tags,./../tags,./*/tags這會使 Vim 找到當前檔案所在目錄

及其父目錄和所有子目錄下的標籤檔案。 這已經是不少的標籤檔案了，但也許仍不夠。比如，當編輯 "~/proj/src" 目錄下的一個檔案時，你

無法找到 "~/proj/sub/tags" 目錄下的標籤檔案。對這種情況，Vim提供了一個尋找整個分類樹下標籤檔案的方法，比如： :set

tags=~/proj/**/tags單 個 標 記 文 件當 Vim 在多個地方尋找標籤檔案時，你會聽到硬碟在格格作響。這樣會有點慢。在這種情況下，你最

好將這些時間花在產生一個大的標籤檔案上。你可以要等一會兒。 這得藉助上面提到的 "Exuberant ctags" 程式。它有一個選項可以搜尋整

個分類樹： cd ~/proj ctags -R .這樣做的好處是
"Exuberant ctags" 可以識別多種檔案類型，它不僅適用於 C 和 C++程式，還適用於 Eiffel 甚至 Vim 指令碼。請參考 ctags 文檔進行調整

所用參數。 現在你只需要告訴 Vim 你的標籤檔案在何處： :set tags=~/proj/tags多 個 匹 配當一個函數（或類中的方法）被定義多次，
":tags" 命令會跳轉到第一處。如果在當前檔案中存在匹配，那它將會被首先使用。 你現在可以跳轉到同一個標籤的其它匹配處： :tnext重

複執行這個命令可以找到更多的匹配。如果存在很多匹配，你可以選擇要跳轉到哪一個：
:tselect tagnameVim 會為你展示一個挑選清單： # pri kind tag file 1 F f mch_init os_amiga.c mch_init() 2 F f mch_init

os_mac.c mch_init() 3 F f mch_init os_msdos.c mch_init(void) 4 F f
mch_init os_riscos.c mch_init() Enter nr of choice (<CR>

to abort): 你現在可以輸入要跳轉到的匹配代號（在第一列）。其它列的資訊可以讓你知道匹配在何處被定義。可以用這些命令在各匹配的標

簽間移動： :tfirst 到第一個匹配 :[count]tprevious 向前 [count] 個匹配 :[count]tnext 向後 [count] 個匹配 :tlast 到最後一個匹配

如果沒有指定，[count] 省缺為一。
猜 測 標 簽 名命令列補全是避免輸入長標籤名的好辦法。只需輸入開始的一部分然後按 <Tab>： :tag write_<Tab>你會得到第一個匹配。如

果這不是你想要的，重複輸入 <Tab> 直到你找到正確的匹配。 有時你只知道一個函數名的一部分，或是你有很多以相同字串開頭而結尾不

同的標記。這時你可以告訴 Vim 使用一個模式來尋找標籤。 假設你要跳轉到一個包含 "block" 的標籤。首先輸入： :tag /block現在再利用

命令列補全功能：輸入 <Tab>。Vim 會找到所有包含 "block" 的標籤並使用第一個匹配。 標籤名前面的 "/" 告訴 Vim 這不是一個確定的標

簽名而是一個模式。你可以利用有關尋找模式的所有特性。舉個列子，假設你要選擇所有以 "write_" 開頭的標籤： :tselect /^write_"^"

指定標籤以 "write_" 開頭，否則在中間含有 "write_" 的標籤名也會被找到。類似地，"___FCKpd___0quot; 指定標籤名結尾處的匹配。
標 簽 瀏 覽 器CTRL-] 可以讓你跳轉到游標所在標識符的定義處，因此你可以利用標識符的列表來形成一個目錄。
這裡給出一個例子。 首先產生一個標識符列表（需要 Exuberant ctags)： ctags --c-types=f -f functions *.c現在開啟 Vim 並在一個垂

直分割視窗中編輯這個檔案： vim :vsplit functions視窗中包含一個所有函數的列表。其它的東西可以被忽略。用 ":setlocal ts=99" 命令

使其顯示得更清晰些。 在這個視窗中，定義一個 mapping： :nnoremap <buffer> <CR> 0ye<C-W>w:tag <C-R>"<CR>移動游標至要跳轉到函數

的所在行，輸入 <Enter>。Vim 會在另一個視窗中跳轉到所選擇的函數定義處。相 關 雜 項你可以設定 'ignorecase' 選項來忽略標籤名裡的

大小寫。'tagbsearch' 選項標明標籤檔案是否經過排序。省缺是假定為標籤檔案已排序，這樣會使尋找更快，但如果檔案沒有被排序是無法工

作的。'taglength' 選項可用來告訴 Vim 一個標籤的有效字元個數。當你使用 SNiFF+ 程式時，你可以利用 Vim 的有關介面 |sniff| 。

SNiFF+ 是一個商業軟體。Cscope 是一個自由軟體。它不僅可以找到一個標識符被聲明的地方，還可以找到標識符被使用的地方。 請參考

|cscope|。

---

*29.2* 預覽視窗當編輯含有函數調用的代碼時，你需要使用正確的調用參數。
要獲知所要傳遞的值，你可以查看這個函數是如何定義的。標籤機制對此十分適用。如果定義可在另一個視窗內顯示那就更好了。對此我們可

以利用預覽視窗。 開啟一個預覽視窗來顯示函數 "write_char"： :ptag write_charVim 會開啟一個視窗，跳轉到 "write_char" 標籤。然後

它會回到原來的位置。這樣你可以繼續輸入而不必使用 CTRL-W 命令。 如果函數名出現在文本中，你可以用下面的命令在預覽視窗中得到其定

義： CTRL-W }有一個指令碼可以自動顯示光線標處的標籤定義。請參考 |CursorHold-example| 。用下面的命令關閉預覽視窗： :pclose要在預覽

視窗中編輯一個指定的檔案，用 ":pedit" 。這在編輯標頭檔時很有用，比如： :pedit defs.h最後， "psearch" 可用來尋找當前檔案和任何

包含檔案中的單詞並在預覽視窗中顯示匹配。這在使用沒有標籤檔案的庫函數時十分有用。例如： :psearch popen這會在預覽視窗中顯示含有

popen() 原型的 "stdio.h" 檔案： FILE *popen __P((const char *, const char *)); 你可以用 'previewheight' 選項指定預覽視窗開啟

時的高度。

---

*29.3* 在代碼間移動因為程式碼是結構化的，Vim 可以識別其中的有關項目。
一些特定的命令可用來完成相關的移動。 C 程式中經常包含類似下面的代碼： #ifdef USE_POPEN fd = popen("ls", "r") #else fd =

fopen("tmp", "w") #endif 有時會更長，也許還有套嵌。
將游標置於 "#ifdef" 處按 %。Vim 會跳轉到"#else"。繼續按 % 會跳轉到 "#endif"。再次按下 % 又回到原來的 "#ifdef"。 當代碼套嵌時

，Vim 會找到相匹配的項目。這是檢查你是否忘記了一個 "#endif" 的好辦法。
當你在一個 "#ifdef" - "#endif" 塊內的某個位置，你可以用下面的命令回到開始處： [#如果你的位置不是在 "#if" 或 "#ifdef" 之後,

Vim 會鳴音。
用下面命令可以跳轉到下一個 "#else" 或 "#endif"： ]#這兩個命令會跳過它所經過的 "#if" - "#endif" 塊。例如： #if defined

(HAS_INC_H)
a = a + inc();
# ifdef USE_THEME
a += 3;
# endif
set_width(a);
如果游標在最後一行，"[#" 會移動到第一行。中間的 "#ifdef" - "#endif" 塊被跳過。在 代 碼 塊 內 移 動C 代碼塊包含在 {} 中，有時

一個代碼會很長。要跳轉到外部代碼塊的開始處，用 "[["命令。用 "][" 找到結尾處。（前提是 "{" 和 "}" 都在第一列。） "[{" 命令跳轉

到當前代碼塊的開始處。它會跳過同一層級的 {} 對。"]}" 跳轉到結尾。 一點概述： function(int a) +-> { | if (a) | +-> { [[ | |

for (;;) --+ | | +-> { | | [{ | | foo(32); | --+ | | [{ | if
(bar(a)) --+ | ]} | +-- | +-- break; | ]} | | | } <-+ | | ][ +--

foobar(a) | | } <-+ | } <-+當編寫 C++ 或 Java 代碼時，外部代碼塊是類，而下一級的 {} 是方法。在類內部用"[m" 可以找到前一個方法

的開始。"]m" 會找到下一個方法的開始。另外，"[]" 向後移動到一個函數的結尾，"]]" 向前移動到一個函數的結尾。函數的結尾指的是處在

第一列的 "}"。 int func1(void) { return 1; +---> } | [] | int func2(void) | +-> { | [[ | if (flag) start +-- +-- return flag;

| ][ | return 2; | +-> } ]] | | int func3(void) +---> { return 3; }不要忘了你還可以用 "%" 在匹配的 (), {} 和 [] 間移動。這在

它們相距很多行時仍然適用。在 括 號 內 移 動"[(" 和 "])" 命令"[}" 和 "]}" 類似，只不過它們適用於 () 對而不是 {} 對。 [( <----

<------- if (a == b && (c == d || (e > f)) &&
x > y) -------> ----> ])在 注 釋 間 移 動移動到一個注釋的開始用 "[/"；向前移動

到注釋的結尾用 "]/"。這隻對 /* - */ 注釋有效。 +-> +-> /* | [/ | * A comment about --+ [/ | +-- * wonderful life. | ]/ | */

<-+ | +-- foo = bar * 3; --+ | ]/ /* a short comment */ <-+

---

*29.4* 尋找全域識別碼你在編輯一個 C 程式，想要知道一個變數是被聲明為 "int" 還是 "unsigned"。
一個快速的方法是使用 "[I" 命令來尋找。
假設游標在單詞 "column" 處。輸入： [IVim 會列出它所找出的匹配行，不僅在當前檔案內尋找，還會在所有的包含檔案中尋找。結果如下

所示：
structs.h 1: 29 unsigned column; /* column number */ 相對使用標籤檔案或預覽視窗的好處是包含檔案也被搜尋。大多數情況下都能找

到正確的聲明。即使標籤檔案已經到期或者你沒有為包含檔案建立標籤也不會影響結果。 但是一些準備工作是必要的，否則 "[I" 就沒法工作

。首先，'include' 選項必須指定檔案是如何被包含的。省缺值適用於 C 和 C++。對其它的語言，你需要自己設定。定 位 包 含 文 件 Vim

會找到 'path' 選項指定路徑中的包含檔案。如果缺少某個目錄，一些包含檔案將不會被找到。你可以用這個命令來查看： :checkpath它會列

出不能找到的包含檔案，以及被找到的包含檔案。一個輸出範例：
--- Included files not found in path ---
<io.h> vim.h -->
<functions.h> <clib/exec_protos.h>
檔案 "io.h" 被當前檔案包含但無法找到。"vim.h" 可以找到，這樣 ":checkpath" 跟進這個檔案並檢查其中的包含檔案。結果顯示無法找到

"vim.h" 包含的 "functions.h" 和"clib/exec_protos.h" 檔案。
Note: Vim 不是一個編譯器。它無法識別 "#ifdef" 語句。這就是說所有的 "#include" 語句都會被使用，即使它在 "#if NEVER" 之後。
給 'path' 選項增加一個目錄可以修正無法找到檔案的錯誤。一個好得參考是 Makefile。注意那些包括 "-I" 的條目，比如 "-

I/usr/local/X11"。
要增加這個目錄，用： :set path+=/usr/local/X11如果有很多的子目錄，你可以用 "*" 萬用字元。
例如：
:set path+=/usr/*/include這會找到 "/usr/local/include" 以及 "/usr/X11/include" 目錄下的檔案。如果你的工程項目的包含檔案都在

一個套嵌的分類樹下，"**" 就非常有用。它會搜尋所有的子目錄。例如： :set path+=/projects/invent/**/include這會找到這些目錄下的

檔案： /projects/invent/include /projects/invent/main/include /projects/invent/main/os/include etc.還有其它的可能性。更多資訊

，請查看 'path' 選項。
如果你想查看找到的包含檔案，用這個命令： :checkpath!你會得到一個（很長）的包含檔案清單。為使它更短些，Vim 會對已經找到的檔案

顯示"(Already listed)" 而不再重新顯示一遍。跳 轉 到 匹 配"[I" 產生一個每項只有一行文本的列表。如果你想要進一步的查看第一項，

你可以這個命令來跳轉： [<Tab>你也可以使用 "[ CTRL-I", 因為 CTRL-I 和按 <Tab> 效果一樣。"[I" 產生的列表在每行的開頭都有一個序

號。如果你要跳轉到第一項外的其它項，首先輸入序號： 3[<Tab>會跳轉到列表中的第三項。記住你可以用 CTRL-O 跳回到原來的地方。相 關

命 令 [i 只列出第一項匹配 ]I 只列出游標下面的項目 ]i 只列出游標下面的第一項匹配查 找 宏 定 義 標 識 符"[I" 命令尋找任何標識符

。只尋找 "#define" 定義的宏，用： [D同樣，這會在所有的包含檔案中尋找。 'define' 選項指定 "[D" 所尋找的預定義樣式。你需要改變

它值來適用於 C 或 C++ 以外的語言。 "[D" 相關命令： [d 只列出第一項匹配 ]D 只列出游標下面的項目 ]d 只列出游標下面的第一項匹配

---

*29.5* 尋找局部標識符"[I" 命令尋找所有的包含檔案。要在當前檔案中尋找並跳轉到游標處單詞被首次使用的地方，用：
gD提示：Goto Definition。這個命令對尋找局部（C 語言中的 "static") 聲明的變數或函數很有用。例如（游標在 "counter" 處）： +->

static int counter = 0; | | int get_counter(void) gD | { | ++counter; +-- return counter; }要進一步的縮小尋找範圍，只在當前函

數內尋找，用這個命令： gd這會回到當前函數的開始處尋找游標處單詞首次出現的地方。實際上，它是向後找到一個在第一列 '{' 上面的空

行，然後再從那裡向前尋找標識符。例如（游標位於 idx 上）： int find_entry(char *name) { +-> int idx; | gd | for (idx = 0; idx

< table_len; ++idx) | if (strcmp(table[idx].name, name) == 0) +-- return idx; }