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 for the header mappings:
48 " For each level, contains the regexp that matches at that level only.
50 let s:levelRegexpDict = {
51 \ 1: '\v^(#[^#]@=|.+\n\=+$)',
52 \ 2: '\v^(##[^#]@=|.+\n-+$)',
55 \ 5: '\v^#####[^#]@=',
56 \ 6: '\v^######[^#]@='
59 " Maches any header level of any type.
61 " This could be deduced from `s:levelRegexpDict`, but it is more
62 " efficient to have a single regexp for this.
64 let s:headersRegexp = '\v^(#|.+\n(\=+|-+)$)'
66 " Returns the line number of the first header before `line`, called the
69 " If there is no current header, return `0`.
71 " @param a:1 The line to look the header of. Default value: `getpos('.')`.
73 function! s:GetHeaderLineNum(...)
80 if join(getline(l:l, l:l + 1), "\n") =~ s:headersRegexp
88 " - if inside a header goes to it.
89 " Return its line number.
91 " - if on top level outside any headers,
95 function! s:MoveToCurHeader()
96 let l:lineNum = s:GetHeaderLineNum()
98 call cursor(l:lineNum, 1)
100 echo 'outside any header'
106 " Move cursor to next header of any level.
108 " If there are no more headers, print a warning.
110 function! s:MoveToNextHeader()
111 if search(s:headersRegexp, 'W') == 0
113 echo 'no next header'
117 " Move cursor to previous header (before current) of any level.
119 " If it does not exist, print a warning.
121 function! s:MoveToPreviousHeader()
122 let l:curHeaderLineNumber = s:GetHeaderLineNum()
123 let l:noPreviousHeader = 0
124 if l:curHeaderLineNumber <= 1
125 let l:noPreviousHeader = 1
127 let l:previousHeaderLineNumber = s:GetHeaderLineNum(l:curHeaderLineNumber - 1)
128 if l:previousHeaderLineNumber == 0
129 let l:noPreviousHeader = 1
131 call cursor(l:previousHeaderLineNumber, 1)
134 if l:noPreviousHeader
135 echo 'no previous header'
139 " - if line is inside a header, return the header level (h1 -> 1, h2 -> 2, etc.).
141 " - if line is at top level outside any headers, return `0`.
143 function! s:GetHeaderLevel(...)
145 let l:line = line('.')
149 let l:linenum = s:GetHeaderLineNum(l:line)
151 return s:GetLevelOfHeaderAtLine(l:linenum)
157 " Returns the level of the header at the given line.
159 " If there is no header at the given line, returns `0`.
161 function! s:GetLevelOfHeaderAtLine(linenum)
162 let l:lines = join(getline(a:linenum, a:linenum + 1), "\n")
163 for l:key in keys(s:levelRegexpDict)
164 if l:lines =~ get(s:levelRegexpDict, l:key)
171 " Move cursor to parent header of the current header.
173 " If it does not exit, print a warning and do nothing.
175 function! s:MoveToParentHeader()
176 let l:linenum = s:GetParentHeaderLineNumber()
178 call cursor(l:linenum, 1)
180 echo 'no parent header'
184 " Return the line number of the parent header of line `line`.
186 " If it has no parent, return `0`.
188 function! s:GetParentHeaderLineNumber(...)
190 let l:line = line('.')
194 let l:level = s:GetHeaderLevel(l:line)
196 let l:linenum = s:GetPreviousHeaderLineNumberAtLevel(l:level - 1, l:line)
202 " Return the line number of the previous header of given level.
203 " in relation to line `a:1`. If not given, `a:1 = getline()`
205 " `a:1` line is included, and this may return the current header.
209 function! s:GetNextHeaderLineNumberAtLevel(level, ...)
211 let l:line = line('.')
216 while(l:l <= line('$'))
217 if join(getline(l:l, l:l + 1), "\n") =~ get(s:levelRegexpDict, a:level)
225 " Return the line number of the previous header of given level.
226 " in relation to line `a:1`. If not given, `a:1 = getline()`
228 " `a:1` line is included, and this may return the current header.
232 function! s:GetPreviousHeaderLineNumberAtLevel(level, ...)
234 let l:line = line('.')
240 if join(getline(l:l, l:l + 1), "\n") =~ get(s:levelRegexpDict, a:level)
248 " Move cursor to next sibling header.
250 " If there is no next siblings, print a warning and don't move.
252 function! s:MoveToNextSiblingHeader()
253 let l:curHeaderLineNumber = s:GetHeaderLineNum()
254 let l:curHeaderLevel = s:GetLevelOfHeaderAtLine(l:curHeaderLineNumber)
255 let l:curHeaderParentLineNumber = s:GetParentHeaderLineNumber()
256 let l:nextHeaderSameLevelLineNumber = s:GetNextHeaderLineNumberAtLevel(l:curHeaderLevel, l:curHeaderLineNumber + 1)
257 let l:noNextSibling = 0
258 if l:nextHeaderSameLevelLineNumber == 0
259 let l:noNextSibling = 1
261 let l:nextHeaderSameLevelParentLineNumber = s:GetParentHeaderLineNumber(l:nextHeaderSameLevelLineNumber)
262 if l:curHeaderParentLineNumber == l:nextHeaderSameLevelParentLineNumber
263 call cursor(l:nextHeaderSameLevelLineNumber, 1)
265 let l:noNextSibling = 1
269 echo 'no next sibling header'
273 " Move cursor to previous sibling header.
275 " If there is no previous siblings, print a warning and do nothing.
277 function! s:MoveToPreviousSiblingHeader()
278 let l:curHeaderLineNumber = s:GetHeaderLineNum()
279 let l:curHeaderLevel = s:GetLevelOfHeaderAtLine(l:curHeaderLineNumber)
280 let l:curHeaderParentLineNumber = s:GetParentHeaderLineNumber()
281 let l:previousHeaderSameLevelLineNumber = s:GetPreviousHeaderLineNumberAtLevel(l:curHeaderLevel, l:curHeaderLineNumber - 1)
282 let l:noPreviousSibling = 0
283 if l:previousHeaderSameLevelLineNumber == 0
284 let l:noPreviousSibling = 1
286 let l:previousHeaderSameLevelParentLineNumber = s:GetParentHeaderLineNumber(l:previousHeaderSameLevelLineNumber)
287 if l:curHeaderParentLineNumber == l:previousHeaderSameLevelParentLineNumber
288 call cursor(l:previousHeaderSameLevelLineNumber, 1)
290 let l:noPreviousSibling = 1
293 if l:noPreviousSibling
294 echo 'no previous sibling header'
300 let l:window_type = a:1
302 let l:window_type = 'vertical'
306 let l:bufnr = bufnr('%')
307 let l:cursor_line = line('.')
308 let l:cursor_header = 0
309 let l:fenced_block = 0
310 let l:front_matter = 0
311 let l:header_list = []
312 let l:header_max_len = 0
313 let l:vim_markdown_toc_autofit = get(g:, "vim_markdown_toc_autofit", 0)
314 let l:vim_markdown_frontmatter = get(g:, "vim_markdown_frontmatter", 0)
315 for i in range(1, line('$'))
316 let l:lineraw = getline(i)
317 let l:l1 = getline(i+1)
318 let l:line = substitute(l:lineraw, "#", "\\\#", "g")
319 if l:line =~ '````*' || l:line =~ '\~\~\~\~*'
320 if l:fenced_block == 0
321 let l:fenced_block = 1
322 elseif l:fenced_block == 1
323 let l:fenced_block = 0
325 elseif l:vim_markdown_frontmatter == 1
326 if l:front_matter == 1
328 let l:front_matter = 0
332 let l:front_matter = 1
336 if l:line =~ '^#\+' || (l:l1 =~ '^=\+\s*$' || l:l1 =~ '^-\+\s*$') && l:line =~ '^\S'
341 if l:is_header == 1 && l:fenced_block == 0 && l:front_matter == 0
342 " append line to location list
343 let l:item = {'lnum': i, 'text': l:line, 'valid': 1, 'bufnr': l:bufnr, 'col': 1}
344 let l:header_list = l:header_list + [l:item]
345 " set header number of the cursor position
346 if l:cursor_header == 0
347 if i == l:cursor_line
348 let l:cursor_header = len(l:header_list)
349 elseif i > l:cursor_line
350 let l:cursor_header = len(l:header_list) - 1
353 " keep track of the longest header size (heading level + title)
354 let l:total_len = stridx(l:line, ' ') + len(l:line)
355 if l:total_len > l:header_max_len
356 let l:header_max_len = l:total_len
360 call setloclist(0, l:header_list)
361 if len(l:header_list) == 0
362 echom "Toc: No headers."
366 if l:window_type ==# 'horizontal'
368 elseif l:window_type ==# 'vertical'
370 " auto-fit toc window when possible to shrink it
371 if (&columns/2) > l:header_max_len && l:vim_markdown_toc_autofit == 1
372 execute 'vertical resize ' . (l:header_max_len + 1)
374 execute 'vertical resize ' . (&columns/2)
376 elseif l:window_type ==# 'tab'
382 for i in range(1, line('$'))
383 " this is the location-list data for the current item
384 let d = getloclist(0)[i-1]
386 if match(d.text, "^#") > -1
387 let l:level = len(matchstr(d.text, '#*', 'g'))-1
388 let d.text = substitute(d.text, '\v^#*[ ]*', '', '')
389 let d.text = substitute(d.text, '\v[ ]*#*$', '', '')
392 let l:next_line = getbufline(d.bufnr, d.lnum+1)
393 if match(l:next_line, "=") > -1
395 elseif match(l:next_line, "-") > -1
399 call setline(i, repeat(' ', l:level). d.text)
402 setlocal nomodifiable
403 execute 'normal! ' . l:cursor_header . 'G'
406 " Convert Setex headers in range `line1 .. line2` to Atx.
408 " Return the number of conversions.
410 function! s:SetexToAtx(line1, line2)
411 let l:originalNumLines = line('$')
412 execute 'silent! ' . a:line1 . ',' . a:line2 . 'substitute/\v(.*\S.*)\n\=+$/# \1/'
413 execute 'silent! ' . a:line1 . ',' . a:line2 . 'substitute/\v(.*\S.*)\n-+$/## \1/'
414 return l:originalNumLines - line('$')
417 " If `a:1` is 0, decrease the level of all headers in range `line1 .. line2`.
419 " Otherwise, increase the level. `a:1` defaults to `0`.
421 function! s:HeaderDecrease(line1, line2, ...)
428 let l:forbiddenLevel = 6
429 let l:replaceLevels = [5, 1]
432 let l:forbiddenLevel = 1
433 let l:replaceLevels = [2, 6]
434 let l:levelDelta = -1
436 for l:line in range(a:line1, a:line2)
437 if join(getline(l:line, l:line + 1), "\n") =~ s:levelRegexpDict[l:forbiddenLevel]
438 echomsg 'There is an h' . l:forbiddenLevel . ' at line ' . l:line . '. Aborting.'
442 let l:numSubstitutions = s:SetexToAtx(a:line1, a:line2)
443 let l:flags = (&gdefault ? '' : 'g')
444 for l:level in range(replaceLevels[0], replaceLevels[1], -l:levelDelta)
445 execute 'silent! ' . a:line1 . ',' . (a:line2 - l:numSubstitutions) . 'substitute/' . s:levelRegexpDict[l:level] . '/' . repeat('#', l:level + l:levelDelta) . '/' . l:flags
449 " Format table under cursor.
451 " Depends on Tabularize.
453 function! s:TableFormat()
454 let l:pos = getpos('.')
456 " Search instead of `normal! j` because of the table at beginning of file edge case.
459 " Remove everything that is not a pipe, colon or hyphen next to a colon othewise
460 " well formated tables would grow because of addition of 2 spaces on the separator
461 " line by Tabularize /|.
462 let l:flags = (&gdefault ? '' : 'g')
463 execute 's/\(:\@<!-:\@!\|[^|:-]\)//e' . l:flags
464 execute 's/--/-/e' . l:flags
466 " Move colons for alignment to left or right side of the cell.
467 execute 's/:\( \+\)|/\1:|/e' . l:flags
468 execute 's/|\( \+\):/|:\1/e' . l:flags
469 execute 's/ /-/' . l:flags
470 call setpos('.', l:pos)
473 " Wrapper to do move commands in visual mode.
475 function! s:VisMove(f)
480 " Map in both normal and visual modes.
482 function! s:MapNormVis(rhs,lhs)
483 execute 'nn <buffer><silent> ' . a:rhs . ' :call ' . a:lhs . '()<cr>'
484 execute 'vn <buffer><silent> ' . a:rhs . ' <esc>:call <sid>VisMove(''' . a:lhs . ''')<cr>'
489 " - step +1 for right, -1 for left
491 " TODO: multiple lines.
493 function! s:FindCornerOfSyntax(lnum, col, step)
495 let l:syn = synIDattr(synID(a:lnum, l:col, 1), 'name')
496 while synIDattr(synID(a:lnum, l:col, 1), 'name') ==# l:syn
499 return l:col - a:step
502 " Return the next position of the given syntax name,
503 " inclusive on the given position.
505 " TODO: multiple lines
507 function! s:FindNextSyntax(lnum, col, name)
510 while synIDattr(synID(a:lnum, l:col, 1), 'name') !=# a:name
513 return [a:lnum, l:col]
516 function! s:FindCornersOfSyntax(lnum, col)
517 return [<sid>FindLeftOfSyntax(a:lnum, a:col), <sid>FindRightOfSyntax(a:lnum, a:col)]
520 function! s:FindRightOfSyntax(lnum, col)
521 return <sid>FindCornerOfSyntax(a:lnum, a:col, 1)
524 function! s:FindLeftOfSyntax(lnum, col)
525 return <sid>FindCornerOfSyntax(a:lnum, a:col, -1)
530 " - a string with the the URL for the link under the cursor
531 " - an empty string if the cursor is not on a link
535 " - multiline support
536 " - give an error if the separator does is not on a link
538 function! s:Markdown_GetUrlForPosition(lnum, col)
541 let l:syn = synIDattr(synID(l:lnum, l:col, 1), 'name')
543 if l:syn ==# 'mkdInlineURL' || l:syn ==# 'mkdURL' || l:syn ==# 'mkdLinkDefTarget'
545 elseif l:syn ==# 'mkdLink'
546 let [l:lnum, l:col] = <sid>FindNextSyntax(l:lnum, l:col, 'mkdURL')
548 elseif l:syn ==# 'mkdDelimiter'
549 let l:line = getline(l:lnum)
550 let l:char = l:line[col - 1]
553 elseif l:char ==# '>' || l:char ==# ')'
555 elseif l:char ==# '[' || l:char ==# ']' || l:char ==# '('
556 let [l:lnum, l:col] = <sid>FindNextSyntax(l:lnum, l:col, 'mkdURL')
564 let [l:left, l:right] = <sid>FindCornersOfSyntax(l:lnum, l:col)
565 return getline(l:lnum)[l:left - 1 : l:right - 1]
568 " Front end for GetUrlForPosition.
570 function! s:OpenUrlUnderCursor()
571 let l:url = s:Markdown_GetUrlForPosition(line('.'), col('.'))
573 call s:VersionAwareNetrwBrowseX(l:url)
575 echomsg 'The cursor is not on a link.'
579 " We need a definition guard because we invoke 'edit' which will reload this
580 " script while this function is running. We must not replace it.
581 if !exists("*s:EditUrlUnderCursor")
582 function s:EditUrlUnderCursor()
583 let l:url = s:Markdown_GetUrlForPosition(line('.'), col('.'))
585 if get(g:, 'vim_markdown_no_extensions_in_markdown', 0)
586 execute 'edit' fnamemodify(expand('%:~'), ':p:h').'/'.l:url.'.md'
591 echomsg 'The cursor is not on a link.'
596 function! s:VersionAwareNetrwBrowseX(url)
597 if has('patch-7.4.567')
598 call netrw#BrowseX(a:url, 0)
600 call netrw#NetrwBrowseX(a:url, 0)
604 function! s:MapNotHasmapto(lhs, rhs)
605 if !hasmapto('<Plug>' . a:rhs)
606 execute 'nmap <buffer>' . a:lhs . ' <Plug>' . a:rhs
607 execute 'vmap <buffer>' . a:lhs . ' <Plug>' . a:rhs
611 call <sid>MapNormVis('<Plug>Markdown_MoveToNextHeader', '<sid>MoveToNextHeader')
612 call <sid>MapNormVis('<Plug>Markdown_MoveToPreviousHeader', '<sid>MoveToPreviousHeader')
613 call <sid>MapNormVis('<Plug>Markdown_MoveToNextSiblingHeader', '<sid>MoveToNextSiblingHeader')
614 call <sid>MapNormVis('<Plug>Markdown_MoveToPreviousSiblingHeader', '<sid>MoveToPreviousSiblingHeader')
615 call <sid>MapNormVis('<Plug>Markdown_MoveToParentHeader', '<sid>MoveToParentHeader')
616 call <sid>MapNormVis('<Plug>Markdown_MoveToCurHeader', '<sid>MoveToCurHeader')
617 nnoremap <Plug>Markdown_OpenUrlUnderCursor :call <sid>OpenUrlUnderCursor()<cr>
618 nnoremap <Plug>Markdown_EditUrlUnderCursor :call <sid>EditUrlUnderCursor()<cr>
620 if !get(g:, 'vim_markdown_no_default_key_mappings', 0)
621 call <sid>MapNotHasmapto(']]', 'Markdown_MoveToNextHeader')
622 call <sid>MapNotHasmapto('[[', 'Markdown_MoveToPreviousHeader')
623 call <sid>MapNotHasmapto('][', 'Markdown_MoveToNextSiblingHeader')
624 call <sid>MapNotHasmapto('[]', 'Markdown_MoveToPreviousSiblingHeader')
625 call <sid>MapNotHasmapto(']u', 'Markdown_MoveToParentHeader')
626 call <sid>MapNotHasmapto(']c', 'Markdown_MoveToCurHeader')
627 call <sid>MapNotHasmapto('gx', 'Markdown_OpenUrlUnderCursor')
628 call <sid>MapNotHasmapto('ge', 'Markdown_EditUrlUnderCursor')
631 command! -buffer -range=% HeaderDecrease call s:HeaderDecrease(<line1>, <line2>)
632 command! -buffer -range=% HeaderIncrease call s:HeaderDecrease(<line1>, <line2>, 1)
633 command! -buffer -range=% SetexToAtx call s:SetexToAtx(<line1>, <line2>)
634 command! -buffer TableFormat call s:TableFormat()
635 command! -buffer Toc call s:Toc()
636 command! -buffer Toch call s:Toc('horizontal')
637 command! -buffer Tocv call s:Toc('vertical')
638 command! -buffer Toct call s:Toc('tab')
640 " Heavily based on vim-notes - http://peterodding.com/code/vim/notes/
641 if exists('g:vim_markdown_fenced_languages')
642 let s:filetype_dict = {}
643 for s:filetype in g:vim_markdown_fenced_languages
644 let key = matchstr(s:filetype, "[^=]*")
645 let val = matchstr(s:filetype, "[^=]*$")
646 let s:filetype_dict[key] = val
649 let s:filetype_dict = {
657 function! s:MarkdownHighlightSources(force)
658 " Syntax highlight source code embedded in notes.
659 " Look for code blocks in the current file
661 for line in getline(1, '$')
662 let ft = matchstr(line, '```\s*\zs[0-9A-Za-z_+-]*')
663 if !empty(ft) && ft !~ '^\d*$' | let filetypes[ft] = 1 | endif
665 if !exists('b:mkd_known_filetypes')
666 let b:mkd_known_filetypes = {}
668 if !exists('b:mkd_included_filetypes')
669 " set syntax file name included
670 let b:mkd_included_filetypes = {}
672 if !a:force && (b:mkd_known_filetypes == filetypes || empty(filetypes))
676 " Now we're ready to actually highlight the code blocks.
677 let startgroup = 'mkdCodeStart'
678 let endgroup = 'mkdCodeEnd'
679 for ft in keys(filetypes)
680 if a:force || !has_key(b:mkd_known_filetypes, ft)
681 if has_key(s:filetype_dict, ft)
682 let filetype = s:filetype_dict[ft]
686 let group = 'mkdSnippet' . toupper(substitute(filetype, "[+-]", "_", "g"))
687 if !has_key(b:mkd_included_filetypes, filetype)
688 let include = s:SyntaxInclude(filetype)
689 let b:mkd_included_filetypes[filetype] = 1
691 let include = '@' . toupper(filetype)
693 let command = 'syntax region %s matchgroup=%s start="^\s*```\s*%s$" matchgroup=%s end="\s*```$" keepend contains=%s%s'
694 execute printf(command, group, startgroup, ft, endgroup, include, has('conceal') && get(g:, 'vim_markdown_conceal', 1) ? ' concealends' : '')
695 execute printf('syntax cluster mkdNonListItem add=%s', group)
697 let b:mkd_known_filetypes[ft] = 1
702 function! s:SyntaxInclude(filetype)
703 " Include the syntax highlighting of another {filetype}.
704 let grouplistname = '@' . toupper(a:filetype)
705 " Unset the name of the current syntax while including the other syntax
706 " because some syntax scripts do nothing when "b:current_syntax" is set
707 if exists('b:current_syntax')
708 let syntax_save = b:current_syntax
709 unlet b:current_syntax
712 execute 'syntax include' grouplistname 'syntax/' . a:filetype . '.vim'
713 execute 'syntax include' grouplistname 'after/syntax/' . a:filetype . '.vim'
715 " Ignore missing scripts
717 " Restore the name of the current syntax
718 if exists('syntax_save')
719 let b:current_syntax = syntax_save
720 elseif exists('b:current_syntax')
721 unlet b:current_syntax
727 function! s:MarkdownRefreshSyntax(force)
728 if &filetype == 'markdown' && line('$') > 1
729 call s:MarkdownHighlightSources(a:force)
733 function! s:MarkdownClearSyntaxVariables()
734 if &filetype == 'markdown'
735 unlet! b:mkd_included_filetypes
741 au BufWinEnter * call s:MarkdownRefreshSyntax(1)
742 au BufUnload * call s:MarkdownClearSyntaxVariables()
743 au BufWritePost * call s:MarkdownRefreshSyntax(0)
744 au InsertEnter,InsertLeave * call s:MarkdownRefreshSyntax(0)
745 au CursorHold,CursorHoldI * call s:MarkdownRefreshSyntax(0)