]> git.madduck.net Git - etc/vim.git/blobdiff - ftplugin/mkd.vim

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Merge pull request #88 from cirosantilli/change-header-level
[etc/vim.git] / ftplugin / mkd.vim
index 07f81db54e31d95d4d64944791f286d1609fac1e..21292030079543fc33f55e0f5bdf5158bd426f61 100644 (file)
 
 " 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 +60,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 +69,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:Markdown_GetHeaderLineNum(...)
     if a:0 == 0
         let l:l = line('.')
     else
@@ -91,8 +91,8 @@ endfunction
 "    print a warning
 "    Return `0`.
 "
-function! b:Markdown_MoveToCurHeader()
-    let l:lineNum = b:Markdown_GetHeaderLineNum()
+function! s:Markdown_MoveToCurHeader()
+    let l:lineNum = s:Markdown_GetHeaderLineNum()
     if l:lineNum != 0
         call cursor(l:lineNum, 1)
     else
@@ -106,7 +106,7 @@ endfunction
 "
 " If there are no more headers, print a warning.
 "
-function! b:Markdown_MoveToNextHeader()
+function! s:Markdown_MoveToNextHeader()
     if search(s:headersRegexp, 'W') == 0
         "normal! G
         echo 'no next header'
@@ -117,13 +117,13 @@ endfunction
 "
 " If it does not exist, print a warning.
 "
-function! b:Markdown_MoveToPreviousHeader()
-    let l:curHeaderLineNumber = b:Markdown_GetHeaderLineNum()
+function! s:Markdown_MoveToPreviousHeader()
+    let l:curHeaderLineNumber = s:Markdown_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:Markdown_GetHeaderLineNum(l:curHeaderLineNumber - 1)
         if l:previousHeaderLineNumber == 0
             let l:noPreviousHeader = 1
         else
@@ -139,15 +139,15 @@ endfunction
 "
 " - if line is at top level outside any headers, return `0`.
 "
-function! b:Markdown_GetHeaderLevel(...)
+function! s:Markdown_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:Markdown_GetHeaderLineNum(l:line)
     if l:linenum != 0
-        return b:Markdown_GetLevelOfHeaderAtLine(l:linenum)
+        return s:Markdown_GetLevelOfHeaderAtLine(l:linenum)
     else
         return 0
     endif
@@ -157,7 +157,7 @@ endfunction
 "
 " If there is no header at the given line, returns `0`.
 "
-function! b:Markdown_GetLevelOfHeaderAtLine(linenum)
+function! s:Markdown_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 +171,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:Markdown_MoveToParentHeader()
+    let l:linenum = s:Markdown_GetParentHeaderLineNumber()
     if l:linenum != 0
         call cursor(l:linenum, 1)
     else
@@ -184,15 +184,15 @@ endfunction
 "
 " If it has no parent, return `0`.
 "
-function! b:Markdown_GetParentHeaderLineNumber(...)
+function! s:Markdown_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:Markdown_GetHeaderLevel(l:line)
     if l:level > 1
-        let l:linenum = b:Markdown_GetPreviousHeaderLineNumberAtLevel(l:level - 1, l:line)
+        let l:linenum = s:Markdown_GetPreviousHeaderLineNumberAtLevel(l:level - 1, l:line)
         return l:linenum
     endif
     return 0
@@ -205,7 +205,7 @@ endfunction
 "
 " If none return 0.
 "
-function! b:Markdown_GetNextHeaderLineNumberAtLevel(level, ...)
+function! s:Markdown_GetNextHeaderLineNumberAtLevel(level, ...)
     if a:0 < 1
         let l:line = line('.')
     else
@@ -228,7 +228,7 @@ endfunction
 "
 " If none return 0.
 "
-function! b:Markdown_GetPreviousHeaderLineNumberAtLevel(level, ...)
+function! s:Markdown_GetPreviousHeaderLineNumberAtLevel(level, ...)
     if a:0 == 0
         let l:line = line('.')
     else
