swapit.vim

"SwapIt: General Purpose related word swapping for vim
" Script Info and Documentation  {{{1
"=============================================================================
"
"    Copyright: Copyright (C) 2008 Michael Brown {{{2
"      License: The MIT License
"
"               Permission is hereby granted, free of charge, to any person obtaining
"               a copy of this software and associated documentation files
"               (the "Software"), to deal in the Software without restriction,
"               including without limitation the rights to use, copy, modify,
"               merge, publish, distribute, sublicense, and/or sell copies of the
"               Software, and to permit persons to whom the Software is furnished
"               to do so, subject to the following conditions:
"
"               The above copyright notice and this permission notice shall be included
"               in all copies or substantial portions of the Software.
"
"               THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
"               OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
"               MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
"               IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
"               CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
"               TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
"               SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"
" Name Of File: swapit.vim {{{2
"  Description: system for swapping related words
"   Maintainer: Michael Brown
" Contributors: Ingo Karkat (speedating compatability)
"  Last Change:
"          URL:
"      Version: 0.1.2
"
"        Usage: {{{2
"
"               On a current word that is a member of a swap list use the
"               incrementor/decrementor keys (:he ctrl-a,ctrl-x). The script
"               will cycle through a list of related options.
"
"               eg. 1. Boolean
"
"               foo=yes
"
"               in normal mode, pressing ctrl-a on the y will make it.
"
"               foo=no
"
"               The plugin handles clashes. Eg. if yes appears in more than
"               one swap list (eg. yes/no or yes/no/maybe), a confirm dialog will appear.
"
"               eg. 2. Multi Word Swaps.
"
"               Hello World! is a test multi word swap.
"
"               on 'Hello World!' go select in visual (vi'<ctrl-a>) to get
"
"               'GoodBye Cruel World!'
"
"               eg 3. Defining custom swaps
"
"               A custom list is defined as follows.
"
"               :SwapList datatype bool char int float double
"
"               The first argument is the list name and following args
"               are members of the list.
"
"               if there is no match then the regular incrementor decrementor
"               function will work on numbers
"
"               At the bottom of the script I've added some generic stuff but
"
"               You can create a custom swap file for file types at
"
"               ~/.vim/after/ftplugins/<filetype>_swapit.vim
"               with custom execs eg.
"               exec "SwapList function_scope private protected public"
"
"               4. Insert mode completion
"
"               You can use a swap list in insert mode by typing the list name
"               and hitting ctrl+b eg.
"
"               datatype<ctrl+b>    once  will provide a complete list of datatypes.
"
"               (Note: insert mode complete is still buggy and will eat your current
"               word if you keep hitting ctrl+b on an incorrect. It's disabled
"               by default so as not to annoy anyone.  Uncomment the line in the
"               command configuration if you want to try it out.
"
"               Note: This alpha version doesnt create the directory structure
"
"               To integrate with other incrementor scripts (such as
"               speeddating.vim or monday.vim), map
"               <Plug>SwapItFallbackIncrement and <Plug>SwapItFallbackDecrement
"               to the keys that should be invoked when swapit doesn't have a
"               proper option. For example for speeddating.vim:
"
"               nmap <Plug>SwapItFallbackIncrement <Plug>SpeedDatingUp
"               nmap <Plug>SwapItFallbackDecrement <Plug>SpeedDatingDown
"               vmap <Plug>SwapItFallbackIncrement <Plug>SpeedDatingUp
"               vmap <Plug>SwapItFallbackDecrement <Plug>SpeedDatingDown
"
"         Bugs: {{{2
"
"               Will only give swap options for first match (eg make sure
"               options are unique).
"
"               The visual mode is inconsistent on highlighting the end of a
"               phrase occasionally one character under see VISHACK
"
"        To Do: {{{2
"
"               - improve filetype handling
"               - look at load performance if it becomes an issue
"               - might create a text file swap list rather than vim list
"               - look at clever case option to reduce permutations
"               - look at possibilities beyond <cword> for non word swaps
"                   eg swap > for < , == to != etc.
"               - add a repeated keyword warning for :SwapList
"               - add repeat resolition confirm option eg.
"                SwapSelect>   a. (yes/no) b. (yes/no/maybe)
"
"               ideas welcome at mjbrownie (at) gmail dot com.
"
"               I'd like to compile some useful swap lists for different
"               languages to package with the script
"
"Variable Initialization {{{1
"if exists('g:loaded_swapit')
"    finish
"elseif v:version < 700
"    echomsg "SwapIt plugin requires Vim version 7 or later"
"    finish
"endif
let g:loaded_swapit = 1

