Merge branch 'dev'

Author: aserebryakov

README.md

@@ -38,6 +38,25 @@ The sequence matching the expression '^\s\*[ ].\*' marks a line as a TODO list i
   [X] Done
 ```
 
+##### Items Hierarchy
+
+If one item has lesser indentation than the next one then the first one is meant
+to be **parent** and the second to be **child**.
+
+###### Example
+
+```
+  [ ] Parent
+    [ ] Child1
+    [ ] Child2
+```
+
+###### Rules:
+* Changig state of the parent item changes the state of all children items accorndantly
+* If all children items are marked done, parent will also be marked as done
+* If parent is marked as done and one of the children changes state to not done
+  parent will also be marked as not done
+
 ##### Commands
 
 * `:VimTodoListsCreateNewItemAbove` - creates a new item in a line above cursor
@@ -126,6 +145,11 @@ Changelog
 * Improves work with indentations of list items
 * Fixed the error when trying to navigate the buffer that doesn't contain items
 
+
+#### 0.4.0
+
+* Added items hierarchy support
+
 Credits
 -------
 

doc/vim-todo-lists.txt

@@ -1,4 +1,4 @@
-*vim-todo-lists.txt*    Version 0.3.0
+*vim-todo-lists.txt*    Version 0.4.0
 *vim-todo-lists*
 
 Plugin for TODO lists management.
@@ -59,6 +59,25 @@ Example
 [ ] Not done
 [X] Done
 
+Items Hierarchy
+---------------
+
+If one item has lesser indentation than the next one then the first one is meant
+to be 'parent' and the second to be 'child'.
+
+Example
+-------
+
+[ ] Parent
+  [ ] Child1
+  [ ] Child2
+
+Rules:
+* Changig state of the parent item changes the state of all children items accorndantly
+* If all children items are marked done, parent will also be marked as done
+* If parent is marked as done and one of the children changes state to not done
+  parent will also be marked as not done
+
 Commands
 --------
 	*:VimTodoListsCreateNewItemAbove* *:VimTodoListsCreateNewItemBelow*
@@ -159,6 +178,10 @@ SOFTWARE.
 * Improves work with indentations of list items
 * Fixed the error when trying to navigate the buffer that doesn't contain items
 
+0.4.0
+
+* Added items hierarchy support
+
 ==============================================================================
 8. Credits                                                 *VimTodoListsCredits*
 

plugin/vim-todo-lists.vim

@@ -44,6 +44,147 @@ function! VimTodoListsInit()
 endfunction
 
 
+" Sets the item done
+function! VimTodoListsSetItemDone(lineno)
+  let l:line = getline(a:lineno)
+  call setline(a:lineno, substitute(l:line, '^\(\s*\)\[ \]', '\1[X]', ''))
+endfunction
+
+
+" Sets the item not done
+function! VimTodoListsSetItemNotDone(lineno)
+  let l:line = getline(a:lineno)
+  call setline(a:lineno, substitute(l:line, '^\(\s*\)\[X\]', '\1[ ]', ''))
+endfunction
+
+
+" Checks that line is a todo list item
+function! VimTodoListsLineIsItem(line)
+  if match(a:line, '^\s*\[[ X]\].*') != -1
+    return 1
+  else
+
+  return 0
+endfunction
+
+
+" Checks that item is not done
+function! VimTodoListsItemIsNotDone(line)
+  if match(a:line, '^\s*\[ \].*') != -1
+    return 1
+  else
+    return 0
+  endif
+
+  return 0
+endfunction
+
+
+" Checks that item is done
+function! VimTodoListsItemIsDone(line)
+  if match(a:line, '^\s*\[X\].*') != -1
+    return 1
+  else
+    return 0
+  endif
+
+  return 0
+endfunction
+
+
+" Counts the number of leading spaces
+function! VimTodoListsCountLeadingSpaces(line)
+  return (strlen(a:line) - strlen(substitute(a:line, '^\s*', '', '')))
+endfunction
+
+
+" Returns the line number of the parent
+function! VimTodoListsFindParent(lineno)
+  let l:indent = VimTodoListsCountLeadingSpaces(getline(a:lineno))
+  let l:parent_lineno = -1
+
+  for current_line in range (a:lineno, 1, -1)
+    if (VimTodoListsLineIsItem(getline(current_line)) &&
+      \ VimTodoListsCountLeadingSpaces(getline(current_line)) < l:indent)
+      let l:parent_lineno = current_line
+      break
+    endif
+  endfor
+
+  return l:parent_lineno
+endfunction
+
+
+" Returns the line number of the last child
+function! VimTodoListsFindLastChild(lineno)
+  let l:indent = VimTodoListsCountLeadingSpaces(getline(a:lineno))
+  let l:last_child_lineno = a:lineno
+
+  " If item is the last line in the buffer it has no children
+  if a:lineno == line('$')
+    return l:last_child_lineno
+  endif
+
+  for current_line in range (a:lineno + 1, line('$'))
+    if (VimTodoListsLineIsItem(getline(current_line)) &&
+      \ VimTodoListsCountLeadingSpaces(getline(current_line)) > l:indent)
+      let l:last_child_lineno = current_line
+    else
+      break
+    endif
+  endfor
+
+  return l:last_child_lineno
+endfunction
+
+
+" Marks the parent done if all children are done
+function! VimTodoListsUpdateParent(lineno)
+  let l:parent_lineno = VimTodoListsFindParent(a:lineno)
+
+  " No parent item
+  if l:parent_lineno == -1
+    return
+  endif
+
+  let l:last_child_lineno = VimTodoListsFindLastChild(l:parent_lineno)
+
+  " There is no children
+  if l:last_child_lineno == l:parent_lineno
+    return
+  endif
+
+  for current_line in range(l:parent_lineno + 1, l:last_child_lineno)
+    if VimTodoListsItemIsNotDone(getline(current_line)) == 1
+      " Not all children are done
+      call VimTodoListsSetItemNotDone(l:parent_lineno)
+      call VimTodoListsUpdateParent(l:parent_lineno)
+      return
+    endif
+  endfor
+
+  call VimTodoListsSetItemDone(l:parent_lineno)
+  call VimTodoListsUpdateParent(l:parent_lineno)
+endfunction
+
+
+" Applies the function for each child
+function! VimTodoListsForEachChild(lineno, function)
+  let l:last_child_lineno = VimTodoListsFindLastChild(a:lineno)
+
+  " No children items
+  if l:last_child_lineno == a:lineno
+    call call(a:function, [a:lineno])
+    return
+  endif
+
+  for current_line in range(a:lineno, l:last_child_lineno)
+    call call(a:function, [current_line])
+  endfor
+
+endfunction
+
+
 " Sets mapping for normal navigation and editing mode
 function! VimTodoListsSetNormalMode()
   nunmap <buffer> o
@@ -114,12 +255,13 @@ endfunction
 function! VimTodoListsToggleItem()
   let l:line = getline('.')
 
-  if match(l:line, '^\s*\[ \].*') != -1
-    call setline('.', substitute(l:line, '^\(\s*\)\[ \]', '\1[X]', ''))
-  elseif match(l:line, '^\s*\[X\] .*') != -1
-    call setline('.', substitute(l:line, '^\(\s*\)\[X\]', '\1[ ]', ''))
+  if VimTodoListsItemIsNotDone(l:line) == 1
+    call VimTodoListsForEachChild(line('.'), 'VimTodoListsSetItemDone')
+  elseif VimTodoListsItemIsDone(l:line) == 1
+    call VimTodoListsForEachChild(line('.'), 'VimTodoListsSetItemNotDone')
   endif
 
+  call VimTodoListsUpdateParent(line('.'))
 endfunction