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.
1 "TODO print messages when on visual mode. I only see VISUAL, not the messages.
3 " Function interface phylosophy:
5 " - functions take arbitrary line numbers as parameters.
6 " Current cursor line is only a suitable default parameter.
8 " - only functions that bind directly to user actions:
10 " - print error messages.
11 " All intermediate functions limit themselves return `0` to indicate an error.
13 " - move the cursor. All other functions do not move the cursor.
15 " This is how you should view headers:
48 " For each level, contains the regexp that matches at that level only.
49 let s:levelRegexpDict = {
50 \ 1: '\v^(#[^#]@=|.+\n\=+$)',
51 \ 2: '\v^(##[^#]@=|.+\n-+$)',
54 \ 5: '\v^#####[^#]@=',
55 \ 6: '\v^######[^#]@='
58 " Maches any header level of any type.
60 " This could be deduced from `s:levelRegexpDict`, but it is more
61 " efficient to have a single regexp for this.
63 let s:headersRegexp = '\v^(#|.+\n(\=+|-+)$)'
65 " Returns the line number of the first header before `line`, called the
68 " If there is no current header, return `0`.
70 " @param a:1 The line to look the header of. Default value: `getpos('.')`.
72 function! s:Markdown_GetHeaderLineNum(...)
79 if join(getline(l:l, l:l + 1), "\n") =~ s:headersRegexp
87 " - if inside a header goes to it.
88 " Return its line number.
90 " - if on top level outside any headers,
94 function! s:Markdown_MoveToCurHeader()
95 let l:lineNum = s:Markdown_GetHeaderLineNum()
97 call cursor(l:lineNum, 1)
99 echo 'outside any header'
105 " Move cursor to next header of any level.
107 " If there are no more headers, print a warning.
109 function! s:Markdown_MoveToNextHeader()
110 if search(s:headersRegexp, 'W') == 0
112 echo 'no next header'
116 " Move cursor to previous header (before current) of any level.
118 " If it does not exist, print a warning.
120 function! s:Markdown_MoveToPreviousHeader()
121 let l:curHeaderLineNumber = s:Markdown_GetHeaderLineNum()
122 let l:noPreviousHeader = 0
123 if l:curHeaderLineNumber <= 1
124 let l:noPreviousHeader = 1
126 let l:previousHeaderLineNumber = s:Markdown_GetHeaderLineNum(l:curHeaderLineNumber - 1)
127 if l:previousHeaderLineNumber == 0
128 let l:noPreviousHeader = 1
130 call cursor(l:previousHeaderLineNumber, 1)
133 if l:noPreviousHeader
134 echo 'no previous header'
138 " - if line is inside a header, return the header level (h1 -> 1, h2 -> 2, etc.).
140 " - if line is at top level outside any headers, return `0`.
142 function! s:Markdown_GetHeaderLevel(...)
144 let l:line = line('.')
148 let l:linenum = s:Markdown_GetHeaderLineNum(l:line)
150 return s:Markdown_GetLevelOfHeaderAtLine(l:linenum)
156 " Returns the level of the header at the given line.
158 " If there is no header at the given line, returns `0`.
160 function! s:Markdown_GetLevelOfHeaderAtLine(linenum)
161 let l:lines = join(getline(a:linenum, a:linenum + 1), "\n")
162 for l:key in keys(s:levelRegexpDict)
163 if l:lines =~ get(s:levelRegexpDict, l:key)
170 " Move cursor to parent header of the current header.
172 " If it does not exit, print a warning and do nothing.
174 function! s:Markdown_MoveToParentHeader()
175 let l:linenum = s:Markdown_GetParentHeaderLineNumber()
177 call cursor(l:linenum, 1)
179 echo 'no parent header'
183 " Return the line number of the parent header of line `line`.
185 " If it has no parent, return `0`.
187 function! s:Markdown_GetParentHeaderLineNumber(...)
189 let l:line = line('.')
193 let l:level = s:Markdown_GetHeaderLevel(l:line)
195 let l:linenum = s:Markdown_GetPreviousHeaderLineNumberAtLevel(l:level - 1, l:line)
201 " Return the line number of the previous header of given level.
202 " in relation to line `a:1`. If not given, `a:1 = getline()`
204 " `a:1` line is included, and this may return the current header.
208 function! s:Markdown_GetNextHeaderLineNumberAtLevel(level, ...)
210 let l:line = line('.')
215 while(l:l <= line('$'))
216 if join(getline(l:l, l:l + 1), "\n") =~ get(s:levelRegexpDict, a:level)
224 " Return the line number of the previous header of given level.
225 " in relation to line `a:1`. If not given, `a:1 = getline()`
227 " `a:1` line is included, and this may return the current header.
231 function! s:Markdown_GetPreviousHeaderLineNumberAtLevel(level, ...)
233 let l:line = line('.')
239 if join(getline(l:l, l:l + 1), "\n") =~ get(s:levelRegexpDict, a:level)
247 " Move cursor to next sibling header.
249 " If there is no next siblings, print a warning and don't move.
251 function! s:Markdown_MoveToNextSiblingHeader()
252 let l:curHeaderLineNumber = s:Markdown_GetHeaderLineNum()
253 let l:curHeaderLevel = s:Markdown_GetLevelOfHeaderAtLine(l:curHeaderLineNumber)
254 let l:curHeaderParentLineNumber = s:Markdown_GetParentHeaderLineNumber()
255 let l:nextHeaderSameLevelLineNumber = s:Markdown_GetNextHeaderLineNumberAtLevel(l:curHeaderLevel, l:curHeaderLineNumber + 1)
256 let l:noNextSibling = 0
257 if l:nextHeaderSameLevelLineNumber == 0
258 let l:noNextSibling = 1
260 let l:nextHeaderSameLevelParentLineNumber = s:Markdown_GetParentHeaderLineNumber(l:nextHeaderSameLevelLineNumber)
261 if l:curHeaderParentLineNumber == l:nextHeaderSameLevelParentLineNumber
262 call cursor(l:nextHeaderSameLevelLineNumber, 1)
264 let l:noNextSibling = 1
268 echo 'no next sibling header'
272 " Move cursor to previous sibling header.
274 " If there is no previous siblings, print a warning and do nothing.
276 function! s:Markdown_MoveToPreviousSiblingHeader()
277 let l:curHeaderLineNumber = s:Markdown_GetHeaderLineNum()
278 let l:curHeaderLevel = s:Markdown_GetLevelOfHeaderAtLine(l:curHeaderLineNumber)
279 let l:curHeaderParentLineNumber = s:Markdown_GetParentHeaderLineNumber()
280 let l:previousHeaderSameLevelLineNumber = s:Markdown_GetPreviousHeaderLineNumberAtLevel(l:curHeaderLevel, l:curHeaderLineNumber - 1)
281 let l:noPreviousSibling = 0
282 if l:previousHeaderSameLevelLineNumber == 0
283 let l:noPreviousSibling = 1
285 let l:previousHeaderSameLevelParentLineNumber = s:Markdown_GetParentHeaderLineNumber(l:previousHeaderSameLevelLineNumber)
286 if l:curHeaderParentLineNumber == l:previousHeaderSameLevelParentLineNumber
287 call cursor(l:previousHeaderSameLevelLineNumber, 1)
289 let l:noPreviousSibling = 1
292 if l:noPreviousSibling
293 echo 'no previous sibling header'
297 function! s:Markdown_Toc(...)
299 let l:window_type = a:1
301 let l:window_type = 'vertical'
305 silent lvimgrep /\(^\S.*\(\n[=-]\+\n\)\@=\|^#\+\)/ %
307 echom "Toc: No headers."
311 if l:window_type ==# 'horizontal'
313 elseif l:window_type ==# 'vertical'
315 let &winwidth=(&columns/2)
316 elseif l:window_type ==# 'tab'
322 for i in range(1, line('$'))
323 " this is the location-list data for the current item
324 let d = getloclist(0)[i-1]
326 if match(d.text, "^#") > -1
327 let l:level = len(matchstr(d.text, '#*', 'g'))-1
328 let d.text = substitute(d.text, '\v^#*[ ]*', '', '')
329 let d.text = substitute(d.text, '\v[ ]*#*$', '', '')
332 let l:next_line = getbufline(bufname(d.bufnr), d.lnum+1)
333 if match(l:next_line, "=") > -1
335 elseif match(l:next_line, "-") > -1
339 call setline(i, repeat(' ', l:level). d.text)
342 setlocal nomodifiable
346 " Wrapper to do move commands in visual mode.
348 function! s:VisMove(f)
353 " Map in both normal and visual modes.
355 function! s:MapNormVis(rhs,lhs)
356 execute 'nn <buffer><silent> ' . a:rhs . ' :call ' . a:lhs . '()<cr>'
357 execute 'vn <buffer><silent> ' . a:rhs . ' <esc>:call <sid>VisMove(''' . a:lhs . ''')<cr>'
360 " Convert Setex headers in range `line1 .. line2` to Atx.
361 " Returns the number of conversions.
362 function! s:SetexToAtx(line1, line2)
363 let l:originalNumLines = line('$')
364 execute 'silent! ' . a:line1 . ',' . a:line2 . 'substitute/\v(.*\S.*)\n\=+$/# \1/'
365 execute 'silent! ' . a:line1 . ',' . a:line2 . 'substitute/\v(.*\S.*)\n-+$/## \1/'
366 return l:originalNumLines - line('$')
369 " If `a:1` is 0, decrease the level of all headers in range `line1 .. line2`.
370 " Otherwise, increase the level. `a:1` defaults to `0`.
371 function! s:HeaderDecrease(line1, line2, ...)
378 let l:forbiddenLevel = 6
379 let l:replaceLevels = [5, 1]
382 let l:forbiddenLevel = 1
383 let l:replaceLevels = [2, 6]
384 let l:levelDelta = -1
386 for l:line in range(a:line1, a:line2)
387 if join(getline(l:line, l:line + 1), "\n") =~ s:levelRegexpDict[l:forbiddenLevel]
388 echomsg 'There is an h' . l:forbiddenLevel . ' at line ' . l:line . '. Aborting.'
392 let l:numSubstitutions = s:SetexToAtx(a:line1, a:line2)
393 for l:level in range(replaceLevels[0], replaceLevels[1], -l:levelDelta)
394 execute 'silent! ' . a:line1 . ',' . (a:line2 - l:numSubstitutions) . 'substitute/' . s:levelRegexpDict[l:level] . '/' . repeat('#', l:level + l:levelDelta) . '/g'
398 " Format table under cursor.
399 " Depends on Tabularize.
400 function! s:TableFormat()
401 let l:pos = getpos('.')
403 " Search instead of `normal! j` because of the table at beginning of file edge case.
406 " Remove everything that is not a pipe othewise well formated tables would grow
407 " because of addition of 2 spaces on the separator line by Tabularize /|.
411 call setpos('.', l:pos)
416 " - step +1 for right, -1 for left
418 " TODO: multiple lines.
420 function! s:FindCornerOfSyntax(lnum, col, step)
422 let l:syn = synIDattr(synID(a:lnum, l:col, 1), 'name')
423 while synIDattr(synID(a:lnum, l:col, 1), 'name') ==# l:syn
426 return l:col - a:step
429 " Return the next position of the given syntax name,
430 " inclusive on the given position.
432 " TODO: multiple lines
434 function! s:FindNextSyntax(lnum, col, name)
437 while synIDattr(synID(a:lnum, l:col, 1), 'name') !=# a:name
440 return [a:lnum, l:col]
443 function! s:FindCornersOfSyntax(lnum, col)
444 return [<sid>FindLeftOfSyntax(a:lnum, a:col), <sid>FindRightOfSyntax(a:lnum, a:col)]
447 function! s:FindRightOfSyntax(lnum, col)
448 return <sid>FindCornerOfSyntax(a:lnum, a:col, 1)
451 function! s:FindLeftOfSyntax(lnum, col)
452 return <sid>FindCornerOfSyntax(a:lnum, a:col, -1)
457 " - a string with the the URL for the link under the cursor
458 " - an empty string if the cursor is not on a link
460 " `b:` instead of `s:` to make it testable.
464 " - multiline support
465 " - give an error if the separator does is not on a link
467 function! b:Markdown_GetUrlForPosition(lnum, col)
470 let l:syn = synIDattr(synID(l:lnum, l:col, 1), 'name')
472 if l:syn ==# 'mkdInlineURL' || l:syn ==# 'mkdURL' || l:syn ==# 'mkdLinkDefTarget'
474 elseif l:syn ==# 'mkdLink'
475 let [l:lnum, l:col] = <sid>FindNextSyntax(l:lnum, l:col, 'mkdURL')
477 elseif l:syn ==# 'mkdDelimiter'
478 let l:line = getline(l:lnum)
479 let l:char = l:line[col - 1]
482 elseif l:char ==# '>' || l:char ==# ')'
484 elseif l:char ==# '[' || l:char ==# ']' || l:char ==# '('
485 let [l:lnum, l:col] = <sid>FindNextSyntax(l:lnum, l:col, 'mkdURL')
493 let [l:left, l:right] = <sid>FindCornersOfSyntax(l:lnum, l:col)
494 return getline(l:lnum)[l:left - 1 : l:right - 1]
497 " Front end for GetUrlForPosition.
499 function! s:OpenUrlUnderCursor()
500 let l:url = b:Markdown_GetUrlForPosition(line('.'), col('.'))
502 call netrw#NetrwBrowseX(l:url, 0)
504 echomsg 'The cursor is not on a link.'
508 call <sid>MapNormVis('<Plug>Markdown_MoveToNextHeader', '<sid>Markdown_MoveToNextHeader')
509 call <sid>MapNormVis('<Plug>Markdown_MoveToPreviousHeader', '<sid>Markdown_MoveToPreviousHeader')
510 call <sid>MapNormVis('<Plug>Markdown_MoveToNextSiblingHeader', '<sid>Markdown_MoveToNextSiblingHeader')
511 call <sid>MapNormVis('<Plug>Markdown_MoveToPreviousSiblingHeader', '<sid>Markdown_MoveToPreviousSiblingHeader')
512 call <sid>MapNormVis('<Plug>Markdown_MoveToParentHeader', '<sid>Markdown_MoveToParentHeader')
513 call <sid>MapNormVis('<Plug>Markdown_MoveToCurHeader', '<sid>Markdown_MoveToCurHeader')
514 nnoremap <Plug>(OpenUrlUnderCursor) :call <sid>OpenUrlUnderCursor()<cr>
516 if !get(g:, 'vim_markdown_no_default_key_mappings', 0)
517 nmap <buffer> ]] <Plug>Markdown_MoveToNextHeader
518 nmap <buffer> [[ <Plug>Markdown_MoveToPreviousHeader
519 nmap <buffer> ][ <Plug>Markdown_MoveToNextSiblingHeader
520 nmap <buffer> [] <Plug>Markdown_MoveToPreviousSiblingHeader
521 nmap <buffer> ]u <Plug>Markdown_MoveToParentHeader
522 nmap <buffer> ]c <Plug>Markdown_MoveToCurHeader
523 nmap <buffer> gx <Plug>OpenUrlUnderCursor
525 vmap <buffer> ]] <Plug>Markdown_MoveToNextHeader
526 vmap <buffer> [[ <Plug>Markdown_MoveToPreviousHeader
527 vmap <buffer> ][ <Plug>Markdown_MoveToNextSiblingHeader
528 vmap <buffer> [] <Plug>Markdown_MoveToPreviousSiblingHeader
529 vmap <buffer> ]u <Plug>Markdown_MoveToParentHeader
530 vmap <buffer> ]c <Plug>Markdown_MoveToCurHeader
533 command! -buffer -range=% HeaderDecrease call s:HeaderDecrease(<line1>, <line2>)
534 command! -buffer -range=% HeaderIncrease call s:HeaderDecrease(<line1>, <line2>, 1)
535 command! -buffer -range=% SetexToAtx call s:SetexToAtx(<line1>, <line2>)
536 command! -buffer TableFormat call s:TableFormat()
537 command! -buffer Toc call s:Markdown_Toc()
538 command! -buffer Toch call s:Markdown_Toc('horizontal')
539 command! -buffer Tocv call s:Markdown_Toc('vertical')
540 command! -buffer Toct call s:Markdown_Toc('tab')