Merge pull request #373 from Nudin/wontdo

"Won't-do" state for checkbox list items

autoload/vimwiki/html.vim

@@ -876,6 +876,8 @@ function! s:process_tag_list(line, lists) "{{{
       let n = len(g:vimwiki_listsyms_list)
       if completion == 0
         let st_tag = '<li class="done0">'
+      elseif completion == -1 && chk[1] == g:vimwiki_listsym_rejected
+        let st_tag = '<li class="rejected">'
       elseif completion > 0 && completion < n
         let completion = float2nr(round(completion / (n-1.0) * 3.0 + 0.5 ))
         let st_tag = '<li class="done'.completion.'">'

autoload/vimwiki/lst.vim

@@ -693,6 +693,9 @@ function! s:get_rate(item) "{{{
     return -1
   endif
   let state = a:item.cb
+  if state == g:vimwiki_listsym_rejected
+    return -1
+  endif
   let n=len(g:vimwiki_listsyms_list)
   return index(g:vimwiki_listsyms_list, state) * 100/(n-1)
 endfunction "}}}
@@ -735,6 +738,8 @@ function! s:rate_to_state(rate) "{{{
     let state = g:vimwiki_listsyms_list[n-1]
   elseif a:rate == 0
     let state = g:vimwiki_listsyms_list[0]
+  elseif a:rate == -1
+    let state = g:vimwiki_listsym_rejected
   else
     let index = float2nr(ceil(a:rate/100.0*(n-2)))
     let state = g:vimwiki_listsyms_list[index]
@@ -759,8 +764,11 @@ function! s:update_state(item) "{{{
       break
     endif
     if child_item.cb != ''
+      let rate = s:get_rate(child_item)
+      if rate != -1
         let count_children_with_cb += 1
-      let sum_children_rate += s:get_rate(child_item)
+        let sum_children_rate += rate
+      endif
     endif
     let child_item = s:get_next_child_item(a:item, child_item)
   endwhile
@@ -835,6 +843,46 @@ function! s:change_cb(from_line, to_line, new_rate) "{{{
 
 endfunction "}}}
 
+"Toggles checkbox between two states in the lines of the given range,
+"creates chceckboxes if there aren't any.
+function! s:toggle_create_cb(from_line, to_line, state1, state2) "{{{
+  let from_item = s:get_corresponding_item(a:from_line)
+  if from_item.type == 0
+    return
+  endif
+
+  if from_item.cb == ''
+
+    "if from_line has no CB, make a CB in every selected line
+    let parent_items_of_lines = []
+    for cur_ln in range(from_item.lnum, a:to_line)
+      let cur_item = s:get_item(cur_ln)
+      let success = s:create_cb(cur_item)
+
+      if success
+        let cur_parent_item = s:get_parent(cur_item)
+        if index(parent_items_of_lines, cur_parent_item) == -1
+          call insert(parent_items_of_lines, cur_parent_item)
+        endif
+      endif
+    endfor
+
+    for parent_item in parent_items_of_lines
+      call s:update_state(parent_item)
+    endfor
+
+  else
+
+    "if from_line has CB, toggle it and set all siblings to the same new state
+    let rate_first_line = s:get_rate(from_item)
+    let new_rate = rate_first_line == a:state1 ? a:state2 : a:state1
+
+    call s:change_cb(a:from_line, a:to_line, new_rate)
+
+  endif
+
+endfunction "}}}
+
 "Decrement checkbox between [ ] and [X]
 "in the lines of the given range
 function! vimwiki#lst#decrement_cb(from_line, to_line) "{{{
@@ -872,41 +920,13 @@ endfunction "}}}
 "Toggles checkbox between [ ] and [X] or creates one
 "in the lines of the given range
 function! vimwiki#lst#toggle_cb(from_line, to_line) "{{{
