todo-mode.el 15.7 KB
Newer Older
1
; todomode.el -- major mode for editing TODO list files
Oliver Seidel's avatar
Oliver Seidel committed
2 3 4

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

5
;; Copyright (C) 1997 Oliver Seidel
Oliver Seidel's avatar
Oliver Seidel committed
6

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
;; Keywords: todo-mode

;; todomode.el is free software; you can redistribute it and/or modify
;; 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.

;; todomode.el is distributed in the hope that it will be useful,
;; 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.

;; 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.

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

;; Contact information:    (address) O Seidel, Lessingstr 8, Eschborn, FRG
;;                         (e-mail ) Oliver.Seidel@cl.cam.ac.uk (2 Aug 1997)

;; $Id: todomode.el,v 1.7 1997/08/05 22:34:14 os10000 Exp os10000 $
Oliver Seidel's avatar
Oliver Seidel committed
30
;;
Oliver Seidel's avatar
Oliver Seidel committed
31
;; $Log: todomode.el,v $
32 33 34 35 36
;; Revision 1.7  1997/08/05 22:34:14  os10000
;; Fixed insertion routine with help from Trey Jackson
;; <tjackson@ichips.intel.com>; added todo-ins-thresh;
;; fixed keyboard layout to remove unwanted keys.
;;
37 38 39 40
;; 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.
;;
41 42 43 44
;; Revision 1.5  1997/08/05  14:43:39  os10000
;; Added improvements from Ron Gut <rgut@aware.com>.
;; Added category management.
;;
45 46 47
;; Revision 1.4  1997/08/04  16:18:45  os10000
;; Added Raise/Lower item.
;;
Oliver Seidel's avatar
Oliver Seidel committed
48 49 50
;; Revision 1.3  1997/08/03  12:47:26  os10000
;; Cleaned up variables, prefix and cursor position.
;;
51 52 53
;; Revision 1.2  1997/08/03 12:15:28  os10000
;; It appears to work.
;;
Oliver Seidel's avatar
Oliver Seidel committed
54 55
;; Revision 1.1  1997/08/03 12:15:13  os10000
;; Initial revision
Oliver Seidel's avatar
Oliver Seidel committed
56 57 58 59
;;

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

60 61 62 63 64
;; Description:
;;
;; To get this to work, make emacs execute the line "(require 'todomode)"
;; and maybe initialise the variables below on startup.
;;
65 66 67 68 69 70 71 72 73
;; Just for the case that you are wondering about the ugly name of this
;; package: I am one of those unfortunate people who have DOS, LINUX and
;; OS/2 on one of their computers, so part of my home-filespace is shared
;; and stored on a DOS partition, which is accessible to all systems.  If
;; you wish, you can of course rename the name of the file (and the last
;; command) to something more aisthetically (please don't argue about
;; this spelling ...) pleasing, like i.e. todo-mode.
;;
;; You will have the following facilities available:
74 75
;;
;; M-x todo-mode              will enter the todo list screen, here type
76 77
;; +                          to go to next category
;; -                          to go to previous category
78
;; e                          to edit the current entry
79 80
;; f                          to file the current entry, including a
;;                                                 comment and timestamp
81 82
;; i                          to insert a new entry
;; k                          to kill the current entry
Oliver Seidel's avatar
Oliver Seidel committed
83
;; l                          lower the current entry's priority
84 85 86 87 88
;; n                          for the next entry
;; p                          for the previous entry
;; q                          to save the list and exit the buffer
;; r                          raise current entryk's priority
;; s                          to save the list
89
;;
90 91 92 93 94 95 96 97
;; 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.
;;
98 99
;; I would recommend to add the following bindings to your global keymap:
;;
100
;; (global-set-key "\C-ct" 'todo-show)
101 102 103 104 105 106
;; (global-set-key "\C-ci" 'todo-cmd-inst)
;;
;; This will enable you to quickly find the todo-list, or to simply add an
;; entry, without changing to it and getting sidetracked from your current
;; project.
;;
107 108 109
;; I would also recommend that use the prefix "*/*" (by leaving the
;; variable 'todo-prefix' untouched) so that the diary displays
;; each entry every day.
110 111 112 113 114 115
;;
;; For this, 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.
;;
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
;; 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 <tjackson@ichips.intel.com>
;; who corrected some of my awful coding and pointed me towards some good
;; reading.  Thanks Trey!
;;
131 132 133 134
;; Enjoy this package and express your gratitude by sending valuables
;; to my parents' address as listed above!!!
;;
;; Oliver Seidel
135 136 137

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

Oliver Seidel's avatar
Oliver Seidel committed
138 139
;; User-configurable variables:

140
(defvar todo-prefix "*/*" "TODO mode prefix when creating entries")
141
(defvar todo-file-do "~/.todo-do" "TODO mode filename of list file")
Oliver Seidel's avatar
Oliver Seidel committed
142 143
(defvar todo-file-done "~/.todo-done" "TODO mode filename of archive file")
(defvar todo-mode-hook nil "Hooks invoked when the *TODO* buffer is created.")
144
(defvar todo-ins-thresh 0 "TODO mode insertion accuracy.")
Oliver Seidel's avatar
Oliver Seidel committed
145 146 147 148 149

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

(require 'time-stamp)

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
(defvar todo-mode-map nil "TODO mode keymap.  See `todo-mode'")
(if todo-mode-map
    nil
  (let ((map (make-keymap)))
    (suppress-keymap map t)
    (define-key map "+" 'todo-cmd-forw)
    (define-key map "-" 'todo-cmd-back)
    (define-key map "e" 'todo-cmd-edit)
    (define-key map "f" 'todo-cmd-file)
    (define-key map "i" 'todo-cmd-inst)
    (define-key map "k" 'todo-cmd-kill)
    (define-key map "l" 'todo-cmd-lowr)
    (define-key map "n" 'todo-cmd-next)
    (define-key map "p" 'todo-cmd-prev)
    (define-key map "q" 'todo-cmd-done)
    (define-key map "r" 'todo-cmd-rais)
    (define-key map "s" 'todo-cmd-save)
    (setq todo-mode-map map)))
Oliver Seidel's avatar
Oliver Seidel committed
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
(defun todo-cat-slct ()
  (let ((todo-category-name (nth todo-category-number todo-cats)))
    (setq mode-line-buffer-identification (concat "Category: " todo-category-name))
    (widen)
    (goto-char (point-min))
    (search-forward (concat "--- " todo-category-name))
    (setq begin (+ (point-at-eol) 1))
    (search-forward "--- End")
    (narrow-to-region begin (point-at-bol))
    (goto-char (point-min))
    )
)

(defun todo-cmd-forw () "Go forward to TODO list of next category."
  (interactive)
  (let ((todo-cat-cnt (- (length todo-cats) 1)))
    (setq todo-category-number (if (< todo-category-number todo-cat-cnt)
				   (+ todo-category-number 1) 0))
    (todo-cat-slct)
    )
  )

(defun todo-cmd-back () "Go back to TODO list of previous category."
  (interactive)
  (let ((todo-cat-cnt (- (length todo-cats) 1)))
    (setq todo-category-number (if (> todo-category-number 0)
				   (- todo-category-number 1) todo-cat-cnt))
    (todo-cat-slct)
    )
  )

(defun todo-cmd-prev () "Select previous entry of TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
201 202 203 204 205 206
  (interactive)
  (forward-line -1)
  (beginning-of-line nil)
  (message "")
  )

207
(defun todo-cmd-next () "Select next entry of TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
208 209 210 211 212 213
  (interactive)
  (forward-line 1)
  (beginning-of-line nil)
  (message "")
  )

214 215 216 217 218 219
(defun todo-cmd-save () "Save the TODO list."
  (interactive)
  (save-buffer)
  )

(defun todo-cmd-done () "Done with TODO list for now."
Oliver Seidel's avatar
Oliver Seidel committed
220
  (interactive)
221 222
  (widen)
  (save-buffer)
223 224
  (beginning-of-line nil)
  (message "")
Oliver Seidel's avatar
Oliver Seidel committed
225 226 227
  (bury-buffer)
  )

228
(defun todo-line () "Find current line in buffer."  (buffer-substring (point-at-bol) (point-at-eol)))
Oliver Seidel's avatar
Oliver Seidel committed
229

230
(defun todo-cmd-edit () "Edit current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
231
  (interactive)
232 233 234 235 236 237
  (let ((todo-entry (todo-line)))
    (delete-region (point-at-bol) (point-at-eol))
    (insert (read-from-minibuffer "Edit: " todo-entry))
    (beginning-of-line nil)
    (message "")
    )
Oliver Seidel's avatar
Oliver Seidel committed
238 239 240 241 242
  )

(defvar todo-prv-lne 0 "previous line that I asked about.")
(defvar todo-prv-ans 0 "previous answer that I got.")

243
(defun todo-add-category (cat) "Add a new category to the TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
244 245
  (interactive)
  (save-window-excursion
246
    (setq todo-cats (cons cat todo-cats))
Oliver Seidel's avatar
Oliver Seidel committed
247
    (find-file todo-file-do)
248 249 250 251 252
    (widen)
    (goto-char (point-min))
    (let ((posn (search-forward "-*- mode: todo; " 17 t)))
      (if (not (null posn)) (goto-char posn))
      (if (equal posn nil) (progn (insert "-*- mode: todo; \n") (forward-char -1)) (kill-line))
Oliver Seidel's avatar
Oliver Seidel committed
253
      )
254 255 256
    (insert (format "todo-cats: %S; -*-" todo-cats))
    (forward-char 1)
    (insert (format "%s --- %s\n--- End\n%s %s\n" todo-prefix cat todo-prefix (make-string 75 ?-)))
Oliver Seidel's avatar
Oliver Seidel committed
257
    )
258 259 260
  0
  )

261 262
(defun todo-cmd-inst ()
  "Insert new TODO list entry."
263
  (interactive)
Oliver Seidel's avatar
Oliver Seidel committed
264
  (beginning-of-line nil)
265
  (let* ((todo-entry (concat todo-prefix " " (read-from-minibuffer "New TODO entry: ")))
266 267
         (temp-catgs todo-cats)
         (todo-hstry (cons 'temp-catgs (+ todo-category-number 1))))
268 269
    (save-window-excursion
      (setq todo-category
270 271 272 273 274 275 276 277 278
            (read-from-minibuffer "Category: "
                                  (nth todo-category-number todo-cats)
                                  nil nil todo-hstry))

      (let ((cat-exists (member todo-category todo-cats)))
        (setq todo-category-number
              (if cat-exists
                  (- (length todo-cats) (length cat-exists))
                (todo-add-category todo-category))))
279 280
      (todo-show)
      (setq todo-prv-lne 0)
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296

      (let ((todo-fst 1)
            (todo-lst (+ 1 (count-lines (point-min) (point-max)))))
        (while (> (- todo-lst todo-fst) todo-ins-thresh)
          (let* ((todo-cur (/ (+ todo-fst todo-lst) 2))
                 (todo-ans (if (< todo-cur todo-lst) (todo-ask todo-cur) nil)))
            (if todo-ans
                (setq todo-lst todo-cur)
              (setq todo-fst (+ todo-cur 1)))))

	(setq todo-fst (/ (+ todo-fst todo-lst) 2))
        ;; goto-line doesn't have the desired behavior in a narrowed buffer
        (goto-char (point-min))
	(message (format "todo-fst=%d" todo-fst))
        (forward-line (- todo-fst 1)))
      
297
      (insert (concat todo-entry "\n"))
298
      (forward-line -1))
299
    (beginning-of-line nil)
300 301 302 303 304 305 306 307 308 309 310
    (message "")))

(defun todo-ask (lne) 
  "Ask whether entry is more important than at LNE."
  (if (not (equal todo-prv-lne lne))
      (progn
        (setq todo-prv-lne lne)
        (goto-char (point-min))
        (forward-line (- todo-prv-lne 1))
        (setq todo-prv-ans (y-or-n-p (concat "More important than '" (todo-line) "'? ")))))
  todo-prv-ans)
Oliver Seidel's avatar
Oliver Seidel committed
311

312
(defun todo-cmd-kill () "Delete current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
313 314 315
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
      (progn
316 317 318 319 320 321 322 323 324 325
	(let* ((todo-entry (todo-line))
	       (todo-answer (y-or-n-p (concat "Permanently remove '" todo-entry "'? "))))
	  (if todo-answer
	      (progn
		(delete-region (point-at-bol) (+ 1 (point-at-eol))) 
		(forward-line -1)
		)
	    )
	  )
	(message "")
Oliver Seidel's avatar
Oliver Seidel committed
326
	)
327
    (message "No TODO list entry to delete.")
Oliver Seidel's avatar
Oliver Seidel committed
328 329 330 331
    )
  (beginning-of-line nil)
  )

Oliver Seidel's avatar
Oliver Seidel committed
332 333 334 335 336
(defun todo-cmd-rais () "Raise priority of current entry."
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
      (progn
	(setq todo-entry (todo-line))
337
	(delete-region (point-at-bol) (+ 1 (point-at-eol))) 
Oliver Seidel's avatar
Oliver Seidel committed
338 339
	(forward-line -1)
	(insert (concat todo-entry "\n"))
340 341
	(forward-line -1)
	(message "")
Oliver Seidel's avatar
Oliver Seidel committed
342
	)
343
    (message "No TODO list entry to raise.")
Oliver Seidel's avatar
Oliver Seidel committed
344 345 346 347 348 349 350 351 352
    )
  (beginning-of-line nil)
  )

(defun todo-cmd-lowr () "Lower priority of current entry."
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
      (progn
	(setq todo-entry (todo-line))
353
	(delete-region (point-at-bol) (+ 1 (point-at-eol))) 
Oliver Seidel's avatar
Oliver Seidel committed
354 355
	(forward-line 1)
	(insert (concat todo-entry "\n"))
356 357
	(forward-line -1)
	(message "")
Oliver Seidel's avatar
Oliver Seidel committed
358
	)
359
    (message "No TODO list entry to raise.")
Oliver Seidel's avatar
Oliver Seidel committed
360 361 362 363
    )
  (beginning-of-line nil)
  )

364
(defun todo-cmd-file () "File away the current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
365 366 367
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
      (progn
368 369
	(let ((time-stamp-format "%3b %2d, %y, %02I:%02M%p"))
	  (beginning-of-line nil)
370
	  (delete-region (point-at-bol) (search-forward todo-prefix))
371 372
	  (insert (time-stamp-string))
	  (end-of-line nil)
373
	  (insert (concat " (" (read-from-minibuffer "Comment: ") ")"))
374 375 376 377 378
	  (append-to-file (point-at-bol) (+ 1 (point-at-eol)) todo-file-done)
	  (delete-region (point-at-bol) (+ 1 (point-at-eol)))
	  (forward-line -1)
	  )
	(message "")
Oliver Seidel's avatar
Oliver Seidel committed
379
	)
380
    (message "No TODO list entry to delete.")
Oliver Seidel's avatar
Oliver Seidel committed
381 382 383 384 385 386
    )
  (beginning-of-line nil)
  )

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

387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
;; utility functions:  These are available in XEmacs, but not in Emacs 19.34

(if (not (fboundp 'point-at-bol))
    (defun point-at-bol ()
      (save-excursion
	(beginning-of-line)
	(point))))

(if (not (fboundp 'point-at-eol))
    (defun point-at-eol ()
      (save-excursion
	(end-of-line)
	(point))))

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

403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
(defvar todo-mode-popup-menu
  (purecopy '("Todo Mode Menu"
              ["Forward item"         todo-cmd-forw t]
              ["Backward item"        todo-cmd-back t]
              "---"
              ["Edit item"            todo-cmd-edit t]
              ["File item"            todo-cmd-file t]
              ["Insert new item"      todo-cmd-inst t]
              ["Kill item"            todo-cmd-kill t]
              "---"
              ["Lower item priority"  todo-cmd-lowr t]
              ["Raise item priority"  todo-cmd-rais t]
              "---"
              ["Next item"            todo-cmd-next t]
              ["Previous item"        todo-cmd-prev t]
              "---"
              ["Save"                 todo-cmd-save t]
              "---"
              ["Quit"                 todo-cmd-done t]
              )
	    )
  )

426 427 428 429
(defvar todo-cats nil "TODO categories.")
(defvar todo-category-number 0 "TODO category number.")

(defun todo-mode () "Major mode for editing TODO lists.\n\n\\{todo-mode-map}"
Oliver Seidel's avatar
Oliver Seidel committed
430 431 432 433
  (interactive)
  (setq major-mode 'todo-mode)
  (setq mode-name "TODO")
  (use-local-map todo-mode-map)
434
  (setq mode-popup-menu todo-mode-popup-menu)
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
  (run-hooks 'todo-mode-hook)
  )

(defun todo-show () "Show TODO list."
  (interactive)
  (find-file todo-file-do)
  (if (null todo-cats)
      (progn
	(todo-add-category "Todo")
	(goto-char (point-min))
	(goto-char (search-forward "--- End"))
	(let ((bol (point-at-bol)))
	  (forward-line 1)
	  (let* ((eol (+ (point-at-eol) 1))
		 (mrkr (buffer-substring bol eol)))
	    (delete-region bol eol)
	    (goto-char (point-max))
	    (insert mrkr)
	    )
	  )
	(save-buffer)
	(kill-buffer (current-buffer))
	(find-file todo-file-do)
	)
    )
460
  (beginning-of-line nil)
461 462
  (todo-cat-slct)
  )
Oliver Seidel's avatar
Oliver Seidel committed
463 464 465 466 467

(provide 'todomode)

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

468
;; todomode.el ends here
Oliver Seidel's avatar
Oliver Seidel committed
469 470

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