;;; type-break.el --- encourage rests from typing at appropriate intervals
-;; Copyright (C) 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1994, 1995, 1997 Free Software Foundation, Inc.
-;; Author: Noah Friedman <friedman@prep.ai.mit.edu>
-;; Maintainer: friedman@prep.ai.mit.edu
+;; Author: Noah Friedman
+;; Maintainer: Noah Friedman <friedman@splode.com>
;; Keywords: extensions, timers
-;; Status: known to work in GNU Emacs 19.25 or later.
+;; Status: Works in GNU Emacs 19.25 or later, some versions of XEmacs
;; Created: 1994-07-13
-;; $Id$
+
+;; $Id: type-break.el,v 1.22 1999/04/27 19:00:42 fx Exp kwzh $
;; This file is part of GNU Emacs.
;; 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; 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:
-;;; 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,
-;;; 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
-;;; least, you will want to turn off the keystroke thresholds and rest
-;;; interval tracking.
-
-;;; This package was inspired by Roland McGrath's hanoi-break.el.
-;;; Thanks to both Roland McGrath <roland@gnu.ai.mit.edu> and Mark Ashton
-;;; <mpashton@gnu.ai.mit.edu> for feedback and ideas.
+;; 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,
+;; 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
+;; least, you will want to turn off the keystroke thresholds and rest
+;; interval tracking.
+
+;; If you prefer not to be queried about taking breaks, but instead just
+;; want to be reminded, do the following:
+;;
+;; (setq type-break-query-mode nil)
+;;
+;; Or call the command `type-break-query-mode' with a negative prefix
+;; argument.
+
+;; If you find echo area messages annoying and would prefer to see messages
+;; in the mode line instead, do M-x type-break-mode-line-message-mode
+;; or set the variable of the same name to `t'.
+
+;; This program can truly cons up a storm because of all the calls to
+;; `current-time' (which always returns 3 fresh conses). I'm dismayed by
+;; this, but I think the health of my hands is far more important than a
+;; few pages of virtual memory.
+
+;; This program has no hope of working in Emacs 18.
+
+;; This package was inspired by Roland McGrath's hanoi-break.el.
+;; Several people contributed feedback and ideas, including
+;; Roland McGrath <roland@gnu.org>
+;; Kleanthes Koniaris <kgk@martigny.ai.mit.edu>
+;; Mark Ashton <mpashton@gnu.org>
+;; Matt Wilding <wilding@cli.com>
+;; Robert S. Boyer <boyer@cs.utexas.edu>
;;; Code:
\f
-(require 'timer)
+(defgroup type-break nil
+ "Encourage the user to take a rest from typing at suitable intervals."
+ :prefix "type-break"
+ :group 'keyboard)
-;; Make this nil initially so that the call to type-break-mode at the end
-;; will cause scheduling and so forth to happen.
;;;###autoload
-(defvar type-break-mode nil
- "*Non-`nil' means typing break mode is enabled.
-See the docstring for the `type-break-mode' command for more information.")
+(defcustom type-break-mode nil
+ "Toggle typing break mode.
+See the docstring for the `type-break-mode' command for more information.
+Setting this variable directly does not take effect;
+use either \\[customize] or the function `type-break-mode'."
+ :set (lambda (symbol value)
+ (type-break-mode (if value 1 -1)))
+ :initialize 'custom-initialize-default
+ :type 'boolean
+ :group 'type-break
+ :require 'type-break)
;;;###autoload
-(defvar type-break-interval (* 60 60)
- "*Number of seconds between scheduled typing breaks.")
+(defcustom type-break-interval (* 60 60)
+ "*Number of seconds between scheduled typing breaks."
+ :type 'integer
+ :group 'type-break)
;;;###autoload
-(defvar type-break-good-rest-interval (/ type-break-interval 6)
+(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
rest from typing, then the next typing break is simply rescheduled for later.
If a break is interrupted before this much time elapses, the user will be
-asked whether or not really to interrupt the break.")
+asked whether or not really to interrupt the break."
+ :type 'integer
+ :group 'type-break)
;;;###autoload
-(defvar type-break-keystroke-threshold
+(defcustom type-break-keystroke-threshold
;; Assuming typing speed is 35wpm (on the average, do you really
;; type more than that in a minute? I spend a lot of time reading mail
;; and simply studying code in buffers) and average word length is
(lower (/ upper 5)))
(cons lower upper))
"*Upper and lower bound on number of keystrokes for considering typing break.
-This structure is a pair of numbers.
+This structure is a pair of numbers (MIN . MAX).
The first number is the minimum number of keystrokes that must have been
entered since the last typing break before considering another one, even if
will occur; only scheduled ones will.
Keys with bucky bits (shift, control, meta, etc) are counted as only one
-keystroke even though they really require multiple keys to generate them.")
+keystroke even though they really require multiple keys to generate them.
-(defvar type-break-time-warning-intervals '(300 120 60 30)
+The command `type-break-guesstimate-keystroke-threshold' can be used to
+guess a reasonably good pair of values for this variable."
+ :type 'sexp
+ :group 'type-break)
+
+(defcustom type-break-query-mode t
+ "*Non-`nil' means ask whether or not to prompt user for breaks.
+If so, call the function specified in the value of the variable
+`type-break-query-function' to do the asking."
+ :type 'boolean
+ :group 'type-break)
+
+(defvar type-break-query-function 'yes-or-no-p
+ "Function to use for making query for a typing break.
+It should take a string as an argument, the prompt.
+Usually this should be set to `yes-or-no-p' or `y-or-n-p'.
+
+To avoid being queried at all, set `type-break-query-mode' to `nil'.")
+
+(defcustom type-break-query-interval 60
+ "*Number of seconds between queries to take a break, if put off.
+The user will continue to be prompted at this interval until he or she
+finally submits to taking a typing break."
+ :type 'integer
+ :group 'type-break)
+
+(defcustom type-break-time-warning-intervals '(300 120 60 30)
"*List of time intervals for warnings about upcoming typing break.
At each of the intervals (specified in seconds) away from a scheduled
-typing break, print a warning in the echo area.")
+typing break, print a warning in the echo area."
+ :type '(repeat integer)
+ :group 'type-break)
-(defvar type-break-keystroke-warning-intervals '(300 200 100 50)
+(defcustom type-break-keystroke-warning-intervals '(300 200 100 50)
"*List of keystroke measurements for warnings about upcoming typing break.
At each of the intervals (specified in keystrokes) away from the upper
keystroke threshold, print a warning in the echo area.
If either this variable or the upper threshold is set, then no warnings
-Will occur.")
+will occur."
+ :type '(repeat integer)
+ :group 'type-break)
-(defvar type-break-query-interval 60
- "*Number of seconds between queries to take a break, if put off.
-The user will continue to be prompted at this interval until he or she
-finally submits to taking a typing break.")
-(defvar type-break-warning-repeat 40
+(defcustom type-break-warning-repeat 40
"*Number of keystrokes for which warnings should be repeated.
That is, for each of this many keystrokes the warning is redisplayed
-in the echo area to make sure it's really seen.")
-
-(defvar type-break-query-function 'yes-or-no-p
- "Function to use for making query for a typing break.
-It should take a string as an argument, the prompt.
-Usually this should be set to `yes-or-no-p' or `y-or-n-p'.")
+in the echo area to make sure it's really seen."
+ :type 'integer
+ :group 'type-break)
-(defvar type-break-demo-functions
+(defcustom type-break-demo-functions
'(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.
Any function in this list should start a demo which ceases as soon as a
-key is pressed.")
+key is pressed."
+ :type '(repeat function)
+ :group 'type-break)
+
+(defvar type-break-post-command-hook '(type-break-check)
+ "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.
+It exists because `post-command-hook' itself is inaccessible while its
+functions are being run, and some type-break--related functions want to
+remove themselves after running.")
-(defvar type-break-post-command-hook nil
- "Hook run indirectly by post-command-hook for typing break functions.")
+\f
+;; Mode line frobs
+
+(defcustom type-break-mode-line-message-mode nil
+ "*Non-`nil' means put type-break related messages in the mode line.
+Otherwise, messages typically go in the echo area.
+
+See also `type-break-mode-line-format' and its members."
+ :type 'boolean
+ :group 'type-break)
+
+(defvar type-break-mode-line-format
+ '(type-break-mode-line-message-mode
+ (""
+ type-break-mode-line-break-message
+ type-break-mode-line-warning))
+ "*Format of messages in the mode line concerning typing breaks.")
+
+(defvar type-break-mode-line-break-message
+ '(type-break-mode-line-break-message-p
+ type-break-mode-line-break-string))
+
+(defvar type-break-mode-line-break-message-p nil)
+(defvar type-break-mode-line-break-string " *** TAKE A TYPING BREAK ***")
+
+(defvar type-break-mode-line-warning
+ '(type-break-mode-line-break-message-p
+ ("")
+ (type-break-warning-countdown-string
+ (" ***Break in "
+ type-break-warning-countdown-string
+ " "
+ type-break-warning-countdown-string-type
+ "***"))))
+
+(defvar type-break-warning-countdown-string nil
+ "If non-nil, this is a countdown for the next typing break.
+
+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.")
+
+(defvar type-break-warning-countdown-string-type nil
+ "Indicates the unit type of `type-break-warning-countdown-string'.
+It will be either \"seconds\" or \"keystrokes\".")
+\f
;; These are internal variables. Do not set them yourself.
(defvar type-break-alarm-p 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))
+
\f
;;;###autoload
(defun type-break-mode (&optional prefix)
The variable `type-break-keystroke-threshold' is used to determine the
thresholds at which typing breaks should be considered. You can use
-the command `type-break-guestimate-keystroke-threshold' to try to
+the command `type-break-guesstimate-keystroke-threshold' to try to
approximate good values for this.
+There are several variables that affect how or when warning messages about
+imminent typing breaks are displayed. They include:
+
+ `type-break-mode-line-message-mode'
+ `type-break-time-warning-intervals'
+ `type-break-keystroke-warning-intervals'
+ `type-break-warning-repeat'
+ `type-break-warning-countdown-string'
+ `type-break-warning-countdown-string-type'
+
+There are several variables that affect if, how, and when queries to begin
+a typing break occur. They include:
+
+ `type-break-query-mode'
+ `type-break-query-function'
+ `type-break-query-interval'
+
Finally, the command `type-break-statistics' prints interesting things."
(interactive "P")
- ;; make sure it's there.
- (add-hook 'post-command-hook 'type-break-run-tb-post-command-hook 'append)
- (add-hook 'type-break-post-command-hook 'type-break-check)
+ (type-break-check-post-command-hook)
(let ((already-enabled type-break-mode))
(setq type-break-mode (>= (prefix-numeric-value prefix) 0))
(cond
((and already-enabled type-break-mode)
(and (interactive-p)
- (message "type-break-mode is enabled")))
+ (message "Type Break mode is already enabled")))
(type-break-mode
+ (or global-mode-string
+ (setq global-mode-string '("")))
+ (or (assq 'type-break-mode-line-message-mode
+ minor-mode-alist)
+ (setq minor-mode-alist
+ (cons type-break-mode-line-format
+ minor-mode-alist)))
(type-break-keystroke-reset)
+ (type-break-mode-line-countdown-or-break nil)
(type-break-schedule)
(and (interactive-p)
- (message "type-break-mode is enabled and reset")))
- ((interactive-p)
- (message "type-break-mode is disabled"))))
+ (message "Type Break mode is enabled and reset")))
+ (t
+ (type-break-keystroke-reset)
+ (type-break-mode-line-countdown-or-break nil)
+ (type-break-cancel-schedule)
+ (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.
+No argument or any non-negative argument enables it.
+
+The user may also enable or disable this mode simply by setting the
+variable of the same name.
+
+Variables controlling the display of messages in the mode line include:
+
+ `mode-line-format'
+ `global-mode-string'
+ `type-break-mode-line-break-message'
+ `type-break-mode-line-warning'"
+ (interactive "P")
+ (setq type-break-mode-line-message-mode
+ (>= (prefix-numeric-value prefix) 0))
+ (and (interactive-p)
+ (if type-break-mode-line-message-mode
+ (message "type-break-mode-line-message-mode is enabled")
+ (message "type-break-mode-line-message-mode is disabled")))
+ type-break-mode-line-message-mode)
+
+(defun type-break-query-mode (&optional prefix)
+ "Enable or disable warnings in the mode line about typing breaks.
+
+When enabled, the user is periodically queried about whether to take a
+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.
+No argument or any non-negative argument enables it.
+
+The user may also enable or disable this mode simply by setting the
+variable of the same name."
+ (interactive "P")
+ (setq type-break-query-mode
+ (>= (prefix-numeric-value prefix) 0))
+ (and (interactive-p)
+ (if type-break-query-mode
+ (message "type-break-query-mode is enabled")
+ (message "type-break-query-mode is disabled")))
+ type-break-query-mode)
+
+\f
;;;###autoload
(defun type-break ()
"Take a typing break.
(cond
((>= break-secs type-break-good-rest-interval)
(setq continue nil))
- ;; Don't be pedantic; if user's rest was only a minute short,
- ;; why bother?
- ((> 60 (abs (- 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 "You really ought to rest %s more. Continue break? "
(t (setq continue nil)))))
(type-break-keystroke-reset)
+ (type-break-mode-line-countdown-or-break nil)
(type-break-schedule))
\f
(interactive (list (and current-prefix-arg
(prefix-numeric-value current-prefix-arg))))
(or time (setq time type-break-interval))
+ (type-break-check-post-command-hook)
(type-break-cancel-schedule)
(type-break-time-warning-schedule time 'reset)
- (run-at-time time nil 'type-break-alarm)
+ (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)))
(defun type-break-cancel-schedule ()
(type-break-cancel-time-warning-schedule)
- (let ((timer-dont-exit t))
- (cancel-function-timers 'type-break-alarm))
+ (type-break-cancel-function-timers 'type-break-alarm)
(setq type-break-alarm-p nil)
(setq type-break-time-next-break nil))
(defun type-break-time-warning-schedule (&optional time resetp)
- (let (type-break-current-time-warning-interval)
+ (let ((type-break-current-time-warning-interval nil))
(type-break-cancel-time-warning-schedule))
+ (add-hook 'type-break-post-command-hook 'type-break-time-warning 'append)
(cond
(type-break-time-warning-intervals
(and resetp
(setq type-break-current-time-warning-interval
(cdr type-break-current-time-warning-interval))
- (let (type-break-current-time-warning-interval)
- (type-break-cancel-time-warning-schedule))
- (run-at-time time nil 'type-break-time-warning-alarm))))))
+ ;(let (type-break-current-time-warning-interval)
+ ; (type-break-cancel-time-warning-schedule))
+ (type-break-run-at-time (max 1 time) nil 'type-break-time-warning-alarm)
+
+ (cond
+ (resetp
+ (setq type-break-warning-countdown-string nil))
+ (t
+ (setq type-break-warning-countdown-string (number-to-string time))
+ (setq type-break-warning-countdown-string-type "seconds"))))))))
(defun type-break-cancel-time-warning-schedule ()
- (let ((timer-dont-exit t))
- (cancel-function-timers 'type-break-time-warning-alarm))
+ (type-break-cancel-function-timers 'type-break-time-warning-alarm)
(remove-hook 'type-break-post-command-hook 'type-break-time-warning)
(setq type-break-current-time-warning-interval
- type-break-time-warning-intervals))
+ type-break-time-warning-intervals)
+ (setq type-break-warning-countdown-string nil))
(defun type-break-alarm ()
- (setq type-break-alarm-p t))
+ (type-break-check-post-command-hook)
+ (setq type-break-alarm-p t)
+ (type-break-mode-line-countdown-or-break 'break))
(defun type-break-time-warning-alarm ()
+ (type-break-check-post-command-hook)
(type-break-time-warning-schedule)
(setq type-break-time-warning-count type-break-warning-repeat)
- (add-hook 'type-break-post-command-hook 'type-break-time-warning 'append))
+ (type-break-time-warning)
+ (type-break-mode-line-countdown-or-break 'countdown))
\f
(defun type-break-run-tb-post-command-hook ()
type-break-good-rest-interval)
(progn
(type-break-keystroke-reset)
+ (type-break-mode-line-countdown-or-break nil)
(setq type-break-time-last-break (current-time))
(type-break-schedule)))
(setq type-break-time-last-command (current-time))))
(and type-break-keystroke-threshold
- (setq type-break-keystroke-count
- (+ type-break-keystroke-count (length (this-command-keys)))))
+ ;; next line is test for 20.2 that can be deleted
+ ;;(setq type-break-keystroke-count (1+ type-break-keystroke-count))
+ (let ((keys (this-command-keys)))
+ (cond
+ ;; Ignore mouse motion
+ ((and (vectorp keys)
+ (consp (aref keys 0))
+ (memq (car (aref keys 0)) '(mouse-movement))))
+ (t
+ (setq type-break-keystroke-count
+ (+ type-break-keystroke-count (length keys)))))))
- ;; This has been optimized for speed; calls to input-pending-p and
- ;; checking for the minibuffer window are only done if it would
- ;; matter for the sake of querying user.
(cond
(type-break-alarm-p
(cond
(type-break-schedule))
(t
;; If keystroke count is within min-threshold of
- ;; max-threshold, lower it to reduce the liklihood of an
+ ;; max-threshold, lower it to reduce the likelihood of an
;; immediate subsequent query.
(and max-threshold
min-threshold
(type-break-query)))))
;; This should return t if warnings were enabled, nil otherwise.
-(defsubst type-break-check-keystroke-warning ()
+(defun type-break-check-keystroke-warning ()
+ ;; This is safe because the caller should have checked that the cdr was
+ ;; non-nil already.
(let ((left (- (cdr type-break-keystroke-threshold)
type-break-keystroke-count)))
(cond
(cdr type-break-current-keystroke-warning-interval)))
(setq type-break-keystroke-warning-count type-break-warning-repeat)
(add-hook 'type-break-post-command-hook 'type-break-keystroke-warning)
+ (setq type-break-warning-countdown-string (number-to-string left))
+ (setq type-break-warning-countdown-string-type "keystrokes")
+ (type-break-mode-line-countdown-or-break 'countdown)
t))))
+;; Arrange for a break query to be made, when the user stops typing furiously.
(defun type-break-query ()
- (condition-case ()
- (cond
- ((let ((type-break-mode nil))
- (funcall type-break-query-function "Take a break from typing now? "))
- (type-break))
- (t
- (type-break-schedule type-break-query-interval)))
- (quit
- (type-break-schedule type-break-query-interval))))
+ (add-hook 'type-break-post-command-hook 'type-break-do-query))
+
+(defun type-break-do-query ()
+ (cond
+ ((not type-break-query-mode)
+ (type-break-noninteractive-query)
+ (type-break-schedule type-break-query-interval)
+ (remove-hook 'type-break-post-command-hook 'type-break-do-query))
+ ((sit-for 2)
+ (condition-case ()
+ (cond
+ ((let ((type-break-mode nil)
+ ;; yes-or-no-p sets this-command to exit-minibuffer,
+ ;; which hoses undo or yank-pop (if you happened to be
+ ;; yanking just when the query occurred).
+ (this-command this-command))
+ (funcall type-break-query-function
+ "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))))
+
+(defun type-break-noninteractive-query (&optional ignored-args)
+ "Null query function which doesn't interrupt user and assumes `no'.
+It prints a reminder in the echo area to take a break, but doesn't enforce
+this or ask the user to start one right now."
+ (cond
+ (type-break-mode-line-message-mode)
+ (t
+ (beep t)
+ (message "You should take a typing break now. Do `M-x type-break'.")
+ (sit-for 1)
+ (beep t)
+ ;; return nil so query caller knows to reset reminder, as if user
+ ;; said "no" in response to yes-or-no-p.
+ nil)))
(defun type-break-time-warning ()
(cond
((and (car type-break-keystroke-threshold)
(< type-break-keystroke-count (car type-break-keystroke-threshold))))
((> type-break-time-warning-count 0)
- (cond
- ((eq (selected-window) (minibuffer-window)))
- (t
- ;; Pause for a moment so previous messages can be seen.
- (sit-for 2)
- (message "Warning: typing break due in %s."
- (type-break-format-time
- (type-break-time-difference (current-time)
- type-break-time-next-break)))
- (setq type-break-time-warning-count
- (1- type-break-time-warning-count)))))
+ (let ((timeleft (type-break-time-difference (current-time)
+ type-break-time-next-break)))
+ (setq type-break-warning-countdown-string (number-to-string timeleft))
+ (cond
+ ((eq (selected-window) (minibuffer-window)))
+ ;; Do nothing if the command was just a prefix arg, since that will
+ ;; immediately be followed by some other interactive command.
+ ;; Otherwise, it is particularly annoying for the sit-for below to
+ ;; delay redisplay when one types sequences like `C-u -1 C-l'.
+ ((memq this-command '(digit-argument universal-argument)))
+ ((not type-break-mode-line-message-mode)
+ ;; Pause for a moment so any previous message can be seen.
+ (sit-for 2)
+ (message "Warning: typing break due in %s."
+ (type-break-format-time timeleft))
+ (setq type-break-time-warning-count
+ (1- type-break-time-warning-count))))))
(t
- (remove-hook 'type-break-post-command-hook 'type-break-time-warning))))
+ (remove-hook 'type-break-post-command-hook 'type-break-time-warning)
+ (setq type-break-warning-countdown-string nil))))
(defun type-break-keystroke-warning ()
(cond
((> type-break-keystroke-warning-count 0)
+ (setq type-break-warning-countdown-string
+ (number-to-string (- (cdr type-break-keystroke-threshold)
+ type-break-keystroke-count)))
(cond
((eq (selected-window) (minibuffer-window)))
- (t
+ ;; Do nothing if the command was just a prefix arg, since that will
+ ;; immediately be followed by some other interactive command.
+ ;; Otherwise, it is particularly annoying for the sit-for below to
+ ;; delay redisplay when one types sequences like `C-u -1 C-l'.
+ ((memq this-command '(digit-argument universal-argument)))
+ ((not type-break-mode-line-message-mode)
(sit-for 2)
(message "Warning: typing break due in %s keystrokes."
(- (cdr type-break-keystroke-threshold)
(1- type-break-keystroke-warning-count)))))
(t
(remove-hook 'type-break-post-command-hook
- 'type-break-keystroke-warning))))
+ 'type-break-keystroke-warning)
+ (setq type-break-warning-countdown-string nil))))
+
+(defun type-break-mode-line-countdown-or-break (&optional type)
+ (cond
+ ((not type-break-mode-line-message-mode))
+ ((eq type 'countdown)
+ ;(setq type-break-mode-line-break-message-p nil)
+ (add-hook 'type-break-post-command-hook
+ 'type-break-force-mode-line-update 'append))
+ ((eq type 'break)
+ ;; Alternate
+ (setq type-break-mode-line-break-message-p
+ (not type-break-mode-line-break-message-p))
+ (remove-hook 'type-break-post-command-hook
+ 'type-break-force-mode-line-update))
+ (t
+ (setq type-break-mode-line-break-message-p nil)
+ (setq type-break-warning-countdown-string nil)
+ (remove-hook 'type-break-post-command-hook
+ 'type-break-force-mode-line-update)))
+ (type-break-force-mode-line-update))
\f
;;;###autoload
(interactive)
(with-output-to-temp-buffer "*Typing Break Statistics*"
(princ (format "Typing break statistics\n-----------------------\n
-Last typing break : %s
+Typing break mode is currently %s.
+Interactive query for breaks is %s.
+Warnings of imminent typing breaks in mode line is %s.
+
+Last typing break ended : %s
Next scheduled typing break : %s\n
Minimum keystroke threshold : %s
Maximum keystroke threshold : %s
Current keystroke count : %s"
+ (if type-break-mode "enabled" "disabled")
+ (if type-break-query-mode "enabled" "disabled")
+ (if type-break-mode-line-message-mode "enabled" "disabled")
(if type-break-time-last-break
(current-time-string type-break-time-last-break)
"never")
type-break-keystroke-count))))
;;;###autoload
-(defun type-break-guestimate-keystroke-threshold (wpm &optional wordlen frac)
+(defun type-break-guesstimate-keystroke-threshold (wpm &optional wordlen frac)
"Guess values for the minimum/maximum keystroke threshold for typing breaks.
+
If called interactively, the user is prompted for their guess as to how
-many words per minute they usually type. From that, the command sets the
-values in `type-break-keystroke-threshold' based on a fairly simple
-algorithm involving assumptions about the average length of words (5).
-For the minimum threshold, it uses about a quarter of the computed maximum
-threshold.
+many words per minute they usually type. This value should not be your
+maximum WPM, but your average. Of course, this is harder to gauge since it
+can vary considerably depending on what you are doing. For example, one
+tends to type less when debugging a program as opposed to writing
+documentation. (Perhaps a separate program should be written to estimate
+average typing speed.)
+
+From that, this command sets the values in `type-break-keystroke-threshold'
+based on a fairly simple algorithm involving assumptions about the average
+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
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
2 would mean to use one half, a value of 4 would mean to use one quarter, etc."
- (interactive "NHow many words per minute do you type? ")
+ (interactive "NOn average, how many words per minute do you type? ")
(let* ((upper (* wpm (or wordlen 5) (/ type-break-interval 60)))
(lower (/ upper (or frac 5))))
(or type-break-keystroke-threshold
;; Use addition rather than logand since that is more robust; the low 16
;; bits of the seconds might have been incremented, making it more than 16
;; bits wide.
-(defsubst type-break-time-difference (a b)
+(defun type-break-time-difference (a b)
(+ (lsh (- (car b) (car a)) 16)
(- (car (cdr b)) (car (cdr a)))))
;; This function keeps the high and low 16 bits of the seconds properly
;; balanced so that the lower value never exceeds 16 bits. Otherwise, when
;; the result is passed to `current-time-string' it will toss some of the
-;; "low" bits and return the wrong value.
+;; "low" bits and format the time incorrectly.
(defun type-break-time-sum (&rest tmlist)
(let ((high 0)
(low 0)
(list high low micro)))
-(defsubst type-break-format-time (secs)
+(defun type-break-format-time (secs)
(let ((mins (/ secs 60)))
(cond
((= mins 1) (format "%d minute" mins))
type-break-keystroke-warning-intervals)
(remove-hook 'type-break-post-command-hook 'type-break-keystroke-warning))
+(defun type-break-force-mode-line-update (&optional all)
+ "Force the mode-line of the current buffer to be redisplayed.
+With optional non-nil ALL, force redisplay of all mode-lines."
+ (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
+;; 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
+;; of restoring it. This function is called from the timers to restore it,
+;; just in case.
+(defun type-break-check-post-command-hook ()
+ (add-hook 'post-command-hook 'type-break-run-tb-post-command-hook 'append))
+
+\f
+;;; Timer wrapper functions
+;;;
+;;; These shield type-break from variations in the interval timer packages
+;;; 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)))))
+
+(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))
+ (let ((list itimer-list))
+ (while list
+ (and (eq (funcall 'itimer-function (car list)) function)
+ (funcall 'delete-itimer (car list)))
+ (setq list (cdr list)))))))
+
\f
;;; Demo wrappers
(read-char)
(kill-buffer "*Life*"))
(life-extinct
- (message (get 'life-extinct 'error-message))
+ (message "%s" (get 'life-extinct 'error-message))
(sit-for 3)
;; restart demo
(setq continue t))
\f
(provide 'type-break)
-;; Do not do this at load time because it makes it impossible to load this
-;; file into temacs and then dump it.
-;(type-break-mode t)
-
-;; local variables:
-;; vc-make-backup-files: t
-;; end:
-
+(if type-break-mode
+ (type-break-mode 1))
;;; type-break.el ends here
HCoop / bpt / emacs.git / blobdiff