sponsor Vim development Vim logo Vim Book Ad

cscope.vim : create cscope database and connect to existing proper database automatically.

 script karma  Rating 32/12, Downloaded by 1206    Comments, bugs, improvements  Vim wiki

created by
brook hong
script type
This plugin helps you to create cscope database and connect to existing proper database automatically.

For latest version and bug reports, please go to https://github.com/brookhong/cscope.vim

Default settings --

    " in case your cscope execute is not in system path.
    " let g:cscope_cmd = 'D:/tools/vim/cscope.exe'
    " s: Find this C symbol
    map <leader>fs :call CscopeFind('s', expand('<cword>'))<CR>
    " g: Find this definition
    map <leader>fg :call CscopeFind('g', expand('<cword>'))<CR>
    " d: Find functions called by this function
    map <leader>fd :call CscopeFind('d', expand('<cword>'))<CR>
    " c: Find functions calling this function
    map <leader>fc :call CscopeFind('c', expand('<cword>'))<CR>
    " t: Find this text string
    map <leader>ft :call CscopeFind('t', expand('<cword>'))<CR>
    " e: Find this egrep pattern
    map <leader>fe :call CscopeFind('e', expand('<cword>'))<CR>
    " f: Find this file
    map <leader>ff :call CscopeFind('f', expand('<cword>'))<CR>
    " i: Find files #including this file
    map <leader>fi :call CscopeFind('i', expand('<cword>'))<CR>
    map <leader>l :call ToggleLocationList()<CR>

To use the plugin, just open your source file with VIM, and press <leader>fs with cursor on a function name.

The plugin will try to find and connect a proper cscope database for current file. If there is no proper cscope database for current file, you are prompted to specify a folder with a string like --

    *** Can not find proper cscope db, please input a path to create cscope db for. ***

Then the plugin will create cscope database for you, connect to it, and find what you want.

The found result will be listed in location list window, press <leader>l to toggle it.

Next time when you open the same file or other file that the cscope database can be used for, the plugin will connect to the cscope database automatically. You need not take care of anything about cscope database.

There is one case you need take care cscope database. If you have some files added/edited in those folders for which cscope databases have been created, then you want to refresh the cscope database, you can use command --

    :CscopeGen [path_to_the_folder]

If there is no path_to_the_folder provided, all existing cscope databases will be re-created.

For exmample,

    :CscopeGen /works/vim/src

Other commands --

    :CscopeClear    to remove all existing cscope databases
    :CscopeList     to list all existing cscope databases

Here is example output from :CscopeList

ID                   COUNT    PATH
*1337668712           3        /works/vim/src

'*'         means the db has been connected.
ID          id of the db.
COUNT       how many times this db has ever been used.
PATH        which folder the db is for.
install details
Just unzip the zip file to your VIM file path, usually to be ~/.vim.


Bundle 'brookhong/cscope.vim'

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
cscope.zip 1.01 2012-05-31 7.2 brook hong minor fix of CscopeFind
cscope.zip 1.0 2012-05-23 7.2 brook hong Initial upload
ip used for rating:

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
SourceForge.net Logo