| blob | c1c8e196eaffd1e13e4eec9a48712d7f563b0912 |
1 ;;; todo-mode.el --- facilities for making and maintaining todo lists -*- lexical-binding:t -*-
3 ;; Copyright (C) 1997, 1999, 2001-2018 Free Software Foundation, Inc.
5 ;; Author: Oliver Seidel <privat@os10000.net>
6 ;; Stephen Berman <stephen.berman@gmx.net>
7 ;; Maintainer: Stephen Berman <stephen.berman@gmx.net>
8 ;; Keywords: calendar, todo
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
25 ;;; Commentary:
27 ;; This package provides facilities for making and maintaining
28 ;; prioritized lists of things to do. These todo lists are identified
29 ;; with named categories, so you can group together thematically
30 ;; related todo items. Each category is stored in a file, providing a
31 ;; further level of organization. You can create as many todo files,
32 ;; and in each as many categories, as you want.
34 ;; With Todo mode you can navigate among the items of a category, and
35 ;; between categories in the same and in different todo files. You
36 ;; can add and edit todo items, reprioritize them, move them to
37 ;; another category, or delete them. You can also mark items as done
38 ;; and store them within their category or in separate archive files.
39 ;; You can include todo items in the Emacs Fancy Diary display and
40 ;; treat them as appointments. You can add new todo files, and rename
41 ;; or delete them. You can add new categories to a file, rename or
42 ;; delete them, move a category to another file and merge the items of
43 ;; two categories. You can also reorder the sequence of categories in
44 ;; a todo file for the purpose of navigation. You can display
45 ;; sortable summary tables of the categories in a file and the types
46 ;; of items they contain. And you can filter items by various
47 ;; criteria from multiple categories in one or more todo files to
48 ;; create prioritizable cross-category overviews of your todo items.
50 ;; To get started, type `M-x todo-show'. For full details of the user
51 ;; interface, commands and options, consult the Todo mode user manual,
52 ;; which is included in the Info documentation.
54 ;;; Code:
59 ;; -----------------------------------------------------------------------------
60 ;;; Setting up todo files, categories, and items
61 ;; -----------------------------------------------------------------------------
64 "Directory where user's todo files are saved."
69 "Default value of `todo-files-function'.
70 This returns the case-insensitive alphabetically sorted list of
71 file truenames in `todo-directory' with the extension
83 "Function returning the value of the variable `todo-files'.
84 This function should take an optional argument that, if non-nil,
85 makes it return the value of the variable `todo-archives'."
96 "List of todo files visited in this session by `todo-show'.
97 Used to determine initial display according to the value of
104 "Variable holding name of current todo file.
105 Used by functions called from outside of Todo mode to visit the
106 current todo file rather than the default todo file (i.e. when
113 "Alist of categories in the current todo file.
114 The elements are cons cells whose car is a category name and
115 whose cdr is a vector of the category's item counts. These are,
116 in order, the numbers of todo items, of todo items included in
120 "Variable holding the number of the current todo category.
133 "String determining the value of variable `todo-done-separator'.
134 If the string consists of a single character,
135 `todo-done-separator' will be the string made by repeating this
136 character for the width of the window, and the length is
137 automatically recalculated when the window width changes. If the
138 string consists of more (or less) than one character, it will be
139 the value of `todo-done-separator'."
146 "Return string used as value of variable `todo-done-separator'."
150 todo-done-separator-string)
154 "String used to visually separate done from not done items.
155 Displayed as an overlay instead of `todo-category-done' when
156 done items are shown. Its value is determined by user option
160 "If non-nil display only done items in current category.
161 Set by the command `todo-toggle-view-done-only' and used by
165 "List of strings surrounding item date to block diary inclusion.
166 The first string is inserted before the item date and must be a
167 non-empty string that does not match a diary date in order to
168 have its intended effect. The second string is inserted after
169 the diary date."
183 "Array of month names, in order.
188 "Array of abbreviated month names, in order.
192 ;; FIXME: These vars lack a prefix, but this is out of our control, because
193 ;; they're defined by Calendar, e.g. for calendar-date-display-form.
205 todo-month-name-array
206 todo-month-abbrev-array)))
214 ;; By itself this matches anything, because of the `?'; however, it's only
215 ;; used in the context of `todo-date-pattern' (but Emacs Lisp lacks
216 ;; lookahead).
223 "Identifying string appended to the front of done todo items."
235 todo-date-pattern)
238 ;; -----------------------------------------------------------------------------
239 ;;; Todo mode display options
240 ;; -----------------------------------------------------------------------------
243 "String prefixed to todo items for visual distinction."
248 widget :error
251 widget)))
257 "Non-nil to prefix items with consecutively increasing integers.
258 These reflect the priorities of the items in each category."
265 "Return a mode line control for todo or archive file buffers.
266 Argument CAT is the name of the current todo category.
267 This function is the value of the user variable
268 `todo-mode-line-function'."
273 "Function that returns a mode line control for Todo mode buffers.
274 The function expects one argument holding the name of the current
275 todo category. The resulting control becomes the local value of
276 `mode-line-buffer-identification' in each Todo mode buffer."
281 "Non-nil means highlight items at point."
288 "Non-nil to activate Visual Line mode and use wrap prefix."
293 "Number of spaces to indent continuation lines of items.
294 This must be a positive number to ensure such items are fully
295 shown in the Fancy Diary display."
301 widget)))
305 "Indent from point to `todo-indent-to-here'."
309 "Non-nil to display done items in all categories."
313 ;; -----------------------------------------------------------------------------
314 ;;; Faces
315 ;; -----------------------------------------------------------------------------
319 "Face for making keys in item insertion prompt stand out."
323 ;; '((t :inherit font-lock-warning-face))
345 "Face for marks on marked items."
349 ;; '((t :inherit font-lock-constant-face))
360 "Face for todo item prefix or numerical priority string."
364 ;; bold font-lock-comment-face
375 "Face for top priority todo item numerical priority string.
376 The item's priority number string has this face if the number is
377 less than or equal the category's top priority setting."
381 ;; '((t :inherit font-lock-type-face))
390 "Face for non-diary markers around todo item date/time header."
395 "Face for the date string of a todo item."
400 "Face for the time string of a todo item."
404 ;; Doesn't contrast enough with todo-date (= diary) face.
405 ;; ;; '((t :inherit warning))
406 ;; '((default :weight bold)
407 ;; (((class color) (min-colors 16)) :foreground "DarkOrange")
408 ;; (((class color)) :foreground "yellow"))
409 ;; bold font-lock-function-name-face
417 "Face for expired dates of diary items."
421 ;; '((t :inherit font-lock-builtin-face))
430 "Face for separator string between done and not done todo items."
434 ;; '((t :inherit font-lock-keyword-face))
443 "Face for done todo item header string."
447 ;; '((t :inherit font-lock-comment-face))
465 "Face for comments appended to done todo items."
469 ;; '((t :inherit match))
491 "Face for matches found by `todo-search'."
495 ;; '((t :inherit widget-field))
506 "Face for buttons in table of categories."
520 "Face for sorted column in table of categories."
524 ;; '((t (:inherit (shadow))))
533 "Face for archived-only category names in table of categories."
537 ;; '((t :inherit font-lock-type-face))
546 "Face for category-file header in Todo Filtered Items mode."
549 ;; -----------------------------------------------------------------------------
550 ;;; Entering and exiting
551 ;; -----------------------------------------------------------------------------
553 ;; (defcustom todo-visit-files-commands (list 'find-file 'dired-find-file)
554 ;; "List of file finding commands for `todo-display-as-todo-file'.
555 ;; Invoking these commands to visit a todo file or todo archive file
556 ;; calls `todo-show' or `todo-find-archive', so that the file is
557 ;; displayed correctly."
558 ;; :type '(repeat function)
559 ;; :group 'todo)
562 "Return the short form of todo file FILE's name.
563 This lacks the extension and directory components."
573 "Todo file visited by first session invocation of `todo-show'."
579 "Non-nil to make `todo-show' visit the current todo file.
580 Otherwise, `todo-show' always visits `todo-default-todo-file'."
587 "What action to take on first use of `todo-show' on a file."
596 "Non-nil to prompt for an item after adding a new category."
601 "Default file name offered on adding first todo file."
606 "Default category name offered on initializing a new todo file."
611 "List of files for building `todo-read-category' completions."
616 "Non-nil means case is ignored by `todo-read-*' functions."
620 ;;;###autoload
622 "Visit a todo file and display one of its categories.
624 When invoked in Todo mode, Todo Archive mode or Todo Filtered
625 Items mode, or when invoked anywhere else with a prefix argument,
626 prompt for which todo file to visit. When invoked outside of a
627 Todo mode buffer without a prefix argument, visit
628 `todo-default-todo-file'. Subsequent invocations from outside of
629 Todo mode revisit this file or, with option
630 `todo-show-current-file' non-nil (the default), whichever todo
631 file was last visited.
633 If you call this command before you have created any todo file in
634 the current format, and you have a todo file in old format, it
635 will ask you whether to convert that file and show it.
636 Otherwise, calling this command before any todo file exists
637 prompts for a file name and an initial category (defaulting to
638 `todo-initial-file' and `todo-initial-category'), creates both of
639 these, visits the file and displays the category, and if option
640 `todo-add-item-if-new-category' is non-nil (the default), prompts
641 for the first item.
643 The first invocation of this command on an existing todo file
644 interacts with the option `todo-show-first': if its value is
645 `first' (the default), show the first category in the file; if
646 its value is `table', show the table of categories in the file;
647 if its value is one of `top', `diary' or `regexp', show the
648 corresponding saved top priorities, diary items, or regexp items
649 file, if any. Subsequent invocations always show the file's
650 current (i.e., last displayed) category.
652 In Todo mode just the category's unfinished todo items are shown
653 by default. The done items are hidden, but typing
655 items. With non-nil user option `todo-show-with-done' both todo
656 and done items are always shown on visiting a category."
661 ;; Before initializing the first todo first, check if there is a
662 ;; legacy todo file and if so, offer to convert to the current
663 ;; format and make it the first new todo file.
666 todo-file-do
679 todo-archive-mode
680 todo-filtered-items-mode))))
683 nil t)
686 ;; Called noninteractively via todo-quit
687 ;; to jump to corresponding category in
688 ;; todo file.
696 todo-global-current-todo-file)
699 add-item first-file)
701 ;; We just initialized the first todo file, so make it the default.
703 first-file t)
707 ;; Can't setq t-c-t-f here, otherwise wrong file shown when
708 ;; todo-show is called from todo-show-categories-table.
715 shortf todo-show-first)))
723 "Choose a regexp items file: "
724 rxf)
740 shortf)
745 ;; If todo-show is called from the minibuffer, don't visit
746 ;; the todo file there.
753 ;; When quitting an archive file, show the corresponding
754 ;; category in the corresponding todo file, if it exists.
757 ;; If this is a new todo file, add its first category.
759 ;; Don't confuse an erased buffer with a fresh buffer for
760 ;; adding a new todo file -- it might have been erased by
761 ;; mistake or due to a bug (e.g. Bug#20832).
768 add-item todo-add-item-if-new-category
769 cat-added t)
771 ;; If the category was added, save the file now, so we
772 ;; don't risk having an empty todo file, which would
773 ;; signal an error if we tried to visit it later,
774 ;; since doing that looks for category boundaries.
776 ;; If user cancels before adding the category, clean up
777 ;; and exit, so we have a fresh slate the next time.
779 ;; (setq todo-files (funcall todo-files-function))
783 todo-current-todo-file nil)
794 "Save the current todo file."
805 "Exit the current Todo-related buffer.
806 Depending on the specific mode, this either kills the buffer or
807 buries it and restores state as needed."
811 ;; Postpone killing buffer till after calling todo-show, to
812 ;; prevent killing todo-mode buffer.
814 ;; Ensure todo-show calls todo-show-categories-table only on
815 ;; first invocation per file.
824 ;; Have to write a newly created archive to file to avoid
825 ;; subsequent errors.
833 ;; When todo-check-file runs in todo-show, it kills the
834 ;; buffer if the archive file was deleted externally.
840 ;; -----------------------------------------------------------------------------
841 ;;; Navigation between and within categories
842 ;; -----------------------------------------------------------------------------
845 "Non-nil to handle categories with only archived items specially.
849 archived items. Other commands still recognize these categories.
851 categories shown in `todo-archived-only' face and pressing the
852 category button visits the category in the archive instead of the
853 todo file."
858 "Visit the numerically next category in this todo file.
859 If the current category is the highest numbered, visit the first
860 category. With non-nil argument BACK, visit the numerically
861 previous category (the highest numbered one, if the current
862 category is the first)."
877 "Visit the numerically previous category in this todo file.
878 If the current category is the highest numbered, visit the first
879 category."
886 "Prompt for a category in a todo file and jump to it.
888 With non-nil FILE (interactively a prefix argument), prompt for a
889 specific todo file and choose (with TAB completion) a category
890 in it to jump to; otherwise, choose and jump to any category in
891 either the current todo file or a file in
892 `todo-category-completions-files'.
894 Also accept a non-existing category name and ask whether to add a
895 new category by that name; on confirmation, add it and jump to
896 that category, and if option `todo-add-item-if-new-category' is
897 non-nil (the default), then prompt for the first item.
899 In noninteractive calls non-nil WHERE specifies either the goal
900 category or its file. If its value is `archive', the choice of
901 categories is restricted to the current archive file or the
902 archive you were prompted to choose; this is used by
903 `todo-jump-to-archive-category'. If its value is the name of a
904 category, jump directly to that category; this is used in Todo
905 Categories mode."
907 ;; If invoked outside of Todo mode and there is not yet any Todo
908 ;; file, initialize one.
914 todo-skip-archived-categories
920 ;; If the category has only archived items and
921 ;; `todo-skip-archived-categories' is non-nil, jump to
922 ;; the archive category.
925 ;; Otherwise, jump to the category in the todo file.
926 todo-current-todo-file)))
947 "Move point down to the beginning of the next item.
948 With positive numerical prefix COUNT, move point COUNT items
949 downward.
951 If the category's done items are hidden, this command also moves
952 point to the empty line below the last todo item from any higher
953 item in the category, i.e., when invoked with or without a prefix
954 argument. If the category's done items are visible, this command
955 called with a prefix argument only moves point to a lower item,
956 e.g., with point on the last todo item and called with prefix 1,
957 it moves point to the first done item; but if called with point
958 on the last todo item without a prefix argument, it moves point
959 to the empty line above the done items separator."
961 ;; It's not worth the trouble to allow prefix arg value < 1, since
962 ;; we have the corresponding command.
971 "Move point up to start of item with next higher priority.
972 With positive numerical prefix COUNT, move point COUNT items
973 upward.
975 If the category's done items are visible, this command called
976 with a prefix argument only moves point to a higher item, e.g.,
977 with point on the first done item and called with prefix 1, it
978 moves to the last todo item; but if called with point on the
979 first done item without a prefix argument, it moves point to the
980 empty line above the done items separator."
982 ;; Avoid moving to bob if on the first item but not at bob.
984 ;; It's not worth the trouble to allow prefix arg value < 1, since
985 ;; we have the corresponding command.
993 ;; -----------------------------------------------------------------------------
994 ;;; Display toggle commands
995 ;; -----------------------------------------------------------------------------
998 "Hide item numbering if shown, show if hidden."
1013 "Show hidden or hide visible done items in current category."
1023 ;; If start of done items sections is below the bottom of the
1024 ;; window, make it visible.
1034 "Switch between displaying only done or only todo items."
1040 "Highlight or unhighlight the todo item the cursor is on."
1053 "Hide or show item date-time headers in the current file.
1054 With done items, this hides only the done date-time string, not
1055 the original date-time string."
1078 nil t)
1085 ;; -----------------------------------------------------------------------------
1086 ;;; File and category editing
1087 ;; -----------------------------------------------------------------------------
1090 "Name and initialize a new todo file.
1091 Interactively, prompt for a category and display it, and if
1092 option `todo-add-item-if-new-category' is non-nil (the default),
1093 prompt for the first item.
1094 Noninteractively, return the name of the new file."
1099 ;; Don't accept the name of an existing todo file.
1114 file)))
1117 "Rename the current todo file.
1118 With prefix ARG, prompt for a todo file and rename it.
1119 If there are corresponding archive or filtered items files,
1120 rename these accordingly. If there are live buffers visiting
1121 these files, also rename them accordingly."
1125 nil t))
1133 t)))
1164 "Delete the current todo, archive or filtered items file.
1165 If the todo file has a corresponding archive file, or vice versa,
1166 prompt whether to delete that as well. Also kill the buffers
1167 visiting the deleted files."
1197 ;; If we deleted an archive but not its todo file, update the
1198 ;; latter's category sexp.
1229 file1-sn))))
1235 "Put current buffer in `todo-edit-mode'.
1236 This makes the entire file visible and the buffer writable and
1237 you can use the self-insertion keys and standard Emacs editing
1238 commands to make changes. To return to Todo mode, type
1240 an error if the format has become invalid. However, this check
1241 cannot tell if the number of items changed, which could result in
1242 the file containing inconsistent information. For this reason
1243 this command should be used with caution."
1250 Type %s to return to Todo mode.
1252 This also runs a file format check and signals an error if
1253 the format has become invalid. However, this check cannot
1254 tell if the number of items or categories changed, which
1255 could result in the file containing inconsistent information.
1256 You can repair this inconsistency by invoking the command
1257 `todo-repair-categories-sexp', but this will revert any
1258 renumbering of the categories you have made, so you will
1259 have to renumber them again (see `(todo-mode) Reordering
1263 "Add a new category to a todo file.
1265 Called interactively with prefix argument FILE, prompt for a file
1266 and then for a new category to add to that file, otherwise prompt
1267 just for a category to add to the current todo file. After
1268 adding the category, visit it in Todo mode and if option
1269 `todo-add-item-if-new-category' is non-nil (the default), prompt
1270 for the first item.
1272 Non-interactively, add category CAT to file FILE; if FILE is nil,
1273 add CAT to the current todo file. After adding the category,
1274 return the new category number."
1277 ;; If cat is passed from caller, don't prompt, unless it is "",
1278 ;; which means the file was just added and has no category yet.
1281 todo-current-todo-file))
1284 file))
1288 file)))
1301 ;; If invoked by user, display the newly added category, if
1302 ;; called programmatically return the category number to the
1303 ;; caller.
1310 num))))
1313 "Rename current todo category.
1314 If this file has an archive containing this category, rename the
1315 category there as well."
1338 nil t)
1344 "Delete current todo category provided it contains no items.
1345 With prefix ARG delete the category even if it does contain
1346 todo or done items."
1367 "after deleting the todo category. "
1369 "(see `todo-skip-archived-categories' "
1380 nil t))
1384 nil t)
1390 ;; If deleted category was the only one, delete the file.
1393 ;; Skip confirming killing the archive buffer if it has been
1394 ;; modified and not saved.
1400 todo-categories))
1409 "Move current category to a different todo file.
1410 If the todo file chosen does not exist, it is created.
1411 If the current category has archived items, also move those to
1412 the archive of the file moved to, creating it if it does not exist."
1425 new)
1437 ;; Make sure archive file is in Todo Archive mode so that
1438 ;; todo-categories has correct value.
1449 nil t))
1457 buffer-read-only)
1458 ;; Move the category to the new file. Also update or create
1459 ;; archive file if necessary.
1462 ;; Regenerate todo-archives in case there
1463 ;; is a newly created archive.
1466 nfile))
1474 nfile-short)
1477 buffer-read-only)
1481 ;; If the file moved to has a category with the same
1482 ;; name, rename the moved category.
1488 ;; Replace old with new name in todo and archive files.
1494 nil t)
1500 ;; Delete existing sexp.
1502 ;; Otherwise, file is new, so make space for categories sexp.
1505 ;; Insert (new or updated) sexp.
1507 ;; If archive was just created, save it to avoid "File
1508 ;; <xyz> no longer exists!" message on invoking
1509 ;; `todo-view-archived-items'.
1514 ;; Delete the category from the old file, and if that was the
1515 ;; last category, delete the file. Also handle archive file
1516 ;; if necessary.
1520 ;; Put point after todo-categories sexp.
1524 ;; Skip confirming killing the archive buffer.
1531 todo-categories))
1540 "Merge current category into another existing category.
1542 With prefix argument FILE, prompt for a specific todo file and
1543 choose (with TAB completion) a category in it to merge into;
1544 otherwise, choose and merge into a category in either the
1545 current todo file or a file in `todo-category-completions-files'.
1547 After merging, the source category's todo and done items are
1548 appended to the chosen goal category's todo and done items,
1549 respectively. The goal category becomes the current category,
1550 and the source category is deleted.
1552 If both the source and goal categories also have archived items,
1553 they are also merged. If only the source category has archived
1554 items, the goal category is added as a new category to the
1555 archive file and the source category is deleted."
1565 here)
1578 ;; Omit empty line between todo and done items.
1591 ;; Merge into goal todo category.
1597 ;; Merge any todo items.
1601 nil t)
1608 ;; Merge any done items.
1612 nil t)
1619 ;; Update and clean up source todo file.
1623 todo-categories))
1639 nil t)
1650 ;; Merge into goal archive category, if it exists, else create it.
1656 nil t)
1662 nil t))
1668 ;; Update and clean up source archive file.
1673 ;; Update goal todo file for merged archived items and display it.
1679 ;; If there are only merged done items, show them.
1682 ;; Put point on the first merged item.
1686 ;; -----------------------------------------------------------------------------
1687 ;;; Item editing
1688 ;; -----------------------------------------------------------------------------
1691 "Non-nil to allow new todo items to be included in the diary."
1696 "Non-nil to insert new todo diary items as nonmarking by default.
1697 This appends `diary-nonmarking-symbol' to the front of an item on
1698 insertion provided it doesn't begin with `todo-nondiary-marker'."
1703 "Non-nil adds current time to a new item's date header by default.
1705 argument, this reverses the effect of
1706 `todo-always-add-time-string': if t, these commands omit the
1707 current time, if nil, they include it."
1712 "Non-nil to enable inserting only highlighted region as new item."
1717 "Default priority of new and moved items."
1723 "String used to mark items.
1724 To ensure item marking works, change the value of this option
1725 only when no items are marked."
1730 widget :error
1733 widget)))
1739 "String inserted before optional comment appended to done item."
1746 "Whether to omit done item comment on undoing the item.
1747 Nil means never omit the comment, t means always omit it, `ask'
1748 means prompt user and omit comment only on confirmation."
1755 "Mark item with `todo-item-mark' if unmarked, otherwise unmark it.
1756 With positive numerical prefix argument N, change the marking of
1757 the next N items in the current category. If both the todo and
1758 done items sections are visible, the sequence of N items can
1759 consist of the last todo items and the first done items."
1784 ;; Don't try to mark the empty lines at the end of the todo
1785 ;; and done items sections.
1792 "Mark all visible items in this category with `todo-item-mark'."
1800 ;; When done items are shown and there are no todo items, the
1801 ;; loop starts on the empty line in the todo items sections,
1802 ;; which has no overlay, so don't try to get it.
1810 ;; Don't try to mark the empty line between the todo and done
1811 ;; items sections.
1817 "Remove `todo-item-mark' from all visible items in this category."
1825 ;; See comment above in `todo-mark-category'.
1840 "Choose an item insertion operation and carry it out.
1841 This inserts a new todo item into a category.
1843 With no prefix argument ARG, add the item to the current
1844 category; with one prefix argument (`C-u'), prompt for a category
1845 from the current todo file; with two prefix arguments (`C-u
1846 C-u'), first prompt for a todo file, then a category in that
1847 file. If a non-existing category is entered, ask whether to add
1848 it to the todo file; if answered affirmatively, add the category
1849 and insert the item there.
1851 There are a number of item insertion parameters which can be
1852 combined by entering specific keys to produce different insertion
1853 commands. After entering each key, a message shows which have
1854 already been entered and which remain available. See
1855 `(todo-mode) Inserting New Items' for details of the parameters,
1856 their associated keys and their effects."
1862 "Function implementing the core of `todo-insert-item'."
1863 ;; If invoked outside of Todo mode and there is not yet any Todo
1864 ;; file, initialize one.
1870 diary-item)
1897 todo-global-current-todo-file)
1899 todo-default-todo-file))))))
1914 ;; If user exits Calendar before choosing
1915 ;; a date, cancel item insertion.
1931 ;; If this command was invoked outside of a Todo mode buffer,
1932 ;; the call to todo-current-category above returned nil. If
1933 ;; we just entered Todo mode now, then cat was set to the
1934 ;; file's first category, but if todo-mode was already
1935 ;; enabled, cat did not get set, so we have to do that.
1943 done-only item-added)
1946 ;; Add date, time and diary marking as required.
1949 todo-nondiary-start
1952 diary-nonmarking-symbol))
1955 time-string))))
1959 todo-nondiary-end)
1961 ;; Indent newlines inserted by C-q C-j if nonspace char follows.
1966 ;; Make sure the correct category is selected. There
1967 ;; are two cases: (i) we just visited the file, so no
1968 ;; category is selected yet, or (ii) we invoked
1969 ;; insertion "here" from outside the category we want
1970 ;; to insert in (with priority insertion, category
1971 ;; selection is done by todo-set-item-priority).
1976 ;; If only done items are displayed in category,
1977 ;; toggle to todo items before inserting new item.
1985 ;; If command was invoked with point in done
1986 ;; items section or outside of the current
1987 ;; category, can't insert "here", so to be
1988 ;; useful give new item top priority.
1990 called-from-outside
1991 done-only)
1996 ;; If user cancels before setting priority, restore
1997 ;; display.
2006 ;; If the todo items section is not visible when the
2007 ;; insertion command is called (either because only done
2008 ;; items were shown or because the category was not in the
2009 ;; current buffer), then if the item is inserted at the
2010 ;; end of the category, point is at eob and eob at
2011 ;; window-start, so that higher priority todo items are
2012 ;; out of view. So we recenter to make sure the todo
2013 ;; items are displayed in the window.
2021 "Return string of date chosen from Calendar."
2024 todo-date-from-calendar)
2029 ;; If user exits Calendar before choosing a date, clean up properly.
2043 todo-date-from-calendar)
2048 todo-date-from-calendar)))))
2051 "Prompt for and insert a new item with date selected from calendar.
2052 Invoked without prefix argument ARG, insert the item into the
2053 current category, without one prefix argument, prompt for the
2054 category from the current todo file or from one listed in
2055 `todo-category-completions-files'; with two prefix arguments,
2056 prompt for a todo file and then for a category in it."
2066 "Delete at least one item in this category.
2067 If there are marked items, delete all of these; otherwise, delete
2068 the item at point."
2084 buffer-read-only)
2098 ;; Don't leave point below last item.
2115 "Choose an editing operation for the current item and carry it out."
2124 "Function providing the text editing facilities of `todo-edit-item'."
2126 ;; If there are marked items and user invokes a text-editing
2127 ;; commands with point not on an item, todo-item-start is nil and
2128 ;; 1+ signals an error, so just make this a noop.
2145 full-item
2154 end t)))
2157 ;; When there are marked items, user can invoke todo-edit-item
2158 ;; even if point is not on an item, but text editing only
2159 ;; applies to the item at point.
2171 end t)
2181 ;; If user moved point during editing,
2182 ;; make sure it moves back.
2203 todo-date-pattern)
2204 new))
2207 ;; Ensure lines following hard newlines are indented.
2210 ;; If user moved point during editing, make sure it moves back.
2217 "Return from Todo Edit mode to Todo mode.
2218 If the item contains hard line breaks, make sure the following
2219 lines are indented by `todo-indent-to-here' to conform to diary
2220 format.
2222 If the whole file was in Todo Edit mode, check before returning
2223 whether the file is still a valid todo file and if so, also
2224 recalculate the todo file's categories sexp, in case changes were
2225 made in the number or names of categories."
2228 ;; We got here via `e m'.
2233 todo-date-pattern)
2234 item))
2237 ;; Ensure lines following hard newlines are indented.
2245 ;; We got here via `F e'.
2247 ;; FIXME: separate out sexp check?
2248 ;; If manual editing makes e.g. item counts change, have to
2249 ;; call this to update todo-categories, but it restores
2250 ;; category order to list order.
2251 ;; (todo-repair-categories-sexp)
2252 ;; Compare (todo-make-categories-list t) with sexp and if
2253 ;; different ask (todo-update-categories-sexp) ?
2269 "Function providing header editing facilities of `todo-edit-item'."
2273 ;; INC must be an integer, but users could pass it via
2274 ;; `todo-edit-item' as e.g. `-' or `C-u'.
2277 ndate ntime year monthname month day
2289 todo-date-pattern
2311 ;; If there are marked items, use only the first to set
2312 ;; header changes, and apply these to all marked items.
2327 ;; When date string consists only of a day name,
2328 ;; passing other date components is a noop.
2332 monthname omonthname
2333 month omonth
2342 year oyear
2344 month
2345 monthname)
2352 ;; Increment or decrement month by INC
2353 ;; modulo 12.
2355 ;; If result is 0, make month December.
2357 ;; Adjust year if necessary.
2364 oyear)))
2365 ;; Return the changed numerical month as
2366 ;; a string or the corresponding month name.
2370 ;; Since the number corresponding to the arbitrary
2371 ;; month name "*" is out of the range of
2372 ;; calendar-last-day-of-month, set it to 1
2373 ;; (corresponding to January) to allow 31 days.
2382 month omonth
2383 monthname omonthname
2395 ;; Increment or decrement day by INC,
2396 ;; adjusting month and year if necessary
2397 ;; (if year is "*" assume current year to
2398 ;; calculate adjustment).
2405 inc)))
2407 ;; Set year and month(name) to adjusted values.
2413 ;; Return changed numerical day as a string.
2416 ;; If year, month or day date string components were
2417 ;; changed, rebuild the date string.
2421 ;; Add new time string to the header, if it was supplied.
2429 ;; Apply the changes to the first marked item header to the
2430 ;; remaining marked items. If there are no marked items,
2431 ;; we're finished.
2437 "Function providing diary marking facilities of `todo-edit-item'."
2480 "Make all items in this category diary items.
2481 With prefix ARG, make all items in this category non-diary
2482 items."
2518 "Add `diary-nonmarking-symbol' to all diary items in this category.
2519 With prefix ARG, remove `diary-nonmarking-symbol' from all diary
2520 items in this category."
2538 "Prompt for and set ITEM's priority in CATegory.
2540 Interactively, ITEM is the todo item at point, CAT is the current
2541 category, and the priority is a number between 1 and the number
2542 of items in the category. Non-interactively, non-nil NEW means
2543 ITEM is a new item and the lowest priority is one more than the
2544 number of items in CAT.
2546 The new priority is set either interactively by prompt or by a
2547 numerical prefix argument, or noninteractively by argument ARG,
2548 whose value can be either of the symbols `raise' or `lower',
2549 meaning to raise or lower the item's priority by one."
2560 todo-date-pattern
2567 curnum
2578 count)))
2584 current-prefix-arg)
2589 candidate
2590 buffer-read-only)
2594 ;; When moving item to another category, show the category before
2595 ;; prompting for its priority.
2598 ;; If done items in category are visible, keep them visible.
2605 ;; Keep current item or top of moved to category in view
2606 ;; while setting priority.
2608 ;; Prompt for priority only when the category has at least one
2609 ;; todo item.
2617 maxnum)))
2619 ;; In Top Priorities buffer, an item's priority can be changed
2620 ;; wrt items in another category, but not wrt items in the same
2621 ;; category.
2643 ;; Interactively or with non-nil ARG, relocate the item within its
2644 ;; category.
2651 ;; When called from todo-item-undone and the highest priority
2652 ;; is chosen, this advances point to the first done item, so
2653 ;; move it up to the empty line above the done items
2654 ;; separator.
2661 ;; If item was marked, restore the mark.
2669 "Raise priority of current item by moving it up by one item."
2674 "Lower priority of current item by moving it down by one item."
2679 "Move at least one todo or done item to another category.
2680 If there are marked items, move all of these; otherwise, move
2681 the item at point.
2683 With prefix argument FILE, prompt for a specific todo file and
2684 choose (with TAB completion) a category in it to move the item or
2685 items to; otherwise, choose and move to any category in either
2686 the current todo file or one of the files in
2687 `todo-category-completions-files'. If the chosen category is
2688 not an existing categories, then it is created and the item(s)
2689 become(s) the first entry/entries in that category.
2691 With moved todo items, prompt to set the priority in the category
2692 moved to (with multiple todo items, the one that had the highest
2693 priority in the category moved from gets the new priority and the
2694 rest of the moved todo items are inserted in sequence below it).
2695 Moved done items are appended to the top of the done items
2696 section in the category moved to."
2700 ;; Noop if point is not on an item and there are no marked items.
2711 ov cat2 file2 moved nmark todo-items done-items)
2721 nil file)))
2763 ;; Move done items en bloc to top of done items section.
2770 nil t)
2778 ;; If only done items were moved, move point to the top
2779 ;; one, otherwise, move point to the top moved todo item.
2783 ;; Move succeeded, so remove item from starting category,
2784 ;; update item counts and display the category containing
2785 ;; the moved item.
2807 nil t)
2831 ;; If item is moved to end of (just first?) category, make
2832 ;; sure the items above it are displayed in the window.
2834 ;; User quit before setting priority of todo item(s), so
2835 ;; return to starting category.
2844 "Tag a todo item in this category as done and relocate it.
2846 With prefix argument ARG prompt for a comment and append it to
2847 the done item; this is only possible if there are no marked
2848 items. If there are marked items, tag all of these with
2849 `todo-done-string' plus the current date and, if
2850 `todo-always-add-time-string' is non-nil, the current time;
2851 otherwise, just tag the item at point. Items tagged as done are
2852 relocated to the category's (by default hidden) done section. If
2853 done items are visible on invoking this command, they remain
2854 visible."
2861 ;; Point is between todo and done items.
2877 header item done-items
2879 ;; Don't add empty comment to done item.
2885 ;; Stop looping when we hit the empty line below the last
2886 ;; todo item (this is eobp if only done items are hidden).
2915 nil t)
2925 ;; When done items are visible, put point at the top of the
2926 ;; done items section. When done items are hidden, restore
2927 ;; point to its location prior to invoking this command.
2931 "Restore at least one done item to this category's todo section.
2932 Prompt for the new priority. If there are marked items, undo all
2933 of these, giving the first undone item the new priority and the
2934 rest following directly in sequence; otherwise, undo just the
2935 item at point.
2937 If the done item has a comment, ask whether to omit the comment
2938 from the restored item. With multiple marked done items with
2939 comments, only ask once, and if affirmed, omit subsequent
2940 comments without asking."
2952 start end item ov npoint undone)
2966 ;; Find the end of the date string added upon tagging item as
2967 ;; done.
2973 ;; Ask (once) whether to omit done item's comment. If
2974 ;; affirmed, omit subsequent comments without asking.
2978 end t)
2985 " from restored item"
2989 t)
3000 ;; Chop off last newline of multiple items string, since
3001 ;; it will be reinserted on setting priority.
3028 ;; Put cursor on undone item.
3032 ;; -----------------------------------------------------------------------------
3033 ;;; Done item archives
3034 ;; -----------------------------------------------------------------------------
3037 "Visit the archive of the current todo category, if it exists.
3038 If the category has no archived items, prompt to visit the
3039 archive anyway. If there is no archive for this file or with
3040 non-nil argument ASK, prompt to visit another archive.
3042 The buffer showing the archive is in Todo Archive mode. The
3043 first visit in a session displays the first category in the
3044 archive, subsequent visits return to the last category
3045 displayed."
3076 "Choose an archive and visit it."
3081 "Archive at least one done item in this category.
3083 With prefix argument ALL, prompt whether to archive all done
3084 items in this category and on confirmation archive them.
3085 Otherwise, if there are marked done items (and no marked todo
3086 items), archive all of these; otherwise, archive the done item at
3087 point.
3089 If the archive of this file does not exist, it is created. If
3090 this category does not exist in the archive, it is created."
3106 marked-items beg end all-done
3107 buffer-read-only)
3117 nil t)
3122 nil t)
3127 ;; Restore starting point, unless it was on a done
3128 ;; item, since they will all be deleted.
3147 buffer-read-only)
3154 nil t)
3156 nil t))
3157 ;; Start of done items section in existing category.
3160 ;; Start of done items section in new category.
3167 ;; If archive is new, save to file now (with
3168 ;; write-region to avoid prompt for file to save to)
3169 ;; to update todo-archives, and set the mode for
3170 ;; visiting the archive below.
3181 ;; Make sure done items are accessible.
3188 ;; If we're archiving all done items, can't
3189 ;; first archive item point was on, since
3190 ;; that will short-circuit the rest.
3200 ;; Don't leave point below last item.
3217 ;; Make todo file current to select category.
3219 ;; Make sure done item separator is hidden (if done items
3220 ;; were initially visible).
3224 "Unarchive at least one item in this archive category.
3225 If there are marked items, unarchive all of these; otherwise,
3226 unarchive the item at point.
3228 Unarchived items are restored as done items to the corresponding
3229 category in the todo file, inserted at the top of done items
3230 section. If all items in the archive category have been
3231 restored, the category is deleted from the archive. If this was
3232 the only category in the archive, the archive file is deleted."
3239 t))
3243 marked-items
3244 buffer-read-only)
3253 ;; Restore items to top of category's done section and update counts.
3256 buffer-read-only newcat)
3260 ;; Find the corresponding todo category, or if there isn't
3261 ;; one, add it.
3265 nil t)
3268 ;; Go to top of category's done section.
3284 ;; Delete restored items from archive.
3297 ;; If we unarchived the last item in category, then if that was
3298 ;; the only category, delete the whole file, otherwise, just
3299 ;; delete the category.
3304 ;; Kill the archive buffer silently.
3310 nil t))
3319 todo-categories)))))
3321 ;; Visit category in todo file and show restored done items.
3328 ;; Selecting the category leaves point at the end of the done
3329 ;; items separator string, so move it to the (first) restored
3330 ;; done item.
3335 "Prompt for a category in a todo archive and jump to it.
3336 With prefix argument FILE, prompt for an archive and choose (with
3337 TAB completion) a category in it to jump to; otherwise, choose
3338 and jump to any category in the current archive."
3342 ;; -----------------------------------------------------------------------------
3343 ;;; Displaying and sorting tables of categories
3344 ;; -----------------------------------------------------------------------------
3347 "Category button label in Todo Categories mode."
3352 "Todo button label in Todo Categories mode."
3357 "Diary button label in Todo Categories mode."
3362 "Done button label in Todo Categories mode."
3367 "Archived button label in Todo Categories mode."
3372 "String to label total item counts in Todo Categories mode."
3377 "String between number and category in Todo Categories mode.
3378 This separates the number from the category name in the default
3379 categories display according to priority."
3384 "Alignment of category names in Todo Categories mode."
3389 "Display a table of the current file's categories and item counts.
3391 In the initial display the lines of the table are numbered,
3392 indicating the current order of the categories when sequentially
3399 with a numeric prefix. If you save the todo file after
3400 reordering the categories, the new order persists in subsequent
3401 Emacs sessions.
3403 The labels above the category names and item counts are buttons,
3404 and clicking these changes the display: sorted by category name
3405 or by the respective item counts (alternately descending or
3406 ascending). In these displays the categories are not numbered
3409 sorting is triggered by passing a non-nil SORTKEY argument.)
3411 In addition, the lines with the category names and item counts
3412 are buttonized, and pressing one of these button jumps to the
3413 category in Todo mode (or Todo Archive mode, for categories
3414 containing only archived items, provided user option
3415 `todo-skip-archived-categories' is non-nil. These categories
3416 are shown in `todo-archived-only' face."
3423 "Move point to the Nth next button in the table of categories."
3427 ;; Align with beginning of category label.
3431 "Move point to the Nth previous button in the table of categories."
3435 ;; Align with beginning of category label.
3439 "Change number of category at point in the table of categories.
3441 With ARG nil, prompt for the new number. Alternatively, the
3442 enter the new number with numerical prefix ARG. Otherwise, if
3443 ARG is either of the symbols `raise' or `lower', raise or lower
3444 the category line in the table by one, respectively, thereby
3445 decreasing or increasing its number."
3448 ;; Get the number representing the priority of the category
3449 ;; on the current line.
3460 candidate)
3467 maxnum))
3476 todo-categories))
3477 ;; Category's name and items counts list.
3480 newcats)
3494 "Raise priority of category at point in the table of categories."
3499 "Lower priority of category at point in the table of categories."
3504 "Sort table of categories alphabetically or numerically."
3517 "Sort table of categories by number of todo items."
3525 "Sort table of categories by number of diary items."
3533 "Sort table of categories by number of non-archived done items."
3541 "Sort table of categories by number of archived items."
3552 "Return the length of the longest name in list CATEGORIES."
3558 "Return adjusted length of category label button.
3559 The adjustment ensures proper tabular alignment in Todo
3560 Categories mode."
3570 "Return category name or label string STR padded with spaces.
3571 The placement of the padding is determined by the value of user
3572 option `todo-categories-align'."
3592 "Return a copy of LIST, possibly sorted according to KEY."
3597 ;; Keep track of whether the last sort by key was descending or
3598 ;; ascending.
3608 ;; Switch between descending and ascending sort order.
3613 l))
3616 "Keep point on the TYPE count sorting button just clicked."
3622 "Return symbol for sort key associated with LABEL."
3634 key))
3637 "Insert button for displaying categories sorted by item counts.
3638 LABEL determines which type of count is sorted."
3641 label))
3644 ov)
3646 'action
3652 ;; If display is alphabetical, switch back to
3653 ;; category priority order.
3662 "Return a list of total item counts for the current file."
3664 todo-categories)))
3671 "Insert button with category CAT's name and item counts.
3672 With non-nil argument NONUM show only these; otherwise, insert a
3673 number in front of the button indicating the category's priority.
3674 The number and the category name are separated by the string
3675 which is the value of the user option
3676 `todo-categories-number-separator'."
3687 str
3692 ;; Add an extra space if label length is odd.
3707 'todo-archived-only
3708 nil)
3713 ;; Highlight the sorted count column.
3715 end ovl)
3737 "Prepare buffer for displaying table of categories and item counts."
3747 buffer-read-only)
3754 ;; Make space for the column of category numbers.
3756 ;; Add the category and item count buttons (if this is the list of
3757 ;; categories in an archive, show only done item counts).
3774 "Populate table of categories and sort by SORTKEY."
3779 ;; Find start of Category button if we just entered Todo Categories
3780 ;; mode.
3789 ;; Fill in the table with buttonized lines, each showing a category and
3790 ;; its item counts.
3794 ;; Add a line showing item count totals.
3802 ;; Add an extra space if label length is odd.
3811 ;; Put cursor on Category button initially.
3815 ;; -----------------------------------------------------------------------------
3816 ;;; Searching and item filtering
3817 ;; -----------------------------------------------------------------------------
3820 "Search for a regular expression in this todo file.
3821 The search runs through the whole file and encompasses all and
3822 only todo and done items; it excludes category names. Multiple
3823 matches are shown sequentially, highlighted in `todo-search'
3824 face."
3828 matches match cat in-done ov mlen msg)
3849 nil t)
3863 mlen)
3868 mlen)
3882 "Remove highlighting on matches found by todo-search."
3887 "List of rules specifying number of top priority items to show.
3888 These rules override `todo-top-priorities' on invocations of
3891 of the form (FILE NUM ALIST), where FILE is a member of
3892 `todo-files', NUM is a number specifying the default number of
3893 top priority items for each category in that file, and ALIST,
3894 when non-nil, consists of conses of a category name in FILE and a
3895 number specifying the default number of top priority items in
3896 that category, which overrides NUM.
3898 This variable should be set interactively by
3905 "Default number of top priorities shown by `todo-filter-top-priorities'."
3910 "List of default files for multifile item filtering."
3915 "Non-nil to include done items when processing regexp filters.
3916 Done items from corresponding archive files are also included."
3921 "Set number of top priorities for this file.
3922 See `todo-set-top-priorities' for more details."
3927 "Set number of top priorities for this category.
3928 See `todo-set-top-priorities' for more details."
3933 "Display a list of top priority items from different categories.
3934 The categories can be any of those in the current todo file.
3936 With numerical prefix ARG show at most ARG top priority items
3937 from each category. With `C-u' as prefix argument show the
3938 numbers of top priority items specified by category in
3939 `todo-top-priorities-overrides', if this has an entry for the file(s);
3940 otherwise show `todo-top-priorities' items per category in the
3941 file(s). With no prefix argument, if a top priorities file for
3942 the current todo file has previously been saved (see
3943 `todo-save-filtered-items-buffer'), visit this file; if there is
3944 no such file, build the list as with prefix argument `C-u'.
3946 The prefix ARG regulates how many top priorities from
3947 each category to show, as described above."
3952 "Display a list of top priority items from different categories.
3953 The categories are a subset of the categories in the files listed
3954 in `todo-filter-files', or if this nil, in the files chosen from
3955 a file selection dialog that pops up in this case.
3957 With numerical prefix ARG show at most ARG top priority items
3958 from each category in each file. With `C-u' as prefix argument
3959 show the numbers of top priority items specified in
3960 `todo-top-priorities-overrides', if this is non-nil; otherwise show
3961 `todo-top-priorities' items per category. With no prefix
3962 argument, if a top priorities file for the chosen todo files
3963 exists (see `todo-save-filtered-items-buffer'), visit this file;
3964 if there is no such file, do the same as with prefix argument
3965 `C-u'."
3970 "Display a list of todo diary items from different categories.
3971 The categories can be any of those in the current todo file.
3973 Called with no prefix ARG, if a diary items file for the current
3974 todo file has previously been saved (see
3975 `todo-save-filtered-items-buffer'), visit this file; if there is
3976 no such file, build the list of diary items. Called with a
3977 prefix argument, build the list even if there is a saved file of
3978 diary items."
3983 "Display a list of todo diary items from different categories.
3984 The categories are a subset of the categories in the files listed
3985 in `todo-filter-files', or if this nil, in the files chosen from
3986 a file selection dialog that pops up in this case.
3988 Called with no prefix ARG, if a diary items file for the chosen
3989 todo files has previously been saved (see
3990 `todo-save-filtered-items-buffer'), visit this file; if there is
3991 no such file, build the list of diary items. Called with a
3992 prefix argument, build the list even if there is a saved file of
3993 diary items."
3998 "Prompt for a regular expression and display items that match it.
3999 The matches can be from any categories in the current todo file
4000 and with non-nil option `todo-filter-done-items', can include
4001 not only todo items but also done items, including those in
4002 Archive files.
4004 Called with no prefix ARG, if a regexp items file for the current
4005 todo file has previously been saved (see
4006 `todo-save-filtered-items-buffer'), visit this file; if there is
4007 no such file, build the list of regexp items. Called with a
4008 prefix argument, build the list even if there is a saved file of
4009 regexp items."
4014 "Prompt for a regular expression and display items that match it.
4015 The matches can be from any categories in the files listed in
4016 `todo-filter-files', or if this nil, in the files chosen from a
4017 file selection dialog that pops up in this case. With non-nil
4018 option `todo-filter-done-items', the matches can include not
4019 only todo items but also done items, including those in Archive
4020 files.
4022 Called with no prefix ARG, if a regexp items file for the current
4023 todo file has previously been saved (see
4024 `todo-save-filtered-items-buffer'), visit this file; if there is
4025 no such file, build the list of regexp items. Called with a
4026 prefix argument, build the list even if there is a saved file of
4027 regexp items."
4032 "Choose a filtered items file and visit it."
4035 falist file)
4041 falist)))
4051 "Display the file and category of the filtered item at point."
4068 t
4069 todo-show-with-done)))
4080 "Pop to a buffer with a widget for choosing multiple filter files."
4108 todo-multiple-filter-files-widget)))
4130 "Display a list of items filtered by FILTER.
4131 The values of FILTER can be `top' for top priority items, a cons
4132 of `top' and a number passed by the caller, `diary' for diary
4133 items, or `regexp' for items matching a regular expression
4134 entered by the user. The items can come from any categories in
4135 the current todo file or, with non-nil MULTIFILE, from several
4136 files. If NEW is nil, visit an appropriate file containing the
4137 list of filtered items; if there is no such file, or with non-nil
4138 NEW, build the list and display it.
4140 See the documentation strings of the commands
4141 `todo-filter-top-priorities', `todo-filter-diary-items',
4142 `todo-filter-regexp-items', and those of the corresponding
4143 multifile commands for further details."
4153 todo-multiple-filter-files))
4156 ;; Pressed `cancel' in t-m-f-f file selection dialog.
4167 bufname)
4175 rxf)
4187 #'todo-short-file-name
4188 todo-files))
4190 s)
4191 s)))
4193 buf bufname))))
4196 "Build a list of items by applying FILTER to FILE-LIST.
4197 Internal subroutine called by `todo-filter-items', which passes
4198 the values of FILTER and FILE-LIST."
4202 regexp fname bufstr cat beg end done)
4213 ;; Before inserting file contents into temp buffer, save a modified
4214 ;; buffer visiting it.
4221 ;; If there is a corresponding archive file for the
4222 ;; todo file, insert it first and add identifiers for
4223 ;; todo-go-to-source-item.
4227 ;; Delete todo archive file's categories sexp.
4237 todo-date-string-start)
4243 nil t)
4247 ;; Delete todo file's categories sexp.
4250 ;; Unless the number of top priorities to show was
4251 ;; passed by the caller, the file-wide value from
4252 ;; `todo-top-priorities-overrides', if non-nil, overrides
4253 ;; `todo-top-priorities'.
4256 todo-top-priorities)))
4260 nil t)
4263 ;; Unless the number of top priorities to show was
4264 ;; passed by the caller, the category-wide value
4265 ;; from `todo-top-priorities-overrides', if non-nil,
4266 ;; overrides a non-nil file-wide value from
4267 ;; `todo-top-priorities-overrides' as well as
4268 ;; `todo-top-priorities'.
4276 nil t)
4283 end t)
4285 end))
4287 ;; Leave done items.
4292 ;; Apply the filter.
4304 ;; Kill lines that aren't part of a todo or done
4305 ;; item (empty or todo-category-done).
4308 ;; If last todo item in file matches regexp and
4309 ;; there are no following done items,
4310 ;; todo-category-done string is left dangling,
4311 ;; because todo-forward-item jumps over it.
4325 ;; Delete non-top-priority items.
4329 ;; Add file (if using multiple files) and category tags to
4330 ;; item.
4337 todo-date-string-start)
4343 nil t)
4358 "Set number of top priorities shown by `todo-filter-top-priorities'.
4359 With non-nil ARG, set the number only for the current Todo
4360 category; otherwise, set the number for all categories in the
4361 current todo file.
4363 Calling this function via either of the commands
4364 `todo-set-top-priorities-in-file' or
4365 `todo-set-top-priorities-in-category' is the recommended way to
4366 set the user customizable option `todo-top-priorities-overrides'."
4374 todo-top-priorities))
4376 fcur))
4385 prompt "Enter a non-negative number: "
4386 cur nil)))
4392 nrule)
4398 "Search for filtered item STR in its saved todo file.
4399 Return the list (FOUND FILE CAT), where CAT and FILE are the
4400 item's category and file, and FOUND is a cons cell if the search
4401 succeeds, whose car is the start of the item in FILE and whose
4402 cdr is `done', if the item is now a done item, `changed', if its
4403 text was truncated or augmented or, for a top priority item, if
4404 its priority has changed, and `same' otherwise."
4408 todo-date-string-start)
4415 str)
4422 found)
4425 ;; Calculate priority of STR wrt its category.
4435 todo-global-current-todo-file)))
4447 nil t))
4454 nil t)
4461 'done
4465 ;; Not top item in category.
4469 ;; Can't move backward beyond
4470 ;; first item in file.
4474 ;; Proper substring is not the same.
4476 str))
4477 'same
4482 "Check if filtered items file is up to date and a show suitable message."
4483 ;; (catch 'old
4493 ;; (throw 'old (message "The marked item is not up to date.")))
4498 "not up to date."
4499 ;; "\nType <return> on item for details."
4500 )))))
4503 "Return absolute file name for saving this Filtered Items buffer."
4521 "Save current Filtered Items buffer to a file.
4522 If the file already exists, overwrite it only on confirmation."
4526 ;; -----------------------------------------------------------------------------
4527 ;;; Printing Todo mode buffers
4528 ;; -----------------------------------------------------------------------------
4531 "Function called by `todo-print-buffer' to print Todo mode buffers.
4532 Called with one argument which can either be:
4533 - a string, naming a file to save the print image to.
4534 - nil, to send the image to the printer."
4542 "Produce a printable version of the current Todo mode buffer.
4543 This converts overlays and soft line wrapping and, depending on
4544 the value of `todo-print-buffer-function', includes faces. With
4545 non-nil argument TO-FILE write the printable version to a file;
4546 otherwise, send it to the default printer."
4573 ;; Calling todo-forward-item infloops at todo-item-start due to
4574 ;; non-overlay prefix, so search for item start instead.
4579 nil t)
4590 "Save printable version of this Todo mode buffer to a file."
4594 ;; -----------------------------------------------------------------------------
4595 ;;; Legacy Todo mode files
4596 ;; -----------------------------------------------------------------------------
4601 "Regexp matching legacy todo-mode.el item date-time strings.
4602 In order for `todo-convert-legacy-files' to correctly convert
4603 this string to the current Todo mode format, the regexp must
4604 contain four explicitly numbered groups (see `(elisp) Regexp
4605 Backslash'), where group 1 matches a string for the year, group 2
4606 a string for the month, group 3 a string for the day and group 4
4607 a string for the time. The default value converts date-time
4608 strings built using the default value of
4609 `todo-time-string-format' from todo-mode.el."
4614 "Return converted date-time string.
4615 Helper function for `todo-convert-legacy-files'."
4621 dayname)
4627 "Convert legacy todo files to the current Todo mode format.
4628 The old-style files named by the variables `todo-file-do' and
4629 `todo-file-done' from the old package are converted to the new
4630 format and saved (the latter as a todo archive file) with a new
4631 name in `todo-directory'. See also the documentation string of
4632 `todo-legacy-date-time-regexp' for further details."
4634 ;; If there are user customizations of legacy options, use them,
4635 ;; otherwise use the legacy default values.
4637 todo-file-do
4640 todo-file-done
4644 todo-entry-prefix-function))
4645 todo-prefix-tem)
4646 ;; Convert `todo-file-do'.
4650 file archive-sexp)
4653 ;; Eliminate old-style local variables list in first line.
4661 ;; Old-style category start delimiter.
4664 ;; Old-style category end delimiter.
4667 ;; Old-style category separator.
4672 ;; Old-style item header (date/time/initials).
4686 nil nil default)
4698 ;; Convert `todo-file-done'.
4704 cat cats comment item)
4719 todo-initials-tem)
4733 ;; If the item ends with a non-comment parenthesis not
4734 ;; followed by a period, we lose (but we inherit that
4735 ;; problem from the legacy code).
4736 ;; FIXME: fails on multiline comment
4743 ;; If item is already in its category, leave it there.
4748 nil t)
4750 ;; Else move it to its category.
4758 nil t)
4763 nil t)
4789 ;; Update categories sexp of converted todo file again, adding
4790 ;; counts of archived items.
4809 ;; We just initialized the first todo file, so make it the
4810 ;; default now to avoid an infinite recursion with todo-show.
4814 ;; -----------------------------------------------------------------------------
4815 ;;; Utility functions for todo files, categories and items
4816 ;; -----------------------------------------------------------------------------
4819 "Return the absolute file name of short todo file NAME.
4820 With TYPE `archive' or `top' return the absolute file name of the
4821 short todo archive or top priorities file name, respectively."
4822 ;; No-op if there is no todo file yet (i.e. don't concatenate nil).
4833 "Check the state associated with FILE and update it if necessary.
4834 If FILE exists, return t. If it does not exist and there is no
4835 live buffer with its content, return nil; if there is such a
4836 buffer and the user tries to show it, ask whether to restore
4837 FILE, and if confirmed, do so and return t; else delete the
4838 buffer, clean up the state and return nil."
4842 t
4856 t)
4870 nil)))))
4873 "Return the number of category CAT in this todo file.
4874 The buffer-local variable `todo-category-number' holds this
4875 number as its value."
4878 ;; Increment by one, so that the number of the first
4879 ;; category is one rather than zero.
4884 "Return the name of the current category."
4888 "Display the current category correctly."
4890 cat-begin cat-end done-start done-sep-start done-end)
4907 nil t)
4917 ;; Now we want to see the done items, so reset displayed end to end of
4918 ;; done items.
4920 ;; Make display overlay for done items separator string, unless there
4921 ;; already is one.
4930 ;; Loading this from todo-mode, or adding it to the mode hook, causes
4931 ;; Emacs to hang in todo-item-start, at (looking-at todo-item-start).
4937 "Return count of TYPE items in CATEGORY.
4938 If CATEGORY is nil, default to the current category."
4948 "Change count of TYPE items in CATEGORY by integer INCREMENT.
4949 With nil or omitted CATEGORY, default to the current category."
4959 "Set `todo-categories' from the sexp at the top of the file."
4960 ;; New archive files created by `todo-move-category' are empty, which would
4961 ;; make the sexp test fail and raise an error, so in this case we skip it.
4975 "Update the `todo-categories' sexp at the top of the file."
4988 "Return an alist of todo categories and their item counts.
4989 With non-nil argument FORCE parse the entire file to build the
4990 list; otherwise, get the value by reading the sexp at the top of
4991 the file."
4998 ;; If the file is a todo file and has archived items, identify the
4999 ;; archive, in order to count its items. But skip this with
5000 ;; `todo-convert-legacy-files', since that converts filed items to
5001 ;; archived items.
5003 ;; If the file is an archive, it doesn't have an archive.
5012 ;; Counts for each category: [todo diary done archive]
5016 ;; Add archived item count to the todo file item counts.
5017 ;; Make sure to include newly created archives, e.g. due to
5018 ;; todo-move-category.
5052 ;; If first line is todo-categories list, use it and end loop
5053 ;; -- unless FORCEd to scan whole file.
5061 todo-categories)
5064 "Repair corrupt todo file categories sexp.
5065 This should only be needed as a consequence of careless manual
5066 editing or a bug in todo.el.
5068 *Warning*: Calling this command restores the category order to
5069 the list element order in the todo file categories sexp, so any
5070 order changes made in Todo Categories mode will have to be made
5071 again."
5077 "Signal an error if the current todo file is ill-formatted.
5078 Otherwise return t. Display a message if the file is well-formed
5079 but the categories sexp differs from the current value of
5080 `todo-categories'."
5089 ;; Check the first line for `todo-categories' sexp.
5097 ;; Check well-formedness of categories.
5110 ;; Warn user if categories sexp has changed.
5114 "If the sexp is wrong, you can fix it with "
5116 "but note this reverts any changes you have "
5118 t)
5121 "Move to start of current todo item and return its position."
5123 ;; Buffer is empty (invocation possible e.g. via todo-forward-item
5124 ;; from todo-filter-items when processing category with no todo
5125 ;; items).
5127 ;; Point is on the empty line below category's last todo item...
5134 ;; Buffer is widened.
5142 "Move to end of current todo item and return its position."
5143 ;; Items cannot end with a blank line.
5147 ;; For todo items, end is before the done items section, for done
5148 ;; items, end is before the next category. If these limits are
5149 ;; missing or inaccessible, end it before the end of the buffer.
5153 todo-category-beg
5154 todo-category-done)))
5155 nil t))
5162 ;; For last todo item, skip back over the empty line before the done
5163 ;; items section, else just back to the end of the previous line.
5168 "Return bare text of current item as a string."
5176 "Move point COUNT items down (by default, move down by one item)."
5183 ;; If points advances by one from a todo to a done item, go back
5184 ;; to the space above todo-done-separator, since that is a
5185 ;; legitimate place to insert an item. But skip this space if
5186 ;; count > 1, since that should only stop on an item.
5188 ;; (if (or (not count) (= count 1))
5190 ;; The preceding sexp is insufficient when buffer is not narrowed,
5191 ;; since there could be no done items in this category, so the
5192 ;; search puts us on first todo item of next category. Does this
5193 ;; ever happen? If so:
5194 ;; (let ((opoint) (point))
5195 ;; (forward-line -1)
5196 ;; (when (or (not count) (= count 1))
5197 ;; (cond ((looking-at (concat "^" (regexp-quote todo-category-beg)))
5198 ;; (forward-line -2))
5199 ;; ((looking-at (concat "^" (regexp-quote todo-category-done)))
5200 ;; (forward-line -1))
5201 ;; (t
5202 ;; (goto-char opoint)))))))
5205 "Move point up to start of item with next higher priority.
5206 With positive numerical prefix COUNT, move point COUNT items
5207 upward.
5209 If the category's done items are visible, this command called
5210 with a prefix argument only moves point to a higher item, e.g.,
5211 with point on the first done item and called with prefix 1, it
5212 moves to the last todo item; but if called with point on the
5213 first done item without a prefix argument, it moves point to the
5214 empty line above the done items separator."
5222 ;; If the item date-time header is hidden, the display engine
5223 ;; moves point to the next earlier displayable position, which
5224 ;; is the end of the next item above, so we move it to the start
5225 ;; of the current item's text (that's what the display engine
5226 ;; does with todo-forward-item in this case.)
5227 ;; FIXME: would it be better to use cursor-sensor-functions?
5229 ;; Unless this is a regexp filtered items buffer (which can contain
5230 ;; intermixed todo and done items), if points advances by one from a
5231 ;; done to a todo item, go back to the space above
5232 ;; todo-done-separator, since that is a legitimate place to insert an
5233 ;; item. But skip this space if count > 1, since that should only
5234 ;; stop on an item.
5236 ;(or (not count) (= count 1))
5239 nil t)
5243 "Internal function called in editing, deleting or moving items."
5246 ovs)
5253 "Return non-nil if item at point has diary entry format."
5259 ;; This duplicates the item locating code from diary-goto-entry, but
5260 ;; without the marker code, to test whether the latter is dispensable.
5261 ;; If it is, diary-goto-entry can be simplified. The code duplication
5262 ;; here can also be eliminated, leaving only the widening and category
5263 ;; selection, and instead of :override advice :around can be used.
5266 "Jump to the diary entry for the BUTTON at point.
5267 If the entry is a todo item, display its category properly.
5268 Overrides `diary-goto-entry'."
5269 ;; Locate the diary item in its source file.
5277 ;; If it's a Todo file, make sure it's in Todo mode.
5286 ;; If it's a todo item, determine its category and display the
5287 ;; category properly.
5292 nil t)
5300 "Call `revert-buffer', preserving buffer's current modes.
5301 Also preserve category display, if applicable."
5307 ;; revert-buffer--default calls after-find-file, which makes
5308 ;; buffer writable.
5329 "Return non-nil if item at point is a done item."
5335 "Return non-nil if point is in category's done items section."
5338 nil t)
5343 "Signal user error on marked done items.
5344 Helper function for editing commands that apply only to (possibly
5345 marked) not done todo items."
5362 "Replace existing overlays of done items separator string SEP."
5374 new-ov)
5383 "Return the overlay at point whose `todo' property has value VAL."
5385 ;; When headers are hidden, the display engine makes item's start
5386 ;; inaccessible to commands, so then we have to go there
5387 ;; non-interactively to check for prefix and header overlays.
5390 ;; Use overlays-in to find prefix overlays and check over two
5391 ;; positions to find done separator overlay.
5393 ov)
5401 "Non-nil if this item begins with `todo-item-mark'.
5402 In that case, return the item's prefix overlay."
5404 ;; If an item insertion command is called on a todo file
5405 ;; before it is visited, it has no prefix overlays yet, so
5406 ;; check for this.
5410 pref))))
5414 "Insert ITEM at point and update prefix and header overlays."
5419 ;; Insertion pushes item down but not its prefix overlay. When
5420 ;; the overlay includes a mark, this would now mark the inserted
5421 ;; ITEM, so move it to the pushed down item.
5424 ;; With hidden headers, todo-backward-item puts point on first
5425 ;; visible character after header, so we have to search backward.
5430 nil t)
5437 "Update the prefix overlays of the current category's items.
5438 The overlay's value is the string `todo-prefix' or with non-nil
5439 `todo-number-prefix' an integer in the sequence from 1 to
5440 the number of todo or done items in the category indicating the
5441 item's priority. Todo and done items are numbered independently
5442 of each other."
5447 todo-top-priorities-overrides))))
5449 todo-top-priorities-overrides))
5450 todo-top-priorities))
5451 done prefix)
5459 ;; Reset number to 1 for first done item.
5467 done t))
5471 todo-prefix)
5472 'face
5473 ;; Prefix of top priority items has a
5474 ;; distinct face in Todo mode.
5478 'todo-top-priority
5483 ;; Prefix overlay must be at a single position so its
5484 ;; bounds aren't changed when (re)moving an item.
5489 prefix))))
5492 ;; -----------------------------------------------------------------------------
5493 ;;; Generating and applying item insertion and editing key sequences
5494 ;; -----------------------------------------------------------------------------
5496 ;; Thanks to Stefan Monnier for suggesting dynamically generating item
5497 ;; insertion commands and their key bindings, and offering an elegant
5498 ;; implementation, which, however, relies on lexical scoping and so
5499 ;; cannot be used here until the Calendar code used by todo-mode.el is
5500 ;; converted to lexical binding. Hence, the following implementation
5501 ;; uses dynamic binding.
5505 "List of all item insertion parameters.
5506 Passed by `todo-insert-item' to `todo-insert-item--next-param' to
5523 "Return key paired with item insertion PARAM."
5527 "Return sublist of LIST whose first member corresponds to KEY."
5540 list)
5546 list))
5559 "Build list of arguments for item insertion and apply them.
5560 The list consists of item insertion parameters that can be passed
5561 as insertion command arguments in fixed positions. If a position
5562 in the list is not occupied by the corresponding parameter, it is
5563 occupied by nil."
5568 todo-insert-item--argsleft)))))
5570 args
5586 "Build item insertion command from LAST, ARGS and ARGSLEFT and call it.
5587 Dynamically generate key bindings, prompting with the keys
5588 already entered and those still available."
5600 "%s=>%s"
5604 name))))))
5634 todo-insert-item--argsleft))
5638 todo-insert-item--argsleft))))
5641 todo-insert-item--argsleft)))))))))
5644 todo-insert-item--keys-so-far prompt))
5699 todo-edit-item--date-param-key-alist arg)))
5711 ;; -----------------------------------------------------------------------------
5712 ;;; Todo minibuffer utilities
5713 ;; -----------------------------------------------------------------------------
5723 SPC to affirm the question only if option `todo-y-with-space' is
5724 non-nil."
5732 "Return a list of completions for `todo-read-category'.
5733 Each element of the list is a cons of a category name and the
5734 file or list of files (as short file names) it is in. The files
5735 are either the current (or if there is none, the default) todo
5736 file plus the files listed in `todo-category-completions-files',
5737 or, with non-nil ARCHIVE, the current archive file.
5739 Before calculating the completions, update the value of
5740 `todo-category-completions-files' in case any files named in it
5741 have been removed."
5754 names))
5762 todo-global-current-todo-file)
5766 todo-category-completions-files))
5768 listall listf)
5769 ;; If file was just added, it has no category completions.
5778 ;; Ensure category is properly displayed in case user
5779 ;; switches to file via a non-Todo mode command. And if
5780 ;; done items in category are visible, keep them visible.
5801 listf)))))
5804 "Choose and return the name of a todo file, prompting with PROMPT.
5806 Show completions with TAB or SPC; the names are shown in short
5807 form but the absolute truename is returned. With non-nil ARCHIVE
5808 return the absolute truename of a todo archive file. With non-nil
5809 MUSTMATCH the name of an existing file must be chosen;
5810 otherwise, a new file name is allowed."
5813 ;; (funcall todo-files-function archive)))
5817 ;; If user hit RET without
5818 ;; choosing a file, default to
5819 ;; current or default file.
5823 todo-global-current-todo-file)
5825 todo-default-todo-file)))
5826 ;; Trigger prompt for initial file.
5836 "Choose and return a category name, prompting with PROMPT.
5837 Show completions for existing categories with TAB or SPC.
5839 The argument MATCH-TYPE specifies the matching requirements on
5840 the category name: with the value `todo' or `archive' the name
5841 must complete to that of an existing todo or archive category,
5842 respectively; with the value `add' the name must not be that of
5843 an existing category; with all other values both existing and new
5844 valid category names are accepted.
5846 With non-nil argument FILE prompt for a file and complete only
5847 against categories in that file; otherwise complete against all
5848 categories from `todo-category-completions-files'."
5849 ;; Allow SPC to insert spaces, for adding new category names.
5854 map)))
5859 "n archive"
5862 archive t)))
5869 todo-categories)))
5873 todo-categories))
5875 completions)))
5879 ;; Unless we're adding a category via
5880 ;; todo-add-category, set default
5881 ;; for existing categories to the
5882 ;; current category of the chosen
5883 ;; file or else of the current file.
5888 todo-current-todo-file
5890 todo-default-todo-file)))
5892 ;; Trigger prompt for initial category.
5896 ;; If we do category completion and the chosen category name
5897 ;; occurs in more than one file, prompt to choose one file.
5901 catfil
5905 ;; Default to the current file.
5907 ;; First validate only a name passed interactively from
5908 ;; todo-add-category, which must be of a nonexistent category.
5910 ;; Validate only against completion categories.
5913 ;; When user enters a nonexistent category name by jumping or
5914 ;; moving, confirm that it should be added, then validate.
5922 ;; Restore point and narrowing after adding new
5923 ;; category, to avoid moving to beginning of file when
5924 ;; moving marked items to a new category
5925 ;; (todo-move-item).
5929 ;; If we decide not to add a category, exit without returning.
5934 "Prompt for new NAME for TYPE until it is valid, then return it.
5935 TYPE can be either of the symbols `file' or `category'."
5938 prompt)
5945 "Enter a non-empty file name: "
5946 ;; Empty string passed by todo-show to
5947 ;; prompt for initial todo file.
5952 "Enter a non-empty category name: "
5953 ;; Empty string passed by todo-show to
5954 ;; prompt for initial category of a new
5955 ;; todo file.
5968 files)
5970 categories)))
5971 ;; Offer default initial name.
5973 files
5974 categories)
5976 todo-initial-file
5977 todo-initial-category))))))
5978 name))
5980 ;; Adapted from calendar-read-date and calendar-date-string.
5982 "Prompt for Gregorian date and return it in the current format.
5984 With non-nil ARG, prompt for and return only the date component
5985 specified by ARG, which can be one of these symbols:
5986 `month' (prompt for name, return name or number according to
5987 value of `calendar-date-display-form'), `day' of month, or
5988 `year'. The value of each of these components can be `*',
5989 indicating an unspecified month, day, or year.
5991 When ARG is `day', non-nil arguments MO and YR determine the
5992 number of the last the day of the month."
5998 "Year (>0 or RET for this year or * for any year): "
6009 "Month name (RET for current month, * for any month): "
6010 mlist nil t nil nil
6020 ;; If month is unspecified, use a month with 31
6021 ;; days for checking day of month input. Does
6022 ;; Calendar do anything special when * is
6023 ;; currently a shorter month?
6025 ;; If year is unspecified, use a leap year to
6026 ;; allow Feb. 29.
6032 last)
6036 ;; Stringify read values (monthname is already a string).
6051 month
6052 monthname)))
6056 "Choose name of a day of the week with completion and return it."
6060 nil t)))
6063 "Prompt for and return a valid clock time as a string.
6065 Valid time strings are those matching `diary-time-regexp'.
6066 Typing `<return>' at the prompt returns the current time, if the
6067 user option `todo-always-add-time-string' is non-nil, otherwise
6068 the empty string (i.e., no time string)."
6077 answer))
6079 ;; -----------------------------------------------------------------------------
6080 ;;; Customization groups and utilities
6081 ;; -----------------------------------------------------------------------------
6084 "Create and maintain categorized lists of todo items."
6090 "User options for adding and editing todo items."
6095 "User options for Todo Categories mode."
6100 "User options for Todo Filter Items mode."
6105 "User display options for Todo mode."
6110 "Faces for the Todo modes."
6115 "The :set function for user option `todo-show-current-file'."
6122 "The :set function for `todo-prefix' and `todo-number-prefix'."
6129 ;; Activate the new setting in the current category.
6133 "The :set function for user option `todo-nondiary-marker'."
6138 ;; Need to reset these to get font-locking right.
6141 todo-date-string-start
6142 ;; See comment in defvar of `todo-date-string-start'.
6159 nil t)
6171 "The :set function for `todo-done-separator-string'."
6186 "The :set function for user option `todo-done-string'."
6191 ;; Need to reset this to get font-locking right.
6205 nil t)
6215 "The :set function for user option `todo-comment-string'."
6231 nil t)
6241 "The :set function for user option `todo-highlight-item'."
6257 "Update defcustoms that provide choice list of todo files."
6263 ;; -----------------------------------------------------------------------------
6264 ;;; Font locking
6265 ;; -----------------------------------------------------------------------------
6268 "Search for todo item nondiary markers within LIM for font-locking."
6272 lim t))
6275 "Search for diary nonmarking symbol within LIM for font-locking."
6278 lim t))
6281 "Search for todo item date string within LIM for font-locking."
6286 "Search for todo item time string within LIM for font-locking."
6289 lim t))
6292 "Search for expired diary item date within LIM for font-locking."
6297 lim t)
6300 ;; Function days-between requires a non-empty time string.
6307 "Search for done todo item header within LIM for font-locking."
6310 lim t))
6313 "Search for done todo item comment within LIM for font-locking."
6315 lim t))
6318 "Search for todo category name within LIM for font-locking.
6319 This is for fontifying category and file names appearing in Todo
6320 Filtered Items mode following done items."
6324 ;; Use non-greedy operator to prevent
6325 ;; capturing possible following non-diary
6326 ;; date string.
6328 lim t)))
6331 "Search for todo category name within LIM for font-locking.
6332 This is for fontifying category and file names appearing in Todo
6333 Filtered Items mode following todo (not done) items."
6339 lim t)))
6353 ;; diary-lib.el uses font-lock-constant-face for diary-nonmarking-symbol.
6363 )
6366 ;; -----------------------------------------------------------------------------
6367 ;;; Key binding
6368 ;; -----------------------------------------------------------------------------
6371 `(
6404 )
6408 `(
6430 )
6434 `(
6439 )
6443 `(
6447 )
6460 map)
6471 map)
6478 map)
6494 (define-key map [backtab] 'todo-previous-button)
6495 (define-key map "q" 'todo-quit)
6496 map)
6497 "Todo Categories mode keymap.")
6499 (defvar todo-filtered-items-mode-map
6500 (let ((map (make-sparse-keymap)))
6501 (dolist (kb todo-key-bindings-t+a+f)
6502 (define-key map (nth 0 kb) (nth 1 kb)))
6503 (dolist (kb todo-key-bindings-t+f)
6504 (define-key map (nth 0 kb) (nth 1 kb)))
6505 (define-key map "g" 'todo-go-to-source-item)
6506 (define-key map [remap newline] 'todo-go-to-source-item)
6507 map)
6508 "Todo Filtered Items mode keymap.")
6510 (easy-menu-define
6511 todo-menu todo-mode-map "Todo Menu"
6512 '("Todo"
6513 ("Navigation"
6514 ["Next Item" todo-next-item t]
6515 ["Previous Item" todo-previous-item t]
6516 "---"
6517 ["Next Category" todo-forward-category t]
6518 ["Previous Category" todo-backward-category t]
6519 ["Jump to Another Category" todo-jump-to-category t]
6520 "---"
6521 ["Visit Another Todo File" todo-show t]
6522 ["Visit Archive" todo-find-archive t]
6523 ["Visit Filtered Items File" todo-find-filtered-items-file t]
6524 )
6525 ("Editing"
6526 ["Insert New Item" todo-insert-item t]
6527 ["Edit Item" todo-edit-item t]
6528 ["Lower Item Priority" todo-lower-item-priority t]
6529 ["Raise Item Priority" todo-raise-item-priority t]
6530 ["Set Item Priority" todo-set-item-priority t]
6531 ["Mark/Unmark Item" todo-toggle-mark-item t]
6532 ["Move (Recategorize) Item" todo-move-item t]
6533 ["Delete Item" todo-delete-item t]
6534 ["Mark and Bury Done Item" todo-item-done t]
6535 ["Undo Done Item" todo-item-undone t]
6536 ["Archive Done Item" todo-archive-done-item t]
6537 "---"
6538 ["Add New Category" todo-add-category t]
6539 ["Rename Current Category" todo-rename-category t]
6540 ["Delete Current Category" todo-delete-category t]
6541 ["Move Current Category" todo-move-category t]
6542 ["Merge Current Category" todo-merge-category t]
6543 "---"
6544 ["Add New Todo File" todo-add-file t]
6545 ["Rename Todo File" todo-rename-file t]
6546 ["Delete Todo File" todo-delete-file t]
6547 ["Edit Todo File" todo-edit-file t]
6548 )
6549 ("Searching and Item Filtering"
6550 ["Search Todo File" todo-search t]
6551 ["Clear Match Highlighting" todo-clear-matches t]
6552 "---"
6553 ["Set Top Priorities in File" todo-set-top-priorities-in-file t]
6554 ["Set Top Priorities in Category" todo-set-top-priorities-in-category t]
6555 ["Filter Top Priorities" todo-filter-top-priorities t]
6556 ["Filter Multifile Top Priorities" todo-filter-top-priorities-multifile t]
6557 ["Filter Diary Items" todo-filter-diary-items t]
6558 ["Filter Multifile Diary Items" todo-filter-diary-items-multifile t]
6559 ["Filter Regexp" todo-filter-regexp-items t]
6560 ["Filter Multifile Regexp" todo-filter-regexp-items-multifile t]
6561 )
6562 ("Display and Printing"
6563 ["Show/Hide Done Items" todo-toggle-view-done-items t]
6564 ["Show/Hide Done Items Only" todo-toggle-view-done-only t]
6565 ["Show/Hide Item Highlighting" todo-toggle-item-highlighting t]
6566 ["Show/Hide Item Numbering" todo-toggle-prefix-numbers t]
6567 ["Show/Hide Item Header" todo-toggle-item-header t]
6568 "---"
6569 ["Display Table of Categories" todo-show-categories-table t]
6570 "---"
6571 ["Print Category" todo-print-buffer t]
6572 ["Print Category to File" todo-print-buffer-to-file t]
6573 )
6574 "---"
6575 ["Save Todo File" todo-save t]
6576 ["Quit Todo Mode" todo-quit t]
6577 ))
6579 ;; -----------------------------------------------------------------------------
6580 ;;; Hook functions and mode definitions
6581 ;; -----------------------------------------------------------------------------
6583 (defun todo-show-current-file ()
6584 "Visit current instead of default todo file with `todo-show'.
6585 Added to `pre-command-hook' in Todo mode when user option
6586 `todo-show-current-file' is set to non-nil."
6587 (setq todo-global-current-todo-file todo-current-todo-file))
6589 ;; (defun todo-display-as-todo-file ()
6590 ;; "Show todo files correctly when visited from outside of Todo mode.
6591 ;; Added to `find-file-hook' in Todo mode and Todo Archive mode."
6592 ;; (and (member this-command todo-visit-files-commands)
6593 ;; (= (- (point-max) (point-min)) (buffer-size))
6594 ;; (member major-mode '(todo-mode todo-archive-mode))
6595 ;; (todo-category-select)))
6597 ;; (defun todo-add-to-buffer-list ()
6598 ;; "Add name of just visited todo file to `todo-file-buffers'.
6599 ;; This function is added to `find-file-hook' in Todo mode."
6600 ;; (let ((filename (file-truename (buffer-file-name))))
6601 ;; (when (member filename todo-files)
6602 ;; (add-to-list 'todo-file-buffers filename))))
6604 (defun todo-update-buffer-list ()
6605 "Make current Todo mode buffer file car of `todo-file-buffers'.
6606 This function is added to `post-command-hook' in Todo mode."
6607 (let ((filename (file-truename (buffer-file-name))))
6608 (unless (eq (car todo-file-buffers) filename)
6609 (setq todo-file-buffers
6610 (cons filename (delete filename todo-file-buffers))))))
6612 (defun todo-reset-global-current-todo-file ()
6613 "Update the value of `todo-global-current-todo-file'.
6614 This becomes the latest existing todo file or, if there is none,
6615 the value of `todo-default-todo-file'.
6616 This function is added to `kill-buffer-hook' in Todo mode."
6617 (let ((filename (file-truename (buffer-file-name))))
6618 (setq todo-file-buffers (delete filename todo-file-buffers))
6619 (setq todo-global-current-todo-file
6620 (or (car todo-file-buffers)
6621 (todo-absolute-file-name todo-default-todo-file)))))
6623 (defun todo-reset-and-enable-done-separator ()
6624 "Show resized done items separator overlay after window change.
6625 Added to `window-configuration-change-hook' in Todo mode."
6626 (when (= 1 (length todo-done-separator-string))
6627 (let ((sep todo-done-separator))
6628 (setq todo-done-separator (todo-done-separator))
6629 (save-match-data (todo-reset-done-separator sep)))))
6631 (defun todo-modes-set-1 ()
6632 "Make some settings that apply to multiple Todo modes."
6633 (setq-local font-lock-defaults '(todo-font-lock-keywords t))
6634 (setq-local revert-buffer-function #'todo-revert-buffer)
6635 (setq-local tab-width todo-indent-to-here)
6636 (setq-local indent-line-function #'todo-indent)
6637 (when todo-wrap-lines
6638 (visual-line-mode)
6639 (setq wrap-prefix (make-string todo-indent-to-here 32))))
6641 (defun todo-hl-line-range ()
6642 "Make `todo-toggle-item-highlighting' highlight entire item."
6643 (save-excursion
6644 (when (todo-item-end)
6645 (cons (todo-item-start)
6646 (todo-item-end)))))
6648 (defun todo-modes-set-2 ()
6649 "Make some settings that apply to multiple Todo modes."
6650 (add-to-invisibility-spec 'todo)
6651 (setq buffer-read-only t)
6652 (setq-local todo--item-headers-hidden nil)
6653 (setq-local desktop-save-buffer 'todo-desktop-save-buffer)
6654 (setq-local hl-line-range-function #'todo-hl-line-range))
6656 (defun todo-modes-set-3 ()
6657 "Make some settings that apply to multiple Todo modes."
6658 (setq-local todo-categories (todo-set-categories))
6659 (setq-local todo-category-number 1)
6660 ;; (add-hook 'find-file-hook #'todo-display-as-todo-file nil t)
6661 )
6663 (put 'todo-mode 'mode-class 'special)
6665 ;;;###autoload
6666 (define-derived-mode todo-mode special-mode "Todo"
6667 "Major mode for displaying, navigating and editing todo lists.
6670 (if (called-interactively-p 'any)
6671 (message "%s"
6672 (substitute-command-keys
6674 (todo-modes-set-1)
6675 (todo-modes-set-2)
6676 (todo-modes-set-3)
6677 ;; Initialize todo-current-todo-file.
6678 (when (member (file-truename (buffer-file-name))
6679 (funcall todo-files-function))
6680 (setq-local todo-current-todo-file (file-truename (buffer-file-name))))
6681 (setq-local todo-show-done-only nil)
6682 (setq-local todo-categories-with-marks nil)
6683 ;; (add-hook 'find-file-hook #'todo-add-to-buffer-list nil t)
6684 (add-hook 'post-command-hook #'todo-update-buffer-list nil t)
6685 (when todo-show-current-file
6686 (add-hook 'pre-command-hook #'todo-show-current-file nil t))
6687 (add-hook 'window-configuration-change-hook
6688 #'todo-reset-and-enable-done-separator nil t)
6689 (add-hook 'kill-buffer-hook #'todo-reset-global-current-todo-file nil t)))
6691 (put 'todo-archive-mode 'mode-class 'special)
6693 ;; If todo-mode is parent, all todo-mode key bindings appear to be
6694 ;; available in todo-archive-mode (e.g. shown by C-h m).
6695 ;;;###autoload
6696 (define-derived-mode todo-archive-mode special-mode "Todo-Arch"
6697 "Major mode for archived todo categories.
6700 (todo-modes-set-1)
6701 (todo-modes-set-2)
6702 (todo-modes-set-3)
6703 (setq-local todo-current-todo-file (file-truename (buffer-file-name)))
6704 (setq-local todo-show-done-only t))
6706 (defun todo-mode-external-set ()
6707 "Set `todo-categories' externally to `todo-current-todo-file'."
6708 (setq-local todo-current-todo-file todo-global-current-todo-file)
6709 (let ((cats (with-current-buffer
6710 ;; Can't use find-buffer-visiting when
6711 ;; `todo-show-categories-table' is called on first
6712 ;; invocation of `todo-show', since there is then
6713 ;; no buffer visiting the current file.
6714 (find-file-noselect todo-current-todo-file 'nowarn)
6715 (or todo-categories
6716 ;; In Todo Edit mode todo-categories is now nil
6717 ;; since it uses same buffer as Todo mode but
6718 ;; doesn't have the latter's local variables.
6719 (save-excursion
6720 (goto-char (point-min))
6721 (read (buffer-substring-no-properties
6722 (line-beginning-position)
6723 (line-end-position))))))))
6724 (setq-local todo-categories cats)))
6726 (define-derived-mode todo-edit-mode text-mode "Todo-Ed"
6727 "Major mode for editing multiline todo items.
6730 (todo-modes-set-1)
6731 (todo-mode-external-set)
6732 (setq buffer-read-only nil))
6734 (put 'todo-categories-mode 'mode-class 'special)
6736 (define-derived-mode todo-categories-mode special-mode "Todo-Cats"
6737 "Major mode for displaying and editing todo categories.
6740 (todo-mode-external-set))
6742 (put 'todo-filtered-items-mode 'mode-class 'special)
6744 ;;;###autoload
6745 (define-derived-mode todo-filtered-items-mode special-mode "Todo-Fltr"
6746 "Mode for displaying and reprioritizing top priority Todo.
6749 (todo-modes-set-1)
6750 (todo-modes-set-2))
6752 ;; -----------------------------------------------------------------------------
6753 (provide 'todo-mode)
6755 ;;; todo-mode.el ends here