vim+ctags+cscope 打造Android源码阅读工具

1. 在Android源码顶层目录下运行ctags -R 生成tags文件

2. 在Android源码顶层目录运行cscope -Rbq，生成cscope.out文件

3.修改~/.vimrc使之可以自动加载tags和cscope.out文件，注意要使用ctags和cscope数据库，必须在android源码顶层运行vim程序

我的.vimrc如下：

"开关tag窗口

nnoremap <silent> <F8> :TlistToggle<CR>

 

"使用右侧tag窗口

"let Tlist_Use_Right_Window=1

 

"一般设置.

"set nocompatible "VIM而不是VI

set history=50 "历史记录50条

set fenc=utf-8 "设置默认语言为8位unicode

"man Q gq "屏蔽Q, 以免进入Ex模式

filetype on "打开文件类型检测

 

"

""颜色设置.

colorscheme delek "主题

"colorscheme evening "主题

syntax on "语法高亮

"set hls " 查找文本高亮

 

"界面设置.

set ruler "显示当前位置

set number "显示行号

""set nonumber "不显示行号

 

"格式设置.

set autoindent "自动缩进

set smartindent "智能缩进

set cindent "C缩进

set tabstop=4 "硬TAB

set softtabstop=4 "软TAB

set shiftwidth=4 "缩进空格数

set expandtab "空格替换TAB

"set smarttab "智能TAB

"

set showmatch "显示匹配

"set matchtime=5 "1/10秒延迟

"set hlsearch "高亮搜索

"set incsearch "搜索中匹配

set tags=tags; "ctags

"set autochdir "ctags

 

4.但是这样有个问题就是每次必须从android顶层运行vim,从子目录中运行ctags和cscope无法正常使用。因此我写了一个脚本，用来解决这个问题

#! /bin/bash 

i=`pwd` 

cd ~/source/unicore_src 

vim $i/$1 $2 $3 

cd $i

保存成mvim可执行文件，放到PATH环境变量中，就可以在子目录中通过mvim来打开android源码，并进行各种跳转了。

使用cscope的最大好处是可以替代source insight的功能，并可以快速定位某个函数在哪些地方被调用，非常方便

下面介绍常用的taglist配置选项，你可以根据自己的习惯进行配置：

- Tlist_Ctags_Cmd选项用于指定你的Exuberant ctags程序的位置，如果它没在你PATH变量所定义的路径中，需要使用此选项设置一下；

- 如果你不想同时显示多个文件中的tag，设置Tlist_Show_One_File为1。缺省为显示多个文件中的tag；

- 设置Tlist_Sort_Type为”name”可以使taglist以tag名字进行排序，缺省是按tag在文件中出现的顺序进行排序。按tag出现的范围（即所属的namespace或class）排序，已经加入taglist的TODO List，但尚未支持；

- 如果你在想taglist窗口是最后一个窗口时退出VIM，设置Tlist_Exit_OnlyWindow为１；

- 如果你想taglist窗口出现在右侧，设置Tlist_Use_Right_Window为１。缺省显示在左侧。

- 在gvim中，如果你想显示taglist菜单，设置Tlist_Show_Menu为１。你可以使用Tlist_Max_Submenu_Items和Tlist_Max_Tag_Length来控制菜单条目数和所显示tag名字的长度；

- 缺省情况下，在双击一个tag时，才会跳到该tag定义的位置，如果你想单击tag就跳转，设置Tlist_Use_SingleClick为１；

- 如果你想在启动VIM后，自动打开taglist窗口，设置Tlist_Auto_Open为1；

- 如果你希望在选择了tag后自动关闭taglist窗口，设置Tlist_Close_On_Select为1；

- 当同时显示多个文件中的tag时，设置Tlist_File_Fold_Auto_Close为１，可使taglist只显示当前文件tag，其它文件的tag都被折叠起来。

- 在使用:TlistToggle打开taglist窗口时，如果希望输入焦点在taglist窗口中，设置Tlist_GainFocus_On_ToggleOpen为1；

- 如果希望taglist始终解析文件中的tag，不管taglist窗口有没有打开，设置Tlist_Process_File_Always为1；

- Tlist_WinHeight和Tlist_WinWidth可以设置taglist窗口的高度和宽度。Tlist_Use_Horiz_Window为１设置taglist窗口横向显示；

在taglist窗口中，可以使用下面的快捷键：

<CR>          跳到光标下tag所定义的位置，用鼠标双击此tag功能也一样
o             在一个新打开的窗口中显示光标下tag
<Space>       显示光标下tag的原型定义
u             更新taglist窗口中的tag
s             更改排序方式，在按名字排序和按出现顺序排序间切换
x             taglist窗口放大和缩小，方便查看较长的tag
+             打开一个折叠，同zo
-             将tag折叠起来，同zc
*             打开所有的折叠，同zR
=             将所有tag折叠起来，同zM
[[            跳到前一个文件
]]            跳到后一个文件
q             关闭taglist窗口
<F1>          显示帮助

可以用“:TlistOpen”打开taglist窗口，用“:TlistClose”关闭taglist窗口。或者使用“:TlistToggle”在打开和关闭间切换。在我的vimrc中定义了下面的映射，使用“,tl”键就可以打开/关闭taglist窗口：

map <silent> <leader>tl :TlistToogle<cr>

Taglist插件还提供了很多Ex命令，你甚至可以用这些命令创建一个taglist的会话，然后在下次进入VIM时加载此会话。

Taglist插件还可以与winmanager插件协同使用