todo-mode.el 27.3 KB
Newer Older
1
;; todo-mode.el -- Major mode for editing TODO list files
Oliver Seidel's avatar
Oliver Seidel committed
2

Oliver Seidel's avatar
Oliver Seidel committed
3
;; Copyright (C) 1997 Free Software Foundation, Inc.
Oliver Seidel's avatar
Oliver Seidel committed
4

Oliver Seidel's avatar
Oliver Seidel committed
5 6
;; Author: Oliver.Seidel@cl.cam.ac.uk (was valid on Aug 2, 1997)
;; Created: 2 Aug 1997
7
;; Version: $Id: todo-mode.el,v 1.18 1997/10/15 17:18:11 os10000 Exp os10000 $
Oliver Seidel's avatar
Oliver Seidel committed
8
;; Keywords: Categorised TODO list editor, todo-mode
Oliver Seidel's avatar
Oliver Seidel committed
9

Oliver Seidel's avatar
Oliver Seidel committed
10
;; This file is part of GNU Emacs.
11

Oliver Seidel's avatar
Oliver Seidel committed
12
;; GNU Emacs is free software; you can redistribute it and/or modify
13 14 15
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
Oliver Seidel's avatar
Oliver Seidel committed
16 17

;; GNU Emacs is distributed in the hope that it will be useful,
18 19 20
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.
Oliver Seidel's avatar
Oliver Seidel committed
21

22 23 24 25 26 27 28
;; 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.

;; ---------------------------------------------------------------------------

Oliver Seidel's avatar
Oliver Seidel committed
29 30
;;; Commentary:

