annotate lisp/type-break.el @ 56216:efd6af30bde2

(Fsnarf_documentation): Doc fix.
author Luc Teirlinck <teirllm@auburn.edu>
date Wed, 23 Jun 2004 17:00:06 +0000
parents 51108148b11d
children a14f0e52fd5e 0c11f1f77626 4c90ffeb71c5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
1 ;;; type-break.el --- encourage rests from typing at appropriate intervals
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
2
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
3 ;; Copyright (C) 1994, 95, 97, 2000, 2004 Free Software Foundation, Inc.
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
4
23240
b9d8ec6db59a Comment fixes only.
Noah Friedman <friedman@splode.com>
parents: 23239
diff changeset
5 ;; Author: Noah Friedman
b9d8ec6db59a Comment fixes only.
Noah Friedman <friedman@splode.com>
parents: 23239
diff changeset
6 ;; Maintainer: Noah Friedman <friedman@splode.com>
9355
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
7 ;; Keywords: extensions, timers
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
8 ;; Status: Works in GNU Emacs 19.25 or later, some versions of XEmacs
9355
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
9 ;; Created: 1994-07-13
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
10
9355
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
11 ;; This file is part of GNU Emacs.
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
12
9355
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
14 ;; it under the terms of the GNU General Public License as published by
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
15 ;; the Free Software Foundation; either version 2, or (at your option)
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
16 ;; any later version.
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
17
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
18 ;; GNU Emacs is distributed in the hope that it will be useful,
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
21 ;; GNU General Public License for more details.
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
22
8ac258bc59ef Assign copyright to FSF, and change comments to reflect that type-break
Noah Friedman <friedman@splode.com>
parents: 8497
diff changeset
23 ;; You should have received a copy of the GNU General Public License
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
26 ;; Boston, MA 02111-1307, USA.
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
27
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
28 ;;; Commentary:
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
29
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
30 ;; The docstring for the function `type-break-mode' summarizes most of the
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
31 ;; details of the interface.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
32
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
33 ;; This package relies on the assumption that you live entirely in Emacs,
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
34 ;; as the author does. If that's not the case for you (e.g. you often
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
35 ;; suspend Emacs or work in other windows) then this won't help very much;
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
36 ;; it will depend on just how often you switch back to Emacs. At the very
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
37 ;; least, you will want to turn off the keystroke thresholds and rest
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
38 ;; interval tracking.
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
39
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
40 ;; If you prefer not to be queried about taking breaks, but instead just
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
41 ;; want to be reminded, do the following:
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
42 ;;
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
43 ;; (setq type-break-query-mode nil)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
44 ;;
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
45 ;; Or call the command `type-break-query-mode' with a negative prefix
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
46 ;; argument.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
47
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
48 ;; If you find echo area messages annoying and would prefer to see messages
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
49 ;; in the mode line instead, do M-x type-break-mode-line-message-mode
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
50 ;; or set the variable of the same name to `t'.
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
51
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
52 ;; This program can truly cons up a storm because of all the calls to
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
53 ;; `current-time' (which always returns 3 fresh conses). I'm dismayed by
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
54 ;; this, but I think the health of my hands is far more important than a
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
55 ;; few pages of virtual memory.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
56
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
57 ;; This program has no hope of working in Emacs 18.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
58
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
59 ;; This package was inspired by Roland McGrath's hanoi-break.el.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
60 ;; Several people contributed feedback and ideas, including
25278
cbe304a26771 Fix maintainer address.
Karl Heuer <kwzh@gnu.org>
parents: 24648
diff changeset
61 ;; Roland McGrath <roland@gnu.org>
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
62 ;; Kleanthes Koniaris <kgk@koniaris.com>
25278
cbe304a26771 Fix maintainer address.
Karl Heuer <kwzh@gnu.org>
parents: 24648
diff changeset
63 ;; Mark Ashton <mpashton@gnu.org>
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
64 ;; Matt Wilding <wilding@cli.com>
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
65 ;; Robert S. Boyer <boyer@cs.utexas.edu>
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
66
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
67 ;;; Code:
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
68
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
69
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
70 (defgroup type-break nil
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
71 "Encourage the user to take a rest from typing at suitable intervals."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
72 :prefix "type-break"
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
73 :group 'keyboard)
5939
454dc146502d Initial revision
Roland McGrath <roland@gnu.org>
parents:
diff changeset
74
454dc146502d Initial revision
Roland McGrath <roland@gnu.org>
parents:
diff changeset
75 ;;;###autoload
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
76 (defcustom type-break-mode nil
24547
ab118f20a10b (type-break-mode): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 23240
diff changeset
77 "Toggle typing break mode.
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
78 See the docstring for the `type-break-mode' command for more information.
24648
4c102f02bdcd (type-break-mode): Doc fix.
Dave Love <fx@gnu.org>
parents: 24550
diff changeset
79 Setting this variable directly does not take effect;
4c102f02bdcd (type-break-mode): Doc fix.
Dave Love <fx@gnu.org>
parents: 24550
diff changeset
80 use either \\[customize] or the function `type-break-mode'."
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
81 :set (lambda (symbol value)
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
82 (type-break-mode (if value 1 -1)))
23239
b88e81176427 (type-break-mode): remove :version field from defcustom declaration.
Noah Friedman <friedman@splode.com>
parents: 22069
diff changeset
83 :initialize 'custom-initialize-default
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
84 :type 'boolean
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
85 :group 'type-break
23239
b88e81176427 (type-break-mode): remove :version field from defcustom declaration.
Noah Friedman <friedman@splode.com>
parents: 22069
diff changeset
86 :require 'type-break)
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
87
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
88 ;;;###autoload
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
89 (defcustom type-break-interval (* 60 60)
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
90 "*Number of seconds between scheduled typing breaks."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
91 :type 'integer
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
92 :group 'type-break)
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
93
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
94 ;;;###autoload
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
95 (defcustom type-break-good-rest-interval (/ type-break-interval 6)
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
96 "*Number of seconds of idle time considered to be an adequate typing rest.
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
97
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
98 When this variable is non-nil, Emacs checks the idle time between
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
99 keystrokes. If this idle time is long enough to be considered a \"good\"
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
100 rest from typing, then the next typing break is simply rescheduled for later.
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
101
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
102 If a break is interrupted before this much time elapses, the user will be
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
103 asked whether or not really to interrupt the break."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
104 :type 'integer
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
105 :group 'type-break)
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
106
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
107 ;;;###autoload
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
108 (defcustom type-break-good-break-interval nil
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
109 "*Number of seconds considered to be an adequate explicit typing rest.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
110
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
111 When this variable is non-nil, its value is considered to be a \"good\"
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
112 length (in seconds) for a break initiated by the command `type-break',
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
113 overriding `type-break-good-rest-interval'. This provides querying of
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
114 break interruptions when `type-break-good-rest-interval' is nil."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
115 :type 'integer
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
116 :group 'type-break)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
117
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
118 ;;;###autoload
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
119 (defcustom type-break-keystroke-threshold
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
120 ;; Assuming typing speed is 35wpm (on the average, do you really
8282
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
121 ;; type more than that in a minute? I spend a lot of time reading mail
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
122 ;; and simply studying code in buffers) and average word length is
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
123 ;; about 5 letters, default upper threshold to the average number of
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
124 ;; keystrokes one is likely to type in a break interval. That way if the
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
125 ;; user goes through a furious burst of typing activity, cause a typing
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
126 ;; break to be required sooner than originally scheduled.
8282
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
127 ;; Conversely, the minimum threshold should be about a fifth of this.
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
128 (let* ((wpm 35)
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
129 (avg-word-length 5)
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
130 (upper (* wpm avg-word-length (/ type-break-interval 60)))
8282
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
131 (lower (/ upper 5)))
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
132 (cons lower upper))
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
133 "*Upper and lower bound on number of keystrokes for considering typing break.
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
134 This structure is a pair of numbers (MIN . MAX).
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
135
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
136 The first number is the minimum number of keystrokes that must have been
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
137 entered since the last typing break before considering another one, even if
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
138 the scheduled time has elapsed; the break is simply rescheduled until later
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
139 if the minimum threshold hasn't been reached. If this first value is nil,
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
140 then there is no minimum threshold; as soon as the scheduled time has
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
141 elapsed, the user will always be queried.
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
142
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
143 The second number is the maximum number of keystrokes that can be entered
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
144 before a typing break is requested immediately, pre-empting the originally
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
145 scheduled break. If this second value is nil, then no pre-emptive breaks
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
146 will occur; only scheduled ones will.
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
147
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
148 Keys with bucky bits (shift, control, meta, etc) are counted as only one
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
149 keystroke even though they really require multiple keys to generate them.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
150
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
151 The command `type-break-guesstimate-keystroke-threshold' can be used to
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
152 guess a reasonably good pair of values for this variable."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
153 :type 'sexp
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
154 :group 'type-break)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
155
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
156 (defcustom type-break-query-mode t
50868
7588d6aa3cb7 (type-break-good-rest-interval, type-break-query-mode)
Juanma Barranquero <lekktu@gmail.com>
parents: 50551
diff changeset
157 "*Non-nil means ask whether or not to prompt user for breaks.
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
158 If so, call the function specified in the value of the variable
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
159 `type-break-query-function' to do the asking."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
160 :type 'boolean
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
161 :group 'type-break)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
162
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
163 (defcustom type-break-query-function 'yes-or-no-p
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
164 "*Function to use for making query for a typing break.
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
165 It should take a string as an argument, the prompt.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
166 Usually this should be set to `yes-or-no-p' or `y-or-n-p'.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
167
50868
7588d6aa3cb7 (type-break-good-rest-interval, type-break-query-mode)
Juanma Barranquero <lekktu@gmail.com>
parents: 50551
diff changeset
168 To avoid being queried at all, set `type-break-query-mode' to nil."
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
169 :type '(radio function
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
170 (function-item yes-or-no-p)
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
171 (function-item y-or-n-p))
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
172 :group 'type-break)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
173
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
174 (defcustom type-break-query-interval 60
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
175 "*Number of seconds between queries to take a break, if put off.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
176 The user will continue to be prompted at this interval until he or she
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
177 finally submits to taking a typing break."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
178 :type 'integer
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
179 :group 'type-break)
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
180
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
181 (defcustom type-break-time-warning-intervals '(300 120 60 30)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
182 "*List of time intervals for warnings about upcoming typing break.
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
183 At each of the intervals (specified in seconds) away from a scheduled
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
184 typing break, print a warning in the echo area."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
185 :type '(repeat integer)
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
186 :group 'type-break)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
187
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
188 (defcustom type-break-keystroke-warning-intervals '(300 200 100 50)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
189 "*List of keystroke measurements for warnings about upcoming typing break.
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
190 At each of the intervals (specified in keystrokes) away from the upper
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
191 keystroke threshold, print a warning in the echo area.
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
192 If either this variable or the upper threshold is set, then no warnings
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
193 will occur."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
194 :type '(repeat integer)
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
195 :group 'type-break)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
196
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
197 (defcustom type-break-warning-repeat 40
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
198 "*Number of keystrokes for which warnings should be repeated.
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
199 That is, for each of this many keystrokes the warning is redisplayed
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
200 in the echo area to make sure it's really seen."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
201 :type 'integer
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
202 :group 'type-break)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
203
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
204 (defcustom type-break-time-stamp-format "[%H:%M] "
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
205 "*Timestamp format used to prefix messages.
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
206 Format specifiers are as used by `format-time-string'."
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
207 :type 'string
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
208 :group 'type-break)
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
209
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
210 (defcustom type-break-demo-functions
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
211 '(type-break-demo-boring type-break-demo-life type-break-demo-hanoi)
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
212 "*List of functions to consider running as demos during typing breaks.
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
213 When a typing break begins, one of these functions is selected randomly
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
214 to have Emacs do something interesting.
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
215
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
216 Any function in this list should start a demo which ceases as soon as a
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
217 key is pressed."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
218 :type '(repeat function)
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
219 :group 'type-break)
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
220
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
221 (defcustom type-break-demo-boring-stats nil
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
222 "*Show word per minute and keystroke figures in the Boring demo."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
223 :type 'boolean
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
224 :group 'type-break)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
225
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
226 (defcustom type-break-terse-messages nil
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
227 "*Use slightly terser messages."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
228 :type 'boolean
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
229 :group 'type-break)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
230
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
231 (defcustom type-break-file-name (convert-standard-filename "~/.type-break")
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
232 "*Name of file used to save state across sessions."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
233 :type 'file
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
234 :group 'type-break)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
235
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
236 (defvar type-break-post-command-hook '(type-break-check)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
237 "Hook run indirectly by `post-command-hook' for typing break functions.
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
238 This is not really intended to be set by the user, but it's probably
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
239 harmless to do so. Mainly it is used by various parts of the typing break
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
240 program to delay actions until after the user has completed some command.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
241 It exists because `post-command-hook' itself is inaccessible while its
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
242 functions are being run, and some type-break--related functions want to
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
243 remove themselves after running.")
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
244
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
245
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
246 ;; Mode line frobs
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
247
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
248 (defcustom type-break-mode-line-message-mode nil
50868
7588d6aa3cb7 (type-break-good-rest-interval, type-break-query-mode)
Juanma Barranquero <lekktu@gmail.com>
parents: 50551
diff changeset
249 "*Non-nil means put type-break related messages in the mode line.
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
250 Otherwise, messages typically go in the echo area.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
251
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
252 See also `type-break-mode-line-format' and its members."
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
253 :type 'boolean
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
254 :group 'type-break)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
255
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
256 (defvar type-break-mode-line-format
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
257 '(type-break-mode-line-message-mode
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
258 (""
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
259 type-break-mode-line-break-message
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
260 type-break-mode-line-warning))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
261 "*Format of messages in the mode line concerning typing breaks.")
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
262
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
263 (defvar type-break-mode-line-break-message
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
264 '(type-break-mode-line-break-message-p
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
265 type-break-mode-line-break-string))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
266
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
267 (defvar type-break-mode-line-break-message-p nil)
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
268 (defvar type-break-mode-line-break-string " *** TAKE A TYPING BREAK NOW ***")
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
269
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
270 (defvar type-break-mode-line-warning
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
271 '(type-break-mode-line-break-message-p
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
272 ("")
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
273 (type-break-warning-countdown-string
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
274 (" *** "
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
275 "Break in "
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
276 type-break-warning-countdown-string
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
277 " "
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
278 type-break-warning-countdown-string-type
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
279 "***"))))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
280
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
281 (defvar type-break-warning-countdown-string nil
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
282 "If non-nil, this is a countdown for the next typing break.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
283
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
284 This variable, in conjunction with `type-break-warning-countdown-string-type'
50551
f51ff6ca84ca (type-break-warning-countdown-string): Doc fix; escape open paren at col 0.
John Paul Wallington <jpw@pobox.com>
parents: 34145
diff changeset
285 \(which indicates whether this value is a number of keystrokes or seconds)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
286 is installed in `mode-line-format' to notify of imminent typing breaks.")
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
287
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
288 (defvar type-break-warning-countdown-string-type nil
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
289 "Indicates the unit type of `type-break-warning-countdown-string'.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
290 It will be either \"seconds\" or \"keystrokes\".")
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
291
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
292
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
293 ;; These are internal variables. Do not set them yourself.
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
294
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
295 (defvar type-break-alarm-p nil)
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
296 (defvar type-break-keystroke-count 0)
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
297 (defvar type-break-time-last-break nil)
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
298 (defvar type-break-time-next-break nil)
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
299 (defvar type-break-time-last-command (current-time))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
300 (defvar type-break-current-time-warning-interval nil)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
301 (defvar type-break-current-keystroke-warning-interval nil)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
302 (defvar type-break-time-warning-count 0)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
303 (defvar type-break-keystroke-warning-count 0)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
304 (defvar type-break-interval-start nil)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
305
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
306
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
307 ;;;###autoload
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
308 (defun type-break-mode (&optional prefix)
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
309 "Enable or disable typing-break mode.
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
310 This is a minor mode, but it is global to all buffers by default.
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
311
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
312 When this mode is enabled, the user is encouraged to take typing breaks at
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
313 appropriate intervals; either after a specified amount of time or when the
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
314 user has exceeded a keystroke threshold. When the time arrives, the user
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
315 is asked to take a break. If the user refuses at that time, Emacs will ask
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
316 again in a short period of time. The idea is to give the user enough time
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
317 to find a good breaking point in his or her work, but be sufficiently
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
318 annoying to discourage putting typing breaks off indefinitely.
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
319
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
320 A negative prefix argument disables this mode.
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
321 No argument or any non-negative argument enables it.
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
322
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
323 The user may enable or disable this mode by setting the variable of the
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
324 same name, though setting it in that way doesn't reschedule a break or
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
325 reset the keystroke counter.
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
326
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
327 If the mode was previously disabled and is enabled as a consequence of
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
328 calling this function, it schedules a break with `type-break-schedule' to
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
329 make sure one occurs (the user can call that command to reschedule the
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
330 break at any time). It also initializes the keystroke counter.
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
331
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
332 The variable `type-break-interval' specifies the number of seconds to
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
333 schedule between regular typing breaks. This variable doesn't directly
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
334 affect the time schedule; it simply provides a default for the
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
335 `type-break-schedule' command.
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
336
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
337 If set, the variable `type-break-good-rest-interval' specifies the minimum
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
338 amount of time which is considered a reasonable typing break. Whenever
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
339 that time has elapsed, typing breaks are automatically rescheduled for
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
340 later even if Emacs didn't prompt you to take one first. Also, if a break
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
341 is ended before this much time has elapsed, the user will be asked whether
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
342 or not to continue. A nil value for this variable prevents automatic
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
343 break rescheduling, making `type-break-interval' an upper bound on the time
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
344 between breaks. In this case breaks will be prompted for as usual before
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
345 the upper bound if the keystroke threshold is reached.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
346
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
347 If `type-break-good-rest-interval' is nil and
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
348 `type-break-good-break-interval' is set, then confirmation is required to
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
349 interrupt a break before `type-break-good-break-interval' seconds
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
350 have passed. This provides for an upper bound on the time between breaks
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
351 together with confirmation of interruptions to these breaks.
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
352
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
353 The variable `type-break-keystroke-threshold' is used to determine the
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
354 thresholds at which typing breaks should be considered. You can use
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
355 the command `type-break-guesstimate-keystroke-threshold' to try to
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
356 approximate good values for this.
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
357
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
358 There are several variables that affect how or when warning messages about
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
359 imminent typing breaks are displayed. They include:
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
360
22049
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
361 `type-break-mode-line-message-mode'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
362 `type-break-time-warning-intervals'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
363 `type-break-keystroke-warning-intervals'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
364 `type-break-warning-repeat'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
365 `type-break-warning-countdown-string'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
366 `type-break-warning-countdown-string-type'
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
367
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
368 There are several variables that affect if, how, and when queries to begin
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
369 a typing break occur. They include:
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
370
22049
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
371 `type-break-query-mode'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
372 `type-break-query-function'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
373 `type-break-query-interval'
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
374
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
375 The command `type-break-statistics' prints interesting things.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
376
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
377 Finally, a file (named `type-break-file-name') is used to store information
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
378 across Emacs sessions. This provides recovery of the break status between
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
379 sessions and after a crash. Manual changes to the file may result in
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
380 problems."
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
381 (interactive "P")
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
382 (type-break-check-post-command-hook)
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
383
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
384 (let ((already-enabled type-break-mode))
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
385 (setq type-break-mode (>= (prefix-numeric-value prefix) 0))
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
386
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
387 (cond
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
388 ((and already-enabled type-break-mode)
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
389 (and (interactive-p)
22049
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
390 (message "Type Break mode is already enabled")))
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
391 (type-break-mode
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
392 (or global-mode-string
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
393 (setq global-mode-string '("")))
22069
3df130425e5e (type-break-mode): Don't alter global-mode-string.
Richard M. Stallman <rms@gnu.org>
parents: 22049
diff changeset
394 (or (assq 'type-break-mode-line-message-mode
3df130425e5e (type-break-mode): Don't alter global-mode-string.
Richard M. Stallman <rms@gnu.org>
parents: 22049
diff changeset
395 minor-mode-alist)
3df130425e5e (type-break-mode): Don't alter global-mode-string.
Richard M. Stallman <rms@gnu.org>
parents: 22049
diff changeset
396 (setq minor-mode-alist
3df130425e5e (type-break-mode): Don't alter global-mode-string.
Richard M. Stallman <rms@gnu.org>
parents: 22049
diff changeset
397 (cons type-break-mode-line-format
3df130425e5e (type-break-mode): Don't alter global-mode-string.
Richard M. Stallman <rms@gnu.org>
parents: 22049
diff changeset
398 minor-mode-alist)))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
399 (type-break-keystroke-reset)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
400 (type-break-mode-line-countdown-or-break nil)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
401
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
402 (if (boundp 'save-some-buffers-always)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
403 (add-to-list 'save-some-buffers-always
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
404 (expand-file-name type-break-file-name)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
405
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
406 (setq type-break-time-last-break (type-break-get-previous-time))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
407
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
408 ;; schedule according to break time from session file
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
409 (type-break-schedule
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
410 (let (diff)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
411 (if (and type-break-time-last-break
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
412 (< (setq diff (type-break-time-difference
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
413 type-break-time-last-break
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
414 (current-time)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
415 type-break-interval))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
416 ;; use the file's value
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
417 (progn
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
418 (setq type-break-keystroke-count
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
419 (type-break-get-previous-count))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
420 ;; file the time, in case it was read from the auto-save file
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
421 (type-break-file-time type-break-interval-start)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
422 (setq type-break-interval-start type-break-time-last-break)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
423 (- type-break-interval diff))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
424 ;; schedule from now
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
425 (setq type-break-interval-start (current-time))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
426 (type-break-file-time type-break-interval-start)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
427 type-break-interval))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
428 type-break-interval-start
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
429 type-break-interval)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
430
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
431 (and (interactive-p)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
432 (message "Type Break mode is enabled and set")))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
433 (t
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
434 (type-break-keystroke-reset)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
435 (type-break-mode-line-countdown-or-break nil)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
436 (type-break-cancel-schedule)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
437 (do-auto-save)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
438 (with-current-buffer (find-file-noselect type-break-file-name
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
439 'nowarn)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
440 (set-buffer-modified-p nil)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
441 (unlock-buffer)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
442 (kill-this-buffer))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
443 (if (boundp 'save-some-buffers-always)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
444 (setq save-some-buffers-always
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
445 (remove (expand-file-name type-break-file-name)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
446 save-some-buffers-always)))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
447 (and (interactive-p)
22049
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
448 (message "Type Break mode is disabled")))))
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
449 type-break-mode)
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
450
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
451 (defun type-break-mode-line-message-mode (&optional prefix)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
452 "Enable or disable warnings in the mode line about typing breaks.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
453
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
454 A negative PREFIX argument disables this mode.
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
455 No argument or any non-negative argument enables it.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
456
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
457 The user may also enable or disable this mode simply by setting the
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
458 variable of the same name.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
459
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
460 Variables controlling the display of messages in the mode line include:
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
461
22049
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
462 `mode-line-format'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
463 `global-mode-string'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
464 `type-break-mode-line-break-message'
247682b1da6b (type-break-mode-line-message-mode): Doc fix. Fix some messages.
Richard M. Stallman <rms@gnu.org>
parents: 21670
diff changeset
465 `type-break-mode-line-warning'"
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
466 (interactive "P")
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
467 (setq type-break-mode-line-message-mode
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
468 (>= (prefix-numeric-value prefix) 0))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
469 (and (interactive-p)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
470 (if type-break-mode-line-message-mode
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
471 (message "type-break-mode-line-message-mode is enabled")
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
472 (message "type-break-mode-line-message-mode is disabled")))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
473 type-break-mode-line-message-mode)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
474
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
475 (defun type-break-query-mode (&optional prefix)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
476 "Enable or disable warnings in the mode line about typing breaks.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
477
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
478 When enabled, the user is periodically queried about whether to take a
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
479 typing break at that moment. The function which does this query is
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
480 specified by the variable `type-break-query-function'.
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
481
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
482 A negative PREFIX argument disables this mode.
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
483 No argument or any non-negative argument enables it.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
484
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
485 The user may also enable or disable this mode simply by setting the
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
486 variable of the same name."
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
487 (interactive "P")
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
488 (setq type-break-query-mode
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
489 (>= (prefix-numeric-value prefix) 0))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
490 (and (interactive-p)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
491 (if type-break-query-mode
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
492 (message "type-break-query-mode is enabled")
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
493 (message "type-break-query-mode is disabled")))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
494 type-break-query-mode)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
495
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
496
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
497 ;;; session file functions
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
498
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
499 (defvar type-break-auto-save-file-name
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
500 (let ((buffer-file-name type-break-file-name))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
501 (make-auto-save-file-name))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
502 "Auto-save name of `type-break-file-name'.")
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
503
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
504 (defun type-break-file-time (&optional time)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
505 "File break time in `type-break-file-name', unless the file is locked."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
506 (if (not (stringp (file-locked-p type-break-file-name)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
507 (with-current-buffer (find-file-noselect type-break-file-name
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
508 'nowarn)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
509 (let ((inhibit-read-only t))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
510 (erase-buffer)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
511 (insert (format "%s\n\n" (or time type-break-interval-start)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
512 ;; file saving is left to auto-save
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
513 ))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
514
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
515 (defun type-break-file-keystroke-count ()
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
516 "File keystroke count in `type-break-file-name', unless the file is locked."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
517 (if (not (stringp (file-locked-p type-break-file-name)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
518 (with-current-buffer (find-file-noselect type-break-file-name
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
519 'nowarn)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
520 (save-excursion
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
521 (let ((inhibit-read-only t))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
522 (goto-char (point-min))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
523 (forward-line)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
524 (delete-region (point) (save-excursion (end-of-line) (point)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
525 (insert (format "%s" type-break-keystroke-count))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
526 ;; file saving is left to auto-save
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
527 )))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
528
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
529 (defun timep (time)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
530 "If TIME is in the format returned by `current-time' then
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
531 return TIME, else return nil."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
532 (and (listp time)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
533 (eq (length time) 3)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
534 (integerp (car time))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
535 (integerp (nth 1 time))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
536 (integerp (nth 2 time))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
537 time))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
538
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
539 (defun type-break-choose-file ()
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
540 "Return file to read from."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
541 (cond
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
542 ((and (file-exists-p type-break-auto-save-file-name)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
543 (file-readable-p type-break-auto-save-file-name))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
544 type-break-auto-save-file-name)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
545 ((and (file-exists-p type-break-file-name)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
546 (file-readable-p type-break-file-name))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
547 type-break-file-name)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
548 (t nil)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
549
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
550 (defun type-break-get-previous-time ()
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
551 "Get previous break time from `type-break-file-name'.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
552 Returns nil if the file is missing or if the time breaks with the
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
553 `current-time' format."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
554 (let ((file (type-break-choose-file)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
555 (if file
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
556 (timep ;; returns expected format, else nil
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
557 (with-current-buffer (find-file-noselect file 'nowarn)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
558 (save-excursion
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
559 (goto-char (point-min))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
560 (read (current-buffer))))))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
561
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
562 (defun type-break-get-previous-count ()
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
563 "Get previous keystroke count from `type-break-file-name'.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
564 Return 0 if the file is missing or if the form read is not an
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
565 integer."
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
566 (let ((file (type-break-choose-file)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
567 (if (and file
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
568 (integerp
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
569 (setq file
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
570 (with-current-buffer
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
571 (find-file-noselect file 'nowarn)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
572 (save-excursion
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
573 (goto-char (point-min))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
574 (forward-line 1)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
575 (read (current-buffer)))))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
576 file
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
577 0)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
578
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
579
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
580 ;;;###autoload
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
581 (defun type-break ()
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
582 "Take a typing break.
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
583
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
584 During the break, a demo selected from the functions listed in
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
585 `type-break-demo-functions' is run.
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
586
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
587 After the typing break is finished, the next break is scheduled
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
588 as per the function `type-break-schedule'."
5939
454dc146502d Initial revision
Roland McGrath <roland@gnu.org>
parents:
diff changeset
589 (interactive)
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
590 (do-auto-save)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
591 (type-break-cancel-schedule)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
592 ;; remove any query scheduled during interactive invocation
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
593 (remove-hook 'type-break-post-command-hook 'type-break-do-query)
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
594 (let ((continue t)
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
595 (start-time (current-time)))
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
596 (setq type-break-time-last-break start-time)
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
597 (while continue
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
598 (save-window-excursion
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
599 ;; Eat the screen.
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
600 (and (eq (selected-window) (minibuffer-window))
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
601 (other-window 1))
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
602 (delete-other-windows)
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
603 (scroll-right (window-width))
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
604 (unless type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
605 (message "Press any key to resume from typing break."))
5939
454dc146502d Initial revision
Roland McGrath <roland@gnu.org>
parents:
diff changeset
606
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
607 (random t)
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
608 (let* ((len (length type-break-demo-functions))
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
609 (idx (random len))
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
610 (fn (nth idx type-break-demo-functions)))
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
611 (condition-case ()
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
612 (funcall fn)
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
613 (error nil))))
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
614
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
615 (let ((good-interval (or type-break-good-rest-interval
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
616 type-break-good-break-interval)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
617 (cond
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
618 (good-interval
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
619 (let ((break-secs (type-break-time-difference
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
620 start-time (current-time))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
621 (cond
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
622 ((>= break-secs good-interval)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
623 (setq continue nil))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
624 ;; 60 seconds may be too much leeway if the break is only 3
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
625 ;; minutes to begin with. You can just say "no" to the query
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
626 ;; below if you're in that much of a hurry.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
627 ;;((> 60 (abs (- break-secs good-interval)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
628 ;; (setq continue nil))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
629 ((funcall
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
630 type-break-query-function
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
631 (format
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
632 (if type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
633 "%s%s remaining. Continue break? "
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
634 "%sYou really ought to rest %s more. Continue break? ")
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
635 (type-break-time-stamp)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
636 (type-break-format-time (- good-interval
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
637 break-secs)))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
638 (t
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
639 (setq continue nil)))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
640 (t (setq continue nil))))))
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
641
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
642 (type-break-keystroke-reset)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
643 (type-break-file-time)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
644 (type-break-mode-line-countdown-or-break nil)
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
645 (type-break-schedule))
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
646
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
647
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
648 (defun type-break-schedule (&optional time start interval)
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
649 "Schedule a typing break for TIME seconds from now.
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
650 If time is not specified it defaults to `type-break-interval'.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
651 START and INTERVAL are used when recovering a break.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
652 START is the start of the break (defaults to now).
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
653 INTERVAL is the full length of an interval (defaults to TIME)."
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
654 (interactive (list (and current-prefix-arg
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
655 (prefix-numeric-value current-prefix-arg))))
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
656 (or time (setq time type-break-interval))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
657 (type-break-check-post-command-hook)
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
658 (type-break-cancel-schedule)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
659 (type-break-time-warning-schedule time 'reset)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
660 (type-break-run-at-time (max 1 time) nil 'type-break-alarm)
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
661 (setq type-break-time-next-break
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
662 (type-break-time-sum (or start (current-time))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
663 (or interval time))))
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
664
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
665 (defun type-break-cancel-schedule ()
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
666 (type-break-cancel-time-warning-schedule)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
667 (type-break-cancel-function-timers 'type-break-alarm)
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
668 (setq type-break-alarm-p nil)
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
669 (setq type-break-time-next-break nil))
5939
454dc146502d Initial revision
Roland McGrath <roland@gnu.org>
parents:
diff changeset
670
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
671 (defun type-break-time-warning-schedule (&optional time resetp)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
672 (let ((type-break-current-time-warning-interval nil))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
673 (type-break-cancel-time-warning-schedule))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
674 (add-hook 'type-break-post-command-hook 'type-break-time-warning 'append)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
675 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
676 (type-break-time-warning-intervals
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
677 (and resetp
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
678 (setq type-break-current-time-warning-interval
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
679 type-break-time-warning-intervals))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
680
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
681 (or time
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
682 (setq time (type-break-time-difference (current-time)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
683 type-break-time-next-break)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
684
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
685 (while (and type-break-current-time-warning-interval
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
686 (> (car type-break-current-time-warning-interval) time))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
687 (setq type-break-current-time-warning-interval
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
688 (cdr type-break-current-time-warning-interval)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
689
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
690 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
691 (type-break-current-time-warning-interval
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
692 (setq time (- time (car type-break-current-time-warning-interval)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
693 (setq type-break-current-time-warning-interval
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
694 (cdr type-break-current-time-warning-interval))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
695
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
696 ;(let (type-break-current-time-warning-interval)
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
697 ; (type-break-cancel-time-warning-schedule))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
698 (type-break-run-at-time (max 1 time) nil 'type-break-time-warning-alarm)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
699
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
700 (cond
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
701 (resetp
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
702 (setq type-break-warning-countdown-string nil))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
703 (t
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
704 (setq type-break-warning-countdown-string (number-to-string time))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
705 (setq type-break-warning-countdown-string-type "seconds"))))))))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
706
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
707 (defun type-break-cancel-time-warning-schedule ()
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
708 (type-break-cancel-function-timers 'type-break-time-warning-alarm)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
709 (remove-hook 'type-break-post-command-hook 'type-break-time-warning)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
710 (setq type-break-current-time-warning-interval
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
711 type-break-time-warning-intervals)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
712 (setq type-break-time-warning-count 0) ; avoid warnings after break
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
713 (setq type-break-warning-countdown-string nil))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
714
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
715 (defun type-break-alarm ()
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
716 (type-break-check-post-command-hook)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
717 (setq type-break-alarm-p t)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
718 (type-break-mode-line-countdown-or-break 'break))
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
719
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
720 (defun type-break-time-warning-alarm ()
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
721 (type-break-check-post-command-hook)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
722 (type-break-time-warning-schedule)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
723 (setq type-break-time-warning-count type-break-warning-repeat)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
724 (type-break-time-warning)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
725 (type-break-mode-line-countdown-or-break 'countdown))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
726
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
727
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
728 (defun type-break-run-tb-post-command-hook ()
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
729 (and type-break-mode
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
730 (run-hooks 'type-break-post-command-hook)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
731
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
732 (defun type-break-check ()
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
733 "Ask to take a typing break if appropriate.
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
734 This may be the case either because the scheduled time has come \(and the
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
735 minimum keystroke threshold has been reached\) or because the maximum
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
736 keystroke threshold has been exceeded."
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
737 (type-break-file-keystroke-count)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
738 (let* ((min-threshold (car type-break-keystroke-threshold))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
739 (max-threshold (cdr type-break-keystroke-threshold)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
740 (and type-break-good-rest-interval
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
741 (progn
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
742 (and (> (type-break-time-difference
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
743 type-break-time-last-command (current-time))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
744 type-break-good-rest-interval)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
745 (progn
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
746 (type-break-keystroke-reset)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
747 (type-break-mode-line-countdown-or-break nil)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
748 (setq type-break-time-last-break (current-time))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
749 (type-break-schedule)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
750 (setq type-break-time-last-command (current-time))))
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
751
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
752 (and type-break-keystroke-threshold
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
753 (let ((keys (this-command-keys)))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
754 (cond
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
755 ;; Ignore mouse motion
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
756 ((and (vectorp keys)
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
757 (consp (aref keys 0))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
758 (memq (car (aref keys 0)) '(mouse-movement))))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
759 (t
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
760 (setq type-break-keystroke-count
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
761 (+ type-break-keystroke-count (length keys)))))))
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
762
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
763 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
764 (type-break-alarm-p
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
765 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
766 ((input-pending-p))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
767 ((eq (selected-window) (minibuffer-window)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
768 ((and min-threshold
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
769 (< type-break-keystroke-count min-threshold))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
770 (type-break-schedule))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
771 (t
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
772 ;; If keystroke count is within min-threshold of
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
773 ;; max-threshold, lower it to reduce the likelihood of an
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
774 ;; immediate subsequent query.
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
775 (and max-threshold
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
776 min-threshold
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
777 (< (- max-threshold type-break-keystroke-count) min-threshold)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
778 (progn
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
779 (type-break-keystroke-reset)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
780 (setq type-break-keystroke-count min-threshold)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
781 (type-break-query))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
782 ((and type-break-keystroke-warning-intervals
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
783 max-threshold
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
784 (= type-break-keystroke-warning-count 0)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
785 (type-break-check-keystroke-warning)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
786 ((and max-threshold
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
787 (> type-break-keystroke-count max-threshold)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
788 (not (input-pending-p))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
789 (not (eq (selected-window) (minibuffer-window))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
790 (type-break-keystroke-reset)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
791 (setq type-break-keystroke-count (or min-threshold 0))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
792 (type-break-query)))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
793
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
794 ;; This should return t if warnings were enabled, nil otherwise.
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
795 (defun type-break-check-keystroke-warning ()
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
796 ;; This is safe because the caller should have checked that the cdr was
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
797 ;; non-nil already.
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
798 (let ((left (- (cdr type-break-keystroke-threshold)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
799 type-break-keystroke-count)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
800 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
801 ((null (car type-break-current-keystroke-warning-interval))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
802 nil)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
803 ((> left (car type-break-current-keystroke-warning-interval))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
804 nil)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
805 (t
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
806 (while (and (car type-break-current-keystroke-warning-interval)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
807 (< left (car type-break-current-keystroke-warning-interval)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
808 (setq type-break-current-keystroke-warning-interval
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
809 (cdr type-break-current-keystroke-warning-interval)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
810 (setq type-break-keystroke-warning-count type-break-warning-repeat)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
811 (add-hook 'type-break-post-command-hook 'type-break-keystroke-warning)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
812 (setq type-break-warning-countdown-string (number-to-string left))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
813 (setq type-break-warning-countdown-string-type "keystrokes")
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
814 (type-break-mode-line-countdown-or-break 'countdown)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
815 t))))
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
816
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
817 ;; Arrange for a break query to be made, when the user stops typing furiously.
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
818 (defun type-break-query ()
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
819 (add-hook 'type-break-post-command-hook 'type-break-do-query))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
820
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
821 (defun type-break-do-query ()
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
822 (cond
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
823 ((not type-break-query-mode)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
824 (type-break-noninteractive-query)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
825 (type-break-schedule type-break-query-interval)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
826 (remove-hook 'type-break-post-command-hook 'type-break-do-query))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
827 ((sit-for 2)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
828 (condition-case ()
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
829 (cond
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
830 ((let ((type-break-mode nil)
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
831 ;; yes-or-no-p sets this-command to exit-minibuffer,
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
832 ;; which hoses undo or yank-pop (if you happened to be
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
833 ;; yanking just when the query occurred).
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
834 (this-command this-command))
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
835 ;; Cancel schedule to prevent possibility of a second query
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
836 ;; from taking place before this one has even returned.
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
837 ;; The condition-case wrapper will reschedule on quit.
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
838 (type-break-cancel-schedule)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
839 ;; Also prevent a second query when the break is interrupted.
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
840 (remove-hook 'type-break-post-command-hook 'type-break-do-query)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
841 (funcall type-break-query-function
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
842 (format "%s%s"
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
843 (type-break-time-stamp)
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
844 (if type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
845 "Break now? "
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
846 "Take a break from typing now? "))))
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
847 (type-break))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
848 (t
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
849 (type-break-schedule type-break-query-interval)))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
850 (quit
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
851 (type-break-schedule type-break-query-interval))))))
5939
454dc146502d Initial revision
Roland McGrath <roland@gnu.org>
parents:
diff changeset
852
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
853 (defun type-break-noninteractive-query (&optional ignored-args)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
854 "Null query function which doesn't interrupt user and assumes `no'.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
855 It prints a reminder in the echo area to take a break, but doesn't enforce
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
856 this or ask the user to start one right now."
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
857 (cond
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
858 (type-break-mode-line-message-mode)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
859 (t
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
860 (beep t)
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
861 (message "%sYou should take a typing break now. Do `M-x type-break'."
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
862 (type-break-time-stamp))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
863 (sit-for 1)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
864 (beep t)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
865 ;; return nil so query caller knows to reset reminder, as if user
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
866 ;; said "no" in response to yes-or-no-p.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
867 nil)))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
868
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
869 (defun type-break-time-warning ()
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
870 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
871 ((and (car type-break-keystroke-threshold)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
872 (< type-break-keystroke-count (car type-break-keystroke-threshold))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
873 ((> type-break-time-warning-count 0)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
874 (let ((timeleft (type-break-time-difference (current-time)
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
875 type-break-time-next-break)))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
876 (setq type-break-warning-countdown-string (number-to-string timeleft))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
877 (cond
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
878 ((eq (selected-window) (minibuffer-window)))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
879 ;; Do nothing if the command was just a prefix arg, since that will
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
880 ;; immediately be followed by some other interactive command.
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
881 ;; Otherwise, it is particularly annoying for the sit-for below to
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
882 ;; delay redisplay when one types sequences like `C-u -1 C-l'.
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
883 ((memq this-command '(digit-argument universal-argument)))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
884 ((not type-break-mode-line-message-mode)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
885 ;; Pause for a moment so any previous message can be seen.
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
886 (sit-for 2)
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
887 (message "%sWarning: typing break due in %s."
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
888 (type-break-time-stamp)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
889 (type-break-format-time timeleft))
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
890 (setq type-break-time-warning-count
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
891 (1- type-break-time-warning-count))))))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
892 (t
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
893 (remove-hook 'type-break-post-command-hook 'type-break-time-warning)
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
894 (setq type-break-warning-countdown-string nil))))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
895
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
896 (defun type-break-keystroke-warning ()
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
897 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
898 ((> type-break-keystroke-warning-count 0)
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
899 (setq type-break-warning-countdown-string
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
900 (number-to-string (- (cdr type-break-keystroke-threshold)
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
901 type-break-keystroke-count)))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
902 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
903 ((eq (selected-window) (minibuffer-window)))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
904 ;; Do nothing if the command was just a prefix arg, since that will
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
905 ;; immediately be followed by some other interactive command.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
906 ;; Otherwise, it is particularly annoying for the sit-for below to
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
907 ;; delay redisplay when one types sequences like `C-u -1 C-l'.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
908 ((memq this-command '(digit-argument universal-argument)))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
909 ((not type-break-mode-line-message-mode)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
910 (sit-for 2)
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
911 (message "%sWarning: typing break due in %s keystrokes."
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
912 (type-break-time-stamp)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
913 (- (cdr type-break-keystroke-threshold)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
914 type-break-keystroke-count))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
915 (setq type-break-keystroke-warning-count
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
916 (1- type-break-keystroke-warning-count)))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
917 (t
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
918 (remove-hook 'type-break-post-command-hook
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
919 'type-break-keystroke-warning)
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
920 (setq type-break-warning-countdown-string nil))))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
921
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
922 (defun type-break-mode-line-countdown-or-break (&optional type)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
923 (cond
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
924 ((not type-break-mode-line-message-mode))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
925 ((eq type 'countdown)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
926 ;(setq type-break-mode-line-break-message-p nil)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
927 (add-hook 'type-break-post-command-hook
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
928 'type-break-force-mode-line-update 'append))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
929 ((eq type 'break)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
930 ;; Alternate
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
931 (setq type-break-mode-line-break-message-p
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
932 (not type-break-mode-line-break-message-p))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
933 (remove-hook 'type-break-post-command-hook
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
934 'type-break-force-mode-line-update))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
935 (t
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
936 (setq type-break-mode-line-break-message-p nil)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
937 (setq type-break-warning-countdown-string nil)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
938 (remove-hook 'type-break-post-command-hook
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
939 'type-break-force-mode-line-update)))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
940 (type-break-force-mode-line-update))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
941
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
942
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
943 ;;;###autoload
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
944 (defun type-break-statistics ()
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
945 "Print statistics about typing breaks in a temporary buffer.
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
946 This includes the last time a typing break was taken, when the next one is
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
947 scheduled, the keystroke thresholds and the current keystroke count, etc."
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
948 (interactive)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
949 (with-output-to-temp-buffer "*Typing Break Statistics*"
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
950 (princ (format "Typing break statistics\n-----------------------\n
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
951 Typing break mode is currently %s.
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
952 Interactive query for breaks is %s.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
953 Warnings of imminent typing breaks in mode line is %s.
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
954
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
955 Last typing break ended : %s
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
956 Next scheduled typing break : %s\n
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
957 Minimum keystroke threshold : %s
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
958 Maximum keystroke threshold : %s
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
959 Current keystroke count : %s"
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
960 (if type-break-mode "enabled" "disabled")
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
961 (if type-break-query-mode "enabled" "disabled")
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
962 (if type-break-mode-line-message-mode "enabled" "disabled")
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
963 (if type-break-time-last-break
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
964 (current-time-string type-break-time-last-break)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
965 "never")
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
966 (if (and type-break-mode type-break-time-next-break)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
967 (format "%s\t(%s from now)"
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
968 (current-time-string type-break-time-next-break)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
969 (type-break-format-time
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
970 (type-break-time-difference
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
971 (current-time)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
972 type-break-time-next-break)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
973 "none scheduled")
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
974 (or (car type-break-keystroke-threshold) "none")
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
975 (or (cdr type-break-keystroke-threshold) "none")
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
976 type-break-keystroke-count))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
977
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
978 ;;;###autoload
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
979 (defun type-break-guesstimate-keystroke-threshold (wpm &optional wordlen frac)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
980 "Guess values for the minimum/maximum keystroke threshold for typing breaks.
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
981
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
982 If called interactively, the user is prompted for their guess as to how
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
983 many words per minute they usually type. This value should not be your
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
984 maximum WPM, but your average. Of course, this is harder to gauge since it
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
985 can vary considerably depending on what you are doing. For example, one
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
986 tends to type less when debugging a program as opposed to writing
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
987 documentation. (Perhaps a separate program should be written to estimate
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
988 average typing speed.)
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
989
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
990 From that, this command sets the values in `type-break-keystroke-threshold'
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
991 based on a fairly simple algorithm involving assumptions about the average
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
992 length of words (5). For the minimum threshold, it uses about a fifth of
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
993 the computed maximum threshold.
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
994
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
995 When called from Lisp programs, the optional args WORDLEN and FRAC can be
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
996 used to override the default assumption about average word length and the
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
997 fraction of the maximum threshold to which to set the minimum threshold.
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
998 FRAC should be the inverse of the fractional value; for example, a value of
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
999 2 would mean to use one half, a value of 4 would mean to use one quarter, etc."
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
1000 (interactive "NOn average, how many words per minute do you type? ")
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1001 (let* ((upper (* wpm (or wordlen 5) (/ type-break-interval 60)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1002 (lower (/ upper (or frac 5))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1003 (or type-break-keystroke-threshold
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1004 (setq type-break-keystroke-threshold (cons nil nil)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1005 (setcar type-break-keystroke-threshold lower)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1006 (setcdr type-break-keystroke-threshold upper)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1007 (if (interactive-p)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1008 (message "min threshold: %d\tmax threshold: %d" lower upper)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1009 type-break-keystroke-threshold)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1010
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1011
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1012 ;;; misc functions
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1013
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1014 ;; Compute the difference, in seconds, between a and b, two structures
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1015 ;; similar to those returned by `current-time'.
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1016 ;; Use addition rather than logand since that is more robust; the low 16
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1017 ;; bits of the seconds might have been incremented, making it more than 16
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1018 ;; bits wide.
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1019 (defun type-break-time-difference (a b)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1020 (+ (lsh (- (car b) (car a)) 16)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1021 (- (car (cdr b)) (car (cdr a)))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1022
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1023 ;; Return (in a new list the same in structure to that returned by
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1024 ;; `current-time') the sum of the arguments. Each argument may be a time
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1025 ;; list or a single integer, a number of seconds.
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1026 ;; This function keeps the high and low 16 bits of the seconds properly
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1027 ;; balanced so that the lower value never exceeds 16 bits. Otherwise, when
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1028 ;; the result is passed to `current-time-string' it will toss some of the
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1029 ;; "low" bits and format the time incorrectly.
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1030 (defun type-break-time-sum (&rest tmlist)
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1031 (let ((high 0)
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1032 (low 0)
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1033 (micro 0)
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1034 tem)
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1035 (while tmlist
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1036 (setq tem (car tmlist))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1037 (setq tmlist (cdr tmlist))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1038 (cond
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1039 ((numberp tem)
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1040 (setq low (+ low tem)))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1041 (t
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1042 (setq high (+ high (or (car tem) 0)))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1043 (setq low (+ low (or (car (cdr tem)) 0)))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1044 (setq micro (+ micro (or (car (cdr (cdr tem))) 0))))))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1045
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1046 (and (>= micro 1000000)
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1047 (progn
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1048 (setq tem (/ micro 1000000))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1049 (setq low (+ low tem))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1050 (setq micro (- micro (* tem 1000000)))))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1051
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1052 (setq tem (lsh low -16))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1053 (and (> tem 0)
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1054 (progn
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1055 (setq low (logand low 65535))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1056 (setq high (+ high tem))))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1057
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1058 (list high low micro)))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1059
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
1060 (defun type-break-time-stamp (&optional when)
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
1061 (if (fboundp 'format-time-string)
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
1062 (format-time-string type-break-time-stamp-format when)
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
1063 ;; Emacs 19.28 and prior do not have format-time-string.
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
1064 ;; In that case, result is not customizable. Upgrade today!
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
1065 (format "[%s] " (substring (current-time-string when) 11 16))))
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
1066
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1067 (defun type-break-format-time (secs)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1068 (let ((mins (/ secs 60)))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1069 (cond
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1070 ((= mins 1) (format "%d minute" mins))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1071 ((> mins 0) (format "%d minutes" mins))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1072 ((= secs 1) (format "%d second" secs))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1073 (t (format "%d seconds" secs)))))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1074
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1075 (defun type-break-keystroke-reset ()
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1076 (setq type-break-interval-start (current-time)) ; not a keystroke
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1077 (setq type-break-keystroke-count 0)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1078 (setq type-break-keystroke-warning-count 0)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1079 (setq type-break-current-keystroke-warning-interval
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1080 type-break-keystroke-warning-intervals)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1081 (remove-hook 'type-break-post-command-hook 'type-break-keystroke-warning))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1082
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1083 (defun type-break-force-mode-line-update (&optional all)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1084 "Force the mode-line of the current buffer to be redisplayed.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1085 With optional non-nil ALL, force redisplay of all mode-lines."
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1086 (and all (save-excursion (set-buffer (other-buffer))))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1087 (set-buffer-modified-p (buffer-modified-p)))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1088
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1089 ;; If an exception occurs in Emacs while running the post command hook, the
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1090 ;; value of that hook is clobbered. This is because the value of the
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1091 ;; variable is temporarily set to nil while it's running to prevent
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1092 ;; recursive application, but it also means an exception aborts the routine
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1093 ;; of restoring it. This function is called from the timers to restore it,
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1094 ;; just in case.
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1095 (defun type-break-check-post-command-hook ()
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1096 (add-hook 'post-command-hook 'type-break-run-tb-post-command-hook 'append))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1097
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1098
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1099 ;;; Timer wrapper functions
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1100 ;;;
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1101 ;;; These shield type-break from variations in the interval timer packages
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1102 ;;; for different versions of Emacs.
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1103
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1104 (defun type-break-run-at-time (time repeat function)
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1105 (condition-case nil (or (require 'timer) (require 'itimer)) (error nil))
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1106 (cond ((fboundp 'run-at-time)
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1107 (run-at-time time repeat function))
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1108 ((fboundp 'start-timer)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1109 (let ((name (if (symbolp function)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1110 (symbol-name function)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1111 "type-break")))
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1112 (start-timer name function time repeat)))
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1113 ((fboundp 'start-itimer)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1114 (let ((name (if (symbolp function)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1115 (symbol-name function)
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1116 "type-break")))
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1117 (start-itimer name function time repeat)))))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1118
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1119 (defvar timer-dont-exit)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1120 (defun type-break-cancel-function-timers (function)
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1121 (cond ((fboundp 'cancel-function-timers)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1122 (let ((timer-dont-exit t))
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1123 (cancel-function-timers function)))
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1124 ((fboundp 'delete-timer)
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1125 (let ((list timer-list))
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1126 (while list
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1127 (and (eq (funcall 'timer-function (car list)) function)
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1128 (delete-timer (car list)))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1129 (setq list (cdr list)))))
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1130 ((fboundp 'delete-itimer)
51288
f0563005bb3d (type-break-cancel-function-timers): Use with-no-warnings.
Richard M. Stallman <rms@gnu.org>
parents: 50868
diff changeset
1131 (with-no-warnings
f0563005bb3d (type-break-cancel-function-timers): Use with-no-warnings.
Richard M. Stallman <rms@gnu.org>
parents: 50868
diff changeset
1132 (let ((list itimer-list))
f0563005bb3d (type-break-cancel-function-timers): Use with-no-warnings.
Richard M. Stallman <rms@gnu.org>
parents: 50868
diff changeset
1133 (while list
f0563005bb3d (type-break-cancel-function-timers): Use with-no-warnings.
Richard M. Stallman <rms@gnu.org>
parents: 50868
diff changeset
1134 (and (eq (funcall 'itimer-function (car list)) function)
54322
4712727ef275 (type-break-emacs-variant): Remove.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 52401
diff changeset
1135 (delete-itimer (car list)))
51288
f0563005bb3d (type-break-cancel-function-timers): Use with-no-warnings.
Richard M. Stallman <rms@gnu.org>
parents: 50868
diff changeset
1136 (setq list (cdr list))))))))
18416
2ec71bb15f86 Don't require timer; use autoloaded functions from Emacs or XEmacs,
Noah Friedman <friedman@splode.com>
parents: 18414
diff changeset
1137
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1138
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1139 ;;; Demo wrappers
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1140
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1141 ;; This is a wrapper around hanoi that calls it with an arg large enough to
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1142 ;; make the largest discs possible that will fit in the window.
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1143 ;; Also, clean up the *Hanoi* buffer after we're done.
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
1144 (defun type-break-demo-hanoi ()
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1145 "Take a hanoiing typing break."
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1146 (and (get-buffer "*Hanoi*")
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1147 (kill-buffer "*Hanoi*"))
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1148 (condition-case ()
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1149 (progn
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1150 (hanoi (/ (window-width) 8))
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1151 ;; Wait for user to come back.
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1152 (read-char)
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1153 (kill-buffer "*Hanoi*"))
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
1154 (quit
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
1155 ;; eat char
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
1156 (read-char)
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1157 (and (get-buffer "*Hanoi*")
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1158 (kill-buffer "*Hanoi*")))))
5939
454dc146502d Initial revision
Roland McGrath <roland@gnu.org>
parents:
diff changeset
1159
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1160 ;; This is a wrapper around life that calls it with a `sleep' arg to make
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1161 ;; it run a little more leisurely.
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1162 ;; Also, clean up the *Life* buffer after we're done.
8275
4fdf77f4e45c type-break-mode: New variable and function.
Noah Friedman <friedman@splode.com>
parents: 8248
diff changeset
1163 (defun type-break-demo-life ()
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1164 "Take a typing break and get a life."
8282
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1165 (let ((continue t))
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1166 (while continue
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1167 (setq continue nil)
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1168 (and (get-buffer "*Life*")
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1169 (kill-buffer "*Life*"))
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1170 (condition-case ()
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1171 (progn
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1172 (life 3)
8304
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
1173 ;; wait for user to return
6c34e249d217 type-break-good-rest-interval: Doc fix.
Noah Friedman <friedman@splode.com>
parents: 8282
diff changeset
1174 (read-char)
8282
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1175 (kill-buffer "*Life*"))
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1176 (life-extinct
18414
8d2051b79879 Changes which are not mine:
Noah Friedman <friedman@splode.com>
parents: 9355
diff changeset
1177 (message "%s" (get 'life-extinct 'error-message))
8282
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1178 (sit-for 3)
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1179 ;; restart demo
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1180 (setq continue t))
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1181 (quit
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1182 (and (get-buffer "*Life*")
206451cdd48a type-break-keystroke-threshold: Change default wpm to 30 and lower
Noah Friedman <friedman@splode.com>
parents: 8281
diff changeset
1183 (kill-buffer "*Life*")))))))
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1184
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1185 ;; Boring demo, but doesn't use many cycles
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1186 (defun type-break-demo-boring ()
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1187 "Boring typing break demo."
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1188 (let ((rmsg (if type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1189 ""
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1190 "Press any key to resume from typing break"))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1191 (buffer-name "*Typing Break Buffer*")
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1192 lines elapsed timeleft tmsg)
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1193 (condition-case ()
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1194 (progn
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1195 (switch-to-buffer (get-buffer-create buffer-name))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1196 (buffer-disable-undo (current-buffer))
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1197 (setq lines (/ (window-body-height) 2))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1198 (unless type-break-terse-messages (setq lines (1- lines)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1199 (if type-break-demo-boring-stats
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1200 (setq lines (- lines 2)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1201 (setq lines (make-string lines ?\C-j))
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1202 (while (not (input-pending-p))
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1203 (erase-buffer)
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1204 (setq elapsed (type-break-time-difference
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1205 type-break-time-last-break
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1206 (current-time)))
55189
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1207 (let ((good-interval (or type-break-good-rest-interval
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1208 type-break-good-break-interval)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1209 (cond
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1210 (good-interval
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1211 (setq timeleft (- good-interval elapsed))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1212 (if (> timeleft 0)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1213 (setq tmsg
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1214 (format (if type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1215 "Break remaining: %s"
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1216 "You should rest for %s more")
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1217 (type-break-format-time timeleft)))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1218 (setq tmsg
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1219 (format (if type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1220 "Break complete (%s elapsed in total)"
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1221 "Typing break has lasted %s")
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1222 (type-break-format-time elapsed)))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1223 (t
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1224 (setq tmsg
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1225 (format (if type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1226 "Break has lasted %s"
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1227 "Typing break has lasted %s")
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1228 (type-break-format-time elapsed))))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1229 (insert lines
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1230 (make-string (/ (- (window-width) (length tmsg)) 2) ?\ )
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1231 tmsg)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1232 (if (> (length rmsg) 0)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1233 (insert "\n"
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1234 (make-string (/ (- (window-width) (length rmsg)) 2)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1235 ?\ )
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1236 rmsg))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1237 (if type-break-demo-boring-stats
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1238 (let*
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1239 ((message
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1240 (format
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1241 (if type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1242 "Since last break: %s keystrokes\n"
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1243 "Since your last break you've typed %s keystrokes\n")
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1244 type-break-keystroke-count))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1245 (column-spaces
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1246 (make-string (/ (- (window-width) (length message)) 2)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1247 ?\ ))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1248 (wpm (/ (/ (float type-break-keystroke-count) 5)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1249 (/ (type-break-time-difference
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1250 type-break-interval-start
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1251 type-break-time-last-break)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1252 60.0))))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1253 (insert "\n\n" column-spaces message)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1254 (if type-break-terse-messages
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1255 (insert (format " %s%.2f wpm"
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1256 column-spaces
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1257 wpm))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1258 (setq message
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1259 (format "at an average of %.2f words per minute"
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1260 wpm))
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1261 (insert
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1262 (make-string (/ (- (window-width) (length message)) 2)
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1263 ?\ )
51108148b11d Capitalise Emacs and Lisp.
Eli Zaretskii <eliz@gnu.org>
parents: 54770
diff changeset
1264 message))))
8497
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1265 (goto-char (point-min))
3d566eab9870 type-break-time-sum: New function.
Noah Friedman <friedman@splode.com>
parents: 8370
diff changeset
1266 (sit-for 60))
8370
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1267 (read-char)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1268 (kill-buffer buffer-name))
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1269 (quit
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1270 (and (get-buffer buffer-name)
97cacab659d3 type-break-time-warning-intervals, type-break-keystroke-warning-intervals,
Noah Friedman <friedman@splode.com>
parents: 8305
diff changeset
1271 (kill-buffer buffer-name))))))
8276
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
1272
73b85998c868 type-break-mode: Make variable `nil' by default.
Noah Friedman <friedman@splode.com>
parents: 8275
diff changeset
1273
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1274 (provide 'type-break)
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1275
20800
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
1276 (if type-break-mode
43c77517a76c (type-break-mode): New customize variable to automatically load the package.
Stephen Eglen <stephen@gnu.org>
parents: 18416
diff changeset
1277 (type-break-mode 1))
30391
246b2f521192 (type-break): perform autosave.
Noah Friedman <friedman@splode.com>
parents: 25278
diff changeset
1278
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51288
diff changeset
1279 ;;; arch-tag: 943a2eb3-07e6-420b-993f-96e4796f5fd0
8248
5ecef3b02f2d Real initial revision. (rewrite from hanoi-break.)
Noah Friedman <friedman@splode.com>
parents: 5939
diff changeset
1280 ;;; type-break.el ends here