" Copyright (c) 2013 Junegunn Choi " " 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. if exists("g:loaded_easy_align") finish endif let g:loaded_easy_align = 1 let s:easy_align_delimiters_default = { \ ' ': { 'pattern': ' ', 'left_margin': '', 'right_margin': '', 'stick_to_left': 0 }, \ '=': { 'pattern': '===\|<=>\|\(&&\|||\|<<\|>>\)=\|=\~\|=>\|[:+/*!%^=><&|-]\?=[#?]\?', \ 'left_margin': ' ', 'right_margin': ' ', 'stick_to_left': 0 }, \ ':': { 'pattern': ':', 'left_margin': '', 'right_margin': ' ', 'stick_to_left': 1 }, \ ',': { 'pattern': ',', 'left_margin': '', 'right_margin': ' ', 'stick_to_left': 1 }, \ '|': { 'pattern': '|', 'left_margin': ' ', 'right_margin': ' ', 'stick_to_left': 0 }, \ '.': { 'pattern': '\.', 'left_margin': '', 'right_margin': '', 'stick_to_left': 0 }, \ '{': { 'pattern': '(\@ ^s.*_t.*_l.* let regexp1 = '^' .key[0]. '.*' .substitute(key[1 : -1], '\(.\)', '_\1.*', 'g') let matches = filter(keys(s:known_options), 'v:val =~ regexp1') if len(matches) == 1 return matches[0] endif " stl -> ^s.*t.*l.* let regexp2 = '^' . substitute(substitute(key, '-', '_', 'g'), '\(.\)', '\1.*', 'g') let matches = filter(keys(s:known_options), 'v:val =~ regexp2') if empty(matches) call s:exit("Unknown option key: ". a:key) elseif len(matches) == 1 return matches[0] else " Avoid ambiguity introduced by deprecated margin_left and margin_right if sort(matches) == ['margin_left', 'margin_right', 'mode_sequence'] return 'mode_sequence' endif if sort(matches) == ['ignore_groups', 'ignores'] return 'ignore_groups' endif call s:exit("Ambiguous option key: ". a:key ." (" .join(matches, ', '). ")") endif endfunction function! s:shift(modes, cycle) let item = remove(a:modes, 0) if a:cycle || empty(a:modes) call add(a:modes, item) endif return item endfunction function! s:normalize_options(opts) let ret = {} for k in keys(a:opts) let v = a:opts[k] let k = s:fuzzy_lu(k) " Backward-compatibility if k == 'margin_left' | let k = 'left_margin' | endif if k == 'margin_right' | let k = 'right_margin' | endif let ret[k] = v unlet v endfor return s:validate_options(ret) endfunction function! s:validate_options(opts) for k in keys(a:opts) let v = a:opts[k] if index(s:known_options[k], type(v)) == -1 call s:exit("Invalid type for option: ". k) endif unlet v endfor return a:opts endfunction function! s:split_line(line, nth, modes, cycle, fc, lc, pattern, stick_to_left, ignore_unmatched, ignore_groups) let mode = '' let string = a:lc ? \ strpart(getline(a:line), a:fc - 1, a:lc - a:fc + 1) : \ strpart(getline(a:line), a:fc - 1) let idx = 0 " Do not allow \zs " 1: whole match " 2: token " 3: delimiter let pattern = '^\(\(.\{-}\s*\)\(' .a:pattern. '\)\s' . (a:stick_to_left ? '*' : '\{-}') . '\)' let tokens = [] let delims = [] " Phase 1: split let ignorable = 0 let token = '' while 1 let matches = matchlist(string, pattern, idx) " No match if empty(matches) | break | endif " Match, but empty delimiter if empty(matches[1]) let char = strpart(string, idx, 1) if empty(char) | break | endif let [match, part, delim] = [char, char, ''] " Match else let [match, part, delim] = matches[1 : 3] endif let ignorable = s:highlighted_as(a:line, idx + len(part) + a:fc, a:ignore_groups) if ignorable let token .= match else let [pmode, mode] = [mode, s:shift(a:modes, a:cycle)] call add(tokens, token . match) call add(delims, delim) let token = '' endif let idx += len(match) " If the string is non-empty and ends with the delimiter, " append an empty token to the list if idx == len(string) call add(tokens, '') call add(delims, '') break endif endwhile let leftover = token . strpart(string, idx) if !empty(leftover) let ignorable = s:highlighted_as(a:line, len(string) + a:fc - 1, a:ignore_groups) call add(tokens, leftover) call add(delims, '') endif let [pmode, mode] = [mode, s:shift(a:modes, a:cycle)] " Preserve indentation - merge first two tokens if len(tokens) > 1 && empty(s:rtrim(tokens[0])) let tokens[1] = tokens[0] . tokens[1] call remove(tokens, 0) call remove(delims, 0) let mode = pmode endif " Skip comment line if ignorable && len(tokens) == 1 && a:ignore_unmatched let tokens = [] let delims = [] " Append an empty item to enable right/center alignment of the last token " - if the last token is not ignorable or ignorable but not the only token elseif (mode ==? 'r' || mode ==? 'c') && (!ignorable || len(tokens) > 1) && a:nth >= 0 " includes -0 call add(tokens, '') call add(delims, '') endif return [tokens, delims] endfunction function! s:max(old, new) for k in keys(a:new) if a:new[k] > a:old[k] let a:old[k] = a:new[k] " max() doesn't work with Floats endif endfor endfunction function! s:do_align(modes, all_tokens, all_delims, fl, ll, fc, lc, pattern, nth, \ ml, mr, da, indentation, stick_to_left, ignore_unmatched, ignore_groups, recur) let mode = a:modes[0] let lines = {} let min_indent = -1 let max = { 'pivot_len': 0.0, 'token_len': 0, 'just_len': 0, 'delim_len': 0, \ 'indent': 0, 'tokens': 0, 'strip_len': 0 } " Phase 1 for line in range(a:fl, a:ll) if !has_key(a:all_tokens, line) " Split line into the tokens by the delimiters let [tokens, delims] = s:split_line( \ line, a:nth, copy(a:modes), a:recur == 2, \ a:fc, a:lc, a:pattern, \ a:stick_to_left, a:ignore_unmatched, a:ignore_groups) " Remember tokens for subsequent recursive calls let a:all_tokens[line] = tokens let a:all_delims[line] = delims else let tokens = a:all_tokens[line] let delims = a:all_delims[line] endif " Skip empty lines if empty(tokens) continue endif " Calculate the maximum number of tokens for a line within the range call s:max(max, { 'tokens': len(tokens) }) if a:nth > 0 " Positive field number if len(tokens) < a:nth continue endif let nth = a:nth - 1 " make it 0-based else " -0 or Negative field number if a:nth == 0 && mode !=? 'l' let nth = len(tokens) - 1 else let nth = len(tokens) + a:nth endif if empty(delims[len(delims) - 1]) let nth -= 1 endif if nth < 0 || nth == len(tokens) continue endif endif let prefix = nth > 0 ? join(tokens[0 : nth - 1], '') : '' let delim = delims[nth] let token = s:rtrim( tokens[nth] ) let token = s:rtrim( strpart(token, 0, len(token) - len(s:rtrim(delim))) ) if empty(delim) && !exists('tokens[nth + 1]') && a:ignore_unmatched continue endif let indent = len(matchstr(tokens[0], '^\s\+')) if min_indent < 0 || indent < min_indent let min_indent = indent endif if mode ==? 'c' | let token .= matchstr(token, '^\s*') | endif let [pw, tw] = [s:strwidth(prefix), s:strwidth(token)] call s:max(max, { 'indent': indent, 'token_len': tw, 'just_len': pw + tw, \ 'delim_len': s:strwidth(delim) }) if mode ==? 'c' call s:max(max, { 'pivot_len': pw + tw / 2.0, \ 'strip_len': s:strwidth(s:trim(token)) }) endif let lines[line] = [nth, prefix, token, delim] endfor " Phase 1-5: indentation handling (only on a:nth == 1) if a:nth == 1 if a:indentation ==? 'd' let indent = repeat(' ', max.indent) elseif a:indentation ==? 's' let indent = repeat(' ', min_indent) elseif a:indentation ==? 'n' let indent = '' elseif a:indentation !=? 'k' call s:exit('Invalid indentation: ' . a:indentation) end if a:indentation !=? 'k' let max.just_len = 0 let max.token_len = 0 let max.pivot_len = 0 for [line, elems] in items(lines) let [nth, prefix, token, delim] = elems let token = substitute(token, '^\s*', indent, '') if mode ==? 'c' let token = substitute(token, '\s*$', indent, '') endif let [pw, tw] = [s:strwidth(prefix), s:strwidth(token)] call s:max(max, { 'token_len': tw, 'just_len': pw + tw }) if mode ==? 'c' call s:max(max, { 'pivot_len': pw + tw / 2.0 }) endif let lines[line][2] = token endfor endif endif " Phase 2 for [line, elems] in items(lines) let tokens = a:all_tokens[line] let delims = a:all_delims[line] let [nth, prefix, token, delim] = elems " Remove the leading whitespaces of the next token if len(tokens) > nth + 1 let tokens[nth + 1] = s:ltrim(tokens[nth + 1]) endif " Pad the token with spaces let [pw, tw] = [s:strwidth(prefix), s:strwidth(token)] let rpad = '' if mode ==? 'l' let pad = repeat(' ', max.just_len - pw - tw) if a:stick_to_left let rpad = pad else let token = token . pad endif elseif mode ==? 'r' let pad = repeat(' ', max.just_len - pw - tw) let token = pad . token elseif mode ==? 'c' let p1 = max.pivot_len - (pw + tw / 2.0) let p2 = (max.token_len - tw) / 2.0 let pf1 = floor(p1) if pf1 < p1 | let p2 = ceil(p2) else | let p2 = floor(p2) endif let strip = float2nr(ceil((max.token_len - max.strip_len) / 2.0)) let token = repeat(' ', float2nr(pf1)) .token. repeat(' ', float2nr(p2)) let token = substitute(token, repeat(' ', strip) . '$', '', '') endif let tokens[nth] = token " Pad the delimiter let dpadl = max.delim_len - s:strwidth(delim) if a:da ==? 'l' let [dl, dr] = ['', repeat(' ', dpadl)] elseif a:da ==? 'c' let dl = repeat(' ', dpadl / 2) let dr = repeat(' ', dpadl - dpadl / 2) elseif a:da ==? 'r' let [dl, dr] = [repeat(' ', dpadl), ''] else call s:exit('Invalid delimiter_align: ' . a:da) endif " Before and after the range (for blockwise visual mode) let cline = getline(line) let before = strpart(cline, 0, a:fc - 1) let after = a:lc ? strpart(cline, a:lc) : '' " Determine the left and right margin around the delimiter let rest = join(tokens[nth + 1 : -1], '') let ml = empty(prefix . token) ? '' : a:ml let mr = (empty(rest) || \ (empty(rest) && stridx(after, a:mr) == 0)) ? '' : a:mr " Adjust indentation of the lines starting with a delimiter let lpad = '' if nth == 0 let ipad = repeat(' ', min_indent - len(token.ml)) if mode ==? 'l' let token = ipad . token else let lpad = ipad endif endif " Align the token let aligned = join([lpad, token, ml, dl, delim, dr, mr, rpad], '') let tokens[nth] = aligned " Update the line let newline = s:rtrim(before.join(tokens, '').after) call setline(line, newline) endfor if a:nth < max.tokens && (a:recur || len(a:modes) > 1) call s:shift(a:modes, a:recur == 2) call s:do_align( \ a:modes, a:all_tokens, a:all_delims, \ a:fl, a:ll, a:fc, a:lc, a:pattern, \ a:nth + 1, a:ml, a:mr, a:da, a:indentation, a:stick_to_left, \ a:ignore_unmatched, a:ignore_groups, a:recur) endif endfunction function! s:input(str, default) redraw call inputsave() let got = input(a:str, a:default) call inputrestore() try return eval(got) catch return got endtry endfunction function! s:interactive(modes) let mode = s:shift(a:modes, 1) let n = '' let ch = '' let opts = {} let vals = deepcopy(s:option_values) while 1 call s:echon(mode, n, '', opts) let c = getchar() let ch = nr2char(c) if c == 3 || c == 27 " CTRL-C / ESC throw 'exit' elseif c == "\" if len(n) > 0 let n = strpart(n, 0, len(n) - 1) endif elseif c == 13 " Enter key let mode = s:shift(a:modes, 1) if has_key(opts, 'm') let opts.m = mode . strpart(opts.m, 1) endif elseif ch == '-' if empty(n) | let n = '-' elseif n == '-' | let n = '' else | break endif elseif ch == '*' if empty(n) | let n = '*' elseif n == '*' | let n = '**' elseif n == '**' | let n = '' else | break endif elseif c >= 48 && c <= 57 " Numbers if n[0] == '*' | break else | let n = n . ch end elseif ch == "\" let opts['da'] = s:shift(vals['delimiter_align'], 1) elseif ch == "\" let opts['idt'] = s:shift(vals['indentation'], 1) elseif ch == "\" let opts['lm'] = s:input("Left margin: ", get(opts, 'lm', '')) elseif ch == "\" let opts['rm'] = s:input("Right margin: ", get(opts, 'rm', '')) elseif ch == "\" let opts['iu'] = s:shift(vals['ignore_unmatched'], 1) elseif ch == "\" let opts['ig'] = s:shift(vals['ignore_groups'], 1) elseif ch == "\" let modes = tolower(s:input("Mode sequence: ", get(opts, 'm', mode))) if match(modes, '^[lrc]\+$') != -1 let opts['m'] = modes let mode = modes[0] while mode != s:shift(a:modes, 1) endwhile else silent! call remove(opts, 'm') endif else break endif endwhile return [mode, n, ch, opts, s:normalize_options(opts)] endfunction function! s:parse_args(args) let n = '' let ch = '' let args = a:args let cand = '' let opts = {} " Poor man's option parser let idx = 0 while 1 let midx = match(args, '\s*{.*}\s*$', idx) if midx == -1 | break | endif let cand = strpart(args, midx) try let [l, r, c, k, s, d, n] = ['l', 'r', 'c', 'k', 's', 'd', 'n'] let [L, R, C, K, S, D, N] = ['l', 'r', 'c', 'k', 's', 'd', 'n'] let o = eval(cand) if type(o) == 4 let opts = o if args[midx - 1 : midx] == '\ ' let midx += 1 endif let args = strpart(args, 0, midx) break endif catch " Ignore endtry let idx = midx + 1 endwhile " Invalid option dictionary if len(substitute(cand, '\s', '', 'g')) > 2 && empty(opts) call s:exit("Invalid option: ". cand) else let opts = s:normalize_options(opts) endif " Has /Regexp/? let matches = matchlist(args, '^\(.\{-}\)\s*/\(.*\)/\s*$') " Found regexp if !empty(matches) let regexp = matches[2] " Test regexp try | call matchlist('', regexp) catch | call s:exit("Invalid regular expression: ". regexp) endtry return [matches[1], regexp, opts, 1] else let tokens = matchlist(args, '^\([1-9][0-9]*\|-[0-9]*\|\*\*\?\)\?\s*\(.\{-}\)\?$') return [tokens[1], tokens[2], opts, 0] endif endfunction function! easy_align#align(bang, expr) range let modes = get(g:, \ (a:bang ? 'easy_align_bang_interactive_modes' : 'easy_align_interactive_modes'), \ (a:bang ? ['r', 'l', 'c'] : ['l', 'r', 'c'])) let mode = modes[0] let recur = 0 let n = '' let ch = '' let opts = {} let ioptsr = {} let iopts = {} let regexp = 0 try if empty(a:expr) let [mode, n, ch, ioptsr, iopts] = s:interactive(copy(modes)) else let [n, ch, opts, regexp] = s:parse_args(a:expr) if empty(n) && empty(ch) let [mode, n, ch, ioptsr, iopts] = s:interactive(copy(modes)) elseif empty(ch) " Try swapping n and ch let [n, ch] = ['', n] endif endif catch 'exit' return endtry if n == '*' | let [nth, recur] = [1, 1] elseif n == '**' | let [nth, recur] = [1, 2] elseif n == '-' | let nth = -1 elseif empty(n) | let nth = 1 elseif n == '0' || ( n != '-0' && n != string(str2nr(n)) ) echon "\rInvalid field number: ". n return else let nth = n endif let delimiters = s:easy_align_delimiters_default if exists('g:easy_align_delimiters') let delimiters = extend(copy(delimiters), g:easy_align_delimiters) endif if regexp let dict = { 'pattern': ch } else " Resolving command-line ambiguity if !empty(a:expr) " '\ ' => ' ' if ch =~ '^\\\s\+$' let ch = ' ' " '\\' => '\' elseif ch =~ '^\\\\\s*$' let ch = '\' endif endif if !has_key(delimiters, ch) echon "\rUnknown delimiter key: ". ch return endif let dict = delimiters[ch] endif for opt in [opts, iopts] if !empty(opt) let dict = extend(copy(dict), opt) endif endfor let ml = get(dict, 'left_margin', ' ') let mr = get(dict, 'right_margin', ' ') if type(ml) == 0 | let ml = repeat(' ', ml) | endif if type(mr) == 0 | let mr = repeat(' ', mr) | endif let bvisual = char2nr(visualmode()) == 22 " ^V if recur && bvisual echon "\rRecursive alignment is currently not supported in blockwise-visual mode" return endif let aseq = get(dict, 'mode_sequence', \ recur == 2 ? (mode ==? 'r' ? ['r', 'l'] : ['l', 'r']) : [mode]) try call s:do_align( \ type(aseq) == 1 ? split(tolower(aseq), '\s*') : map(copy(aseq), 'tolower(v:val)'), \ {}, {}, a:firstline, a:lastline, \ bvisual ? min([col("'<"), col("'>")]) : 1, \ bvisual ? max([col("'<"), col("'>")]) : 0, \ get(dict, 'pattern', ch), \ nth, \ ml, \ mr, \ get(dict, 'delimiter_align', get(g:, 'easy_align_delimiter_align', 'r'))[0], \ get(dict, 'indentation', get(g:, 'easy_align_indentation', 'k'))[0], \ get(dict, 'stick_to_left', 0), \ get(dict, 'ignore_unmatched', get(g:, 'easy_align_ignore_unmatched', 1)), \ get(dict, 'ignore_groups', get(dict, 'ignores', s:ignored_syntax())), \ recur) call s:echon(mode, n, regexp ? '/'.ch.'/' : ch, ioptsr) catch 'exit' endtry endfunction