Vim+ctags+cscope+Nerdtree+Taglist入门

介于linux下并没有什么像Source Insight这样优秀的内核源码阅读工具，只有一些模仿的都不伦不类，所以我用打造vim为一个合格的源码阅读器，看着贼爽。

可能一下子看起来那么多东西可能怕怕的，但是可以一个一个来。Vim+ctags可以先用着，能够实现自动跳转。然后再一点一点加入其他的来完善。

下面就是我的vim的效果图（实际上不难，别被吓到），左边是Taglist 右边是Nerdtree,然后可以通过ctrl+点击可以跳转到指定函数，通过ctrl+T就可以返回。

一.Ctags

1.1 Ctags安装

我用的是ubuntu，所以直接用sudo apt-get install ctags就行

或者按照下面的步骤安装：

   1）从http://ctags.sourceforge.net/下载源代码包后，解压缩生成源代码目录，

   2）然后进入源代码根目录执行./configure，

   3）然后执行make，

   4）编译成功后执行make install。

这样就能安装成功了。

1.2 Ctags使用

到指定目录下使用语句：

$ ctags -R --c++-kinds=+p --fields=+iaS --extra=+q . 

这里，--c++-kinds=+ps是为c/c+语言添加函数原型信息。--fields=+iaS是为标签添加继承信息（inheritance），访问控制信息（access）和函数特征（Signature）如参数表或原型等。--extra=+q是为类成员添加标签。

（使用Ctags还有一个方法，就是在vimrc中添加上述语句，然后设置快捷键来生成）

执行完这句话就能在当前目录下生成一个tags,这个时候在当前目录vim一个文件，就能够通过对特点函数用ctrl+] 快捷键跳转到定义处。

两个基本的一些操作

１Ctrl + ]            (跳转到定义处)

２Ctrl + T           (退回至跳转前)

我的vim关于Ctags的配置：

" ctags的配置 ctrl+f12快速生成tags
map <C-F12> :!ctags -R --c++-kinds=+p --fields=+iaS --extra=+q .<CR>  

二．安装使用Taglist

Taglist就是一开始显示图片的左边部分，能显示这段代码的变量名，方法名等。

（１）下载taglist.zip压缩包，并解压

（２）将doc里面的taglist.txt复制到~/.vim/doc/下面，如果不存在就创建这个文件夹;将plugin里面的taglist.vim加入到~/.vim/plugin/下面就行。

（３）我给Taglist设置了一个快捷键，这样打开vim的时候就可以直接通过快捷键进行打开以及关闭.

" 以F2作为Tlist的快捷键

 map <F2> :Tlist <CR> 

(4)使用：接下来用vim打开一个文件只需要输入　:Tlist就能调出，或者用刚才设置的快捷键

我的关于Taglist的配置：

  " Tlist 的快捷键
  map <F2> :Tlist <CR>

三．安装使用cscope

使用cscope能够：

以便能够在源代码中：
 1. 快速切换至函数的定义。
 2. 函数的声明.
 3. 查找某个函数被使用的情况。

3.1　安装

如果你的系统没有安装cscope，可以通过以下链接下载到最新版本的cscope的源代码：

 

http://sourceforge.net/projects/cscope/files/

解压之后，通过以下命令安装：

1. $ ./configure --with-flex  
2. $ make  
3. $ make install  

 

3.2　使用

主要是利用cscope生成cscope.out数据库，可以直接用：

cscope -Rbkq  递归所有文件生成.out文件

或者可以先将相关的文件汇集到某一个文件(cscope.files)中，然后再使用cscope -bkq -i cscope.files  生成out文件

 

然后可以将这个out文件加入vimrc中进行配置，或者直接在用vim打开的文件中，用:cs add添加文件

 

"cscope find"的用法:
cs find c|d|e|f|g|i|s|t name

0　 或　 s	查找本 C 符号(可以跳过注释)
1　 或 　g	查找本定义
2 　或　 d	查找本函数调用的函数
3 　或　 c	查找调用本函数的函数
4 　或 　t	查找本字符串
6 　或　 e	查找本 egrep 模式
7　 或　 f	查找本文件
8　 或　 i	查找包含本文件的文件

可以用如下命令查找函数，比如假设我要查找　f2fs_init()函数：

cs find 1 f2fs_int 

 

我在vim中关于cscope的配置：

" vim支持cscope
set cscopequickfix=s-,c-,d-,i-,t-,e-
" 添加 cscope.out
cs add /home/jackie/fragmetation/linux-4.12.1/linux/cscope.out

四．安装使用Nerdtree

（１）获得Nerdtree.zip文件，并解压

（２）将doc里面的taglist.txt复制到~/.vim/doc/下面，如果不存在就创建这个文件夹;将plugin里面的taglist.vim加入到~/.vim/plugin/下面就行。

（３）输入命令：vim，然后在vim中输入命令 :NERDTree 再按回车就可以看到安装成功了

我在vim中关于NerdTree的配置：

" 将 NERDTree 的窗口设置在 vim 窗口的右侧（默认为左侧）
 let NERDTreeWinPos="right"
"  当打开 NERDTree 窗口时，自动显示 Bookmarks
let NERDTreeShowBookmarks=1
" 在 vim 启动的时候默认开启 NERDTree（autocmd 可以缩写为 au）
 "autocmd VimEnter * NERDTree

最后附上我的vim配置：

" my configuration
" 关闭vi的一致性模式，避免以前版本的一些Bug和局限  
set nocompatible

" 打开鼠标功能
set mouse=a

syntax on "配色
syntax enable "语法高亮

" 设置取消备份，禁止临时文件生成  
set nobackup
set noswapfile

" 设置C/C++方式自动对齐  
set autoindent
set cindent
set smartindent


" 设置编码方式  
set encoding=utf-8

"set number "显示行号
set tabstop=4  "tab宽度
set shiftwidth=4  "设置自动对齐空格数

filetype on "检测文件类型
filetype indent on "针对不同文件采用不同的缩进方式
filetype plugin on "允许插件

set showmatch "设置代码匹配，包括括号匹配情况

set nocp

" Tlist的配置
let Tlist_Show_One_File=1
let Tlist_Exit_OnlyWindow=1
" 用ctrl+f1代替 :Tlist并且不需要回车确认


" ctags的配置 ctrl+f12快速生成tags
map <C-F12> :!ctags -R --c++-kinds=+p --fields=+iaS --extra=+q .<CR>

" vim支持cscope
set cscopequickfix=s-,c-,d-,i-,t-,e-
" 添加 cscope.out
cs add /home/jackie/fragmetation/linux-4.12.1/linux/cscope.out

" Tlist 的快捷键
map <F2> :Tlist <CR>

" 设置NerdTree
map <F3> :NERDTreeMirror<CR>
map <F3> :NERDTreeToggle<CR>

" 将 NERDTree 的窗口设置在 vim 窗口的右侧（默认为左侧）
let NERDTreeWinPos="right"
"  当打开 NERDTree 窗口时，自动显示 Bookmarks
let NERDTreeShowBookmarks=1
" 在 vim 启动的时候默认开启 NERDTree（autocmd 可以缩写为 au）
"autocmd VimEnter * NERDTree