-;; todo-mode.el -- Major mode for editing TODO list files
+;;; todo-mode.el --- major mode for editing TODO list files
-;; Copyright (C) 1997 Free Software Foundation, Inc.
+;; Copyright (C) 1997, 1999, 2001, 2002, 2003, 2004, 2005, 2006
+;; Free Software Foundation, Inc.
-;; Author: Oliver.Seidel@cl.cam.ac.uk (was valid on Aug 2, 1997)
+;; Author: Oliver Seidel <os10000@seidel-space.de>
+;; [Not clear the above works, July 2000]
;; Created: 2 Aug 1997
-;; Version: $Id: todo-mode.el,v 1.24 1997/10/28 19:41:53 os10000 Exp os10000 $
-;; Keywords: Categorised TODO list editor, todo-mode
+;; Keywords: calendar, todo
;; This file is part of GNU Emacs.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;; ---------------------------------------------------------------------------
;;; Commentary:
+;; Mode Description
+;;
+;; TODO is a major mode for EMACS which offers functionality to
+;; treat most lines in one buffer as a list of items one has to
+;; do. There are facilities to add new items, which are
+;; categorised, to edit or even delete items from the buffer.
+;; The buffer contents are currently compatible with the diary,
+;; so that the list of todo-items will show up in the FANCY diary
+;; mode.
+;;
+;; Notice: Besides the major mode, this file also exports the
+;; function `todo-show' which will change to the one specific
+;; TODO file that has been specified in the todo-file-do
+;; variable. If this file does not conform to the TODO mode
+;; conventions, the todo-show function will add the appropriate
+;; header and footer. I don't anticipate this to cause much
+;; grief, but be warned, in case you attempt to read a plain text
+;; file.
+;;
;; Preface, Quickstart Installation
;;
;; To get this to work, make emacs execute the line
;; entered by visiting the TODO file, and later by switching to
;; its buffer).
;;
-;; Version
-;;
-;; Which version of todo-mode.el does this documentation refer to?
-;;
-;; $Id: todo-mode.el,v 1.24 1997/10/28 19:41:53 os10000 Exp os10000 $
+;; If you are an advanced user of this package, please consult
+;; the whole source code for autoloads, because there are several
+;; extensions that are not explicitly listed in the above quick
+;; installation.
;;
;; Pre-Requisites
;;
;; time-stamp
;; easymenu
;;
-;; Mode Description
-;;
-;; TODO is a major mode for EMACS which offers functionality to
-;; treat most lines in one buffer as a list of items one has to
-;; do. There are facilities to add new items, which are
-;; categorised, to edit or even delete items from the buffer.
-;; The buffer contents are currently compatible with the diary,
-;; so that the list of todo-items will show up in the FANCY diary
-;; mode.
-;;
-;; Notice: Besides the major mode, this file also exports the
-;; function "todo-show" which will change to the one specific
-;; TODO file that has been specified in the todo-file-do
-;; variable. If this file does not conform to the TODO mode
-;; conventions, the todo-show function will add the appropriate
-;; header and footer. I don't anticipate this to cause much
-;; grief, but be warned, in case you attempt to read a plain text
-;; file.
-;;
;; Operation
;;
;; You will have the following facilities available:
;; d to file the current entry, including a
;; comment and timestamp
;; e to edit the current entry
+;; E to edit a multi-line entry
;; f to file the current entry, including a
;; comment and timestamp
-;; i to insert a new entry
+;; i to insert a new entry, with prefix, omit category
+;; I to insert a new entry at current cursor position
;; j jump to category
;; k to kill the current entry
;; l to lower the current entry's priority
;; r to raise the current entry's priority
;; s to save the list
;; S to save the list of top priorities
-;; t show top priority items for each category
+;; t show top priority items for each category
;;
;; When you add a new entry, you are asked for the text and then
;; for the category. I for example have categories for things
;; as the value of `todo-prefix'. Please note that this may slow
;; down the processing of your diary file some.
;;
+;; Carsten Dominik <dominik@strw.LeidenUniv.nl> suggested that
+;;
+;; "&%%(todo-cp)"
+;;
+;; might be nicer and to that effect a function has been declared
+;; further down in the code. You may wish to auto-load this.
+;;
+;; Carsten also writes that that *changing* the prefix after the
+;; todo list is already established is not as simple as changing
+;; the variable - the todo files have to be changed by hand.
+;;
;; Variable todo-file-do
;;
;; This variable is fairly self-explanatory. You have to store
;; is the window size at which it will stop. If you set the
;; threshhold to zero, the upper and lower bound will coincide at
;; the end of the loop and you will insert your item just before
-;; that point. If you set the threshhold to i.e. 8, it will stop
+;; that point. If you set the threshhold to, e.g. 8, it will stop
;; as soon as the window size drops below that amount and will
;; insert the item in the approximate centre of that window. I
;; got the idea for this feature after reading a very helpful
;; o The optional COUNT variable of todo-forward-item should be
;; applied to the other functions performing similar tasks
;; o Modularization could be done for repeaded elements of
-;; the code, like the completing-read lines of code.
+;; the code, like the completing-read lines of code.
;; o license / version function
;; o export to diary file
;; o todo-report-bug
;;
;; Oliver Seidel
;; (Lessingstr. 8, 65760 Eschborn, Federal Republic of Germany)
-;;
-
-;; ---------------------------------------------------------------------------
-;;; Change Log:
-
-;; $Log: todo-mode.el,v $
-;; Revision 1.24 1997/10/28 19:41:53 os10000
-;; Added fix from Frank Ridderbusch <ridderbusch.pad@sni.de>,
-;; an apostrophe was missing.
-;;
-;; Revision 1.23 1997/10/24 17:30:54 os10000
-;; Added three suggestions from Carsten
-;; Dominik <dominik@strw.LeidenUniv.nl>:
-;;
-;; - recommend autoloading instead of require
-;; - inserting from different buffer didn't work
-;; (now fixed -- I pray)
-;; - provided public entry point to insert items
-;; from normal lisp code
-;;
-;; Revision 1.22 1997/10/24 16:53:20 os10000
-;; Paul Stodghill <stodghil@CS.Cornell.EDU> writes:
-;;
-;; When invoked with a prefix, todo-insert-item
-;; should not prompt for a category. (He adds:
-;; At least that's what I think.)
-;;
-;; Revision 1.21 1997/10/24 16:51:02 os10000
-;; Rafael Laboissiere <rafael@icp.inpg.fr> writes:
-;;
-;; I was just annoyed with the fact that there is no way
-;; to dynamically control the insertion accuracy. I mean:
-;; the variable `todo-insert-threshold' does the job, but
-;; it is not very handy if one wants to mix the two
-;; behaviors (bisection and "insert right here under the
-;; cursor").
-;;
-;; Therefore I did a quick hack in the function
-;; `todo-insert-item'. Now by giving a prefix argument to
-;; the insert command (i.e. by typing "C-u i"), entries
-;; are inserted exactly at the line where the cursor is.
-;; It would be better to give the value of
-;; `todo-insert-threshold' as a numeric argument of
-;; `todo-insert-item' (like "M-8 i"), but it's too late
-;; now for continuing to hack.
-;;
-;; Revision 1.20 1997/10/17 15:41:57 os10000
-;; Thanks to Harald Backer <harald.backer@fou.telenor.no>, we now have
-;; the following facilities available:
-;;
-;; Added todo-print, todo-top-priorities and todo-jump with matching
-;; variables; Parameterized todo-header, todo-category-beg,
-;; todo-category-end and todo-category-sep; Added autoload comments;
-;; todo-category-select: Modified regexp to make category names unique;
-;; todo-forward-item: Added optional COUNT vaiable; todo-insert-item:
-;; Rewrote completing read entry.
-;;
-;; Also, check out the extended list of things left to be done to this
-;; package at the end of the documentation!
-;;
-;; Revision 1.19 1997/10/16 21:21:16 os10000
-;; Jari Aalto <jari.aalto@poboxes.com> writes:
-;;
-;; I just downloaded your package and after reading the docs I
-;; decided to do some reformatting. Hope you don't mind. Now
-;; they are in such a format that the html page can be
-;; automatically generated from the source file. As an example, I
-;; generated the attached page using the following command:
-;; ripdoc.pls < todo-mode.el | t2html.pls -a "Oliver.Seidel" -e \
-;; Oliver.Seidel@cl.cam.ac.uk -simple -base
-;;
-;; And of course I appreciate it. Jari's stuff can be found at:
-;; ftp://cs.uta.fi/pub/ssjaaa/, while I'm making the rev 1.18 page
-;; available at http://www.cl.cam.ac.uk/users/os10000/doc/todo-mode.html
-;; (That link will be valid until 10/1998 or slightly longer.)
-;;
-;; Revision 1.18 1997/10/15 17:18:11 os10000
-;; Everything seems to work in Harald Melands Emacs 20.02 and
-;; my Emacs 19.34. Beware of the spelling in some of the
-;; variable names. I looked up "threshold" in a dictionary
-;; and here in Britain this appears to be the way to spell it.
-;;
-;; Revision 1.17 1997/10/15 14:30:41 os10000
-;; Attempted to reconcile Harald's changes with mine since 1.15.
-;;
-;; Revision 1.16 1997/10/15 14:00:12 os10000
-;; Fixed 'file-item' and added 20.02 split-string function.
-;;
-;; Revision 1.15 1997/10/14 22:22:35 os10000
-;; Added string-split (which I stole from ediff-util), changed
-;; pop-to-buffer to switch-to-buffer and added message on how
-;; to exit the multi-line-edit mode.
-;;
-;; Revision 1.14 1997/10/09 09:24:50 os10000
-;; Harald Meland <harald.meland@usit.uio.no> asked for
-;; the latest version, got 1.13, and returned this.
-;; He writes:
-;;
-;; Thanks a lot for the new version of todo-mode.el. As you will see I
-;; have messed it up a bit, hopefully for the better -- I don't like
-;; short, cryptic names for variables and functions, so I renamed most of
-;; them, and `defalias'ed the old function names. I hope you don't mind
-;; too much, I just kinda couldn't stop myself.
-;;
-;; Additionally, I included some support for multiline entries, cleaned
-;; up (IMHO :) a lot of the code, included completion-support for which
-;; category to install a new entry in, and possibly some other changes I
-;; can't remember :)
-;;
-;; It's getting rather late, and I have just done some preliminary
-;; testing on whether all of this really works, but so far it looks
-;; good.
-;;
-;; Revision 1.13 1997/08/19 14:00:36 seidel
-;; - changed name to todo-mode
-;; - fixed menu descriptions
-;; - fixed "pressing abort while filing"
-;; - attempted Emacs Lisp Manual *Tips* section compliance
-;;
-;; Revision 1.12 1997/08/06 10:56:15 os10000
-;; Fixed header, typos, layout, documentation.
-;;
-;; Revision 1.11 1997/08/06 09:14:25 os10000
-;; Applied patch from Istvan Marko <istvan@cmdmail.amd.com>
-;; to make menus work anywhere.
-;;
-;; Revision 1.10 1997/08/06 08:56:03 os10000
-;; Acted upon suggestion from Shane Holder <holder@rsn.hp.com>:
-;; Cancelling the editing of an entry will not delete it any more.
-;;
-;; Revision 1.9 1997/08/06 08:12:03 os10000
-;; Improved documentation. Broke some lines to comply with
-;; Richard Stallman's email to please keep in sync with the
-;; rest of the Emacs distribution files.
-;;
-;; Revision 1.8 1997/08/05 22:39:04 os10000
-;; Made todo-mode.el available under GPL.
-;;
-;; Revision 1.7 1997/08/05 22:34:14 os10000
-;; Fixed insertion routine with help from Trey Jackson
-;; <trey@cs.berkeley.edu>; added todo-inst-tresh;
-;; fixed keyboard layout to remove unwanted keys.
-;;
-;; Revision 1.6 1997/08/05 16:47:01 os10000
-;; Incorporated menus for XEmacs from Allan.Cochrane@soton.sc.philips.com,
-;; fixed TYPO, fixed todo-file-cmd, cleaned up rcs history.
-;;
-;; Revision 1.5 1997/08/05 14:43:39 os10000
-;; Added improvements from Ron Gut <rgut@aware.com>.
-;; Added category management.
-;;
-;; Revision 1.4 1997/08/04 16:18:45 os10000
-;; Added Raise/Lower item.
-;;
-;; Revision 1.3 1997/08/03 12:47:26 os10000
-;; Cleaned up variables, prefix and cursor position.
-;;
-;; Revision 1.2 1997/08/03 12:15:28 os10000
-;; It appears to work.
-;;
-;; Revision 1.1 1997/08/03 12:15:13 os10000
-;; Initial revision
-;;
+;;; Code:
-;; ---------------------------------------------------------------------------
+(require 'time-stamp)
-;;; Code:
;; User-configurable variables:
-(defvar todo-prefix "*/*" "*TODO mode prefix for entries.")
-(defvar todo-file-do "~/.todo-do" "*TODO mode list file.")
-(defvar todo-file-done "~/.todo-done" "*TODO mode archive file.")
-(defvar todo-mode-hook nil "*TODO mode hooks.")
-(defvar todo-edit-mode-hook nil "*TODO Edit mode hooks.")
-(defvar todo-insert-threshold 0 "*TODO mode insertion accuracy.")
-(defvar todo-edit-buffer " *TODO Edit*" "TODO Edit buffer name.")
-(defvar todo-file-top "~/.todo-top"
+(defgroup todo nil
+ "Maintain a list of todo items."
+ :link '(emacs-commentary-link "todo-mode")
+ :version "21.1"
+ :group 'calendar)
+
+(defcustom todo-prefix "*/*"
+ "*TODO mode prefix for entries.
+
+This is useful in conjunction with `calendar' and `diary' if you use
+
+#include \"~/.todo-do\"
+
+in your diary file to include your todo list file as part of your
+diary. With the default value \"*/*\" the diary displays each entry
+every day and it may also be marked on every day of the calendar.
+Using \"&%%(equal (calendar-current-date) date)\" instead will only
+show and mark todo entreis for today, but may slow down processing of
+the diary file somewhat."
+ :type 'string
+ :group 'todo)
+(defcustom todo-file-do "~/.todo-do"
+ "*TODO mode list file."
+ :type 'file
+ :group 'todo)
+(defcustom todo-file-done "~/.todo-done"
+ "*TODO mode archive file."
+ :type 'file
+ :group 'todo)
+(defcustom todo-mode-hook nil
+ "*TODO mode hooks."
+ :type 'hook
+ :group 'todo)
+(defcustom todo-edit-mode-hook nil
+ "*TODO Edit mode hooks."
+ :type 'hook
+ :group 'todo)
+(defcustom todo-insert-threshold 0
+ "*TODO mode insertion accuracy.
+
+If you have 8 items in your TODO list, then you may get asked 4
+questions by the binary insertion algorithm. However, you may not
+really have a need for such accurate priorities amongst your TODO
+items. If you now think about the binary insertion halfing the size
+of the window each time, then the threshhold is the window size at
+which it will stop. If you set the threshhold to zero, the upper and
+lower bound will coincide at the end of the loop and you will insert
+your item just before that point. If you set the threshhold to,
+e.g. 8, it will stop as soon as the window size drops below that
+amount and will insert the item in the approximate center of that
+window."
+ :type 'integer
+ :group 'todo)
+(defvar todo-edit-buffer " *TODO Edit*"
+ "TODO Edit buffer name.")
+(defcustom todo-file-top "~/.todo-top"
"*TODO mode top priorities file.
+
Not in TODO format, but diary compatible.
-Automatically generated when `todo-save-top-priorities' is non-nil.")
-
-(defvar todo-print-function 'ps-print-buffer-with-faces
- "*Function to print the current buffer.")
-(defvar todo-show-priorities 1
- "*Default number of priorities to show by
- \\[todo-top-priorities]. 0 means show all entries.")
-(defvar todo-print-priorities 0
- "*Default number of priorities to print by
- \\[todo-print]. 0 means print all entries.")
-(defvar todo-remove-separator t
- "*Non-nil removes category separators in
- \\[todo-top-priorities] and \\[todo-print].")
-(defvar todo-save-top-priorities-too t
- "*Non-nil makes todo-save automatically save top-priorities in
-`todo-file-top'.")
+Automatically generated when `todo-save-top-priorities' is non-nil."
+ :type 'string
+ :group 'todo)
+
+(defcustom todo-print-function 'ps-print-buffer-with-faces
+ "*Function to print the current buffer."
+ :type 'symbol
+ :group 'todo)
+(defcustom todo-show-priorities 1
+ "*Default number of priorities to show by \\[todo-top-priorities].
+0 means show all entries."
+ :type 'integer
+ :group 'todo)
+(defcustom todo-print-priorities 0
+ "*Default number of priorities to print by \\[todo-print].
+0 means print all entries."
+ :type 'integer
+ :group 'todo)
+(defcustom todo-remove-separator t
+ "*Non-nil to remove category separators in\
+\\[todo-top-priorities] and \\[todo-print]."
+ :type 'boolean
+ :group 'todo)
+(defcustom todo-save-top-priorities-too t
+ "*Non-nil makes `todo-save' automatically save top-priorities in `todo-file-top'."
+ :type 'boolean
+ :group 'todo)
;; Thanks for the ISO time stamp format go to Karl Eichwalder <ke@suse.de>
;; My format string for the appt.el package is "%3b %2d, %y, %02I:%02M%p".
;;
-(defvar todo-time-string-format
+(defcustom todo-time-string-format
"%:y-%02m-%02d %02H:%02M"
- "TODO mode time string format for done entries.
-For details see the variable `time-stamp-format'.")
-
-(defvar todo-entry-prefix-function nil
- "*Function producing text to insert at start of todo entry.
-
-See `todo-entry-prefix-function' as an example:
-(defun todo-entry-timestamp-initials ()
- \"Prepend timestamp and your initials to the head of a TODO entry.\"
- (let ((time-stamp-format todo-time-string-format))
- (concat (time-stamp-string) \" \" todo-initials \": \")))
-")
-
-(defvar todo-initials (or (getenv "INITIALS") (user-login-name))
- "*Initials of todo item author.")
+ "*TODO mode time string format for done entries.
+For details see the variable `time-stamp-format'."
+ :type 'string
+ :group 'todo)
+
+(defcustom todo-entry-prefix-function 'todo-entry-timestamp-initials
+ "*Function producing text to insert at start of todo entry."
+ :type 'symbol
+ :group 'todo)
+(defcustom todo-initials (or (getenv "INITIALS") (user-login-name))
+ "*Initials of todo item author."
+ :type 'string
+ :group 'todo)
(defun todo-entry-timestamp-initials ()
"Prepend timestamp and your initials to the head of a TODO entry."
;; ---------------------------------------------------------------------------
-;; Get some outside help ...
-
-(require 'time-stamp)
-(require 'easymenu)
-
-;; ---------------------------------------------------------------------------
-
;; Set up some helpful context ...
-(defvar todo-categories nil "TODO categories.")
-(defvar todo-cats nil "Old variable for holding the
-TODO categories. Use `todo-categories' instead.")
-(defvar todo-previous-line 0 "Previous line that I asked about.")
-(defvar todo-previous-answer 0 "Previous answer that I got.")
-(defvar todo-mode-map nil "TODO mode keymap.")
-(defvar todo-category-number 0 "TODO category number.")
-
-(defvar todo-tmp-buffer-name "*Tmp*")
-
-(defvar todo-category-sep (make-string 75 ?-)
- "Category separator.")
-(defvar todo-category-beg " --- "
- "Category start separator to be prepended onto category name.")
-(defvar todo-category-end "--- End"
- "Separator after a category.")
-(defvar todo-header "-*- mode: todo; "
- "Header of todo files.")
+(defvar todo-categories nil
+ "TODO categories.")
+(defvar todo-cats nil
+ "Old variable for holding the TODO categories.
+Use `todo-categories' instead.")
+(defvar todo-previous-line 0
+ "Previous line asked about.")
-;; ---------------------------------------------------------------------------
+(defvar todo-previous-answer 0
+ "Previous answer got.")
-(if todo-mode-map
- nil
+(defvar todo-mode-map
(let ((map (make-keymap)))
(suppress-keymap map t)
(define-key map "+" 'todo-forward-category)
(define-key map "-" 'todo-backward-category)
+ (define-key map "d" 'todo-file-item) ;done/delete
(define-key map "e" 'todo-edit-item)
(define-key map "E" 'todo-edit-multiline)
- (define-key map "d" 'todo-file-item) ;done/delete
(define-key map "f" 'todo-file-item)
(define-key map "i" 'todo-insert-item)
+ (define-key map "I" 'todo-insert-item-here)
(define-key map "j" 'todo-jump-to-category)
(define-key map "k" 'todo-delete-item)
(define-key map "l" 'todo-lower-item)
(define-key map "s" 'todo-save)
(define-key map "S" 'todo-save-top-priorities)
(define-key map "t" 'todo-top-priorities)
- (setq todo-mode-map map)))
+ map)
+ "TODO mode keymap.")
+
+(defvar todo-category-number 0 "TODO category number.")
+
+(defvar todo-tmp-buffer-name " *todo tmp*")
+
+(defvar todo-category-sep (make-string 75 ?-)
+ "Category separator.")
+
+(defvar todo-category-beg " --- "
+ "Category start separator to be prepended onto category name.")
+
+(defvar todo-category-end "--- End"
+ "Separator after a category.")
+
+(defvar todo-header "-*- mode: todo; "
+ "Header of todo files.")
+
+;; ---------------------------------------------------------------------------
(defun todo-category-select ()
"Make TODO mode display the current category correctly."
(let ((name (nth todo-category-number todo-categories)))
(setq mode-line-buffer-identification
- (concat "Category: " name))
+;; (concat "Category: " name))
+ (concat "Category: " (format "%18s" name)))
(widen)
(goto-char (point-min))
(search-forward-regexp
(concat "^"
(regexp-quote (concat todo-prefix todo-category-beg name))
"$"))
- (let ((begin (1+ (point-at-eol))))
+ (let ((begin (1+ (line-end-position))))
(search-forward-regexp (concat "^" todo-category-end))
- (narrow-to-region begin (point-at-bol))
+ (narrow-to-region begin (line-beginning-position))
(goto-char (point-min)))))
(defalias 'todo-cat-slct 'todo-category-select)
-(defun todo-forward-category () "Go forward to TODO list of next category."
+(defun todo-forward-category ()
+ "Go forward to TODO list of next category."
(interactive)
(setq todo-category-number
(mod (1+ todo-category-number) (length todo-categories)))
(todo-category-select))
(defalias 'todo-cmd-forw 'todo-forward-category)
-(defun todo-backward-category () "Go back to TODO list of previous category."
+(defun todo-backward-category ()
+ "Go back to TODO list of previous category."
(interactive)
(setq todo-category-number
(mod (1- todo-category-number) (length todo-categories)))
(todo-category-select))
(defalias 'todo-cmd-back 'todo-backward-category)
-(defun todo-backward-item () "Select previous entry of TODO list."
+(defun todo-backward-item ()
+ "Select previous entry of TODO list."
(interactive)
(search-backward-regexp (concat "^" (regexp-quote todo-prefix)) nil t)
(message ""))
(defalias 'todo-cmd-prev 'todo-backward-item)
(defun todo-forward-item (&optional count)
- "Select Nth next entry of TODO list."
+ "Select COUNT-th next entry of TODO list."
(interactive "P")
(if (listp count) (setq count (car count)))
(end-of-line)
(message ""))
(defalias 'todo-cmd-next 'todo-forward-item)
-(defun todo-save () "Save the TODO list."
+(defun todo-save ()
+ "Save the TODO list."
(interactive)
- (save-buffer)
- (if todo-save-top-priorities-too (todo-save-top-priorities))
- )
+ (save-excursion
+ (save-restriction
+ (save-buffer)))
+ (if todo-save-top-priorities-too (todo-save-top-priorities)))
(defalias 'todo-cmd-save 'todo-save)
-(defun todo-quit () "Done with TODO list for now."
+(defun todo-quit ()
+ "Done with TODO list for now."
(interactive)
(widen)
(todo-save)
(bury-buffer))
(defalias 'todo-cmd-done 'todo-quit)
-(defun todo-edit-item () "Edit current TODO list entry."
+(defun todo-edit-item ()
+ "Edit current TODO list entry."
(interactive)
(let ((item (todo-item-string)))
(if (todo-string-multiline-p item)
(todo-edit-mode)
(narrow-to-region (todo-item-start) (todo-item-end))))
-;;;### autoload
-(defun todo-add-category (cat) "Add a new category to the TODO list."
- (interactive)
+;;;###autoload
+(defun todo-add-category (cat)
+ "Add new category CAT to the TODO list."
+ (interactive "sCategory: ")
(save-window-excursion
(setq todo-categories (cons cat todo-categories))
(find-file todo-file-do)
(forward-char 1)
(insert (format "%s%s%s\n%s\n%s %s\n"
todo-prefix todo-category-beg cat
- todo-category-end
+ todo-category-end
todo-prefix todo-category-sep)))
0)
-;;;### autoload
+;;;###autoload
(defun todo-add-item-non-interactively (new-item category)
- "Insert new TODO list entry."
+ "Insert NEW-ITEM in TODO list as a new entry in CATEGORY."
+ (save-excursion
+ (todo-show))
(save-excursion
- (todo-show)
(if (string= "" category)
(setq category (nth todo-category-number todo-categories)))
(let ((cat-exists (member category todo-categories)))
(if cat-exists
(- (length todo-categories) (length cat-exists))
(todo-add-category category))))
- (if (not ARG)
- (progn
- (todo-show)
- (setq todo-previous-line 0)
- (let ((top 1)
- (bottom (1+ (count-lines (point-min) (point-max)))))
- (while (> (- bottom top) todo-insert-threshold)
- (let* ((current (/ (+ top bottom) 2))
- (answer (if (< current bottom)
- (todo-more-important-p current) nil)))
- (if answer
- (setq bottom current)
- (setq top (1+ current)))))
- (setq top (/ (+ top bottom) 2))
- ;; goto-line doesn't have the desired behavior in a narrowed buffer
- (goto-char (point-min))
- (forward-line (1- top))))
- (beginning-of-line))
+ (todo-show)
+ (setq todo-previous-line 0)
+ (let ((top 1)
+ (bottom (1+ (count-lines (point-min) (point-max)))))
+ (while (> (- bottom top) todo-insert-threshold)
+ (let* ((current (/ (+ top bottom) 2))
+ (answer (if (< current bottom)
+ (todo-more-important-p current) nil)))
+ (if answer
+ (setq bottom current)
+ (setq top (1+ current)))))
+ (setq top (/ (+ top bottom) 2))
+ ;; goto-line doesn't have the desired behavior in a narrowed buffer
+ (goto-char (point-min))
+ (forward-line (1- top)))
(insert new-item "\n")
(todo-backward-item)
(todo-save)
(message "")))
-;;;### autoload
-(defun todo-insert-item (ARG)
- "Insert new TODO list entry."
+;;;###autoload
+(defun todo-insert-item (arg)
+ "Insert new TODO list entry.
+With a prefix argument solicit the category, otherwise use the current
+category."
(interactive "P")
- (todo-show)
- (let* ((new-item (concat todo-prefix " "
- (read-from-minibuffer
- "New TODO entry: "
- (if todo-entry-prefix-function
- (funcall todo-entry-prefix-function)))))
- (categories todo-categories)
- (history (cons 'categories (1+ todo-category-number)))
- (current-category (nth todo-category-number todo-categories))
- (category
- (if ARG
- current-category
- (completing-read
- (concat "Category ["
- current-category "]: ")
- (todo-category-alist) nil nil nil history))))
- (todo-add-item-non-interactively new-item category)))
+ (save-excursion
+ (if (not (string-equal mode-name "TODO")) (todo-show))
+ (let* ((new-item (concat todo-prefix " "
+ (read-from-minibuffer
+ "New TODO entry: "
+ (if todo-entry-prefix-function
+ (funcall todo-entry-prefix-function)))))
+ (categories todo-categories)
+ (history (cons 'categories (1+ todo-category-number)))
+ (current-category (nth todo-category-number todo-categories))
+ (category
+ (if arg
+ current-category
+ (completing-read (concat "Category [" current-category "]: ")
+ (todo-category-alist) nil nil nil
+ history current-category))))
+ (todo-add-item-non-interactively new-item category))))
(defalias 'todo-cmd-inst 'todo-insert-item)
+(defun todo-insert-item-here ()
+ "Insert new TODO list entry under the cursor."
+ (interactive "")
+ (save-excursion
+ (if (not (string-equal mode-name "TODO")) (todo-show))
+ (let* ((new-item (concat todo-prefix " "
+ (read-from-minibuffer
+ "New TODO entry: "
+ (if todo-entry-prefix-function
+ (funcall todo-entry-prefix-function))))))
+ (insert (concat new-item "\n")))))
+
(defun todo-more-important-p (line)
"Ask whether entry is more important than the one at LINE."
(if (not (equal todo-previous-line line))
todo-previous-answer)
(defalias 'todo-ask-p 'todo-more-important-p)
-(defun todo-delete-item () "Delete current TODO list entry."
+(defun todo-delete-item ()
+ "Delete current TODO list entry."
(interactive)
(if (> (count-lines (point-min) (point-max)) 0)
(let* ((todo-entry (todo-item-string-start))
(error "No TODO list entry to delete")))
(defalias 'todo-cmd-kill 'todo-delete-item)
-(defun todo-raise-item () "Raise priority of current entry."
+(defun todo-raise-item ()
+ "Raise priority of current entry."
(interactive)
(if (> (count-lines (point-min) (point)) 0)
(let ((item (todo-item-string)))
(error "No TODO list entry to raise")))
(defalias 'todo-cmd-rais 'todo-raise-item)
-(defun todo-lower-item () "Lower priority of current entry."
+(defun todo-lower-item ()
+ "Lower priority of current entry."
(interactive)
(if (> (count-lines (point) (point-max)) 1)
;; Assume there is a final newline
(error "No TODO list entry to lower")))
(defalias 'todo-cmd-lowr 'todo-lower-item)
-(defun todo-file-item () "File the current TODO list entry away."
- (interactive)
- (if (> (count-lines (point-min) (point-max)) 0)
- (let ((comment (read-from-minibuffer "Comment: "))
- (time-stamp-format todo-time-string-format))
- (if (> (length comment) 0)
- (progn
- (goto-char (todo-item-end))
- (insert
- (if (save-excursion (beginning-of-line)
- (looking-at (regexp-quote todo-prefix)))
- " "
- "\n\t")
- "(" (nth todo-category-number todo-categories) ": "
- comment ")\n")))
- (goto-char (todo-item-start))
- (let ((temp-point (point)))
- (if (looking-at (regexp-quote todo-prefix))
- (replace-match (time-stamp-string))
- ;; Standard prefix -> timestamp
- ;; Else prefix non-standard item start with timestamp
- (insert (time-stamp-string)))
- (append-to-file temp-point (todo-item-end) todo-file-done)
- (delete-region temp-point (1+ (todo-item-end))))
- (todo-backward-item)
- (message ""))
- (error "No TODO list entry to file away")))
+(defun todo-file-item (&optional comment)
+ "File the current TODO list entry away, annotated with an optional COMMENT."
+ (interactive "sComment: ")
+ (or (> (count-lines (point-min) (point-max)) 0)
+ (error "No TODO list entry to file away"))
+ (let ((time-stamp-format todo-time-string-format))
+ (if (and comment (> (length comment) 0))
+ (progn
+ (goto-char (todo-item-end))
+ (insert
+ (if (save-excursion (beginning-of-line)
+ (looking-at (regexp-quote todo-prefix)))
+ " "
+ "\n\t")
+ "(" comment ")")))
+ (goto-char (todo-item-end))
+ (insert " [" (nth todo-category-number todo-categories) "]")
+ (goto-char (todo-item-start))
+ (let ((temp-point (point)))
+ (if (looking-at (regexp-quote todo-prefix))
+ (replace-match (time-stamp-string))
+ ;; Standard prefix -> timestamp
+ ;; Else prefix non-standard item start with timestamp
+ (insert (time-stamp-string)))
+ (append-to-file temp-point (1+ (todo-item-end)) todo-file-done)
+ (delete-region temp-point (1+ (todo-item-end))))
+ (todo-backward-item)
+ (message "")))
;; ---------------------------------------------------------------------------
(or nof-priorities (setq nof-priorities todo-show-priorities))
(if (listp nof-priorities) ;universal argument
(setq nof-priorities (car nof-priorities)))
- (let ((todo-category-break (if category-pr-page "\f" ""))
+ (let ((todo-print-buffer-name todo-tmp-buffer-name)
+ ;;(todo-print-category-number 0)
+ (todo-category-break (if category-pr-page "\f" ""))
(cat-end
(concat
(if todo-remove-separator
(save-excursion
(save-restriction
(widen)
- (copy-to-buffer todo-tmp-buffer-name (point-min) (point-max))
- (set-buffer todo-tmp-buffer-name)
+ (copy-to-buffer todo-print-buffer-name (point-min) (point-max))
+ (set-buffer todo-print-buffer-name)
(goto-char (point-min))
- (if (re-search-forward (regexp-quote todo-header) nil t)
- (progn
- (beginning-of-line 1)
- (kill-line))) ;Remove mode line
+ (when (re-search-forward (regexp-quote todo-header) nil t)
+ (beginning-of-line 1)
+ (delete-region (point) (line-end-position)))
(while (re-search-forward ;Find category start
(regexp-quote (concat todo-prefix todo-category-beg))
nil t)
- (setq beg (+ (point-at-eol) 1)) ;Start of first entry.
+ (setq beg (+ (line-end-position) 1)) ;Start of first entry.
(re-search-forward cat-end nil t)
(setq end (match-beginning 0))
(replace-match todo-category-break)
;; Could have used switch-to-buffer as it has a norecord argument,
;; which is nice when we are called from e.g. todo-print.
;; Else we could have used pop-to-buffer.
- (display-buffer todo-tmp-buffer-name)
+ (display-buffer todo-print-buffer-name)
(message "Type C-x 1 to remove %s window. M-C-v to scroll the help."
- todo-tmp-buffer-name)
- ))
+ todo-print-buffer-name)))
-;;;###autoload
(defun todo-save-top-priorities (&optional nof-priorities)
"Save top priorities for each category in `todo-file-top'.
(todo-top-priorities nof-priorities)
(set-buffer todo-tmp-buffer-name)
(write-file todo-file-top)
- (kill-this-buffer)
- ))))
+ (kill-this-buffer)))))
;;;###autoload
(defun todo-print (&optional category-pr-page)
- "Print todo summary using \\\[todo-print-function].
-If CATEGORY-PR-PAGE is non-nil, a page separator \'^L\' is inserted
+ "Print todo summary using `todo-print-function'.
+If CATEGORY-PR-PAGE is non-nil, a page separator `^L' is inserted
between each category.
-Number of entries for each category is given by
-\'todo-print-priorities\'."
+Number of entries for each category is given by `todo-print-priorities'."
(interactive "P")
- (if todo-print-function
- (progn
(save-window-excursion
- (save-excursion
- (save-restriction
- (todo-top-priorities todo-print-priorities
- category-pr-page)
- (set-buffer todo-tmp-buffer-name)
- (and (funcall todo-print-function)
- (kill-this-buffer))
- (message "Todo printing done."))
- )))
- (message "todo-print-function undefinded")
- ))
+ (save-excursion
+ (save-restriction
+ (todo-top-priorities todo-print-priorities
+ category-pr-page)
+ (set-buffer todo-tmp-buffer-name)
+ (and (funcall todo-print-function)
+ (kill-this-buffer))
+ (message "Todo printing done.")))))
(defun todo-jump-to-category ()
"Jump to a category. Default is previous category."
(interactive)
(let* ((categories todo-categories)
(history (cons 'categories (1+ todo-category-number)))
- (category (completing-read
- (concat "Category ["
- (nth todo-category-number todo-categories) "]: ")
- (todo-category-alist) nil nil nil history)))
+ (default (nth todo-category-number todo-categories))
+ (category (completing-read
+ (concat "Category [" default "]: ")
+ (todo-category-alist) nil nil nil history default)))
(if (string= "" category)
(setq category (nth todo-category-number todo-categories)))
(setq todo-category-number
(todo-add-category category)))
(todo-show)))
-(defun todo-line-string () "Return current line in buffer as a string."
- (buffer-substring (point-at-bol) (point-at-eol)))
+(defun todo-line-string ()
+ "Return current line in buffer as a string."
+ (buffer-substring (line-beginning-position) (line-end-position)))
(defun todo-item-string-start ()
"Return the start of this TODO list entry as a string."
(setq item (concat (substring item 0 56) "...")))
item))
-(defun todo-item-start () "Return point at start of current TODO list item."
+(defun todo-item-start ()
+ "Return point at start of current TODO list item."
(save-excursion
(beginning-of-line)
(if (not (looking-at (regexp-quote todo-prefix)))
(concat "^" (regexp-quote todo-prefix)) nil t))
(point)))
-(defun todo-item-end () "Return point at end of current TODO list item."
+(defun todo-item-end ()
+ "Return point at end of current TODO list item."
(save-excursion
(end-of-line)
(search-forward-regexp
(concat "^" (regexp-quote todo-prefix)) nil 'goto-end)
- (1- (point-at-bol))))
+ (1- (line-beginning-position))))
-(defun todo-remove-item () "Delete the current entry from the TODO list."
+(defun todo-remove-item ()
+ "Delete the current entry from the TODO list."
(delete-region (todo-item-start) (1+ (todo-item-end))))
-(defun todo-item-string () "Return current TODO list entry as a string."
+(defun todo-item-string ()
+ "Return current TODO list entry as a string."
(buffer-substring (todo-item-start) (todo-item-end)))
(defun todo-string-count-lines (string)
(length (split-string string "\n")))
(defun todo-string-multiline-p (string)
- "Returns non-nil if STRING spans several lines"
+ "Return non-nil if STRING spans several lines."
(> (todo-string-count-lines string) 1))
(defun todo-category-alist ()
- "Generate an alist fro use in `completing-read' from `todo-categories'"
- (mapcar (lambda (cat) (cons cat nil))
- todo-categories))
-
-;; utility functions: These are available in XEmacs, but not in Emacs 19.34
-
-(if (not (fboundp 'point-at-bol))
- (defun point-at-bol () "Return value of point at beginning of line."
- (save-excursion
- (beginning-of-line)
- (point))))
-
-(if (not (fboundp 'point-at-eol))
- (defun point-at-eol () "Return value of point at end of line."
- (save-excursion
- (end-of-line)
- (point))))
-
-;; splits at a white space, returns a list
-(if (not (fboundp 'split-string))
- (defun split-string (string &optional separators)
- "Splits STRING into substrings where there are matches for SEPARATORS.
-Each match for SEPARATORS is a splitting point.
-The substrings between the splitting points are made into a list
-which is returned.
-If SEPARATORS is absent, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
- (let ((rexp (or separators "[ \f\t\n\r\v]+"))
- (start 0)
- (list nil))
- (while (string-match rexp string start)
- (or (eq (match-beginning 0) 0)
- (setq list
- (cons (substring string start (match-beginning 0))
- list)))
- (setq start (match-end 0)))
- (or (eq start (length string))
- (setq list
- (cons (substring string start)
- list)))
- (nreverse list))))
+ "Generate an alist for use in `completing-read' from `todo-categories'."
+ (mapcar #'list todo-categories))
;; ---------------------------------------------------------------------------
["Edit item" todo-edit-item t]
["File item" todo-file-item t]
["Insert new item" todo-insert-item t]
+ ["Insert item here" todo-insert-item-here t]
["Kill item" todo-delete-item t]
"---"
["Lower item priority" todo-lower-item t]
))
;; As calendar reads .todo-do before todo-mode is loaded.
-;;;### autoload
-(defun todo-mode () "Major mode for editing TODO lists.\n\n\\{todo-mode-map}"
+;;;###autoload
+(defun todo-mode ()
+ "Major mode for editing TODO lists.
+
+\\{todo-mode-map}"
(interactive)
+ (kill-all-local-variables)
(setq major-mode 'todo-mode)
(setq mode-name "TODO")
(use-local-map todo-mode-map)
(easy-menu-add todo-menu)
- (run-hooks 'todo-mode-hook))
+ (run-mode-hooks 'todo-mode-hook))
+
+(eval-when-compile
+ (defvar date)
+ (defvar entry))
+
+;; Read about this function in the setup instructions above!
+;;;###autoload
+(defun todo-cp ()
+ "Make a diary entry appear only in the current date's diary."
+ (if (equal (calendar-current-date) date)
+ entry))
+
+(define-derived-mode todo-edit-mode text-mode "TODO Edit"
+ "Major mode for editing items in the TODO list.
-(defun todo-edit-mode ()
- "Major mode for editing items in the TODO list\n\n\\{todo-edit-mode-map}"
- (text-mode)
- (setq major-mode 'todo-edit-mode)
- (setq mode-name "TODO Edit")
- (run-hooks 'todo-edit-mode-hook))
+\\{todo-edit-mode-map}")
-;;;### autoload
-(defun todo-show () "Show TODO list."
+;;;###autoload
+(defun todo-show ()
+ "Show TODO list."
(interactive)
(if (file-exists-p todo-file-do)
(find-file todo-file-do)
(beginning-of-line)
(todo-category-select))
-(defun todo-initial-setup () "Set up things to work properly in TODO mode."
+(defun todo-initial-setup ()
+ "Set up things to work properly in TODO mode."
(find-file todo-file-do)
(erase-buffer)
(todo-mode)
(provide 'todo-mode)
-;; ---------------------------------------------------------------------------
+;;; arch-tag: 6fd91be5-776e-4464-a109-da4ea0e4e497
;;; todo-mode.el ends here
-;; ---------------------------------------------------------------------------