linux下使用 vim + cscope 查看代碼

這兩天想要在linux下編寫量比較大的代碼，聽說vim+cscope可以實作類別似sourceinsight的功能，就花了半天時間學習cscope的使用。

1. vim的準備

首先 vim --version | grpe
cscope，看看vim是否支援cscope，如果不支援需要重新安裝vim。最簡單的是在./configure
後加上-enable-cscope，當然可以在Makefile檔案（./src/Makefile）中修改（把原來的注釋去掉），這是最根本的：
CONF_OPT_CSCOPE = --enable-cscope
然後安裝：make && make install

2. cscope的準備

安裝cscope（我的版本15.6），由於是非root使用者，需要./configure --prefix=$HOME/local/cscope指可執行定檔案和man檔案的地址。

3. 產生所需的檔案

前兩樣都具備了，現在可以在vim中用cscope來看代碼了。怎麼看？？ 如同sourceingight一樣，cscope需要一些資料檔案（資料庫&索引）來尋找代碼的相關關鍵字資訊。
這些檔案需要手工產生： 格式： cscope [options]


下面是cscope的常用選項：

現在進入代碼的根目錄然後：cscope -Rbq。這個命令會產生三個檔案：cscope.out, cscope.in.out, cscope.po.out。其
中cscope.out是基本的符號索引，後兩個檔案是使用"-q"選項產生的，可以加快cscope的索引速度。
cscope預設只解析C檔案(.c和.h)、lex檔案(.l)和yacc檔案(.y)，雖然它也可以支援C++以及Java，但它在掃描目錄時會跳
過C++及Java尾碼的檔案。如果你希望cscope解析C++或Java檔案，需要把這些檔案的名字和路徑儲存在一個名為cscope.files的檔案
。當cscope發現在目前的目錄中存在cscope.files時，就會為cscope.files中列出的所有檔案產生索引資料庫。
一般用如下命令產生包含cpp檔案的cscope.files:
find ./ -name "*.h" -o -name "*.c" -o -name "*.cpp" > cscope.files
在cscope.files產生以後，就可以cscope -bq來得到索引（.out）檔案了。

-R:
在產生索引檔案時，搜尋子目錄樹中的代碼
-b:
只產生索引檔案，不進入cscope的介面
-q:
產生cscope.in.out和cscope.po.out檔案，加快cscope的索引速度
-k:
在產生索引檔案時，不搜尋/usr/include目錄
-i:
如果儲存檔案清單的檔案名稱不是cscope.files時，需要加此選項告訴cscope到哪兒去找源檔案清單。可以使用“-”，表示由標準輸入獲得檔案清單。
-I dir:
在-I選項指出的目錄中尋找標頭檔
-u:
掃描所有檔案，重建交叉索引檔案
-C:
在搜尋時忽略大小寫
-P path:
在以相對路徑表示的檔案前加上的path，這樣，你不用切換到你資料庫檔案所在的目錄也可以使用它了。

 

4. 在vim中使用cscope

在
VIM
中使用cscope
非常簡單，首先調用“
cscope add
”命令添加一個
cscope
資料庫，然後就可以調用“
cscope find
”命令進行尋找了。
VIM
支援
8
種
cscope的查詢功能，如下：
例如，我們想在
代碼中尋找調用
work()
函數的函數，我們可以輸入：“
:cs find c work
”，斷行符號後發現沒有找到匹配的功能，可能並沒有函數調用work
()
。我們再輸入“
:cs find s work
”，尋找這個
符號出現的位置，現在vim
列出了這個符號出現的所有位置。
我們還可以進行字串尋找，它會雙引號或單引號括起來的內容中尋找。還可以輸入一個Regex，這類似於
egrep
程式的功能。

s:
尋找C語言符號，即尋找函數名、宏、枚舉值等出現的地方
g:
尋找函數、宏、枚舉等定義的位置，類似ctags所提供的功能
d:
尋找本函數調用的函數
c:
尋找調用本函數的函數
t:
尋找指定的字串
e:
尋找egrep模式，相當於egrep功能，但尋找速度快多了
f:
尋找並開啟檔案，類似vim的find功能
i:
尋找包含本檔案的文

 

可以看到，想尋找一個關鍵詞要輸入不少命令，降低了效率，其實可以通過快速鍵實現快速尋找。下面是從網上找到的一個.vimrc中進行cscope選項和鍵盤對應的指令碼段：

 

"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" cscope setting
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
if has("cscope")
       set csprg=/usr/bin/cscope
       set csto=1
       set cst
       set nocsverb
       " add any database in current directory
       if filereadable("cscope.out")
           cs add cscope.out
       endif
       set csverb
endif

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>

初次使用可能會覺得恨不適應，慢慢習慣了就好。在
VIM
的網站上有很多與
cscope
相關的外掛程式：http://www.vim.org/scripts/script_search_results.php?keywords=cscope&script_type=&order_by=rating&direction=descending&search=search
，還有cscope的首頁：http://cscope.sourceforge.net/

。

原文地址：http://hi.baidu.com/ganss/blog/item/bbb676d35a3351023af3cfe2.html