From a60e299a3ce55b4a84a48b240d35c84e6e5a8746 Mon Sep 17 00:00:00 2001 From: Adam Stankiewicz Date: Tue, 31 Dec 2019 14:08:15 +0100 Subject: Switch back to plasticboy for markdown --- ftplugin/markdown.vim | 903 +++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 748 insertions(+), 155 deletions(-) (limited to 'ftplugin') diff --git a/ftplugin/markdown.vim b/ftplugin/markdown.vim index 8d327f61..43c9773a 100644 --- a/ftplugin/markdown.vim +++ b/ftplugin/markdown.vim @@ -1,202 +1,795 @@ if !exists('g:polyglot_disabled') || index(g:polyglot_disabled, 'markdown') == -1 -if exists('b:did_ftplugin') | finish | endif - -" {{{ CONFIGURATION - -if !exists('g:markdown_flavor') - let g:markdown_flavor = 'github' -endif - -if !exists('g:markdown_enable_folding') - let g:markdown_enable_folding = 0 -endif - -if !exists('g:markdown_enable_mappings') - " make it compatible with previous configuration value - if exists('g:markdown_include_default_mappings') - let g:markdown_enable_mappings = g:markdown_include_default_mappings - else - let g:markdown_enable_mappings = 1 - endif -endif - -if !exists('g:markdown_enable_insert_mode_mappings') - " make it compatible with previous configuration value - if exists('g:markdown_include_insert_mode_default_mappings') - let g:markdown_enable_insert_mode_mappings = g:markdown_include_insert_mode_default_mappings - else - let g:markdown_enable_insert_mode_mappings = 1 - endif -endif +"TODO print messages when on visual mode. I only see VISUAL, not the messages. + +" Function interface phylosophy: +" +" - functions take arbitrary line numbers as parameters. +" Current cursor line is only a suitable default parameter. +" +" - only functions that bind directly to user actions: +" +" - print error messages. +" All intermediate functions limit themselves return `0` to indicate an error. +" +" - move the cursor. All other functions do not move the cursor. +" +" This is how you should view headers for the header mappings: +" +" |BUFFER +" | +" |Outside any header +" | +" a-+# a +" | +" |Inside a +" | +" a-+ +" b-+## b +" | +" |inside b +" | +" b-+ +" c-+### c +" | +" |Inside c +" | +" c-+ +" d-|# d +" | +" |Inside d +" | +" d-+ +" e-|e +" |==== +" | +" |Inside e +" | +" e-+ + +" For each level, contains the regexp that matches at that level only. +" +let s:levelRegexpDict = { + \ 1: '\v^(#[^#]@=|.+\n\=+$)', + \ 2: '\v^(##[^#]@=|.+\n-+$)', + \ 3: '\v^###[^#]@=', + \ 4: '\v^####[^#]@=', + \ 5: '\v^#####[^#]@=', + \ 6: '\v^######[^#]@=' +\ } + +" Maches any header level of any type. +" +" This could be deduced from `s:levelRegexpDict`, but it is more +" efficient to have a single regexp for this. +" +let s:headersRegexp = '\v^(#|.+\n(\=+|-+)$)' + +" Returns the line number of the first header before `line`, called the +" current header. +" +" If there is no current header, return `0`. +" +" @param a:1 The line to look the header of. Default value: `getpos('.')`. +" +function! s:GetHeaderLineNum(...) + if a:0 == 0 + let l:l = line('.') + else + let l:l = a:1 + endif + while(l:l > 0) + if join(getline(l:l, l:l + 1), "\n") =~ s:headersRegexp + return l:l + endif + let l:l -= 1 + endwhile + return 0 +endfunction -if !exists('g:markdown_enable_insert_mode_leader_mappings') - let g:markdown_enable_insert_mode_leader_mappings = 0 -endif +" - if inside a header goes to it. +" Return its line number. +" +" - if on top level outside any headers, +" print a warning +" Return `0`. +" +function! s:MoveToCurHeader() + let l:lineNum = s:GetHeaderLineNum() + if l:lineNum != 0 + call cursor(l:lineNum, 1) + else + echo 'outside any header' + "normal! gg + endif + return l:lineNum +endfunction -if !exists('g:markdown_drop_empty_blockquotes') - let g:markdown_drop_empty_blockquotes = 0 -endif +" Move cursor to next header of any level. +" +" If there are no more headers, print a warning. +" +function! s:MoveToNextHeader() + if search(s:headersRegexp, 'W') == 0 + "normal! G + echo 'no next header' + endif +endfunction -if !exists('g:markdown_mapping_switch_status') - let g:markdown_mapping_switch_status = '' -endif +" Move cursor to previous header (before current) of any level. +" +" If it does not exist, print a warning. +" +function! s:MoveToPreviousHeader() + let l:curHeaderLineNumber = s:GetHeaderLineNum() + let l:noPreviousHeader = 0 + if l:curHeaderLineNumber <= 1 + let l:noPreviousHeader = 1 + else + let l:previousHeaderLineNumber = s:GetHeaderLineNum(l:curHeaderLineNumber - 1) + if l:previousHeaderLineNumber == 0 + let l:noPreviousHeader = 1 + else + call cursor(l:previousHeaderLineNumber, 1) + endif + endif + if l:noPreviousHeader + echo 'no previous header' + endif +endfunction -if !exists('g:markdown_enable_spell_checking') - let g:markdown_enable_spell_checking = 1 -endif +" - if line is inside a header, return the header level (h1 -> 1, h2 -> 2, etc.). +" +" - if line is at top level outside any headers, return `0`. +" +function! s:GetHeaderLevel(...) + if a:0 == 0 + let l:line = line('.') + else + let l:line = a:1 + endif + let l:linenum = s:GetHeaderLineNum(l:line) + if l:linenum != 0 + return s:GetLevelOfHeaderAtLine(l:linenum) + else + return 0 + endif +endfunction -if !exists('g:markdown_enable_input_abbreviations') - let g:markdown_enable_input_abbreviations = 1 -endif +" Returns the level of the header at the given line. +" +" If there is no header at the given line, returns `0`. +" +function! s:GetLevelOfHeaderAtLine(linenum) + let l:lines = join(getline(a:linenum, a:linenum + 1), "\n") + for l:key in keys(s:levelRegexpDict) + if l:lines =~ get(s:levelRegexpDict, l:key) + return l:key + endif + endfor + return 0 +endfunction -" }}} +" Move cursor to parent header of the current header. +" +" If it does not exit, print a warning and do nothing. +" +function! s:MoveToParentHeader() + let l:linenum = s:GetParentHeaderLineNumber() + if l:linenum != 0 + call cursor(l:linenum, 1) + else + echo 'no parent header' + endif +endfunction +" Return the line number of the parent header of line `line`. +" +" If it has no parent, return `0`. +" +function! s:GetParentHeaderLineNumber(...) + if a:0 == 0 + let l:line = line('.') + else + let l:line = a:1 + endif + let l:level = s:GetHeaderLevel(l:line) + if l:level > 1 + let l:linenum = s:GetPreviousHeaderLineNumberAtLevel(l:level - 1, l:line) + return l:linenum + endif + return 0 +endfunction -" {{{ OPTIONS +" Return the line number of the previous header of given level. +" in relation to line `a:1`. If not given, `a:1 = getline()` +" +" `a:1` line is included, and this may return the current header. +" +" If none return 0. +" +function! s:GetNextHeaderLineNumberAtLevel(level, ...) + if a:0 < 1 + let l:line = line('.') + else + let l:line = a:1 + endif + let l:l = l:line + while(l:l <= line('$')) + if join(getline(l:l, l:l + 1), "\n") =~ get(s:levelRegexpDict, a:level) + return l:l + endif + let l:l += 1 + endwhile + return 0 +endfunction -setlocal textwidth=0 -setlocal ts=2 sw=2 expandtab smarttab -setlocal comments=b:*,b:-,b:+,n:>,se:``` commentstring=>\ %s -setlocal formatoptions=tron -setlocal formatlistpat=^\\s*\\d\\+\\.\\s\\+\\\\|^\\s*[+-\\*]\\s\\+ -setlocal nolisp -setlocal autoindent +" Return the line number of the previous header of given level. +" in relation to line `a:1`. If not given, `a:1 = getline()` +" +" `a:1` line is included, and this may return the current header. +" +" If none return 0. +" +function! s:GetPreviousHeaderLineNumberAtLevel(level, ...) + if a:0 == 0 + let l:line = line('.') + else + let l:line = a:1 + endif + let l:l = l:line + while(l:l > 0) + if join(getline(l:l, l:l + 1), "\n") =~ get(s:levelRegexpDict, a:level) + return l:l + endif + let l:l -= 1 + endwhile + return 0 +endfunction -" Enable spelling and completion based on dictionary words -if &spelllang !~# '^\s*$' && g:markdown_enable_spell_checking - setlocal spell -endif +" Move cursor to next sibling header. +" +" If there is no next siblings, print a warning and don't move. +" +function! s:MoveToNextSiblingHeader() + let l:curHeaderLineNumber = s:GetHeaderLineNum() + let l:curHeaderLevel = s:GetLevelOfHeaderAtLine(l:curHeaderLineNumber) + let l:curHeaderParentLineNumber = s:GetParentHeaderLineNumber() + let l:nextHeaderSameLevelLineNumber = s:GetNextHeaderLineNumberAtLevel(l:curHeaderLevel, l:curHeaderLineNumber + 1) + let l:noNextSibling = 0 + if l:nextHeaderSameLevelLineNumber == 0 + let l:noNextSibling = 1 + else + let l:nextHeaderSameLevelParentLineNumber = s:GetParentHeaderLineNumber(l:nextHeaderSameLevelLineNumber) + if l:curHeaderParentLineNumber == l:nextHeaderSameLevelParentLineNumber + call cursor(l:nextHeaderSameLevelLineNumber, 1) + else + let l:noNextSibling = 1 + endif + endif + if l:noNextSibling + echo 'no next sibling header' + endif +endfunction -" Custom dictionary for emoji -execute 'setlocal dictionary+=' . shellescape(expand(':p:h:h')) . '/dict/emoticons.dict' -setlocal iskeyword+=:,+,- -setlocal complete+=k - -if g:markdown_enable_input_abbreviations - " Replace common ascii emoticons with supported emoji - iabbrev :-) :smile: - iabbrev :-D :laughing: - iabbrev :-( :disappointed: - - " Replace common punctuation - iabbrev ... … - iabbrev << « - iabbrev >> » -endif +" Move cursor to previous sibling header. +" +" If there is no previous siblings, print a warning and do nothing. +" +function! s:MoveToPreviousSiblingHeader() + let l:curHeaderLineNumber = s:GetHeaderLineNum() + let l:curHeaderLevel = s:GetLevelOfHeaderAtLine(l:curHeaderLineNumber) + let l:curHeaderParentLineNumber = s:GetParentHeaderLineNumber() + let l:previousHeaderSameLevelLineNumber = s:GetPreviousHeaderLineNumberAtLevel(l:curHeaderLevel, l:curHeaderLineNumber - 1) + let l:noPreviousSibling = 0 + if l:previousHeaderSameLevelLineNumber == 0 + let l:noPreviousSibling = 1 + else + let l:previousHeaderSameLevelParentLineNumber = s:GetParentHeaderLineNumber(l:previousHeaderSameLevelLineNumber) + if l:curHeaderParentLineNumber == l:previousHeaderSameLevelParentLineNumber + call cursor(l:previousHeaderSameLevelLineNumber, 1) + else + let l:noPreviousSibling = 1 + endif + endif + if l:noPreviousSibling + echo 'no previous sibling header' + endif +endfunction -" Folding -if g:markdown_enable_folding - setlocal foldmethod=expr - setlocal foldexpr=markdown#FoldLevelOfLine(v:lnum) -endif +function! s:Toc(...) + if a:0 > 0 + let l:window_type = a:1 + else + let l:window_type = 'vertical' + endif -" }}} + let l:bufnr = bufnr('%') + let l:cursor_line = line('.') + let l:cursor_header = 0 + let l:fenced_block = 0 + let l:front_matter = 0 + let l:header_list = [] + let l:header_max_len = 0 + let l:vim_markdown_toc_autofit = get(g:, "vim_markdown_toc_autofit", 0) + let l:vim_markdown_frontmatter = get(g:, "vim_markdown_frontmatter", 0) + for i in range(1, line('$')) + let l:lineraw = getline(i) + let l:l1 = getline(i+1) + let l:line = substitute(l:lineraw, "#", "\\\#", "g") + if l:line =~ '````*' || l:line =~ '\~\~\~\~*' + if l:fenced_block == 0 + let l:fenced_block = 1 + elseif l:fenced_block == 1 + let l:fenced_block = 0 + endif + elseif l:vim_markdown_frontmatter == 1 + if l:front_matter == 1 + if l:line == '---' + let l:front_matter = 0 + endif + elseif i == 1 + if l:line == '---' + let l:front_matter = 1 + endif + endif + endif + if l:line =~ '^#\+' || (l:l1 =~ '^=\+\s*$' || l:l1 =~ '^-\+\s*$') && l:line =~ '^\S' + let l:is_header = 1 + else + let l:is_header = 0 + endif + if l:is_header == 1 && l:fenced_block == 0 && l:front_matter == 0 + " append line to location list + let l:item = {'lnum': i, 'text': l:line, 'valid': 1, 'bufnr': l:bufnr, 'col': 1} + let l:header_list = l:header_list + [l:item] + " set header number of the cursor position + if l:cursor_header == 0 + if i == l:cursor_line + let l:cursor_header = len(l:header_list) + elseif i > l:cursor_line + let l:cursor_header = len(l:header_list) - 1 + endif + endif + " keep track of the longest header size (heading level + title) + let l:total_len = stridx(l:line, ' ') + strdisplaywidth(l:line) + if l:total_len > l:header_max_len + let l:header_max_len = l:total_len + endif + endif + endfor + call setloclist(0, l:header_list) + if len(l:header_list) == 0 + echom "Toc: No headers." + return + endif -" {{{ FUNCTIONS + if l:window_type ==# 'horizontal' + lopen + elseif l:window_type ==# 'vertical' + vertical lopen + " auto-fit toc window when possible to shrink it + if (&columns/2) > l:header_max_len && l:vim_markdown_toc_autofit == 1 + execute 'vertical resize ' . (l:header_max_len + 1) + else + execute 'vertical resize ' . (&columns/2) + endif + elseif l:window_type ==# 'tab' + tab lopen + else + lopen + endif + setlocal modifiable + for i in range(1, line('$')) + " this is the location-list data for the current item + let d = getloclist(0)[i-1] + " atx headers + if match(d.text, "^#") > -1 + let l:level = len(matchstr(d.text, '#*', 'g'))-1 + let d.text = substitute(d.text, '\v^#*[ ]*', '', '') + let d.text = substitute(d.text, '\v[ ]*#*$', '', '') + " setex headers + else + let l:next_line = getbufline(d.bufnr, d.lnum+1) + if match(l:next_line, "=") > -1 + let l:level = 0 + elseif match(l:next_line, "-") > -1 + let l:level = 1 + endif + endif + call setline(i, repeat(' ', l:level). d.text) + endfor + setlocal nomodified + setlocal nomodifiable + execute 'normal! ' . l:cursor_header . 'G' +endfunction -function! s:JumpToHeader(forward, visual) - let cnt = v:count1 - let save = @/ - let pattern = '\v^#{1,6}.*$|^.+\n%(\-+|\=+)$' - if a:visual - normal! gv - endif - if a:forward - let motion = '/' . pattern - else - let motion = '?' . pattern - endif - while cnt > 0 - silent! execute motion - let cnt = cnt - 1 - endwhile - call histdel('/', -1) - let @/ = save +" Convert Setex headers in range `line1 .. line2` to Atx. +" +" Return the number of conversions. +" +function! s:SetexToAtx(line1, line2) + let l:originalNumLines = line('$') + execute 'silent! ' . a:line1 . ',' . a:line2 . 'substitute/\v(.*\S.*)\n\=+$/# \1/' + execute 'silent! ' . a:line1 . ',' . a:line2 . 'substitute/\v(.*\S.*)\n-+$/## \1/' + return l:originalNumLines - line('$') endfunction -function! s:Indent(indent) - if getline('.') =~ '\v^\s*%([-*+]|\d\.)\s*$' - if a:indent - normal >> +" If `a:1` is 0, decrease the level of all headers in range `line1 .. line2`. +" +" Otherwise, increase the level. `a:1` defaults to `0`. +" +function! s:HeaderDecrease(line1, line2, ...) + if a:0 > 0 + let l:increase = a:1 else - normal << + let l:increase = 0 endif - call setline('.', substitute(getline('.'), '\([-*+]\|\d\.\)\s*$', '\1 ', '')) - normal $ - elseif getline('.') =~ '\v^\s*(\s?\>)+\s*$' - if a:indent - call setline('.', substitute(getline('.'), '>\s*$', '>> ', '')) + if l:increase + let l:forbiddenLevel = 6 + let l:replaceLevels = [5, 1] + let l:levelDelta = 1 else - call setline('.', substitute(getline('.'), '\s*>\s*$', ' ', '')) - call setline('.', substitute(getline('.'), '^\s\+$', '', '')) + let l:forbiddenLevel = 1 + let l:replaceLevels = [2, 6] + let l:levelDelta = -1 endif - normal $ - endif + for l:line in range(a:line1, a:line2) + if join(getline(l:line, l:line + 1), "\n") =~ s:levelRegexpDict[l:forbiddenLevel] + echomsg 'There is an h' . l:forbiddenLevel . ' at line ' . l:line . '. Aborting.' + return + endif + endfor + let l:numSubstitutions = s:SetexToAtx(a:line1, a:line2) + let l:flags = (&gdefault ? '' : 'g') + for l:level in range(replaceLevels[0], replaceLevels[1], -l:levelDelta) + execute 'silent! ' . a:line1 . ',' . (a:line2 - l:numSubstitutions) . 'substitute/' . s:levelRegexpDict[l:level] . '/' . repeat('#', l:level + l:levelDelta) . '/' . l:flags + endfor +endfunction + +" Format table under cursor. +" +" Depends on Tabularize. +" +function! s:TableFormat() + let l:pos = getpos('.') + normal! { + " Search instead of `normal! j` because of the table at beginning of file edge case. + call search('|') + normal! j + " Remove everything that is not a pipe, colon or hyphen next to a colon othewise + " well formated tables would grow because of addition of 2 spaces on the separator + " line by Tabularize /|. + let l:flags = (&gdefault ? '' : 'g') + execute 's/\(:\@)+\s*$' +" Map in both normal and visual modes. +" +function! s:MapNormVis(rhs,lhs) + execute 'nn ' . a:rhs . ' :call ' . a:lhs . '()' + execute 'vn ' . a:rhs . ' :call VisMove(''' . a:lhs . ''')' endfunction -" }}} +" Parameters: +" +" - step +1 for right, -1 for left +" +" TODO: multiple lines. +" +function! s:FindCornerOfSyntax(lnum, col, step) + let l:col = a:col + let l:syn = synIDattr(synID(a:lnum, l:col, 1), 'name') + while synIDattr(synID(a:lnum, l:col, 1), 'name') ==# l:syn + let l:col += a:step + endwhile + return l:col - a:step +endfunction + +" Return the next position of the given syntax name, +" inclusive on the given position. +" +" TODO: multiple lines +" +function! s:FindNextSyntax(lnum, col, name) + let l:col = a:col + let l:step = 1 + while synIDattr(synID(a:lnum, l:col, 1), 'name') !=# a:name + let l:col += l:step + endwhile + return [a:lnum, l:col] +endfunction +function! s:FindCornersOfSyntax(lnum, col) + return [FindLeftOfSyntax(a:lnum, a:col), FindRightOfSyntax(a:lnum, a:col)] +endfunction -" {{{ MAPPINGS +function! s:FindRightOfSyntax(lnum, col) + return FindCornerOfSyntax(a:lnum, a:col, 1) +endfunction -" Commands -command! -nargs=0 -range MarkdownEditBlock :,call markdown#EditBlock() +function! s:FindLeftOfSyntax(lnum, col) + return FindCornerOfSyntax(a:lnum, a:col, -1) +endfunction -if g:markdown_enable_mappings - " Jumping around - noremap