" File: UltiSnips.vim " Author: Holger Rapp " Description: The Ultimate Snippets solution for Vim " Last Modified: July 21, 2009 " " Testing Info: {{{ " See directions at the top of the test.py script located one " directory above this file. " }}} if exists('did_UltiSnips_vim') || &cp || version < 700 finish endif if !has("python3") if !has("python") echo "UltiSnips requires py >= 2.5 or any py3" finish endif endif " Global Variables {{{ " The trigger used to expand a snippet. " NOTE: expansion and forward jumping can, but needn't be the same trigger if !exists("g:UltiSnipsExpandTrigger") let g:UltiSnipsExpandTrigger = "" endif " The trigger used to display all triggers that could possible " match in the current position. if !exists("g:UltiSnipsListSnippets") let g:UltiSnipsListSnippets = "" endif " The trigger used to jump forward to the next placeholder. " NOTE: expansion and forward jumping can, but needn't be the same trigger if !exists("g:UltiSnipsJumpForwardTrigger") let g:UltiSnipsJumpForwardTrigger = "" endif " The trigger to jump backward inside a snippet if !exists("g:UltiSnipsJumpBackwardTrigger") let g:UltiSnipsJumpBackwardTrigger = "" endif " Should UltiSnips unmap select mode mappings automagically? if !exists("g:UltiSnipsRemoveSelectModeMappings") let g:UltiSnipsRemoveSelectModeMappings = 1 end " If UltiSnips should remove Mappings, which should be ignored if !exists("g:UltiSnipsMappingsToIgnore") let g:UltiSnipsMappingsToIgnore = [] endif " UltiSnipsEdit will use this variable to decide if a new window " is opened when editing. default is "normal", allowed are also " "vertical", "horizontal" if !exists("g:UltiSnipsEditSplit") let g:UltiSnipsEditSplit = 'normal' endif " A list of directory names that are searched for snippets. if !exists("g:UltiSnipsSnippetDirectories") let g:UltiSnipsSnippetDirectories = [ "UltiSnips" ] endif " }}} "" Global Commands {{{ function! UltiSnipsEdit(...) if a:0 == 1 && a:1 != '' let type = a:1 else if has("python3") python3 vim.command("let type = '%s'" % UltiSnips_Manager.filetype) else python vim.command("let type = '%s'" % UltiSnips_Manager.filetype) endif endif if has("python3") python3 vim.command("let file = '%s'" % UltiSnips_Manager.file_to_edit(vim.eval("type"))) else python vim.command("let file = '%s'" % UltiSnips_Manager.file_to_edit(vim.eval("type"))) endif let mode = 'e' if exists('g:UltiSnipsEditSplit') if g:UltiSnipsEditSplit == 'vertical' let mode = 'vs' elseif g:UltiSnipsEditSplit == 'horizontal' let mode = 'sp' endif endif exe ':'.mode.' '.file endfunction " edit snippets, default of current file type or the specified type command! -nargs=? UltiSnipsEdit :call UltiSnipsEdit() "" }}} "" FUNCTIONS {{{ function! CompensateForPUM() """ The CursorMovedI event is not triggered while the popup-menu is visible, """ and it's by this event that UltiSnips updates its vim-state. The fix is """ to explicitly check for the presence of the popup menu, and update """ the vim-state accordingly. if pumvisible() if has("python3") python3 UltiSnips_Manager.cursor_moved() else python UltiSnips_Manager.cursor_moved() endif endif endfunction function! UltiSnips_ExpandSnippet() if has("python3") python3 UltiSnips_Manager.expand() else python UltiSnips_Manager.expand() endif return "" endfunction function! UltiSnips_ExpandSnippetOrJump() call CompensateForPUM() if has("python3") python3 UltiSnips_Manager.expand_or_jump() else python UltiSnips_Manager.expand_or_jump() endif return "" endfunction function! UltiSnips_ListSnippets() if has("python3") python3 UltiSnips_Manager.list_snippets() else python UltiSnips_Manager.list_snippets() endif return "" endfunction function! UltiSnips_SaveLastVisualSelection() if has("python3") python3 UltiSnips_Manager.save_last_visual_selection() else python UltiSnips_Manager.save_last_visual_selection() endif return "" endfunction function! UltiSnips_JumpBackwards() call CompensateForPUM() if has("python3") python3 UltiSnips_Manager.jump_backwards() else python UltiSnips_Manager.jump_backwards() endif return "" endfunction function! UltiSnips_JumpForwards() call CompensateForPUM() if has("python3") python3 UltiSnips_Manager.jump_forwards() else python UltiSnips_Manager.jump_forwards() endif return "" endfunction function! UltiSnips_AddSnippet(trigger, value, descr, options, ...) " Takes the same arguments as SnippetManager.add_snippet: " (trigger, value, descr, options, ft = "all", globals = None) if has("python3") python3 << EOB args = vim.eval("a:000") trigger = vim.eval("a:trigger") value = vim.eval("a:value") descr = vim.eval("a:descr") options = vim.eval("a:options") UltiSnips_Manager.add_snippet(trigger, value, descr, options, *args) EOB else python << EOB args = vim.eval("a:000") trigger = vim.eval("a:trigger") value = vim.eval("a:value") descr = vim.eval("a:descr") options = vim.eval("a:options") UltiSnips_Manager.add_snippet(trigger, value, descr, options, *args) EOB endif return "" endfunction function! UltiSnips_Anon(value, ...) " Takes the same arguments as SnippetManager.expand_anon: " (value, trigger="", descr="", options="", globals = None) if has("python3") python3 << EOB args = vim.eval("a:000") value = vim.eval("a:value") UltiSnips_Manager.expand_anon(value, *args) EOB else python << EOB args = vim.eval("a:000") value = vim.eval("a:value") UltiSnips_Manager.expand_anon(value, *args) EOB endif return "" endfunction function! UltiSnips_MapKeys() " Map the keys correctly if g:UltiSnipsExpandTrigger == g:UltiSnipsJumpForwardTrigger exec "inoremap " . g:UltiSnipsExpandTrigger . " =UltiSnips_ExpandSnippetOrJump()" exec "snoremap " . g:UltiSnipsExpandTrigger . " :call UltiSnips_ExpandSnippetOrJump()" else exec "inoremap " . g:UltiSnipsExpandTrigger . " =UltiSnips_ExpandSnippet()" exec "snoremap " . g:UltiSnipsExpandTrigger . " :call UltiSnips_ExpandSnippet()" exec "inoremap " . g:UltiSnipsJumpForwardTrigger . " =UltiSnips_JumpForwards()" exec "snoremap " . g:UltiSnipsJumpForwardTrigger . " :call UltiSnips_JumpForwards()" endif exec 'xnoremap ' . g:UltiSnipsExpandTrigger. ' :call UltiSnips_SaveLastVisualSelection()gvs' exec "inoremap " . g:UltiSnipsJumpBackwardTrigger . " =UltiSnips_JumpBackwards()" exec "snoremap " . g:UltiSnipsJumpBackwardTrigger . " :call UltiSnips_JumpBackwards()" exec "inoremap " . g:UltiSnipsListSnippets . " =UltiSnips_ListSnippets()" exec "snoremap " . g:UltiSnipsListSnippets . " :call UltiSnips_ListSnippets()" " Do not remap this. if has("python3") snoremap :python3 UltiSnips_Manager.backspace_while_selected() else snoremap :python UltiSnips_Manager.backspace_while_selected() endif endf function! UltiSnips_CursorMoved() if has("python3") python3 UltiSnips_Manager.cursor_moved() else python UltiSnips_Manager.cursor_moved() endif endf function! UltiSnips_EnteredInsertMode() if has("python3") python3 UltiSnips_Manager.entered_insert_mode() else python UltiSnips_Manager.entered_insert_mode() endif endf function! UltiSnips_LeavingWindow() if has("python3") python3 UltiSnips_Manager.leaving_window() else python UltiSnips_Manager.leaving_window() endif endf " }}} "" STARTUP CODE {{{ " Expand our path if has("python3") python3 << EOF import vim, os, sys new_path = vim.eval('expand(":h")') sys.path.append(new_path) from UltiSnips import UltiSnips_Manager UltiSnips_Manager.expand_trigger = vim.eval("g:UltiSnipsExpandTrigger") UltiSnips_Manager.forward_trigger = vim.eval("g:UltiSnipsJumpForwardTrigger") UltiSnips_Manager.backward_trigger = vim.eval("g:UltiSnipsJumpBackwardTrigger") EOF else python << EOF import vim, os, sys new_path = vim.eval('expand(":h")') sys.path.append(new_path) from UltiSnips import UltiSnips_Manager UltiSnips_Manager.expand_trigger = vim.eval("g:UltiSnipsExpandTrigger") UltiSnips_Manager.forward_trigger = vim.eval("g:UltiSnipsJumpForwardTrigger") UltiSnips_Manager.backward_trigger = vim.eval("g:UltiSnipsJumpBackwardTrigger") EOF endif au CursorMovedI * call UltiSnips_CursorMoved() au InsertEnter * call UltiSnips_EnteredInsertMode() au WinLeave * call UltiSnips_LeavingWindow() call UltiSnips_MapKeys() let did_UltiSnips_vim=1 " }}} " vim: ts=8 sts=4 sw=4