當前位置：
首頁 >
cscope 使用
發布時間：2025/5/22
30
豆豆
Cscope 是一個非常靈巧的工具，但是它仍然需要使用您最順手的編輯器去發揮它強大的功能。 幸運的是，Vim 已經包含了 Cscope 支持。
這篇指導主要介紹了 Vim 內在的 Cscope 支持，以及如何更好的通過已配置的 Map（a set of maps）實現搜索功能。
下面假設您有基本的使用類 vi 編輯器的技能 - 不過并不需要 Vim 更特殊和高深的功能（熟悉 ViM 的一些高級功能，比如多窗口等需要一定的精力和時間）。您不需要了解有關 Cscope 的任何信息：這就是我們下面要闡述的。
萬變不離其宗，如果您使用類似功能的軟件，比如 Vim 的?ctags，您會發現 Cscope 與其非常的相似。不過有一點不同的是，Cscope 比 ctags 有更多的搜索類型和選項。
這是具體步驟的指導，所以請您打開一個終端（shell），并且按照下面的步驟：
注意：如果您的 Vim 在編譯時沒有加入 '--enable-cscope' 選項，請您加入此選項并重新編譯安裝。大部分 Linux 發行版中 Vim 中的此編譯選項是被禁止的。
可惜 Cscope 有一個缺陷：您如果打算編輯一個新的搜索結果，那么您必須退出當前的編輯狀態。解決這一辦法就是 Vim 對應的插件。使用 CTRL-D 推出 Cscope。
助記符：'\' （反斜線）是在按鍵 ']' 的右邊（它用來對應 ctags 搜索）。
助記符：各分割條分割了您的 Vim 窗口。
現在運行 'cscope -b' 命令重新生成數據庫（ -b 參數表示僅僅重新生成數據庫而不調用 Cscope 前端），然后你就可以瀏覽 Java 程序中的變量等信息了。顯然，這說明 Cscope 解析器是非常靈活的。
在大型項目中，您可能需要 -q 選項，并且（或者）使用功能更強大的 'find' 命令。此方面請您查看?使用 Cscope 進行大型項目管理指南?文檔(好像已經壞了)。
然后再在同樣的目錄使用 Cscope 調用 cscope.files 文件（或者使用 'cscope -i /foo/cscope.files' 命令），然后再設置 $CSCOPE_DB 環境變量（指向 scscope.out 文件的結果）： cd /foo
cscope -b
CSCOPE_DB=/foo/cscope.out; export CSCOPE_DB
（上述的命令是針對 Bourne/Korn/Bash shells 的：我忘記怎么使用 csh-based Shell 來定義全局變量了，我不想在這上面花太多的功夫。）
您現在您本機上的任何目錄使用 'vim -t foo' 命令，然后 Vim 會跳轉到 'foo' 所定義的正確位置。我曾經嘗試編寫一些 Shell 腳本（就是定義 CSCOPE_DB 環境變量），用來切換我不同的項目，比如可以簡單的使用 'source projectA' 命令。
| BUG: Cscope 在 15.4 以前的版本中，有一個非常愚蠢的 BUG。如果數據庫名是另外名字而非 'cscope.out' 可能會造成 Vim 假死。解決這個問題的方法就是使用 '-f foo' 參數代替 'foot.out'，這樣就好了（最新版本已經解決了該問題）。 |
cscope_maps.vim文件內容：
" CSCOPE settings for vim
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
"
" This file contains some boilerplate settings for vim's cscope interface,
" plus some keyboard mappings that I've found useful.
"
" USAGE:
" -- vim 6: Stick this file in your ~/.vim/plugin directory (or in a
" 'plugin' directory in some other directory that is in your
" 'runtimepath'.
"
" -- vim 5: Stick this file somewhere and 'source cscope.vim' it from
" your ~/.vimrc file (or cut and paste it into your .vimrc).
"
" NOTE:
" These key maps use multiple keystrokes (2 or 3 keys). If you find that vim
" keeps timing you out before you can complete them, try changing your timeout
" settings, as explained below.
"
" Happy cscoping,
"
" Jason Duell jduell@alumni.princeton.edu 2002/3/7
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" This tests to see if vim was configured with the '--enable-cscope' option
" when it was compiled. If it wasn't, time to recompile vim...
if has("cscope")
""""""""""""" Standard cscope/vim boilerplate
" use both cscope and ctag for 'ctrl-]', ':ta', and 'vim -t'
set cscopetag
" check cscope for definition of a symbol before checking ctags: set to 1
" if you want the reverse search order.
set csto=0
" add any cscope database in current directory
if filereadable("cscope.out")
cs add cscope.out
" else add the database pointed to by environment variable
elseif $CSCOPE_DB != ""
cs add $CSCOPE_DB
endif
" show msg when any other cscope db added
set cscopeverbose
""""""""""""" My cscope/vim key mappings
"
" The following maps all invoke one of the following cscope search types:
"
" 's' symbol: find all references to the token under cursor
" 'g' global: find global definition(s) of the token under cursor
" 'c' calls: find all calls to the function name under cursor
" 't' text: find all instances of the text under cursor
" 'e' egrep: egrep search for the word under cursor
" 'f' file: open the filename under cursor
" 'i' includes: find files that include the filename under cursor
" 'd' called: find functions that function under cursor calls
"
" Below are three sets of the maps: one set that just jumps to your
" search result, one that splits the existing vim window horizontally and
" diplays your search result in the new window, and one that does the same
" thing, but does a vertical split instead (vim 6 only).
"
" I've used CTRL-\ and CTRL-@ as the starting keys for these maps, as it's
" unlikely that you need their default mappings (CTRL-\'s default use is
" as part of CTRL-\ CTRL-N typemap, which basically just does the same
" thing as hitting 'escape': CTRL-@ doesn't seem to have any default use).
" If you don't like using 'CTRL-@' or CTRL-\, , you can change some or all
" of these maps to use other keys. One likely candidate is 'CTRL-_'
" (which also maps to CTRL-/, which is easier to type). By default it is
" used to switch between Hebrew and English keyboard mode.
"
" All of the maps involving the <cfile> macro use '^<cfile>$': this is so
" that searches over '#include <time.h>" return only references to
" 'time.h', and not 'sys/time.h', etc. (by default cscope will return all
" files that contain 'time.h' as part of their name).
" To do the first type of search, hit 'CTRL-\', followed by one of the
" cscope search types above (s,g,c,t,e,f,i,d). The result of your cscope
" search will be displayed in the current window. You can use CTRL-T to
" go back to where you were before the search.
"
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>
" Using 'CTRL-spacebar' (intepreted as CTRL-@ by vim) then a search type
" makes the vim window split horizontally, with search result displayed in
" the new window.
"
" (Note: earlier versions of vim may not have the :scs command, but it
" can be simulated roughly via:
" nmap <C-@>s <C-W><C-S> :cs find s <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>s :scs find s <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>g :scs find g <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>c :scs find c <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>t :scs find t <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>e :scs find e <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>f :scs find f <C-R>=expand("<cfile>")<CR><CR>
nmap <C-@>i :scs find i ^<C-R>=expand("<cfile>")<CR>$<CR>
nmap <C-@>d :scs find d <C-R>=expand("<cword>")<CR><CR>
" Hitting CTRL-space *twice* before the search type does a vertical
" split instead of a horizontal one (vim 6 and up only)
"
" (Note: you may wish to put a 'set splitright' in your .vimrc
" if you prefer the new window on the right instead of the left
nmap <C-@><C-@>s :vert scs find s <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>g :vert scs find g <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>c :vert scs find c <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>t :vert scs find t <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>e :vert scs find e <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>f :vert scs find f <C-R>=expand("<cfile>")<CR><CR>
nmap <C-@><C-@>i :vert scs find i ^<C-R>=expand("<cfile>")<CR>$<CR>
nmap <C-@><C-@>d :vert scs find d <C-R>=expand("<cword>")<CR><CR>
""""""""""""" key map timeouts
"
" By default Vim will only wait 1 second for each keystroke in a mapping.
" You may find that too short with the above typemaps. If so, you should
" either turn off mapping timeouts via 'notimeout'.
"
"set notimeout
"
" Or, you can keep timeouts, by uncommenting the timeoutlen line below,
" with your own personal favorite value (in milliseconds):
"
"set timeoutlen=4000
"
" Either way, since mapping timeout settings by default also set the
" timeouts for multicharacter 'keys codes' (like <F1>), you should also
" set ttimeout and ttimeoutlen: otherwise, you will experience strange
" delays as vim waits for a keystroke after you hit ESC (it will be
" waiting to see if the ESC is actually part of a key code like <F1>).
"
"set ttimeout
"
" personally, I find a tenth of a second to work well for key code
" timeouts. If you experience problems and have a slow terminal or network
" connection, set it higher. If you don't set ttimeoutlen, the value for
" timeoutlent (default: 1000 = 1 second, which is sluggish) is used.
"
"set ttimeoutlen=100
endif
轉載于:https://www.cnblogs.com/jianyungsun/archive/2010/12/07/1899348.html
總結
- 上一篇： 微软：Visual Studio2010
- 下一篇： 重新建立索引脚本