Go to the current header on Toc

[etc/vim.git] / ftplugin / markdown.vim

diff --git a/ftplugin/markdown.vim b/ftplugin/markdown.vim
index 7e2b35e8e51d82d2adac075b3190ebb3d848559a..408d92e635f6c1cf11b7164ce08816993cae9cc0 100644 (file)
--- a/ftplugin/markdown.vim
+++ b/ftplugin/markdown.vim
@@ -303,43 +303,76 @@ function! s:Toc(...)
     endif
 
 
     endif
 
 

-    let b:bufnr = bufnr('%')
-    let b:fenced_block = 0
-    let b:header_list = []
+    let l:bufnr = bufnr('%')
+    let l:cursor_line = line('.')
+    let l:cursor_header = 0
+    let l:fenced_block = 0
+    let l:front_matter = 0
+    let l:header_list = []

     let l:header_max_len = 0
     let l:header_max_len = 0

+    let l:vim_markdown_toc_autofit = get(g:, "vim_markdown_toc_autofit", 0)
+    let l:vim_markdown_frontmatter = get(g:, "vim_markdown_frontmatter", 0)

     for i in range(1, line('$'))
         let l:lineraw = getline(i)
         let l:l1 = getline(i+1)
         let l:line = substitute(l:lineraw, "#", "\\\#", "g")
         if l:line =~ '````*' || l:line =~ '\~\~\~\~*'
     for i in range(1, line('$'))
         let l:lineraw = getline(i)
         let l:l1 = getline(i+1)
         let l:line = substitute(l:lineraw, "#", "\\\#", "g")
         if l:line =~ '````*' || l:line =~ '\~\~\~\~*'

-            if b:fenced_block == 0
-                let b:fenced_block = 1
-            elseif b:fenced_block == 1
-                let b:fenced_block = 0
+            if l:fenced_block == 0
+                let l:fenced_block = 1
+            elseif l:fenced_block == 1
+                let l:fenced_block = 0
+            endif
+        elseif l:vim_markdown_frontmatter == 1
+            if l:front_matter == 1
+                if l:line == '---'
+                    let l:front_matter = 0
+                endif
+            elseif i == 1
+                if l:line == '---'
+                    let l:front_matter = 1
+                endif

             endif
         endif
             endif
         endif

-        if l:line =~ '^#\+' || l:l1 =~ '^==\+\s*' || l:l1 =~ '^--\+\s*'
-            let b:is_header = 1
+        if l:line =~ '^#\+' || (l:l1 =~ '^=\+\s*$' || l:l1 =~ '^-\+\s*$') && l:line =~ '^\S'
+            let l:is_header = 1

         else
         else

-            let b:is_header = 0
+            let l:is_header = 0

         endif
         endif

-        if b:is_header == 1 && b:fenced_block == 0
+        if l:is_header == 1 && l:fenced_block == 0 && l:front_matter == 0

             " append line to location list
             " append line to location list

-            let b:item = {'lnum': i, 'text': l:line, 'valid': 1, 'bufnr': b:bufnr, 'col': 1}
-            let b:header_list = b:header_list + [b:item]
+            let l:item = {'lnum': i, 'text': l:line, 'valid': 1, 'bufnr': l:bufnr, 'col': 1}
+            let l:header_list = l:header_list + [l:item]
+            " set header number of the cursor position
+            if l:cursor_header == 0
+                if i == l:cursor_line
+                    let l:cursor_header = len(l:header_list)
+                elseif i > l:cursor_line
+                    let l:cursor_header = len(l:header_list) - 1
+                endif
+            endif
+            " keep track of the longest header size (heading level + title)
+            let l:total_len = stridx(l:line, ' ') + len(l:line)
+            if l:total_len > l:header_max_len
+                let l:header_max_len = l:total_len
+            endif

         endif
     endfor
         endif
     endfor

-    if len(b:header_list) == 0
+    if len(l:header_list) == 0

         echom "Toc: No headers."
         return
     endif
         echom "Toc: No headers."
         return
     endif

-    call setloclist(0, b:header_list)
+    call setloclist(0, l:header_list)

 
     if l:window_type ==# 'horizontal'
         lopen
     elseif l:window_type ==# 'vertical'
         vertical lopen
 
     if l:window_type ==# 'horizontal'
         lopen
     elseif l:window_type ==# 'vertical'
         vertical lopen

