| blob | 7d01fe31fb21a88ba9f37dd5c197b5915e755062 |
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.
197 todo-month-name-array
198 todo-month-abbrev-array)))
206 ;; By itself this matches anything, because of the `?'; however, it's only
207 ;; used in the context of `todo-date-pattern' (but Emacs Lisp lacks
208 ;; lookahead).
215 "Identifying string appended to the front of done todo items."
227 todo-date-pattern)
230 ;; -----------------------------------------------------------------------------
231 ;;; Todo mode display options
232 ;; -----------------------------------------------------------------------------
235 "String prefixed to todo items for visual distinction."
240 widget :error
243 widget)))
249 "Non-nil to prefix items with consecutively increasing integers.
250 These reflect the priorities of the items in each category."
257 "Return a mode line control for todo or archive file buffers.
258 Argument CAT is the name of the current todo category.
259 This function is the value of the user variable
260 `todo-mode-line-function'."
265 "Function that returns a mode line control for Todo mode buffers.
266 The function expects one argument holding the name of the current
267 todo category. The resulting control becomes the local value of
268 `mode-line-buffer-identification' in each Todo mode buffer."
273 "Non-nil means highlight items at point."
280 "Non-nil to activate Visual Line mode and use wrap prefix."
285 "Number of spaces to indent continuation lines of items.
286 This must be a positive number to ensure such items are fully
287 shown in the Fancy Diary display."
293 widget)))
297 "Indent from point to `todo-indent-to-here'."
301 "Non-nil to display done items in all categories."
305 ;; -----------------------------------------------------------------------------
306 ;;; Faces
307 ;; -----------------------------------------------------------------------------
311 "Face for making keys in item insertion prompt stand out."
315 ;; '((t :inherit font-lock-warning-face))
337 "Face for marks on marked items."
341 ;; '((t :inherit font-lock-constant-face))
352 "Face for todo item prefix or numerical priority string."
356 ;; bold font-lock-comment-face
367 "Face for top priority todo item numerical priority string.
368 The item's priority number string has this face if the number is
369 less than or equal the category's top priority setting."
373 ;; '((t :inherit font-lock-type-face))
382 "Face for non-diary markers around todo item date/time header."
387 "Face for the date string of a todo item."
392 "Face for the time string of a todo item."
396 ;; Doesn't contrast enough with todo-date (= diary) face.
397 ;; ;; '((t :inherit warning))
398 ;; '((default :weight bold)
399 ;; (((class color) (min-colors 16)) :foreground "DarkOrange")
400 ;; (((class color)) :foreground "yellow"))
401 ;; bold font-lock-function-name-face
409 "Face for expired dates of diary items."
413 ;; '((t :inherit font-lock-builtin-face))
422 "Face for separator string between done and not done todo items."
426 ;; '((t :inherit font-lock-keyword-face))
435 "Face for done todo item header string."
439 ;; '((t :inherit font-lock-comment-face))
457 "Face for comments appended to done todo items."
461 ;; '((t :inherit match))
483 "Face for matches found by `todo-search'."
487 ;; '((t :inherit widget-field))
498 "Face for buttons in table of categories."
512 "Face for sorted column in table of categories."
516 ;; '((t (:inherit (shadow))))
525 "Face for archived-only category names in table of categories."
529 ;; '((t :inherit font-lock-type-face))
538 "Face for category-file header in Todo Filtered Items mode."
541 ;; -----------------------------------------------------------------------------
542 ;;; Entering and exiting
543 ;; -----------------------------------------------------------------------------
545 ;; (defcustom todo-visit-files-commands (list 'find-file 'dired-find-file)
546 ;; "List of file finding commands for `todo-display-as-todo-file'.
547 ;; Invoking these commands to visit a todo file or todo archive file
548 ;; calls `todo-show' or `todo-find-archive', so that the file is
549 ;; displayed correctly."
550 ;; :type '(repeat function)
551 ;; :group 'todo)
554 "Return the short form of todo file FILE's name.
555 This lacks the extension and directory components."
565 "Todo file visited by first session invocation of `todo-show'."
571 "Non-nil to make `todo-show' visit the current todo file.
572 Otherwise, `todo-show' always visits `todo-default-todo-file'."
579 "What action to take on first use of `todo-show' on a file."
588 "Non-nil to prompt for an item after adding a new category."
593 "Default file name offered on adding first todo file."
598 "Default category name offered on initializing a new todo file."
603 "List of files for building `todo-read-category' completions."
608 "Non-nil means case is ignored by `todo-read-*' functions."
612 ;;;###autoload
614 "Visit a todo file and display one of its categories.
616 When invoked in Todo mode, Todo Archive mode or Todo Filtered
617 Items mode, or when invoked anywhere else with a prefix argument,
618 prompt for which todo file to visit. When invoked outside of a
619 Todo mode buffer without a prefix argument, visit
620 `todo-default-todo-file'. Subsequent invocations from outside of
621 Todo mode revisit this file or, with option
622 `todo-show-current-file' non-nil (the default), whichever todo
623 file was last visited.
625 If you call this command before you have created any todo file in
626 the current format, and you have a todo file in old format, it
627 will ask you whether to convert that file and show it.
628 Otherwise, calling this command before any todo file exists
629 prompts for a file name and an initial category (defaulting to
630 `todo-initial-file' and `todo-initial-category'), creates both of
631 these, visits the file and displays the category, and if option
632 `todo-add-item-if-new-category' is non-nil (the default), prompts
633 for the first item.
635 The first invocation of this command on an existing todo file
636 interacts with the option `todo-show-first': if its value is
637 `first' (the default), show the first category in the file; if
638 its value is `table', show the table of categories in the file;
639 if its value is one of `top', `diary' or `regexp', show the
640 corresponding saved top priorities, diary items, or regexp items
641 file, if any. Subsequent invocations always show the file's
642 current (i.e., last displayed) category.
644 In Todo mode just the category's unfinished todo items are shown
645 by default. The done items are hidden, but typing
647 items. With non-nil user option `todo-show-with-done' both todo
648 and done items are always shown on visiting a category."
653 ;; Before initializing the first todo first, check if there is a
654 ;; legacy todo file and if so, offer to convert to the current
655 ;; format and make it the first new todo file.
658 todo-file-do
671 todo-archive-mode
672 todo-filtered-items-mode))))
675 nil t)
678 ;; Called noninteractively via todo-quit
679 ;; to jump to corresponding category in
680 ;; todo file.
688 todo-global-current-todo-file)
691 add-item first-file)
693 ;; We just initialized the first todo file, so make it the default.
695 first-file t)
699 ;; Can't setq t-c-t-f here, otherwise wrong file shown when
700 ;; todo-show is called from todo-show-categories-table.
707 shortf todo-show-first)))
715 "Choose a regexp items file: "
716 rxf)
732 shortf)
737 ;; If todo-show is called from the minibuffer, don't visit
738 ;; the todo file there.
745 ;; When quitting an archive file, show the corresponding
746 ;; category in the corresponding todo file, if it exists.
749 ;; If this is a new todo file, add its first category.
751 ;; Don't confuse an erased buffer with a fresh buffer for
752 ;; adding a new todo file -- it might have been erased by
753 ;; mistake or due to a bug (e.g. Bug#20832).
760 add-item todo-add-item-if-new-category
761 cat-added t)
763 ;; If the category was added, save the file now, so we
764 ;; don't risk having an empty todo file, which would
765 ;; signal an error if we tried to visit it later,
766 ;; since doing that looks for category boundaries.
768 ;; If user cancels before adding the category, clean up
769 ;; and exit, so we have a fresh slate the next time.
771 ;; (setq todo-files (funcall todo-files-function))
775 todo-current-todo-file nil)
786 "Save the current todo file."
797 "Exit the current Todo-related buffer.
798 Depending on the specific mode, this either kills the buffer or
799 buries it and restores state as needed."
803 ;; Postpone killing buffer till after calling todo-show, to
804 ;; prevent killing todo-mode buffer.
806 ;; Ensure todo-show calls todo-show-categories-table only on
807 ;; first invocation per file.
816 ;; Have to write a newly created archive to file to avoid
817 ;; subsequent errors.
825 ;; When todo-check-file runs in todo-show, it kills the
826 ;; buffer if the archive file was deleted externally.
832 ;; -----------------------------------------------------------------------------
833 ;;; Navigation between and within categories
834 ;; -----------------------------------------------------------------------------
837 "Non-nil to handle categories with only archived items specially.
841 archived items. Other commands still recognize these categories.
843 categories shown in `todo-archived-only' face and pressing the
844 category button visits the category in the archive instead of the
845 todo file."
850 "Visit the numerically next category in this todo file.
851 If the current category is the highest numbered, visit the first
852 category. With non-nil argument BACK, visit the numerically
853 previous category (the highest numbered one, if the current
854 category is the first)."
870 "Visit the numerically previous category in this todo file.
871 If the current category is the highest numbered, visit the first
872 category."
879 "Prompt for a category in a todo file and jump to it.
881 With non-nil FILE (interactively a prefix argument), prompt for a
882 specific todo file and choose (with TAB completion) a category
883 in it to jump to; otherwise, choose and jump to any category in
884 either the current todo file or a file in
885 `todo-category-completions-files'.
887 Also accept a non-existing category name and ask whether to add a
888 new category by that name; on confirmation, add it and jump to
889 that category, and if option `todo-add-item-if-new-category' is
890 non-nil (the default), then prompt for the first item.
892 In noninteractive calls non-nil WHERE specifies either the goal
893 category or its file. If its value is `archive', the choice of
894 categories is restricted to the current archive file or the
895 archive you were prompted to choose; this is used by
896 `todo-jump-to-archive-category'. If its value is the name of a
897 category, jump directly to that category; this is used in Todo
898 Categories mode."
900 ;; If invoked outside of Todo mode and there is not yet any Todo
901 ;; file, initialize one.
907 todo-skip-archived-categories
913 ;; If the category has only archived items and
914 ;; `todo-skip-archived-categories' is non-nil, jump to
915 ;; the archive category.
918 ;; Otherwise, jump to the category in the todo file.
919 todo-current-todo-file)))
942 "Move point down to the beginning of the next item.
943 With positive numerical prefix COUNT, move point COUNT items
944 downward.
946 If the category's done items are hidden, this command also moves
947 point to the empty line below the last todo item from any higher
948 item in the category, i.e., when invoked with or without a prefix
949 argument. If the category's done items are visible, this command
950 called with a prefix argument only moves point to a lower item,
951 e.g., with point on the last todo item and called with prefix 1,
952 it moves point to the first done item; but if called with point
953 on the last todo item without a prefix argument, it moves point
954 to the empty line above the done items separator."
956 ;; It's not worth the trouble to allow prefix arg value < 1, since
957 ;; we have the corresponding command.
966 "Move point up to start of item with next higher priority.
967 With positive numerical prefix COUNT, move point COUNT items
968 upward.
970 If the category's done items are visible, this command called
971 with a prefix argument only moves point to a higher item, e.g.,
972 with point on the first done item and called with prefix 1, it
973 moves to the last todo item; but if called with point on the
974 first done item without a prefix argument, it moves point to the
975 empty line above the done items separator."
977 ;; Avoid moving to bob if on the first item but not at bob.
979 ;; It's not worth the trouble to allow prefix arg value < 1, since
980 ;; we have the corresponding command.
988 ;; -----------------------------------------------------------------------------
989 ;;; Display toggle commands
990 ;; -----------------------------------------------------------------------------
993 "Hide item numbering if shown, show if hidden."
1008 "Show hidden or hide visible done items in current category."
1018 ;; If start of done items sections is below the bottom of the
1019 ;; window, make it visible.
1030 "Switch between displaying only done or only todo items."
1037 "Highlight or unhighlight the todo item the cursor is on."
1050 "Hide or show item date-time headers in the current file.
1051 With done items, this hides only the done date-time string, not
1052 the original date-time string."
1075 nil t)
1082 ;; -----------------------------------------------------------------------------
1083 ;;; File and category editing
1084 ;; -----------------------------------------------------------------------------
1087 "Name and initialize a new todo file.
1088 Interactively, prompt for a category and display it, and if
1089 option `todo-add-item-if-new-category' is non-nil (the default),
1090 prompt for the first item.
1091 Noninteractively, return the name of the new file."
1096 ;; Don't accept the name of an existing todo file.
1109 ;; Since buffer is not yet in todo-mode, we need to
1110 ;; explicitly make todo-current-todo-file buffer local.
1113 file)))
1116 "Rename the current todo file.
1117 With prefix ARG, prompt for a todo file and rename it.
1118 If there are corresponding archive or filtered items files,
1119 rename these accordingly. If there are live buffers visiting
1120 these files, also rename them accordingly."
1124 nil t))
1132 t)))
1163 "Delete the current todo, archive or filtered items file.
1164 If the todo file has a corresponding archive file, or vice versa,
1165 prompt whether to delete that as well. Also kill the buffers
1166 visiting the deleted files."
1196 ;; If we deleted an archive but not its todo file, update the
1197 ;; latter's category sexp.
1228 file1-sn))))
1234 "Put current buffer in `todo-edit-mode'.
1235 This makes the entire file visible and the buffer writable and
1236 you can use the self-insertion keys and standard Emacs editing
1237 commands to make changes. To return to Todo mode, type
1239 an error if the format has become invalid. However, this check
1240 cannot tell if the number of items changed, which could result in
1241 the file containing inconsistent information. For this reason
1242 this command should be used with caution."
1250 Type %s to return to Todo%s 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
1260 Categories').
1261 "
1268 "Add a new category to a todo file.
1270 Called interactively with prefix argument FILE, prompt for a file
1271 and then for a new category to add to that file, otherwise prompt
1272 just for a category to add to the current todo file. After
1273 adding the category, visit it in Todo mode and if option
1274 `todo-add-item-if-new-category' is non-nil (the default), prompt
1275 for the first item.
1277 Non-interactively, add category CAT to file FILE; if FILE is nil,
1278 add CAT to the current todo file. After adding the category,
1279 return the new category number."
1282 ;; If cat is passed from caller, don't prompt, unless it is "",
1283 ;; which means the file was just added and has no category yet.
1286 todo-current-todo-file))
1289 file))
1293 file)))
1306 ;; If invoked by user, display the newly added category, if
1307 ;; called programmatically return the category number to the
1308 ;; caller.
1315 num))))
1318 "Rename current todo category.
1319 If this file has an archive containing this category, rename the
1320 category there as well."
1343 nil t)
1349 "Delete current todo category provided it contains no items.
1350 With prefix ARG delete the category even if it does contain
1351 todo or done items."
1372 "after deleting the todo category. "
1374 "(see `todo-skip-archived-categories' "
1385 nil t))
1389 nil t)
1395 ;; If deleted category was the only one, delete the file.
1398 ;; Skip confirming killing the archive buffer if it has been
1399 ;; modified and not saved.
1405 todo-categories))
1414 "Move current category to a different todo file.
1415 If the todo file chosen does not exist, it is created.
1416 If the current category has archived items, also move those to
1417 the archive of the file moved to, creating it if it does not exist."
1430 new)
1442 ;; Make sure archive file is in Todo Archive mode so that
1443 ;; todo-categories has correct value.
1454 nil t))
1462 buffer-read-only)
1463 ;; Move the category to the new file. Also update or create
1464 ;; archive file if necessary.
1467 ;; Regenerate todo-archives in case there
1468 ;; is a newly created archive.
1471 nfile))
1479 nfile-short)
1482 buffer-read-only)
1486 ;; If the file moved to has a category with the same
1487 ;; name, rename the moved category.
1493 ;; Replace old with new name in todo and archive files.
1499 nil t)
1505 ;; Delete existing sexp.
1507 ;; Otherwise, file is new, so make space for categories sexp.
1510 ;; Insert (new or updated) sexp.
1512 ;; If archive was just created, save it to avoid "File
1513 ;; <xyz> no longer exists!" message on invoking
1514 ;; `todo-view-archived-items'.
1519 ;; Delete the category from the old file, and if that was the
1520 ;; last category, delete the file. Also handle archive file
1521 ;; if necessary.
1525 ;; Put point after todo-categories sexp.
1529 ;; Skip confirming killing the archive buffer.
1536 todo-categories))
1545 "Merge current category into another existing category.
1547 With prefix argument FILE, prompt for a specific todo file and
1548 choose (with TAB completion) a category in it to merge into;
1549 otherwise, choose and merge into a category in either the
1550 current todo file or a file in `todo-category-completions-files'.
1552 After merging, the source category's todo and done items are
1553 appended to the chosen goal category's todo and done items,
1554 respectively. The goal category becomes the current category,
1555 and the source category is deleted.
1557 If both the source and goal categories also have archived items,
1558 they are also merged. If only the source category has archived
1559 items, the goal category is added as a new category to the
1560 archive file and the source category is deleted."
1570 here)
1583 ;; Omit empty line between todo and done items.
1596 ;; Merge into goal todo category.
1602 ;; Merge any todo items.
1606 nil t)
1613 ;; Merge any done items.
1617 nil t)
1624 ;; Update and clean up source todo file.
1628 todo-categories))
1644 nil t)
1655 ;; Merge into goal archive category, if it exists, else create it.
1661 nil t)
1667 nil t))
1673 ;; Update and clean up source archive file.
1678 ;; Update goal todo file for merged archived items and display it.
1684 ;; If there are only merged done items, show them.
1687 ;; Put point on the first merged item.
1691 ;; -----------------------------------------------------------------------------
1692 ;;; Item editing
1693 ;; -----------------------------------------------------------------------------
1696 "Non-nil to allow new todo items to be included in the diary."
1701 "Non-nil to insert new todo diary items as nonmarking by default.
1702 This appends `diary-nonmarking-symbol' to the front of an item on
1703 insertion provided it doesn't begin with `todo-nondiary-marker'."
1708 "Non-nil adds current time to a new item's date header by default.
1710 argument, this reverses the effect of
1711 `todo-always-add-time-string': if t, these commands omit the
1712 current time, if nil, they include it."
1717 "Non-nil to enable inserting only highlighted region as new item."
1722 "Default priority of new and moved items."
1728 "String used to mark items.
1729 To ensure item marking works, change the value of this option
1730 only when no items are marked."
1735 widget :error
1738 widget)))
1744 "String inserted before optional comment appended to done item."
1751 "Whether to omit done item comment on undoing the item.
1752 Nil means never omit the comment, t means always omit it, `ask'
1753 means prompt user and omit comment only on confirmation."
1760 "Mark item with `todo-item-mark' if unmarked, otherwise unmark it.
1761 With positive numerical prefix argument N, change the marking of
1762 the next N items in the current category. If both the todo and
1763 done items sections are visible, the sequence of N items can
1764 consist of the last todo items and the first done items."
1789 ;; Don't try to mark the empty lines at the end of the todo
1790 ;; and done items sections.
1797 "Mark all visible items in this category with `todo-item-mark'."
1805 ;; When done items are shown and there are no todo items, the
1806 ;; loop starts on the empty line in the todo items sections,
1807 ;; which has no overlay, so don't try to get it.
1815 ;; Don't try to mark the empty line between the todo and done
1816 ;; items sections.
1822 "Remove `todo-item-mark' from all visible items in this category."
1830 ;; See comment above in `todo-mark-category'.
1844 "Choose an item insertion operation and carry it out.
1845 This inserts a new todo item into a category.
1847 With no prefix argument ARG, add the item to the current
1848 category; with one prefix argument (`C-u'), prompt for a category
1849 from the current todo file; with two prefix arguments (`C-u
1850 C-u'), first prompt for a todo file, then a category in that
1851 file. If a non-existing category is entered, ask whether to add
1852 it to the todo file; if answered affirmatively, add the category
1853 and insert the item there.
1855 There are a number of item insertion parameters which can be
1856 combined by entering specific keys to produce different insertion
1857 commands. After entering each key, a message shows which have
1858 already been entered and which remain available. See
1859 `(todo-mode) Inserting New Items' for details of the parameters,
1860 their associated keys and their effects."
1865 "Function implementing the core of `todo-insert-item'."
1866 ;; If invoked outside of Todo mode and there is not yet any Todo
1867 ;; file, initialize one.
1873 diary-item)
1881 ;; Point is on done items separator.
1902 todo-global-current-todo-file)
1904 todo-default-todo-file))))))
1922 ;; If user exits Calendar before choosing
1923 ;; a date, cancel item insertion.
1939 ;; If this command was invoked outside of a Todo mode buffer,
1940 ;; the call to todo-current-category above returned nil. If
1941 ;; we just entered Todo mode now, then cat was set to the
1942 ;; file's first category, but if todo-mode was already
1943 ;; enabled, cat did not get set, so we have to do that.
1950 done-only item-added)
1953 ;; Add date, time and diary marking as required.
1956 todo-nondiary-start
1959 diary-nonmarking-symbol))
1962 time-string))))
1966 todo-nondiary-end)
1968 ;; Indent newlines inserted by C-q C-j if nonspace char follows.
1973 ;; If we just visited the file, no category is selected yet.
1977 ;; If only done items are displayed in category,
1978 ;; toggle to todo items before inserting new item.
1988 ;; If user cancels before setting priority, restore
1989 ;; display.
1998 ;; If the todo items section is not visible when the
1999 ;; insertion command is called (either because only done
2000 ;; items were shown or because the category was not in the
2001 ;; current buffer), then if the item is inserted at the
2002 ;; end of the category, point is at eob and eob at
2003 ;; window-start, so that higher priority todo items are
2004 ;; out of view. So we recenter to make sure the todo
2005 ;; items are displayed in the window.
2013 "Return string of date chosen from Calendar."
2016 todo-date-from-calendar)
2021 ;; If user exits Calendar before choosing a date, clean up properly.
2035 todo-date-from-calendar)
2040 todo-date-from-calendar)))))
2043 "Prompt for and insert a new item with date selected from calendar.
2044 Invoked without prefix argument ARG, insert the item into the
2045 current category, without one prefix argument, prompt for the
2046 category from the current todo file or from one listed in
2047 `todo-category-completions-files'; with two prefix arguments,
2048 prompt for a todo file and then for a category in it."
2058 "Delete at least one item in this category.
2059 If there are marked items, delete all of these; otherwise, delete
2060 the item at point."
2076 buffer-read-only)
2090 ;; Don't leave point below last item.
2106 nil t)))
2111 "Choose an editing operation for the current item and carry it out."
2120 "Function providing the text editing facilities of `todo-edit-item'."
2122 ;; If there are marked items and user invokes a text-editing
2123 ;; commands with point not on an item, todo-item-start is nil and
2124 ;; 1+ signals an error, so just make this a noop.
2141 full-item
2150 end t)))
2153 ;; When there are marked items, user can invoke todo-edit-item
2154 ;; even if point is not on an item, but text editing only
2155 ;; applies to the item at point.
2167 end t)
2177 ;; If user moved point during editing,
2178 ;; make sure it moves back.
2199 todo-date-pattern)
2200 new))
2203 ;; Ensure lines following hard newlines are indented.
2206 ;; If user moved point during editing, make sure it moves back.
2213 "Return from Todo Edit mode to Todo mode.
2214 If the item contains hard line breaks, make sure the following
2215 lines are indented by `todo-indent-to-here' to conform to diary
2216 format.
2218 If the whole file was in Todo Edit mode, check before returning
2219 whether the file is still a valid todo file and if so, also
2220 recalculate the todo file's categories sexp, in case changes were
2221 made in the number or names of categories."
2224 ;; We got here via `e m'.
2229 todo-date-pattern)
2230 item))
2233 ;; Ensure lines following hard newlines are indented.
2242 ;; We got here via `F e'.
2244 ;; FIXME: separate out sexp check?
2245 ;; If manual editing makes e.g. item counts change, have to
2246 ;; call this to update todo-categories, but it restores
2247 ;; category order to list order.
2248 ;; (todo-repair-categories-sexp)
2249 ;; Compare (todo-make-categories-list t) with sexp and if
2250 ;; different ask (todo-update-categories-sexp) ?
2268 "Function providing header editing facilities of `todo-edit-item'."
2272 ;; INC must be an integer, but users could pass it via
2273 ;; `todo-edit-item' as e.g. `-' or `C-u'.
2276 ndate ntime
2277 year monthname month day dayname)
2288 todo-date-pattern
2310 ;; If there are marked items, use only the first to set
2311 ;; header changes, and apply these to all marked items.
2326 ;; When date string consists only of a day name,
2327 ;; passing other date components is a noop.
2331 monthname omonthname
2332 month omonth
2341 year oyear
2343 month
2344 monthname)
2351 ;; Increment or decrement month by INC
2352 ;; modulo 12.
2354 ;; If result is 0, make month December.
2356 ;; Adjust year if necessary.
2363 oyear)))
2364 ;; Return the changed numerical month as
2365 ;; a string or the corresponding month name.
2369 ;; Since the number corresponding to the arbitrary
2370 ;; month name "*" is out of the range of
2371 ;; calendar-last-day-of-month, set it to 1
2372 ;; (corresponding to January) to allow 31 days.
2381 month omonth
2382 monthname omonthname
2394 ;; Increment or decrement day by INC,
2395 ;; adjusting month and year if necessary
2396 ;; (if year is "*" assume current year to
2397 ;; calculate adjustment).
2404 inc)))
2406 ;; Set year and month(name) to adjusted values.
2412 ;; Return changed numerical day as a string.
2415 ;; If year, month or day date string components were
2416 ;; changed, rebuild the date string.
2420 ;; Needed by calendar-date-display-form.
2428 ;; Add new time string to the header, if it was supplied.
2436 ;; Apply the changes to the first marked item header to the
2437 ;; remaining marked items. If there are no marked items,
2438 ;; we're finished.
2444 "Function providing diary marking facilities of `todo-edit-item'."
2487 "Make all items in this category diary items.
2488 With prefix ARG, make all items in this category non-diary
2489 items."
2525 "Add `diary-nonmarking-symbol' to all diary items in this category.
2526 With prefix ARG, remove `diary-nonmarking-symbol' from all diary
2527 items in this category."
2545 "Prompt for and set ITEM's priority in CATegory.
2547 Interactively, ITEM is the todo item at point, CAT is the current
2548 category, and the priority is a number between 1 and the number
2549 of items in the category. Non-interactively, non-nil NEW means
2550 ITEM is a new item and the lowest priority is one more than the
2551 number of items in CAT.
2553 The new priority is set either interactively by prompt or by a
2554 numerical prefix argument, or noninteractively by argument ARG,
2555 whose value can be either of the symbols `raise' or `lower',
2556 meaning to raise or lower the item's priority by one."
2559 ;; Noop if point is not on a todo (i.e. not done) item.
2561 ;; On done items separator.
2571 todo-date-pattern
2578 curnum
2589 count)))
2595 current-prefix-arg)
2600 candidate
2601 buffer-read-only)
2605 ;; When moving item to another category, show the category before
2606 ;; prompting for its priority.
2609 ;; If done items in category are visible, keep them visible.
2616 ;; Keep current item or top of moved to category in view
2617 ;; while setting priority.
2619 ;; Prompt for priority only when the category has at least one
2620 ;; todo item.
2628 maxnum)))
2630 ;; In Top Priorities buffer, an item's priority can be changed
2631 ;; wrt items in another category, but not wrt items in the same
2632 ;; category.
2654 ;; Interactively or with non-nil ARG, relocate the item within its
2655 ;; category.
2662 ;; When called from todo-item-undone and the highest priority
2663 ;; is chosen, this advances point to the first done item, so
2664 ;; move it up to the empty line above the done items
2665 ;; separator.
2672 ;; If item was marked, restore the mark.
2680 "Raise priority of current item by moving it up by one item."
2685 "Lower priority of current item by moving it down by one item."
2690 "Move at least one todo or done item to another category.
2691 If there are marked items, move all of these; otherwise, move
2692 the item at point.
2694 With prefix argument FILE, prompt for a specific todo file and
2695 choose (with TAB completion) a category in it to move the item or
2696 items to; otherwise, choose and move to any category in either
2697 the current todo file or one of the files in
2698 `todo-category-completions-files'. If the chosen category is
2699 not an existing categories, then it is created and the item(s)
2700 become(s) the first entry/entries in that category.
2702 With moved todo items, prompt to set the priority in the category
2703 moved to (with multiple todo items, the one that had the highest
2704 priority in the category moved from gets the new priority and the
2705 rest of the moved todo items are inserted in sequence below it).
2706 Moved done items are appended to the top of the done items
2707 section in the category moved to."
2712 ;; Noop if point is not on an item and there are no marked items.
2714 ;; On done items separator.
2726 ov cat2 file2 moved nmark todo-items done-items)
2736 nil file)))
2778 ;; Move done items en bloc to top of done items section.
2785 nil t)
2793 ;; If only done items were moved, move point to the top
2794 ;; one, otherwise, move point to the top moved todo item.
2798 ;; Move succeeded, so remove item from starting category,
2799 ;; update item counts and display the category containing
2800 ;; the moved item.
2822 nil t)
2846 ;; If item is moved to end of (just first?) category, make
2847 ;; sure the items above it are displayed in the window.
2849 ;; User quit before setting priority of todo item(s), so
2850 ;; return to starting category.
2859 "Tag a todo item in this category as done and relocate it.
2861 With prefix argument ARG prompt for a comment and append it to
2862 the done item; this is only possible if there are no marked
2863 items. If there are marked items, tag all of these with
2864 `todo-done-string' plus the current date and, if
2865 `todo-always-add-time-string' is non-nil, the current time;
2866 otherwise, just tag the item at point. Items tagged as done are
2867 relocated to the category's (by default hidden) done section. If
2868 done items are visible on invoking this command, they remain
2869 visible."
2875 ;; Noop if point is not on a todo (i.e. not done) item and
2876 ;; there are no marked items.
2878 ;; On done items separator.
2896 header item done-items
2898 ;; Don't add empty comment to done item.
2904 ;; Stop looping when we hit the empty line below the last
2905 ;; todo item (this is eobp if only done items are hidden).
2934 nil t)
2944 ;; When done items are visible, put point at the top of the
2945 ;; done items section. When done items are hidden, restore
2946 ;; point to its location prior to invoking this command.
2950 "Restore at least one done item to this category's todo section.
2951 Prompt for the new priority. If there are marked items, undo all
2952 of these, giving the first undone item the new priority and the
2953 rest following directly in sequence; otherwise, undo just the
2954 item at point.
2956 If the done item has a comment, ask whether to omit the comment
2957 from the restored item. With multiple marked done items with
2958 comments, only ask once, and if affirmed, omit subsequent
2959 comments without asking."
2971 start end item ov npoint undone)
2985 ;; Find the end of the date string added upon tagging item as
2986 ;; done.
2992 ;; Ask (once) whether to omit done item's comment. If
2993 ;; affirmed, omit subsequent comments without asking.
2997 end t)
3004 " from restored item"
3008 t)
3019 ;; Chop off last newline of multiple items string, since
3020 ;; it will be reinserted on setting priority.
3047 ;; Put cursor on undone item.
3051 ;; -----------------------------------------------------------------------------
3052 ;;; Done item archives
3053 ;; -----------------------------------------------------------------------------
3056 "Visit the archive of the current todo category, if it exists.
3057 If the category has no archived items, prompt to visit the
3058 archive anyway. If there is no archive for this file or with
3059 non-nil argument ASK, prompt to visit another archive.
3061 The buffer showing the archive is in Todo Archive mode. The
3062 first visit in a session displays the first category in the
3063 archive, subsequent visits return to the last category
3064 displayed."
3095 "Choose an archive and visit it."
3100 "Archive at least one done item in this category.
3102 With prefix argument ALL, prompt whether to archive all done
3103 items in this category and on confirmation archive them.
3104 Otherwise, if there are marked done items (and no marked todo
3105 items), archive all of these; otherwise, archive the done item at
3106 point.
3108 If the archive of this file does not exist, it is created. If
3109 this category does not exist in the archive, it is created."
3125 marked-items beg end all-done
3126 buffer-read-only)
3136 nil t)
3141 nil t)
3146 ;; Restore starting point, unless it was on a done
3147 ;; item, since they will all be deleted.
3166 buffer-read-only)
3173 nil t)
3175 nil t))
3176 ;; Start of done items section in existing category.
3179 ;; Start of done items section in new category.
3186 ;; If archive is new, save to file now (with
3187 ;; write-region to avoid prompt for file to save to)
3188 ;; to update todo-archives, and set the mode for
3189 ;; visiting the archive below.
3200 ;; Make sure done items are accessible.
3207 ;; If we're archiving all done items, can't
3208 ;; first archive item point was on, since
3209 ;; that will short-circuit the rest.
3219 ;; Don't leave point below last item.
3236 ;; Make todo file current to select category.
3238 ;; Make sure done item separator is hidden (if done items
3239 ;; were initially visible).
3243 "Unarchive at least one item in this archive category.
3244 If there are marked items, unarchive all of these; otherwise,
3245 unarchive the item at point.
3247 Unarchived items are restored as done items to the corresponding
3248 category in the todo file, inserted at the top of done items
3249 section. If all items in the archive category have been
3250 restored, the category is deleted from the archive. If this was
3251 the only category in the archive, the archive file is deleted."
3258 t))
3262 marked-items
3263 buffer-read-only)
3272 ;; Restore items to top of category's done section and update counts.
3275 buffer-read-only newcat)
3279 ;; Find the corresponding todo category, or if there isn't
3280 ;; one, add it.
3284 nil t)
3287 ;; Go to top of category's done section.
3303 ;; Delete restored items from archive.
3316 ;; If we unarchived the last item in category, then if that was
3317 ;; the only category, delete the whole file, otherwise, just
3318 ;; delete the category.
3323 ;; Kill the archive buffer silently.
3329 nil t))
3338 todo-categories)))))
3340 ;; Visit category in todo file and show restored done items.
3347 ;; Selecting the category leaves point at the end of the done
3348 ;; items separator string, so move it to the (first) restored
3349 ;; done item.
3354 "Prompt for a category in a todo archive and jump to it.
3355 With prefix argument FILE, prompt for an archive and choose (with
3356 TAB completion) a category in it to jump to; otherwise, choose
3357 and jump to any category in the current archive."
3361 ;; -----------------------------------------------------------------------------
3362 ;;; Displaying and sorting tables of categories
3363 ;; -----------------------------------------------------------------------------
3366 "Category button label in Todo Categories mode."
3371 "Todo button label in Todo Categories mode."
3376 "Diary button label in Todo Categories mode."
3381 "Done button label in Todo Categories mode."
3386 "Archived button label in Todo Categories mode."
3391 "String to label total item counts in Todo Categories mode."
3396 "String between number and category in Todo Categories mode.
3397 This separates the number from the category name in the default
3398 categories display according to priority."
3403 "Alignment of category names in Todo Categories mode."
3408 "Display a table of the current file's categories and item counts.
3410 In the initial display the lines of the table are numbered,
3411 indicating the current order of the categories when sequentially
3418 with a numeric prefix. If you save the todo file after
3419 reordering the categories, the new order persists in subsequent
3420 Emacs sessions.
3422 The labels above the category names and item counts are buttons,
3423 and clicking these changes the display: sorted by category name
3424 or by the respective item counts (alternately descending or
3425 ascending). In these displays the categories are not numbered
3428 sorting is triggered by passing a non-nil SORTKEY argument.)
3430 In addition, the lines with the category names and item counts
3431 are buttonized, and pressing one of these button jumps to the
3432 category in Todo mode (or Todo Archive mode, for categories
3433 containing only archived items, provided user option
3434 `todo-skip-archived-categories' is non-nil. These categories
3435 are shown in `todo-archived-only' face."
3442 "Move point to the Nth next button in the table of categories."
3446 ;; Align with beginning of category label.
3450 "Move point to the Nth previous button in the table of categories."
3454 ;; Align with beginning of category label.
3458 "Change number of category at point in the table of categories.
3460 With ARG nil, prompt for the new number. Alternatively, the
3461 enter the new number with numerical prefix ARG. Otherwise, if
3462 ARG is either of the symbols `raise' or `lower', raise or lower
3463 the category line in the table by one, respectively, thereby
3464 decreasing or increasing its number."
3467 ;; Get the number representing the priority of the category
3468 ;; on the current line.
3479 candidate)
3486 maxnum))
3495 todo-categories))
3496 ;; Category's name and items counts list.
3499 newcats)
3513 "Raise priority of category at point in the table of categories."
3518 "Lower priority of category at point in the table of categories."
3523 "Sort table of categories alphabetically or numerically."
3536 "Sort table of categories by number of todo items."
3544 "Sort table of categories by number of diary items."
3552 "Sort table of categories by number of non-archived done items."
3560 "Sort table of categories by number of archived items."
3571 "Return the length of the longest name in list CATEGORIES."
3577 "Return adjusted length of category label button.
3578 The adjustment ensures proper tabular alignment in Todo
3579 Categories mode."
3589 "Return category name or label string STR padded with spaces.
3590 The placement of the padding is determined by the value of user
3591 option `todo-categories-align'."
3611 "Return a copy of LIST, possibly sorted according to KEY."
3616 ;; Keep track of whether the last sort by key was descending or
3617 ;; ascending.
3627 ;; Switch between descending and ascending sort order.
3632 l))
3635 "Keep point on the TYPE count sorting button just clicked."
3641 "Return symbol for sort key associated with LABEL."
3653 key))
3656 "Insert button for displaying categories sorted by item counts.
3657 LABEL determines which type of count is sorted."
3660 label))
3663 ov)
3665 'action
3671 ;; If display is alphabetical, switch back to
3672 ;; category priority order.
3681 "Return a list of total item counts for the current file."
3683 todo-categories)))
3690 "Insert button with category CAT's name and item counts.
3691 With non-nil argument NONUM show only these; otherwise, insert a
3692 number in front of the button indicating the category's priority.
3693 The number and the category name are separated by the string
3694 which is the value of the user option
3695 `todo-categories-number-separator'."
3706 str
3711 ;; Add an extra space if label length is odd.
3726 'todo-archived-only
3727 nil)
3732 ;; Highlight the sorted count column.
3734 end ovl)
3756 "Prepare buffer for displaying table of categories and item counts."
3766 buffer-read-only)
3773 ;; Make space for the column of category numbers.
3775 ;; Add the category and item count buttons (if this is the list of
3776 ;; categories in an archive, show only done item counts).
3793 "Populate table of categories and sort by SORTKEY."
3798 ;; Find start of Category button if we just entered Todo Categories
3799 ;; mode.
3808 ;; Fill in the table with buttonized lines, each showing a category and
3809 ;; its item counts.
3813 ;; Add a line showing item count totals.
3821 ;; Add an extra space if label length is odd.
3830 ;; Put cursor on Category button initially.
3834 ;; -----------------------------------------------------------------------------
3835 ;;; Searching and item filtering
3836 ;; -----------------------------------------------------------------------------
3839 "Search for a regular expression in this todo file.
3840 The search runs through the whole file and encompasses all and
3841 only todo and done items; it excludes category names. Multiple
3842 matches are shown sequentially, highlighted in `todo-search'
3843 face."
3847 matches match cat in-done ov mlen msg)
3869 nil t)
3883 mlen)
3888 mlen)
3902 "Remove highlighting on matches found by todo-search."
3907 "List of rules specifying number of top priority items to show.
3908 These rules override `todo-top-priorities' on invocations of
3911 of the form (FILE NUM ALIST), where FILE is a member of
3912 `todo-files', NUM is a number specifying the default number of
3913 top priority items for each category in that file, and ALIST,
3914 when non-nil, consists of conses of a category name in FILE and a
3915 number specifying the default number of top priority items in
3916 that category, which overrides NUM.
3918 This variable should be set interactively by
3925 "Default number of top priorities shown by `todo-filter-top-priorities'."
3930 "List of default files for multifile item filtering."
3935 "Non-nil to include done items when processing regexp filters.
3936 Done items from corresponding archive files are also included."
3941 "Set number of top priorities for this file.
3942 See `todo-set-top-priorities' for more details."
3947 "Set number of top priorities for this category.
3948 See `todo-set-top-priorities' for more details."
3953 "Display a list of top priority items from different categories.
3954 The categories can be any of those in the current todo file.
3956 With numerical prefix ARG show at most ARG top priority items
3957 from each category. With `C-u' as prefix argument show the
3958 numbers of top priority items specified by category in
3959 `todo-top-priorities-overrides', if this has an entry for the file(s);
3960 otherwise show `todo-top-priorities' items per category in the
3961 file(s). With no prefix argument, if a top priorities file for
3962 the current todo file has previously been saved (see
3963 `todo-save-filtered-items-buffer'), visit this file; if there is
3964 no such file, build the list as with prefix argument `C-u'.
3966 The prefix ARG regulates how many top priorities from
3967 each category to show, as described above."
3972 "Display a list of top priority items from different categories.
3973 The categories are a subset of the categories in the files listed
3974 in `todo-filter-files', or if this nil, in the files chosen from
3975 a file selection dialog that pops up in this case.
3977 With numerical prefix ARG show at most ARG top priority items
3978 from each category in each file. With `C-u' as prefix argument
3979 show the numbers of top priority items specified in
3980 `todo-top-priorities-overrides', if this is non-nil; otherwise show
3981 `todo-top-priorities' items per category. With no prefix
3982 argument, if a top priorities file for the chosen todo files
3983 exists (see `todo-save-filtered-items-buffer'), visit this file;
3984 if there is no such file, do the same as with prefix argument
3985 `C-u'."
3990 "Display a list of todo diary items from different categories.
3991 The categories can be any of those in the current todo file.
3993 Called with no prefix ARG, if a diary items file for the current
3994 todo file has previously been saved (see
3995 `todo-save-filtered-items-buffer'), visit this file; if there is
3996 no such file, build the list of diary items. Called with a
3997 prefix argument, build the list even if there is a saved file of
3998 diary items."
4003 "Display a list of todo diary items from different categories.
4004 The categories are a subset of the categories in the files listed
4005 in `todo-filter-files', or if this nil, in the files chosen from
4006 a file selection dialog that pops up in this case.
4008 Called with no prefix ARG, if a diary items file for the chosen
4009 todo files has previously been saved (see
4010 `todo-save-filtered-items-buffer'), visit this file; if there is
4011 no such file, build the list of diary items. Called with a
4012 prefix argument, build the list even if there is a saved file of
4013 diary items."
4018 "Prompt for a regular expression and display items that match it.
4019 The matches can be from any categories in the current todo file
4020 and with non-nil option `todo-filter-done-items', can include
4021 not only todo items but also done items, including those in
4022 Archive files.
4024 Called with no prefix ARG, if a regexp items file for the current
4025 todo file has previously been saved (see
4026 `todo-save-filtered-items-buffer'), visit this file; if there is
4027 no such file, build the list of regexp items. Called with a
4028 prefix argument, build the list even if there is a saved file of
4029 regexp items."
4034 "Prompt for a regular expression and display items that match it.
4035 The matches can be from any categories in the files listed in
4036 `todo-filter-files', or if this nil, in the files chosen from a
4037 file selection dialog that pops up in this case. With non-nil
4038 option `todo-filter-done-items', the matches can include not
4039 only todo items but also done items, including those in Archive
4040 files.
4042 Called with no prefix ARG, if a regexp items file for the current
4043 todo file has previously been saved (see
4044 `todo-save-filtered-items-buffer'), visit this file; if there is
4045 no such file, build the list of regexp items. Called with a
4046 prefix argument, build the list even if there is a saved file of
4047 regexp items."
4055 "Choose a filtered items file and visit it."
4058 falist file)
4074 "Display the file and category of the filtered item at point."
4092 t
4093 todo-show-with-done)))
4105 "Pop to a buffer with a widget for choosing multiple filter files."
4133 todo-multiple-filter-files-widget)))
4155 "Display a list of items filtered by FILTER.
4156 The values of FILTER can be `top' for top priority items, a cons
4157 of `top' and a number passed by the caller, `diary' for diary
4158 items, or `regexp' for items matching a regular expression
4159 entered by the user. The items can come from any categories in
4160 the current todo file or, with non-nil MULTIFILE, from several
4161 files. If NEW is nil, visit an appropriate file containing the
4162 list of filtered items; if there is no such file, or with non-nil
4163 NEW, build the list and display it.
4165 See the documentation strings of the commands
4166 `todo-filter-top-priorities', `todo-filter-diary-items',
4167 `todo-filter-regexp-items', and those of the corresponding
4168 multifile commands for further details."
4178 todo-multiple-filter-files))
4181 ;; Pressed `cancel' in t-m-f-f file selection dialog.
4192 bufname)
4200 rxf)
4212 #'todo-short-file-name
4213 todo-files))
4215 s)
4216 s)))
4218 buf bufname))))
4221 "Build a list of items by applying FILTER to FILE-LIST.
4222 Internal subroutine called by `todo-filter-items', which passes
4223 the values of FILTER and FILE-LIST."
4227 regexp fname bufstr cat beg end done)
4238 ;; Before inserting file contents into temp buffer, save a modified
4239 ;; buffer visiting it.
4246 ;; If there is a corresponding archive file for the
4247 ;; todo file, insert it first and add identifiers for
4248 ;; todo-go-to-source-item.
4252 ;; Delete todo archive file's categories sexp.
4262 todo-date-string-start)
4268 nil t)
4272 ;; Delete todo file's categories sexp.
4275 ;; Unless the number of top priorities to show was
4276 ;; passed by the caller, the file-wide value from
4277 ;; `todo-top-priorities-overrides', if non-nil, overrides
4278 ;; `todo-top-priorities'.
4281 todo-top-priorities)))
4285 nil t)
4288 ;; Unless the number of top priorities to show was
4289 ;; passed by the caller, the category-wide value
4290 ;; from `todo-top-priorities-overrides', if non-nil,
4291 ;; overrides a non-nil file-wide value from
4292 ;; `todo-top-priorities-overrides' as well as
4293 ;; `todo-top-priorities'.
4301 nil t)
4308 end t)
4310 end))
4312 ;; Leave done items.
4317 ;; Apply the filter.
4329 ;; Kill lines that aren't part of a todo or done
4330 ;; item (empty or todo-category-done).
4333 ;; If last todo item in file matches regexp and
4334 ;; there are no following done items,
4335 ;; todo-category-done string is left dangling,
4336 ;; because todo-forward-item jumps over it.
4350 ;; Delete non-top-priority items.
4354 ;; Add file (if using multiple files) and category tags to
4355 ;; item.
4362 todo-date-string-start)
4368 nil t)
4383 "Set number of top priorities shown by `todo-filter-top-priorities'.
4384 With non-nil ARG, set the number only for the current Todo
4385 category; otherwise, set the number for all categories in the
4386 current todo file.
4388 Calling this function via either of the commands
4389 `todo-set-top-priorities-in-file' or
4390 `todo-set-top-priorities-in-category' is the recommended way to
4391 set the user customizable option `todo-top-priorities-overrides'."
4399 todo-top-priorities))
4401 fcur))
4410 prompt "Enter a non-negative number: "
4411 cur nil)))
4417 nrule)
4423 "Search for filtered item STR in its saved todo file.
4424 Return the list (FOUND FILE CAT), where CAT and FILE are the
4425 item's category and file, and FOUND is a cons cell if the search
4426 succeeds, whose car is the start of the item in FILE and whose
4427 cdr is `done', if the item is now a done item, `changed', if its
4428 text was truncated or augmented or, for a top priority item, if
4429 its priority has changed, and `same' otherwise."
4433 todo-date-string-start)
4440 str)
4447 found)
4450 ;; Calculate priority of STR wrt its category.
4460 todo-global-current-todo-file)))
4472 nil t))
4479 nil t)
4486 'done
4490 ;; Not top item in category.
4494 ;; Can't move backward beyond
4495 ;; first item in file.
4499 ;; Proper substring is not the same.
4501 str))
4502 'same
4507 "Check if filtered items file is up to date and a show suitable message."
4508 ;; (catch 'old
4518 ;; (throw 'old (message "The marked item is not up to date.")))
4523 "not up to date."
4524 ;; "\nType <return> on item for details."
4525 )))))
4528 "Return absolute file name for saving this Filtered Items buffer."
4546 "Save current Filtered Items buffer to a file.
4547 If the file already exists, overwrite it only on confirmation."
4554 ;; -----------------------------------------------------------------------------
4555 ;;; Printing Todo mode buffers
4556 ;; -----------------------------------------------------------------------------
4559 "Function called by `todo-print-buffer' to print Todo mode buffers.
4560 Called with one argument which can either be:
4561 - a string, naming a file to save the print image to.
4562 - nil, to send the image to the printer."
4570 "Produce a printable version of the current Todo mode buffer.
4571 This converts overlays and soft line wrapping and, depending on
4572 the value of `todo-print-buffer-function', includes faces. With
4573 non-nil argument TO-FILE write the printable version to a file;
4574 otherwise, send it to the default printer."
4601 ;; Calling todo-forward-item infloops at todo-item-start due to
4602 ;; non-overlay prefix, so search for item start instead.
4607 nil t)
4618 "Save printable version of this Todo mode buffer to a file."
4622 ;; -----------------------------------------------------------------------------
4623 ;;; Legacy Todo mode files
4624 ;; -----------------------------------------------------------------------------
4629 "Regexp matching legacy todo-mode.el item date-time strings.
4630 In order for `todo-convert-legacy-files' to correctly convert
4631 this string to the current Todo mode format, the regexp must
4632 contain four explicitly numbered groups (see `(elisp) Regexp
4633 Backslash'), where group 1 matches a string for the year, group 2
4634 a string for the month, group 3 a string for the day and group 4
4635 a string for the time. The default value converts date-time
4636 strings built using the default value of
4637 `todo-time-string-format' from todo-mode.el."
4642 "Return converted date-time string.
4643 Helper function for `todo-convert-legacy-files'."
4650 dayname)
4656 "Convert legacy todo files to the current Todo mode format.
4657 The old-style files named by the variables `todo-file-do' and
4658 `todo-file-done' from the old package are converted to the new
4659 format and saved (the latter as a todo archive file) with a new
4660 name in `todo-directory'. See also the documentation string of
4661 `todo-legacy-date-time-regexp' for further details."
4663 ;; If there are user customizations of legacy options, use them,
4664 ;; otherwise use the legacy default values.
4666 todo-file-do
4669 todo-file-done
4673 todo-entry-prefix-function))
4674 todo-prefix-tem)
4675 ;; Convert `todo-file-do'.
4679 file archive-sexp)
4682 ;; Eliminate old-style local variables list in first line.
4690 ;; Old-style category start delimiter.
4693 ;; Old-style category end delimiter.
4696 ;; Old-style category separator.
4701 ;; Old-style item header (date/time/initials).
4715 nil nil default)
4727 ;; Convert `todo-file-done'.
4733 cat cats comment item)
4748 todo-initials-tem)
4762 ;; If the item ends with a non-comment parenthesis not
4763 ;; followed by a period, we lose (but we inherit that
4764 ;; problem from the legacy code).
4765 ;; FIXME: fails on multiline comment
4772 ;; If item is already in its category, leave it there.
4777 nil t)
4779 ;; Else move it to its category.
4787 nil t)
4792 nil t)
4818 ;; Update categories sexp of converted todo file again, adding
4819 ;; counts of archived items.
4838 ;; We just initialized the first todo file, so make it the
4839 ;; default now to avoid an infinite recursion with todo-show.
4843 ;; -----------------------------------------------------------------------------
4844 ;;; Utility functions for todo files, categories and items
4845 ;; -----------------------------------------------------------------------------
4848 "Return the absolute file name of short todo file NAME.
4849 With TYPE `archive' or `top' return the absolute file name of the
4850 short todo archive or top priorities file name, respectively."
4851 ;; No-op if there is no todo file yet (i.e. don't concatenate nil).
4862 "Check the state associated with FILE and update it if necessary.
4863 If FILE exists, return t. If it does not exist and there is no
4864 live buffer with its content, return nil; if there is such a
4865 buffer and the user tries to show it, ask whether to restore
4866 FILE, and if confirmed, do so and return t; else delete the
4867 buffer, clean up the state and return nil."
4871 t
4885 t)
4899 nil)))))
4902 "Return the number of category CAT in this todo file.
4903 The buffer-local variable `todo-category-number' holds this
4904 number as its value."
4907 ;; Increment by one, so that the number of the first
4908 ;; category is one rather than zero.
4913 "Return the name of the current category."
4917 "Display the current category correctly."
4919 cat-begin cat-end done-start done-sep-start done-end)
4936 nil t)
4946 ;; Now we want to see the done items, so reset displayed end to end of
4947 ;; done items.
4949 ;; Make display overlay for done items separator string, unless there
4950 ;; already is one.
4959 ;; Loading this from todo-mode, or adding it to the mode hook, causes
4960 ;; Emacs to hang in todo-item-start, at (looking-at todo-item-start).
4966 "Return count of TYPE items in CATEGORY.
4967 If CATEGORY is nil, default to the current category."
4977 "Change count of TYPE items in CATEGORY by integer INCREMENT.
4978 With nil or omitted CATEGORY, default to the current category."
4988 "Set `todo-categories' from the sexp at the top of the file."
4989 ;; New archive files created by `todo-move-category' are empty, which would
4990 ;; make the sexp test fail and raise an error, so in this case we skip it.
5004 "Update the `todo-categories' sexp at the top of the file."
5017 "Return an alist of todo categories and their item counts.
5018 With non-nil argument FORCE parse the entire file to build the
5019 list; otherwise, get the value by reading the sexp at the top of
5020 the file."
5027 ;; If the file is a todo file and has archived items, identify the
5028 ;; archive, in order to count its items. But skip this with
5029 ;; `todo-convert-legacy-files', since that converts filed items to
5030 ;; archived items.
5032 ;; If the file is an archive, it doesn't have an archive.
5041 ;; Counts for each category: [todo diary done archive]
5045 ;; Add archived item count to the todo file item counts.
5046 ;; Make sure to include newly created archives, e.g. due to
5047 ;; todo-move-category.
5081 ;; If first line is todo-categories list, use it and end loop
5082 ;; -- unless FORCEd to scan whole file.
5090 todo-categories)
5093 "Repair corrupt todo file categories sexp.
5094 This should only be needed as a consequence of careless manual
5095 editing or a bug in todo.el.
5097 *Warning*: Calling this command restores the category order to
5098 the list element order in the todo file categories sexp, so any
5099 order changes made in Todo Categories mode will have to be made
5100 again."
5106 "Signal an error if the current todo file is ill-formatted.
5107 Otherwise return t. Display a warning if the file is well-formed
5108 but the categories sexp differs from the current value of
5109 `todo-categories'."
5118 ;; Check the first line for `todo-categories' sexp.
5126 ;; Check well-formedness of categories.
5139 ;; Warn user if categories sexp has changed.
5143 The sexp at the beginning of the file differs from the value of
5144 `todo-categories'. If the sexp is wrong, you can fix it with
5145 M-x todo-repair-categories-sexp, but note this reverts any
5146 changes you have made in the order of the categories.
5147 "
5148 )))))
5149 t)
5152 "Move to start of current todo item and return its position."
5154 ;; Buffer is empty (invocation possible e.g. via todo-forward-item
5155 ;; from todo-filter-items when processing category with no todo
5156 ;; items).
5158 ;; Point is on the empty line below category's last todo item...
5165 ;; Point is on done items separator.
5167 ;; Buffer is widened.
5175 "Move to end of current todo item and return its position."
5177 ;; Items cannot end with a blank line.
5179 ;; Point is on done items separator.
5183 ;; For todo items, end is before the done items section, for done
5184 ;; items, end is before the next category. If these limits are
5185 ;; missing or inaccessible, end it before the end of the buffer.
5189 todo-category-beg
5190 todo-category-done)))
5191 nil t))
5198 ;; For last todo item, skip back over the empty line before the done
5199 ;; items section, else just back to the end of the previous line.
5204 "Return bare text of current item as a string."
5212 "Move point COUNT items down (by default, move down by one item)."
5219 ;; If points advances by one from a todo to a done item, go back
5220 ;; to the space above todo-done-separator, since that is a
5221 ;; legitimate place to insert an item. But skip this space if
5222 ;; count > 1, since that should only stop on an item.
5224 ;; (if (or (not count) (= count 1))
5226 ;; The preceding sexp is insufficient when buffer is not narrowed,
5227 ;; since there could be no done items in this category, so the
5228 ;; search puts us on first todo item of next category. Does this
5229 ;; ever happen? If so:
5230 ;; (let ((opoint) (point))
5231 ;; (forward-line -1)
5232 ;; (when (or (not count) (= count 1))
5233 ;; (cond ((looking-at (concat "^" (regexp-quote todo-category-beg)))
5234 ;; (forward-line -2))
5235 ;; ((looking-at (concat "^" (regexp-quote todo-category-done)))
5236 ;; (forward-line -1))
5237 ;; (t
5238 ;; (goto-char opoint)))))))
5241 "Move point up to start of item with next higher priority.
5242 With positive numerical prefix COUNT, move point COUNT items
5243 upward.
5245 If the category's done items are visible, this command called
5246 with a prefix argument only moves point to a higher item, e.g.,
5247 with point on the first done item and called with prefix 1, it
5248 moves to the last todo item; but if called with point on the
5249 first done item without a prefix argument, it moves point to the
5250 empty line above the done items separator."
5258 ;; If the item date-time header is hidden, the display engine
5259 ;; moves point to the next earlier displayable position, which
5260 ;; is the end of the next item above, so we move it to the start
5261 ;; of the current item's text (that's what the display engine
5262 ;; does with todo-forward-item in this case.)
5263 ;; FIXME: would it be better to use cursor-sensor-functions?
5265 ;; Unless this is a regexp filtered items buffer (which can contain
5266 ;; intermixed todo and done items), if points advances by one from a
5267 ;; done to a todo item, go back to the space above
5268 ;; todo-done-separator, since that is a legitimate place to insert an
5269 ;; item. But skip this space if count > 1, since that should only
5270 ;; stop on an item.
5272 ;(or (not count) (= count 1))
5275 nil t)
5279 "Internal function called in editing, deleting or moving items."
5282 ovs)
5289 "Return non-nil if item at point has diary entry format."
5295 ;; This duplicates the item locating code from diary-goto-entry, but
5296 ;; without the marker code, to test whether the latter is dispensable.
5297 ;; If it is, diary-goto-entry can be simplified. The code duplication
5298 ;; here can also be eliminated, leaving only the widening and category
5299 ;; selection, and instead of :override advice :around can be used.
5302 "Jump to the diary entry for the BUTTON at point.
5303 If the entry is a todo item, display its category properly.
5304 Overrides `diary-goto-entry'."
5305 ;; Locate the diary item in its source file.
5313 ;; If it's a Todo file, make sure it's in Todo mode.
5322 ;; If it's a todo item, determine its category and display the
5323 ;; category properly.
5328 nil t)
5337 "Call `revert-buffer', preserving buffer's current modes.
5338 Also preserve category display, if applicable."
5344 ;; revert-buffer--default calls after-find-file, which makes
5345 ;; buffer writable.
5366 "Return non-nil if item at point is a done item."
5372 "Return non-nil if point is in category's done items section."
5375 nil t)
5380 "Signal user error on marked done items.
5381 Helper function for editing commands that apply only to (possibly
5382 marked) not done todo items."
5399 "Replace existing overlays of done items separator string SEP."
5411 new-ov)
5420 "Return the overlay at point whose `todo' property has value VAL."
5422 ;; When headers are hidden, the display engine makes item's start
5423 ;; inaccessible to commands, so then we have to go there
5424 ;; non-interactively to check for prefix and header overlays.
5427 ;; Use overlays-in to find prefix overlays and check over two
5428 ;; positions to find done separator overlay.
5430 ov)
5438 "Non-nil if this item begins with `todo-item-mark'.
5439 In that case, return the item's prefix overlay."
5441 ;; If an item insertion command is called on a todo file
5442 ;; before it is visited, it has no prefix overlays yet, so
5443 ;; check for this.
5447 pref))))
5451 "Insert ITEM at point and update prefix and header overlays."
5456 ;; Insertion pushes item down but not its prefix overlay. When
5457 ;; the overlay includes a mark, this would now mark the inserted
5458 ;; ITEM, so move it to the pushed down item.
5461 ;; With hidden headers, todo-backward-item puts point on first
5462 ;; visible character after header, so we have to search backward.
5467 nil t)
5474 "Update the prefix overlays of the current category's items.
5475 The overlay's value is the string `todo-prefix' or with non-nil
5476 `todo-number-prefix' an integer in the sequence from 1 to
5477 the number of todo or done items in the category indicating the
5478 item's priority. Todo and done items are numbered independently
5479 of each other."
5484 todo-top-priorities-overrides))))
5486 todo-top-priorities-overrides))
5487 todo-top-priorities))
5488 done prefix)
5496 ;; Reset number to 1 for first done item.
5504 done t))
5508 todo-prefix)
5509 'face
5510 ;; Prefix of top priority items has a
5511 ;; distinct face in Todo mode.
5515 'todo-top-priority
5520 ;; Prefix overlay must be at a single position so its
5521 ;; bounds aren't changed when (re)moving an item.
5526 prefix))))
5529 ;; -----------------------------------------------------------------------------
5530 ;;; Generating and applying item insertion and editing key sequences
5531 ;; -----------------------------------------------------------------------------
5533 ;; Thanks to Stefan Monnier for (i) not only suggesting dynamically
5534 ;; generating item insertion commands and their key bindings but also
5535 ;; offering an elegant implementation which, however, since it used
5536 ;; lexical binding, was at the time incompatible with the Calendar and
5537 ;; Diary code in todo-mode.el; and (ii) later making that code
5538 ;; compatible with lexical binding, so that his implementation, of
5539 ;; which the following is a somewhat expanded version, could be
5540 ;; realized in todo-mode.el.
5544 "List of all item insertion parameters.
5545 Passed by `todo-insert-item' to `todo-insert-item--next-param' to
5549 "Generate and invoke an item insertion command.
5550 Dynamically generate the command, its arguments ARGS and its key
5551 binding by recursing through the list of parameters PARAMS,
5552 taking the LAST from a sublist and prompting with KEYS-SO-FAR
5553 keys already entered and those still available."
5566 ;; Return key paired with given item insertion parameter.
5568 ;; The key just typed.
5571 ;; Add successively entered keys to the prompt and show what
5572 ;; possibilities remain.
5581 "%s=>%s"
5585 name)))))
5586 ;; Return the sublist of the given list of parameters whose
5587 ;; first member is paired with the given key.
5603 lst)
5609 lst)))
5610 ;; Build list of arguments for item insertion and then
5611 ;; execute the basic insertion function. The list consists of
5612 ;; item insertion parameters that can be passed as insertion
5613 ;; command arguments in fixed positions. If a position in
5614 ;; the list is not occupied by the corresponding parameter,
5615 ;; it is occupied by nil.
5622 params)))))
5624 rest
5638 ;; Operate on a copy of the parameter list so the original is
5639 ;; not consumed, thus available for the next key typed.
5669 keys-so-far))))))
5732 ;; -----------------------------------------------------------------------------
5733 ;;; Todo minibuffer utilities
5734 ;; -----------------------------------------------------------------------------
5744 SPC to affirm the question only if option `todo-y-with-space' is
5745 non-nil."
5753 "Return a list of completions for `todo-read-category'.
5754 Each element of the list is a cons of a category name and the
5755 file or list of files (as short file names) it is in. The files
5756 are either the current (or if there is none, the default) todo
5757 file plus the files listed in `todo-category-completions-files',
5758 or, with non-nil ARCHIVE, the current archive file.
5760 Before calculating the completions, update the value of
5761 `todo-category-completions-files' in case any files named in it
5762 have been removed."
5775 names))
5783 todo-global-current-todo-file)
5787 todo-category-completions-files))
5789 listall listf)
5790 ;; If file was just added, it has no category completions.
5799 ;; Ensure category is properly displayed in case user
5800 ;; switches to file via a non-Todo mode command. And if
5801 ;; done items in category are visible, keep them visible.
5822 listf)))))
5825 "Choose and return the name of a todo file, prompting with PROMPT.
5827 Show completions with TAB or SPC; the names are shown in short
5828 form but the absolute truename is returned. With non-nil ARCHIVE
5829 return the absolute truename of a todo archive file. With non-nil
5830 MUSTMATCH the name of an existing file must be chosen;
5831 otherwise, a new file name is allowed."
5834 ;; (funcall todo-files-function archive)))
5838 ;; If user hit RET without
5839 ;; choosing a file, default to
5840 ;; current or default file.
5844 todo-global-current-todo-file)
5846 todo-default-todo-file)))
5847 ;; Trigger prompt for initial file.
5857 "Choose and return a category name, prompting with PROMPT.
5858 Show completions for existing categories with TAB or SPC.
5860 The argument MATCH-TYPE specifies the matching requirements on
5861 the category name: with the value `todo' or `archive' the name
5862 must complete to that of an existing todo or archive category,
5863 respectively; with the value `add' the name must not be that of
5864 an existing category; with all other values both existing and new
5865 valid category names are accepted.
5867 With non-nil argument FILE prompt for a file and complete only
5868 against categories in that file; otherwise complete against all
5869 categories from `todo-category-completions-files'."
5870 ;; Allow SPC to insert spaces, for adding new category names.
5875 map)))
5880 "n archive"
5883 archive t)))
5890 todo-categories)))
5894 todo-categories))
5896 completions)))
5900 ;; Unless we're adding a category via
5901 ;; todo-add-category, set default
5902 ;; for existing categories to the
5903 ;; current category of the chosen
5904 ;; file or else of the current file.
5909 todo-current-todo-file
5911 todo-default-todo-file)))
5913 ;; Trigger prompt for initial category.
5917 ;; If we do category completion and the chosen category name
5918 ;; occurs in more than one file, prompt to choose one file.
5922 catfil
5926 ;; Default to the current file.
5928 ;; First validate only a name passed interactively from
5929 ;; todo-add-category, which must be of a nonexistent category.
5931 ;; Validate only against completion categories.
5934 ;; When user enters a nonexistent category name by jumping or
5935 ;; moving, confirm that it should be added, then validate.
5943 ;; Restore point and narrowing after adding new
5944 ;; category, to avoid moving to beginning of file when
5945 ;; moving marked items to a new category
5946 ;; (todo-move-item).
5950 ;; If we decide not to add a category, exit without returning.
5955 "Prompt for new NAME for TYPE until it is valid, then return it.
5956 TYPE can be either of the symbols `file' or `category'."
5959 prompt)
5966 "Enter a non-empty file name: "
5967 ;; Empty string passed by todo-show to
5968 ;; prompt for initial todo file.
5973 "Enter a non-empty category name: "
5974 ;; Empty string passed by todo-show to
5975 ;; prompt for initial category of a new
5976 ;; todo file.
5989 files)
5991 categories)))
5992 ;; Offer default initial name.
5994 files
5995 categories)
5997 todo-initial-file
5998 todo-initial-category))))))
5999 name))
6001 ;; Adapted from calendar-read-date and calendar-date-string.
6003 "Prompt for Gregorian date and return it in the current format.
6005 With non-nil ARG, prompt for and return only the date component
6006 specified by ARG, which can be one of these symbols:
6007 `month' (prompt for name, return name or number according to
6008 value of `calendar-date-display-form'), `day' of month, or
6009 `year'. The value of each of these components can be `*',
6010 indicating an unspecified month, day, or year.
6012 When ARG is `day', non-nil arguments MO and YR determine the
6013 number of the last the day of the month."
6019 "Year (>0 or RET for this year or * for any year): "
6030 "Month name (RET for current month, * for any month): "
6031 mlist nil t nil nil
6041 ;; If month is unspecified, use a month with 31
6042 ;; days for checking day of month input. Does
6043 ;; Calendar do anything special when * is
6044 ;; currently a shorter month?
6046 ;; If year is unspecified, use a leap year to
6047 ;; allow Feb. 29.
6053 last)
6057 ;; Stringify read values (monthname is already a string).
6072 month
6073 monthname)))
6077 "Choose name of a day of the week with completion and return it."
6081 nil t)))
6084 "Prompt for and return a valid clock time as a string.
6086 Valid time strings are those matching `diary-time-regexp'.
6087 Typing `<return>' at the prompt returns the current time, if the
6088 user option `todo-always-add-time-string' is non-nil, otherwise
6089 the empty string (i.e., no time string)."
6098 answer))
6100 ;; -----------------------------------------------------------------------------
6101 ;;; Customization groups and utilities
6102 ;; -----------------------------------------------------------------------------
6105 "Create and maintain categorized lists of todo items."
6111 "User options for adding and editing todo items."
6116 "User options for Todo Categories mode."
6121 "User options for Todo Filter Items mode."
6126 "User display options for Todo mode."
6131 "Faces for the Todo modes."
6136 "The :set function for user option `todo-show-current-file'."
6143 "The :set function for `todo-prefix' and `todo-number-prefix'."
6150 ;; Activate the new setting in the current category.
6154 "The :set function for user option `todo-nondiary-marker'."
6159 ;; Need to reset these to get font-locking right.
6162 todo-date-string-start
6163 ;; See comment in defvar of `todo-date-string-start'.
6180 nil t)
6192 "The :set function for `todo-done-separator-string'."
6207 "The :set function for user option `todo-done-string'."
6212 ;; Need to reset this to get font-locking right.
6226 nil t)
6236 "The :set function for user option `todo-comment-string'."
6252 nil t)
6262 "The :set function for user option `todo-highlight-item'."
6278 "Update defcustoms that provide choice list of todo files."
6284 ;; -----------------------------------------------------------------------------
6285 ;;; Font locking
6286 ;; -----------------------------------------------------------------------------
6289 "Search for todo item nondiary markers within LIM for font-locking."
6293 lim t))
6296 "Search for diary nonmarking symbol within LIM for font-locking."
6299 lim t))
6302 "Search for todo item date string within LIM for font-locking."
6307 "Search for todo item time string within LIM for font-locking."
6310 lim t))
6313 "Search for expired diary item date within LIM for font-locking."
6318 lim t)
6321 ;; Function days-between requires a non-empty time string.
6328 "Search for done todo item header within LIM for font-locking."
6331 lim t))
6334 "Search for done todo item comment within LIM for font-locking."
6336 lim t))
6339 "Search for todo category name within LIM for font-locking.
6340 This is for fontifying category and file names appearing in Todo
6341 Filtered Items mode following done items."
6345 ;; Use non-greedy operator to prevent
6346 ;; capturing possible following non-diary
6347 ;; date string.
6349 lim t)))
6352 "Search for todo category name within LIM for font-locking.
6353 This is for fontifying category and file names appearing in Todo
6354 Filtered Items mode following todo (not done) items."
6360 lim t)))
6374 ;; diary-lib.el uses font-lock-constant-face for diary-nonmarking-symbol.
6384 )
6387 ;; -----------------------------------------------------------------------------
6388 ;;; Key binding
6389 ;; -----------------------------------------------------------------------------
6392 `(
6425 )
6429 `(
6448 )
6452 `(
6459 )
6463 `(
6467 )
6480 map)
6491 map)
6498 map)
6514 (define-key map [backtab] 'todo-previous-button)
6515 (define-key map "q" 'todo-quit)
6516 map)
6517 "Todo Categories mode keymap.")
6519 (defvar todo-filtered-items-mode-map
6520 (let ((map (make-sparse-keymap)))
6521 (dolist (kb todo-key-bindings-t+a+f)
6522 (define-key map (nth 0 kb) (nth 1 kb)))
6523 (dolist (kb todo-key-bindings-t+f)
6524 (define-key map (nth 0 kb) (nth 1 kb)))
6525 (define-key map "g" 'todo-go-to-source-item)
6526 (define-key map [remap newline] 'todo-go-to-source-item)
6527 map)
6528 "Todo Filtered Items mode keymap.")
6530 (easy-menu-define
6531 todo-menu todo-mode-map "Todo Menu"
6532 '("Todo"
6533 ("Navigation"
6534 ["Next Item" todo-next-item t]
6535 ["Previous Item" todo-previous-item t]
6536 "---"
6537 ["Next Category" todo-forward-category t]
6538 ["Previous Category" todo-backward-category t]
6539 ["Jump to Another Category" todo-jump-to-category t]
6540 "---"
6541 ["Visit Another Todo File" todo-show t]
6542 ["Visit Archive" todo-find-archive t]
6543 ["Visit Filtered Items File" todo-find-filtered-items-file t]
6544 )
6545 ("Editing"
6546 ["Insert New Item" todo-insert-item t]
6547 ["Edit Item" todo-edit-item t]
6548 ["Lower Item Priority" todo-lower-item-priority t]
6549 ["Raise Item Priority" todo-raise-item-priority t]
6550 ["Set Item Priority" todo-set-item-priority t]
6551 ["Mark/Unmark Item" todo-toggle-mark-item t]
6552 ["Move (Recategorize) Item" todo-move-item t]
6553 ["Delete Item" todo-delete-item t]
6554 ["Mark and Bury Done Item" todo-item-done t]
6555 ["Undo Done Item" todo-item-undone t]
6556 ["Archive Done Item" todo-archive-done-item t]
6557 "---"
6558 ["Add New Category" todo-add-category t]
6559 ["Rename Current Category" todo-rename-category t]
6560 ["Delete Current Category" todo-delete-category t]
6561 ["Move Current Category" todo-move-category t]
6562 ["Merge Current Category" todo-merge-category t]
6563 "---"
6564 ["Add New Todo File" todo-add-file t]
6565 ["Rename Todo File" todo-rename-file t]
6566 ["Delete Todo File" todo-delete-file t]
6567 ["Edit Todo File" todo-edit-file t]
6568 )
6569 ("Searching and Item Filtering"
6570 ["Search Todo File" todo-search t]
6571 ["Clear Match Highlighting" todo-clear-matches t]
6572 "---"
6573 ["Set Top Priorities in File" todo-set-top-priorities-in-file t]
6574 ["Set Top Priorities in Category" todo-set-top-priorities-in-category t]
6575 ["Filter Top Priorities" todo-filter-top-priorities t]
6576 ["Filter Multifile Top Priorities" todo-filter-top-priorities-multifile t]
6577 ["Filter Diary Items" todo-filter-diary-items t]
6578 ["Filter Multifile Diary Items" todo-filter-diary-items-multifile t]
6579 ["Filter Regexp" todo-filter-regexp-items t]
6580 ["Filter Multifile Regexp" todo-filter-regexp-items-multifile t]
6581 )
6582 ("Display and Printing"
6583 ["Show/Hide Done Items" todo-toggle-view-done-items t]
6584 ["Show/Hide Done Items Only" todo-toggle-view-done-only t]
6585 ["Show/Hide Item Highlighting" todo-toggle-item-highlighting t]
6586 ["Show/Hide Item Numbering" todo-toggle-prefix-numbers t]
6587 ["Show/Hide Item Header" todo-toggle-item-header t]
6588 "---"
6589 ["Display Table of Categories" todo-show-categories-table t]
6590 "---"
6591 ["Print Category" todo-print-buffer t]
6592 ["Print Category to File" todo-print-buffer-to-file t]
6593 )
6594 "---"
6595 ["Save Todo File" todo-save t]
6596 ["Quit Todo Mode" todo-quit t]
6597 ))
6599 ;; -----------------------------------------------------------------------------
6600 ;;; Hook functions and mode definitions
6601 ;; -----------------------------------------------------------------------------
6603 (defun todo-show-current-file ()
6604 "Visit current instead of default todo file with `todo-show'.
6605 Added to `pre-command-hook' in Todo mode when user option
6606 `todo-show-current-file' is set to non-nil."
6607 (setq todo-global-current-todo-file todo-current-todo-file))
6609 ;; (defun todo-display-as-todo-file ()
6610 ;; "Show todo files correctly when visited from outside of Todo mode.
6611 ;; Added to `find-file-hook' in Todo mode and Todo Archive mode."
6612 ;; (and (member this-command todo-visit-files-commands)
6613 ;; (= (- (point-max) (point-min)) (buffer-size))
6614 ;; (member major-mode '(todo-mode todo-archive-mode))
6615 ;; (todo-category-select)))
6617 ;; (defun todo-add-to-buffer-list ()
6618 ;; "Add name of just visited todo file to `todo-file-buffers'.
6619 ;; This function is added to `find-file-hook' in Todo mode."
6620 ;; (let ((filename (file-truename (buffer-file-name))))
6621 ;; (when (member filename todo-files)
6622 ;; (add-to-list 'todo-file-buffers filename))))
6624 (defun todo-update-buffer-list ()
6625 "Make current Todo mode buffer file car of `todo-file-buffers'.
6626 This function is added to `post-command-hook' in Todo mode."
6627 (let ((filename (file-truename (buffer-file-name))))
6628 (unless (eq (car todo-file-buffers) filename)
6629 (setq todo-file-buffers
6630 (cons filename (delete filename todo-file-buffers))))))
6632 (defun todo-reset-global-current-todo-file ()
6633 "Update the value of `todo-global-current-todo-file'.
6634 This becomes the latest existing todo file or, if there is none,
6635 the value of `todo-default-todo-file'.
6636 This function is added to `kill-buffer-hook' in Todo mode."
6637 (let ((filename (file-truename (buffer-file-name))))
6638 (setq todo-file-buffers (delete filename todo-file-buffers))
6639 (setq todo-global-current-todo-file
6640 (or (car todo-file-buffers)
6641 (todo-absolute-file-name todo-default-todo-file)))))
6643 (defun todo-reset-and-enable-done-separator ()
6644 "Show resized done items separator overlay after window change.
6645 Added to `window-configuration-change-hook' in Todo mode."
6646 (when (= 1 (length todo-done-separator-string))
6647 (let ((sep todo-done-separator))
6648 (setq todo-done-separator (todo-done-separator))
6649 (save-match-data (todo-reset-done-separator sep)))))
6651 (defun todo-modes-set-1 ()
6652 "Make some settings that apply to multiple Todo modes."
6653 (setq-local font-lock-defaults '(todo-font-lock-keywords t))
6654 (setq-local revert-buffer-function #'todo-revert-buffer)
6655 (setq-local tab-width todo-indent-to-here)
6656 (setq-local indent-line-function #'todo-indent)
6657 (when todo-wrap-lines
6658 (visual-line-mode)
6659 (setq wrap-prefix (make-string todo-indent-to-here 32))))
6661 (defun todo-hl-line-range ()
6662 "Make `todo-toggle-item-highlighting' highlight entire item."
6663 (save-excursion
6664 (when (todo-item-end)
6665 (cons (todo-item-start)
6666 (todo-item-end)))))
6668 (defun todo-modes-set-2 ()
6669 "Make some settings that apply to multiple Todo modes."
6670 (add-to-invisibility-spec 'todo)
6671 (setq buffer-read-only t)
6672 (setq-local todo--item-headers-hidden nil)
6673 (setq-local desktop-save-buffer 'todo-desktop-save-buffer)
6674 (setq-local hl-line-range-function #'todo-hl-line-range))
6676 (defun todo-modes-set-3 ()
6677 "Make some settings that apply to multiple Todo modes."
6678 (setq-local todo-categories (todo-set-categories))
6679 (setq-local todo-category-number 1)
6680 ;; (add-hook 'find-file-hook #'todo-display-as-todo-file nil t)
6681 )
6683 (put 'todo-mode 'mode-class 'special)
6685 ;;;###autoload
6686 (define-derived-mode todo-mode special-mode "Todo"
6687 "Major mode for displaying, navigating and editing todo lists.
6690 (if (called-interactively-p 'any)
6691 (message "%s"
6692 (substitute-command-keys
6694 (todo-modes-set-1)
6695 (todo-modes-set-2)
6696 (todo-modes-set-3)
6697 ;; Initialize todo-current-todo-file.
6698 (when (member (file-truename (buffer-file-name))
6699 (funcall todo-files-function))
6700 (setq-local todo-current-todo-file (file-truename (buffer-file-name))))
6701 (setq-local todo-show-done-only nil)
6702 (setq-local todo-categories-with-marks nil)
6703 ;; (add-hook 'find-file-hook #'todo-add-to-buffer-list nil t)
6704 (add-hook 'post-command-hook #'todo-update-buffer-list nil t)
6705 (when todo-show-current-file
6706 (add-hook 'pre-command-hook #'todo-show-current-file nil t))
6707 (add-hook 'window-configuration-change-hook
6708 #'todo-reset-and-enable-done-separator nil t)
6709 (add-hook 'kill-buffer-hook #'todo-reset-global-current-todo-file nil t)))
6711 (put 'todo-archive-mode 'mode-class 'special)
6713 ;; If todo-mode is parent, all todo-mode key bindings appear to be
6714 ;; available in todo-archive-mode (e.g. shown by C-h m).
6715 ;;;###autoload
6716 (define-derived-mode todo-archive-mode special-mode "Todo-Arch"
6717 "Major mode for archived todo categories.
6720 (todo-modes-set-1)
6721 (todo-modes-set-2)
6722 (todo-modes-set-3)
6723 (setq-local todo-current-todo-file (file-truename (buffer-file-name)))
6724 (setq-local todo-show-done-only t))
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 (if (> (buffer-size) (- (point-max) (point-min)))
6732 ;; Editing one item in an indirect buffer, so buffer-file-name is nil.
6733 (setq-local todo-current-todo-file todo-global-current-todo-file)
6734 ;; When editing archive file, make sure it is current todo file.
6735 (setq-local todo-current-todo-file (file-truename (buffer-file-name)))
6736 ;; Need this when editing the whole file to return to the category
6737 ;; editing was invoked from.
6738 (setq-local todo-categories (todo-set-categories)))
6739 (setq buffer-read-only nil))
6741 (put 'todo-categories-mode 'mode-class 'special)
6743 (define-derived-mode todo-categories-mode special-mode "Todo-Cats"
6744 "Major mode for displaying and editing todo categories.
6747 (setq-local todo-current-todo-file todo-global-current-todo-file)
6748 (setq-local todo-categories
6749 ;; Can't use find-buffer-visiting when
6750 ;; `todo-show-categories-table' is called on first
6751 ;; invocation of `todo-show', since there is then no
6752 ;; buffer visiting the current file.
6753 (with-current-buffer (find-file-noselect
6754 todo-current-todo-file 'nowarn)
6755 todo-categories)))
6757 (put 'todo-filtered-items-mode 'mode-class 'special)
6759 ;;;###autoload
6760 (define-derived-mode todo-filtered-items-mode special-mode "Todo-Fltr"
6761 "Mode for displaying and reprioritizing top priority Todo.
6764 (todo-modes-set-1)
6765 (todo-modes-set-2))
6767 ;; -----------------------------------------------------------------------------
6768 (provide 'todo-mode)
6770 ;;; todo-mode.el ends here