vim ctags

最新推荐文章于 2023-08-22 09:20:38 发布

长空飞鹰

最新推荐文章于 2023-08-22 09:20:38 发布

阅读量534

点赞数

分类专栏： linux 文章标签： vim tags path makefile c 语言

linux 专栏收录该内容

44 篇文章 0 订阅

订阅专栏

[/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"命令，例如：

:tafoo_bar

3) 最方便的方法是把光标移到变量名或函数名上，然后按下"Ctrl-]"。用"Ctrl-o"退回原来的地方。

注意：运行vim的时候，必须在"tags"文件所在的目录下运行。否则，运行vim的时候还要用":settags="命令设定"tags"文件的路径，这样vim才能找到"tags"文件。

在函数中移动光标

[{转到上一个位于第一列的"{"

}] 转到下一个位于第一列的"{"

{ 转到上一个空行

} 转到下一个空行

gd 转到当前光标所指的局部变量的定义

* 转到当前光标所指的单词下一次出现的地方

# 转到当前光标所指的单词上一次出现的地方

Vim的创造者是一名计算机程序员，因此这就不奇怪 Vim 中有许多帮助编写程序的功能：

跳转到标识符被定义和使用的地方；在另一个窗口中预览有关的声明等等。在下一章中还

会介绍更多的功能。

|29.1| 使用标签

|29.2| 预览窗口

|29.3| 在代码间移动

|29.4| 查找全局标识符

|29.5| 查找局部标识符

下一章：|usr_30.txt| 编辑程序

前一章：|usr_28.txt| 折叠

目录：|usr_toc.txt|

*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; intcnt) |

|{ |

| int i; |

| for (i = 0; i < cnt; ++i) |

| write_line(s[i]); |

|} | |

+-----------|-------------------------+

CTRL-] |

| +----------------------------+

+--> |voidwrite_line(char *s) |

|{ |

| while (*s != 0) |

| write_char(*s++); |

|} | |

+--------|-------------------+

CTRL-] |

| +------------------------------------+

+--> |voidwrite_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 tagname

Vim会为你展示一个选择列表：

# 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> toabort):

你现在可以输入要跳转到的匹配代号（在第一列）。其它列的信息可以让你知道匹配在何

处被定义。

可以用这些命令在各匹配的标签间移动：

: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_" 的标签名也会被找到。类似

地，"$"指定标签名结尾处的匹配。

标签浏览器

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 会在另一个窗口中跳转到所选择

的函数定义处。