Mercurial > emacs
annotate lisp/timer.el @ 24283:6822ef19292a
*** empty log message ***
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 08 Feb 1999 18:03:22 +0000 |
parents | f51f46bef183 |
children | 01102e63ed88 |
rev | line source |
---|---|
14449 | 1 ;;; timer.el --- run a function with args at some time in future. |
2 | |
3 ;; Copyright (C) 1996 Free Software Foundation, Inc. | |
4 | |
5 ;; Maintainer: FSF | |
6 | |
7 ;; This file is part of GNU Emacs. | |
8 | |
9 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
10 ;; it under the terms of the GNU General Public License as published by | |
11 ;; the Free Software Foundation; either version 2, or (at your option) | |
12 ;; any later version. | |
13 | |
14 ;; GNU Emacs is distributed in the hope that it will be useful, | |
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 ;; GNU General Public License for more details. | |
18 | |
19 ;; You should have received a copy of the GNU General Public License | |
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
22 ;; Boston, MA 02111-1307, USA. | |
23 | |
24 ;;; Commentary: | |
25 | |
26 ;; This package gives you the capability to run Emacs Lisp commands at | |
27 ;; specified times in the future, either as one-shots or periodically. | |
28 | |
29 ;;; Code: | |
30 | |
31 ;; Layout of a timer vector: | |
14632
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
32 ;; [triggered-p high-seconds low-seconds usecs repeat-delay |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
33 ;; function args idle-delay] |
14449 | 34 |
35 (defun timer-create () | |
36 "Create a timer object." | |
14632
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
37 (let ((timer (make-vector 8 nil))) |
14449 | 38 (aset timer 0 t) |
39 timer)) | |
40 | |
41 (defun timerp (object) | |
42 "Return t if OBJECT is a timer." | |
14632
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
43 (and (vectorp object) (= (length object) 8))) |
14449 | 44 |
45 (defun timer-set-time (timer time &optional delta) | |
46 "Set the trigger time of TIMER to TIME. | |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
47 TIME must be in the internal format returned by, e.g., `current-time'. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
48 If optional third argument DELTA is a non-zero integer, make the timer |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
49 fire repeatedly that many seconds apart." |
14449 | 50 (or (timerp timer) |
51 (error "Invalid timer")) | |
52 (aset timer 1 (car time)) | |
53 (aset timer 2 (if (consp (cdr time)) (car (cdr time)) (cdr time))) | |
14870
c51cef393dae
(timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents:
14705
diff
changeset
|
54 (aset timer 3 (or (and (consp (cdr time)) (consp (cdr (cdr time))) |
c51cef393dae
(timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents:
14705
diff
changeset
|
55 (nth 2 time)) |
c51cef393dae
(timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents:
14705
diff
changeset
|
56 0)) |
14449 | 57 (aset timer 4 (and (numberp delta) (> delta 0) delta)) |
58 timer) | |
59 | |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
60 (defun timer-set-idle-time (timer secs &optional repeat) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
61 "Set the trigger idle time of TIMER to SECS. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
62 If optional third argument REPEAT is non-nil, make the timer |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
63 fire each time Emacs is idle for that many seconds." |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
64 (or (timerp timer) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
65 (error "Invalid timer")) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
66 (aset timer 1 0) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
67 (aset timer 2 0) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
68 (aset timer 3 0) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
69 (timer-inc-time timer secs) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
70 (aset timer 4 repeat) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
71 timer) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
72 |
16085
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
73 (defun timer-next-integral-multiple-of-time (time secs) |
16654
4f8b4e26cc92
(timer-next-integral-multiple-of-time): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
16407
diff
changeset
|
74 "Yield the next value after TIME that is an integral multiple of SECS. |
4f8b4e26cc92
(timer-next-integral-multiple-of-time): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
16407
diff
changeset
|
75 More precisely, the next value, after TIME, that is an integral multiple |
4f8b4e26cc92
(timer-next-integral-multiple-of-time): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
16407
diff
changeset
|
76 of SECS seconds since the epoch. SECS may be a fraction." |
16085
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
77 (let ((time-base (ash 1 16))) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
78 (if (fboundp 'atan) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
79 ;; Use floating point, taking care to not lose precision. |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
80 (let* ((float-time-base (float time-base)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
81 (million 1000000.0) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
82 (time-usec (+ (* million |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
83 (+ (* float-time-base (nth 0 time)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
84 (nth 1 time))) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
85 (nth 2 time))) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
86 (secs-usec (* million secs)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
87 (mod-usec (mod time-usec secs-usec)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
88 (next-usec (+ (- time-usec mod-usec) secs-usec)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
89 (time-base-million (* float-time-base million))) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
90 (list (floor next-usec time-base-million) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
91 (floor (mod next-usec time-base-million) million) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
92 (floor (mod next-usec million)))) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
93 ;; Floating point is not supported. |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
94 ;; Use integer arithmetic, avoiding overflow if possible. |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
95 (let* ((mod-sec (mod (+ (* (mod time-base secs) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
96 (mod (nth 0 time) secs)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
97 (nth 1 time)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
98 secs)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
99 (next-1-sec (+ (- (nth 1 time) mod-sec) secs))) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
100 (list (+ (nth 0 time) (floor next-1-sec time-base)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
101 (mod next-1-sec time-base) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
102 0))))) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
103 |
14449 | 104 (defun timer-relative-time (time secs &optional usecs) |
105 "Advance TIME by SECS seconds and optionally USECS microseconds. | |
106 SECS may be a fraction." | |
107 (let ((high (car time)) | |
108 (low (if (consp (cdr time)) (nth 1 time) (cdr time))) | |
109 (micro (if (numberp (car-safe (cdr-safe (cdr time)))) | |
110 (nth 2 time) | |
111 0))) | |
112 ;; Add | |
113 (if usecs (setq micro (+ micro usecs))) | |
114 (if (floatp secs) | |
115 (setq micro (+ micro (floor (* 1000000 (- secs (floor secs))))))) | |
116 (setq low (+ low (floor secs))) | |
117 | |
118 ;; Normalize | |
119 (setq low (+ low (/ micro 1000000))) | |
120 (setq micro (mod micro 1000000)) | |
121 (setq high (+ high (/ low 65536))) | |
122 (setq low (logand low 65535)) | |
123 | |
124 (list high low (and (/= micro 0) micro)))) | |
125 | |
126 (defun timer-inc-time (timer secs &optional usecs) | |
127 "Increment the time set in TIMER by SECS seconds and USECS microseconds. | |
128 SECS may be a fraction." | |
129 (let ((time (timer-relative-time | |
130 (list (aref timer 1) (aref timer 2) (aref timer 3)) | |
131 secs | |
132 usecs))) | |
133 (aset timer 1 (nth 0 time)) | |
134 (aset timer 2 (nth 1 time)) | |
135 (aset timer 3 (or (nth 2 time) 0)))) | |
136 | |
137 (defun timer-set-time-with-usecs (timer time usecs &optional delta) | |
138 "Set the trigger time of TIMER to TIME. | |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
139 TIME must be in the internal format returned by, e.g., `current-time'. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
140 If optional third argument DELTA is a non-zero integer, make the timer |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
141 fire repeatedly that many seconds apart." |
14449 | 142 (or (timerp timer) |
143 (error "Invalid timer")) | |
144 (aset timer 1 (car time)) | |
145 (aset timer 2 (if (consp (cdr time)) (car (cdr time)) (cdr time))) | |
146 (aset timer 3 usecs) | |
147 (aset timer 4 (and (numberp delta) (> delta 0) delta)) | |
148 timer) | |
149 | |
150 (defun timer-set-function (timer function &optional args) | |
151 "Make TIMER call FUNCTION with optional ARGS when triggering." | |
152 (or (timerp timer) | |
153 (error "Invalid timer")) | |
154 (aset timer 5 function) | |
155 (aset timer 6 args) | |
156 timer) | |
157 | |
158 (defun timer-activate (timer) | |
159 "Put TIMER on the list of active timers." | |
160 (if (and (timerp timer) | |
161 (integerp (aref timer 1)) | |
162 (integerp (aref timer 2)) | |
163 (integerp (aref timer 3)) | |
164 (aref timer 5)) | |
165 (let ((timers timer-list) | |
166 last) | |
167 ;; Skip all timers to trigger before the new one. | |
168 (while (and timers | |
169 (or (> (aref timer 1) (aref (car timers) 1)) | |
170 (and (= (aref timer 1) (aref (car timers) 1)) | |
171 (> (aref timer 2) (aref (car timers) 2))) | |
172 (and (= (aref timer 1) (aref (car timers) 1)) | |
173 (= (aref timer 2) (aref (car timers) 2)) | |
174 (> (aref timer 3) (aref (car timers) 3))))) | |
175 (setq last timers | |
176 timers (cdr timers))) | |
177 ;; Insert new timer after last which possibly means in front of queue. | |
178 (if last | |
179 (setcdr last (cons timer timers)) | |
180 (setq timer-list (cons timer timers))) | |
181 (aset timer 0 nil) | |
14632
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
182 (aset timer 7 nil) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
183 nil) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
184 (error "Invalid or uninitialized timer"))) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
185 |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
186 (defun timer-activate-when-idle (timer) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
187 "Arrange to activate TIMER whenever Emacs is next idle." |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
188 (if (and (timerp timer) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
189 (integerp (aref timer 1)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
190 (integerp (aref timer 2)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
191 (integerp (aref timer 3)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
192 (aref timer 5)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
193 (let ((timers timer-idle-list) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
194 last) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
195 ;; Skip all timers to trigger before the new one. |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
196 (while (and timers |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
197 (or (> (aref timer 1) (aref (car timers) 1)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
198 (and (= (aref timer 1) (aref (car timers) 1)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
199 (> (aref timer 2) (aref (car timers) 2))) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
200 (and (= (aref timer 1) (aref (car timers) 1)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
201 (= (aref timer 2) (aref (car timers) 2)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
202 (> (aref timer 3) (aref (car timers) 3))))) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
203 (setq last timers |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
204 timers (cdr timers))) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
205 ;; Insert new timer after last which possibly means in front of queue. |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
206 (if last |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
207 (setcdr last (cons timer timers)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
208 (setq timer-idle-list (cons timer timers))) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
209 (aset timer 0 t) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
210 (aset timer 7 t) |
14449 | 211 nil) |
212 (error "Invalid or uninitialized timer"))) | |
213 | |
16400
9a39893d9861
(cancel-timer): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
16085
diff
changeset
|
214 ;;;###autoload |
14449 | 215 (defalias 'disable-timeout 'cancel-timer) |
16400
9a39893d9861
(cancel-timer): Add autoload cookie.
Richard M. Stallman <rms@gnu.org>
parents:
16085
diff
changeset
|
216 ;;;###autoload |
14449 | 217 (defun cancel-timer (timer) |
218 "Remove TIMER from the list of active timers." | |
219 (or (timerp timer) | |
220 (error "Invalid timer")) | |
221 (setq timer-list (delq timer timer-list)) | |
14632
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
222 (setq timer-idle-list (delq timer timer-idle-list)) |
14449 | 223 nil) |
224 | |
16407
a3bd74a05c45
(cancel-function-timers): Add autoload.
Richard M. Stallman <rms@gnu.org>
parents:
16400
diff
changeset
|
225 ;;;###autoload |
14449 | 226 (defun cancel-function-timers (function) |
227 "Cancel all timers scheduled by `run-at-time' which would run FUNCTION." | |
228 (interactive "aCancel timers of function: ") | |
229 (let ((tail timer-list)) | |
230 (while tail | |
231 (if (eq (aref (car tail) 5) function) | |
232 (setq timer-list (delq (car tail) timer-list))) | |
14632
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
233 (setq tail (cdr tail)))) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
234 (let ((tail timer-idle-list)) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
235 (while tail |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
236 (if (eq (aref (car tail) 5) function) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
237 (setq timer-idle-list (delq (car tail) timer-idle-list))) |
14449 | 238 (setq tail (cdr tail))))) |
239 | |
14885
38e792454ee3
(timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents:
14870
diff
changeset
|
240 ;; Record the last few events, for debugging. |
38e792454ee3
(timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents:
14870
diff
changeset
|
241 (defvar timer-event-last-2 nil) |
38e792454ee3
(timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents:
14870
diff
changeset
|
242 (defvar timer-event-last-1 nil) |
38e792454ee3
(timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents:
14870
diff
changeset
|
243 (defvar timer-event-last nil) |
38e792454ee3
(timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents:
14870
diff
changeset
|
244 |
17452 | 245 (defvar timer-max-repeats 10 |
246 "*Maximum number of times to repeat a timer, if real time jumps.") | |
247 | |
248 (defun timer-until (timer time) | |
249 "Calculate number of seconds from when TIMER will run, until TIME. | |
250 TIMER is a timer, and stands for the time when its next repeat is scheduled. | |
17457
e614abd1ff44
(timer-until): Fix syntax error.
Karl Heuer <kwzh@gnu.org>
parents:
17452
diff
changeset
|
251 TIME is a time-list." |
17452 | 252 (let ((high (- (car time) (aref timer 1))) |
253 (low (- (nth 1 time) (aref timer 2)))) | |
254 (+ low (* high 65536)))) | |
255 | |
17708
95f0456681cc
(timer-event-handler): Take timer as arg directly.
Richard M. Stallman <rms@gnu.org>
parents:
17457
diff
changeset
|
256 (defun timer-event-handler (timer) |
95f0456681cc
(timer-event-handler): Take timer as arg directly.
Richard M. Stallman <rms@gnu.org>
parents:
17457
diff
changeset
|
257 "Call the handler for the timer TIMER. |
95f0456681cc
(timer-event-handler): Take timer as arg directly.
Richard M. Stallman <rms@gnu.org>
parents:
17457
diff
changeset
|
258 This function is called, by name, directly by the C code." |
14885
38e792454ee3
(timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents:
14870
diff
changeset
|
259 (setq timer-event-last-2 timer-event-last-1) |
38e792454ee3
(timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents:
14870
diff
changeset
|
260 (setq timer-event-last-1 timer-event-last) |
17708
95f0456681cc
(timer-event-handler): Take timer as arg directly.
Richard M. Stallman <rms@gnu.org>
parents:
17457
diff
changeset
|
261 (setq timer-event-last timer) |
95f0456681cc
(timer-event-handler): Take timer as arg directly.
Richard M. Stallman <rms@gnu.org>
parents:
17457
diff
changeset
|
262 (let ((inhibit-quit t)) |
14449 | 263 (if (timerp timer) |
264 (progn | |
265 ;; Delete from queue. | |
266 (cancel-timer timer) | |
267 ;; Re-schedule if requested. | |
268 (if (aref timer 4) | |
14632
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
269 (if (aref timer 7) |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
270 (timer-activate-when-idle timer) |
14449 | 271 (timer-inc-time timer (aref timer 4) 0) |
17452 | 272 ;; If real time has jumped forward, |
273 ;; perhaps because Emacs was suspended for a long time, | |
274 ;; limit how many times things get repeated. | |
275 (if (and (numberp timer-max-repeats) | |
276 (< 0 (timer-until timer (current-time)))) | |
277 (let ((repeats (/ (timer-until timer (current-time)) | |
278 (aref timer 4)))) | |
279 (if (> repeats timer-max-repeats) | |
280 (timer-inc-time timer (* (aref timer 4) repeats))))) | |
19588
f51f46bef183
(timer-event-handler): Reactivate timer first,
Richard M. Stallman <rms@gnu.org>
parents:
17708
diff
changeset
|
281 (timer-activate timer))) |
f51f46bef183
(timer-event-handler): Reactivate timer first,
Richard M. Stallman <rms@gnu.org>
parents:
17708
diff
changeset
|
282 ;; Run handler. |
f51f46bef183
(timer-event-handler): Reactivate timer first,
Richard M. Stallman <rms@gnu.org>
parents:
17708
diff
changeset
|
283 ;; We do this after rescheduling so that the handler function |
f51f46bef183
(timer-event-handler): Reactivate timer first,
Richard M. Stallman <rms@gnu.org>
parents:
17708
diff
changeset
|
284 ;; can cancel its own timer successfully with cancel-timer. |
f51f46bef183
(timer-event-handler): Reactivate timer first,
Richard M. Stallman <rms@gnu.org>
parents:
17708
diff
changeset
|
285 (condition-case nil |
f51f46bef183
(timer-event-handler): Reactivate timer first,
Richard M. Stallman <rms@gnu.org>
parents:
17708
diff
changeset
|
286 (apply (aref timer 5) (aref timer 6)) |
f51f46bef183
(timer-event-handler): Reactivate timer first,
Richard M. Stallman <rms@gnu.org>
parents:
17708
diff
changeset
|
287 (error nil))) |
14449 | 288 (error "Bogus timer event")))) |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
289 |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
290 ;; This function is incompatible with the one in levents.el. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
291 (defun timeout-event-p (event) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
292 "Non-nil if EVENT is a timeout event." |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
293 (and (listp event) (eq (car event) 'timer-event))) |
14449 | 294 |
295 ;;;###autoload | |
296 (defun run-at-time (time repeat function &rest args) | |
16077 | 297 "Perform an action at time TIME. |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
298 Repeat the action every REPEAT seconds, if REPEAT is non-nil. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
299 TIME should be a string like \"11:23pm\", nil meaning now, a number of seconds |
16085
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
300 from now, a value from `current-time', or t (with non-nil REPEAT) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
301 meaning the next integral multiple of REPEAT. |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
302 REPEAT may be an integer or floating point number. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
303 The action is to call FUNCTION with arguments ARGS. |
14449 | 304 |
305 This function returns a timer object which you can use in `cancel-timer'." | |
306 (interactive "sRun at time: \nNRepeat interval: \naFunction: ") | |
307 | |
16085
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
308 (or (null repeat) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
309 (and (numberp repeat) (< 0 repeat)) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
310 (error "Invalid repetition interval")) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
311 |
14686 | 312 ;; Special case: nil means "now" and is useful when repeating. |
14449 | 313 (if (null time) |
314 (setq time (current-time))) | |
315 | |
16085
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
316 ;; Special case: t means the next integral multiple of REPEAT. |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
317 (if (and (eq time t) repeat) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
318 (setq time (timer-next-integral-multiple-of-time (current-time) repeat))) |
b215fb935fc3
(timer-next-integral-multiple-of-time): New function.
Paul Eggert <eggert@twinsun.com>
parents:
16077
diff
changeset
|
319 |
14508
87b0d4b7577a
(run-at-time): Handle numbers as relative times in seconds, as the original
Roland McGrath <roland@gnu.org>
parents:
14470
diff
changeset
|
320 ;; Handle numbers as relative times in seconds. |
87b0d4b7577a
(run-at-time): Handle numbers as relative times in seconds, as the original
Roland McGrath <roland@gnu.org>
parents:
14470
diff
changeset
|
321 (if (numberp time) |
87b0d4b7577a
(run-at-time): Handle numbers as relative times in seconds, as the original
Roland McGrath <roland@gnu.org>
parents:
14470
diff
changeset
|
322 (setq time (timer-relative-time (current-time) time))) |
87b0d4b7577a
(run-at-time): Handle numbers as relative times in seconds, as the original
Roland McGrath <roland@gnu.org>
parents:
14470
diff
changeset
|
323 |
14449 | 324 ;; Handle relative times like "2 hours and 35 minutes" |
325 (if (stringp time) | |
326 (let ((secs (timer-duration time))) | |
327 (if secs | |
328 (setq time (timer-relative-time (current-time) secs))))) | |
329 | |
330 ;; Handle "11:23pm" and the like. Interpret it as meaning today | |
331 ;; which admittedly is rather stupid if we have passed that time | |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
332 ;; already. (Though only Emacs hackers hack Emacs at that time.) |
14449 | 333 (if (stringp time) |
334 (progn | |
335 (require 'diary-lib) | |
336 (let ((hhmm (diary-entry-time time)) | |
337 (now (decode-time))) | |
338 (if (>= hhmm 0) | |
339 (setq time | |
340 (encode-time 0 (% hhmm 100) (/ hhmm 100) (nth 3 now) | |
341 (nth 4 now) (nth 5 now) (nth 8 now))))))) | |
342 | |
343 (or (consp time) | |
344 (error "Invalid time format")) | |
345 | |
346 (let ((timer (timer-create))) | |
347 (timer-set-time timer time repeat) | |
348 (timer-set-function timer function args) | |
349 (timer-activate timer) | |
350 timer)) | |
351 | |
352 ;;;###autoload | |
353 (defun run-with-timer (secs repeat function &rest args) | |
354 "Perform an action after a delay of SECS seconds. | |
355 Repeat the action every REPEAT seconds, if REPEAT is non-nil. | |
356 SECS and REPEAT may be integers or floating point numbers. | |
357 The action is to call FUNCTION with arguments ARGS. | |
358 | |
359 This function returns a timer object which you can use in `cancel-timer'." | |
360 (interactive "sRun after delay (seconds): \nNRepeat interval: \naFunction: ") | |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
361 (apply 'run-at-time secs repeat function args)) |
14632
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
362 |
f50f87fae914
(run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents:
14509
diff
changeset
|
363 ;;;###autoload |
14449 | 364 (defun add-timeout (secs function object &optional repeat) |
365 "Add a timer to run SECS seconds from now, to call FUNCTION on OBJECT. | |
366 If REPEAT is non-nil, repeat the timer every REPEAT seconds. | |
367 This function is for compatibility; see also `run-with-timer'." | |
368 (run-with-timer secs repeat function object)) | |
369 | |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
370 ;;;###autoload |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
371 (defun run-with-idle-timer (secs repeat function &rest args) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
372 "Perform an action the next time Emacs is idle for SECS seconds. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
373 If REPEAT is non-nil, do this each time Emacs is idle for SECS seconds. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
374 SECS may be an integer or a floating point number. |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
375 The action is to call FUNCTION with arguments ARGS. |
14449 | 376 |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
377 This function returns a timer object which you can use in `cancel-timer'." |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
378 (interactive |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
379 (list (read-from-minibuffer "Run after idle (seconds): " nil nil t) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
380 (y-or-n-p "Repeat each time Emacs is idle? ") |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
381 (intern (completing-read "Function: " obarray 'fboundp t)))) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
382 (let ((timer (timer-create))) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
383 (timer-set-function timer function args) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
384 (timer-set-idle-time timer secs repeat) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
385 (timer-activate-when-idle timer) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
386 timer)) |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
387 |
14449 | 388 (defun with-timeout-handler (tag) |
389 (throw tag 'timeout)) | |
390 | |
391 ;;;###autoload (put 'with-timeout 'lisp-indent-function 1) | |
392 | |
393 ;;;###autoload | |
394 (defmacro with-timeout (list &rest body) | |
395 "Run BODY, but if it doesn't finish in SECONDS seconds, give up. | |
396 If we give up, we run the TIMEOUT-FORMS and return the value of the last one. | |
14705
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
397 The call should look like: |
5e7b3fbecc8d
(timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents:
14686
diff
changeset
|
398 (with-timeout (SECONDS TIMEOUT-FORMS...) BODY...) |
14449 | 399 The timeout is checked whenever Emacs waits for some kind of external |
400 event \(such as keyboard input, input from subprocesses, or a certain time); | |
401 if the program loops without waiting in any way, the timeout will not | |
402 be detected." | |
403 (let ((seconds (car list)) | |
404 (timeout-forms (cdr list))) | |
405 `(let ((with-timeout-tag (cons nil nil)) | |
406 with-timeout-value with-timeout-timer) | |
407 (if (catch with-timeout-tag | |
408 (progn | |
409 (setq with-timeout-timer | |
410 (run-with-timer ,seconds nil | |
411 'with-timeout-handler | |
412 with-timeout-tag)) | |
413 (setq with-timeout-value (progn . ,body)) | |
414 nil)) | |
415 (progn . ,timeout-forms) | |
416 (cancel-timer with-timeout-timer) | |
417 with-timeout-value)))) | |
418 | |
419 (defun y-or-n-p-with-timeout (prompt seconds default-value) | |
420 "Like (y-or-n-p PROMPT), with a timeout. | |
421 If the user does not answer after SECONDS seconds, return DEFAULT-VALUE." | |
422 (with-timeout (seconds default-value) | |
423 (y-or-n-p prompt))) | |
424 | |
425 (defvar timer-duration-words | |
426 (list (cons "microsec" 0.000001) | |
427 (cons "microsecond" 0.000001) | |
428 (cons "millisec" 0.001) | |
429 (cons "millisecond" 0.001) | |
430 (cons "sec" 1) | |
431 (cons "second" 1) | |
432 (cons "min" 60) | |
433 (cons "minute" 60) | |
434 (cons "hour" (* 60 60)) | |
435 (cons "day" (* 24 60 60)) | |
436 (cons "week" (* 7 24 60 60)) | |
437 (cons "fortnight" (* 14 24 60 60)) | |
438 (cons "month" (* 30 24 60 60)) ; Approximation | |
439 (cons "year" (* 365.25 24 60 60)) ; Approximation | |
440 ) | |
441 "Alist mapping temporal words to durations in seconds") | |
442 | |
443 (defun timer-duration (string) | |
444 "Return number of seconds specified by STRING, or nil if parsing fails." | |
445 (let ((secs 0) | |
446 (start 0) | |
447 (case-fold-search t)) | |
448 (while (string-match | |
449 "[ \t]*\\([0-9.]+\\)?[ \t]*\\([a-z]+[a-rt-z]\\)s?[ \t]*" | |
450 string start) | |
451 (let ((count (if (match-beginning 1) | |
452 (string-to-number (match-string 1 string)) | |
453 1)) | |
454 (itemsize (cdr (assoc (match-string 2 string) | |
455 timer-duration-words)))) | |
456 (if itemsize | |
457 (setq start (match-end 0) | |
458 secs (+ secs (* count itemsize))) | |
459 (setq secs nil | |
460 start (length string))))) | |
14870
c51cef393dae
(timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents:
14705
diff
changeset
|
461 (if (= start (length string)) |
c51cef393dae
(timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents:
14705
diff
changeset
|
462 secs |
c51cef393dae
(timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents:
14705
diff
changeset
|
463 (if (string-match "\\`[0-9.]+\\'" string) |
c51cef393dae
(timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents:
14705
diff
changeset
|
464 (string-to-number string))))) |
14449 | 465 |
466 (provide 'timer) | |
467 | |
468 ;;; timer.el ends here |