"TODO print messages when on visual mode. I only see VISUAL, not the messages.
-" This is how you should view things:
+" 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
" |
" |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^######[^#]@='
+\ }
-let s:headerExpr = '\v^(\s*#|.+\n(\=+|-+)$)'
+" 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(\=+|-+)$)'
-" Return 0 if not found, else the actual line number.
+" 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! b:Markdown_GetLineNumCurHeader()
- echo s:headerExpr
- return search(s:headerExpr, 'bcnW')
+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.
" print a warning
" Return `0`.
"
-function! b:Markdown_GoCurHeader()
- let l:lineNum = b:Markdown_GetLineNumCurHeader()
+function! s:Markdown_MoveToCurHeader()
+ let l:lineNum = s:Markdown_GetHeaderLineNum()
if l:lineNum != 0
call cursor(l:lineNum, 1)
else
- echo 'error: outside any header'
+ echo 'outside any header'
"normal! gg
- end
+ endif
return l:lineNum
endfunction
-" Put cursor on next header of any level.
+" Move cursor to next header of any level.
"
" If there are no more headers, print a warning.
"
-function! b:Markdown_GoNextHeader()
- if search(s:headerExpr, 'W') == 0
+function! s:Markdown_MoveToNextHeader()
+ if search(s:headersRegexp, 'W') == 0
"normal! G
- echo 'error: no next header'
- end
+ echo 'no next header'
+ endif
endfunction
-" Put cursor on previous header (before current) of any level.
+" Move cursor to previous header (before current) of any level.
"
" If it does not exist, print a warning.
"
-function! b:Markdown_GoPreviousHeader()
- let l:oldPos = getpos('.')
- let l:curHeaderLineNumber = b:Markdown_GoCurHeader()
- if l:curHeaderLineNumber == 0
- call setpos('.', l:oldPos)
- end
- if search(s:headerExpr, 'bW') == 0
- "normal! gg
- call setpos('.', l:oldPos)
- echo 'error: no previous header'
- end
+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
-"- if inside a header, cursor goes to it.
-" Return its hashes.
+" Move cursor to parent header of the current header.
"
-"- if on top level outside any headers,
-" print a warning
-" return ''
+" If it does not exit, print a warning and do nothing.
"
-function! b:Markdown_GoCurHeaderGetHashes()
- let l:linenum = b:Markdown_GetLineNumCurHeader()
+function! s:Markdown_MoveToParentHeader()
+ let l:linenum = s:Markdown_GetParentHeaderLineNumber()
if l:linenum != 0
call cursor(l:linenum, 1)
- return matchlist(getline(linenum), '\v^\s*(#+)')[1]
else
- return ''
- end
+ 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
-" Put cursor on previous header of any level.
+" Return the line number of the previous header of given level.
+" in relation to line `a:1`. If not given, `a:1 = getline()`
"
-" If it exists, return its lines number.
+" `a:1` line is included, and this may return the current header.
"
-" Otherwise, print a warning and return `0`.
+" If none return 0.
"
-function! b:Markdown_GoHeaderUp()
- let l:oldPos = getpos('.')
- let l:hashes = b:Markdown_GoCurHeaderGetHashes()
- if len(l:hashes) > 1
- call search('^\s*' . l:hashes[1:] . '[^#]', 'b')
+function! s:Markdown_GetNextHeaderLineNumberAtLevel(level, ...)
+ if a:0 < 1
+ let l:line = line('.')
else
- call setpos('.', l:oldPos)
- echo 'error: already at top level'
- end
+ 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
-" If no more next siblings, print error message and do nothing.
+" Return the line number of the previous header of given level.
+" in relation to line `a:1`. If not given, `a:1 = getline()`
"
-function! b:Markdown_GoNextSiblingHeader()
- let l:oldPos = getpos('.')
- let l:hashes = b:Markdown_GoCurHeaderGetHashes()
- let l:noSibling = 0
- if l:hashes ==# ''
- let l:noSibling = 1
+" `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:nhashes = len(l:hashes)
- if l:nhashes == 1
- "special case, just add the largest possible value
- let l:nextLowerLevelLine = line('$') + 1
- else
- let l:nextLowerLevelLine = search('\v^\s*#{1,' . (l:nhashes - 1) . '}[^#]' , 'nW')
- end
- let l:nextSameLevelLine = search('\v^\s*' . l:hashes . '[^#]', 'nW')
- if (
- \ l:nextSameLevelLine > 0
- \ &&
- \ (
- \ l:nextLowerLevelLine == 0
- \ ||
- \ l:nextLowerLevelLine > l:nextSameLevelLine
- \ )
- \ )
- call cursor(l:nextSameLevelLine, 1)
+ 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:noSibling = 1
- end
- end
- if l:noSibling
- call setpos('.', l:oldPos)
- echo 'error: no next sibling'
- end
-endfunction
-
-"if no more next siblings, print error message and do nothing.
-function! b:Markdown_GoPreviousSiblingHeader()
- let l:oldPos = getpos('.')
- let l:hashes = b:Markdown_GoCurHeaderGetHashes()
- let l:noSibling = 0
- if l:hashes ==# ''
- let l:noSibling = 1
- else
- let l:nhashes = len(l:hashes)
- if l:nhashes == 1
- "special case, just add the largest possible value
- let l:prevLowerLevelLine = -1
+ 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:prevLowerLevelLine = search('\v^\s*#{1,' . (l:nhashes - 1) . '}[^#]' , 'bnW')
- end
- let l:prevSameLevelLine = search('\v^\s*' . l:hashes . '[^#]', 'bnW')
- if (
- \ l:prevSameLevelLine > 0
- \ &&
- \ (
- \ l:prevLowerLevelLine == 0
- \ ||
- \ l:prevLowerLevelLine < l:prevSameLevelLine
- \ )
- \)
- call cursor(l:prevSameLevelLine, 1)
+ 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 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:noSibling = 1
- end
- end
- if l:noSibling
- call setpos('.', l:oldPos)
- echo 'error: no previous sibling'
- end
+ 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
-"wrapper to do move commands in visual mode
+" 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
+" Map in both normal and visual modes.
+"
function! s:MapNormVis(rhs,lhs)
execute 'nn <buffer><silent> ' . a:rhs . ' :call ' . a:lhs . '()<cr>'
execute 'vn <buffer><silent> ' . a:rhs . ' <esc>:call <sid>VisMove(''' . a:lhs . ''')<cr>'
endfunction
-call <sid>MapNormVis(']]', 'b:Markdown_GoNextHeader')
-call <sid>MapNormVis('[[', 'b:Markdown_GoPreviousHeader')
-call <sid>MapNormVis('][', 'b:Markdown_GoNextSiblingHeader')
-call <sid>MapNormVis('[]', 'b:Markdown_GoPreviousSiblingHeader')
-"menmonic: Up
-call <sid>MapNormVis(']u', 'b:Markdown_GoHeaderUp')
-"menmonic: Current
-call <sid>MapNormVis(']c', 'b:Markdown_GoCurHeader')
+" 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) . '/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
+
+" 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 [<sid>FindLeftOfSyntax(a:lnum, a:col), <sid>FindRightOfSyntax(a:lnum, a:col)]
+endfunction
+
+function! s:FindRightOfSyntax(lnum, col)
+ return <sid>FindCornerOfSyntax(a:lnum, a:col, 1)
+endfunction
+
+function! s:FindLeftOfSyntax(lnum, col)
+ return <sid>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
+"
+" `b:` instead of `s:` to make it testable.
+"
+" TODO
+"
+" - multiline support
+" - give an error if the separator does is not on a link
+"
+function! b: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] = <sid>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] = <sid>FindNextSyntax(l:lnum, l:col, 'mkdURL')
+ else
+ return ''
+ endif
+ else
+ return ''
+ endif
+
+ let [l:left, l:right] = <sid>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 = b:Markdown_GetUrlForPosition(line('.'), col('.'))
+ if l:url != ''
+ call netrw#NetrwBrowseX(l:url, 0)
+ else
+ echomsg 'The cursor is not on a link.'
+ endif
+endfunction
+
+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)', '<sid>Markdown_MoveToParentHeader')
+" Menmonic: Current
+call <sid>MapNormVis('<Plug>(Markdown_MoveToCurHeader)', '<sid>Markdown_MoveToCurHeader')
+nnoremap <Plug>(OpenUrlUnderCursor) :call <sid>OpenUrlUnderCursor()<cr>
+
+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)
+ nmap <buffer> gx <Plug>(OpenUrlUnderCursor)
+
+ 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 -range=% HeaderDecrease call s:HeaderDecrease(<line1>, <line2>)
+command! -buffer -range=% HeaderIncrease call s:HeaderDecrease(<line1>, <line2>, 1)
+command! -buffer -range=% SetexToAtx call s:SetexToAtx(<line1>, <line2>)
+command! -buffer TableFormat call s:TableFormat()
+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')
projects / etc / vim.git / blobdiff