" surround.vim - Surroundings " Author: Tim Pope " Version: 1.90 " GetLatestVimScripts: 1697 1 :AutoInstall: surround.vim if exists("g:loaded_surround") || &cp || v:version < 700 finish endif let g:loaded_surround = 1 " Input functions {{{1 function! s:getchar() let c = getchar() if c =~ '^\d\+$' let c = nr2char(c) endif return c endfunction function! s:inputtarget() let c = s:getchar() while c =~ '^\d\+$' let c .= s:getchar() endwhile if c == " " let c .= s:getchar() endif if c =~ "\\|\\|\0" return "" else return c endif endfunction function! s:inputreplacement() let c = s:getchar() if c == " " let c .= s:getchar() endif if c =~ "\" || c =~ "\" return "" else return c endif endfunction function! s:beep() exe "norm! \" return "" endfunction function! s:redraw() redraw return "" endfunction " }}}1 " Wrapping functions {{{1 function! s:extractbefore(str) if a:str =~ '\r' return matchstr(a:str,'.*\ze\r') else return matchstr(a:str,'.*\ze\n') endif endfunction function! s:extractafter(str) if a:str =~ '\r' return matchstr(a:str,'\r\zs.*') else return matchstr(a:str,'\n\zs.*') endif endfunction function! s:fixindent(str,spc) let str = substitute(a:str,'\t',repeat(' ',&sw),'g') let spc = substitute(a:spc,'\t',repeat(' ',&sw),'g') let str = substitute(str,'\(\n\|\%^\).\@=','\1'.spc,'g') if ! &et let str = substitute(str,'\s\{'.&ts.'\}',"\t",'g') endif return str endfunction function! s:process(string) let i = 0 for i in range(7) let repl_{i} = '' let m = matchstr(a:string,nr2char(i).'.\{-\}\ze'.nr2char(i)) if m != '' let m = substitute(strpart(m,1),'\r.*','','') let repl_{i} = input(substitute(m,':\s*$','','').': ') endif endfor let s = "" let i = 0 while i < strlen(a:string) let char = strpart(a:string,i,1) if char2nr(char) < 8 let next = stridx(a:string,char,i+1) if next == -1 let s .= char else let insertion = repl_{char2nr(char)} let subs = strpart(a:string,i+1,next-i-1) let subs = matchstr(subs,'\r.*') while subs =~ '^\r.*\r' let sub = matchstr(subs,"^\r\\zs[^\r]*\r[^\r]*") let subs = strpart(subs,strlen(sub)+1) let r = stridx(sub,"\r") let insertion = substitute(insertion,strpart(sub,0,r),strpart(sub,r+1),'') endwhile let s .= insertion let i = next endif else let s .= char endif let i += 1 endwhile return s endfunction function! s:wrap(string,char,type,...) let keeper = a:string let newchar = a:char let s:tag = "" let type = a:type let linemode = type ==# 'V' ? 1 : 0 let special = a:0 ? a:1 : 0 let before = "" let after = "" if type ==# "V" let initspaces = matchstr(keeper,'\%^\s*') else let initspaces = matchstr(getline('.'),'\%^\s*') endif let pairs = "b()B{}r[]a<>" let extraspace = "" if newchar =~ '^ ' let newchar = strpart(newchar,1) let extraspace = ' ' endif let idx = stridx(pairs,newchar) if newchar == ' ' let before = '' let after = '' elseif exists("b:surround_".char2nr(newchar)) let all = s:process(b:surround_{char2nr(newchar)}) let before = s:extractbefore(all) let after = s:extractafter(all) elseif exists("g:surround_".char2nr(newchar)) let all = s:process(g:surround_{char2nr(newchar)}) let before = s:extractbefore(all) let after = s:extractafter(all) elseif newchar ==# "p" let before = "\n" let after = "\n\n" elseif newchar =~# "[tT\<,]" let dounmapp = 0 let dounmapb = 0 if !maparg(">","c") let dounmapb = 1 " Hide from AsNeeded exe "cn"."oremap > " endif let default = "" if newchar ==# "T" if !exists("s:lastdel") let s:lastdel = "" endif let default = matchstr(s:lastdel,'<\zs.\{-\}\ze>') endif let tag = input("<",default) echo "<".substitute(tag,'>*$','>','') if dounmapb silent! cunmap > endif let s:tag = tag if tag != "" let tag = substitute(tag,'>*$','','') let s:tag = tag . '>' let before = '<'.tag.'>' if tag =~ '/$' let after = '' else let after = '' endif if newchar == "\" || newchar == "," if type ==# "v" || type ==# "V" let before .= "\n\t" endif if type ==# "v" let after = "\n". after endif endif endif elseif newchar ==# 'l' || newchar == '\' " LaTeX let env = input('\begin{') let env = '{' . env let env .= s:closematch(env) echo '\begin'.env if env != "" let before = '\begin'.env let after = '\end'.matchstr(env,'[^}]*').'}' endif elseif newchar ==# 'f' || newchar ==# 'F' let fnc = input('function: ') if fnc != "" let before = substitute(fnc,'($','','').'(' let after = ')' if newchar ==# 'F' let before .= ' ' let after = ' ' . after endif endif elseif idx >= 0 let spc = (idx % 3) == 1 ? " " : "" let idx = idx / 3 * 3 let before = strpart(pairs,idx+1,1) . spc let after = spc . strpart(pairs,idx+2,1) elseif newchar == "\" || newchar == "\" let before = "{\n\t" let after = "\n}" elseif newchar !~ '\a' let before = newchar let after = newchar else let before = '' let after = '' endif let after = substitute(after ,'\n','\n'.initspaces,'g') if type ==# 'V' || (special && type ==# "v") let before = substitute(before,' \+$','','') let after = substitute(after ,'^ \+','','') if after !~ '^\n' let after = initspaces.after endif if keeper !~ '\n$' && after !~ '^\n' let keeper .= "\n" elseif keeper =~ '\n$' && after =~ '^\n' let after = strpart(after,1) endif if before !~ '\n\s*$' let before .= "\n" if special let before .= "\t" endif endif endif if type ==# 'V' let before = initspaces.before endif if before =~ '\n\s*\%$' if type ==# 'v' let keeper = initspaces.keeper endif let padding = matchstr(before,'\n\zs\s\+\%$') let before = substitute(before,'\n\s\+\%$','\n','') let keeper = s:fixindent(keeper,padding) endif if type ==# 'V' let keeper = before.keeper.after elseif type =~ "^\" " Really we should be iterating over the buffer let repl = substitute(before,'[\\~]','\\&','g').'\1'.substitute(after,'[\\~]','\\&','g') let repl = substitute(repl,'\n',' ','g') let keeper = substitute(keeper."\n",'\(.\{-\}\)\(\n\)',repl.'\n','g') let keeper = substitute(keeper,'\n\%$','','') else let keeper = before.extraspace.keeper.extraspace.after endif return keeper endfunction function! s:wrapreg(reg,char,...) let orig = getreg(a:reg) let type = substitute(getregtype(a:reg),'\d\+$','','') let special = a:0 ? a:1 : 0 let new = s:wrap(orig,a:char,type,special) call setreg(a:reg,new,type) endfunction " }}}1 function! s:insert(...) " {{{1 " Optional argument causes the result to appear on 3 lines, not 1 let linemode = a:0 ? a:1 : 0 let char = s:inputreplacement() while char == "\" || char == "\" " TODO: use total count for additional blank lines let linemode += 1 let char = s:inputreplacement() endwhile if char == "" return "" endif let cb_save = &clipboard set clipboard-=unnamed clipboard-=unnamedplus let reg_save = @@ call setreg('"',"\r",'v') call s:wrapreg('"',char,linemode) " If line mode is used and the surrounding consists solely of a suffix, " remove the initial newline. This fits a use case of mine but is a " little inconsistent. Is there anyone that would prefer the simpler " behavior of just inserting the newline? if linemode && match(getreg('"'),'^\n\s*\zs.*') == 0 call setreg('"',matchstr(getreg('"'),'^\n\s*\zs.*'),getregtype('"')) endif " This can be used to append a placeholder to the end if exists("g:surround_insert_tail") call setreg('"',g:surround_insert_tail,"a".getregtype('"')) endif if col('.') >= col('$') norm! ""p else norm! ""P endif if linemode call s:reindent() endif norm! `] call search('\r','bW') let @@ = reg_save let &clipboard = cb_save return "\" endfunction " }}}1 function! s:reindent() " {{{1 if exists("b:surround_indent") ? b:surround_indent : (exists("g:surround_indent") && g:surround_indent) silent norm! '[='] endif endfunction " }}}1 function! s:dosurround(...) " {{{1 let scount = v:count1 let char = (a:0 ? a:1 : s:inputtarget()) let spc = "" if char =~ '^\d\+' let scount = scount * matchstr(char,'^\d\+') let char = substitute(char,'^\d\+','','') endif if char =~ '^ ' let char = strpart(char,1) let spc = 1 endif if char == 'a' let char = '>' endif if char == 'r' let char = ']' endif let newchar = "" if a:0 > 1 let newchar = a:2 if newchar == "\" || newchar == "\" || newchar == "" return s:beep() endif endif let cb_save = &clipboard set clipboard-=unnamed clipboard-=unnamedplus let append = "" let original = getreg('"') let otype = getregtype('"') call setreg('"',"") let strcount = (scount == 1 ? "" : scount) if char == '/' exe 'norm! '.strcount.'[/d'.strcount.']/' else exe 'norm! d'.strcount.'i'.char endif let keeper = getreg('"') let okeeper = keeper " for reindent below if keeper == "" call setreg('"',original,otype) let &clipboard = cb_save return "" endif let oldline = getline('.') let oldlnum = line('.') if char ==# "p" call setreg('"','','V') elseif char ==# "s" || char ==# "w" || char ==# "W" " Do nothing call setreg('"','') elseif char =~ "[\"'`]" exe "norm! i \d2i".char call setreg('"',substitute(getreg('"'),' ','','')) elseif char == '/' norm! "_x call setreg('"','/**/',"c") let keeper = substitute(substitute(keeper,'^/\*\s\=','',''),'\s\=\*$','','') else " One character backwards call search('.','bW') exe "norm! da".char endif let removed = getreg('"') let rem2 = substitute(removed,'\n.*','','') let oldhead = strpart(oldline,0,strlen(oldline)-strlen(rem2)) let oldtail = strpart(oldline, strlen(oldline)-strlen(rem2)) let regtype = getregtype('"') if char =~# '[\[({Dsurround".char,scount) else silent! call repeat#set("\Csurround".char.newchar.s:tag,scount) endif endfunction " }}}1 function! s:changesurround() " {{{1 let a = s:inputtarget() if a == "" return s:beep() endif let b = s:inputreplacement() if b == "" return s:beep() endif call s:dosurround(a,b) endfunction " }}}1 function! s:opfunc(type,...) " {{{1 let char = s:inputreplacement() if char == "" return s:beep() endif let reg = '"' let sel_save = &selection let &selection = "inclusive" let cb_save = &clipboard set clipboard-=unnamed clipboard-=unnamedplus let reg_save = getreg(reg) let reg_type = getregtype(reg) let type = a:type if a:type == "char" silent exe 'norm! v`[o`]"'.reg.'y' let type = 'v' elseif a:type == "line" silent exe 'norm! `[V`]"'.reg.'y' let type = 'V' elseif a:type ==# "v" || a:type ==# "V" || a:type ==# "\" let &selection = sel_save let ve = &virtualedit if !(a:0 && a:1) set virtualedit= endif silent exe 'norm! gv"'.reg.'y' let &virtualedit = ve elseif a:type =~ '^\d\+$' let type = 'v' silent exe 'norm! ^v'.a:type.'$h"'.reg.'y' if mode() ==# 'v' norm! v return s:beep() endif else let &selection = sel_save let &clipboard = cb_save return s:beep() endif let keeper = getreg(reg) if type ==# "v" && a:type !=# "v" let append = matchstr(keeper,'\_s\@Y".(a:0 && a:1 ? "S" : "s")."surround".char.s:tag,a:type) else silent! call repeat#set("\SurroundRepeat".char.s:tag) endif endfunction function! s:opfunc2(arg) call s:opfunc(a:arg,1) endfunction " }}}1 function! s:closematch(str) " {{{1 " Close an open (, {, [, or < on the command line. let tail = matchstr(a:str,'.[^\[\](){}<>]*$') if tail =~ '^\[.\+' return "]" elseif tail =~ '^(.\+' return ")" elseif tail =~ '^{.\+' return "}" elseif tail =~ '^<.+' return ">" else return "" endif endfunction " }}}1 nnoremap SurroundRepeat . nnoremap Dsurround :call dosurround(inputtarget()) nnoremap Csurround :call changesurround() nnoremap Yssurround :call opfunc(v:count1) nnoremap YSsurround :call opfunc2(v:count1) " discards the numerical argument but there's not much we can do with it nnoremap Ysurround :set opfunc=opfuncg@ nnoremap YSurround :set opfunc=opfunc2g@ vnoremap VSurround :call opfunc(visualmode(),visualmode() ==# 'V' ? 1 : 0) vnoremap VgSurround :call opfunc(visualmode(),visualmode() ==# 'V' ? 0 : 1) inoremap Isurround =insert() inoremap ISurround =insert(1) if !exists("g:surround_no_mappings") || ! g:surround_no_mappings nmap ds Dsurround nmap cs Csurround nmap ys Ysurround nmap yS YSurround nmap yss Yssurround nmap ySs YSsurround nmap ySS YSsurround xmap S VSurround xmap gS VgSurround if maparg('s', 'x') ==# '' xnoremap s :echoerr 'surround.vim: Visual mode s has been removed in favor of S' endif if !hasmapto("Isurround","i") && "" == mapcheck("","i") imap Isurround endif imap s Isurround imap S ISurround endif " vim:set ft=vim sw=2 sts=2 et: