X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/8c609c8af79d81b34cb139c44017e6d881696d85..44ac1f42e98063e8148d1a67ed22dca86af79380:/ftplugin/mkd.vim diff --git a/ftplugin/mkd.vim b/ftplugin/mkd.vim index 0627cc5..d67864a 100644 --- a/ftplugin/mkd.vim +++ b/ftplugin/mkd.vim @@ -12,7 +12,7 @@ " " - move the cursor. All other functions do not move the cursor. " -" This is how you should view headers: +" This is how you should view headers for the header mappings: " " |BUFFER " | @@ -46,13 +46,14 @@ " e-+ " For each level, contains the regexp that matches at that level only. +" let s:levelRegexpDict = { - \ 1: '\v^(\s*#[^#]|.+\n\=+$)', - \ 2: '\v^(\s*##[^#]|.+\n-+$)', - \ 3: '\v^\s*###[^#]', - \ 4: '\v^\s*####[^#]', - \ 5: '\v^\s*#####[^#]', - \ 6: '\v^\s*######[^#]' + \ 1: '\v^(#[^#]@=|.+\n\=+$)', + \ 2: '\v^(##[^#]@=|.+\n-+$)', + \ 3: '\v^###[^#]@=', + \ 4: '\v^####[^#]@=', + \ 5: '\v^#####[^#]@=', + \ 6: '\v^######[^#]@=' \ } " Maches any header level of any type. @@ -60,7 +61,7 @@ let s:levelRegexpDict = { " This could be deduced from `s:levelRegexpDict`, but it is more " efficient to have a single regexp for this. " -let s:headersRegexp = '\v^(\s*#|.+\n(\=+|-+)$)' +let s:headersRegexp = '\v^(#|.+\n(\=+|-+)$)' " Returns the line number of the first header before `line`, called the " current header. @@ -69,7 +70,7 @@ let s:headersRegexp = '\v^(\s*#|.+\n(\=+|-+)$)' " " @param a:1 The line to look the header of. Default value: `getpos('.')`. " -function! b:Markdown_GetHeaderLineNum(...) +function! s:GetHeaderLineNum(...) if a:0 == 0 let l:l = line('.') else @@ -84,15 +85,15 @@ function! b:Markdown_GetHeaderLineNum(...) return 0 endfunction -" - if inside a header goes to it. +" - if inside a header goes to it. " Return its line number. " -" - if on top level outside any headers, +" - if on top level outside any headers, " print a warning " Return `0`. " -function! b:Markdown_MoveToCurHeader() - let l:lineNum = b:Markdown_GetHeaderLineNum() +function! s:MoveToCurHeader() + let l:lineNum = s:GetHeaderLineNum() if l:lineNum != 0 call cursor(l:lineNum, 1) else @@ -106,7 +107,7 @@ endfunction " " If there are no more headers, print a warning. " -function! b:Markdown_MoveToNextHeader() +function! s:MoveToNextHeader() if search(s:headersRegexp, 'W') == 0 "normal! G echo 'no next header' @@ -117,13 +118,13 @@ endfunction " " If it does not exist, print a warning. " -function! b:Markdown_MoveToPreviousHeader() - let l:curHeaderLineNumber = b:Markdown_GetHeaderLineNum() +function! s:MoveToPreviousHeader() + let l:curHeaderLineNumber = s:GetHeaderLineNum() let l:noPreviousHeader = 0 if l:curHeaderLineNumber <= 1 let l:noPreviousHeader = 1 else - let l:previousHeaderLineNumber = b:Markdown_GetHeaderLineNum(l:curHeaderLineNumber - 1) + let l:previousHeaderLineNumber = s:GetHeaderLineNum(l:curHeaderLineNumber - 1) if l:previousHeaderLineNumber == 0 let l:noPreviousHeader = 1 else @@ -139,15 +140,15 @@ endfunction " " - if line is at top level outside any headers, return `0`. " -function! b:Markdown_GetHeaderLevel(...) +function! s:GetHeaderLevel(...) if a:0 == 0 let l:line = line('.') else let l:line = a:1 endif - let l:linenum = b:Markdown_GetHeaderLineNum(l:line) + let l:linenum = s:GetHeaderLineNum(l:line) if l:linenum != 0 - return b:Markdown_GetLevelOfHeaderAtLine(l:linenum) + return s:GetLevelOfHeaderAtLine(l:linenum) else return 0 endif @@ -157,7 +158,7 @@ endfunction " " If there is no header at the given line, returns `0`. " -function! b:Markdown_GetLevelOfHeaderAtLine(linenum) +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) @@ -171,8 +172,8 @@ endfunction " " If it does not exit, print a warning and do nothing. " -function! b:Markdown_MoveToParentHeader() - let l:linenum = b:Markdown_GetParentHeaderLineNumber() +function! s:MoveToParentHeader() + let l:linenum = s:GetParentHeaderLineNumber() if l:linenum != 0 call cursor(l:linenum, 1) else @@ -184,15 +185,15 @@ endfunction " " If it has no parent, return `0`. " -function! b:Markdown_GetParentHeaderLineNumber(...) +function! s:GetParentHeaderLineNumber(...) if a:0 == 0 let l:line = line('.') else let l:line = a:1 endif - let l:level = b:Markdown_GetHeaderLevel(l:line) + let l:level = s:GetHeaderLevel(l:line) if l:level > 1 - let l:linenum = b:Markdown_GetPreviousHeaderLineNumberAtLevel(l:level - 1, l:line) + let l:linenum = s:GetPreviousHeaderLineNumberAtLevel(l:level - 1, l:line) return l:linenum endif return 0 @@ -205,7 +206,7 @@ endfunction " " If none return 0. " -function! b:Markdown_GetNextHeaderLineNumberAtLevel(level, ...) +function! s:GetNextHeaderLineNumberAtLevel(level, ...) if a:0 < 1 let l:line = line('.') else @@ -228,7 +229,7 @@ endfunction " " If none return 0. " -function! b:Markdown_GetPreviousHeaderLineNumberAtLevel(level, ...) +function! s:GetPreviousHeaderLineNumberAtLevel(level, ...) if a:0 == 0 let l:line = line('.') else @@ -248,16 +249,16 @@ endfunction " " If there is no next siblings, print a warning and don't move. " -function! b:Markdown_MoveToNextSiblingHeader() - let l:curHeaderLineNumber = b:Markdown_GetHeaderLineNum() - let l:curHeaderLevel = b:Markdown_GetLevelOfHeaderAtLine(l:curHeaderLineNumber) - let l:curHeaderParentLineNumber = b:Markdown_GetParentHeaderLineNumber() - let l:nextHeaderSameLevelLineNumber = b:Markdown_GetNextHeaderLineNumberAtLevel(l:curHeaderLevel, l:curHeaderLineNumber + 1) +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 = b:Markdown_GetParentHeaderLineNumber(l:nextHeaderSameLevelLineNumber) + let l:nextHeaderSameLevelParentLineNumber = s:GetParentHeaderLineNumber(l:nextHeaderSameLevelLineNumber) if l:curHeaderParentLineNumber == l:nextHeaderSameLevelParentLineNumber call cursor(l:nextHeaderSameLevelLineNumber, 1) else @@ -273,16 +274,16 @@ endfunction " " If there is no previous siblings, print a warning and do nothing. " -function! b:Markdown_MoveToPreviousSiblingHeader() - let l:curHeaderLineNumber = b:Markdown_GetHeaderLineNum() - let l:curHeaderLevel = b:Markdown_GetLevelOfHeaderAtLine(l:curHeaderLineNumber) - let l:curHeaderParentLineNumber = b:Markdown_GetParentHeaderLineNumber() - let l:previousHeaderSameLevelLineNumber = b:Markdown_GetPreviousHeaderLineNumberAtLevel(l:curHeaderLevel, l:curHeaderLineNumber - 1) +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 = b:Markdown_GetParentHeaderLineNumber(l:previousHeaderSameLevelLineNumber) + let l:previousHeaderSameLevelParentLineNumber = s:GetParentHeaderLineNumber(l:previousHeaderSameLevelLineNumber) if l:curHeaderParentLineNumber == l:previousHeaderSameLevelParentLineNumber call cursor(l:previousHeaderSameLevelLineNumber, 1) else @@ -294,6 +295,115 @@ function! b:Markdown_MoveToPreviousSiblingHeader() endif endfunction +function! s:Toc(...) + if a:0 > 0 + let l:window_type = a:1 + else + let l:window_type = 'vertical' + endif + + try + silent lvimgrep /\(^\S.*\(\n[=-]\+\n\)\@=\|^#\+\)/ % + catch /E480/ + echom "Toc: No headers." + return + endtry + + if l:window_type ==# 'horizontal' + lopen + elseif l:window_type ==# 'vertical' + vertical lopen + let &winwidth=(&columns/2) + 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(bufname(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 + normal! gg +endfunction + +" 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 + +" 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 + let l:increase = 0 + endif + if l:increase + let l:forbiddenLevel = 6 + let l:replaceLevels = [5, 1] + let l:levelDelta = 1 + else + let l:forbiddenLevel = 1 + let l:replaceLevels = [2, 6] + let l:levelDelta = -1 + 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) + 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) . '/g' + 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 othewise well formated tables would grow + " because of addition of 2 spaces on the separator line by Tabularize /|. + s/[^|]//g + Tabularize /| + s/ /-/g + call setpos('.', l:pos) +endfunction + " Wrapper to do move commands in visual mode. " function! s:VisMove(f) @@ -308,29 +418,128 @@ function! s:MapNormVis(rhs,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 -call MapNormVis('(Markdown_MoveToNextHeader)', 'b:Markdown_MoveToNextHeader') -call MapNormVis('(Markdown_MoveToPreviousHeader)', 'b:Markdown_MoveToPreviousHeader') -call MapNormVis('(Markdown_MoveToNextSiblingHeader)', 'b:Markdown_MoveToNextSiblingHeader') -call MapNormVis('(Markdown_MoveToPreviousSiblingHeader)', 'b:Markdown_MoveToPreviousSiblingHeader') -" Menmonic: Up -call MapNormVis('(Markdown_MoveToParentHeader)', 'b:Markdown_MoveToParentHeader') -" Menmonic: Current -call MapNormVis('(Markdown_MoveToCurHeader)', 'b:Markdown_MoveToCurHeader') - -if ! exists('g:markdown_no_default_key_mappings') -\ || !g:markdown_no_default_key_mappings - nmap ]] (Markdown_MoveToNextHeader) - nmap [[ (Markdown_MoveToPreviousHeader) - nmap ][ (Markdown_MoveToNextSiblingHeader) - nmap [] (Markdown_MoveToPreviousSiblingHeader) - nmap ]u (Markdown_MoveToParentHeader) - nmap ]c (Markdown_MoveToCurHeader) - - vmap ]] (Markdown_MoveToNextHeader) - vmap [[ (Markdown_MoveToPreviousHeader) - vmap ][ (Markdown_MoveToNextSiblingHeader) - vmap [] (Markdown_MoveToPreviousSiblingHeader) - vmap ]u (Markdown_MoveToParentHeader) - vmap ]c (Markdown_MoveToCurHeader) +" 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 + +function! s:FindRightOfSyntax(lnum, col) + return FindCornerOfSyntax(a:lnum, a:col, 1) +endfunction + +function! s:FindLeftOfSyntax(lnum, col) + return FindCornerOfSyntax(a:lnum, a:col, -1) +endfunction + +" Returns: +" +" - a string with the the URL for the link under the cursor +" - an empty string if the cursor is not on a link +" +" TODO +" +" - multiline support +" - give an error if the separator does is not on a link +" +function! s:Markdown_GetUrlForPosition(lnum, col) + let l:lnum = a:lnum + let l:col = a:col + let l:syn = synIDattr(synID(l:lnum, l:col, 1), 'name') + + if l:syn ==# 'mkdInlineURL' || l:syn ==# 'mkdURL' || l:syn ==# 'mkdLinkDefTarget' + " Do nothing. + elseif l:syn ==# 'mkdLink' + let [l:lnum, l:col] = FindNextSyntax(l:lnum, l:col, 'mkdURL') + let l:syn = 'mkdURL' + elseif l:syn ==# 'mkdDelimiter' + let l:line = getline(l:lnum) + let l:char = l:line[col - 1] + if l:char ==# '<' + let l:col += 1 + elseif l:char ==# '>' || l:char ==# ')' + let l:col -= 1 + elseif l:char ==# '[' || l:char ==# ']' || l:char ==# '(' + let [l:lnum, l:col] = FindNextSyntax(l:lnum, l:col, 'mkdURL') + else + return '' + endif + else + return '' + endif + + let [l:left, l:right] = FindCornersOfSyntax(l:lnum, l:col) + return getline(l:lnum)[l:left - 1 : l:right - 1] +endfunction + +" Front end for GetUrlForPosition. +" +function! s:OpenUrlUnderCursor() + let l:url = s:Markdown_GetUrlForPosition(line('.'), col('.')) + if l:url != '' + call netrw#NetrwBrowseX(l:url, 0) + else + echomsg 'The cursor is not on a link.' + endif +endfunction + +function! s:MapNotHasmapto(lhs, rhs) + if !hasmapto('' . a:rhs) + execute 'nmap ' . a:lhs . ' ' . a:rhs + execute 'vmap ' . a:lhs . ' ' . a:rhs + endif +endfunction + +call MapNormVis('Markdown_MoveToNextHeader', 'MoveToNextHeader') +call MapNormVis('Markdown_MoveToPreviousHeader', 'MoveToPreviousHeader') +call MapNormVis('Markdown_MoveToNextSiblingHeader', 'MoveToNextSiblingHeader') +call MapNormVis('Markdown_MoveToPreviousSiblingHeader', 'MoveToPreviousSiblingHeader') +call MapNormVis('Markdown_MoveToParentHeader', 'MoveToParentHeader') +call MapNormVis('Markdown_MoveToCurHeader', 'MoveToCurHeader') +nnoremap Markdown_OpenUrlUnderCursor :call OpenUrlUnderCursor() + +if !get(g:, 'vim_markdown_no_default_key_mappings', 0) + call MapNotHasmapto(']]', 'Markdown_MoveToNextHeader') + call MapNotHasmapto('[[', 'Markdown_MoveToPreviousHeader') + call MapNotHasmapto('][', 'Markdown_MoveToNextSiblingHeader') + call MapNotHasmapto('[]', 'Markdown_MoveToPreviousSiblingHeader') + call MapNotHasmapto(']u', 'Markdown_MoveToParentHeader') + call MapNotHasmapto(']c', 'Markdown_MoveToCurHeader') + call MapNotHasmapto('gx', 'Markdown_OpenUrlUnderCursor') endif + +command! -buffer -range=% HeaderDecrease call s:HeaderDecrease(, ) +command! -buffer -range=% HeaderIncrease call s:HeaderDecrease(, , 1) +command! -buffer -range=% SetexToAtx call s:SetexToAtx(, ) +command! -buffer TableFormat call s:TableFormat() +command! -buffer Toc call s:Toc() +command! -buffer Toch call s:Toc('horizontal') +command! -buffer Tocv call s:Toc('vertical') +command! -buffer Toct call s:Toc('tab')