-  let from_item = s:get_corresponding_item(a:from_line)
+  return s:toggle_create_cb(a:from_line, a:to_line, 100, 0)
-  if from_item.type == 0
+endfunction "}}}
-    return
-  endif
-
-  if from_item.cb == ''
-
-    "if from_line has no CB, make a CB in every selected line
-    let parent_items_of_lines = []
-    for cur_ln in range(from_item.lnum, a:to_line)
-      let cur_item = s:get_item(cur_ln)
-      let success = s:create_cb(cur_item)
-
-      if success
-        let cur_parent_item = s:get_parent(cur_item)
-        if index(parent_items_of_lines, cur_parent_item) == -1
-          call insert(parent_items_of_lines, cur_parent_item)
-        endif
-      endif
-    endfor
-
-    for parent_item in parent_items_of_lines
-      call s:update_state(parent_item)
-    endfor
-
-  else
-
-    "if from_line has CB, toggle it and set all siblings to the same new state
-    let rate_first_line = s:get_rate(from_item)
-    let new_rate = rate_first_line == 100 ? 0 : 100
-
-    call s:change_cb(a:from_line, a:to_line, new_rate)
-
-  endif
 
+"Toggles checkbox between [ ] and [-] or creates one
+"in the lines of the given range
+function! vimwiki#lst#toggle_rejected_cb(from_line, to_line) "{{{
+  return s:toggle_create_cb(a:from_line, a:to_line, -1, 0)
 endfunction "}}}
 
 function! vimwiki#lst#remove_cb(first_line, last_line) "{{{
@@ -1549,6 +1569,10 @@ function! vimwiki#lst#setup_marker_infos() "{{{
 
   "the user can set the listsyms as string, but vimwiki needs a list
   let g:vimwiki_listsyms_list = split(g:vimwiki_listsyms, '\zs')
+
+  if match(g:vimwiki_listsyms, g:vimwiki_listsym_rejected) != -1
+    echomsg "Warning: g:vimwiki_listsyms and g:vimwiki_listsym_rejected overlap"
+  endif
 endfunction "}}}
 
 function! vimwiki#lst#TO_list_item(inner, visual) "{{{

autoload/vimwiki/style.css

@@ -27,6 +27,13 @@ del {text-decoration: line-through; color: #777777;}
 .tag {background-color: #eeeeee; font-family: monospace; padding: 2px;}
 
 /* classes for items of todo lists */
+.rejected {
+    /* list-style: none; */
+    background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAMAAAAMCGV4AAAACXBIWXMAAADFAAAAxQEdzbqoAAAAB3RJTUUH4QgEFhAtuWgv9wAAAPZQTFRFmpqam5iYnJaWnJeXnpSUn5OTopCQpoqKpouLp4iIqIiIrYCAt3V1vW1tv2xsmZmZmpeXnpKS/x4e/x8f/yAg/yIi/yQk/yUl/yYm/ygo/ykp/yws/zAw/zIy/zMz/zQ0/zU1/zY2/zw8/0BA/0ZG/0pK/1FR/1JS/1NT/1RU/1VV/1ZW/1dX/1pa/15e/19f/2Zm/2lp/21t/25u/3R0/3p6/4CA/4GB/4SE/4iI/46O/4+P/52d/6am/6ur/66u/7Oz/7S0/7e3/87O/9fX/9zc/93d/+Dg/+vr/+3t/+/v//Dw//Ly//X1//f3//n5//z8////gzaKowAAAA90Uk5T/Pz8/Pz8/Pz8/Pz8/f39ppQKWQAAAAFiS0dEEnu8bAAAAACuSURBVAhbPY9ZF4FQFEZPSKbIMmWep4gMGTKLkIv6/3/GPbfF97b3w17rA0kQOPgvAeHW6uJ6+5h7HqLdwowgOzejXRXBdx6UdSru216xuOMBHHNU0clTzeSUA6EhF8V8kqroluMiU6HKcuf4phGPr1o2q9kYZWwNq1qfRRmTaXpqsyjj17KkWCxKBUBgXWueHIyiAIg18gsse4KHkLF5IKIY10WQgv7fOy4ST34BRiopZ8WLNrgAAAAASUVORK5CYII=);
+    background-repeat: no-repeat;
+    background-position: 0 .2em;
+    padding-left: 1.5em;
+}
 .done0 {
     /* list-style: none; */
     background-image: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA8AAAAPCAYAAAA71pVKAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAAxQAAAMUBHc26qAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAA7SURBVCiR7dMxEgAgCANBI3yVRzF5KxNbW6wsuH7LQ2YKQK1mkswBVERYF5Os3UV3gwd/jF2SkXy66gAZkxS6BniubAAAAABJRU5ErkJggg==);

doc/vimwiki.txt

@@ -455,6 +455,13 @@ gLI                     Change the symbol of the current list to
                         To remap: >
                         noremap glo :VimwikiChangeSymbolTo I)<CR>
                         noremap glO :VimwikiChangeSymbolInListTo I)<CR>
