Skip to content

Commit

Permalink
Merge branch 'autoload'
Browse files Browse the repository at this point in the history
  • Loading branch information
sk1418 committed Nov 7, 2013
2 parents 1abc6e3 + 1613cd0 commit 3e08e84
Show file tree
Hide file tree
Showing 3 changed files with 225 additions and 181 deletions.
221 changes: 221 additions & 0 deletions autoload/Join.vim
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
" Join : a better (hopefully) :Join command in Vim
" Author : Kai Yuan <[email protected]>
" License: {{{
"Copyright (c) 2013 Kai Yuan
"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.
" }}}
if exists("g:autoloaded_Join") || &cp
finish
endif

let g:autoloaded_Join = 1
let s:FLAGS = ['k','r'] "available flags

"message dictionary
let s:errMsgsDict = {'err_arg_sep': '[JoinErr:ARG] Invalid Separator'}
let s:errMsgsDict['err_arg_num'] = '[JoinErr:ARG] Invalid number of arguments'
let s:errMsgsDict['err_arg_cf'] = '[JoinErr:ARG] Argument Count or Flags is invalid'

"============================================================
" Helper functions {{{
"============================================================

"------------------------------------
" display highlighted error message
"------------------------------------
function! Join#err_msg(errKey)
echohl Error
echon s:errMsgsDict[a:errKey]
echohl None
endfunction


"------------------------------------
"check if an input is Count argument
"------------------------------------
function! Join#is_count(inputCount)
return a:inputCount =~ '^-\?[1-9]\d*$'
endfunction

"------------------------------------
"check if an input string is flags argument
"------------------------------------
function! Join#is_flag(inputFlags)
let flagReg = '['. join(s:FLAGS,'') .']'
if empty(a:inputFlags) || len(a:inputFlags) > len(s:FLAGS)
return 0
else
return empty(substitute(a:inputFlags,flagReg, '','g'))
endif
endfunction

"}}}

"------------------------------------
" Do the join logic here
"------------------------------------
function! Join#do_join(sep, bang, count, flag, first, last)
if g:Join_debug"{{{
echom '---------------------'
echom 'parsed sep:' . a:sep
echom 'bang:' . a:bang
echom 'input count:' . a:count
echom 'input flags' . a:flag
echom '---------------------'
endif"}}}
let cnt = a:count

"flags
let joinRev = stridx(a:flag, 'r') >= 0
let joinKeep = stridx(a:flag, 'k') >= 0

if a:first == a:last
let cnt = cnt == 0 ? 1 : cnt
"a:first and a:last are same
let jbegin = cnt > 0 ? a:first : a:first + ((cnt + 1)<0?cnt+1:cnt)
let jend = cnt > 0 ? (cnt > 1 ? a:first + cnt - 1:a:first + cnt): a:first
else " user inputed a range > 1 line
if cnt == 0 "without count
let jbegin = a:first
let jend = a:last
elseif cnt > 0 "with positive count
let jbegin = a:last
let jend = jbegin + (cnt==1?1:cnt -1)
else " negative count !! could be confusing, need explain in doc
let jend = a:first
let jbegin = (a:first + ((cnt+1)<0?cnt+1:cnt) )
endif
endif
"
if g:Join_debug"{{{
echom '---------------------'
echom 'calculated firstline:'.jbegin
echom 'calculated lastline:' . jend
echom 'join keep :' . joinKeep
echom 'join rev :' . joinRev
echom '---------------------'
endif"}}}


let jbegin = jbegin < 0 ? 0 : jbegin
let jend = jend >= line('$') ? line('$') : jend

"now load lines
let lines = getline(jbegin, jend)

if !a:bang "without bang, trim lines
call map(lines, "substitute(v:val, '^\\s\\+\\|\\s\\$','','g')")
endif

if !joinKeep
"remove lines
execute jbegin . ',' . jend . 'd'
call append(jbegin>0 ? jbegin-1 : 0, join(joinRev?reverse(lines):lines, a:sep))
else
if cnt>=0
call setline(jbegin, join(joinRev?reverse(lines):lines, a:sep))
else
call setline(jend, join(joinRev?reverse(lines):lines, a:sep))
endif

endif

endfunction



"------------------------------------
" this function parses user inputs, and return parted
" arguments in a dictionary. If parsing error occured, exception will be thrown
" argstr should follow format [sep] [count] [flags]
" for example 'I am sep' 20 kr
"------------------------------------
function! Join#parse_args(argstr)
let rest = a:argstr
let c = 0
let sep = " "
let flags = ""

"first check sep
if a:argstr[0] =~ "['\"]"
let sepRegex = "\\v^(['\"]).*(\\\\)@<!\\1( |$)@="
try
let sepInput = matchstr(a:argstr,sepRegex,0)
catch /.*/
throw 'err_arg-sep'
endtry

if empty(sepInput)
throw 'err_arg_sep'
else
let rest = strpart(rest, len(sepInput))
let sep = eval(sepInput)
endif
endif

let rest = substitute(rest,' \+', " ","g")
let cfList = split(rest, " ") "count flag list
let ln = len(cfList)
if ln > 2
throw 'err_arg_num'
elseif ln == 1
if Join#is_count(cfList[0])
let c = cfList[0]
elseif Join#is_flag(cfList[0])
let flags = cfList[0]
else
throw 'err_arg_cf'
endif
elseif ln == 2
if Join#is_count(cfList[0]) && Join#is_flag(cfList[1])
let c = cfList[0]
let flags = cfList[1]
elseif Join#is_count(cfList[1]) && Join#is_flag(cfList[0])
let c = cfList[1]
let flags = cfList[0]
else
throw 'err_arg_cf'
endif
endif

return {'sep':sep, 'count':c, 'flags':flags}
endfunction


"--------------------------------------------
" The function is the entry point. When user
" executed the :Join command, this function will
" be called.
"--------------------------------------------
function! Join#Join(argstr, bang) range
try
let args = Join#parse_args(a:argstr)
catch /^err/
call Join#err_msg(v:exception)
return
endtry

let args['first'] = a:firstline
let args['last'] = a:lastline
let args['bang'] = a:bang
call Join#do_join( args['sep'], args['bang'], args['count'], args['flags'], args['first'], args['last'])
endfunction



" vim: ts=2:sw=2:ft=vim:fdm=marker
4 changes: 2 additions & 2 deletions doc/Join.txt
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Argument rules:
<
- all arguments are optional. If an argument was not given by user, the default
value will be used:

>
========================
arg | Default value
========================
Expand All @@ -81,7 +81,7 @@ Argument rules:
separator| " "
flags | ""
------------------------

<
*Join-negative-count* *Join-range-count*

If [count] is negative. |Join| will join lines backwards. For example:
Expand Down
Loading

0 comments on commit 3e08e84

Please sign in to comment.