分类: LINUX
2009-10-03 12:12:58
Cscope 是一个非常灵巧的工具,但是它仍然需要使用您最顺手的编辑器去发挥它强大的功能。 幸运的是,Vim 已经包含了 Cscope 支持。
这篇指导主要介绍了 Vim 内在的 Cscope 支持,以及如何更好的通过已配置的 Map(a set of maps)实现搜索功能。
下面假设您有基本的使用类 vi 编辑器的技能 - 不过并不需要 Vim 更特殊和高深的功能(熟悉 ViM 的一些高级功能,比如多窗口等需要一定的精力和时间)。您不需要了解有关 Cscope 的任何信息:这就是我们下面要阐述的。
万变不离其宗,如果您使用类似功能的软件,比如 Vim 的 ,您会发现 Cscope 与其非常的相似。不过有一点不同的是,Cscope 比 ctags 有更多的搜索类型和选项。
这是具体步骤的指导,所以请您打开一个终端(shell),并且按照下面的步骤:
注意:如果您的 Vim 在编译时没有加入 '--enable-cscope' 选项,请您加入此选项并重新编译安装。大部分 Linux 发行版中 Vim 中的此编译选项是被禁止的。
可惜 Cscope 有一个缺陷:您如果打算编辑一个新的搜索结果,那么您必须退出当前的编辑状态。解决这一办法就是 Vim 对应的插件。使用 CTRL-D 推出 Cscope。
助记符:'\' (反斜线)是在按键 ']' 的右边(它用来对应 ctags 搜索)。
助记符:各分割条分割了您的 Vim 窗口。
find . -name '*.java' > cscope.files
现在运行 'cscope -b' 命令重新生成数据库( -b 参数表示仅仅重新生成数据库而不调用 Cscope 前端),然后你就可以浏览 Java 程序中的变量等信息了。显然,这说明 Cscope 解析器是非常灵活的。
在大型项目中,您可能需要 -q 选项,并且(或者)使用功能更强大的 'find' 命令。此方面请您查看 文档(好像已经坏了)。
find /my/project/dir -name '*.c' -o -name '*.h' > /foo/cscope.files然后再在同样的目录使用 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 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 themacro use '^ $': this is so
" that searches over '#include" 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.
"
nmaps :cs find s =expand(" ")
nmapg :cs find g =expand(" ")
nmapc :cs find c =expand(" ")
nmapt :cs find t =expand(" ")
nmape :cs find e =expand(" ")
nmapf :cs find f =expand(" ")
nmapi :cs find i ^ =expand(" ") $
nmapd :cs find d =expand(" ")
" 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:
" nmaps :cs find s =expand(" ")
nmaps :scs find s =expand(" ")
nmapg :scs find g =expand(" ")
nmapc :scs find c =expand(" ")
nmapt :scs find t =expand(" ")
nmape :scs find e =expand(" ")
nmapf :scs find f =expand(" ")
nmapi :scs find i ^ =expand(" ") $
nmapd :scs find d =expand(" ")
" 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
nmaps :vert scs find s =expand(" ")
nmapg :vert scs find g =expand(" ")
nmapc :vert scs find c =expand(" ")
nmapt :vert scs find t =expand(" ")
nmape :vert scs find e =expand(" ")
nmapf :vert scs find f =expand(" ")
nmapi :vert scs find i ^ =expand(" ") $
nmapd :vert scs find d =expand(" ")
""""""""""""" 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), 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).
"
"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