+<
+                        *vimwiki_glx*
+glx                     Toggle checkbox of a list item disabled/off.
+                        Maps to |:VimwikiToggleRejectedListItem|.
+                        See |vimwiki-todo-lists|.
+                        To remap: >
+                        :map <Leader>tx <Plug>VimwikiToggleRejectedListItem
 <
                         *vimwiki_gqq*  *vimwiki_gww*
 gqq                     Format table. If you made some changes to a table
@@ -656,6 +663,10 @@ Vimwiki file.
     Toggle checkbox of a list item on/off.
     See |vimwiki-todo-lists|.
 
+*:VimwikiToggleRejectedListItem*
+    Toggle checkbox of a list item disabled/off.
+    See |vimwiki-todo-lists|.
+
 *:VimwikiListChangeLevel* CMD
     Change the nesting level, or symbol, for a single-line list item.
     CMD may be ">>" or "<<" to change the indentation of the item, or
@@ -1621,6 +1632,10 @@ Use gl<Space> (see |vimwiki_gl<Space>|) to remove a single checkbox and
 gL<Space> (see |vimwiki_gL<Space>|) to remove all checkboxes of the list the
 cursor is in.
 
+You can mark an item as rejected ("won't do") with
+|vimwiki_glx|. A rejected item will not influence the status of it's
+parents.
+
 
 ==============================================================================
 9. Tables                                                     *vimwiki-tables*
@@ -2345,6 +2360,19 @@ You can set it to some more fancy symbols like this:
    let g:vimwiki_listsyms = '✗○◐●✓'
 
 
+------------------------------------------------------------------------------
+*g:vimwiki_listsym_rejected*
+
+Character that is used to show that an item of a todo list will not be done.
+Default value is '-'.
+
+The character used here may not be part of g:vimwiki_listsyms.
+
+You can set it to some more fancy symbols like this:
+>
+   let g:vimwiki_listsym_rejected = '✗'
+
+
 ------------------------------------------------------------------------------
 *g:vimwiki_use_mouse*
 

ftplugin/vimwiki.vim

@@ -295,6 +295,7 @@ command! -buffer -range -nargs=1 VimwikiChangeSymbolTo call vimwiki#lst#change_m
 command! -buffer -range -nargs=1 VimwikiListChangeSymbolI call vimwiki#lst#change_marker(<line1>, <line2>, <f-args>, 'i')
 command! -buffer -nargs=1 VimwikiChangeSymbolInListTo call vimwiki#lst#change_marker_in_list(<f-args>)
 command! -buffer -range VimwikiToggleListItem call vimwiki#lst#toggle_cb(<line1>, <line2>)
+command! -buffer -range VimwikiToggleRejectedListItem call vimwiki#lst#toggle_rejected_cb(<line1>, <line2>)
 command! -buffer -range VimwikiIncrementListItem call vimwiki#lst#increment_cb(<line1>, <line2>)
 command! -buffer -range VimwikiDecrementListItem call vimwiki#lst#decrement_cb(<line1>, <line2>)
 command! -buffer -range -nargs=+ VimwikiListChangeLvl call vimwiki#lst#change_level(<line1>, <line2>, <f-args>)
@@ -442,10 +443,18 @@ if !hasmapto('<Plug>VimwikiToggleListItem')
     vmap <silent><buffer> <C-@> <Plug>VimwikiToggleListItem
   endif
 endif
+if !hasmapto('<Plug>VimwikiToggleRejectedListItem')
+  nmap <silent><buffer> glx <Plug>VimwikiToggleRejectedListItem
+  vmap <silent><buffer> glx <Plug>VimwikiToggleRejectedListItem
+endif
 nnoremap <silent><script><buffer>
       \ <Plug>VimwikiToggleListItem :VimwikiToggleListItem<CR>
 vnoremap <silent><script><buffer>
       \ <Plug>VimwikiToggleListItem :VimwikiToggleListItem<CR>
