-;;; todos.el --- facilities for making and maintaining todo lists
+;;; todo-mode.el --- facilities for making and maintaining todo lists
;; Copyright (C) 1997, 1999, 2001-2013 Free Software Foundation, Inc.
;; level of organization. You can create as many todo files, and in
;; each as many categories, as you want.
-;; With Todos you can navigate among the items of a category, and
+;; With Todo mode you can navigate among the items of a category, and
;; between categories in the same and in different todo files. You
;; can edit todo items, reprioritize them within their category, move
;; them to another category, delete them, or mark items as done and
;; contain. And you can build cross-categorial lists of items that
;; satisfy various criteria.
-;; To get started, load this package and type `M-x todos-show'. This
+;; To get started, load this package and type `M-x todo-show'. This
;; will prompt you for the name of the first todo file, its first
;; category and the category's first item, create these and display
-;; them in Todos mode. Now you can insert further items into the list
+;; them in Todo mode. Now you can insert further items into the list
;; (i.e., the category) and assign them priorities by typing `i i'.
-;; You will probably find it convenient to give `todos-show' a global
+;; You will probably find it convenient to give `todo-show' a global
;; key binding in your init file, since it is one of the entry points
-;; to Todos mode; a good choice is `C-c t', since `todos-show' is
-;; bound to `t' in Todos mode.
+;; to Todo mode; a good choice is `C-c t', since `todo-show' is
+;; bound to `t' in Todo mode.
-;; To see a list of all Todos mode commands and their key bindings,
-;; including other entry points, type `C-h m' in Todos mode. Consult
+;; To see a list of all Todo mode commands and their key bindings,
+;; including other entry points, type `C-h m' in Todo mode. Consult
;; the document strings of the commands for details of their use. The
-;; `todos' customization group and its subgroups list the options you
+;; `todo' customization group and its subgroups list the options you
;; can set to alter the behavior of many commands and various aspects
;; of the display.
;; lists and the basic UI, it significantly extends these and adds
;; many features. This also required making changes to the internals,
;; including the file format. To convert files in the old format to
-;; the new format, use the command `todos-convert-legacy-files'.
+;; the new format, use the command `todo-convert-legacy-files'.
;;; Code:
(require 'diary-lib)
-;; For cl-remove-duplicates (in todos-insertion-commands-args) and
+;; For cl-remove-duplicates (in todo-insertion-commands-args) and
;; cl-oddp.
(require 'cl-lib)
;; -----------------------------------------------------------------------------
-;;; Setting up Todos files, categories, and items
+;;; Setting up Todo files, categories, and items
;; -----------------------------------------------------------------------------
-(defcustom todos-directory (locate-user-emacs-file "todos/")
- "Directory where user's Todos files are saved."
+(defcustom todo-directory (locate-user-emacs-file "todo/")
+ "Directory where user's Todo files are saved."
:type 'directory
- :group 'todos)
+ :group 'todo)
-(defun todos-files (&optional archives)
- "Default value of `todos-files-function'.
+(defun todo-files (&optional archives)
+ "Default value of `todo-files-function'.
This returns the case-insensitive alphabetically sorted list of
-file truenames in `todos-directory' with the extension
+file truenames in `todo-directory' with the extension
\".todo\". With non-nil ARCHIVES return the list of archive file
truenames (those with the extension \".toda\")."
- (let ((files (if (file-exists-p todos-directory)
+ (let ((files (if (file-exists-p todo-directory)
(mapcar 'file-truename
- (directory-files todos-directory t
+ (directory-files todo-directory t
(if archives "\.toda$" "\.todo$") t)))))
(sort files (lambda (s1 s2) (let ((cis1 (upcase s1))
(cis2 (upcase s2)))
(string< cis1 cis2))))))
-(defcustom todos-files-function 'todos-files
- "Function returning the value of the variable `todos-files'.
+(defcustom todo-files-function 'todo-files
+ "Function returning the value of the variable `todo-files'.
This function should take an optional argument that, if non-nil,
-makes it return the value of the variable `todos-archives'."
+makes it return the value of the variable `todo-archives'."
:type 'function
- :group 'todos)
+ :group 'todo)
-(defvar todos-files (funcall todos-files-function)
- "List of truenames of user's Todos files.")
+(defvar todo-files (funcall todo-files-function)
+ "List of truenames of user's Todo files.")
-(defvar todos-archives (funcall todos-files-function t)
- "List of truenames of user's Todos archives.")
+(defvar todo-archives (funcall todo-files-function t)
+ "List of truenames of user's Todo archives.")
-(defvar todos-visited nil
- "List of Todos files visited in this session by `todos-show'.
+(defvar todo-visited nil
+ "List of Todo files visited in this session by `todo-show'.
Used to determine initial display according to the value of
-`todos-show-first'.")
+`todo-show-first'.")
-(defvar todos-file-buffers nil
- "List of file names of live Todos mode buffers.")
+(defvar todo-file-buffers nil
+ "List of file names of live Todo mode buffers.")
-(defvar todos-global-current-todos-file nil
- "Variable holding name of current Todos file.
-Used by functions called from outside of Todos mode to visit the
-current Todos file rather than the default Todos file (i.e. when
-users option `todos-show-current-file' is non-nil).")
+(defvar todo-global-current-todo-file nil
+ "Variable holding name of current Todo file.
+Used by functions called from outside of Todo mode to visit the
+current Todo file rather than the default Todo file (i.e. when
+users option `todo-show-current-file' is non-nil).")
-(defvar todos-current-todos-file nil
- "Variable holding the name of the currently active Todos file.")
+(defvar todo-current-todo-file nil
+ "Variable holding the name of the currently active Todo file.")
-(defvar todos-categories nil
- "Alist of categories in the current Todos file.
+(defvar todo-categories nil
+ "Alist of categories in the current Todo file.
The elements are cons cells whose car is a category name and
whose cdr is a vector of the category's item counts. These are,
in order, the numbers of todo items, of todo items included in
the Diary, of done items and of archived items.")
-(defvar todos-category-number 1
- "Variable holding the number of the current Todos category.
-Todos categories are numbered starting from 1.")
+(defvar todo-category-number 1
+ "Variable holding the number of the current Todo category.
+Todo categories are numbered starting from 1.")
-(defvar todos-categories-with-marks nil
+(defvar todo-categories-with-marks nil
"Alist of categories and number of marked items they contain.")
-(defconst todos-category-beg "--==-- "
+(defconst todo-category-beg "--==-- "
"String marking beginning of category (inserted with its name).")
-(defconst todos-category-done "==--== DONE "
+(defconst todo-category-done "==--== DONE "
"String marking beginning of category's done items.")
-(defcustom todos-done-separator-string "="
- "String determining the value of variable `todos-done-separator'.
+(defcustom todo-done-separator-string "="
+ "String determining the value of variable `todo-done-separator'.
If the string consists of a single character,
-`todos-done-separator' will be the string made by repeating this
+`todo-done-separator' will be the string made by repeating this
character for the width of the window, and the length is
automatically recalculated when the window width changes. If the
string consists of more (or less) than one character, it will be
-the value of `todos-done-separator'."
+the value of `todo-done-separator'."
:type 'string
:initialize 'custom-initialize-default
- :set 'todos-reset-done-separator-string
- :group 'todos-display)
+ :set 'todo-reset-done-separator-string
+ :group 'todo-display)
-(defun todos-done-separator ()
- "Return string used as value of variable `todos-done-separator'."
- (let ((sep todos-done-separator-string))
+(defun todo-done-separator ()
+ "Return string used as value of variable `todo-done-separator'."
+ (let ((sep todo-done-separator-string))
(propertize (if (= 1 (length sep))
;; Until bug#2749 is fixed, if separator's length
- ;; is window-width and todos-wrap-lines is
+ ;; is window-width and todo-wrap-lines is
;; non-nil, an indented empty line appears between
;; the separator and the first done item.
;; (make-string (window-width) (string-to-char sep))
(make-string (1- (window-width)) (string-to-char sep))
- todos-done-separator-string)
- 'face 'todos-done-sep)))
+ todo-done-separator-string)
+ 'face 'todo-done-sep)))
-(defvar todos-done-separator (todos-done-separator)
+(defvar todo-done-separator (todo-done-separator)
"String used to visually separate done from not done items.
-Displayed as an overlay instead of `todos-category-done' when
+Displayed as an overlay instead of `todo-category-done' when
done items are shown. Its value is determined by user option
-`todos-done-separator-string'.")
+`todo-done-separator-string'.")
-(defvar todos-show-done-only nil
+(defvar todo-show-done-only nil
"If non-nil display only done items in current category.
-Set by the command `todos-toggle-view-done-only' and used by
-`todos-category-select'.")
+Set by the command `todo-toggle-view-done-only' and used by
+`todo-category-select'.")
-(defcustom todos-nondiary-marker '("[" "]")
+(defcustom todo-nondiary-marker '("[" "]")
"List of strings surrounding item date to block diary inclusion.
The first string is inserted before the item date and must be a
non-empty string that does not match a diary date in order to
have its intended effect. The second string is inserted after
the diary date."
:type '(list string string)
- :group 'todos-edit
+ :group 'todo-edit
:initialize 'custom-initialize-default
- :set 'todos-reset-nondiary-marker)
+ :set 'todo-reset-nondiary-marker)
-(defconst todos-nondiary-start (nth 0 todos-nondiary-marker)
+(defconst todo-nondiary-start (nth 0 todo-nondiary-marker)
"String inserted before item date to block diary inclusion.")
-(defconst todos-nondiary-end (nth 1 todos-nondiary-marker)
- "String inserted after item date matching `todos-nondiary-start'.")
+(defconst todo-nondiary-end (nth 1 todo-nondiary-marker)
+ "String inserted after item date matching `todo-nondiary-start'.")
-(defconst todos-month-name-array
+(defconst todo-month-name-array
(vconcat calendar-month-name-array (vector "*"))
"Array of month names, in order.
The final element is \"*\", indicating an unspecified month.")
-(defconst todos-month-abbrev-array
+(defconst todo-month-abbrev-array
(vconcat calendar-month-abbrev-array (vector "*"))
"Array of abbreviated month names, in order.
The final element is \"*\", indicating an unspecified month.")
-(defconst todos-date-pattern
+(defconst todo-date-pattern
(let ((dayname (diary-name-pattern calendar-day-name-array nil t)))
(concat "\\(?4:\\(?5:" dayname "\\)\\|"
(let ((dayname)
(monthname (format "\\(?6:%s\\)" (diary-name-pattern
- todos-month-name-array
- todos-month-abbrev-array)))
+ todo-month-name-array
+ todo-month-abbrev-array)))
(month "\\(?7:[0-9]+\\|\\*\\)")
(day "\\(?8:[0-9]+\\|\\*\\)")
(year "-?\\(?9:[0-9]+\\|\\*\\)"))
(mapconcat 'eval calendar-date-display-form ""))
"\\)"))
- "Regular expression matching a Todos date header.")
+ "Regular expression matching a Todo date header.")
;; By itself this matches anything, because of the `?'; however, it's only
-;; used in the context of `todos-date-pattern' (but Emacs Lisp lacks
+;; used in the context of `todo-date-pattern' (but Emacs Lisp lacks
;; lookahead).
-(defconst todos-date-string-start
- (concat "^\\(" (regexp-quote todos-nondiary-start) "\\|"
+(defconst todo-date-string-start
+ (concat "^\\(" (regexp-quote todo-nondiary-start) "\\|"
(regexp-quote diary-nonmarking-symbol) "\\)?")
"Regular expression matching part of item header before the date.")
-(defcustom todos-done-string "DONE "
- "Identifying string appended to the front of done todos items."
+(defcustom todo-done-string "DONE "
+ "Identifying string appended to the front of done todo items."
:type 'string
:initialize 'custom-initialize-default
- :set 'todos-reset-done-string
- :group 'todos-edit)
+ :set 'todo-reset-done-string
+ :group 'todo-edit)
-(defconst todos-done-string-start
- (concat "^\\[" (regexp-quote todos-done-string))
+(defconst todo-done-string-start
+ (concat "^\\[" (regexp-quote todo-done-string))
"Regular expression matching start of done item.")
-(defconst todos-item-start (concat "\\(" todos-date-string-start "\\|"
- todos-done-string-start "\\)"
- todos-date-pattern)
- "String identifying start of a Todos item.")
+(defconst todo-item-start (concat "\\(" todo-date-string-start "\\|"
+ todo-done-string-start "\\)"
+ todo-date-pattern)
+ "String identifying start of a Todo item.")
;; -----------------------------------------------------------------------------
-;;; Todos mode display options
+;;; Todo mode display options
;; -----------------------------------------------------------------------------
-(defcustom todos-prefix ""
+(defcustom todo-prefix ""
"String prefixed to todo items for visual distinction."
:type '(string :validate
(lambda (widget)
- (when (string= (widget-value widget) todos-item-mark)
+ (when (string= (widget-value widget) todo-item-mark)
(widget-put
widget :error
- "Invalid value: must be distinct from `todos-item-mark'")
+ "Invalid value: must be distinct from `todo-item-mark'")
widget)))
:initialize 'custom-initialize-default
- :set 'todos-reset-prefix
- :group 'todos-display)
+ :set 'todo-reset-prefix
+ :group 'todo-display)
-(defcustom todos-number-prefix t
+(defcustom todo-number-prefix t
"Non-nil to prefix items with consecutively increasing integers.
These reflect the priorities of the items in each category."
:type 'boolean
:initialize 'custom-initialize-default
- :set 'todos-reset-prefix
- :group 'todos-display)
+ :set 'todo-reset-prefix
+ :group 'todo-display)
-(defun todos-mode-line-control (cat)
+(defun todo-mode-line-control (cat)
"Return a mode line control for todo or archive file buffers.
-Argument CAT is the name of the current Todos category.
+Argument CAT is the name of the current Todo category.
This function is the value of the user variable
-`todos-mode-line-function'."
- (let ((file (todos-short-file-name todos-current-todos-file)))
- (format "%s category %d: %s" file todos-category-number cat)))
+`todo-mode-line-function'."
+ (let ((file (todo-short-file-name todo-current-todo-file)))
+ (format "%s category %d: %s" file todo-category-number cat)))
-(defcustom todos-mode-line-function 'todos-mode-line-control
- "Function that returns a mode line control for Todos buffers.
+(defcustom todo-mode-line-function 'todo-mode-line-control
+ "Function that returns a mode line control for Todo buffers.
The function expects one argument holding the name of the current
-Todos category. The resulting control becomes the local value of
-`mode-line-buffer-identification' in each Todos buffer."
+Todo category. The resulting control becomes the local value of
+`mode-line-buffer-identification' in each Todo buffer."
:type 'function
- :group 'todos-display)
+ :group 'todo-display)
-(defcustom todos-highlight-item nil
+(defcustom todo-highlight-item nil
"Non-nil means highlight items at point."
:type 'boolean
:initialize 'custom-initialize-default
- :set 'todos-reset-highlight-item
- :group 'todos-display)
+ :set 'todo-reset-highlight-item
+ :group 'todo-display)
-(defcustom todos-wrap-lines t
+(defcustom todo-wrap-lines t
"Non-nil to activate Visual Line mode and use wrap prefix."
:type 'boolean
- :group 'todos-display)
+ :group 'todo-display)
-(defcustom todos-indent-to-here 3
+(defcustom todo-indent-to-here 3
"Number of spaces to indent continuation lines of items.
This must be a positive number to ensure such items are fully
shown in the Fancy Diary display."
(widget-put widget :error
"Invalid value: must be a positive integer")
widget)))
- :group 'todos-display)
+ :group 'todo-display)
-(defun todos-indent ()
- "Indent from point to `todos-indent-to-here'."
- (indent-to todos-indent-to-here todos-indent-to-here))
+(defun todo-indent ()
+ "Indent from point to `todo-indent-to-here'."
+ (indent-to todo-indent-to-here todo-indent-to-here))
-(defcustom todos-show-with-done nil
+(defcustom todo-show-with-done nil
"Non-nil to display done items in all categories."
:type 'boolean
- :group 'todos-display)
+ :group 'todo-display)
;; -----------------------------------------------------------------------------
;;; Faces
;; -----------------------------------------------------------------------------
-(defface todos-mark
+(defface todo-mark
;; '((t :inherit font-lock-warning-face))
'((((class color)
(min-colors 88)
(t
(:weight bold :inverse-video t)))
"Face for marks on marked items."
- :group 'todos-faces)
+ :group 'todo-faces)
-(defface todos-prefix-string
+(defface todo-prefix-string
;; '((t :inherit font-lock-constant-face))
'((((class grayscale) (background light))
(:foreground "LightGray" :weight bold :underline t))
(((class color) (min-colors 16) (background dark)) (:foreground "Aquamarine"))
(((class color) (min-colors 8)) (:foreground "magenta"))
(t (:weight bold :underline t)))
- "Face for Todos prefix or numerical priority string."
- :group 'todos-faces)
+ "Face for Todo prefix or numerical priority string."
+ :group 'todo-faces)
-(defface todos-top-priority
+(defface todo-top-priority
;; bold font-lock-comment-face
'((default :weight bold)
(((class grayscale) (background light)) :foreground "DimGray" :slant italic)
(((class color) (min-colors 8) (background light)) :foreground "red")
(((class color) (min-colors 8) (background dark)) :foreground "yellow")
(t :slant italic))
- "Face for top priority Todos item numerical priority string.
+ "Face for top priority Todo item numerical priority string.
The item's priority number string has this face if the number is
less than or equal the category's top priority setting."
- :group 'todos-faces)
+ :group 'todo-faces)
-(defface todos-nondiary
+(defface todo-nondiary
;; '((t :inherit font-lock-type-face))
'((((class grayscale) (background light)) :foreground "Gray90" :weight bold)
(((class grayscale) (background dark)) :foreground "DimGray" :weight bold)
(((class color) (min-colors 8)) :foreground "green")
(t :weight bold :underline t))
"Face for non-diary markers around todo item date/time header."
- :group 'todos-faces)
+ :group 'todo-faces)
-(defface todos-date
+(defface todo-date
'((t :inherit diary))
- "Face for the date string of a Todos item."
- :group 'todos-faces)
+ "Face for the date string of a Todo item."
+ :group 'todo-faces)
-(defface todos-time
+(defface todo-time
'((t :inherit diary-time))
- "Face for the time string of a Todos item."
- :group 'todos-faces)
+ "Face for the time string of a Todo item."
+ :group 'todo-faces)
-(defface todos-diary-expired
- ;; Doesn't contrast enough with todos-date (= diary) face.
+(defface todo-diary-expired
+ ;; Doesn't contrast enough with todo-date (= diary) face.
;; ;; '((t :inherit warning))
;; '((default :weight bold)
;; (((class color) (min-colors 16)) :foreground "DarkOrange")
(((class color) (min-colors 8)) :foreground "blue")
(t :inverse-video t))
"Face for expired dates of diary items."
- :group 'todos-faces)
+ :group 'todo-faces)
-(defface todos-done-sep
+(defface todo-done-sep
;; '((t :inherit font-lock-builtin-face))
'((((class grayscale) (background light)) :foreground "LightGray" :weight bold)
(((class grayscale) (background dark)) :foreground "DimGray" :weight bold)
(((class color) (min-colors 16) (background dark)) :foreground "LightSteelBlue")
(((class color) (min-colors 8)) :foreground "blue" :weight bold)
(t :weight bold))
- "Face for separator string bewteen done and not done Todos items."
- :group 'todos-faces)
+ "Face for separator string bewteen done and not done Todo items."
+ :group 'todo-faces)
-(defface todos-done
+(defface todo-done
;; '((t :inherit font-lock-keyword-face))
'((((class grayscale) (background light)) :foreground "LightGray" :weight bold)
(((class grayscale) (background dark)) :foreground "DimGray" :weight bold)
(((class color) (min-colors 16) (background dark)) :foreground "Cyan")
(((class color) (min-colors 8)) :foreground "cyan" :weight bold)
(t :weight bold))
- "Face for done Todos item header string."
- :group 'todos-faces)
+ "Face for done Todo item header string."
+ :group 'todo-faces)
-(defface todos-comment
+(defface todo-comment
;; '((t :inherit font-lock-comment-face))
'((((class grayscale) (background light))
:foreground "DimGray" :weight bold :slant italic)
(((class color) (min-colors 8) (background dark))
:foreground "yellow")
(t :weight bold :slant italic))
- "Face for comments appended to done Todos items."
- :group 'todos-faces)
+ "Face for comments appended to done Todo items."
+ :group 'todo-faces)
-(defface todos-search
+(defface todo-search
;; '((t :inherit match))
'((((class color)
(min-colors 88)
(:inverse-video t))
(t
(:background "gray")))
- "Face for matches found by `todos-search'."
- :group 'todos-faces)
+ "Face for matches found by `todo-search'."
+ :group 'todo-faces)
-(defface todos-button
+(defface todo-button
;; '((t :inherit widget-field))
'((((type tty))
(:foreground "black" :background "yellow3"))
(t
(:slant italic)))
"Face for buttons in table of categories."
- :group 'todos-faces)
+ :group 'todo-faces)
-(defface todos-sorted-column
+(defface todo-sorted-column
'((((type tty))
(:inverse-video t))
(((class color)
(t
(:background "gray")))
"Face for sorted column in table of categories."
- :group 'todos-faces)
+ :group 'todo-faces)
-(defface todos-archived-only
+(defface todo-archived-only
;; '((t (:inherit (shadow))))
'((((class color)
(background light))
(t
(:foreground "gray")))
"Face for archived-only category names in table of categories."
- :group 'todos-faces)
+ :group 'todo-faces)
-(defface todos-category-string
+(defface todo-category-string
;; '((t :inherit font-lock-type-face))
'((((class grayscale) (background light)) :foreground "Gray90" :weight bold)
(((class grayscale) (background dark)) :foreground "DimGray" :weight bold)
(((class color) (min-colors 16) (background dark)) :foreground "PaleGreen")
(((class color) (min-colors 8)) :foreground "green")
(t :weight bold :underline t))
- "Face for category-file header in Todos Filtered Items mode."
- :group 'todos-faces)
+ "Face for category-file header in Todo Filtered Items mode."
+ :group 'todo-faces)
;; -----------------------------------------------------------------------------
-;;; Entering and exiting Todos
+;;; Entering and exiting Todo
;; -----------------------------------------------------------------------------
-(defcustom todos-visit-files-commands (list 'find-file 'dired-find-file)
- "List of file finding commands for `todos-display-as-todos-file'.
-Invoking these commands to visit a Todos or Todos Archive file
-calls `todos-show' or `todos-find-archive', so that the file is
+(defcustom todo-visit-files-commands (list 'find-file 'dired-find-file)
+ "List of file finding commands for `todo-display-as-todo-file'.
+Invoking these commands to visit a Todo or Todo Archive file
+calls `todo-show' or `todo-find-archive', so that the file is
displayed correctly."
:type '(repeat function)
- :group 'todos)
+ :group 'todo)
-(defun todos-short-file-name (file)
- "Return short form of Todos FILE.
+(defun todo-short-file-name (file)
+ "Return short form of Todo FILE.
This lacks the extension and directory components."
(when (stringp file)
(file-name-sans-extension (file-name-nondirectory file))))
-(defcustom todos-default-todos-file (todos-short-file-name
- (car (funcall todos-files-function)))
- "Todos file visited by first session invocation of `todos-show'."
+(defcustom todo-default-todo-file (todo-short-file-name
+ (car (funcall todo-files-function)))
+ "Todo file visited by first session invocation of `todo-show'."
:type `(radio ,@(mapcar (lambda (f) (list 'const f))
- (mapcar 'todos-short-file-name
- (funcall todos-files-function))))
- :group 'todos)
+ (mapcar 'todo-short-file-name
+ (funcall todo-files-function))))
+ :group 'todo)
-(defcustom todos-show-current-file t
- "Non-nil to make `todos-show' visit the current Todos file.
-Otherwise, `todos-show' always visits `todos-default-todos-file'."
+(defcustom todo-show-current-file t
+ "Non-nil to make `todo-show' visit the current Todo file.
+Otherwise, `todo-show' always visits `todo-default-todo-file'."
:type 'boolean
:initialize 'custom-initialize-default
- :set 'todos-set-show-current-file
- :group 'todos)
+ :set 'todo-set-show-current-file
+ :group 'todo)
-(defcustom todos-show-first 'first
- "What action to take on first use of `todos-show' on a file."
+(defcustom todo-show-first 'first
+ "What action to take on first use of `todo-show' on a file."
:type '(choice (const :tag "Show first category" first)
(const :tag "Show table of categories" table)
(const :tag "Show top priorities" top)
(const :tag "Show diary items" diary)
(const :tag "Show regexp items" regexp))
- :group 'todos)
+ :group 'todo)
-(defcustom todos-add-item-if-new-category t
+(defcustom todo-add-item-if-new-category t
"Non-nil to prompt for an item after adding a new category."
:type 'boolean
- :group 'todos-edit)
+ :group 'todo-edit)
-(defcustom todos-initial-file "Todo"
- "Default file name offered on adding first Todos file."
+(defcustom todo-initial-file "Todo"
+ "Default file name offered on adding first Todo file."
:type 'string
- :group 'todos)
+ :group 'todo)
-(defcustom todos-initial-category "Todo"
- "Default category name offered on initializing a new Todos file."
+(defcustom todo-initial-category "Todo"
+ "Default category name offered on initializing a new Todo file."
:type 'string
- :group 'todos)
+ :group 'todo)
-(defcustom todos-category-completions-files nil
- "List of files for building `todos-read-category' completions."
+(defcustom todo-category-completions-files nil
+ "List of files for building `todo-read-category' completions."
:type `(set ,@(mapcar (lambda (f) (list 'const f))
- (mapcar 'todos-short-file-name
- (funcall todos-files-function))))
- :group 'todos)
+ (mapcar 'todo-short-file-name
+ (funcall todo-files-function))))
+ :group 'todo)
-(defcustom todos-completion-ignore-case nil
- "Non-nil means case is ignored by `todos-read-*' functions."
+(defcustom todo-completion-ignore-case nil
+ "Non-nil means case is ignored by `todo-read-*' functions."
:type 'boolean
- :group 'todos)
+ :group 'todo)
-(defun todos-show (&optional solicit-file)
- "Visit a Todos file and display one of its categories.
+(defun todo-show (&optional solicit-file)
+ "Visit a Todo file and display one of its categories.
-When invoked in Todos mode, prompt for which todo file to visit.
-When invoked outside of Todos mode with non-nil prefix argument
+When invoked in Todo mode, prompt for which todo file to visit.
+When invoked outside of Todo mode with non-nil prefix argument
SOLICIT-FILE prompt for which todo file to visit; otherwise visit
-`todos-default-todos-file'. Subsequent invocations from outside
-of Todos mode revisit this file or, with option
-`todos-show-current-file' non-nil (the default), whichever Todos
+`todo-default-todo-file'. Subsequent invocations from outside
+of Todo mode revisit this file or, with option
+`todo-show-current-file' non-nil (the default), whichever Todo
file was last visited.
-Calling this command before any Todos file exists prompts for a
+Calling this command before any Todo file exists prompts for a
file name and an initial category (defaulting to
-`todos-initial-file' and `todos-initial-category'), creates both
+`todo-initial-file' and `todo-initial-category'), creates both
of these, visits the file and displays the category, and if
-option `todos-add-item-if-new-category' is non-nil (the default),
+option `todo-add-item-if-new-category' is non-nil (the default),
prompts for the first item.
-The first invocation of this command on an existing Todos file
-interacts with the option `todos-show-first': if its value is
+The first invocation of this command on an existing Todo file
+interacts with the option `todo-show-first': if its value is
`first' (the default), show the first category in the file; if
its value is `table', show the table of categories in the file;
if its value is one of `top', `diary' or `regexp', show the
file, if any. Subsequent invocations always show the file's
current (i.e., last displayed) category.
-In Todos mode just the category's unfinished todo items are shown
+In Todo mode just the category's unfinished todo items are shown
by default. The done items are hidden, but typing
-`\\[todos-toggle-view-done-items]' displays them below the todo
-items. With non-nil user option `todos-show-with-done' both todo
+`\\[todo-toggle-view-done-items]' displays them below the todo
+items. With non-nil user option `todo-show-with-done' both todo
and done items are always shown on visiting a category.
-Invoking this command in Todos Archive mode visits the
-corresponding Todos file, displaying the corresponding category."
+Invoking this command in Todo Archive mode visits the
+corresponding Todo file, displaying the corresponding category."
(interactive "P")
(let* ((cat)
- (show-first todos-show-first)
+ (show-first todo-show-first)
(file (cond ((or solicit-file
(and (called-interactively-p 'any)
- (memq major-mode '(todos-mode
- todos-archive-mode
- todos-filtered-items-mode))))
- (if (funcall todos-files-function)
- (todos-read-file-name "Choose a Todos file to visit: "
+ (memq major-mode '(todo-mode
+ todo-archive-mode
+ todo-filtered-items-mode))))
+ (if (funcall todo-files-function)
+ (todo-read-file-name "Choose a Todo file to visit: "
nil t)
- (user-error "There are no Todos files")))
- ((and (eq major-mode 'todos-archive-mode)
- ;; Called noninteractively via todos-quit
+ (user-error "There are no Todo files")))
+ ((and (eq major-mode 'todo-archive-mode)
+ ;; Called noninteractively via todo-quit
;; to jump to corresponding category in
;; todo file.
(not (called-interactively-p 'any)))
- (setq cat (todos-current-category))
+ (setq cat (todo-current-category))
(concat (file-name-sans-extension
- todos-current-todos-file) ".todo"))
+ todo-current-todo-file) ".todo"))
(t
- (or todos-current-todos-file
- (and todos-show-current-file
- todos-global-current-todos-file)
- (todos-absolute-file-name todos-default-todos-file)
- (todos-add-file)))))
+ (or todo-current-todo-file
+ (and todo-show-current-file
+ todo-global-current-todo-file)
+ (todo-absolute-file-name todo-default-todo-file)
+ (todo-add-file)))))
add-item first-file)
- (unless todos-default-todos-file
+ (unless todo-default-todo-file
;; We just initialized the first todo file, so make it the default.
- (setq todos-default-todos-file (todos-short-file-name file)
+ (setq todo-default-todo-file (todo-short-file-name file)
first-file t)
- (todos-reevaluate-default-file-defcustom))
- (unless (member file todos-visited)
+ (todo-reevaluate-default-file-defcustom))
+ (unless (member file todo-visited)
;; Can't setq t-c-t-f here, otherwise wrong file shown when
- ;; todos-show is called from todos-show-categories-table.
- (let ((todos-current-todos-file file))
- (cond ((eq todos-show-first 'table)
- (todos-show-categories-table))
- ((memq todos-show-first '(top diary regexp))
- (let* ((shortf (todos-short-file-name file))
- (fi-file (todos-absolute-file-name
- shortf todos-show-first)))
- (when (eq todos-show-first 'regexp)
- (let ((rxfiles (directory-files todos-directory t
+ ;; todo-show is called from todo-show-categories-table.
+ (let ((todo-current-todo-file file))
+ (cond ((eq todo-show-first 'table)
+ (todo-show-categories-table))
+ ((memq todo-show-first '(top diary regexp))
+ (let* ((shortf (todo-short-file-name file))
+ (fi-file (todo-absolute-file-name
+ shortf todo-show-first)))
+ (when (eq todo-show-first 'regexp)
+ (let ((rxfiles (directory-files todo-directory t
".*\\.todr$" t)))
(when (and rxfiles (> (length rxfiles) 1))
- (let ((rxf (mapcar 'todos-short-file-name rxfiles)))
- (setq fi-file (todos-absolute-file-name
+ (let ((rxf (mapcar 'todo-short-file-name rxfiles)))
+ (setq fi-file (todo-absolute-file-name
(completing-read
"Choose a regexp items file: "
rxf) 'regexp))))))
(selected-window)
(set-buffer (find-file-noselect fi-file 'nowarn)))
(message "There is no %s file for %s"
- (cond ((eq todos-show-first 'top)
+ (cond ((eq todo-show-first 'top)
"top priorities")
- ((eq todos-show-first 'diary)
+ ((eq todo-show-first 'diary)
"diary items")
- ((eq todos-show-first 'regexp)
+ ((eq todo-show-first 'regexp)
"regexp items"))
shortf)
- (setq todos-show-first 'first)))))))
- (when (or (member file todos-visited)
- (eq todos-show-first 'first))
+ (setq todo-show-first 'first)))))))
+ (when (or (member file todo-visited)
+ (eq todo-show-first 'first))
(set-window-buffer (selected-window)
(set-buffer (find-file-noselect file 'nowarn)))
;; When quitting archive file, show corresponding category in
- ;; Todos file, if it exists.
- (when (assoc cat todos-categories)
- (setq todos-category-number (todos-category-number cat)))
- ;; If this is a new Todos file, add its first category.
+ ;; Todo file, if it exists.
+ (when (assoc cat todo-categories)
+ (setq todo-category-number (todo-category-number cat)))
+ ;; If this is a new Todo file, add its first category.
(when (zerop (buffer-size))
(let (cat-added)
(unwind-protect
- (setq todos-category-number
- (todos-add-category todos-current-todos-file "")
- add-item todos-add-item-if-new-category
+ (setq todo-category-number
+ (todo-add-category todo-current-todo-file "")
+ add-item todo-add-item-if-new-category
cat-added t)
(if cat-added
;; If the category was added, save the file now, so we
;; If user cancels before adding the category, clean up
;; and exit, so we have a fresh slate the next time.
(delete-file file)
- (setq todos-files (delete file todos-files))
+ (setq todo-files (delete file todo-files))
(when first-file
- (setq todos-default-todos-file nil
- todos-current-todos-file nil))
+ (setq todo-default-todo-file nil
+ todo-current-todo-file nil))
(kill-buffer)
(keyboard-quit)))))
- (save-excursion (todos-category-select))
- (when add-item (todos-basic-insert-item)))
- (setq todos-show-first show-first)
- (add-to-list 'todos-visited file)))
+ (save-excursion (todo-category-select))
+ (when add-item (todo-basic-insert-item)))
+ (setq todo-show-first show-first)
+ (add-to-list 'todo-visited file)))
-(defun todos-save ()
- "Save the current Todos file."
+(defun todo-save ()
+ "Save the current Todo file."
(interactive)
- (cond ((eq major-mode 'todos-filtered-items-mode)
- (todos-check-filtered-items-file)
- (todos-save-filtered-items-buffer))
+ (cond ((eq major-mode 'todo-filtered-items-mode)
+ (todo-check-filtered-items-file)
+ (todo-save-filtered-items-buffer))
(t
(save-buffer))))
-(defvar todos-descending-counts)
+(defvar todo-descending-counts)
-(defun todos-quit ()
- "Exit the current Todos-related buffer.
+(defun todo-quit ()
+ "Exit the current Todo-related buffer.
Depending on the specific mode, this either kills the buffer or
buries it and restores state as needed."
(interactive)
(let ((buf (current-buffer)))
- (cond ((eq major-mode 'todos-categories-mode)
- ;; Postpone killing buffer till after calling todos-show, to
- ;; prevent killing todos-mode buffer.
- (setq todos-descending-counts nil)
- ;; Ensure todos-show calls todos-show-categories-table only on
+ (cond ((eq major-mode 'todo-categories-mode)
+ ;; Postpone killing buffer till after calling todo-show, to
+ ;; prevent killing todo-mode buffer.
+ (setq todo-descending-counts nil)
+ ;; Ensure todo-show calls todo-show-categories-table only on
;; first invocation per file.
- (when (eq todos-show-first 'table)
- (add-to-list 'todos-visited todos-current-todos-file))
- (todos-show)
+ (when (eq todo-show-first 'table)
+ (add-to-list 'todo-visited todo-current-todo-file))
+ (todo-show)
(kill-buffer buf))
- ((eq major-mode 'todos-filtered-items-mode)
+ ((eq major-mode 'todo-filtered-items-mode)
(kill-buffer)
- (unless (eq major-mode 'todos-mode) (todos-show)))
- ((eq major-mode 'todos-archive-mode)
+ (unless (eq major-mode 'todo-mode) (todo-show)))
+ ((eq major-mode 'todo-archive-mode)
;; Have to write a newly created archive to file to avoid
;; subsequent errors.
- (todos-save)
- (todos-show)
+ (todo-save)
+ (todo-show)
(bury-buffer buf))
- ((eq major-mode 'todos-mode)
- (todos-save)
+ ((eq major-mode 'todo-mode)
+ (todo-save)
;; If we just quit archive mode, just burying the buffer
- ;; in todos-mode would return to archive.
+ ;; in todo-mode would return to archive.
(set-window-buffer (selected-window)
(set-buffer (other-buffer)))
(bury-buffer buf)))))
;;; Navigation between and within categories
;; -----------------------------------------------------------------------------
-(defcustom todos-skip-archived-categories nil
+(defcustom todo-skip-archived-categories nil
"Non-nil to handle categories with only archived items specially.
-Sequential category navigation using \\[todos-forward-category]
-or \\[todos-backward-category] skips categories that contain only
+Sequential category navigation using \\[todo-forward-category]
+or \\[todo-backward-category] skips categories that contain only
archived items. Other commands still recognize these categories.
-In Todos Categories mode (\\[todos-show-categories-table]) these
-categories shown in `todos-archived-only' face and pressing the
+In Todo Categories mode (\\[todo-show-categories-table]) these
+categories shown in `todo-archived-only' face and pressing the
category button visits the category in the archive instead of the
todo file."
:type 'boolean
- :group 'todos-display)
+ :group 'todo-display)
-(defun todos-forward-category (&optional back)
- "Visit the numerically next category in this Todos file.
+(defun todo-forward-category (&optional back)
+ "Visit the numerically next category in this Todo file.
If the current category is the highest numbered, visit the first
category. With non-nil argument BACK, visit the numerically
previous category (the highest numbered one, if the current
category is the first)."
(interactive)
- (setq todos-category-number
- (1+ (mod (- todos-category-number (if back 2 0))
- (length todos-categories))))
- (when todos-skip-archived-categories
- (while (and (zerop (todos-get-count 'todo))
- (zerop (todos-get-count 'done))
- (not (zerop (todos-get-count 'archived))))
- (setq todos-category-number
- (apply (if back '1- '1+) (list todos-category-number)))))
- (todos-category-select)
+ (setq todo-category-number
+ (1+ (mod (- todo-category-number (if back 2 0))
+ (length todo-categories))))
+ (when todo-skip-archived-categories
+ (while (and (zerop (todo-get-count 'todo))
+ (zerop (todo-get-count 'done))
+ (not (zerop (todo-get-count 'archived))))
+ (setq todo-category-number
+ (apply (if back '1- '1+) (list todo-category-number)))))
+ (todo-category-select)
(goto-char (point-min)))
-(defun todos-backward-category ()
- "Visit the numerically previous category in this Todos file.
+(defun todo-backward-category ()
+ "Visit the numerically previous category in this Todo file.
If the current category is the highest numbered, visit the first
category."
(interactive)
- (todos-forward-category t))
+ (todo-forward-category t))
-(defvar todos-categories-buffer)
+(defvar todo-categories-buffer)
-(defun todos-jump-to-category (&optional file where)
- "Prompt for a category in a Todos file and jump to it.
+(defun todo-jump-to-category (&optional file where)
+ "Prompt for a category in a Todo file and jump to it.
With non-nil FILE (interactively a prefix argument), prompt for a
-specific Todos file and choose (with TAB completion) a category
+specific Todo file and choose (with TAB completion) a category
in it to jump to; otherwise, choose and jump to any category in
-either the current Todos file or a file in
-`todos-category-completions-files'.
+either the current Todo file or a file in
+`todo-category-completions-files'.
Also accept a non-existing category name and ask whether to add a
new category by that name; on confirmation, add it and jump to
-that category, and if option `todos-add-item-if-new-category' is
+that category, and if option `todo-add-item-if-new-category' is
non-nil (the default), then prompt for the first item.
In noninteractive calls non-nil WHERE specifies either the goal
category or its file. If its value is `archive', the choice of
categories is restricted to the current archive file or the
archive you were prompted to choose; this is used by
-`todos-jump-to-archive-category'. If its value is the name of a
-category, jump directly to that category; this is used in Todos
+`todo-jump-to-archive-category'. If its value is the name of a
+category, jump directly to that category; this is used in Todo
Categories mode."
(interactive "P")
- ;; If invoked outside of Todos mode and there is not yet any Todos
+ ;; If invoked outside of Todo mode and there is not yet any Todo
;; file, initialize one.
- (if (null todos-files)
- (todos-show)
+ (if (null todo-files)
+ (todo-show)
(let* ((archive (eq where 'archive))
(cat (unless archive where))
- (file0 (when cat ; We're in Todos Categories mode.
- ;; With non-nil `todos-skip-archived-categories'
+ (file0 (when cat ; We're in Todo Categories mode.
+ ;; With non-nil `todo-skip-archived-categories'
;; jump to archive file of a category with only
;; archived items.
- (if (and todos-skip-archived-categories
- (zerop (todos-get-count 'todo cat))
- (zerop (todos-get-count 'done cat))
- (not (zerop (todos-get-count 'archived cat))))
+ (if (and todo-skip-archived-categories
+ (zerop (todo-get-count 'todo cat))
+ (zerop (todo-get-count 'done cat))
+ (not (zerop (todo-get-count 'archived cat))))
(concat (file-name-sans-extension
- todos-current-todos-file) ".toda")
- ;; Otherwise, jump to current todos file.
- todos-current-todos-file)))
- (len (length todos-categories))
+ todo-current-todo-file) ".toda")
+ ;; Otherwise, jump to current todo file.
+ todo-current-todo-file)))
+ (len (length todo-categories))
(cat+file (unless cat
- (todos-read-category "Jump to category: "
+ (todo-read-category "Jump to category: "
(if archive 'archive) file)))
- (add-item (and todos-add-item-if-new-category
- (> (length todos-categories) len)))
+ (add-item (and todo-add-item-if-new-category
+ (> (length todo-categories) len)))
(category (or cat (car cat+file))))
(unless cat (setq file0 (cdr cat+file)))
(with-current-buffer (find-file-noselect file0 'nowarn)
- (setq todos-current-todos-file file0)
- ;; If called from Todos Categories mode, clean up before jumping.
- (if (string= (buffer-name) todos-categories-buffer)
+ (setq todo-current-todo-file file0)
+ ;; If called from Todo Categories mode, clean up before jumping.
+ (if (string= (buffer-name) todo-categories-buffer)
(kill-buffer))
(set-window-buffer (selected-window)
(set-buffer (find-buffer-visiting file0)))
- (unless todos-global-current-todos-file
- (setq todos-global-current-todos-file todos-current-todos-file))
- (todos-category-number category)
- (todos-category-select)
+ (unless todo-global-current-todo-file
+ (setq todo-global-current-todo-file todo-current-todo-file))
+ (todo-category-number category)
+ (todo-category-select)
(goto-char (point-min))
- (when add-item (todos-basic-insert-item))))))
+ (when add-item (todo-basic-insert-item))))))
-(defun todos-next-item (&optional count)
+(defun todo-next-item (&optional count)
"Move point down to the beginning of the next item.
With positive numerical prefix COUNT, move point COUNT items
downward.
(cond ((and current-prefix-arg (< count 1))
(user-error "The prefix argument must be a positive number"))
(current-prefix-arg
- (todos-forward-item count))
+ (todo-forward-item count))
(t
- (todos-forward-item))))
+ (todo-forward-item))))
-(defun todos-previous-item (&optional count)
+(defun todo-previous-item (&optional count)
"Move point up to start of item with next higher priority.
With positive numerical prefix COUNT, move point COUNT items
upward.
(cond ((and current-prefix-arg (< count 1))
(user-error "The prefix argument must be a positive number"))
(current-prefix-arg
- (todos-backward-item count))
+ (todo-backward-item count))
(t
- (todos-backward-item)))))
+ (todo-backward-item)))))
;; -----------------------------------------------------------------------------
;;; Display toggle commands
;; -----------------------------------------------------------------------------
-(defun todos-toggle-prefix-numbers ()
+(defun todo-toggle-prefix-numbers ()
"Hide item numbering if shown, show if hidden."
(interactive)
(save-excursion
(save-restriction
(goto-char (point-min))
- (let* ((ov (todos-get-overlay 'prefix))
- (show-done (re-search-forward todos-done-string-start nil t))
- (todos-show-with-done show-done)
- (todos-number-prefix (not (equal (overlay-get ov 'before-string)
+ (let* ((ov (todo-get-overlay 'prefix))
+ (show-done (re-search-forward todo-done-string-start nil t))
+ (todo-show-with-done show-done)
+ (todo-number-prefix (not (equal (overlay-get ov 'before-string)
"1 "))))
- (if (eq major-mode 'todos-filtered-items-mode)
- (todos-prefix-overlays)
- (todos-category-select))))))
+ (if (eq major-mode 'todo-filtered-items-mode)
+ (todo-prefix-overlays)
+ (todo-category-select))))))
-(defun todos-toggle-view-done-items ()
+(defun todo-toggle-view-done-items ()
"Show hidden or hide visible done items in current category."
(interactive)
- (if (zerop (todos-get-count 'done (todos-current-category)))
+ (if (zerop (todo-get-count 'done (todo-current-category)))
(message "There are no done items in this category.")
(let ((opoint (point)))
(goto-char (point-min))
- (let* ((shown (re-search-forward todos-done-string-start nil t))
- (todos-show-with-done (not shown)))
- (todos-category-select)
+ (let* ((shown (re-search-forward todo-done-string-start nil t))
+ (todo-show-with-done (not shown)))
+ (todo-category-select)
(goto-char opoint)
;; If start of done items sections is below the bottom of the
;; window, make it visible.
(unless shown
(setq shown (progn
(goto-char (point-min))
- (re-search-forward todos-done-string-start nil t)))
+ (re-search-forward todo-done-string-start nil t)))
(if (not (pos-visible-in-window-p shown))
(recenter)
(goto-char opoint)))))))
-(defun todos-toggle-view-done-only ()
+(defun todo-toggle-view-done-only ()
"Switch between displaying only done or only todo items."
(interactive)
- (setq todos-show-done-only (not todos-show-done-only))
- (todos-category-select))
+ (setq todo-show-done-only (not todo-show-done-only))
+ (todo-category-select))
-(defun todos-toggle-item-highlighting ()
+(defun todo-toggle-item-highlighting ()
"Highlight or unhighlight the todo item the cursor is on."
(interactive)
(eval-when-compile (require 'hl-line))
(when (memq major-mode
- '(todos-mode todos-archive-mode todos-filtered-items-mode))
+ '(todo-mode todo-archive-mode todo-filtered-items-mode))
(if hl-line-mode
(hl-line-mode -1)
(hl-line-mode 1))))
-(defun todos-toggle-item-header ()
+(defun todo-toggle-item-header ()
"Hide or show item date-time headers in the current file.
With done items, this hides only the done date-time string, not
the the original date-time string."
(save-excursion
(save-restriction
(goto-char (point-min))
- (let ((ov (todos-get-overlay 'header)))
+ (let ((ov (todo-get-overlay 'header)))
(if ov
- (remove-overlays 1 (1+ (buffer-size)) 'todos 'header)
+ (remove-overlays 1 (1+ (buffer-size)) 'todo 'header)
(widen)
(goto-char (point-min))
(while (not (eobp))
(when (re-search-forward
- (concat todos-item-start
+ (concat todo-item-start
"\\( " diary-time-regexp "\\)?"
- (regexp-quote todos-nondiary-end) "? ")
+ (regexp-quote todo-nondiary-end) "? ")
nil t)
(setq ov (make-overlay (match-beginning 0) (match-end 0) nil t))
- (overlay-put ov 'todos 'header)
+ (overlay-put ov 'todo 'header)
(overlay-put ov 'display ""))
- (todos-forward-item)))))))
+ (todo-forward-item)))))))
;; -----------------------------------------------------------------------------
;;; File and category editing
;; -----------------------------------------------------------------------------
-(defun todos-add-file ()
- "Name and initialize a new Todos file.
+(defun todo-add-file ()
+ "Name and initialize a new Todo file.
Interactively, prompt for a category and display it, and if
-option `todos-add-item-if-new-category' is non-nil (the default),
+option `todo-add-item-if-new-category' is non-nil (the default),
prompt for the first item.
Noninteractively, return the name of the new file."
(interactive)
- (let ((prompt (concat "Enter name of new Todos file "
+ (let ((prompt (concat "Enter name of new Todo file "
"(TAB or SPC to see current names): "))
file)
- (setq file (todos-read-file-name prompt))
+ (setq file (todo-read-file-name prompt))
(with-current-buffer (get-buffer-create file)
(erase-buffer)
(write-region (point-min) (point-max) file nil 'nomessage nil t)
(kill-buffer file))
- (setq todos-files (funcall todos-files-function))
- (todos-reevaluate-filelist-defcustoms)
+ (setq todo-files (funcall todo-files-function))
+ (todo-reevaluate-filelist-defcustoms)
(if (called-interactively-p 'any)
(progn
(set-window-buffer (selected-window)
(set-buffer (find-file-noselect file)))
- (setq todos-current-todos-file file)
- (todos-show))
+ (setq todo-current-todo-file file)
+ (todo-show))
file)))
-(defvar todos-edit-buffer "*Todos Edit*"
- "Name of current buffer in Todos Edit mode.")
+(defvar todo-edit-buffer "*Todo Edit*"
+ "Name of current buffer in Todo Edit mode.")
-(defun todos-edit-file ()
- "Put current buffer in `todos-edit-mode'.
+(defun todo-edit-file ()
+ "Put current buffer in `todo-edit-mode'.
This makes the entire file visible and the buffer writeable and
you can use the self-insertion keys and standard Emacs editing
-commands to make changes. To return to Todos mode, type
-\\[todos-edit-quit]. This runs a file format check, signalling
+commands to make changes. To return to Todo mode, type
+\\[todo-edit-quit]. This runs a file format check, signalling
an error if the format has become invalid. However, this check
cannot tell if the number of items changed, which could result in
the file containing inconsistent information. For this reason
this command should be used with caution."
(interactive)
(widen)
- (todos-edit-mode)
+ (todo-edit-mode)
(remove-overlays)
(message "%s" (substitute-command-keys
- (concat "Type \\[todos-edit-quit] to check file format "
- "validity and return to Todos mode.\n"))))
+ (concat "Type \\[todo-edit-quit] to check file format "
+ "validity and return to Todo mode.\n"))))
-(defun todos-add-category (&optional file cat)
- "Add a new category to a Todos file.
+(defun todo-add-category (&optional file cat)
+ "Add a new category to a Todo file.
Called interactively with prefix argument FILE, prompt for a file
and then for a new category to add to that file, otherwise prompt
-just for a category to add to the current Todos file. After
-adding the category, visit it in Todos mode and if option
-`todos-add-item-if-new-category' is non-nil (the default), prompt
+just for a category to add to the current Todo file. After
+adding the category, visit it in Todo mode and if option
+`todo-add-item-if-new-category' is non-nil (the default), prompt
for the first item.
Non-interactively, add category CAT to file FILE; if FILE is nil,
-add CAT to the current Todos file. After adding the category,
+add CAT to the current Todo file. After adding the category,
return the new category number."
(interactive "P")
(let (catfil file0)
;; which means the file was just added and has no category yet.
(if (and cat (> (length cat) 0))
(setq file0 (or (and (stringp file) file)
- todos-current-todos-file))
- (setq catfil (todos-read-category "Enter a new category name: "
+ todo-current-todo-file))
+ (setq catfil (todo-read-category "Enter a new category name: "
'add (when (called-interactively-p 'any)
file))
cat (car catfil)
file)))
(find-file file0)
(let ((counts (make-vector 4 0)) ; [todo diary done archived]
- (num (1+ (length todos-categories)))
+ (num (1+ (length todo-categories)))
(buffer-read-only nil))
- (setq todos-current-todos-file file0)
- (setq todos-categories (append todos-categories
+ (setq todo-current-todo-file file0)
+ (setq todo-categories (append todo-categories
(list (cons cat counts))))
(widen)
(goto-char (point-max))
- (save-excursion ; Save point for todos-category-select.
- (insert todos-category-beg cat "\n\n" todos-category-done "\n"))
- (todos-update-categories-sexp)
+ (save-excursion ; Save point for todo-category-select.
+ (insert todo-category-beg cat "\n\n" todo-category-done "\n"))
+ (todo-update-categories-sexp)
;; If invoked by user, display the newly added category, if
;; called programmatically return the category number to the
;; caller.
(if (called-interactively-p 'any)
(progn
- (setq todos-category-number num)
- (todos-category-select)
- (when todos-add-item-if-new-category
- (todos-basic-insert-item)))
+ (setq todo-category-number num)
+ (todo-category-select)
+ (when todo-add-item-if-new-category
+ (todo-basic-insert-item)))
num))))
-(defun todos-rename-category ()
- "Rename current Todos category.
+(defun todo-rename-category ()
+ "Rename current Todo category.
If this file has an archive containing this category, rename the
category there as well."
(interactive)
- (let* ((cat (todos-current-category))
+ (let* ((cat (todo-current-category))
(new (read-from-minibuffer
(format "Rename category \"%s\" to: " cat))))
- (setq new (todos-validate-name new 'category))
- (let* ((ofile todos-current-todos-file)
+ (setq new (todo-validate-name new 'category))
+ (let* ((ofile todo-current-todo-file)
(archive (concat (file-name-sans-extension ofile) ".toda"))
(buffers (append (list ofile)
- (unless (zerop (todos-get-count 'archived cat))
+ (unless (zerop (todo-get-count 'archived cat))
(list archive)))))
(dolist (buf buffers)
(with-current-buffer (find-file-noselect buf)
(let (buffer-read-only)
- (setq todos-categories (todos-set-categories))
+ (setq todo-categories (todo-set-categories))
(save-excursion
(save-restriction
- (setcar (assoc cat todos-categories) new)
+ (setcar (assoc cat todo-categories) new)
(widen)
(goto-char (point-min))
- (todos-update-categories-sexp)
- (re-search-forward (concat (regexp-quote todos-category-beg)
+ (todo-update-categories-sexp)
+ (re-search-forward (concat (regexp-quote todo-category-beg)
"\\(" (regexp-quote cat) "\\)\n")
nil t)
(replace-match new t t nil 1)))))))
(force-mode-line-update))
- (save-excursion (todos-category-select)))
+ (save-excursion (todo-category-select)))
-(defun todos-delete-category (&optional arg)
- "Delete current Todos category provided it is empty.
+(defun todo-delete-category (&optional arg)
+ "Delete current Todo category provided it is empty.
With ARG non-nil delete the category unconditionally,
i.e. including all existing todo and done items."
(interactive "P")
- (let* ((file todos-current-todos-file)
- (cat (todos-current-category))
- (todo (todos-get-count 'todo cat))
- (done (todos-get-count 'done cat))
- (archived (todos-get-count 'archived cat)))
+ (let* ((file todo-current-todo-file)
+ (cat (todo-current-category))
+ (todo (todo-get-count 'todo cat))
+ (done (todo-get-count 'done cat))
+ (archived (todo-get-count 'archived cat)))
(if (and (not arg)
(or (> todo 0) (> done 0)))
(message "%s" (substitute-command-keys
(concat "To delete a non-empty category, "
- "type C-u \\[todos-delete-category].")))
- (when (cond ((= (length todos-categories) 1)
- (todos-y-or-n-p
+ "type C-u \\[todo-delete-category].")))
+ (when (cond ((= (length todo-categories) 1)
+ (todo-y-or-n-p
(concat "This is the only category in this file; "
"deleting it will also delete the file.\n"
"Do you want to proceed? ")))
((> archived 0)
- (todos-y-or-n-p (concat "This category has archived items; "
+ (todo-y-or-n-p (concat "This category has archived items; "
"the archived category will remain\n"
"after deleting the todo category. "
"Do you still want to delete it\n"
- "(see `todos-skip-archived-categories' "
+ "(see `todo-skip-archived-categories' "
"for another option)? ")))
(t
- (todos-y-or-n-p (concat "Permanently remove category \"" cat
+ (todo-y-or-n-p (concat "Permanently remove category \"" cat
"\"" (and arg " and all its entries")
"? "))))
(widen)
(let ((buffer-read-only)
(beg (re-search-backward
- (concat "^" (regexp-quote (concat todos-category-beg cat))
+ (concat "^" (regexp-quote (concat todo-category-beg cat))
"\n") nil t))
(end (if (re-search-forward
- (concat "\n\\(" (regexp-quote todos-category-beg)
+ (concat "\n\\(" (regexp-quote todo-category-beg)
".*\n\\)") nil t)
(match-beginning 1)
(point-max))))
(remove-overlays beg end)
(delete-region beg end)
- (if (= (length todos-categories) 1)
+ (if (= (length todo-categories) 1)
;; If deleted category was the only one, delete the file.
(progn
- (todos-reevaluate-filelist-defcustoms)
+ (todo-reevaluate-filelist-defcustoms)
;; Skip confirming killing the archive buffer if it has been
;; modified and not saved.
(set-buffer-modified-p nil)
(delete-file file)
(kill-buffer)
- (message "Deleted Todos file %s." file))
- (setq todos-categories (delete (assoc cat todos-categories)
- todos-categories))
- (todos-update-categories-sexp)
- (setq todos-category-number
- (1+ (mod todos-category-number (length todos-categories))))
- (todos-category-select)
+ (message "Deleted Todo file %s." file))
+ (setq todo-categories (delete (assoc cat todo-categories)
+ todo-categories))
+ (todo-update-categories-sexp)
+ (setq todo-category-number
+ (1+ (mod todo-category-number (length todo-categories))))
+ (todo-category-select)
(goto-char (point-min))
(message "Deleted category %s." cat)))))))
-(defun todos-move-category ()
- "Move current category to a different Todos file.
+(defun todo-move-category ()
+ "Move current category to a different Todo file.
If current category has archived items, also move those to the
archive of the file moved to, creating it if it does not exist."
(interactive)
- (when (or (> (length todos-categories) 1)
- (todos-y-or-n-p (concat "This is the only category in this file; "
+ (when (or (> (length todo-categories) 1)
+ (todo-y-or-n-p (concat "This is the only category in this file; "
"moving it will also delete the file.\n"
"Do you want to proceed? ")))
- (let* ((ofile todos-current-todos-file)
- (cat (todos-current-category))
- (nfile (todos-read-file-name
- "Choose a Todos file to move this category to: " nil t))
+ (let* ((ofile todo-current-todo-file)
+ (cat (todo-current-category))
+ (nfile (todo-read-file-name
+ "Choose a Todo file to move this category to: " nil t))
(archive (concat (file-name-sans-extension ofile) ".toda"))
(buffers (append (list ofile)
- (unless (zerop (todos-get-count 'archived cat))
+ (unless (zerop (todo-get-count 'archived cat))
(list archive))))
new)
(while (equal (file-truename nfile) (file-truename ofile))
- (setq nfile (todos-read-file-name
+ (setq nfile (todo-read-file-name
"Choose a file distinct from this file: " nil t)))
(dolist (buf buffers)
(with-current-buffer (find-file-noselect buf)
(goto-char (point-max))
(let* ((beg (re-search-backward
(concat "^"
- (regexp-quote (concat todos-category-beg cat))
+ (regexp-quote (concat todo-category-beg cat))
"$")
nil t))
(end (if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg))
+ (concat "^" (regexp-quote todo-category-beg))
nil t 2)
(match-beginning 0)
(point-max)))
(content (buffer-substring-no-properties beg end))
- (counts (cdr (assoc cat todos-categories)))
+ (counts (cdr (assoc cat todo-categories)))
buffer-read-only)
;; Move the category to the new file. Also update or create
;; archive file if necessary.
(with-current-buffer
(find-file-noselect
- ;; Regenerate todos-archives in case there
+ ;; Regenerate todo-archives in case there
;; is a newly created archive.
- (if (member buf (funcall todos-files-function t))
+ (if (member buf (funcall todo-files-function t))
(concat (file-name-sans-extension nfile) ".toda")
nfile))
- (let* ((nfile-short (todos-short-file-name nfile))
+ (let* ((nfile-short (todo-short-file-name nfile))
(prompt (concat
- (format "Todos file \"%s\" already has "
+ (format "Todo file \"%s\" already has "
nfile-short)
(format "the category \"%s\";\n" cat)
"enter a new category name: "))
(insert content)
;; If the file moved to has a category with the same
;; name, rename the moved category.
- (when (assoc cat todos-categories)
+ (when (assoc cat todo-categories)
(unless (member (file-truename (buffer-file-name))
- (funcall todos-files-function t))
+ (funcall todo-files-function t))
(setq new (read-from-minibuffer prompt))
- (setq new (todos-validate-name new 'category))))
- ;; Replace old with new name in Todos and archive files.
+ (setq new (todo-validate-name new 'category))))
+ ;; Replace old with new name in Todo and archive files.
(when new
(goto-char (point-max))
(re-search-backward
- (concat "^" (regexp-quote todos-category-beg)
+ (concat "^" (regexp-quote todo-category-beg)
"\\(" (regexp-quote cat) "\\)$") nil t)
(replace-match new nil nil nil 1)))
- (setq todos-categories
- (append todos-categories (list (cons new counts))))
- (todos-update-categories-sexp)
+ (setq todo-categories
+ (append todo-categories (list (cons new counts))))
+ (todo-update-categories-sexp)
;; If archive was just created, save it to avoid "File
;; <xyz> no longer exists!" message on invoking
- ;; `todos-view-archived-items'.
+ ;; `todo-view-archived-items'.
(unless (file-exists-p (buffer-file-name))
(save-buffer))
- (todos-category-number (or new cat))
- (todos-category-select))
+ (todo-category-number (or new cat))
+ (todo-category-select))
;; Delete the category from the old file, and if that was the
;; last category, delete the file. Also handle archive file
;; if necessary.
(remove-overlays beg end)
(delete-region beg end)
(goto-char (point-min))
- ;; Put point after todos-categories sexp.
+ ;; Put point after todo-categories sexp.
(forward-line)
(if (eobp) ; Aside from sexp, file is empty.
(progn
;; Skip confirming killing the archive buffer.
(set-buffer-modified-p nil)
- (delete-file todos-current-todos-file)
+ (delete-file todo-current-todo-file)
(kill-buffer)
- (when (member todos-current-todos-file todos-files)
- (todos-reevaluate-filelist-defcustoms)))
- (setq todos-categories (delete (assoc cat todos-categories)
- todos-categories))
- (todos-update-categories-sexp)
- (todos-category-select)))))
+ (when (member todo-current-todo-file todo-files)
+ (todo-reevaluate-filelist-defcustoms)))
+ (setq todo-categories (delete (assoc cat todo-categories)
+ todo-categories))
+ (todo-update-categories-sexp)
+ (todo-category-select)))))
(set-window-buffer (selected-window)
(set-buffer (find-file-noselect nfile)))
- (todos-category-number (or new cat))
- (todos-category-select))))
+ (todo-category-number (or new cat))
+ (todo-category-select))))
-(defun todos-merge-category (&optional file)
+(defun todo-merge-category (&optional file)
"Merge current category into another existing category.
-With prefix argument FILE, prompt for a specific Todos file and
+With prefix argument FILE, prompt for a specific Todo file and
choose (with TAB completion) a category in it to merge into;
otherwise, choose and merge into a category in either the
-current Todos file or a file in `todos-category-completions-files'.
+current Todo file or a file in `todo-category-completions-files'.
After merging, the current category's todo and done items are
appended to the chosen goal category's todo and done items,
has archived items, the archived category is renamed to the goal
category."
(interactive "P")
- (let* ((tfile todos-current-todos-file)
- (cat (todos-current-category))
- (cat+file (todos-read-category "Merge into category: " 'todo file))
+ (let* ((tfile todo-current-todo-file)
+ (cat (todo-current-category))
+ (cat+file (todo-read-category "Merge into category: " 'todo file))
(goal (car cat+file))
(gfile (cdr cat+file))
(archive (concat (file-name-sans-extension (if file gfile tfile))
(let* ((buffer-read-only nil)
(cbeg (progn
(re-search-backward
- (concat "^" (regexp-quote todos-category-beg)) nil t)
+ (concat "^" (regexp-quote todo-category-beg)) nil t)
(point-marker)))
(tbeg (progn (forward-line) (point-marker)))
(dbeg (progn
(re-search-forward
- (concat "^" (regexp-quote todos-category-done)) nil t)
+ (concat "^" (regexp-quote todo-category-done)) nil t)
(forward-line) (point-marker)))
;; Omit empty line between todo and done items.
(tend (progn (forward-line -2) (point-marker)))
(cend (progn
(if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg)) nil t)
+ (concat "^" (regexp-quote todo-category-beg)) nil t)
(progn
(goto-char (match-beginning 0))
(point-marker))
;; Merge any todo items.
(unless (zerop (length todo))
(re-search-forward
- (concat "^" (regexp-quote (concat todos-category-beg goal)) "$")
+ (concat "^" (regexp-quote (concat todo-category-beg goal)) "$")
nil t)
(re-search-forward
- (concat "^" (regexp-quote todos-category-done)) nil t)
+ (concat "^" (regexp-quote todo-category-done)) nil t)
(forward-line -1)
(setq here (point-marker))
(insert todo)
- (todos-update-count 'todo (todos-get-count 'todo cat) goal))
+ (todo-update-count 'todo (todo-get-count 'todo cat) goal))
;; Merge any done items.
(unless (zerop (length done))
(goto-char (if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg)) nil t)
+ (concat "^" (regexp-quote todo-category-beg)) nil t)
(match-beginning 0)
(point-max)))
(when (zerop (length todo)) (setq here (point-marker)))
(insert done)
- (todos-update-count 'done (todos-get-count 'done cat) goal))
+ (todo-update-count 'done (todo-get-count 'done cat) goal))
(remove-overlays cbeg cend)
(delete-region cbeg cend)
- (setq todos-categories (delete (assoc cat todos-categories)
- todos-categories))
- (todos-update-categories-sexp)
+ (setq todo-categories (delete (assoc cat todo-categories)
+ todo-categories))
+ (todo-update-categories-sexp)
(mapc (lambda (m) (set-marker m nil)) (list cbeg tbeg dbeg tend cend))))
(when (file-exists-p archive)
;; Merge in archive file.
(cbeg (save-excursion
(when (re-search-forward
(concat "^" (regexp-quote
- (concat todos-category-beg cat)) "$")
+ (concat todo-category-beg cat)) "$")
nil t)
(goto-char (match-beginning 0))
(point-marker))))
(gbeg (save-excursion
(when (re-search-forward
(concat "^" (regexp-quote
- (concat todos-category-beg goal)) "$")
+ (concat todo-category-beg goal)) "$")
nil t)
(goto-char (match-beginning 0))
(point-marker))))
cend carch)
(when cbeg
- (setq archived-count (todos-get-count 'done cat))
+ (setq archived-count (todo-get-count 'done cat))
(setq cend (save-excursion
(if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg))
+ (concat "^" (regexp-quote todo-category-beg))
nil t)
(match-beginning 0)
(point-max))))
(if gbeg
(progn
(goto-char (if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg))
+ (concat "^" (regexp-quote todo-category-beg))
nil t)
(match-beginning 0)
(point-max)))
(goto-char cbeg)
(search-forward cat)
(replace-match goal))
- (setq todos-categories (todos-make-categories-list t))
- (todos-update-categories-sexp)))))
+ (setq todo-categories (todo-make-categories-list t))
+ (todo-update-categories-sexp)))))
(with-current-buffer (get-file-buffer tfile)
(when archived-count
(unless (zerop archived-count)
- (todos-update-count 'archived archived-count goal)
- (todos-update-categories-sexp)))
- (todos-category-number goal)
+ (todo-update-count 'archived archived-count goal)
+ (todo-update-categories-sexp)))
+ (todo-category-number goal)
;; If there are only merged done items, show them.
- (let ((todos-show-with-done (zerop (todos-get-count 'todo goal))))
- (todos-category-select)
+ (let ((todo-show-with-done (zerop (todo-get-count 'todo goal))))
+ (todo-category-select)
;; Put point on the first merged item.
(goto-char here)))
(set-marker here nil)))
;;; Item editing
;; -----------------------------------------------------------------------------
-(defcustom todos-include-in-diary nil
+(defcustom todo-include-in-diary nil
"Non-nil to allow new Todo items to be included in the diary."
:type 'boolean
- :group 'todos-edit)
+ :group 'todo-edit)
-(defcustom todos-diary-nonmarking nil
+(defcustom todo-diary-nonmarking nil
"Non-nil to insert new Todo diary items as nonmarking by default.
This appends `diary-nonmarking-symbol' to the front of an item on
-insertion provided it doesn't begin with `todos-nondiary-marker'."
+insertion provided it doesn't begin with `todo-nondiary-marker'."
:type 'boolean
- :group 'todos-edit)
+ :group 'todo-edit)
-(defcustom todos-always-add-time-string nil
+(defcustom todo-always-add-time-string nil
"Non-nil adds current time to a new item's date header by default.
-When the Todos insertion commands have a non-nil \"maybe-notime\"
+When the Todo insertion commands have a non-nil \"maybe-notime\"
argument, this reverses the effect of
-`todos-always-add-time-string': if t, these commands omit the
+`todo-always-add-time-string': if t, these commands omit the
current time, if nil, they include it."
:type 'boolean
- :group 'todos-edit)
+ :group 'todo-edit)
-(defcustom todos-use-only-highlighted-region t
+(defcustom todo-use-only-highlighted-region t
"Non-nil to enable inserting only highlighted region as new item."
:type 'boolean
- :group 'todos-edit)
+ :group 'todo-edit)
-(defcustom todos-item-mark "*"
+(defcustom todo-item-mark "*"
"String used to mark items.
To ensure item marking works, change the value of this option
only when no items are marked."
:type '(string :validate
(lambda (widget)
- (when (string= (widget-value widget) todos-prefix)
+ (when (string= (widget-value widget) todo-prefix)
(widget-put
widget :error
- "Invalid value: must be distinct from `todos-prefix'")
+ "Invalid value: must be distinct from `todo-prefix'")
widget)))
:set (lambda (symbol value)
- (custom-set-default symbol (propertize value 'face 'todos-mark)))
- :group 'todos-edit)
+ (custom-set-default symbol (propertize value 'face 'todo-mark)))
+ :group 'todo-edit)
-(defcustom todos-comment-string "COMMENT"
+(defcustom todo-comment-string "COMMENT"
"String inserted before optional comment appended to done item."
:type 'string
:initialize 'custom-initialize-default
- :set 'todos-reset-comment-string
- :group 'todos-edit)
+ :set 'todo-reset-comment-string
+ :group 'todo-edit)
-(defcustom todos-undo-item-omit-comment 'ask
+(defcustom todo-undo-item-omit-comment 'ask
"Whether to omit done item comment on undoing the item.
Nil means never omit the comment, t means always omit it, `ask'
means prompt user and omit comment only on confirmation."
:type '(choice (const :tag "Never" nil)
(const :tag "Always" t)
(const :tag "Ask" ask))
- :group 'todos-edit)
+ :group 'todo-edit)
-(defun todos-toggle-mark-item (&optional n)
- "Mark item with `todos-item-mark' if unmarked, otherwise unmark it.
+(defun todo-toggle-mark-item (&optional n)
+ "Mark item with `todo-item-mark' if unmarked, otherwise unmark it.
With a positive numerical prefix argument N, change the
marking of the next N items."
(interactive "p")
- (when (todos-item-string)
+ (when (todo-item-string)
(unless (> n 1) (setq n 1))
(dotimes (i n)
- (let* ((cat (todos-current-category))
- (marks (assoc cat todos-categories-with-marks))
+ (let* ((cat (todo-current-category))
+ (marks (assoc cat todo-categories-with-marks))
(ov (progn
- (unless (looking-at todos-item-start)
- (todos-item-start))
- (todos-get-overlay 'prefix)))
+ (unless (looking-at todo-item-start)
+ (todo-item-start))
+ (todo-get-overlay 'prefix)))
(pref (overlay-get ov 'before-string)))
- (if (todos-marked-item-p)
+ (if (todo-marked-item-p)
(progn
(overlay-put ov 'before-string (substring pref 1))
(if (= (cdr marks) 1) ; Deleted last mark in this category.
- (setq todos-categories-with-marks
- (assq-delete-all cat todos-categories-with-marks))
+ (setq todo-categories-with-marks
+ (assq-delete-all cat todo-categories-with-marks))
(setcdr marks (1- (cdr marks)))))
- (overlay-put ov 'before-string (concat todos-item-mark pref))
+ (overlay-put ov 'before-string (concat todo-item-mark pref))
(if marks
(setcdr marks (1+ (cdr marks)))
- (push (cons cat 1) todos-categories-with-marks))))
- (todos-forward-item))))
+ (push (cons cat 1) todo-categories-with-marks))))
+ (todo-forward-item))))
-(defun todos-mark-category ()
- "Mark all visiblw items in this category with `todos-item-mark'."
+(defun todo-mark-category ()
+ "Mark all visiblw items in this category with `todo-item-mark'."
(interactive)
- (let* ((cat (todos-current-category))
- (marks (assoc cat todos-categories-with-marks)))
+ (let* ((cat (todo-current-category))
+ (marks (assoc cat todo-categories-with-marks)))
(save-excursion
(goto-char (point-min))
(while (not (eobp))
- (let* ((ov (todos-get-overlay 'prefix))
+ (let* ((ov (todo-get-overlay 'prefix))
(pref (overlay-get ov 'before-string)))
- (unless (todos-marked-item-p)
- (overlay-put ov 'before-string (concat todos-item-mark pref))
+ (unless (todo-marked-item-p)
+ (overlay-put ov 'before-string (concat todo-item-mark pref))
(if marks
(setcdr marks (1+ (cdr marks)))
- (push (cons cat 1) todos-categories-with-marks))))
- (todos-forward-item)))))
+ (push (cons cat 1) todo-categories-with-marks))))
+ (todo-forward-item)))))
-(defun todos-unmark-category ()
- "Remove `todos-item-mark' from all visible items in this category."
+(defun todo-unmark-category ()
+ "Remove `todo-item-mark' from all visible items in this category."
(interactive)
- (let* ((cat (todos-current-category))
- (marks (assoc cat todos-categories-with-marks)))
+ (let* ((cat (todo-current-category))
+ (marks (assoc cat todo-categories-with-marks)))
(save-excursion
(goto-char (point-min))
(while (not (eobp))
- (let* ((ov (todos-get-overlay 'prefix))
+ (let* ((ov (todo-get-overlay 'prefix))
;; No overlay on empty line between todo and done items.
(pref (when ov (overlay-get ov 'before-string))))
- (when (todos-marked-item-p)
+ (when (todo-marked-item-p)
(overlay-put ov 'before-string (substring pref 1)))
- (todos-forward-item))))
- (setq todos-categories-with-marks
- (delq marks todos-categories-with-marks))))
+ (todo-forward-item))))
+ (setq todo-categories-with-marks
+ (delq marks todo-categories-with-marks))))
-(defvar todos-date-from-calendar nil
+(defvar todo-date-from-calendar nil
"Helper variable for setting item date from the Emacs Calendar.")
-(defun todos-basic-insert-item (&optional arg diary nonmarking date-type time
+(defun todo-basic-insert-item (&optional arg diary nonmarking date-type time
region-or-here)
"Insert a new Todo item into a category.
-This is the function from which the generated Todos item
+This is the function from which the generated Todo item
insertion commands derive.
The generated commands have mnenomic key bindings based on the
In command invocations, ARG is passed as a prefix argument as
follows. With no prefix argument, add the item to the current
category; with one prefix argument (`C-u'), prompt for a category
-from the current Todos file; with two prefix arguments (`C-u C-u'),
-first prompt for a Todos file, then a category in that file. If
+from the current Todo file; with two prefix arguments (`C-u C-u'),
+first prompt for a Todo file, then a category in that file. If
a non-existing category is entered, ask whether to add it to the
-Todos file; if answered affirmatively, add the category and
+Todo file; if answered affirmatively, add the category and
insert the item there.
The remaining arguments are set or left nil by the generated item
paragraphs.
When argument DIARY is non-nil, this overrides the intent of the
-user option `todos-include-in-diary' for this item: if
-`todos-include-in-diary' is nil, include the item in the Fancy
+user option `todo-include-in-diary' for this item: if
+`todo-include-in-diary' is nil, include the item in the Fancy
Diary display, and if it is non-nil, exclude the item from the
-Fancy Diary display. When DIARY is nil, `todos-include-in-diary'
+Fancy Diary display. When DIARY is nil, `todo-include-in-diary'
has its intended effect.
When the item is included in the Fancy Diary display and the
argument NONMARKING is non-nil, this overrides the intent of the
-user option `todos-diary-nonmarking' for this item: if
-`todos-diary-nonmarking' is nil, append `diary-nonmarking-symbol'
+user option `todo-diary-nonmarking' for this item: if
+`todo-diary-nonmarking' is nil, append `diary-nonmarking-symbol'
to the item, and if it is non-nil, omit `diary-nonmarking-symbol'.
The argument DATE-TYPE determines the content of the item's
date, in the format set by `calendar-date-display-form',
becomes the date in the header.
- If DATE-TYPE is a string matching the regexp
- `todos-date-pattern', that string becomes the date in the
+ `todo-date-pattern', that string becomes the date in the
header. This case is for the command
- `todos-insert-item-from-calendar' which is called from the
+ `todo-insert-item-from-calendar' which is called from the
Calendar.
- If DATE-TYPE is the symbol `date', the header contains the date
in the format set by `calendar-date-display-form', with year,
With non-nil argument TIME prompt for a time string, which must
match `diary-time-regexp'. Typing `<return>' at the prompt
returns the current time, if the user option
-`todos-always-add-time-string' is non-nil, otherwise the empty
+`todo-always-add-time-string' is non-nil, otherwise the empty
string (i.e., no time string). If TIME is absent or nil, add or
omit the current time string according as
-`todos-always-add-time-string' is non-nil or nil, respectively.
+`todo-always-add-time-string' is non-nil or nil, respectively.
The argument REGION-OR-HERE determines the source and location of
the new item:
insert the new item as the first item in the category.
- If REGION-OR-HERE is the symbol `region', use the region of the
current buffer as the text of the new item, depending on the
- value of user option `todos-use-only-highlighted-region': if
+ value of user option `todo-use-only-highlighted-region': if
this is non-nil, then use the region only when it is
highlighted; otherwise, use the region regardless of
highlighting. An error is signalled if there is no region in
- If REGION-OR-HERE has any other value (in particular, nil or
none), prompt for the text and the item's priority, and insert
the item accordingly."
- ;; If invoked outside of Todos mode and there is not yet any Todos
+ ;; If invoked outside of Todo mode and there is not yet any Todo
;; file, initialize one.
- (if (null todos-files)
- (todos-show)
+ (if (null todo-files)
+ (todo-show)
(let ((region (eq region-or-here 'region))
(here (eq region-or-here 'here)))
(when region
(let (use-empty-active-region)
- (unless (and todos-use-only-highlighted-region (use-region-p))
+ (unless (and todo-use-only-highlighted-region (use-region-p))
(user-error "There is no active region"))))
(let* ((obuf (current-buffer))
- (ocat (todos-current-category))
+ (ocat (todo-current-category))
(opoint (point))
- (todos-mm (eq major-mode 'todos-mode))
+ (todo-mm (eq major-mode 'todo-mode))
(cat+file (cond ((equal arg '(4))
- (todos-read-category "Insert in category: "))
+ (todo-read-category "Insert in category: "))
((equal arg '(16))
- (todos-read-category "Insert in category: "
+ (todo-read-category "Insert in category: "
nil 'file))
(t
- (cons (todos-current-category)
- (or todos-current-todos-file
- (and todos-show-current-file
- todos-global-current-todos-file)
- (todos-absolute-file-name
- todos-default-todos-file))))))
+ (cons (todo-current-category)
+ (or todo-current-todo-file
+ (and todo-show-current-file
+ todo-global-current-todo-file)
+ (todo-absolute-file-name
+ todo-default-todo-file))))))
(cat (car cat+file))
(file (cdr cat+file))
(new-item (if region
(read-from-minibuffer "Todo item: ")))
(date-string (cond
((eq date-type 'date)
- (todos-read-date))
+ (todo-read-date))
((eq date-type 'dayname)
- (todos-read-dayname))
+ (todo-read-dayname))
((eq date-type 'calendar)
- (setq todos-date-from-calendar t)
- (or (todos-set-date-from-calendar)
+ (setq todo-date-from-calendar t)
+ (or (todo-set-date-from-calendar)
;; If user exits Calendar before choosing
;; a date, cancel item insertion.
(keyboard-quit)))
((and (stringp date-type)
- (string-match todos-date-pattern date-type))
- (setq todos-date-from-calendar date-type)
- (todos-set-date-from-calendar))
+ (string-match todo-date-pattern date-type))
+ (setq todo-date-from-calendar date-type)
+ (todo-set-date-from-calendar))
(t
(calendar-date-string
(calendar-current-date) t t))))
- (time-string (or (and time (todos-read-time))
- (and todos-always-add-time-string
+ (time-string (or (and time (todo-read-time))
+ (and todo-always-add-time-string
(substring (current-time-string) 11 16)))))
- (setq todos-date-from-calendar nil)
+ (setq todo-date-from-calendar nil)
(find-file-noselect file 'nowarn)
(set-window-buffer (selected-window)
(set-buffer (find-buffer-visiting file)))
- ;; If this command was invoked outside of a Todos buffer, the
- ;; call to todos-current-category above returned nil. If we
- ;; just entered Todos mode now, then cat was set to the file's
- ;; first category, but if todos-mode was already enabled, cat
+ ;; If this command was invoked outside of a Todo buffer, the
+ ;; call to todo-current-category above returned nil. If we
+ ;; just entered Todo mode now, then cat was set to the file's
+ ;; first category, but if todo-mode was already enabled, cat
;; did not get set, so we have to set it explicitly.
(unless cat
- (setq cat (todos-current-category)))
- (setq todos-current-todos-file file)
- (unless todos-global-current-todos-file
- (setq todos-global-current-todos-file todos-current-todos-file))
+ (setq cat (todo-current-category)))
+ (setq todo-current-todo-file file)
+ (unless todo-global-current-todo-file
+ (setq todo-global-current-todo-file todo-current-todo-file))
(let ((buffer-read-only nil)
- (called-from-outside (not (and todos-mm (equal cat ocat))))
+ (called-from-outside (not (and todo-mm (equal cat ocat))))
done-only item-added)
(setq new-item
;; Add date, time and diary marking as required.
- (concat (if (not (and diary (not todos-include-in-diary)))
- todos-nondiary-start
- (when (and nonmarking (not todos-diary-nonmarking))
+ (concat (if (not (and diary (not todo-include-in-diary)))
+ todo-nondiary-start
+ (when (and nonmarking (not todo-diary-nonmarking))
diary-nonmarking-symbol))
date-string (when (and time-string ; Can be empty.
(not (zerop (length
time-string))))
(concat " " time-string))
- (when (not (and diary (not todos-include-in-diary)))
- todos-nondiary-end)
+ (when (not (and diary (not todo-include-in-diary)))
+ todo-nondiary-end)
" " new-item))
;; Indent newlines inserted by C-q C-j if nonspace char follows.
(setq new-item (replace-regexp-in-string "\\(\n\\)[^[:blank:]]"
;; category is selected yet, or (ii) we invoked
;; insertion "here" from outside the category we want
;; to insert in (with priority insertion, category
- ;; selection is done by todos-set-item-priority).
+ ;; selection is done by todo-set-item-priority).
(when (or (= (- (point-max) (point-min)) (buffer-size))
(and here called-from-outside))
- (todos-category-number cat)
- (todos-category-select))
+ (todo-category-number cat)
+ (todo-category-select))
;; If only done items are displayed in category,
;; toggle to todo items before inserting new item.
(when (save-excursion
(goto-char (point-min))
- (looking-at todos-done-string-start))
+ (looking-at todo-done-string-start))
(setq done-only t)
- (todos-toggle-view-done-only))
+ (todo-toggle-view-done-only))
(if here
(progn
;; If command was invoked with point in done
;; items section or outside of the current
;; category, can't insert "here", so to be
;; useful give new item top priority.
- (when (or (todos-done-item-section-p)
+ (when (or (todo-done-item-section-p)
called-from-outside
done-only)
(goto-char (point-min)))
- (todos-insert-with-overlays new-item))
- (todos-set-item-priority new-item cat t))
+ (todo-insert-with-overlays new-item))
+ (todo-set-item-priority new-item cat t))
(setq item-added t))
;; If user cancels before setting priority, restore
;; display.
(if ocat
(progn
(unless (equal cat ocat)
- (todos-category-number ocat)
- (todos-category-select))
- (and done-only (todos-toggle-view-done-only)))
+ (todo-category-number ocat)
+ (todo-category-select))
+ (and done-only (todo-toggle-view-done-only)))
(set-window-buffer (selected-window) (set-buffer obuf)))
(goto-char opoint))
;; If the todo items section is not visible when the
;; out of view. So we recenter to make sure the todo
;; items are displayed in the window.
(when item-added (recenter)))
- (todos-update-count 'todo 1)
- (if (or diary todos-include-in-diary) (todos-update-count 'diary 1))
- (todos-update-categories-sexp))))))
+ (todo-update-count 'todo 1)
+ (if (or diary todo-include-in-diary) (todo-update-count 'diary 1))
+ (todo-update-categories-sexp))))))
-(defun todos-set-date-from-calendar ()
+(defun todo-set-date-from-calendar ()
"Return string of date chosen from Calendar."
- (cond ((and (stringp todos-date-from-calendar)
- (string-match todos-date-pattern todos-date-from-calendar))
- todos-date-from-calendar)
- (todos-date-from-calendar
+ (cond ((and (stringp todo-date-from-calendar)
+ (string-match todo-date-pattern todo-date-from-calendar))
+ todo-date-from-calendar)
+ (todo-date-from-calendar
(let (calendar-view-diary-initially-flag)
(calendar)) ; *Calendar* is now current buffer.
(define-key calendar-mode-map [remap newline] 'exit-recursive-edit)
(recursive-edit)
(unwind-protect
(when (equal (buffer-name) calendar-buffer)
- (setq todos-date-from-calendar
+ (setq todo-date-from-calendar
(calendar-date-string (calendar-cursor-to-date t) t t))
(calendar-exit)
- todos-date-from-calendar)
+ todo-date-from-calendar)
(define-key calendar-mode-map [remap newline] nil)
(define-key calendar-mode-map [remap calendar-exit] nil)
(unless (zerop (recursion-depth)) (exit-recursive-edit))
- (when (stringp todos-date-from-calendar)
- todos-date-from-calendar)))))
+ (when (stringp todo-date-from-calendar)
+ todo-date-from-calendar)))))
-(defun todos-insert-item-from-calendar (&optional arg)
+(defun todo-insert-item-from-calendar (&optional arg)
"Prompt for and insert a new item with date selected from calendar.
Invoked without prefix argument ARG, insert the item into the
current category, without one prefix argument, prompt for the
category from the current todo file or from one listed in
-`todos-category-completions-files'; with two prefix arguments,
+`todo-category-completions-files'; with two prefix arguments,
prompt for a todo file and then for a category in it."
(interactive "P")
- (setq todos-date-from-calendar
+ (setq todo-date-from-calendar
(calendar-date-string (calendar-cursor-to-date t) t t))
(calendar-exit)
- (todos-basic-insert-item arg nil nil todos-date-from-calendar))
+ (todo-basic-insert-item arg nil nil todo-date-from-calendar))
-(define-key calendar-mode-map "it" 'todos-insert-item-from-calendar)
+(define-key calendar-mode-map "it" 'todo-insert-item-from-calendar)
-(defun todos-copy-item ()
+(defun todo-copy-item ()
"Copy item at point and insert the copy as a new item."
(interactive)
- (unless (or (todos-done-item-p) (looking-at "^$"))
- (let ((copy (todos-item-string))
- (diary-item (todos-diary-item-p)))
- (todos-set-item-priority copy (todos-current-category) t)
- (todos-update-count 'todo 1)
- (when diary-item (todos-update-count 'diary 1))
- (todos-update-categories-sexp))))
-
-(defun todos-delete-item ()
+ (unless (or (todo-done-item-p) (looking-at "^$"))
+ (let ((copy (todo-item-string))
+ (diary-item (todo-diary-item-p)))
+ (todo-set-item-priority copy (todo-current-category) t)
+ (todo-update-count 'todo 1)
+ (when diary-item (todo-update-count 'diary 1))
+ (todo-update-categories-sexp))))
+
+(defun todo-delete-item ()
"Delete at least one item in this category.
If there are marked items, delete all of these; otherwise, delete
the item at point."
(interactive)
(let (ov)
(unwind-protect
- (let* ((cat (todos-current-category))
- (marked (assoc cat todos-categories-with-marks))
- (item (unless marked (todos-item-string)))
+ (let* ((cat (todo-current-category))
+ (marked (assoc cat todo-categories-with-marks))
+ (item (unless marked (todo-item-string)))
(answer (if marked
- (todos-y-or-n-p
+ (todo-y-or-n-p
"Permanently delete all marked items? ")
(when item
(setq ov (make-overlay
- (save-excursion (todos-item-start))
- (save-excursion (todos-item-end))))
- (overlay-put ov 'face 'todos-search)
- (todos-y-or-n-p "Permanently delete this item? "))))
+ (save-excursion (todo-item-start))
+ (save-excursion (todo-item-end))))
+ (overlay-put ov 'face 'todo-search)
+ (todo-y-or-n-p "Permanently delete this item? "))))
buffer-read-only)
(when answer
(and marked (goto-char (point-min)))
(catch 'done
(while (not (eobp))
- (if (or (and marked (todos-marked-item-p)) item)
+ (if (or (and marked (todo-marked-item-p)) item)
(progn
- (if (todos-done-item-p)
- (todos-update-count 'done -1)
- (todos-update-count 'todo -1 cat)
- (and (todos-diary-item-p)
- (todos-update-count 'diary -1)))
+ (if (todo-done-item-p)
+ (todo-update-count 'done -1)
+ (todo-update-count 'todo -1 cat)
+ (and (todo-diary-item-p)
+ (todo-update-count 'diary -1)))
(if ov (delete-overlay ov))
- (todos-remove-item)
+ (todo-remove-item)
;; Don't leave point below last item.
(and item (bolp) (eolp) (< (point-min) (point-max))
- (todos-backward-item))
+ (todo-backward-item))
(when item
(throw 'done (setq item nil))))
- (todos-forward-item))))
+ (todo-forward-item))))
(when marked
- (setq todos-categories-with-marks
- (assq-delete-all cat todos-categories-with-marks)))
- (todos-update-categories-sexp)
- (todos-prefix-overlays)))
+ (setq todo-categories-with-marks
+ (assq-delete-all cat todo-categories-with-marks)))
+ (todo-update-categories-sexp)
+ (todo-prefix-overlays)))
(if ov (delete-overlay ov)))))
-(defun todos-edit-item (&optional arg)
+(defun todo-edit-item (&optional arg)
"Edit the Todo item at point.
With non-nil prefix argument ARG, include the item's date/time
header, making it also editable; otherwise, include only the item
content.
If the item consists of only one logical line, edit it in the
-minibuffer; otherwise, edit it in Todos Edit mode."
+minibuffer; otherwise, edit it in Todo Edit mode."
(interactive "P")
- (when (todos-item-string)
+ (when (todo-item-string)
(let* ((opoint (point))
- (start (todos-item-start))
+ (start (todo-item-start))
(item-beg (progn
(re-search-forward
- (concat todos-date-string-start todos-date-pattern
+ (concat todo-date-string-start todo-date-pattern
"\\( " diary-time-regexp "\\)?"
- (regexp-quote todos-nondiary-end) "?")
+ (regexp-quote todo-nondiary-end) "?")
(line-end-position) t)
(1+ (- (point) start))))
- (header (substring (todos-item-string) 0 item-beg))
- (item (if arg (todos-item-string)
- (substring (todos-item-string) item-beg)))
+ (header (substring (todo-item-string) 0 item-beg))
+ (item (if arg (todo-item-string)
+ (substring (todo-item-string) item-beg)))
(multiline (> (length (split-string item "\n")) 1))
(buffer-read-only nil))
(if multiline
- (todos-edit-multiline-item)
+ (todo-edit-multiline-item)
(let ((new (concat (if arg "" header)
(read-string "Edit: " (if arg
(cons item item-beg)
(cons item 0))))))
(when arg
- (while (not (string-match (concat todos-date-string-start
- todos-date-pattern) new))
+ (while (not (string-match (concat todo-date-string-start
+ todo-date-pattern) new))
(setq new (read-from-minibuffer
"Item must start with a date: " new))))
;; Ensure lines following hard newlines are indented.
"\n\t" new nil nil 1))
;; If user moved point during editing, make sure it moves back.
(goto-char opoint)
- (todos-remove-item)
- (todos-insert-with-overlays new)
+ (todo-remove-item)
+ (todo-insert-with-overlays new)
(move-to-column item-beg))))))
-(defun todos-edit-multiline-item ()
- "Edit current Todo item in Todos Edit mode.
-Use of newlines invokes `todos-indent' to insure compliance with
+(defun todo-edit-multiline-item ()
+ "Edit current Todo item in Todo Edit mode.
+Use of newlines invokes `todo-indent' to insure compliance with
the format of Diary entries."
(interactive)
- (when (todos-item-string)
- (let ((buf todos-edit-buffer))
+ (when (todo-item-string)
+ (let ((buf todo-edit-buffer))
(set-window-buffer (selected-window)
(set-buffer (make-indirect-buffer (buffer-name) buf)))
- (narrow-to-region (todos-item-start) (todos-item-end))
- (todos-edit-mode)
+ (narrow-to-region (todo-item-start) (todo-item-end))
+ (todo-edit-mode)
(message "%s" (substitute-command-keys
- (concat "Type \\[todos-edit-quit] "
- "to return to Todos mode.\n"))))))
+ (concat "Type \\[todo-edit-quit] "
+ "to return to Todo mode.\n"))))))
-(defun todos-edit-quit ()
- "Return from Todos Edit mode to Todos mode.
+(defun todo-edit-quit ()
+ "Return from Todo Edit mode to Todo mode.
If the item contains hard line breaks, make sure the following
-lines are indented by `todos-indent-to-here' to conform to diary
+lines are indented by `todo-indent-to-here' to conform to diary
format.
-If the whole file was in Todos Edit mode, check before returning
-whether the file is still a valid Todos file and if so, also
-recalculate the Todos categories sexp, in case changes were made
+If the whole file was in Todo Edit mode, check before returning
+whether the file is still a valid Todo file and if so, also
+recalculate the Todo categories sexp, in case changes were made
in the number or names of categories."
(interactive)
(if (> (buffer-size) (- (point-max) (point-min)))
(let ((item (buffer-string))
(regex "\\(\n\\)[^[:blank:]]")
(buf (buffer-base-buffer)))
- (while (not (string-match (concat todos-date-string-start
- todos-date-pattern) item))
+ (while (not (string-match (concat todo-date-string-start
+ todo-date-pattern) item))
(setq item (read-from-minibuffer
"Item must start with a date: " item)))
;; Ensure lines following hard newlines are indented.
(unless (eq (current-buffer) buf)
(set-window-buffer (selected-window) (set-buffer buf))))
;; We got here via `F e'.
- (when (todos-check-format)
+ (when (todo-check-format)
;; FIXME: separate out sexp check?
;; If manual editing makes e.g. item counts change, have to
- ;; call this to update todos-categories, but it restores
+ ;; call this to update todo-categories, but it restores
;; category order to list order.
- ;; (todos-repair-categories-sexp)
- ;; Compare (todos-make-categories-list t) with sexp and if
- ;; different ask (todos-update-categories-sexp) ?
- (todos-mode)
- (let* ((cat-beg (concat "^" (regexp-quote todos-category-beg)
+ ;; (todo-repair-categories-sexp)
+ ;; Compare (todo-make-categories-list t) with sexp and if
+ ;; different ask (todo-update-categories-sexp) ?
+ (todo-mode)
+ (let* ((cat-beg (concat "^" (regexp-quote todo-category-beg)
"\\(.*\\)$"))
(curline (buffer-substring-no-properties
(line-beginning-position) (line-end-position)))
((or (re-search-backward cat-beg nil t)
(re-search-forward cat-beg nil t))
(match-string-no-properties 1)))))
- (todos-category-number cat)
- (todos-category-select)
+ (todo-category-number cat)
+ (todo-category-select)
(goto-char (point-min))))))
-(defun todos-basic-edit-item-header (what &optional inc)
+(defun todo-basic-edit-item-header (what &optional inc)
"Function underlying commands to edit item date/time header.
The argument WHAT (passed by invoking commands) specifies what
If there are marked items, apply the same edit to all of these;
otherwise, edit just the item at point."
- (let* ((cat (todos-current-category))
- (marked (assoc cat todos-categories-with-marks))
+ (let* ((cat (todo-current-category))
+ (marked (assoc cat todo-categories-with-marks))
(first t)
- (todos-date-from-calendar t)
+ (todo-date-from-calendar t)
(buffer-read-only nil)
ndate ntime year monthname month day
dayname) ; Needed by calendar-date-display-form.
(save-excursion
- (or (and marked (goto-char (point-min))) (todos-item-start))
+ (or (and marked (goto-char (point-min))) (todo-item-start))
(catch 'end
(while (not (eobp))
(and marked
- (while (not (todos-marked-item-p))
- (todos-forward-item)
+ (while (not (todo-marked-item-p))
+ (todo-forward-item)
(and (eobp) (throw 'end nil))))
- (re-search-forward (concat todos-date-string-start "\\(?1:"
- todos-date-pattern
+ (re-search-forward (concat todo-date-string-start "\\(?1:"
+ todo-date-pattern
"\\)\\(?2: " diary-time-regexp "\\)?"
- (regexp-quote todos-nondiary-end) "?")
+ (regexp-quote todo-nondiary-end) "?")
(line-end-position) t)
(let* ((odate (match-string-no-properties 1))
(otime (match-string-no-properties 2))
(omonth (match-string-no-properties 7))
(oday (match-string-no-properties 8))
(oyear (match-string-no-properties 9))
- (tmn-array todos-month-name-array)
+ (tmn-array todo-month-name-array)
(mlist (append tmn-array nil))
- (tma-array todos-month-abbrev-array)
+ (tma-array todo-month-abbrev-array)
(mablist (append tma-array nil))
(yy (and oyear (unless (string= oyear "*")
(string-to-number oyear))))
(when first
(cond
((eq what 'date)
- (setq ndate (todos-read-date)))
+ (setq ndate (todo-read-date)))
((eq what 'calendar)
- (setq ndate (save-match-data (todos-set-date-from-calendar))))
+ (setq ndate (save-match-data (todo-set-date-from-calendar))))
((eq what 'today)
(setq ndate (calendar-date-string (calendar-current-date) t t)))
((eq what 'dayname)
- (setq ndate (todos-read-dayname)))
+ (setq ndate (todo-read-dayname)))
((eq what 'time)
- (setq ntime (save-match-data (todos-read-time)))
+ (setq ntime (save-match-data (todo-read-time)))
(when (> (length ntime) 0)
(setq ntime (concat " " ntime))))
;; When date string consists only of a day name,
monthname omonthname
month omonth
year (cond ((not current-prefix-arg)
- (todos-read-date 'year))
+ (todo-read-date 'year))
((string= oyear "*")
(user-error "Cannot increment *"))
(t
month
monthname)
(cond ((not current-prefix-arg)
- (todos-read-date 'month))
+ (todo-read-date 'month))
((or (string= omonth "*") (= mm 13))
(user-error "Cannot increment *"))
(t
monthname omonthname
day (cond
((not current-prefix-arg)
- (todos-read-date 'day mm oyear))
+ (todo-read-date 'day mm oyear))
((string= oday "*")
(user-error "Cannot increment *"))
((or (string= omonth "*") (string= omonthname "*"))
(replace-match ntime nil nil nil 2)
(goto-char (match-end 1))
(insert ntime)))
- (setq todos-date-from-calendar nil)
+ (setq todo-date-from-calendar nil)
(setq first nil))
;; Apply the changes to the first marked item header to the
;; remaining marked items. If there are no marked items,
;; we're finished.
(if marked
- (todos-forward-item)
+ (todo-forward-item)
(goto-char (point-max))))))))
-(defun todos-edit-item-header ()
+(defun todo-edit-item-header ()
"Interactively edit at least the date of item's date/time header.
-If user option `todos-always-add-time-string' is non-nil, also
+If user option `todo-always-add-time-string' is non-nil, also
edit item's time string."
(interactive)
- (todos-basic-edit-item-header 'date)
- (when todos-always-add-time-string
- (todos-edit-item-time)))
+ (todo-basic-edit-item-header 'date)
+ (when todo-always-add-time-string
+ (todo-edit-item-time)))
-(defun todos-edit-item-time ()
+(defun todo-edit-item-time ()
"Interactively edit the time string of item's date/time header."
(interactive)
- (todos-basic-edit-item-header 'time))
+ (todo-basic-edit-item-header 'time))
-(defun todos-edit-item-date-from-calendar ()
+(defun todo-edit-item-date-from-calendar ()
"Interactively edit item's date using the Calendar."
(interactive)
- (todos-basic-edit-item-header 'calendar))
+ (todo-basic-edit-item-header 'calendar))
-(defun todos-edit-item-date-to-today ()
+(defun todo-edit-item-date-to-today ()
"Set item's date to today's date."
(interactive)
- (todos-basic-edit-item-header 'today))
+ (todo-basic-edit-item-header 'today))
-(defun todos-edit-item-date-day-name ()
+(defun todo-edit-item-date-day-name ()
"Replace item's date with the name of a day of the week."
(interactive)
- (todos-basic-edit-item-header 'dayname))
+ (todo-basic-edit-item-header 'dayname))
-(defun todos-edit-item-date-year (&optional inc)
+(defun todo-edit-item-date-year (&optional inc)
"Interactively edit the year of item's date string.
With prefix argument INC a positive or negative integer,
increment or decrement the year by INC."
(interactive "p")
- (todos-basic-edit-item-header 'year inc))
+ (todo-basic-edit-item-header 'year inc))
-(defun todos-edit-item-date-month (&optional inc)
+(defun todo-edit-item-date-month (&optional inc)
"Interactively edit the month of item's date string.
With prefix argument INC a positive or negative integer,
increment or decrement the month by INC."
(interactive "p")
- (todos-basic-edit-item-header 'month inc))
+ (todo-basic-edit-item-header 'month inc))
-(defun todos-edit-item-date-day (&optional inc)
+(defun todo-edit-item-date-day (&optional inc)
"Interactively edit the day of the month of item's date string.
With prefix argument INC a positive or negative integer,
increment or decrement the day by INC."
(interactive "p")
- (todos-basic-edit-item-header 'day inc))
+ (todo-basic-edit-item-header 'day inc))
-(defun todos-edit-item-diary-inclusion ()
+(defun todo-edit-item-diary-inclusion ()
"Change diary status of one or more todo items in this category.
-That is, insert `todos-nondiary-marker' if the candidate items
+That is, insert `todo-nondiary-marker' if the candidate items
lack this marking; otherwise, remove it.
If there are marked todo items, change the diary status of all
point."
(interactive)
(let ((buffer-read-only)
- (marked (assoc (todos-current-category)
- todos-categories-with-marks)))
+ (marked (assoc (todo-current-category)
+ todo-categories-with-marks)))
(catch 'stop
(save-excursion
(when marked (goto-char (point-min)))
(while (not (eobp))
- (if (todos-done-item-p)
+ (if (todo-done-item-p)
(throw 'stop (message "Done items cannot be edited"))
- (unless (and marked (not (todos-marked-item-p)))
- (let* ((beg (todos-item-start))
- (lim (save-excursion (todos-item-end)))
+ (unless (and marked (not (todo-marked-item-p)))
+ (let* ((beg (todo-item-start))
+ (lim (save-excursion (todo-item-end)))
(end (save-excursion
- (or (todos-time-string-matcher lim)
- (todos-date-string-matcher lim)))))
- (if (looking-at (regexp-quote todos-nondiary-start))
+ (or (todo-time-string-matcher lim)
+ (todo-date-string-matcher lim)))))
+ (if (looking-at (regexp-quote todo-nondiary-start))
(progn
(replace-match "")
- (search-forward todos-nondiary-end (1+ end) t)
+ (search-forward todo-nondiary-end (1+ end) t)
(replace-match "")
- (todos-update-count 'diary 1))
+ (todo-update-count 'diary 1))
(when end
- (insert todos-nondiary-start)
+ (insert todo-nondiary-start)
(goto-char (1+ end))
- (insert todos-nondiary-end)
- (todos-update-count 'diary -1)))))
+ (insert todo-nondiary-end)
+ (todo-update-count 'diary -1)))))
(unless marked (throw 'stop nil))
- (todos-forward-item)))))
- (todos-update-categories-sexp)))
+ (todo-forward-item)))))
+ (todo-update-categories-sexp)))
-(defun todos-edit-category-diary-inclusion (arg)
+(defun todo-edit-category-diary-inclusion (arg)
"Make all items in this category diary items.
With prefix ARG, make all items in this category non-diary
items."
(interactive "P")
(save-excursion
(goto-char (point-min))
- (let ((todo-count (todos-get-count 'todo))
- (diary-count (todos-get-count 'diary))
+ (let ((todo-count (todo-get-count 'todo))
+ (diary-count (todo-get-count 'diary))
(buffer-read-only))
(catch 'stop
(while (not (eobp))
- (if (todos-done-item-p) ; We've gone too far.
+ (if (todo-done-item-p) ; We've gone too far.
(throw 'stop nil)
- (let* ((beg (todos-item-start))
- (lim (save-excursion (todos-item-end)))
+ (let* ((beg (todo-item-start))
+ (lim (save-excursion (todo-item-end)))
(end (save-excursion
- (or (todos-time-string-matcher lim)
- (todos-date-string-matcher lim)))))
+ (or (todo-time-string-matcher lim)
+ (todo-date-string-matcher lim)))))
(if arg
- (unless (looking-at (regexp-quote todos-nondiary-start))
- (insert todos-nondiary-start)
+ (unless (looking-at (regexp-quote todo-nondiary-start))
+ (insert todo-nondiary-start)
(goto-char (1+ end))
- (insert todos-nondiary-end))
- (when (looking-at (regexp-quote todos-nondiary-start))
+ (insert todo-nondiary-end))
+ (when (looking-at (regexp-quote todo-nondiary-start))
(replace-match "")
- (search-forward todos-nondiary-end (1+ end) t)
+ (search-forward todo-nondiary-end (1+ end) t)
(replace-match "")))))
- (todos-forward-item))
+ (todo-forward-item))
(unless (if arg (zerop diary-count) (= diary-count todo-count))
- (todos-update-count 'diary (if arg
+ (todo-update-count 'diary (if arg
(- diary-count)
(- todo-count diary-count))))
- (todos-update-categories-sexp)))))
+ (todo-update-categories-sexp)))))
-(defun todos-edit-item-diary-nonmarking ()
+(defun todo-edit-item-diary-nonmarking ()
"Change non-marking of one or more diary items in this category.
That is, insert `diary-nonmarking-symbol' if the candidate items
lack this marking; otherwise, remove it.
the item at point."
(interactive)
(let ((buffer-read-only)
- (marked (assoc (todos-current-category)
- todos-categories-with-marks)))
+ (marked (assoc (todo-current-category)
+ todo-categories-with-marks)))
(catch 'stop
(save-excursion
(when marked (goto-char (point-min)))
(while (not (eobp))
- (if (todos-done-item-p)
+ (if (todo-done-item-p)
(throw 'stop (message "Done items cannot be edited"))
- (unless (and marked (not (todos-marked-item-p)))
- (todos-item-start)
- (unless (looking-at (regexp-quote todos-nondiary-start))
+ (unless (and marked (not (todo-marked-item-p)))
+ (todo-item-start)
+ (unless (looking-at (regexp-quote todo-nondiary-start))
(if (looking-at (regexp-quote diary-nonmarking-symbol))
(replace-match "")
(insert diary-nonmarking-symbol))))
(unless marked (throw 'stop nil))
- (todos-forward-item)))))))
+ (todo-forward-item)))))))
-(defun todos-edit-category-diary-nonmarking (arg)
+(defun todo-edit-category-diary-nonmarking (arg)
"Add `diary-nonmarking-symbol' to all diary items in this category.
With prefix ARG, remove `diary-nonmarking-symbol' from all diary
items in this category."
(let (buffer-read-only)
(catch 'stop
(while (not (eobp))
- (if (todos-done-item-p) ; We've gone too far.
+ (if (todo-done-item-p) ; We've gone too far.
(throw 'stop nil)
- (unless (looking-at (regexp-quote todos-nondiary-start))
+ (unless (looking-at (regexp-quote todo-nondiary-start))
(if arg
(when (looking-at (regexp-quote diary-nonmarking-symbol))
(replace-match ""))
(unless (looking-at (regexp-quote diary-nonmarking-symbol))
(insert diary-nonmarking-symbol))))
- (todos-forward-item)))))))
+ (todo-forward-item)))))))
-(defun todos-set-item-priority (&optional item cat new arg)
+(defun todo-set-item-priority (&optional item cat new arg)
"Prompt for and set ITEM's priority in CATegory.
Interactively, ITEM is the todo item at point, CAT is the current
meaning to raise or lower the item's priority by one."
(interactive)
(unless (and (called-interactively-p 'any)
- (or (todos-done-item-p) (looking-at "^$")))
- (let* ((item (or item (todos-item-string)))
- (marked (todos-marked-item-p))
- (cat (or cat (cond ((eq major-mode 'todos-mode)
- (todos-current-category))
- ((eq major-mode 'todos-filtered-items-mode)
+ (or (todo-done-item-p) (looking-at "^$")))
+ (let* ((item (or item (todo-item-string)))
+ (marked (todo-marked-item-p))
+ (cat (or cat (cond ((eq major-mode 'todo-mode)
+ (todo-current-category))
+ ((eq major-mode 'todo-filtered-items-mode)
(let* ((regexp1
- (concat todos-date-string-start
- todos-date-pattern
+ (concat todo-date-string-start
+ todo-date-pattern
"\\( " diary-time-regexp "\\)?"
- (regexp-quote todos-nondiary-end)
+ (regexp-quote todo-nondiary-end)
"?\\(?1: \\[\\(.+:\\)?.+\\]\\)")))
(save-excursion
(re-search-forward regexp1 nil t)
(match-string-no-properties 1)))))))
curnum
(todo (cond ((or (eq arg 'raise) (eq arg 'lower)
- (eq major-mode 'todos-filtered-items-mode))
+ (eq major-mode 'todo-filtered-items-mode))
(save-excursion
- (let ((curstart (todos-item-start))
+ (let ((curstart (todo-item-start))
(count 0))
(goto-char (point-min))
- (while (looking-at todos-item-start)
+ (while (looking-at todo-item-start)
(setq count (1+ count))
(when (= (point) curstart) (setq curnum count))
- (todos-forward-item))
+ (todo-forward-item))
count)))
- ((eq major-mode 'todos-mode)
- (todos-get-count 'todo cat))))
+ ((eq major-mode 'todo-mode)
+ (todo-get-count 'todo cat))))
(maxnum (if new (1+ todo) todo))
(prompt (format "Set item priority (1-%d): " maxnum))
(priority (cond ((and (not arg) (numberp current-prefix-arg))
;; When moving item to another category, show the category before
;; prompting for its priority.
(unless (or arg (called-interactively-p 'any))
- (todos-category-number cat)
+ (todo-category-number cat)
;; If done items in category are visible, keep them visible.
- (let ((done todos-show-with-done))
+ (let ((done todo-show-with-done))
(when (> (buffer-size) (- (point-max) (point-min)))
(save-excursion
(goto-char (point-min))
- (setq done (re-search-forward todos-done-string-start nil t))))
- (let ((todos-show-with-done done))
- (todos-category-select)
+ (setq done (re-search-forward todo-done-string-start nil t))))
+ (let ((todo-show-with-done done))
+ (todo-category-select)
;; Keep top of category in view while setting priority.
(goto-char (point-min)))))
;; Prompt for priority only when the category has at least one
;; In Top Priorities buffer, an item's priority can be changed
;; wrt items in another category, but not wrt items in the same
;; category.
- (when (eq major-mode 'todos-filtered-items-mode)
- (let* ((regexp2 (concat todos-date-string-start todos-date-pattern
+ (when (eq major-mode 'todo-filtered-items-mode)
+ (let* ((regexp2 (concat todo-date-string-start todo-date-pattern
"\\( " diary-time-regexp "\\)?"
- (regexp-quote todos-nondiary-end)
+ (regexp-quote todo-nondiary-end)
"?\\(?1:" (regexp-quote cat) "\\)"))
(end (cond ((< curnum priority)
- (save-excursion (todos-item-end)))
+ (save-excursion (todo-item-end)))
((> curnum priority)
- (save-excursion (todos-item-start)))))
+ (save-excursion (todo-item-start)))))
(match (save-excursion
(cond ((< curnum priority)
- (todos-forward-item (1+ (- priority curnum)))
+ (todo-forward-item (1+ (- priority curnum)))
(when (re-search-backward regexp2 end t)
(match-string-no-properties 1)))
((> curnum priority)
- (todos-backward-item (- curnum priority))
+ (todo-backward-item (- curnum priority))
(when (re-search-forward regexp2 end t)
(match-string-no-properties 1)))))))
(when match
(user-error (concat "Cannot reprioritize items from the same "
- "category in this mode, only in Todos mode")))))
+ "category in this mode, only in Todo mode")))))
;; Interactively or with non-nil ARG, relocate the item within its
;; category.
(when (or arg (called-interactively-p 'any))
- (todos-remove-item))
+ (todo-remove-item))
(goto-char (point-min))
(when priority
(unless (= priority 1)
- (todos-forward-item (1- priority))
- ;; When called from todos-item-undone and the highest priority
+ (todo-forward-item (1- priority))
+ ;; When called from todo-item-undone and the highest priority
;; is chosen, this advances point to the first done item, so
;; move it up to the empty line above the done items
;; separator.
(when (looking-back (concat "^"
- (regexp-quote todos-category-done)
+ (regexp-quote todo-category-done)
"\n"))
- (todos-backward-item))))
- (todos-insert-with-overlays item)
+ (todo-backward-item))))
+ (todo-insert-with-overlays item)
;; If item was marked, restore the mark.
(and marked
- (let* ((ov (todos-get-overlay 'prefix))
+ (let* ((ov (todo-get-overlay 'prefix))
(pref (overlay-get ov 'before-string)))
(overlay-put ov 'before-string
- (concat todos-item-mark pref))))))))
+ (concat todo-item-mark pref))))))))
-(defun todos-raise-item-priority ()
+(defun todo-raise-item-priority ()
"Raise priority of current item by moving it up by one item."
(interactive)
- (todos-set-item-priority nil nil nil 'raise))
+ (todo-set-item-priority nil nil nil 'raise))
-(defun todos-lower-item-priority ()
+(defun todo-lower-item-priority ()
"Lower priority of current item by moving it down by one item."
(interactive)
- (todos-set-item-priority nil nil nil 'lower))
+ (todo-set-item-priority nil nil nil 'lower))
-(defun todos-move-item (&optional file)
+(defun todo-move-item (&optional file)
"Move at least one todo or done item to another category.
If there are marked items, move all of these; otherwise, move
the item at point.
-With prefix argument FILE, prompt for a specific Todos file and
+With prefix argument FILE, prompt for a specific Todo file and
choose (with TAB completion) a category in it to move the item or
items to; otherwise, choose and move to any category in either
-the current Todos file or one of the files in
-`todos-category-completions-files'. If the chosen category is
+the current Todo file or one of the files in
+`todo-category-completions-files'. If the chosen category is
not an existing categories, then it is created and the item(s)
become(s) the first entry/entries in that category.
With moved Todo items, prompt to set the priority in the category
-moved to (with multiple todos items, the one that had the highest
+moved to (with multiple todo items, the one that had the highest
priority in the category moved from gets the new priority and the
rest of the moved todo items are inserted in sequence below it).
Moved done items are appended to the top of the done items
section in the category moved to."
(interactive "P")
- (let* ((cat1 (todos-current-category))
- (marked (assoc cat1 todos-categories-with-marks)))
+ (let* ((cat1 (todo-current-category))
+ (marked (assoc cat1 todo-categories-with-marks)))
;; Noop if point is not on an item and there are no marked items.
(unless (and (looking-at "^$")
(not marked))
(let* ((buffer-read-only)
- (file1 todos-current-todos-file)
- (num todos-category-number)
- (item (todos-item-string))
- (diary-item (todos-diary-item-p))
- (done-item (and (todos-done-item-p) (concat item "\n")))
- (omark (save-excursion (todos-item-start) (point-marker)))
+ (file1 todo-current-todo-file)
+ (num todo-category-number)
+ (item (todo-item-string))
+ (diary-item (todo-diary-item-p))
+ (done-item (and (todo-done-item-p) (concat item "\n")))
+ (omark (save-excursion (todo-item-start) (point-marker)))
(todo 0)
(diary 0)
(done 0)
(unwind-protect
(progn
(unless marked
- (setq ov (make-overlay (save-excursion (todos-item-start))
- (save-excursion (todos-item-end))))
- (overlay-put ov 'face 'todos-search))
+ (setq ov (make-overlay (save-excursion (todo-item-start))
+ (save-excursion (todo-item-end))))
+ (overlay-put ov 'face 'todo-search))
(let* ((pl (if (and marked (> (cdr marked) 1)) "s" ""))
- (cat+file (todos-read-category (concat "Move item" pl
+ (cat+file (todo-read-category (concat "Move item" pl
" to category: ")
nil file)))
(while (and (equal (car cat+file) cat1)
(equal (cdr cat+file) file1))
- (setq cat+file (todos-read-category
+ (setq cat+file (todo-read-category
"Choose a different category: ")))
(setq cat2 (car cat+file)
file2 (cdr cat+file))))
(progn
(goto-char (point-min))
(while (not (eobp))
- (when (todos-marked-item-p)
- (if (todos-done-item-p)
+ (when (todo-marked-item-p)
+ (if (todo-done-item-p)
(setq done-items (concat done-items
- (todos-item-string) "\n")
+ (todo-item-string) "\n")
done (1+ done))
(setq todo-items (concat todo-items
- (todos-item-string) "\n")
+ (todo-item-string) "\n")
todo (1+ todo))
- (when (todos-diary-item-p)
+ (when (todo-diary-item-p)
(setq diary (1+ diary)))))
- (todos-forward-item))
+ (todo-forward-item))
;; Chop off last newline of multiple todo item string,
;; since it will be reinserted when setting priority
;; (but with done items priority is not set, so keep
;; last newline).
(and todo-items
(setq todo-items (substring todo-items 0 -1))))
- (if (todos-done-item-p)
+ (if (todo-done-item-p)
(setq done 1)
(setq todo 1)
- (when (todos-diary-item-p) (setq diary 1))))
+ (when (todo-diary-item-p) (setq diary 1))))
(set-window-buffer (selected-window)
(set-buffer (find-file-noselect file2 'nowarn)))
(unwind-protect
(progn
(when (or todo-items (and item (not done-item)))
- (todos-set-item-priority (or todo-items item) cat2 t))
+ (todo-set-item-priority (or todo-items item) cat2 t))
;; Move done items en bloc to top of done items section.
(when (or done-items done-item)
- (todos-category-number cat2)
+ (todo-category-number cat2)
(widen)
(goto-char (point-min))
(re-search-forward
- (concat "^" (regexp-quote (concat todos-category-beg cat2))
+ (concat "^" (regexp-quote (concat todo-category-beg cat2))
"$") nil t)
(re-search-forward
- (concat "^" (regexp-quote todos-category-done)) nil t)
+ (concat "^" (regexp-quote todo-category-done)) nil t)
(forward-line)
(insert (or done-items done-item)))
(setq moved t))
;; the moved item.
(moved
(setq nmark (point-marker))
- (when todo (todos-update-count 'todo todo))
- (when diary (todos-update-count 'diary diary))
- (when done (todos-update-count 'done done))
- (todos-update-categories-sexp)
+ (when todo (todo-update-count 'todo todo))
+ (when diary (todo-update-count 'diary diary))
+ (when done (todo-update-count 'done done))
+ (todo-update-categories-sexp)
(with-current-buffer (find-buffer-visiting file1)
(save-excursion
(save-restriction
(let (beg end)
(setq item nil)
(re-search-backward
- (concat "^" (regexp-quote todos-category-beg)) nil t)
+ (concat "^" (regexp-quote todo-category-beg)) nil t)
(forward-line)
(setq beg (point))
(setq end (if (re-search-forward
(concat "^" (regexp-quote
- todos-category-beg)) nil t)
+ todo-category-beg)) nil t)
(match-beginning 0)
(point-max)))
(goto-char beg)
(while (< (point) end)
- (if (todos-marked-item-p)
- (todos-remove-item)
- (todos-forward-item)))
- (setq todos-categories-with-marks
- (assq-delete-all cat1 todos-categories-with-marks)))
+ (if (todo-marked-item-p)
+ (todo-remove-item)
+ (todo-forward-item)))
+ (setq todo-categories-with-marks
+ (assq-delete-all cat1 todo-categories-with-marks)))
(if ov (delete-overlay ov))
- (todos-remove-item))))
- (when todo (todos-update-count 'todo (- todo) cat1))
- (when diary (todos-update-count 'diary (- diary) cat1))
- (when done (todos-update-count 'done (- done) cat1))
- (todos-update-categories-sexp))
+ (todo-remove-item))))
+ (when todo (todo-update-count 'todo (- todo) cat1))
+ (when diary (todo-update-count 'diary (- diary) cat1))
+ (when done (todo-update-count 'done (- done) cat1))
+ (todo-update-categories-sexp))
(set-window-buffer (selected-window)
(set-buffer (find-file-noselect file2 'nowarn)))
- (setq todos-category-number (todos-category-number cat2))
- (let ((todos-show-with-done (or done-items done-item)))
- (todos-category-select))
+ (setq todo-category-number (todo-category-number cat2))
+ (let ((todo-show-with-done (or done-items done-item)))
+ (todo-category-select))
(goto-char nmark)
;; If item is moved to end of (just first?) category, make
;; sure the items above it are displayed in the window.
(t
(set-window-buffer (selected-window)
(set-buffer (find-file-noselect file1 'nowarn)))
- (todos-category-number cat1)
- (todos-category-select)
+ (todo-category-number cat1)
+ (todo-category-select)
(goto-char omark))))))))
-(defun todos-item-done (&optional arg)
+(defun todo-item-done (&optional arg)
"Tag a todo item in this category as done and relocate it.
With prefix argument ARG prompt for a comment and append it to
the done item; this is only possible if there are no marked
items. If there are marked items, tag all of these with
-`todos-done-string' plus the current date and, if
-`todos-always-add-time-string' is non-nil, the current time;
+`todo-done-string' plus the current date and, if
+`todo-always-add-time-string' is non-nil, the current time;
otherwise, just tag the item at point. Items tagged as done are
relocated to the category's (by default hidden) done section. If
done items are visible on invoking this command, they remain
visible."
(interactive "P")
- (let* ((cat (todos-current-category))
- (marked (assoc cat todos-categories-with-marks)))
+ (let* ((cat (todo-current-category))
+ (marked (assoc cat todo-categories-with-marks)))
(when marked
(save-excursion
(save-restriction
(goto-char (point-max))
- (todos-backward-item)
- (unless (todos-done-item-p)
+ (todo-backward-item)
+ (unless (todo-done-item-p)
(widen)
(unless (re-search-forward
- (concat "^" (regexp-quote todos-category-beg)) nil t)
+ (concat "^" (regexp-quote todo-category-beg)) nil t)
(goto-char (point-max)))
(forward-line -1))
- (while (todos-done-item-p)
- (when (todos-marked-item-p)
+ (while (todo-done-item-p)
+ (when (todo-marked-item-p)
(user-error "This command does not apply to done items"))
- (todos-backward-item)))))
+ (todo-backward-item)))))
(unless (and (not marked)
- (or (todos-done-item-p)
+ (or (todo-done-item-p)
;; Point is between todo and done items.
(looking-at "^$")))
(let* ((date-string (calendar-date-string (calendar-current-date) t t))
- (time-string (if todos-always-add-time-string
+ (time-string (if todo-always-add-time-string
(concat " " (substring (current-time-string)
11 16))
""))
- (done-prefix (concat "[" todos-done-string date-string time-string
+ (done-prefix (concat "[" todo-done-string date-string time-string
"] "))
(comment (and arg (read-string "Enter a comment: ")))
(item-count 0)
(diary-count 0)
(show-done (save-excursion
(goto-char (point-min))
- (re-search-forward todos-done-string-start nil t)))
+ (re-search-forward todo-done-string-start nil t)))
(buffer-read-only nil)
item done-item opoint)
;; Don't add empty comment to done item.
(setq comment (unless (zerop (length comment))
- (concat " [" todos-comment-string ": " comment "]")))
+ (concat " [" todo-comment-string ": " comment "]")))
(and marked (goto-char (point-min)))
(catch 'done
;; Stop looping when we hit the empty line below the last
;; todo item (this is eobp if only done items are hidden).
(while (not (looking-at "^$"))
- (if (or (not marked) (and marked (todos-marked-item-p)))
+ (if (or (not marked) (and marked (todo-marked-item-p)))
(progn
- (setq item (todos-item-string))
+ (setq item (todo-item-string))
(setq done-item (concat done-item done-prefix item
comment (and marked "\n")))
(setq item-count (1+ item-count))
- (when (todos-diary-item-p)
+ (when (todo-diary-item-p)
(setq diary-count (1+ diary-count)))
- (todos-remove-item)
+ (todo-remove-item)
(unless marked (throw 'done nil)))
- (todos-forward-item))))
+ (todo-forward-item))))
(when marked
;; Chop off last newline of done item string.
(setq done-item (substring done-item 0 -1))
- (setq todos-categories-with-marks
- (assq-delete-all cat todos-categories-with-marks)))
+ (setq todo-categories-with-marks
+ (assq-delete-all cat todo-categories-with-marks)))
(save-excursion
(widen)
(re-search-forward
- (concat "^" (regexp-quote todos-category-done)) nil t)
+ (concat "^" (regexp-quote todo-category-done)) nil t)
(forward-char)
(when show-done (setq opoint (point)))
(insert done-item "\n"))
- (todos-update-count 'todo (- item-count))
- (todos-update-count 'done item-count)
- (todos-update-count 'diary (- diary-count))
- (todos-update-categories-sexp)
- (let ((todos-show-with-done show-done))
- (todos-category-select)
+ (todo-update-count 'todo (- item-count))
+ (todo-update-count 'done item-count)
+ (todo-update-count 'diary (- diary-count))
+ (todo-update-categories-sexp)
+ (let ((todo-show-with-done show-done))
+ (todo-category-select)
;; When done items are shown, put cursor on first just done item.
(when opoint (goto-char opoint)))))))
-(defun todos-edit-done-item-comment (&optional arg)
+(defun todo-edit-done-item-comment (&optional arg)
"Add a comment to this done item or edit an existing comment.
With prefix ARG delete an existing comment."
(interactive "P")
- (when (todos-done-item-p)
- (let ((item (todos-item-string))
+ (when (todo-done-item-p)
+ (let ((item (todo-item-string))
(opoint (point))
- (end (save-excursion (todos-item-end)))
+ (end (save-excursion (todo-item-end)))
comment buffer-read-only)
(save-excursion
- (todos-item-start)
+ (todo-item-start)
(if (re-search-forward (concat " \\["
- (regexp-quote todos-comment-string)
+ (regexp-quote todo-comment-string)
": \\([^]]+\\)\\]") end t)
(if arg
- (when (todos-y-or-n-p "Delete comment? ")
+ (when (todo-y-or-n-p "Delete comment? ")
(delete-region (match-beginning 0) (match-end 0)))
(setq comment (read-string "Edit comment: "
(cons (match-string 1) 1)))
(setq comment (read-string "Enter a comment: "))
;; If user moved point during editing, make sure it moves back.
(goto-char opoint)
- (todos-item-end)
- (insert " [" todos-comment-string ": " comment "]"))))))
+ (todo-item-end)
+ (insert " [" todo-comment-string ": " comment "]"))))))
-(defun todos-item-undone ()
+(defun todo-item-undone ()
"Restore at least one done item to this category's todo section.
Prompt for the new priority. If there are marked items, undo all
of these, giving the first undone item the new priority and the
comments, only ask once, and if affirmed, omit subsequent
comments without asking."
(interactive)
- (let* ((cat (todos-current-category))
- (marked (assoc cat todos-categories-with-marks))
+ (let* ((cat (todo-current-category))
+ (marked (assoc cat todo-categories-with-marks))
(pl (if (and marked (> (cdr marked) 1)) "s" "")))
- (when (or marked (todos-done-item-p))
+ (when (or marked (todo-done-item-p))
(let ((buffer-read-only)
(opoint (point))
(omark (point-marker))
(and marked (goto-char (point-min)))
(catch 'done
(while (not (eobp))
- (when (or (not marked) (and marked (todos-marked-item-p)))
- (if (not (todos-done-item-p))
+ (when (or (not marked) (and marked (todo-marked-item-p)))
+ (if (not (todo-done-item-p))
(user-error "Only done items can be undone")
- (todos-item-start)
+ (todo-item-start)
(unless marked
- (setq ov (make-overlay (save-excursion (todos-item-start))
- (save-excursion (todos-item-end))))
- (overlay-put ov 'face 'todos-search))
+ (setq ov (make-overlay (save-excursion (todo-item-start))
+ (save-excursion (todo-item-end))))
+ (overlay-put ov 'face 'todo-search))
;; Find the end of the date string added upon tagging item as
;; done.
(setq start (search-forward "] "))
(setq item-count (1+ item-count))
- (unless (looking-at (regexp-quote todos-nondiary-start))
+ (unless (looking-at (regexp-quote todo-nondiary-start))
(setq diary-count (1+ diary-count)))
- (setq end (save-excursion (todos-item-end)))
+ (setq end (save-excursion (todo-item-end)))
;; Ask (once) whether to omit done item's comment. If
;; affirmed, omit subsequent comments without asking.
(when (re-search-forward
- (concat " \\[" (regexp-quote todos-comment-string)
+ (concat " \\[" (regexp-quote todo-comment-string)
": [^]]+\\]") end t)
(unwind-protect
(if (eq first 'first)
(setq first
- (if (eq todos-undo-item-omit-comment 'ask)
- (when (todos-y-or-n-p
+ (if (eq todo-undo-item-omit-comment 'ask)
+ (when (todo-y-or-n-p
(concat "Omit comment" pl
" from restored item"
pl "? "))
'omit)
- (when todos-undo-item-omit-comment 'omit)))
+ (when todo-undo-item-omit-comment 'omit)))
t)
(when (and (eq first 'first) ov) (delete-overlay ov)))
(when (eq first 'omit)
(buffer-substring-no-properties start end)
(when marked "\n")))
(unless marked (throw 'done nil))))
- (todos-forward-item)))
+ (todo-forward-item)))
(unwind-protect
(progn
;; Chop off last newline of multiple items string, since
;; it will be reinserted on setting priority.
(and marked (setq item (substring item 0 -1)))
- (todos-set-item-priority item cat t)
+ (todo-set-item-priority item cat t)
(setq npoint (point))
(setq undone t))
(when ov (delete-overlay ov))
(progn
(setq item nil)
(re-search-forward
- (concat "^" (regexp-quote todos-category-done)) nil t)
+ (concat "^" (regexp-quote todo-category-done)) nil t)
(while (not (eobp))
- (if (todos-marked-item-p)
- (todos-remove-item)
- (todos-forward-item)))
- (setq todos-categories-with-marks
- (assq-delete-all cat todos-categories-with-marks)))
+ (if (todo-marked-item-p)
+ (todo-remove-item)
+ (todo-forward-item)))
+ (setq todo-categories-with-marks
+ (assq-delete-all cat todo-categories-with-marks)))
(goto-char omark)
- (todos-remove-item))
- (todos-update-count 'todo item-count)
- (todos-update-count 'done (- item-count))
- (when diary-count (todos-update-count 'diary diary-count))
- (todos-update-categories-sexp)
- (let ((todos-show-with-done (> (todos-get-count 'done) 0)))
- (todos-category-select))
+ (todo-remove-item))
+ (todo-update-count 'todo item-count)
+ (todo-update-count 'done (- item-count))
+ (when diary-count (todo-update-count 'diary diary-count))
+ (todo-update-categories-sexp)
+ (let ((todo-show-with-done (> (todo-get-count 'done) 0)))
+ (todo-category-select))
;; Put cursor on undone item.
(goto-char npoint)))
(set-marker omark nil)))))
;;; Done item archives
;; -----------------------------------------------------------------------------
-(defun todos-find-archive (&optional ask)
- "Visit the archive of the current Todos category, if it exists.
+(defun todo-find-archive (&optional ask)
+ "Visit the archive of the current Todo category, if it exists.
If the category has no archived items, prompt to visit the
archive anyway. If there is no archive for this file or with
non-nil argument ASK, prompt to visit another archive.
-The buffer showing the archive is in Todos Archive mode. The
+The buffer showing the archive is in Todo Archive mode. The
first visit in a session displays the first category in the
archive, subsequent visits return to the last category
displayed."
(interactive)
- (let* ((cat (todos-current-category))
- (count (todos-get-count 'archived cat))
- (archive (concat (file-name-sans-extension todos-current-todos-file)
+ (let* ((cat (todo-current-category))
+ (count (todo-get-count 'archived cat))
+ (archive (concat (file-name-sans-extension todo-current-todo-file)
".toda"))
place)
(setq place (cond (ask 'other-archive)
((file-exists-p archive) 'this-archive)
- (t (when (todos-y-or-n-p
+ (t (when (todo-y-or-n-p
(concat "This file has no archive; "
"visit another archive? "))
'other-archive))))
(when (eq place 'other-archive)
- (setq archive (todos-read-file-name "Choose a Todos archive: " t t)))
+ (setq archive (todo-read-file-name "Choose a Todo archive: " t t)))
(when (and (eq place 'this-archive) (zerop count))
- (setq place (when (todos-y-or-n-p
+ (setq place (when (todo-y-or-n-p
(concat "This category has no archived items;"
" visit archive anyway? "))
'other-cat)))
(set-window-buffer (selected-window)
(set-buffer (find-file-noselect archive)))
(if (member place '(other-archive other-cat))
- (setq todos-category-number 1)
- (todos-category-number cat))
- (todos-category-select))))
+ (setq todo-category-number 1)
+ (todo-category-number cat))
+ (todo-category-select))))
-(defun todos-choose-archive ()
+(defun todo-choose-archive ()
"Choose an archive and visit it."
(interactive)
- (todos-find-archive t))
+ (todo-find-archive t))
-(defun todos-archive-done-item (&optional all)
+(defun todo-archive-done-item (&optional all)
"Archive at least one done item in this category.
With prefix argument ALL, prompt whether to archive all done
If the archive of this file does not exist, it is created. If
this category does not exist in the archive, it is created."
(interactive "P")
- (when (eq major-mode 'todos-mode)
- (if (and all (zerop (todos-get-count 'done)))
+ (when (eq major-mode 'todo-mode)
+ (if (and all (zerop (todo-get-count 'done)))
(message "No done items in this category")
(catch 'end
- (let* ((cat (todos-current-category))
+ (let* ((cat (todo-current-category))
(tbuf (current-buffer))
- (marked (assoc cat todos-categories-with-marks))
+ (marked (assoc cat todo-categories-with-marks))
(afile (concat (file-name-sans-extension
- todos-current-todos-file) ".toda"))
+ todo-current-todo-file) ".toda"))
(archive (if (file-exists-p afile)
(find-file-noselect afile t)
(get-buffer-create afile)))
- (item (and (todos-done-item-p)
- (concat (todos-item-string) "\n")))
+ (item (and (todo-done-item-p)
+ (concat (todo-item-string) "\n")))
(count 0)
- (opoint (unless (todos-done-item-p) (point)))
+ (opoint (unless (todo-done-item-p) (point)))
marked-items beg end all-done
buffer-read-only)
(cond
(all
- (if (todos-y-or-n-p "Archive all done items in this category? ")
+ (if (todo-y-or-n-p "Archive all done items in this category? ")
(save-excursion
(save-restriction
(goto-char (point-min))
(widen)
(setq beg (progn
- (re-search-forward todos-done-string-start
+ (re-search-forward todo-done-string-start
nil t)
(match-beginning 0))
end (if (re-search-forward
(concat "^"
- (regexp-quote todos-category-beg))
+ (regexp-quote todo-category-beg))
nil t)
(match-beginning 0)
(point-max))
all-done (buffer-substring-no-properties beg end)
- count (todos-get-count 'done))
+ count (todo-get-count 'done))
;; Restore starting point, unless it was on a done
;; item, since they will all be deleted.
(when opoint (goto-char opoint))))
(save-excursion
(goto-char (point-min))
(while (not (eobp))
- (when (todos-marked-item-p)
- (if (not (todos-done-item-p))
+ (when (todo-marked-item-p)
+ (if (not (todo-done-item-p))
(throw 'end (message "Only done items can be archived"))
(setq marked-items
- (concat marked-items (todos-item-string) "\n"))
+ (concat marked-items (todo-item-string) "\n"))
(setq count (1+ count))))
- (todos-forward-item)))))
+ (todo-forward-item)))))
(if (not (or marked all item))
(throw 'end (message "Only done items can be archived"))
(with-current-buffer archive
(goto-char (point-min))
(if (and (re-search-forward
(concat "^" (regexp-quote
- (concat todos-category-beg cat)) "$")
+ (concat todo-category-beg cat)) "$")
nil t)
- (re-search-forward (regexp-quote todos-category-done)
+ (re-search-forward (regexp-quote todo-category-done)
nil t))
;; Start of done items section in existing category.
(forward-char)
- (todos-add-category nil cat)
+ (todo-add-category nil cat)
;; Start of done items section in new category.
(goto-char (point-max)))
(insert (cond (marked marked-items)
(all all-done)
(item)))
- (todos-update-count 'done (if (or marked all) count 1) cat)
- (todos-update-categories-sexp)
+ (todo-update-count 'done (if (or marked all) count 1) cat)
+ (todo-update-categories-sexp)
;; If archive is new, save to file now (using write-region in
;; order not to get prompted for file to save to), to let
;; auto-mode-alist take effect below.
(widen)
(remove-overlays beg end)
(delete-region beg end)
- (todos-update-count 'done (- count))
- (todos-update-count 'archived count))))
+ (todo-update-count 'done (- count))
+ (todo-update-count 'archived count))))
((or marked
;; If we're archiving all done items, can't
;; first archive item point was on, since
(and marked (goto-char (point-min)))
(catch 'done
(while (not (eobp))
- (if (or (and marked (todos-marked-item-p)) item)
+ (if (or (and marked (todo-marked-item-p)) item)
(progn
- (todos-remove-item)
- (todos-update-count 'done -1)
- (todos-update-count 'archived 1)
+ (todo-remove-item)
+ (todo-update-count 'done -1)
+ (todo-update-count 'archived 1)
;; Don't leave point below last item.
(and item (bolp) (eolp) (< (point-min) (point-max))
- (todos-backward-item))
+ (todo-backward-item))
(when item
(throw 'done (setq item nil))))
- (todos-forward-item))))))
+ (todo-forward-item))))))
(when marked
- (setq todos-categories-with-marks
- (assq-delete-all cat todos-categories-with-marks)))
- (todos-update-categories-sexp)
- (todos-prefix-overlays)))
+ (setq todo-categories-with-marks
+ (assq-delete-all cat todo-categories-with-marks)))
+ (todo-update-categories-sexp)
+ (todo-prefix-overlays)))
(find-file afile)
- (todos-category-number cat)
- (todos-category-select)
+ (todo-category-number cat)
+ (todo-category-select)
(split-window-below)
(set-window-buffer (selected-window) tbuf)
;; Make todo file current to select category.
(find-file (buffer-file-name tbuf))
;; Make sure done item separator is hidden (if done items
;; were initially visible).
- (let (todos-show-with-done) (todos-category-select)))))))
+ (let (todo-show-with-done) (todo-category-select)))))))
-(defun todos-unarchive-items ()
+(defun todo-unarchive-items ()
"Unarchive at least one item in this archive category.
If there are marked items, unarchive all of these; otherwise,
unarchive the item at point.
Unarchived items are restored as done items to the corresponding
-category in the Todos file, inserted at the top of done items
+category in the Todo file, inserted at the top of done items
section. If all items in the archive category have been
restored, the category is deleted from the archive. If this was
the only category in the archive, the archive file is deleted."
(interactive)
- (when (eq major-mode 'todos-archive-mode)
- (let* ((cat (todos-current-category))
+ (when (eq major-mode 'todo-archive-mode)
+ (let* ((cat (todo-current-category))
(tbuf (find-file-noselect
- (concat (file-name-sans-extension todos-current-todos-file)
+ (concat (file-name-sans-extension todo-current-todo-file)
".todo") t))
- (marked (assoc cat todos-categories-with-marks))
- (item (concat (todos-item-string) "\n"))
+ (marked (assoc cat todo-categories-with-marks))
+ (item (concat (todo-item-string) "\n"))
(marked-count 0)
marked-items
buffer-read-only)
(save-excursion
(goto-char (point-min))
(while (not (eobp))
- (when (todos-marked-item-p)
- (setq marked-items (concat marked-items (todos-item-string) "\n"))
+ (when (todo-marked-item-p)
+ (setq marked-items (concat marked-items (todo-item-string) "\n"))
(setq marked-count (1+ marked-count)))
- (todos-forward-item))))
+ (todo-forward-item))))
;; Restore items to top of category's done section and update counts.
(with-current-buffer tbuf
(let (buffer-read-only newcat)
;; Find the corresponding todo category, or if there isn't
;; one, add it.
(unless (re-search-forward
- (concat "^" (regexp-quote (concat todos-category-beg cat))
+ (concat "^" (regexp-quote (concat todo-category-beg cat))
"$") nil t)
- (todos-add-category nil cat)
+ (todo-add-category nil cat)
(setq newcat t))
;; Go to top of category's done section.
(re-search-forward
- (concat "^" (regexp-quote todos-category-done)) nil t)
+ (concat "^" (regexp-quote todo-category-done)) nil t)
(forward-line)
(cond (marked
(insert marked-items)
- (todos-update-count 'done marked-count cat)
+ (todo-update-count 'done marked-count cat)
(unless newcat ; Newly added category has no archive.
- (todos-update-count 'archived (- marked-count) cat)))
+ (todo-update-count 'archived (- marked-count) cat)))
(t
(insert item)
- (todos-update-count 'done 1 cat)
+ (todo-update-count 'done 1 cat)
(unless newcat ; Newly added category has no archive.
- (todos-update-count 'archived -1 cat))))
- (todos-update-categories-sexp)))
+ (todo-update-count 'archived -1 cat))))
+ (todo-update-categories-sexp)))
;; Delete restored items from archive.
(when marked
(setq item nil)
(goto-char (point-min)))
(catch 'done
(while (not (eobp))
- (if (or (todos-marked-item-p) item)
+ (if (or (todo-marked-item-p) item)
(progn
- (todos-remove-item)
+ (todo-remove-item)
(when item
(throw 'done (setq item nil))))
- (todos-forward-item))))
- (todos-update-count 'done (if marked (- marked-count) -1) cat)
+ (todo-forward-item))))
+ (todo-update-count 'done (if marked (- marked-count) -1) cat)
;; If that was the last category in the archive, delete the whole file.
- (if (= (length todos-categories) 1)
+ (if (= (length todo-categories) 1)
(progn
- (delete-file todos-current-todos-file)
+ (delete-file todo-current-todo-file)
;; Kill the archive buffer silently.
(set-buffer-modified-p nil)
(kill-buffer))
(when (eq (point-min) (point-max))
(widen)
(let ((beg (re-search-backward
- (concat "^" (regexp-quote todos-category-beg) cat "$")
+ (concat "^" (regexp-quote todo-category-beg) cat "$")
nil t))
(end (if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg))
+ (concat "^" (regexp-quote todo-category-beg))
nil t 2)
(match-beginning 0)
(point-max))))
(remove-overlays beg end)
(delete-region beg end)
- (setq todos-categories (delete (assoc cat todos-categories)
- todos-categories))
- (todos-update-categories-sexp))))
- ;; Visit category in Todos file and show restored done items.
+ (setq todo-categories (delete (assoc cat todo-categories)
+ todo-categories))
+ (todo-update-categories-sexp))))
+ ;; Visit category in Todo file and show restored done items.
(let ((tfile (buffer-file-name tbuf))
- (todos-show-with-done t))
+ (todo-show-with-done t))
(set-window-buffer (selected-window)
(set-buffer (find-file-noselect tfile)))
- (todos-category-number cat)
- (todos-category-select)
+ (todo-category-number cat)
+ (todo-category-select)
(message "Items unarchived.")))))
-(defun todos-jump-to-archive-category (&optional file)
- "Prompt for a category in a Todos archive and jump to it.
+(defun todo-jump-to-archive-category (&optional file)
+ "Prompt for a category in a Todo archive and jump to it.
With prefix argument FILE, prompt for an archive and choose (with
TAB completion) a category in it to jump to; otherwise, choose
and jump to any category in the current archive."
(interactive "P")
- (todos-jump-to-category file 'archive))
+ (todo-jump-to-category file 'archive))
;; -----------------------------------------------------------------------------
;;; Displaying and sorting tables of categories
;; -----------------------------------------------------------------------------
-(defcustom todos-categories-category-label "Category"
- "Category button label in Todos Categories mode."
+(defcustom todo-categories-category-label "Category"
+ "Category button label in Todo Categories mode."
:type 'string
- :group 'todos-categories)
+ :group 'todo-categories)
-(defcustom todos-categories-todo-label "Todo"
- "Todo button label in Todos Categories mode."
+(defcustom todo-categories-todo-label "Todo"
+ "Todo button label in Todo Categories mode."
:type 'string
- :group 'todos-categories)
+ :group 'todo-categories)
-(defcustom todos-categories-diary-label "Diary"
- "Diary button label in Todos Categories mode."
+(defcustom todo-categories-diary-label "Diary"
+ "Diary button label in Todo Categories mode."
:type 'string
- :group 'todos-categories)
+ :group 'todo-categories)
-(defcustom todos-categories-done-label "Done"
- "Done button label in Todos Categories mode."
+(defcustom todo-categories-done-label "Done"
+ "Done button label in Todo Categories mode."
:type 'string
- :group 'todos-categories)
+ :group 'todo-categories)
-(defcustom todos-categories-archived-label "Archived"
- "Archived button label in Todos Categories mode."
+(defcustom todo-categories-archived-label "Archived"
+ "Archived button label in Todo Categories mode."
:type 'string
- :group 'todos-categories)
+ :group 'todo-categories)
-(defcustom todos-categories-totals-label "Totals"
- "String to label total item counts in Todos Categories mode."
+(defcustom todo-categories-totals-label "Totals"
+ "String to label total item counts in Todo Categories mode."
:type 'string
- :group 'todos-categories)
+ :group 'todo-categories)
-(defcustom todos-categories-number-separator " | "
- "String between number and category in Todos Categories mode.
+(defcustom todo-categories-number-separator " | "
+ "String between number and category in Todo Categories mode.
This separates the number from the category name in the default
categories display according to priority."
:type 'string
- :group 'todos-categories)
+ :group 'todo-categories)
-(defcustom todos-categories-align 'center
- "Alignment of category names in Todos Categories mode."
+(defcustom todo-categories-align 'center
+ "Alignment of category names in Todo Categories mode."
:type '(radio (const left) (const center) (const right))
- :group 'todos-categories)
+ :group 'todo-categories)
-(defun todos-show-categories-table ()
+(defun todo-show-categories-table ()
"Display a table of the current file's categories and item counts.
In the initial display the categories are numbered, indicating
-their current order for navigating by \\[todos-forward-category]
-and \\[todos-backward-category]. You can persistantly change the
+their current order for navigating by \\[todo-forward-category]
+and \\[todo-backward-category]. You can persistantly change the
order of the category at point by typing
-\\[todos-set-category-number], \\[todos-raise-category] or
-\\[todos-lower-category].
+\\[todo-set-category-number], \\[todo-raise-category] or
+\\[todo-lower-category].
The labels above the category names and item counts are buttons,
and clicking these changes the display: sorted by category name
or by the respective item counts (alternately descending or
ascending). In these displays the categories are not numbered
-and \\[todos-set-category-number], \\[todos-raise-category] and
-\\[todos-lower-category] are disabled. (Programmatically, the
+and \\[todo-set-category-number], \\[todo-raise-category] and
+\\[todo-lower-category] are disabled. (Programmatically, the
sorting is triggered by passing a non-nil SORTKEY argument.)
In addition, the lines with the category names and item counts
are buttonized, and pressing one of these button jumps to the
-category in Todos mode (or Todos Archive mode, for categories
+category in Todo mode (or Todo Archive mode, for categories
containing only archived items, provided user option
-`todos-skip-archived-categories' is non-nil. These categories
-are shown in `todos-archived-only' face."
+`todo-skip-archived-categories' is non-nil. These categories
+are shown in `todo-archived-only' face."
(interactive)
- (todos-display-categories)
+ (todo-display-categories)
(let (sortkey)
- (todos-update-categories-display sortkey)))
+ (todo-update-categories-display sortkey)))
-(defun todos-next-button (n)
+(defun todo-next-button (n)
"Move point to the Nth next button in the table of categories."
(interactive "p")
(forward-button n 'wrap 'display-message)
(and (bolp) (button-at (point))
;; Align with beginning of category label.
- (forward-char (+ 4 (length todos-categories-number-separator)))))
+ (forward-char (+ 4 (length todo-categories-number-separator)))))
-(defun todos-previous-button (n)
+(defun todo-previous-button (n)
"Move point to the Nth previous button in the table of categories."
(interactive "p")
(backward-button n 'wrap 'display-message)
(and (bolp) (button-at (point))
;; Align with beginning of category label.
- (forward-char (+ 4 (length todos-categories-number-separator)))))
+ (forward-char (+ 4 (length todo-categories-number-separator)))))
-(defun todos-set-category-number (&optional arg)
+(defun todo-set-category-number (&optional arg)
"Change number of category at point in the table of categories.
With ARG nil, prompt for the new number. Alternatively, the
;; on the current line.
(forward-line 0) (skip-chars-forward " ") (number-at-point))))
(when curnum ; Do nothing if we're not on a category line.
- (let* ((maxnum (length todos-categories))
+ (let* ((maxnum (length todo-categories))
(prompt (format "Set category priority (1-%d): " maxnum))
(col (current-column))
(buffer-read-only nil)
"Choose a different priority than the current one: ")))
(unless prompt (setq priority candidate)))
(let* ((lower (< curnum priority)) ; Priority is being lowered.
- (head (butlast todos-categories
+ (head (butlast todo-categories
(apply (if lower 'identity '1+)
(list (- maxnum priority)))))
(tail (nthcdr (apply (if lower 'identity '1-) (list priority))
- todos-categories))
+ todo-categories))
;; Category's name and items counts list.
- (catcons (nth (1- curnum) todos-categories))
- (todos-categories (nconc head (list catcons) tail))
+ (catcons (nth (1- curnum) todo-categories))
+ (todo-categories (nconc head (list catcons) tail))
newcats)
- (when lower (setq todos-categories (nreverse todos-categories)))
- (setq todos-categories (delete-dups todos-categories))
- (when lower (setq todos-categories (nreverse todos-categories)))
- (setq newcats todos-categories)
+ (when lower (setq todo-categories (nreverse todo-categories)))
+ (setq todo-categories (delete-dups todo-categories))
+ (when lower (setq todo-categories (nreverse todo-categories)))
+ (setq newcats todo-categories)
(kill-buffer)
- (with-current-buffer (find-buffer-visiting todos-current-todos-file)
- (setq todos-categories newcats)
- (todos-update-categories-sexp))
- (todos-show-categories-table)
+ (with-current-buffer (find-buffer-visiting todo-current-todo-file)
+ (setq todo-categories newcats)
+ (todo-update-categories-sexp))
+ (todo-show-categories-table)
(forward-line (1+ priority))
(forward-char col))))))
-(defun todos-raise-category ()
- "Raise priority of category at point in Todos Categories buffer."
+(defun todo-raise-category ()
+ "Raise priority of category at point in Todo Categories buffer."
(interactive)
- (todos-set-category-number 'raise))
+ (todo-set-category-number 'raise))
-(defun todos-lower-category ()
- "Lower priority of category at point in Todos Categories buffer."
+(defun todo-lower-category ()
+ "Lower priority of category at point in Todo Categories buffer."
(interactive)
- (todos-set-category-number 'lower))
+ (todo-set-category-number 'lower))
-(defun todos-sort-categories-alphabetically-or-numerically ()
+(defun todo-sort-categories-alphabetically-or-numerically ()
"Sort table of categories alphabetically or numerically."
(interactive)
(save-excursion
(goto-char (point-min))
(forward-line 2)
- (if (member 'alpha todos-descending-counts)
+ (if (member 'alpha todo-descending-counts)
(progn
- (todos-update-categories-display nil)
- (setq todos-descending-counts
- (delete 'alpha todos-descending-counts)))
- (todos-update-categories-display 'alpha))))
+ (todo-update-categories-display nil)
+ (setq todo-descending-counts
+ (delete 'alpha todo-descending-counts)))
+ (todo-update-categories-display 'alpha))))
-(defun todos-sort-categories-by-todo ()
+(defun todo-sort-categories-by-todo ()
"Sort table of categories by number of todo items."
(interactive)
(save-excursion
(goto-char (point-min))
(forward-line 2)
- (todos-update-categories-display 'todo)))
+ (todo-update-categories-display 'todo)))
-(defun todos-sort-categories-by-diary ()
+(defun todo-sort-categories-by-diary ()
"Sort table of categories by number of diary items."
(interactive)
(save-excursion
(goto-char (point-min))
(forward-line 2)
- (todos-update-categories-display 'diary)))
+ (todo-update-categories-display 'diary)))
-(defun todos-sort-categories-by-done ()
+(defun todo-sort-categories-by-done ()
"Sort table of categories by number of non-archived done items."
(interactive)
(save-excursion
(goto-char (point-min))
(forward-line 2)
- (todos-update-categories-display 'done)))
+ (todo-update-categories-display 'done)))
-(defun todos-sort-categories-by-archived ()
+(defun todo-sort-categories-by-archived ()
"Sort table of categories by number of archived items."
(interactive)
(save-excursion
(goto-char (point-min))
(forward-line 2)
- (todos-update-categories-display 'archived)))
+ (todo-update-categories-display 'archived)))
-(defvar todos-categories-buffer "*Todos Categories*"
- "Name of buffer in Todos Categories mode.")
+(defvar todo-categories-buffer "*Todo Categories*"
+ "Name of buffer in Todo Categories mode.")
-(defun todos-longest-category-name-length (categories)
+(defun todo-longest-category-name-length (categories)
"Return the length of the longest name in list CATEGORIES."
(let ((longest 0))
(dolist (c categories longest)
(setq longest (max longest (length c))))))
-(defun todos-adjusted-category-label-length ()
+(defun todo-adjusted-category-label-length ()
"Return adjusted length of category label button.
-The adjustment ensures proper tabular alignment in Todos
+The adjustment ensures proper tabular alignment in Todo
Categories mode."
- (let* ((categories (mapcar 'car todos-categories))
- (longest (todos-longest-category-name-length categories))
- (catlablen (length todos-categories-category-label))
+ (let* ((categories (mapcar 'car todo-categories))
+ (longest (todo-longest-category-name-length categories))
+ (catlablen (length todo-categories-category-label))
(lc-diff (- longest catlablen)))
(if (and (natnump lc-diff) (cl-oddp lc-diff))
(1+ longest)
(max longest catlablen))))
-(defun todos-padded-string (str)
+(defun todo-padded-string (str)
"Return category name or label string STR padded with spaces.
The placement of the padding is determined by the value of user
-option `todos-categories-align'."
- (let* ((len (todos-adjusted-category-label-length))
+option `todo-categories-align'."
+ (let* ((len (todo-adjusted-category-label-length))
(strlen (length str))
(strlen-odd (eq (logand strlen 1) 1))
(padding (max 0 (/ (- len strlen) 2)))
- (padding-left (cond ((eq todos-categories-align 'left) 0)
- ((eq todos-categories-align 'center) padding)
- ((eq todos-categories-align 'right)
+ (padding-left (cond ((eq todo-categories-align 'left) 0)
+ ((eq todo-categories-align 'center) padding)
+ ((eq todo-categories-align 'right)
(if strlen-odd (1+ (* padding 2)) (* padding 2)))))
- (padding-right (cond ((eq todos-categories-align 'left)
+ (padding-right (cond ((eq todo-categories-align 'left)
(if strlen-odd (1+ (* padding 2)) (* padding 2)))
- ((eq todos-categories-align 'center)
+ ((eq todo-categories-align 'center)
(if strlen-odd (1+ padding) padding))
- ((eq todos-categories-align 'right) 0))))
+ ((eq todo-categories-align 'right) 0))))
(concat (make-string padding-left 32) str (make-string padding-right 32))))
-(defvar todos-descending-counts nil
+(defvar todo-descending-counts nil
"List of keys for category counts sorted in descending order.")
-(defun todos-sort (list &optional key)
+(defun todo-sort (list &optional key)
"Return a copy of LIST, possibly sorted according to KEY."
(let* ((l (copy-sequence list))
(fn (if (eq key 'alpha)
(lambda (x) (upcase x)) ; Alphabetize case insensitively.
- (lambda (x) (todos-get-count key x))))
+ (lambda (x) (todo-get-count key x))))
;; Keep track of whether the last sort by key was descending or
;; ascending.
- (descending (member key todos-descending-counts))
+ (descending (member key todo-descending-counts))
(cmp (if (eq key 'alpha)
'string<
(if descending '< '>)))
(setq l (sort l pred))
;; Switch between descending and ascending sort order.
(if descending
- (setq todos-descending-counts
- (delete key todos-descending-counts))
- (push key todos-descending-counts)))
+ (setq todo-descending-counts
+ (delete key todo-descending-counts))
+ (push key todo-descending-counts)))
l))
-(defun todos-display-sorted (type)
+(defun todo-display-sorted (type)
"Keep point on the TYPE count sorting button just clicked."
(let ((opoint (point)))
- (todos-update-categories-display type)
+ (todo-update-categories-display type)
(goto-char opoint)))
-(defun todos-label-to-key (label)
+(defun todo-label-to-key (label)
"Return symbol for sort key associated with LABEL."
(let (key)
- (cond ((string= label todos-categories-category-label)
+ (cond ((string= label todo-categories-category-label)
(setq key 'alpha))
- ((string= label todos-categories-todo-label)
+ ((string= label todo-categories-todo-label)
(setq key 'todo))
- ((string= label todos-categories-diary-label)
+ ((string= label todo-categories-diary-label)
(setq key 'diary))
- ((string= label todos-categories-done-label)
+ ((string= label todo-categories-done-label)
(setq key 'done))
- ((string= label todos-categories-archived-label)
+ ((string= label todo-categories-archived-label)
(setq key 'archived)))
key))
-(defun todos-insert-sort-button (label)
+(defun todo-insert-sort-button (label)
"Insert button for displaying categories sorted by item counts.
LABEL determines which type of count is sorted."
- (let* ((str (if (string= label todos-categories-category-label)
- (todos-padded-string label)
+ (let* ((str (if (string= label todo-categories-category-label)
+ (todo-padded-string label)
label))
(beg (point))
(end (+ beg (length str)))
(insert-button str 'face nil
'action
`(lambda (button)
- (let ((key (todos-label-to-key ,label)))
- (if (and (member key todos-descending-counts)
+ (let ((key (todo-label-to-key ,label)))
+ (if (and (member key todo-descending-counts)
(eq key 'alpha))
(progn
;; If display is alphabetical, switch back to
;; category priority order.
- (todos-display-sorted nil)
- (setq todos-descending-counts
- (delete key todos-descending-counts)))
- (todos-display-sorted key)))))
+ (todo-display-sorted nil)
+ (setq todo-descending-counts
+ (delete key todo-descending-counts)))
+ (todo-display-sorted key)))))
(setq ov (make-overlay beg end))
- (overlay-put ov 'face 'todos-button)))
+ (overlay-put ov 'face 'todo-button)))
-(defun todos-total-item-counts ()
+(defun todo-total-item-counts ()
"Return a list of total item counts for the current file."
(mapcar (lambda (i) (apply '+ (mapcar (lambda (l) (aref l i))
- (mapcar 'cdr todos-categories))))
+ (mapcar 'cdr todo-categories))))
(list 0 1 2 3)))
-(defvar todos-categories-category-number 0
- "Variable for numbering categories in Todos Categories mode.")
+(defvar todo-categories-category-number 0
+ "Variable for numbering categories in Todo Categories mode.")
-(defun todos-insert-category-line (cat &optional nonum)
+(defun todo-insert-category-line (cat &optional nonum)
"Insert button with category CAT's name and item counts.
With non-nil argument NONUM show only these; otherwise, insert a
number in front of the button indicating the category's priority.
The number and the category name are separated by the string
which is the value of the user option
-`todos-categories-number-separator'."
- (let ((archive (member todos-current-todos-file todos-archives))
- (num todos-categories-category-number)
- (str (todos-padded-string cat))
+`todo-categories-number-separator'."
+ (let ((archive (member todo-current-todo-file todo-archives))
+ (num todo-categories-category-number)
+ (str (todo-padded-string cat))
(opoint (point)))
- (setq num (1+ num) todos-categories-category-number num)
+ (setq num (1+ num) todo-categories-category-number num)
(insert-button
(concat (if nonum
- (make-string (+ 4 (length todos-categories-number-separator))
+ (make-string (+ 4 (length todo-categories-number-separator))
32)
- (format " %3d%s" num todos-categories-number-separator))
+ (format " %3d%s" num todo-categories-number-separator))
str
(mapconcat (lambda (elt)
(concat
(make-string (1+ (/ (length (car elt)) 2)) 32) ; label
- (format "%3d" (todos-get-count (cdr elt) cat)) ; count
+ (format "%3d" (todo-get-count (cdr elt) cat)) ; count
;; Add an extra space if label length is odd.
(when (cl-oddp (length (car elt))) " ")))
(if archive
- (list (cons todos-categories-done-label 'done))
- (list (cons todos-categories-todo-label 'todo)
- (cons todos-categories-diary-label 'diary)
- (cons todos-categories-done-label 'done)
- (cons todos-categories-archived-label
+ (list (cons todo-categories-done-label 'done))
+ (list (cons todo-categories-todo-label 'todo)
+ (cons todo-categories-diary-label 'diary)
+ (cons todo-categories-done-label 'done)
+ (cons todo-categories-archived-label
'archived)))
"")
" ") ; Make highlighting on last column look better.
- 'face (if (and todos-skip-archived-categories
- (zerop (todos-get-count 'todo cat))
- (zerop (todos-get-count 'done cat))
- (not (zerop (todos-get-count 'archived cat))))
- 'todos-archived-only
+ 'face (if (and todo-skip-archived-categories
+ (zerop (todo-get-count 'todo cat))
+ (zerop (todo-get-count 'done cat))
+ (not (zerop (todo-get-count 'archived cat))))
+ 'todo-archived-only
nil)
'action `(lambda (button) (let ((buf (current-buffer)))
- (todos-jump-to-category nil ,cat)
+ (todo-jump-to-category nil ,cat)
(kill-buffer buf))))
;; Highlight the sorted count column.
(let* ((beg (+ opoint 7 (length str)))
end ovl)
(cond ((eq nonum 'todo)
- (setq beg (+ beg 1 (/ (length todos-categories-todo-label) 2))))
+ (setq beg (+ beg 1 (/ (length todo-categories-todo-label) 2))))
((eq nonum 'diary)
- (setq beg (+ beg 1 (length todos-categories-todo-label)
- 2 (/ (length todos-categories-diary-label) 2))))
+ (setq beg (+ beg 1 (length todo-categories-todo-label)
+ 2 (/ (length todo-categories-diary-label) 2))))
((eq nonum 'done)
- (setq beg (+ beg 1 (length todos-categories-todo-label)
- 2 (length todos-categories-diary-label)
- 2 (/ (length todos-categories-done-label) 2))))
+ (setq beg (+ beg 1 (length todo-categories-todo-label)
+ 2 (length todo-categories-diary-label)
+ 2 (/ (length todo-categories-done-label) 2))))
((eq nonum 'archived)
- (setq beg (+ beg 1 (length todos-categories-todo-label)
- 2 (length todos-categories-diary-label)
- 2 (length todos-categories-done-label)
- 2 (/ (length todos-categories-archived-label) 2)))))
+ (setq beg (+ beg 1 (length todo-categories-todo-label)
+ 2 (length todo-categories-diary-label)
+ 2 (length todo-categories-done-label)
+ 2 (/ (length todo-categories-archived-label) 2)))))
(unless (= beg (+ opoint 7 (length str))) ; Don't highlight categories.
(setq end (+ beg 4))
(setq ovl (make-overlay beg end))
- (overlay-put ovl 'face 'todos-sorted-column)))
+ (overlay-put ovl 'face 'todo-sorted-column)))
(newline)))
-(defun todos-display-categories ()
+(defun todo-display-categories ()
"Prepare buffer for displaying table of categories and item counts."
- (unless (eq major-mode 'todos-categories-mode)
- (setq todos-global-current-todos-file
- (or todos-current-todos-file
- (todos-absolute-file-name todos-default-todos-file)))
+ (unless (eq major-mode 'todo-categories-mode)
+ (setq todo-global-current-todo-file
+ (or todo-current-todo-file
+ (todo-absolute-file-name todo-default-todo-file)))
(set-window-buffer (selected-window)
- (set-buffer (get-buffer-create todos-categories-buffer)))
+ (set-buffer (get-buffer-create todo-categories-buffer)))
(kill-all-local-variables)
- (todos-categories-mode)
- (let ((archive (member todos-current-todos-file todos-archives))
+ (todo-categories-mode)
+ (let ((archive (member todo-current-todo-file todo-archives))
buffer-read-only)
(erase-buffer)
- (insert (format (concat "Category counts for Todos "
+ (insert (format (concat "Category counts for Todo "
(if archive "archive" "file")
" \"%s\".")
- (todos-short-file-name todos-current-todos-file)))
+ (todo-short-file-name todo-current-todo-file)))
(newline 2)
;; Make space for the column of category numbers.
- (insert (make-string (+ 4 (length todos-categories-number-separator)) 32))
+ (insert (make-string (+ 4 (length todo-categories-number-separator)) 32))
;; Add the category and item count buttons (if this is the list of
;; categories in an archive, show only done item counts).
- (todos-insert-sort-button todos-categories-category-label)
+ (todo-insert-sort-button todo-categories-category-label)
(if archive
(progn
(insert (make-string 3 32))
- (todos-insert-sort-button todos-categories-done-label))
+ (todo-insert-sort-button todo-categories-done-label))
(insert (make-string 3 32))
- (todos-insert-sort-button todos-categories-todo-label)
+ (todo-insert-sort-button todo-categories-todo-label)
(insert (make-string 2 32))
- (todos-insert-sort-button todos-categories-diary-label)
+ (todo-insert-sort-button todo-categories-diary-label)
(insert (make-string 2 32))
- (todos-insert-sort-button todos-categories-done-label)
+ (todo-insert-sort-button todo-categories-done-label)
(insert (make-string 2 32))
- (todos-insert-sort-button todos-categories-archived-label))
+ (todo-insert-sort-button todo-categories-archived-label))
(newline 2))))
-(defun todos-update-categories-display (sortkey)
+(defun todo-update-categories-display (sortkey)
"Populate table of categories and sort by SORTKEY."
- (let* ((cats0 todos-categories)
- (cats (todos-sort cats0 sortkey))
- (archive (member todos-current-todos-file todos-archives))
- (todos-categories-category-number 0)
- ;; Find start of Category button if we just entered Todos Categories
+ (let* ((cats0 todo-categories)
+ (cats (todo-sort cats0 sortkey))
+ (archive (member todo-current-todo-file todo-archives))
+ (todo-categories-category-number 0)
+ ;; Find start of Category button if we just entered Todo Categories
;; mode.
(pt (if (eq (point) (point-max))
(save-excursion
(delete-region (point) (point-max))
;; Fill in the table with buttonized lines, each showing a category and
;; its item counts.
- (mapc (lambda (cat) (todos-insert-category-line cat sortkey))
+ (mapc (lambda (cat) (todo-insert-category-line cat sortkey))
(mapcar 'car cats))
(newline)
;; Add a line showing item count totals.
- (insert (make-string (+ 4 (length todos-categories-number-separator)) 32)
- (todos-padded-string todos-categories-totals-label)
+ (insert (make-string (+ 4 (length todo-categories-number-separator)) 32)
+ (todo-padded-string todo-categories-totals-label)
(mapconcat
(lambda (elt)
(concat
(make-string (1+ (/ (length (car elt)) 2)) 32)
- (format "%3d" (nth (cdr elt) (todos-total-item-counts)))
+ (format "%3d" (nth (cdr elt) (todo-total-item-counts)))
;; Add an extra space if label length is odd.
(when (cl-oddp (length (car elt))) " ")))
(if archive
- (list (cons todos-categories-done-label 2))
- (list (cons todos-categories-todo-label 0)
- (cons todos-categories-diary-label 1)
- (cons todos-categories-done-label 2)
- (cons todos-categories-archived-label 3)))
+ (list (cons todo-categories-done-label 2))
+ (list (cons todo-categories-todo-label 0)
+ (cons todo-categories-diary-label 1)
+ (cons todo-categories-done-label 2)
+ (cons todo-categories-archived-label 3)))
""))
;; Put cursor on Category button initially.
(if pt (goto-char pt))
;;; Searching and item filtering
;; -----------------------------------------------------------------------------
-(defun todos-search ()
- "Search for a regular expression in this Todos file.
+(defun todo-search ()
+ "Search for a regular expression in this Todo file.
The search runs through the whole file and encompasses all and
only todo and done items; it excludes category names. Multiple
-matches are shown sequentially, highlighted in `todos-search'
+matches are shown sequentially, highlighted in `todo-search'
face."
(interactive)
(let ((regex (read-from-minibuffer "Enter a search string (regexp): "))
(setq match (re-search-forward regex nil t))
(goto-char (line-beginning-position))
(unless (or (equal (point) 1)
- (looking-at (concat "^" (regexp-quote todos-category-beg))))
+ (looking-at (concat "^" (regexp-quote todo-category-beg))))
(if match (push match matches)))
(forward-line))
(setq matches (reverse matches))
(while matches
(setq match (pop matches))
(goto-char match)
- (todos-item-start)
- (when (looking-at todos-done-string-start)
+ (todo-item-start)
+ (when (looking-at todo-done-string-start)
(setq in-done t))
- (re-search-backward (concat "^" (regexp-quote todos-category-beg)
+ (re-search-backward (concat "^" (regexp-quote todo-category-beg)
"\\(.*\\)\n") nil t)
(setq cat (match-string-no-properties 1))
- (todos-category-number cat)
- (todos-category-select)
+ (todo-category-number cat)
+ (todo-category-select)
(if in-done
- (unless todos-show-with-done (todos-toggle-view-done-items)))
+ (unless todo-show-with-done (todo-toggle-view-done-items)))
(goto-char match)
(setq ov (make-overlay (- (point) (length regex)) (point)))
- (overlay-put ov 'face 'todos-search)
+ (overlay-put ov 'face 'todo-search)
(when matches
(setq mlen (length matches))
- (if (todos-y-or-n-p
+ (if (todo-y-or-n-p
(if (> mlen 1)
(format "There are %d more matches; go to next match? "
mlen)
mlen)
"There is one more match."))))))
(setq msg "There are no more matches."))
- (todos-category-select)
+ (todo-category-select)
(goto-char opoint)
(message "No match for \"%s\"" regex))
(when msg
- (if (todos-y-or-n-p (concat msg "\nUnhighlight matches? "))
- (todos-clear-matches)
+ (if (todo-y-or-n-p (concat msg "\nUnhighlight matches? "))
+ (todo-clear-matches)
(message "You can unhighlight the matches later by typing %s"
(key-description (car (where-is-internal
- 'todos-clear-matches))))))))
+ 'todo-clear-matches))))))))
-(defun todos-clear-matches ()
- "Remove highlighting on matches found by todos-search."
+(defun todo-clear-matches ()
+ "Remove highlighting on matches found by todo-search."
(interactive)
- (remove-overlays 1 (1+ (buffer-size)) 'face 'todos-search))
+ (remove-overlays 1 (1+ (buffer-size)) 'face 'todo-search))
-(defcustom todos-top-priorities-overrides nil
+(defcustom todo-top-priorities-overrides nil
"List of rules specifying number of top priority items to show.
-These rules override `todos-top-priorities' on invocations of
-`\\[todos-filter-top-priorities]' and
-`\\[todos-filter-top-priorities-multifile]'. Each rule is a list
+These rules override `todo-top-priorities' on invocations of
+`\\[todo-filter-top-priorities]' and
+`\\[todo-filter-top-priorities-multifile]'. Each rule is a list
of the form (FILE NUM ALIST), where FILE is a member of
-`todos-files', NUM is a number specifying the default number of
+`todo-files', NUM is a number specifying the default number of
top priority items for each category in that file, and ALIST,
when non-nil, consists of conses of a category name in FILE and a
number specifying the default number of top priority items in
that category, which overrides NUM.
This variable should be set interactively by
-`\\[todos-set-top-priorities-in-file]' or
-`\\[todos-set-top-priorities-in-category]'."
+`\\[todo-set-top-priorities-in-file]' or
+`\\[todo-set-top-priorities-in-category]'."
:type 'sexp
- :group 'todos-filtered)
+ :group 'todo-filtered)
-(defcustom todos-top-priorities 1
- "Default number of top priorities shown by `todos-filter-top-priorities'."
+(defcustom todo-top-priorities 1
+ "Default number of top priorities shown by `todo-filter-top-priorities'."
:type 'integer
- :group 'todos-filtered)
+ :group 'todo-filtered)
-(defcustom todos-filter-files nil
+(defcustom todo-filter-files nil
"List of default files for multifile item filtering."
:type `(set ,@(mapcar (lambda (f) (list 'const f))
- (mapcar 'todos-short-file-name
- (funcall todos-files-function))))
- :group 'todos-filtered)
+ (mapcar 'todo-short-file-name
+ (funcall todo-files-function))))
+ :group 'todo-filtered)
-(defcustom todos-filter-done-items nil
+(defcustom todo-filter-done-items nil
"Non-nil to include done items when processing regexp filters.
Done items from corresponding archive files are also included."
:type 'boolean
- :group 'todos-filtered)
+ :group 'todo-filtered)
-(defun todos-set-top-priorities-in-file ()
+(defun todo-set-top-priorities-in-file ()
"Set number of top priorities for this file.
-See `todos-set-top-priorities' for more details."
+See `todo-set-top-priorities' for more details."
(interactive)
- (todos-set-top-priorities))
+ (todo-set-top-priorities))
-(defun todos-set-top-priorities-in-category ()
+(defun todo-set-top-priorities-in-category ()
"Set number of top priorities for this category.
-See `todos-set-top-priorities' for more details."
+See `todo-set-top-priorities' for more details."
(interactive)
- (todos-set-top-priorities t))
+ (todo-set-top-priorities t))
-(defun todos-filter-top-priorities (&optional arg)
+(defun todo-filter-top-priorities (&optional arg)
"Display a list of top priority items from different categories.
-The categories can be any of those in the current Todos file.
+The categories can be any of those in the current Todo file.
With numerical prefix ARG show at most ARG top priority items
from each category. With `C-u' as prefix argument show the
numbers of top priority items specified by category in
-`todos-top-priorities-overrides', if this has an entry for the file(s);
-otherwise show `todos-top-priorities' items per category in the
+`todo-top-priorities-overrides', if this has an entry for the file(s);
+otherwise show `todo-top-priorities' items per category in the
file(s). With no prefix argument, if a top priorities file for
-the current Todos file has previously been saved (see
-`todos-save-filtered-items-buffer'), visit this file; if there is
+the current Todo file has previously been saved (see
+`todo-save-filtered-items-buffer'), visit this file; if there is
no such file, build the list as with prefix argument `C-u'.
The prefix ARG regulates how many top priorities from
each category to show, as described above."
(interactive "P")
- (todos-filter-items 'top arg))
+ (todo-filter-items 'top arg))
-(defun todos-filter-top-priorities-multifile (&optional arg)
+(defun todo-filter-top-priorities-multifile (&optional arg)
"Display a list of top priority items from different categories.
The categories are a subset of the categories in the files listed
-in `todos-filter-files', or if this nil, in the files chosen from
+in `todo-filter-files', or if this nil, in the files chosen from
a file selection dialog that pops up in this case.
With numerical prefix ARG show at most ARG top priority items
from each category in each file. With `C-u' as prefix argument
show the numbers of top priority items specified in
-`todos-top-priorities-overrides', if this is non-nil; otherwise show
-`todos-top-priorities' items per category. With no prefix
-argument, if a top priorities file for the chosen Todos files
-exists (see `todos-save-filtered-items-buffer'), visit this file;
+`todo-top-priorities-overrides', if this is non-nil; otherwise show
+`todo-top-priorities' items per category. With no prefix
+argument, if a top priorities file for the chosen Todo files
+exists (see `todo-save-filtered-items-buffer'), visit this file;
if there is no such file, do the same as with prefix argument
`C-u'."
(interactive "P")
- (todos-filter-items 'top arg t))
+ (todo-filter-items 'top arg t))
-(defun todos-filter-diary-items (&optional arg)
+(defun todo-filter-diary-items (&optional arg)
"Display a list of todo diary items from different categories.
-The categories can be any of those in the current Todos file.
+The categories can be any of those in the current Todo file.
Called with no prefix ARG, if a diary items file for the current
-Todos file has previously been saved (see
-`todos-save-filtered-items-buffer'), visit this file; if there is
+Todo file has previously been saved (see
+`todo-save-filtered-items-buffer'), visit this file; if there is
no such file, build the list of diary items. Called with a
prefix argument, build the list even if there is a saved file of
diary items."
(interactive "P")
- (todos-filter-items 'diary arg))
+ (todo-filter-items 'diary arg))
-(defun todos-filter-diary-items-multifile (&optional arg)
+(defun todo-filter-diary-items-multifile (&optional arg)
"Display a list of todo diary items from different categories.
The categories are a subset of the categories in the files listed
-in `todos-filter-files', or if this nil, in the files chosen from
+in `todo-filter-files', or if this nil, in the files chosen from
a file selection dialog that pops up in this case.
Called with no prefix ARG, if a diary items file for the chosen
-Todos files has previously been saved (see
-`todos-save-filtered-items-buffer'), visit this file; if there is
+Todo files has previously been saved (see
+`todo-save-filtered-items-buffer'), visit this file; if there is
no such file, build the list of diary items. Called with a
prefix argument, build the list even if there is a saved file of
diary items."
(interactive "P")
- (todos-filter-items 'diary arg t))
+ (todo-filter-items 'diary arg t))
-(defun todos-filter-regexp-items (&optional arg)
+(defun todo-filter-regexp-items (&optional arg)
"Prompt for a regular expression and display items that match it.
-The matches can be from any categories in the current Todos file
-and with non-nil option `todos-filter-done-items', can include
+The matches can be from any categories in the current Todo file
+and with non-nil option `todo-filter-done-items', can include
not only todo items but also done items, including those in
Archive files.
Called with no prefix ARG, if a regexp items file for the current
-Todos file has previously been saved (see
-`todos-save-filtered-items-buffer'), visit this file; if there is
+Todo file has previously been saved (see
+`todo-save-filtered-items-buffer'), visit this file; if there is
no such file, build the list of regexp items. Called with a
prefix argument, build the list even if there is a saved file of
regexp items."
(interactive "P")
- (todos-filter-items 'regexp arg))
+ (todo-filter-items 'regexp arg))
-(defun todos-filter-regexp-items-multifile (&optional arg)
+(defun todo-filter-regexp-items-multifile (&optional arg)
"Prompt for a regular expression and display items that match it.
The matches can be from any categories in the files listed in
-`todos-filter-files', or if this nil, in the files chosen from a
+`todo-filter-files', or if this nil, in the files chosen from a
file selection dialog that pops up in this case. With non-nil
-option `todos-filter-done-items', the matches can include not
+option `todo-filter-done-items', the matches can include not
only todo items but also done items, including those in Archive
files.
Called with no prefix ARG, if a regexp items file for the current
-Todos file has previously been saved (see
-`todos-save-filtered-items-buffer'), visit this file; if there is
+Todo file has previously been saved (see
+`todo-save-filtered-items-buffer'), visit this file; if there is
no such file, build the list of regexp items. Called with a
prefix argument, build the list even if there is a saved file of
regexp items."
(interactive "P")
- (todos-filter-items 'regexp arg t))
+ (todo-filter-items 'regexp arg t))
-(defun todos-find-filtered-items-file ()
+(defun todo-find-filtered-items-file ()
"Choose a filtered items file and visit it."
(interactive)
- (let ((files (directory-files todos-directory t "\.tod[rty]$" t))
+ (let ((files (directory-files todo-directory t "\.tod[rty]$" t))
falist file)
(dolist (f files)
(let ((type (cond ((equal (file-name-extension f) "todr") "regexp")
((equal (file-name-extension f) "todt") "top")
((equal (file-name-extension f) "tody") "diary"))))
- (push (cons (concat (todos-short-file-name f) " (" type ")") f)
+ (push (cons (concat (todo-short-file-name f) " (" type ")") f)
falist)))
(setq file (completing-read "Choose a filtered items file: "
falist nil t nil nil (car falist)))
(setq file (cdr (assoc-string file falist)))
(find-file file)))
-(defun todos-go-to-source-item ()
+(defun todo-go-to-source-item ()
"Display the file and category of the filtered item at point."
(interactive)
- (let* ((str (todos-item-string))
+ (let* ((str (todo-item-string))
(buf (current-buffer))
- (res (todos-find-item str))
+ (res (todo-find-item str))
(found (nth 0 res))
(file (nth 1 res))
(cat (nth 2 res)))
(kill-buffer buf)
(set-window-buffer (selected-window)
(set-buffer (find-buffer-visiting file)))
- (setq todos-current-todos-file file)
- (setq todos-category-number (todos-category-number cat))
- (let ((todos-show-with-done (if (or todos-filter-done-items
+ (setq todo-current-todo-file file)
+ (setq todo-category-number (todo-category-number cat))
+ (let ((todo-show-with-done (if (or todo-filter-done-items
(eq (cdr found) 'done))
t
- todos-show-with-done)))
- (todos-category-select))
+ todo-show-with-done)))
+ (todo-category-select))
(goto-char (car found)))))
-(defvar todos-multiple-filter-files nil
- "List of files selected from `todos-multiple-filter-files' widget.")
+(defvar todo-multiple-filter-files nil
+ "List of files selected from `todo-multiple-filter-files' widget.")
-(defvar todos-multiple-filter-files-widget nil
- "Variable holding widget created by `todos-multiple-filter-files'.")
+(defvar todo-multiple-filter-files-widget nil
+ "Variable holding widget created by `todo-multiple-filter-files'.")
-(defun todos-multiple-filter-files ()
+(defun todo-multiple-filter-files ()
"Pop to a buffer with a widget for choosing multiple filter files."
(require 'widget)
(eval-when-compile
(require 'wid-edit))
- (with-current-buffer (get-buffer-create "*Todos Filter Files*")
+ (with-current-buffer (get-buffer-create "*Todo Filter Files*")
(pop-to-buffer (current-buffer))
(erase-buffer)
(kill-all-local-variables)
(widget-insert "Select files for generating the top priorities list.\n\n")
- (setq todos-multiple-filter-files-widget
+ (setq todo-multiple-filter-files-widget
(widget-create
`(set ,@(mapcar (lambda (x) (list 'const x))
- (mapcar 'todos-short-file-name
- (funcall todos-files-function))))))
+ (mapcar 'todo-short-file-name
+ (funcall todo-files-function))))))
(widget-insert "\n")
(widget-create 'push-button
:notify (lambda (widget &rest ignore)
- (setq todos-multiple-filter-files 'quit)
+ (setq todo-multiple-filter-files 'quit)
(quit-window t)
(exit-recursive-edit))
"Cancel")
(widget-insert " ")
(widget-create 'push-button
:notify (lambda (&rest ignore)
- (setq todos-multiple-filter-files
+ (setq todo-multiple-filter-files
(mapcar (lambda (f)
(file-truename
- (concat todos-directory
+ (concat todo-directory
f ".todo")))
(widget-value
- todos-multiple-filter-files-widget)))
+ todo-multiple-filter-files-widget)))
(quit-window t)
(exit-recursive-edit))
"Apply")
(message "Click \"Apply\" after selecting files.")
(recursive-edit))
-(defconst todos-filtered-items-buffer "Todos filtered items"
- "Initial name of buffer in Todos Filter Items mode.")
+(defconst todo-filtered-items-buffer "Todo filtered items"
+ "Initial name of buffer in Todo Filter Items mode.")
-(defconst todos-top-priorities-buffer "Todos top priorities"
- "Buffer type string for `todos-filter-items'.")
+(defconst todo-top-priorities-buffer "Todo top priorities"
+ "Buffer type string for `todo-filter-items'.")
-(defconst todos-diary-items-buffer "Todos diary items"
- "Buffer type string for `todos-filter-items'.")
+(defconst todo-diary-items-buffer "Todo diary items"
+ "Buffer type string for `todo-filter-items'.")
-(defconst todos-regexp-items-buffer "Todos regexp items"
- "Buffer type string for `todos-filter-items'.")
+(defconst todo-regexp-items-buffer "Todo regexp items"
+ "Buffer type string for `todo-filter-items'.")
-(defun todos-filter-items (filter &optional new multifile)
+(defun todo-filter-items (filter &optional new multifile)
"Display a cross-categorial list of items filtered by FILTER.
The values of FILTER can be `top' for top priority items, a cons
of `top' and a number passed by the caller, `diary' for diary
list and display it.
See the document strings of the commands
-`todos-filter-top-priorities', `todos-filter-diary-items',
-`todos-filter-regexp-items', and those of the corresponding
+`todo-filter-top-priorities', `todo-filter-diary-items',
+`todo-filter-regexp-items', and those of the corresponding
multifile commands for further details."
(let* ((top (eq filter 'top))
(diary (eq filter 'diary))
(regexp (eq filter 'regexp))
- (buf (cond (top todos-top-priorities-buffer)
- (diary todos-diary-items-buffer)
- (regexp todos-regexp-items-buffer)))
+ (buf (cond (top todo-top-priorities-buffer)
+ (diary todo-diary-items-buffer)
+ (regexp todo-regexp-items-buffer)))
(flist (if multifile
- (or todos-filter-files
- (progn (todos-multiple-filter-files)
- todos-multiple-filter-files))
- (list todos-current-todos-file)))
+ (or todo-filter-files
+ (progn (todo-multiple-filter-files)
+ todo-multiple-filter-files))
+ (list todo-current-todo-file)))
(multi (> (length flist) 1))
(fname (if (equal flist 'quit)
;; Pressed `cancel' in t-m-f-f file selection dialog.
(keyboard-quit)
- (concat todos-directory
- (mapconcat 'todos-short-file-name flist "-")
+ (concat todo-directory
+ (mapconcat 'todo-short-file-name flist "-")
(cond (top ".todt")
(diary ".tody")
(regexp ".todr")))))
(rxfiles (when regexp
- (directory-files todos-directory t ".*\\.todr$" t)))
+ (directory-files todo-directory t ".*\\.todr$" t)))
(file-exists (or (file-exists-p fname) rxfiles)))
(cond ((and top new (natnump new))
- (todos-filter-items-1 (cons 'top new) flist))
+ (todo-filter-items-1 (cons 'top new) flist))
((and (not new) file-exists)
(when (and rxfiles (> (length rxfiles) 1))
- (let ((rxf (mapcar 'todos-short-file-name rxfiles)))
- (setq fname (todos-absolute-file-name
+ (let ((rxf (mapcar 'todo-short-file-name rxfiles)))
+ (setq fname (todo-absolute-file-name
(completing-read "Choose a regexp items file: "
rxf) 'regexp))))
(find-file fname)
- (todos-prefix-overlays)
- (todos-check-filtered-items-file))
+ (todo-prefix-overlays)
+ (todo-check-filtered-items-file))
(t
- (todos-filter-items-1 filter flist)))
+ (todo-filter-items-1 filter flist)))
(setq fname (replace-regexp-in-string "-" ", "
- (todos-short-file-name fname)))
+ (todo-short-file-name fname)))
(rename-buffer (format (concat "%s for file" (if multi "s" "")
" \"%s\"") buf fname))))
-(defun todos-filter-items-1 (filter file-list)
+(defun todo-filter-items-1 (filter file-list)
"Build a list of items by applying FILTER to FILE-LIST.
-Internal subroutine called by `todos-filter-items', which passes
+Internal subroutine called by `todo-filter-items', which passes
the values of FILTER and FILE-LIST."
- (let ((num (if (consp filter) (cdr filter) todos-top-priorities))
- (buf (get-buffer-create todos-filtered-items-buffer))
+ (let ((num (if (consp filter) (cdr filter) todo-top-priorities))
+ (buf (get-buffer-create todo-filtered-items-buffer))
(multifile (> (length file-list) 1))
regexp fname bufstr cat beg end done)
(if (null file-list)
(with-current-buffer buf
(erase-buffer)
(kill-all-local-variables)
- (todos-filtered-items-mode))
+ (todo-filtered-items-mode))
(when (eq filter 'regexp)
(setq regexp (read-string "Enter a regular expression: ")))
(save-current-buffer
(let ((bf (find-buffer-visiting f)))
(when (buffer-modified-p bf)
(with-current-buffer bf (save-buffer))))
- (setq fname (todos-short-file-name f))
+ (setq fname (todo-short-file-name f))
(with-temp-buffer
- (when (and todos-filter-done-items (eq filter 'regexp))
+ (when (and todo-filter-done-items (eq filter 'regexp))
;; If there is a corresponding archive file for the
- ;; Todos file, insert it first and add identifiers for
- ;; todos-go-to-source-item.
+ ;; Todo file, insert it first and add identifiers for
+ ;; todo-go-to-source-item.
(let ((arch (concat (file-name-sans-extension f) ".toda")))
(when (file-exists-p arch)
(insert-file-contents arch)
- ;; Delete Todos archive file categories sexp.
+ ;; Delete Todo archive file categories sexp.
(delete-region (line-beginning-position)
(1+ (line-end-position)))
(save-excursion
(while (not (eobp))
(when (re-search-forward
- (concat (if todos-filter-done-items
- (concat "\\(?:" todos-done-string-start
- "\\|" todos-date-string-start
+ (concat (if todo-filter-done-items
+ (concat "\\(?:" todo-done-string-start
+ "\\|" todo-date-string-start
"\\)")
- todos-date-string-start)
- todos-date-pattern "\\(?: "
+ todo-date-string-start)
+ todo-date-pattern "\\(?: "
diary-time-regexp "\\)?"
- (if todos-filter-done-items
+ (if todo-filter-done-items
"\\]"
- (regexp-quote todos-nondiary-end)) "?")
+ (regexp-quote todo-nondiary-end)) "?")
nil t)
(insert "(archive) "))
(forward-line))))))
(insert-file-contents f)
- ;; Delete Todos file categories sexp.
+ ;; Delete Todo file categories sexp.
(delete-region (line-beginning-position) (1+ (line-end-position)))
(let (fnum)
;; Unless the number of top priorities to show was
;; passed by the caller, the file-wide value from
- ;; `todos-top-priorities-overrides', if non-nil, overrides
- ;; `todos-top-priorities'.
+ ;; `todo-top-priorities-overrides', if non-nil, overrides
+ ;; `todo-top-priorities'.
(unless (consp filter)
- (setq fnum (or (nth 1 (assoc f todos-top-priorities-overrides))
- todos-top-priorities)))
+ (setq fnum (or (nth 1 (assoc f todo-top-priorities-overrides))
+ todo-top-priorities)))
(while (re-search-forward
- (concat "^" (regexp-quote todos-category-beg)
+ (concat "^" (regexp-quote todo-category-beg)
"\\(.+\\)\n") nil t)
(setq cat (match-string 1))
(let (cnum)
;; Unless the number of top priorities to show was
;; passed by the caller, the category-wide value
- ;; from `todos-top-priorities-overrides', if non-nil,
+ ;; from `todo-top-priorities-overrides', if non-nil,
;; overrides a non-nil file-wide value from
- ;; `todos-top-priorities-overrides' as well as
- ;; `todos-top-priorities'.
+ ;; `todo-top-priorities-overrides' as well as
+ ;; `todo-top-priorities'.
(unless (consp filter)
- (let ((cats (nth 2 (assoc f todos-top-priorities-overrides))))
+ (let ((cats (nth 2 (assoc f todo-top-priorities-overrides))))
(setq cnum (or (cdr (assoc cat cats)) fnum))))
(delete-region (match-beginning 0) (match-end 0))
(setq beg (point)) ; First item in the current category.
(setq end (if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg))
+ (concat "^" (regexp-quote todo-category-beg))
nil t)
(match-beginning 0)
(point-max)))
(goto-char beg)
(setq done
(if (re-search-forward
- (concat "\n" (regexp-quote todos-category-done))
+ (concat "\n" (regexp-quote todo-category-done))
end t)
(match-beginning 0)
end))
- (unless (and todos-filter-done-items (eq filter 'regexp))
+ (unless (and todo-filter-done-items (eq filter 'regexp))
;; Leave done items.
(delete-region done end)
(setq end done))
;; Apply the filter.
(cond ((eq filter 'diary)
(while (not (eobp))
- (if (looking-at (regexp-quote todos-nondiary-start))
- (todos-remove-item)
- (todos-forward-item))))
+ (if (looking-at (regexp-quote todo-nondiary-start))
+ (todo-remove-item)
+ (todo-forward-item))))
((eq filter 'regexp)
(while (not (eobp))
- (if (looking-at todos-item-start)
- (if (string-match regexp (todos-item-string))
- (todos-forward-item)
- (todos-remove-item))
+ (if (looking-at todo-item-start)
+ (if (string-match regexp (todo-item-string))
+ (todo-forward-item)
+ (todo-remove-item))
;; Kill lines that aren't part of a todo or done
- ;; item (empty or todos-category-done).
+ ;; item (empty or todo-category-done).
(delete-region (line-beginning-position)
(1+ (line-end-position))))
;; If last todo item in file matches regexp and
;; there are no following done items,
- ;; todos-category-done string is left dangling,
- ;; because todos-forward-item jumps over it.
+ ;; todo-category-done string is left dangling,
+ ;; because todo-forward-item jumps over it.
(if (and (eobp)
(looking-back
- (concat (regexp-quote todos-done-string)
+ (concat (regexp-quote todo-done-string)
"\n")))
(delete-region (point) (progn
(forward-line -2)
(t ; Filter top priority items.
(setq num (or cnum fnum num))
(unless (zerop num)
- (todos-forward-item num))))
+ (todo-forward-item num))))
(setq beg (point))
;; Delete non-top-priority items.
(unless (member filter '(diary regexp))
;; item.
(while (not (eobp))
(when (re-search-forward
- (concat (if todos-filter-done-items
- (concat "\\(?:" todos-done-string-start
- "\\|" todos-date-string-start
+ (concat (if todo-filter-done-items
+ (concat "\\(?:" todo-done-string-start
+ "\\|" todo-date-string-start
"\\)")
- todos-date-string-start)
- todos-date-pattern "\\(?: " diary-time-regexp
- "\\)?" (if todos-filter-done-items
+ todo-date-string-start)
+ todo-date-pattern "\\(?: " diary-time-regexp
+ "\\)?" (if todo-filter-done-items
"\\]"
- (regexp-quote todos-nondiary-end))
+ (regexp-quote todo-nondiary-end))
"?")
nil t)
(insert " [")
(let (buffer-read-only)
(insert bufstr)))))))
(set-window-buffer (selected-window) (set-buffer buf))
- (todos-prefix-overlays)
+ (todo-prefix-overlays)
(goto-char (point-min)))))
-(defun todos-set-top-priorities (&optional arg)
- "Set number of top priorities shown by `todos-filter-top-priorities'.
-With non-nil ARG, set the number only for the current Todos
+(defun todo-set-top-priorities (&optional arg)
+ "Set number of top priorities shown by `todo-filter-top-priorities'.
+With non-nil ARG, set the number only for the current Todo
category; otherwise, set the number for all categories in the
-current Todos file.
+current Todo file.
Calling this function via either of the commands
-`todos-set-top-priorities-in-file' or
-`todos-set-top-priorities-in-category' is the recommended way to
-set the user customizable option `todos-top-priorities-overrides'."
- (let* ((cat (todos-current-category))
- (file todos-current-todos-file)
- (rules todos-top-priorities-overrides)
+`todo-set-top-priorities-in-file' or
+`todo-set-top-priorities-in-category' is the recommended way to
+set the user customizable option `todo-top-priorities-overrides'."
+ (let* ((cat (todo-current-category))
+ (file todo-current-todo-file)
+ (rules todo-top-priorities-overrides)
(frule (assoc-string file rules))
(crule (assoc-string cat (nth 2 frule)))
(crules (nth 2 frule))
(cur (or (if arg (cdr crule) (nth 1 frule))
- todos-top-priorities))
+ todo-top-priorities))
(prompt (if arg (concat "Number of top priorities in this category"
" (currently %d): ")
(concat "Default number of top priorities per category"
(list file cur nrule)
nrule)
(delete frule rules)))
- (customize-save-variable 'todos-top-priorities-overrides rules)
- (todos-prefix-overlays)))
+ (customize-save-variable 'todo-top-priorities-overrides rules)
+ (todo-prefix-overlays)))
-(defun todos-find-item (str)
- "Search for filtered item STR in its saved Todos file.
+(defun todo-find-item (str)
+ "Search for filtered item STR in its saved Todo file.
Return the list (FOUND FILE CAT), where CAT and FILE are the
item's category and file, and FOUND is a cons cell if the search
succeeds, whose car is the start of the item in FILE and whose
cdr is `done', if the item is now a done item, `changed', if its
text was truncated or augmented or, for a top priority item, if
its priority has changed, and `same' otherwise."
- (string-match (concat (if todos-filter-done-items
- (concat "\\(?:" todos-done-string-start "\\|"
- todos-date-string-start "\\)")
- todos-date-string-start)
- todos-date-pattern "\\(?: " diary-time-regexp "\\)?"
- (if todos-filter-done-items
+ (string-match (concat (if todo-filter-done-items
+ (concat "\\(?:" todo-done-string-start "\\|"
+ todo-date-string-start "\\)")
+ todo-date-string-start)
+ todo-date-pattern "\\(?: " diary-time-regexp "\\)?"
+ (if todo-filter-done-items
"\\]"
- (regexp-quote todos-nondiary-end)) "?"
+ (regexp-quote todo-nondiary-end)) "?"
"\\(?4: \\[\\(?3:(archive) \\)?\\(?2:.*:\\)?"
"\\(?1:.*\\)\\]\\).*$") str)
(let ((cat (match-string 1 str))
(while (search-backward filcat nil t)
(setq tpriority (1+ tpriority)))))
(setq file (if file
- (concat todos-directory (substring file 0 -1)
+ (concat todo-directory (substring file 0 -1)
(if archive ".toda" ".todo"))
(if archive
(concat (file-name-sans-extension
- todos-global-current-todos-file) ".toda")
- todos-global-current-todos-file)))
+ todo-global-current-todo-file) ".toda")
+ todo-global-current-todo-file)))
(find-file-noselect file)
(with-current-buffer (find-buffer-visiting file)
(save-restriction
(widen)
(goto-char (point-min))
(let ((beg (re-search-forward
- (concat "^" (regexp-quote (concat todos-category-beg cat))
+ (concat "^" (regexp-quote (concat todo-category-beg cat))
"$")
nil t))
(done (save-excursion
(re-search-forward
- (concat "^" (regexp-quote todos-category-done)) nil t)))
+ (concat "^" (regexp-quote todo-category-done)) nil t)))
(end (save-excursion
(or (re-search-forward
- (concat "^" (regexp-quote todos-category-beg))
+ (concat "^" (regexp-quote todo-category-beg))
nil t)
(point-max)))))
(setq found (when (search-forward str end t)
;; Not top item in category.
(while (> (point) (1+ beg))
(let ((opoint (point)))
- (todos-backward-item)
+ (todo-backward-item)
;; Can't move backward beyond
;; first item in file.
(unless (= (point) opoint)
(setq cpriority (1+ cpriority)))))))
(if (and (= tpriority cpriority)
;; Proper substring is not the same.
- (string= (todos-item-string)
+ (string= (todo-item-string)
str))
'same
'changed)))))))))
(list found file cat)))
-(defun todos-check-filtered-items-file ()
+(defun todo-check-filtered-items-file ()
"Check if filtered items file is up to date and a show suitable message."
;; (catch 'old
(let ((count 0))
(while (not (eobp))
- (let* ((item (todos-item-string))
- (found (car (todos-find-item item))))
+ (let* ((item (todo-item-string))
+ (found (car (todo-find-item item))))
(unless (eq (cdr found) 'same)
(save-excursion
- (overlay-put (make-overlay (todos-item-start) (todos-item-end))
- 'face 'todos-search))
+ (overlay-put (make-overlay (todo-item-start) (todo-item-end))
+ 'face 'todo-search))
(setq count (1+ count))))
;; (throw 'old (message "The marked item is not up to date.")))
- (todos-forward-item))
+ (todo-forward-item))
(if (zerop count)
(message "Filtered items file is up to date.")
(message (concat "The highlighted item" (if (= count 1) " is " "s are ")
;; "\nType <return> on item for details."
)))))
-(defun todos-filter-items-filename ()
+(defun todo-filter-items-filename ()
"Return absolute file name for saving this Filtered Items buffer."
(let ((bufname (buffer-name)))
(string-match "\"\\([^\"]+\\)\"" bufname)
(let ((prompt (concat "Enter a short identifying string"
" to make this file name unique: ")))
(setq filename-base (concat filename-base "-" (read-string prompt)))))
- (concat todos-directory filename-base
+ (concat todo-directory filename-base
(cond (top-priorities ".todt")
(diary-items ".tody")
(regexp-items ".todr"))))))
-(defun todos-save-filtered-items-buffer ()
+(defun todo-save-filtered-items-buffer ()
"Save current Filtered Items buffer to a file.
If the file already exists, overwrite it only on confirmation."
- (let ((filename (or (buffer-file-name) (todos-filter-items-filename))))
+ (let ((filename (or (buffer-file-name) (todo-filter-items-filename))))
(write-file filename t)))
;; -----------------------------------------------------------------------------
-;;; Printing Todos buffers
+;;; Printing Todo buffers
;; -----------------------------------------------------------------------------
-(defcustom todos-print-buffer-function 'ps-print-buffer-with-faces
- "Function called by the command `todos-print-buffer'."
+(defcustom todo-print-buffer-function 'ps-print-buffer-with-faces
+ "Function called by the command `todo-print-buffer'."
:type 'symbol
- :group 'todos)
+ :group 'todo)
-(defvar todos-print-buffer "*Todos Print*"
- "Name of buffer containing printable Todos text.")
+(defvar todo-print-buffer "*Todo Print*"
+ "Name of buffer containing printable Todo text.")
-(defun todos-print-buffer (&optional to-file)
- "Produce a printable version of the current Todos buffer.
+(defun todo-print-buffer (&optional to-file)
+ "Produce a printable version of the current Todo buffer.
This converts overlays and soft line wrapping and, depending on
-the value of `todos-print-buffer-function', includes faces. With
+the value of `todo-print-buffer-function', includes faces. With
non-nil argument TO-FILE write the printable version to a file;
otherwise, send it to the default printer."
(interactive)
- (let ((buf todos-print-buffer)
+ (let ((buf todo-print-buffer)
(header (cond
- ((eq major-mode 'todos-mode)
- (concat "Todos File: "
- (todos-short-file-name todos-current-todos-file)
- "\nCategory: " (todos-current-category)))
- ((eq major-mode 'todos-filtered-items-mode)
+ ((eq major-mode 'todo-mode)
+ (concat "Todo File: "
+ (todo-short-file-name todo-current-todo-file)
+ "\nCategory: " (todo-current-category)))
+ ((eq major-mode 'todo-filtered-items-mode)
(buffer-name))))
- (prefix (propertize (concat todos-prefix " ")
- 'face 'todos-prefix-string))
+ (prefix (propertize (concat todo-prefix " ")
+ 'face 'todo-prefix-string))
(num 0)
- (fill-prefix (make-string todos-indent-to-here 32))
+ (fill-prefix (make-string todo-indent-to-here 32))
(content (buffer-string))
file)
(with-current-buffer (get-buffer-create buf)
(goto-char (point-min))
(while (not (eobp))
(let ((beg (point))
- (end (save-excursion (todos-item-end))))
- (when todos-number-prefix
+ (end (save-excursion (todo-item-end))))
+ (when todo-number-prefix
(setq num (1+ num))
(setq prefix (propertize (concat (number-to-string num) " ")
- 'face 'todos-prefix-string)))
+ 'face 'todo-prefix-string)))
(insert prefix)
(fill-region beg end))
- ;; Calling todos-forward-item infloops at todos-item-start due to
+ ;; Calling todo-forward-item infloops at todo-item-start due to
;; non-overlay prefix, so search for item start instead.
- (if (re-search-forward todos-item-start nil t)
+ (if (re-search-forward todo-item-start nil t)
(beginning-of-line)
(goto-char (point-max))))
- (if (re-search-backward (concat "^" (regexp-quote todos-category-done))
+ (if (re-search-backward (concat "^" (regexp-quote todo-category-done))
nil t)
- (replace-match todos-done-separator))
+ (replace-match todo-done-separator))
(goto-char (point-min))
(insert header)
(newline 2)
(if to-file
(let ((file (read-file-name "Print to file: ")))
- (funcall todos-print-buffer-function file))
- (funcall todos-print-buffer-function)))
+ (funcall todo-print-buffer-function file))
+ (funcall todo-print-buffer-function)))
(kill-buffer buf)))
-(defun todos-print-buffer-to-file ()
- "Save printable version of this Todos buffer to a file."
+(defun todo-print-buffer-to-file ()
+ "Save printable version of this Todo buffer to a file."
(interactive)
- (todos-print-buffer t))
+ (todo-print-buffer t))
;; -----------------------------------------------------------------------------
;;; Legacy Todo mode files
;; -----------------------------------------------------------------------------
-(defcustom todos-legacy-date-time-regexp
+(defcustom todo-legacy-date-time-regexp
(concat "\\(?1:[0-9]\\{4\\}\\)-\\(?2:[0-9]\\{2\\}\\)-"
"\\(?3:[0-9]\\{2\\}\\) \\(?4:[0-9]\\{2\\}:[0-9]\\{2\\}\\)")
"Regexp matching legacy todo-mode.el item date-time strings.
-In order for `todos-convert-legacy-files' to correctly convert this
-string to the current Todos format, the regexp must contain four
+In order for `todo-convert-legacy-files' to correctly convert this
+string to the current Todo format, the regexp must contain four
explicitly numbered groups (see `(elisp) Regexp Backslash'),
where group 1 matches a string for the year, group 2 a string for
the month, group 3 a string for the day and group 4 a string for
using the default value of `todo-time-string-format' from
todo-mode.el."
:type 'regexp
- :group 'todos)
+ :group 'todo)
-(defun todos-convert-legacy-date-time ()
+(defun todo-convert-legacy-date-time ()
"Return converted date-time string.
-Helper function for `todos-convert-legacy-files'."
+Helper function for `todo-convert-legacy-files'."
(let* ((year (match-string 1))
(month (match-string 2))
(monthname (calendar-month-name (string-to-number month) t))
(insert (mapconcat 'eval calendar-date-display-form "")
(when time (concat " " time)))))
-(defun todos-convert-legacy-files ()
- "Convert legacy Todo files to the current Todos format.
+(defun todo-convert-legacy-files ()
+ "Convert legacy Todo files to the current Todo format.
The old-style files named by the variables `todo-file-do' and
`todo-file-done' from the old package are converted to the new
-format and saved (the latter as a Todos Archive file) with a new
-name in `todos-directory'. See also the documentation string of
-`todos-legacy-date-time-regexp' for further details."
+format and saved (the latter as a Todo Archive file) with a new
+name in `todo-directory'. See also the documentation string of
+`todo-legacy-date-time-regexp' for further details."
(interactive)
- (if todos-file-buffers
+ (if todo-file-buffers
(message "Before converting you must kill all todo file buffers")
;; Before loading legacy code we have to void symbols whose names
;; are the same in the old and new versions, so use placeholders
;; during conversion and restore them afterwards.
- (let ((todos-categories-tem todos-categories)
- (todos-prefix-tem todos-prefix)
- (todos-category-beg-tem todos-category-beg))
- (fset 'todos-mode-tem 'todos-mode)
- (makunbound 'todos-categories)
- (makunbound 'todos-prefix)
- (makunbound 'todos-category-beg)
- (fmakunbound 'todos-mode)
- (when (eq this-command 'todos-convert-legacy-files)
+ (let ((todo-categories-tem todo-categories)
+ (todo-prefix-tem todo-prefix)
+ (todo-category-beg-tem todo-category-beg))
+ ;; (fset 'todo-mode-tem 'todo-mode)
+ (makunbound 'todo-categories)
+ (makunbound 'todo-prefix)
+ (makunbound 'todo-category-beg)
+ (fmakunbound 'todo-mode)
+ (when (eq this-command 'todo-convert-legacy-files)
;; We can't use require because the feature provided by the
;; old version is the same as the new version's.
(load "todo-mode"))
(while (not (eobp))
(cond
((looking-at (regexp-quote (concat todo-prefix todo-category-beg)))
- (replace-match todos-category-beg-tem))
+ (replace-match todo-category-beg-tem))
((looking-at (regexp-quote todo-category-end))
(replace-match ""))
((looking-at (regexp-quote (concat todo-prefix " "
todo-category-sep)))
- (replace-match todos-category-done))
+ (replace-match todo-category-done))
((looking-at (concat (regexp-quote todo-prefix) " "
- todos-legacy-date-time-regexp " "
+ todo-legacy-date-time-regexp " "
(regexp-quote todo-initials) ":"))
;; FIXME: Should todo-initials be converted? That
;; would require changes to item insertion and editing.
- (todos-convert-legacy-date-time)))
+ (todo-convert-legacy-date-time)))
(forward-line))
- (setq file (concat todos-directory
+ (setq file (concat todo-directory
(read-string
(format "Save file as (default \"%s\"): " default)
nil nil default)
(write-region (point-min) (point-max) file nil 'nomessage nil t))
(with-temp-buffer
(insert-file-contents file)
- (let* ((todos-category-beg todos-category-beg-tem) ; Used by t-m-c-l.
- (todos-categories (todos-make-categories-list t)))
- (todos-update-categories-sexp))
+ (let* ((todo-category-beg todo-category-beg-tem) ; Used by t-m-c-l.
+ (todo-categories (todo-make-categories-list t)))
+ (todo-update-categories-sexp))
(write-region (point-min) (point-max) file nil 'nomessage))
;; Convert `todo-file-done'.
(when (file-exists-p todo-file-done)
(end (make-marker))
cat cats comment item)
(while (not (eobp))
- (when (looking-at todos-legacy-date-time-regexp)
+ (when (looking-at todo-legacy-date-time-regexp)
(set-marker beg (point))
- (todos-convert-legacy-date-time)
+ (todo-convert-legacy-date-time)
(set-marker end (point))
(goto-char beg)
- (insert "[" todos-done-string)
+ (insert "[" todo-done-string)
(goto-char end)
(insert "]")
(forward-char)
- (when (looking-at todos-legacy-date-time-regexp)
- (todos-convert-legacy-date-time))
+ (when (looking-at todo-legacy-date-time-regexp)
+ (todo-convert-legacy-date-time))
(when (looking-at (concat " "
(regexp-quote todo-initials) ":"))
;; FIXME: Should todo-initials be converted?
(replace-match "")))
(if (re-search-forward
- (concat "^" todos-legacy-date-time-regexp) nil t)
+ (concat "^" todo-legacy-date-time-regexp) nil t)
(goto-char (match-beginning 0))
(goto-char (point-max)))
(backward-char)
(when (looking-back "(\\(.*\\)) ")
(setq comment (match-string 1))
(replace-match "")
- (insert "[" todos-comment-string ": " comment "]"))
+ (insert "[" todo-comment-string ": " comment "]"))
(set-marker end (point))
(if (member cat cats)
;; If item is already in its category, leave it there.
(unless (save-excursion
(re-search-backward
- (concat "^" (regexp-quote todos-category-beg-tem)
+ (concat "^" (regexp-quote todo-category-beg-tem)
"\\(.*\\)$") nil t)
(string= (match-string 1) cat))
;; Else move it to its category.
(set-marker beg (point))
(re-search-backward
(concat "^"
- (regexp-quote (concat todos-category-beg-tem cat))
+ (regexp-quote (concat todo-category-beg-tem cat))
"$")
nil t)
(forward-line)
(if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg-tem)
+ (concat "^" (regexp-quote todo-category-beg-tem)
"\\(.*\\)$") nil t)
(progn (goto-char (match-beginning 0))
(newline)
(goto-char beg))
(push cat cats)
(goto-char beg)
- (insert todos-category-beg-tem cat "\n\n"
- todos-category-done "\n"))
+ (insert todo-category-beg-tem cat "\n\n"
+ todo-category-done "\n"))
(forward-line))
(set-marker beg nil)
(set-marker end nil))
(write-region (point-min) (point-max) file nil 'nomessage nil t))
(with-temp-buffer
(insert-file-contents file)
- (let* ((todos-category-beg todos-category-beg-tem) ; Used by t-m-c-l.
- (todos-categories (todos-make-categories-list t)))
- (todos-update-categories-sexp))
+ (let* ((todo-category-beg todo-category-beg-tem) ; Used by t-m-c-l.
+ (todo-categories (todo-make-categories-list t)))
+ (todo-update-categories-sexp))
(write-region (point-min) (point-max) file nil 'nomessage)
(setq archive-sexp (read (buffer-substring-no-properties
(line-beginning-position)
(line-end-position)))))
(setq file (concat (file-name-sans-extension file) ".todo"))
- ;; Update categories sexp of converted Todos file again, adding
+ ;; Update categories sexp of converted Todo file again, adding
;; counts of archived items.
(with-temp-buffer
(insert-file-contents file)
(delete-region (line-beginning-position) (line-end-position))
(prin1 sexp (current-buffer)))
(write-region (point-min) (point-max) file nil 'nomessage)))
- (todos-reevaluate-filelist-defcustoms)
+ (todo-reevaluate-filelist-defcustoms)
(message "Format conversion done."))
(message "No legacy Todo file exists"))
- ;; (setq todos-categories todos-categories-tem
- ;; todos-prefix todos-prefix-tem
- ;; todos-category-beg todos-category-beg-tem)
- ;; (fset 'todos-mode 'todos-mode-tem)
- ;; (makunbound 'todos-categories-tem)
- ;; (makunbound 'todos-prefix-tem)
- ;; (makunbound 'todos-category-beg-tem)
- ;; (fmakunbound 'todos-mode-tem)
- (unload-feature 'todos)
- (require 'todos))))
+ ;; (setq todo-categories todo-categories-tem
+ ;; todo-prefix todo-prefix-tem
+ ;; todo-category-beg todo-category-beg-tem)
+ ;; (fset 'todo-mode 'todo-mode-tem)
+ ;; (makunbound 'todo-categories-tem)
+ ;; (makunbound 'todo-prefix-tem)
+ ;; (makunbound 'todo-category-beg-tem)
+ ;; (fmakunbound 'todo-mode-tem)
+ (unload-feature 'todo)
+ (require 'todo))))
;; -----------------------------------------------------------------------------
-;;; Utility functions for Todos files, categories and items
+;;; Utility functions for Todo files, categories and items
;; -----------------------------------------------------------------------------
-(defun todos-absolute-file-name (name &optional type)
- "Return the absolute file name of short Todos file NAME.
+(defun todo-absolute-file-name (name &optional type)
+ "Return the absolute file name of short Todo file NAME.
With TYPE `archive' or `top' return the absolute file name of the
-short Todos Archive or Top Priorities file name, respectively."
- ;; NOP if there is no Todos file yet (i.e. don't concatenate nil).
+short Todo Archive or Top Priorities file name, respectively."
+ ;; NOP if there is no Todo file yet (i.e. don't concatenate nil).
(when name
(file-truename
- (concat todos-directory name
+ (concat todo-directory name
(cond ((eq type 'archive) ".toda")
((eq type 'top) ".todt")
((eq type 'diary) ".tody")
((eq type 'regexp) ".todr")
(t ".todo"))))))
-(defun todos-category-number (cat)
- "Return the number of category CAT in this Todos file.
-The buffer-local variable `todos-category-number' holds this
+(defun todo-category-number (cat)
+ "Return the number of category CAT in this Todo file.
+The buffer-local variable `todo-category-number' holds this
number as its value."
- (let ((categories (mapcar 'car todos-categories)))
- (setq todos-category-number
- ;; Increment by one, so that the highest priority category in Todos
+ (let ((categories (mapcar 'car todo-categories)))
+ (setq todo-category-number
+ ;; Increment by one, so that the highest priority category in Todo
;; Categories mode is numbered one rather than zero.
(1+ (- (length categories)
(length (member cat categories)))))))
-(defun todos-current-category ()
+(defun todo-current-category ()
"Return the name of the current category."
- (car (nth (1- todos-category-number) todos-categories)))
+ (car (nth (1- todo-category-number) todo-categories)))
-(defun todos-category-select ()
+(defun todo-category-select ()
"Display the current category correctly."
- (let ((name (todos-current-category))
+ (let ((name (todo-current-category))
cat-begin cat-end done-start done-sep-start done-end)
(widen)
(goto-char (point-min))
(re-search-forward
- (concat "^" (regexp-quote (concat todos-category-beg name)) "$") nil t)
+ (concat "^" (regexp-quote (concat todo-category-beg name)) "$") nil t)
(setq cat-begin (1+ (line-end-position)))
(setq cat-end (if (re-search-forward
- (concat "^" (regexp-quote todos-category-beg)) nil t)
+ (concat "^" (regexp-quote todo-category-beg)) nil t)
(match-beginning 0)
(point-max)))
(setq mode-line-buffer-identification
- (funcall todos-mode-line-function name))
+ (funcall todo-mode-line-function name))
(narrow-to-region cat-begin cat-end)
- (todos-prefix-overlays)
+ (todo-prefix-overlays)
(goto-char (point-min))
- (if (re-search-forward (concat "\n\\(" (regexp-quote todos-category-done)
+ (if (re-search-forward (concat "\n\\(" (regexp-quote todo-category-done)
"\\)") nil t)
(progn
(setq done-start (match-beginning 0))
(setq done-sep-start (match-beginning 1))
(setq done-end (match-end 0)))
- (error "Category %s is missing todos-category-done string" name))
- (if todos-show-done-only
+ (error "Category %s is missing todo-category-done string" name))
+ (if todo-show-done-only
(narrow-to-region (1+ done-end) (point-max))
- (when (and todos-show-with-done
- (re-search-forward todos-done-string-start nil t))
+ (when (and todo-show-with-done
+ (re-search-forward todo-done-string-start nil t))
;; Now we want to see the done items, so reset displayed end to end of
;; done items.
(setq done-start cat-end)
;; Make display overlay for done items separator string, unless there
;; already is one.
- (let* ((done-sep todos-done-separator)
+ (let* ((done-sep todo-done-separator)
(ov (progn (goto-char done-sep-start)
- (todos-get-overlay 'separator))))
+ (todo-get-overlay 'separator))))
(unless ov
(setq ov (make-overlay done-sep-start done-end))
- (overlay-put ov 'todos 'separator)
+ (overlay-put ov 'todo 'separator)
(overlay-put ov 'display done-sep))))
(narrow-to-region (point-min) done-start)
- ;; Loading this from todos-mode, or adding it to the mode hook, causes
- ;; Emacs to hang in todos-item-start, at (looking-at todos-item-start).
- (when todos-highlight-item
+ ;; Loading this from todo-mode, or adding it to the mode hook, causes
+ ;; Emacs to hang in todo-item-start, at (looking-at todo-item-start).
+ (when todo-highlight-item
(require 'hl-line)
(hl-line-mode 1)))))
-(defun todos-get-count (type &optional category)
+(defun todo-get-count (type &optional category)
"Return count of TYPE items in CATEGORY.
If CATEGORY is nil, default to the current category."
- (let* ((cat (or category (todos-current-category)))
- (counts (cdr (assoc cat todos-categories)))
+ (let* ((cat (or category (todo-current-category)))
+ (counts (cdr (assoc cat todo-categories)))
(idx (cond ((eq type 'todo) 0)
((eq type 'diary) 1)
((eq type 'done) 2)
((eq type 'archived) 3))))
(aref counts idx)))
-(defun todos-update-count (type increment &optional category)
+(defun todo-update-count (type increment &optional category)
"Change count of TYPE items in CATEGORY by integer INCREMENT.
With nil or omitted CATEGORY, default to the current category."
- (let* ((cat (or category (todos-current-category)))
- (counts (cdr (assoc cat todos-categories)))
+ (let* ((cat (or category (todo-current-category)))
+ (counts (cdr (assoc cat todo-categories)))
(idx (cond ((eq type 'todo) 0)
((eq type 'diary) 1)
((eq type 'done) 2)
((eq type 'archived) 3))))
(aset counts idx (+ increment (aref counts idx)))))
-(defun todos-set-categories ()
- "Set `todos-categories' from the sexp at the top of the file."
- ;; New archive files created by `todos-move-category' are empty, which would
+(defun todo-set-categories ()
+ "Set `todo-categories' from the sexp at the top of the file."
+ ;; New archive files created by `todo-move-category' are empty, which would
;; make the sexp test fail and raise an error, so in this case we skip it.
(unless (zerop (buffer-size))
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
- (setq todos-categories
+ (setq todo-categories
(if (looking-at "\(\(\"")
(read (buffer-substring-no-properties
(line-beginning-position)
(line-end-position)))
- (error "Invalid or missing todos-categories sexp")))))))
+ (error "Invalid or missing todo-categories sexp")))))))
-(defun todos-update-categories-sexp ()
- "Update the `todos-categories' sexp at the top of the file."
+(defun todo-update-categories-sexp ()
+ "Update the `todo-categories' sexp at the top of the file."
(let (buffer-read-only)
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
- (if (looking-at (concat "^" (regexp-quote todos-category-beg)))
+ (if (looking-at (concat "^" (regexp-quote todo-category-beg)))
(progn (newline) (goto-char (point-min)) ; Make space for sexp.
- (setq todos-categories (todos-make-categories-list t)))
+ (setq todo-categories (todo-make-categories-list t)))
(delete-region (line-beginning-position) (line-end-position)))
- (prin1 todos-categories (current-buffer))))))
+ (prin1 todo-categories (current-buffer))))))
-(defun todos-make-categories-list (&optional force)
- "Return an alist of Todos categories and their item counts.
+(defun todo-make-categories-list (&optional force)
+ "Return an alist of Todo categories and their item counts.
With non-nil argument FORCE parse the entire file to build the
list; otherwise, get the value by reading the sexp at the top of
the file."
- (setq todos-categories nil)
+ (setq todo-categories nil)
(save-excursion
(save-restriction
(widen)
(let (counts cat archive)
;; If the file is a todo file and has archived items, identify the
;; archive, in order to count its items. But skip this with
- ;; `todos-convert-legacy-files', since that converts filed items to
+ ;; `todo-convert-legacy-files', since that converts filed items to
;; archived items.
(when buffer-file-name ; During conversion there is no file yet.
;; If the file is an archive, it doesn't have an archive.
(unless (member (file-truename buffer-file-name)
- (funcall todos-files-function t))
+ (funcall todo-files-function t))
(setq archive (concat (file-name-sans-extension
- todos-current-todos-file) ".toda"))))
+ todo-current-todo-file) ".toda"))))
(while (not (eobp))
- (cond ((looking-at (concat (regexp-quote todos-category-beg)
+ (cond ((looking-at (concat (regexp-quote todo-category-beg)
"\\(.*\\)\n"))
(setq cat (match-string-no-properties 1))
;; Counts for each category: [todo diary done archive]
(setq counts (make-vector 4 0))
- (setq todos-categories
- (append todos-categories (list (cons cat counts))))
+ (setq todo-categories
+ (append todo-categories (list (cons cat counts))))
;; Add archived item count to the todo file item counts.
;; Make sure to include newly created archives, e.g. due to
- ;; todos-move-category.
- (when (member archive (funcall todos-files-function t))
+ ;; todo-move-category.
+ (when (member archive (funcall todo-files-function t))
(let ((archive-count 0))
(with-current-buffer (find-file-noselect archive)
(widen)
(goto-char (point-min))
(when (re-search-forward
- (concat "^" (regexp-quote todos-category-beg)
+ (concat "^" (regexp-quote todo-category-beg)
cat "$")
(point-max) t)
(forward-line)
(while (not (or (looking-at
(concat
- (regexp-quote todos-category-beg)
+ (regexp-quote todo-category-beg)
"\\(.*\\)\n"))
(eobp)))
- (when (looking-at todos-done-string-start)
+ (when (looking-at todo-done-string-start)
(setq archive-count (1+ archive-count)))
(forward-line))))
- (todos-update-count 'archived archive-count cat))))
- ((looking-at todos-done-string-start)
- (todos-update-count 'done 1 cat))
+ (todo-update-count 'archived archive-count cat))))
+ ((looking-at todo-done-string-start)
+ (todo-update-count 'done 1 cat))
((looking-at (concat "^\\("
(regexp-quote diary-nonmarking-symbol)
- "\\)?" todos-date-pattern))
- (todos-update-count 'diary 1 cat)
- (todos-update-count 'todo 1 cat))
- ((looking-at (concat todos-date-string-start todos-date-pattern))
- (todos-update-count 'todo 1 cat))
- ;; If first line is todos-categories list, use it and end loop
+ "\\)?" todo-date-pattern))
+ (todo-update-count 'diary 1 cat)
+ (todo-update-count 'todo 1 cat))
+ ((looking-at (concat todo-date-string-start todo-date-pattern))
+ (todo-update-count 'todo 1 cat))
+ ;; If first line is todo-categories list, use it and end loop
;; -- unless FORCEd to scan whole file.
((bobp)
(unless force
- (setq todos-categories (read (buffer-substring-no-properties
+ (setq todo-categories (read (buffer-substring-no-properties
(line-beginning-position)
(line-end-position))))
(goto-char (1- (point-max))))))
(forward-line)))))
- todos-categories)
+ todo-categories)
-(defun todos-repair-categories-sexp ()
- "Repair corrupt Todos categories sexp.
+(defun todo-repair-categories-sexp ()
+ "Repair corrupt Todo categories sexp.
This should only be needed as a consequence of careless manual
-editing or a bug in todos.el.
+editing or a bug in todo.el.
*Warning*: Calling this command restores the category order to
-the list element order in the Todos categories sexp, so any order
-changes made in Todos Categories mode will have to be made again."
+the list element order in the Todo categories sexp, so any order
+changes made in Todo Categories mode will have to be made again."
(interactive)
- (let ((todos-categories (todos-make-categories-list t)))
- (todos-update-categories-sexp)))
+ (let ((todo-categories (todo-make-categories-list t)))
+ (todo-update-categories-sexp)))
-(defun todos-check-format ()
- "Signal an error if the current Todos file is ill-formatted.
+(defun todo-check-format ()
+ "Signal an error if the current Todo file is ill-formatted.
Otherwise return t. Display a message if the file is well-formed
but the categories sexp differs from the current value of
-`todos-categories'."
+`todo-categories'."
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
- (let* ((cats (prin1-to-string todos-categories))
+ (let* ((cats (prin1-to-string todo-categories))
(ssexp (buffer-substring-no-properties (line-beginning-position)
(line-end-position)))
(sexp (read ssexp)))
- ;; Check the first line for `todos-categories' sexp.
+ ;; Check the first line for `todo-categories' sexp.
(dolist (c sexp)
(let ((v (cdr c)))
(unless (and (stringp (car c))
(vectorp v)
(= 4 (length v)))
- (user-error "Invalid or missing todos-categories sexp"))))
+ (user-error "Invalid or missing todo-categories sexp"))))
(forward-line)
;; Check well-formedness of categories.
(let ((legit (concat
- "\\(^" (regexp-quote todos-category-beg) "\\)"
- "\\|\\(" todos-date-string-start todos-date-pattern "\\)"
+ "\\(^" (regexp-quote todo-category-beg) "\\)"
+ "\\|\\(" todo-date-string-start todo-date-pattern "\\)"
"\\|\\(^[ \t]+[^ \t]*\\)"
"\\|^$"
- "\\|\\(^" (regexp-quote todos-category-done) "\\)"
- "\\|\\(" todos-done-string-start "\\)")))
+ "\\|\\(^" (regexp-quote todo-category-done) "\\)"
+ "\\|\\(" todo-done-string-start "\\)")))
(while (not (eobp))
(unless (looking-at legit)
- (user-error "Illegitimate Todos file format at line %d"
+ (user-error "Illegitimate Todo file format at line %d"
(line-number-at-pos (point))))
(forward-line)))
;; Warn user if categories sexp has changed.
(unless (string= ssexp cats)
(message (concat "The sexp at the beginning of the file differs "
- "from the value of `todos-categories.\n"
+ "from the value of `todo-categories.\n"
"If the sexp is wrong, you can fix it with "
- "M-x todos-repair-categories-sexp,\n"
+ "M-x todo-repair-categories-sexp,\n"
"but note this reverts any changes you have "
"made in the order of the categories."))))))
t)
-(defun todos-item-start ()
- "Move to start of current Todos item and return its position."
+(defun todo-item-start ()
+ "Move to start of current Todo item and return its position."
(unless (or
- ;; Buffer is empty (invocation possible e.g. via todos-forward-item
- ;; from todos-filter-items when processing category with no todo
+ ;; Buffer is empty (invocation possible e.g. via todo-forward-item
+ ;; from todo-filter-items when processing category with no todo
;; items).
(eq (point-min) (point-max))
;; Point is on the empty line below category's last todo item...
(save-excursion ; ...or done items are visible.
(forward-line)
(looking-at (concat "^"
- (regexp-quote todos-category-done))))))
+ (regexp-quote todo-category-done))))))
;; Buffer is widened.
- (looking-at (regexp-quote todos-category-beg)))
+ (looking-at (regexp-quote todo-category-beg)))
(goto-char (line-beginning-position))
- (while (not (looking-at todos-item-start))
+ (while (not (looking-at todo-item-start))
(forward-line -1))
(point)))
-(defun todos-item-end ()
- "Move to end of current Todos item and return its position."
+(defun todo-item-end ()
+ "Move to end of current Todo item and return its position."
;; Items cannot end with a blank line.
(unless (looking-at "^$")
- (let* ((done (todos-done-item-p))
+ (let* ((done (todo-done-item-p))
(to-lim nil)
;; For todo items, end is before the done items section, for done
;; items, end is before the next category. If these limits are
(lim (if (save-excursion
(re-search-forward
(concat "^" (regexp-quote (if done
- todos-category-beg
- todos-category-done)))
+ todo-category-beg
+ todo-category-done)))
nil t))
(progn (setq to-lim t) (match-beginning 0))
(point-max))))
(when (bolp) (forward-char)) ; Find start of next item.
- (goto-char (if (re-search-forward todos-item-start lim t)
+ (goto-char (if (re-search-forward todo-item-start lim t)
(match-beginning 0)
(if to-lim lim (point-max))))
;; For last todo item, skip back over the empty line before the done
(backward-char (when (and to-lim (not done) (eq (point) lim)) 2))
(point))))
-(defun todos-item-string ()
+(defun todo-item-string ()
"Return bare text of current item as a string."
(let ((opoint (point))
- (start (todos-item-start))
- (end (todos-item-end)))
+ (start (todo-item-start))
+ (end (todo-item-end)))
(goto-char opoint)
(and start end (buffer-substring-no-properties start end))))
-(defun todos-forward-item (&optional count)
+(defun todo-forward-item (&optional count)
"Move point COUNT items down (by default, move down by one item)."
- (let* ((not-done (not (or (todos-done-item-p) (looking-at "^$"))))
+ (let* ((not-done (not (or (todo-done-item-p) (looking-at "^$"))))
(start (line-end-position)))
(goto-char start)
- (if (re-search-forward todos-item-start nil t (or count 1))
+ (if (re-search-forward todo-item-start nil t (or count 1))
(goto-char (match-beginning 0))
(goto-char (point-max)))
;; If points advances by one from a todo to a done item, go back
- ;; to the space above todos-done-separator, since that is a
+ ;; to the space above todo-done-separator, since that is a
;; legitimate place to insert an item. But skip this space if
;; count > 1, since that should only stop on an item.
- (when (and not-done (todos-done-item-p) (not count))
+ (when (and not-done (todo-done-item-p) (not count))
;; (if (or (not count) (= count 1))
(re-search-backward "^$" start t))));)
;; The preceding sexp is insufficient when buffer is not narrowed,
;; (let ((opoint) (point))
;; (forward-line -1)
;; (when (or (not count) (= count 1))
- ;; (cond ((looking-at (concat "^" (regexp-quote todos-category-beg)))
+ ;; (cond ((looking-at (concat "^" (regexp-quote todo-category-beg)))
;; (forward-line -2))
- ;; ((looking-at (concat "^" (regexp-quote todos-category-done)))
+ ;; ((looking-at (concat "^" (regexp-quote todo-category-done)))
;; (forward-line -1))
;; (t
;; (goto-char opoint)))))))
-(defun todos-backward-item (&optional count)
+(defun todo-backward-item (&optional count)
"Move point up to start of item with next higher priority.
With positive numerical prefix COUNT, move point COUNT items
upward.
moves to the last todo item; but if called with point on the
first done item without a prefix argument, it moves point the the
empty line above the done items separator."
- (let* ((done (todos-done-item-p)))
- (todos-item-start)
+ (let* ((done (todo-done-item-p)))
+ (todo-item-start)
(unless (bobp)
- (re-search-backward todos-item-start nil t (or count 1)))
+ (re-search-backward todo-item-start nil t (or count 1)))
;; Unless this is a regexp filtered items buffer (which can contain
;; intermixed todo and done items), if points advances by one from a
;; done to a todo item, go back to the space above
- ;; todos-done-separator, since that is a legitimate place to insert an
+ ;; todo-done-separator, since that is a legitimate place to insert an
;; item. But skip this space if count > 1, since that should only
;; stop on an item.
- (when (and done (not (todos-done-item-p)) (not count)
+ (when (and done (not (todo-done-item-p)) (not count)
;(or (not count) (= count 1))
- (not (equal (buffer-name) todos-regexp-items-buffer)))
- (re-search-forward (concat "^" (regexp-quote todos-category-done))
+ (not (equal (buffer-name) todo-regexp-items-buffer)))
+ (re-search-forward (concat "^" (regexp-quote todo-category-done))
nil t)
(forward-line -1))))
-(defun todos-remove-item ()
+(defun todo-remove-item ()
"Internal function called in editing, deleting or moving items."
- (let* ((end (progn (todos-item-end) (1+ (point))))
- (beg (todos-item-start))
- (ov (todos-get-overlay 'prefix)))
+ (let* ((end (progn (todo-item-end) (1+ (point))))
+ (beg (todo-item-start))
+ (ov (todo-get-overlay 'prefix)))
(when ov (delete-overlay ov))
(delete-region beg end)))
-(defun todos-diary-item-p ()
+(defun todo-diary-item-p ()
"Return non-nil if item at point has diary entry format."
(save-excursion
- (when (todos-item-string) ; Exclude empty lines.
- (todos-item-start)
- (not (looking-at (regexp-quote todos-nondiary-start))))))
+ (when (todo-item-string) ; Exclude empty lines.
+ (todo-item-start)
+ (not (looking-at (regexp-quote todo-nondiary-start))))))
;; This duplicates the item locating code from diary-goto-entry, but
;; without the marker code, to test whether the latter is dispensible.
;; here can also be eliminated, leaving only the widening and category
;; selection, and instead of :override advice :around can be used.
-(defun todos-diary-goto-entry (button)
+(defun todo-diary-goto-entry (button)
"Jump to the diary entry for the BUTTON at point.
If the entry is a todo item, display its category properly.
Overrides `diary-goto-entry'."
(if (not (and (file-exists-p file)
(find-file-other-window file)))
(message "Unable to locate this diary entry")
- (when (eq major-mode 'todos-mode) (widen))
+ (when (eq major-mode 'todo-mode) (widen))
(goto-char (point-min))
(when (re-search-forward (format "%s.*\\(%s\\)" date content) nil t)
(goto-char (match-beginning 1)))
;; If it's a todo item, determine its category and display the
;; category properly.
- (when (eq major-mode 'todos-mode)
+ (when (eq major-mode 'todo-mode)
(let ((opoint (point)))
- (re-search-backward (concat "^" (regexp-quote todos-category-beg)
+ (re-search-backward (concat "^" (regexp-quote todo-category-beg)
"\\(.*\\)\n") nil t)
- (todos-category-number (match-string 1))
- (todos-category-select)
+ (todo-category-number (match-string 1))
+ (todo-category-select)
(goto-char opoint))))))
-(add-function :override diary-goto-entry-function #'todos-diary-goto-entry)
+(add-function :override diary-goto-entry-function #'todo-diary-goto-entry)
-(defun todos-done-item-p ()
+(defun todo-done-item-p ()
"Return non-nil if item at point is a done item."
(save-excursion
- (todos-item-start)
- (looking-at todos-done-string-start)))
+ (todo-item-start)
+ (looking-at todo-done-string-start)))
-(defun todos-done-item-section-p ()
+(defun todo-done-item-section-p ()
"Return non-nil if point is in category's done items section."
(save-excursion
- (or (re-search-backward (concat "^" (regexp-quote todos-category-done))
+ (or (re-search-backward (concat "^" (regexp-quote todo-category-done))
nil t)
(progn (goto-char (point-min))
- (looking-at todos-done-string-start)))))
+ (looking-at todo-done-string-start)))))
-(defun todos-reset-done-separator (sep)
+(defun todo-reset-done-separator (sep)
"Replace existing overlays of done items separator string SEP."
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(while (re-search-forward
- (concat "\n\\(" (regexp-quote todos-category-done) "\\)") nil t)
+ (concat "\n\\(" (regexp-quote todo-category-done) "\\)") nil t)
(let* ((beg (match-beginning 1))
(end (match-end 0))
(ov (progn (goto-char beg)
- (todos-get-overlay 'separator)))
+ (todo-get-overlay 'separator)))
(old-sep (when ov (overlay-get ov 'display)))
new-ov)
(when old-sep
(unless (string= old-sep sep)
(setq new-ov (make-overlay beg end))
- (overlay-put new-ov 'todos 'separator)
- (overlay-put new-ov 'display todos-done-separator)
+ (overlay-put new-ov 'todo 'separator)
+ (overlay-put new-ov 'display todo-done-separator)
(delete-overlay ov))))))))
-(defun todos-get-overlay (val)
- "Return the overlay at point whose `todos' property has value VAL."
+(defun todo-get-overlay (val)
+ "Return the overlay at point whose `todo' property has value VAL."
;; Use overlays-in to find prefix overlays and check over two
;; positions to find done separator overlay.
(let ((ovs (overlays-in (point) (1+ (point))))
(catch 'done
(while ovs
(setq ov (pop ovs))
- (when (eq (overlay-get ov 'todos) val)
+ (when (eq (overlay-get ov 'todo) val)
(throw 'done ov))))))
-(defun todos-marked-item-p ()
- "Non-nil if this item begins with `todos-item-mark'.
+(defun todo-marked-item-p ()
+ "Non-nil if this item begins with `todo-item-mark'.
In that case, return the item's prefix overlay."
- (let* ((ov (todos-get-overlay 'prefix))
- ;; If an item insertion command is called on a Todos file
+ (let* ((ov (todo-get-overlay 'prefix))
+ ;; If an item insertion command is called on a Todo file
;; before it is visited, it has no prefix overlays yet, so
;; check for this.
(pref (when ov (overlay-get ov 'before-string)))
(marked (when pref
- (string-match (concat "^" (regexp-quote todos-item-mark))
+ (string-match (concat "^" (regexp-quote todo-item-mark))
pref))))
(when marked ov)))
-(defun todos-insert-with-overlays (item)
+(defun todo-insert-with-overlays (item)
"Insert ITEM at point and update prefix/priority number overlays."
- (todos-item-start)
+ (todo-item-start)
;; Insertion pushes item down but not its prefix overlay. When the
;; overlay includes a mark, this would now mark the inserted ITEM,
;; so move it to the pushed down item.
- (let ((ov (todos-get-overlay 'prefix))
- (marked (todos-marked-item-p)))
+ (let ((ov (todo-get-overlay 'prefix))
+ (marked (todo-marked-item-p)))
(insert item "\n")
(when marked (move-overlay ov (point) (point))))
- (todos-backward-item)
- (todos-prefix-overlays))
+ (todo-backward-item)
+ (todo-prefix-overlays))
-(defun todos-prefix-overlays ()
+(defun todo-prefix-overlays ()
"Update the prefix overlays of the current category's items.
-The overlay's value is the string `todos-prefix' or with non-nil
-`todos-number-prefix' an integer in the sequence from 1 to
+The overlay's value is the string `todo-prefix' or with non-nil
+`todo-number-prefix' an integer in the sequence from 1 to
the number of todo or done items in the category indicating the
item's priority. Todo and done items are numbered independently
of each other."
(let ((num 0)
(cat-tp (or (cdr (assoc-string
- (todos-current-category)
- (nth 2 (assoc-string todos-current-todos-file
- todos-top-priorities-overrides))))
- todos-top-priorities))
+ (todo-current-category)
+ (nth 2 (assoc-string todo-current-todo-file
+ todo-top-priorities-overrides))))
+ todo-top-priorities))
done prefix)
(save-excursion
(goto-char (point-min))
(while (not (eobp))
- (when (or (todos-date-string-matcher (line-end-position))
- (todos-done-string-matcher (line-end-position)))
+ (when (or (todo-date-string-matcher (line-end-position))
+ (todo-done-string-matcher (line-end-position)))
(goto-char (match-beginning 0))
(setq num (1+ num))
;; Reset number to 1 for first done item.
- (when (and (eq major-mode 'todos-mode)
- (looking-at todos-done-string-start)
+ (when (and (eq major-mode 'todo-mode)
+ (looking-at todo-done-string-start)
(looking-back (concat "^"
- (regexp-quote todos-category-done)
+ (regexp-quote todo-category-done)
"\n")))
(setq num 1
done t))
(setq prefix (concat (propertize
- (if todos-number-prefix
+ (if todo-number-prefix
(number-to-string num)
- todos-prefix)
+ todo-prefix)
'face
;; Prefix of top priority items has a
- ;; distinct face in Todos mode.
- (if (and (eq major-mode 'todos-mode)
+ ;; distinct face in Todo mode.
+ (if (and (eq major-mode 'todo-mode)
(not done)
(<= num cat-tp))
- 'todos-top-priority
- 'todos-prefix-string))
+ 'todo-top-priority
+ 'todo-prefix-string))
" "))
- (let ((ov (todos-get-overlay 'prefix))
- (marked (todos-marked-item-p)))
+ (let ((ov (todo-get-overlay 'prefix))
+ (marked (todo-marked-item-p)))
;; Prefix overlay must be at a single position so its
;; bounds aren't changed when (re)moving an item.
(unless ov (setq ov (make-overlay (point) (point))))
- (overlay-put ov 'todos 'prefix)
+ (overlay-put ov 'todo 'prefix)
(overlay-put ov 'before-string (if marked
- (concat todos-item-mark prefix)
+ (concat todo-item-mark prefix)
prefix))))
(forward-line)))))
;; (http://lists.gnu.org/archive/html/emacs-devel/2013-06/msg00423.html)
;; and kindly gave me permission to use it.
-(defun todos-powerset (list)
+(defun todo-powerset (list)
"Return the powerset of LIST."
(let ((powerset (list nil)))
(dolist (elt list (mapcar 'reverse powerset))
(nconc powerset (mapcar (apply-partially 'cons elt) powerset)))))
-(defun todos-gen-arglists (arglist)
+(defun todo-gen-arglists (arglist)
"Return list of lists of non-nil atoms produced from ARGLIST.
The elements of ARGLIST may be atoms or lists."
(let (arglists)
arg))))))
(setq arglists (mapcar 'reverse (apply 'append (mapc 'car arglists))))))
-(defvar todos-insertion-commands-args-genlist
+(defvar todo-insertion-commands-args-genlist
'(diary nonmarking (calendar date dayname) time (here region))
"Generator list for argument lists of item insertion commands.")
-(defvar todos-insertion-commands-args
- (let ((argslist (todos-gen-arglists todos-insertion-commands-args-genlist))
+(defvar todo-insertion-commands-args
+ (let ((argslist (todo-gen-arglists todo-insertion-commands-args-genlist))
res new)
(setq res (cl-remove-duplicates
- (apply 'append (mapcar 'todos-powerset argslist)) :test 'equal))
+ (apply 'append (mapcar 'todo-powerset argslist)) :test 'equal))
(dolist (l res)
(unless (= 5 (length l))
(let ((v (make-vector 5 nil)) elt)
(setq l (append v nil))))
(setq new (append new (list l))))
new)
- "List of all argument lists for Todos item insertion commands.")
+ "List of all argument lists for Todo item insertion commands.")
-(defun todos-insertion-command-name (arglist)
- "Generate Todos item insertion command name from ARGLIST."
+(defun todo-insertion-command-name (arglist)
+ "Generate Todo item insertion command name from ARGLIST."
(replace-regexp-in-string
"-\\_>" ""
(replace-regexp-in-string
"-+" "-"
- ;; (concat "todos-item-insert-"
- (concat "todos-insert-item-"
+ ;; (concat "todo-item-insert-"
+ (concat "todo-insert-item-"
(mapconcat (lambda (e) (if e (symbol-name e))) arglist "-")))))
-(defvar todos-insertion-commands-names
+(defvar todo-insertion-commands-names
(mapcar (lambda (l)
- (todos-insertion-command-name l))
- todos-insertion-commands-args)
- "List of names of Todos item insertion commands.")
+ (todo-insertion-command-name l))
+ todo-insertion-commands-args)
+ "List of names of Todo item insertion commands.")
-(defmacro todos-define-insertion-command (&rest args)
+(defmacro todo-define-insertion-command (&rest args)
"Generate item insertion command definitions from ARGS."
- (let ((name (intern (todos-insertion-command-name args)))
+ (let ((name (intern (todo-insertion-command-name args)))
(arg0 (nth 0 args))
(arg1 (nth 1 args))
(arg2 (nth 2 args))
(arg3 (nth 3 args))
(arg4 (nth 4 args)))
`(defun ,name (&optional arg &rest args)
- "Todos item insertion command generated from ARGS.
+ "Todo item insertion command generated from ARGS.
For descriptions of the individual arguments, their values, and
-their relation to key bindings, see `todos-basic-insert-item'."
+their relation to key bindings, see `todo-basic-insert-item'."
(interactive (list current-prefix-arg))
- (todos-basic-insert-item arg ',arg0 ',arg1 ',arg2 ',arg3 ',arg4))))
+ (todo-basic-insert-item arg ',arg0 ',arg1 ',arg2 ',arg3 ',arg4))))
-(defvar todos-insertion-commands
+(defvar todo-insertion-commands
(mapcar (lambda (c)
- (eval `(todos-define-insertion-command ,@c)))
- todos-insertion-commands-args)
- "List of Todos item insertion commands.")
+ (eval `(todo-define-insertion-command ,@c)))
+ todo-insertion-commands-args)
+ "List of Todo item insertion commands.")
-(defvar todos-insertion-commands-arg-key-list
+(defvar todo-insertion-commands-arg-key-list
'(("diary" "y" "yy")
("nonmarking" "k" "kk")
("calendar" "c" "cc")
("region" "r" "r"))
"List of mappings of insertion command arguments to key sequences.")
-(defun todos-insertion-key-bindings (map)
+(defun todo-insertion-key-bindings (map)
"Generate key binding definitions for item insertion keymap MAP."
- (dolist (c todos-insertion-commands)
+ (dolist (c todo-insertion-commands)
(let* ((key "")
(cname (symbol-name c)))
(mapc (lambda (l)
(setq key (concat key key2)))
(if (string-match (concat (regexp-quote arg) ".+") cname)
(setq key (concat key key1)))))
- todos-insertion-commands-arg-key-list)
- (if (string-match (concat (regexp-quote "todos-insert-item") "\\_>") cname)
+ todo-insertion-commands-arg-key-list)
+ (if (string-match (concat (regexp-quote "todo-insert-item") "\\_>") cname)
(setq key (concat key "i")))
(define-key map key c))))
;; -----------------------------------------------------------------------------
-;;; Todos minibuffer utilities
+;;; Todo minibuffer utilities
;; -----------------------------------------------------------------------------
-(defcustom todos-y-with-space nil
+(defcustom todo-y-with-space nil
"Non-nil means allow SPC to affirm a \"y or n\" question."
:type 'boolean
- :group 'todos)
+ :group 'todo)
-(defun todos-y-or-n-p (prompt)
+(defun todo-y-or-n-p (prompt)
"Ask \"y or n\" question PROMPT and return t if answer is \"y\".
Also return t if answer is \"Y\", but unlike `y-or-n-p', allow
-SPC to affirm the question only if option `todos-y-with-space' is
+SPC to affirm the question only if option `todo-y-with-space' is
non-nil."
- (unless todos-y-with-space
+ (unless todo-y-with-space
(define-key query-replace-map " " 'ignore))
(prog1
(y-or-n-p prompt)
(define-key query-replace-map " " 'act)))
-(defun todos-category-completions (&optional archive)
- "Return a list of completions for `todos-read-category'.
+(defun todo-category-completions (&optional archive)
+ "Return a list of completions for `todo-read-category'.
Each element of the list is a cons of a category name and the
file or list of files (as short file names) it is in. The files
are either the current (or if there is none, the default) todo
-file plus the files listed in `todos-category-completions-files',
+file plus the files listed in `todo-category-completions-files',
or, with non-nil ARCHIVE, the current archive file."
- (let* ((curfile (or todos-current-todos-file
- (and todos-show-current-file
- todos-global-current-todos-file)
- (todos-absolute-file-name todos-default-todos-file)))
+ (let* ((curfile (or todo-current-todo-file
+ (and todo-show-current-file
+ todo-global-current-todo-file)
+ (todo-absolute-file-name todo-default-todo-file)))
(files (or (unless archive
- (mapcar 'todos-absolute-file-name
- todos-category-completions-files))
+ (mapcar 'todo-absolute-file-name
+ todo-category-completions-files))
(list curfile)))
listall listf)
;; If file was just added, it has no category completions.
(unless (zerop (buffer-size (find-buffer-visiting curfile)))
- (unless (member curfile todos-archives)
+ (unless (member curfile todo-archives)
(add-to-list 'files curfile))
(dolist (f files listall)
(with-current-buffer (find-file-noselect f 'nowarn)
;; Ensure category is properly displayed in case user
- ;; switches to file via a non-Todos command. And if done
+ ;; switches to file via a non-Todo command. And if done
;; items in category are visible, keep them visible.
- (let ((done todos-show-with-done))
+ (let ((done todo-show-with-done))
(when (> (buffer-size) (- (point-max) (point-min)))
(save-excursion
(goto-char (point-min))
- (setq done (re-search-forward todos-done-string-start nil t))))
- (let ((todos-show-with-done done))
- (save-excursion (todos-category-select))))
+ (setq done (re-search-forward todo-done-string-start nil t))))
+ (let ((todo-show-with-done done))
+ (save-excursion (todo-category-select))))
(save-excursion
(save-restriction
(widen)
(push (cons cat f) listall))))
listf)))))
-(defun todos-read-file-name (prompt &optional archive mustmatch)
- "Choose and return the name of a Todos file, prompting with PROMPT.
+(defun todo-read-file-name (prompt &optional archive mustmatch)
+ "Choose and return the name of a Todo file, prompting with PROMPT.
Show completions with TAB or SPC; the names are shown in short
form but the absolute truename is returned. With non-nil ARCHIVE
-return the absolute truename of a Todos archive file. With non-nil
+return the absolute truename of a Todo archive file. With non-nil
MUSTMATCH the name of an existing file must be chosen;
otherwise, a new file name is allowed."
- (let* ((completion-ignore-case todos-completion-ignore-case)
- (files (mapcar 'todos-short-file-name
- (if archive todos-archives todos-files)))
+ (let* ((completion-ignore-case todo-completion-ignore-case)
+ (files (mapcar 'todo-short-file-name
+ (if archive todo-archives todo-files)))
(file (completing-read prompt files nil mustmatch nil nil
(if files
;; If user hit RET without
;; choosing a file, default to
;; current or default file.
- (todos-short-file-name
- (or todos-current-todos-file
- (and todos-show-current-file
- todos-global-current-todos-file)
- (todos-absolute-file-name
- todos-default-todos-file)))
+ (todo-short-file-name
+ (or todo-current-todo-file
+ (and todo-show-current-file
+ todo-global-current-todo-file)
+ (todo-absolute-file-name
+ todo-default-todo-file)))
;; Trigger prompt for initial file.
""))))
- (unless (file-exists-p todos-directory)
- (make-directory todos-directory))
+ (unless (file-exists-p todo-directory)
+ (make-directory todo-directory))
(unless mustmatch
- (setq file (todos-validate-name file 'file)))
- (setq file (file-truename (concat todos-directory file
+ (setq file (todo-validate-name file 'file)))
+ (setq file (file-truename (concat todo-directory file
(if archive ".toda" ".todo"))))))
-(defun todos-read-category (prompt &optional match-type file)
+(defun todo-read-category (prompt &optional match-type file)
"Choose and return a category name, prompting with PROMPT.
Show completions for existing categories with TAB or SPC.
With non-nil argument FILE prompt for a file and complete only
against categories in that file; otherwise complete against all
-categories from `todos-category-completions-files'."
+categories from `todo-category-completions-files'."
;; Allow SPC to insert spaces, for adding new category names.
(let ((map minibuffer-local-completion-map))
(define-key map " " nil)
(let* ((add (eq match-type 'add))
(archive (eq match-type 'archive))
- (file0 (when (and file (> (length todos-files) 1))
- (todos-read-file-name (concat "Choose a" (if archive
+ (file0 (when (and file (> (length todo-files) 1))
+ (todo-read-file-name (concat "Choose a" (if archive
"n archive"
" todo")
" file: ") archive t)))
- (completions (unless file0 (todos-category-completions archive)))
+ (completions (unless file0 (todo-category-completions archive)))
(categories (cond (file0
(with-current-buffer
(find-file-noselect file0 'nowarn)
- (let ((todos-current-todos-file file0))
- todos-categories)))
+ (let ((todo-current-todo-file file0))
+ todo-categories)))
((and add (not file))
(with-current-buffer
- (find-file-noselect todos-current-todos-file)
- todos-categories))
+ (find-file-noselect todo-current-todo-file)
+ todo-categories))
(t
completions)))
- (completion-ignore-case todos-completion-ignore-case)
+ (completion-ignore-case todo-completion-ignore-case)
(cat (completing-read prompt categories nil
(eq match-type 'todo) nil nil
;; Unless we're adding a category via
- ;; todos-add-category, set default
+ ;; todo-add-category, set default
;; for existing categories to the
;; current category of the chosen
;; file or else of the current file.
(with-current-buffer
(find-file-noselect
(or file0
- todos-current-todos-file
- (todos-absolute-file-name
- todos-default-todos-file)))
- (todos-current-category))
+ todo-current-todo-file
+ (todo-absolute-file-name
+ todo-default-todo-file)))
+ (todo-current-category))
;; Trigger prompt for initial category.
"")))
(catfil (cdr (assoc cat completions)))
(setq file0 (file-truename
(if (atom catfil)
catfil
- (todos-absolute-file-name
- (let ((files (mapcar 'todos-short-file-name catfil)))
+ (todo-absolute-file-name
+ (let ((files (mapcar 'todo-short-file-name catfil)))
(completing-read (format str cat) files)))))))
;; Default to the current file.
- (unless file0 (setq file0 todos-current-todos-file))
+ (unless file0 (setq file0 todo-current-todo-file))
;; First validate only a name passed interactively from
- ;; todos-add-category, which must be of a nonexisting category.
+ ;; todo-add-category, which must be of a nonexisting category.
(unless (and (assoc cat categories) (not add))
;; Validate only against completion categories.
- (let ((todos-categories categories))
- (setq cat (todos-validate-name cat 'category)))
+ (let ((todo-categories categories))
+ (setq cat (todo-validate-name cat 'category)))
;; When user enters a nonexisting category name by jumping or
;; moving, confirm that it should be added, then validate.
(unless add
- (if (todos-y-or-n-p (format "Add new category \"%s\" to file \"%s\"? "
- cat (todos-short-file-name file0)))
+ (if (todo-y-or-n-p (format "Add new category \"%s\" to file \"%s\"? "
+ cat (todo-short-file-name file0)))
(progn
(when (assoc cat categories)
- (let ((todos-categories categories))
- (setq cat (todos-validate-name cat 'category))))
+ (let ((todo-categories categories))
+ (setq cat (todo-validate-name cat 'category))))
;; Restore point and narrowing after adding new
;; category, to avoid moving to beginning of file when
;; moving marked items to a new category
- ;; (todos-move-item).
+ ;; (todo-move-item).
(save-excursion
(save-restriction
- (todos-add-category file0 cat))))
+ (todo-add-category file0 cat))))
;; If we decide not to add a category, exit without returning.
(keyboard-quit))))
(cons cat file0))))
-(defun todos-validate-name (name type)
+(defun todo-validate-name (name type)
"Prompt for new NAME for TYPE until it is valid, then return it.
TYPE can be either of the symbols `file' or `category'."
- (let ((categories todos-categories)
- (files (mapcar 'todos-short-file-name todos-files))
+ (let ((categories todo-categories)
+ (files (mapcar 'todo-short-file-name todo-files))
prompt)
(while
(and
(cond ((eq type 'file)
(if files
"Enter a non-empty file name: "
- ;; Empty string passed by todos-show to
- ;; prompt for initial Todos file.
+ ;; Empty string passed by todo-show to
+ ;; prompt for initial Todo file.
(concat "Initial file name ["
- todos-initial-file "]: ")))
+ todo-initial-file "]: ")))
((eq type 'category)
(if categories
"Enter a non-empty category name: "
- ;; Empty string passed by todos-show to
+ ;; Empty string passed by todo-show to
;; prompt for initial category of a new
- ;; Todos file.
+ ;; Todo file.
(concat "Initial category name ["
- todos-initial-category "]: "))))))
+ todo-initial-category "]: "))))))
((string-match "\\`\\s-+\\'" name)
(setq prompt
"Enter a name that does not contain only white space: "))
files
categories)
nil nil (if (eq type 'file)
- todos-initial-file
- todos-initial-category))))))
+ todo-initial-file
+ todo-initial-category))))))
name))
;; Adapted from calendar-read-date and calendar-date-string.
-(defun todos-read-date (&optional arg mo yr)
+(defun todo-read-date (&optional arg mo yr)
"Prompt for Gregorian date and return it in the current format.
With non-nil ARG, prompt for and return only the date component
(calendar-extract-year
(calendar-current-date)))))))
(when (or (not arg) (eq arg 'month))
- (let* ((marray todos-month-name-array)
+ (let* ((marray todo-month-name-array)
(mlist (append marray nil))
- (mabarray todos-month-abbrev-array)
+ (mabarray todo-month-abbrev-array)
(mablist (append mabarray nil))
- (completion-ignore-case todos-completion-ignore-case))
+ (completion-ignore-case todo-completion-ignore-case))
(setq monthname (completing-read
"Month name (RET for current month, * for any month): "
;; (mapcar 'list (append marray nil))
monthname)))
(mapconcat 'eval calendar-date-display-form ""))))
-(defun todos-read-dayname ()
+(defun todo-read-dayname ()
"Choose name of a day of the week with completion and return it."
- (let ((completion-ignore-case todos-completion-ignore-case))
+ (let ((completion-ignore-case todo-completion-ignore-case))
(completing-read "Enter a day name: "
(append calendar-day-name-array nil)
nil t)))
-(defun todos-read-time ()
+(defun todo-read-time ()
"Prompt for and return a valid clock time as a string.
Valid time strings are those matching `diary-time-regexp'.
Typing `<return>' at the prompt returns the current time, if the
-user option `todos-always-add-time-string' is non-nil, otherwise
+user option `todo-always-add-time-string' is non-nil, otherwise
the empty string (i.e., no time string)."
(let (valid answer)
(while (not valid)
(setq answer (read-string "Enter a clock time: " nil nil
- (when todos-always-add-time-string
+ (when todo-always-add-time-string
(substring (current-time-string) 11 16))))
(when (or (string= "" answer)
(string-match diary-time-regexp answer))
;;; Customization groups and utilities
;; -----------------------------------------------------------------------------
-(defgroup todos nil
+(defgroup todo nil
"Create and maintain categorized lists of todo items."
- :link '(emacs-commentary-link "todos")
+ :link '(emacs-commentary-link "todo")
:version "24.4"
:group 'calendar)
-(defgroup todos-edit nil
+(defgroup todo-edit nil
"User options for adding and editing todo items."
:version "24.4"
- :group 'todos)
+ :group 'todo)
-(defgroup todos-categories nil
- "User options for Todos Categories mode."
+(defgroup todo-categories nil
+ "User options for Todo Categories mode."
:version "24.4"
- :group 'todos)
+ :group 'todo)
-(defgroup todos-filtered nil
- "User options for Todos Filter Items mode."
+(defgroup todo-filtered nil
+ "User options for Todo Filter Items mode."
:version "24.4"
- :group 'todos)
+ :group 'todo)
-(defgroup todos-display nil
- "User display options for Todos mode."
+(defgroup todo-display nil
+ "User display options for Todo mode."
:version "24.4"
- :group 'todos)
+ :group 'todo)
-(defgroup todos-faces nil
- "Faces for the Todos modes."
+(defgroup todo-faces nil
+ "Faces for the Todo modes."
:version "24.4"
- :group 'todos)
+ :group 'todo)
-(defun todos-set-show-current-file (symbol value)
- "The :set function for user option `todos-show-current-file'."
+(defun todo-set-show-current-file (symbol value)
+ "The :set function for user option `todo-show-current-file'."
(custom-set-default symbol value)
(if value
- (add-hook 'pre-command-hook 'todos-show-current-file nil t)
- (remove-hook 'pre-command-hook 'todos-show-current-file t)))
+ (add-hook 'pre-command-hook 'todo-show-current-file nil t)
+ (remove-hook 'pre-command-hook 'todo-show-current-file t)))
-(defun todos-reset-prefix (symbol value)
- "The :set function for `todos-prefix' and `todos-number-prefix'."
+(defun todo-reset-prefix (symbol value)
+ "The :set function for `todo-prefix' and `todo-number-prefix'."
(let ((oldvalue (symbol-value symbol))
- (files todos-file-buffers))
+ (files todo-file-buffers))
(custom-set-default symbol value)
(when (not (equal value oldvalue))
(dolist (f files)
(with-current-buffer (find-file-noselect f)
;; Activate the new setting in the current category.
- (save-excursion (todos-category-select)))))))
+ (save-excursion (todo-category-select)))))))
-(defun todos-reset-nondiary-marker (symbol value)
- "The :set function for user option `todos-nondiary-marker'."
+(defun todo-reset-nondiary-marker (symbol value)
+ "The :set function for user option `todo-nondiary-marker'."
(let ((oldvalue (symbol-value symbol))
- (files (append todos-files todos-archives)))
+ (files (append todo-files todo-archives)))
(custom-set-default symbol value)
;; Need to reset these to get font-locking right.
- (setq todos-nondiary-start (nth 0 todos-nondiary-marker)
- todos-nondiary-end (nth 1 todos-nondiary-marker)
- todos-date-string-start
- ;; See comment in defvar of `todos-date-string-start'.
- (concat "^\\(" (regexp-quote todos-nondiary-start) "\\|"
+ (setq todo-nondiary-start (nth 0 todo-nondiary-marker)
+ todo-nondiary-end (nth 1 todo-nondiary-marker)
+ todo-date-string-start
+ ;; See comment in defvar of `todo-date-string-start'.
+ (concat "^\\(" (regexp-quote todo-nondiary-start) "\\|"
(regexp-quote diary-nonmarking-symbol) "\\)?"))
(when (not (equal value oldvalue))
(dolist (f files)
(goto-char (point-min))
(while (not (eobp))
(if (re-search-forward
- (concat "^\\(" todos-done-string-start "[^][]+] \\)?"
+ (concat "^\\(" todo-done-string-start "[^][]+] \\)?"
"\\(?1:" (regexp-quote (car oldvalue))
- "\\)" todos-date-pattern "\\( "
+ "\\)" todo-date-pattern "\\( "
diary-time-regexp "\\)?\\(?2:"
(regexp-quote (cadr oldvalue)) "\\)")
nil t)
(replace-match (nth 0 value) t t nil 1)
(replace-match (nth 1 value) t t nil 2))
(forward-line)))
- (todos-category-select)))))))
+ (todo-category-select)))))))
-(defun todos-reset-done-separator-string (symbol value)
- "The :set function for `todos-done-separator-string'."
+(defun todo-reset-done-separator-string (symbol value)
+ "The :set function for `todo-done-separator-string'."
(let ((oldvalue (symbol-value symbol))
- (files todos-file-buffers)
- (sep todos-done-separator))
+ (files todo-file-buffers)
+ (sep todo-done-separator))
(custom-set-default symbol value)
(when (not (equal value oldvalue))
(dolist (f files)
(with-current-buffer (find-file-noselect f)
(let (buffer-read-only)
- (setq todos-done-separator (todos-done-separator))
+ (setq todo-done-separator (todo-done-separator))
(when (= 1 (length value))
- (todos-reset-done-separator sep)))
- (todos-category-select))))))
+ (todo-reset-done-separator sep)))
+ (todo-category-select))))))
-(defun todos-reset-done-string (symbol value)
- "The :set function for user option `todos-done-string'."
+(defun todo-reset-done-string (symbol value)
+ "The :set function for user option `todo-done-string'."
(let ((oldvalue (symbol-value symbol))
- (files (append todos-files todos-archives)))
+ (files (append todo-files todo-archives)))
(custom-set-default symbol value)
;; Need to reset this to get font-locking right.
- (setq todos-done-string-start
- (concat "^\\[" (regexp-quote todos-done-string)))
+ (setq todo-done-string-start
+ (concat "^\\[" (regexp-quote todo-done-string)))
(when (not (equal value oldvalue))
(dolist (f files)
(with-current-buffer (find-file-noselect f)
(goto-char (point-min))
(while (not (eobp))
(if (re-search-forward
- (concat "^" (regexp-quote todos-nondiary-start)
+ (concat "^" (regexp-quote todo-nondiary-start)
"\\(" (regexp-quote oldvalue) "\\)")
nil t)
(replace-match value t t nil 1)
(forward-line)))
- (todos-category-select)))))))
+ (todo-category-select)))))))
-(defun todos-reset-comment-string (symbol value)
- "The :set function for user option `todos-comment-string'."
+(defun todo-reset-comment-string (symbol value)
+ "The :set function for user option `todo-comment-string'."
(let ((oldvalue (symbol-value symbol))
- (files (append todos-files todos-archives)))
+ (files (append todo-files todo-archives)))
(custom-set-default symbol value)
(when (not (equal value oldvalue))
(dolist (f files)
nil t)
(replace-match value t t nil 1)
(forward-line)))
- (todos-category-select))))))))
+ (todo-category-select))))))))
-(defun todos-reset-highlight-item (symbol value)
- "The :set function for `todos-toggle-item-highlighting'."
+(defun todo-reset-highlight-item (symbol value)
+ "The :set function for `todo-toggle-item-highlighting'."
(let ((oldvalue (symbol-value symbol))
- (files (append todos-files todos-archives)))
+ (files (append todo-files todo-archives)))
(custom-set-default symbol value)
(when (not (equal value oldvalue))
(dolist (f files)
(hl-line-mode 1)
(hl-line-mode -1)))))))))
-(defun todos-reevaluate-filelist-defcustoms ()
- "Reevaluate defcustoms that provide choice list of Todos files."
- (custom-set-default 'todos-default-todos-file
- (symbol-value 'todos-default-todos-file))
- (todos-reevaluate-default-file-defcustom)
- (custom-set-default 'todos-filter-files (symbol-value 'todos-filter-files))
- (todos-reevaluate-filter-files-defcustom)
- (custom-set-default 'todos-category-completions-files
- (symbol-value 'todos-category-completions-files))
- (todos-reevaluate-category-completions-files-defcustom))
-
-(defun todos-reevaluate-default-file-defcustom ()
- "Reevaluate defcustom of `todos-default-todos-file'.
-Called after adding or deleting a Todos file."
- (eval (defcustom todos-default-todos-file (car (funcall todos-files-function))
- "Todos file visited by first session invocation of `todos-show'."
+(defun todo-reevaluate-filelist-defcustoms ()
+ "Reevaluate defcustoms that provide choice list of Todo files."
+ (custom-set-default 'todo-default-todo-file
+ (symbol-value 'todo-default-todo-file))
+ (todo-reevaluate-default-file-defcustom)
+ (custom-set-default 'todo-filter-files (symbol-value 'todo-filter-files))
+ (todo-reevaluate-filter-files-defcustom)
+ (custom-set-default 'todo-category-completions-files
+ (symbol-value 'todo-category-completions-files))
+ (todo-reevaluate-category-completions-files-defcustom))
+
+(defun todo-reevaluate-default-file-defcustom ()
+ "Reevaluate defcustom of `todo-default-todo-file'.
+Called after adding or deleting a Todo file."
+ (eval (defcustom todo-default-todo-file (car (funcall todo-files-function))
+ "Todo file visited by first session invocation of `todo-show'."
:type `(radio ,@(mapcar (lambda (f) (list 'const f))
- (mapcar 'todos-short-file-name
- (funcall todos-files-function))))
- :group 'todos)))
-
-(defun todos-reevaluate-category-completions-files-defcustom ()
- "Reevaluate defcustom of `todos-category-completions-files'.
-Called after adding or deleting a Todos file."
- (eval (defcustom todos-category-completions-files nil
- "List of files for building `todos-read-category' completions."
+ (mapcar 'todo-short-file-name
+ (funcall todo-files-function))))
+ :group 'todo)))
+
+(defun todo-reevaluate-category-completions-files-defcustom ()
+ "Reevaluate defcustom of `todo-category-completions-files'.
+Called after adding or deleting a Todo file."
+ (eval (defcustom todo-category-completions-files nil
+ "List of files for building `todo-read-category' completions."
:type `(set ,@(mapcar (lambda (f) (list 'const f))
- (mapcar 'todos-short-file-name
- (funcall todos-files-function))))
- :group 'todos)))
-
-(defun todos-reevaluate-filter-files-defcustom ()
- "Reevaluate defcustom of `todos-filter-files'.
-Called after adding or deleting a Todos file."
- (eval (defcustom todos-filter-files nil
+ (mapcar 'todo-short-file-name
+ (funcall todo-files-function))))
+ :group 'todo)))
+
+(defun todo-reevaluate-filter-files-defcustom ()
+ "Reevaluate defcustom of `todo-filter-files'.
+Called after adding or deleting a Todo file."
+ (eval (defcustom todo-filter-files nil
"List of files for multifile item filtering."
:type `(set ,@(mapcar (lambda (f) (list 'const f))
- (mapcar 'todos-short-file-name
- (funcall todos-files-function))))
- :group 'todos)))
+ (mapcar 'todo-short-file-name
+ (funcall todo-files-function))))
+ :group 'todo)))
;; -----------------------------------------------------------------------------
;;; Font locking
;; -----------------------------------------------------------------------------
-(defun todos-nondiary-marker-matcher (lim)
- "Search for Todos nondiary markers within LIM for font-locking."
- (re-search-forward (concat "^\\(?1:" (regexp-quote todos-nondiary-start) "\\)"
- todos-date-pattern "\\(?: " diary-time-regexp
- "\\)?\\(?2:" (regexp-quote todos-nondiary-end) "\\)")
+(defun todo-nondiary-marker-matcher (lim)
+ "Search for Todo nondiary markers within LIM for font-locking."
+ (re-search-forward (concat "^\\(?1:" (regexp-quote todo-nondiary-start) "\\)"
+ todo-date-pattern "\\(?: " diary-time-regexp
+ "\\)?\\(?2:" (regexp-quote todo-nondiary-end) "\\)")
lim t))
-(defun todos-diary-nonmarking-matcher (lim)
+(defun todo-diary-nonmarking-matcher (lim)
"Search for diary nonmarking symbol within LIM for font-locking."
(re-search-forward (concat "^\\(?1:" (regexp-quote diary-nonmarking-symbol)
- "\\)" todos-date-pattern) lim t))
+ "\\)" todo-date-pattern) lim t))
-(defun todos-date-string-matcher (lim)
- "Search for Todos date string within LIM for font-locking."
+(defun todo-date-string-matcher (lim)
+ "Search for Todo date string within LIM for font-locking."
(re-search-forward
- (concat todos-date-string-start "\\(?1:" todos-date-pattern "\\)") lim t))
+ (concat todo-date-string-start "\\(?1:" todo-date-pattern "\\)") lim t))
-(defun todos-time-string-matcher (lim)
- "Search for Todos time string within LIM for font-locking."
- (re-search-forward (concat todos-date-string-start todos-date-pattern
+(defun todo-time-string-matcher (lim)
+ "Search for Todo time string within LIM for font-locking."
+ (re-search-forward (concat todo-date-string-start todo-date-pattern
" \\(?1:" diary-time-regexp "\\)") lim t))
-(defun todos-diary-expired-matcher (lim)
+(defun todo-diary-expired-matcher (lim)
"Search for expired diary item date within LIM for font-locking."
(when (re-search-forward (concat "^\\(?:"
(regexp-quote diary-nonmarking-symbol)
- "\\)?\\(?1:" todos-date-pattern "\\) \\(?2:"
+ "\\)?\\(?1:" todo-date-pattern "\\) \\(?2:"
diary-time-regexp "\\)?") lim t)
(let* ((date (match-string-no-properties 1))
(time (match-string-no-properties 2))
(date-time (concat date " " (or time "00:00"))))
(or (and (not (string-match ".+day\\|\\*" date))
(< (days-between date-time (current-time-string)) 0))
- (todos-diary-expired-matcher lim)))))
+ (todo-diary-expired-matcher lim)))))
-(defun todos-done-string-matcher (lim)
- "Search for Todos done header within LIM for font-locking."
- (re-search-forward (concat todos-done-string-start
+(defun todo-done-string-matcher (lim)
+ "Search for Todo done header within LIM for font-locking."
+ (re-search-forward (concat todo-done-string-start
"[^][]+]")
lim t))
-(defun todos-comment-string-matcher (lim)
- "Search for Todos done comment within LIM for font-locking."
- (re-search-forward (concat "\\[\\(?1:" todos-comment-string "\\):")
+(defun todo-comment-string-matcher (lim)
+ "Search for Todo done comment within LIM for font-locking."
+ (re-search-forward (concat "\\[\\(?1:" todo-comment-string "\\):")
lim t))
-(defun todos-category-string-matcher-1 (lim)
- "Search for Todos category name within LIM for font-locking.
-This is for fontifying category and file names appearing in Todos
+(defun todo-category-string-matcher-1 (lim)
+ "Search for Todo category name within LIM for font-locking.
+This is for fontifying category and file names appearing in Todo
Filtered Items mode following done items."
- (if (eq major-mode 'todos-filtered-items-mode)
- (re-search-forward (concat todos-done-string-start todos-date-pattern
+ (if (eq major-mode 'todo-filtered-items-mode)
+ (re-search-forward (concat todo-done-string-start todo-date-pattern
"\\(?: " diary-time-regexp
;; Use non-greedy operator to prevent
;; capturing possible following non-diary
"\\)?] \\(?1:\\[.+?\\]\\)")
lim t)))
-(defun todos-category-string-matcher-2 (lim)
- "Search for Todos category name within LIM for font-locking.
-This is for fontifying category and file names appearing in Todos
+(defun todo-category-string-matcher-2 (lim)
+ "Search for Todo category name within LIM for font-locking.
+This is for fontifying category and file names appearing in Todo
Filtered Items mode following todo (not done) items."
- (if (eq major-mode 'todos-filtered-items-mode)
- (re-search-forward (concat todos-date-string-start todos-date-pattern
+ (if (eq major-mode 'todo-filtered-items-mode)
+ (re-search-forward (concat todo-date-string-start todo-date-pattern
"\\(?: " diary-time-regexp "\\)?\\(?:"
- (regexp-quote todos-nondiary-end)
+ (regexp-quote todo-nondiary-end)
"\\)? \\(?1:\\[.+\\]\\)")
lim t)))
-(defvar todos-nondiary-face 'todos-nondiary)
-(defvar todos-date-face 'todos-date)
-(defvar todos-time-face 'todos-time)
-(defvar todos-diary-expired-face 'todos-diary-expired)
-(defvar todos-done-sep-face 'todos-done-sep)
-(defvar todos-done-face 'todos-done)
-(defvar todos-comment-face 'todos-comment)
-(defvar todos-category-string-face 'todos-category-string)
-(defvar todos-font-lock-keywords
+(defvar todo-nondiary-face 'todo-nondiary)
+(defvar todo-date-face 'todo-date)
+(defvar todo-time-face 'todo-time)
+(defvar todo-diary-expired-face 'todo-diary-expired)
+(defvar todo-done-sep-face 'todo-done-sep)
+(defvar todo-done-face 'todo-done)
+(defvar todo-comment-face 'todo-comment)
+(defvar todo-category-string-face 'todo-category-string)
+(defvar todo-font-lock-keywords
(list
- '(todos-nondiary-marker-matcher 1 todos-nondiary-face t)
- '(todos-nondiary-marker-matcher 2 todos-nondiary-face t)
+ '(todo-nondiary-marker-matcher 1 todo-nondiary-face t)
+ '(todo-nondiary-marker-matcher 2 todo-nondiary-face t)
;; diary-lib.el uses font-lock-constant-face for diary-nonmarking-symbol.
- '(todos-diary-nonmarking-matcher 1 font-lock-constant-face t)
- '(todos-date-string-matcher 1 todos-date-face t)
- '(todos-time-string-matcher 1 todos-time-face t)
- '(todos-done-string-matcher 0 todos-done-face t)
- '(todos-comment-string-matcher 1 todos-comment-face t)
- '(todos-category-string-matcher-1 1 todos-category-string-face t t)
- '(todos-category-string-matcher-2 1 todos-category-string-face t t)
- '(todos-diary-expired-matcher 1 todos-diary-expired-face t)
- '(todos-diary-expired-matcher 2 todos-diary-expired-face t t)
+ '(todo-diary-nonmarking-matcher 1 font-lock-constant-face t)
+ '(todo-date-string-matcher 1 todo-date-face t)
+ '(todo-time-string-matcher 1 todo-time-face t)
+ '(todo-done-string-matcher 0 todo-done-face t)
+ '(todo-comment-string-matcher 1 todo-comment-face t)
+ '(todo-category-string-matcher-1 1 todo-category-string-face t t)
+ '(todo-category-string-matcher-2 1 todo-category-string-face t t)
+ '(todo-diary-expired-matcher 1 todo-diary-expired-face t)
+ '(todo-diary-expired-matcher 2 todo-diary-expired-face t t)
)
- "Font-locking for Todos modes.")
+ "Font-locking for Todo modes.")
;; -----------------------------------------------------------------------------
;;; Key binding
;; -----------------------------------------------------------------------------
-(defvar todos-insertion-map
+(defvar todo-insertion-map
(let ((map (make-keymap)))
- (todos-insertion-key-bindings map)
- (define-key map "p" 'todos-copy-item)
+ (todo-insertion-key-bindings map)
+ (define-key map "p" 'todo-copy-item)
map)
- "Keymap for Todos mode item insertion commands.")
+ "Keymap for Todo mode item insertion commands.")
-(defvar todos-key-bindings-t
+(defvar todo-key-bindings-t
`(
- ("Af" todos-find-archive)
- ("Ac" todos-choose-archive)
- ("Ad" todos-archive-done-item)
- ("Cv" todos-toggle-view-done-items)
- ("v" todos-toggle-view-done-items)
- ("Ca" todos-add-category)
- ("Cr" todos-rename-category)
- ("Cg" todos-merge-category)
- ("Cm" todos-move-category)
- ("Ck" todos-delete-category)
- ("Cts" todos-set-top-priorities-in-category)
- ("Cey" todos-edit-category-diary-inclusion)
- ("Cek" todos-edit-category-diary-nonmarking)
- ("Fa" todos-add-file)
- ("Ff" todos-find-filtered-items-file)
- ("FV" todos-toggle-view-done-only)
- ("V" todos-toggle-view-done-only)
- ("Ftt" todos-filter-top-priorities)
- ("Ftm" todos-filter-top-priorities-multifile)
- ("Fts" todos-set-top-priorities-in-file)
- ("Fyy" todos-filter-diary-items)
- ("Fym" todos-filter-diary-items-multifile)
- ("Frr" todos-filter-regexp-items)
- ("Frm" todos-filter-regexp-items-multifile)
- ("ee" todos-edit-item)
- ("em" todos-edit-multiline-item)
- ("edt" todos-edit-item-header)
- ("edc" todos-edit-item-date-from-calendar)
- ("eda" todos-edit-item-date-to-today)
- ("edn" todos-edit-item-date-day-name)
- ("edy" todos-edit-item-date-year)
- ("edm" todos-edit-item-date-month)
- ("edd" todos-edit-item-date-day)
- ("et" todos-edit-item-time)
- ("eyy" todos-edit-item-diary-inclusion)
- ("eyk" todos-edit-item-diary-nonmarking)
- ("ec" todos-edit-done-item-comment)
- ("d" todos-item-done)
- ("i" ,todos-insertion-map)
- ("k" todos-delete-item)
- ("m" todos-move-item)
- ("u" todos-item-undone)
+ ("Af" todo-find-archive)
+ ("Ac" todo-choose-archive)
+ ("Ad" todo-archive-done-item)
+ ("Cv" todo-toggle-view-done-items)
+ ("v" todo-toggle-view-done-items)
+ ("Ca" todo-add-category)
+ ("Cr" todo-rename-category)
+ ("Cg" todo-merge-category)
+ ("Cm" todo-move-category)
+ ("Ck" todo-delete-category)
+ ("Cts" todo-set-top-priorities-in-category)
+ ("Cey" todo-edit-category-diary-inclusion)
+ ("Cek" todo-edit-category-diary-nonmarking)
+ ("Fa" todo-add-file)
+ ("Ff" todo-find-filtered-items-file)
+ ("FV" todo-toggle-view-done-only)
+ ("V" todo-toggle-view-done-only)
+ ("Ftt" todo-filter-top-priorities)
+ ("Ftm" todo-filter-top-priorities-multifile)
+ ("Fts" todo-set-top-priorities-in-file)
+ ("Fyy" todo-filter-diary-items)
+ ("Fym" todo-filter-diary-items-multifile)
+ ("Frr" todo-filter-regexp-items)
+ ("Frm" todo-filter-regexp-items-multifile)
+ ("ee" todo-edit-item)
+ ("em" todo-edit-multiline-item)
+ ("edt" todo-edit-item-header)
+ ("edc" todo-edit-item-date-from-calendar)
+ ("eda" todo-edit-item-date-to-today)
+ ("edn" todo-edit-item-date-day-name)
+ ("edy" todo-edit-item-date-year)
+ ("edm" todo-edit-item-date-month)
+ ("edd" todo-edit-item-date-day)
+ ("et" todo-edit-item-time)
+ ("eyy" todo-edit-item-diary-inclusion)
+ ("eyk" todo-edit-item-diary-nonmarking)
+ ("ec" todo-edit-done-item-comment)
+ ("d" todo-item-done)
+ ("i" ,todo-insertion-map)
+ ("k" todo-delete-item)
+ ("m" todo-move-item)
+ ("u" todo-item-undone)
([remap newline] newline-and-indent)
)
- "List of key bindings for Todos mode only.")
+ "List of key bindings for Todo mode only.")
-(defvar todos-key-bindings-t+a+f
+(defvar todo-key-bindings-t+a+f
`(
- ("C*" todos-mark-category)
- ("Cu" todos-unmark-category)
- ("Fh" todos-toggle-item-header)
- ("h" todos-toggle-item-header)
- ("Fe" todos-edit-file)
- ("FH" todos-toggle-item-highlighting)
- ("H" todos-toggle-item-highlighting)
- ("FN" todos-toggle-prefix-numbers)
- ("N" todos-toggle-prefix-numbers)
- ("PB" todos-print-buffer)
- ("PF" todos-print-buffer-to-file)
- ("b" todos-backward-category)
- ("d" todos-item-done)
- ("f" todos-forward-category)
- ("j" todos-jump-to-category)
- ("n" todos-next-item)
- ("p" todos-previous-item)
- ("q" todos-quit)
- ("s" todos-save)
- ("t" todos-show)
+ ("C*" todo-mark-category)
+ ("Cu" todo-unmark-category)
+ ("Fh" todo-toggle-item-header)
+ ("h" todo-toggle-item-header)
+ ("Fe" todo-edit-file)
+ ("FH" todo-toggle-item-highlighting)
+ ("H" todo-toggle-item-highlighting)
+ ("FN" todo-toggle-prefix-numbers)
+ ("N" todo-toggle-prefix-numbers)
+ ("PB" todo-print-buffer)
+ ("PF" todo-print-buffer-to-file)
+ ("b" todo-backward-category)
+ ("d" todo-item-done)
+ ("f" todo-forward-category)
+ ("j" todo-jump-to-category)
+ ("n" todo-next-item)
+ ("p" todo-previous-item)
+ ("q" todo-quit)
+ ("s" todo-save)
+ ("t" todo-show)
)
- "List of key bindings for Todos, Archive, and Filtered Items modes.")
+ "List of key bindings for Todo, Archive, and Filtered Items modes.")
-(defvar todos-key-bindings-t+a
+(defvar todo-key-bindings-t+a
`(
- ("Fc" todos-show-categories-table)
- ("S" todos-search)
- ("X" todos-clear-matches)
- ("*" todos-toggle-mark-item)
+ ("Fc" todo-show-categories-table)
+ ("S" todo-search)
+ ("X" todo-clear-matches)
+ ("*" todo-toggle-mark-item)
)
- "List of key bindings for Todos and Todos Archive modes.")
+ "List of key bindings for Todo and Todo Archive modes.")
-(defvar todos-key-bindings-t+f
+(defvar todo-key-bindings-t+f
`(
- ("l" todos-lower-item-priority)
- ("r" todos-raise-item-priority)
- ("#" todos-set-item-priority)
+ ("l" todo-lower-item-priority)
+ ("r" todo-raise-item-priority)
+ ("#" todo-set-item-priority)
)
- "List of key bindings for Todos and Todos Filtered Items modes.")
+ "List of key bindings for Todo and Todo Filtered Items modes.")
-(defvar todos-mode-map
+(defvar todo-mode-map
(let ((map (make-keymap)))
;; Don't suppress digit keys, so they can supply prefix arguments.
(suppress-keymap map)
- (dolist (kb todos-key-bindings-t)
+ (dolist (kb todo-key-bindings-t)
(define-key map (nth 0 kb) (nth 1 kb)))
- (dolist (kb todos-key-bindings-t+a+f)
+ (dolist (kb todo-key-bindings-t+a+f)
(define-key map (nth 0 kb) (nth 1 kb)))
- (dolist (kb todos-key-bindings-t+a)
+ (dolist (kb todo-key-bindings-t+a)
(define-key map (nth 0 kb) (nth 1 kb)))
- (dolist (kb todos-key-bindings-t+f)
+ (dolist (kb todo-key-bindings-t+f)
(define-key map (nth 0 kb) (nth 1 kb)))
map)
- "Todos mode keymap.")
+ "Todo mode keymap.")
-(defvar todos-archive-mode-map
+(defvar todo-archive-mode-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
- (dolist (kb todos-key-bindings-t+a+f)
+ (dolist (kb todo-key-bindings-t+a+f)
(define-key map (nth 0 kb) (nth 1 kb)))
- (dolist (kb todos-key-bindings-t+a)
+ (dolist (kb todo-key-bindings-t+a)
(define-key map (nth 0 kb) (nth 1 kb)))
- (define-key map "a" 'todos-jump-to-archive-category)
- (define-key map "u" 'todos-unarchive-items)
+ (define-key map "a" 'todo-jump-to-archive-category)
+ (define-key map "u" 'todo-unarchive-items)
map)
- "Todos Archive mode keymap.")
+ "Todo Archive mode keymap.")
-(defvar todos-edit-mode-map
+(defvar todo-edit-mode-map
(let ((map (make-sparse-keymap)))
- (define-key map "\C-x\C-q" 'todos-edit-quit)
+ (define-key map "\C-x\C-q" 'todo-edit-quit)
(define-key map [remap newline] 'newline-and-indent)
map)
- "Todos Edit mode keymap.")
+ "Todo Edit mode keymap.")
-(defvar todos-categories-mode-map
+(defvar todo-categories-mode-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
- (define-key map "c" 'todos-sort-categories-alphabetically-or-numerically)
- (define-key map "t" 'todos-sort-categories-by-todo)
- (define-key map "y" 'todos-sort-categories-by-diary)
- (define-key map "d" 'todos-sort-categories-by-done)
- (define-key map "a" 'todos-sort-categories-by-archived)
- (define-key map "#" 'todos-set-category-number)
- (define-key map "l" 'todos-lower-category)
- (define-key map "r" 'todos-raise-category)
- (define-key map "n" 'todos-next-button)
- (define-key map "p" 'todos-previous-button)
- (define-key map [tab] 'todos-next-button)
- (define-key map [backtab] 'todos-previous-button)
- (define-key map "q" 'todos-quit)
+ (define-key map "c" 'todo-sort-categories-alphabetically-or-numerically)
+ (define-key map "t" 'todo-sort-categories-by-todo)
+ (define-key map "y" 'todo-sort-categories-by-diary)
+ (define-key map "d" 'todo-sort-categories-by-done)
+ (define-key map "a" 'todo-sort-categories-by-archived)
+ (define-key map "#" 'todo-set-category-number)
+ (define-key map "l" 'todo-lower-category)
+ (define-key map "r" 'todo-raise-category)
+ (define-key map "n" 'todo-next-button)
+ (define-key map "p" 'todo-previous-button)
+ (define-key map [tab] 'todo-next-button)
+ (define-key map [backtab] 'todo-previous-button)
+ (define-key map "q" 'todo-quit)
map)
- "Todos Categories mode keymap.")
+ "Todo Categories mode keymap.")
-(defvar todos-filtered-items-mode-map
+(defvar todo-filtered-items-mode-map
(let ((map (make-sparse-keymap)))
(suppress-keymap map)
- (dolist (kb todos-key-bindings-t+a+f)
+ (dolist (kb todo-key-bindings-t+a+f)
(define-key map (nth 0 kb) (nth 1 kb)))
- (dolist (kb todos-key-bindings-t+f)
+ (dolist (kb todo-key-bindings-t+f)
(define-key map (nth 0 kb) (nth 1 kb)))
- (define-key map "g" 'todos-go-to-source-item)
- (define-key map [remap newline] 'todos-go-to-source-item)
+ (define-key map "g" 'todo-go-to-source-item)
+ (define-key map [remap newline] 'todo-go-to-source-item)
map)
- "Todos Filtered Items mode keymap.")
+ "Todo Filtered Items mode keymap.")
;; FIXME: Is it worth having a menu and if so, which commands?
;; (easy-menu-define
-;; todos-menu todos-mode-map "Todos Menu"
-;; '("Todos"
+;; todo-menu todo-mode-map "Todo Menu"
+;; '("Todo"
;; ("Navigation"
-;; ["Next Item" todos-forward-item t]
-;; ["Previous Item" todos-backward-item t]
+;; ["Next Item" todo-forward-item t]
+;; ["Previous Item" todo-backward-item t]
;; "---"
-;; ["Next Category" todos-forward-category t]
-;; ["Previous Category" todos-backward-category t]
-;; ["Jump to Category" todos-jump-to-category t]
+;; ["Next Category" todo-forward-category t]
+;; ["Previous Category" todo-backward-category t]
+;; ["Jump to Category" todo-jump-to-category t]
;; "---"
-;; ["Search Todos File" todos-search t]
-;; ["Clear Highlighting on Search Matches" todos-category-done t])
+;; ["Search Todo File" todo-search t]
+;; ["Clear Highlighting on Search Matches" todo-category-done t])
;; ("Display"
-;; ["List Current Categories" todos-show-categories-table t]
-;; ;; ["List Categories Alphabetically" todos-display-categories-alphabetically t]
-;; ["Turn Item Highlighting on/off" todos-toggle-item-highlighting t]
-;; ["Turn Item Numbering on/off" todos-toggle-prefix-numbers t]
-;; ["Turn Item Time Stamp on/off" todos-toggle-item-header t]
-;; ["View/Hide Done Items" todos-toggle-view-done-items t]
+;; ["List Current Categories" todo-show-categories-table t]
+;; ;; ["List Categories Alphabetically" todo-display-categories-alphabetically t]
+;; ["Turn Item Highlighting on/off" todo-toggle-item-highlighting t]
+;; ["Turn Item Numbering on/off" todo-toggle-prefix-numbers t]
+;; ["Turn Item Time Stamp on/off" todo-toggle-item-header t]
+;; ["View/Hide Done Items" todo-toggle-view-done-items t]
;; "---"
-;; ["View Diary Items" todos-filter-diary-items t]
-;; ["View Top Priority Items" todos-filter-top-priorities t]
-;; ["View Multifile Top Priority Items" todos-filter-top-priorities-multifile t]
+;; ["View Diary Items" todo-filter-diary-items t]
+;; ["View Top Priority Items" todo-filter-top-priorities t]
+;; ["View Multifile Top Priority Items" todo-filter-top-priorities-multifile t]
;; "---"
-;; ["Print Category" todos-print-buffer t])
+;; ["Print Category" todo-print-buffer t])
;; ("Editing"
-;; ["Insert New Item" todos-insert-item t]
-;; ["Insert Item Here" todos-insert-item-here t]
+;; ["Insert New Item" todo-insert-item t]
+;; ["Insert Item Here" todo-insert-item-here t]
;; ("More Insertion Commands")
-;; ["Edit Item" todos-edit-item t]
-;; ["Edit Multiline Item" todos-edit-multiline-item t]
-;; ["Edit Item Header" todos-edit-item-header t]
-;; ["Edit Item Date" todos-edit-item-date t]
-;; ["Edit Item Time" todos-edit-item-time t]
+;; ["Edit Item" todo-edit-item t]
+;; ["Edit Multiline Item" todo-edit-multiline-item t]
+;; ["Edit Item Header" todo-edit-item-header t]
+;; ["Edit Item Date" todo-edit-item-date t]
+;; ["Edit Item Time" todo-edit-item-time t]
;; "---"
-;; ["Lower Item Priority" todos-lower-item-priority t]
-;; ["Raise Item Priority" todos-raise-item-priority t]
-;; ["Set Item Priority" todos-set-item-priority t]
-;; ["Move (Recategorize) Item" todos-move-item t]
-;; ["Delete Item" todos-delete-item t]
-;; ["Undo Done Item" todos-item-undone t]
-;; ["Mark/Unmark Item for Diary" todos-toggle-item-diary-inclusion t]
-;; ["Mark/Unmark Items for Diary" todos-edit-item-diary-inclusion t]
-;; ["Mark & Hide Done Item" todos-item-done t]
-;; ["Archive Done Items" todos-archive-category-done-items t]
+;; ["Lower Item Priority" todo-lower-item-priority t]
+;; ["Raise Item Priority" todo-raise-item-priority t]
+;; ["Set Item Priority" todo-set-item-priority t]
+;; ["Move (Recategorize) Item" todo-move-item t]
+;; ["Delete Item" todo-delete-item t]
+;; ["Undo Done Item" todo-item-undone t]
+;; ["Mark/Unmark Item for Diary" todo-toggle-item-diary-inclusion t]
+;; ["Mark/Unmark Items for Diary" todo-edit-item-diary-inclusion t]
+;; ["Mark & Hide Done Item" todo-item-done t]
+;; ["Archive Done Items" todo-archive-category-done-items t]
;; "---"
-;; ["Add New Todos File" todos-add-file t]
-;; ["Add New Category" todos-add-category t]
-;; ["Delete Current Category" todos-delete-category t]
-;; ["Rename Current Category" todos-rename-category t]
+;; ["Add New Todo File" todo-add-file t]
+;; ["Add New Category" todo-add-category t]
+;; ["Delete Current Category" todo-delete-category t]
+;; ["Rename Current Category" todo-rename-category t]
;; "---"
-;; ["Save Todos File" todos-save t]
+;; ["Save Todo File" todo-save t]
;; )
;; "---"
-;; ["Quit" todos-quit t]
+;; ["Quit" todo-quit t]
;; ))
;; -----------------------------------------------------------------------------
;;; Hook functions and mode definitions
;; -----------------------------------------------------------------------------
-(defun todos-show-current-file ()
- "Visit current instead of default Todos file with `todos-show'.
+(defun todo-show-current-file ()
+ "Visit current instead of default Todo file with `todo-show'.
This function is added to `pre-command-hook' when user option
-`todos-show-current-file' is set to non-nil."
- (setq todos-global-current-todos-file todos-current-todos-file))
+`todo-show-current-file' is set to non-nil."
+ (setq todo-global-current-todo-file todo-current-todo-file))
-(defun todos-display-as-todos-file ()
- "Show Todos files correctly when visited from outside of Todos mode."
- (and (member this-command todos-visit-files-commands)
+(defun todo-display-as-todo-file ()
+ "Show Todo files correctly when visited from outside of Todo mode."
+ (and (member this-command todo-visit-files-commands)
(= (- (point-max) (point-min)) (buffer-size))
- (member major-mode '(todos-mode todos-archive-mode))
- (todos-category-select)))
+ (member major-mode '(todo-mode todo-archive-mode))
+ (todo-category-select)))
-(defun todos-add-to-buffer-list ()
- "Add name of just visited Todos file to `todos-file-buffers'.
-This function is added to `find-file-hook' in Todos mode."
+(defun todo-add-to-buffer-list ()
+ "Add name of just visited Todo file to `todo-file-buffers'.
+This function is added to `find-file-hook' in Todo mode."
(let ((filename (file-truename (buffer-file-name))))
- (when (member filename todos-files)
- (add-to-list 'todos-file-buffers filename))))
+ (when (member filename todo-files)
+ (add-to-list 'todo-file-buffers filename))))
-(defun todos-update-buffer-list ()
- "Make current Todos mode buffer file car of `todos-file-buffers'.
-This function is added to `post-command-hook' in Todos mode."
+(defun todo-update-buffer-list ()
+ "Make current Todo mode buffer file car of `todo-file-buffers'.
+This function is added to `post-command-hook' in Todo mode."
(let ((filename (file-truename (buffer-file-name))))
- (unless (eq (car todos-file-buffers) filename)
- (setq todos-file-buffers
- (cons filename (delete filename todos-file-buffers))))))
-
-(defun todos-reset-global-current-todos-file ()
- "Update the value of `todos-global-current-todos-file'.
-This becomes the latest existing Todos file or, if there is none,
-the value of `todos-default-todos-file'.
-This function is added to `kill-buffer-hook' in Todos mode."
+ (unless (eq (car todo-file-buffers) filename)
+ (setq todo-file-buffers
+ (cons filename (delete filename todo-file-buffers))))))
+
+(defun todo-reset-global-current-todo-file ()
+ "Update the value of `todo-global-current-todo-file'.
+This becomes the latest existing Todo file or, if there is none,
+the value of `todo-default-todo-file'.
+This function is added to `kill-buffer-hook' in Todo mode."
(let ((filename (file-truename (buffer-file-name))))
- (setq todos-file-buffers (delete filename todos-file-buffers))
- (setq todos-global-current-todos-file
- (or (car todos-file-buffers)
- (todos-absolute-file-name todos-default-todos-file)))))
+ (setq todo-file-buffers (delete filename todo-file-buffers))
+ (setq todo-global-current-todo-file
+ (or (car todo-file-buffers)
+ (todo-absolute-file-name todo-default-todo-file)))))
-(defun todos-reset-and-enable-done-separator ()
+(defun todo-reset-and-enable-done-separator ()
"Show resized done items separator overlay after window change.
-Added to `window-configuration-change-hook' in `todos-mode'."
- (when (= 1 (length todos-done-separator-string))
- (let ((sep todos-done-separator))
- (setq todos-done-separator (todos-done-separator))
- (save-match-data (todos-reset-done-separator sep)))))
-
-(defun todos-modes-set-1 ()
- "Make some settings that apply to multiple Todos modes."
- (setq-local font-lock-defaults '(todos-font-lock-keywords t))
- (setq-local tab-width todos-indent-to-here)
- (setq-local indent-line-function 'todos-indent)
- (when todos-wrap-lines
+Added to `window-configuration-change-hook' in `todo-mode'."
+ (when (= 1 (length todo-done-separator-string))
+ (let ((sep todo-done-separator))
+ (setq todo-done-separator (todo-done-separator))
+ (save-match-data (todo-reset-done-separator sep)))))
+
+(defun todo-modes-set-1 ()
+ "Make some settings that apply to multiple Todo modes."
+ (setq-local font-lock-defaults '(todo-font-lock-keywords t))
+ (setq-local tab-width todo-indent-to-here)
+ (setq-local indent-line-function 'todo-indent)
+ (when todo-wrap-lines
(visual-line-mode)
- (setq wrap-prefix (make-string todos-indent-to-here 32))))
+ (setq wrap-prefix (make-string todo-indent-to-here 32))))
-(defun todos-modes-set-2 ()
- "Make some settings that apply to multiple Todos modes."
- (add-to-invisibility-spec 'todos)
+(defun todo-modes-set-2 ()
+ "Make some settings that apply to multiple Todo modes."
+ (add-to-invisibility-spec 'todo)
(setq buffer-read-only t)
(when (boundp 'hl-line-range-function)
(setq-local hl-line-range-function
(lambda() (save-excursion
- (when (todos-item-end)
- (cons (todos-item-start)
- (todos-item-end))))))))
+ (when (todo-item-end)
+ (cons (todo-item-start)
+ (todo-item-end))))))))
-(defun todos-modes-set-3 ()
- "Make some settings that apply to multiple Todos modes."
- (setq-local todos-categories (todos-set-categories))
- (setq-local todos-category-number 1)
- (add-hook 'find-file-hook 'todos-display-as-todos-file nil t))
+(defun todo-modes-set-3 ()
+ "Make some settings that apply to multiple Todo modes."
+ (setq-local todo-categories (todo-set-categories))
+ (setq-local todo-category-number 1)
+ (add-hook 'find-file-hook 'todo-display-as-todo-file nil t))
-(put 'todos-mode 'mode-class 'special)
+(put 'todo-mode 'mode-class 'special)
-(define-derived-mode todos-mode special-mode "Todos"
+(define-derived-mode todo-mode special-mode "Todo"
"Major mode for displaying, navigating and editing Todo lists.
-\\{todos-mode-map}"
- ;; (easy-menu-add todos-menu)
- (todos-modes-set-1)
- (todos-modes-set-2)
- (todos-modes-set-3)
- ;; Initialize todos-current-todos-file.
+\\{todo-mode-map}"
+ ;; (easy-menu-add todo-menu)
+ (todo-modes-set-1)
+ (todo-modes-set-2)
+ (todo-modes-set-3)
+ ;; Initialize todo-current-todo-file.
(when (member (file-truename (buffer-file-name))
- (funcall todos-files-function))
- (setq-local todos-current-todos-file (file-truename (buffer-file-name))))
- (setq-local todos-show-done-only nil)
- (setq-local todos-categories-with-marks nil)
- (add-hook 'find-file-hook 'todos-add-to-buffer-list nil t)
- (add-hook 'post-command-hook 'todos-update-buffer-list nil t)
- (when todos-show-current-file
- (add-hook 'pre-command-hook 'todos-show-current-file nil t))
+ (funcall todo-files-function))
+ (setq-local todo-current-todo-file (file-truename (buffer-file-name))))
+ (setq-local todo-show-done-only nil)
+ (setq-local todo-categories-with-marks nil)
+ (add-hook 'find-file-hook 'todo-add-to-buffer-list nil t)
+ (add-hook 'post-command-hook 'todo-update-buffer-list nil t)
+ (when todo-show-current-file
+ (add-hook 'pre-command-hook 'todo-show-current-file nil t))
(add-hook 'window-configuration-change-hook
- 'todos-reset-and-enable-done-separator nil t)
- (add-hook 'kill-buffer-hook 'todos-reset-global-current-todos-file nil t))
-
-(put 'todos-archive-mode 'mode-class 'special)
-
-;; If todos-mode is parent, all todos-mode key bindings appear to be
-;; available in todos-archive-mode (e.g. shown by C-h m).
-(define-derived-mode todos-archive-mode special-mode "Todos-Arch"
- "Major mode for archived Todos categories.
-
-\\{todos-archive-mode-map}"
- (todos-modes-set-1)
- (todos-modes-set-2)
- (todos-modes-set-3)
- (setq-local todos-current-todos-file (file-truename (buffer-file-name)))
- (setq-local todos-show-done-only t))
-
-(defun todos-mode-external-set ()
- "Set `todos-categories' externally to `todos-current-todos-file'."
- (setq-local todos-current-todos-file todos-global-current-todos-file)
+ 'todo-reset-and-enable-done-separator nil t)
+ (add-hook 'kill-buffer-hook 'todo-reset-global-current-todo-file nil t))
+
+(put 'todo-archive-mode 'mode-class 'special)
+
+;; If todo-mode is parent, all todo-mode key bindings appear to be
+;; available in todo-archive-mode (e.g. shown by C-h m).
+(define-derived-mode todo-archive-mode special-mode "Todo-Arch"
+ "Major mode for archived Todo categories.
+
+\\{todo-archive-mode-map}"
+ (todo-modes-set-1)
+ (todo-modes-set-2)
+ (todo-modes-set-3)
+ (setq-local todo-current-todo-file (file-truename (buffer-file-name)))
+ (setq-local todo-show-done-only t))
+
+(defun todo-mode-external-set ()
+ "Set `todo-categories' externally to `todo-current-todo-file'."
+ (setq-local todo-current-todo-file todo-global-current-todo-file)
(let ((cats (with-current-buffer
;; Can't use find-buffer-visiting when
- ;; `todos-show-categories-table' is called on first
- ;; invocation of `todos-show', since there is then
+ ;; `todo-show-categories-table' is called on first
+ ;; invocation of `todo-show', since there is then
;; no buffer visiting the current file.
- (find-file-noselect todos-current-todos-file 'nowarn)
- (or todos-categories
- ;; In Todos Edit mode todos-categories is now nil
- ;; since it uses same buffer as Todos mode but
+ (find-file-noselect todo-current-todo-file 'nowarn)
+ (or todo-categories
+ ;; In Todo Edit mode todo-categories is now nil
+ ;; since it uses same buffer as Todo mode but
;; doesn't have the latter's local variables.
(save-excursion
(goto-char (point-min))
(read (buffer-substring-no-properties
(line-beginning-position)
(line-end-position))))))))
- (setq-local todos-categories cats)))
+ (setq-local todo-categories cats)))
-(define-derived-mode todos-edit-mode text-mode "Todos-Ed"
+(define-derived-mode todo-edit-mode text-mode "Todo-Ed"
"Major mode for editing multiline Todo items.
-\\{todos-edit-mode-map}"
- (todos-modes-set-1)
- (todos-mode-external-set)
+\\{todo-edit-mode-map}"
+ (todo-modes-set-1)
+ (todo-mode-external-set)
(setq buffer-read-only nil))
-(put 'todos-categories-mode 'mode-class 'special)
+(put 'todo-categories-mode 'mode-class 'special)
-(define-derived-mode todos-categories-mode special-mode "Todos-Cats"
- "Major mode for displaying and editing Todos categories.
+(define-derived-mode todo-categories-mode special-mode "Todo-Cats"
+ "Major mode for displaying and editing Todo categories.
-\\{todos-categories-mode-map}"
- (todos-mode-external-set))
+\\{todo-categories-mode-map}"
+ (todo-mode-external-set))
-(put 'todos-filtered-items-mode 'mode-class 'special)
+(put 'todo-filtered-items-mode 'mode-class 'special)
-(define-derived-mode todos-filtered-items-mode special-mode "Todos-Fltr"
- "Mode for displaying and reprioritizing top priority Todos.
+(define-derived-mode todo-filtered-items-mode special-mode "Todo-Fltr"
+ "Mode for displaying and reprioritizing top priority Todo.
-\\{todos-filtered-items-mode-map}"
- (todos-modes-set-1)
- (todos-modes-set-2))
+\\{todo-filtered-items-mode-map}"
+ (todo-modes-set-1)
+ (todo-modes-set-2))
-(add-to-list 'auto-mode-alist '("\\.todo\\'" . todos-mode))
-(add-to-list 'auto-mode-alist '("\\.toda\\'" . todos-archive-mode))
-(add-to-list 'auto-mode-alist '("\\.tod[tyr]\\'" . todos-filtered-items-mode))
+(add-to-list 'auto-mode-alist '("\\.todo\\'" . todo-mode))
+(add-to-list 'auto-mode-alist '("\\.toda\\'" . todo-archive-mode))
+(add-to-list 'auto-mode-alist '("\\.tod[tyr]\\'" . todo-filtered-items-mode))
;; -----------------------------------------------------------------------------
-(provide 'todos)
+(provide 'todo-mode)
-;;; todos.el ends here
+;;; todo-mode.el ends here