Drupal source code and [g]vim/cscope

When you start looking at modules developed for Drupal - you kinda get lost amidst all the references to different system functions - user_external_load, db_query, etc. It becomes really maddening!

Fortunately a cscope-enable gvim binary will ease out the source code browsing angst to a large extent. Amongst all the other things, here is what I have in my .vimrc

if has("cscope")

   function! CScope_Refresh()

cs kill 0

 !find $PWD -name \*.php > files && cscope -b -i files

!find $PWD -name \*.js >> files && cscope -b -i files

!find $PWD -name \*.module >> files && cscope -b -i files

!find $PWD -name \*.info >> files && cscope -b -i files

!find $PWD -name \*.install >> files && cscope -b -i files

!find $PWD -name \*.inc >> files && cscope -b -i files

cs add .

!rm -f files

endfunction

comm! -nargs=0 R call CScope_Refresh()

endif

After you have sourced your .vimrc again, you can navigate into your Drupal install directory, fire up gvim and just hit :R and you will be able to search for symbols, look for references to functions, look for files etc. using the standard cscope commands:

e.g.:

:cs find g user_menu

The above will lead us to the definition of the user_menu function in user.module. 

Hope, this post will relieve some of your source code browsing pangs :)