@@ -248,16 +248,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:Markdown_MoveToNextSiblingHeader()
+    let l:curHeaderLineNumber = s:Markdown_GetHeaderLineNum()
+    let l:curHeaderLevel = s:Markdown_GetLevelOfHeaderAtLine(l:curHeaderLineNumber)
+    let l:curHeaderParentLineNumber = s:Markdown_GetParentHeaderLineNumber()
+    let l:nextHeaderSameLevelLineNumber = s:Markdown_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:Markdown_GetParentHeaderLineNumber(l:nextHeaderSameLevelLineNumber)
         if l:curHeaderParentLineNumber == l:nextHeaderSameLevelParentLineNumber
             call cursor(l:nextHeaderSameLevelLineNumber, 1)
         else
@@ -273,16 +273,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:Markdown_MoveToPreviousSiblingHeader()
+    let l:curHeaderLineNumber = s:Markdown_GetHeaderLineNum()
+    let l:curHeaderLevel = s:Markdown_GetLevelOfHeaderAtLine(l:curHeaderLineNumber)
+    let l:curHeaderParentLineNumber = s:Markdown_GetParentHeaderLineNumber()
+    let l:previousHeaderSameLevelLineNumber = s:Markdown_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:Markdown_GetParentHeaderLineNumber(l:previousHeaderSameLevelLineNumber)
         if l:curHeaderParentLineNumber == l:previousHeaderSameLevelParentLineNumber
             call cursor(l:previousHeaderSameLevelLineNumber, 1)
         else
@@ -294,13 +294,20 @@ function! b:Markdown_MoveToPreviousSiblingHeader()
     endif
 endfunction
 
-function! b:Markdown_Toc(...)
+function! s:Markdown_Toc(...)
     if a:0 > 0
         let l:window_type = a:1
     else
         let l:window_type = 'vertical'
     endif
