annotate lisp/timer.el @ 14961:2c7b32c3c6aa libc-960409 libc-960410 libc-960411 libc-960412

Add Solaris on PowerPC support
author Michael Meissner <gnu@the-meissners.org>
date Mon, 08 Apr 1996 20:19:10 +0000
parents e4f4dc22f5a3
children 740cd456b1da
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 ;;; timer.el --- run a function with args at some time in future.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3 ;; Copyright (C) 1996 Free Software Foundation, Inc.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 ;; Maintainer: FSF
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 ;; This file is part of GNU Emacs.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 ;; it under the terms of the GNU General Public License as published by
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; the Free Software Foundation; either version 2, or (at your option)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 ;; any later version.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; GNU Emacs is distributed in the hope that it will be useful,
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 ;; GNU General Public License for more details.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; You should have received a copy of the GNU General Public License
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 ;; Boston, MA 02111-1307, USA.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 ;;; Commentary:
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 ;; This package gives you the capability to run Emacs Lisp commands at
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 ;; specified times in the future, either as one-shots or periodically.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 ;;; Code:
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 (defun timer-create ()
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38 (aset timer 0 t)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 timer))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 (defun timerp (object)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 (defun timer-set-time (timer time &optional delta)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50 (or (timerp timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
51 (error "Invalid timer"))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
52 (aset timer 1 (car time))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 (aset timer 4 (and (numberp delta) (> delta 0) delta))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58 timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
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
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 (defun timer-relative-time (time secs &optional usecs)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 "Advance TIME by SECS seconds and optionally USECS microseconds.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 SECS may be a fraction."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 (let ((high (car time))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 (low (if (consp (cdr time)) (nth 1 time) (cdr time)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78 (micro (if (numberp (car-safe (cdr-safe (cdr time))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 (nth 2 time)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 0)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 ;; Add
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 (if usecs (setq micro (+ micro usecs)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 (if (floatp secs)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 (setq micro (+ micro (floor (* 1000000 (- secs (floor secs)))))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 (setq low (+ low (floor secs)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 ;; Normalize
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 (setq low (+ low (/ micro 1000000)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89 (setq micro (mod micro 1000000))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 (setq high (+ high (/ low 65536)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91 (setq low (logand low 65535))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93 (list high low (and (/= micro 0) micro))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 (defun timer-inc-time (timer secs &optional usecs)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 "Increment the time set in TIMER by SECS seconds and USECS microseconds.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 SECS may be a fraction."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 (let ((time (timer-relative-time
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 (list (aref timer 1) (aref timer 2) (aref timer 3))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 secs
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 usecs)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 (aset timer 1 (nth 0 time))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 (aset timer 2 (nth 1 time))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 (aset timer 3 (or (nth 2 time) 0))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 (defun timer-set-time-with-usecs (timer time usecs &optional delta)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 "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
108 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
109 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
110 fire repeatedly that many seconds apart."
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111 (or (timerp timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 (error "Invalid timer"))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 (aset timer 1 (car time))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 (aset timer 2 (if (consp (cdr time)) (car (cdr time)) (cdr time)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 (aset timer 3 usecs)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116 (aset timer 4 (and (numberp delta) (> delta 0) delta))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 (defun timer-set-function (timer function &optional args)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 "Make TIMER call FUNCTION with optional ARGS when triggering."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 (or (timerp timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 (error "Invalid timer"))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 (aset timer 5 function)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 (aset timer 6 args)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 (defun timer-activate (timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 "Put TIMER on the list of active timers."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 (if (and (timerp timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130 (integerp (aref timer 1))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
131 (integerp (aref timer 2))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
132 (integerp (aref timer 3))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 (aref timer 5))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134 (let ((timers timer-list)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 last)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 ;; Skip all timers to trigger before the new one.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 (while (and timers
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 (or (> (aref timer 1) (aref (car timers) 1))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 (and (= (aref timer 1) (aref (car timers) 1))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 (> (aref timer 2) (aref (car timers) 2)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141 (and (= (aref timer 1) (aref (car timers) 1))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 (= (aref timer 2) (aref (car timers) 2))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 (> (aref timer 3) (aref (car timers) 3)))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 (setq last timers
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 timers (cdr timers)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146 ;; Insert new timer after last which possibly means in front of queue.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
147 (if last
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
148 (setcdr last (cons timer timers))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
149 (setq timer-list (cons timer timers)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
150 (aset timer 0 nil)
14632
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
151 (aset timer 7 nil)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
152 nil)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
153 (error "Invalid or uninitialized timer")))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
154
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
155 (defun timer-activate-when-idle (timer)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
156 "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
157 (if (and (timerp timer)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
158 (integerp (aref timer 1))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
159 (integerp (aref timer 2))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
160 (integerp (aref timer 3))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
161 (aref timer 5))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
162 (let ((timers timer-idle-list)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
163 last)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
164 ;; 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
165 (while (and timers
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
166 (or (> (aref timer 1) (aref (car timers) 1))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
167 (and (= (aref timer 1) (aref (car timers) 1))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
168 (> (aref timer 2) (aref (car timers) 2)))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
169 (and (= (aref timer 1) (aref (car timers) 1))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
170 (= (aref timer 2) (aref (car timers) 2))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
171 (> (aref timer 3) (aref (car timers) 3)))))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
172 (setq last timers
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
173 timers (cdr timers)))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
174 ;; 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
175 (if last
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
176 (setcdr last (cons timer timers))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
177 (setq timer-idle-list (cons timer timers)))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
178 (aset timer 0 t)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
179 (aset timer 7 t)
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
180 nil)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
181 (error "Invalid or uninitialized timer")))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
182
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
183 (defalias 'disable-timeout 'cancel-timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
184 (defun cancel-timer (timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
185 "Remove TIMER from the list of active timers."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
186 (or (timerp timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
187 (error "Invalid timer"))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
188 (setq timer-list (delq timer timer-list))
14632
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
189 (setq timer-idle-list (delq timer timer-idle-list))
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
190 nil)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192 (defun cancel-function-timers (function)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 "Cancel all timers scheduled by `run-at-time' which would run FUNCTION."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194 (interactive "aCancel timers of function: ")
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 (let ((tail timer-list))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 (while tail
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 (if (eq (aref (car tail) 5) function)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198 (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
199 (setq tail (cdr tail))))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
200 (let ((tail timer-idle-list))
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
201 (while tail
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
202 (if (eq (aref (car tail) 5) function)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
203 (setq timer-idle-list (delq (car tail) timer-idle-list)))
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 (setq tail (cdr tail)))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 ;; Set up the common handler for all timer events. Since the event has
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 ;; the timer as parameter we can still distinguish. Note that using
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
208 ;; special-event-map ensures that event timer events that arrive in the
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209 ;; middle of a key sequence being entered are still handled correctly.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210 (define-key special-event-map [timer-event] 'timer-event-handler)
14705
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
211
14885
38e792454ee3 (timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents: 14870
diff changeset
212 ;; Record the last few events, for debugging.
38e792454ee3 (timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents: 14870
diff changeset
213 (defvar timer-event-last-2 nil)
38e792454ee3 (timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents: 14870
diff changeset
214 (defvar timer-event-last-1 nil)
38e792454ee3 (timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents: 14870
diff changeset
215 (defvar timer-event-last nil)
38e792454ee3 (timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents: 14870
diff changeset
216
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217 (defun timer-event-handler (event)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 "Call the handler for the timer in the event EVENT."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 (interactive "e")
14885
38e792454ee3 (timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents: 14870
diff changeset
220 (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
221 (setq timer-event-last-1 timer-event-last)
14923
20c5d04f8013 (timer-event-handler): Save copies of events too.
Richard M. Stallman <rms@gnu.org>
parents: 14885
diff changeset
222 (setq timer-event-last (cons event (copy-sequence event)))
14885
38e792454ee3 (timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents: 14870
diff changeset
223 (let ((inhibit-quit t)
38e792454ee3 (timer-event-handler): Inhibit quitting.
Richard M. Stallman <rms@gnu.org>
parents: 14870
diff changeset
224 (timer (car-safe (cdr-safe event))))
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 (if (timerp timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 (progn
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227 ;; Delete from queue.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
228 (cancel-timer timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
229 ;; Run handler
14870
c51cef393dae (timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents: 14705
diff changeset
230 (condition-case nil
c51cef393dae (timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents: 14705
diff changeset
231 (apply (aref timer 5) (aref timer 6))
c51cef393dae (timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents: 14705
diff changeset
232 (error nil))
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233 ;; Re-schedule if requested.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 (if (aref timer 4)
14632
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
235 (if (aref timer 7)
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
236 (timer-activate-when-idle timer)
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237 (timer-inc-time timer (aref timer 4) 0)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 (timer-activate timer))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239 (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
240
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
241 ;; 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
242 (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
243 "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
244 (and (listp event) (eq (car event) 'timer-event)))
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
245
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246 ;;;###autoload
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247 (defun run-at-time (time repeat function &rest args)
14705
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
248 "Perform an action after a delay of SECS seconds.
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
249 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
250 TIME should be a string like \"11:23pm\", nil meaning now, a number of seconds
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
251 from now, or a value from `encode-time'.
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
252 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
253 The action is to call FUNCTION with arguments ARGS.
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
254
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
255 This function returns a timer object which you can use in `cancel-timer'."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
256 (interactive "sRun at time: \nNRepeat interval: \naFunction: ")
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
257
14686
6edb5012f490 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 14632
diff changeset
258 ;; Special case: nil means "now" and is useful when repeating.
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 (if (null time)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
260 (setq time (current-time)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261
14508
87b0d4b7577a (run-at-time): Handle numbers as relative times in seconds, as the original
Roland McGrath <roland@gnu.org>
parents: 14470
diff changeset
262 ;; 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
263 (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
264 (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
265
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266 ;; Handle relative times like "2 hours and 35 minutes"
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 (if (stringp time)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268 (let ((secs (timer-duration time)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
269 (if secs
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
270 (setq time (timer-relative-time (current-time) secs)))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
271
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272 ;; Handle "11:23pm" and the like. Interpret it as meaning today
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273 ;; 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
274 ;; already. (Though only Emacs hackers hack Emacs at that time.)
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
275 (if (stringp time)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276 (progn
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
277 (require 'diary-lib)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278 (let ((hhmm (diary-entry-time time))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279 (now (decode-time)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 (if (>= hhmm 0)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281 (setq time
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282 (encode-time 0 (% hhmm 100) (/ hhmm 100) (nth 3 now)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
283 (nth 4 now) (nth 5 now) (nth 8 now)))))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
284
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
285 (or (consp time)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286 (error "Invalid time format"))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
287
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
288 (or (null repeat)
14938
e4f4dc22f5a3 (run-at-time): Allow floating REPEAT values.
Richard M. Stallman <rms@gnu.org>
parents: 14923
diff changeset
289 (numberp repeat)
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 (error "Invalid repetition interval"))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
292 (let ((timer (timer-create)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
293 (timer-set-time timer time repeat)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
294 (timer-set-function timer function args)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
295 (timer-activate timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
296 timer))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
297
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
298 ;;;###autoload
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
299 (defun run-with-timer (secs repeat function &rest args)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
300 "Perform an action after a delay of SECS seconds.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301 Repeat the action every REPEAT seconds, if REPEAT is non-nil.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
302 SECS and REPEAT may be integers or floating point numbers.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
303 The action is to call FUNCTION with arguments ARGS.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
304
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
305 This function returns a timer object which you can use in `cancel-timer'."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
306 (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
307 (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
308
f50f87fae914 (run-with-idle-timer): New function.
Karl Heuer <kwzh@gnu.org>
parents: 14509
diff changeset
309 ;;;###autoload
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
310 (defun add-timeout (secs function object &optional repeat)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
311 "Add a timer to run SECS seconds from now, to call FUNCTION on OBJECT.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
312 If REPEAT is non-nil, repeat the timer every REPEAT seconds.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313 This function is for compatibility; see also `run-with-timer'."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314 (run-with-timer secs repeat function object))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
315
14705
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
316 ;;;###autoload
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
317 (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
318 "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
319 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
320 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
321 The action is to call FUNCTION with arguments ARGS.
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
322
14705
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
323 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
324 (interactive
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
325 (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
326 (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
327 (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
328 (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
329 (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
330 (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
331 (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
332 timer))
5e7b3fbecc8d (timer-set-time, timer-set-time-with-usecs): Doc fix.
Richard M. Stallman <rms@gnu.org>
parents: 14686
diff changeset
333
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
334 (defun with-timeout-handler (tag)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
335 (throw tag 'timeout))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
336
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
337 ;;;###autoload (put 'with-timeout 'lisp-indent-function 1)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
338
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339 ;;;###autoload
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
340 (defmacro with-timeout (list &rest body)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
341 "Run BODY, but if it doesn't finish in SECONDS seconds, give up.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
342 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
343 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
344 (with-timeout (SECONDS TIMEOUT-FORMS...) BODY...)
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
345 The timeout is checked whenever Emacs waits for some kind of external
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
346 event \(such as keyboard input, input from subprocesses, or a certain time);
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
347 if the program loops without waiting in any way, the timeout will not
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
348 be detected."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 (let ((seconds (car list))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350 (timeout-forms (cdr list)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351 `(let ((with-timeout-tag (cons nil nil))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352 with-timeout-value with-timeout-timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 (if (catch with-timeout-tag
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354 (progn
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355 (setq with-timeout-timer
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
356 (run-with-timer ,seconds nil
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
357 'with-timeout-handler
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
358 with-timeout-tag))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 (setq with-timeout-value (progn . ,body))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360 nil))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
361 (progn . ,timeout-forms)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362 (cancel-timer with-timeout-timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 with-timeout-value))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
364
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
365 (defun y-or-n-p-with-timeout (prompt seconds default-value)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
366 "Like (y-or-n-p PROMPT), with a timeout.
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
367 If the user does not answer after SECONDS seconds, return DEFAULT-VALUE."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
368 (with-timeout (seconds default-value)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
369 (y-or-n-p prompt)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
370
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371 (defvar timer-duration-words
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372 (list (cons "microsec" 0.000001)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373 (cons "microsecond" 0.000001)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374 (cons "millisec" 0.001)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
375 (cons "millisecond" 0.001)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 (cons "sec" 1)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377 (cons "second" 1)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378 (cons "min" 60)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 (cons "minute" 60)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380 (cons "hour" (* 60 60))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 (cons "day" (* 24 60 60))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 (cons "week" (* 7 24 60 60))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 (cons "fortnight" (* 14 24 60 60))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 (cons "month" (* 30 24 60 60)) ; Approximation
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385 (cons "year" (* 365.25 24 60 60)) ; Approximation
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386 )
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387 "Alist mapping temporal words to durations in seconds")
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
388
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
389 (defun timer-duration (string)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
390 "Return number of seconds specified by STRING, or nil if parsing fails."
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
391 (let ((secs 0)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
392 (start 0)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393 (case-fold-search t))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 (while (string-match
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
395 "[ \t]*\\([0-9.]+\\)?[ \t]*\\([a-z]+[a-rt-z]\\)s?[ \t]*"
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396 string start)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
397 (let ((count (if (match-beginning 1)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398 (string-to-number (match-string 1 string))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 1))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400 (itemsize (cdr (assoc (match-string 2 string)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 timer-duration-words))))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 (if itemsize
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 (setq start (match-end 0)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 secs (+ secs (* count itemsize)))
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 (setq secs nil
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 start (length string)))))
14870
c51cef393dae (timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents: 14705
diff changeset
407 (if (= start (length string))
c51cef393dae (timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents: 14705
diff changeset
408 secs
c51cef393dae (timer-set-time): Don't set usecs to nil.
Richard M. Stallman <rms@gnu.org>
parents: 14705
diff changeset
409 (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
410 (string-to-number string)))))
14449
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 (provide 'timer)
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413
ac2720f17eb7 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 ;;; timer.el ends here