Linux下阅读源码工具

       闲来无事，于是又想进到Linux内核里面去逛逛了，但是只装了个ctags的工具，虽然说它可以在源码中到处跳动查看代码，但是感觉应该会有更好的方法。

       虽然说可以转到windows下面去使用SourceInsight工具来阅读源码，但是对于我们这种经常使用vim编辑器的人来说，还是打算使用vim比较舒服一点，这也许是习惯了吧，再说系统切换也麻烦，也不喜欢使用虚拟机。于是找了些资料研究了下，原来只需几个工具（插件）配合起来使用就很方便了，也能达到IDE的强大效果。

       我使用的系统是ubuntu10.04的，只需要3个工具就可以轻松阅读内核源代码了，分别是： ctags、cscope、taglist ，下面就来看如何安装使用他们吧。

       一、安装ctags

       它在浏览代码是非常方便，可以在变量、函数定义之间来回的跳动，这些网上有很多介绍，这里不啰嗦了。

       在终端中输入： sudo apt-get install ctags 即可安装ctags，如果没有找到软件包，还可以输入: sudo apt-get install exuberant-ctags ，如果还是不行，那么可以到官网下载源码来编译安装，安装方法相信都会吧，也就是安装软件的三部曲：./configure 、make 、make install 。

       下载地址为： http://nchc.dl.sourceforge.net/project/ctags/ctags/5.8/ctags-5.8.tar.gz

       完了以后，可以测试下安装是否成功，在终端运行： ctags --version ，如果打印出如下字符说明安装正确：

       安装完成以后，进入到源代码目录中，终端输入如下命令：ctags -R . ，将在当前目录下生成文件 tags

       然后打开源文件，光标定位到函数或者宏名上，按Ctrl + ]，就可以跳转到该函数或者宏的定义处，要想退回来则使用Ctrl + o 或者 Ctrl + t ，也可以直接在终端输入 vim -t 函数名，也可以查看函数定义。

       二、安装cscope插件

       在终端输入以下命令：sudo apt-get install cscope 、如果不行，同样可以到官网下载源码来自行安装。

       下载地址为：http://sourceforge.net/projects/cscope/files/

       使用方法：

       在终端下，切换到源码所在目录后，输入命令：cscope -Rbkq

       参数意义：R 表示把所有子目录里的文件建立索引

                         b 表示仅建立符号数据库，不启动自带的用户界面

                         k 表示在生成索引时，不搜索/usr/include/目录

                         q 表示生成cscope.in.out 和 cscope.po.out文件，加快cscope的索引速度

       完成后将在当前目录生成这么几个文件：cscope.in.out 、cscope.po.out 和 cscope.out

       修改～/.vimrc配置文件，在文件中加入如下代码：

       if filereadable("cscope.out")

                cs add cscope.out

       endif

       这样做的目的是为了在每次使用vim打开文件是都输入命令   ：cs add cscope.out

       如果想使用快捷键进行快捷查找的话，那么需要在~/.vimrc文件中加入如下代码：

       if has("cscope")

               set cscopetag   " 使支持用 Ctrl+]  和 Ctrl+t 快捷键在代码间跳来跳去

               "check cscope for definition of a symbol before checking ctags:

               "set to 1 if you want the reverse search order.

               set csto=1

 

               " add any cscope database in current directory

               if filereadable("cscope.out")

                       cs add cscope.out

                       " else add the database pointed to by environment variable

               elseif $CSCOPE_DB !=""

                       cs add $CSCOPE_DB

               endif

              " show msg when any other cscope db added

              set cscopeverbose 

              nmap <C-/>s :cs find s <C-R>=expand("<cword>")<CR><CR>

              nmap <C-/>g :cs find g <C-R>=expand("<cword>")<CR><CR>

              nmap <C-/>c :cs find c <C-R>=expand("<cword>")<CR><CR>

              nmap <C-/>t :cs find t <C-R>=expand("<cword>")<CR><CR>

              nmap <C-/>e :cs find e <C-R>=expand("<cword>")<CR><CR>

              nmap <C-/>f :cs find f <C-R>=expand("<cfile>")<CR><CR>

              nmap <C-/>i :cs find i ^<C-R>=expand("<cfile>")<CR>$<CR>

              nmap <C-/>d :cs find d <C-R>=expand("<cword>")<CR><CR>

       endif

       常用的命令：

                     ：cs find s ---- 查找C语言符号，即查找函数名、宏、枚举值等出现的地方

                     ：cs find g ---- 查找函数、宏、枚举等定义的位置，类似ctags所提供的功能

                     ：cs find d ---- 查找本函数调用的函数：cs find c ---- 查找调用本函数的函数

                     ：cs find t: ---- 查找指定的字符串

                     ：cs find e ---- 查找egrep模式，相当于egrep功能，但查找速度快多了

                     ：cs find f ---- 查找并打开文件，类似vim的find功能

                     ：cs find i ---- 查找包含本文件的文

       更多帮助在vim末行命令模式下输入cs 或 cscope获得帮助信息。

       三、taglist插件

       不需要安装，只需要简单配置就可以了，但是需要ctags的支持。

       下载地址为：http://www.vim.org/scripts/download_script.php?src_id=7701

       下载完成后，解压开压缩文件有两个目录，plugin和doc ，分别将plugin目录下的taglist.vim复制到~/.vim/plugin/下，将doc目录下的taglist.txt文件复制到~/.vim/doc/下，这样就可以了。

       然后再将以下代码加入到~/.vimrc配置文件中：

       " 按F8按钮，在窗口的左侧出现taglist的窗口,像vc的左侧的workpace

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

       " :Tlist              调用TagList

       let Tlist_Show_One_File=0                    " 只显示当前文件的tags

       let Tlist_Exit_OnlyWindow=1                  " 如果Taglist窗口是最后一个窗口则退出Vim

       let Tlist_Use_Right_Window=1                 " 在右侧窗口中显示

       let Tlist_File_Fold_Auto_Close=1             " 自动折叠

       配置完成以后，按F8试试就可以看到效果了，直接用鼠标就能操作。

       在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”在打开和关闭间切换。

       四、现在都安装完毕了，可以写一个小的脚本文件来建立索引

       例如名字就叫作cscope.sh，在里面加入以下内容：

       #!/bin/bash

       find . -name *.h >> cscope.files

       find . -name *.c >> cscope.files

       find . -name *.cpp >> cscope.files

       cscope -Rbkq -i cscope.files

       ctags -R .

       保存退出，如果还需要加入更多的文件，则继续 find 即可

       修改文件权限：chmod a+x cscope.sh ，可以将这个脚本放到/bin/目录下

       切换到源代码目录，执行 cscope.sh 即可生成索引并使用了