+nnoremap <silent><script><buffer>
+      \ <Plug>VimwikiToggleRejectedListItem :VimwikiToggleRejectedListItem<CR>
+vnoremap <silent><script><buffer>
+      \ <Plug>VimwikiToggleRejectedListItem :VimwikiToggleRejectedListItem<CR>
 
 if !hasmapto('<Plug>VimwikiIncrementListItem')
   nmap <silent><buffer> gln <Plug>VimwikiIncrementListItem

plugin/vimwiki.vim

@@ -373,6 +373,7 @@ call s:default('hl_cb_checked', 0)
 call s:default('list_ignore_newline', 1)
 call s:default('text_ignore_newline', 1)
 call s:default('listsyms', ' .oOX')
+call s:default('listsym_rejected', '-')
 call s:default('use_calendar', 1)
 call s:default('table_mappings', 1)
 call s:default('table_auto_fmt', 1)

syntax/vimwiki_default.vim

@@ -79,7 +79,7 @@ let g:vimwiki_rxListDefine = '::\(\s\|$\)'
 call vimwiki#lst#setup_marker_infos()
 
 let g:vimwiki_rxListItemWithoutCB = '^\s*\%(\('.g:vimwiki_rxListBullet.'\)\|\('.g:vimwiki_rxListNumber.'\)\)\s'
-let g:vimwiki_rxListItem = g:vimwiki_rxListItemWithoutCB . '\+\%(\[\(['.g:vimwiki_listsyms.']\)\]\s\)\?'
+let g:vimwiki_rxListItem = g:vimwiki_rxListItemWithoutCB . '\+\%(\[\(['.g:vimwiki_listsyms.g:vimwiki_listsym_rejected.']\)\]\s\)\?'
 let g:vimwiki_rxListItemAndChildren = '^\(\s*\)\%('.g:vimwiki_rxListBullet.'\|'.g:vimwiki_rxListNumber.'\)\s\+\['.g:vimwiki_listsyms_list[-1].'\]\s.*\%(\n\%(\1\s.*\|^$\)\)*'
 
 " Preformatted text

syntax/vimwiki_markdown.vim

@@ -76,7 +76,7 @@ let g:vimwiki_rxListDefine = '::\%(\s\|$\)'
 call vimwiki#lst#setup_marker_infos()
 
 let g:vimwiki_rxListItemWithoutCB = '^\s*\%(\('.g:vimwiki_rxListBullet.'\)\|\('.g:vimwiki_rxListNumber.'\)\)\s'
-let g:vimwiki_rxListItem = g:vimwiki_rxListItemWithoutCB . '\+\%(\[\(['.g:vimwiki_listsyms.']\)\]\s\)\?'
+let g:vimwiki_rxListItem = g:vimwiki_rxListItemWithoutCB . '\+\%(\[\(['.g:vimwiki_listsyms.g:vimwiki_listsym_rejected.']\)\]\s\)\?'
 let g:vimwiki_rxListItemAndChildren = '^\(\s*\)\%('.g:vimwiki_rxListBullet.'\|'.g:vimwiki_rxListNumber.'\)\s\+\['.g:vimwiki_listsyms_list[-1].'\]\s.*\%(\n\%(\1\s.*\|^$\)\)*'
 
 " Preformatted text

syntax/vimwiki_media.vim

@@ -57,7 +57,7 @@ let g:vimwiki_rxListDefine = '^\%(;\|:\)\s'
 call vimwiki#lst#setup_marker_infos()
 
 let g:vimwiki_rxListItemWithoutCB = '^\s*\%(\('.g:vimwiki_rxListBullet.'\)\|\('.g:vimwiki_rxListNumber.'\)\)\s'
-let g:vimwiki_rxListItem = g:vimwiki_rxListItemWithoutCB . '\+\%(\[\(['.g:vimwiki_listsyms.']\)\]\s\)\?'
+let g:vimwiki_rxListItem = g:vimwiki_rxListItemWithoutCB . '\+\%(\[\(['.g:vimwiki_listsyms.g:vimwiki_listsym_rejected.']\)\]\s\)\?'
 let g:vimwiki_rxListItemAndChildren = '^\('.g:vimwiki_rxListBullet.'\)\s\+\['.g:vimwiki_listsyms_list[-1].'\]\s.*\%(\n\%(\1\%('.g:vimwiki_rxListBullet.'\).*\|^$\|\s.*\)\)*'
 
 " Preformatted text