if !exists('g:swap_list_dont_append')
    let g:swap_list_dont_append = 'no'
endif
if empty(maparg('<Plug>SwapItFallbackIncrement', 'n'))
    nnoremap <Plug>SwapItFallbackIncrement <c-a>
endif
if empty(maparg('<Plug>SwapItFallbackDecrement', 'n'))
    nnoremap <Plug>SwapItFallbackDecrement <c-x>
endif
" Don't define default fallback mappings for visual mode; there is no such
" built-in functionality. The undefined <Plug> mappings will cause a beep, just
" as we want.

"Command/AutoCommand Configuration {{{1
"
" For executing the listing
nnoremap <silent><c-a> :<c-u>call SwapWord(expand("<cword>"), v:count, 'forward', 'no')<cr>
nnoremap <silent><c-x> :<c-u>call SwapWord(expand("<cword>"), v:count, 'backward','no')<cr>
vnoremap <silent><c-a> :<c-u>let swap_count = v:count<Bar>call SwapWord(<SID>GetSelection(), swap_count, 'forward', 'yes')<Bar>unlet swap_count<cr>
vnoremap <silent><c-x> :<c-u>let swap_count = v:count<Bar>call SwapWord(<SID>GetSelection(), swap_count, 'backward','yes')<Bar>unlet swap_count<cr>
"inoremap <silent><c-b> <esc>b"sdwi <c-r>=SwapInsert()<cr>
"inoremap <expr> <c-b> SwapInsert()

" For adding lists
com! -nargs=* SwapList call AddSwapList(<q-args>)
com! ClearSwapList let b:swap_lists = []
com! SwapIdea call OpenSwapFileType()
com! -range -nargs=1 SwapWordVisual call SwapWord(getline('.'), 1, <f-args>,'yes')
com! -nargs=+ SwapXmlMatchit call AddSwapXmlMatchit(<q-args>)
"Swap Processing Functions {{{1
"
"
" <SID>GetSelection() retrieves the selected text without clobbering a register {{{2
fun! s:GetSelection()
    let save_clipboard = &clipboard
    set clipboard= " Avoid clobbering the selection and clipboard registers.
        let save_reg = getreg('"')
        let save_regmode = getregtype('"')
            execute 'silent! normal! gvy'
            let selection = @"
        call setreg('"', save_reg, save_regmode)
    let &clipboard = save_clipboard
    return selection
endfun

" <SID>GetLists() accessor for swap lists {{{2
fun! s:GetLists()
    if g:swap_list_dont_append == 'yes'
        return exists('b:swap_lists') ? b:swap_lists : []
    elseif exists('b:swap_lists')
        let lists = copy(b:swap_lists)
        let names = map(copy(b:swap_lists), 'v:val.name')
        for swap_list in g:default_swap_list
            if index(names, swap_list.name) == -1
                call add(lists, swap_list)
            endif
        endfor
        return lists
    else
        return g:default_swap_list
    endif
endfun

"SwapWord() main processiong event function {{{2
fun! SwapWord (word, count, direction, is_visual)

    let comfunc_result = 0
    "{{{3 css omnicomplete property swapping
    if exists('b:swap_completefunc')
        exec "let complete_func = " . b:swap_completefunc . "('". a:direction ."')"
        if ( comfunc_result == 1 )
            return 1
        endif
    endif

    let cur_word = a:word
    let match_list = []

    " Main for loop over each swaplist {{{3
    for swap_list in s:GetLists()
        let word_options = swap_list['options']
        let word_index = index(word_options, cur_word)

        if word_index != -1
            call add(match_list, swap_list)
        endif
    endfor

    "}}}

    let out =  ProcessMatches(match_list, cur_word , a:count, a:direction, a:is_visual)
    return ''
endfun

"ProcessMatches() handles various result {{{2
fun! ProcessMatches(match_list, cur_word, count, direction, is_visual)

    if len(a:match_list) == 0
        let visual_prefix = (a:is_visual == 'yes' ? 'gv' : '')
        if a:direction == 'forward'
            exec 'normal' visual_prefix . (a:count ? a:count : '') . "\<Plug>SwapItFallbackIncrement"
        else
            exec 'normal' visual_prefix . (a:count ? a:count : '') . "\<Plug>SwapItFallbackDecrement"
        endif
        return ''
    endif

    if len(a:match_list) == 1
        let swap_list = a:match_list[0]
        call SwapMatch(swap_list, a:cur_word, (a:count ? a:count : 1), a:direction, a:is_visual)
        return ''
    endif

    if len(a:match_list) > 7
        echo "Too many matches for " . a:cur_word . ". "
        echo a:match_list
        return ''
    endif

    if len(a:match_list) > 1
        call ShowSwapChoices(a:match_list, a:cur_word, (a:count ? a:count : 1), a:direction, a:is_visual)
    endif

