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

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1997, 1999, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4
;;   Free Software Foundation, Inc.
Oliver Seidel's avatar
Oliver Seidel committed
5

6 7
;; Author: Oliver Seidel <os10000@seidel-space.de>
;;   [Not clear the above works, July 2000]
Oliver Seidel's avatar
Oliver Seidel committed
8
;; Created: 2 Aug 1997
9
;; 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
;; it under the terms of the GNU General Public License as published by
15
;; the Free Software Foundation; either version 3, or (at your option)
16
;; 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
;; 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
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
27 28 29

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

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 97 98 99 100 101 102
;;  Pre-Requisites
;;
;;      This package will require the following packages to be
;;      available on the load-path:
;;
;;          time-stamp
;;          easymenu
103
;;
104
;;  Operation
105 106 107 108 109 110 111
;;
;;	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
112 113
;;          d  to file the current entry, including a
;;            			    comment and timestamp
114
;;          e  to edit the current entry
115
;;          E  to edit a multi-line entry
116 117
;;          f  to file the current entry, including a
;;            			    comment and timestamp
Oliver Seidel's avatar
Oliver Seidel committed
118
;;          i  to insert a new entry, with prefix, omit category
119
;;          I  to insert a new entry at current cursor position
120
;;	    j  jump to category
121 122 123 124
;;          k  to kill the current entry
;;          l  to lower the current entry's priority
;;          n  for the next entry
;;          p  for the previous entry
125
;;	    P  print
126 127 128
;;          q  to save the list and exit the buffer
;;          r  to raise the current entry's priority
;;          s  to save the list
129
;;          S  to save the list of top priorities
130
;;	    t  show top priority items for each category
131
;;
132 133 134 135 136 137 138 139
;;	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.
140 141 142 143 144 145
;;
;;  Configuration
;;
;;  Variable todo-prefix
;;
;;	I would like to recommend that you use the prefix "*/*" (by
146 147
;;	leaving the variable 'todo-prefix' untouched) so that the
;;	diary displays each entry every day.
148
;;
149 150 151 152
;;	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.
153
;;
154 155
;;	If you have the diary package set up to usually display more
;;	than one day's entries at once, consider using
156 157 158
;;
;;	    "&%%(equal (calendar-current-date) date)"
;;
159 160
;;	as the value of `todo-prefix'.  Please note that this may slow
;;	down the processing of your diary file some.
161
;;
162 163 164 165 166 167 168 169 170 171 172
;;      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.
;;
173 174
;;  Variable todo-file-do
;;
175 176 177
;;	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.
178 179 180
;;
;;  Variable todo-file-done
;;
181 182 183 184 185
;;	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.
186
;;
187 188 189 190 191 192
;;  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.
;;
193 194
;;  Variable todo-mode-hook
;;
195 196 197 198 199 200 201 202 203 204 205 206 207
;;	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
Glenn Morris's avatar
Glenn Morris committed
208
;;     	halving the size of the window each time, then the threshold
209
;;     	is the window size at which it will stop.  If you set the
210
;;     	threshold to zero, the upper and lower bound will coincide at
211
;;     	the end of the loop and you will insert your item just before
212
;;     	that point.  If you set the threshold to, e.g. 8, it will stop
213 214 215 216 217 218
;;     	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!
219 220 221
;;
;;  Things to do
;;
222 223 224 225 226 227 228 229 230 231 232 233
;;      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
Glenn Morris's avatar
Glenn Morris committed
234
;;      o   Modularization could be done for repeated elements of
235
;;          the code, like the completing-read lines of code.
236
;;	o   license / version function
237 238 239
;;	o   export to diary file
;;	o   todo-report-bug
;;	o   GNATS support
240 241 242 243
;;	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,
Glenn Morris's avatar
Glenn Morris committed
244
;;          etc.  (Richard Stallman pointed out this is a bad idea)
245
;;      o   so base todo-mode.el on generic-mode.el instead
246
;;
247
;;  History and Gossip
248
;;
249 250 251
;;	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!
252
;;
253 254
;;	Enjoy this package and express your gratitude by sending nice
;;	things to my parents' address!
255 256
;;
;;	Oliver Seidel
Glenn Morris's avatar
Glenn Morris committed
257
;;	(Lessingstr.  8, 65760 Eschborn, Federal Republic of Germany)
258

Oliver Seidel's avatar
Oliver Seidel committed
259 260
;;; Code:

Pavel Janík's avatar
Pavel Janík committed
261 262 263
(require 'time-stamp)


Oliver Seidel's avatar
Oliver Seidel committed
264 265
;; User-configurable variables:

266 267
(defgroup todo nil
  "Maintain a list of todo items."
Dave Love's avatar
Dave Love committed
268 269
  :link '(emacs-commentary-link "todo-mode")
  :version "21.1"
270 271
  :group 'calendar)

272
(defcustom todo-prefix     "*/*"
273 274 275 276 277 278 279 280 281 282
  "*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
Glenn Morris's avatar
Glenn Morris committed
283
show and mark todo entries for today, but may slow down processing of
284 285 286
the diary file somewhat."
  :type 'string
  :group 'todo)
287
(defcustom todo-file-do    "~/.todo-do"
288 289 290
  "*TODO mode list file."
  :type 'file
  :group 'todo)
291
(defcustom todo-file-done  "~/.todo-done"
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
  "*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
Glenn Morris's avatar
Glenn Morris committed
309
items.  If you now think about the binary insertion halving the size
310 311
of the window each time, then the threshold is the window size at
which it will stop.  If you set the threshold to zero, the upper and
312
lower bound will coincide at the end of the loop and you will insert
313
your item just before that point.  If you set the threshold to,
314
e.g. 8, it will stop as soon as the window size drops below that
315
amount and will insert the item in the approximate center of that
316 317 318
window."
  :type 'integer
  :group 'todo)
319 320
(defvar todo-edit-buffer " *TODO Edit*"
  "TODO Edit buffer name.")
321
(defcustom todo-file-top "~/.todo-top"
322
  "*TODO mode top priorities file.
323

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

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

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

377 378
;; ---------------------------------------------------------------------------

379 380
;; Set up some helpful context ...

381 382
(defvar todo-categories nil
  "TODO categories.")
383

384
(defvar todo-cats nil
385 386
  "Old variable for holding the TODO categories.
Use `todo-categories' instead.")
387

