1 ;;; timer.el --- run a function with args at some time in future.
3 ;; Copyright (C) 1996 Free Software Foundation, Inc.
7 ;; This file is part of GNU Emacs.
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)
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.
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.
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.
31 ;; Layout of a timer vector:
32 ;; [triggered-p high-seconds low-seconds usecs repeat-delay
33 ;; function args idle-delay]
35 (defun timer-create ()
36 "Create a timer object."
37 (let ((timer (make-vector 8 nil
)))
41 (defun timerp (object)
42 "Return t if OBJECT is a timer."
43 (and (vectorp object
) (= (length object
) 8)))
45 (defun timer-set-time (timer time
&optional delta
)
46 "Set the trigger time of TIMER to TIME.
47 TIME must be in the internal format returned by, e.g., `current-time'
48 If optional third argument DELTA is a non-zero integer make the timer
49 fire repeatedly that meny seconds apart."
51 (error "Invalid timer"))
52 (aset timer
1 (car time
))
53 (aset timer
2 (if (consp (cdr time
)) (car (cdr time
)) (cdr time
)))
54 (aset timer
3 (if (consp (cdr time
)) (nth 2 time
) 0))
55 (aset timer
4 (and (numberp delta
) (> delta
0) delta
))
58 (defun timer-relative-time (time secs
&optional usecs
)
59 "Advance TIME by SECS seconds and optionally USECS microseconds.
60 SECS may be a fraction."
61 (let ((high (car time
))
62 (low (if (consp (cdr time
)) (nth 1 time
) (cdr time
)))
63 (micro (if (numberp (car-safe (cdr-safe (cdr time
))))
67 (if usecs
(setq micro
(+ micro usecs
)))
69 (setq micro
(+ micro
(floor (* 1000000 (- secs
(floor secs
)))))))
70 (setq low
(+ low
(floor secs
)))
73 (setq low
(+ low
(/ micro
1000000)))
74 (setq micro
(mod micro
1000000))
75 (setq high
(+ high
(/ low
65536)))
76 (setq low
(logand low
65535))
78 (list high low
(and (/= micro
0) micro
))))
80 (defun timer-inc-time (timer secs
&optional usecs
)
81 "Increment the time set in TIMER by SECS seconds and USECS microseconds.
82 SECS may be a fraction."
83 (let ((time (timer-relative-time
84 (list (aref timer
1) (aref timer
2) (aref timer
3))
87 (aset timer
1 (nth 0 time
))
88 (aset timer
2 (nth 1 time
))
89 (aset timer
3 (or (nth 2 time
) 0))))
91 (defun timer-set-time-with-usecs (timer time usecs
&optional delta
)
92 "Set the trigger time of TIMER to TIME.
93 TIME must be in the internal format returned by, e.g., `current-time'
94 If optional third argument DELTA is a non-zero integer make the timer
95 fire repeatedly that menu seconds apart."
97 (error "Invalid timer"))
98 (aset timer
1 (car time
))
99 (aset timer
2 (if (consp (cdr time
)) (car (cdr time
)) (cdr time
)))
101 (aset timer
4 (and (numberp delta
) (> delta
0) delta
))
104 (defun timer-set-function (timer function
&optional args
)
105 "Make TIMER call FUNCTION with optional ARGS when triggering."
107 (error "Invalid timer"))
108 (aset timer
5 function
)
112 (defun timer-activate (timer)
113 "Put TIMER on the list of active timers."
114 (if (and (timerp timer
)
115 (integerp (aref timer
1))
116 (integerp (aref timer
2))
117 (integerp (aref timer
3))
119 (let ((timers timer-list
)
121 ;; Skip all timers to trigger before the new one.
123 (or (> (aref timer
1) (aref (car timers
) 1))
124 (and (= (aref timer
1) (aref (car timers
) 1))
125 (> (aref timer
2) (aref (car timers
) 2)))
126 (and (= (aref timer
1) (aref (car timers
) 1))
127 (= (aref timer
2) (aref (car timers
) 2))
128 (> (aref timer
3) (aref (car timers
) 3)))))
130 timers
(cdr timers
)))
131 ;; Insert new timer after last which possibly means in front of queue.
133 (setcdr last
(cons timer timers
))
134 (setq timer-list
(cons timer timers
)))
138 (error "Invalid or uninitialized timer")))
140 (defun timer-activate-when-idle (timer)
141 "Arrange to activate TIMER whenever Emacs is next idle."
142 (if (and (timerp timer
)
143 (integerp (aref timer
1))
144 (integerp (aref timer
2))
145 (integerp (aref timer
3))
147 (let ((timers timer-idle-list
)
149 ;; Skip all timers to trigger before the new one.
151 (or (> (aref timer
1) (aref (car timers
) 1))
152 (and (= (aref timer
1) (aref (car timers
) 1))
153 (> (aref timer
2) (aref (car timers
) 2)))
154 (and (= (aref timer
1) (aref (car timers
) 1))
155 (= (aref timer
2) (aref (car timers
) 2))
156 (> (aref timer
3) (aref (car timers
) 3)))))
158 timers
(cdr timers
)))
159 ;; Insert new timer after last which possibly means in front of queue.
161 (setcdr last
(cons timer timers
))
162 (setq timer-idle-list
(cons timer timers
)))
166 (error "Invalid or uninitialized timer")))
168 (defalias 'disable-timeout
'cancel-timer
)
169 (defun cancel-timer (timer)
170 "Remove TIMER from the list of active timers."
172 (error "Invalid timer"))
173 (setq timer-list
(delq timer timer-list
))
174 (setq timer-idle-list
(delq timer timer-idle-list
))
177 (defun cancel-function-timers (function)
178 "Cancel all timers scheduled by `run-at-time' which would run FUNCTION."
179 (interactive "aCancel timers of function: ")
180 (let ((tail timer-list
))
182 (if (eq (aref (car tail
) 5) function
)
183 (setq timer-list
(delq (car tail
) timer-list
)))
184 (setq tail
(cdr tail
))))
185 (let ((tail timer-idle-list
))
187 (if (eq (aref (car tail
) 5) function
)
188 (setq timer-idle-list
(delq (car tail
) timer-idle-list
)))
189 (setq tail
(cdr tail
)))))
191 ;; Set up the common handler for all timer events. Since the event has
192 ;; the timer as parameter we can still distinguish. Note that using
193 ;; special-event-map ensures that event timer events that arrive in the
194 ;; middle of a key sequence being entered are still handled correctly.
195 (define-key special-event-map
[timer-event
] 'timer-event-handler
)
196 (defun timer-event-handler (event)
197 "Call the handler for the timer in the event EVENT."
199 (let ((timer (car-safe (cdr-safe event
))))
202 ;; Delete from queue.
205 (apply (aref timer
5) (aref timer
6))
206 ;; Re-schedule if requested.
209 (timer-activate-when-idle timer
)
210 (timer-inc-time timer
(aref timer
4) 0)
211 (timer-activate timer
))))
212 (error "Bogus timer event"))))
215 (defun run-at-time (time repeat function
&rest args
)
216 "Run a function at a time, and optionally on a regular interval.
217 Arguments are TIME, REPEAT, FUNCTION &rest ARGS.
218 TIME is a string like \"11:23pm\" or a value from `encode-time',
219 or a number of seconds from now.
220 REPEAT, an integer number of seconds, is the interval on which to repeat
221 the call to the function. If REPEAT is nil or 0, call it just once.
223 This function returns a timer object which you can use in `cancel-timer'."
224 (interactive "sRun at time: \nNRepeat interval: \naFunction: ")
226 ;; Special case: nil means "now" and is useful when repeting.
228 (setq time
(current-time)))
230 ;; Handle numbers as relative times in seconds.
232 (setq time
(timer-relative-time (current-time) time
)))
234 ;; Handle relative times like "2 hours and 35 minutes"
236 (let ((secs (timer-duration time
)))
238 (setq time
(timer-relative-time (current-time) secs
)))))
240 ;; Handle "11:23pm" and the like. Interpret it as meaning today
241 ;; which admittedly is rather stupid if we have passed that time
246 (let ((hhmm (diary-entry-time time
))
250 (encode-time 0 (% hhmm
100) (/ hhmm
100) (nth 3 now
)
251 (nth 4 now
) (nth 5 now
) (nth 8 now
)))))))
254 (error "Invalid time format"))
258 (error "Invalid repetition interval"))
260 (let ((timer (timer-create)))
261 (timer-set-time timer time repeat
)
262 (timer-set-function timer function args
)
263 (timer-activate timer
)
267 (defun run-with-timer (secs repeat function
&rest args
)
268 "Perform an action after a delay of SECS seconds.
269 Repeat the action every REPEAT seconds, if REPEAT is non-nil.
270 SECS and REPEAT may be integers or floating point numbers.
271 The action is to call FUNCTION with arguments ARGS.
273 This function returns a timer object which you can use in `cancel-timer'."
274 (interactive "sRun after delay (seconds): \nNRepeat interval: \naFunction: ")
277 (and (numberp repeat
) (>= repeat
0))
278 (error "Invalid repetition interval"))
280 (let ((timer (timer-create)))
281 (timer-set-time timer
(current-time) repeat
)
282 (timer-inc-time timer secs
)
283 (timer-set-function timer function args
)
284 (timer-activate timer
)
288 (defun run-with-idle-timer (secs repeat function
&rest args
)
289 "Perform an action the next time Emacs is idle for SECS seconds.
290 The action is to call FUNCTION with arguments ARGS.
291 If REPEAT is non-nil, do this each time Emacs is idle for SECS seconds.
292 SECS may be an integer or a floating point number.
294 This function returns a timer object which you can use in `cancel-timer'."
295 (interactive "sRun after delay (seconds): \nNRepeat interval: \naFunction: ")
297 (let ((timer (timer-create)))
298 (timer-set-function timer function args
)
299 ;; Store 0 into the time fields, then add in SECS.
303 (timer-inc-time timer secs
)
304 (aset timer
4 repeat
)
305 (timer-activate-when-idle timer
)
309 (defun add-timeout (secs function object
&optional repeat
)
310 "Add a timer to run SECS seconds from now, to call FUNCTION on OBJECT.
311 If REPEAT is non-nil, repeat the timer every REPEAT seconds.
312 This function is for compatibility; see also `run-with-timer'."
313 (run-with-timer secs repeat function object
))
315 (defun timeout-event-p (event)
316 "Non-nil if EVENT is a timeout event."
318 (eq (car event
) 'timer-event
)))
320 (defun with-timeout-handler (tag)
321 (throw tag
'timeout
))
323 ;;;###autoload (put 'with-timeout 'lisp-indent-function 1)
326 (defmacro with-timeout
(list &rest body
)
327 "Run BODY, but if it doesn't finish in SECONDS seconds, give up.
328 If we give up, we run the TIMEOUT-FORMS and return the value of the last one.
330 (with-timeout (SECONDS TIMEOUT-FORMS...) BODY...)
331 The timeout is checked whenever Emacs waits for some kind of external
332 event \(such as keyboard input, input from subprocesses, or a certain time);
333 if the program loops without waiting in any way, the timeout will not
335 (let ((seconds (car list
))
336 (timeout-forms (cdr list
)))
337 `(let ((with-timeout-tag (cons nil nil
))
338 with-timeout-value with-timeout-timer
)
339 (if (catch with-timeout-tag
341 (setq with-timeout-timer
342 (run-with-timer ,seconds nil
343 'with-timeout-handler
345 (setq with-timeout-value
(progn .
,body
))
347 (progn .
,timeout-forms
)
348 (cancel-timer with-timeout-timer
)
349 with-timeout-value
))))
351 (defun y-or-n-p-with-timeout (prompt seconds default-value
)
352 "Like (y-or-n-p PROMPT), with a timeout.
353 If the user does not answer after SECONDS seconds, return DEFAULT-VALUE."
354 (with-timeout (seconds default-value
)
357 (defvar timer-duration-words
358 (list (cons "microsec" 0.000001)
359 (cons "microsecond" 0.000001)
360 (cons "millisec" 0.001)
361 (cons "millisecond" 0.001)
366 (cons "hour" (* 60 60))
367 (cons "day" (* 24 60 60))
368 (cons "week" (* 7 24 60 60))
369 (cons "fortnight" (* 14 24 60 60))
370 (cons "month" (* 30 24 60 60)) ; Approximation
371 (cons "year" (* 365.25 24 60 60)) ; Approximation
373 "Alist mapping temporal words to durations in seconds")
375 (defun timer-duration (string)
376 "Return number of seconds specified by STRING, or nil if parsing fails."
379 (case-fold-search t
))
381 "[ \t]*\\([0-9.]+\\)?[ \t]*\\([a-z]+[a-rt-z]\\)s?[ \t]*"
383 (let ((count (if (match-beginning 1)
384 (string-to-number (match-string 1 string
))
386 (itemsize (cdr (assoc (match-string 2 string
)
387 timer-duration-words
))))
389 (setq start
(match-end 0)
390 secs
(+ secs
(* count itemsize
)))
392 start
(length string
)))))
397 ;;; timer.el ends here