-        let &winwidth=(&columns/2)
+        " auto-fit toc window when possible to shrink it
+        if (&columns/2) > l:header_max_len && l:vim_markdown_toc_autofit == 1
+            execute 'vertical resize ' . (l:header_max_len + 1)
+        else
+            execute 'vertical resize ' . (&columns/2)
+        endif

     elseif l:window_type ==# 'tab'
         tab lopen
     else
     elseif l:window_type ==# 'tab'
         tab lopen
     else


@@ -367,7 +400,7 @@ function! s:Toc(...)
     endfor
     setlocal nomodified
     setlocal nomodifiable
     endfor
     setlocal nomodified
     setlocal nomodifiable

-    normal! gg
+    execute 'normal! ' . l:cursor_header . 'G'

 endfunction
 
 " Convert Setex headers in range `line1 .. line2` to Atx.
 endfunction
 
 " Convert Setex headers in range `line1 .. line2` to Atx.


@@ -586,7 +619,7 @@ let s:filetype_dict = {
     \ 'viml': 'vim'
 \ }
 
     \ 'viml': 'vim'
 \ }
 

-function! s:Markdown_highlight_sources(force)
+function! s:MarkdownHighlightSources(force)

     " Syntax highlight source code embedded in notes.
     " Look for code blocks in the current file
     let filetypes = {}
     " Syntax highlight source code embedded in notes.
     " Look for code blocks in the current file
     let filetypes = {}


@@ -612,7 +645,7 @@ function! s:Markdown_highlight_sources(force)
                 let filetype = ft
             endif
             let group = 'mkdSnippet' . toupper(substitute(filetype, "[+-]", "_", "g"))
                 let filetype = ft
             endif
             let group = 'mkdSnippet' . toupper(substitute(filetype, "[+-]", "_", "g"))

-            let include = s:syntax_include(filetype)
+            let include = s:SyntaxInclude(filetype)

             let command = 'syntax region %s matchgroup=%s start="^\s*```%s$" matchgroup=%s end="\s*```$" keepend contains=%s%s'
             execute printf(command, group, startgroup, ft, endgroup, include, has('conceal') ? ' concealends' : '')
             execute printf('syntax cluster mkdNonListItem add=%s', group)
             let command = 'syntax region %s matchgroup=%s start="^\s*```%s$" matchgroup=%s end="\s*```$" keepend contains=%s%s'
             execute printf(command, group, startgroup, ft, endgroup, include, has('conceal') ? ' concealends' : '')
             execute printf('syntax cluster mkdNonListItem add=%s', group)


@@ -622,7 +655,7 @@ function! s:Markdown_highlight_sources(force)
     endfor
 endfunction
 
     endfor
 endfunction
 

-function! s:syntax_include(filetype)
+function! s:SyntaxInclude(filetype)

     " Include the syntax highlighting of another {filetype}.
     let grouplistname = '@' . toupper(a:filetype)
     " Unset the name of the current syntax while including the other syntax
     " Include the syntax highlighting of another {filetype}.
     let grouplistname = '@' . toupper(a:filetype)
     " Unset the name of the current syntax while including the other syntax


@@ -647,16 +680,16 @@ function! s:syntax_include(filetype)
 endfunction
 
 
 endfunction
 
 

-function! s:Markdown_refresh_syntax(force)
+function! s:MarkdownRefreshSyntax(force)

     if &filetype == 'markdown' && line('$') > 1
     if &filetype == 'markdown' && line('$') > 1

-        call s:Markdown_highlight_sources(a:force)
+        call s:MarkdownHighlightSources(a:force)

     endif
 endfunction
 
 augroup Mkd
     autocmd!
     endif
 endfunction
 
 augroup Mkd
     autocmd!

-    au BufWinEnter * call s:Markdown_refresh_syntax(1)
-    au BufWritePost * call s:Markdown_refresh_syntax(0)
-    au InsertEnter,InsertLeave * call s:Markdown_refresh_syntax(0)
-    au CursorHold,CursorHoldI * call s:Markdown_refresh_syntax(0)
+    au BufWinEnter * call s:MarkdownRefreshSyntax(1)
+    au BufWritePost * call s:MarkdownRefreshSyntax(0)
+    au InsertEnter,InsertLeave * call s:MarkdownRefreshSyntax(0)
+    au CursorHold,CursorHoldI * call s:MarkdownRefreshSyntax(0)

 augroup END
 augroup END