388 389
(defvar todo-previous-line 0
  "Previous line asked about.")
390

391 392
(defvar todo-previous-answer 0
  "Previous answer got.")
393

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

419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
(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
436

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

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

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

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

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

489 490
(defun todo-save ()
  "Save the TODO list."
491
  (interactive)
492 493
  (save-excursion
    (save-restriction
494 495
      (save-buffer)))
  (if todo-save-top-priorities-too (todo-save-top-priorities)))
496
(defalias 'todo-cmd-save 'todo-save)
497

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

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

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

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

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

612
(defalias 'todo-cmd-inst 'todo-insert-item)
613

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

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

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

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

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

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

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

712 713
;; Utility functions:

714 715

;;;###autoload
716 717 718 719 720 721 722 723 724 725 726 727 728
(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)))
Dave Love's avatar
Dave Love committed
729
  (let ((todo-print-buffer-name todo-tmp-buffer-name)
730 731
        ;;(todo-print-category-number 0)
        (todo-category-break (if category-pr-page "" ""))
732 733 734 735 736 737 738 739 740 741 742
        (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)
743 744
        (copy-to-buffer todo-print-buffer-name (point-min) (point-max))
        (set-buffer todo-print-buffer-name)
745
        (goto-char (point-min))
746 747 748
        (when (re-search-forward (regexp-quote todo-header) nil t)
	  (beginning-of-line 1)
	  (delete-region (point) (line-end-position)))
749 750 751
        (while (re-search-forward       ;Find category start
                (regexp-quote (concat todo-prefix todo-category-beg))
                nil t)
752
          (setq beg (+ (line-end-position) 1)) ;Start of first entry.
753 754 755 756 757 758
          (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.
759
              (goto-char end)            ;All entries
760 761 762 763
            (todo-forward-item nof-priorities))
          (setq beg (point))
          (delete-region beg end)
          (widen))
764
        (and (looking-at "") (replace-match "")) ;Remove trailing form-feed.
765 766 767 768
        (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.
769
    ;; Else we could have used pop-to-buffer.
770
    (display-buffer todo-print-buffer-name)
771
    (message "Type C-x 1 to remove %s window.  M-C-v to scroll the help."
772
             todo-print-buffer-name)))
773

774 775 776 777 778 779
(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")
780 781 782 783 784 785 786
  (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)))))
787

788 789
;;;###autoload
(defun todo-print (&optional category-pr-page)
790
  "Print todo summary using `todo-print-function'.
791
If CATEGORY-PR-PAGE is non-nil, a page separator `^L' is inserted
792 793
between each category.

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

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

824 825 826
(defun todo-line-string ()
  "Return current line in buffer as a string."
  (buffer-substring (line-beginning-position) (line-end-position)))
827 828 829 830 831 832

(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)
833
        (setq item (concat (substring item 0 56) "...")))
834 835
    item))

836 837
(defun todo-item-start ()
  "Return point at start of current TODO list item."
838 839 840
  (save-excursion
    (beginning-of-line)
    (if (not (looking-at (regexp-quote todo-prefix)))
841 842
        (search-backward-regexp
         (concat "^" (regexp-quote todo-prefix)) nil t))
843 844
    (point)))

845 846
(defun todo-item-end ()
  "Return point at end of current TODO list item."
847 848
  (save-excursion
    (end-of-line)
849 850
    (search-forward-regexp
     (concat "^" (regexp-quote todo-prefix)) nil 'goto-end)
851
    (1- (line-beginning-position))))
852

853 854
(defun todo-remove-item ()
  "Delete the current entry from the TODO list."
855 856
  (delete-region (todo-item-start) (1+ (todo-item-end))))

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

(defun todo-category-alist ()
870
  "Generate an alist for use in `completing-read' from `todo-categories'."
871
  (mapcar #'list todo-categories))
872

873 874
;; ---------------------------------------------------------------------------

875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899
(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]
                    ))
900

901
;; As calendar reads .todo-do before todo-mode is loaded.
Dave Love's avatar
Dave Love committed
902
;;;###autoload