Sublime Text + CTags + Cscope (部分替代Source Insight)

时间:2022-01-02 14:50:38

CTags & cscope 下载:

CTags+Cscope --- 我的百度云盘下载
http://pan.baidu.com/s/1gfyPnuN

ctags58.zip --- src
http://jaist.dl.sourceforge.net/project/ctags/ctags/5.8/ctags58.zip

cscope-win32/downloads -- Google Code
https://code.google.com/archive/p/cscope-win32/downloads

cscope-15.8b.tar.gz --src
http://pilotfiber.dl.sourceforge.net/project/cscope/cscope/15.8b/cscope-15.8b.tar.gz

--------------------------------

安装方法:

1. 安装Package Control for ST3 

2. 安装Ctags插件

(1) 通过 Preference -> Package Control -> Install Package安装Ctags插件 
(2) 下载 Ctags.exe, 通过 Preference -> Package Settings -> Ctags -> Settings Default 中的内容拷贝到 Setting User中,将 command": "" 中的 "" 填入Ctags.exe的路径位置 
(3) 在工程根目录上点击右键,选择Ctags:Rebuild tags

说明:

CTags设置:

user settings中的设置:

"file_exclude_patterns":[".tags", ".tags_sorted_by_file", ".gemtags"],
"command" : "D:\\Program Files\\Sublime Text 3\\ctags.exe",      ----说明:这里win下的路径要加 \ 转义字符,linux下用 /

3. 安装Cscope插件

(1) 通过 Preference -> Package Control -> Install Package安装Cscope插件 
(2) 下载 Cscope.exe, 并在工程根目录下生成cscope.out文件 
(3) 打开CscopeSublime.sublime-settings文件(可能需要添加到 Package -> User 目录下),将 "executable": "" 中的"" 填入Cscope.exe的路径位置,将 "database_location": "" 中的 ""填入cscope.out的路径位置

 说明:

首先在目录下使用“cscope -Rkqb”生成cscope.out文件;   ----在代码浏览的工程目录下执行该命令生成cscope.out索引文件
用下面的命令生成代码的符号索引文件:

cscope -Rbkq

这个命令会生成三个文件:cscope.out, cscope.in.out, cscope.po.out。
其中cscope.out是基本的符号索引,后两个文件是使用”-q”选项生成的,可以加快cscope的索引速度。
上面所用到的命令参数,含义如下:

-R: 在生成索引文件时,搜索子目录树中的代码
-b: 只生成索引文件,不进入cscope的界面
-k: 在生成索引文件时,不搜索/usr/include目录
-q: 生成cscope.in.out和cscope.po.out文件,加快cscope的索引速度

功能实现:

(1) 对于symbol函数的定义查询,ST3自带此功能Go to Definition,且搜索结果有多个时可以预览,不用跳转到另一个文件。Ctags也有此功能navigate_to_definition,搜索结果比ST3要准确一些,但多结果时不支持预览。Csope也有此功能 Cscope: look up function defintion,但搜索结果不支持双击点开。因此实际中多用ST3和Ctags来实现此功能 
(2) 对于symbol变量的定义查询,ST3不支持,Ctags有此功能,方法同其查询symbol函数的定义一致。Cscope也可以用查询symbol函数定义的方法实现此功能,搜索结果不支持双击点开。因此实际中多用Ctags来实现此功能 
(3) 对于函数caller的查询,只有Cscope有此功能Cscope: look up function calling this function 
(4) 全局搜索, ST3可通过Ctrl+Shift+F实现,但搜索耗时较长。Cscope可通过Cscope: look up symbol实现,因为已经通过cscope.out建立了索引,所以结果很快,但结果不一定全面

注:使用Cscope的功能时,需按enter键确定才会执行

比较:ST3 + Ctags + Cscope的方案基本可以实现Source Insight的常用有效功能(除了查看类继承关系的Relation Windows),且其速度更快,界面也更为清爽。ST3相比于SI的其他优点还包括: 
(1)ST3使用Ctrl+P搜索文件时,使用的是模糊匹配,不像SI必须顺次拼写正确才行 
(2)ST3支持tab模式,可方便的在多个文件间切换

 

ST3实用技巧:

(1) Alt+O可以实现头文件和源文件之间的快速切换 
(2) 通过 View -> Side bar 可在左侧显示当前打开的文件列表 
(3) ST3虽然不像notepad++可以在sidebar上显示函数列表,但是可通过Ctrl+R查看 
(3) 通过 Preference -> Key binding user 可根据个人操作习惯自定义快捷键(包括ST3自带的和插件的) 
(4) 双击可选中光标所在单词,三击可选中光标所在行 
(5) Ctrl+Shift+T可以打开之前关闭的tab页,这点同chrome是一样的

--------------------------------
补充说明:

目前跳转至caller的插件个人还是依靠cscope,
而symbol view的功能可以用ctrl+r实现

在sublime请使用command + p(windows 下 Ctrl+p)呼叫出goto anything的窗口,然后输入你想查看的文件名,如果你还想快速定位,可以加@

在sublime,只要记住模糊匹配这四个字就很OK

ctrl+p:如果是js文件输入@,可以快速定位到function;如果是css文件输入@,可以快速定位到选择器;如果是html文件输入#,可以快速定位到标签

--------------------------------

参考:

使用Sublime Text3+Ctags+Cscope替代Source Insight - 作业部落 Cmd Markdown 编辑阅读器
https://www.zybuluo.com/lanxinyuchs/note/33551

CTags - Packages - Package Control
https://packagecontrol.io/packages/CTags

[图文详解] Sublime Text在Windows/Ubuntu/Mac OSX中配置使用CTags - petercao - 博客园
http://www.cnblogs.com/bluestorm/p/4768395.html

配置cscope && ctags - Dream的日志 - 网易博客
http://genime.blog.163.com/blog/static/167157753201313115255964/