使用 vim + ctags + cscope + taglist 阅读源码 收藏 bo博 发表于 5年前 阅读 20197 收藏 14 点赞 4 评论 1 最近,准备跟学长一起

使用 vim + ctags + cscope + taglist 阅读源码
  • 发表于5年前
  • 阅读20197
  • 收藏14
  • 点赞4
  • 评论1

最近,准备跟学长一起往 linux kernel 的门里瞧瞧里面的世界,虽然我们知道门就在那,但我们还得找到合适的角度才会看得更舒服,对吧^_^ 。

阅读源码的工具有很多,而且如今的集成开发环境(IDE)也很强大,但对于经常使用vim编辑器的程序员来说,对vim的强大绝对是“不抛弃,不放弃”的,况且我们只要安装一些插件配合vim的工作一样能达到IDE的效果,好了,废话少说。浏览了很多有关的网页资源后,发现有很多插件可以用,但在此推荐3款比较常用的“小”插件供大家参考,它们其实并不“小”,非常强大!一般地,只是单个小程序源码的阅读就不必劳驾插件了(我是这样认为的),对于工程代码不用它们就有点困难了。

这三个插件分别是:ctags , cscope , taglist

先看看效果如何吧


在ubuntu下的安装与配置如下——

(1)ctags插件

a) 功能:对浏览代码非常的方便,可以在函数,变量之间跳来跳去等等等等 (更多说明请百度或谷歌一下)
b) 安装配置:
终端下输入 sudo apt-get install ctags
如果没发现该软件包就用 sudo apt-get install exuberant-ctags 就行了……
如果还不行可以到官网下载源码手动编译安装,有点麻烦是不是?不要嫌麻烦,这也是一个学习的机会,如果遇到其他类似的你也可以仿照这里的例子,再配合压缩包里的README文件就能手动安装了,你说是不是,呵呵。
下载解压后
$ cd ctags-5.8
$ ./configure
$ make
# make install // 需要root权限
使用 ctags --hlep 命令简单测试一下安装成功了没 >^_^<

c) 使用方法:
然后去你的源码目录,如果你的源码是多层的目录,就去最上层的目录,在该目录下
运行命令: ctags -R 其中-R表示递归遍历
我现在以 linux-kernel的源码目录做演示
$ cd ~/ linux-kernel
$ ctags -R (如果是kernel源码的话还可以用 make tags)
此时在/home/ linux-kernel/目录下会生成一个 tags 文件,现在用vim打开
即输入vim 然后Shift + :
然后再在vim末行运行命令,
: set tags=/home/bob/linux-kernel/tags (最前面的:是提示符,不必输入)
每次都要输入这个才能使tags生效,我很懒,所以把该命令加入到~/.vimrc中,你也可以将这句话放到~/.vimrc中去,
如果你经常在这个 工程目录编程的话.
再如果你经常在不同工程间编程,可以在.vimrc中加上:
set tags=tags; " 其中 ; 不能没有
set autochdir
d) 使用举例:
把光标定位到某一函数名上或者宏上,按下 Ctrl + ],vim就可以自动切换到该函数定义处!
要返回只需要按下Ctrl + o 或者 Ctrl + t. 是不是很方便吖。

(2) cscope 插件

a) 功能:可以对函数以及部分类型定义进行跳转(更多说明请百度或谷歌一下)
b) 安装配置:
sudo apt-get install cscope
这个源里应该有了,如果没有请到其官网 http://sourceforge.net/projects/cscope/files/ 下载源码安装,具体安装方法和 ctags 一样的,我就不罗嗦啦!

d)使用举例:
在终端下,转到你源码的所在目录然后
$cscope -Rbkq <回车>
说明一下参数:
R 表示把所有子目录里的文件也建立索引
   b 表示cscope不启动自带的用户界面,而仅仅建立符号数据库
  q 生成cscope.in.out和cscope.po.out文件,加快cscope的索引速度
   k 在生成索引文件时,不搜索/usr/include目录
之后会在当前目录生成几个文件, cscope.in.out和cscope.po.out文件,cscope.out
vim的normal模式下输入
:cs add cscope.out
不会吧,每次都要输入这些命令,烦死人了,有没有捷径呢?想偷懒总有人找到方法的,
sudo gedit ~/.vimrc ;然后在该文件下添加如下代码:
if filereadable("cscope.out")
cs add cscope.out
endif

