emacs使用之cedet

用来管理项目&＃xff0c;它可以把emacs模拟得像一个IDE那样&＃xff0c;把一堆文件作为一个project来管理。

Semantic应该是cedet里用得最多的组件了&＃xff0c;代码间跳转和自动补全这两大功能都是通过semantic来实现的。

SRecode是一个模板系统&＃xff0c;通过一些预定义的模板&＃xff0c;可以很快地插入一段代码。个人觉得这个功能跟msf-abbrev和yasnippet的功能有些类似。

全称叫”Connected Graph Editor”&＃xff0c;主要和图形相关&＃xff0c;比如可以用它来为C&＃43;&＃43;类生成UML图。

Speedbar可以单独创建一个frame&＃xff0c;用于显示目录树&＃xff0c;函数列表等等。这个组件已经包含在emacs官方发布包中。

EIEIO是一个底层库&＃xff0c;它为elisp加入了OO支持。cedet的其它组件都依赖于EIEIO。

一般装插件的思路&＃xff0c;都是先load然后enable某个minor mode。cedet基本上也遵循这个规则&＃xff0c;不过有点区别是semantic定义了很多个mode&＃xff0c;要是挨个去enable&＃xff0c;用户可能就要骂娘了&＃xff0c;所以cedet的作者Eric定义了几个方便使用的函数&＃xff0c;这些函数会自动帮你enable某些minor mode&＃xff0c;大概有这么几个&＃xff1a;

简单介绍一下各个函数的功能&＃xff1a;

了解了上面这些feature&＃xff0c;就可以根据需要配置了&＃xff0c;为了使用semantic&＃xff0c;至少需要开启semantic-load-enable-minimum-features定义的三个基础feature&＃xff0c;其余的feature就可以根据自己的需要开启了。比如我的配置是&＃xff1a;

因为imenu,idle-summary-mode,senator-mode,mru-bookmark-mode都是我需要的。特别是senator&＃xff0c;有时候我会碰到semantic等很久也不自动解析文件的问题&＃xff0c;这时候就需要在senator菜单里[Force Tag Refresh]一下了&＃xff0c;并且senator还可以通过菜单方便地打开和关闭某些mode&＃xff0c;用起来还是很方便的。

(semantic-load-enable-guady-code-helpers)和(semantic-load-enable-excessive-code-helpers)定义的那些feature&＃xff0c;对我来说用处不大&＃xff0c;而且我感觉打开的话还会让emacs反应变慢&＃xff0c;所以我就不启用了。

(semantic-load-enable-semantic-debugging-helpers)的几个feature我都比较喜欢&＃xff0c;所以我也启用了。

有了这些基本配置&＃xff0c;在emacs打开C和C&＃43;&＃43;文件的时候&＃xff0c;semantic就会自动解析文件。不过有个问题&＃xff0c;一个cpp文件中肯定会include很多头文件&＃xff0c;要想解析这个cpp的内容&＃xff0c;头文件的信息是必要的&＃xff1b;但是头文件可能和cpp放在一起&＃xff0c;也可能放在系统某个目录下&＃xff0c;semantic怎么才能找到这个头文件一起解析呢&＃xff1f;

semantic是这样处理的&＃xff1a;1、如果当前目录中能找到&＃xff0c;就直接在当前文件中读取头文件。2、如果当前目录下没有&＃xff0c;就上系统INCLUDE目录中去找&＃xff08;在Linux下&＃xff0c;我们一般使用gcc编译器&＃xff0c;semantic会自动调用gcc&＃xff0c;取得gcc的INCLUDE目录&＃xff0c;比如/usr/include,/usr/local/include等&＃xff0c;但是Windows下就不行了&＃xff09;。

BTW&＃xff1a;很多文档中提到需要load semantic-gcc&＃xff0c;不过我没有load它&＃xff0c;在Linux下semantic仍然能自动把gcc的INCLUDE目录加进来。

semantic这种找法肯定会造成大量的头文件找不到的(找不到头文件还怎么解析啊)&＃xff0c;有两个问题需要解决&＃xff1a;1、很多工程中都会把头文件和实现文件分开放置&＃xff0c;比如头文件放在include(或者inc,public,common等)目录中&＃xff0c;实现文件放在src目录中&＃xff0c;这些目录semantic是不能自己找的&＃xff1b;2、在Windows下怎么能让semantic去找编译器的INCLUDE目录。

既然semantic不能自动查找找&＃xff0c;那就只能我们告诉semantic了&＃xff0c;办法是调用semantic-add-system-include函数&＃xff0c;这个函数会根据mode把路径加入到semantic-dependency-system-include-path里去。下面是我的配置&＃xff1a;

