A plugin to use Cscope for code navigation from inside Sublime Text 2 and 3.
This plugin supports the majority of the functionality offered by Cscope, namely:
- Find a given symbol
- Find a given function definition
- Find functions called by a given function
- Find functions calling a given function
- Find a given text string
- Find a given egrep pattern
- Find a given file
- Find files #including a given file
This plugin also allows the user to rebuild the Cscope database from inside Sublime Text.
- Install Cscope (a Windows port can be found here)
- Customize the cscope executable path as explained in the Configuration section below, if needed.
- Generate a cscope database (cscope.out) in the root directory of your project
- Check out the repo under your "Packages" directory or install via Package Control and restart Sublime Text.
Here's what the symbol lookup results buffer looks like:
If you wish to change the way CscopeSublime behaves, you have two options:
- Modify the corresponding setting in the default CscopeSublime.sublime-settings file in the package's directory
- Add a setting in your
Settings - Userfile prefixed withCscopeSublime_. For example, to modify thedisplay_outlinesetting and set it tofalse, put the line"CscopeSublime_display_outline": falsein your settings file.
Ctrl/Super + \- Show Cscope optionsCtrl/Super + L``Ctrl/Super + S- Look up symbol under cursorCtrl/Super + L``Ctrl/Super + D- Look up definition under cursorCtrl/Super + L``Ctrl/Super + E- Look up functions called by the function under the cursorCtrl/Super + L``Ctrl/Super + R- Look up functions calling the function under the cursorCtrl/Super + Shift + [- Jump backCtrl/Super + Shift + ]- Jump forward
The plugin will recursively search for the cscope database in parent directories of the currently open file until it either finds the database or reaches the root directory.
This whole package is distributed under the MIT license.