"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: " " |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^(\s*#[^#]|.+\n\=+$)', \ 2: '\v^(\s*##[^#]|.+\n-+$)', \ 3: '\v^\s*###[^#]', \ 4: '\v^\s*####[^#]', \ 5: '\v^\s*#####[^#]', \ 6: '\v^\s*######[^#]' \ } " 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^(\s*#|.+\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:Markdown_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 inside a header goes to it. " Return its line number. " " - if on top level outside any headers, " print a warning " Return `0`. " function! s:Markdown_MoveToCurHeader() let l:lineNum = s:Markdown_GetHeaderLineNum() if l:lineNum != 0 call cursor(l:lineNum, 1) else echo 'outside any header' "normal! gg endif return l:lineNum endfunction " Move cursor to next header of any level. " " If there are no more headers, print a warning. " function! s:Markdown_MoveToNextHeader() if search(s:headersRegexp, 'W') == 0 "normal! G echo 'no next header' endif endfunction " Move cursor to previous header (before current) of any level. " " If it does not exist, print a warning. " 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 = s:Markdown_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 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:Markdown_GetHeaderLevel(...) if a:0 == 0 let l:line = line('.') else let l:line = a:1 endif let l:linenum = s:Markdown_GetHeaderLineNum(l:line) if l:linenum != 0 return s:Markdown_GetLevelOfHeaderAtLine(l:linenum) else return 0 endif endfunction " Returns the level of the header at the given line. " " If there is no header at the given line, returns `0`. " 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) 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:Markdown_MoveToParentHeader() let l:linenum = s:Markdown_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:Markdown_GetParentHeaderLineNumber(...) if a:0 == 0 let l:line = line('.') else let l:line = a:1 endif let l:level = s:Markdown_GetHeaderLevel(l:line) if l:level > 1 let l:linenum = s:Markdown_GetPreviousHeaderLineNumberAtLevel(l:level - 1, l:line) return l:linenum endif return 0 endfunction " 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:Markdown_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 " 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:Markdown_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 " Move cursor to next sibling header. " " If there is no next siblings, print a warning and don't move. " 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 = s:Markdown_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 " Move cursor to previous sibling header. " " If there is no previous siblings, print a warning and do nothing. " 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 = s:Markdown_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 function! s:Markdown_Toc(...) if a:0 > 0 let l:window_type = a:1 else let l:window_type = 'vertical' endif try silent vimgrep /\(^\S.*\(\n[=-]\+\)\@=\|^#\+\)/ % catch /E480/ echom "Toc: No headers." return endtry if l:window_type ==# 'horizontal' copen elseif l:window_type ==# 'vertical' vertical copen let &winwidth=(&columns/2) elseif l:window_type ==# 'tab' tab copen else copen endif set modifiable %s/\v^([^|]*\|){2,2} #// for i in range(1, 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 = d.text[l:level+2:] " 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 normal! gg endfunction " Wrapper to do move commands in visual mode. " function! s:VisMove(f) norm! gv call function(a:f)() endfunction " 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 call MapNormVis('(Markdown_MoveToNextHeader)', 'Markdown_MoveToNextHeader') call MapNormVis('(Markdown_MoveToPreviousHeader)', 'Markdown_MoveToPreviousHeader') call MapNormVis('(Markdown_MoveToNextSiblingHeader)', 'Markdown_MoveToNextSiblingHeader') call MapNormVis('(Markdown_MoveToPreviousSiblingHeader)', 'Markdown_MoveToPreviousSiblingHeader') " Menmonic: Up call MapNormVis('(Markdown_MoveToParentHeader)', 'Markdown_MoveToParentHeader') " Menmonic: Current call MapNormVis('(Markdown_MoveToCurHeader)', 'Markdown_MoveToCurHeader') if ! exists('g:vim_markdown_no_default_key_mappings') \ || !g:vim_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) endif 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')