因为我在Windows下可能用MinGW和VC6&＃xff0c;所以我把它们的include目录都加进来了&＃xff0c;要是你用别的编译器&＃xff0c;就改成自己的目录好了。

另外&＃xff0c;我找了一些一般项目中经常用到的头文件目录名(include,inc,common,public)&＃xff0c;把它们也加进来了&＃xff0c;这样对于一般的项目来说基本上都能解析正确&＃xff08;比如我们在项目中见到头文件放在include目录实现文件放在src目录的方式&＃xff0c;对src目录下一个cpp文件&＃xff0c;通过“../include”这个路径就能找到对应的头文件&＃xff09;。如果你的项目中还用了其它一些目录名&＃xff0c;也可以配置在这儿。

上面配置中那一行(require ’semantic-c nil ‘noerror)是必须的&＃xff0c;因为semantic的大部分功能是autoload的&＃xff0c;如果不在这儿load semantic-c&＃xff0c;那打开一个c文件时会自动load semantic-c&＃xff0c;它会把semantic-dependency-system-include-path重设为/usr/include&＃xff0c;结果就造成前面自定义的include路径丢失了。

顺便说一下semanticdb-project-roots的配置&＃xff0c;很多地方都说要把它配置成”/”&＃xff0c;但是我在Linux/Mac/Windows都试验过&＃xff0c;不配这一行并没什么影响。

解析文件是semantic基本高级功能的基础&＃xff0c;正确地解析了文件我们才能实现&＃xff1a;代码跳转和代码补全。

有了前面的配置&＃xff0c;semantic自动就解析c/c&＃43;&＃43;文件&＃xff0c;解析完后跳转就容易了&＃xff1a;光标放在函数上&＃xff0c;执行M-x semantic-ia-fast-jump&＃xff0c;马上就跳转到函数的定义上了。如果跳不过去&＃xff0c;那就检查一下前面配置的INCLUDE路径&＃xff0c;是不是当前文件include的所有头文件都能在INCLUDE中找到。如果检查了很多遍都不好用&＃xff0c;那就换个项目或者别的文件试试&＃xff0c;确实存在semantic对某些文件支持不太好的情况&＃xff0c;比如boost。

semantic-ia-fast-jump这个功能如此常用&＃xff0c;我就把它绑定到f12上去了。

另外&＃xff0c;前面我们说过跳转过去了我们还需要跳回来&＃xff0c;在打开mru-bookmark-mode的情况下&＃xff0c;按[C-x B]&＃xff0c;emacs会提示你跳回到哪个地方&＃xff0c;一般默认的就是上一次semantic-ia-fast-jump的位置&＃xff0c;所以回车就可以回去了。

不过看代码时候我经常需要跳转后马上就跳回来&＃xff0c;要按[C-x B] [RET]这么多键实在有点麻烦&＃xff0c;所以我写了个函数不提示直接就跳回上次的位置&＃xff0c;并把它绑定到shift&＃43;f12上了&＃xff1a;

除了semantic-ia-fast-jump可以跳转之外&＃xff0c;其实semantic中还有两个函数也有类似的功能&＃xff1a;

• semantic-complete-jump-local
• semantic-complete-jump

看名字很容易看出来&＃xff0c;前一个只能在当前buffer内跳转&＃xff0c;后一个可以跳转到其它文件。不过这两个命令都需要用户手工输入要跳转的Tag名&＃xff0c;不能像semantic-ia-fast-jump那样自动识别当前光标处单词&＃xff0c;所以浏览代码时还是semantic-ia-fast-jump舒服。

cedet还有个功能在函数和声明和实现间跳转&＃xff0c;一般的&＃xff0c;函数声明放在h文件中&＃xff0c;函数的实现放在cpp文件中&＃xff0c;光标在函数体的时候通过M-x semantic-analyze-proto-impl-toggle可以跳到函数声明去&＃xff0c;在声明处再执行的话就会再跳回函数体&＃xff0c;我把它绑定到M-S-F12上了&＃xff1a;

不是这个功能不是十分准确&＃xff0c;一般在cpp中函数实现处想跳到函数声明处正常&＃xff0c;但是从声明处跳到实现处的话cedet不一定能找到cpp文件的位置。

semantic中有4个用来代码补全的命令&＃xff1a;

• senator-complete-symbol
• senator-completion-menu-popup
• semantic-ia-complete-symbol
• semantic-ia-complete-symbol-menu

senator-complete-symbol和semantic-ia-complete-symbol这两个函数是新开一个buffer提示可能的补全内容&＃xff1b;而senator-completion-menu-popup和semantic-ia-complete-symbol-menu会弹出一个补全菜单。