31
;;  Preface, Quickstart Installation
32
;;
33
;;	To get this to work, make emacs execute the line
34
;;
35
;;	    (require 'todo-mode) ;; load the TODO package
36
;;
37 38
;;	You may now enter new items by typing "M-x todo-insert-item", or enter
;;	your the TODO list file by typing "M-x todo-show".
Oliver Seidel's avatar
Oliver Seidel committed
39
;;
40 41 42 43 44 45
;;	The TODO list file has a special format and some auxiliary
;;	information, which will be added by the todo-show function if it
;;	attempts to visit an un-initialised file.  Hence it is
;;	recommended to use the todo-show function for the first time, in
;;	order to initialise the file, but it is not necessary
;;	afterwards.
Oliver Seidel's avatar
Oliver Seidel committed
46
;;
47 48 49
;;	As these commands are quite long to type, I would recommend the
;;	addition of two bindings to your to your global keymap.  I
;;	personally have the following in my initialisation file:
Oliver Seidel's avatar
Oliver Seidel committed
50
;;
51 52
;;	    (global-set-key "\C-ct" 'todo-show) ;; switch to TODO buffer
;;	    (global-set-key "\C-ci" 'todo-insert-item) ;; insert new item
Oliver Seidel's avatar
Oliver Seidel committed
53
;;
54 55 56 57 58 59 60 61 62 63
;;	Note, however, that this recommendation has prompted some
;;	criticism, since the keys C-c LETTER are reserved for user
;;	functions.  I believe my recommendation is acceptable, since the
;;	Emacs Lisp Manual *Tips* section also details that the mode itself
;;	should not bind any functions to those keys.  The express aim of
;;	the above two bindings is to work outside the mode, which doesn't
;;	need the show function and offers a different binding for the
;;	insert function.  They serve as shortcuts and are not even needed
;;	(since the TODO mode will be entered by visiting the TODO file, and
;;	later by switching to its buffer).
Oliver Seidel's avatar
Oliver Seidel committed
64 65
;;
;; Pre-Requisites
66
;;
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201
;;	This package will require the following packages to be available on
;;	the load-path:
;;
;;	    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:
;;
;;	    M-x todo-show   will enter the todo list screen, here type
;;
;;	    +  to go to next category
;;          -  to go to previous category
;;          e  to edit the current entry
;;          f  to file the current entry, including a
;;            			    comment and timestamp
;;          i  to insert a new entry
;;          k  to kill the current entry
;;          l  to lower the current entry's priority
;;          n  for the next entry
;;          p  for the previous entry
;;          q  to save the list and exit the buffer
;;          r  to raise the current entry's priority
;;          s  to save the list
;;
;;	When you add a new entry, you are asked for the text and then for
;;	the category.  I for example have categories for things that I want
;;	to do in the office (like mail my mum), that I want to do in town
;;	(like buy cornflakes) and things I want to do at home (move my
;;	suitcases).  The categories can be selected with the cursor keys
;;	and if you type in the name of a category which didn't exist
;;	before, an empty category of the desired name will be added and
;;	filled with the new entry.
;;
;;  Configuration
;;
;;  Variable todo-prefix
;;
;;	I would like to recommend that you use the prefix "*/*" (by
;;	leaving the variable 'todo-prefix' untouched) so that the diary
;;	displays each entry every day.
;;
;;	To understand what I mean, please read the documentation that goes
;;	with the calendar since that will tell you how you can set up the
;;	fancy diary display and use the #include command to include your
;;	todo list file as part of your diary.
;;
;;	 If you have the diary package set up to usually display more than
;;	one day's entries at once, consider using
;;
;;	    "&%%(equal (calendar-current-date) date)"
;;
;;	as the value of `todo-prefix'.  Please note that this may slow down
;;	the processing of your diary file some.
;;
;;  Variable todo-file-do
;;
;;	This variable is fairly self-explanatory.  You have to store your TODO
;;	list somewhere.  This variable tells the package where to go and find
;;	this file.
;;
;;  Variable todo-file-done
;;
;;	Even when you're done, you may wish to retain the entries.  Given
;;	that they're timestamped and you are offered to add a comment, this
;;	can make a useful diary of past events.  It will even blend in with
;;	the EMACS diary package.  So anyway, this variable holds the name
;;	of the file for the filed todo-items.
;;
;;  Variable todo-mode-hook
;;
;;	Just like other modes, too, this mode offers to call your functions
;;	before it goes about its business.  This variable will be inspected
;;	for any functions you may wish to have called once the other TODO
;;	mode preparations have been completed.
;;
;;  Variables todo-insert-threshold
;;
;;     	Another nifty feature is the 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 i.e. 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 e-mail
;;     	reply from Trey Jackson <trey@cs.berkeley.edu> who corrected some
;;     	of my awful coding and pointed me towards some good reading.
;;     	Thanks Trey!
;;
;;  Things to do
;;
;;	o   licence / version function
;;	o   export to diary file
;;	o   todo-report-bug
;;	o   GNATS support
;;	o   elide multiline
;;	o   rewrite complete package to store data as lisp objects and have
;;	    display modes for display, for diary export, etc.
;;          (Richard Stallman pointed out this is a bad idea)
;;      o   base todo-mode.el on generic-mode.el instead
;;
;; History and Gossip
;;
;;	Many thanks to all the ones who have contributed to the evolution
;;	of this package!  I hope I have listed all of you somewhere in the
;;	documentation or at least in the RCS history!
;;
;;	Enjoy this package and express your gratitude by sending nice things
;;	to my parents' address!
;;
;;	Oliver Seidel
;;	(O Seidel, Lessingstr. 8, 65760 Eschborn, Federal Republic of Germany)
202 203 204 205
;;

;; ---------------------------------------------------------------------------

Oliver Seidel's avatar
Oliver Seidel committed
206 207 208 209 210
;; ---------------------------------------------------------------------------

;;; Change Log:

;; $Log: todo-mode.el,v $
211 212 213 214 215 216
;; 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.
;;
217 218 219
;; Revision 1.17  1997/10/15  14:30:41  os10000
;; Attempted to reconcile Harald's changes with mine since 1.15.
;;
220 221 222
;; Revision 1.16  1997/10/15  14:00:12  os10000
;; Fixed 'file-item' and added 20.02 split-string function.
;;
223 224 225 226 227
;; 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.
;;
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
;; 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.
;;
248 249 250 251 252 253
;; 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
;;
Oliver Seidel's avatar
Oliver Seidel committed
254 255
;; Revision 1.12  1997/08/06  10:56:15  os10000
;; Fixed header, typos, layout, documentation.
256
;;
257 258 259 260
;; Revision 1.11  1997/08/06  09:14:25  os10000
;; Applied patch from Istvan Marko <istvan@cmdmail.amd.com>
;; to make menus work anywhere.
;;
261 262 263 264
;; 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.
;;
265 266 267 268 269
;; 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.
;;
270
;; Revision 1.8  1997/08/05 22:39:04  os10000
Oliver Seidel's avatar
Oliver Seidel committed
271
;; Made todo-mode.el available under GPL.
272 273 274
;;
;; Revision 1.7  1997/08/05 22:34:14  os10000
;; Fixed insertion routine with help from Trey Jackson
275
;; <trey@cs.berkeley.edu>; added todo-inst-tresh;
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
;; 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
;;
298 299 300

;; ---------------------------------------------------------------------------

Oliver Seidel's avatar
Oliver Seidel committed
301 302
;;; Code:

Oliver Seidel's avatar
Oliver Seidel committed
303 304
;; User-configurable variables:

305 306 307 308 309 310 311
(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.")
Oliver Seidel's avatar
Oliver Seidel committed
312 313 314 315

;; 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".
;;
316 317
(defvar todo-time-string-format
  "%:y-%02m-%02d %02H:%02M"
Oliver Seidel's avatar
Oliver Seidel committed
318 319 320
  "TODO mode time string format for done entries.
For details see the variable `time-stamp-format'.")

Oliver Seidel's avatar
Oliver Seidel committed
321 322
;; ---------------------------------------------------------------------------

323 324
;; Get some outside help ...

Oliver Seidel's avatar
Oliver Seidel committed
325
(require 'time-stamp)
326 327 328
(require 'easymenu)

;; ---------------------------------------------------------------------------
Oliver Seidel's avatar
Oliver Seidel committed
329

330 331
;; Set up some helpful context ...

332 333
(defvar todo-categories         nil     "TODO categories.")
(defvar todo-cats               nil
334
  "Old variable for holding the TODO categories.  Use `todo-categories' instead.")
335 336 337 338
(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.")
339 340 341

;; ---------------------------------------------------------------------------

342 343 344 345
(if todo-mode-map
    nil
  (let ((map (make-keymap)))
    (suppress-keymap map t)
346 347 348 349 350 351 352 353 354 355 356 357 358
    (define-key map "+" 'todo-forward-category)
    (define-key map "-" 'todo-backward-category)
    (define-key map "e" 'todo-edit-item)
    (define-key map "E" 'todo-edit-multiline)
    (define-key map "f" 'todo-file-item)
    (define-key map "i" 'todo-insert-item)
    (define-key map "k" 'todo-delete-item)
    (define-key map "l" 'todo-lower-item)
    (define-key map "n" 'todo-forward-item)
    (define-key map "p" 'todo-backward-item)
    (define-key map "q" 'todo-quit)
    (define-key map "r" 'todo-raise-item)
    (define-key map "s" 'todo-save)
359
    (setq todo-mode-map map)))
Oliver Seidel's avatar
Oliver Seidel committed
360

361 362 363
(defun todo-category-select ()
  "Make TODO mode display the current category correctly."
  (let ((name (nth todo-category-number todo-categories)))
364
    (setq mode-line-buffer-identification
365
          (concat "Category: " name))
366 367
    (widen)
    (goto-char (point-min))
368 369 370 371 372 373 374 375 376
    (search-forward-regexp
     (concat "^" (regexp-quote (concat todo-prefix " --- " name))))
    (let ((begin (1+ (point-at-eol))))
      (search-forward-regexp "^--- End")
      (narrow-to-region begin (point-at-bol))
      (goto-char (point-min)))))
(defalias 'todo-cat-slct 'todo-category-select)

(defun todo-forward-category () "Go forward to TODO list of next category."
377
  (interactive)
378
  (setq todo-category-number
379
        (mod (1+ todo-category-number) (length todo-categories)))
380 381
  (todo-category-select))
(defalias 'todo-cmd-forw 'todo-forward-category)
382

383
(defun todo-backward-category () "Go back to TODO list of previous category."
384
  (interactive)
385
  (setq todo-category-number
386
        (mod (1- todo-category-number) (length todo-categories)))
387 388
  (todo-category-select))
(defalias 'todo-cmd-back 'todo-backward-category)
389

390
(defun todo-backward-item () "Select previous entry of TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
391
  (interactive)
392
  (search-backward-regexp (concat "^" (regexp-quote todo-prefix)) nil t)
393
  (message ""))
394
(defalias 'todo-cmd-prev 'todo-backward-item)
Oliver Seidel's avatar
Oliver Seidel committed
395

396
(defun todo-forward-item () "Select next entry of TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
397
  (interactive)
398 399 400
  (end-of-line)
  (search-forward-regexp (concat "^" (regexp-quote todo-prefix)) nil 'goto-end)
  (beginning-of-line)
401
  (message ""))
402
(defalias 'todo-cmd-next 'todo-forward-item)
Oliver Seidel's avatar
Oliver Seidel committed
403

404
(defun todo-save () "Save the TODO list."
405
  (interactive)
406
  (save-buffer))
407
(defalias 'todo-cmd-save 'todo-save)
408

409
(defun todo-quit () "Done with TODO list for now."
Oliver Seidel's avatar
Oliver Seidel committed
410
  (interactive)
411 412
  (widen)
  (save-buffer)
413
  (message "")
414
  (bury-buffer))
415
(defalias 'todo-cmd-done 'todo-quit)
Oliver Seidel's avatar
Oliver Seidel committed
416

417
(defun todo-edit-item () "Edit current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
418
  (interactive)
419 420
  (let ((item (todo-item-string)))
    (if (todo-string-multiline-p item)
421
        (todo-edit-multiline)
422
      (let ((new (read-from-minibuffer "Edit: " item)))
423 424 425 426
        (todo-remove-item)
        (insert new "\n")
        (todo-backward-item)
        (message "")))))
427 428 429 430 431 432
(defalias 'todo-cmd-edit 'todo-edit-item)

(defun todo-edit-multiline ()
  "Set up a buffer for editing a multiline TODO list entry."
  (interactive)
  (let ((buffer-name (generate-new-buffer-name todo-edit-buffer)))
433
    (switch-to-buffer (make-indirect-buffer (file-name-nondirectory todo-file-do)
434
                                         buffer-name))
435
    (message "To exit, simply kill this buffer and return to list.")
436 437
    (todo-edit-mode)
    (narrow-to-region (todo-item-start) (todo-item-end))))
Oliver Seidel's avatar
Oliver Seidel committed
438

439
(defun todo-add-category (cat) "Add a new category to the TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
440 441
  (interactive)
  (save-window-excursion
442
    (setq todo-categories (cons cat todo-categories))
Oliver Seidel's avatar
Oliver Seidel committed
443
    (find-file todo-file-do)
444 445 446 447
    (widen)
    (goto-char (point-min))
    (let ((posn (search-forward "-*- mode: todo; " 17 t)))
      (if (not (null posn)) (goto-char posn))
448
      (if (equal posn nil)
449 450 451 452
          (progn
            (insert "-*- mode: todo; \n")
            (forward-char -1))
        (kill-line)))
453
    (insert (format "todo-categories: %S; -*-" todo-categories))
454
    (forward-char 1)
455
    (insert (format "%s --- %s\n--- End\n%s %s\n"
456
                    todo-prefix cat todo-prefix (make-string 75 ?-))))
457
  0)
458

459
(defun todo-insert-item ()
460
  "Insert new TODO list entry."
461
  (interactive)
462
  (let* ((new-item (concat todo-prefix " "
463
                           (read-from-minibuffer "New TODO entry: ")))
464 465
         (categories todo-categories)
         (history (cons 'categories (1+ todo-category-number)))
466 467 468 469
         (category (completing-read "Category: "
                                    (todo-category-alist) nil nil
                                    (nth todo-category-number todo-categories)
                                    history)))
470 471
    (let ((cat-exists (member category todo-categories)))
      (setq todo-category-number
472 473 474
            (if cat-exists
                (- (length todo-categories) (length cat-exists))
              (todo-add-category category))))
475 476 477
    (todo-show)
    (setq todo-previous-line 0)
    (let ((top 1)
478
          (bottom (1+ (count-lines (point-min) (point-max)))))
479
      (while (> (- bottom top) todo-insert-threshold)
480 481 482 483 484 485
        (let* ((current (/ (+ top bottom) 2))
               (answer (if (< current bottom)
                           (todo-more-important-p current) nil)))
          (if answer
              (setq bottom current)
            (setq top (1+ current)))))
486 487 488 489 490 491
      (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)
Oliver Seidel's avatar
Oliver Seidel committed
492
    (save-buffer)
493
    (message "")))
494
(defalias 'todo-cmd-inst 'todo-insert-item)
495

496
(defun todo-more-important-p (line)
497 498
  "Ask whether entry is more important than the one at LINE."
  (if (not (equal todo-previous-line line))
499
      (progn
500
        (setq todo-previous-line line)
501
        (goto-char (point-min))
502
        (forward-line (1- todo-previous-line))
503 504 505
        (let ((item (todo-item-string-start)))
          (setq todo-previous-answer
                (y-or-n-p (concat "More important than '" item "'? "))))))
506 507 508 509
  todo-previous-answer)
(defalias 'todo-ask-p 'todo-more-important-p)

(defun todo-delete-item () "Delete current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
510 511
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
512
      (let* ((todo-entry (todo-item-string-start))
513 514 515 516 517 518 519
             (todo-answer (y-or-n-p (concat "Permanently remove '"
                                            todo-entry "'? "))))
        (if todo-answer
            (progn
              (todo-remove-item)
              (todo-backward-item)))
        (message ""))
520 521
    (error "No TODO list entry to delete")))
(defalias 'todo-cmd-kill 'todo-delete-item)
Oliver Seidel's avatar
Oliver Seidel committed
522

523
(defun todo-raise-item () "Raise priority of current entry."
Oliver Seidel's avatar
Oliver Seidel committed
524
  (interactive)
525 526
  (if (> (count-lines (point-min) (point)) 0)
      (let ((item (todo-item-string)))
527 528 529 530 531
        (todo-remove-item)
        (todo-backward-item)
        (save-excursion
          (insert item "\n"))
        (message ""))
532 533
    (error "No TODO list entry to raise")))
(defalias 'todo-cmd-rais 'todo-raise-item)
Oliver Seidel's avatar
Oliver Seidel committed
534

535
(defun todo-lower-item () "Lower priority of current entry."
Oliver Seidel's avatar
Oliver Seidel committed
536
  (interactive)
537 538
  (if (> (count-lines (point) (point-max)) 1) ; Assume there is a final newline
      (let ((item (todo-item-string)))
539 540 541 542 543
        (todo-remove-item)
        (todo-forward-item)
        (save-excursion
          (insert item "\n"))
        (message ""))
544 545
    (error "No TODO list entry to lower")))
(defalias 'todo-cmd-lowr 'todo-lower-item)
Oliver Seidel's avatar
Oliver Seidel committed
546

547
(defun todo-file-item () "File the current TODO list entry away."
Oliver Seidel's avatar
Oliver Seidel committed
548 549
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
550
      (let ((comment (read-from-minibuffer "Comment: "))
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
            (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 ""))
571
    (error "No TODO list entry to file away")))
Oliver Seidel's avatar
Oliver Seidel committed
572 573 574

;; ---------------------------------------------------------------------------

575 576 577 578 579 580 581 582 583 584
;; Utility functions:

(defun todo-line-string () "Return current line in buffer as a string."
  (buffer-substring (point-at-bol) (point-at-eol)))

(defun todo-item-string-start ()
  "Return the start of this TODO list entry as a string."
  ;; Suitable for putting in the minibuffer when asking the user
  (let ((item (todo-item-string)))
    (if (> (length item) 60)
585
        (setq item (concat (substring item 0 56) "...")))
586 587 588 589 590 591
    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)))
592 593
        (search-backward-regexp
         (concat "^" (regexp-quote todo-prefix)) nil t))
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
    (point)))

(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))))

(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."
  (buffer-substring (todo-item-start) (todo-item-end)))

(defun todo-string-count-lines (string)
  "Return the number of lines STRING spans."
  (length (split-string string "\n")))

(defun todo-string-multiline-p (string)
  "Returns 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'"
618
  (mapcar (lambda (cat) (cons cat nil))
619
          todo-categories))
620

621 622 623
;; utility functions:  These are available in XEmacs, but not in Emacs 19.34

(if (not (fboundp 'point-at-bol))
624
    (defun point-at-bol () "Return value of point at beginning of line."
625
      (save-excursion
626 627
        (beginning-of-line)
        (point))))
628 629

(if (not (fboundp 'point-at-eol))
630
    (defun point-at-eol () "Return value of point at end of line."
631
      (save-excursion
632 633
        (end-of-line)
        (point))))
634

635 636
;; splits at a white space, returns a list
(if (not (fboundp 'split-string))
637 638 639 640 641 642 643
    (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]+"))
644 645 646 647 648 649 650 651 652 653 654 655 656
            (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))))
657

658 659
;; ---------------------------------------------------------------------------

660
(easy-menu-define todo-menu todo-mode-map "Todo Menu"
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
                  '("Todo"
                    ["Next category"        todo-forward-category t]
                    ["Previous category"    todo-backward-category t]
                    "---"
                    ["Edit item"            todo-edit-item t]
                    ["File item"            todo-file-item t]
                    ["Insert new item"      todo-insert-item t]
                    ["Kill item"            todo-delete-item t]
                    "---"
                    ["Lower item priority"  todo-lower-item t]
                    ["Raise item priority"  todo-raise-item t]
                    "---"
                    ["Next item"            todo-forward-item t]
                    ["Previous item"        todo-backward-item t]
                    "---"
                    ["Save"                 todo-save t]
                    "---"
                    ["Quit"                 todo-quit t]
                    ))
680

681
(defun todo-mode () "Major mode for editing TODO lists.\n\n\\{todo-mode-map}"
Oliver Seidel's avatar
Oliver Seidel committed
682 683 684 685
  (interactive)
  (setq major-mode 'todo-mode)
  (setq mode-name "TODO")
  (use-local-map todo-mode-map)
686 687
  (easy-menu-add todo-menu)
  (run-hooks 'todo-mode-hook))
688

689 690 691 692 693 694 695
(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))

696 697
(defun todo-show () "Show TODO list."
  (interactive)
698 699 700 701 702
  (if (file-exists-p todo-file-do)
      (find-file todo-file-do)
    (todo-initial-setup))
  (if (null todo-categories)
      (if (null todo-cats)
703 704 705 706 707 708 709
          (error "Error in %s: No categories in list `todo-categories'"
                 todo-file-do)
        (goto-char (point-min))
        (and (search-forward "todo-cats:" nil t)
             (replace-match "todo-categories:"))
        (make-local-variable todo-categories)
        (setq todo-categories todo-cats)))
710 711 712 713
  (beginning-of-line)
  (todo-category-select))

(defun todo-initial-setup () "Set up things to work properly in TODO mode."
714
  (find-file todo-file-do)
715 716 717
  (erase-buffer)
  (todo-mode)
  (todo-add-category "Todo"))
Oliver Seidel's avatar
Oliver Seidel committed
718

Oliver Seidel's avatar
Oliver Seidel committed
719
(provide 'todo-mode)
Oliver Seidel's avatar
Oliver Seidel committed
720 721

;; ---------------------------------------------------------------------------
Oliver Seidel's avatar
Oliver Seidel committed
722
;;; todo-mode.el ends here
Oliver Seidel's avatar
Oliver Seidel committed
723
;; ---------------------------------------------------------------------------