diff options
Diffstat (limited to 'autoload/vimtex/format.vim')
| -rw-r--r-- | autoload/vimtex/format.vim | 217 |
1 files changed, 217 insertions, 0 deletions
diff --git a/autoload/vimtex/format.vim b/autoload/vimtex/format.vim new file mode 100644 index 00000000..b68aa336 --- /dev/null +++ b/autoload/vimtex/format.vim @@ -0,0 +1,217 @@ +if !exists('g:polyglot_disabled') || index(g:polyglot_disabled, 'latex') == -1 + +" vimtex - LaTeX plugin for Vim +" +" Maintainer: Karl Yngve Lervåg +" Email: karl.yngve@gmail.com +" + +function! vimtex#format#init_buffer() abort " {{{1 + if !g:vimtex_format_enabled | return | endif + + setlocal formatexpr=vimtex#format#formatexpr() +endfunction + +" }}}1 + +function! vimtex#format#formatexpr() abort " {{{1 + if mode() =~# '[iR]' | return -1 | endif + + " Temporary disable folds and save view + let l:save_view = winsaveview() + let l:foldenable = &l:foldenable + setlocal nofoldenable + + let l:top = v:lnum + let l:bottom = v:lnum + v:count - 1 + let l:lines_old = getline(l:top, l:bottom) + let l:tries = 5 + let s:textwidth = &l:textwidth == 0 ? 79 : &l:textwidth + + " This is a hack to make undo restore the correct position + if mode() !=# 'i' + normal! ix + normal! x + endif + + " Main formatting algorithm + while l:tries > 0 + " Format the range of lines + let l:bottom = s:format(l:top, l:bottom) + + " Ensure proper indentation + if l:top < l:bottom + silent! execute printf('normal! %sG=%sG', l:top+1, l:bottom) + endif + + " Check if any lines have changed + let l:lines_new = getline(l:top, l:bottom) + let l:index = s:compare_lines(l:lines_new, l:lines_old) + let l:top += l:index + if l:top > l:bottom | break | endif + let l:lines_old = l:lines_new[l:index : -1] + let l:tries -= 1 + endwhile + + " Restore fold and view + let &l:foldenable = l:foldenable + call winrestview(l:save_view) + + " Set cursor at appropriate position + execute 'normal!' l:bottom . 'G^' + + " Don't change the text if the formatting algorithm failed + if l:tries == 0 + silent! undo + call vimtex#log#warning('Formatting of selected text failed!') + endif +endfunction + +" }}}1 + +function! s:format(top, bottom) abort " {{{1 + let l:bottom = a:bottom + let l:mark = a:bottom + for l:current in range(a:bottom, a:top, -1) + let l:line = getline(l:current) + + if vimtex#util#in_mathzone(l:current, 1) + \ && vimtex#util#in_mathzone(l:current, col([l:current, '$'])) + let l:mark = l:current - 1 + continue + endif + + " Skip all lines with comments + if l:line =~# '\v%(^|[^\\])\%' + if l:current < l:mark + let l:bottom += s:format_build_lines(l:current+1, l:mark) + endif + let l:mark = l:current - 1 + continue + endif + + " Handle long lines + if strdisplaywidth(l:line) > s:textwidth + let l:bottom += s:format_build_lines(l:current, l:mark) + let l:mark = l:current-1 + endif + + if l:line =~# s:border_end + if l:current < l:mark + let l:bottom += s:format_build_lines(l:current+1, l:mark) + endif + let l:mark = l:current + endif + + if l:line =~# s:border_beginning + if l:current < l:mark + let l:bottom += s:format_build_lines(l:current, l:mark) + endif + let l:mark = l:current-1 + endif + + if l:line =~# '^\s*$' + let l:bottom += s:format_build_lines(l:current+1, l:mark) + let l:mark = l:current-1 + endif + endfor + + if a:top <= l:mark + let l:bottom += s:format_build_lines(a:top, l:mark) + endif + + return l:bottom +endfunction + +" }}}1 +function! s:format_build_lines(start, end) abort " {{{1 + " + " Get the desired text to format as a list of words, but preserve the ending + " line spaces + " + let l:text = join(map(getline(a:start, a:end), + \ 'substitute(v:val, ''^\s*'', '''', '''')'), ' ') + let l:spaces = matchstr(l:text, '\s*$') + let l:words = split(l:text, ' ') + if empty(l:words) | return 0 | endif + + " + " Add the words in properly indented and formatted lines + " + let l:lnum = a:start-1 + let l:current = s:get_indents(indent(a:start)) + for l:word in l:words + if strdisplaywidth(l:word) + strdisplaywidth(l:current) > s:textwidth + call append(l:lnum, substitute(l:current, '\s$', '', '')) + let l:lnum += 1 + let l:current = s:get_indents(VimtexIndent(a:start)) + endif + let l:current .= l:word . ' ' + endfor + if l:current !~# '^\s*$' + call append(l:lnum, substitute(l:current, '\s$', '', '')) + let l:lnum += 1 + endif + + " + " Append the ending line spaces + " + if !empty(l:spaces) + call setline(l:lnum, getline(l:lnum) . l:spaces) + endif + + " + " Remove old text + " + silent! execute printf('%s;+%s delete', l:lnum+1, a:end-a:start) + + " + " Return the difference between number of lines of old and new text + " + return l:lnum - a:end +endfunction + +" }}}1 + +function! s:compare_lines(new, old) abort " {{{1 + let l:min_length = min([len(a:new), len(a:old)]) + for l:i in range(l:min_length) + if a:new[l:i] !=# a:old[l:i] + return l:i + endif + endfor + return l:min_length +endfunction + +" }}}1 +function! s:get_indents(number) abort " {{{1 + return !&l:expandtab && &l:shiftwidth == &l:tabstop + \ ? repeat("\t", a:number/&l:tabstop) + \ : repeat(' ', a:number) +endfunction + +" }}}1 + + +" {{{1 Initialize module + +let s:border_beginning = '\v^\s*%(' . join([ + \ '\\item', + \ '\\begin', + \ '\\end', + \ '%(\\\[|\$\$)\s*$', + \], '|') . ')' + +let s:border_end = '\v\\%(' . join([ + \ '\\\*?', + \ 'clear%(double)?page', + \ 'linebreak', + \ 'new%(line|page)', + \ 'pagebreak', + \ '%(begin|end)\{[^}]*\}', + \ ], '|') . ')\s*$' + \ . '|^\s*%(\\\]|\$\$)\s*$' + +" }}}1 + +endif |