最近在學(xué)習(xí)內(nèi)核代碼,由于經(jīng)常用到Cedet來幫助瀏覽代碼,所以整理了一下Cedet的使用。 這里的Cedet是Emacs 23.2中自帶的,版本和sourceforge上的Cedet相同,但是其中的內(nèi) 容(主要是函數(shù)名之類)有不少的變化。這里以 A Gentle introduction to Cedet 為基礎(chǔ),寫的這個文章,結(jié)構(gòu)與之類似,內(nèi)容上有些地方是翻譯,但大多是我根據(jù)自己的 配置整理出來的。
1 什么是Cedet
CEDET 是 Collection of Emacs Development Environment Tools的縮寫, 意為"Emacs開發(fā)環(huán)境工具集",其主要目的是在Emacs中建立一個高級的開發(fā)環(huán)境。 它主要包括下列組件:
Semantic -— 多種編程語言的語法分析的基礎(chǔ)組件。
SemanticDB-—包含在Semantic中的一個數(shù)據(jù)庫,用于保存代碼的語法、接口等等信息。
Senator -— 通過Semantic提取出來的信息構(gòu)成的代碼文件中的navegation。
Srecode -— 代碼生成組件。
EDE -— 提供工程管理相關(guān)功能;
Speedbar -— 用于顯示當(dāng)前Buffer的側(cè)邊欄。
Eieio is a library, implementating CLOS-like (Common Lisp Object System) infrastructure for Emacs Lisp;
Cogre is a library for drawing of UML-like diagrams in Emacs buffer, with basic integration with Semantic.
其中,最后面這兩個我沒怎么用過。
2 Cedet的安裝和啟用
Emacs 23.2 中已經(jīng)自帶了Cedet,所以無需再單獨安裝,直接啟用即可:
(require 'cedet)
如果你想使用Cedet的工程管理功能,可以啟用EDE Mode ----
(global-ede-mode t)
3 Cedet 的定制
3.1 基本Helpter的定制
Emacs 23.2中自帶的Cedet中,去掉了原來的諸如 semantic-load-enable-minimum-features, semantic-load-enable-code-helpers 等等的命令,而是通過定制子模式(semantic-default-submodes)來確 定使用哪些輔助功能,最后使用semantic-mode 來啟用這些功能。
以下是我的設(shè)置:
;;;; Helper tools.
(custom-set-variables
'(semantic-default-submodes (quote (global-semantic-decoration-mode global-semantic-idle-completions-mode
global-semantic-idle-scheduler-mode global-semanticdb-minor-mode
global-semantic-idle-summary-mode global-semantic-mru-bookmark-mode)))
'(semantic-idle-scheduler-idle-time 3))
(semantic-mode)
3.2 Semantic/ia 的配置
semantic/ia 提供了機遇semantic的自動補齊,Tag信息顯示等功能, Semantic/ia 可通過下面的代碼來啟用和優(yōu)化
;; smart complitions
(require 'semantic/ia)
(setq-mode-local c-mode semanticdb-find-default-throttle
'(project unloaded system recursive))
(setq-mode-local c++-mode semanticdb-find-default-throttle
'(project unloaded system recursive))
3.3 頭文件的設(shè)置
C/C++ 的開發(fā)中,和頭文件要打很多交道。 頭文件分為兩種:系統(tǒng)頭文件和用戶自定義頭文件。
3.3.1 系統(tǒng)頭文件
如果我們使用的編譯器為gcc,那么可以使用 semantic/gcc 來自動加載系統(tǒng)的頭文件路徑。
當(dāng)然,在此基礎(chǔ)上,我們也可以使用 semantic-add-system-include 來手動顯示地添加某些路徑。
3.3.2 用戶頭文件
用戶自己定義的頭文件,一般所在的位置可以用與當(dāng)前路徑的相對關(guān)系來表示出來, 然后在手動添加。
系統(tǒng)頭文件和用戶頭文件的設(shè)置代碼如下:
;;;; Include settings
(require 'semantic/bovine/gcc)
(require 'semantic/bovine/c)
(defconst cedet-user-include-dirs
(list ".." "../include" "../inc" "../common" "../public" "."
"../.." "../../include" "../../inc" "../../common" "../../public"))
(setq cedet-sys-include-dirs (list
"/usr/include"
"/usr/include/bits"
"/usr/include/glib-2.0"
"/usr/include/gnu"
"/usr/include/gtk-2.0"
"/usr/include/gtk-2.0/gdk-pixbuf"
"/usr/include/gtk-2.0/gtk"
"/usr/local/include"
"/usr/local/include"))
(let ((include-dirs cedet-user-include-dirs))
(setq include-dirs (append include-dirs cedet-sys-include-dirs))
(mapc (lambda (dir)
(semantic-add-system-include dir 'c++-mode)
(semantic-add-system-include dir 'c-mode))
include-dirs))
(setq semantic-c-dependency-system-include-path "/usr/include/")
3.4 IMenu的集成
Semantic 可以通過imenu集成到Emacs菜單中, 從而通過菜單來顯示和訪問函數(shù)、變量以及其他Tag的列表。
Emacs 23.2 中,可以通過下面的代碼來實現(xiàn)這個功能:
;;;; TAGS Menu
(defun my-semantic-hook ()
(imenu-add-to-menubar "TAGS"))
(add-hook 'semantic-init-hooks 'my-semantic-hook)
3.5 Semanticdb 的定制
如果按照前面的代碼中來定制HelperTool,sematicdb會自動啟用。 這里我們首先需要自定義一下semanticdb的存放路徑,例如我的:
;;;; Semantic DataBase存儲位置
(setq semanticdb-default-save-directory
(expand-file-name "~/.emacs.d/semanticdb"))
semanticdb 可以使用其他工具產(chǎn)生的Tag,例如GNU Global產(chǎn)生的Tags, 可以按照下面的代碼來啟用:
;; 使用 gnu global 的TAGS。
(require 'semantic/db-global)
(semanticdb-enable-gnu-global-databases 'c-mode)
(semanticdb-enable-gnu-global-databases 'c++-mode)
3.6 管理C/C++的工程
建議使用EDE來管理C/C++工程,下面的代碼可用來定義一個工程:
(ede-cpp-root-project "Kernel"
:name "Kernel Project"
:file "~/Work/projects/kernel/linux-2.6.34/Makefile"
:include-path '("/"
"/include"
)
:system-include-path '("/usr/include")
:spp-table '(("__FLT_MIN__" . "1.17549435e-38F")
("__GCC_HAVE_SYNC_COMPARE_AND_SWAP_2" . "1")
("__SIZEOF_POINTER__" . "4")
("__GCC_HAVE_DWARF2_CFI_ASM" . "1")
("__FLT_MIN_EXP__" . "(-125)")
("__SIZEOF_PTRDIFF_T__" . "4")
("__FLT_HAS_INFINITY__" . "1")
("_FORTIFY_SOURCE" . "2")
("__ELF__" . "1")
("__DBL_MANT_DIG__" . "53")
("__DBL_EPSILON__" . "2.2204460492503131e-16")
("__GCC_HAVE_SYNC_COMPARE_AND_SWAP_4" . "1")
("__unix" . "1")
("__SIZEOF_WINT_T__" . "4")
("__LDBL_EPSILON__" . "1.08420217248550443401e-19L")
("__INT_MAX__" . "2147483647")
("__FLT_MAX_EXP__" . "128")
("__FLT_MAX__" . "3.40282347e+38F")
("__SIZEOF_DOUBLE__" . "8")
("__LDBL_DENORM_MIN__" . "3.64519953188247460253e-4951L")
("__DEC128_MANT_DIG__" . "34")
("__SHRT_MAX__" . "32767")
("__SIZEOF_LONG__" . "4")
("__GNUC__" . "4")
("__DEC32_MIN_EXP__" . "(-94)")
("__cplusplus" . "1")
("__tune_i486__" . "1")
("__DBL_HAS_DENORM__" . "1")
("__DEC128_SUBNORMAL_MIN__" . "0.000000000000000000000000000000001E-6143DL")
("__DEC64_MIN_EXP__" . "(-382)")
("__FLT_DENORM_MIN__" . "1.40129846e-45F")
("__PTRDIFF_TYPE__" . "int")
("__THROW" . "")
("__CHAR_BIT__" . "8")
("__linux__" . "1")
("__STDC_HOSTED__" . "1")
("__DEC32_MIN__" . "1E-95DF")
("__VERSION__" . "\"4.4.3\"")
("__DEC128_MIN_EXP__" . "(-6142)")
("__i386__" . "1")
("__DEC64_MIN__" . "1E-383DD")
("__DBL_MAX_10_EXP__" . "308")
("__DBL_MIN_10_EXP__" . "(-307)")
("__DEC64_MAX_EXP__" . "385")
("__FLT_EPSILON__" . "1.19209290e-7F")
("__DEPRECATED" . "1")
("__GXX_ABI_VERSION" . "1002")
("__DEC128_MIN__" . "1E-6143DL")
("__i486__" . "1")
("unix" . "1")
("__DEC64_MANT_DIG__" . "16")
("__DEC32_MAX_EXP__" . "97")
("linux" . "1")
("__SIZEOF_FLOAT__" . "4")
("__i486" . "1")
("__GNUC_PATCHLEVEL__" . "3")
("__DBL_DIG__" . "15")
("__SIZEOF_INT__" . "4")
("__DEC32_MAX__" . "9.999999E96DF")
("__i386" . "1")
("__DEC64_MAX__" . "9.999999999999999E384DD")
("__SIZEOF_SHORT__" . "2")
("__DEC128_MAX_EXP__" . "6145")
("__FINITE_MATH_ONLY__" . "0")
("__linux" . "1")
("__SCHAR_MAX__" . "127")
("__gnu_linux__" . "1")
("__LDBL_HAS_QUIET_NAN__" . "1")
("__BIGGEST_ALIGNMENT__" . "16")
("__DBL_HAS_INFINITY__" . "1")
("__DEC128_MAX__" . "9.999999999999999999999999999999999E6144DL")
("__DECIMAL_BID_FORMAT__" . "1")
("__NO_INLINE__" . "1")
("__FLT_MANT_DIG__" . "24")
("__FLT_HAS_QUIET_NAN__" . "1")
("__INTMAX_MAX__" . "9223372036854775807LL")
("__STDC__" . "1")
("__const" . "const")
("__restrict" . nil)
("__FLT_EVAL_METHOD__" . "2")
("__unix__" . "1")
("__DEC32_EPSILON__" . "1E-6DF")
("__GXX_RTTI" . "1")
("__SIZEOF_LONG_DOUBLE__" . "12")
("__LDBL_HAS_DENORM__" . "1")
("__LONG_LONG_MAX__" . "9223372036854775807LL")
("__DBL_MIN__" . "2.2250738585072014e-308")
("__DEC64_EPSILON__" . "1E-15DD")
("__LDBL_DIG__" . "18")
("__DBL_MIN_EXP__" . "(-1021)")
("__WCHAR_MAX__" . "2147483647")
("__DBL_DENORM_MIN__" . "4.9406564584124654e-324")
("__DECIMAL_DIG__" . "21")
("__DEC128_EPSILON__" . "1E-33DL")
("__LDBL_MANT_DIG__" . "64")
("__SIZEOF_WCHAR_T__" . "4")
("i386" . "1")
("__DEC64_SUBNORMAL_MIN__" . "0.000000000000001E-383DD")
("__LDBL_MIN__" . "3.36210314311209350626e-4932L")
("__FLT_HAS_DENORM__" . "1")
("__DBL_MAX__" . "1.7976931348623157e+308")
("__FLT_RADIX__" . "2")
("__DEC32_SUBNORMAL_MIN__" . "0.000001E-95DF")
("__LONG_MAX__" . "2147483647L")
("__EXCEPTIONS" . "1")
("__LDBL_MIN_EXP__" . "(-16381)")
("__DEC_EVAL_METHOD__" . "2")
("__DEC32_MANT_DIG__" . "7")
("__SIZEOF_LONG_LONG__" . "8")
("__GXX_WEAK__" . "1")
("__DBL_MAX_EXP__" . "1024")
("__SIZEOF_SIZE_T__" . "4")
("__FLT_MAX_10_EXP__" . "38")
("__DBL_HAS_QUIET_NAN__" . "1")
("__FLT_DIG__" . "6")
("__LDBL_MAX_10_EXP__" . "4932")
("__LDBL_MIN_10_EXP__" . "(-4931)")
("__GCC_HAVE_SYNC_COMPARE_AND_SWAP_1" . "1")
("__LDBL_MAX__" . "1.18973149535723176502e+4932L")
("__LDBL_MAX_EXP__" . "16384")
("__LDBL_HAS_INFINITY__" . "1")
("__GNUG__" . "4")
("__FLT_MIN_10_EXP__" . "(-37)")
("__GNUC_MINOR__" . "4")
("__GNUC_GNU_INLINE__" . "1")
("_GNU_SOURCE" . "1")
))
這里有幾個變量值得注意:
file:
file可以為該程根目錄下面的任意文件,該文件不用來解析,而只是這個工程的一個標(biāo)志。
include-path:
該變量是一個相對路徑,指出了自定義的include目錄。 其中的"/"并不表示系統(tǒng)的根目錄,而表示該工程的根目錄。
system-include-path:
這是一個絕對路徑,該路徑指明了系統(tǒng)的Include目錄。
spp-table:
spp-table 給出了預(yù)處理時的使用的宏,通常是在Makefile里使用-DXXX定義的宏。
這些宏可以在載入工程后,通過命令semantic-lex-spp-describe來獲得。
4 Cedet的使用
4.1 命名補齊
這里的補齊包括函數(shù)名稱,變量名等等,是很常用的一個功能。 個人以為最實用的一個補齊是 semantic-ia-complete-symbol, 他可以通過快捷鍵"C-c, /" 來調(diào)用。為了使用方便并和其他Package統(tǒng)一, 我將該函數(shù)添加到了hippie-expand中, 并將hippie-expand包進(jìn)了自定義的函數(shù)indent-or-complete (從別人的配置文件中找到的)中,并將這個函數(shù)綁定到了Tab上。 這樣,大多數(shù)情況下,通過Tab即可實現(xiàn)補齊或者對齊。 如果偶爾Tab不成功,再使用"M-/"或者"C-c, /"來修正一下。
這段配置的Lisp代碼如下:
;;;; 縮進(jìn)或者補齊
;;; hippie-try-expand settings
(setq hippie-expand-try-functions-list
'(
yas/hippie-try-expand
semantic-ia-complete-symbol
try-expand-dabbrev
try-expand-dabbrev-visible
try-expand-dabbrev-all-buffers
try-expand-dabbrev-from-kill
try-complete-file-name-partially
try-complete-file-name
try-expand-all-abbrevs))
(defun indent-or-complete ()
"Complete if point is at end of a word, otherwise indent line."
(interactive)
(if (looking-at "\\>")
(hippie-expand nil)
(indent-for-tab-command)
))
(defun yyc/indent-key-setup ()
"Set tab as key for indent-or-complete"
(local-set-key [(tab)] 'indent-or-complete)
)
此外,對于C和C++的struct/class結(jié)構(gòu),函數(shù)semantic-complete-self-insert 可以插入類或結(jié)構(gòu)中的成員變量,將至綁定到"."或者">",會加速代碼編寫的效率:
;;;; C-mode-hooks .
(defun yyc/c-mode-keys ()
"description"
;; Semantic functions.
(semantic-default-c-setup)
(local-set-key "\C-c?" 'semantic-ia-complete-symbol-menu)
(local-set-key "\C-cb" 'semantic-mrub-switch-tags)
(local-set-key "\C-cR" 'semantic-symref)
(local-set-key "\C-cj" 'semantic-ia-fast-jump)
(local-set-key "\C-cp" 'semantic-ia-show-summary)
(local-set-key "\C-cl" 'semantic-ia-show-doc)
(local-set-key "\C-cr" 'semantic-symref-symbol)
(local-set-key "\C-c/" 'semantic-ia-complete-symbol)
(local-set-key [(control return)] 'semantic-ia-complete-symbol)
(local-set-key "." 'semantic-complete-self-insert)
(local-set-key ">" 'semantic-complete-self-insert)
;; Indent or complete
(local-set-key [(tab)] 'indent-or-complete)
)
(add-hook 'c-mode-common-hook 'yyc/c-mode-keys)
4.2 獲取Tag信息
semantic-ia-show-doc, semantic-ia-show-summary, semantic-ia-describe-class 這三個函數(shù)可以用來獲取Tag信息,顯示出代碼的注釋(包括Doxgen的注釋), 對于閱讀代碼有很大幫助。
這些函數(shù)可以按照自己的習(xí)慣去綁定。其中前面兩個的綁定過程在前面的 yyc/c-mode-keys中可以找到。
4.3 代碼中的跳轉(zhuǎn)
閱讀代碼時候,在不同的Tag中跳轉(zhuǎn)是一個很有用的功能。 Cedet提供了這個功能,但是我手頭上的Emacs 23.2 中自帶的Cedet在Tag 跳轉(zhuǎn)上有個問題————可以用 semantic-ia-fast-jump 跳轉(zhuǎn)到Tag定義, 但是每次跳轉(zhuǎn)后,卻不能跳回來。
按照本文3.1節(jié)的方法設(shè)置Helper以后,在配置文件中添加下面的代碼可以解決這一問題:
(defadvice push-mark (around semantic-mru-bookmark activate)
"Push a mark at LOCATION with NOMSG and ACTIVATE passed to `push-mark'.
If `semantic-mru-bookmark-mode' is active, also push a tag onto
the mru bookmark stack."
(semantic-mrub-push semantic-mru-bookmark-ring
(point)
'mark)
ad-do-it)
4.4 查找函數(shù)調(diào)用
前面一節(jié)說的是在當(dāng)前函數(shù)中,跳到Tag定義;而這里, 說的是查看當(dāng)前光標(biāo)下面的函數(shù)被哪些函數(shù)調(diào)用了。 Cedet中的 semantic-symref 實現(xiàn)了這一功能。 可以將該函數(shù)綁定到自己喜歡的快捷鍵上,如4.1中所示。
對于代碼的瀏覽這個部分,我大部分時候使用的是global這個工具, global配置Xgtags來用,很方便。
4.5 Srecode的使用
Cedet提供了srecode,用于自動生成代碼。但,個人感覺這個功能不怎么好用, 或者說是我不會用吧。
Emacs 23.2中自帶的Cedet,僅提供了srecode的功能,但卻沒有將需要的template 一起和emacs一同發(fā)布出來。
對此,我的做法是修改了srecode-map-load-path,添加了 "~/.emacs.d/templates/srecode",
;;;; Custom template for srecode
(setq srecode-map-load-path
(list (srecode-map-base-template-dir)
(expand-file-name "~/.emacs.d/templates/srecode")
))
然后從cedet官網(wǎng)上 下載源碼包,并把template解壓到 "~/.emacs.d/templates/srecode"中。
然后將可以使用srecode-insert之類的函數(shù)來插入代碼模版了。