ctags
vim下方便代码阅读的工具
ctags(Generate tag files for source code)是vim下方便代码阅读的工具。尽管ctags也可以支持其它编辑器,但是它正式支持的只有VIM。并且VIM中已经默认安装了Ctags,它可以帮助程序员很容易地浏览源代码。
最初的Ctags是在BSD Unix 3.0中引入的,由Ken Arnold编写,Jim Kleckner提供Fortran支持,Bill Joy提供Pascal支持。它是1992年Single Unix规范和XPG4的初始版本的一部分。
简介
ctags 最先是用来生成C代码的tags文件,后来扩展成可以生成各类语言的tags, 有些语言也有专有的tags生成工具(比如java的jtags, Python的 ptags)。Ctags是一种编程工具,用于在各种编程语言的源文件和头文件中生成名称索引(或标签)文件,以帮助理解代码。根据语言的不同,函数、变量、类成员、宏等都可以被索引。
ctags程序还有一些其他实现,包括GNU Emacs附带的etags和ctags,Exuberant Ctags由Darren Hiebert编写和维护,Universal Ctags是Exuberant Ctags的一个分支,以及针对特定语言的ctags,如Hasktags为Haskell源文件创建兼容ctags的标签文件,jsctags是ECMAScript的一个兼容ctags的代码索引解决方案。
ctags及其后继者使用的标签文件格式有多种。原始的ctags和Exuberant/Universal后继者具有类似的文件格式,标签文件通常命名为“tags”,而Emacs etags使用的格式则通常命名为“TAGS”。标签文件是一系列行,每行包含标签名、文件名和标签地址。扩展Ctags和Etags格式提供了更多的信息,如附加字段和特殊ASCII字符用于特殊目的。
软件相关
安装
到ctags官网 下载源码,解压后
$ ./configure
$ make
$ sudo make install
如果你使用的是Ubuntu系统(Debian),那么可以使用如下命令直接安装:sudo APT install ctags [2]
生成索引文件
在源码目录下执行
–R
“-R”表示递归创建,也就包括源代码根目录(当前目录)下的所有子目录。“*”表示所有文件。这条命令会在当前目录下产生一个“tags”文件,当用户在当前目录中运行vi时,会自动载入此tags文件。Tags文件中包括这些对象的列表:用#define定义的宏枚举型变量的值函数的定义、原型和声明名字空间(namespace)类型定义(typedefs)变量(包括定义和声明)类(class)、结构(struct)、枚举类型(enum)和联合(union)类、结构和联合中成员变量或函数VIM用这个“tags”文件来定位上面这些做了标记的对象。
配置
使用sudo VIM /etc/vim/vimrc 编辑vim的配置文档,在其中加入如下命令:
set tags=/home/zhouyl/linux-3.4.7/tags;"后面的路径是使用ctags -R 后生成的tags文件所在目录,如果需要配置多个tags,只需如下再添加即可
set tags=/home/zhouyl/rap/libpcap-1.3.0/tags;
set autochdir
运用
熟练的运用ctags仅需记住下面七条命令:
1. –R * (,这个命令上面已经有所介绍)
2. $ vi –t tag (请把tag替换为您欲查找的变量或函数名)
3.:ts(ts助记字:tagslist, “:”开头的命令为VI中命令行模式命令)
4.:tp(tp助记字:tagspreview)---此命令不常用,可以不用记
5.:tn(tn助记字:tagsnext) ---此命令不常用,可以不用记
6.Ctrl+ ]跳到光标所在函数或者结构体的定义处
7.Ctrl+ T返回查找或跳转
“ –t tag” :在运行vim的时候加上“-t”参数,例如:[/usr/src] -tmain这个命令将打开定义“main”(变量或函数或其它)的文件,并把光标定位到这一行。如果这个变量或函数有多处定义,
在VI命令行模式 “:ts”命令就能列出一个列表供用户选择。
“:tp”为上一个tag标记文件,
“:tn”为下一个tag标记文件。
当然,若当前tags文件中用户所查找的变量或函数名只有一个,“:tp,:tn”命令不可用。
(最方便的方法是把光标移到变量名或函数名上,然后按下“Ctrl+j”,这样就能直接跳到这个变量或函数定义的源文件中,并把光标定位到这一行。用“Ctrl+T”可以退回原来的地方。即使用户使用了N次“Ctrl+]”查找了N个变量,按N次“Ctrl+t”也能回到最初打开的文件,它会按原路返回 。
注意:运行VIM的时候,必须在“tags”文件所在的目录下运行。否则,运行vim的时候还要用“:set tags=”命令设定“tags”文件的路径,这样vim才能找到“tags”文件。在完成编码时,可以手工删掉tags文件。
参考资料
目录
概述
简介
软件相关
参考资料