" Vimball Archiver by Charles E. Campbell
UseVimball
finish
autoload/SwapText.vim	[[[1
216
" SwapText.vim: Mappings to exchange text with the previously deleted text.
"
" DEPENDENCIES:
"   - ingo/err.vim autoload script
"
" Copyright: (C) 2007-2016 Ingo Karkat
"   The VIM LICENSE applies to this script; see ':help copyright'.
"
" Maintainer:	Ingo Karkat <ingo@karkat.de>
"
" REVISION	DATE		REMARKS
"   1.02.021	18-Sep-2016	BUG: When deleting at the end of a line, and
"				swapping with a longer text before it, the swap
"				location is off by one. The EOL position isn't
"				properly detected, because the virtual line
"				length after the paste is used in the condition.
"				Save the deleted virtual line length in
"				deletedVirtLen, and pass that on to
"				s:WasDeletionAtEndOfLine(). Thanks to Marcelo
"				Montu for the bug report.
"   1.02.020	04-Feb-2015	"E790: undojoin is not allowed after undo" may
"				also be raised in SwapText#Operator(); ignore
"				it.
"   1.00.019	24-Jun-2014	Prepare for publishing.
"	018	05-May-2014	Abort on error.
"	017	21-Mar-2013	Avoid changing the jumplist.
"	016	19-Mar-2013	Handle deletion at the end of a line by checking
"				for the delete cursor position being at the end
"				of the line and (via the stored
"				s:deletedStartPos, as the '[ mark gets
"				clobbered) whether the deletion actually started
"				after it.
"   	015	28-Aug-2012	For the operators, handle readonly and
"				nomodifiable buffers by printing just the
"				warning / error, without the multi-line function
"				error. (Unlikely as it may be, as the user must
"				have done a delete first, anyway.)
"	014	17-Nov-2011	ENH: Handle :undojoin failure when user did undo
"				between delete and swap. To avoid a potential
"				swap with wrong register contents, error in this
"				case.
"				FIX: Require Vim 7, necessary for :undojoin.
"				Rename to SwapText.vim.
"				Split off autoload script and documentation.
"	013	30-Sep-2011	Use <silent> for <Plug> mapping instead of
"				default mapping.
"	012	22-Jun-2011	BUG: Must adapt the deleted line location if
"				it's below the overridden range; the override
"				may have changed the number of lines.
"	011	16-Jun-2011	Remove general "P" command from pasteCmd
"				argument and rename it selectReplacementCmd.
"				Remove outdated comment.
"	010	12-Feb-2010	After further problems with the used marks, set
"				jumps, etc., replaced all used marks with a
"				variable, and was even able to simplify the code
"				through it.
"				ENH: The swap is now atomic, i.e. it can be
"				undone in a single action.
"	009	12-Feb-2010	BUG: Used mark ' instead of mark ", thereby
"				horribly breaking everything. (It's astounding
"				how long it took me to notice!)
"	008	11-Sep-2009	BUG: Cannot set mark " in Vim 7.0 and 7.1; using
"				mark z instead; abstracted mark via s:tempMark.
"	007	04-Jul-2009	Also replacing temporary mark ` with mark " and
"				using g` command for the visual mode swap.
"	006	18-Jun-2009	Replaced temporary mark z with mark " and using
"				g` command to avoid clobbering jumplist.
"	005	21-Mar-2009	Added \xx mapping for linewise swap.
"				Added \X mapping for swap until the end of line.
"	004	07-Aug-2008	hasmapto() now checks for normal mode.
"	003	30-Jun-2008	Removed unnecessary <script> from mappings.
"	002	07-Jun-2007	Changed offset algorithm from calculating
"				differences to set marks to differences in
"				pasted text.
"				BF: Saving position of deleted text and adding
"				offset to that instead of jumping to mark and
"				adding offset then (which doesn't work when the
"				swap shortens the line and the mark now points
"				to after the end of the line.
"				Added Vim 7 custom operator.
"				Refactored code so that both the visual mode
"				mapping and the operator use the same functions.
"	001	06-Jun-2007	file creation

function! s:WasDeletionAtEndOfLine( deletedCol, deletedVirtCol, deletedVirtLen )
    let l:isAtEndOfDeletedLine = (a:deletedVirtCol + 1 == a:deletedVirtLen)
    if ! l:isAtEndOfDeletedLine
	return 0
    endif

    " Because the '[,'] marks are already set to the current swap area, we
    " cannot use them any more to determine whether the previous deletion
    " was before or after the cursor position. Therefore we save that
    " position at the start of the mapping.
    let l:wasDeletionAtEndOfLine = (s:deletedStartPos[1] == line('.') && s:deletedStartPos[2] > a:deletedCol)
"****D echomsg '****' string(getpos('.')) l:isAtEndOfDeletedLine string(s:deletedStartPos) l:wasDeletionAtEndOfLine
    return l:wasDeletionAtEndOfLine
endfunction
function! s:Replace( deletedCol, deletedVirtCol, deletedVirtLen )
    execute 'normal!' (s:WasDeletionAtEndOfLine(a:deletedCol, a:deletedVirtCol, a:deletedVirtLen) ? 'p' : 'P')
endfunction

function! s:SwapTextWithOffsetCorrection( selectReplacementCmd )
    " When you change a line by inserting/deleting characters, any marks to
    " the right of the change don't get adjusted to correct for the change,
    " but stay pointing at the exact same column as before the change (which
    " is not the right place anymore).
    let l:deletedCol = col("'.")
    let l:deletedVirtCol = virtcol("'.")
    let l:deletedVirtLen = virtcol('$')
    let l:deletedTextLen = len(@")
    execute 'normal! ' . a:selectReplacementCmd . 'P'
    let l:replacedTextLen = len(@")
    let l:offset = l:deletedTextLen - l:replacedTextLen
"****D echomsg '**** corrected for ' . l:offset. ' characters.'
    call cursor(line('.'), l:deletedCol + l:offset)
    call s:Replace(l:deletedCol, l:deletedVirtCol, l:deletedVirtLen)
endfunction

function! s:LineCnt( text )
    return strlen(substitute(a:text, '\n\@!.', '', 'g'))
endfunction
function! s:SwapText( selectReplacementCmd )
    if line('.') == line("'.") && col('.') < col("'.")
	call s:SwapTextWithOffsetCorrection(a:selectReplacementCmd)
    else
	let l:deletedCol = col("'.")
	let l:deletedVirtCol = virtcol("'.")
	let l:deletedVirtLen = virtcol('$')
	let l:deletedLine = line("'.")
	let l:deletedLineCnt = s:LineCnt(@")

	" Override with deleted contents.
	execute 'normal!' a:selectReplacementCmd . 'P'
"****D echomsg '****' l:deletedCol l:deletedLine l:deletedLineCnt
	" Must adapt the deleted line location if it's below the overridden
	" range; the override may have changed the number of lines.
	let l:overwrittenLineCnt = s:LineCnt(@")
	let l:offset = l:deletedLineCnt - l:overwrittenLineCnt
	if l:deletedLine > line('.')
	    let l:deletedLine += l:offset
	endif
"****D echomsg '****' l:overwrittenLineCnt l:offset
	" Put overridden contents at the formerly deleted location.
	call cursor(l:deletedLine, l:deletedCol)
	call s:Replace(l:deletedCol, l:deletedVirtCol, l:deletedVirtLen)
    endif
endfunction

function! SwapText#Visual()
    let s:deletedStartPos = getpos("'[")
    call s:SwapText('gv')
endfunction

function! SwapText#Operator( type )
    " The operator needs another undojoin for the operator action itself.
    " Ignore any E790 in here; I hope that's fine.
    call SwapText#UndoJoin()

    " The 'selection' option is temporarily set to "inclusive" to be able to
    " yank exactly the right text by using Visual mode from the '[ to the ']
    " mark.
    let l:save_sel = &selection
    set selection=inclusive

    if a:type ==# 'char'
	call s:SwapText('g`[vg`]')
    elseif a:type ==# 'line'
	call s:SwapText('g`[Vg`]')
    else
	throw 'ASSERT: There is no blockwise visual motion, because we have a special vmap.'
    endif

    let &selection = l:save_sel
endfunction

function! SwapText#UndoJoin()
    " :undojoin may fail with "E790: undojoin is not allowed after undo" when
    " there was an undo immediately before the SwapText mapping. SwapText's
    " problem with undo is that register modifications of the undone command are
    " _not_ undone, so the replacement may be wrong. (We cannot know for sure,
    " the undone command may have specified another target register, or not
    " affected the registers at all.) Better be safe than doing unexpected
    " things.
    try
	undojoin
	return 1
    catch /^Vim\%((\a\+)\)\=:E790/	" E790: undojoin is not allowed after undo
	call ingo#err#Set('Cannot swap after undo')
	return 0
    endtry
endfunction

function! SwapText#OperatorExpr()
    if ! SwapText#UndoJoin()
	return ''
    endif

    let s:deletedStartPos = getpos("'[")

    set opfunc=SwapText#Operator

    let l:keys = 'g@'

    if ! &l:modifiable || &l:readonly
	" Probe for "Cannot make changes" error and readonly warning via a no-op
	" dummy modification.
	" In the case of a nomodifiable buffer, Vim will abort the normal mode
	" command chain, discard the g@, and thus not invoke the operatorfunc.
	let l:keys = ":call setline('.', getline('.'))\<CR>" . l:keys
    endif

    return l:keys
endfunction

" vim: set ts=8 sts=4 sw=4 noexpandtab ff=unix fdm=syntax :
plugin/SwapText.vim	[[[1
84
" SwapText.vim: Mappings to exchange text with the previously deleted text.
"
" DEPENDENCIES:
"   - Requires Vim 7.0 or higher.
"   - SwapText.vim autoload script
"   - ingo/err.vim autoload script
"
" Copyright: (C) 2007-2014 Ingo Karkat
"   The VIM LICENSE applies to this script; see ':help copyright'.
"
" Maintainer:	Ingo Karkat <ingo@karkat.de>
" Source: Based on vimtip #470: Map to quickly swap/exchange arbitrary text by
"	  Piet Delport and an enhancement by ad_scriven@postmaster.co.uk.
"
" REVISION	DATE		REMARKS
"   1.01.019	22-Jul-2014	BUG: <Leader>X includes the newline unless :set
"				selection=exclusive. Thanks to Enno Nagel for
"				reporting this.
"				Minor: Supply the count to "$", no need for a
"				separate "count times j".
"   1.00.018	05-May-2014	Abort on error.
"	017	19-Mar-2013	Revert: Last change broke swapping. Replace
"				<Bar> with <CR>; because SwapText#Visual() uses
"				gv, the selection must have been established.
"	016	18-Feb-2013	Reformat and replace <CR>: with <Bar>.
"				Change <Plug>-mapping names.
"	015	26-Nov-2011	BUG: Incorrectly placed if..endif broke
"				<Plug>SwapTextLines.
"	014	17-Nov-2011	Split off separate autoload script and
"				documentation.
"	001	06-Jun-2007	file creation

" Avoid installing twice or when in unsupported Vim version.
if exists('g:loaded_SwapText') || (v:version < 700)
    finish
endif
let g:loaded_SwapText = 1
let s:save_cpo = &cpo
set cpo&vim

" How it works:
" <ESC>	exits visual mode
" `.	returns to exact spot of last modification (the deleted text)
" m`	put the `. mark into ``, as it'll be overridden by the first paste
" gv	re-selects last visual text
" P	put/paste last deleted text over visually selected text
" ``	moves to where text was deleted
" P	visually selected text is now in the default register, so just paste it.
"
"vnoremap <Leader>x <Esc>`.m`gvP``P

" The simple mapping doesn't work when the deleted text occurs on the right of
" the selected text (i.e. when you edit against the typical left-to-right
" direction) _and_ both text elements are on the same line.
" This implementation explicitly checks for that condition and takes corrective
" actions.
vnoremap <silent> <Plug>(SwapTextVisual)
\ :<C-u>if SwapText#UndoJoin()<Bar>call SwapText#Visual()<Bar>else<Bar>echoerr ingo#err#Get()<Bar>endif<CR>
if ! hasmapto('<Plug>(SwapTextVisual)', 'x')
    xmap <Leader>x <Plug>(SwapTextVisual)
endif

nnoremap <silent> <Plug>(SwapTextLines)
\ :<C-u>execute 'normal! V' . v:count1 . '_'<CR>
\:<C-u>if SwapText#UndoJoin()<Bar>call SwapText#Visual()<Bar>else<Bar>echoerr ingo#err#Get()<Bar>endif<CR>
if ! hasmapto('<Plug>(SwapTextLines)', 'n')
    nmap <Leader>xx <Plug>(SwapTextLines)
endif

nnoremap <silent> <Plug>(SwapTextUntilEnd)
\ :<C-u>execute 'normal! v' . (v:count ? v:count : '') . '$' . (&selection ==# 'exclusive' ? '' : 'h')<CR>
\:<C-u>if SwapText#UndoJoin()<Bar>call SwapText#Visual()<Bar>else<Bar>echoerr ingo#err#Get()<Bar>endif<CR>
if ! hasmapto('<Plug>(SwapTextUntilEnd)', 'n')
    nmap <Leader>X <Plug>(SwapTextUntilEnd)
endif

nnoremap <silent> <expr> <Plug>(SwapTextOperator) SwapText#OperatorExpr()
if ! hasmapto('<Plug>(SwapTextOperator)', 'n')
    nmap <Leader>x <Plug>(SwapTextOperator)
endif

let &cpo = s:save_cpo
unlet s:save_cpo
" vim: set ts=8 sts=4 sw=4 noexpandtab ff=unix fdm=syntax :
doc/SwapText.txt	[[[1
135
*SwapText.txt*          Mappings to exchange text with the previously deleted text.

			 SWAP TEXT    by Ingo Karkat
								*SwapText.vim*
description			|SwapText-description|
usage				|SwapText-usage|
installation			|SwapText-installation|
limitations			|SwapText-limitations|
known problems			|SwapText-known-problems|
todo				|SwapText-todo|
history				|SwapText-history|

==============================================================================
DESCRIPTION						*SwapText-description*

Swapping text areas when there's other text in between (e.g. function
arguments separated by other arguments) is done frequently, yet cumbersome.
One way to do this is by deleting A, selecting B, pasting over it, then going
back to where A used to be and pasting the original B.

This plugin lets you exchange the current selection / line / text covered by a
motion with the previously deleted text, with a short and simple mapping. The
swap can be undone as a single action.

SOURCE									     *

Based on vimtip #470: Map to quickly swap/exchange arbitrary text by Piet
Delport and an enhancement by ad_scriven@postmaster.co.uk.
    http://vim.wikia.com/wiki/Swapping_characters,_words_and_lines

SEE ALSO								     *

- The |LineJuggler.vim| plugin (vimscript #4140) provides [E / ]E mappings to
  swap lines / the selection with the same amount of visible lines located
  [count] above / below.
- The |LineJugglerCommands.vim| plugin (vimscript #4465) provides swapping of
  ranges as an Ex |:Swap| command.

RELATED WORKS								     *

- visswap.vim (http://www.drchip.org/astronaut/vim/vbafiles/visswap.vba.gz)
  uses a visual selection, <C-y>, another selection, <C-x> to swap the two.
- swapstrings.vim (http://www.drchip.org/astronaut/vim/#SWAPSTRINGS) can swap
  all instances of two strings in a range.
- swap.vim (vimscript #3250) can swap around a pivot (e.g. ==) or to WORDs to
  the left / right with <Leader>x / <Leader>X.
- exchange (https://github.com/tommcdo/vim-exchange) defines a cx{motion}
  operator that has to be used twice to exchange the first with the second
  one.

==============================================================================
USAGE							      *SwapText-usage*

First, delete some text (using any normal Vim command, such as "daw",
{Visual}x, or "dt"). Then, visually select some other text, and press
<Leader>x, or use the custom operator <Leader>x{motion}. The two pieces of
text should now be swapped.

			    *v_<Leader>x* *<Leader>x* *<Leader>xx* *<Leader>X*
{Visual}<Leader>x	Swap the visual selection with the just deleted text.
<Leader>x{motion}	Swap the characters covered by {motion} with the just
			deleted text.
[count]<Leader>xx	Swap the current [count] line(s) with the just deleted
			text.
[count]<Leader>X	Swap the characters under the cursor until the end of
			the line and [count]-1 more lines with the just
			deleted text.

==============================================================================
INSTALLATION					       *SwapText-installation*

This script is packaged as a |vimball|. If you have the "gunzip" decompressor
in your PATH, simply edit the *.vmb.gz package in Vim; otherwise, decompress
the archive first, e.g. using WinZip. Inside Vim, install by sourcing the
vimball or via the |:UseVimball| command. >
    vim SwapText*.vmb.gz
    :so %
To uninstall, use the |:RmVimball| command.

DEPENDENCIES					       *SwapText-dependencies*

- Requires Vim 7.0 or higher.
- Requires the |ingo-library.vim| plugin (vimscript #4433), version 1.005 or
  higher.

==============================================================================
LIMITATIONS						*SwapText-limitations*

- Unless :set virtualedit=all, swapping the last characters in a line will
  insert one character short of where the insert should be. This only
  happens when you swap FROM the last characters in a line to somewhere else.
  If you swap TO (in the natural left-to-right editing order) the last
  characters in a line, everythings works fine.

KNOWN PROBLEMS					     *SwapText-known-problems*

- Offset correction only works when the entire swap-to text is inside one
  line.

TODO							       *SwapText-todo*

IDEAS							      *SwapText-ideas*

==============================================================================
HISTORY							    *SwapText-history*

1.02	19-Sep-2016
- "E790: undojoin is not allowed after undo" may also be raised in
  SwapText#Operator(); ignore it.
- BUG: When deleting at the end of a line, and swapping with a longer text
  before it, the swap location is off by one. The EOL position isn't properly
  detected, because the virtual line length after the paste is used in the
  condition. Save the deleted virtual line length in deletedVirtLen, and pass
  that on to s:WasDeletionAtEndOfLine(). Thanks to Marcelo Montu for the bug
  report.

1.01	22-Jul-2014
- BUG: <Leader>X includes the newline unless :set selection=exclusive. Thanks
  to Enno Nagel for reporting this.

1.00	24-Jun-2014
First published version.

0.01	06-Jun-2007
Started development based on vimtip #470: Map to quickly swap/exchange
arbitrary text by Piet Delport and an enhancement by
ad_scriven@postmaster.co.uk.

==============================================================================
Copyright: (C) 2007-2016 Ingo Karkat
The VIM LICENSE applies to this plugin; see |copyright|.

Maintainer:	Ingo Karkat <ingo@karkat.de>
==============================================================================
 vim:tw=78:ts=8:ft=help:norl: