Commit | Line | Data |
---|---|---|
5e046f6d JB |
1 | ;;; timer.el --- run a function with args at some time in future |
2 | ||
d59c3137 | 3 | ;; Copyright (C) 1996, 2001, 2002, 2003, 2004, 2005, |
8b72699e | 4 | ;; 2006, 2007, 2008 Free Software Foundation, Inc. |
5e046f6d JB |
5 | |
6 | ;; Maintainer: FSF | |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
e0085d62 | 12 | ;; the Free Software Foundation; either version 3, or (at your option) |
5e046f6d JB |
13 | ;; any later version. |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
3a35cf56 LK |
22 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
23 | ;; Boston, MA 02110-1301, USA. | |
5e046f6d JB |
24 | |
25 | ;;; Commentary: | |
26 | ||
27 | ;; This package gives you the capability to run Emacs Lisp commands at | |
28 | ;; specified times in the future, either as one-shots or periodically. | |
29 | ||
30 | ;;; Code: | |
31 | ||
32 | ;; Layout of a timer vector: | |
33 | ;; [triggered-p high-seconds low-seconds usecs repeat-delay | |
34 | ;; function args idle-delay] | |
b8bd37f2 RS |
35 | ;; triggered-p is nil if the timer is active (waiting to be triggered), |
36 | ;; t if it is inactive ("already triggered", in theory) | |
5e046f6d JB |
37 | |
38 | (defun timer-create () | |
b8bd37f2 | 39 | "Create a timer object which can be passed to `timer-activate'." |
5e046f6d JB |
40 | (let ((timer (make-vector 8 nil))) |
41 | (aset timer 0 t) | |
42 | timer)) | |
43 | ||
44 | (defun timerp (object) | |
45 | "Return t if OBJECT is a timer." | |
46 | (and (vectorp object) (= (length object) 8))) | |
47 | ||
48 | (defun timer-set-time (timer time &optional delta) | |
49 | "Set the trigger time of TIMER to TIME. | |
50 | TIME must be in the internal format returned by, e.g., `current-time'. | |
51 | If optional third argument DELTA is a positive number, make the timer | |
52 | fire repeatedly that many seconds apart." | |
53 | (or (timerp timer) | |
54 | (error "Invalid timer")) | |
55 | (aset timer 1 (car time)) | |
56 | (aset timer 2 (if (consp (cdr time)) (car (cdr time)) (cdr time))) | |
57 | (aset timer 3 (or (and (consp (cdr time)) (consp (cdr (cdr time))) | |
58 | (nth 2 time)) | |
59 | 0)) | |
60 | (aset timer 4 (and (numberp delta) (> delta 0) delta)) | |
61 | timer) | |
62 | ||
63 | (defun timer-set-idle-time (timer secs &optional repeat) | |
64 | "Set the trigger idle time of TIMER to SECS. | |
1063efe8 CY |
65 | SECS may be an integer, floating point number, or the internal |
66 | time format (HIGH LOW USECS) returned by, e.g., `current-idle-time'. | |
5e046f6d JB |
67 | If optional third argument REPEAT is non-nil, make the timer |
68 | fire each time Emacs is idle for that many seconds." | |
69 | (or (timerp timer) | |
70 | (error "Invalid timer")) | |
1063efe8 CY |
71 | (if (consp secs) |
72 | (progn (aset timer 1 (car secs)) | |
73 | (aset timer 2 (if (consp (cdr secs)) (car (cdr secs)) (cdr secs))) | |
74 | (aset timer 3 (or (and (consp (cdr secs)) (consp (cdr (cdr secs))) | |
75 | (nth 2 secs)) | |
76 | 0))) | |
77 | (aset timer 1 0) | |
78 | (aset timer 2 0) | |
79 | (aset timer 3 0) | |
80 | (timer-inc-time timer secs)) | |
5e046f6d JB |
81 | (aset timer 4 repeat) |
82 | timer) | |
83 | ||
84 | (defun timer-next-integral-multiple-of-time (time secs) | |
85 | "Yield the next value after TIME that is an integral multiple of SECS. | |
86 | More precisely, the next value, after TIME, that is an integral multiple | |
87 | of SECS seconds since the epoch. SECS may be a fraction." | |
88 | (let ((time-base (ash 1 16))) | |
89 | (if (fboundp 'atan) | |
90 | ;; Use floating point, taking care to not lose precision. | |
91 | (let* ((float-time-base (float time-base)) | |
92 | (million 1000000.0) | |
93 | (time-usec (+ (* million | |
94 | (+ (* float-time-base (nth 0 time)) | |
95 | (nth 1 time))) | |
96 | (nth 2 time))) | |
97 | (secs-usec (* million secs)) | |
98 | (mod-usec (mod time-usec secs-usec)) | |
99 | (next-usec (+ (- time-usec mod-usec) secs-usec)) | |
100 | (time-base-million (* float-time-base million))) | |
101 | (list (floor next-usec time-base-million) | |
102 | (floor (mod next-usec time-base-million) million) | |
103 | (floor (mod next-usec million)))) | |
104 | ;; Floating point is not supported. | |
105 | ;; Use integer arithmetic, avoiding overflow if possible. | |
106 | (let* ((mod-sec (mod (+ (* (mod time-base secs) | |
107 | (mod (nth 0 time) secs)) | |
108 | (nth 1 time)) | |
109 | secs)) | |
110 | (next-1-sec (+ (- (nth 1 time) mod-sec) secs))) | |
111 | (list (+ (nth 0 time) (floor next-1-sec time-base)) | |
112 | (mod next-1-sec time-base) | |
113 | 0))))) | |
114 | ||
115 | (defun timer-relative-time (time secs &optional usecs) | |
116 | "Advance TIME by SECS seconds and optionally USECS microseconds. | |
1063efe8 | 117 | SECS may be either an integer or a floating point number." |
5e046f6d JB |
118 | (let ((high (car time)) |
119 | (low (if (consp (cdr time)) (nth 1 time) (cdr time))) | |
120 | (micro (if (numberp (car-safe (cdr-safe (cdr time)))) | |
121 | (nth 2 time) | |
122 | 0))) | |
123 | ;; Add | |
124 | (if usecs (setq micro (+ micro usecs))) | |
125 | (if (floatp secs) | |
126 | (setq micro (+ micro (floor (* 1000000 (- secs (floor secs))))))) | |
127 | (setq low (+ low (floor secs))) | |
128 | ||
129 | ;; Normalize | |
130 | ;; `/' rounds towards zero while `mod' returns a positive number, | |
131 | ;; so we can't rely on (= a (+ (* 100 (/ a 100)) (mod a 100))). | |
132 | (setq low (+ low (/ micro 1000000) (if (< micro 0) -1 0))) | |
133 | (setq micro (mod micro 1000000)) | |
134 | (setq high (+ high (/ low 65536) (if (< low 0) -1 0))) | |
135 | (setq low (logand low 65535)) | |
136 | ||
137 | (list high low (and (/= micro 0) micro)))) | |
138 | ||
139 | (defun timer-inc-time (timer secs &optional usecs) | |
140 | "Increment the time set in TIMER by SECS seconds and USECS microseconds. | |
141 | SECS may be a fraction. If USECS is omitted, that means it is zero." | |
142 | (let ((time (timer-relative-time | |
143 | (list (aref timer 1) (aref timer 2) (aref timer 3)) | |
144 | secs | |
145 | usecs))) | |
146 | (aset timer 1 (nth 0 time)) | |
147 | (aset timer 2 (nth 1 time)) | |
148 | (aset timer 3 (or (nth 2 time) 0)))) | |
149 | ||
150 | (defun timer-set-time-with-usecs (timer time usecs &optional delta) | |
151 | "Set the trigger time of TIMER to TIME plus USECS. | |
152 | TIME must be in the internal format returned by, e.g., `current-time'. | |
153 | The microsecond count from TIME is ignored, and USECS is used instead. | |
154 | If optional fourth argument DELTA is a positive number, make the timer | |
155 | fire repeatedly that many seconds apart." | |
156 | (or (timerp timer) | |
157 | (error "Invalid timer")) | |
158 | (aset timer 1 (nth 0 time)) | |
159 | (aset timer 2 (nth 1 time)) | |
160 | (aset timer 3 usecs) | |
161 | (aset timer 4 (and (numberp delta) (> delta 0) delta)) | |
162 | timer) | |
163 | (make-obsolete 'timer-set-time-with-usecs | |
164 | "use `timer-set-time' and `timer-inc-time' instead." | |
bf247b6e | 165 | "22.1") |
5e046f6d JB |
166 | |
167 | (defun timer-set-function (timer function &optional args) | |
168 | "Make TIMER call FUNCTION with optional ARGS when triggering." | |
169 | (or (timerp timer) | |
170 | (error "Invalid timer")) | |
171 | (aset timer 5 function) | |
172 | (aset timer 6 args) | |
173 | timer) | |
174 | \f | |
dbbee529 RS |
175 | (defun timer-activate (timer &optional triggered-p reuse-cell) |
176 | "Put TIMER on the list of active timers. | |
177 | ||
b8bd37f2 RS |
178 | If TRIGGERED-P is t, that means to make the timer inactive |
179 | \(put it on the list, but mark it as already triggered). | |
180 | To remove from the list, use `cancel-timer'. | |
181 | ||
dbbee529 RS |
182 | REUSE-CELL, if non-nil, is a cons cell to reuse instead |
183 | of allocating a new one." | |
5e046f6d JB |
184 | (if (and (timerp timer) |
185 | (integerp (aref timer 1)) | |
186 | (integerp (aref timer 2)) | |
187 | (integerp (aref timer 3)) | |
188 | (aref timer 5)) | |
189 | (let ((timers timer-list) | |
190 | last) | |
191 | ;; Skip all timers to trigger before the new one. | |
192 | (while (and timers | |
193 | (or (> (aref timer 1) (aref (car timers) 1)) | |
194 | (and (= (aref timer 1) (aref (car timers) 1)) | |
195 | (> (aref timer 2) (aref (car timers) 2))) | |
196 | (and (= (aref timer 1) (aref (car timers) 1)) | |
197 | (= (aref timer 2) (aref (car timers) 2)) | |
198 | (> (aref timer 3) (aref (car timers) 3))))) | |
199 | (setq last timers | |
200 | timers (cdr timers))) | |
dbbee529 RS |
201 | (if reuse-cell |
202 | (progn | |
203 | (setcar reuse-cell timer) | |
204 | (setcdr reuse-cell timers)) | |
205 | (setq reuse-cell (cons timer timers))) | |
5e046f6d JB |
206 | ;; Insert new timer after last which possibly means in front of queue. |
207 | (if last | |
dbbee529 RS |
208 | (setcdr last reuse-cell) |
209 | (setq timer-list reuse-cell)) | |
6160f933 | 210 | (aset timer 0 triggered-p) |
5e046f6d JB |
211 | (aset timer 7 nil) |
212 | nil) | |
213 | (error "Invalid or uninitialized timer"))) | |
214 | ||
dbbee529 | 215 | (defun timer-activate-when-idle (timer &optional dont-wait reuse-cell) |
5e046f6d JB |
216 | "Arrange to activate TIMER whenever Emacs is next idle. |
217 | If optional argument DONT-WAIT is non-nil, then enable the | |
218 | timer to activate immediately, or at the right time, if Emacs | |
dbbee529 RS |
219 | is already idle. |
220 | ||
221 | REUSE-CELL, if non-nil, is a cons cell to reuse instead | |
222 | of allocating a new one." | |
5e046f6d JB |
223 | (if (and (timerp timer) |
224 | (integerp (aref timer 1)) | |
225 | (integerp (aref timer 2)) | |
226 | (integerp (aref timer 3)) | |
227 | (aref timer 5)) | |
228 | (let ((timers timer-idle-list) | |
229 | last) | |
230 | ;; Skip all timers to trigger before the new one. | |
231 | (while (and timers | |
232 | (or (> (aref timer 1) (aref (car timers) 1)) | |
233 | (and (= (aref timer 1) (aref (car timers) 1)) | |
234 | (> (aref timer 2) (aref (car timers) 2))) | |
235 | (and (= (aref timer 1) (aref (car timers) 1)) | |
236 | (= (aref timer 2) (aref (car timers) 2)) | |
237 | (> (aref timer 3) (aref (car timers) 3))))) | |
238 | (setq last timers | |
239 | timers (cdr timers))) | |
dbbee529 RS |
240 | (if reuse-cell |
241 | (progn | |
242 | (setcar reuse-cell timer) | |
243 | (setcdr reuse-cell timers)) | |
244 | (setq reuse-cell (cons timer timers))) | |
5e046f6d JB |
245 | ;; Insert new timer after last which possibly means in front of queue. |
246 | (if last | |
dbbee529 RS |
247 | (setcdr last reuse-cell) |
248 | (setq timer-idle-list reuse-cell)) | |
5e046f6d JB |
249 | (aset timer 0 (not dont-wait)) |
250 | (aset timer 7 t) | |
251 | nil) | |
252 | (error "Invalid or uninitialized timer"))) | |
253 | ||
254 | ;;;###autoload | |
255 | (defalias 'disable-timeout 'cancel-timer) | |
256 | ;;;###autoload | |
257 | (defun cancel-timer (timer) | |
258 | "Remove TIMER from the list of active timers." | |
259 | (or (timerp timer) | |
260 | (error "Invalid timer")) | |
261 | (setq timer-list (delq timer timer-list)) | |
262 | (setq timer-idle-list (delq timer timer-idle-list)) | |
263 | nil) | |
264 | ||
dbbee529 | 265 | (defun cancel-timer-internal (timer) |
b8bd37f2 RS |
266 | "Remove TIMER from the list of active timers or idle timers. |
267 | Only to be used in this file. It returns the cons cell | |
268 | that was removed from the timer list." | |
dbbee529 RS |
269 | (let ((cell1 (memq timer timer-list)) |
270 | (cell2 (memq timer timer-idle-list))) | |
271 | (if cell1 | |
272 | (setq timer-list (delq timer timer-list))) | |
273 | (if cell2 | |
274 | (setq timer-idle-list (delq timer timer-idle-list))) | |
275 | (or cell1 cell2))) | |
276 | ||
5e046f6d JB |
277 | ;;;###autoload |
278 | (defun cancel-function-timers (function) | |
b8bd37f2 RS |
279 | "Cancel all timers which would run FUNCTION. |
280 | This affects ordinary timers such as are scheduled by `run-at-time', | |
281 | and idle timers such as are scheduled by `run-with-idle-timer'." | |
5e046f6d JB |
282 | (interactive "aCancel timers of function: ") |
283 | (let ((tail timer-list)) | |
284 | (while tail | |
285 | (if (eq (aref (car tail) 5) function) | |
286 | (setq timer-list (delq (car tail) timer-list))) | |
287 | (setq tail (cdr tail)))) | |
288 | (let ((tail timer-idle-list)) | |
289 | (while tail | |
290 | (if (eq (aref (car tail) 5) function) | |
291 | (setq timer-idle-list (delq (car tail) timer-idle-list))) | |
292 | (setq tail (cdr tail))))) | |
293 | \f | |
294 | ;; Record the last few events, for debugging. | |
b8bd37f2 RS |
295 | (defvar timer-event-last nil |
296 | "Last timer that was run.") | |
297 | (defvar timer-event-last-1 nil | |
298 | "Next-to-last timer that was run.") | |
299 | (defvar timer-event-last-2 nil | |
300 | "Third-to-last timer that was run.") | |
5e046f6d JB |
301 | |
302 | (defvar timer-max-repeats 10 | |
e00c3f6f RS |
303 | "*Maximum number of times to repeat a timer, if many repeats are delayed. |
304 | Timer invocations can be delayed because Emacs is suspended or busy, | |
305 | or because the system's time changes. If such an occurrence makes it | |
306 | appear that many invocations are overdue, this variable controls | |
307 | how many will really happen.") | |
5e046f6d JB |
308 | |
309 | (defun timer-until (timer time) | |
310 | "Calculate number of seconds from when TIMER will run, until TIME. | |
311 | TIMER is a timer, and stands for the time when its next repeat is scheduled. | |
312 | TIME is a time-list." | |
313 | (let ((high (- (car time) (aref timer 1))) | |
314 | (low (- (nth 1 time) (aref timer 2)))) | |
315 | (+ low (* high 65536)))) | |
316 | ||
317 | (defun timer-event-handler (timer) | |
318 | "Call the handler for the timer TIMER. | |
319 | This function is called, by name, directly by the C code." | |
320 | (setq timer-event-last-2 timer-event-last-1) | |
321 | (setq timer-event-last-1 timer-event-last) | |
322 | (setq timer-event-last timer) | |
323 | (let ((inhibit-quit t)) | |
324 | (if (timerp timer) | |
dbbee529 RS |
325 | (let (retrigger cell) |
326 | ;; Delete from queue. Record the cons cell that was used. | |
327 | (setq cell (cancel-timer-internal timer)) | |
5e046f6d JB |
328 | ;; Re-schedule if requested. |
329 | (if (aref timer 4) | |
330 | (if (aref timer 7) | |
dbbee529 | 331 | (timer-activate-when-idle timer nil cell) |
5e046f6d JB |
332 | (timer-inc-time timer (aref timer 4) 0) |
333 | ;; If real time has jumped forward, | |
334 | ;; perhaps because Emacs was suspended for a long time, | |
335 | ;; limit how many times things get repeated. | |
336 | (if (and (numberp timer-max-repeats) | |
337 | (< 0 (timer-until timer (current-time)))) | |
338 | (let ((repeats (/ (timer-until timer (current-time)) | |
339 | (aref timer 4)))) | |
340 | (if (> repeats timer-max-repeats) | |
341 | (timer-inc-time timer (* (aref timer 4) repeats))))) | |
dbbee529 | 342 | (timer-activate timer t cell) |
6160f933 | 343 | (setq retrigger t))) |
5e046f6d JB |
344 | ;; Run handler. |
345 | ;; We do this after rescheduling so that the handler function | |
346 | ;; can cancel its own timer successfully with cancel-timer. | |
347 | (condition-case nil | |
348 | (apply (aref timer 5) (aref timer 6)) | |
6160f933 KS |
349 | (error nil)) |
350 | (if retrigger | |
8cb7feb8 | 351 | (aset timer 0 nil))) |
5e046f6d JB |
352 | (error "Bogus timer event")))) |
353 | ||
354 | ;; This function is incompatible with the one in levents.el. | |
355 | (defun timeout-event-p (event) | |
356 | "Non-nil if EVENT is a timeout event." | |
357 | (and (listp event) (eq (car event) 'timer-event))) | |
358 | \f | |
153ef845 | 359 | |
5cec3056 | 360 | (declare-function diary-entry-time "diary-lib" (s)) |
153ef845 | 361 | |
5e046f6d JB |
362 | ;;;###autoload |
363 | (defun run-at-time (time repeat function &rest args) | |
364 | "Perform an action at time TIME. | |
365 | Repeat the action every REPEAT seconds, if REPEAT is non-nil. | |
b9be25fd GM |
366 | TIME should be one of: a string giving an absolute time like |
367 | \"11:23pm\" (the acceptable formats are those recognized by | |
368 | `diary-entry-time'; note that such times are interpreted as times | |
369 | today, even if in the past); a string giving a relative time like | |
370 | \"2 hours 35 minutes\" (the acceptable formats are those | |
371 | recognized by `timer-duration'); nil meaning now; a number of | |
372 | seconds from now; a value from `encode-time'; or t (with non-nil | |
373 | REPEAT) meaning the next integral multiple of REPEAT. REPEAT may | |
374 | be an integer or floating point number. The action is to call | |
375 | FUNCTION with arguments ARGS. | |
5e046f6d JB |
376 | |
377 | This function returns a timer object which you can use in `cancel-timer'." | |
378 | (interactive "sRun at time: \nNRepeat interval: \naFunction: ") | |
379 | ||
380 | (or (null repeat) | |
381 | (and (numberp repeat) (< 0 repeat)) | |
382 | (error "Invalid repetition interval")) | |
383 | ||
384 | ;; Special case: nil means "now" and is useful when repeating. | |
385 | (if (null time) | |
386 | (setq time (current-time))) | |
387 | ||
388 | ;; Special case: t means the next integral multiple of REPEAT. | |
389 | (if (and (eq time t) repeat) | |
390 | (setq time (timer-next-integral-multiple-of-time (current-time) repeat))) | |
391 | ||
392 | ;; Handle numbers as relative times in seconds. | |
393 | (if (numberp time) | |
394 | (setq time (timer-relative-time (current-time) time))) | |
395 | ||
b9be25fd | 396 | ;; Handle relative times like "2 hours 35 minutes" |
5e046f6d JB |
397 | (if (stringp time) |
398 | (let ((secs (timer-duration time))) | |
399 | (if secs | |
400 | (setq time (timer-relative-time (current-time) secs))))) | |
401 | ||
402 | ;; Handle "11:23pm" and the like. Interpret it as meaning today | |
403 | ;; which admittedly is rather stupid if we have passed that time | |
404 | ;; already. (Though only Emacs hackers hack Emacs at that time.) | |
405 | (if (stringp time) | |
406 | (progn | |
407 | (require 'diary-lib) | |
408 | (let ((hhmm (diary-entry-time time)) | |
409 | (now (decode-time))) | |
410 | (if (>= hhmm 0) | |
411 | (setq time | |
412 | (encode-time 0 (% hhmm 100) (/ hhmm 100) (nth 3 now) | |
413 | (nth 4 now) (nth 5 now) (nth 8 now))))))) | |
414 | ||
415 | (or (consp time) | |
416 | (error "Invalid time format")) | |
417 | ||
418 | (let ((timer (timer-create))) | |
419 | (timer-set-time timer time repeat) | |
420 | (timer-set-function timer function args) | |
421 | (timer-activate timer) | |
422 | timer)) | |
423 | ||
424 | ;;;###autoload | |
425 | (defun run-with-timer (secs repeat function &rest args) | |
426 | "Perform an action after a delay of SECS seconds. | |
427 | Repeat the action every REPEAT seconds, if REPEAT is non-nil. | |
428 | SECS and REPEAT may be integers or floating point numbers. | |
429 | The action is to call FUNCTION with arguments ARGS. | |
430 | ||
431 | This function returns a timer object which you can use in `cancel-timer'." | |
432 | (interactive "sRun after delay (seconds): \nNRepeat interval: \naFunction: ") | |
433 | (apply 'run-at-time secs repeat function args)) | |
434 | ||
435 | ;;;###autoload | |
436 | (defun add-timeout (secs function object &optional repeat) | |
437 | "Add a timer to run SECS seconds from now, to call FUNCTION on OBJECT. | |
438 | If REPEAT is non-nil, repeat the timer every REPEAT seconds. | |
439 | This function is for compatibility; see also `run-with-timer'." | |
440 | (run-with-timer secs repeat function object)) | |
441 | ||
442 | ;;;###autoload | |
443 | (defun run-with-idle-timer (secs repeat function &rest args) | |
444 | "Perform an action the next time Emacs is idle for SECS seconds. | |
445 | The action is to call FUNCTION with arguments ARGS. | |
1063efe8 CY |
446 | SECS may be an integer, a floating point number, or the internal |
447 | time format (HIGH LOW USECS) returned by, e.g., `current-idle-time'. | |
171d328e RS |
448 | If Emacs is currently idle, and has been idle for N seconds (N < SECS), |
449 | then it will call FUNCTION in SECS - N seconds from now. | |
5e046f6d JB |
450 | |
451 | If REPEAT is non-nil, do the action each time Emacs has been idle for | |
452 | exactly SECS seconds (that is, only once for each time Emacs becomes idle). | |
453 | ||
454 | This function returns a timer object which you can use in `cancel-timer'." | |
455 | (interactive | |
456 | (list (read-from-minibuffer "Run after idle (seconds): " nil nil t) | |
457 | (y-or-n-p "Repeat each time Emacs is idle? ") | |
458 | (intern (completing-read "Function: " obarray 'fboundp t)))) | |
459 | (let ((timer (timer-create))) | |
460 | (timer-set-function timer function args) | |
461 | (timer-set-idle-time timer secs repeat) | |
171d328e | 462 | (timer-activate-when-idle timer t) |
5e046f6d JB |
463 | timer)) |
464 | \f | |
465 | (defun with-timeout-handler (tag) | |
b8bd37f2 | 466 | "This is the timer function used for the timer made by `with-timeout'." |
5e046f6d JB |
467 | (throw tag 'timeout)) |
468 | ||
469 | ;;;###autoload (put 'with-timeout 'lisp-indent-function 1) | |
470 | ||
89c020e8 RS |
471 | (defvar with-timeout-timers nil |
472 | "List of all timers used by currently pending `with-timeout' calls.") | |
473 | ||
5e046f6d JB |
474 | ;;;###autoload |
475 | (defmacro with-timeout (list &rest body) | |
476 | "Run BODY, but if it doesn't finish in SECONDS seconds, give up. | |
477 | If we give up, we run the TIMEOUT-FORMS and return the value of the last one. | |
5e046f6d | 478 | The timeout is checked whenever Emacs waits for some kind of external |
7452fadc | 479 | event (such as keyboard input, input from subprocesses, or a certain time); |
5e046f6d | 480 | if the program loops without waiting in any way, the timeout will not |
7452fadc JB |
481 | be detected. |
482 | \n(fn (SECONDS TIMEOUT-FORMS...) BODY)" | |
5e046f6d JB |
483 | (let ((seconds (car list)) |
484 | (timeout-forms (cdr list))) | |
485 | `(let ((with-timeout-tag (cons nil nil)) | |
89c020e8 RS |
486 | with-timeout-value with-timeout-timer |
487 | (with-timeout-timers with-timeout-timers)) | |
5e046f6d JB |
488 | (if (catch with-timeout-tag |
489 | (progn | |
490 | (setq with-timeout-timer | |
491 | (run-with-timer ,seconds nil | |
492 | 'with-timeout-handler | |
493 | with-timeout-tag)) | |
89c020e8 | 494 | (push with-timeout-timer with-timeout-timers) |
5e046f6d JB |
495 | (setq with-timeout-value (progn . ,body)) |
496 | nil)) | |
497 | (progn . ,timeout-forms) | |
498 | (cancel-timer with-timeout-timer) | |
499 | with-timeout-value)))) | |
500 | ||
89c020e8 RS |
501 | (defun with-timeout-suspend () |
502 | "Stop the clock for `with-timeout'. Used by debuggers. | |
503 | The idea is that the time you spend in the debugger should not | |
504 | count against these timeouts. | |
505 | ||
506 | The value is a list that the debugger can pass to `with-timeout-unsuspend' | |
507 | when it exits, to make these timers start counting again." | |
508 | (mapcar (lambda (timer) | |
509 | (cancel-timer timer) | |
510 | (list timer | |
511 | (time-subtract | |
512 | ;; The time that this timer will go off. | |
513 | (list (aref timer 1) (aref timer 2) (aref timer 3)) | |
514 | (current-time)))) | |
515 | with-timeout-timers)) | |
516 | ||
517 | (defun with-timeout-unsuspend (timer-spec-list) | |
518 | "Restart the clock for `with-timeout'. | |
519 | The argument should be a value previously returned by `with-timeout-suspend'." | |
520 | (dolist (elt timer-spec-list) | |
521 | (let ((timer (car elt)) | |
522 | (delay (cadr elt))) | |
523 | (timer-set-time timer (time-add (current-time) delay)) | |
524 | (timer-activate timer)))) | |
525 | ||
5e046f6d JB |
526 | (defun y-or-n-p-with-timeout (prompt seconds default-value) |
527 | "Like (y-or-n-p PROMPT), with a timeout. | |
528 | If the user does not answer after SECONDS seconds, return DEFAULT-VALUE." | |
529 | (with-timeout (seconds default-value) | |
530 | (y-or-n-p prompt))) | |
531 | \f | |
532 | (defvar timer-duration-words | |
533 | (list (cons "microsec" 0.000001) | |
534 | (cons "microsecond" 0.000001) | |
535 | (cons "millisec" 0.001) | |
536 | (cons "millisecond" 0.001) | |
537 | (cons "sec" 1) | |
538 | (cons "second" 1) | |
539 | (cons "min" 60) | |
540 | (cons "minute" 60) | |
541 | (cons "hour" (* 60 60)) | |
542 | (cons "day" (* 24 60 60)) | |
543 | (cons "week" (* 7 24 60 60)) | |
544 | (cons "fortnight" (* 14 24 60 60)) | |
545 | (cons "month" (* 30 24 60 60)) ; Approximation | |
546 | (cons "year" (* 365.25 24 60 60)) ; Approximation | |
547 | ) | |
548 | "Alist mapping temporal words to durations in seconds") | |
549 | ||
550 | (defun timer-duration (string) | |
551 | "Return number of seconds specified by STRING, or nil if parsing fails." | |
552 | (let ((secs 0) | |
553 | (start 0) | |
554 | (case-fold-search t)) | |
555 | (while (string-match | |
556 | "[ \t]*\\([0-9.]+\\)?[ \t]*\\([a-z]+[a-rt-z]\\)s?[ \t]*" | |
557 | string start) | |
558 | (let ((count (if (match-beginning 1) | |
559 | (string-to-number (match-string 1 string)) | |
560 | 1)) | |
561 | (itemsize (cdr (assoc (match-string 2 string) | |
562 | timer-duration-words)))) | |
563 | (if itemsize | |
564 | (setq start (match-end 0) | |
565 | secs (+ secs (* count itemsize))) | |
566 | (setq secs nil | |
567 | start (length string))))) | |
568 | (if (= start (length string)) | |
569 | secs | |
570 | (if (string-match "\\`[0-9.]+\\'" string) | |
571 | (string-to-number string))))) | |
572 | \f | |
573 | (provide 'timer) | |
574 | ||
ab5796a9 | 575 | ;;; arch-tag: b1a9237b-7787-4382-9e46-8f2c3b3273e0 |
5e046f6d | 576 | ;;; timer.el ends here |