;;; type-break.el --- encourage rests from typing at appropriate intervals
-;; Copyright (C) 1994, 95, 97, 2000 Free Software Foundation, Inc.
+;; Copyright (C) 1994, 1995, 1997, 2000, 2002, 2003,
+;; 2004, 2005, 2006 Free Software Foundation, Inc.
;; Author: Noah Friedman
;; Maintainer: Noah Friedman <friedman@splode.com>
;; Status: Works in GNU Emacs 19.25 or later, some versions of XEmacs
;; Created: 1994-07-13
-;; $Id: type-break.el,v 1.28 2003/05/28 11:25:44 rms Exp $
-
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; The docstring for the function `type-break-mode' summarizes most of the
;; details of the interface.
-;; This package relies on the assumption that you live entirely in emacs,
+;; This package relies on the assumption that you live entirely in Emacs,
;; as the author does. If that's not the case for you (e.g. you often
-;; suspend emacs or work in other windows) then this won't help very much;
-;; it will depend on just how often you switch back to emacs. At the very
+;; suspend Emacs or work in other windows) then this won't help very much;
+;; it will depend on just how often you switch back to Emacs. At the very
;; least, you will want to turn off the keystroke thresholds and rest
;; interval tracking.
(defcustom type-break-good-rest-interval (/ type-break-interval 6)
"*Number of seconds of idle time considered to be an adequate typing rest.
-When this variable is non-nil, emacs checks the idle time between
+When this variable is non-nil, Emacs checks the idle time between
keystrokes. If this idle time is long enough to be considered a \"good\"
rest from typing, then the next typing break is simply rescheduled for later.
:type 'integer
:group 'type-break)
+;;;###autoload
+(defcustom type-break-good-break-interval nil
+ "*Number of seconds considered to be an adequate explicit typing rest.
+
+When this variable is non-nil, its value is considered to be a \"good\"
+length (in seconds) for a break initiated by the command `type-break',
+overriding `type-break-good-rest-interval'. This provides querying of
+break interruptions when `type-break-good-rest-interval' is nil."
+ :type 'integer
+ :group 'type-break)
+
;;;###autoload
(defcustom type-break-keystroke-threshold
;; Assuming typing speed is 35wpm (on the average, do you really
'(type-break-demo-boring type-break-demo-life type-break-demo-hanoi)
"*List of functions to consider running as demos during typing breaks.
When a typing break begins, one of these functions is selected randomly
-to have emacs do something interesting.
+to have Emacs do something interesting.
Any function in this list should start a demo which ceases as soon as a
key is pressed."
:type '(repeat function)
:group 'type-break)
+(defcustom type-break-demo-boring-stats nil
+ "*Show word per minute and keystroke figures in the Boring demo."
+ :type 'boolean
+ :group 'type-break)
+
+(defcustom type-break-terse-messages nil
+ "*Use slightly terser messages."
+ :type 'boolean
+ :group 'type-break)
+
+(defcustom type-break-file-name (convert-standard-filename "~/.type-break")
+ "*Name of file used to save state across sessions.
+If this is nil, no data will be saved across sessions."
+ :type 'file
+ :group 'type-break)
+
(defvar type-break-post-command-hook '(type-break-check)
- "Hook run indirectly by post-command-hook for typing break functions.
+ "Hook run indirectly by `post-command-hook' for typing break functions.
This is not really intended to be set by the user, but it's probably
harmless to do so. Mainly it is used by various parts of the typing break
program to delay actions until after the user has completed some command.
This variable, in conjunction with `type-break-warning-countdown-string-type'
\(which indicates whether this value is a number of keystrokes or seconds)
-is installed in mode-line-format to notify of imminent typing breaks.")
+is installed in `mode-line-format' to notify of imminent typing breaks.")
(defvar type-break-warning-countdown-string-type nil
"Indicates the unit type of `type-break-warning-countdown-string'.
(defvar type-break-current-keystroke-warning-interval nil)
(defvar type-break-time-warning-count 0)
(defvar type-break-keystroke-warning-count 0)
-
-;; Constant indicating emacs variant.
-;; This can be one of `xemacs', `lucid', `epoch', `mule', etc.
-(defconst type-break-emacs-variant
- (let ((data (match-data))
- (version (cond
- ((fboundp 'nemacs-version)
- (nemacs-version))
- (t
- (emacs-version))))
- (alist '(("\\bXEmacs\\b" . xemacs)
- ("\\bLucid\\b" . lucid)
- ("^Nemacs\\b" . nemacs)
- ("^GNU Emacs 19" . standard19)
- ("^GNU Emacs 20" . standard19)
- ("^GNU Emacs 18" . emacs18)))
- result)
- (while alist
- (cond
- ((string-match (car (car alist)) version)
- (setq result (cdr (car alist)))
- (setq alist nil))
- (t
- (setq alist (cdr alist)))))
- (set-match-data data)
- (cond ((eq result 'lucid)
- (and (string= emacs-version "19.8 Lucid")
- (setq result 'lucid-19-8)))
- ((memq result '(nemacs emacs18))
- (signal 'error
- "type-break not supported in this version of emacs.")))
- result))
+(defvar type-break-interval-start nil)
\f
;;;###autoload
When this mode is enabled, the user is encouraged to take typing breaks at
appropriate intervals; either after a specified amount of time or when the
user has exceeded a keystroke threshold. When the time arrives, the user
-is asked to take a break. If the user refuses at that time, emacs will ask
+is asked to take a break. If the user refuses at that time, Emacs will ask
again in a short period of time. The idea is to give the user enough time
to find a good breaking point in his or her work, but be sufficiently
annoying to discourage putting typing breaks off indefinitely.
If set, the variable `type-break-good-rest-interval' specifies the minimum
amount of time which is considered a reasonable typing break. Whenever
that time has elapsed, typing breaks are automatically rescheduled for
-later even if emacs didn't prompt you to take one first. Also, if a break
+later even if Emacs didn't prompt you to take one first. Also, if a break
is ended before this much time has elapsed, the user will be asked whether
-or not to continue.
+or not to continue. A nil value for this variable prevents automatic
+break rescheduling, making `type-break-interval' an upper bound on the time
+between breaks. In this case breaks will be prompted for as usual before
+the upper bound if the keystroke threshold is reached.
+
+If `type-break-good-rest-interval' is nil and
+`type-break-good-break-interval' is set, then confirmation is required to
+interrupt a break before `type-break-good-break-interval' seconds
+have passed. This provides for an upper bound on the time between breaks
+together with confirmation of interruptions to these breaks.
The variable `type-break-keystroke-threshold' is used to determine the
thresholds at which typing breaks should be considered. You can use
`type-break-query-function'
`type-break-query-interval'
-Finally, the command `type-break-statistics' prints interesting things."
+The command `type-break-statistics' prints interesting things.
+
+Finally, a file (named `type-break-file-name') is used to store information
+across Emacs sessions. This provides recovery of the break status between
+sessions and after a crash. Manual changes to the file may result in
+problems."
(interactive "P")
(type-break-check-post-command-hook)
(and (interactive-p)
(message "Type Break mode is already enabled")))
(type-break-mode
+ (when type-break-file-name
+ (with-current-buffer (find-file-noselect type-break-file-name 'nowarn)
+ (setq buffer-save-without-query t)))
+
(or global-mode-string
(setq global-mode-string '("")))
(or (assq 'type-break-mode-line-message-mode
minor-mode-alist)))
(type-break-keystroke-reset)
(type-break-mode-line-countdown-or-break nil)
- (type-break-schedule)
+
+ (setq type-break-time-last-break
+ (or (type-break-get-previous-time)
+ (current-time)))
+
+ ;; schedule according to break time from session file
+ (type-break-schedule
+ (let (diff)
+ (if (and type-break-time-last-break
+ (< (setq diff (type-break-time-difference
+ type-break-time-last-break
+ (current-time)))
+ type-break-interval))
+ ;; use the file's value
+ (progn
+ (setq type-break-keystroke-count
+ (type-break-get-previous-count))
+ ;; file the time, in case it was read from the auto-save file
+ (type-break-file-time type-break-interval-start)
+ (setq type-break-interval-start type-break-time-last-break)
+ (- type-break-interval diff))
+ ;; schedule from now
+ (setq type-break-interval-start (current-time))
+ (type-break-file-time type-break-interval-start)
+ type-break-interval))
+ type-break-interval-start
+ type-break-interval)
+
(and (interactive-p)
- (message "Type Break mode is enabled and reset")))
+ (message "Type Break mode is enabled and set")))
(t
(type-break-keystroke-reset)
(type-break-mode-line-countdown-or-break nil)
(type-break-cancel-schedule)
+ (do-auto-save)
+ (when type-break-file-name
+ (with-current-buffer (find-file-noselect type-break-file-name
+ 'nowarn)
+ (set-buffer-modified-p nil)
+ (unlock-buffer)
+ (kill-this-buffer)))
(and (interactive-p)
(message "Type Break mode is disabled")))))
type-break-mode)
(defun type-break-mode-line-message-mode (&optional prefix)
"Enable or disable warnings in the mode line about typing breaks.
-A negative prefix argument disables this mode.
+A negative PREFIX argument disables this mode.
No argument or any non-negative argument enables it.
The user may also enable or disable this mode simply by setting the
typing break at that moment. The function which does this query is
specified by the variable `type-break-query-function'.
-A negative prefix argument disables this mode.
+A negative PREFIX argument disables this mode.
No argument or any non-negative argument enables it.
The user may also enable or disable this mode simply by setting the
(message "type-break-query-mode is disabled")))
type-break-query-mode)
+\f
+;;; session file functions
+
+(defvar type-break-auto-save-file-name
+ (let ((buffer-file-name type-break-file-name))
+ (make-auto-save-file-name))
+ "Auto-save name of `type-break-file-name'.")
+
+(defun type-break-file-time (&optional time)
+ "File break time in `type-break-file-name', unless the file is locked."
+ (if (and type-break-file-name
+ (not (stringp (file-locked-p type-break-file-name))))
+ (with-current-buffer (find-file-noselect type-break-file-name
+ 'nowarn)
+ (let ((inhibit-read-only t))
+ (erase-buffer)
+ (insert (format "%s\n\n" (or time type-break-interval-start)))
+ ;; file saving is left to auto-save
+ ))))
+
+(defun type-break-file-keystroke-count ()
+ "File keystroke count in `type-break-file-name', unless the file is locked."
+ (if (and type-break-file-name
+ (not (stringp (file-locked-p type-break-file-name))))
+ ;; Prevent deactivation of the mark in some other buffer.
+ (let (deactivate-mark)
+ (with-current-buffer (find-file-noselect type-break-file-name
+ 'nowarn)
+ (save-excursion
+ (let ((inhibit-read-only t))
+ (goto-char (point-min))
+ (forward-line)
+ (delete-region (point) (save-excursion (end-of-line) (point)))
+ (insert (format "%s" type-break-keystroke-count))
+ ;; file saving is left to auto-save
+ ))))))
+
+(defun timep (time)
+ "If TIME is in the format returned by `current-time' then
+return TIME, else return nil."
+ (and (listp time)
+ (eq (length time) 3)
+ (integerp (car time))
+ (integerp (nth 1 time))
+ (integerp (nth 2 time))
+ time))
+
+(defun type-break-choose-file ()
+ "Return file to read from."
+ (cond
+ ((not type-break-file-name)
+ nil)
+ ((and (file-exists-p type-break-auto-save-file-name)
+ (file-readable-p type-break-auto-save-file-name))
+ type-break-auto-save-file-name)
+ ((and (file-exists-p type-break-file-name)
+ (file-readable-p type-break-file-name))
+ type-break-file-name)
+ (t nil)))
+
+(defun type-break-get-previous-time ()
+ "Get previous break time from `type-break-file-name'.
+Returns nil if the file is missing or if the time breaks with the
+`current-time' format."
+ (let ((file (type-break-choose-file)))
+ (if file
+ (timep ;; returns expected format, else nil
+ (with-current-buffer (find-file-noselect file 'nowarn)
+ (save-excursion
+ (goto-char (point-min))
+ (read (current-buffer))))))))
+
+(defun type-break-get-previous-count ()
+ "Get previous keystroke count from `type-break-file-name'.
+Return 0 if the file is missing or if the form read is not an
+integer."
+ (let ((file (type-break-choose-file)))
+ (if (and file
+ (integerp
+ (setq file
+ (with-current-buffer
+ (find-file-noselect file 'nowarn)
+ (save-excursion
+ (goto-char (point-min))
+ (forward-line 1)
+ (read (current-buffer)))))))
+ file
+ 0)))
+
\f
;;;###autoload
(defun type-break ()
(interactive)
(do-auto-save)
(type-break-cancel-schedule)
+ ;; remove any query scheduled during interactive invocation
+ (remove-hook 'type-break-post-command-hook 'type-break-do-query)
(let ((continue t)
(start-time (current-time)))
(setq type-break-time-last-break start-time)
(other-window 1))
(delete-other-windows)
(scroll-right (window-width))
- (message "Press any key to resume from typing break.")
+ (unless type-break-terse-messages
+ (message "Press any key to resume from typing break."))
(random t)
(let* ((len (length type-break-demo-functions))
(funcall fn)
(error nil))))
- (cond
- (type-break-good-rest-interval
- (let ((break-secs (type-break-time-difference
- start-time (current-time))))
- (cond
- ((>= break-secs type-break-good-rest-interval)
- (setq continue nil))
- ;; 60 seconds may be too much leeway if the break is only 3
- ;; minutes to begin with. You can just say "no" to the query
- ;; below if you're in that much of a hurry.
- ;((> 60 (abs (- break-secs type-break-good-rest-interval)))
- ; (setq continue nil))
- ((funcall
- type-break-query-function
- (format "%sYou really ought to rest %s more. Continue break? "
- (type-break-time-stamp)
- (type-break-format-time (- type-break-good-rest-interval
- break-secs)))))
- (t
- (setq continue nil)))))
- (t (setq continue nil)))))
+ (let ((good-interval (or type-break-good-rest-interval
+ type-break-good-break-interval)))
+ (cond
+ (good-interval
+ (let ((break-secs (type-break-time-difference
+ start-time (current-time))))
+ (cond
+ ((>= break-secs good-interval)
+ (setq continue nil))
+ ;; 60 seconds may be too much leeway if the break is only 3
+ ;; minutes to begin with. You can just say "no" to the query
+ ;; below if you're in that much of a hurry.
+ ;;((> 60 (abs (- break-secs good-interval)))
+ ;; (setq continue nil))
+ ((funcall
+ type-break-query-function
+ (format
+ (if type-break-terse-messages
+ "%s%s remaining. Continue break? "
+ "%sYou really ought to rest %s more. Continue break? ")
+ (type-break-time-stamp)
+ (type-break-format-time (- good-interval
+ break-secs)))))
+ (t
+ (setq continue nil)))))
+ (t (setq continue nil))))))
(type-break-keystroke-reset)
+ (type-break-file-time)
(type-break-mode-line-countdown-or-break nil)
(type-break-schedule))
\f
-(defun type-break-schedule (&optional time)
+(defun type-break-schedule (&optional time start interval)
"Schedule a typing break for TIME seconds from now.
-If time is not specified, default to `type-break-interval'."
+If time is not specified it defaults to `type-break-interval'.
+START and INTERVAL are used when recovering a break.
+START is the start of the break (defaults to now).
+INTERVAL is the full length of an interval (defaults to TIME)."
(interactive (list (and current-prefix-arg
(prefix-numeric-value current-prefix-arg))))
(or time (setq time type-break-interval))
(type-break-time-warning-schedule time 'reset)
(type-break-run-at-time (max 1 time) nil 'type-break-alarm)
(setq type-break-time-next-break
- (type-break-time-sum (current-time) time)))
+ (type-break-time-sum (or start (current-time))
+ (or interval time))))
(defun type-break-cancel-schedule ()
(type-break-cancel-time-warning-schedule)
(remove-hook 'type-break-post-command-hook 'type-break-time-warning)
(setq type-break-current-time-warning-interval
type-break-time-warning-intervals)
+ (setq type-break-time-warning-count 0) ; avoid warnings after break
(setq type-break-warning-countdown-string nil))
(defun type-break-alarm ()
This may be the case either because the scheduled time has come \(and the
minimum keystroke threshold has been reached\) or because the maximum
keystroke threshold has been exceeded."
+ (type-break-file-keystroke-count)
(let* ((min-threshold (car type-break-keystroke-threshold))
(max-threshold (cdr type-break-keystroke-threshold)))
(and type-break-good-rest-interval
;; from taking place before this one has even returned.
;; The condition-case wrapper will reschedule on quit.
(type-break-cancel-schedule)
+ ;; Also prevent a second query when the break is interrupted.
+ (remove-hook 'type-break-post-command-hook 'type-break-do-query)
(funcall type-break-query-function
(format "%s%s"
(type-break-time-stamp)
- "Take a break from typing now? ")))
+ (if type-break-terse-messages
+ "Break now? "
+ "Take a break from typing now? "))))
(type-break))
(t
(type-break-schedule type-break-query-interval)))
(quit
- (type-break-schedule type-break-query-interval)))
- (remove-hook 'type-break-post-command-hook 'type-break-do-query))))
+ (type-break-schedule type-break-query-interval))))))
(defun type-break-noninteractive-query (&optional ignored-args)
"Null query function which doesn't interrupt user and assumes `no'.
length of words (5). For the minimum threshold, it uses about a fifth of
the computed maximum threshold.
-When called from lisp programs, the optional args WORDLEN and FRAC can be
+When called from Lisp programs, the optional args WORDLEN and FRAC can be
used to override the default assumption about average word length and the
fraction of the maximum threshold to which to set the minimum threshold.
FRAC should be the inverse of the fractional value; for example, a value of
(setcar type-break-keystroke-threshold lower)
(setcdr type-break-keystroke-threshold upper)
(if (interactive-p)
- (message "min threshold: %d\tmax threshold: %d" lower upper)
- type-break-keystroke-threshold)))
+ (message "min threshold: %d\tmax threshold: %d" lower upper))
+ type-break-keystroke-threshold))
\f
;;; misc functions
(t (format "%d seconds" secs)))))
(defun type-break-keystroke-reset ()
+ (setq type-break-interval-start (current-time)) ; not a keystroke
(setq type-break-keystroke-count 0)
(setq type-break-keystroke-warning-count 0)
(setq type-break-current-keystroke-warning-interval
(and all (save-excursion (set-buffer (other-buffer))))
(set-buffer-modified-p (buffer-modified-p)))
-;; If an exception occurs in emacs while running the post command hook, the
+;; If an exception occurs in Emacs while running the post command hook, the
;; value of that hook is clobbered. This is because the value of the
;; variable is temporarily set to nil while it's running to prevent
;; recursive application, but it also means an exception aborts the routine
;;; Timer wrapper functions
;;;
;;; These shield type-break from variations in the interval timer packages
-;;; for different versions of emacs.
+;;; for different versions of Emacs.
(defun type-break-run-at-time (time repeat function)
- (cond ((eq type-break-emacs-variant 'standard19)
- (require 'timer)
- (funcall 'run-at-time time repeat function))
- ((eq type-break-emacs-variant 'lucid-19-8)
- (let ((name (if (symbolp function)
- (symbol-name function)
- "type-break")))
- (require 'timer)
- (funcall 'start-timer name function time repeat)))
- ((memq type-break-emacs-variant '(xemacs lucid))
- (let ((name (if (symbolp function)
- (symbol-name function)
- "type-break")))
- (require 'itimer)
- (funcall 'start-itimer name function time repeat)))))
+ (condition-case nil (or (require 'timer) (require 'itimer)) (error nil))
+ (run-at-time time repeat function))
+(defvar timer-dont-exit)
(defun type-break-cancel-function-timers (function)
- (cond ((eq type-break-emacs-variant 'standard19)
- (let ((timer-dont-exit t))
- (funcall 'cancel-function-timers function)))
- ((eq type-break-emacs-variant 'lucid-19-8)
- (let ((list timer-list))
- (while list
- (and (eq (funcall 'timer-function (car list)) function)
- (funcall 'delete-timer (car list)))
- (setq list (cdr list)))))
- ((memq type-break-emacs-variant '(xemacs lucid))
- (with-no-warnings
- (let ((list itimer-list))
- (while list
- (and (eq (funcall 'itimer-function (car list)) function)
- (funcall 'delete-itimer (car list)))
- (setq list (cdr list))))))))
+ (let ((timer-dont-exit t))
+ (cancel-function-timers function)))
\f
;;; Demo wrappers
;; Boring demo, but doesn't use many cycles
(defun type-break-demo-boring ()
"Boring typing break demo."
- (let ((rmsg "Press any key to resume from typing break")
+ (let ((rmsg (if type-break-terse-messages
+ ""
+ "Press any key to resume from typing break"))
(buffer-name "*Typing Break Buffer*")
- line col pos
- elapsed timeleft tmsg)
+ lines elapsed timeleft tmsg)
(condition-case ()
(progn
(switch-to-buffer (get-buffer-create buffer-name))
(buffer-disable-undo (current-buffer))
- (erase-buffer)
- (setq line (1+ (/ (window-height) 2)))
- (setq col (/ (- (window-width) (length rmsg)) 2))
- (insert (make-string line ?\C-j)
- (make-string col ?\ )
- rmsg)
- (forward-line -1)
- (beginning-of-line)
- (setq pos (point))
+ (setq lines (/ (window-body-height) 2))
+ (unless type-break-terse-messages (setq lines (1- lines)))
+ (if type-break-demo-boring-stats
+ (setq lines (- lines 2)))
+ (setq lines (make-string lines ?\C-j))
(while (not (input-pending-p))
- (delete-region pos (progn
- (goto-char pos)
- (end-of-line)
- (point)))
+ (erase-buffer)
(setq elapsed (type-break-time-difference
type-break-time-last-break
(current-time)))
- (cond
- (type-break-good-rest-interval
- (setq timeleft (- type-break-good-rest-interval elapsed))
- (if (> timeleft 0)
- (setq tmsg (format "You should rest for %s more"
- (type-break-format-time timeleft)))
- (setq tmsg (format "Typing break has lasted %s"
- (type-break-format-time elapsed)))))
- (t
- (setq tmsg (format "Typing break has lasted %s"
- (type-break-format-time elapsed)))))
- (setq col (/ (- (window-width) (length tmsg)) 2))
- (insert (make-string col ?\ ) tmsg)
+ (let ((good-interval (or type-break-good-rest-interval
+ type-break-good-break-interval)))
+ (cond
+ (good-interval
+ (setq timeleft (- good-interval elapsed))
+ (if (> timeleft 0)
+ (setq tmsg
+ (format (if type-break-terse-messages
+ "Break remaining: %s"
+ "You should rest for %s more")
+ (type-break-format-time timeleft)))
+ (setq tmsg
+ (format (if type-break-terse-messages
+ "Break complete (%s elapsed in total)"
+ "Typing break has lasted %s")
+ (type-break-format-time elapsed)))))
+ (t
+ (setq tmsg
+ (format (if type-break-terse-messages
+ "Break has lasted %s"
+ "Typing break has lasted %s")
+ (type-break-format-time elapsed))))))
+ (insert lines
+ (make-string (/ (- (window-width) (length tmsg)) 2) ?\ )
+ tmsg)
+ (if (> (length rmsg) 0)
+ (insert "\n"
+ (make-string (/ (- (window-width) (length rmsg)) 2)
+ ?\ )
+ rmsg))
+ (if type-break-demo-boring-stats
+ (let*
+ ((message
+ (format
+ (if type-break-terse-messages
+ "Since last break: %s keystrokes\n"
+ "Since your last break you've typed %s keystrokes\n")
+ type-break-keystroke-count))
+ (column-spaces
+ (make-string (/ (- (window-width) (length message)) 2)
+ ?\ ))
+ (wpm (/ (/ (float type-break-keystroke-count) 5)
+ (/ (type-break-time-difference
+ type-break-interval-start
+ type-break-time-last-break)
+ 60.0))))
+ (insert "\n\n" column-spaces message)
+ (if type-break-terse-messages
+ (insert (format " %s%.2f wpm"
+ column-spaces
+ wpm))
+ (setq message
+ (format "at an average of %.2f words per minute"
+ wpm))
+ (insert
+ (make-string (/ (- (window-width) (length message)) 2)
+ ?\ )
+ message))))
(goto-char (point-min))
(sit-for 60))
(read-char)