将Emacs打造成阅读源代码的神器

原文地址为： 将Emacs打造成阅读源代码的神器

Start

Emacs是一个功能相对较多而且很复杂的text­editor，所以想要熟练使用必须要对emacs的一些基本概念进行了解，了解这些概念最好的教程就是emacs自带的 “Emacs Tutorial“。可以通过点击菜单栏的Help->Emacs Tutorial(choose language)进行学习。

将Emacs打造成舒适的代码阅读器

要想将Emacs打造成舒适的代码阅读环境除了需要Emacs本体之外，还需要几种插 件来帮助我们实现这个愿望。Emacs是一种扩展性很强的编辑器，并且定义了一种 elisp语言来专门配置Emacs并开发新的功能。我们为将emacs打造成代码阅读器所 需要的插件主要有 CEDET，ECB以及CSCOPE，下面分别介绍一下这几个插件的作用。

CEDET

cedet是一堆完全用elisp实现的emacs工具的集合。包含了很多的功能，这个插件 的主要目的是为Emacs提供基础功能的支持以使其变成变成类似Eclipse或VS系列 这样的高级开发环境。

ECB

ECB是“Emacs Code Browser”的简称，从其名字就可以看出这个插件的作用是将 Emacs变成一
个代码浏览器。使用了ECB之后的效果可见下图。

CSCOPE

Cscope 是一款开源免费的 C/C++浏览工具，自带一个基于文本的用户界面，通过 cscope可以很方便地找到某个函数或变量的定义位置、被调用的位置等信息。 Cscope对 C /C++支持较好，也可以自己定制来支持Java和Perl、Python等脚本语 言。所以CSCOPE是一个为代码浏览提供基础功能的程序，这个程序并不是为了 Emacs而专门开发的，因此要想在Emacs上使用这个程序需要在Emacs中安装插件调 用CSCOPE提供的功能。

安装

接下来介绍这些插件的安装过程，首先CEDET的支持是直接包含在emacs中的并不 需要额外安装，因此我们只要安装ECB和CSCOPE就可以了。在介绍具体的安装过程 之前先介绍下emacs的插件配置过程。

Emacs的插件配置

简单地说Emacs的插件配置主要有以下两步，第一步是将插件文件拷贝到emacs的 插件文件夹（默认是～文件夹下的.emacs.d/）中，第二部是在emacs的配置文件 （～下的.emacs）中描述这个插件的路径loadpath)并启用插件。

ECB的安装

https://github.com/alexott/ecb 下载ecb的tar文件，解压后将解压出来的文件 拷贝到.emacs.d中并编辑emacs配置文件加入以下代码。注意将文件的位置改成自 己的位置。

;;将ECB的路径添加到读取列表中
(add­to­list 'load­path "/home/augustus/.emacs.d/ecb­master")
;;告诉emacs启用ecb
(require 'ecb)

保存emacs配置文件并重新启动emacs就可以在菜单栏的Tools­>Start Code Browser打开ecb了。

CSCOPE的安装

首先要在系统上安装CSCOPE

sudo apt­get install cscope

然后去CSCOPE的官网http://cscope.sourceforge.net/ 下载源码包，并将其中的 xcscope.el拷贝到
loadpath包含的目录里。并在.emacs里面加上

;;告诉emacs启用cscope
(require 'xcscope)

至此，用emacs来阅读c/c++源代码所需要的工具包都安装好了，当然用emacs来写代码调试代码都是很方便的，也有很多相关的插件，但这已不在本文的范围之内了。

CSCOPE使用方法

下面我们用bitvisor的源代码为例展示一下用这套工具阅读源码的强大之处。首先我们用配置好的emacs打开vtmain.c文件，然后在菜单栏里选择Tools­>Start Code Browser(ECB)来开启ECB，也可以使用M­x ‘ecb­activate来开启ecb。并且可以看到菜单栏里出现了CSCOPE的菜单，下面我就来一一介绍下CSCOPE提供的 这些功能都有什么作用。

建立索引

首先CSCOPE对源码进行分析时需要对要分析的源码建立一个索引，否则就没办法 提供诸如代码跳转之类的功能。通过在菜单栏选择Cscope­>Cscope Database­>Set Initial Dictionary设置代码的初始目录，然后再选择create list of files to index 并选择一个目录，这样cscope就会对该目录下的所有源 代码建立索引，也就意味着在你选择的这个目录范围之内的所有源代码都可以在你阅读和分析的时候进行变量函数等内容的跳转。

功能介绍

Find Symbol

我们以Find Symbol这个指令为例介绍下CSCOPE的使用，其他的指令和这个指令的 功能是类似的。如文字意思所述，这个指令提供的功能是在源代码中搜索一个 Symbol，这个Symbol可以理解为变量，函数名称，类名等有意义的符号。通过选 中想要查找的内容然后选择这个指令就可以在所有源码中搜索选中的这个符号了。 然后就会看到下图的内容

CSCOPE给出了所有包含这个Symbol的文件list， 只要点击鼠标中键就可以查看对应的那行代码了。当你看完代码想要回到跳转之前的那段代码只要选择Cscope菜单里的pop mark功能就好了。类似的功能有Find globaldefinition no prompting, Find text String, Find egrep pattern, Find a file等，都可以通过名字来判断功能，使用方法上和Find Symbol是一样 的。当然如果完全用鼠标选择这些功能的话效率是非常低下的，所以我们需要快 捷键来提高我们的工作效率, Emacs本身为这些功能定义好了一组快捷键，但是使 用起来一点都不方便，以Find Symbol为例他的快捷键是’C­c s s’,也就是说要按下Control+C 再按 s s才能完成这一功能，所以我们要改造Cscope的快捷键。

自定义快捷键

在emacs里自定义快捷键是一件十分方便和快捷的事情,只要打开.emacs文件进行 设置就可以了，这里我给出一段.emacs中设置快捷键的代码

;;将find­this­file功能绑定到Ctrl+F4上
(define­key global­map [(control f4)] 'cscope­find­this­file)
;;将find­this­symbol功能绑定到Ctrl+F5上
(define­key global­map [(control f5)] 'cscope­find­this­symbol)
(define­key global­map [(control f6)] 'cscope­find­this­text­string)
(define­key global­map [(control f7)] 'cscope­find­global­definition­no­prompting)
(define­key global­map [(control f8)] 'cscope­pop­mark)
(define­key global­map [(control f9)] 'cscope­prev­symbol)
(define­key global­map [(control f10)] 'cscope­next­symbol)
(define­key global­map [(control f11)] 'cscope­prev­file)
(define­key global­map [(control f12)] 'cscope­next­file)

这样通过一番调试和适应之后就能很快的学会Emacs看源代码啦！

转载请注明本文地址： 将Emacs打造成阅读源代码的神器