至于功能&＃xff0c;以senator开头的两个函数是调用senator补全&＃xff0c;另外两个是调用semantic-ia补全。至于senator和semantic-ia的区别&＃xff0c;http://alexott.net/en/writings/emacs-devenv/EmacsCedet.html#sec9是这样解释的&＃xff1a;

“semantic-ia调用semantic-analyze-possible-completions函数来取得可能的补全内容&＃xff0c;它能为用户提供精确的补全列表&＃xff1b;而senator用了一个更简单的的函数来获取补全内容&＃xff0c;所以有可能会提供错误的结果。”

也就是说semantic-ia的补全更智能一些。

至于semantic-ia这两个补全选哪一样就看各人喜好了&＃xff0c;我喜欢用semantic-ia-complete-symbol-menu&＃xff0c;因为看起来更直观一些&＃xff0c;像这样&＃xff1a;

semantic的补全菜单

我喜欢把它绑定到[Alt&＃43;n]上&＃xff1a;

不过semantic-ia-complete-symbol-menu只能用于GUI下&＃xff0c;要是在终端下&＃xff0c;就只能用semantic-ia-complete-symbol了。(终端下想要semantic-ia-complete-symbol一样的结果可以用别的插件&＃xff0c;比如auto-complete或者company-mode)

如果启用了semantic-idle-completions-mode&＃xff0c;不用按键只需要光标在.或者->后面停一会semantic就会自动开始补全了。

如果你用cedet不能补全&＃xff0c;检查一下semantic是不是已经启用了&＃xff0c;我的emacs上经常出现第一次打开c&＃43;&＃43;-mode时semantic没自动启用的情况。看semantic是否正常有个直观的方法就是senator&＃xff0c;如果启用了senator-minor-mode&＃xff0c;打开c&＃43;&＃43;文件时emacs会出现Senator菜单&＃xff0c;如果没有Senator菜单你可以关掉再重新打开试试&＃xff0c;要是仍然不出现菜单那就得检查配置是不是有问题。

如果确认semantic启用了仍然不能补全&＃xff0c;就需要检查INCLUDE路径的配置&＃xff0c;通过C-h v semantic-dependency-system-include-path RET检查INCLUDE路径&＃xff0c;确保当前cpp中直接或间接include的头文件都能在INCLUDE路径中找到。

emacs有自带的书签功能(c-x r m, c-x r b, c-x r l)&＃xff0c;不过对于用了多年VC6的我来说还是更习惯让一个书签能高亮显示出来。cedet里就带了一个可视化的书签&＃xff0c;通过下面的语句可以启用它&＃xff1a;

之后就可以通过下面几个按键操作书签了&＃xff1a;

• F2 在当前行设置或取消书签
• C-F2 查找下一个书签
• S-F2 查找上一个书签
• C-S-F2 清空当前文件的所有书签

看这个效果&＃xff1a;

cedet的可视化标签

有点遗憾的是这个书签功能只能在当前buffer的书签间跳转。

使用semantic-ia-fast-jump跳转时&＃xff0c;cedet有个很酷的效果&＃xff1a;在跳转到的行上实现一个淡入淡出的效果。具体的分析和使用看这儿。

cedet的contrib目录下有一些实用的小功能&＃xff0c;比如eassist.el就提供了一个在C&＃43;&＃43;的头文件和实现文件间跳转的小功能。

要使用这个功能首先要load它&＃xff1a;

之后就可以通过命令M-x eassist-switch-h-cpp来切换了&＃xff0c;我喜欢把它绑定到M-F12上&＃xff1a;

这个功能是依赖semantic的&＃xff0c;也就是说通过cpp找头文件时它也会上配置好的INCLUDE路径中去查找&＃xff0c;不过如果通过头文件找cpp文件&＃xff0c;好像只能找和头文件所在的同一目录了。

eassist-switch-h-cpp有个BUG&＃xff1a;它是通过文件扩展名来匹配的(通过eassist-header-switches可配置)&＃xff0c;默认它能识别h/hpp/cpp/c/C/H/cc这几个扩展名的文件&＃xff1b;但是C&＃43;&＃43;的扩展名还可能会有别的&＃xff0c;比如c&＃43;&＃43;,cxx等&＃xff0c;对一个扩展名为cxx的文件调用eassist-switch-h-cpp的话&＃xff0c;它会创建一个新buffer显示错误信息。所以我把eassist-header-switches配置为&＃xff1a;

基本上所有C/C&＃43;&＃43;的扩展名都包含了&＃xff0c;同时ObjectiveC也可以用了。