Add basic usage for fold and conceal #334

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

diff --git a/after/ftplugin/markdown.vim b/after/ftplugin/markdown.vim
index 94267eedb315b88c1f165763717a383db853136d..9ee01006960b118c1a82ddec0958b047496e54db 100644 (file)
--- a/after/ftplugin/markdown.vim
+++ b/after/ftplugin/markdown.vim
@@ -6,45 +6,155 @@
 "
 " original version from Steve Losh's gist: https://gist.github.com/1038710
 
 "
 " original version from Steve Losh's gist: https://gist.github.com/1038710
 

-func! s:is_mkdCode(lnum)
-    return synIDattr(synID(a:lnum, 1, 0), 'name') == 'mkdCode'
-endfunc
-
-func! s:effective_line(lnum)
-    return s:is_mkdCode(a:lnum) ? '' : getline(a:lnum)
-endfunc
-
-func! Foldexpr_markdown(lnum)
-    if (a:lnum == 1)
-        let l0 = ''
-    else
-        let l0 = s:effective_line(a:lnum-1)
-    endif
+function! s:is_mkdCode(lnum)
+    let name = synIDattr(synID(a:lnum, 1, 0), 'name')
+    return (name =~ '^mkd\%(Code$\|Snippet\)' || name != '' && name !~ '^\%(mkd\|html\)')
+endfunction

 
 

-    let l1 = s:effective_line(a:lnum)
-
-    let l2 = s:effective_line(a:lnum+1)
-
-    if  l2 =~ '^==\+\s*'
-        " next line is underlined (level 1)
-        return '>1'
-    elseif l2 =~ '^--\+\s*'
-        " next line is underlined (level 2)
-        return '>2'
-    elseif l1 =~ '^#'
-        " don't include the section title in the fold
-        return '-1'
-    elseif l0 =~ '^#'
-        " current line starts with hashes
-        return '>'.matchend(l0, '^#\+')
-    else
-        " keep previous foldlevel
-        return '='
-    endif
-endfunc
+if get(g:, "vim_markdown_folding_style_pythonic", 0)
+    function! Foldexpr_markdown(lnum)
+        let l1 = getline(a:lnum)
+        " keep track of fenced code blocks
+        if l1 =~ '````*' || l1 =~ '\~\~\~\~*'
+            if b:fenced_block == 0
+                let b:fenced_block = 1
+            elseif b:fenced_block == 1
+                let b:fenced_block = 0
+            endif
+        elseif g:vim_markdown_frontmatter == 1
+            if b:front_matter == 1 && a:lnum > 2
+                let l0 = getline(a:lnum-1)
+                if l0 == '---'
+                    let b:front_matter = 0
+                endif
+            elseif a:lnum == 1
+                if l1 == '---'
+                    let b:front_matter = 1
+                endif
+            endif
+        endif
+
+        if b:fenced_block == 1 || b:front_matter == 1
+            if a:lnum == 1
+                " fold any 'preamble'
+                return '>1'
+            else
+                " keep previous foldlevel
+                return '='
+            endif
+        endif
+
+        let l2 = getline(a:lnum+1)
+        if l2 =~ '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
+            " next line is underlined (level 1)
+            return '>0'
+        elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
+            " next line is underlined (level 2)
+            return '>1'
+        endif
+
+        if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
+            " current line starts with hashes
+            return '>'.(matchend(l1, '^#\+') - 1)
+        elseif a:lnum == 1
+            " fold any 'preamble'
+            return '>1'
+        else
+            " keep previous foldlevel
+            return '='
+        endif
+    endfunction
+
+    function! Foldtext_markdown()
+        let line = getline(v:foldstart)
+        let has_numbers = &number || &relativenumber
+        let nucolwidth = &fdc + has_numbers * &numberwidth
+        let windowwidth = winwidth(0) - nucolwidth - 6
+        let foldedlinecount = v:foldend - v:foldstart
+        let line = strpart(line, 0, windowwidth - 2 -len(foldedlinecount))
+        let line = substitute(line, '\%("""\|''''''\)', '', '')
+        let fillcharcount = windowwidth - len(line) - len(foldedlinecount) + 1
+        return line . ' ' . repeat("-", fillcharcount) . ' ' . foldedlinecount
+    endfunction
+else
+    function! Foldexpr_markdown(lnum)
+        if (a:lnum == 1)
+            let l0 = ''
+        else
+            let l0 = getline(a:lnum-1)
+        endif
+
+        " keep track of fenced code blocks
+        if l0 =~ '````*' || l0 =~ '\~\~\~\~*'
+            if b:fenced_block == 0
+                let b:fenced_block = 1
+            elseif b:fenced_block == 1
+                let b:fenced_block = 0
+            endif
+        elseif g:vim_markdown_frontmatter == 1
+            if b:front_matter == 1
+                if l0 == '---'
+                    let b:front_matter = 0
+                endif
+            elseif a:lnum == 2
+                if l0 == '---'
+                    let b:front_matter = 1
+                endif
+            endif
+        endif

 
 

+        if b:fenced_block == 1 || b:front_matter == 1
+            " keep previous foldlevel
+            return '='
+        endif
+
+        let l2 = getline(a:lnum+1)
+        if  l2 =~ '^==\+\s*' && !s:is_mkdCode(a:lnum+1)
+            " next line is underlined (level 1)
+            return '>1'
+        elseif l2 =~ '^--\+\s*' && !s:is_mkdCode(a:lnum+1)
+            " next line is underlined (level 2)
+            if s:vim_markdown_folding_level >= 2
+                return '>1'
+            else
+                return '>2'
+            endif
+        endif
+
+        let l1 = getline(a:lnum)
+        if l1 =~ '^#' && !s:is_mkdCode(a:lnum)
+            " fold level according to option
+            if s:vim_markdown_folding_level == 1 || matchend(l1, '^#\+') > s:vim_markdown_folding_level
+                if a:lnum == line('$')
+                    return matchend(l1, '^#\+') - 1
+                else
+                    return -1
+                endif
+            else
+                " headers are not folded
+                return 0
+            endif
+        endif
+
+        if l0 =~ '^#' && !s:is_mkdCode(a:lnum-1)
+            " previous line starts with hashes
+            return '>'.matchend(l0, '^#\+')
+        else
+            " keep previous foldlevel
+            return '='
+        endif
+    endfunction
+endif
+
+
+let b:fenced_block = 0
+let b:front_matter = 0
+let s:vim_markdown_folding_level = get(g:, "vim_markdown_folding_level", 1)

 
 if !get(g:, "vim_markdown_folding_disabled", 0)
 
 if !get(g:, "vim_markdown_folding_disabled", 0)

-  setlocal foldexpr=Foldexpr_markdown(v:lnum)
-  setlocal foldmethod=expr
+    setlocal foldexpr=Foldexpr_markdown(v:lnum)
+    setlocal foldmethod=expr
+    if get(g:, "vim_markdown_folding_style_pythonic", 0) && get(g:, "vim_markdown_override_foldtext", 1)
+        setlocal foldtext=Foldtext_markdown()
+    endif

 endif
 endif