endfun

" SwapMatch()  handles match {{{2
fun! SwapMatch(swap_list, cur_word, count, direction, is_visual)

    let word_options = a:swap_list['options']
    let word_index = index(word_options, a:cur_word)

    if a:direction == 'forward'
        let word_index = ( word_index + a:count ) % len(word_options)
    else
        let word_index = ( word_index - a:count ) % len(word_options)
    endif

    let next_word = word_options[word_index]

    let save_clipboard = &clipboard
    set clipboard= " Avoid clobbering the selection and clipboard registers.
    let save_reg = @"
    let save_regmode = getregtype('"')
    let @" = next_word
    let in_visual = 0

    try
        let temp_mark = (v:version < 702 ? 'a' : '"')

        "XML matchit handling  {{{3
        if exists('b:swap_xml_matchit') && index(b:swap_xml_matchit, a:swap_list['name']) != -1 && exists('g:loaded_matchit') && g:loaded_matchit " We need the matchit.vim plugin for this.

            if match(getline("."),"<\\(\\/".a:cur_word."\\|".a:cur_word."\\)[^>]*>" ) == -1
                return 0
            endif

            exec 'norm! T<m' . temp_mark
            norm %
            let on_start_tag = 1

            "Always mark the start tag, and put the cursor on the end tag.

            if getline(".")[col(".") -1] != "/"
                exec 'norm! m' . temp_mark
                norm %
                let on_start_tag = 0
            endif

            norm! lviw""p
            let @" = next_word  " Paste in visual mode clobbers the contents of the default register.
            exec "norm! g`" . temp_mark . "viw\"\"p"

            if !on_start_tag
                "Return to the (end) tag the swap was triggered on.
                norm %
            endif
        " Regular swaps {{{3
        else

            if a:is_visual == 'yes'
                if next_word =~ '\W'
                    let in_visual = 1
                    exec 'norm! gv""pg`[vg`]' . (&selection ==# 'exclusive' ? 'l' : '')
                else
                    exec 'norm! gv""pg`['
                endif
            else
                if next_word =~ '\W'
                    let in_visual = 1
                    exec 'norm! m' . temp_mark . 'viw""pg`[vg`]' . (&selection ==# 'exclusive' ? 'l' : '')
                else
                    exec 'norm! m' . temp_mark . 'viw""pg`' . temp_mark
                endif
            endif
        endif
        " 3}}}

        "TODO VISHACK This is a silly hack to fix the visual range. if the v ends with
        "a word character the visual range is onw column over but not for
        "non word characters.

"       if in_visual == 1 && next_word =~ "\\w$" && &selection == 'inclusive'
"           exec 'norm! h'
"       endif

"       if in_visual == 1 && (next_word =~  "\\W$") && &selection == 'exclusive'
"           exec 'norm! l'
"       endif
        return 1
    finally
        call setreg('"', save_reg, save_regmode)
        let &clipboard = save_clipboard
        "    echo "Swap: " . a:swap_list['name'] .' '. a:cur_word . " > " . next_word
        "\. ' ' . word_index . ' ' . a:direction . ' ' . len(word_options)
    endtry
endfun
"
"ShowSwapChoices() shows alternative swaps {{{2
fun! ShowSwapChoices(match_list, cur_word, count, direction, is_visual)

    let a_opts = ['A','B','C','D','E','F','G']
    let con_index = 0
    let confirm_options = ''
    let confirm_but = ''

    "Generate the prompt {{{3
    for swap_list in a:match_list
        let next_index = (index(swap_list['options'], a:cur_word) + (a:direction == 'forward' ? 1 : -1)) % len(swap_list['options'])
        let confirm_options =  confirm_options . ' ' . a_opts[con_index] . " . " . swap_list['name'] . ' (' .
                    \a:cur_word . ' > ' . swap_list['options'][next_index] . ') '

        "        For some reason concatenating stuffs up the string, using an
        "        if con_index > 0
        "            let confirm_but = confirm_but + '\n'
        "        endif
        "        let confirm_but = confirm_but +  "option&". a_opts[con_index]

        let con_index = con_index + 1
    endfor
    "   }}}
    "    TODO Prompt  This is a bit inelegant but I'm using it as the second argument of
    "       confirm wont take a concatenated string (some escape issue). At the moment I just want it
    "       to work
    "       {{{3
    if len(a:match_list) == 2
        let choice = confirm("Swap Options: " . confirm_options , "&A\n&B" ,  0)
    elseif len(a:match_list) == 3
        let choice = confirm("Swap Options: ". confirm_options  , "&A\n&B\n&C" ,  0)
    elseif len(a:match_list) == 4
        let choice = confirm("Swap Options: ". confirm_options  , "&A\n&B\n&C\n&D" , 0)
    elseif len(a:match_list) == 5
        let choice = confirm("Swap Options: ". confirm_options  , "&A\n&B\n&C\n&D\n&E" ,  0)
    elseif len(a:match_list) == 6
        let choice = confirm("Swap Options: ". confirm_options  , "&A\n&B\n&C\n&D\n&E\n&F" , 0)
    elseif len(a:match_list) == 7
        let choice = confirm("Swap Options: ". confirm_options  , "&A\n&B\n&C\n&D\n&E\&F\&G" , 0)
    endif
    "   }}}
    if choice != 0
        call SwapMatch(a:match_list[choice -1], a:cur_word, a:count, a:direction, a:is_visual)
    else
        echo "Swap: Cancelled"
    endif
endfun
"Insert Mode List Handling {{{1
"
"SwapInsert() call a swap list from insert mode
fun! SwapInsert()
    for swap_list in s:GetLists()
        if swap_list['name'] == @s
            call complete(col('.'), swap_list['options'])
            return ''
        endif
    endfor
    return  ''
endfun
"List Maintenance Functions {{{1
"AddSwapList()  Main Definition Function {{{2
"use with after/ftplugin/ vim files to set up file type swap lists
fun! AddSwapList(s_list)

    let word_list = split(a:s_list,'\s\+')

    if len(word_list) < 3
        echo "Usage :SwapList <list_name> <member1> <member2> .. <membern>"
        return 1
    endif

    let list_name = remove (word_list,0)

    if !exists('b:swap_lists') | let b:swap_lists = [] | endif
    call add(b:swap_lists,{'name':list_name, 'options':word_list})
endfun

fun! AddSwapXmlMatchit(s_list)
    let b:swap_xml_matchit = split(a:s_list,'\s\+')
endfun
"OpenSwapFileType() Quick Access to filtype file {{{2
fun! OpenSwapFileType()
    let ftpath = "~/.vim/after/ftplugin/". &filetype ."_swapit.vim"
    if !filereadable(ftpath)
        "TODO add a directory check
        exec "10 split " . ftpath
        "exec 'norm! I "SwapIt.vim definitions for ' . &filetype . ': eg exec "SwapList names Tom Dick Harry\"'
        return ''
    else
        exec "10 split " . ftpath
    endif
    exec "norm! G"
endfun
"Default DataSet. Add Generic swap lists here {{{1
if g:swap_list_dont_append == 'yes'

    let g:default_swap_list = []

else
    let g:default_swap_list = [
                \{'name':'yes/no', 'options': ['yes','no']},
                \{'name':'Yes/No', 'options': ['Yes','No']},
                \{'name':'True/False', 'options': ['True','False']},
                \{'name':'true/false', 'options': ['true','false']},
                \{'name':'AND/OR', 'options': ['AND','OR']},
                \{'name':'Hello World', 'options': ['Hello World!','GoodBye Cruel World!' , 'See You Next Tuesday!']},
                \{'name':'On/Off', 'options': ['On','Off']},
                \{'name':'on/off', 'options': ['on','off']},
                \{'name':'ON/OFF', 'options': ['ON','OFF']},
                \{'name':'comparison_operator', 'options': ['<','<=','==', '>=', '>' , '=~', '!=']},
                \{'name': 'datatype', 'options': ['bool', 'char','int','unsigned int', 'float','long', 'double']},
                \{'name':'weekday', 'options': ['Sunday','Monday', 'Tuesday', 'Wednesday','Thursday', 'Friday', 'Saturday']},
                \]
endif
"NOTE: comparison_operator doesn't work yet but there in the hope of future
"
"capability

" modeline: {{{
" vim: expandtab softtabstop=4 shiftwidth=4 foldmethod=marker