这样每次打开vim就可以直接使用cscope了。
再试试把下面的内容复制到~/.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 ---- 查找包含本文件的文
Ctrl+]将跳到光标所在变量或函数的定义处 Ctrl+T返回
更多帮助在vim末行命令模式下输入cs 或 cscope获得帮助信息。
更多的例子如下
首先进入源码目录,在linux终端中输入以下命令以创建cscope数据库:
$ find ~/work/..Project/ -name "*.h" -o -name "*.cpp" > cscope.files
$ cscope -bkq -i cscope.files
如果是在windows环境中,则换成如下命令:
dir /s /b *.cpp *.h > cscope.files
cscope -b -q -k -i cscope.files

然后,用vim打开一个源文件(如: vim main.cpp),
打开后,第一件事就是导入cscope数据库了:
:cs add /home/yourname/workpace/cscope.out /home/yourname/workpace

cscope数据库导入成功后,就可以利用上面定义的快捷键进行相关的查找,

(3) taglist 插件

a) 功能:高效地浏览源码,其功能就像vc中的workpace,那里面列出了当前文件中的所有宏等等。
b)安装就不需要了,简单配置一下就行了,但需要ctags的支持,
下载后,解压缩后里面有两个目录 plugin和doc ,然后分别把plugin/taglist.vim复制到~/.vim/plugin目录下,
把doc/taglist.txt复制到~/.vim/doc目录下,ok!
记得把下面的加入到~/.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 " 自动折叠

d) 使用举例:这个就不用多说了,自己按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”在打开和关闭间切换。在我的vimrc中定义了下面的映射,使用“,tl”键就可以打开/关闭taglist窗口:


map <silent> <leader>tl :TlistToogle<cr>
 终于大功告成了,我也歇会儿啦 :-) 
<<++++++++++++++++++++++++++++++++^^^^^++++++++++++++++++++++++++++++++++++>>
这是我第一次写技术blog的第一篇博文,若有什么不足,请不要见笑,请留下建议,3Q!

本文是之前在这的,因为那个blog不再更新,所以现在转到此处来了

转自:https://my.oschina.net/u/554995/blog/59927

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐


解决方案:解决linux下vim乱码的情况:(修改vimrc的内容)全局的情况下:即所有用户都能用这个配置文件地址:/etc/vimrc在文件中添加:setfileencodings=utf-8,ucs-bom,gb18030,gbk,gb2312,cp936settermencoding=utf-8setencoding=utf-8如果只修改个人的vim配置情况:需要把/etc/
Linuxvi/vim所有的UnixLike系统都会内建vi文书编辑器,其他的文书编辑器则不一定会存在。但是目前我们使用比较多的是vim编辑器。vim具有程序编辑的能力,可以主动的以字体颜色辨别语法的正确性,方便程序设计。相关文章:史上最全Vim快捷键键位图—入门到进阶什么是vim
      vim正则匹配:空行:/^$/  /^[\t]*$/注释行:/^#/ /^[\t]*#/:1,$s/\([Rr]\)oot/\1ename/:1,$s/\(square\)and\(fair\)/\2and\1/ 
