Call out opening bracket behavior in FAQ

Apparently mentioning in the both the README intro and the help file
isn't enough.  I give up.

Resolves: https://github.com/tpope/vim-surround/issues/366
Resolves: https://github.com/tpope/vim-surround/issues/363
Resolves: https://github.com/tpope/vim-surround/issues/314
Resolves: https://github.com/tpope/vim-surround/issues/303
Resolves: https://github.com/tpope/vim-surround/issues/240
Resolves: https://github.com/tpope/vim-surround/issues/205
Resolves: https://github.com/tpope/vim-surround/issues/108
Resolves: https://github.com/tpope/vim-surround/issues/27

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: tpope
+custom: ["https://www.paypal.me/vimpope"]

README.markdown

@@ -1,5 +1,4 @@
-surround.vim
+# surround.vim
-============
 
 Surround.vim is all about "surroundings": parentheses, brackets, quotes,
 XML tags, and more.  The plugin provides mappings to easily delete,
@@ -61,37 +60,39 @@ and removing pairs of tags simultaneously is a breeze.
 The `.` command will work with `ds`, `cs`, and `yss` if you install
 [repeat.vim](https://github.com/tpope/vim-repeat).
 
-Installation
+## Installation
-------------
 
-If you don't have a preferred installation method, I recommend
+Install using your favorite package manager, or use Vim's built-in package
-installing [pathogen.vim](https://github.com/tpope/vim-pathogen), and
+support:
-then simply copy and paste:
 
-    cd ~/.vim/bundle
+    mkdir -p ~/.vim/pack/tpope/start
-    git clone git://github.com/tpope/vim-surround.git
+    cd ~/.vim/pack/tpope/start
+    git clone https://tpope.io/vim/surround.git
+    vim -u NONE -c "helptags surround/doc" -c q
 
-Once help tags have been generated, you can view the manual with
+## FAQ
-`:help surround`.
 
-Contributing
+> How do I surround without adding a space?
-------------
+
+Only the opening brackets—`[`, `{`, and `(`—add a space.  Use a closing
+bracket, or the `b` (`(`) and `B` (`{`) aliases.
+
+## Contributing
 
 See the contribution guidelines for
 [pathogen.vim](https://github.com/tpope/vim-pathogen#readme).
 
-Self-Promotion
+## Self-Promotion
---------------
 
-Like surround.vim? Follow the repository on
+Like surround.vim?  Star the repository on
 [GitHub](https://github.com/tpope/vim-surround) and vote for it on
-[vim.org](http://www.vim.org/scripts/script.php?script_id=1697).  And if
+[vim.org](https://www.vim.org/scripts/script.php?script_id=1697).
-you're feeling especially charitable, follow [tpope](http://tpo.pe/) on
-[Twitter](http://twitter.com/tpope) and
-[GitHub](https://github.com/tpope).
 
-License
+Love surround.vim?  Follow [tpope](http://tpo.pe/) on
--------
+[GitHub](https://github.com/tpope) and
+[Twitter](http://twitter.com/tpope).
+
+## License
 
 Copyright (c) Tim Pope.  Distributed under the same terms as Vim itself.
 See `:help license`.

doc/surround.txt

@@ -39,8 +39,9 @@ easiest to understand with some examples:
   <div>Yo!*</div>           dst         Yo!
 
 Change surroundings is *cs* .  It takes two arguments, a target like with
-|ds|, and a replacement.  Details about the second argument can be found
+|ds|, and a replacement.  *cS* changes surroundings, placing the surrounded
-below in |surround-replacements|.  Once again, examples are in order.
+text on its own line(s) like |yS|.  Details about the second argument can be
+found below in |surround-replacements|.  Once again, examples are in order.
 
   Old text                  Command     New text ~
   "Hello *world!"           cs"'        'Hello world!'
@@ -129,9 +130,20 @@ code blocks in C-style languages, <C-}> (which is really <C-]>) adds braces on
 lines separate from the content.
 
 If t or < is used, Vim prompts for an HTML/XML tag to insert.  You may specify
-attributes here and they will be stripped from the closing tag.  End your
+attributes here and they will be stripped from the closing tag. If replacing a
-input by pressing <CR> or >.  If <C-T> is used, the tags will appear on lines
+tag, its attributes are kept in the new tag. End your input with > to discard
-by themselves.
+the those attributes. If <C-T> is used, the tags will appear on lines by
+themselves.
+
+If f, F, or <C-F> is used, Vim prompts for a function name to insert.  The target
+text will be wrapped in a function call. If f is used, the text is wrapped with
+() parentheses; F adds additional spaces inside the parentheses. <C-F> inserts the
+function name inside the parentheses.
+
+  Old text                  Command           New text ~
+  "hello"                   ysWfprint<cr>     print("hello")
+  "hello"                   ysWFprint<cr>     print( "hello" )
+  "hello"                   ysW<C-f>print<cr> (print "hello")
 
 If s is used, a leading but not trailing space is added.  This is useful for
 removing parentheses from a function call with csbs.
@@ -190,16 +202,4 @@ that allow you to jump to such markings.
 >
   let g:surround_insert_tail = "<++>"
 <
-ISSUES                                          *surround-issues*
-
-Vim could potentially get confused when deleting/changing occurs at the very
-end of the line.  Please report any repeatable instances of this.
-
-Do we need to use |inputsave()|/|inputrestore()| with the tag replacement?
-
-Indenting is handled haphazardly.  Need to decide the most appropriate
-behavior and implement it.  Right now one can do :let b:surround_indent = 1
-(or the global equivalent) to enable automatic re-indenting by Vim via |=|;
-should this be the default?
-
  vim:tw=78:ts=8:ft=help:norl:

plugin/surround.vim

@@ -1,6 +1,6 @@
 " surround.vim - Surroundings
 " Author:       Tim Pope <http://tpo.pe/>
-" Version:      2.0
+" Version:      2.2
 " GetLatestVimScripts: 1697 1 :AutoInstall: surround.vim
 
 if exists("g:loaded_surround") || &cp || v:version < 700
@@ -92,7 +92,7 @@ function! s:process(string)
     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*$','','').': ')
+      let repl_{i} = input(match(m,'\w\+$') >= 0 ? m.': ' : m)
     endif
   endfor
   let s = ""
@@ -124,13 +124,12 @@ function! s:process(string)
   return s
 endfunction
 
-function! s:wrap(string,char,type,...)
+function! s:wrap(string,char,type,removed,special)
   let keeper = a:string
   let newchar = a:char
-  let s:tag = ""
+  let s:input = ""
   let type = a:type
   let linemode = type ==# 'V' ? 1 : 0
-  let special = a:0 ? a:1 : 0
   let before = ""
   let after  = ""
   if type ==# "V"
@@ -165,13 +164,13 @@ function! s:wrap(string,char,type,...)
   elseif newchar ==# ':'
     let before = ':'
     let after = ''
-  elseif newchar =~# "[tT\<C-T><,]"
+  elseif newchar =~# "[tT\<C-T><]"
     let dounmapp = 0
     let dounmapb = 0
     if !maparg(">","c")
       let dounmapb = 1
       " Hide from AsNeeded
-      exe "cn"."oremap > <CR>"
+      exe "cn"."oremap > ><CR>"
     endif
     let default = ""
     if newchar ==# "T"
@@ -181,21 +180,27 @@ function! s:wrap(string,char,type,...)
       let default = matchstr(s:lastdel,'<\zs.\{-\}\ze>')
     endif
     let tag = input("<",default)
-    echo "<".substitute(tag,'>*$','>','')
     if dounmapb
       silent! cunmap >
     endif
-    let s:tag = tag
+    let s:input = tag
     if tag != ""
+      let keepAttributes = ( match(tag, ">$") == -1 )
       let tag = substitute(tag,'>*$','','')
-      let s:tag = tag . '>'
+      let attributes = ""
-      let before = '<'.tag.'>'
+      if keepAttributes
+        let attributes = matchstr(a:removed, '<[^ \t\n]\+\zs\_.\{-\}\ze>')
+      endif
+      let s:input = tag . '>'
       if tag =~ '/$'
+        let tag = substitute(tag, '/$', '', '')
+        let before = '<'.tag.attributes.' />'
         let after = ''
       else
+        let before = '<'.tag.attributes.'>'
         let after  = '</'.substitute(tag,' .*','','').'>'
       endif
-      if newchar == "\<C-T>" || newchar == ","
+      if newchar == "\<C-T>"
         if type ==# "v" || type ==# "V"
           let before .= "\n\t"
         endif
@@ -207,16 +212,18 @@ function! s:wrap(string,char,type,...)
   elseif newchar ==# 'l' || newchar == '\'
     " LaTeX
     let env = input('\begin{')
+    if env != ""
+      let s:input = env."\<CR>"
       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 s:input = fnc."\<CR>"
       let before = substitute(fnc,'($','','').'('
       let after  = ')'
       if newchar ==# 'F'
@@ -226,6 +233,7 @@ function! s:wrap(string,char,type,...)
     endif
   elseif newchar ==# "\<C-F>"
     let fnc = input('function: ')
+    let s:input = fnc."\<CR>"
     let before = '('.fnc.' '
     let after = ')'
   elseif idx >= 0
@@ -244,7 +252,7 @@ function! s:wrap(string,char,type,...)
     let after  = ''
   endif
   let after  = substitute(after ,'\n','\n'.initspaces,'g')
-  if type ==# 'V' || (special && type ==# "v")
+  if type ==# 'V' || (a:special && type ==# "v")
     let before = substitute(before,' \+$','','')
     let after  = substitute(after ,'^ \+','','')
     if after !~ '^\n'
@@ -255,11 +263,16 @@ function! s:wrap(string,char,type,...)
     elseif keeper =~ '\n$' && after =~ '^\n'
       let after = strpart(after,1)
     endif
-    if before !~ '\n\s*$'
+    if keeper !~ '^\n' && before !~ '\n\s*$'
       let before .= "\n"
-      if special
+      if a:special
         let before .= "\t"
       endif
+    elseif keeper =~ '^\n' && before =~ '\n\s*$'
+      let keeper = strcharpart(keeper,1)
+    endif
+    if type ==# 'V' && keeper =~ '\n\s*\n$'
+      let keeper = strcharpart(keeper,0,strchars(keeper) - 1)
     endif
   endif
   if type ==# 'V'
@@ -287,11 +300,10 @@ function! s:wrap(string,char,type,...)
   return keeper
 endfunction
 
-function! s:wrapreg(reg,char,...)
+function! s:wrapreg(reg,char,removed,special)
   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,a:removed,a:special)
-  let new = s:wrap(orig,a:char,type,special)
   call setreg(a:reg,new,type)
 endfunction
 " }}}1
@@ -311,8 +323,8 @@ function! s:insert(...) " {{{1
   let cb_save = &clipboard
   set clipboard-=unnamed clipboard-=unnamedplus
   let reg_save = @@
-  call setreg('"',"\r",'v')
+  call setreg('"',"\032",'v')
-  call s:wrapreg('"',char,linemode)
+  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
@@ -324,7 +336,16 @@ function! s:insert(...) " {{{1
   if exists("g:surround_insert_tail")
     call setreg('"',g:surround_insert_tail,"a".getregtype('"'))
   endif
-  if col('.') >= col('$')
+  if &ve != 'all' && col('.') >= col('$')
+    if &ve == 'insert'
+      let extra_cols = virtcol('.') - virtcol('$')
+      if extra_cols > 0
+        let [regval,regtype] = [getreg('"',1,1),getregtype('"')]
+        call setreg('"',join(map(range(extra_cols),'" "'),''),'v')
+        norm! ""p
+        call setreg('"',regval,regtype)
+      endif
+    endif
     norm! ""p
   else
     norm! ""P
@@ -333,19 +354,21 @@ function! s:insert(...) " {{{1
     call s:reindent()
   endif
   norm! `]
-  call search('\r','bW')
+  call search("\032",'bW')
   let @@ = reg_save
   let &clipboard = cb_save
   return "\<Del>"
 endfunction " }}}1
 
-function! s:reindent() " {{{1
+function! s:reindent() abort " {{{1
-  if exists("b:surround_indent") ? b:surround_indent : (exists("g:surround_indent") && g:surround_indent)
+  if get(b:, 'surround_indent', get(g:, 'surround_indent', 1)) && (!empty(&equalprg) || !empty(&indentexpr) || &cindent || &smartindent || &lisp)
     silent norm! '[=']
   endif
 endfunction " }}}1
 
 function! s:dosurround(...) " {{{1
+  let sol_save = &startofline
+  set startofline
   let scount = v:count1
   let char = (a:0 ? a:1 : s:inputtarget())
   let spc = ""
@@ -367,6 +390,9 @@ function! s:dosurround(...) " {{{1
   if a:0 > 1
     let newchar = a:2
     if newchar == "\<Esc>" || newchar == "\<C-C>" || newchar == ""
+      if !sol_save
+        set nostartofline
+      endif
       return s:beep()
     endif
   endif
@@ -379,6 +405,12 @@ function! s:dosurround(...) " {{{1
   let strcount = (scount == 1 ? "" : scount)
   if char == '/'
     exe 'norm! '.strcount.'[/d'.strcount.']/'
+  elseif char =~# '[[:punct:][:space:]]' && char !~# '[][(){}<>"''`]'
+    exe 'norm! T'.char
+    if getline('.')[col('.')-1] == char
+      exe 'norm! l'
+    endif
+    exe 'norm! dt'.char
   else
     exe 'norm! d'.strcount.'i'.char
   endif
@@ -387,6 +419,9 @@ function! s:dosurround(...) " {{{1
   if keeper == ""
     call setreg('"',original,otype)
     let &clipboard = cb_save
+    if !sol_save
+      set nostartofline
+    endif
     return ""
   endif
   let oldline = getline('.')
@@ -403,9 +438,12 @@ function! s:dosurround(...) " {{{1
     norm! "_x
     call setreg('"','/**/',"c")
     let keeper = substitute(substitute(keeper,'^/\*\s\=','',''),'\s\=\*$','','')
+  elseif char =~# '[[:punct:][:space:]]' && char !~# '[][(){}<>]'
+    exe 'norm! F'.char
+    exe 'norm! df'.char
   else
     " One character backwards
-    call search('.','bW')
+    call search('\m.', 'bW')
     exe "norm! da".char
   endif
   let removed = getreg('"')
@@ -417,7 +455,7 @@ function! s:dosurround(...) " {{{1
     let keeper = substitute(keeper,'^\s\+','','')
     let keeper = substitute(keeper,'\s\+$','','')
   endif
-  if col("']") == col("$") && col('.') + 1 == col('$')
+  if col("']") == col("$") && virtcol('.') + 1 == virtcol('$')
     if oldhead =~# '^\s*$' && a:0 < 2
       let keeper = substitute(keeper,'\%^\n'.oldhead.'\(\s*.\{-\}\)\n\s*\%$','\1','')
     endif
@@ -430,7 +468,8 @@ function! s:dosurround(...) " {{{1
   endif
   call setreg('"',keeper,regtype)
   if newchar != ""
-    call s:wrapreg('"',newchar)
+    let special = a:0 > 2 ? a:3 : 0
+    call s:wrapreg('"',newchar,removed,special)
   endif
   silent exe 'norm! ""'.pcmd.'`['
   if removed =~ '\n' || okeeper =~ '\n' || getreg('"') =~ '\n'
@@ -445,11 +484,14 @@ function! s:dosurround(...) " {{{1
   if newchar == ""
     silent! call repeat#set("\<Plug>Dsurround".char,scount)
   else
-    silent! call repeat#set("\<Plug>Csurround".char.newchar.s:tag,scount)
+    silent! call repeat#set("\<Plug>C".(a:0 > 2 && a:3 ? "S" : "s")."urround".char.newchar.s:input,scount)
+  endif
+  if !sol_save
+    set nostartofline
   endif
 endfunction " }}}1
 
-function! s:changesurround() " {{{1
+function! s:changesurround(...) " {{{1
   let a = s:inputtarget()
   if a == ""
     return s:beep()
@@ -458,10 +500,14 @@ function! s:changesurround() " {{{1
   if b == ""
     return s:beep()
   endif
-  call s:dosurround(a,b)
+  call s:dosurround(a,b,a:0 && a:1)
 endfunction " }}}1
 
-function! s:opfunc(type,...) " {{{1
+function! s:opfunc(type, ...) abort " {{{1
+  if a:type ==# 'setup'
+    let &opfunc = matchstr(expand('<sfile>'), '<SNR>\w\+$')
+    return 'g@'
+  endif
   let char = s:inputreplacement()
   if char == ""
     return s:beep()
@@ -506,7 +552,7 @@ function! s:opfunc(type,...) " {{{1
     let keeper = substitute(keeper,'\_s\@<!\s*$','','')
   endif
   call setreg(reg,keeper,type)
-  call s:wrapreg(reg,char,a:0 && a:1)
+  call s:wrapreg(reg,char,"",a:0 && a:1)
   if type ==# "v" && a:type !=# "v" && append != ""
     call setreg(reg,append,"ac")
   endif
@@ -518,14 +564,18 @@ function! s:opfunc(type,...) " {{{1
   let &selection = sel_save
   let &clipboard = cb_save
   if a:type =~ '^\d\+$'
-    silent! call repeat#set("\<Plug>Y".(a:0 && a:1 ? "S" : "s")."surround".char.s:tag,a:type)
+    silent! call repeat#set("\<Plug>Y".(a:0 && a:1 ? "S" : "s")."surround".char.s:input,a:type)
   else
-    silent! call repeat#set("\<Plug>SurroundRepeat".char.s:tag)
+    silent! call repeat#set("\<Plug>SurroundRepeat".char.s:input)
   endif
 endfunction
 
-function! s:opfunc2(arg)
+function! s:opfunc2(...) abort
-  call s:opfunc(a:arg,1)
+  if !a:0 || a:1 ==# 'setup'
+    let &opfunc = matchstr(expand('<sfile>'), '<SNR>\w\+$')
+    return 'g@'
+  endif
+  call s:opfunc(a:1, 1)
 endfunction " }}}1
 
 function! s:closematch(str) " {{{1
@@ -547,11 +597,11 @@ endfunction " }}}1
 nnoremap <silent> <Plug>SurroundRepeat .
 nnoremap <silent> <Plug>Dsurround  :<C-U>call <SID>dosurround(<SID>inputtarget())<CR>
 nnoremap <silent> <Plug>Csurround  :<C-U>call <SID>changesurround()<CR>
-nnoremap <silent> <Plug>Yssurround :<C-U>call <SID>opfunc(v:count1)<CR>
+nnoremap <silent> <Plug>CSurround  :<C-U>call <SID>changesurround(1)<CR>
-nnoremap <silent> <Plug>YSsurround :<C-U>call <SID>opfunc2(v:count1)<CR>
+nnoremap <expr>   <Plug>Yssurround '^'.v:count1.<SID>opfunc('setup').'g_'
-" <C-U> discards the numerical argument but there's not much we can do with it
+nnoremap <expr>   <Plug>YSsurround <SID>opfunc2('setup').'_'
-nnoremap <silent> <Plug>Ysurround  :<C-U>set opfunc=<SID>opfunc<CR>g@
+nnoremap <expr>   <Plug>Ysurround  <SID>opfunc('setup')
-nnoremap <silent> <Plug>YSurround  :<C-U>set opfunc=<SID>opfunc2<CR>g@
+nnoremap <expr>   <Plug>YSurround  <SID>opfunc2('setup')
 vnoremap <silent> <Plug>VSurround  :<C-U>call <SID>opfunc(visualmode(),visualmode() ==# 'V' ? 1 : 0)<CR>
 vnoremap <silent> <Plug>VgSurround :<C-U>call <SID>opfunc(visualmode(),visualmode() ==# 'V' ? 0 : 1)<CR>
 inoremap <silent> <Plug>Isurround  <C-R>=<SID>insert()<CR>
@@ -560,6 +610,7 @@ inoremap <silent> <Plug>ISurround  <C-R>=<SID>insert(1)<CR>
 if !exists("g:surround_no_mappings") || ! g:surround_no_mappings
   nmap ds  <Plug>Dsurround
   nmap cs  <Plug>Csurround
+  nmap cS  <Plug>CSurround
   nmap ys  <Plug>Ysurround
   nmap yS  <Plug>YSurround
   nmap yss <Plug>Yssurround
@@ -567,11 +618,13 @@ if !exists("g:surround_no_mappings") || ! g:surround_no_mappings
   nmap ySS <Plug>YSsurround
   xmap S   <Plug>VSurround
   xmap gS  <Plug>VgSurround
+  if !exists("g:surround_no_insert_mappings") || ! g:surround_no_insert_mappings
     if !hasmapto("<Plug>Isurround","i") && "" == mapcheck("<C-S>","i")
       imap    <C-S> <Plug>Isurround
     endif
     imap      <C-G>s <Plug>Isurround
     imap      <C-G>S <Plug>ISurround
+  endif
 endif
 
 " vim:set ft=vim sw=2 sts=2 et: