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

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

;; Note: You may copy this file freely for non-commercial use; otherwise,
;;       please contact   (address) O Seidel, Lessingstr 8, Eschborn, FRG
;;                        (e-mail ) Oliver.Seidel@cl.cam.ac.uk (2 Aug 1997)

9
;; $Id: todomode.el,v 1.6 1997/08/05 16:47:01 os10000 Exp os10000 $
Oliver Seidel's avatar
Oliver Seidel committed
10
;;
Oliver Seidel's avatar
Oliver Seidel committed
11
;; $Log: todomode.el,v $
12 13 14 15
;; 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.
;;
16 17 18 19
;; Revision 1.5  1997/08/05  14:43:39  os10000
;; Added improvements from Ron Gut <rgut@aware.com>.
;; Added category management.
;;
20 21 22
;; Revision 1.4  1997/08/04  16:18:45  os10000
;; Added Raise/Lower item.
;;
Oliver Seidel's avatar
Oliver Seidel committed
23 24 25
;; Revision 1.3  1997/08/03  12:47:26  os10000
;; Cleaned up variables, prefix and cursor position.
;;
26 27 28
;; Revision 1.2  1997/08/03 12:15:28  os10000
;; It appears to work.
;;
Oliver Seidel's avatar
Oliver Seidel committed
29 30
;; Revision 1.1  1997/08/03 12:15:13  os10000
;; Initial revision
Oliver Seidel's avatar
Oliver Seidel committed
31 32 33 34
;;

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

