1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
|
" Author:
" Original: Gergely Kontra <kgergely@mcl.hu>
" Current: Eric Van Dewoestine <ervandew@yahoo.com> (as of version 0.4)
" Please direct all correspondence to Eric.
" Version: 0.45
"
" Description: {{{
" Use your tab key to do all your completion in insert mode!
" You can cycle forward and backward with the <Tab> and <S-Tab> keys
" (<S-Tab> will not work in the console version)
" Note: you must press <Tab> once to be able to cycle back
"
" http://www.vim.org/scripts/script.php?script_id=1643
" }}}
"
" License: {{{
" Software License Agreement (BSD License)
"
" Copyright (c) 2002 - 2007
" All rights reserved.
"
" Redistribution and use of this software in source and binary forms, with
" or without modification, are permitted provided that the following
" conditions are met:
"
" * Redistributions of source code must retain the above
" copyright notice, this list of conditions and the
" following disclaimer.
"
" * Redistributions in binary form must reproduce the above
" copyright notice, this list of conditions and the
" following disclaimer in the documentation and/or other
" materials provided with the distribution.
"
" * Neither the name of Gergely Kontra or Eric Van Dewoestine nor the names
" of its contributors may be used to endorse or promote products derived
" from this software without specific prior written permission of Gergely
" Kontra or Eric Van Dewoestine.
"
" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
" IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
" THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
" PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
" LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
" NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
" SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
" }}}
if exists('complType') "Integration with other completion functions.
finish
endif
" Global Variables {{{
" Used to set the default completion type.
" There is no need to escape this value as that will be done for you when
" the type is set.
" Ex. let g:SuperTabDefaultCompletionType = "<C-X><C-U>"
if !exists("g:SuperTabDefaultCompletionType")
let g:SuperTabDefaultCompletionType = "<C-P>"
endif
" Used to set a list of variable, completion type pairs used to determine
" the default completion type to use for the current buffer. If the
" variable is non-zero and non-empty then the associated completion type
" will be used.
" Ex. To use omni or user completion when available, but fall back to the
" global default otherwise.
" let g:SuperTabDefaultCompletionTypeDiscovery = "&omnifunc:<C-X><C-O>,&completefunc:<C-X><C-U>"
if !exists("g:SuperTabDefaultCompletionTypeDiscovery")
let g:SuperTabDefaultCompletionTypeDiscovery = ""
endif
" Determines if, and for how long, the current completion type is retained.
" The possible values include:
" 0 - The current completion type is only retained for the current completion.
" Once you have chosen a completion result or exited the completion
" mode, the default completion type is restored.
" 1 - The current completion type is saved for the duration of your vim
" session or until you enter a different completion mode.
" (SuperTab default).
" 2 - The current completion type is saved until you exit insert mode (via
" ESC). Once you exit insert mode the default completion type is
" restored.
if !exists("g:SuperTabRetainCompletionType")
let g:SuperTabRetainCompletionType = 1
endif
" Sets whether or not mid word completion is enabled.
" When enabled, <tab> will kick off completion when ever a word character is
" to the left of the cursor. When disabled, completion will only occur if
" the char to the left is a word char and the char to the right is not (you
" are at the end of the word).
if !exists("g:SuperTabMidWordCompletion")
let g:SuperTabMidWordCompletion = 1
endif
" The following two variables allow you to set the key mapping used to kick
" off the current completion. By default this is <tab> and <s-tab>. To
" change to something like <c-space> and <s-c-space>, you can add the
" following to your vimrc.
"
" let g:SuperTabMappingForward = '<c-space>'
" let g:SuperTabMappingBackward = '<s-c-space>'
"
" Note: if the above does not have the desired effect (which may happen in
" console version of vim), you can try the following mappings. Although the
" backwards mapping still doesn't seem to work in the console for me, your
" milage may vary.
"
" let g:SuperTabMappingForward = '<nul>'
" let g:SuperTabMappingBackward = '<s-nul>'
"
if !exists("g:SuperTabMappingForward")
let g:SuperTabMappingForward = '<tab>'
endif
if !exists("g:SuperTabMappingBackward")
let g:SuperTabMappingBackward = '<s-tab>'
endif
" Sets whether or not to pre-highlight first match when completeopt has
" the popup menu enabled and the 'longest' option as well.
" When enabled, <tab> will kick off completion and pre-select the first
" entry in the popup menu, allowing you to simply hit <enter> to use it.
if !exists("g:SuperTabLongestHighlight")
let g:SuperTabLongestHighlight = 0
endif
" }}}
" Script Variables {{{
" construct the help text.
let s:tabHelp =
\ "Hit <CR> or CTRL-] on the completion type you wish to switch to.\n" .
\ "Use :help ins-completion for more information.\n" .
\ "\n" .
\ "|<C-N>| - Keywords in 'complete' searching down.\n" .
\ "|<C-P>| - Keywords in 'complete' searching up (SuperTab default).\n" .
\ "|<C-X><C-L>| - Whole lines.\n" .
\ "|<C-X><C-N>| - Keywords in current file.\n" .
\ "|<C-X><C-K>| - Keywords in 'dictionary'.\n" .
\ "|<C-X><C-T>| - Keywords in 'thesaurus', thesaurus-style.\n" .
\ "|<C-X><C-I>| - Keywords in the current and included files.\n" .
\ "|<C-X><C-]>| - Tags.\n" .
\ "|<C-X><C-F>| - File names.\n" .
\ "|<C-X><C-D>| - Definitions or macros.\n" .
\ "|<C-X><C-V>| - Vim command-line."
if v:version >= 700
let s:tabHelp = s:tabHelp . "\n" .
\ "|<C-X><C-U>| - User defined completion.\n" .
\ "|<C-X><C-O>| - Omni completion.\n" .
\ "|<C-X>s| - Spelling suggestions."
endif
" set the available completion types and modes.
let s:types =
\ "\<C-E>\<C-Y>\<C-L>\<C-N>\<C-K>\<C-T>\<C-I>\<C-]>\<C-F>\<C-D>\<C-V>\<C-N>\<C-P>"
let s:modes = '/^E/^Y/^L/^N/^K/^T/^I/^]/^F/^D/^V/^P'
if v:version >= 700
let s:types = s:types . "\<C-U>\<C-O>\<C-N>\<C-P>s"
let s:modes = s:modes . '/^U/^O/s'
endif
let s:types = s:types . "np"
let s:modes = s:modes . '/n/p'
" }}}
" CtrlXPP() {{{
" Handles entrance into completion mode.
function! CtrlXPP()
if &smd
echo '' | echo '-- ^X++ mode (' . s:modes . ')'
endif
let complType = nr2char(getchar())
if stridx(s:types, complType) != -1
if stridx("\<C-E>\<C-Y>", complType) != -1 " no memory, just scroll...
return "\<C-x>" . complType
elseif stridx('np', complType) != -1
let complType = nr2char(char2nr(complType) - 96) " char2nr('n')-char2nr("\<C-n")
else
let complType="\<C-x>" . complType
endif
if g:SuperTabRetainCompletionType
let b:complType = complType
endif
return complType
else
echohl "Unknown mode"
return complType
endif
endfunction " }}}
" SuperTabSetCompletionType(type) {{{
" Globally available function that user's can use to create mappings to
" quickly switch completion modes. Useful when a user wants to restore the
" default or switch to another mode without having to kick off a completion
" of that type or use SuperTabHelp.
" Example mapping to restore SuperTab default:
" nmap <F6> :call SetSuperTabCompletionType("<C-P>")<cr>
function! SuperTabSetCompletionType (type)
exec "let b:complType = \"" . escape(a:type, '<') . "\""
endfunction " }}}
" s:Init {{{
" Global initilization when supertab is loaded.
function! s:Init ()
augroup supertab_init
autocmd!
autocmd BufEnter * call <SID>InitBuffer()
augroup END
" ensure InitBuffer gets called for the first buffer.
call s:InitBuffer()
" Setup mechanism to restore orignial completion type upon leaving insert
" mode if g:SuperTabRetainCompletionType == 2
if g:SuperTabRetainCompletionType == 2
" pre vim 7, must map <esc>
if v:version < 700
im <silent> <ESC> <ESC>:call s:SetDefaultCompletionType()<cr>
" since vim 7, we can use InsertLeave autocmd.
else
augroup supertab_retain
autocmd!
autocmd InsertLeave * call s:SetDefaultCompletionType()
augroup END
endif
endif
endfunction " }}}
" s:InitBuffer {{{
" Per buffer initilization.
function! s:InitBuffer ()
if exists("b:complType")
return
endif
if !exists("b:SuperTabDefaultCompletionType")
" loop through discovery list to find the default
if g:SuperTabDefaultCompletionTypeDiscovery != ''
let dlist = g:SuperTabDefaultCompletionTypeDiscovery
while dlist != ''
let pair = substitute(dlist, '\(.\{-}\)\(,.*\|$\)', '\1', '')
let dlist = substitute(dlist, '.\{-}\(,.*\|$\)', '\1', '')
let dlist = substitute(dlist, '^,', '\1', '')
let var = substitute(pair, '\(.*\):.*', '\1', '')
let type = substitute(pair, '.*:\(.*\)', '\1', '')
exec 'let value = ' . var
if value !~ '^\s*$' && value != '0'
let b:SuperTabDefaultCompletionType = type
break
endif
endwhile
endif
" fallback to configured default.
if !exists("b:SuperTabDefaultCompletionType")
let b:SuperTabDefaultCompletionType = g:SuperTabDefaultCompletionType
endif
endif
" set the default completion type.
call SuperTabSetCompletionType(b:SuperTabDefaultCompletionType)
endfunction " }}}
" s:IsWordChar(char) {{{
" Determines if the supplied character is a word character or matches value
" defined by 'iskeyword'.
function! s:IsWordChar (char)
if a:char =~ '\w'
return 1
endif
" check against 'iskeyword'
let values = &iskeyword
let index = stridx(values, ',')
while index > 0 || values != ''
if index > 0
let value = strpart(values, 0, index)
let values = strpart(values, index + 1)
else
let value = values
let values = ''
endif
" exception case for '^,'
if value == '^'
let value = '^,'
" execption case for ','
elseif value =~ '^,,'
let values .= strpart(value, 2)
let value = ','
" execption case after a ^,
elseif value =~ '^,'
let value = strpart(value, 1)
endif
" keyword values is an ascii number range
if value =~ '[0-9]\+-[0-9]\+'
let charnum = char2nr(a:char)
exec 'let start = ' . substitute(value, '\([0-9]\+\)-.*', '\1', '')
exec 'let end = ' . substitute(value, '.*-\([0-9]\+\)', '\1', '')
if charnum >= start && charnum <= end
return 1
endif
" keyword value is a set of include or exclude characters
else
let include = 1
if value =~ '^\^'
let value = strpart(value, 1)
let include = 0
endif
if a:char =~ '[' . escape(value, '[]') . ']'
return include
endif
endif
let index = stridx(values, ',')
endwhile
return 0
endfunction " }}}
" s:SetCompletionType() {{{
" Sets the completion type based on what the user has chosen from the help
" buffer.
function! s:SetCompletionType ()
let chosen = substitute(getline('.'), '.*|\(.*\)|.*', '\1', '')
if chosen != getline('.')
let winnr = b:winnr
close
exec winnr . 'winc w'
call SuperTabSetCompletionType(chosen)
endif
endfunction " }}}
" s:SetDefaultCompletionType () {{{
function! s:SetDefaultCompletionType ()
if exists('b:SuperTabDefaultCompletionType')
call SuperTabSetCompletionType(b:SuperTabDefaultCompletionType)
endif
endfunction " }}}
" s:SuperTab(command) {{{
" Used to perform proper cycle navigtion as the user requests the next or
" previous entry in a completion list, and determines whether or not to simply
" retain the normal usage of <tab> based on the cursor position.
function! s:SuperTab(command)
if s:WillComplete()
let key = ''
" highlight first result if longest enabled
if g:SuperTabLongestHighlight && !pumvisible() && &completeopt =~ 'longest'
let key = (b:complType == "\<C-P>") ? "\<C-P>" : "\<C-N>"
endif
" exception: if in <c-p> mode, then <c-n> should move up the list, and
" <c-p> down the list.
if a:command == 'p' && b:complType == "\<C-P>"
return "\<C-N>"
endif
return b:complType . key
endif
return "\<Tab>"
endfunction " }}}
" s:SuperTabHelp() {{{
" Opens a help window where the user can choose a completion type to enter.
function! s:SuperTabHelp()
let winnr = winnr()
if bufwinnr("SuperTabHelp") == -1
botright split SuperTabHelp
setlocal noswapfile
setlocal buftype=nowrite
setlocal bufhidden=delete
let saved = @"
let @" = s:tabHelp
silent put
call cursor(1, 1)
silent 1,delete
call cursor(4, 1)
let @" = saved
exec "resize " . line('$')
syntax match Special "|.\{-}|"
setlocal readonly
setlocal nomodifiable
nmap <silent> <buffer> <cr> :call <SID>SetCompletionType()<cr>
nmap <silent> <buffer> <c-]> :call <SID>SetCompletionType()<cr>
else
exec bufwinnr("SuperTabHelp") . "winc w"
endif
let b:winnr = winnr
endfunction " }}}
" s:WillComplete () {{{
" Determines if completion should be kicked off at the current location.
function! s:WillComplete ()
let line = getline('.')
let cnum = col('.')
" Start of line.
let prev_char = strpart(line, cnum - 2, 1)
if prev_char =~ '^\s*$'
return 0
endif
" Within a word, but user does not have mid word completion enabled.
let next_char = strpart(line, cnum - 1, 1)
if !g:SuperTabMidWordCompletion && s:IsWordChar(next_char)
return 0
endif
" In keyword completion mode and no preceding word characters.
"if (b:complType == "\<C-N>" || b:complType == "\<C-P>") && !s:IsWordChar(prev_char)
" return 0
"endif
return 1
endfunction " }}}
" Key Mappings {{{
im <C-X> <C-r>=CtrlXPP()<CR>
" From the doc |insert.txt| improved
exec 'im ' . g:SuperTabMappingForward . ' <C-n>'
exec 'im ' . g:SuperTabMappingBackward . ' <C-p>'
" After hitting <Tab>, hitting it once more will go to next match
" (because in XIM mode <C-n> and <C-p> mappings are ignored)
" and wont start a brand new completion
" The side effect, that in the beginning of line <C-n> and <C-p> inserts a
" <Tab>, but I hope it may not be a problem...
ino <C-n> <C-R>=<SID>SuperTab('n')<CR>
ino <C-p> <C-R>=<SID>SuperTab('p')<CR>
" }}}
" Command Mappings {{{
if !exists(":SuperTabHelp")
command SuperTabHelp :call <SID>SuperTabHelp()
endif
" }}}
call <SID>Init()
" vim:ft=vim:fdm=marker
|