10:43 p.m.
The new files to be added with my calendar sync patch.
Jeff
;;; todo-mode.el --- major mode for editing TODO list files
;; Copyright (C) 1997, 1999, 2001 Free Software Foundation, Inc.
;; Author: Oliver Seidel <os10000(a)seidel-space.de>
;; [Not clear the above works, July 2000]
;; Created: 2 Aug 1997
;; Version: $Id: todo-mode.el,v 1.47.4.1 2001/11/13 04:12:45 rms Exp $
;; Keywords: calendar, todo
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;; ---------------------------------------------------------------------------
;;; Commentary:
;; Mode Description
;;
;; TODO is a major mode for EMACS which offers functionality to
;; treat most lines in one buffer as a list of items one has to
;; do. There are facilities to add new items, which are
;; categorised, to edit or even delete items from the buffer.
;; The buffer contents are currently compatible with the diary,
;; so that the list of todo-items will show up in the FANCY diary
;; mode.
;;
;; Notice: Besides the major mode, this file also exports the
;; function `todo-show' which will change to the one specific
;; TODO file that has been specified in the todo-file-do
;; variable. If this file does not conform to the TODO mode
;; conventions, the todo-show function will add the appropriate
;; header and footer. I don't anticipate this to cause much
;; grief, but be warned, in case you attempt to read a plain text
;; file.
;;
;; Preface, Quickstart Installation
;;
;; To get this to work, make emacs execute the line
;;
;; (autoload 'todo-mode "todo-mode"
;; "Major mode for editing TODO lists." t)
;; (autoload 'todo-show "todo-mode"
;; "Show TODO items." t)
;; (autoload 'todo-insert-item "todo-mode"
;; "Add TODO item." t)
;;
;; You may now enter new items by typing "M-x todo-insert-item",
;; or enter your TODO list file by typing "M-x todo-show".
;;
;; The TODO list file has a special format and some auxiliary
;; information, which will be added by the todo-show function if
;; it attempts to visit an un-initialised file. Hence it is
;; recommended to use the todo-show function for the first time,
;; in order to initialise the file, but it is not necessary
;; afterwards.
;;
;; As these commands are quite long to type, I would recommend
;; the addition of two bindings to your to your global keymap. I
;; personally have the following in my initialisation file:
;;
;; (global-set-key "\C-ct" 'todo-show) ;; switch to TODO buffer
;; (global-set-key "\C-ci" 'todo-insert-item) ;; insert new item
;;
;; Note, however, that this recommendation has prompted some
;; criticism, since the keys C-c LETTER are reserved for user
;; functions. I believe my recommendation is acceptable, since
;; the Emacs Lisp Manual *Tips* section also details that the
;; mode itself should not bind any functions to those keys. The
;; express aim of the above two bindings is to work outside the
;; mode, which doesn't need the show function and offers a
;; different binding for the insert function. They serve as
;; shortcuts and are not even needed (since the TODO mode will be
;; entered by visiting the TODO file, and later by switching to
;; its buffer).
;;
;; If you are an advanced user of this package, please consult
;; the whole source code for autoloads, because there are several
;; extensions that are not explicitly listed in the above quick
;; installation.
;;
;; Version
;;
;; Which version of todo-mode.el does this documentation refer to?
;;
;; $Id: todo-mode.el,v 1.47.4.1 2001/11/13 04:12:45 rms Exp $
;;
;; Pre-Requisites
;;
;; This package will require the following packages to be
;; available on the load-path:
;;
;; time-stamp
;; easymenu
;;
;; Operation
;;
;; You will have the following facilities available:
;;
;; M-x todo-show will enter the todo list screen, here type
;;
;; + to go to next category
;; - to go to previous category
;; d to file the current entry, including a
;; comment and timestamp
;; e to edit the current entry
;; E to edit a multi-line entry
;; f to file the current entry, including a
;; comment and timestamp
;; i to insert a new entry, with prefix, omit category
;; I to insert a new entry at current cursor position
;; j jump to category
;; k to kill the current entry
;; l to lower the current entry's priority
;; n for the next entry
;; p for the previous entry
;; P print
;; q to save the list and exit the buffer
;; r to raise the current entry's priority
;; s to save the list
;; S to save the list of top priorities
;; t show top priority items for each category
;;
;; When you add a new entry, you are asked for the text and then
;; for the category. I for example have categories for things
;; that I want to do in the office (like mail my mum), that I
;; want to do in town (like buy cornflakes) and things I want to
;; do at home (move my suitcases). The categories can be
;; selected with the cursor keys and if you type in the name of a
;; category which didn't exist before, an empty category of the
;; desired name will be added and filled with the new entry.
;;
;; Configuration
;;
;; Variable todo-prefix
;;
;; I would like to recommend that you use the prefix "*/*" (by
;; leaving the variable 'todo-prefix' untouched) so that the
;; diary displays each entry every day.
;;
;; To understand what I mean, please read the documentation that
;; goes with the calendar since that will tell you how you can
;; set up the fancy diary display and use the #include command to
;; include your todo list file as part of your diary.
;;
;; If you have the diary package set up to usually display more
;; than one day's entries at once, consider using
;;
;; "&%%(equal (calendar-current-date) date)"
;;
;; as the value of `todo-prefix'. Please note that this may slow
;; down the processing of your diary file some.
;;
;; Carsten Dominik <dominik(a)strw.LeidenUniv.nl> suggested that
;;
;; "&%%(todo-cp)"
;;
;; might be nicer and to that effect a function has been declared
;; further down in the code. You may wish to auto-load this.
;;
;; Carsten also writes that that *changing* the prefix after the
;; todo list is already established is not as simple as changing
;; the variable - the todo files have to be changed by hand.
;;
;; Variable todo-file-do
;;
;; This variable is fairly self-explanatory. You have to store
;; your TODO list somewhere. This variable tells the package
;; where to go and find this file.
;;
;; Variable todo-file-done
;;
;; Even when you're done, you may wish to retain the entries.
;; Given that they're timestamped and you are offered to add a
;; comment, this can make a useful diary of past events. It will
;; even blend in with the EMACS diary package. So anyway, this
;; variable holds the name of the file for the filed todo-items.
;;
;; Variable todo-file-top
;;
;; File storing the top priorities of your TODO list when
;; todo-save-top-priorities is non-nil. Nice to include in your
;; diary instead of the complete TODO list.
;;
;; Variable todo-mode-hook
;;
;; Just like other modes, too, this mode offers to call your
;; functions before it goes about its business. This variable
;; will be inspected for any functions you may wish to have
;; called once the other TODO mode preparations have been
;; completed.
;;
;; Variable todo-insert-threshold
;;
;; Another nifty feature is the insertion accuracy. If you have
;; 8 items in your TODO list, then you may get asked 4 questions
;; by the binary insertion algorithm. However, you may not
;; really have a need for such accurate priorities amongst your
;; TODO items. If you now think about the binary insertion
;; halfing the size of the window each time, then the threshhold
;; is the window size at which it will stop. If you set the
;; threshhold to zero, the upper and lower bound will coincide at
;; the end of the loop and you will insert your item just before
;; that point. If you set the threshhold to, e.g. 8, it will stop
;; as soon as the window size drops below that amount and will
;; insert the item in the approximate centre of that window. I
;; got the idea for this feature after reading a very helpful
;; e-mail reply from Trey Jackson <trey(a)cs.berkeley.edu> who
;; corrected some of my awful coding and pointed me towards some
;; good reading. Thanks Trey!
;;
;; Things to do
;;
;; These originally were my ideas, but now also include all the
;; suggestions that I included before forgetting them:
;;
;; o Fancy fonts for todo/top-priority buffer
;; o Remove todo-prefix option in todo-top-priorities
;; o Rename category
;; o Move entry from one category to another one
;; o Entries which both have the generic */* prefix and a
;; "deadline" entry which are understood by diary, indicating
;; an event (unless marked by &)
;; o The optional COUNT variable of todo-forward-item should be
;; applied to the other functions performing similar tasks
;; o Modularization could be done for repeaded elements of
;; the code, like the completing-read lines of code.
;; o license / version function
;; o export to diary file
;; o todo-report-bug
;; o GNATS support
;; o elide multiline (as in bbdb, or, to a lesser degree, in
;; outline mode)
;; o rewrite complete package to store data as lisp objects
;; and have display modes for display, for diary export,
;; etc. (Richard Stallman pointed out this is a bad idea)
;; o so base todo-mode.el on generic-mode.el instead
;;
;; History and Gossip
;;
;; Many thanks to all the ones who have contributed to the
;; evolution of this package! I hope I have listed all of you
;; somewhere in the documentation or at least in the RCS history!
;;
;; Enjoy this package and express your gratitude by sending nice
;; things to my parents' address!
;;
;; Oliver Seidel
;; (Lessingstr. 8, 65760 Eschborn, Federal Republic of Germany)
;;; Code:
;; XEmacs
(eval-and-compile
(unless (fboundp 'line-beginning-position)
(defalias 'line-beginning-position 'point-at-bol))
(unless (fboundp 'line-end-position)
(defalias 'line-end-position 'point-at-eol)))
;; User-configurable variables:
(defgroup todo nil
"Maintain a list of todo items."
:link '(emacs-commentary-link "todo-mode")
:version "21.1"
:group 'calendar)
(defcustom todo-prefix "*/*"
"*TODO mode prefix for entries.
This is useful in conjunction with `calendar' and `diary' if you use
#include \"~/.todo-do\"
in your diary file to include your todo list file as part of your
diary. With the default value \"*/*\" the diary displays each entry
every day and it may also be marked on every day of the calendar.
Using \"&%%(equal (calendar-current-date) date)\" instead will only
show and mark todo entreis for today, but may slow down processing of
the diary file somewhat."
:type 'string
:group 'todo)
(defcustom todo-file-do "~/.todo-do"
"*TODO mode list file."
:type 'file
:group 'todo)
(defcustom todo-file-done "~/.todo-done"
"*TODO mode archive file."
:type 'file
:group 'todo)
(defcustom todo-mode-hook nil
"*TODO mode hooks."
:type 'hook
:group 'todo)
(defcustom todo-edit-mode-hook nil
"*TODO Edit mode hooks."
:type 'hook
:group 'todo)
(defcustom todo-insert-threshold 0
"*TODO mode insertion accuracy.
If you have 8 items in your TODO list, then you may get asked 4
questions by the binary insertion algorithm. However, you may not
really have a need for such accurate priorities amongst your TODO
items. If you now think about the binary insertion halfing the size
of the window each time, then the threshhold is the window size at
which it will stop. If you set the threshhold to zero, the upper and
lower bound will coincide at the end of the loop and you will insert
your item just before that point. If you set the threshhold to,
e.g. 8, it will stop as soon as the window size drops below that
amount and will insert the item in the approximate centre of that
window."
:type 'integer
:group 'todo)
(defvar todo-edit-buffer " *TODO Edit*"
"TODO Edit buffer name.")
(defcustom todo-file-top "~/.todo-top"
"*TODO mode top priorities file.
Not in TODO format, but diary compatible.
Automatically generated when `todo-save-top-priorities' is non-nil."
:type 'string
:group 'todo)
(defcustom todo-print-function 'ps-print-buffer-with-faces
"*Function to print the current buffer."
:type 'symbol
:group 'todo)
(defcustom todo-show-priorities 1
"*Default number of priorities to show by \\[todo-top-priorities].
0 means show all entries."
:type 'integer
:group 'todo)
(defcustom todo-print-priorities 0
"*Default number of priorities to print by \\[todo-print].
0 means print all entries."
:type 'integer
:group 'todo)
(defcustom todo-remove-separator t
"*Non-nil to remove category separators in\
\\[todo-top-priorities] and \\[todo-print]."
:type 'boolean
:group 'todo)
(defcustom todo-save-top-priorities-too t
"*Non-nil makes `todo-save' automatically save top-priorities in
`todo-file-top'."
:type 'boolean
:group 'todo)
;; Thanks for the ISO time stamp format go to Karl Eichwalder <ke(a)suse.de>
;; My format string for the appt.el package is "%3b %2d, %y, %02I:%02M%p".
;;
(defcustom todo-time-string-format
"%:y-%02m-%02d %02H:%02M"
"*TODO mode time string format for done entries.
For details see the variable `time-stamp-format'."
:type 'string
:group 'todo)
(defcustom todo-entry-prefix-function 'todo-entry-timestamp-initials
"*Function producing text to insert at start of todo entry."
:type 'symbol
:group 'todo)
(defcustom todo-initials (or (getenv "INITIALS") (user-login-name))
"*Initials of todo item author."
:type 'string
:group 'todo)
(autoload 'time-stamp-string "time-stamp")
(defun todo-entry-timestamp-initials ()
"Prepend timestamp and your initials to the head of a TODO entry."
(let ((time-stamp-format todo-time-string-format))
(concat (time-stamp-string) " " todo-initials ": ")))
;; ---------------------------------------------------------------------------
;; Set up some helpful context ...
(defvar todo-categories nil
"TODO categories.")
(defvar todo-cats nil
"Old variable for holding the TODO categories.
Use `todo-categories' instead.")
(defvar todo-previous-line 0
"Previous line asked about.")
(defvar todo-previous-answer 0
"Previous answer got.")
(defvar todo-mode-map
(let ((map (make-keymap)))
(suppress-keymap map t)
(define-key map "+" 'todo-forward-category)
(define-key map "-" 'todo-backward-category)
(define-key map "d" 'todo-file-item) ;done/delete
(define-key map "e" 'todo-edit-item)
(define-key map "E" 'todo-edit-multiline)
(define-key map "f" 'todo-file-item)
(define-key map "i" 'todo-insert-item)
(define-key map "I" 'todo-insert-item-here)
(define-key map "j" 'todo-jump-to-category)
(define-key map "k" 'todo-delete-item)
(define-key map "l" 'todo-lower-item)
(define-key map "n" 'todo-forward-item)
(define-key map "p" 'todo-backward-item)
(define-key map "P" 'todo-print)
(define-key map "q" 'todo-quit)
(define-key map "r" 'todo-raise-item)
(define-key map "s" 'todo-save)
(define-key map "S" 'todo-save-top-priorities)
(define-key map "t" 'todo-top-priorities)
map)
"TODO mode keymap.")
(defvar todo-category-number 0 "TODO category number.")
(defvar todo-tmp-buffer-name " *todo tmp*")
(defvar todo-category-sep (make-string 75 ?-)
"Category separator.")
(defvar todo-category-beg " --- "
"Category start separator to be prepended onto category name.")
(defvar todo-category-end "--- End"
"Separator after a category.")
(defvar todo-header "-*- mode: todo; "
"Header of todo files.")
;; ---------------------------------------------------------------------------
(defun todo-category-select ()
"Make TODO mode display the current category correctly."
(let ((name (nth todo-category-number todo-categories)))
(setq mode-line-buffer-identification
;; (concat "Category: " name))
(concat "Category: " (format "%18s" name)))
(widen)
(goto-char (point-min))
(search-forward-regexp
(concat "^"
(regexp-quote (concat todo-prefix todo-category-beg name))
"$"))
(let ((begin (1+ (line-end-position))))
(search-forward-regexp (concat "^" todo-category-end))
(narrow-to-region begin (line-beginning-position))
(goto-char (point-min)))))
(defalias 'todo-cat-slct 'todo-category-select)
(defun todo-forward-category ()
"Go forward to TODO list of next category."
(interactive)
(setq todo-category-number
(mod (1+ todo-category-number) (length todo-categories)))
(todo-category-select))
(defalias 'todo-cmd-forw 'todo-forward-category)
(defun todo-backward-category ()
"Go back to TODO list of previous category."
(interactive)
(setq todo-category-number
(mod (1- todo-category-number) (length todo-categories)))
(todo-category-select))
(defalias 'todo-cmd-back 'todo-backward-category)
(defun todo-backward-item ()
"Select previous entry of TODO list."
(interactive)
(search-backward-regexp (concat "^" (regexp-quote todo-prefix)) nil t)
(message ""))
(defalias 'todo-cmd-prev 'todo-backward-item)
(defun todo-forward-item (&optional count)
"Select COUNT-th next entry of TODO list."
(interactive "P")
(if (listp count) (setq count (car count)))
(end-of-line)
(search-forward-regexp (concat "^" (regexp-quote todo-prefix))
nil 'goto-end count)
(beginning-of-line)
(message ""))
(defalias 'todo-cmd-next 'todo-forward-item)
(defun todo-save ()
"Save the TODO list."
(interactive)
(save-excursion
(save-restriction
(save-buffer)
(if todo-save-top-priorities-too (todo-save-top-priorities))
)))
(defalias 'todo-cmd-save 'todo-save)
(defun todo-quit ()
"Done with TODO list for now."
(interactive)
(widen)
(todo-save)
(message "")
(bury-buffer))
(defalias 'todo-cmd-done 'todo-quit)
(defun todo-edit-item ()
"Edit current TODO list entry."
(interactive)
(let ((item (todo-item-string)))
(if (todo-string-multiline-p item)
(todo-edit-multiline)
(let ((new (read-from-minibuffer "Edit: " item)))
(todo-remove-item)
(insert new "\n")
(todo-backward-item)
(message "")))))
(defalias 'todo-cmd-edit 'todo-edit-item)
(defun todo-edit-multiline ()
"Set up a buffer for editing a multiline TODO list entry."
(interactive)
(let ((buffer-name (generate-new-buffer-name todo-edit-buffer)))
(switch-to-buffer
(make-indirect-buffer
(file-name-nondirectory todo-file-do) buffer-name))
(message "To exit, simply kill this buffer and return to list.")
(todo-edit-mode)
(narrow-to-region (todo-item-start) (todo-item-end))))
;;;###autoload
(defun todo-add-category (cat)
"Add new category CAT to the TODO list."
(interactive "sCategory: ")
(save-window-excursion
(setq todo-categories (cons cat todo-categories))
(find-file todo-file-do)
(widen)
(goto-char (point-min))
(let ((posn (search-forward "-*- mode: todo; " 17 t)))
(if (not (null posn)) (goto-char posn))
(if (equal posn nil)
(progn
(insert "-*- mode: todo; \n")
(forward-char -1))
(kill-line)))
(insert (format "todo-categories: %S; -*-" todo-categories))
(forward-char 1)
(insert (format "%s%s%s\n%s\n%s %s\n"
todo-prefix todo-category-beg cat
todo-category-end
todo-prefix todo-category-sep)))
0)
;;;###autoload
(defun todo-add-item-non-interactively (new-item category)
"Insert NEW-ITEM in TODO list as a new entry in CATEGORY."
(save-excursion
(todo-show))
(save-excursion
(if (string= "" category)
(setq category (nth todo-category-number todo-categories)))
(let ((cat-exists (member category todo-categories)))
(setq todo-category-number
(if cat-exists
(- (length todo-categories) (length cat-exists))
(todo-add-category category))))
(todo-show)
(setq todo-previous-line 0)
(let ((top 1)
(bottom (1+ (count-lines (point-min) (point-max)))))
(while (> (- bottom top) todo-insert-threshold)
(let* ((current (/ (+ top bottom) 2))
(answer (if (< current bottom)
(todo-more-important-p current) nil)))
(if answer
(setq bottom current)
(setq top (1+ current)))))
(setq top (/ (+ top bottom) 2))
;; goto-line doesn't have the desired behavior in a narrowed buffer
(goto-char (point-min))
(forward-line (1- top)))
(insert new-item "\n")
(todo-backward-item)
(todo-save)
(message "")))
;;;###autoload
(defun todo-insert-item (arg)
"Insert new TODO list entry.
With a prefix argument solicit the category, otherwise use the current
category."
(interactive "P")
(save-excursion
(if (not (string-equal mode-name "TODO")) (todo-show))
(let* ((new-item (concat todo-prefix " "
(read-from-minibuffer
"New TODO entry: "
(if todo-entry-prefix-function
(funcall todo-entry-prefix-function)))))
(categories todo-categories)
(history (cons 'categories (1+ todo-category-number)))
(current-category (nth todo-category-number todo-categories))
(category
(if arg
current-category
(completing-read (concat "Category [" current-category "]: ")
(todo-category-alist) nil nil nil
history current-category))))
(todo-add-item-non-interactively new-item category))))
(defalias 'todo-cmd-inst 'todo-insert-item)
(defun todo-insert-item-here ()
"Insert new TODO list entry under the cursor."
(interactive "")
(save-excursion
(if (not (string-equal mode-name "TODO")) (todo-show))
(let* ((new-item (concat todo-prefix " "
(read-from-minibuffer
"New TODO entry: "
(if todo-entry-prefix-function
(funcall todo-entry-prefix-function))))))
(insert (concat new-item "\n")))))
(defun todo-more-important-p (line)
"Ask whether entry is more important than the one at LINE."
(if (not (equal todo-previous-line line))
(progn
(setq todo-previous-line line)
(goto-char (point-min))
(forward-line (1- todo-previous-line))
(let ((item (todo-item-string-start)))
(setq todo-previous-answer
(y-or-n-p (concat "More important than '" item "'?
"))))))
todo-previous-answer)
(defalias 'todo-ask-p 'todo-more-important-p)
(defun todo-delete-item ()
"Delete current TODO list entry."
(interactive)
(if (> (count-lines (point-min) (point-max)) 0)
(let* ((todo-entry (todo-item-string-start))
(todo-answer (y-or-n-p (concat "Permanently remove '"
todo-entry "'? "))))
(if todo-answer
(progn
(todo-remove-item)
(todo-backward-item)))
(message ""))
(error "No TODO list entry to delete")))
(defalias 'todo-cmd-kill 'todo-delete-item)
(defun todo-raise-item ()
"Raise priority of current entry."
(interactive)
(if (> (count-lines (point-min) (point)) 0)
(let ((item (todo-item-string)))
(todo-remove-item)
(todo-backward-item)
(save-excursion
(insert item "\n"))
(message ""))
(error "No TODO list entry to raise")))
(defalias 'todo-cmd-rais 'todo-raise-item)
(defun todo-lower-item ()
"Lower priority of current entry."
(interactive)
(if (> (count-lines (point) (point-max)) 1)
;; Assume there is a final newline
(let ((item (todo-item-string)))
(todo-remove-item)
(todo-forward-item)
(save-excursion
(insert item "\n"))
(message ""))
(error "No TODO list entry to lower")))
(defalias 'todo-cmd-lowr 'todo-lower-item)
(defun todo-file-item (&optional comment)
"File the current TODO list entry away, annotated with an optional COMMENT."
(interactive "sComment: ")
(or (> (count-lines (point-min) (point-max)) 0)
(error "No TODO list entry to file away"))
(let ((time-stamp-format todo-time-string-format))
(if (and comment (> (length comment) 0))
(progn
(goto-char (todo-item-end))
(insert
(if (save-excursion (beginning-of-line)
(looking-at (regexp-quote todo-prefix)))
" "
"\n\t")
"(" comment ")")))
(goto-char (todo-item-end))
(insert " [" (nth todo-category-number todo-categories) "]")
(goto-char (todo-item-start))
(let ((temp-point (point)))
(if (looking-at (regexp-quote todo-prefix))
(replace-match (time-stamp-string))
;; Standard prefix -> timestamp
;; Else prefix non-standard item start with timestamp
(insert (time-stamp-string)))
(append-to-file temp-point (1+ (todo-item-end)) todo-file-done)
(delete-region temp-point (1+ (todo-item-end))))
(todo-backward-item)
(message "")))
;; ---------------------------------------------------------------------------
;; Utility functions:
;;;###autoload
(defun todo-top-priorities (&optional nof-priorities category-pr-page)
"List top priorities for each category.
Number of entries for each category is given by NOF-PRIORITIES which
defaults to \'todo-show-priorities\'.
If CATEGORY-PR-PAGE is non-nil, a page separator \'^L\' is inserted
between each category."
(interactive "P")
(or nof-priorities (setq nof-priorities todo-show-priorities))
(if (listp nof-priorities) ;universal argument
(setq nof-priorities (car nof-priorities)))
(let ((todo-print-buffer-name todo-tmp-buffer-name)
;;(todo-print-category-number 0)
(todo-category-break (if category-pr-page " " ""))
(cat-end
(concat
(if todo-remove-separator
(concat todo-category-end "\n"
(regexp-quote todo-prefix) " " todo-category-sep
"\n")
(concat todo-category-end "\n"))))
beg end)
(todo-show)
(save-excursion
(save-restriction
(widen)
(copy-to-buffer todo-print-buffer-name (point-min) (point-max))
(set-buffer todo-print-buffer-name)
(goto-char (point-min))
(when (re-search-forward (regexp-quote todo-header) nil t)
(beginning-of-line 1)
(delete-region (point) (line-end-position)))
(while (re-search-forward ;Find category start
(regexp-quote (concat todo-prefix todo-category-beg))
nil t)
(setq beg (+ (line-end-position) 1)) ;Start of first entry.
(re-search-forward cat-end nil t)
(setq end (match-beginning 0))
(replace-match todo-category-break)
(narrow-to-region beg end) ;In case we have too few entries.
(goto-char (point-min))
(if (= 0 nof-priorities) ;Traverse entries.
(goto-char end) ;All entries
(todo-forward-item nof-priorities))
(setq beg (point))
(delete-region beg end)
(widen))
(and (looking-at " ") (replace-match "")) ;Remove trailing form-feed.
(goto-char (point-min)) ;Due to display buffer
))
;; Could have used switch-to-buffer as it has a norecord argument,
;; which is nice when we are called from e.g. todo-print.
;; Else we could have used pop-to-buffer.
(display-buffer todo-print-buffer-name)
(message "Type C-x 1 to remove %s window. M-C-v to scroll the help."
todo-print-buffer-name)))
(defun todo-save-top-priorities (&optional nof-priorities)
"Save top priorities for each category in `todo-file-top'.
Number of entries for each category is given by NOF-PRIORITIES which
defaults to `todo-show-priorities'."
(interactive "P")
(save-window-excursion
(save-excursion
(save-restriction
(todo-top-priorities nof-priorities)
(set-buffer todo-tmp-buffer-name)
(write-file todo-file-top)
(kill-this-buffer)))))
;;;###autoload
(defun todo-print (&optional category-pr-page)
"Print todo summary using `todo-print-function'.
If CATEGORY-PR-PAGE is non-nil, a page separator `^L' is inserted
between each category.
Number of entries for each category is given by `todo-print-priorities'."
(interactive "P")
(save-window-excursion
(save-excursion
(save-restriction
(todo-top-priorities todo-print-priorities
category-pr-page)
(set-buffer todo-tmp-buffer-name)
(and (funcall todo-print-function)
(kill-this-buffer))
(message "Todo printing done.")))))
(defun todo-jump-to-category ()
"Jump to a category. Default is previous category."
(interactive)
(let* ((categories todo-categories)
(history (cons 'categories (1+ todo-category-number)))
(default (nth todo-category-number todo-categories))
(category (completing-read
(concat "Category [" default "]: ")
(todo-category-alist) nil nil nil history default)))
(if (string= "" category)
(setq category (nth todo-category-number todo-categories)))
(setq todo-category-number
(if (member category todo-categories)
(- (length todo-categories)
(length (member category todo-categories)))
(todo-add-category category)))
(todo-show)))
(defun todo-line-string ()
"Return current line in buffer as a string."
(buffer-substring (line-beginning-position) (line-end-position)))
(defun todo-item-string-start ()
"Return the start of this TODO list entry as a string."
;; Suitable for putting in the minibuffer when asking the user
(let ((item (todo-item-string)))
(if (> (length item) 60)
(setq item (concat (substring item 0 56) "...")))
item))
(defun todo-item-start ()
"Return point at start of current TODO list item."
(save-excursion
(beginning-of-line)
(if (not (looking-at (regexp-quote todo-prefix)))
(search-backward-regexp
(concat "^" (regexp-quote todo-prefix)) nil t))
(point)))
(defun todo-item-end ()
"Return point at end of current TODO list item."
(save-excursion
(end-of-line)
(search-forward-regexp
(concat "^" (regexp-quote todo-prefix)) nil 'goto-end)
(1- (line-beginning-position))))
(defun todo-remove-item ()
"Delete the current entry from the TODO list."
(delete-region (todo-item-start) (1+ (todo-item-end))))
(defun todo-item-string ()
"Return current TODO list entry as a string."
(buffer-substring (todo-item-start) (todo-item-end)))
(defun todo-string-count-lines (string)
"Return the number of lines STRING spans."
(length (split-string string "\n")))
(defun todo-string-multiline-p (string)
"Return non-nil if STRING spans several lines."
(> (todo-string-count-lines string) 1))
(defun todo-category-alist ()
"Generate an alist for use in `completing-read' from
`todo-categories'."
(mapcar #'list todo-categories))
;; ---------------------------------------------------------------------------
(easy-menu-define todo-menu todo-mode-map "Todo Menu"
'("Todo"
["Next category" todo-forward-category t]
["Previous category" todo-backward-category t]
["Jump to category" todo-jump-to-category t]
["Show top priority items" todo-top-priorities t]
["Print categories" todo-print t]
"---"
["Edit item" todo-edit-item t]
["File item" todo-file-item t]
["Insert new item" todo-insert-item t]
["Insert item here" todo-insert-item-here t]
["Kill item" todo-delete-item t]
"---"
["Lower item priority" todo-lower-item t]
["Raise item priority" todo-raise-item t]
"---"
["Next item" todo-forward-item t]
["Previous item" todo-backward-item t]
"---"
["Save" todo-save t]
["Save Top Priorities" todo-save-top-priorities t]
"---"
["Quit" todo-quit t]
))
;; As calendar reads .todo-do before todo-mode is loaded.
;;;###autoload
(defun todo-mode ()
"Major mode for editing TODO lists.
\\{todo-mode-map}"
(interactive)
(setq major-mode 'todo-mode)
(setq mode-name "TODO")
(use-local-map todo-mode-map)
(easy-menu-add todo-menu)
(run-hooks 'todo-mode-hook))
(eval-when-compile
(defvar date)
(defvar entry))
;; Read about this function in the setup instructions above!
;;;###autoload
(defun todo-cp ()
"Make a diary entry appear only in the current date's diary."
(if (equal (calendar-current-date) date)
entry))
(define-derived-mode todo-edit-mode text-mode "TODO Edit"
"Major mode for editing items in the TODO list.
\\{todo-edit-mode-map}")
;;;###autoload
(defun todo-show ()
"Show TODO list."
(interactive)
(if (file-exists-p todo-file-do)
(find-file todo-file-do)
(todo-initial-setup))
(if (null todo-categories)
(if (null todo-cats)
(error "Error in %s: No categories in list `todo-categories'"
todo-file-do)
(goto-char (point-min))
(and (search-forward "todo-cats:" nil t)
(replace-match "todo-categories:"))
(make-local-variable 'todo-categories)
(setq todo-categories todo-cats)))
(beginning-of-line)
(todo-category-select))
(defun todo-initial-setup ()
"Set up things to work properly in TODO mode."
(find-file todo-file-do)
(erase-buffer)
(todo-mode)
(todo-add-category "Todo"))
(provide 'todo-mode)
;;; todo-mode.el ends here
;;; timeclock.el --- mode for keeping track of how much you work
;; Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
;; Author: John Wiegley <johnw(a)gnu.org>
;; Created: 25 Mar 1999
;; Version: 2.6
;; Keywords: calendar data
;; This file is part of XEmacs.
;; XEmacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; XEmacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with XEmacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Commentary:
;; This mode is for keeping track of time intervals. You can use it
;; for whatever purpose you like, but the typical scenario is to keep
;; track of how much time you spend working on certain projects.
;;
;; Use `timeclock-in' when you start on a project, and `timeclock-out'
;; when you're done. Once you've collected some data, you can use
;; `timeclock-workday-remaining' to see how much time is left to be
;; worked today (assuming a typical average of 8 hours a day), and
;; `timeclock-when-to-leave' which will calculate when you're free.
;; You'll probably want to bind the timeclock commands to some handy
;; keystrokes. At the moment, C-x t is unused in Emacs 20:
;;
;; (require 'timeclock)
;;
;; (define-key ctl-x-map "ti" 'timeclock-in)
;; (define-key ctl-x-map "to" 'timeclock-out)
;; (define-key ctl-x-map "tc" 'timeclock-change)
;; (define-key ctl-x-map "tr" 'timeclock-reread-log)
;; (define-key ctl-x-map "tu" 'timeclock-update-modeline)
;; (define-key ctl-x-map "tw" 'timeclock-when-to-leave-string)
;; If you want XEmacs to display the amount of time "left" to your
;; workday in the modeline, you can either set the value of
;; `timeclock-modeline-display' to t using M-x customize, or you
;; can add this code to your .emacs file:
;;
;; (require 'timeclock)
;; (timeclock-modeline-display)
;;
;; To cancel this modeline display at any time, just call
;; `timeclock-modeline-display' again.
;; You may also want XEmacs to ask you before exiting, if you are
;; current working on a project. This can be done either by setting
;; `timeclock-ask-before-exiting' to t using M-x customize (this is
;; the default), or by adding the following to your .emacs file:
;;
;; (add-hook 'kill-emacs-hook 'timeclock-query-out)
;; NOTE: If you change your .timelog file without using timeclock's
;; functions, or if you change the value of any of timeclock's
;; customizable variables, you should run the command
;; `timeclock-reread-log'. This will recompute any discrepancies in
;; your average working time, and will make sure that the various
;; display functions return the correct value.
;;; History:
;;; Code:
(require 'timer)
(defgroup timeclock nil
"Keeping track time of the time that gets spent."
:group 'data)
;;; User Variables:
(defcustom timeclock-file (convert-standard-filename "~/.timelog")
"*The file used to store timeclock data in."
:type 'file
:group 'timeclock)
(defcustom timeclock-workday (* 8 60 60)
"*The length of a work period."
:type 'integer
:group 'timeclock)
(defcustom timeclock-relative t
"*When reporting time, make it relative to `timeclock-workday'?
For example, if the length of a normal workday is eight hours, and you
work four hours on Monday, then the amount of time \"remaining\" on
Tuesday is twelve hours -- relative to an averaged work period of
eight hours -- or eight hours, non-relative. So relative time takes
into account any discrepancy of time under-worked or overworked on
previous days."
:type 'boolean
:group 'timeclock)
(defcustom timeclock-get-project-function 'timeclock-ask-for-project
"*The function used to determine the name of the current project.
When clocking in, and no project is specified, this function will be
called to determine what the current project to be worked on is.
If this variable is nil, no questions will be asked."
:type 'function
:group 'timeclock)
(defcustom timeclock-get-reason-function 'timeclock-ask-for-reason
"*A function used to determine the reason for clocking out.
When clocking out, and no reason is specified, this function will be
called to determine what the reason is.
If this variable is nil, no questions will be asked."
:type 'function
:group 'timeclock)
(defcustom timeclock-get-workday-function nil
"*A function used to determine the length of today's workday.
The first time that a user clocks in each day, this function will be
called to determine what the length of the current workday is. If
the return value is nil, or equal to `timeclock-workday', nothing special
will be done. If it is a quantity different from `timeclock-workday',
however, a record will be output to the timelog file to note the fact that
that day has a different length from the norm."
:type '(choice (const nil) function)
:group 'timeclock)
(defcustom timeclock-ask-before-exiting t
"*If non-nil, ask if the user wants to clock out before exiting Emacs."
:set (lambda (symbol value)
(if value
(add-hook 'kill-emacs-hook 'timeclock-query-out)
(remove-hook 'kill-emacs-hook 'timeclock-query-out))
(setq timeclock-ask-before-exiting value))
:type 'boolean
:group 'timeclock)
(defvar timeclock-update-timer nil
"The timer used to update `timeclock-mode-string'.")
(defcustom timeclock-use-display-time t
"*If non-nil, use `display-time-hook' for doing modeline updates.
The advantage to this is that it means one less timer has to be set
running amok in Emacs' process space. The disadvantage is that it
requires you to have `display-time' running. If you don't want to use
`display-time', but still want the modeline to show how much time is
left, set this variable to nil. You will need to restart Emacs (or
toggle the value of `timeclock-modeline-display') for the change to
take effect."
:set (lambda (symbol value)
(let ((currently-displaying
(and (boundp 'timeclock-modeline-display)
timeclock-modeline-display)))
;; if we're changing to the state that
;; `timeclock-modeline-display' is already using, don't
;; bother toggling it. This happens on the initial loading
;; of timeclock.el.
(if (and currently-displaying
(or (and value
(boundp 'display-time-hook)
(memq 'timeclock-update-modeline
display-time-hook))
(and (not value)
timeclock-update-timer)))
(setq currently-displaying nil))
(and currently-displaying
(set-variable 'timeclock-modeline-display nil))
(setq timeclock-use-display-time value)
(and currently-displaying
(set-variable 'timeclock-modeline-display t))
timeclock-use-display-time))
:type 'boolean
:group 'timeclock
:require 'time)
(defcustom timeclock-first-in-hook nil
"*A hook run for the first \"in\" event each day.
Note that this hook is run before recording any events. Thus the
value of `timeclock-hours-today', `timeclock-last-event' and the
return value of function `timeclock-last-period' are relative previous
to today."
:type 'hook
:group 'timeclock)
(defcustom timeclock-load-hook nil
"*Hook that gets run after timeclock has been loaded."
:type 'hook
:group 'timeclock)
(defcustom timeclock-in-hook nil
"*A hook run every time an \"in\" event is recorded."
:type 'hook
:group 'timeclock)
(defcustom timeclock-day-over-hook nil
"*A hook that is run when the workday has been completed.
This hook is only run if the current time remaining is being display
in the modeline. See the variable `timeclock-modeline-display'."
:type 'hook
:group 'timeclock)
(defcustom timeclock-out-hook nil
"*A hook run every time an \"out\" event is recorded."
:type 'hook
:group 'timeclock)
(defcustom timeclock-done-hook nil
"*A hook run every time a project is marked as completed."
:type 'hook
:group 'timeclock)
(defcustom timeclock-event-hook nil
"*A hook run every time any event is recorded."
:type 'hook
:group 'timeclock)
(defvar timeclock-last-event nil
"A list containing the last event that was recorded.
The format of this list is (CODE TIME PROJECT).")
(defvar timeclock-last-event-workday nil
"The number of seconds in the workday of `timeclock-last-event'.")
;;; Internal Variables:
(defvar timeclock-discrepancy nil
"A variable containing the time discrepancy before the last event.
Normally, timeclock assumes that you intend to work for
`timeclock-workday' seconds every day. Any days in which you work
more or less than this amount is considered either a positive or
negative discrepancy. If you work in such a manner that the
discrepancy is always brought back to zero, then you will by
definition have worked an average amount equal to `timeclock-workday'
each day.")
(defvar timeclock-elapsed nil
"A variable containing the time elapsed for complete periods today.
This value is not accurate enough to be useful by itself. Rather,
call `timeclock-workday-elapsed', to determine how much time has been
worked so far today. Also, if `timeclock-relative' is nil, this value
will be the same as `timeclock-discrepancy'.")
(defvar timeclock-last-period nil
"Integer representing the number of seconds in the last period.
Note that you shouldn't access this value, but should use the function
`timeclock-last-period' instead.")
(defvar timeclock-mode-string nil
"The timeclock string (optionally) displayed in the modeline.")
(defvar timeclock-day-over nil
"The date of the last day when notified \"day over\" for.")
;;; User Functions:
;;;###autoload
(defun timeclock-modeline-display (&optional arg)
"Toggle display of the amount of time left today in the modeline.
If `timeclock-use-display-time' is non-nil, the modeline will be
updated whenever the time display is updated. Otherwise, the
timeclock will use its own sixty second timer to do its updating.
With prefix ARG, turn modeline display on if and only if ARG is
positive. Returns the new status of timeclock modeline display
\(non-nil means on)."
(interactive "P")
(let ((on-p (if arg
(> (prefix-numeric-value arg) 0)
(not timeclock-modeline-display))))
(if on-p
(let ((list-entry (memq 'global-mode-string
mode-line-format)))
(unless (or (null list-entry)
(memq 'timeclock-mode-string mode-line-format))
(setcdr list-entry
(cons 'timeclock-mode-string
(cdr list-entry))))
(unless (memq 'timeclock-update-modeline timeclock-event-hook)
(add-hook 'timeclock-event-hook 'timeclock-update-modeline))
(when timeclock-update-timer
(cancel-timer timeclock-update-timer)
(setq timeclock-update-timer nil))
(if (boundp 'display-time-hook)
(remove-hook 'display-time-hook 'timeclock-update-modeline))
(if timeclock-use-display-time
(add-hook 'display-time-hook 'timeclock-update-modeline)
(setq timeclock-update-timer
(run-at-time nil 60 'timeclock-update-modeline))))
(setq mode-line-format
(delq 'timeclock-mode-string mode-line-format))
(remove-hook 'timeclock-event-hook 'timeclock-update-modeline)
(if (boundp 'display-time-hook)
(remove-hook 'display-time-hook
'timeclock-update-modeline))
(when timeclock-update-timer
(cancel-timer timeclock-update-timer)
(setq timeclock-update-timer nil)))
(force-mode-line-update)
on-p))
;; This has to be here so that the function definition of
;; `timeclock-modeline-display' is known to the "set" function.
(defcustom timeclock-modeline-display nil
"Toggle modeline display of time remaining.
You must modify via \\[customize] for this variable to have an effect."
:set (lambda (symbol value)
(setq timeclock-modeline-display
(timeclock-modeline-display (or value 0))))
:type 'boolean
:group 'timeclock
:require 'timeclock)
;;;###autoload
(defun timeclock-in (&optional arg project find-project)
"Clock in, recording the current time moment in the timelog.
With a numeric prefix ARG, record the fact that today has only that
many hours in it to be worked. If arg is a non-numeric prefix arg
\(non-nil, but not a number), 0 is assumed (working on a holiday or
weekend). *If not called interactively, ARG should be the number of
_seconds_ worked today*. This feature only has effect the first time
this function is called within a day.
PROJECT as the project being clocked into. If PROJECT is nil, and
FIND-PROJECT is non-nil -- or the user calls `timeclock-in'
interactively -- call the function `timeclock-get-project-function' to
discover the name of the project."
(interactive
(list (and current-prefix-arg
(if (numberp current-prefix-arg)
(* current-prefix-arg 60 60)
0))))
(if (equal (car timeclock-last-event) "i")
(error "You've already clocked in!")
(unless timeclock-last-event
(timeclock-reread-log))
(unless (equal (timeclock-time-to-date
(cadr timeclock-last-event))
(timeclock-time-to-date (current-time)))
(let ((workday (or (and (numberp arg) arg)
(and arg 0)
(and timeclock-get-workday-function
(funcall timeclock-get-workday-function))
timeclock-workday)))
(run-hooks 'timeclock-first-in-hook)
;; settle the discrepancy for the new day
(setq timeclock-discrepancy
(- timeclock-discrepancy workday))
(if (not (= workday timeclock-workday))
(timeclock-log "h" (and (numberp arg)
(number-to-string arg))))))
(timeclock-log "i" (or project
(and timeclock-get-project-function
(or find-project (interactive-p))
(funcall timeclock-get-project-function))))
(run-hooks 'timeclock-in-hook)))
;;;###autoload
(defun timeclock-out (&optional arg reason find-reason)
"Clock out, recording the current time moment in the timelog.
If a prefix ARG is given, the user has completed the project that was
begun during the last time segment.
REASON is the user's reason for clocking out. If REASON is nil, and
FIND-REASON is non-nil -- or the user calls `timeclock-out'
interactively -- call the function `timeclock-get-reason-function' to
discover the reason."
(interactive "P")
(or timeclock-last-event
(error "You haven't clocked in!"))
(if (equal (downcase (car timeclock-last-event)) "o")
(error "You've already clocked out!")
(timeclock-log
(if arg "O" "o")
(or reason
(and timeclock-get-reason-function
(or find-reason (interactive-p))
(funcall timeclock-get-reason-function))))
(run-hooks 'timeclock-out-hook)
(if arg
(run-hooks 'timeclock-done-hook))))
;;;###autoload
(defun timeclock-status-string (&optional show-seconds today-only)
"Report the overall timeclock status at the present moment."
(interactive "P")
(let* ((remainder (timeclock-workday-remaining))
(last-in (equal (car timeclock-last-event) "i"))
status)
(setq status
(format "Currently %s since %s (%s), %s %s, leave at %s"
(if last-in "IN" "OUT")
(if show-seconds
(format-time-string "%-I:%M:%S %p"
(nth 1 timeclock-last-event))
(format-time-string "%-I:%M %p"
(nth 1 timeclock-last-event)))
(or (nth 2 timeclock-last-event)
(if last-in "**UNKNOWN**" "workday over"))
(timeclock-seconds-to-string remainder show-seconds t)
(if (> remainder 0)
"remaining" "over")
(timeclock-when-to-leave-string show-seconds today-only)))
(if (interactive-p)
(message status)
status)))
;;;###autoload
(defun timeclock-change (&optional arg project)
"Change to working on a different project, by clocking in then out.
With a prefix ARG, consider the previous project as having been
finished at the time of changeover. PROJECT is the name of the last
project you were working on."
(interactive "P")
(timeclock-out arg)
(timeclock-in nil project (interactive-p)))
;;;###autoload
(defun timeclock-query-out ()
"Ask the user before clocking out.
This is a useful function for adding to `kill-emacs-hook'."
(if (and (equal (car timeclock-last-event) "i")
(y-or-n-p "You're currently clocking time, clock out? "))
(timeclock-out)))
;;;###autoload
(defun timeclock-reread-log ()
"Re-read the timeclock, to account for external changes.
Returns the new value of `timeclock-discrepancy'."
(interactive)
(setq timeclock-discrepancy nil)
(timeclock-find-discrep)
(if (and timeclock-discrepancy timeclock-modeline-display)
(timeclock-update-modeline))
timeclock-discrepancy)
(defun timeclock-seconds-to-string (seconds &optional show-seconds
reverse-leader)
"Convert SECONDS into a compact time string.
If SHOW-SECONDS is non-nil, make the resolution of the return string
include the second count. If REVERSE-LEADER is non-nil, it means to
output a \"+\" if the time value is negative, rather than a \"-\".
This is used when negative time values have an inverted meaning (such
as with time remaining, where negative time really means overtime)."
(if show-seconds
(format "%s%d:%02d:%02d"
(if (< seconds 0) (if reverse-leader "+" "-") "")
(truncate (/ (abs seconds) 60 60))
(% (truncate (/ (abs seconds) 60)) 60)
(% (truncate (abs seconds)) 60))
(format "%s%d:%02d"
(if (< seconds 0) (if reverse-leader "+" "-") "")
(truncate (/ (abs seconds) 60 60))
(% (truncate (/ (abs seconds) 60)) 60))))
(defsubst timeclock-workday-remaining (&optional today-only)
"Return the number of seconds until the workday is complete.
The amount returned is relative to the value of `timeclock-workday'.
If TODAY-ONLY is non-nil, the value returned will be relative only to
the time worked today, and not to past time. This argument only makes
a difference if `timeclock-relative' is non-nil."
(let ((discrep (timeclock-find-discrep)))
(if discrep
(if today-only
(- (cadr discrep))
(- (car discrep)))
0.0)))
(defsubst timeclock-currently-in-p ()
"Return non-nil if the user is currently clocked in."
(equal (car timeclock-last-event) "i"))
;;;###autoload
(defun timeclock-workday-remaining-string (&optional show-seconds
today-only)
"Return a string representing the amount of time left today.
Display second resolution if SHOW-SECONDS is non-nil. If TODAY-ONLY
is non-nil, the display will be relative only to time worked today.
See `timeclock-relative' for more information about the meaning of
\"relative to today\"."
(interactive)
(let ((string (timeclock-seconds-to-string
(timeclock-workday-remaining today-only)
show-seconds t)))
(if (interactive-p)
(message string)
string)))
(defsubst timeclock-workday-elapsed ()
"Return the number of seconds worked so far today.
If RELATIVE is non-nil, the amount returned will be relative to past
time worked. The default is to return only the time that has elapsed
so far today."
(let ((discrep (timeclock-find-discrep)))
(if discrep
(nth 2 discrep)
0.0)))
;;;###autoload
(defun timeclock-workday-elapsed-string (&optional show-seconds)
"Return a string representing the amount of time worked today.
Display seconds resolution if SHOW-SECONDS is non-nil. If RELATIVE is
non-nil, the amount returned will be relative to past time worked."
(interactive)
(let ((string (timeclock-seconds-to-string (timeclock-workday-elapsed)
show-seconds)))
(if (interactive-p)
(message string)
string)))
(defsubst timeclock-when-to-leave (&optional today-only)
"Return a time value representing at when the workday ends today.
If TODAY-ONLY is non-nil, the value returned will be relative only to
the time worked today, and not to past time. This argument only makes
a difference if `timeclock-relative' is non-nil."
(timeclock-seconds-to-time
(- (timeclock-time-to-seconds (current-time))
(let ((discrep (timeclock-find-discrep)))
(if discrep
(if today-only
(cadr discrep)
(car discrep))
0.0)))))
;;;###autoload
(defun timeclock-when-to-leave-string (&optional show-seconds
today-only)
"Return a string representing at what time the workday ends today.
This string is relative to the value of `timeclock-workday'. If
NO-MESSAGE is non-nil, no messages will be displayed in the
minibuffer. If SHOW-SECONDS is non-nil, the value printed/returned
will include seconds. If TODAY-ONLY is non-nil, the value returned
will be relative only to the time worked today, and not to past time.
This argument only makes a difference if `timeclock-relative' is
non-nil."
(interactive)
(let* ((then (timeclock-when-to-leave today-only))
(string
(if show-seconds
(format-time-string "%-I:%M:%S %p" then)
(format-time-string "%-I:%M %p" then))))
(if (interactive-p)
(message string)
string)))
;;; Internal Functions:
(defvar timeclock-project-list nil)
(defvar timeclock-last-project nil)
(defun timeclock-completing-read (prompt alist &optional default)
"A version of `completing-read' that works on both Emacs and XEmacs."
(if (featurep 'xemacs)
(let ((str (completing-read prompt alist)))
(if (or (null str) (= (length str) 0))
default
str))
(completing-read prompt alist nil nil nil nil default)))
(defun timeclock-ask-for-project ()
"Ask the user for the project they are clocking into."
(timeclock-completing-read
(format "Clock into which project (default \"%s\"): "
(or timeclock-last-project
(car timeclock-project-list)))
(mapcar 'list timeclock-project-list)
(or timeclock-last-project
(car timeclock-project-list))))
(defvar timeclock-reason-list nil)
(defun timeclock-ask-for-reason ()
"Ask the user for the reason they are clocking out."
(timeclock-completing-read "Reason for clocking out: "
(mapcar 'list timeclock-reason-list)))
(defun timeclock-update-modeline ()
"Update the `timeclock-mode-string' displayed in the modeline."
(interactive)
(let* ((remainder (timeclock-workday-remaining))
(last-in (equal (car timeclock-last-event) "i")))
(when (and (< remainder 0)
(not (and timeclock-day-over
(equal timeclock-day-over
(timeclock-time-to-date
(current-time))))))
(setq timeclock-day-over
(timeclock-time-to-date (current-time)))
(run-hooks 'timeclock-day-over-hook))
(setq timeclock-mode-string
(format " %c%s%c"
(if last-in ?< ?[)
(timeclock-seconds-to-string remainder nil t)
(if last-in ?> ?])))))
(defun timeclock-log (code &optional project)
"Log the event CODE to the timeclock log, at the time of call.
If PROJECT is a string, it represents the project which the event is
being logged for. Normally only \"in\" events specify a project."
(with-current-buffer (find-file-noselect timeclock-file)
(goto-char (point-max))
(if (not (bolp))
(insert "\n"))
(let ((now (current-time)))
(insert code " "
(format-time-string "%Y/%m/%d %H:%M:%S" now)
(or (and project
(stringp project)
(> (length project) 0)
(concat " " project))
"")
"\n")
(if (equal (downcase code) "o")
(setq timeclock-last-period
(- (timeclock-time-to-seconds now)
(timeclock-time-to-seconds
(cadr timeclock-last-event)))
timeclock-discrepancy
(+ timeclock-discrepancy
timeclock-last-period)))
(setq timeclock-last-event (list code now project)))
(save-buffer)
(run-hooks 'timeclock-event-hook)
(kill-buffer (current-buffer))))
(defvar timeclock-moment-regexp
(concat "\\([bhioO]\\)\\s-+"
"\\([0-9]+\\)/\\([0-9]+\\)/\\([0-9]+\\)\\s-+"
"\\([0-9]+\\):\\([0-9]+\\):\\([0-9]+\\)[ \t]*" "\\([^\n]*\\)"))
(defsubst timeclock-read-moment ()
"Read the moment under point from the timelog."
(if (looking-at timeclock-moment-regexp)
(let ((code (match-string 1))
(year (string-to-number (match-string 2)))
(mon (string-to-number (match-string 3)))
(mday (string-to-number (match-string 4)))
(hour (string-to-number (match-string 5)))
(min (string-to-number (match-string 6)))
(sec (string-to-number (match-string 7)))
(project (match-string 8)))
(list code (encode-time sec min hour mday mon year) project))))
(defsubst timeclock-time-to-seconds (time)
"Convert TIME to a floating point number."
(+ (* (car time) 65536.0)
(cadr time)
(/ (or (car (cdr (cdr time))) 0) 1000000.0)))
(defsubst timeclock-seconds-to-time (seconds)
"Convert SECONDS (a floating point number) to an Emacs time structure."
(list (floor seconds 65536)
(floor (mod seconds 65536))
(floor (* (- seconds (ffloor seconds)) 1000000))))
(defsubst timeclock-time-to-date (time)
"Convert the TIME value to a textual date string."
(format-time-string "%Y/%m/%d" time))
(defun timeclock-last-period (&optional moment)
"Return the value of the last event period.
If the last event was a clock-in, the period will be open ended, and
growing every second. Otherwise, it is a fixed amount which has been
recorded to disk. If MOMENT is non-nil, use that as the current time.
This is only provided for coherency when used by
`timeclock-discrepancy'."
(if (equal (car timeclock-last-event) "i")
(- (timeclock-time-to-seconds (or moment (current-time)))
(timeclock-time-to-seconds
(cadr timeclock-last-event)))
timeclock-last-period))
(defsubst timeclock-entry-length (entry)
(- (timeclock-time-to-seconds (cadr entry))
(timeclock-time-to-seconds (car entry))))
(defsubst timeclock-entry-begin (entry)
(car entry))
(defsubst timeclock-entry-end (entry)
(cadr entry))
(defsubst timeclock-entry-project (entry)
(nth 2 entry))
(defsubst timeclock-entry-comment (entry)
(nth 3 entry))
(defsubst timeclock-entry-list-length (entry-list)
(let ((length 0))
(while entry-list
(setq length (+ length (timeclock-entry-length (car entry-list))))
(setq entry-list (cdr entry-list)))
length))
(defsubst timeclock-entry-list-begin (entry-list)
(timeclock-entry-begin (car entry-list)))
(defsubst timeclock-entry-list-end (entry-list)
(timeclock-entry-end (car (last entry-list))))
(defsubst timeclock-entry-list-span (entry-list)
(- (timeclock-time-to-seconds (timeclock-entry-list-end entry-list))
(timeclock-time-to-seconds (timeclock-entry-list-begin entry-list))))
(defsubst timeclock-entry-list-break (entry-list)
(- (timeclock-entry-list-span entry-list)
(timeclock-entry-list-length entry-list)))
(defsubst timeclock-entry-list-projects (entry-list)
(let (projects)
(while entry-list
(let ((project (timeclock-entry-project (car entry-list))))
(if projects
(add-to-list 'projects project)
(setq projects (list project))))
(setq entry-list (cdr entry-list)))
projects))
(defsubst timeclock-day-required (day)
(or (car day) timeclock-workday))
(defsubst timeclock-day-length (day)
(timeclock-entry-list-length (cdr day)))
(defsubst timeclock-day-debt (day)
(- (timeclock-day-required day)
(timeclock-day-length day)))
(defsubst timeclock-day-begin (day)
(timeclock-entry-list-begin (cdr day)))
(defsubst timeclock-day-end (day)
(timeclock-entry-list-end (cdr day)))
(defsubst timeclock-day-span (day)
(timeclock-entry-list-span (cdr day)))
(defsubst timeclock-day-break (day)
(timeclock-entry-list-break (cdr day)))
(defsubst timeclock-day-projects (day)
(timeclock-entry-list-projects (cdr day)))
(defmacro timeclock-day-list-template (func)
`(let ((length 0))
(while day-list
(setq length (+ length (,(eval func) (car day-list))))
(setq day-list (cdr day-list)))
length))
(defun timeclock-day-list-required (day-list)
(timeclock-day-list-template 'timeclock-day-required))
(defun timeclock-day-list-length (day-list)
(timeclock-day-list-template 'timeclock-day-length))
(defun timeclock-day-list-debt (day-list)
(timeclock-day-list-template 'timeclock-day-debt))
(defsubst timeclock-day-list-begin (day-list)
(timeclock-day-begin (car day-list)))
(defsubst timeclock-day-list-end (day-list)
(timeclock-day-end (car (last day-list))))
(defun timeclock-day-list-span (day-list)
(timeclock-day-list-template 'timeclock-day-span))
(defun timeclock-day-list-break (day-list)
(timeclock-day-list-template 'timeclock-day-break))
(defun timeclock-day-list-projects (day-list)
(let (projects)
(while day-list
(let ((projs (timeclock-day-projects (car day-list))))
(while projs
(if projects
(add-to-list 'projects (car projs))
(setq projects (list (car projs))))
(setq projs (cdr projs))))
(setq day-list (cdr day-list)))
projects))
(defsubst timeclock-current-debt (&optional log-data)
(nth 0 (or log-data (timeclock-log-data))))
(defsubst timeclock-day-alist (&optional log-data)
(nth 1 (or log-data (timeclock-log-data))))
(defun timeclock-day-list (&optional log-data)
(let ((alist (timeclock-day-alist log-data))
day-list)
(while alist
(setq day-list (cons (cdar alist) day-list)
alist (cdr alist)))
day-list))
(defsubst timeclock-project-alist (&optional log-data)
(nth 2 (or log-data (timeclock-log-data))))
(defun timeclock-log-data (&optional recent-only filename)
"Return the contents of the timelog file, in a useful format.
A timelog contains data in the form of a single entry per line.
Each entry has the form:
CODE YYYY/MM/DD HH:MM:SS [COMMENT]
CODE is one of: b, h, i, o or O. COMMENT is optional when the code is
i, o or O. The meanings of the codes are:
b Set the current time balance, or \"time debt\". Useful when
archiving old log data, when a debt must be carried forward.
The COMMENT here is the number of seconds of debt.
h Set the required working time for the given day. This must
be the first entry for that day. The COMMENT in this case is
the number of hours that must be worked. Floating point
amounts are allowed.
i Clock in. The COMMENT in this case should be the name of the
project worked on.
o Clock out. COMMENT is unnecessary, but can be used to provide
a description of how the period went, for example.
O Final clock out. Whatever project was being worked on, it is
now finished. Useful for creating summary reports.
When this function is called, it will return a data structure with the
following format:
(DEBT ENTRIES-BY-DAY ENTRIES-BY-PROJECT)
DEBT is a floating point number representing the number of seconds
\"owed\" before any work was done. For a new file (one without a 'b'
entry), this is always zero.
The two entries lists have similar formats. They are both alists,
where the CAR is the index, and the CDR is a list of time entries.
For ENTRIES-BY-DAY, the CAR is a textual date string, of the form
YYYY/MM/DD. For ENTRIES-BY-PROJECT, it is the name of the project
worked on, or t for the default project.
The CDR for ENTRIES-BY-DAY is slightly different than for
ENTRIES-BY-PROJECT. It has the following form:
(DAY-LENGTH TIME-ENTRIES...)
For ENTRIES-BY-PROJECT, there is no DAY-LENGTH member. It is simply a
list of TIME-ENTRIES. Note that if DAY-LENGTH is nil, it means
whatever is the default should be used.
A TIME-ENTRY is a recorded time interval. It has the following format
\(although generally one does not have to manipulate these entries
directly; see below):
(BEGIN-TIME END-TIME PROJECT [COMMENT] [FINAL-P])
Anyway, suffice it to say there are a lot of structures. Typically
the user is expected to manipulate to the day(s) or project(s) that he
or she wants, at which point the following helper functions may be
used:
timeclock-day-required
timeclock-day-length
timeclock-day-debt
timeclock-day-begin
timeclock-day-end
timeclock-day-span
timeclock-day-break
timeclock-day-projects
timeclock-day-list-required
timeclock-day-list-length
timeclock-day-list-debt
timeclock-day-list-begin
timeclock-day-list-end
timeclock-day-list-span
timeclock-day-list-break
timeclock-day-list-projects
timeclock-entry-length
timeclock-entry-begin
timeclock-entry-end
timeclock-entry-project
timeclock-entry-comment
timeclock-entry-list-length
timeclock-entry-list-begin
timeclock-entry-list-end
timeclock-entry-list-span
timeclock-entry-list-break
timeclock-entry-list-projects
A few comments should make the use of the above functions obvious:
`required' is the amount of time that must be spent during a day, or
sequence of days, in order to have no debt.
`length' is the actual amount of time that was spent.
`debt' is the difference between required time and length. A
negative debt signifies overtime.
`begin' is the earliest moment at which work began.
`end' is the final moment work was done.
`span' is the difference between begin and end.
`break' is the difference between span and length.
`project' is the project that was worked on, and `projects' is a
list of all the projects that were worked on during a given period.
`comment', where it applies, could mean anything.
There are a few more functions available, for locating day and entry
lists:
timeclock-day-alist LOG-DATA
timeclock-project-alist LOG-DATA
timeclock-current-debt LOG-DATA
See the documentation for the given function if more info is needed."
(let* ((log-data (list 0.0 nil nil))
(now (current-time))
(todays-date (timeclock-time-to-date now))
last-date-limited last-date-seconds last-date
(line 0) last beg day entry event)
(with-temp-buffer
(insert-file-contents (or filename timeclock-file))
(when recent-only
(goto-char (point-max))
(unless (re-search-backward "^b\\s-+" nil t)
(goto-char (point-min))))
(while (or (setq event (timeclock-read-moment))
(and beg (not last)
(setq last t event (list "o" now))))
(setq line (1+ line))
(cond ((equal (car event) "b")
(setcar log-data (string-to-number (nth 2 event))))
((equal (car event) "h")
(setq last-date-limited (timeclock-time-to-date (cadr event))
last-date-seconds (* (string-to-number (nth 2 event))
3600.0)))
((equal (car event) "i")
(if beg
(error "Error in format of timelog file, line %d" line)
(setq beg t))
(setq entry (list (cadr event) nil
(and (> (length (nth 2 event)) 0)
(nth 2 event))))
(let ((date (timeclock-time-to-date (cadr event))))
(if (and last-date
(not (equal date last-date)))
(progn
(setcar (cdr log-data)
(cons (cons last-date day)
(cadr log-data)))
(setq day (list (and last-date-limited
last-date-seconds))))
(unless day
(setq day (list (and last-date-limited
last-date-seconds)))))
(setq last-date date
last-date-limited nil)))
((equal (downcase (car event)) "o")
(if (not beg)
(error "Error in format of timelog file, line %d" line)
(setq beg nil))
(setcar (cdr entry) (cadr event))
(let ((desc (and (> (length (nth 2 event)) 0)
(nth 2 event))))
(if desc
(nconc entry (list (nth 2 event))))
(if (equal (car event) "O")
(nconc entry (if desc
(list t)
(list nil t))))
(nconc day (list entry))
(setq desc (nth 2 entry))
(let ((proj (assoc desc (nth 2 log-data))))
(if (null proj)
(setcar (cddr log-data)
(cons (cons desc (list entry))
(car (cddr log-data))))
(nconc (cdr proj) (list entry)))))))
(forward-line))
(if day
(setcar (cdr log-data)
(cons (cons last-date day)
(cadr log-data))))
log-data)))
(defun timeclock-find-discrep ()
"Find overall discrepancy from `timeclock-workday' (in seconds)."
;; This is not implemented in terms of the functions above, because
;; it's a bit wasteful to read all of that data in, just to throw
;; away more than 90% of the information afterwards.
;;
;; If it were implemented using those functions, it would look
;; something like this:
;; (let ((days (timeclock-day-alist (timeclock-log-data)))
;; (total 0.0))
;; (while days
;; (setq total (+ total (- (timeclock-day-length (cdar days))
;; (timeclock-day-required (cdar days))))
;; days (cdr days)))
;; total)
(let* ((now (current-time))
(todays-date (timeclock-time-to-date now))
(first t) (accum 0) (elapsed 0)
event beg last-date avg
last-date-limited last-date-seconds)
(unless timeclock-discrepancy
(when (file-readable-p timeclock-file)
(setq timeclock-project-list nil
timeclock-last-project nil
timeclock-reason-list nil
timeclock-elapsed 0)
(with-temp-buffer
(insert-file-contents timeclock-file)
(goto-char (point-max))
(unless (re-search-backward "^b\\s-+" nil t)
(goto-char (point-min)))
(while (setq event (timeclock-read-moment))
(cond ((equal (car event) "b")
(setq accum (string-to-number (nth 2 event))))
((equal (car event) "h")
(setq last-date-limited
(timeclock-time-to-date (cadr event))
last-date-seconds
(* (string-to-number (nth 2 event)) 3600.0)))
((equal (car event) "i")
(when (and (nth 2 event)
(> (length (nth 2 event)) 0))
(add-to-list 'timeclock-project-list (nth 2 event))
(setq timeclock-last-project (nth 2 event)))
(let ((date (timeclock-time-to-date (cadr event))))
(if (if last-date
(not (equal date last-date))
first)
(setq first nil
accum (- accum (if last-date-limited
last-date-seconds
timeclock-workday))))
(setq last-date date
last-date-limited nil)
(if beg
(error "Error in format of timelog file!")
(setq beg (timeclock-time-to-seconds (cadr event))))))
((equal (downcase (car event)) "o")
(if (and (nth 2 event)
(> (length (nth 2 event)) 0))
(add-to-list 'timeclock-reason-list (nth 2 event)))
(if (not beg)
(error "Error in format of timelog file!")
(setq timeclock-last-period
(- (timeclock-time-to-seconds (cadr event)) beg)
accum (+ timeclock-last-period accum)
beg nil))
(if (equal last-date todays-date)
(setq timeclock-elapsed
(+ timeclock-last-period timeclock-elapsed)))))
(setq timeclock-last-event event
timeclock-last-event-workday
(if (equal (timeclock-time-to-date now) last-date-limited)
last-date-seconds
timeclock-workday))
(forward-line))
(setq timeclock-discrepancy accum))))
(unless timeclock-last-event-workday
(setq timeclock-last-event-workday timeclock-workday))
(setq accum timeclock-discrepancy
elapsed (or timeclock-elapsed elapsed))
(if timeclock-last-event
(if (equal (car timeclock-last-event) "i")
(let ((last-period (timeclock-last-period now)))
(setq accum (+ accum last-period)
elapsed (+ elapsed last-period)))
(if (not (equal (timeclock-time-to-date
(cadr timeclock-last-event))
(timeclock-time-to-date now)))
(setq accum (- accum timeclock-last-event-workday)))))
(list accum (- elapsed timeclock-last-event-workday)
elapsed)))
;;; A reporting function that uses timeclock-log-data
(defun timeclock-time-less-p (t1 t2)
"Say whether time T1 is less than time T2."
(or (< (car t1) (car t2))
(and (= (car t1) (car t2))
(< (nth 1 t1) (nth 1 t2)))))
(defun timeclock-day-base (&optional time)
"Given a time within a day, return 0:0:0 within that day."
(let ((decoded (decode-time (or time (current-time)))))
(setcar (nthcdr 0 decoded) 0)
(setcar (nthcdr 1 decoded) 0)
(setcar (nthcdr 2 decoded) 0)
(apply 'encode-time decoded)))
(defun timeclock-geometric-mean (l)
"Compute the geometric mean of the list L."
(let ((total 0)
(count 0))
(while l
(setq total (+ total (car l))
count (1+ count)
l (cdr l)))
(if (> count 0)
(/ total count)
0)))
(defun timeclock-generate-report (&optional html-p)
"Generate a summary report based on the current timelog file."
(interactive)
(let ((log (timeclock-log-data))
(today (timeclock-day-base)))
(if html-p (insert "<p>"))
(insert "Currently ")
(let ((project (nth 2 timeclock-last-event))
(begin (nth 1 timeclock-last-event))
done)
(if (timeclock-currently-in-p)
(insert "IN")
(if (or (null project) (= (length project) 0))
(progn (insert "Done Working Today")
(setq done t))
(insert "OUT")))
(unless done
(insert " since " (format-time-string "%Y/%m/%d %-I:%M %p" begin))
(if html-p
(insert "<br>\n<b>")
(insert "\n*"))
(if (timeclock-currently-in-p)
(insert "Working on "))
(if html-p
(insert project "</b><br>\n")
(insert project "*\n"))
(let ((proj-data (cdr (assoc project (timeclock-project-alist log))))
(two-weeks-ago (timeclock-seconds-to-time
(- (timeclock-time-to-seconds today)
(* 2 7 24 60 60))))
two-week-len today-len)
(while proj-data
(if (not (timeclock-time-less-p
(timeclock-entry-begin (car proj-data)) today))
(setq today-len (timeclock-entry-list-length proj-data)
proj-data nil)
(if (and (null two-week-len)
(not (timeclock-time-less-p
(timeclock-entry-begin (car proj-data))
two-weeks-ago)))
(setq two-week-len (timeclock-entry-list-length proj-data)))
(setq proj-data (cdr proj-data))))
(if (null two-week-len)
(setq two-week-len today-len))
(if html-p (insert "<p>"))
(if today-len
(insert "\nTime spent on this task today: "
(timeclock-seconds-to-string today-len)
". In the last two weeks: "
(timeclock-seconds-to-string two-week-len))
(if two-week-len
(insert "\nTime spent on this task in the last two weeks: "
(timeclock-seconds-to-string two-week-len))))
(if html-p (insert "<br>"))
(insert "\n"
(timeclock-seconds-to-string (timeclock-workday-elapsed))
" worked today, "
(timeclock-seconds-to-string (timeclock-workday-remaining))
" remaining, done at "
(timeclock-when-to-leave-string) "\n")))
(if html-p (insert "<p>"))
(insert "\nThere have been "
(number-to-string
(length (timeclock-day-alist log)))
" days of activity, starting "
(caar (last (timeclock-day-alist log))))
(if html-p (insert "</p>"))
(when html-p
(insert "<p>
<table>
<td width=\"25\"><br></td><td>
<table border=1 cellpadding=3>
<tr><th><i>Statistics</i></th>
<th>Entire</th>
<th>-30 days</th>
<th>-3 mons</th>
<th>-6 mons</th>
<th>-1 year</th>
</tr>")
(let* ((day-list (timeclock-day-list))
(thirty-days-ago (timeclock-seconds-to-time
(- (timeclock-time-to-seconds today)
(* 30 24 60 60))))
(three-months-ago (timeclock-seconds-to-time
(- (timeclock-time-to-seconds today)
(* 90 24 60 60))))
(six-months-ago (timeclock-seconds-to-time
(- (timeclock-time-to-seconds today)
(* 180 24 60 60))))
(one-year-ago (timeclock-seconds-to-time
(- (timeclock-time-to-seconds today)
(* 365 24 60 60))))
(time-in (vector (list t) (list t) (list t) (list t) (list t)))
(time-out (vector (list t) (list t) (list t) (list t) (list t)))
(breaks (vector (list t) (list t) (list t) (list t) (list t)))
(workday (vector (list t) (list t) (list t) (list t) (list t)))
(lengths (vector '(0 0) thirty-days-ago three-months-ago
six-months-ago one-year-ago)))
;; collect statistics from complete timelog
(while day-list
(let ((i 0) (l 5))
(while (< i l)
(unless (timeclock-time-less-p
(timeclock-day-begin (car day-list))
(aref lengths i))
(let ((base (timeclock-time-to-seconds
(timeclock-day-base
(timeclock-day-begin (car day-list))))))
(nconc (aref time-in i)
(list (- (timeclock-time-to-seconds
(timeclock-day-begin (car day-list)))
base)))
(let ((span (timeclock-day-span (car day-list)))
(len (timeclock-day-length (car day-list)))
(req (timeclock-day-required (car day-list))))
;; If the day's actual work length is less than
;; 70% of its span, then likely the exit time
;; and break amount are not worthwhile adding to
;; the statistic
(when (and (> span 0)
(> (/ (float len) (float span)) 0.70))
(nconc (aref time-out i)
(list (- (timeclock-time-to-seconds
(timeclock-day-end (car day-list)))
base)))
(nconc (aref breaks i) (list (- span len))))
(if req
(setq len (+ len (- timeclock-workday req))))
(nconc (aref workday i) (list len)))))
(setq i (1+ i))))
(setq day-list (cdr day-list)))
;; average statistics
(let ((i 0) (l 5))
(while (< i l)
(aset time-in i (timeclock-geometric-mean
(cdr (aref time-in i))))
(aset time-out i (timeclock-geometric-mean
(cdr (aref time-out i))))
(aset breaks i (timeclock-geometric-mean
(cdr (aref breaks i))))
(aset workday i (timeclock-geometric-mean
(cdr (aref workday i))))
(setq i (1+ i))))
;; Output the HTML table
(insert "<tr>\n")
(insert "<td align=\"center\">Time in</td>\n")
(let ((i 0) (l 5))
(while (< i l)
(insert "<td align=\"right\">"
(timeclock-seconds-to-string (aref time-in i))
"</td>\n")
(setq i (1+ i))))
(insert "</tr>\n")
(insert "<tr>\n")
(insert "<td align=\"center\">Time out</td>\n")
(let ((i 0) (l 5))
(while (< i l)
(insert "<td align=\"right\">"
(timeclock-seconds-to-string (aref time-out i))
"</td>\n")
(setq i (1+ i))))
(insert "</tr>\n")
(insert "<tr>\n")
(insert "<td align=\"center\">Break</td>\n")
(let ((i 0) (l 5))
(while (< i l)
(insert "<td align=\"right\">"
(timeclock-seconds-to-string (aref breaks i))
"</td>\n")
(setq i (1+ i))))
(insert "</tr>\n")
(insert "<tr>\n")
(insert "<td align=\"center\">Workday</td>\n")
(let ((i 0) (l 5))
(while (< i l)
(insert "<td align=\"right\">"
(timeclock-seconds-to-string (aref workday i))
"</td>\n")
(setq i (1+ i))))
(insert "</tr>\n"))
(insert "<tfoot>
<td colspan=\"6\" align=\"center\">
<i>These are approximate figures</i></td>
</tfoot>
</table>
</td></table>")))))
;;; A helpful little function
(defun timeclock-visit-timelog ()
"Open up the .timelog file in another window."
(interactive)
(find-file-other-window timeclock-file))
(provide 'timeclock)
(run-hooks 'timeclock-load-hook)
;; make sure we know the list of reasons, projects, and have computed
;; the last event and current discrepancy.
(if (file-readable-p timeclock-file)
(timeclock-reread-log))
;;; timeclock.el ends here