Cscope layer

Table of ContentsClose

1. Description
- 1.1. Features:
2. Install
3. Usage
4. Key bindings

1. Description

This layer provides bindings for using Cscope and PyCscope in Spacemacs.

See here for a comparison between Cscope and other similar tools (such as gtags).

1.1. Features:

Tag indexing and searching for C-C++ via Cscope
Tag indexing and searching for python via PyCscope

2. Install

2.1. Layer

To use this configuration layer, add it to your ~/.spacemacs. You will need to add cscope to the existing dotspacemacs-configuration-layers list in this file.

2.2. Cscope

Enable c-c++ layer in your ~/.spacemacs file. Install Cscope through your package manager, or download it from the website and build it from source.

From package manager (for example, Ubuntu):

sudo apt-get install cscope

From source:

tar xvf cscope-15.8b
cd cscope-15.8b
./configure
make
sudo make install

2.3. PyCscope

Enable python layer in your ~/.spacemacs file. Install PyCscope through pip:

pip install pycscope

3. Usage

Before using any helm-cscope commands, remember to create a Cscope index file. Do it by running the command cscope-index-files for C and C++ projects, or the command cscope/run-pycscope for Python projects, bound to SPC m g i.

4. Key bindings

Key binding	Description
`SPC m g =`	Find assignments to a symbol
`SPC m g c`	find which functions are called by a function
`SPC m g C`	find where a function is called
`SPC m g d`	find global definition of a symbol
`SPC m g e`	search regular expression
`SPC m g f`	find a file
`SPC m g F`	find which files include a file
`SPC m g i`	create Cscope index
`SPC m g r`	find references of a symbol
`SPC m g x`	search text