" Vimball Archiver by Charles E. Campbell, Jr., Ph.D. UseVimball finish doc/supertab.txt [[[1 351 *supertab.txt* Authors: Original: Gergely Kontra Current: Eric Van Dewoestine (as of version 0.4) Contributors: Christophe-Marie Duquesne (documentation) Please direct all correspondence to Eric. This plugin is licensed under the terms of the BSD License. Please see supertab.vim for the license in its entirety. ============================================================================== Supertab *supertab* 1. Introduction |supertab-intro| 2. Supertab Usage |supertab-usage| 3. Supertab Options |supertab-options| Default completion type |supertab-defaultcompletion| Secondary default completion type |supertab-contextdefault| Completion contexts |supertab-completioncontexts| Context text |supertab-contexttext| Context Discover |supertab-contextdiscover| Example |supertab-contextexample| Completion Duration |supertab-duration| Midword completion |supertab-midword| Changing default mapping |supertab-forwardbackward| Inserting true tabs |supertab-mappingtabliteral| Enhanced longest match support |supertab-longestenhanced| Preselecting the first entry |supertab-longesthighlight| ============================================================================== 1. Introduction *supertab-intro* Supertab is a plugin which allows you to perform all your insert completion (|ins-completion|) using the tab key. Supertab requires Vim version 7.0 or above. ============================================================================== 2. Supertab usage *supertab-usage* Using Supertab is as easy as hitting or (shift+tab) while in insert mode, with at least one non whitespace character before the cursor, to start the completion and then or again to cycle forwards or backwards through the available completions. Example ('|' denotes the cursor location): bar baz b| Hitting here will start the completion, allowing you to then cycle through the suggested words ('bar' and 'baz'). ============================================================================== 3. Supertab Options *supertab-options* Supertab is configured via several global variables that you can set in your |vimrc| file according to your needs. Below is a comprehensive list of the variables available. g:SuperTabDefaultCompletionType |supertab-defaultcompletion| The default completion type to use. If you program in languages that support omni or user completions, it is highly recommended setting this to 'context'. For help about built in completion types in vim, see |i_CTRL-X_index|. g:SuperTabContextDefaultCompletionType |supertab-contextdefault| The default completion type to use when 'context' is the global default, but context completion has determined that neither omni, user, or file completion should be used in the current context. g:SuperTabCompletionContexts |supertab-completioncontexts| Used to configure a list of function names which are used when the global default type is 'context'. These functions will be consulted in order to determine which completion type to use. Advanced users can plug in their own functions here to customize their 'context' completion. g:SuperTabRetainCompletionDuration |supertab-duration| This setting determines how long a non-default completion type should be retained as the temporary default. By default supertab will retain the alternate completion type until you leave insert mode. g:SuperTabMidWordCompletion |supertab-midword| This can be used to turn off completion if you are in the middle of a word (word characters immediately preceding and following the cursor). g:SuperTabMappingForward |supertab-forwardbackward| g:SuperTabMappingBackward |supertab-forwardbackward| If using the tab key for completion isn't for you, then you can use these to set an alternate key to be used for your insert completion needs. g:SuperTabMappingTabLiteral |supertab-mappingtabliteral| For those rare cases where supertab would normal want to start insert completion, but you just want to insert a tab, this setting is used to define the key combination to use to do just that. By default Ctrl-Tab is used. g:SuperTabLongestEnhanced |supertab-longestenhanced| When enabled and 'longest' is in your |completeopt| setting, supertab will provide an enhanced longest match support where typing one or more letters and hitting tab again while in a completion mode will complete the longest common match using the new text in the buffer. g:SuperTabLongestHighlight |supertab-longesthighlight| When enabled and you have the completion popup enable and 'longest' in your completeopt, supertab will auto highlight the first selection in the popup. g:SuperTabCrMapping |supertab-crmapping| When enabled, will end completion mode preserving the current text. Default Completion Type *supertab-defaultcompletion* *g:SuperTabDefaultCompletionType* g:SuperTabDefaultCompletionType (default value: "") 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. Example: setting the default completion to 'user' completion: let g:SuperTabDefaultCompletionType = "" Note: a special value of 'context' is supported which will result in super tab attempting to use the text preceding the cursor to decide which type of completion to attempt. Currently super tab can recognize method calls or attribute references via '.', '::' or '->', and file path references containing '/'. let g:SuperTabDefaultCompletionType = "context" /usr/l # will use filename completion myvar.t # will use user completion if completefunc set, # or omni completion if omnifunc set. myvar-> # same as above When using context completion, super tab will fall back to a secondary default completion type set by |g:SuperTabContextDefaultCompletionType|. Note: once the buffer has been initialized, changing the value of this setting will not change the default complete type used. If you want to change the default completion type for the current buffer after it has been set, perhaps in an ftplugin, you'll need to call SuperTabSetDefaultCompletionType like so, supplying the completion type you wish to switch to: call SuperTabSetDefaultCompletionType("") Secondary default completion type *supertab-contextdefault* *g:SuperTabContextDefaultCompletionType* g:SuperTabContextDefaultCompletionType (default value: "") Sets the default completion type used when g:SuperTabDefaultCompletionType is set to 'context' and no completion type is returned by any of the configured contexts. Completion contexts *supertab-completioncontexts* *g:SuperTabCompletionContexts* g:SuperTabCompletionContexts (default value: ['s:ContextText']) Sets the list of contexts used for context completion. This value should be a list of function names which provide the context implementation. When supertab starts the default completion, each of these contexts will be consulted, in the order they were supplied, to determine the completion type to use. If a context returns a completion type, that type will be used, otherwise the next context in the list will be consulted. If after executing all the context functions, no completion type has been determined, then the value of g:SuperTabContextDefaultCompletionType will be used. Built in completion contexts: s:ContextText *supertab-contexttext* The text context will examine the text near the cursor to decide which type of completion to attempt. Currently the text context can recognize method calls or attribute references via '.', '::' or '->', and file path references containing '/'. /usr/l # will use filename completion myvar.t # will use user completion if completefunc set, or # omni completion if omnifunc set. myvar-> # same as above Supported configuration attributes: g:SuperTabContextTextFileTypeExclusions List of file types for which the text context will be skipped. g:SuperTabContextTextOmniPrecedence List of omni completion option names in the order of precedence that they should be used if available. By default, user completion will be given precedence over omni completion, but you can use this variable to give omni completion higher precedence by placing it first in the list. s:ContextDiscover *supertab-contextdiscover* This context will use the 'g:SuperTabContextDiscoverDiscovery' variable to determine the completion type to use. It will evaluate each value, in the order they were defined, until a variable evaluates to a non-zero or non-empty value, then the associated completion type is used. Supported configuration properties: g:SuperTabContextDiscoverDiscovery List of variable:completionType mappings. Example context configuration: *supertab-contextexample* let g:SuperTabCompletionContexts = ['s:ContextText', 's:ContextDiscover'] let g:SuperTabContextTextOmniPrecedence = ['&omnifunc', '&completefunc'] let g:SuperTabContextDiscoverDiscovery = \ ["&completefunc:", "&omnifunc:"] In addition to the default completion contexts, you can plug in your own implementation by creating a globally accessible function that returns the completion type to use (eg. "\\"). function MyTagContext() if filereadable(expand('%:p:h') . '/tags') return "\\" endif " no return will result in the evaluation of the next " configured context endfunction let g:SuperTabCompletionContexts = \ ['MyTagContext', 's:ContextText', 's:ContextDiscover'] Note: supertab also supports the b:SuperTabCompletionContexts variable allowing you to set the list of contexts separately for the current buffer, like from an ftplugin for example. Completion Duration *supertab-duration* *g:SuperTabRetainCompletionDuration* g:SuperTabRetainCompletionDuration (default value: 'insert') Determines if, and for how long, the current completion type is retained. The possible values include: 'completion' - 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. 'insert' - The current completion type is saved until you exit insert mode (via ESC). Once you exit insert mode the default completion type is restored. (supertab default) 'session' - The current completion type is saved for the duration of your vim session or until you enter a different completion mode. Midword completion *supertab-midword* *g:SuperTabMidWordCompletion* g:SuperTabMidWordCompletion (default value: 1) Sets whether or not mid word completion is enabled. When enabled, will kick off completion when ever a non whitespace character is to the left of the cursor. When disabled, completion will only occur if the char to the left is non whitespace char and the char to the right is not a keyword character (you are at the end of the word). Changing the default mapping *supertab-forwardbackward* *g:SuperTabMappingForward* *g:SuperTabMappingBackward* g:SuperTabMappingForward (default value: '') g:SuperTabMappingBackward (default value: '') These two variables allow you to set the keys used to kick off the current completion. By default this is and . To change to something like and , you can add the following to your |vimrc|. let g:SuperTabMappingForward = '' let g:SuperTabMappingBackward = '' 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 = '' let g:SuperTabMappingBackward = '' Inserting true tabs *supertab-mappingtabliteral* *g:SuperTabMappingTabLiteral* g:SuperTabMappingTabLiteral (default value: '') Sets the key mapping used to insert a literal tab where supertab would otherwise attempt to kick off insert completion. The default is '' (ctrl-tab) which unfortunately might not work at the console. So if you are using a console vim and want this functionality, you may have to change it to something that is supported. Alternatively, you can escape the with (see |i_CTRL-V| for more infos). Enhanced longest match support *supertab-longestenhanced* *g:SuperTabLongestEnhanced* g:SuperTabLongestEnhanced (default value: 0) When enabled and 'longest' is in your |completeopt| setting, supertab will provide an enhanced longest match support where typing one or more letters and hitting tab again while in a completion mode will complete the longest common match using the new text in the buffer. For example, say you have a buffer with the following contents: FooBarFoo FooBar Foo FooBarBaz And you then type F. Vim's builtin longest support will complete the longest common text 'Foo' and offer 'FooBarFoo', 'FooBar', 'Foo', and 'FooBarBaz' as possible completions. With supertab's longest match enhancement disabled, typing B while still in the completion mode will end up completing 'FooBarBaz' or 'FooBarFoo' depending your settings, instead of the next longest common match of 'FooBar'. With supertab's enhanced longest match feature enabled, the typing of B will result in the next longest text being completed. Preselecting the first entry *supertab-longesthighlight* *g:SuperTabLongestHighlight* g:SuperTabLongestHighlight (default value: 0) Sets whether or not to pre-highlight the first match when completeopt has the popup menu enabled and the 'longest' option as well. When enabled, will kick off completion and pre-select the first entry in the popup menu, allowing you to simply hit to use it. Mapping to end completion *supertab-crmapping* *g:SuperTabCrMapping* g:SuperTabCrMapping (default value: 1) When enabled, will cancel completion mode preserving the current text. vim:tw=78:ts=8:ft=help:norl: plugin/supertab.vim [[[1 613 " Author: " Original: Gergely Kontra " Current: Eric Van Dewoestine (as of version 0.4) " Please direct all correspondence to Eric. " Version: 1.1 " GetLatestVimScripts: 1643 1 :AutoInstall: supertab.vim " " Description: {{{ " Use your tab key to do all your completion in insert mode! " You can cycle forward and backward with the and keys " Note: you must press once to be able to cycle back " " http://www.vim.org/scripts/script.php?script_id=1643 " }}} " " License: {{{ " Copyright (c) 2002 - 2010 " 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. " }}} " " Testing Info: {{{ " Running vim + supertab with the absolute bar minimum settings: " $ vim -u NONE -U NONE -c "set nocp | runtime plugin/supertab.vim" " }}} if v:version < 700 finish endif if exists('complType') " Integration with other completion functions. finish endif let s:save_cpo=&cpo set cpo&vim " Global Variables {{{ if !exists("g:SuperTabDefaultCompletionType") let g:SuperTabDefaultCompletionType = "" endif if !exists("g:SuperTabContextDefaultCompletionType") let g:SuperTabContextDefaultCompletionType = "" endif if !exists("g:SuperTabCompletionContexts") let g:SuperTabCompletionContexts = ['s:ContextText'] endif if !exists("g:SuperTabRetainCompletionDuration") let g:SuperTabRetainCompletionDuration = 'insert' endif if !exists("g:SuperTabMidWordCompletion") let g:SuperTabMidWordCompletion = 1 endif if !exists("g:SuperTabMappingForward") let g:SuperTabMappingForward = '' endif if !exists("g:SuperTabMappingBackward") let g:SuperTabMappingBackward = '' endif if !exists("g:SuperTabMappingTabLiteral") let g:SuperTabMappingTabLiteral = '' endif if !exists("g:SuperTabLongestEnhanced") let g:SuperTabLongestEnhanced = 0 endif if !exists("g:SuperTabLongestHighlight") let g:SuperTabLongestHighlight = 0 endif if !exists("g:SuperTabCrMapping") let g:SuperTabCrMapping = 1 endif " }}} " Script Variables {{{ " construct the help text. let s:tabHelp = \ "Hit or CTRL-] on the completion type you wish to switch to.\n" . \ "Use :help ins-completion for more information.\n" . \ "\n" . \ "|| - Keywords in 'complete' searching down.\n" . \ "|| - Keywords in 'complete' searching up (SuperTab default).\n" . \ "|| - Whole lines.\n" . \ "|| - Keywords in current file.\n" . \ "|| - Keywords in 'dictionary'.\n" . \ "|| - Keywords in 'thesaurus', thesaurus-style.\n" . \ "|| - Keywords in the current and included files.\n" . \ "|| - Tags.\n" . \ "|| - File names.\n" . \ "|| - Definitions or macros.\n" . \ "|| - Vim command-line.\n" . \ "|| - User defined completion.\n" . \ "|| - Omni completion.\n" . \ "|s| - Spelling suggestions." " set the available completion types and modes. let s:types = \ "\\\\\\\\" . \ "\\\\\\\\\s" let s:modes = '/^E/^Y/^L/^N/^K/^T/^I/^]/^F/^D/^V/^P/^U/^O/s' let s:types = s:types . "np" let s:modes = s:modes . '/n/p' " }}} " SuperTabSetDefaultCompletionType(type) {{{ " Globally available function that users can use to set the default " completion type for the current buffer, like in an ftplugin. function! SuperTabSetDefaultCompletionType(type) " init hack for workaround. let b:complCommandLine = 0 let b:SuperTabDefaultCompletionType = a:type " set the current completion type to the default call SuperTabSetCompletionType(b:SuperTabDefaultCompletionType) endfunction " }}} " SuperTabSetCompletionType(type) {{{ " Globally available function that users 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. Note, this function only changes the current " completion type, not the default, meaning that the default will still be " restored once the configured retension duration has been met (see " g:SuperTabRetainCompletionDuration). To change the default for the current " buffer, use SuperTabDefaultCompletionType(type) instead. Example mapping to " restore SuperTab default: " nmap :call SetSuperTabCompletionType("") function! SuperTabSetCompletionType(type) exec "let b:complType = \"" . escape(a:type, '<') . "\"" endfunction " }}} " SuperTabAlternateCompletion(type) {{{ " Function which can be mapped to a key to kick off an alternate completion " other than the default. For instance, if you have 'context' as the default " and want to map ctrl+space to issue keyword completion. " Note: due to the way vim expands ctrl characters in mappings, you cannot " create the alternate mapping like so: " imap =SuperTabAlternateCompletion("") " instead, you have to use \ to prevent vim from expanding the key " when creating the mapping. " gvim: " imap =SuperTabAlternateCompletion("\c-p>") " console: " imap =SuperTabAlternateCompletion("\c-p>") function! SuperTabAlternateCompletion(type) call SuperTabSetCompletionType(a:type) " end any current completion before attempting to start the new one. " use feedkeys to prevent possible remapping of from causing issues. "call feedkeys("\", 'n') " ^ since we can't detect completion mode vs regular insert mode, we force " vim into keyword completion mode and end that mode to prevent the regular " insert behavior of from occurring. call feedkeys("\\\", 'n') call feedkeys(b:complType) return '' endfunction " }}} " s:Init {{{ " Global initilization when supertab is loaded. function! s:Init() augroup supertab_init autocmd! autocmd BufEnter * call InitBuffer() augroup END " ensure InitBuffer gets called for the first buffer, after the ftplugins " have been called. augroup supertab_init_first autocmd! autocmd FileType call InitBuffer() augroup END " Setup mechanism to restore orignial completion type upon leaving insert " mode if configured to do so if g:SuperTabRetainCompletionDuration == 'insert' augroup supertab_retain autocmd! autocmd InsertLeave * call s:SetDefaultCompletionType() augroup END endif endfunction " }}} " s:InitBuffer {{{ " Per buffer initilization. function! s:InitBuffer() if exists('b:complType') return endif let b:complReset = 0 let b:complTypeContext = '' let b:capturing = 0 " init hack for workaround. let b:complCommandLine = 0 let b:SuperTabDefaultCompletionType = g:SuperTabDefaultCompletionType " set the current completion type to the default call SuperTabSetCompletionType(b:SuperTabDefaultCompletionType) endfunction " }}} " s:ManualCompletionEnter() {{{ " Handles manual entrance into completion mode. function! s:ManualCompletionEnter() if &smd echo '' | echohl ModeMsg | echo '-- ^X++ mode (' . s:modes . ')' | echohl None endif let complType = nr2char(getchar()) if stridx(s:types, complType) != -1 if stridx("\\", complType) != -1 " no memory, just scroll... return "\" . complType elseif stridx('np', complType) != -1 let complType = nr2char(char2nr(complType) - 96) else let complType = "\" . complType endif if index(['insert', 'session'], g:SuperTabRetainCompletionDuration) != -1 let b:complType = complType endif " Hack to workaround bug when invoking command line completion via = if complType == "\\" return s:CommandLineCompletion() endif " optionally enable enhanced longest completion if g:SuperTabLongestEnhanced && &completeopt =~ 'longest' call s:EnableLongestEnhancement() endif return complType endif echohl "Unknown mode" return complType 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') && \ (!exists('b:complCommandLine') || !b:complCommandLine) call SuperTabSetCompletionType(b:SuperTabDefaultCompletionType) endif endfunction " }}} " s:SuperTab(command) {{{ " Used to perform proper cycle navigation 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 based on the cursor position. function! s:SuperTab(command) if s:WillComplete() " rare case where no autocmds have fired for this buffer to initialize the " supertab vars. call s:InitBuffer() " optionally enable enhanced longest completion if g:SuperTabLongestEnhanced && &completeopt =~ 'longest' call s:EnableLongestEnhancement() endif " highlight first result if longest enabled if g:SuperTabLongestHighlight && !pumvisible() && &completeopt =~ 'longest' let key = (b:complType == "\") ? b:complType : "\" call feedkeys(key) endif " exception: if in mode, then should move up the list, and " down the list. if a:command == 'p' && !b:complReset && \ (b:complType == "\" || \ (b:complType == 'context' && \ tolower(g:SuperTabContextDefaultCompletionType) == '')) return "\" elseif a:command == 'p' && !b:complReset && \ (b:complType == "\" || \ (b:complType == 'context' && \ tolower(g:SuperTabContextDefaultCompletionType) == '')) return "\" " this used to handle call from captured keys with the longest enhancement " enabled, but also must work when the enhancement is disabled. elseif a:command == 'n' && pumvisible() && !b:complReset if b:complType == 'context' exec "let contextDefault = \"" . \ escape(g:SuperTabContextDefaultCompletionType, '<') . "\"" " if we are in another completion mode, just scroll to the next " completion if b:complTypeContext != contextDefault return "\" endif return contextDefault endif return b:complType == "\" ? b:complType : "\" endif " handle 'context' completion. if b:complType == 'context' let complType = s:ContextCompletion() if complType == '' exec "let complType = \"" . \ escape(g:SuperTabContextDefaultCompletionType, '<') . "\"" endif let b:complTypeContext = complType " Hack to workaround bug when invoking command line completion via = elseif b:complType == "\\" let complType = s:CommandLineCompletion() else let complType = b:complType endif if b:complReset let b:complReset = 0 " not an accurate condition for everyone, but better than sending " at the wrong time. if pumvisible() return "\" . complType endif endif return complType endif return "\" 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 :call SetCompletionType() nmap :call SetCompletionType() 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. if line =~ '^\s*\%' . cnum . 'c' 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 && next_char =~ '\k' return 0 endif " In keyword completion mode and no preceding word characters. "if (b:complType == "\" || b:complType == "\") && prev_char !~ '\k' " return 0 "endif return 1 endfunction " }}} " s:EnableLongestEnhancement() {{{ function! s:EnableLongestEnhancement() augroup supertab_reset autocmd! autocmd InsertLeave,CursorMovedI \ call s:ReleaseKeyPresses() | autocmd! supertab_reset call s:CaptureKeyPresses() augroup END endfunction " }}} " s:CompletionReset() {{{ function! s:CompletionReset(char) let b:complReset = 1 return a:char endfunction " }}} " s:CaptureKeyPresses() {{{ function! s:CaptureKeyPresses() if !b:capturing let b:capturing = 1 " TODO: use &keyword to get an accurate list of chars to map for c in split('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_', '.\zs') exec 'imap ' . c . ' =CompletionReset("' . c . '")' endfor imap =CompletionReset("\c-h>") imap =CompletionReset("\c-h>") exec 'imap ' . g:SuperTabMappingForward . ' =SuperTab("n")' endif endfunction " }}} " s:ReleaseKeyPresses() {{{ function! s:ReleaseKeyPresses() if b:capturing let b:capturing = 0 for c in split('abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890_', '.\zs') exec 'iunmap ' . c endfor iunmap iunmap exec 'iunmap ' . g:SuperTabMappingForward if mode() == 'i' " force full exit from completion mode (don't exit insert mode since " that will break repeating with '.') call feedkeys("\\", 'n') endif endif endfunction " }}} " s:CommandLineCompletion() {{{ " Hack needed to account for apparent bug in vim command line mode completion " when invoked via = function! s:CommandLineCompletion() " This hack will trigger InsertLeave which will then invoke " s:SetDefaultCompletionType. To prevent default completion from being " restored prematurely, set an internal flag for s:SetDefaultCompletionType " to check for. let b:complCommandLine = 1 return "\\:call feedkeys('\\\', 'n') | " . \ "let b:complCommandLine = 0\" endfunction " }}} " s:ContextCompletion() {{{ function! s:ContextCompletion() let contexts = exists('b:SuperTabCompletionContexts') ? \ b:SuperTabCompletionContexts : g:SuperTabCompletionContexts for context in contexts try let Context = function(context) let complType = Context() unlet Context if type(complType) == 1 && complType != '' return complType endif catch /E700/ echohl Error echom 'supertab: no context function "' . context . '" found.' echohl None endtry endfor return '' endfunction " }}} " s:ContextDiscover() {{{ function! s:ContextDiscover() let discovery = exists('g:SuperTabContextDiscoverDiscovery') ? \ g:SuperTabContextDiscoverDiscovery : [] " loop through discovery list to find the default if !empty(discovery) for pair in discovery let var = substitute(pair, '\(.*\):.*', '\1', '') let type = substitute(pair, '.*:\(.*\)', '\1', '') exec 'let value = ' . var if value !~ '^\s*$' && value != '0' exec "let complType = \"" . escape(type, '<') . "\"" return complType endif endfor endif endfunction " }}} " s:ContextText() {{{ function! s:ContextText() let exclusions = exists('g:SuperTabContextTextFileTypeExclusions') ? \ g:SuperTabContextTextFileTypeExclusions : [] if index(exclusions, &ft) == -1 let curline = getline('.') let cnum = col('.') let synname = synIDattr(synID(line('.'), cnum - 1, 1), 'name') if curline =~ '.*/\w*\%' . cnum . 'c' || \ ((has('win32') || has('win64')) && curline =~ '.*\\\w*\%' . cnum . 'c') return "\\" elseif curline =~ '.*\(\w\|[\])]\)\(\.\|::\|->\)\w*\%' . cnum . 'c' && \ synname !~ '\(String\|Comment\)' let omniPrecedence = exists('g:SuperTabContextTextOmniPrecedence') ? \ g:SuperTabContextTextOmniPrecedence : ['&completefunc', '&omnifunc'] for omniFunc in omniPrecedence if omniFunc !~ '^&' let omniFunc = '&' . omniFunc endif if getbufvar(bufnr('%'), omniFunc) != '' return omniFunc == '&omnifunc' ? "\\" : "\\" endif endfor endif endif endfunction " }}} " Key Mappings {{{ " map a regular tab to ctrl-tab (note: doesn't work in console vim) exec 'inoremap ' . g:SuperTabMappingTabLiteral . ' ' imap =ManualCompletionEnter() " From the doc |insert.txt| improved exec 'imap ' . g:SuperTabMappingForward . ' ' exec 'imap ' . g:SuperTabMappingBackward . ' ' " After hitting , hitting it once more will go to next match " (because in XIM mode and mappings are ignored) " and wont start a brand new completion " The side effect, that in the beginning of line and inserts a " , but I hope it may not be a problem... inoremap =SuperTab('n') inoremap =SuperTab('p') if g:SuperTabCrMapping " using a mapping instead of , seems to prevent evaluating " other functions mapped to etc. (like endwise.vim) inoremap =SelectCompletion() function s:SelectCompletion() return pumvisible() ? "\\" : "\" endfunction endif " }}} " Command Mappings {{{ if !exists(":SuperTabHelp") command SuperTabHelp :call SuperTabHelp() endif " }}} call s:Init() let &cpo = s:save_cpo " vim:ft=vim:fdm=marker