Micro release

Fix and close #14 and #15
Merge PR#13 and PR#16

.gitignore

@@ -1,2 +1,3 @@
 *.swp
 doc/tags
+*.pyc

README.markdown

@@ -1,93 +1,157 @@
-# Readme
+# Todo.txt-vim
 
-**Note:** Since v0.7.3, `TodoComplete` is `todo#Complete`, you might need to
+        #####                                                #     #
-update your vimrc.
+          #    ####  #####   ####     ##### #    # #####     #     # # #    #
+          #   #    # #    # #    #      #    #  #    #       #     # # ##  ##
+          #   #    # #    # #    #      #     ##     #   ### #     # # # ## #
+          #   #    # #    # #    #      #     ##     #        #   #  # #    #
+          #   #    # #    # #    # ##   #    #  #    #         # #   # #    #
+          #    ####  #####   ####  ##   #   #    #   #          #    # #    #
 
-## What is this plugin ?
+                        Efficient Todo.txt management in vim
+
+## Table of Contents
+
+1. [Release notes](#release-notes)
+2. [Introduction](#introduction)
+    1. [Todo.txt rules](#todo.txt-rules)
+    2. [Why this Fork ?](#Why-this-fork)
+    3. [Installation](#installation)
+3. [TodoTxt Files](#todotxt-files)
+4. [Completion](#completion)
+5. [Hierarchical Sort](#hierarchical-sort)
+6. [Mappings](#mappings)
+    1. [Sort](#sort)
+    2. [Priorities](#priorities)
+    3. [Dates](#dates)
+    4. [Done](#done)
+
+## Release notes
+
++   V0.8.1 Incorporates yet antoher Fretep work : highlithing for tasks due today.
+
++   v0.8 Incorporates Fretep's work on overdue dates (PR#13 and PR#16) witch
+removes python dependency, allow to control the cursor position after a sort by
+todo (see (sort)[#sort] and/or issue #15) and fixes bug when sorting a file
+containing only lines with due:date (issue #14).
+
++   v0.7.6 Incorporates [Sietse's work](https://github.com/sietse/todo.txt-vim/commit/57d45200c8b033d31c9191ee0eb0711c801cdb1d) to make cancel and mark as done mapping repeatable using [vim-repeat](https://github.com/tpope/vim-repeat).
++   v0.7.5 Incorporates [Fievel's work](https://github.com/fievel/todo.txt-vim/commit/0863e1434e9a89ace06c4856b6cb32ba9906e3de) to make overduedates work on python3.
++   v0.7.4 includes the overduedate support from Guilherme Victal (see pull
+
+    [request #45 on freitass version](https://github.com/freitass/todo.txt-vim/pull/45)),
+    it highlight dates in overdue tasks as an Error. It depends on a
+    Python library, however, and as such will only be able to work if your version
+    of Vim was compiled with the `+python` option (as most common versions do).
+ 
+    If your Vim installation does **not** have Python support, this plugin **will work just fine** but this feature will be disabled.
+
+
++   Since v0.7.3, `TodoComplete` is replaced by `todo#Complete`, you might need to update your vimrc (see [completion](#completion)).
+
+## Introduction
+
+Todo.txt-vim is a plugin to manage todo.txt files it was initially designed by
+[Freitass](https://github.com/freitass/todo.txt-vim) then forked and improved
+by David Beniamine.
+
+### Todo.txt rules
+
+Todo.txt is a standard human readable todo notes file defined [here](http://todotxt.com):
+
+"The todo.txt format is a simple set of
+[rules](https://github.com/ginatrapani/todo.txt-cli/wiki/The-Todo.txt-Format)
+that make todo.txt both human and machine-readable. The format supports
+priorities, creation and completion dates, projects and contexts. That's
+all you need to be productive. See an example Todo.txt file":
+
+    (A) Call Mom @Phone +Family
+    (A) Schedule annual checkup +Health
+    (B) Outline chapter 5 +FamilyNovel @Computer
+    (C) Add cover sheets @ComputerOffice +FamilyTPSReports
+    Plan backyard herb garden @ComputerHome
+    Pick up milk @ComputerGroceryStore
+    Research self-publishing services +FamilyNovel @ComputerComputer
+    x Download Todo.txt mobile app @ComputerPhone
+
+### Why this fork ?
 
 This plugin is a fork of [freitass
-todo.txt](https://github.com/freitass/todo.txt-vim). It add severals
+todo.txt-vim](https://github.com/freitass/todo.txt-vim). It add severals cool
-functionalities including a [hierarchical sort](#sort), a
+functionalities including:
-[complete](#completion) function, some stuff to handle [due
-dates](#due-dates), a more [flexible file naming](#flexible-file-naming), and
-others stuff see [new features](#new-features).
 
-Freitass announced on october 30th 2014 that he is not going to merge his version.
++ [Hierarchical sort](##hierarchical-sort)
++ [A completion function](#completion)
++ [A proper handling of due dates](#dates)
++ [A Flexible file naming](#todotxt-files).
++ Syntax Highlight for couples key:value.
++ `<LocalLeader>x` is a toggle which allow you to unmark a task as done.
++ `<LocalLeader>C` Toggle Mark a task cancelled
++ If the current buffer is a done.txt file, the basic sort sorts on
+  completion date.
++ ...
 
-## Install
+### Installation
 
-### Quick install
+#### Vizardry
 
-    git clone https://github.com/dbeniamine/todo.txt-vim.git
+If you have [Vizardry](https://github.com/dbeniamine/vizardry) installed,
-    cd todo.txt-vim
+you can run from vim:
-    cp -r ./* ~/.vim
+
+    :Invoke -u dbeniamine todo.txt-vim
+
+#### Pathogen install
+
+    git clone https://github.com/dbeniamine/todo.txt-vim.git ~/.vim/bundle/todo.txt-vim
+
+Then from vim: `:Helptags` to update the doc
+
+#### Quick install
+
+        git clone https://github.com/dbeniamine/todo.txt-vim.git
+        cd todo.txt-vim
+        cp -r ./* ~/.vim
 
 
 If you want the help installed, run `:helptags ~/.vim/doc` inside vim after
 having copied the files.  Then you will be able to get the commands help with:
 `:h todo.txt`
 
-### Pathogen install
+## TodoTxt Files
 
-    git clone https://github.com/dbeniamine/todo.txt-vim.git ~/.vim/bundle/todo.txt-vim
+This plugin provides a Flexible file naming for todo.txt, all the following
+names are recognized as todo:
 
-Then from vim: `:Helptags` to update the doc
+    YYYY-MM-[Tt]odo.txt
+    YYYY-MM-DD[Tt]odo.txt
+    [Tt]odo-YYYY-MM.txt
+    [Tt]odo-YYYY-MM-DD.txt
+    [Tt]odo.txt
+    [Tt]oday.txt
 
-## Features included in Freitass version
+And obviously the same are recognize as done:
 
-This plugin gives syntax highlighting to [todo.txt](http://todotxt.com/) files. It also defines a few mappings, to help with editing these files:
+    YYYY-MM-[Dd]one.txt
+    YYYY-MM-DD[Dd]one.txt
+    [Dd]one-YYYY-MM.txt
+    [Dd]one-YYYY-MM-DD.txt
+    [Dd]one.txt
+    [Dd]one-[Tt]oday.txt
 
-`<LocalLeader>s` : Sort the file
+Moreover, `<LocalLeader>D` moves the task under the cursor to the done.txt
+file corresponding to the current todo.txt, aka if you are editing
+2015-07-07-todo.txt, the done file while be 2015-07-07-done.txt. If you don't
+like this behavior, you can set the default done.txt name:
 
-`<LocalLeader>s+` : Sort the file on +Projects
+    let g:TodoTxtForceDoneName='done.txt'
 
-`<LocalLeader>s@` : Sort the file on @Contexts
+## Completion
 
-`<LocalLeader>j` : Lower the priority of the current line
+This plugin provides a nice complete function for project and context, to use
+it add the following lines to your vimrc:
 
-`<LocalLeader>k` : Increase the priority of the current line
+    " Use todo#Complete as the omni complete function for todo files
-
+    au filetype todo setlocal omnifunc=todo#Complete
-`<LocalLeader>a` : Add the priority (A) to the current line
-
-`<LocalLeader>b` : Add the priority (B) to the current line
-
-`<LocalLeader>c` : Add the priority (C) to the current line
-
-`<LocalLeader>d` : Insert the current date
-
-`date<tab>`  : (Insert mode) Insert the current date
-
-`<LocalLeader>x` : Toggle mark task as done (inserts current date as completion date)
-
-`<LocalLeader>X` : Mark all tasks as completed
-
-`<leader>-D` : Move completed tasks to done.txt
-
-## New features
-
-### Sort
-
-This fork provides a hierarchical sorting function designed to do by project
-and/or by context sorts and a priority sort.
-
-`<LocalLeader>sc` : Sort the file by context then by priority
-`<LocalLeader>scp` : Sort the file by context, project then by priority
-`<LocalLeader>sp` : Sort the file by project then by priority
-`<LocalLeader>spc` : Sort the file by project, context then by priority
-
-The user can give argument for the two call to vim sort function by changing
-the following variables in its vimrc:
-see :help sort
-    let g:Todo_txt_first_level_sort_mode="! i"
-    let g:Todo_txt_second_level_sort_mode="i"
-
-### Completion
-
-We also provide a nice complete function for project and context, to use it
-add the following lines to your vimrc:
-
-    " Use todo#complete as the omni complete function for todo files
-    au filetype todo setlocal omnifunc=todo#complete
 
 You can also start automatically the completion when entering '+' or '@' by
 adding the next lines to your vimrc:
@@ -98,66 +162,100 @@ adding the next lines to your vimrc:
     " Auto complete contexts
     au filetype todo imap <buffer> @ @<C-X><C-O>
 
-The `todo#complete` function is designed to complete projects (starting by '+')
+
-and context (starting by '@'). If you use it on a regular word, it will do a
+The `todo#Complete` function is designed to complete projects (starting by `+`)
+and context (starting by `@`). If you use it on a regular word, it will do a
 normal keyword completion (on all buffers).
+
 If you try to complete a project, it will propose all projects in all open
 buffers and for each of them, it will show their context and the name of the
-buffers in which they appears in the preview window.
+buffers in which they appears in the preview window. It does the same thing
-TodoCompelte does the same thing for context except that it gives in the
+for context except that it gives in the preview the list of projects existing
-preview the list of projects existing in each existing contexts.
+in each existing contexts.
 
-### Due dates
+## Hierarchical sort
 
-I've integrated the [work from
+This fork provides a hierarchical sorting function designed to do by project
-durcheinandr](https://github.com/durcheinandr/todo.txt-vim/) concerning due
+and/or by context sorts and a priority sort.
-dates + some little improvements:
 
-Accorrding to the todo.txt rules, one can define due dates using `due:date` or
+`<LocalLeader>sc` : Sort the file by context then by priority
-`DUE:date` or any other  `key:value` combination. This plugins handle dates at
+`<LocalLeader>scp` : Sort the file by context, project then by priority
-the format `YYYY-MM-DD` and the key `due` can be spell using any combination
+`<LocalLeader>sp` : Sort the file by project then by priority
-of lower and upper case letters. The following mappings are provided:
+`<LocalLeader>spc` : Sort the file by project, context then by priority
 
-`<leader>-sd` : Sort the file by due-date. Entries with a due date appears
+The user can give argument for the two calls to vim sort function by changing
+the following variables:
+
+    g:Todo_txt_first_level_sort_mode
+    g:Todo_txt_second_level_sort_mode
+
+Defaults values are:
+
+
+    g:Todo_txt_first_level_sort_mode="i"
+    g:Todo_txt_second_level_sort_mode="i"
+
+
+For more information on the available flags see `help :sort`
+
+## Mappings
+
+By default todo-txt.vim set all the mappings secribed in this section. To
+prevent this behavior, add the following line to your vimrc
+
+   let g:Todo_txt_do_not_map=1
+
+
+
+`<LocalLeader>` is \  by default, so ̀`<LocaLeader>-s` means you type \s
+
+### Sort
+
++ `<LocalLeader>s` : Sort the file by priority
++ `<LocalLeader>s+` : Sort the file on `+Projects`
++ `<LocalLeader>s@` : Sort the file on `@Contexts`
++ `<LocalLeader>sd` : Sort the file on due dates
++ `<LocalLeader>sc` : Sort the file by context then by priority
++ `<LocalLeader>scp` : Sort the file by context, project then by priority
++ `<LocalLeader>sp` : Sort the file by project then by priority
++ `<LocalLeader>spc` : Sort the file by project, context then by priority
++ `<leader>-sd` : Sort the file by due-date. Entries with a due date appears
 sorted by at the beginning of the file, the rest of the file is not modified.
 
-`due:`  : (Insert mode) Insert `due:` followed by the current date
+When you sort by due dates, at the end of the sort, your cursor will be placed
+at the top of the file. This behavior can be set with the following global
+variable :
 
-`DUE:`  : (Insert mode) Insert `DUE:` followed by the current date
+    let g:TodoTxtSortDueDateCursorPos = "top"
 
-### Flexible File naming
+Possible values are :
 
-This plugin provides a Flexible file naming for todo.txt, all the following
++ `top` (default): The first line of the buffer, i.e. your most outstanding task
-names are recognized as todo:
++ `lastdue`: The last task with a due:date set
++ `notoverdue`: The first task that is not overdue (requires #13)
++ `bottom`: The last line of the buffer
 
-        YYYY-MM-[Tt]odo.txt
+### Priorities
-        YYYY-MM-DD[Tt]odo.txt
-        [Tt]odo-YYYY-MM.txt
-        [Tt]odo-YYYY-MM-DD.txt
-        [Tt]odo.txt
-        [Tt]oday.txt
 
-And obviously the same are recognize as done:
++ `<LocalLeader>j` : Lower the priority of the current line
++ `<LocalLeader>k` : Increase the priority of the current line
++ `<LocalLeader>a` : Add the priority (A) to the current line
++ `<LocalLeader>b` : Add the priority (B) to the current line
++ `<LocalLeader>c` : Add the priority (C) to the current line
 
-        YYYY-MM-[Dd]one.txt
+### Dates
-        YYYY-MM-DD[Dd]one.txt
-        [Dd]one-YYYY-MM.txt
-        [Dd]one-YYYY-MM-DD.txt
-        [Dd]one.txt
-        [Dd]one-[Tt]oday.txt
 
-Moreover, remove complete tasks `<LocalLeader>D` moves the task to the
++ `<LocalLeader>d` : Insert the current date
-done.txt file corresponding to the current todo.txt, aka if you are editing
++ `date<tab>`  : (Insert mode) Insert the current date
-2015-07-07-todo.txt, the done file while be 2015-07-07-done.txt. If you don't
++ `due:`  : (Insert mode) Insert `due:` followed by the current date
-like this behavior, you can set the default done.txt name:
++ `DUE:`  : (Insert mode) Insert `DUE:` followed by the current date
 
-    let g:TodoTxtForceDoneName='done.txt'
+### Done
 
-### Others
 
-`<LocalLeader>x` is a toggle which allow you to unmark a task as done.
++ `<LocalLeader>x` : Toggle mark task as done (inserts or remove current
-
++ date as completion date)
-Syntax highlighting for couples key:value
++ `<LocalLeader>C` : Toggle mark task cancelled
-
++ `<LocalLeader>X` : Mark all tasks as completed
-If the current buffer is a done.txt file, the basic sort sorts on completion
++ `<LocalLeader>D` : Move completed tasks to done file, see [TodoTxt
-date.
+Files](#todotxt-files)

autoload/todo.vim

@@ -3,7 +3,6 @@
 " Author:      David Beniamine <david@beniamine.net>
 " Licence:     Vim licence
 " Website:     http://github.com/dbeniamine/todo.txt.vim
-" Version:     0.7.3
 " vim: ts=4 sw=4 :help tw=78 cc=80
 
 " These two variables are parameters for the successive calls the vim sort
@@ -23,6 +22,14 @@ endif
 
 " Functions {{{1
 
+
+function! todo#GetCurpos()
+    if exists("*getcurpos")
+        return getcurpos()
+    endif
+        return getpos('.')
+endfunction
+
 " Increment and Decrement The Priority
 :set nf=octal,hex,alpha
 
@@ -35,7 +42,7 @@ function! todo#PrioritizeDecrease()
 endfunction
 
 function! todo#PrioritizeAdd (priority)
-    let oldpos=getcurpos()
+    let oldpos=todo#GetCurpos()
     let line=getline('.')
     if line !~ '^([A-F])'
         :call todo#PrioritizeAddAction(a:priority)
@@ -55,28 +62,40 @@ function! todo#RemovePriority()
 endfunction
 
 function! todo#PrependDate()
-    normal! 0"=strftime("%Y-%m-%d ")
+    if (getline(".") =~ '\v^\(')
-P
+	execute "normal! 0f)a\<space>\<esc>l\"=strftime(\"%Y-%m-%d\")\<esc>P"
-endfunction
-
-function! todo#ToggleMarkAsDone()
-    if (getline(".") =~ 'x\s*\d\{4\}')
     else
-    else
+        normal! 0"=strftime("%Y-%m-%d ")
 P
     endif
 endfunction
-
+
-function! todo#UnMarkAsDone()
+function! todo#ToggleMarkAsDone(status)
+    if (getline(".") =~ 'x\s*\d\{4\}')
+        :call todo#UnMarkAsDone(a:status)
+    else
+        :call todo#MarkAsDone(a:status)
     endif
 endfunction
-
+
+function! todo#UnMarkAsDone(status)
+    if a:status==''
+        let pat=''
+    else
+        let pat=' '.a:status
+    endif
+    exec ':s/\s*x\s*\d\{4}-\d\{1,2}-\d\{1,2}'.pat.'\s*//g'
+endfunction
+
+function! todo#MarkAsDone(status)
+    if a:status!=''
+        exec 'normal! I'.a:status.' '
     endif
     call todo#PrependDate()
     normal! Ix 
 endfunction
 
-function! todo#MarkAllAsDone()
+function! todo#MarkAllAsDone()
     :g!/^x /:call todo#MarkAsDone('')
 endfunction
 
@@ -122,29 +141,76 @@ function! todo#Sort()
         silent! %s/\(x\s*\d\{4}\)-\(\d\{2}\)-\(\d\{2}\)/\1\2\3/g
         sort n /^x\s*/
         silent! %s/\(x\s*\d\{4}\)\(\d\{2}\)/\1-\2-/g
+    else
+        let oldcursor=getpos(".")
+        silent normal gg
+        let l:first=search('^\s*x')
+        if  l:first != 0
+            sort /^./r
+            " at this point done tasks are at the end
+            let l:first=search('^\s*x')
+            let l:last=search('^\s*x','b')
+            let l:diff=l:last-l:first+1
+            " Cut the done lines
+            execute ':'.l:first.'d a '.l:diff
         endif
         sort /@[a-zA-Z]*/ r
-        sort /+[a-zA-Z]*/ r
+        sort /+[a-zA-Z]*/ r
+        sort /\v([A-Z])/ r
+        if l:first != 0
+            silent normal G"ap
+            execute ':'.l:first.','.l:last.'sort /@[a-zA-Z]*/ r'
+            execute ':'.l:first.','.l:last.'sort /+[a-zA-Z]*/ r'
+            execute ':'.l:first.','.l:last.'sort /\v([A-Z])/ r'
+        endif
         call cursor(oldcursor)
     endif
 endfunction
 
-function! todo#SortDue()
+function! todo#SortDue()
-    silent! %s/\([dD][uU][eE]:\d\{4}\)-\(\d\{2}\)-\(\d\{2}\)/\1\2\3/g
+    " Check how many lines have a due:date on them
-    " Sort adding entries with due dates add the beginning
+    let l:tasksWithDueDate = 0
-    sort n /[dD][uU][eE]:/
+    silent! %global/\v\c^[^x].*<due:\d{4}-\d{2}-\d{2}>/let l:tasksWithDueDate += 1
-    " Count the number of lines
+    if l:tasksWithDueDate == 0
-    silent normal gg
+        " No tasks with a due:date: No need to modify the buffer at all
-    execute "/[dD][uU][eE]:"
+        " Also means we don't need to cater for no matches on searches below
-    let l:first=getpos(".")[1]
+        return
-    silent normal N
+    endif
-    let l:last=getpos(".")[1]
+    " FIXME: There is a small chance that due:\d{8} might legitimately exist in the buffer
+    " We modify due:yyyy-mm-dd to yyyymmdd which would then mean we would alter the buffer
+    " in an unexpected way, altering user data. Not sure how to deal with this at the moment.
+    " I'm going to throw an exception, and if this is a problem we can revisit.
+    silent %global/\v\c<due:\d{8}>/throw "Text matching 'due:\\d\\{8\\}' exists in the buffer, this function cannot sort your buffer"
+    " Turn the due:date from due:yyyy-mm-dd to due:yyyymmdd so we can do a numeric sort
+    silent! %substitute/\v<(due:\d{4})\-(\d{2})\-(\d{2})>/\1\2\3/ei
+    " Sort all the lines with due: by numeric yyyymmdd, they will end up in ascending order at the bottom of the buffer
+    sort in /^[^x].*\<due:/
+    " Determine the line number of the first task with a due:date
     let l:firstLineWithDue = line("$") - l:tasksWithDueDate + 1
-    " Put the sorted lines at the beginning of the file
+    " Put the sorted lines at the beginning of the file
-    execute ':'.l:first
+    if l:firstLineWithDue > 1
-    execute ':d'.l:diff
+        " ...but only if the whole file didn't get sorted.
-    silent normal gg
+        execute l:firstLineWithDue . ",$move 0"
-    silent normal P
+    endif
+    " Change the due:yyyymmdd back to due:yyyy-mm-dd.
+    silent! %substitute/\v<(due:\d{4})(\d{2})(\d{2})>/\1-\2-\3/ei
+    " Cursor is now on the last task with a due:date
+    " Let's check a global for a user preference on the cursor position.
+    if exists("g:TodoTxtSortDueDateCursorPos")
+        if g:TodoTxtSortDueDateCursorPos ==? "top"
+            normal gg
+        elseif g:TodoTxtSortDueDateCursorPos ==? "lastdue"
+            " Nothing to do
+        elseif g:TodoTxtSortDueDateCursorPos ==? "notoverdue"
+            " Let's try to put the cursor on the first non-overdue task
+            let l:overduePat = todo#GetDateRegexForPastDates()
+            execute ":silent! ?\\v<due:" . l:overduePat . ">?+1"
+        elseif g:TodoTxtSortDueDateCursorPos ==? "bottom"
+            silent normal G
+        endif
+    else
+        " Default: Top of the document
+        normal gg
     endif
     " TODO: add time sorting (YYYY-MM-DD HH:MM)
 endfunction
@@ -171,16 +237,28 @@ function! todo#HierarchicalSort(symbol, symbolsub, dolastsort)
     let l:sortmodesub=Todo_txt_InsertSpaceIfNeeded(g:Todo_txt_second_level_sort_mode)
     let l:sortmodefinal=Todo_txt_InsertSpaceIfNeeded(g:Todo_txt_third_level_sort_mode)
 
-    " Count the number of lines
+    " Count the number of lines
-    let l:position= getpos(".")
+    let l:position= todo#GetCurpos()
-    execute "silent normal g\<c-g>"
+    execute "silent normal G"
+    let l:linecount=getpos(".")[1]
+    if(exists("g:Todo_txt_debug"))
+        echo "Linescount: ".l:linecount
+    endif
     execute "silent normal gg"
 
     " Get all the groups names
+    let l:groups=GetGroups(a:symbol,1,l:linecount)
+    if(exists("g:Todo_txt_debug"))
+        echo "Groups: "
+        echo l:groups
+        echo 'execute sort'.l:sortmode.' /.\{-}\ze'.a:symbol.'/'
     endif
     " Sort by groups
     execute 'sort'.l:sortmode.' /.\{-}\ze'.a:symbol.'/'
     for l:g in l:groups
+        let l:pat=a:symbol.l:g.'.*$'
+        if(exists("g:Todo_txt_debug"))
+            echo l:pat
         endif
         normal gg
         " Find the beginning of the group
@@ -209,6 +287,9 @@ function! todo#HierarchicalSort(symbol, symbolsub, dolastsort)
                     execute l:subgroupBegin.','.l:subgroupEnd.'sort'.l:sortmodefinal
                 endfor
             else
+                " Sort by priority
+                if(exists("g:Todo_txt_debug"))
+                    echo 'execute '.l:groupBegin.','.l:groupEnd.'sort'.l:sortmodefinal
                 endif
                 execute l:groupBegin.','.l:groupEnd.'sort'.l:sortmodefinal
             endif
@@ -223,7 +304,7 @@ function! GetGroups(symbol,begin, end)
 function! GetGroups(symbol,begin, end)
     let l:curline=a:begin
     let l:groups=[]
-    while l:curline <= a:end
+    while l:curline <= a:end
         let l:curproj=strpart(matchstr(getline(l:curline),a:symbol.'\S*'),1)
         if l:curproj != "" && index(l:groups,l:curproj) == -1
             let l:groups=add(l:groups , l:curproj)
@@ -246,7 +327,7 @@ endfunction
 " Completion {{{1
 
 " Simple keyword completion on all buffers {{{2
-function! TodoKeywordComplete(base)
+function! TodoKeywordComplete(base)
     " Search for matches
     let res = []
     for bufnr in range(1,bufnr('$'))
@@ -262,6 +343,25 @@ function! TodoKeywordComplete(base)
     endfor
     return res
 endfunction
+
+" Convert an item to the completion format and add it to the completion list
+fun! TodoAddToCompletionList(list,item,opp)
+    " Create the definitive item
+    let resitem={}
+    let resitem.word=a:item.word
+    let resitem.info=a:opp=='+'?"Projects":"Contexts"
+    let resitem.info.=": ".join(a:item.related, ", ")
+                \."\nBuffers: ".join(a:item.buffers, ", ")
+    call add(a:list,resitem)
+endfun
+
+fun! TodoCopyTempItem(item)
+    let ret={}
+    let ret.word=a:item.word
+    let ret.related=[a:item.related]
+    let ret.buffers=[a:item.buffers]
+    return ret
+endfun
 
 " Intelligent completion for projects and Contexts {{{2
 fun! todo#Complete(findstart, base)
@@ -282,7 +382,7 @@ fun! todo#Complete(findstart, base)
         let res = []
         for bufnr in range(1,bufnr('$'))
             let lines=getbufline(bufnr,1,"$")
-            for line in lines
+            for line in lines
                 if line =~ " ".a:base
                     " init temporary item
                     let item={}
@@ -296,10 +396,7 @@ fun! todo#Complete(findstart, base)
         call sort(res)
         " Here all results are sorted in res, but we need to merge them
         let ret=[]
-        if res != []
+        if res != []
-            let curitem={}
-            let curitem.word=res[0].word
-            let curitem.related=[]
             let curitem=TodoCopyTempItem(res[0])
             for it in res
                 if curitem.word==it.word
@@ -310,19 +407,14 @@ fun! todo#Complete(findstart, base)
                     if index(curitem.buffers,it.buffers) <0
                         call add(curitem.buffers,it.buffers)
                     endif
-                else
+                else
-                    " Create the definitive item
+                    " Add to list
-                    let resitem={}
-                    let resitem.word=curitem.word
-                    let resitem.info=opp=='+'?"Projects":"Contexts"
-                    let resitem.info.=": ".join(curitem.related, ", ")
-                                \."\nBuffers: ".join(curitem.buffers, ", ")
                     call TodoAddToCompletionList(ret,curitem,opp)
-                    " Init new item from it
+                    " Init new item from it
-                    let curitem.word=it.word
-                    let curitem.related=[it.related]
                     let curitem=TodoCopyTempItem(it)
                 endif
+            endfor
+            " Don't forget to add the list item
             call TodoAddToCompletionList(ret,curitem,opp)
         endif
         return ret

autoload/todo/txt.vim

@@ -0,0 +1,123 @@
+" File:        todo.txt.vim
+" Description: Todo.txt filetype detection
+" Author:      Leandro Freitas <freitass@gmail.com>
+" License:     Vim license
+" Website:     http://github.com/freitass/todo.txt-vim
+" Version:     0.4
+
+" Export Context Dictionary for unit testing {{{1
+function! s:get_SID()
+    return matchstr(expand('<sfile>'), '<SNR>\d\+_')
+endfunction
+let s:SID = s:get_SID()
+delfunction s:get_SID
+
+function! todo#txt#__context__()
+    return { 'sid': s:SID, 'scope': s: }
+endfunction
+
+" Functions {{{1
+function! s:remove_priority()
+    :s/^(\w)\s\+//ge
+endfunction
+
+function! s:get_current_date()
+    return strftime('%Y-%m-%d')
+endfunction
+
+function! todo#txt#prepend_date()
+    execute 'normal! I' . s:get_current_date() . ' '
+endfunction
+
+function! todo#txt#replace_date()
+    let current_line = getline('.')
+    if (current_line =~ '^\(([a-zA-Z]) \)\?\d\{2,4\}-\d\{2\}-\d\{2\} ') &&
+                \ exists('g:todo_existing_date') && g:todo_existing_date == 'n'
+        return
+    endif
+    execute 's/^\(([a-zA-Z]) \)\?\(\d\{2,4\}-\d\{2\}-\d\{2\} \)\?/\1' . s:get_current_date() . ' /'
+endfunction
+
+function! todo#txt#mark_as_done()
+    call s:remove_priority()
+    call todo#txt#prepend_date()
+    normal! Ix 
+endfunction
+
+function! todo#txt#mark_all_as_done()
+    :g!/^x /:call todo#txt#mark_as_done()
+endfunction
+
+function! s:append_to_file(file, lines)
+    let l:lines = []
+
+    " Place existing tasks in done.txt at the beggining of the list.
+    if filereadable(a:file)
+        call extend(l:lines, readfile(a:file))
+    endif
+
+    " Append new completed tasks to the list.
+    call extend(l:lines, a:lines)
+
+    " Write to file.
+    call writefile(l:lines, a:file)
+endfunction
+
+function! todo#txt#remove_completed()
+    " Check if we can write to done.txt before proceeding.
+
+    let l:target_dir = expand('%:p:h')
+    let l:todo_file = expand('%:p')
+    let l:done_file = substitute(substitute(l:todo_file, 'todo.txt$', 'done.txt', ''), 'Todo.txt$', 'Done.txt', '')
+    if !filewritable(l:done_file) && !filewritable(l:target_dir)
+        echoerr "Can't write to file 'done.txt'"
+        return
+    endif
+
+    let l:completed = []
+    :g/^x /call add(l:completed, getline(line(".")))|d
+    call s:append_to_file(l:done_file, l:completed)
+endfunction
+
+function! todo#txt#sort_by_context() range
+    execute a:firstline . "," . a:lastline . "sort /\\(^\\| \\)\\zs@[^[:blank:]]\\+/ r"
+endfunction
+
+function! todo#txt#sort_by_project() range
+    execute a:firstline . "," . a:lastline . "sort /\\(^\\| \\)\\zs+[^[:blank:]]\\+/ r"
+endfunction
+
+function! todo#txt#sort_by_date() range
+    let l:date_regex = "\\d\\{2,4\\}-\\d\\{2\\}-\\d\\{2\\}"
+    execute a:firstline . "," . a:lastline . "sort /" . l:date_regex . "/ r"
+    execute a:firstline . "," . a:lastline . "g!/" . l:date_regex . "/m" . a:lastline
+endfunction
+
+function! todo#txt#sort_by_due_date() range
+    let l:date_regex = "due:\\d\\{2,4\\}-\\d\\{2\\}-\\d\\{2\\}"
+    execute a:firstline . "," . a:lastline . "sort /" . l:date_regex . "/ r"
+    execute a:firstline . "," . a:lastline . "g!/" . l:date_regex . "/m" . a:lastline
+endfunction
+
+" Increment and Decrement The Priority
+:set nf=octal,hex,alpha
+
+function! todo#txt#prioritize_increase()
+    normal! 0f)h

+endfunction
+
+function! todo#txt#prioritize_decrease()
+    normal! 0f)h
+endfunction
+
+function! todo#txt#prioritize_add(priority)
+    " Need to figure out how to only do this if the first visible letter in a line is not (
+    :call todo#txt#prioritize_add_action(a:priority)
+endfunction
+
+function! todo#txt#prioritize_add_action(priority)
+    execute 's/^\(([a-zA-Z]) \)\?/(' . a:priority . ') /'
+endfunction
+
+" Modeline {{{1
+" vim: ts=8 sw=4 sts=4 et foldenable foldmethod=marker foldcolumn=1

doc/todo.txt

@@ -1,112 +1,130 @@
-*todo.txt*
+*Todo.txt-vim*
 
-Note: Since v0.7.3, `TodoComplete` is `todo#Complete`, you might need to
+        #####                                                #     #
-update your vimrc.
+          #    ####  #####   ####     ##### #    # #####     #     # # #    #
+          #   #    # #    # #    #      #    #  #    #       #     # # ##  ##
+          #   #    # #    # #    #      #     ##     #   ### #     # # # ## #
+          #   #    # #    # #    #      #     ##     #        #   #  # #    #
+          #   #    # #    # #    # ##   #    #  #    #         # #   # #    #
+          #    ####  #####   ####  ##   #   #    #   #          #    # #    #
 
-==============================================================================
+                        Efficient Todo.txt management in vim
-COMMANDS                                                       *todo-commands*
 
-`<LocalLeader>s` : Sort the file by priority
-
-`<LocalLeader>s+` : Sort the file on +Projects
-
-`<LocalLeader>s@` : Sort the file on @Contexts
-
-`<LocalLeader>s@` : Sort the file on due dates
-
-`<LocalLeader>sc` : Sort the file by context then by priority
-
-`<LocalLeader>scp` : Sort the file by context, project then by priority
-
-`<LocalLeader>sp` : Sort the file by project then by priority
-
-`<LocalLeader>spc` : Sort the file by project, context then by priority
-
-`<leader>-sd` : Sort the file by due-date. Entries with a due date appears
-sorted by at the beginning of the file, the rest of the file is not modified.
-
-`<LocalLeader>j` : Lower the priority of the current line
-
-`<LocalLeader>k` : Increase the priority of the current line
-
-`<LocalLeader>a` : Add the priority (A) to the current line
-
-`<LocalLeader>b` : Add the priority (B) to the current line
-
-`<LocalLeader>c` : Add the priority (C) to the current line
-
-`<LocalLeader>d` : Insert the current date
-
-`date<tab>`  : (Insert mode) Insert the current date
-
-`due:`  : (Insert mode) Insert `due:` followed by the current date
-
-`DUE:`  : (Insert mode) Insert `DUE:` followed by the current date
-
-`<LocalLeader>x` : Toggle mark task as done (inserts or remove current date as
-                    completion date)
-
-`<LocalLeader>X` : Mark all tasks as completed
-
-`<LocalLeader>D` : Move completed tasks to done file, see |todo-flexibleFileNaming|
-
-`<LocalLeader>` is \ by default, so ̀`<LocaLeader>-s` means you type \s
 
 ===============================================================================
-CONFIGURATION                                              *todo-configuration*
+Table of Contents                                          *TodoTxt-Contents* ~
 
-The user can give argument for the two calls to vim sort function by changing
+    1. Release notes.................................|TodoTxt-ReleaseNotes|
-the following variables:
+    2. Introduction..................................|TodoTxt-Introduction|
-
+        2.1 Todo.txt rules...........................|TodoTxt-Rules|
-g:Todo_txt_first_level_sort_mode
+        2.2 Why this Fork............................|TodoTxt-Fork|
-g:Todo_txt_second_level_sort_mode
+        2.3 Installation.............................|TodoTxt-Installation|
-
+    3. TodoTxt Files.................................|TodoTxt-Files|
-Defaults values are:
+    4. Completion....................................|TodoTxt-Completion|
-
+    5. Hierarchical Sort.............................|TodoTxt-HierarchicalSort|
->
+    6. Mappings......................................|TodoTxt-Mappings|
-    g:Todo_txt_first_level_sort_mode="i"
+        6.1 Sort.....................................|TodoTxt-Sort|
-    g:Todo_txt_second_level_sort_mode="i"
+        6.2 Priorities...............................|TodoTxt-Priorities|
-<
+        6.3 Dates....................................|TodoTxt-Dates|
-
+        6.4 Done.txt.................................|TodoTxt-Done|
-For more information on the available flags see help :sort
-
-We also provide a nice complete function for project and context, to use it
-add the following lines to your vimrc:
->
-    " Use todo#Completete as the omni complete for todo files
-    au filetype todo setlocal omnifunc=todo#Complete
-<
-
-You can also start automatically the completion when entering '+' or '@' by
-adding the next lines to your vimrc:
->
-    " Auto complete projects
-    au filetype todo imap <buffer> + +<C-X><C-O>
-
-    " Auto complete contexts
-    au filetype todo imap <buffer> @ @<C-X><C-O>
-<
-To force completed task to be moved to a file independently from the current
-file name, add the following to your vimrc:
->
-    let g:TodoTxtForceDoneName='done.txt'
-<
-For more explanations, see |todo-flexibleFileNaming|
 
 ===============================================================================
-COMPLETION                                                      *todo-complete*
+1. Release notes                                       *TodoTxt-ReleaseNotes* ~
 
-The `todo#Complete`te function is designed to complete projects (starting by '+')
+V0.8.1 Incorporates yet antoher Fretep work : highlithing for tasks due today.
-and context (starting by '@'). If you use it on a regular word, it will do a
+
-normal keyword completion (on all buffers).
+v0.8 Incorporates Fretep's work on overdue dates (PR#13 and PR#16) witch removes
-If you try to complete a project, it will propose all projects in all open
+python dependency, allow to control the cursor position after a sort by todo
-buffers and for each of them, it will show their context and the name of the
+(see |TodoTxt-Sort| and/or issue #15) and fixes bug when sorting a file
-buffers in which they appears in the preview window.
+containing only lines with due:date (issue #14).
-TodoCompelte does the same thing for context except that it gives in the
+
-preview the list of projects existing in each existing contexts.
+v0.7.6 Incorporates [Sietse's work](https://github.com/sietse/todo.txt-vim/commit/57d45200c8b033d31c9191ee0eb0711c801cdb1d) to make cancel and mark as done mapping repeatable using [vim-repeat](https://github.com/tpope/vim-repeat).
+
+v0.7.5 Incorporates Fievel's work
+(https://github.com/fievel/todo.txt-vim/commit/0863e1434e9a89ace06c4856b6cb32ba9906e3de)
+to make overduedates work on python3.
+
+v0.7.4 includes the overduedate support from Guilherme Victal (see pull
+request #45 on freitass version (https://github.com/freitass/todo.txt-vim/pull/45)),
+it highlight dates in overdue tasks as an Error. It depends on a
+Python library, however, and as such will only be able to work if your version
+of Vim was compiled with the `+python` option (as most common versions do).
+
+Since v0.7.3, `TodoComplete` is replaced by `todo#Complete`, you might need to
+update your vimrc (see |TodoTxt-Completion|).
 
 ===============================================================================
-FLEXIBLE FILE NAMING                                  *todo-flexibleFileNaming*
+2. Introduction                                        *TodoTxt-Introduction* ~
+
+Todo.txt-vim is a plugin to manage todo.txt files it was initially designed by
+Freitass (https://github.com/freitass/todo.txt-vim) then forked and improved
+by David Beniamine.
+
+2.1 Todo.txt rules                                              *TodoTxt-Rules*
+
+    Todo.txt is a standard human readable todo notes file defined here:
+    http://todotxt.com
+
+    "The todo.txt format is a simple set of
+    rules(https://github.com/ginatrapani/todo.txt-cli/wiki/The-Todo.txt-Format)
+    that make todo.txt both human and machine-readable. The format supports
+    priorities, creation and completion dates, projects and contexts. That's
+    all you need to be productive. See an example Todo.txt file":
+>
+        (A) Call Mom @Phone +Family
+        (A) Schedule annual checkup +Health
+        (B) Outline chapter 5 +FamilyNovel @Computer
+        (C) Add cover sheets @ComputerOffice +FamilyTPSReports
+        Plan backyard herb garden @ComputerHome
+        Pick up milk @ComputerGroceryStore
+        Research self-publishing services +FamilyNovel @ComputerComputer
+        x Download Todo.txt mobile app @ComputerPhone
+<
+2.2 Why this fork ?                                              *TodoTxt-Fork*
+
+    This plugin is a fork of freitass todo.txt-vim
+    (https://github.com/freitass/todo.txt-vim). It add severals cool
+    functionalities including:
+
+    + Hierarchical sort: |TodoTxt-Sort| and |TodoTxt-HierarchicalSort|.
+    + A completion function: |TodoTxt-Completion|.
+    + A proper handling of due dates: |TodoTxt-Dates|
+    + A Flexible file naming: |TodoTxt-Files|.
+    + Syntax Highlight for couples key:value.
+    + `<LocalLeader>x` is a toggle which allow you to unmark a task as done.
+    + `<LocalLeader>C` Toggle Mark a task cancelled
+    + If the current buffer is a done.txt file, the basic sort sorts on
+      completion date.
+    + ...
+
+2.3 Installation                                         *TodoTxt-Installation*
+
++ Vizardry
+
+    If you have Vizardry(https://github.com/dbeniamine/vizardry) installed,
+    you can run from vim:
+>
+        :Invoke -u dbeniamine todo.txt-vim
+<
++ Pathogen install
+>
+        git clone https://github.com/dbeniamine/todo.txt-vim.git ~/.vim/bundle/todo.txt-vim
+<
+    Then from vim: `:Helptags` to update the doc
+
++ Quick install
+>
+        git clone https://github.com/dbeniamine/todo.txt-vim.git
+        cd todo.txt-vim
+        cp -r ./* ~/.vim
+<
+
+    If you want the help installed, run `:helptags ~/.vim/doc` inside vim
+    after having copied the files.  Then you will be able to get the commands
+    help with: `:h todo.txt`
+
+===============================================================================
+3. TodoTxt Files                                              *TodoTxt-Files* ~
 
 This plugin provides a Flexible file naming for todo.txt, all the following
 names are recognized as todo:
@@ -127,10 +145,143 @@ And obviously the same are recognize as done:
     [Dd]one.txt
     [Dd]one-[Tt]oday.txt
 <
-Moreover, remove complete tasks `<LocalLeader>D` moves the task to the
+Moreover, `<LocalLeader>D` moves the task under the cursor to the done.txt
-done.txt file corresponding to the current todo.txt, aka if you are editing
+file corresponding to the current todo.txt, aka if you are editing
 2015-07-07-todo.txt, the done file while be 2015-07-07-done.txt. If you don't
 like this behavior, you can set the default done.txt name:
 >
     let g:TodoTxtForceDoneName='done.txt'
 <
+===============================================================================
+4. Completion                                            *TodoTxt-Completion* ~
+
+This plugin provides a nice complete function for project and context, to use
+it add the following lines to your vimrc:
+>
+    " Use todo#complete as the omni complete function for todo files
+    au filetype todo setlocal omnifunc=todo#complete
+<
+You can also start automatically the completion when entering '+' or '@' by
+adding the next lines to your vimrc:
+>
+    " Auto complete projects
+    au filetype todo imap <buffer> + +<C-X><C-O>
+
+    " Auto complete contexts
+    au filetype todo imap <buffer> @ @<C-X><C-O>
+<
+
+The `todo#complete` function is designed to complete projects (starting by `+`)
+and context (starting by `@`). If you use it on a regular word, it will do a
+normal keyword completion (on all buffers).
+
+If you try to complete a project, it will propose all projects in all open
+buffers and for each of them, it will show their context and the name of the
+buffers in which they appears in the preview window. It does the same thing
+for context except that it gives in the preview the list of projects existing
+in each existing contexts.
+
+===============================================================================
+5. Hierarchical sort                               *TodoTxt-HierarchicalSort* ~
+
+This fork provides a hierarchical sorting function designed to do by project
+and/or by context sorts and a priority sort.
+
+`<LocalLeader>sc` : Sort the file by context then by priority
+`<LocalLeader>scp` : Sort the file by context, project then by priority
+`<LocalLeader>sp` : Sort the file by project then by priority
+`<LocalLeader>spc` : Sort the file by project, context then by priority
+
+The user can give argument for the two calls to vim sort function by changing
+the following variables:
+>
+    g:Todo_txt_first_level_sort_mode
+    g:Todo_txt_second_level_sort_mode
+<
+Defaults values are:
+
+>
+    g:Todo_txt_first_level_sort_mode="i"
+    g:Todo_txt_second_level_sort_mode="i"
+<
+
+For more information on the available flags see |:sort|
+
+===============================================================================
+6. Mappings                                                *TodoTxt-Mappings* ~
+
+By default todo-txt.vim set all the mappings secribed in this section. To
+prevent this behavior, add the following line to your vimrc
+>
+   let g:Todo_txt_do_not_map=1
+<
+
+6.1 Sort                                                         *TodoTxt-Sort*
+
+    `<LocalLeader>s` : Sort the file by priority
+
+    `<LocalLeader>s+` : Sort the file on +Projects
+
+    `<LocalLeader>s@` : Sort the file on @Contexts
+
+    `<LocalLeader>sd` : Sort the file on due dates
+
+    `<LocalLeader>sc` : Sort the file by context then by priority
+
+    `<LocalLeader>scp` : Sort the file by context, project then by priority
+
+    `<LocalLeader>sp` : Sort the file by project then by priority
+
+    `<LocalLeader>spc` : Sort the file by project, context then by priority
+
+    `<leader>-sd` : Sort the file by due-date. Entries with a due date appears
+    sorted by at the beginning of the file, the rest of the file is not modified.
+
+When you sort by due dates, at the end of the sort, your cursor will be placed
+at the top of the file. This behavior can be set with the following global
+variable :
+
+    let g:TodoTxtSortDueDateCursorPos = "top"
+
+Possible values are :
+
++ `top` (default): The first line of the buffer, i.e. your most outstanding task
++ `lastdue`: The last task with a due:date set
++ `notoverdue`: The first task that is not overdue (requires #13)
++ `bottom`: The last line of the buffer
+
+6.2 Priorities                                             *TodoTxt-Priorities*
+
+    `<LocalLeader>j` : Lower the priority of the current line
+
+    `<LocalLeader>k` : Increase the priority of the current line
+
+    `<LocalLeader>a` : Add the priority (A) to the current line
+
+    `<LocalLeader>b` : Add the priority (B) to the current line
+
+    `<LocalLeader>c` : Add the priority (C) to the current line
+
+6.3 Dates                                                       *TodoTxt-Dates*
+
+    `<LocalLeader>d` : Insert the current date
+
+    `date<tab>`  : (Insert mode) Insert the current date
+
+    `due:`  : (Insert mode) Insert `due:` followed by the current date
+
+    `DUE:`  : (Insert mode) Insert `DUE:` followed by the current date
+
+6.4 Done                                                         *TodoTxt-Done*
+
+
+    `<LocalLeader>x` : Toggle mark task as done (inserts or remove current
+    date as completion date)
+
+    `<LocalLeader>C` : Toggle mark task cancelled
+
+    `<LocalLeader>X` : Mark all tasks as completed
+
+    `<LocalLeader>D` : Move completed tasks to done file, see |TodoTxt-Files|
+
+`<LocalLeader>` is \ by default, so ̀`<LocaLeader>-s` means you type \s

ftdetect/todo.vim

@@ -3,7 +3,7 @@
 " Author:      David Beniamine <david@beniamine.net>, Leandro Freitas <freitass@gmail.com>
 " License:     Vim license
 " Website:     http://github.com/dbeniamine/todo.txt-vim
-" Version:     0.7.2
+" vim: ts=4 sw=4 :help tw=78 cc=80
 
 autocmd BufNewFile,BufRead [Tt]odo.txt set filetype=todo
 autocmd BufNewFile,BufRead [Tt]odo-\d\\\{4\}-\d\\\{2\}-\d\\\{2\}.txt set filetype=todo

ftplugin/todo.vim

@@ -3,13 +3,18 @@
 " Author:      David Beniamine <David@Beniamine.net>, Leandro Freitas <freitass@gmail.com>
 " License:     Vim license
 " Website:     http://github.com/dbeniamine/todo.txt-vim
-" Version:     0.7.2
 " vim: ts=4 sw=4 :help tw=78 cc=80
 
 " Save context {{{1
 let s:save_cpo = &cpo
 set cpo&vim
 
+if exists("g:Todo_txt_loaded")
+    finish
+else
+    let g:Todo_txt_loaded=0.8.1
+endif
+
 " General options {{{1
 " Some options lose their values when window changes. They will be set every
 " time this script is invocated, which is whenever a file of this type is
@@ -19,128 +24,53 @@ setlocal wrapmargin=0
 
 " Mappings {{{1
 
+if !exists("g:Todo_txt_do_not_map")
 " Sort todo by (first) context
-if !hasmapto("<localleader>sc",'n')
     noremap <silent><localleader>sc :call todo#HierarchicalSort('@', '', 1)<CR>
-endif
-if !hasmapto("<localleader>scp",'n')
-    noremap <silent><localleader>scp :call todo#HierarchicalSort('@', '+', 1)<CR>
-endif
-" Sort todo by (first) project
-if !hasmapto("<localleader>sp",'n')
-    noremap <silent><localleader>sp :call todo#HierarchicalSort('+', '',1)<CR>
-endif
-if !hasmapto("<localleader>spc",'n')
-    noremap <silent><localleader>spc :call todo#HierarchicalSort('+', '@',1)<CR>
-endif
 
+    noremap <silent><localleader>scp :call todo#HierarchicalSort('@', '+', 1)<CR>
+" Sort todo by (first) project
+    noremap <silent><localleader>sp :call todo#HierarchicalSort('+', '',1)<CR>
+    noremap <silent><localleader>spc :call todo#HierarchicalSort('+', '@',1)<CR>
 
 " Sort tasks {{{2
-if !hasmapto("<localleader>s",'n')
     nnoremap <script> <silent> <buffer> <LocalLeader>s :call todo#Sort()<CR>
-endif
-
-if !hasmapto("<LocalLeader>s@",'n')
     nnoremap <script> <silent> <buffer> <LocalLeader>s@ :sort /.\{-}\ze@/ <CR>
-endif
-
-if !hasmapto("<LocalLeader>s+",'n')
     nnoremap <script> <silent> <buffer> <LocalLeader>s+ :sort /.\{-}\ze+/ <CR>
-endif
+" Priorities {{{2
+    noremap <script> <silent> <buffer> <LocalLeader>j :call todo#PrioritizeIncrease()<CR>
+    noremap <script> <silent> <buffer> <LocalLeader>k :call todo#PrioritizeDecrease()<CR>
 
-if !hasmapto("<LocalLeader>j",'n')
+    noremap <script> <silent> <buffer> <LocalLeader>a :call todo#PrioritizeAdd('A')<CR>
-    nnoremap <script> <silent> <buffer> <LocalLeader>j :call todo#PrioritizeIncrease()<CR>
+    noremap <script> <silent> <buffer> <LocalLeader>b :call todo#PrioritizeAdd('B')<CR>
-endif
+    noremap <script> <silent> <buffer> <LocalLeader>c :call todo#PrioritizeAdd('C')<CR>
-
-if !hasmapto("<LocalLeader>j",'v')
-    vnoremap <script> <silent> <buffer> <LocalLeader>j :call todo#PrioritizeIncrease()<CR>
-endif
-
-if !hasmapto("<LocalLeader>k",'n')
-    nnoremap <script> <silent> <buffer> <LocalLeader>k :call todo#PrioritizeDecrease()<CR>
-endif
-
-if !hasmapto("<LocalLeader>k",'v')
-    vnoremap <script> <silent> <buffer> <LocalLeader>k :call todo#PrioritizeDecrease()<CR>
-endif
-
-if !hasmapto("<LocalLeader>a",'n')
-    nnoremap <script> <silent> <buffer> <LocalLeader>a :call todo#PrioritizeAdd('A')<CR>
-endif
-
-if !hasmapto("<LocalLeader>a",'i')
-    inoremap <script> <silent> <buffer> <LocalLeader>a <ESC>:call todo#PrioritizeAdd('A')<CR>i
-endif
-
-if !hasmapto("<LocalLeader>a",'v')
-    vnoremap <script> <silent> <buffer> <LocalLeader>a :call todo#PrioritizeAdd('A')<CR>
-endif
-
-if !hasmapto("<LocalLeader>b",'n')
-    nnoremap <script> <silent> <buffer> <LocalLeader>b :call todo#PrioritizeAdd('B')<CR>
-endif
-
-if !hasmapto("<LocalLeader>b",'i')
-    inoremap <script> <silent> <buffer> <LocalLeader>b <ESC>:call todo#PrioritizeAdd('B')<CR>i
-endif
-
-if !hasmapto("<LocalLeader>b",'v')
-    vnoremap <script> <silent> <buffer> <LocalLeader>b :call todo#PrioritizeAdd('B')<CR>
-endif
-
-if !hasmapto("<LocalLeader>c",'n')
-    nnoremap <script> <silent> <buffer> <LocalLeader>c :call todo#PrioritizeAdd('C')<CR>
-endif
-if !hasmapto("<LocalLeader>c",'i')
-    inoremap <script> <silent> <buffer> <LocalLeader>c <ESC>:call todo#PrioritizeAdd('C')<CR>i
-endif
-
-if !hasmapto("<LocalLeader>c",'v')
-    vnoremap <script> <silent> <buffer> <LocalLeader>c :call todo#PrioritizeAdd('C')<CR>
-endif
 
 " Insert date {{{2
-if !hasmapto("date<Tab>",'i')
     inoremap <script> <silent> <buffer> date<Tab> <C-R>=strftime("%Y-%m-%d")<CR>
-endif
 
-if !hasmapto("due:",'i')
     inoremap <script> <silent> <buffer> due: due:<C-R>=strftime("%Y-%m-%d")<CR>
-endif
-
-if !hasmapto("DUE:",'i')
     inoremap <script> <silent> <buffer> DUE: DUE:<C-R>=strftime("%Y-%m-%d")<CR>
-endif
 
-if !hasmapto("<localleader>d",'n')
+    noremap <script> <silent> <buffer> <localleader>d :call todo#PrependDate()<CR>
-    nnoremap <script> <silent> <buffer> <localleader>d :call todo#PrependDate()<CR>
-endif
-
-if !hasmapto("<localleader>d",'v')
-    vnoremap <script> <silent> <buffer> <localleader>d :call todo#PrependDate()<CR>
-endif
 
 " Mark done {{{2
-if !hasmapto("<localleader>x",'n')
+    noremap <script> <silent> <buffer> <Plug>DoToggleMarkAsDone :call todo#ToggleMarkAsDone('')<CR>
-    nnoremap <script> <silent> <buffer> <localleader>x :call todo#ToggleMarkAsDone()<CR>
+                \:call repeat#set("\<Plug>DoToggleMarkAsDone")<CR>
-endif
+    nmap <localleader>x <Plug>DoToggleMarkAsDone
+    " noremap <script> <silent> <buffer> <localleader>x :call todo#ToggleMarkAsDone('')<CR>
 
-if !hasmapto("<localleader>x",'v')
+" Mark done {{{2
-    vnoremap <script> <silent> <buffer> <localleader>x :call todo#ToggleMarkAsDone()<CR>
+    noremap <script> <silent> <buffer> <Plug>DoCancel :call todo#ToggleMarkAsDone('Cancelled')<CR>
-endif
+                \:call repeat#set("\<Plug>DoCancel")<CR>
+    nmap <localleader>C <Plug>DoCancel
 
 " Mark all done {{{2
-if !hasmapto("<localleader>X",'n')
+    noremap <script> <silent> <buffer> <localleader>X :call todo#MarkAllAsDone()<CR>
-    nnoremap <script> <silent> <buffer> <localleader>X :call todo#MarkAllAsDone()<CR>
-endif
 
 " Remove completed {{{2
-if !hasmapto("<localleader>D",'n')
     nnoremap <script> <silent> <buffer> <localleader>D :call todo#RemoveCompleted()<CR>
-endif
 
 " Sort by due: date {{{2
-if !hasmapto("<localleader>sd".'n')
     nnoremap <script> <silent> <buffer> <localleader>sd :call todo#SortDue()<CR>
 endif
 
@@ -174,4 +104,3 @@ endfunction
 
 " Restore context {{{1
 let &cpo = s:save_cpo
-" Modeline {{{1

syntax/todo.vim

@@ -3,44 +3,49 @@
 " Author:      David Beniamine <David@Beniamine.net>,Leandro Freitas <freitass@gmail.com>
 " License:     Vim license
 " Website:     http://github.com/dbeniamine/todo.txt-vim
-" Version:     0.7.2
+" vim: ts=4 sw=4 :help tw=78 cc=80
 
 if exists("b:current_syntax")
     finish
 endif
 
 syntax  match  TodoDone       '^[xX]\s.\+$'               contains=TodoKey,TodoDate,TodoProject,TodoContext
-syntax  match  TodoPriorityA  '^([aA])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityA  '^([aA])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityB  '^([bB])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityB  '^([bB])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityC  '^([cC])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityC  '^([cC])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityD  '^([dD])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityD  '^([dD])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityE  '^([eE])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityE  '^([eE])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityF  '^([fF])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityF  '^([fF])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityG  '^([gG])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityG  '^([gG])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityH  '^([hH])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityH  '^([hH])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityI  '^([iI])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityI  '^([iI])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityJ  '^([jJ])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityJ  '^([jJ])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityK  '^([kK])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityK  '^([kK])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityL  '^([lL])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityL  '^([lL])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityM  '^([mM])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityM  '^([mM])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityN  '^([nN])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityN  '^([nN])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityO  '^([oO])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityO  '^([oO])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityP  '^([pP])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityP  '^([pP])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityQ  '^([qQ])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityQ  '^([qQ])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityR  '^([rR])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityR  '^([rR])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityS  '^([sS])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityS  '^([sS])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityT  '^([tT])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityT  '^([tT])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityU  '^([uU])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityU  '^([uU])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityV  '^([vV])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityV  '^([vV])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityW  '^([wW])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityW  '^([wW])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityX  '^([xX])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityX  '^([xX])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityY  '^([yY])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityY  '^([yY])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
-syntax  match  TodoPriorityZ  '^([zZ])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext
+syntax  match  TodoPriorityZ  '^([zZ])\s.\+$'             contains=TodoKey,TodoDate,TodoProject,TodoContext,TodoDueToday,TodoOverDueDate
 syntax  match  TodoDate       '\d\{2,4\}-\d\{2\}-\d\{2\}' contains=NONE
-syntax  match  TodoKey        '\S*\S:\S\S*'                   contains=TodoDate
+syntax  match  TodoKey        '\S*\S:\S\S*'               contains=TodoDate
 syntax  match  TodoProject    '\(^\|\W\)+[^[:blank:]]\+'  contains=NONE
 syntax  match  TodoContext    '\(^\|\W\)@[^[:blank:]]\+'  contains=NONE
 
+let s:todayDate=strftime('%Y\-%m\-%d')
+"TODO: Figure out how to allow stop the following line being highlighted inside TodoDone
+"execute 'syntax match TodoDueToday    /\v\c<(due:)@4<=' . s:todayDate . '/ contains=NONE contained'
+execute 'syntax match TodoDueToday    /\v\c<due:' . s:todayDate . '/ contains=NONE'
+
 " Other priority colours might be defined by the user
 highlight  default  link  TodoKey        Special
 highlight  default  link  TodoDone       Comment
@@ -50,5 +55,125 @@ highlight  default  link  TodoPriorityC  type
 highlight  default  link  TodoDate       PreProc
 highlight  default  link  TodoProject    Special
 highlight  default  link  TodoContext    Special
+highlight  default  link  TodoDueToday   Todo
+
+function! todo#GetDateRegexForPastDates(...)
+    " Build a RegExp to match all dates prior to a reference date.
+    "
+    " Optionally accepts a (year, month, day) for the date, otherwise assumes the
+    " reference date is the current date.
+    "
+    " In the end, the RegExp will look something like:
+    "   =todo#GetDateRegexForPastDates(2017, 09, 15)
+    "   \v(([01]\d{3}|200\d|201[0-6])\-\d{2}\-\d{2}|(2017\-(0[0-8])\-\d{2})|(2017\-09\-0\d)|(2017\-09\-1[0-4]))
+    "
+    " We split the RegExp into a few alternation groups:
+    "   1. All dates prior to 2000, dates before this are not supported
+    "   2. All previous decades for the reference date century
+    "   3. The current decade up to the year prior to the reference year
+    "   4. All months for the reference year up to the end of the previous month
+    "   5. Days of the month part 1.
+    "   6. Days of the month part 2.
+    "
+    " Will not work on reference dates past 2099, or before 2000.
+    "
+    " Invalid months and days are not checked, i.e. 2015-14-67 will match.
+    "
+    " Years must be 4 digits.
+    "
+
+    " Get the reference date
+    let l:day=strftime("%d")
+    let l:month=strftime("%m")
+    let l:year=strftime("%Y")
+    if a:0 >= 1
+        let l:year=a:1
+    endif
+    if a:0 >= 2
+        let l:month=a:2
+    endif
+    if a:0 >= 3
+        let l:day=a:3
+    endif
+
+    " Use very magic mode, and start an alternation
+    let l:overdueRex = '\v('
+
+    " PART 1: 0000-1999
+    " This sucker is static and won't change to year 3000. I'm not coding for the year 3000.
+    let l:overdueRex = l:overdueRex . '([01]\d{3}'
+
+    " PART 2. All previous decades for the reference date century
+    " i.e. for 2017: "200\d", for 2035: "20[0-2]\d"
+    "       for 2000: skip
+    let l:decade = strpart(l:year, 2, 1)    " i.e. the 1 from 2017
+    if l:decade > 0
+        let l:overdueRex = l:overdueRex . '|20'
+        if l:decade > 1
+            let l:overdueRex = l:overdueRex . '[0-' . (l:decade - 1) . ']'
+        else
+            let l:overdueRex = l:overdueRex . '0'
+        endif
+        let l:overdueRex = l:overdueRex . '\d'
+    endif
+
+    " PART 3: This decade, to previous year
+    " i.e. for 2017: "201[0-6]", for 2035: "203[0-4]", for 2000: skip
+    let l:y = strpart(l:year, 3, 1) " Last digit of the year, i.e. 7 for 2017
+    if l:y > 0
+        if l:y > 1
+            let l:overdueRex = l:overdueRex . '|20' . l:decade . '[0-' . (l:y - 1) . ']'
+        else
+            let l:overdueRex = l:overdueRex . '|20' . l:decade . '0'
+        endif
+    endif
+    let l:overdueRex = l:overdueRex . ')\-\d{2}\-\d{2}|'
+
+    " PART 4: All months to the end of the previous month
+    " i.e. for a date of 2017-09-07, "2017-(0[1-8])-\d{2}"
+    "       for 2017-11-30: "2017-(0\d|1[0-1])-\d{2}"
+    "       for 2017-01-20: skip
+    " This only applies if the reference date is not in January
+    if l:month > 1
+        let l:overdueRex = l:overdueRex . '(' . l:year . '\-(0'
+        if l:month > 10
+            let l:overdueRex = l:overdueRex . '\d|1'
+        endif
+        let l:y = strpart(printf('%02d', l:month), 1, 1) " Second digit of the month
+        let l:overdueRex = l:overdueRex . '[0-' . (l:y - 1) . '])\-\d{2})|'
+    endif
+
+    " PART 5. Days of the month part 1.
+    " i.e.  for 2017-09-07: skip
+    "       for 2017-12-29: "2017-12-[0-1]\d"
+    let l:y = strpart(printf('%02d', l:day), 0, 1) " First digit of the day
+    if l:y > 0
+        if l:y > 1
+            let l:overdueRex = l:overdueRex . '(' . l:year . '\-' . printf('%02d', l:month) . '\-[0-' . (l:y - 1) . ']\d)|'
+        else
+            let l:overdueRex = l:overdueRex . '(' . l:year . '\-' . printf('%02d', l:month) . '\-0\d)|'
+        endif
+    endif
+
+    " PART 6. Days of the month part 2.
+    " i.e.  for 2017-09-07: "2017-09-0[0-6]"
+    "       for 2017-12-29: "2017-12-2[0-8]"
+    let l:y = strpart(printf('%02d', l:day), 0, 1) " First digit of the day
+    let l:overdueRex = l:overdueRex . '(' . l:year . '\-' . printf('%02d', l:month) . '\-' . l:y
+    let l:y = strpart(printf('%02d', l:day), 1, 1) " Last digit of the day
+    if l:y > 0
+        let l:overdueRex = l:overdueRex . '[0-' . (l:y - 1) . ']'
+    else
+        let l:overdueRex = l:overdueRex . '0'
+    endif
+    let l:overdueRex = l:overdueRex . ')'
+
+    let l:overdueRex = l:overdueRex . ')'
+
+    return l:overdueRex
+endfunction
+
+execute 'syntax match TodoOverDueDate /\v\c<due:' . todo#GetDateRegexForPastDates() . '>/'
+highlight default link TodoOverDueDate Error
 
 let b:current_syntax = "todo"