Using cscope within Atom Code Editor. This is my first Atom package which I created out of need since I was not able to find any package which could let me use cscope in Atom. (It may be there but is probably buried under a million packages so I could not find it.)
- Find this C symbol: ✓
- Find this global definition: ✓
- Find functions called by this function: ✓
- Find functions calling this function: ✓
- Find this text string: ✓
- Change this text string: ✗
- Find this egrep pattern: ✓
- Find this file: ✓
- Find files #including this file: ✓
- Find assignments to this symbol: ✓
Finds the selected text or word under cursor to perform a cscope lookup and displays the results in a panel which shows up above (Check the screenshot). Or you could just toggle the display of the atom-cscope panel and look it up yourself.
The following commands are registered to execute search with the word in selection or under cursor:
atom-cscope:find-symbol
atom-cscope:find-global-definition
atom-cscope:find-functions-called-by
atom-cscope:find-functions-calling
atom-cscope:find-text-string
atom-cscope:find-egrep-pattern
atom-cscope:find-file
atom-cscope:find-files-including
atom-cscope:find-assignments-to
The following commands are registered to toggle the Widget open with pre-selected options to save time.
atom-cscope:toggle
atom-cscope:toggle-symbol
atom-cscope:toggle-global-definition
atom-cscope:toggle-functions-called-by
atom-cscope:toggle-functions-calling
atom-cscope:toggle-text-string
atom-cscope:toggle-egrep-pattern
atom-cscope:toggle-file
atom-cscope:toggle-files-including
atom-cscope:toggle-assignments-to
Only atom-cscope:toggle has a keymap set. You can setup your own keymaps for
the other commands.
The command atom-cscope:focus-next allows you to switch between the main
editor and the widget, while the widget is open.
Command atom-cscope:refresh-db allows you to create/re-create the cscope
database for all the projects in the Atom workspace.
For all those who do not want to touch your mouse:
Command atom-cscope:project-select allows you to open a dropdown to select
the project in which you want to run the cscope query in.
Command atom-cscope:option-select allows you to open a dropdown to select
the cscope option.
There are 3 ways of executing a search:
- Live search: Executes a search with configurable delay after you input your search term.
- Enter Key: Just press enter after typing your input.
- Search button: Click the button.
If new search is same as previous search, no action is taken. However, you can force search by clicking on the "SCOPE IT!" button
You can navigate the Result Items using arrow keys and press enter to open
the target file in a new buffer and the cursor automatically moves to the
location of the query or you can click on the Result Item for the same effect.
This package has a history feature as of 24c51c.
atom-cscope:next and atom-cscope:prev are the commands you need to map.
Each time you open a result using this package, it is recorded in a history
stack. You can move back and forth in this stack. Ofcourse, if you move to the
middle of the stack and open a new result, you will lose the forward history, as
it is the behaviour of a stack.
You can use the existing cscope.out file, generate on your own, or generate through the widget with the lightning button.
To generate the cscope.out file on windows, you need to have the windows port
of the cscope binary and point to the location in the settings of this package.
Or just put it in your $PATH and mention cscope in the settings of this
package.
To generate cscope.out manually, in your project directory run:
find . -name "*.c" -o -name "*.cpp" -o -name "*.h" -o -name "*.hpp" > cscope.files
cscope -q -R -b -i cscope.filesAnd then the package will be able to use the cscope.out file to generate results.
- Add 'Change this text string' functionality