35 36 37 38 39
;; Description:
;;
;; To get this to work, make emacs execute the line "(require 'todomode)"
;; and maybe initialise the variables below on startup.
;;
40 41 42 43 44 45 46 47 48
;; 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:
49 50
;;
;; M-x todo-mode              will enter the todo list screen, here type
51 52
;; +                          to go to next category
;; -                          to go to previous category
53
;; e                          to edit the current entry
54 55
;; f                          to file the current entry, including a
;;                                                 comment and timestamp
56 57
;; i                          to insert a new entry
;; k                          to kill the current entry
Oliver Seidel's avatar
Oliver Seidel committed
58
;; l                          lower the current entry's priority
59 60 61 62 63
;; 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
64
;;
65 66 67 68 69 70 71 72
;; 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.
;;
73 74
;; I would recommend to add the following bindings to your global keymap:
;;
75
;; (global-set-key "\C-ct" 'todo-show)
76 77 78 79 80 81
;; (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.
;;
82 83 84
;; I would also recommend that use the prefix "*/*" (by leaving the
;; variable 'todo-prefix' untouched) so that the diary displays
;; each entry every day.
85 86 87 88 89 90
;;
;; 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.
;;
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
;; 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!
;;
106 107 108 109
;; Enjoy this package and express your gratitude by sending valuables
;; to my parents' address as listed above!!!
;;
;; Oliver Seidel
110 111 112

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

Oliver Seidel's avatar
Oliver Seidel committed
113 114
;; User-configurable variables:

115
(defvar todo-prefix "*/*" "TODO mode prefix when creating entries")
116
(defvar todo-file-do "~/.todo-do" "TODO mode filename of list file")
Oliver Seidel's avatar
Oliver Seidel committed
117 118
(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.")
119
(defvar todo-ins-thresh 0 "TODO mode insertion accuracy.")
Oliver Seidel's avatar
Oliver Seidel committed
120 121 122 123 124

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

(require 'time-stamp)

125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
(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
143

144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
(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
176 177 178 179 180 181
  (interactive)
  (forward-line -1)
  (beginning-of-line nil)
  (message "")
  )

182
(defun todo-cmd-next () "Select next entry of TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
183 184 185 186 187 188
  (interactive)
  (forward-line 1)
  (beginning-of-line nil)
  (message "")
  )

189 190 191 192 193 194
(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
195
  (interactive)
196 197
  (widen)
  (save-buffer)
198 199
  (beginning-of-line nil)
  (message "")
Oliver Seidel's avatar
Oliver Seidel committed
200 201 202
  (bury-buffer)
  )

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

205
(defun todo-cmd-edit () "Edit current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
206
  (interactive)
207 208 209 210 211 212
  (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
213 214 215 216 217
  )

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

218
(defun todo-add-category (cat) "Add a new category to the TODO list."
Oliver Seidel's avatar
Oliver Seidel committed
219 220
  (interactive)
  (save-window-excursion
221
    (setq todo-cats (cons cat todo-cats))
Oliver Seidel's avatar
Oliver Seidel committed
222
    (find-file todo-file-do)
223 224 225 226 227
    (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
228
      )
229 230 231
    (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
232
    )
233 234 235
  0
  )

236 237
(defun todo-cmd-inst ()
  "Insert new TODO list entry."
238
  (interactive)
Oliver Seidel's avatar
Oliver Seidel committed
239
  (beginning-of-line nil)
240
  (let* ((todo-entry (concat todo-prefix " " (read-from-minibuffer "New TODO entry: ")))
241 242
         (temp-catgs todo-cats)
         (todo-hstry (cons 'temp-catgs (+ todo-category-number 1))))
243 244
    (save-window-excursion
      (setq todo-category
245 246 247 248 249 250 251 252 253
            (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))))
254 255
      (todo-show)
      (setq todo-prv-lne 0)
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271

      (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)))
      
272
      (insert (concat todo-entry "\n"))
273
      (forward-line -1))
274
    (beginning-of-line nil)
275 276 277 278 279 280 281 282 283 284 285
    (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
286

287
(defun todo-cmd-kill () "Delete current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
288 289 290
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
      (progn
291 292 293 294 295 296 297 298 299 300
	(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
301
	)
302
    (message "No TODO list entry to delete.")
Oliver Seidel's avatar
Oliver Seidel committed
303 304 305 306
    )
  (beginning-of-line nil)
  )

Oliver Seidel's avatar
Oliver Seidel committed
307 308 309 310 311
(defun todo-cmd-rais () "Raise priority of current entry."
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
      (progn
	(setq todo-entry (todo-line))
312
	(delete-region (point-at-bol) (+ 1 (point-at-eol))) 
Oliver Seidel's avatar
Oliver Seidel committed
313 314
	(forward-line -1)
	(insert (concat todo-entry "\n"))
315 316
	(forward-line -1)
	(message "")
Oliver Seidel's avatar
Oliver Seidel committed
317
	)
318
    (message "No TODO list entry to raise.")
Oliver Seidel's avatar
Oliver Seidel committed
319 320 321 322 323 324 325 326 327
    )
  (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))
328
	(delete-region (point-at-bol) (+ 1 (point-at-eol))) 
Oliver Seidel's avatar
Oliver Seidel committed
329 330
	(forward-line 1)
	(insert (concat todo-entry "\n"))
331 332
	(forward-line -1)
	(message "")
Oliver Seidel's avatar
Oliver Seidel committed
333
	)
334
    (message "No TODO list entry to raise.")
Oliver Seidel's avatar
Oliver Seidel committed
335 336 337 338
    )
  (beginning-of-line nil)
  )

339
(defun todo-cmd-file () "File away the current TODO list entry."
Oliver Seidel's avatar
Oliver Seidel committed
340 341 342
  (interactive)
  (if (> (count-lines (point-min) (point-max)) 0)
      (progn
343 344
	(let ((time-stamp-format "%3b %2d, %y, %02I:%02M%p"))
	  (beginning-of-line nil)
345
	  (delete-region (point-at-bol) (search-forward todo-prefix))
346 347
	  (insert (time-stamp-string))
	  (end-of-line nil)
348
	  (insert (concat " (" (read-from-minibuffer "Comment: ") ")"))
349 350 351 352 353
	  (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
354
	)
355
    (message "No TODO list entry to delete.")
Oliver Seidel's avatar
Oliver Seidel committed
356 357 358 359 360 361
    )
  (beginning-of-line nil)
  )

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

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
;; 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))))

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

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
(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]
              )
	    )
  )

401 402 403 404
(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
405 406 407 408
  (interactive)
  (setq major-mode 'todo-mode)
  (setq mode-name "TODO")
  (use-local-map todo-mode-map)
409
  (setq mode-popup-menu todo-mode-popup-menu)
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
  (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)
	)
    )
435
  (beginning-of-line nil)
436 437
  (todo-cat-slct)
  )
Oliver Seidel's avatar
Oliver Seidel committed
438 439 440 441 442

(provide 'todomode)

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

443
;; todomode.el ends here
Oliver Seidel's avatar
Oliver Seidel committed
444 445

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