File cscope-maps-20210418.obscpio of Package vim-plugins
07070100000000000081A4000000000000000000000001607C1B290000068F000000000000000000000000000000000000001F00000000cscope-maps-20210418/README.md# cscope-maps
Just old good cscope maps plugin for vim, taken from [1]. Made a mirror just to
use it in unified way with vim package manager. This repository has some
extra improvements on top of original plugin.
## Description
This plugin adds some boilerplate settings for vim's cscope interface, plus some
keyboard mappings that I've found useful.
These key maps use multiple keystrokes (2 or 3 keys). If you find that vim keeps
timing you out before you can complete them, try changing your timeout settings
in plugin file.
For more details please refer to [2].
## Changes
Next changes are made in this repository comparing to original plugin:
* Add key binding to search for C structure (Ctrl-S), in case the structure is
defined using K&R style, e.g.: `struct abc {`
* Use Ctrl-Space key binding to split vertically (as opposed to horizontal
split in original plugin). To split horizontally, use Ctrl-Space-Space.
* If `cscope.out` file is missing in current directory, try to look for it
in upper directories
* Fix some typos
## Installation
* __vim 8__: Stick this file in `~/.vim/pack/<dir>/start/cscope/plugin/`
where `<dir>` is any arbitrary name. Lookup Vim8 packages
for more details.
* __vim 6__: Stick this file in your `~/.vim/plugin` directory (or in a
'plugin' directory in some other directory that is in your
'runtimepath'.
* __vim 5__: Stick this file somewhere and 'source cscope.vim' it from
your `~/.vimrc` file (or cut and paste it into your `.vimrc`).
[1] http://cscope.sourceforge.net/cscope_maps.vim
[2] http://cscope.sourceforge.net/cscope_vim_tutorial.html
07070100000001000041ED000000000000000000000002607C1B2900000000000000000000000000000000000000000000001C00000000cscope-maps-20210418/plugin07070100000002000081A4000000000000000000000001607C1B2900002030000000000000000000000000000000000000002C00000000cscope-maps-20210418/plugin/cscope_maps.vim""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" CSCOPE settings for vim
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
"
" This file contains some boilerplate settings for vim's cscope interface,
" plus some keyboard mappings that I've found useful.
"
" NOTE:
" These key maps use multiple keystrokes (2 or 3 keys). If you find that vim
" keeps timing you out before you can complete them, try changing your timeout
" settings, as explained below.
"
" Happy cscoping,
"
" Original author:
" Jason Duell <jduell@alumni.princeton.edu> 2002/3/7
"
" Other contributors:
" Sam Protsenko <joe.skb7@gmail.com> 2020
" Pete Dietl <petedietl@gmail.com> 2020
" Do Trung Nguyen <dtngn@dtngn.org> 2021
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
" This tests to see if vim was configured with the '--enable-cscope' option
" when it was compiled. If it wasn't, time to recompile vim...
if has("cscope")
""""""""""""" Standard cscope/vim boilerplate
" use both cscope and ctag for 'ctrl-]', ':ta', and 'vim -t'
set cscopetag
" check cscope for definition of a symbol before checking ctags: set to 1
" if you want the reverse search order.
set csto=0
" hide msg when adding cscope database at start
set nocscopeverbose
" Find and add a cscope file. Either from CSCOPE_DB or by searching for it
" recursively starting in the CWD and going up to /
if $CSCOPE_DB != ""
cs add $CSCOPE_DB
else
" Get all parts of our current path
let dirs = split($PWD, '/')
" Start building a list of paths in which to look for cscope.out
let paths = ['/']
" /foo/bar/baz would result in the `paths` array containing:
" [/ /foo /foo/bar /foo/bar/baz]
for d in dirs
let paths = add(paths, paths[len(paths) - 1] . d . '/')
endfor
" List is backwards search order, so reverse it.
for d in reverse(paths)
let cscope_file = d . "/cscope.out"
if filereadable(cscope_file)
execute('cs add ' . cscope_file)
break
endif
endfor
endif
" show msg when any other cscope db added
set cscopeverbose
""""""""""""" My cscope/vim key mappings
"
" The following maps all invoke one of the following cscope search types:
"
" 's' symbol: find all references to the token under cursor
" 'g' global: find global definition(s) of the token under cursor
" 'c' calls: find all calls to the function name under cursor
" 't' text: find all instances of the text under cursor
" 'e' egrep: egrep search for the word under cursor
" 'f' file: open the filename under cursor
" 'i' includes: find files that include the filename under cursor
" 'd' called: find functions that function under cursor calls
" 'a' assignments: find places where this symbol is assigned a value
" 'S' struct: find struct definition under cursor
"
" Below are three sets of the maps: one set that just jumps to your
" search result, one that splits the existing vim window horizontally and
" displays your search result in the new window, and one that does the same
" thing, but does a vertical split instead (vim 6 only).
"
" I've used CTRL-\ and CTRL-@ as the starting keys for these maps, as it's
" unlikely that you need their default mappings (CTRL-\'s default use is
" as part of CTRL-\ CTRL-N typemap, which basically just does the same
" thing as hitting 'escape': CTRL-@ doesn't seem to have any default use).
" If you don't like using 'CTRL-@' or CTRL-\, , you can change some or all
" of these maps to use other keys. One likely candidate is 'CTRL-_'
" (which also maps to CTRL-/, which is easier to type). By default it is
" used to switch between Hebrew and English keyboard mode.
"
" All of the maps involving the <cfile> macro use '^<cfile>$': this is so
" that searches over '#include <time.h>" return only references to
" 'time.h', and not 'sys/time.h', etc. (by default cscope will return all
" files that contain 'time.h' as part of their name).
" To do the first type of search, hit 'CTRL-\', followed by one of the
" cscope search types above (s,g,c,t,e,f,i,d). The result of your cscope
" search will be displayed in the current window. You can use CTRL-T to
" go back to where you were before the search.
"
nmap <C-\>s :cs find s <C-R>=expand("<cword>")<CR><CR>
nmap <C-\>g :cs find g <C-R>=expand("<cword>")<CR><CR>
nmap <C-\>c :cs find c <C-R>=expand("<cword>")<CR><CR>
nmap <C-\>t :cs find t <C-R>=expand("<cword>")<CR><CR>
nmap <C-\>e :cs find e <C-R>=expand("<cword>")<CR><CR>
nmap <C-\>f :cs find f <C-R>=expand("<cfile>")<CR><CR>
nmap <C-\>i :cs find i ^<C-R>=expand("<cfile>")<CR>$<CR>
nmap <C-\>d :cs find d <C-R>=expand("<cword>")<CR><CR>
nmap <C-\>a :cs find a <C-R>=expand("<cword>")<CR><CR>
nmap <C-\>S :cs find t struct <C-R>=expand("<cword>")<CR> {<CR>
" Using 'CTRL-spacebar' (interpreted as CTRL-@ by vim) then a search type
" makes the vim window split vertically, with search result displayed in
" the new window.
"
" (Note: you may wish to put a 'set splitright' in your .vimrc
" if you prefer the new window on the right instead of the left
nmap <C-@>s :vert scs find s <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>g :vert scs find g <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>c :vert scs find c <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>t :vert scs find t <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>e :vert scs find e <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>f :vert scs find f <C-R>=expand("<cfile>")<CR><CR>
nmap <C-@>i :vert scs find i ^<C-R>=expand("<cfile>")<CR>$<CR>
nmap <C-@>d :vert scs find d <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>a :vert scs find a <C-R>=expand("<cword>")<CR><CR>
nmap <C-@>S :vert scs find t struct <C-R>=expand("<cword>")<CR> {<CR>
" Hitting CTRL-space *twice* before the search type does a horizontal
" split instead of a vertical one (vim 6 and up only)
nmap <C-@><C-@>s :scs find s <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>g :scs find g <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>c :scs find c <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>t :scs find t <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>e :scs find e <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>f :scs find f <C-R>=expand("<cfile>")<CR><CR>
nmap <C-@><C-@>i :scs find i ^<C-R>=expand("<cfile>")<CR>$<CR>
nmap <C-@><C-@>d :scs find d <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>a :scs find a <C-R>=expand("<cword>")<CR><CR>
nmap <C-@><C-@>S :scs find t struct <C-R>=expand("<cword>")<CR> {<CR>
""""""""""""" key map timeouts
"
" By default Vim will only wait 1 second for each keystroke in a mapping.
" You may find that too short with the above typemaps. If so, you should
" either turn off mapping timeouts via 'notimeout'.
"
"set notimeout
"
" Or, you can keep timeouts, by uncommenting the timeoutlen line below,
" with your own personal favorite value (in milliseconds):
"
"set timeoutlen=4000
"
" Either way, since mapping timeout settings by default also set the
" timeouts for multicharacter 'keys codes' (like <F1>), you should also
" set ttimeout and ttimeoutlen: otherwise, you will experience strange
" delays as vim waits for a keystroke after you hit ESC (it will be
" waiting to see if the ESC is actually part of a key code like <F1>).
"
"set ttimeout
"
" personally, I find a tenth of a second to work well for key code
" timeouts. If you experience problems and have a slow terminal or network
" connection, set it higher. If you don't set ttimeoutlen, the value for
" timeoutlent (default: 1000 = 1 second, which is sluggish) is used.
"
"set ttimeoutlen=100
endif
07070100000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000B00000000TRAILER!!!21 blocks
