Commit | Line | Data |
---|---|---|
e8af40ee | 1 | ;;; todo-mode.el --- major mode for editing TODO list files |
3cb152f9 | 2 | |
17a1af53 | 3 | ;; Copyright (C) 1997, 1999, 2001, 2002, 2003, 2004, 2005, 2006, 2007, |
ae940284 | 4 | ;; 2008, 2009 Free Software Foundation, Inc. |
3cb152f9 | 5 | |
cb9222cf DL |
6 | ;; Author: Oliver Seidel <os10000@seidel-space.de> |
7 | ;; [Not clear the above works, July 2000] | |
7c896f63 | 8 | ;; Created: 2 Aug 1997 |
cb9222cf | 9 | ;; Keywords: calendar, todo |
3cb152f9 | 10 | |
7c896f63 | 11 | ;; This file is part of GNU Emacs. |
595b2334 | 12 | |
2ed66575 | 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
595b2334 | 14 | ;; it under the terms of the GNU General Public License as published by |
2ed66575 GM |
15 | ;; the Free Software Foundation, either version 3 of the License, or |
16 | ;; (at your option) any later version. | |
7c896f63 OS |
17 | |
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
595b2334 OS |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
7c896f63 | 22 | |
595b2334 | 23 | ;; You should have received a copy of the GNU General Public License |
2ed66575 | 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
595b2334 OS |
25 | |
26 | ;; --------------------------------------------------------------------------- | |
27 | ||
7c896f63 OS |
28 | ;;; Commentary: |
29 | ||
85b3b166 OS |
30 | ;; Mode Description |
31 | ;; | |
32 | ;; TODO is a major mode for EMACS which offers functionality to | |
33 | ;; treat most lines in one buffer as a list of items one has to | |
34 | ;; do. There are facilities to add new items, which are | |
35 | ;; categorised, to edit or even delete items from the buffer. | |
36 | ;; The buffer contents are currently compatible with the diary, | |
37 | ;; so that the list of todo-items will show up in the FANCY diary | |
38 | ;; mode. | |
39 | ;; | |
40 | ;; Notice: Besides the major mode, this file also exports the | |
41 | ;; function `todo-show' which will change to the one specific | |
42 | ;; TODO file that has been specified in the todo-file-do | |
43 | ;; variable. If this file does not conform to the TODO mode | |
44 | ;; conventions, the todo-show function will add the appropriate | |
45 | ;; header and footer. I don't anticipate this to cause much | |
46 | ;; grief, but be warned, in case you attempt to read a plain text | |
47 | ;; file. | |
48 | ;; | |
01b864bc | 49 | ;; Preface, Quickstart Installation |
595b2334 | 50 | ;; |
e4541b67 | 51 | ;; To get this to work, make emacs execute the line |
3d8105fb | 52 | ;; |
e4541b67 | 53 | ;; (autoload 'todo-mode "todo-mode" |
4cbc9d5a OS |
54 | ;; "Major mode for editing TODO lists." t) |
55 | ;; (autoload 'todo-show "todo-mode" | |
56 | ;; "Show TODO items." t) | |
57 | ;; (autoload 'todo-insert-item "todo-mode" | |
58 | ;; "Add TODO item." t) | |
7c896f63 | 59 | ;; |
e4541b67 OS |
60 | ;; You may now enter new items by typing "M-x todo-insert-item", |
61 | ;; or enter your TODO list file by typing "M-x todo-show". | |
62 | ;; | |
63 | ;; The TODO list file has a special format and some auxiliary | |
64 | ;; information, which will be added by the todo-show function if | |
65 | ;; it attempts to visit an un-initialised file. Hence it is | |
66 | ;; recommended to use the todo-show function for the first time, | |
67 | ;; in order to initialise the file, but it is not necessary | |
68 | ;; afterwards. | |
69 | ;; | |
70 | ;; As these commands are quite long to type, I would recommend | |
71 | ;; the addition of two bindings to your to your global keymap. I | |
72 | ;; personally have the following in my initialisation file: | |
73 | ;; | |
17a1af53 GM |
74 | ;; (global-set-key "\C-ct" 'todo-show) ; switch to TODO buffer |
75 | ;; (global-set-key "\C-ci" 'todo-insert-item) ; insert new item | |
7c896f63 | 76 | ;; |
e4541b67 OS |
77 | ;; Note, however, that this recommendation has prompted some |
78 | ;; criticism, since the keys C-c LETTER are reserved for user | |
79 | ;; functions. I believe my recommendation is acceptable, since | |
80 | ;; the Emacs Lisp Manual *Tips* section also details that the | |
81 | ;; mode itself should not bind any functions to those keys. The | |
82 | ;; express aim of the above two bindings is to work outside the | |
83 | ;; mode, which doesn't need the show function and offers a | |
84 | ;; different binding for the insert function. They serve as | |
85 | ;; shortcuts and are not even needed (since the TODO mode will be | |
86 | ;; entered by visiting the TODO file, and later by switching to | |
87 | ;; its buffer). | |
88 | ;; | |
5d035cad OS |
89 | ;; If you are an advanced user of this package, please consult |
90 | ;; the whole source code for autoloads, because there are several | |
91 | ;; extensions that are not explicitly listed in the above quick | |
92 | ;; installation. | |
93 | ;; | |
cb9222cf DL |
94 | ;; Pre-Requisites |
95 | ;; | |
96 | ;; This package will require the following packages to be | |
97 | ;; available on the load-path: | |
98 | ;; | |
99 | ;; time-stamp | |
100 | ;; easymenu | |
01b864bc | 101 | ;; |
e4541b67 | 102 | ;; Operation |
01b864bc OS |
103 | ;; |
104 | ;; You will have the following facilities available: | |
105 | ;; | |
106 | ;; M-x todo-show will enter the todo list screen, here type | |
107 | ;; | |
108 | ;; + to go to next category | |
109 | ;; - to go to previous category | |
e4541b67 OS |
110 | ;; d to file the current entry, including a |
111 | ;; comment and timestamp | |
01b864bc | 112 | ;; e to edit the current entry |
1966902e | 113 | ;; E to edit a multi-line entry |
01b864bc OS |
114 | ;; f to file the current entry, including a |
115 | ;; comment and timestamp | |
4dc1a160 | 116 | ;; i to insert a new entry, with prefix, omit category |
1966902e | 117 | ;; I to insert a new entry at current cursor position |
e4541b67 | 118 | ;; j jump to category |
01b864bc OS |
119 | ;; k to kill the current entry |
120 | ;; l to lower the current entry's priority | |
121 | ;; n for the next entry | |
122 | ;; p for the previous entry | |
e4541b67 | 123 | ;; P print |
01b864bc OS |
124 | ;; q to save the list and exit the buffer |
125 | ;; r to raise the current entry's priority | |
126 | ;; s to save the list | |
f1757bdd | 127 | ;; S to save the list of top priorities |
85b3b166 | 128 | ;; t show top priority items for each category |
01b864bc | 129 | ;; |
e4541b67 OS |
130 | ;; When you add a new entry, you are asked for the text and then |
131 | ;; for the category. I for example have categories for things | |
132 | ;; that I want to do in the office (like mail my mum), that I | |
133 | ;; want to do in town (like buy cornflakes) and things I want to | |
134 | ;; do at home (move my suitcases). The categories can be | |
135 | ;; selected with the cursor keys and if you type in the name of a | |
136 | ;; category which didn't exist before, an empty category of the | |
137 | ;; desired name will be added and filled with the new entry. | |
01b864bc OS |
138 | ;; |
139 | ;; Configuration | |
140 | ;; | |
141 | ;; Variable todo-prefix | |
142 | ;; | |
143 | ;; I would like to recommend that you use the prefix "*/*" (by | |
e4541b67 OS |
144 | ;; leaving the variable 'todo-prefix' untouched) so that the |
145 | ;; diary displays each entry every day. | |
01b864bc | 146 | ;; |
e4541b67 OS |
147 | ;; To understand what I mean, please read the documentation that |
148 | ;; goes with the calendar since that will tell you how you can | |
149 | ;; set up the fancy diary display and use the #include command to | |
150 | ;; include your todo list file as part of your diary. | |
01b864bc | 151 | ;; |
e4541b67 OS |
152 | ;; If you have the diary package set up to usually display more |
153 | ;; than one day's entries at once, consider using | |
01b864bc OS |
154 | ;; |
155 | ;; "&%%(equal (calendar-current-date) date)" | |
156 | ;; | |
e4541b67 OS |
157 | ;; as the value of `todo-prefix'. Please note that this may slow |
158 | ;; down the processing of your diary file some. | |
01b864bc | 159 | ;; |
5d035cad OS |
160 | ;; Carsten Dominik <dominik@strw.LeidenUniv.nl> suggested that |
161 | ;; | |
162 | ;; "&%%(todo-cp)" | |
163 | ;; | |
164 | ;; might be nicer and to that effect a function has been declared | |
165 | ;; further down in the code. You may wish to auto-load this. | |
166 | ;; | |
167 | ;; Carsten also writes that that *changing* the prefix after the | |
168 | ;; todo list is already established is not as simple as changing | |
169 | ;; the variable - the todo files have to be changed by hand. | |
170 | ;; | |
01b864bc OS |
171 | ;; Variable todo-file-do |
172 | ;; | |
e4541b67 OS |
173 | ;; This variable is fairly self-explanatory. You have to store |
174 | ;; your TODO list somewhere. This variable tells the package | |
175 | ;; where to go and find this file. | |
01b864bc OS |
176 | ;; |
177 | ;; Variable todo-file-done | |
178 | ;; | |
e4541b67 OS |
179 | ;; Even when you're done, you may wish to retain the entries. |
180 | ;; Given that they're timestamped and you are offered to add a | |
181 | ;; comment, this can make a useful diary of past events. It will | |
182 | ;; even blend in with the EMACS diary package. So anyway, this | |
183 | ;; variable holds the name of the file for the filed todo-items. | |
01b864bc | 184 | ;; |
f1757bdd OS |
185 | ;; Variable todo-file-top |
186 | ;; | |
187 | ;; File storing the top priorities of your TODO list when | |
188 | ;; todo-save-top-priorities is non-nil. Nice to include in your | |
189 | ;; diary instead of the complete TODO list. | |
190 | ;; | |
01b864bc OS |
191 | ;; Variable todo-mode-hook |
192 | ;; | |
e4541b67 OS |
193 | ;; Just like other modes, too, this mode offers to call your |
194 | ;; functions before it goes about its business. This variable | |
195 | ;; will be inspected for any functions you may wish to have | |
196 | ;; called once the other TODO mode preparations have been | |
197 | ;; completed. | |
198 | ;; | |
199 | ;; Variable todo-insert-threshold | |
200 | ;; | |
201 | ;; Another nifty feature is the insertion accuracy. If you have | |
202 | ;; 8 items in your TODO list, then you may get asked 4 questions | |
203 | ;; by the binary insertion algorithm. However, you may not | |
204 | ;; really have a need for such accurate priorities amongst your | |
205 | ;; TODO items. If you now think about the binary insertion | |
bd95c2c0 | 206 | ;; halving the size of the window each time, then the threshold |
e4541b67 | 207 | ;; is the window size at which it will stop. If you set the |
745465ec | 208 | ;; threshold to zero, the upper and lower bound will coincide at |
e4541b67 | 209 | ;; the end of the loop and you will insert your item just before |
745465ec | 210 | ;; that point. If you set the threshold to, e.g. 8, it will stop |
e4541b67 | 211 | ;; as soon as the window size drops below that amount and will |
6772c8e1 | 212 | ;; insert the item in the approximate center of that window. I |
e4541b67 OS |
213 | ;; got the idea for this feature after reading a very helpful |
214 | ;; e-mail reply from Trey Jackson <trey@cs.berkeley.edu> who | |
215 | ;; corrected some of my awful coding and pointed me towards some | |
216 | ;; good reading. Thanks Trey! | |
01b864bc OS |
217 | ;; |
218 | ;; Things to do | |
219 | ;; | |
e4541b67 OS |
220 | ;; These originally were my ideas, but now also include all the |
221 | ;; suggestions that I included before forgetting them: | |
222 | ;; | |
e4541b67 OS |
223 | ;; o Fancy fonts for todo/top-priority buffer |
224 | ;; o Remove todo-prefix option in todo-top-priorities | |
225 | ;; o Rename category | |
226 | ;; o Move entry from one category to another one | |
227 | ;; o Entries which both have the generic */* prefix and a | |
228 | ;; "deadline" entry which are understood by diary, indicating | |
229 | ;; an event (unless marked by &) | |
230 | ;; o The optional COUNT variable of todo-forward-item should be | |
231 | ;; applied to the other functions performing similar tasks | |
bd95c2c0 | 232 | ;; o Modularization could be done for repeated elements of |
dad8ca4c | 233 | ;; the code, like the completing-read lines of code. |
e4541b67 | 234 | ;; o license / version function |
01b864bc OS |
235 | ;; o export to diary file |
236 | ;; o todo-report-bug | |
237 | ;; o GNATS support | |
e4541b67 OS |
238 | ;; o elide multiline (as in bbdb, or, to a lesser degree, in |
239 | ;; outline mode) | |
240 | ;; o rewrite complete package to store data as lisp objects | |
241 | ;; and have display modes for display, for diary export, | |
bd95c2c0 | 242 | ;; etc. (Richard Stallman pointed out this is a bad idea) |
e4541b67 | 243 | ;; o so base todo-mode.el on generic-mode.el instead |
01b864bc | 244 | ;; |
e4541b67 | 245 | ;; History and Gossip |
01b864bc | 246 | ;; |
e4541b67 OS |
247 | ;; Many thanks to all the ones who have contributed to the |
248 | ;; evolution of this package! I hope I have listed all of you | |
249 | ;; somewhere in the documentation or at least in the RCS history! | |
01b864bc | 250 | ;; |
e4541b67 OS |
251 | ;; Enjoy this package and express your gratitude by sending nice |
252 | ;; things to my parents' address! | |
01b864bc OS |
253 | ;; |
254 | ;; Oliver Seidel | |
bd95c2c0 | 255 | ;; (Lessingstr. 8, 65760 Eschborn, Federal Republic of Germany) |
7e6ed9b9 | 256 | |
7c896f63 OS |
257 | ;;; Code: |
258 | ||
4f9b5264 PJ |
259 | (require 'time-stamp) |
260 | ||
261 | ||
3cb152f9 OS |
262 | ;; User-configurable variables: |
263 | ||
85b3b166 OS |
264 | (defgroup todo nil |
265 | "Maintain a list of todo items." | |
ade0f0b8 DL |
266 | :link '(emacs-commentary-link "todo-mode") |
267 | :version "21.1" | |
85b3b166 OS |
268 | :group 'calendar) |
269 | ||
cb9222cf | 270 | (defcustom todo-prefix "*/*" |
08f7d912 | 271 | "TODO mode prefix for entries. |
85b3b166 OS |
272 | |
273 | This is useful in conjunction with `calendar' and `diary' if you use | |
274 | ||
275 | #include \"~/.todo-do\" | |
276 | ||
277 | in your diary file to include your todo list file as part of your | |
278 | diary. With the default value \"*/*\" the diary displays each entry | |
279 | every day and it may also be marked on every day of the calendar. | |
280 | Using \"&%%(equal (calendar-current-date) date)\" instead will only | |
bd95c2c0 | 281 | show and mark todo entries for today, but may slow down processing of |
85b3b166 OS |
282 | the diary file somewhat." |
283 | :type 'string | |
284 | :group 'todo) | |
6d83def6 | 285 | (defcustom todo-file-do (convert-standard-filename "~/.todo-do") |
08f7d912 | 286 | "TODO mode list file." |
85b3b166 OS |
287 | :type 'file |
288 | :group 'todo) | |
6d83def6 | 289 | (defcustom todo-file-done (convert-standard-filename "~/.todo-done") |
08f7d912 | 290 | "TODO mode archive file." |
85b3b166 OS |
291 | :type 'file |
292 | :group 'todo) | |
293 | (defcustom todo-mode-hook nil | |
08f7d912 | 294 | "TODO mode hooks." |
85b3b166 OS |
295 | :type 'hook |
296 | :group 'todo) | |
297 | (defcustom todo-edit-mode-hook nil | |
08f7d912 | 298 | "TODO Edit mode hooks." |
85b3b166 OS |
299 | :type 'hook |
300 | :group 'todo) | |
301 | (defcustom todo-insert-threshold 0 | |
08f7d912 | 302 | "TODO mode insertion accuracy. |
85b3b166 OS |
303 | |
304 | If you have 8 items in your TODO list, then you may get asked 4 | |
305 | questions by the binary insertion algorithm. However, you may not | |
306 | really have a need for such accurate priorities amongst your TODO | |
bd95c2c0 | 307 | items. If you now think about the binary insertion halving the size |
745465ec GM |
308 | of the window each time, then the threshold is the window size at |
309 | which it will stop. If you set the threshold to zero, the upper and | |
85b3b166 | 310 | lower bound will coincide at the end of the loop and you will insert |
745465ec | 311 | your item just before that point. If you set the threshold to, |
85b3b166 | 312 | e.g. 8, it will stop as soon as the window size drops below that |
77602fc7 | 313 | amount and will insert the item in the approximate center of that |
85b3b166 OS |
314 | window." |
315 | :type 'integer | |
316 | :group 'todo) | |
cb9222cf DL |
317 | (defvar todo-edit-buffer " *TODO Edit*" |
318 | "TODO Edit buffer name.") | |
6d83def6 | 319 | (defcustom todo-file-top (convert-standard-filename "~/.todo-top") |
08f7d912 | 320 | "TODO mode top priorities file. |
85b3b166 | 321 | |
f1757bdd | 322 | Not in TODO format, but diary compatible. |
85b3b166 OS |
323 | Automatically generated when `todo-save-top-priorities' is non-nil." |
324 | :type 'string | |
325 | :group 'todo) | |
326 | ||
327 | (defcustom todo-print-function 'ps-print-buffer-with-faces | |
08f7d912 | 328 | "Function to print the current buffer." |
85b3b166 OS |
329 | :type 'symbol |
330 | :group 'todo) | |
331 | (defcustom todo-show-priorities 1 | |
08f7d912 | 332 | "Default number of priorities to show by \\[todo-top-priorities]. |
85b3b166 OS |
333 | 0 means show all entries." |
334 | :type 'integer | |
335 | :group 'todo) | |
336 | (defcustom todo-print-priorities 0 | |
08f7d912 | 337 | "Default number of priorities to print by \\[todo-print]. |
85b3b166 OS |
338 | 0 means print all entries." |
339 | :type 'integer | |
340 | :group 'todo) | |
341 | (defcustom todo-remove-separator t | |
08f7d912 | 342 | "Non-nil to remove category separators in\ |
85b3b166 OS |
343 | \\[todo-top-priorities] and \\[todo-print]." |
344 | :type 'boolean | |
345 | :group 'todo) | |
346 | (defcustom todo-save-top-priorities-too t | |
08f7d912 | 347 | "Non-nil makes `todo-save' automatically save top-priorities in `todo-file-top'." |
85b3b166 OS |
348 | :type 'boolean |
349 | :group 'todo) | |
e4541b67 | 350 | |
7c896f63 OS |
351 | ;; Thanks for the ISO time stamp format go to Karl Eichwalder <ke@suse.de> |
352 | ;; My format string for the appt.el package is "%3b %2d, %y, %02I:%02M%p". | |
353 | ;; | |
85b3b166 | 354 | (defcustom todo-time-string-format |
cb9222cf | 355 | "%:y-%02m-%02d %02H:%02M" |
08f7d912 | 356 | "TODO mode time string format for done entries. |
85b3b166 OS |
357 | For details see the variable `time-stamp-format'." |
358 | :type 'string | |
359 | :group 'todo) | |
360 | ||
361 | (defcustom todo-entry-prefix-function 'todo-entry-timestamp-initials | |
08f7d912 | 362 | "Function producing text to insert at start of todo entry." |
85b3b166 OS |
363 | :type 'symbol |
364 | :group 'todo) | |
365 | (defcustom todo-initials (or (getenv "INITIALS") (user-login-name)) | |
08f7d912 | 366 | "Initials of todo item author." |
85b3b166 OS |
367 | :type 'string |
368 | :group 'todo) | |
e4541b67 OS |
369 | |
370 | (defun todo-entry-timestamp-initials () | |
f1757bdd | 371 | "Prepend timestamp and your initials to the head of a TODO entry." |
e4541b67 OS |
372 | (let ((time-stamp-format todo-time-string-format)) |
373 | (concat (time-stamp-string) " " todo-initials ": "))) | |
374 | ||
cb9222cf DL |
375 | ;; --------------------------------------------------------------------------- |
376 | ||
cf1ebf43 OS |
377 | ;; Set up some helpful context ... |
378 | ||
9278c60d DL |
379 | (defvar todo-categories nil |
380 | "TODO categories.") | |
cb9222cf | 381 | |
9278c60d | 382 | (defvar todo-cats nil |
85b3b166 OS |
383 | "Old variable for holding the TODO categories. |
384 | Use `todo-categories' instead.") | |
e4541b67 | 385 | |
cb9222cf DL |
386 | (defvar todo-previous-line 0 |
387 | "Previous line asked about.") | |
e4541b67 | 388 | |
cb9222cf DL |
389 | (defvar todo-previous-answer 0 |
390 | "Previous answer got.") | |
cf1ebf43 | 391 | |
9278c60d | 392 | (defvar todo-mode-map |
3d8105fb OS |
393 | (let ((map (make-keymap))) |
394 | (suppress-keymap map t) | |
7f6241ea OS |
395 | (define-key map "+" 'todo-forward-category) |
396 | (define-key map "-" 'todo-backward-category) | |
1966902e | 397 | (define-key map "d" 'todo-file-item) ;done/delete |
7f6241ea OS |
398 | (define-key map "e" 'todo-edit-item) |
399 | (define-key map "E" 'todo-edit-multiline) | |
400 | (define-key map "f" 'todo-file-item) | |
401 | (define-key map "i" 'todo-insert-item) | |
d145aa83 | 402 | (define-key map "I" 'todo-insert-item-here) |
e4541b67 | 403 | (define-key map "j" 'todo-jump-to-category) |
7f6241ea OS |
404 | (define-key map "k" 'todo-delete-item) |
405 | (define-key map "l" 'todo-lower-item) | |
406 | (define-key map "n" 'todo-forward-item) | |
407 | (define-key map "p" 'todo-backward-item) | |
e4541b67 | 408 | (define-key map "P" 'todo-print) |
7f6241ea OS |
409 | (define-key map "q" 'todo-quit) |
410 | (define-key map "r" 'todo-raise-item) | |
411 | (define-key map "s" 'todo-save) | |
f1757bdd | 412 | (define-key map "S" 'todo-save-top-priorities) |
e4541b67 | 413 | (define-key map "t" 'todo-top-priorities) |
9278c60d DL |
414 | map) |
415 | "TODO mode keymap.") | |
416 | ||
cb9222cf DL |
417 | (defvar todo-category-number 0 "TODO category number.") |
418 | ||
419 | (defvar todo-tmp-buffer-name " *todo tmp*") | |
420 | ||
421 | (defvar todo-category-sep (make-string 75 ?-) | |
422 | "Category separator.") | |
423 | ||
424 | (defvar todo-category-beg " --- " | |
425 | "Category start separator to be prepended onto category name.") | |
426 | ||
427 | (defvar todo-category-end "--- End" | |
428 | "Separator after a category.") | |
429 | ||
430 | (defvar todo-header "-*- mode: todo; " | |
431 | "Header of todo files.") | |
432 | ||
433 | ;; --------------------------------------------------------------------------- | |
3cb152f9 | 434 | |
7f6241ea OS |
435 | (defun todo-category-select () |
436 | "Make TODO mode display the current category correctly." | |
437 | (let ((name (nth todo-category-number todo-categories))) | |
579e1c67 | 438 | (setq mode-line-buffer-identification |
cb9222cf | 439 | ;; (concat "Category: " name)) |
6fe3681b | 440 | (concat "Category: " (format "%18s" name))) |
da2ee685 OS |
441 | (widen) |
442 | (goto-char (point-min)) | |
7f6241ea | 443 | (search-forward-regexp |
e4541b67 OS |
444 | (concat "^" |
445 | (regexp-quote (concat todo-prefix todo-category-beg name)) | |
446 | "$")) | |
9278c60d | 447 | (let ((begin (1+ (line-end-position)))) |
e4541b67 | 448 | (search-forward-regexp (concat "^" todo-category-end)) |
9278c60d | 449 | (narrow-to-region begin (line-beginning-position)) |
7f6241ea OS |
450 | (goto-char (point-min))))) |
451 | (defalias 'todo-cat-slct 'todo-category-select) | |
452 | ||
9278c60d DL |
453 | (defun todo-forward-category () |
454 | "Go forward to TODO list of next category." | |
da2ee685 | 455 | (interactive) |
7f6241ea | 456 | (setq todo-category-number |
01b864bc | 457 | (mod (1+ todo-category-number) (length todo-categories))) |
7f6241ea OS |
458 | (todo-category-select)) |
459 | (defalias 'todo-cmd-forw 'todo-forward-category) | |
da2ee685 | 460 | |
9278c60d DL |
461 | (defun todo-backward-category () |
462 | "Go back to TODO list of previous category." | |
da2ee685 | 463 | (interactive) |
7f6241ea | 464 | (setq todo-category-number |
01b864bc | 465 | (mod (1- todo-category-number) (length todo-categories))) |
7f6241ea OS |
466 | (todo-category-select)) |
467 | (defalias 'todo-cmd-back 'todo-backward-category) | |
da2ee685 | 468 | |
9278c60d DL |
469 | (defun todo-backward-item () |
470 | "Select previous entry of TODO list." | |
3cb152f9 | 471 | (interactive) |
7f6241ea | 472 | (search-backward-regexp (concat "^" (regexp-quote todo-prefix)) nil t) |
cf1ebf43 | 473 | (message "")) |
7f6241ea | 474 | (defalias 'todo-cmd-prev 'todo-backward-item) |
3cb152f9 | 475 | |
e4541b67 | 476 | (defun todo-forward-item (&optional count) |
85b3b166 | 477 | "Select COUNT-th next entry of TODO list." |
e4541b67 OS |
478 | (interactive "P") |
479 | (if (listp count) (setq count (car count))) | |
7f6241ea | 480 | (end-of-line) |
e4541b67 OS |
481 | (search-forward-regexp (concat "^" (regexp-quote todo-prefix)) |
482 | nil 'goto-end count) | |
7f6241ea | 483 | (beginning-of-line) |
cf1ebf43 | 484 | (message "")) |
7f6241ea | 485 | (defalias 'todo-cmd-next 'todo-forward-item) |
3cb152f9 | 486 | |
cb9222cf DL |
487 | (defun todo-save () |
488 | "Save the TODO list." | |
da2ee685 | 489 | (interactive) |
ade67f6a RS |
490 | (save-excursion |
491 | (save-restriction | |
887c6c1f RS |
492 | (save-buffer))) |
493 | (if todo-save-top-priorities-too (todo-save-top-priorities))) | |
7f6241ea | 494 | (defalias 'todo-cmd-save 'todo-save) |
da2ee685 | 495 | |
cb9222cf DL |
496 | (defun todo-quit () |
497 | "Done with TODO list for now." | |
3cb152f9 | 498 | (interactive) |
da2ee685 | 499 | (widen) |
f1757bdd | 500 | (todo-save) |
7e6ed9b9 | 501 | (message "") |
cf1ebf43 | 502 | (bury-buffer)) |
7f6241ea | 503 | (defalias 'todo-cmd-done 'todo-quit) |
3cb152f9 | 504 | |
cb9222cf DL |
505 | (defun todo-edit-item () |
506 | "Edit current TODO list entry." | |
3cb152f9 | 507 | (interactive) |
7f6241ea OS |
508 | (let ((item (todo-item-string))) |
509 | (if (todo-string-multiline-p item) | |
01b864bc | 510 | (todo-edit-multiline) |
7f6241ea | 511 | (let ((new (read-from-minibuffer "Edit: " item))) |
01b864bc | 512 | (todo-remove-item) |
cb9222cf | 513 | (insert new "\n") |
01b864bc OS |
514 | (todo-backward-item) |
515 | (message ""))))) | |
7f6241ea OS |
516 | (defalias 'todo-cmd-edit 'todo-edit-item) |
517 | ||
518 | (defun todo-edit-multiline () | |
519 | "Set up a buffer for editing a multiline TODO list entry." | |
520 | (interactive) | |
521 | (let ((buffer-name (generate-new-buffer-name todo-edit-buffer))) | |
e4541b67 OS |
522 | (switch-to-buffer |
523 | (make-indirect-buffer | |
cb9222cf | 524 | (file-name-nondirectory todo-file-do) buffer-name)) |
2186b974 | 525 | (message "To exit, simply kill this buffer and return to list.") |
7f6241ea OS |
526 | (todo-edit-mode) |
527 | (narrow-to-region (todo-item-start) (todo-item-end)))) | |
3cb152f9 | 528 | |
ade0f0b8 | 529 | ;;;###autoload |
685b5479 | 530 | (defun todo-add-category (&optional cat) |
85b3b166 | 531 | "Add new category CAT to the TODO list." |
685b5479 CY |
532 | (interactive) |
533 | (let ((buf (find-file-noselect todo-file-do t)) | |
534 | (prompt "Category: ")) | |
535 | (unless (zerop (buffer-size buf)) | |
536 | (and (null todo-categories) | |
537 | (null todo-cats) | |
538 | (error "Error in %s: File is non-empty but contains no category" | |
539 | todo-file-do))) | |
540 | (unless cat (setq cat (read-from-minibuffer prompt))) | |
541 | (with-current-buffer buf | |
542 | ;; reject names that could induce bugs and confusion | |
543 | (while (and (cond ((string= "" cat) | |
544 | (setq prompt "Enter a non-empty category name: ")) | |
545 | ((string-match "\\`\\s-+\\'" cat) | |
546 | (setq prompt "Enter a category name that is not only white space: ")) | |
547 | ((member cat todo-categories) | |
548 | (setq prompt "Enter a non-existing category name: "))) | |
549 | (setq cat (read-from-minibuffer prompt)))) | |
550 | ;; initialize a newly created Todo buffer for Todo mode | |
551 | (unless (file-exists-p todo-file-do) (todo-mode)) | |
552 | (setq todo-categories (cons cat todo-categories)) | |
553 | (widen) | |
554 | (goto-char (point-min)) | |
555 | (if (search-forward "-*- mode: todo; " 17 t) | |
556 | (kill-line) | |
557 | (insert "-*- mode: todo; \n") | |
558 | (forward-char -1)) | |
559 | (insert (format "todo-categories: %S; -*-" todo-categories)) | |
560 | (forward-char 1) | |
561 | (insert (format "%s%s%s\n%s\n%s %s\n" | |
562 | todo-prefix todo-category-beg cat | |
563 | todo-category-end | |
564 | todo-prefix todo-category-sep)) | |
565 | (if (interactive-p) | |
566 | ;; properly display the newly added category | |
567 | (progn (setq todo-category-number 0) (todo-show)) | |
568 | 0)))) | |
da2ee685 | 569 | |
ade0f0b8 | 570 | ;;;###autoload |
4dc1a160 | 571 | (defun todo-add-item-non-interactively (new-item category) |
85b3b166 | 572 | "Insert NEW-ITEM in TODO list as a new entry in CATEGORY." |
4cbc9d5a | 573 | (save-excursion |
49b2ae0e OS |
574 | (todo-show)) |
575 | (save-excursion | |
e4541b67 OS |
576 | (if (string= "" category) |
577 | (setq category (nth todo-category-number todo-categories))) | |
cb9222cf DL |
578 | (let ((cat-exists (member category todo-categories))) |
579 | (setq todo-category-number | |
580 | (if cat-exists | |
581 | (- (length todo-categories) (length cat-exists)) | |
582 | (todo-add-category category)))) | |
4dc1a160 OS |
583 | (todo-show) |
584 | (setq todo-previous-line 0) | |
585 | (let ((top 1) | |
586 | (bottom (1+ (count-lines (point-min) (point-max))))) | |
587 | (while (> (- bottom top) todo-insert-threshold) | |
588 | (let* ((current (/ (+ top bottom) 2)) | |
589 | (answer (if (< current bottom) | |
cb9222cf | 590 | (todo-more-important-p current) nil))) |
4dc1a160 OS |
591 | (if answer |
592 | (setq bottom current) | |
593 | (setq top (1+ current))))) | |
594 | (setq top (/ (+ top bottom) 2)) | |
17a1af53 | 595 | ;; goto-line doesn't have the desired behavior in a narrowed buffer. |
4dc1a160 OS |
596 | (goto-char (point-min)) |
597 | (forward-line (1- top))) | |
cb9222cf | 598 | (insert new-item "\n") |
7f6241ea | 599 | (todo-backward-item) |
f1757bdd | 600 | (todo-save) |
3d8105fb | 601 | (message ""))) |
4cbc9d5a | 602 | |
ade0f0b8 | 603 | ;;;###autoload |
89802f43 | 604 | (defun todo-insert-item (arg) |
85b3b166 OS |
605 | "Insert new TODO list entry. |
606 | With a prefix argument solicit the category, otherwise use the current | |
607 | category." | |
4cbc9d5a | 608 | (interactive "P") |
49b2ae0e | 609 | (save-excursion |
3da360a7 | 610 | (if (not (derived-mode-p 'todo-mode)) (todo-show)) |
1966902e OS |
611 | (let* ((new-item (concat todo-prefix " " |
612 | (read-from-minibuffer | |
613 | "New TODO entry: " | |
614 | (if todo-entry-prefix-function | |
615 | (funcall todo-entry-prefix-function))))) | |
1966902e | 616 | (current-category (nth todo-category-number todo-categories)) |
685b5479 | 617 | (category (if arg (todo-completing-read) current-category))) |
4dc1a160 | 618 | (todo-add-item-non-interactively new-item category)))) |
4cbc9d5a | 619 | |
7f6241ea | 620 | (defalias 'todo-cmd-inst 'todo-insert-item) |
3d8105fb | 621 | |
d145aa83 | 622 | (defun todo-insert-item-here () |
685b5479 CY |
623 | "Insert a new TODO list entry directly above the entry at point. |
624 | If point is on an empty line, insert the entry there." | |
625 | (interactive) | |
626 | (if (not (derived-mode-p 'todo-mode)) (todo-show)) | |
627 | (let ((new-item (concat todo-prefix " " | |
628 | (read-from-minibuffer | |
629 | "New TODO entry: " | |
630 | (if todo-entry-prefix-function | |
631 | (funcall todo-entry-prefix-function)))))) | |
632 | (unless (and (bolp) (eolp)) (goto-char (todo-item-start))) | |
633 | (insert (concat new-item "\n")) | |
634 | (backward-char) | |
635 | ;; put point at start of new entry | |
636 | (goto-char (todo-item-start)))) | |
d145aa83 | 637 | |
01b864bc | 638 | (defun todo-more-important-p (line) |
7f6241ea | 639 | "Ask whether entry is more important than the one at LINE." |
17a1af53 GM |
640 | (unless (equal todo-previous-line line) |
641 | (setq todo-previous-line line) | |
642 | (goto-char (point-min)) | |
643 | (forward-line (1- todo-previous-line)) | |
644 | (let ((item (todo-item-string-start))) | |
645 | (setq todo-previous-answer | |
646 | (y-or-n-p (concat "More important than '" item "'? "))))) | |
7f6241ea OS |
647 | todo-previous-answer) |
648 | (defalias 'todo-ask-p 'todo-more-important-p) | |
649 | ||
cb9222cf DL |
650 | (defun todo-delete-item () |
651 | "Delete current TODO list entry." | |
3cb152f9 OS |
652 | (interactive) |
653 | (if (> (count-lines (point-min) (point-max)) 0) | |
7f6241ea | 654 | (let* ((todo-entry (todo-item-string-start)) |
01b864bc OS |
655 | (todo-answer (y-or-n-p (concat "Permanently remove '" |
656 | todo-entry "'? ")))) | |
17a1af53 GM |
657 | (when todo-answer |
658 | (todo-remove-item) | |
659 | (todo-backward-item)) | |
01b864bc | 660 | (message "")) |
7f6241ea OS |
661 | (error "No TODO list entry to delete"))) |
662 | (defalias 'todo-cmd-kill 'todo-delete-item) | |
3cb152f9 | 663 | |
cb9222cf DL |
664 | (defun todo-raise-item () |
665 | "Raise priority of current entry." | |
8cdc3b3d | 666 | (interactive) |
7f6241ea OS |
667 | (if (> (count-lines (point-min) (point)) 0) |
668 | (let ((item (todo-item-string))) | |
01b864bc OS |
669 | (todo-remove-item) |
670 | (todo-backward-item) | |
671 | (save-excursion | |
cb9222cf | 672 | (insert item "\n")) |
01b864bc | 673 | (message "")) |
7f6241ea | 674 | (error "No TODO list entry to raise"))) |
cb9222cf | 675 | (defalias 'todo-cmd-rais 'todo-raise-item) |
8cdc3b3d | 676 | |
cb9222cf DL |
677 | (defun todo-lower-item () |
678 | "Lower priority of current entry." | |
8cdc3b3d | 679 | (interactive) |
e4541b67 OS |
680 | (if (> (count-lines (point) (point-max)) 1) |
681 | ;; Assume there is a final newline | |
7f6241ea | 682 | (let ((item (todo-item-string))) |
01b864bc OS |
683 | (todo-remove-item) |
684 | (todo-forward-item) | |
685 | (save-excursion | |
cb9222cf | 686 | (insert item "\n")) |
01b864bc | 687 | (message "")) |
7f6241ea OS |
688 | (error "No TODO list entry to lower"))) |
689 | (defalias 'todo-cmd-lowr 'todo-lower-item) | |
8cdc3b3d | 690 | |
0561decb | 691 | (defun todo-file-item (&optional comment) |
a554b301 | 692 | "File the current TODO list entry away, annotated with an optional COMMENT." |
0561decb OS |
693 | (interactive "sComment: ") |
694 | (or (> (count-lines (point-min) (point-max)) 0) | |
695 | (error "No TODO list entry to file away")) | |
696 | (let ((time-stamp-format todo-time-string-format)) | |
17a1af53 GM |
697 | (when (and comment (> (length comment) 0)) |
698 | (goto-char (todo-item-end)) | |
699 | (insert | |
700 | (if (save-excursion (beginning-of-line) | |
701 | (looking-at (regexp-quote todo-prefix))) | |
702 | " " | |
703 | "\n\t") | |
704 | "(" comment ")")) | |
0561decb OS |
705 | (goto-char (todo-item-end)) |
706 | (insert " [" (nth todo-category-number todo-categories) "]") | |
707 | (goto-char (todo-item-start)) | |
708 | (let ((temp-point (point))) | |
709 | (if (looking-at (regexp-quote todo-prefix)) | |
710 | (replace-match (time-stamp-string)) | |
711 | ;; Standard prefix -> timestamp | |
712 | ;; Else prefix non-standard item start with timestamp | |
713 | (insert (time-stamp-string))) | |
714 | (append-to-file temp-point (1+ (todo-item-end)) todo-file-done) | |
715 | (delete-region temp-point (1+ (todo-item-end)))) | |
716 | (todo-backward-item) | |
717 | (message ""))) | |
3cb152f9 OS |
718 | |
719 | ;; --------------------------------------------------------------------------- | |
720 | ||
7f6241ea OS |
721 | ;; Utility functions: |
722 | ||
cb9222cf DL |
723 | |
724 | ;;;###autoload | |
e4541b67 OS |
725 | (defun todo-top-priorities (&optional nof-priorities category-pr-page) |
726 | "List top priorities for each category. | |
727 | ||
728 | Number of entries for each category is given by NOF-PRIORITIES which | |
729 | defaults to \'todo-show-priorities\'. | |
730 | ||
731 | If CATEGORY-PR-PAGE is non-nil, a page separator \'^L\' is inserted | |
732 | between each category." | |
733 | ||
734 | (interactive "P") | |
735 | (or nof-priorities (setq nof-priorities todo-show-priorities)) | |
736 | (if (listp nof-priorities) ;universal argument | |
737 | (setq nof-priorities (car nof-priorities))) | |
a54d1c94 | 738 | (let ((todo-print-buffer-name todo-tmp-buffer-name) |
85b3b166 OS |
739 | ;;(todo-print-category-number 0) |
740 | (todo-category-break (if category-pr-page "\f" "")) | |
e4541b67 OS |
741 | (cat-end |
742 | (concat | |
743 | (if todo-remove-separator | |
744 | (concat todo-category-end "\n" | |
745 | (regexp-quote todo-prefix) " " todo-category-sep "\n") | |
746 | (concat todo-category-end "\n")))) | |
747 | beg end) | |
748 | (todo-show) | |
749 | (save-excursion | |
750 | (save-restriction | |
751 | (widen) | |
85b3b166 OS |
752 | (copy-to-buffer todo-print-buffer-name (point-min) (point-max)) |
753 | (set-buffer todo-print-buffer-name) | |
e4541b67 | 754 | (goto-char (point-min)) |
bf2fcd67 GM |
755 | (when (re-search-forward (regexp-quote todo-header) nil t) |
756 | (beginning-of-line 1) | |
757 | (delete-region (point) (line-end-position))) | |
e4541b67 OS |
758 | (while (re-search-forward ;Find category start |
759 | (regexp-quote (concat todo-prefix todo-category-beg)) | |
760 | nil t) | |
9278c60d | 761 | (setq beg (+ (line-end-position) 1)) ;Start of first entry. |
e4541b67 OS |
762 | (re-search-forward cat-end nil t) |
763 | (setq end (match-beginning 0)) | |
764 | (replace-match todo-category-break) | |
765 | (narrow-to-region beg end) ;In case we have too few entries. | |
766 | (goto-char (point-min)) | |
17a1af53 | 767 | (if (zerop nof-priorities) ;Traverse entries. |
cb9222cf | 768 | (goto-char end) ;All entries |
e4541b67 OS |
769 | (todo-forward-item nof-priorities)) |
770 | (setq beg (point)) | |
771 | (delete-region beg end) | |
772 | (widen)) | |
f1757bdd | 773 | (and (looking-at "\f") (replace-match "")) ;Remove trailing form-feed. |
e4541b67 OS |
774 | (goto-char (point-min)) ;Due to display buffer |
775 | )) | |
776 | ;; Could have used switch-to-buffer as it has a norecord argument, | |
777 | ;; which is nice when we are called from e.g. todo-print. | |
f1757bdd | 778 | ;; Else we could have used pop-to-buffer. |
85b3b166 | 779 | (display-buffer todo-print-buffer-name) |
e4541b67 | 780 | (message "Type C-x 1 to remove %s window. M-C-v to scroll the help." |
9278c60d | 781 | todo-print-buffer-name))) |
e4541b67 | 782 | |
f1757bdd OS |
783 | (defun todo-save-top-priorities (&optional nof-priorities) |
784 | "Save top priorities for each category in `todo-file-top'. | |
785 | ||
786 | Number of entries for each category is given by NOF-PRIORITIES which | |
787 | defaults to `todo-show-priorities'." | |
788 | (interactive "P") | |
cb9222cf DL |
789 | (save-window-excursion |
790 | (save-excursion | |
791 | (save-restriction | |
792 | (todo-top-priorities nof-priorities) | |
793 | (set-buffer todo-tmp-buffer-name) | |
794 | (write-file todo-file-top) | |
795 | (kill-this-buffer))))) | |
f1757bdd | 796 | |
e4541b67 OS |
797 | ;;;###autoload |
798 | (defun todo-print (&optional category-pr-page) | |
a554b301 | 799 | "Print todo summary using `todo-print-function'. |
cb9222cf | 800 | If CATEGORY-PR-PAGE is non-nil, a page separator `^L' is inserted |
e4541b67 OS |
801 | between each category. |
802 | ||
cb9222cf | 803 | Number of entries for each category is given by `todo-print-priorities'." |
e4541b67 | 804 | (interactive "P") |
cb9222cf DL |
805 | (save-window-excursion |
806 | (save-excursion | |
807 | (save-restriction | |
808 | (todo-top-priorities todo-print-priorities | |
9278c60d | 809 | category-pr-page) |
cb9222cf DL |
810 | (set-buffer todo-tmp-buffer-name) |
811 | (and (funcall todo-print-function) | |
812 | (kill-this-buffer)) | |
813 | (message "Todo printing done."))))) | |
e4541b67 OS |
814 | |
815 | (defun todo-jump-to-category () | |
816 | "Jump to a category. Default is previous category." | |
817 | (interactive) | |
685b5479 | 818 | (let ((category (todo-completing-read))) |
e4541b67 OS |
819 | (if (string= "" category) |
820 | (setq category (nth todo-category-number todo-categories))) | |
821 | (setq todo-category-number | |
cb9222cf DL |
822 | (if (member category todo-categories) |
823 | (- (length todo-categories) | |
824 | (length (member category todo-categories))) | |
825 | (todo-add-category category))) | |
e4541b67 OS |
826 | (todo-show))) |
827 | ||
9278c60d DL |
828 | (defun todo-line-string () |
829 | "Return current line in buffer as a string." | |
830 | (buffer-substring (line-beginning-position) (line-end-position))) | |
7f6241ea OS |
831 | |
832 | (defun todo-item-string-start () | |
833 | "Return the start of this TODO list entry as a string." | |
834 | ;; Suitable for putting in the minibuffer when asking the user | |
835 | (let ((item (todo-item-string))) | |
836 | (if (> (length item) 60) | |
01b864bc | 837 | (setq item (concat (substring item 0 56) "..."))) |
7f6241ea OS |
838 | item)) |
839 | ||
9278c60d DL |
840 | (defun todo-item-start () |
841 | "Return point at start of current TODO list item." | |
7f6241ea OS |
842 | (save-excursion |
843 | (beginning-of-line) | |
844 | (if (not (looking-at (regexp-quote todo-prefix))) | |
01b864bc OS |
845 | (search-backward-regexp |
846 | (concat "^" (regexp-quote todo-prefix)) nil t)) | |
7f6241ea OS |
847 | (point))) |
848 | ||
9278c60d DL |
849 | (defun todo-item-end () |
850 | "Return point at end of current TODO list item." | |
7f6241ea OS |
851 | (save-excursion |
852 | (end-of-line) | |
e4541b67 OS |
853 | (search-forward-regexp |
854 | (concat "^" (regexp-quote todo-prefix)) nil 'goto-end) | |
9278c60d | 855 | (1- (line-beginning-position)))) |
7f6241ea | 856 | |
9278c60d DL |
857 | (defun todo-remove-item () |
858 | "Delete the current entry from the TODO list." | |
7f6241ea OS |
859 | (delete-region (todo-item-start) (1+ (todo-item-end)))) |
860 | ||
cb9222cf DL |
861 | (defun todo-item-string () |
862 | "Return current TODO list entry as a string." | |
7f6241ea OS |
863 | (buffer-substring (todo-item-start) (todo-item-end))) |
864 | ||
865 | (defun todo-string-count-lines (string) | |
866 | "Return the number of lines STRING spans." | |
867 | (length (split-string string "\n"))) | |
868 | ||
869 | (defun todo-string-multiline-p (string) | |
85b3b166 | 870 | "Return non-nil if STRING spans several lines." |
7f6241ea OS |
871 | (> (todo-string-count-lines string) 1)) |
872 | ||
685b5479 CY |
873 | (defun todo-completing-read () |
874 | "Return a category name, with completion, for use in Todo mode." | |
875 | ;; make a copy of todo-categories in case history-delete-duplicates is | |
876 | ;; non-nil, which makes completing-read alter todo-categories | |
877 | (let* ((categories (copy-sequence todo-categories)) | |
878 | (history (cons 'todo-categories (1+ todo-category-number))) | |
879 | (default (nth todo-category-number todo-categories)) | |
880 | (category (completing-read | |
881 | (concat "Category [" default "]: ") | |
882 | todo-categories nil nil nil history default))) | |
883 | ;; restore the original value of todo-categories | |
884 | (setq todo-categories categories) | |
885 | category)) | |
7f6241ea | 886 | |
da2ee685 OS |
887 | ;; --------------------------------------------------------------------------- |
888 | ||
cb9222cf DL |
889 | (easy-menu-define todo-menu todo-mode-map "Todo Menu" |
890 | '("Todo" | |
891 | ["Next category" todo-forward-category t] | |
892 | ["Previous category" todo-backward-category t] | |
893 | ["Jump to category" todo-jump-to-category t] | |
894 | ["Show top priority items" todo-top-priorities t] | |
895 | ["Print categories" todo-print t] | |
896 | "---" | |
897 | ["Edit item" todo-edit-item t] | |
898 | ["File item" todo-file-item t] | |
899 | ["Insert new item" todo-insert-item t] | |
900 | ["Insert item here" todo-insert-item-here t] | |
901 | ["Kill item" todo-delete-item t] | |
902 | "---" | |
903 | ["Lower item priority" todo-lower-item t] | |
904 | ["Raise item priority" todo-raise-item t] | |
905 | "---" | |
906 | ["Next item" todo-forward-item t] | |
907 | ["Previous item" todo-backward-item t] | |
908 | "---" | |
909 | ["Save" todo-save t] | |
910 | ["Save Top Priorities" todo-save-top-priorities t] | |
911 | "---" | |
912 | ["Quit" todo-quit t] | |
913 | )) | |
a360be79 | 914 | |
e4541b67 | 915 | ;; As calendar reads .todo-do before todo-mode is loaded. |
ade0f0b8 | 916 | ;;;###autoload |
a554b301 DL |
917 | (defun todo-mode () |
918 | "Major mode for editing TODO lists. | |
919 | ||
920 | \\{todo-mode-map}" | |
3cb152f9 | 921 | (interactive) |
30d33965 | 922 | (kill-all-local-variables) |
3cb152f9 OS |
923 | (setq major-mode 'todo-mode) |
924 | (setq mode-name "TODO") | |
925 | (use-local-map todo-mode-map) | |
49c48a1b | 926 | (easy-menu-add todo-menu) |
30d33965 | 927 | (run-mode-hooks 'todo-mode-hook)) |
da2ee685 | 928 | |
4d39c4f7 GM |
929 | (defvar date) |
930 | (defvar entry) | |
cb9222cf | 931 | |
92f0a338 GM |
932 | ;; t-c should be used from diary code, which requires calendar. |
933 | (declare-function calendar-current-date "calendar" nil) | |
934 | ||
5d035cad | 935 | ;; Read about this function in the setup instructions above! |
ade0f0b8 | 936 | ;;;###autoload |
5d035cad | 937 | (defun todo-cp () |
a554b301 | 938 | "Make a diary entry appear only in the current date's diary." |
5d035cad | 939 | (if (equal (calendar-current-date) date) |
a554b301 | 940 | entry)) |
5d035cad | 941 | |
cb9222cf | 942 | (define-derived-mode todo-edit-mode text-mode "TODO Edit" |
a554b301 DL |
943 | "Major mode for editing items in the TODO list. |
944 | ||
cb9222cf | 945 | \\{todo-edit-mode-map}") |
7f6241ea | 946 | |
ade0f0b8 | 947 | ;;;###autoload |
a554b301 DL |
948 | (defun todo-show () |
949 | "Show TODO list." | |
da2ee685 | 950 | (interactive) |
685b5479 CY |
951 | ;; Call todo-initial-setup only if there is neither a Todo file nor |
952 | ;; a corresponding unsaved buffer. | |
953 | (if (or (file-exists-p todo-file-do) | |
954 | (let* ((buf (get-buffer (file-name-nondirectory todo-file-do))) | |
955 | (bufname (buffer-file-name buf))) | |
956 | (equal (expand-file-name todo-file-do) bufname))) | |
7f6241ea OS |
957 | (find-file todo-file-do) |
958 | (todo-initial-setup)) | |
cb9222cf DL |
959 | (if (null todo-categories) |
960 | (if (null todo-cats) | |
961 | (error "Error in %s: No categories in list `todo-categories'" | |
962 | todo-file-do) | |
963 | (goto-char (point-min)) | |
964 | (and (search-forward "todo-cats:" nil t) | |
965 | (replace-match "todo-categories:")) | |
966 | (make-local-variable 'todo-categories) | |
967 | (setq todo-categories todo-cats))) | |
7f6241ea OS |
968 | (beginning-of-line) |
969 | (todo-category-select)) | |
970 | ||
a554b301 DL |
971 | (defun todo-initial-setup () |
972 | "Set up things to work properly in TODO mode." | |
da2ee685 | 973 | (find-file todo-file-do) |
7f6241ea OS |
974 | (erase-buffer) |
975 | (todo-mode) | |
976 | (todo-add-category "Todo")) | |
3cb152f9 | 977 | |
7c896f63 | 978 | (provide 'todo-mode) |
3cb152f9 | 979 | |
3da360a7 | 980 | ;; arch-tag: 6fd91be5-776e-4464-a109-da4ea0e4e497 |
7c896f63 | 981 | ;;; todo-mode.el ends here |