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

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

5 6
;; Author: Oliver Seidel <os10000@seidel-space.de>
;;   [Not clear the above works, July 2000]
Oliver Seidel's avatar
Oliver Seidel committed
7
;; Created: 2 Aug 1997
8 9
;; Version: $Id: todo-mode.el,v 1.1 1999/05/12 11:49:30 fx Exp fx $
;; Keywords: calendar, todo
Oliver Seidel's avatar
Oliver Seidel committed
10

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

Oliver Seidel's avatar
Oliver Seidel committed
13
;; GNU Emacs is free software; you can redistribute it and/or modify
14 15 16
;; 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
17 18

;; GNU Emacs is distributed in the hope that it will be useful,
19 20 21
;; 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
22

23 24 25 26 27 28 29
;; 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
30 31
;;; Commentary:

32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
;;  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.
;;
51
;;  Preface, Quickstart Installation
52
;;
53
;;      To get this to work, make emacs execute the line
54
;;
55
;;          (autoload 'todo-mode "todo-mode"
56 57 58 59 60
;;                    "Major mode for editing TODO lists." t)
;;          (autoload 'todo-show "todo-mode"
;;                    "Show TODO items." t)
;;          (autoload 'todo-insert-item "todo-mode"
;;                    "Add TODO item." t)
Oliver Seidel's avatar
Oliver Seidel committed
61
;;
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
;;      You may now enter new items by typing "M-x todo-insert-item",
;;      or enter your TODO list file by typing "M-x todo-show".
;;
;;      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.
;;
;;      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:
;;
;;          (global-set-key "\C-ct" 'todo-show) ;; switch to TODO buffer
77
;;	    (global-set-key "\C-ci" 'todo-insert-item) ;; insert new item
Oliver Seidel's avatar
Oliver Seidel committed
78
;;
79 80 81 82 83 84 85 86 87 88 89 90
;;      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).
;;
91 92 93 94 95
;;      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.
;;
96
;;  Version
Oliver Seidel's avatar
Oliver Seidel committed
97
;;
98
;;      Which version of todo-mode.el does this documentation refer to?
99
;;
100 101 102 103 104 105 106 107 108
;;      $Id: todo-mode.el,v 1.1 1999/05/12 11:49:30 fx Exp fx $
;;
;;  Pre-Requisites
;;
;;      This package will require the following packages to be
;;      available on the load-path:
;;
;;          time-stamp
;;          easymenu
109
;;
110
;;  Operation
111 112 113 114 115 116 117
;;
;;	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
118 119
;;          d  to file the current entry, including a
;;            			    comment and timestamp
120
;;          e  to edit the current entry
121
;;          E  to edit a multi-line entry
122 123
;;          f  to file the current entry, including a
;;            			    comment and timestamp
Oliver Seidel's avatar
Oliver Seidel committed
124
;;          i  to insert a new entry, with prefix, omit category
125
;;          I  to insert a new entry at current cursor position
126
;;	    j  jump to category
127 128 129 130
;;          k  to kill the current entry
;;          l  to lower the current entry's priority
;;          n  for the next entry
;;          p  for the previous entry
131
;;	    P  print
132 133 134
;;          q  to save the list and exit the buffer
;;          r  to raise the current entry's priority
;;          s  to save the list
135
;;          S  to save the list of top priorities
136
;;	    t  show top priority items for each category
137
;;
138 139 140 141 142 143 144 145
;;	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.
146 147 148 149 150 151
;;
;;  Configuration
;;
;;  Variable todo-prefix
;;
;;	I would like to recommend that you use the prefix "*/*" (by
152 153
;;	leaving the variable 'todo-prefix' untouched) so that the
;;	diary displays each entry every day.
154
;;
155 156 157 158
;;	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.
159
;;
160 161
;;	If you have the diary package set up to usually display more
;;	than one day's entries at once, consider using
162 163 164
;;
;;	    "&%%(equal (calendar-current-date) date)"
;;
165 166
;;	as the value of `todo-prefix'.  Please note that this may slow
;;	down the processing of your diary file some.
167
;;
168 169 170 171 172 173 174 175 176 177 178
;;      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.
;;
179 180
;;  Variable todo-file-do
;;
181 182 183
;;	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.
184 185 186
;;
;;  Variable todo-file-done
;;
187 188 189 190 191
;;	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.
192
;;
193 194 195 196 197 198
;;  Variable todo-file-top
;;
;;      File storing the top priorities of your TODO list when
;;      todo-save-top-priorities is non-nil.  Nice to include in your
;;      diary instead of the complete TODO list.
;;
199 200
;;  Variable todo-mode-hook
;;
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
;;	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.
;;
;;  Variable 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
218
;;     	that point.  If you set the threshhold to, e.g. 8, it will stop
219 220 221 222 223 224
;;     	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!
225 226 227
;;
;;  Things to do
;;
228 229 230 231 232 233 234 235 236 237 238 239 240
;;      These originally were my ideas, but now also include all the
;;      suggestions that I included before forgetting them:
;;
;;      o   Fancy fonts for todo/top-priority buffer
;;      o   Remove todo-prefix option in todo-top-priorities
;;      o   Rename category
;;      o   Move entry from one category to another one
;;      o   Entries which both have the generic */* prefix and a
;;          "deadline" entry which are understood by diary, indicating
;;          an event (unless marked by &)
;;      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
241
;;          the code, like the completing-read lines of code.
242
;;	o   license / version function
243 244 245
;;	o   export to diary file
;;	o   todo-report-bug
;;	o   GNATS support
246 247 248 249 250 251
;;	o   elide multiline (as in bbdb, or, to a lesser degree, in
;;          outline mode)
;;	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   so base todo-mode.el on generic-mode.el instead
252
;;
253
;;  History and Gossip
254
;;
255 256 257
;;	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!
258
;;
259 260
;;	Enjoy this package and express your gratitude by sending nice
;;	things to my parents' address!
261 262
;;
;;	Oliver Seidel
263
;;	(Lessingstr. 8, 65760 Eschborn, Federal Republic of Germany)
264

Oliver Seidel's avatar
Oliver Seidel committed
265 266
;;; Code:

Oliver Seidel's avatar
Oliver Seidel committed
267 268
;; User-configurable variables:

269 270 271 272
(defgroup todo nil
  "Maintain a list of todo items."
  :group 'calendar)

273
(defcustom todo-prefix     "*/*"
274 275 276 277 278 279 280 281 282 283 284 285 286 287
  "*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)
288
(defcustom todo-file-do    "~/.todo-do"
289 290 291
  "*TODO mode list file."
  :type 'file
  :group 'todo)
292
(defcustom todo-file-done  "~/.todo-done"
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
  "*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 centre of that
window."
  :type 'integer
  :group 'todo)
320 321
(defvar todo-edit-buffer " *TODO Edit*"
  "TODO Edit buffer name.")
322
(defcustom todo-file-top "~/.todo-top"
323
  "*TODO mode top priorities file.
324

325
Not in TODO format, but diary compatible.
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
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
345
  "*Non-nil to remove category separators in\
346 347 348 349
\\[todo-top-priorities] and \\[todo-print]."
  :type 'boolean
  :group 'todo)
(defcustom todo-save-top-priorities-too t
350
  "*Non-nil makes `todo-save' automatically save top-priorities in `todo-file-top'."
351 352
  :type 'boolean
  :group 'todo)
353

Oliver Seidel's avatar
Oliver Seidel committed
354 355 356
;; 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".
;;
357
(defcustom todo-time-string-format
358
  "%:y-%02m-%02d %02H:%02M"
359 360 361 362 363 364 365 366 367 368 369 370 371
  "*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)
372

373 374
(autoload 'time-stamp-string "time-stamp")

375
(defun todo-entry-timestamp-initials ()
376
  "Prepend timestamp and your initials to the head of a TODO entry."
377 378 379
  (let ((time-stamp-format todo-time-string-format))
    (concat (time-stamp-string) " " todo-initials ": ")))

380 381
;; ---------------------------------------------------------------------------

382 383
;; Set up some helpful context ...

384 385
(defvar todo-categories nil
  "TODO categories.")
386

387
(defvar todo-cats nil
388 389
  "Old variable for holding the TODO categories.
Use `todo-categories' instead.")
390

391 392
(defvar todo-previous-line 0
  "Previous line asked about.")
393

394 395
(defvar todo-previous-answer 0
  "Previous answer got.")
396

397
(defvar todo-mode-map
398 399
  (let ((map (make-keymap)))
    (suppress-keymap map t)
400 401
    (define-key map "+" 'todo-forward-category)
    (define-key map "-" 'todo-backward-category)
402
    (define-key map "d" 'todo-file-item) ;done/delete
403 404 405 406
    (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)
407
    (define-key map "I" 'todo-insert-item-here)
408
    (define-key map "j" 'todo-jump-to-category)
409 410 411 412
    (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)
413
    (define-key map "P" 'todo-print)
414 415 416
    (define-key map "q" 'todo-quit)
    (define-key map "r" 'todo-raise-item)
    (define-key map "s" 'todo-save)
417
    (define-key map "S" 'todo-save-top-priorities)
418
    (define-key map "t" 'todo-top-priorities)
419 420 421
    map)
  "TODO mode keymap.")

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
(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.")

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

440 441 442
(defun todo-category-select ()
  "Make TODO mode display the current category correctly."
  (let ((name (nth todo-category-number todo-categories)))
443
    (setq mode-line-buffer-identification
444
;;          (concat "Category: " name))
445
          (concat "Category: " (format "%18s" name)))
446 447
    (widen)
    (goto-char (point-min))
448
    (search-forward-regexp
449 450 451
     (concat "^"
             (regexp-quote (concat todo-prefix todo-category-beg name))
             "$"))
452
    (let ((begin (1+ (line-end-position))))
453
      (search-forward-regexp (concat "^" todo-category-end))
454
      (narrow-to-region begin (line-beginning-position))
455 456 457
      (goto-char (point-min)))))
(defalias 'todo-cat-slct 'todo-category-select)

458 459
(defun todo-forward-category ()
  "Go forward to TODO list of next category."
460
  (interactive)
461
  (setq todo-category-number
462
        (mod (1+ todo-category-number) (length todo-categories)))
463 464
  (todo-category-select))
(defalias 'todo-cmd-forw 'todo-forward-category)
465

466 467
(defun todo-backward-category ()
  "Go back to TODO list of previous category."
468
  (interactive)
469
  (setq todo-category-number
470
        (mod (1- todo-category-number) (length todo-categories)))
471 472
  (todo-category-select))
(defalias 'todo-cmd-back 'todo-backward-category)
473

474 475
(defun todo-backward-item ()
  "Select previous entry of TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
476
  (interactive)
477
  (search-backward-regexp (concat "^" (regexp-quote todo-prefix)) nil t)
478
  (message ""))
479
(defalias 'todo-cmd-prev 'todo-backward-item)
Oliver Seidel's avatar
Oliver Seidel committed
480

481
(defun todo-forward-item (&optional count)
482
  "Select COUNT-th next entry of TODO list."
483 484
  (interactive "P")
  (if (listp count) (setq count (car count)))
485
  (end-of-line)
486 487
  (search-forward-regexp (concat "^" (regexp-quote todo-prefix))
                         nil 'goto-end count)
488
  (beginning-of-line)
489
  (message ""))
490
(defalias 'todo-cmd-next 'todo-forward-item)
Oliver Seidel's avatar
Oliver Seidel committed
491

492 493
(defun todo-save ()
  "Save the TODO list."
494
  (interactive)
495
  (save-buffer)
496 497
  (if todo-save-top-priorities-too (todo-save-top-priorities))
  )
498
(defalias 'todo-cmd-save 'todo-save)
499

500 501
(defun todo-quit ()
  "Done with TODO list for now."
Oliver Seidel's avatar
Oliver Seidel committed
502
  (interactive)
503
  (widen)
504
  (todo-save)
505
  (message "")
506
  (bury-buffer))
507
(defalias 'todo-cmd-done 'todo-quit)
Oliver Seidel's avatar
Oliver Seidel committed
508

509 510
(defun todo-edit-item ()
  "Edit current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
511
  (interactive)
512 513
  (let ((item (todo-item-string)))
    (if (todo-string-multiline-p item)
514
        (todo-edit-multiline)
515
      (let ((new (read-from-minibuffer "Edit: " item)))
516
        (todo-remove-item)
517
        (insert new "\n")
518 519
        (todo-backward-item)
        (message "")))))
520 521 522 523 524 525
(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)))
526 527
    (switch-to-buffer
     (make-indirect-buffer
528
      (file-name-nondirectory todo-file-do) buffer-name))
529
    (message "To exit, simply kill this buffer and return to list.")
530 531
    (todo-edit-mode)
    (narrow-to-region (todo-item-start) (todo-item-end))))
Oliver Seidel's avatar
Oliver Seidel committed
532

533
;;;### autoload
534
(defun todo-add-category (cat)
535
  "Add new category CAT to the TODO list."
536
  (interactive "sCategory: ")
Oliver Seidel's avatar
Oliver Seidel committed
537
  (save-window-excursion
538
    (setq todo-categories (cons cat todo-categories))
Oliver Seidel's avatar
Oliver Seidel committed
539
    (find-file todo-file-do)
540 541 542
    (widen)
    (goto-char (point-min))
    (let ((posn (search-forward "-*- mode: todo; " 17 t)))
543 544
      (if (not (null posn)) (goto-char posn))
      (if (equal posn nil)
545
          (progn
546 547 548
            (insert "-*- mode: todo; \n")
            (forward-char -1))
        (kill-line)))
549
    (insert (format "todo-categories: %S; -*-" todo-categories))
550
    (forward-char 1)
551 552
    (insert (format "%s%s%s\n%s\n%s %s\n"
                    todo-prefix todo-category-beg cat
553
                    todo-category-end
554
                    todo-prefix todo-category-sep)))
555
  0)
556

557
;;;### autoload
Oliver Seidel's avatar
Oliver Seidel committed
558
(defun todo-add-item-non-interactively (new-item category)
559
  "Insert NEW-ITEM in TODO list as a new entry in CATEGORY."
560
  (save-excursion
561 562
    (todo-show))
  (save-excursion
563 564
    (if (string= "" category)
        (setq category (nth todo-category-number todo-categories)))
565 566 567 568 569
    (let ((cat-exists (member category todo-categories)))
      (setq todo-category-number
            (if cat-exists
                (- (length todo-categories) (length cat-exists))
              (todo-add-category category))))
Oliver Seidel's avatar
Oliver Seidel committed
570 571 572 573 574 575 576
    (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)
577
			   (todo-more-important-p current) nil)))
Oliver Seidel's avatar
Oliver Seidel committed
578 579 580 581 582 583 584
	  (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)))
585
    (insert new-item "\n")
586
    (todo-backward-item)
587
    (todo-save)
588
    (message "")))
589

590
;;;### autoload
Dave Love's avatar
Dave Love committed
591
(defun todo-insert-item (arg)
592 593 594
  "Insert new TODO list entry.
With a prefix argument solicit the category, otherwise use the current
category."
595
  (interactive "P")
596
  (save-excursion
597 598 599 600 601 602 603 604 605
    (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))
606
	   (category
Dave Love's avatar
Dave Love committed
607
	    (if arg
608
		current-category
609 610 611
	      (completing-read (concat "Category [" current-category "]: ")
			       (todo-category-alist) nil nil nil
			       history current-category))))
Oliver Seidel's avatar
Oliver Seidel committed
612
      (todo-add-item-non-interactively new-item category))))
613

614
(defalias 'todo-cmd-inst 'todo-insert-item)
615

616
;;;### autoload
617 618
(defun todo-insert-item-here ()
  "Insert new TODO list entry under the cursor."
Oliver Seidel's avatar
Oliver Seidel committed
619 620 621 622 623 624 625 626 627
  (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")))))
628

629
(defun todo-more-important-p (line)
630 631
  "Ask whether entry is more important than the one at LINE."
  (if (not (equal todo-previous-line line))
632
      (progn
633
        (setq todo-previous-line line)
634
        (goto-char (point-min))
635
        (forward-line (1- todo-previous-line))
636 637 638
        (let ((item (todo-item-string-start)))
          (setq todo-previous-answer
                (y-or-n-p (concat "More important than '" item "'? "))))))
639 640 641
  todo-previous-answer)
(defalias 'todo-ask-p 'todo-more-important-p)

642 643
(defun todo-delete-item ()
  "Delete current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
644 645
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
646
      (let* ((todo-entry (todo-item-string-start))
647 648
             (todo-answer (y-or-n-p (concat "Permanently remove '"
                                            todo-entry "'? "))))
649 650 651 652
        (if todo-answer
            (progn
              (todo-remove-item)
              (todo-backward-item)))
653
        (message ""))
654 655
    (error "No TODO list entry to delete")))
(defalias 'todo-cmd-kill 'todo-delete-item)
Oliver Seidel's avatar
Oliver Seidel committed
656

657 658
(defun todo-raise-item ()
  "Raise priority of current entry."
Oliver Seidel's avatar
Oliver Seidel committed
659
  (interactive)
660 661
  (if (> (count-lines (point-min) (point)) 0)
      (let ((item (todo-item-string)))
662 663 664
        (todo-remove-item)
        (todo-backward-item)
        (save-excursion
665
          (insert item "\n"))
666
        (message ""))
667
    (error "No TODO list entry to raise")))
668
(defalias 'todo-cmd-rais 'todo-raise-item)
Oliver Seidel's avatar
Oliver Seidel committed
669

670 671
(defun todo-lower-item ()
  "Lower priority of current entry."
Oliver Seidel's avatar
Oliver Seidel committed
672
  (interactive)
673 674
  (if (> (count-lines (point) (point-max)) 1)
      ;; Assume there is a final newline
675
      (let ((item (todo-item-string)))
676 677 678
        (todo-remove-item)
        (todo-forward-item)
        (save-excursion
679
          (insert item "\n"))
680
        (message ""))
681 682
    (error "No TODO list entry to lower")))
(defalias 'todo-cmd-lowr 'todo-lower-item)
Oliver Seidel's avatar
Oliver Seidel committed
683

684
(defun todo-file-item (&optional comment)
685
  "File the current TODO list entry away, annotated with an optional COMMENT."
686 687 688 689
  (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))
690 691 692 693 694 695 696 697 698
    (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 ")")))
699 700 701 702 703 704 705 706 707 708 709 710 711
    (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 "")))
Oliver Seidel's avatar
Oliver Seidel committed
712 713 714

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

715 716
;; Utility functions:

717 718

;;;###autoload
719 720 721 722 723 724 725 726 727 728 729 730 731
(defun todo-top-priorities (&optional nof-priorities category-pr-page)
  "List top priorities for each category.

Number of entries for each category is given by NOF-PRIORITIES which
defaults to \'todo-show-priorities\'.

If CATEGORY-PR-PAGE is non-nil, a page separator \'^L\' is inserted
between each category."

  (interactive "P")
  (or nof-priorities (setq nof-priorities todo-show-priorities))
  (if (listp nof-priorities)            ;universal argument
      (setq nof-priorities (car nof-priorities)))
732
  (let ((todo-print-buffer-name "*Tmp*")
733 734
        ;;(todo-print-category-number 0)
        (todo-category-break (if category-pr-page "" ""))
735 736 737 738 739 740 741 742 743 744 745
        (cat-end
         (concat
          (if todo-remove-separator
              (concat todo-category-end "\n"
                      (regexp-quote todo-prefix) " " todo-category-sep "\n")
            (concat todo-category-end "\n"))))
        beg end)
    (todo-show)
    (save-excursion
      (save-restriction
        (widen)
746 747
        (copy-to-buffer todo-print-buffer-name (point-min) (point-max))
        (set-buffer todo-print-buffer-name)
748
        (goto-char (point-min))
749 750 751 752
        (if (re-search-forward (regexp-quote todo-header) nil t)
            (progn
              (beginning-of-line 1)
              (kill-line)))             ;Remove mode line
753 754 755
        (while (re-search-forward       ;Find category start
                (regexp-quote (concat todo-prefix todo-category-beg))
                nil t)
756
          (setq beg (+ (line-end-position) 1)) ;Start of first entry.
757 758 759 760 761 762
          (re-search-forward cat-end nil t)
          (setq end (match-beginning 0))
          (replace-match todo-category-break)
          (narrow-to-region beg end)    ;In case we have too few entries.
          (goto-char (point-min))
          (if (= 0 nof-priorities)      ;Traverse entries.
763
              (goto-char end)            ;All entries
764 765 766 767
            (todo-forward-item nof-priorities))
          (setq beg (point))
          (delete-region beg end)
          (widen))
768
        (and (looking-at "") (replace-match "")) ;Remove trailing form-feed.
769 770 771 772
        (goto-char (point-min))         ;Due to display buffer
        ))
    ;; Could have used switch-to-buffer as it has a norecord argument,
    ;; which is nice when we are called from e.g. todo-print.
773
    ;; Else we could have used pop-to-buffer.
774
    (display-buffer todo-print-buffer-name)
775
    (message "Type C-x 1 to remove %s window.  M-C-v to scroll the help."
776
             todo-print-buffer-name)))
777

778
;;;###autoload
779 780 781 782 783 784
(defun todo-save-top-priorities (&optional nof-priorities)
  "Save top priorities for each category in `todo-file-top'.

Number of entries for each category is given by NOF-PRIORITIES which
defaults to `todo-show-priorities'."
  (interactive "P")
785 786 787 788 789 790 791
  (save-window-excursion
    (save-excursion
      (save-restriction
        (todo-top-priorities nof-priorities)
        (set-buffer todo-tmp-buffer-name)
        (write-file todo-file-top)
        (kill-this-buffer)))))
792

793 794
;;;###autoload
(defun todo-print (&optional category-pr-page)
795
  "Print todo summary using `todo-print-function'.
796
If CATEGORY-PR-PAGE is non-nil, a page separator `^L' is inserted
797 798
between each category.

799
Number of entries for each category is given by `todo-print-priorities'."
800
  (interactive "P")
801 802 803 804
  (save-window-excursion
    (save-excursion
      (save-restriction
	(todo-top-priorities todo-print-priorities
805
			     category-pr-page)
806 807 808 809
	(set-buffer todo-tmp-buffer-name)
	(and (funcall todo-print-function)
	     (kill-this-buffer))
	(message "Todo printing done.")))))
810 811 812 813 814

(defun todo-jump-to-category ()
  "Jump to a category.  Default is previous category."
  (interactive)
  (let* ((categories todo-categories)
815 816
         (history (cons 'categories (1+ todo-category-number)))
	 (default (nth todo-category-number todo-categories))
817
	 (category (completing-read
818 819
                    (concat "Category [" default "]: ")
                    (todo-category-alist) nil nil nil history default)))
820 821 822
    (if (string= "" category)
        (setq category (nth todo-category-number todo-categories)))
    (setq todo-category-number
823 824 825 826
          (if (member category todo-categories)
              (- (length todo-categories)
                 (length (member category todo-categories)))
            (todo-add-category category)))
827 828
    (todo-show)))

829 830 831
(defun todo-line-string ()
  "Return current line in buffer as a string."
  (buffer-substring (line-beginning-position) (line-end-position)))
832 833 834 835 836 837

(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)
838
        (setq item (concat (substring item 0 56) "...")))
839 840
    item))

841 842
(defun todo-item-start ()
  "Return point at start of current TODO list item."
843 844 845
  (save-excursion
    (beginning-of-line)
    (if (not (looking-at (regexp-quote todo-prefix)))
846 847
        (search-backward-regexp
         (concat "^" (regexp-quote todo-prefix)) nil t))
848 849
    (point)))

850 851
(defun todo-item-end ()
  "Return point at end of current TODO list item."
852 853
  (save-excursion
    (end-of-line)
854 855
    (search-forward-regexp
     (concat "^" (regexp-quote todo-prefix)) nil 'goto-end)
856
    (1- (line-beginning-position))))
857

858 859
(defun todo-remove-item ()
  "Delete the current entry from the TODO list."
860 861
  (delete-region (todo-item-start) (1+ (todo-item-end))))

862 863
(defun todo-item-string ()
  "Return current TODO list entry as a string."
864 865 866 867 868 869 870
  (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)
871
  "Return non-nil if STRING spans several lines."
872 873 874
  (> (todo-string-count-lines string) 1))

(defun todo-category-alist ()
875
  "Generate an alist for use in `completing-read' from `todo-categories'."
876
  (mapcar #'list todo-categories))
877

878 879
;; ---------------------------------------------------------------------------

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
(easy-menu-define todo-menu todo-mode-map "Todo Menu"
                  '("Todo"
                    ["Next category"        todo-forward-category t]
                    ["Previous category"    todo-backward-category t]
                    ["Jump to category"     todo-jump-to-category t]
                    ["Show top priority items" todo-top-priorities t]
                    ["Print categories"     todo-print t]
                    "---"
                    ["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]
                    ["Raise item priority"  todo-raise-item t]
                    "---"
                    ["Next item"            todo-forward-item t]
                    ["Previous item"        todo-backward-item t]
                    "---"
                    ["Save"                 todo-save t]
                    ["Save Top Priorities"  todo-save-top-priorities t]
                    "---"
                    ["Quit"                 todo-quit t]
                    ))
905

906
;; As calendar reads .todo-do before todo-mode is loaded.
907
;;;### autoload
908 909 910 911
(defun todo-mode ()
  "Major mode for editing TODO lists.

\\{todo-mode-map}"
Oliver Seidel's avatar
Oliver Seidel committed
912 913 914 915
  (interactive)
  (setq major-mode 'todo-mode)
  (setq mode-name "TODO")
  (use-local-map todo-mode-map)
916 917
  (easy-menu-add todo-menu)
  (run-hooks 'todo-mode-hook))
918

919 920 921 922
(eval-when-compile
  (defvar date)
  (defvar entry))

923
;; Read about this function in the setup instructions above!
924
;;;### autoload
925
(defun todo-cp ()