$select-editorSelectaneditor.Tochangelater,run'select-editor'.1./bin/ed2./binano<----easiest3./usr/bin/code4./usr/bin/vim.basic5./usr/bin/vim.tinyChoose1-5[2]:4
上次手贱忘了保存,这次就简单做个备忘吧,把踩过的坑记一下预览图安装工具:u盘、manjarokdeminimal20.0.3、win32DiskImager提取码:qt9f进bios、选择u盘启动、改语言、改时区、挂载分区(文件系统ext4、在200M左右的一个FAT分区上挂载/boot/efi)、安装安装很简单,按提示
Linux之文本编译器小结vim的优势所有的UNIX-LIKE习通都会内置vi文本编译器,其他的文本编译器则不一定存在很多软件的编译接口都会主动调用vivim有很强的程序编译能力,可以主动的一字体颜色辨别语法的正确性,方便程序设计因为程序简单,编译速度相当快vi的使用一般命令模
主机名字太长,怎么修改?  1.sudovim/etc/hostname 修改内容为wel,  本地主机名 2.sudovim/etc/hosts      修改主机名为wel,用于网络连接中主机名的识别 3.reboot 
目录#事故现场#事故原因#解决方法方法一:使用notepad转换方法二:使用vscode转换方法三:使用vim转换#参考#事故现场执行shell脚本文件,报错::notfound.sh:6:coreinstall.sh:查看脚本文件第6行,发现是空行;#事故原因window下的换行是回车符+换行符,也就是\r\n,而unix下是换行符\n
1、保存并退出linux下安装好了vim以及gcc后,我们开始新建一个c文件,例如:vimtest.c之后进入vim的编辑框中,点击i进入插入模式,开始编辑程序,当你编写好自己的程序之后,按Esc退出插入编辑状态,然后输入冒号加wq,点击Enter即可,完整的命令如下:wq如下图:  退出后,如果想要编译
概述使用VIM作简单字数统计背景想做一个简单的字数统计环境OSwin10shellmintty-2.9.41.需求概述需求需求统计文段内字符的数量支持自定义字符集2.方案1:vim自带统计概述vim自带方案操作定位到文段内某行vi
经典版下面这个键位图应该是大家最常看见的经典版了。对应的简体中文版其实经典版是一系列的入门教程键位图的组合结果,下面是不同编辑模式下的键位图。 
ssh是一个安全连接协议。作用两个:1.远程连接协议,2.远程文件传输协议协议默认端口为:22。 修改默认端口,再到ssh服务配置文件位置  vim/etc/ssh/ssh_config这条命令就可以修改了。按下ESC键,再输入:x 也可以退出vim。(和:q! 相同)修改注意:1.端口号在0-65535之间。2.别人
Vim是一个类似于Vi的著名的功能强大、高度可定制的文本编辑器,在Vi的基础上改进和增加了很多特性。VIM是自由软件。Vim普遍被推崇为类Vi编辑器中最好的一个,事实上真正的劲敌来自Emacs的不同变体。1999年Emacs被选为Linuxworld文本编辑分类的优胜者,Vim屈居第二。但在2000年2月Vim赢
在Vim中,有时需要将tab转换成space。使用ret命令(replacetab)。[range]ret[ab]![new-tabstop]举例:将第一行到文件尾的tab转换成space,每个tab用4个space替代。:setexpandtab:%ret!4如果没有给定4,则用当前的tab宽度设定替换为space。 相关配置文件命令::settabstop=4设
分屏命令记不得文件名就输入.可浏览文件命令英文功能:sp[文件名]split横向分屏:vsp[文件名]verticalsplit纵向分屏    切换分屏窗口先按Ctrlw切换窗口命令英文功能 wwindow切换下一个窗口 rreverse互换窗口 c
1查看ctags支持的语言ctags--list-languages2查看语言和扩展名的对应关系ctags--list-maps 3对当前目录下所有ctags支持的语言格式文件生成tagsctags-R*缺点很明显,tags会非常大,tags生成会非常慢,而且代码跳转会卡顿。4只对特定文件生成tagsctags`find-name"*.h"`ct
vim基本命令 $vimtutor可以查看基本的vim操作1h(left)j(down)k(up)l(right)q!wqi:insertbeforethecursor(insert)插队嘛,肯定在光标前面A:appendaftertheline(appending)2dw:删除一个单词,保留光标前面部分d$:删除光标之后的同行
~/.vimrc内容如下:setnocompatiblefiletypeoffsetrtp+=~/.vim/bundle/Vundle.vimcallvundle#begin()Plugin'VundleVim/Vundle.vim'Plugin'tpope/vim-fugitive'Plugin'tpope/vim-unimpaired'Plugin'tpope/vim-repeat'Plu
程序:硬盘静态的代码  占用磁盘空间进程:内存运行计算的代码 占用CPU运行内存父进程与子进程  树型结构进程唯一标识: PID僵尸进程找到父进程杀掉  孤儿进程疯狂要内存  危害大 pstree [选项]-a显示完整命令行   -p 查看PID [PID或用户
~/.vimrc"Configurationfileforvimsetmodelines=0 "CVE-2007-2438setnumber"setrelativenumber"显示相对行号(这个非常重要,慢慢体会)setcursorlinesetcursorcolumnsetrulersetscrollbindsetencoding=utf-8colormolokaisyntaxon"开启