/
type-break.el
1183 lines (1033 loc) · 47.2 KB
/
type-break.el
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; type-break.el --- encourage rests from typing at appropriate intervals -*- lexical-binding: t -*-
;; Copyright (C) 1994-1995, 1997, 2000-2013 Free Software Foundation,
;; Inc.
;; Author: Noah Friedman
;; Maintainer: Noah Friedman <friedman@splode.com>
;; Keywords: extensions, timers
;; Created: 1994-07-13
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; The docstring for the function `type-break-mode' summarizes most of the
;; details of the interface.
;; This package relies on the assumption that you live entirely in Emacs,
;; as the author does. If that's not the case for you (e.g. you often
;; suspend Emacs or work in other windows) then this won't help very much;
;; it will depend on just how often you switch back to Emacs. At the very
;; least, you will want to turn off the keystroke thresholds and rest
;; interval tracking.
;; If you prefer not to be queried about taking breaks, but instead just
;; want to be reminded, do the following:
;;
;; (setq type-break-query-mode nil)
;;
;; Or call the command `type-break-query-mode' with a negative prefix
;; argument.
;; If you find echo area messages annoying and would prefer to see messages
;; in the mode line instead, do M-x type-break-mode-line-message-mode
;; or set the variable of the same name to `t'.
;; This program can truly cons up a storm because of all the calls to
;; `current-time' (which always returns fresh conses). I'm dismayed by
;; this, but I think the health of my hands is far more important than a
;; few pages of virtual memory.
;; This program has no hope of working in Emacs 18.
;; This package was inspired by Roland McGrath's hanoi-break.el.
;; Several people contributed feedback and ideas, including
;; Roland McGrath <roland@gnu.org>
;; Kleanthes Koniaris <kgk@koniaris.com>
;; Mark Ashton <mpashton@gnu.org>
;; Matt Wilding <wilding@cli.com>
;; Robert S. Boyer <boyer@cs.utexas.edu>
;;; Code:
(defgroup type-break nil
"Encourage the user to take a rest from typing at suitable intervals."
:prefix "type-break"
:group 'keyboard)
(defcustom type-break-interval (* 60 60)
"Number of seconds between scheduled typing breaks."
:type 'integer
:group 'type-break)
(defcustom type-break-good-rest-interval (/ type-break-interval 6)
"Number of seconds of idle time considered to be an adequate typing rest.
When this variable is non-nil, Emacs checks the idle time between
keystrokes. If this idle time is long enough to be considered a \"good\"
rest from typing, then the next typing break is simply rescheduled for later.
If a break is interrupted before this much time elapses, the user will be
asked whether or not really to interrupt the break."
:set-after '(type-break-interval)
:type 'integer
:group 'type-break)
(defcustom type-break-good-break-interval nil
"Number of seconds considered to be an adequate explicit typing rest.
When this variable is non-nil, its value is considered to be a \"good\"
length (in seconds) for a break initiated by the command `type-break',
overriding `type-break-good-rest-interval'. This provides querying of
break interruptions when `type-break-good-rest-interval' is nil."
:type 'integer
:group 'type-break)
(defcustom type-break-keystroke-threshold
;; Assuming typing speed is 35wpm (on the average, do you really
;; type more than that in a minute? I spend a lot of time reading mail
;; and simply studying code in buffers) and average word length is
;; about 5 letters, default upper threshold to the average number of
;; keystrokes one is likely to type in a break interval. That way if the
;; user goes through a furious burst of typing activity, cause a typing
;; break to be required sooner than originally scheduled.
;; Conversely, the minimum threshold should be about a fifth of this.
(let* ((wpm 35)
(avg-word-length 5)
(upper (* wpm avg-word-length (/ type-break-interval 60)))
(lower (/ upper 5)))
(cons lower upper))
"Upper and lower bound on number of keystrokes for considering typing break.
This structure is a pair of numbers (MIN . MAX).
The first number is the minimum number of keystrokes that must have been
entered since the last typing break before considering another one, even if
the scheduled time has elapsed; the break is simply rescheduled until later
if the minimum threshold hasn't been reached. If this first value is nil,
then there is no minimum threshold; as soon as the scheduled time has
elapsed, the user will always be queried.
The second number is the maximum number of keystrokes that can be entered
before a typing break is requested immediately, pre-empting the originally
scheduled break. If this second value is nil, then no pre-emptive breaks
will occur; only scheduled ones will.
Keys with bucky bits (shift, control, meta, etc) are counted as only one
keystroke even though they really require multiple keys to generate them.
The command `type-break-guesstimate-keystroke-threshold' can be used to
guess a reasonably good pair of values for this variable."
:set-after '(type-break-interval)
:type 'sexp
:group 'type-break)
(defcustom type-break-query-function 'yes-or-no-p
"Function to use for making query for a typing break.
It should take a string as an argument, the prompt.
Usually this should be set to `yes-or-no-p' or `y-or-n-p'.
To avoid being queried at all, set `type-break-query-mode' to nil."
:type '(radio function
(function-item yes-or-no-p)
(function-item y-or-n-p))
:group 'type-break)
(defcustom type-break-query-interval 60
"Number of seconds between queries to take a break, if put off.
The user will continue to be prompted at this interval until he or she
finally submits to taking a typing break."
:type 'integer
:group 'type-break)
(defcustom type-break-time-warning-intervals '(300 120 60 30)
"List of time intervals for warnings about upcoming typing break.
At each of the intervals (specified in seconds) away from a scheduled
typing break, print a warning in the echo area."
:type '(repeat integer)
:group 'type-break)
(defcustom type-break-keystroke-warning-intervals '(300 200 100 50)
"List of keystroke measurements for warnings about upcoming typing break.
At each of the intervals (specified in keystrokes) away from the upper
keystroke threshold, print a warning in the echo area.
If either this variable or the upper threshold is set, then no warnings
will occur."
:type '(repeat integer)
:group 'type-break)
(defcustom type-break-warning-repeat 40
"Number of keystrokes for which warnings should be repeated.
That is, for each of this many keystrokes the warning is redisplayed
in the echo area to make sure it's really seen."
:type 'integer
:group 'type-break)
(defcustom type-break-time-stamp-format "[%H:%M] "
"Timestamp format used to prefix messages.
Format specifiers are as used by `format-time-string'."
:type 'string
:group 'type-break)
(defcustom type-break-demo-functions
'(type-break-demo-boring type-break-demo-life type-break-demo-hanoi)
"List of functions to consider running as demos during typing breaks.
When a typing break begins, one of these functions is selected randomly
to have Emacs do something interesting.
Any function in this list should start a demo which ceases as soon as a
key is pressed."
:type '(repeat function)
:group 'type-break)
(defcustom type-break-demo-boring-stats nil
"Show word per minute and keystroke figures in the Boring demo."
:type 'boolean
:group 'type-break)
(defcustom type-break-terse-messages nil
"Use slightly terser messages."
:type 'boolean
:group 'type-break)
(defcustom type-break-file-name (convert-standard-filename "~/.type-break")
"Name of file used to save state across sessions.
If this is nil, no data will be saved across sessions."
:type 'file
:group 'type-break)
(defvar type-break-post-command-hook '(type-break-check)
"Hook run indirectly by `post-command-hook' for typing break functions.
This is not really intended to be set by the user, but it's probably
harmless to do so. Mainly it is used by various parts of the typing break
program to delay actions until after the user has completed some command.
It exists because `post-command-hook' itself is inaccessible while its
functions are being run, and some type-break--related functions want to
remove themselves after running.")
;; Mode line frobs
(defvar type-break-mode-line-format
'(type-break-mode-line-message-mode
(""
type-break-mode-line-break-message
type-break-mode-line-warning))
"Format of messages in the mode line concerning typing breaks.")
(defvar type-break-mode-line-break-message
'(type-break-mode-line-break-message-p
type-break-mode-line-break-string))
(defvar type-break-mode-line-break-message-p nil)
(defvar type-break-mode-line-break-string " *** TAKE A TYPING BREAK NOW ***")
(defvar type-break-mode-line-warning
'(type-break-mode-line-break-message-p
("")
(type-break-warning-countdown-string
(" *** "
"Break in "
type-break-warning-countdown-string
" "
type-break-warning-countdown-string-type
"***"))))
(defvar type-break-warning-countdown-string nil
"If non-nil, this is a countdown for the next typing break.
This variable, in conjunction with `type-break-warning-countdown-string-type'
\(which indicates whether this value is a number of keystrokes or seconds)
is installed in `mode-line-format' to notify of imminent typing breaks.")
(defvar type-break-warning-countdown-string-type nil
"Indicates the unit type of `type-break-warning-countdown-string'.
It will be either \"seconds\" or \"keystrokes\".")
;; These are internal variables. Do not set them yourself.
(defvar type-break-alarm-p nil)
(defvar type-break-keystroke-count 0)
(defvar type-break-time-last-break nil)
(defvar type-break-time-next-break nil)
(defvar type-break-time-last-command (current-time))
(defvar type-break-current-time-warning-interval nil)
(defvar type-break-current-keystroke-warning-interval nil)
(defvar type-break-time-warning-count 0)
(defvar type-break-keystroke-warning-count 0)
(defvar type-break-interval-start nil)
;;;###autoload
(define-minor-mode type-break-mode
"Enable or disable typing-break mode.
This is a minor mode, but it is global to all buffers by default.
When this mode is enabled, the user is encouraged to take typing breaks at
appropriate intervals; either after a specified amount of time or when the
user has exceeded a keystroke threshold. When the time arrives, the user
is asked to take a break. If the user refuses at that time, Emacs will ask
again in a short period of time. The idea is to give the user enough time
to find a good breaking point in his or her work, but be sufficiently
annoying to discourage putting typing breaks off indefinitely.
A negative prefix argument disables this mode.
No argument or any non-negative argument enables it.
The user may enable or disable this mode by setting the variable of the
same name, though setting it in that way doesn't reschedule a break or
reset the keystroke counter.
If the mode was previously disabled and is enabled as a consequence of
calling this function, it schedules a break with `type-break-schedule' to
make sure one occurs (the user can call that command to reschedule the
break at any time). It also initializes the keystroke counter.
The variable `type-break-interval' specifies the number of seconds to
schedule between regular typing breaks. This variable doesn't directly
affect the time schedule; it simply provides a default for the
`type-break-schedule' command.
If set, the variable `type-break-good-rest-interval' specifies the minimum
amount of time which is considered a reasonable typing break. Whenever
that time has elapsed, typing breaks are automatically rescheduled for
later even if Emacs didn't prompt you to take one first. Also, if a break
is ended before this much time has elapsed, the user will be asked whether
or not to continue. A nil value for this variable prevents automatic
break rescheduling, making `type-break-interval' an upper bound on the time
between breaks. In this case breaks will be prompted for as usual before
the upper bound if the keystroke threshold is reached.
If `type-break-good-rest-interval' is nil and
`type-break-good-break-interval' is set, then confirmation is required to
interrupt a break before `type-break-good-break-interval' seconds
have passed. This provides for an upper bound on the time between breaks
together with confirmation of interruptions to these breaks.
The variable `type-break-keystroke-threshold' is used to determine the
thresholds at which typing breaks should be considered. You can use
the command `type-break-guesstimate-keystroke-threshold' to try to
approximate good values for this.
There are several variables that affect how or when warning messages about
imminent typing breaks are displayed. They include:
`type-break-mode-line-message-mode'
`type-break-time-warning-intervals'
`type-break-keystroke-warning-intervals'
`type-break-warning-repeat'
`type-break-warning-countdown-string'
`type-break-warning-countdown-string-type'
There are several variables that affect if, how, and when queries to begin
a typing break occur. They include:
`type-break-query-mode'
`type-break-query-function'
`type-break-query-interval'
The command `type-break-statistics' prints interesting things.
Finally, a file (named `type-break-file-name') is used to store information
across Emacs sessions. This provides recovery of the break status between
sessions and after a crash. Manual changes to the file may result in
problems."
:lighter type-break-mode-line-format
:global t
(type-break-check-post-command-hook)
(cond
;; ((and already-enabled type-break-mode)
;; (and (called-interactively-p 'interactive)
;; (message "Type Break mode is already enabled")))
(type-break-mode
(when type-break-file-name
(with-current-buffer (find-file-noselect type-break-file-name 'nowarn)
(setq buffer-save-without-query t)))
(or global-mode-string (setq global-mode-string '(""))) ;FIXME: Why?
(type-break-keystroke-reset)
(type-break-mode-line-countdown-or-break nil)
(setq type-break-time-last-break
(or (type-break-get-previous-time)
(current-time)))
;; Schedule according to break time from session file.
(type-break-schedule
(let (diff)
(if (and type-break-time-last-break
(< (setq diff (type-break-time-difference
type-break-time-last-break
(current-time)))
type-break-interval))
;; Use the file's value.
(progn
(setq type-break-keystroke-count
(type-break-get-previous-count))
;; File the time, in case it was read from the auto-save file.
(type-break-file-time type-break-interval-start)
(setq type-break-interval-start type-break-time-last-break)
(- type-break-interval diff))
;; Schedule from now.
(setq type-break-interval-start (current-time))
(type-break-file-time type-break-interval-start)
type-break-interval))
type-break-interval-start
type-break-interval))
(t
(type-break-keystroke-reset)
(type-break-mode-line-countdown-or-break nil)
(type-break-cancel-schedule)
(do-auto-save)
(when type-break-file-name
(with-current-buffer (find-file-noselect type-break-file-name
'nowarn)
(set-buffer-modified-p nil)
(unlock-buffer)
(kill-this-buffer))))))
(define-minor-mode type-break-mode-line-message-mode
"Toggle warnings about typing breaks in the mode line.
With a prefix argument ARG, enable these warnings if ARG is
positive, and disable them otherwise. If called from Lisp,
enable them if ARG is omitted or nil.
The user may also enable or disable this mode simply by setting
the variable of the same name.
Variables controlling the display of messages in the mode line include:
`mode-line-format'
`global-mode-string'
`type-break-mode-line-break-message'
`type-break-mode-line-warning'"
:global t)
(define-minor-mode type-break-query-mode
"Toggle typing break queries.
With a prefix argument ARG, enable these queries if ARG is
positive, and disable them otherwise. If called from Lisp,
enable them if ARG is omitted or nil.
The user may also enable or disable this mode simply by setting
the variable of the same name."
:global t)
;;; session file functions
(defvar type-break-auto-save-file-name
(let ((buffer-file-name type-break-file-name))
(make-auto-save-file-name))
"Auto-save name of `type-break-file-name'.")
(defun type-break-file-time (&optional time)
"File break time in `type-break-file-name', unless the file is locked."
(if (and type-break-file-name
(not (stringp (file-locked-p type-break-file-name))))
(with-current-buffer (find-file-noselect type-break-file-name
'nowarn)
(let ((inhibit-read-only t))
(erase-buffer)
(insert (format "%s\n\n" (or time type-break-interval-start)))
;; file saving is left to auto-save
))))
(defun type-break-file-keystroke-count ()
"File keystroke count in `type-break-file-name', unless the file is locked."
(if (and type-break-file-name
(not (stringp (file-locked-p type-break-file-name))))
;; Prevent deactivation of the mark in some other buffer.
(let (deactivate-mark)
(with-current-buffer (find-file-noselect type-break-file-name
'nowarn)
(save-excursion
(let ((inhibit-read-only t))
(goto-char (point-min))
(forward-line)
(delete-region (point) (line-end-position))
(insert (format "%s" type-break-keystroke-count))
;; file saving is left to auto-save
))))))
(defun timep (time)
"If TIME is in the format returned by `current-time' then
return TIME, else return nil."
(condition-case nil
(and (float-time time) time)
(error nil)))
(defun type-break-choose-file ()
"Return file to read from."
(cond
((not type-break-file-name)
nil)
((and (file-exists-p type-break-auto-save-file-name)
(file-readable-p type-break-auto-save-file-name))
type-break-auto-save-file-name)
((and (file-exists-p type-break-file-name)
(file-readable-p type-break-file-name))
type-break-file-name)
(t nil)))
(defun type-break-get-previous-time ()
"Get previous break time from `type-break-file-name'.
Returns nil if the file is missing or if the time breaks with the
`current-time' format."
(let ((file (type-break-choose-file)))
(if file
(timep ;; returns expected format, else nil
(with-current-buffer (find-file-noselect file 'nowarn)
(condition-case nil
(save-excursion
(goto-char (point-min))
(read (current-buffer)))
(end-of-file
(error "End of file in `%s'" file))))))))
(defun type-break-get-previous-count ()
"Get previous keystroke count from `type-break-file-name'.
Return 0 if the file is missing or if the form read is not an
integer."
(let ((file (type-break-choose-file)))
(if (and file
(integerp
(setq file
(with-current-buffer
(find-file-noselect file 'nowarn)
(condition-case nil
(save-excursion
(goto-char (point-min))
(forward-line 1)
(read (current-buffer)))
(end-of-file
(error "End of file in `%s'" file)))))))
file
0)))
;;;###autoload
(defun type-break ()
"Take a typing break.
During the break, a demo selected from the functions listed in
`type-break-demo-functions' is run.
After the typing break is finished, the next break is scheduled
as per the function `type-break-schedule'."
(interactive)
(do-auto-save)
(type-break-cancel-schedule)
;; remove any query scheduled during interactive invocation
(remove-hook 'type-break-post-command-hook 'type-break-do-query)
(let ((continue t)
(start-time (current-time)))
(setq type-break-time-last-break start-time)
(while continue
(save-window-excursion
;; Eat the screen.
(and (eq (selected-window) (minibuffer-window))
(other-window 1))
(delete-other-windows)
(scroll-right (window-width))
(unless type-break-terse-messages
(message "Press any key to resume from typing break."))
(let* ((len (length type-break-demo-functions))
(idx (random len))
(fn (nth idx type-break-demo-functions)))
(condition-case ()
(funcall fn)
(error nil))))
(let ((good-interval (or type-break-good-rest-interval
type-break-good-break-interval)))
(cond
(good-interval
(let ((break-secs (type-break-time-difference
start-time (current-time))))
(cond
((>= break-secs good-interval)
(setq continue nil))
;; 60 seconds may be too much leeway if the break is only 3
;; minutes to begin with. You can just say "no" to the query
;; below if you're in that much of a hurry.
;;((> 60 (abs (- break-secs good-interval)))
;; (setq continue nil))
((funcall
type-break-query-function
(format
(if type-break-terse-messages
"%s%s remaining. Continue break? "
"%sYou really ought to rest %s more. Continue break? ")
(type-break-time-stamp)
(type-break-format-time (- good-interval
break-secs)))))
(t
(setq continue nil)))))
(t (setq continue nil))))))
(type-break-keystroke-reset)
(type-break-file-time)
(type-break-mode-line-countdown-or-break nil)
(type-break-schedule))
(defun type-break-schedule (&optional time start interval)
"Schedule a typing break for TIME seconds from now.
If time is not specified it defaults to `type-break-interval'.
START and INTERVAL are used when recovering a break.
START is the start of the break (defaults to now).
INTERVAL is the full length of an interval (defaults to TIME)."
(interactive (list (and current-prefix-arg
(prefix-numeric-value current-prefix-arg))))
(or time (setq time type-break-interval))
(type-break-check-post-command-hook)
(type-break-cancel-schedule)
(type-break-time-warning-schedule time 'reset)
(type-break-run-at-time (max 1 time) nil 'type-break-alarm)
(setq type-break-time-next-break
(type-break-time-sum (or start (current-time))
(or interval time))))
(defun type-break-cancel-schedule ()
(type-break-cancel-time-warning-schedule)
(type-break-cancel-function-timers 'type-break-alarm)
(setq type-break-alarm-p nil)
(setq type-break-time-next-break nil))
(defun type-break-time-warning-schedule (&optional time resetp)
(let ((type-break-current-time-warning-interval nil))
(type-break-cancel-time-warning-schedule))
(add-hook 'type-break-post-command-hook 'type-break-time-warning 'append)
(cond
(type-break-time-warning-intervals
(and resetp
(setq type-break-current-time-warning-interval
type-break-time-warning-intervals))
(or time
(setq time (type-break-time-difference (current-time)
type-break-time-next-break)))
(while (and type-break-current-time-warning-interval
(> (car type-break-current-time-warning-interval) time))
(setq type-break-current-time-warning-interval
(cdr type-break-current-time-warning-interval)))
(cond
(type-break-current-time-warning-interval
(setq time (- time (car type-break-current-time-warning-interval)))
(setq type-break-current-time-warning-interval
(cdr type-break-current-time-warning-interval))
;(let (type-break-current-time-warning-interval)
; (type-break-cancel-time-warning-schedule))
(type-break-run-at-time (max 1 time) nil 'type-break-time-warning-alarm)
(cond
(resetp
(setq type-break-warning-countdown-string nil))
(t
(setq type-break-warning-countdown-string (number-to-string time))
(setq type-break-warning-countdown-string-type "seconds"))))))))
(defun type-break-cancel-time-warning-schedule ()
(type-break-cancel-function-timers 'type-break-time-warning-alarm)
(remove-hook 'type-break-post-command-hook 'type-break-time-warning)
(setq type-break-current-time-warning-interval
type-break-time-warning-intervals)
(setq type-break-time-warning-count 0) ; avoid warnings after break
(setq type-break-warning-countdown-string nil))
(defun type-break-alarm ()
(type-break-check-post-command-hook)
(setq type-break-alarm-p t)
(type-break-mode-line-countdown-or-break 'break))
(defun type-break-time-warning-alarm ()
(type-break-check-post-command-hook)
(type-break-time-warning-schedule)
(setq type-break-time-warning-count type-break-warning-repeat)
(type-break-time-warning)
(type-break-mode-line-countdown-or-break 'countdown))
(defun type-break-run-tb-post-command-hook ()
(and type-break-mode
(run-hooks 'type-break-post-command-hook)))
(defun type-break-check ()
"Ask to take a typing break if appropriate.
This may be the case either because the scheduled time has come \(and the
minimum keystroke threshold has been reached\) or because the maximum
keystroke threshold has been exceeded."
(type-break-file-keystroke-count)
(let* ((min-threshold (car type-break-keystroke-threshold))
(max-threshold (cdr type-break-keystroke-threshold)))
(and type-break-good-rest-interval
(progn
(and (> (type-break-time-difference
type-break-time-last-command (current-time))
type-break-good-rest-interval)
(progn
(type-break-keystroke-reset)
(type-break-mode-line-countdown-or-break nil)
(setq type-break-time-last-break (current-time))
(type-break-schedule)))
(setq type-break-time-last-command (current-time))))
(and type-break-keystroke-threshold
(let ((keys (this-command-keys)))
(cond
;; Ignore mouse motion
((and (vectorp keys)
(consp (aref keys 0))
(memq (car (aref keys 0)) '(mouse-movement))))
(t
(setq type-break-keystroke-count
(+ type-break-keystroke-count (length keys)))))))
(cond
(type-break-alarm-p
(cond
((input-pending-p))
((eq (selected-window) (minibuffer-window)))
((and min-threshold
(< type-break-keystroke-count min-threshold))
(type-break-schedule))
(t
;; If keystroke count is within min-threshold of
;; max-threshold, lower it to reduce the likelihood of an
;; immediate subsequent query.
(and max-threshold
min-threshold
(< (- max-threshold type-break-keystroke-count) min-threshold)
(progn
(type-break-keystroke-reset)
(setq type-break-keystroke-count min-threshold)))
(type-break-query))))
((and type-break-keystroke-warning-intervals
max-threshold
(= type-break-keystroke-warning-count 0)
(type-break-check-keystroke-warning)))
((and max-threshold
(> type-break-keystroke-count max-threshold)
(not (input-pending-p))
(not (eq (selected-window) (minibuffer-window))))
(type-break-keystroke-reset)
(setq type-break-keystroke-count (or min-threshold 0))
(type-break-query)))))
;; This should return t if warnings were enabled, nil otherwise.
(defun type-break-check-keystroke-warning ()
;; This is safe because the caller should have checked that the cdr was
;; non-nil already.
(let ((left (- (cdr type-break-keystroke-threshold)
type-break-keystroke-count)))
(cond
((null (car type-break-current-keystroke-warning-interval))
nil)
((> left (car type-break-current-keystroke-warning-interval))
nil)
(t
(while (and (car type-break-current-keystroke-warning-interval)
(< left (car type-break-current-keystroke-warning-interval)))
(setq type-break-current-keystroke-warning-interval
(cdr type-break-current-keystroke-warning-interval)))
(setq type-break-keystroke-warning-count type-break-warning-repeat)
(add-hook 'type-break-post-command-hook 'type-break-keystroke-warning)
(setq type-break-warning-countdown-string (number-to-string left))
(setq type-break-warning-countdown-string-type "keystrokes")
(type-break-mode-line-countdown-or-break 'countdown)
t))))
;; Arrange for a break query to be made, when the user stops typing furiously.
(defun type-break-query ()
(add-hook 'type-break-post-command-hook 'type-break-do-query))
(defun type-break-do-query ()
(cond
((not type-break-query-mode)
(type-break-noninteractive-query)
(type-break-schedule type-break-query-interval)
(remove-hook 'type-break-post-command-hook 'type-break-do-query))
((sit-for 2)
(condition-case ()
(cond
((let ((type-break-mode nil)
;; yes-or-no-p sets this-command to exit-minibuffer,
;; which hoses undo or yank-pop (if you happened to be
;; yanking just when the query occurred).
(this-command this-command))
;; Cancel schedule to prevent possibility of a second query
;; from taking place before this one has even returned.
;; The condition-case wrapper will reschedule on quit.
(type-break-cancel-schedule)
;; Also prevent a second query when the break is interrupted.
(remove-hook 'type-break-post-command-hook 'type-break-do-query)
(funcall type-break-query-function
(format "%s%s"
(type-break-time-stamp)
(if type-break-terse-messages
"Break now? "
"Take a break from typing now? "))))
(type-break))
(t
(type-break-schedule type-break-query-interval)))
(quit
(type-break-schedule type-break-query-interval))))))
(defun type-break-noninteractive-query (&optional _ignored-args)
"Null query function which doesn't interrupt user and assumes `no'.
It prints a reminder in the echo area to take a break, but doesn't enforce
this or ask the user to start one right now."
(cond
(type-break-mode-line-message-mode)
(t
(beep t)
(message "%sYou should take a typing break now. Do `M-x type-break'."
(type-break-time-stamp))
(sit-for 1)
(beep t)
;; return nil so query caller knows to reset reminder, as if user
;; said "no" in response to yes-or-no-p.
nil)))
(defun type-break-time-warning ()
(cond
((and (car type-break-keystroke-threshold)
(< type-break-keystroke-count (car type-break-keystroke-threshold))))
((> type-break-time-warning-count 0)
(let ((timeleft (type-break-time-difference (current-time)
type-break-time-next-break)))
(setq type-break-warning-countdown-string (number-to-string timeleft))
(cond
((eq (selected-window) (minibuffer-window)))
;; Do nothing if the command was just a prefix arg, since that will
;; immediately be followed by some other interactive command.
;; Otherwise, it is particularly annoying for the sit-for below to
;; delay redisplay when one types sequences like `C-u -1 C-l'.
((memq this-command '(digit-argument universal-argument)))
((not type-break-mode-line-message-mode)
;; Pause for a moment so any previous message can be seen.
(sit-for 2)
(message "%sWarning: typing break due in %s."
(type-break-time-stamp)
(type-break-format-time timeleft))
(setq type-break-time-warning-count
(1- type-break-time-warning-count))))))
(t
(remove-hook 'type-break-post-command-hook 'type-break-time-warning)
(setq type-break-warning-countdown-string nil))))
(defun type-break-keystroke-warning ()
(cond
((> type-break-keystroke-warning-count 0)
(setq type-break-warning-countdown-string
(number-to-string (- (cdr type-break-keystroke-threshold)
type-break-keystroke-count)))
(cond
((eq (selected-window) (minibuffer-window)))
;; Do nothing if the command was just a prefix arg, since that will
;; immediately be followed by some other interactive command.
;; Otherwise, it is particularly annoying for the sit-for below to
;; delay redisplay when one types sequences like `C-u -1 C-l'.
((memq this-command '(digit-argument universal-argument)))
((not type-break-mode-line-message-mode)
(sit-for 2)
(message "%sWarning: typing break due in %s keystrokes."
(type-break-time-stamp)
(- (cdr type-break-keystroke-threshold)
type-break-keystroke-count))
(setq type-break-keystroke-warning-count
(1- type-break-keystroke-warning-count)))))
(t
(remove-hook 'type-break-post-command-hook
'type-break-keystroke-warning)
(setq type-break-warning-countdown-string nil))))
(defun type-break-mode-line-countdown-or-break (&optional type)
(cond
((not type-break-mode-line-message-mode))
((eq type 'countdown)
;(setq type-break-mode-line-break-message-p nil)
(add-hook 'type-break-post-command-hook
'type-break-force-mode-line-update 'append))
((eq type 'break)
;; Alternate
(setq type-break-mode-line-break-message-p
(not type-break-mode-line-break-message-p))
(remove-hook 'type-break-post-command-hook
'type-break-force-mode-line-update))
(t
(setq type-break-mode-line-break-message-p nil)
(setq type-break-warning-countdown-string nil)
(remove-hook 'type-break-post-command-hook
'type-break-force-mode-line-update)))
(type-break-force-mode-line-update))
;;;###autoload
(defun type-break-statistics ()
"Print statistics about typing breaks in a temporary buffer.
This includes the last time a typing break was taken, when the next one is
scheduled, the keystroke thresholds and the current keystroke count, etc."
(interactive)
(with-output-to-temp-buffer "*Typing Break Statistics*"
(princ (format "Typing break statistics\n-----------------------\n
Typing break mode is currently %s.
Interactive query for breaks is %s.
Warnings of imminent typing breaks in mode line is %s.
Last typing break ended : %s
Next scheduled typing break : %s\n
Minimum keystroke threshold : %s
Maximum keystroke threshold : %s
Current keystroke count : %s"
(if type-break-mode "enabled" "disabled")
(if type-break-query-mode "enabled" "disabled")
(if type-break-mode-line-message-mode "enabled" "disabled")
(if type-break-time-last-break
(current-time-string type-break-time-last-break)
"never")
(if (and type-break-mode type-break-time-next-break)
(format "%s\t(%s from now)"
(current-time-string type-break-time-next-break)
(type-break-format-time
(type-break-time-difference
(current-time)
type-break-time-next-break)))
"none scheduled")
(or (car type-break-keystroke-threshold) "none")
(or (cdr type-break-keystroke-threshold) "none")
type-break-keystroke-count))))
;;;###autoload
(defun type-break-guesstimate-keystroke-threshold (wpm &optional wordlen frac)
"Guess values for the minimum/maximum keystroke threshold for typing breaks.
If called interactively, the user is prompted for their guess as to how
many words per minute they usually type. This value should not be your
maximum WPM, but your average. Of course, this is harder to gauge since it
can vary considerably depending on what you are doing. For example, one
tends to type less when debugging a program as opposed to writing
documentation. (Perhaps a separate program should be written to estimate
average typing speed.)
From that, this command sets the values in `type-break-keystroke-threshold'
based on a fairly simple algorithm involving assumptions about the average
length of words (5). For the minimum threshold, it uses about a fifth of
the computed maximum threshold.
When called from Lisp programs, the optional args WORDLEN and FRAC can be
used to override the default assumption about average word length and the
fraction of the maximum threshold to which to set the minimum threshold.
FRAC should be the inverse of the fractional value; for example, a value of
2 would mean to use one half, a value of 4 would mean to use one quarter, etc."
(interactive "NOn average, how many words per minute do you type? ")
(let* ((upper (* wpm (or wordlen 5) (/ type-break-interval 60)))
(lower (/ upper (or frac 5))))
(or type-break-keystroke-threshold
(setq type-break-keystroke-threshold (cons nil nil)))
(setcar type-break-keystroke-threshold lower)
(setcdr type-break-keystroke-threshold upper)
(if (called-interactively-p 'interactive)
(message "min threshold: %d\tmax threshold: %d" lower upper))
type-break-keystroke-threshold))
;;; misc functions
;; Compute the difference, in seconds, between a and b, two structures
;; similar to those returned by `current-time'.
(defun type-break-time-difference (a b)
(round (float-time (time-subtract b a))))
;; Return (in a new list the same in structure to that returned by
;; `current-time') the sum of the arguments. Each argument may be a time
;; list or a single integer, a number of seconds.
;; This function keeps the high and low 16 bits of the seconds properly
;; balanced so that the lower value never exceeds 16 bits. Otherwise, when
;; the result is passed to `current-time-string' it will toss some of the
;; "low" bits and format the time incorrectly.
(defun type-break-time-sum (&rest tmlist)
(let ((sum '(0 0 0)))
(dolist (tem tmlist)
(setq sum (time-add sum (if (integerp tem)
(list (floor tem 65536) (mod tem 65536))
tem))))
sum))
(defun type-break-time-stamp (&optional when)
(if (fboundp 'format-time-string)
(format-time-string type-break-time-stamp-format when)
;; Emacs 19.28 and prior do not have format-time-string.
;; In that case, result is not customizable. Upgrade today!
(format "[%s] " (substring (current-time-string when) 11 16))))
(defun type-break-format-time (secs)
(let ((mins (/ secs 60)))
(cond
((= mins 1) (format "%d minute" mins))
((> mins 0) (format "%d minutes" mins))
((= secs 1) (format "%d second" secs))
(t (format "%d seconds" secs)))))
(defun type-break-keystroke-reset ()
(setq type-break-interval-start (current-time)) ; not a keystroke
(setq type-break-keystroke-count 0)
(setq type-break-keystroke-warning-count 0)
(setq type-break-current-keystroke-warning-interval
type-break-keystroke-warning-intervals)
(remove-hook 'type-break-post-command-hook 'type-break-keystroke-warning))