-    silent vimgrep '^#' %
+
+    try
+        silent vimgrep /\(^\S.*\(\n[=-]\+\)\@=\|^#\+\)/ %
+    catch /E480/
+        echom "Toc: No headers."
+        return
+    endtry
+
     if l:window_type ==# 'horizontal'
         copen
     elseif l:window_type ==# 'vertical'
@@ -314,13 +321,23 @@ function! b:Markdown_Toc(...)
     set modifiable
     %s/\v^([^|]*\|){2,2} #//
     for i in range(1, line('$'))
-        let l:line = getline(i)
-        let l:header =  matchstr(l:line, '^#*')
-        let l:length = len(l:header)
-        let l:line = substitute(l:line, '\v^#*[ ]*', '', '')
-        let l:line = substitute(l:line, '\v[ ]*#*$', '', '')
-        let l:line = repeat(' ', (2 * l:length)) . l:line
-        call setline(i, l:line)
+        " this is the quickfix data for the current item
+        let d = getqflist()[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
     set nomodified
     set nomodifiable
@@ -341,34 +358,73 @@ function! s:MapNormVis(rhs,lhs)
     execute 'vn <buffer><silent> ' . a:rhs . ' <esc>:call <sid>VisMove(''' . a:lhs . ''')<cr>'
 endfunction
 
+" Convert Setex headers in range `line1 .. line2` to Atx.
+" Returns 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) . '\1/g'
+    endfor
+endfunction
 
-call <sid>MapNormVis('<Plug>(Markdown_MoveToNextHeader)', 'b:Markdown_MoveToNextHeader')
-call <sid>MapNormVis('<Plug>(Markdown_MoveToPreviousHeader)', 'b:Markdown_MoveToPreviousHeader')
-call <sid>MapNormVis('<Plug>(Markdown_MoveToNextSiblingHeader)', 'b:Markdown_MoveToNextSiblingHeader')
-call <sid>MapNormVis('<Plug>(Markdown_MoveToPreviousSiblingHeader)', 'b:Markdown_MoveToPreviousSiblingHeader')
+call <sid>MapNormVis('<Plug>(Markdown_MoveToNextHeader)', '<sid>Markdown_MoveToNextHeader')
+call <sid>MapNormVis('<Plug>(Markdown_MoveToPreviousHeader)', '<sid>Markdown_MoveToPreviousHeader')
+call <sid>MapNormVis('<Plug>(Markdown_MoveToNextSiblingHeader)', '<sid>Markdown_MoveToNextSiblingHeader')
+call <sid>MapNormVis('<Plug>(Markdown_MoveToPreviousSiblingHeader)', '<sid>Markdown_MoveToPreviousSiblingHeader')
 " Menmonic: Up
-call <sid>MapNormVis('<Plug>(Markdown_MoveToParentHeader)', 'b:Markdown_MoveToParentHeader')
+call <sid>MapNormVis('<Plug>(Markdown_MoveToParentHeader)', '<sid>Markdown_MoveToParentHeader')
 " Menmonic: Current
-call <sid>MapNormVis('<Plug>(Markdown_MoveToCurHeader)', 'b:Markdown_MoveToCurHeader')
+call <sid>MapNormVis('<Plug>(Markdown_MoveToCurHeader)', '<sid>Markdown_MoveToCurHeader')
 
-if ! exists('g:vim_markdown_no_default_key_mappings')
-\ || !g:vim_markdown_no_default_key_mappings
-    nmap ]] <Plug>(Markdown_MoveToNextHeader)
-    nmap [[ <Plug>(Markdown_MoveToPreviousHeader)
-    nmap ][ <Plug>(Markdown_MoveToNextSiblingHeader)
-    nmap [] <Plug>(Markdown_MoveToPreviousSiblingHeader)
-    nmap ]u <Plug>(Markdown_MoveToParentHeader)
-    nmap ]c <Plug>(Markdown_MoveToCurHeader)
+if !get(g:, 'vim_markdown_no_default_key_mappings', 0)
+    nmap <buffer> ]] <Plug>(Markdown_MoveToNextHeader)
+    nmap <buffer> [[ <Plug>(Markdown_MoveToPreviousHeader)
+    nmap <buffer> ][ <Plug>(Markdown_MoveToNextSiblingHeader)
+    nmap <buffer> [] <Plug>(Markdown_MoveToPreviousSiblingHeader)
+    nmap <buffer> ]u <Plug>(Markdown_MoveToParentHeader)
+    nmap <buffer> ]c <Plug>(Markdown_MoveToCurHeader)
 
-    vmap ]] <Plug>(Markdown_MoveToNextHeader)
-    vmap [[ <Plug>(Markdown_MoveToPreviousHeader)
-    vmap ][ <Plug>(Markdown_MoveToNextSiblingHeader)
-    vmap [] <Plug>(Markdown_MoveToPreviousSiblingHeader)
-    vmap ]u <Plug>(Markdown_MoveToParentHeader)
-    vmap ]c <Plug>(Markdown_MoveToCurHeader)
+    vmap <buffer> ]] <Plug>(Markdown_MoveToNextHeader)
+    vmap <buffer> [[ <Plug>(Markdown_MoveToPreviousHeader)
+    vmap <buffer> ][ <Plug>(Markdown_MoveToNextSiblingHeader)
+    vmap <buffer> [] <Plug>(Markdown_MoveToPreviousSiblingHeader)
+    vmap <buffer> ]u <Plug>(Markdown_MoveToParentHeader)
+    vmap <buffer> ]c <Plug>(Markdown_MoveToCurHeader)
 endif
 
-command! -buffer Toc call b:Markdown_Toc()
-command! -buffer Toch call b:Markdown_Toc('horizontal')
-command! -buffer Tocv call b:Markdown_Toc('vertical')
-command! -buffer Toct call b:Markdown_Toc('tab')
+command! -buffer Toc call s:Markdown_Toc()
+command! -buffer Toch call s:Markdown_Toc('horizontal')
+command! -buffer Tocv call s:Markdown_Toc('vertical')
+command! -buffer Toct call s:Markdown_Toc('tab')
+command! -buffer -range=% SetexToAtx call s:SetexToAtx(<line1>, <line2>)
+command! -buffer -range=% HeaderDecrease call s:HeaderDecrease(<line1>, <line2>)
+command! -buffer -range=% HeaderIncrease call s:HeaderDecrease(<line1>, <line2>, 1)