Mercurial > emacs
annotate lisp/=timer.el @ 8588:518c4b07b0ea
Comment change.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Tue, 23 Aug 1994 07:09:07 +0000 |
parents | 6cc76dc79853 |
children | 284c46319091 |
rev | line source |
---|---|
657
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
1 ;;; timer.el --- run a function with args at some time in future |
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
2 |
7300 | 3 ;; Copyright (C) 1990, 1993, 1994 Free Software Foundation, Inc. |
840
113281b361ec
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
4 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
5 ;; Maintainer: FSF |
45 | 6 |
7 ;; This file is part of GNU Emacs. | |
8 | |
9 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
10 ;; it under the terms of the GNU General Public License as published by | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
11 ;; the Free Software Foundation; either version 2, or (at your option) |
45 | 12 ;; any later version. |
13 | |
14 ;; GNU Emacs is distributed in the hope that it will be useful, | |
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 ;; GNU General Public License for more details. | |
18 | |
19 ;; You should have received a copy of the GNU General Public License | |
20 ;; along with GNU Emacs; see the file COPYING. If not, write to | |
21 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
22 | |
2319
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2086
diff
changeset
|
23 ;;; Commentary: |
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2086
diff
changeset
|
24 |
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2086
diff
changeset
|
25 ;; This package gives you the capability to run Emacs Lisp commands at |
3591
507f64624555
Apply typo patches from Paul Eggert.
Jim Blandy <jimb@redhat.com>
parents:
3352
diff
changeset
|
26 ;; specified times in the future, either as one-shots or periodically. |
2319
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2086
diff
changeset
|
27 ;; The single entry point is `run-at-time'. |
d98c49df2acd
Added or corrected Commentary section
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
2086
diff
changeset
|
28 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
29 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
657
diff
changeset
|
30 |
2447
6ff9eee5cdc9
* timer.el (timer-program): New defconst.
Jim Blandy <jimb@redhat.com>
parents:
2319
diff
changeset
|
31 ;;; The name of the program to run as the timer subprocess. It should |
6ff9eee5cdc9
* timer.el (timer-program): New defconst.
Jim Blandy <jimb@redhat.com>
parents:
2319
diff
changeset
|
32 ;;; be in exec-directory. |
6ff9eee5cdc9
* timer.el (timer-program): New defconst.
Jim Blandy <jimb@redhat.com>
parents:
2319
diff
changeset
|
33 (defconst timer-program "timer") |
6ff9eee5cdc9
* timer.el (timer-program): New defconst.
Jim Blandy <jimb@redhat.com>
parents:
2319
diff
changeset
|
34 |
45 | 35 (defvar timer-process nil) |
36 (defvar timer-alist ()) | |
37 (defvar timer-out "") | |
38 (defvar timer-dont-exit nil | |
39 ;; this is useful for functions which will be doing their own erratic | |
40 ;; rescheduling or people who otherwise expect to use the process frequently | |
41 "If non-nil, don't exit the timer process when no more events are pending.") | |
42 | |
6693
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
43 ;; This should not be necessary, but on some systems, we get |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
44 ;; unkillable processes without this. |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
45 ;; It may be a kernel bug, but that's not certain. |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
46 (defun timer-kill-emacs-hook () |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
47 (if timer-process |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
48 (progn |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
49 (set-process-sentinel timer-process nil) |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
50 (set-process-filter timer-process nil) |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
51 (delete-process timer-process)))) |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
52 (add-hook 'kill-emacs-hook 'timer-kill-emacs-hook) |
3661fe3c03d7
(timer-kill-emacs-hook): New function.
Richard M. Stallman <rms@gnu.org>
parents:
3591
diff
changeset
|
53 |
584 | 54 ;;;###autoload |
45 | 55 (defun run-at-time (time repeat function &rest args) |
56 "Run a function at a time, and optionally on a regular interval. | |
57 Arguments are TIME, REPEAT, FUNCTION &rest ARGS. | |
2086
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
58 TIME, a string, can be specified absolutely or relative to now. |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
59 TIME can also be an integer, a number of seconds. |
45 | 60 REPEAT, an integer number of seconds, is the interval on which to repeat |
8044
6cc76dc79853
(run-at-time): If REPEAT is 0, don't repeat.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
61 the call to the function. If REPEAT is nil or 0, call it just once. |
1983
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
62 |
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
63 Absolute times may be specified in a wide variety of formats; |
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
64 Something of the form `HOUR:MIN:SEC TIMEZONE MONTH/DAY/YEAR', where |
2086
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
65 all fields are numbers, works; the format used by the Unix `date' |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
66 command works too. |
1983
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
67 |
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
68 Relative times may be specified as a series of numbers followed by units: |
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
69 1 min denotes one minute from now. |
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
70 min does too. |
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
71 1 min 5 sec denotes 65 seconds from now. |
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
72 1 min 2 sec 3 hour 4 day 5 week 6 fortnight 7 month 8 year |
f7da227e3e68
* timer.el (run-at-time): Doc fix.
Jim Blandy <jimb@redhat.com>
parents:
1753
diff
changeset
|
73 denotes the sum of all the given durations from now." |
45 | 74 (interactive "sRun at time: \nNRepeat interval: \naFunction: ") |
8044
6cc76dc79853
(run-at-time): If REPEAT is 0, don't repeat.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
75 (if (equal repeat 0) |
6cc76dc79853
(run-at-time): If REPEAT is 0, don't repeat.
Richard M. Stallman <rms@gnu.org>
parents:
7300
diff
changeset
|
76 (setq repeat nil)) |
2086
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
77 ;; Make TIME a string. |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
78 (if (integerp time) |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
79 (setq time (format "%d sec" time))) |
45 | 80 (cond ((or (not timer-process) |
81 (memq (process-status timer-process) '(exit signal nil))) | |
82 (if timer-process (delete-process timer-process)) | |
2447
6ff9eee5cdc9
* timer.el (timer-program): New defconst.
Jim Blandy <jimb@redhat.com>
parents:
2319
diff
changeset
|
83 (setq timer-process |
6ff9eee5cdc9
* timer.el (timer-program): New defconst.
Jim Blandy <jimb@redhat.com>
parents:
2319
diff
changeset
|
84 (let ((process-connection-type nil)) |
6ff9eee5cdc9
* timer.el (timer-program): New defconst.
Jim Blandy <jimb@redhat.com>
parents:
2319
diff
changeset
|
85 ;; Don't search the exec path for the timer program; |
6ff9eee5cdc9
* timer.el (timer-program): New defconst.
Jim Blandy <jimb@redhat.com>
parents:
2319
diff
changeset
|
86 ;; we know exactly which one we want. |
3352
03a02339361a
(run-at-time): Pass args to start-process in right order.
Richard M. Stallman <rms@gnu.org>
parents:
3267
diff
changeset
|
87 (start-process "timer" nil |
03a02339361a
(run-at-time): Pass args to start-process in right order.
Richard M. Stallman <rms@gnu.org>
parents:
3267
diff
changeset
|
88 (expand-file-name timer-program |
03a02339361a
(run-at-time): Pass args to start-process in right order.
Richard M. Stallman <rms@gnu.org>
parents:
3267
diff
changeset
|
89 exec-directory))) |
45 | 90 timer-alist nil) |
91 (set-process-filter timer-process 'timer-process-filter) | |
92 (set-process-sentinel timer-process 'timer-process-sentinel) | |
93 (process-kill-without-query timer-process)) | |
94 ((eq (process-status timer-process) 'stop) | |
95 (continue-process timer-process))) | |
96 ;; There should be a living, breathing timer process now | |
2086
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
97 (let* ((token (concat (current-time-string) "-" (length timer-alist))) |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
98 (elt (list token repeat function args))) |
1753
852bc0022185
Use process-send-string instead of send-string.
Michael I. Bushnell <mib@gnu.org>
parents:
1747
diff
changeset
|
99 (process-send-string timer-process (concat time "@" token "\n")) |
2086
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
100 (setq timer-alist (cons elt timer-alist)) |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
101 elt)) |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
102 |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
103 (defun cancel-timer (elt) |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
104 "Cancel a timer previously made with `run-at-time'. |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
105 The argument should be a value previously returned by `run-at-time'. |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
106 Cancelling the timer means that nothing special |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
107 will happen at the specified time." |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
108 (setcar (cdr elt) nil) |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
109 (setcar (cdr (cdr elt)) 'ignore)) |
45 | 110 |
111 (defun timer-process-filter (proc str) | |
112 (setq timer-out (concat timer-out str)) | |
113 (let (do token error) | |
114 (while (string-match "\n" timer-out) | |
115 (setq token (substring timer-out 0 (match-beginning 0)) | |
116 do (assoc token timer-alist) | |
117 timer-out (substring timer-out (match-end 0))) | |
118 (cond | |
2086
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
119 (do |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
120 (apply (nth 2 do) (nth 3 do)) ; do it |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
121 (if (natnump (nth 1 do)) ; reschedule it |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
122 (send-string proc (concat (nth 1 do) " sec@" (car do) "\n")) |
3daa7f080f2b
(run-at-time): Allow an integer as TIME.
Richard M. Stallman <rms@gnu.org>
parents:
1983
diff
changeset
|
123 (setq timer-alist (delq do timer-alist)))) |
998 | 124 ((string-match "timer: \\([^:]+\\): \\([^@]*\\)@\\(.*\\)$" token) |
45 | 125 (setq error (substring token (match-beginning 1) (match-end 1)) |
126 do (substring token (match-beginning 2) (match-end 2)) | |
127 token (assoc (substring token (match-beginning 3) (match-end 3)) | |
128 timer-alist) | |
129 timer-alist (delq token timer-alist)) | |
130 (ding 'no-terminate) ; using error function in process filters is rude | |
131 (message "%s for %s; couldn't set at \"%s\"" error (nth 2 token) do)))) | |
132 (or timer-alist timer-dont-exit (process-send-eof proc)))) | |
133 | |
134 (defun timer-process-sentinel (proc str) | |
135 (let ((stat (process-status proc))) | |
136 (if (eq stat 'stop) (continue-process proc) | |
137 ;; if it exited normally, presumably it was intentional. | |
138 ;; if there were no pending events, who cares that it exited? | |
139 (if (or (not timer-alist) (eq stat 'exit)) () | |
140 (ding 'no-terminate) | |
141 (message "Timer exited abnormally. All events cancelled.")) | |
1241
de92360b091b
(timer-process-sentinel): Don't set timer-scratch.
Richard M. Stallman <rms@gnu.org>
parents:
1223
diff
changeset
|
142 ;; Used to set timer-scratch to "", but nothing uses that var. |
de92360b091b
(timer-process-sentinel): Don't set timer-scratch.
Richard M. Stallman <rms@gnu.org>
parents:
1223
diff
changeset
|
143 (setq timer-process nil timer-alist nil)))) |
45 | 144 |
3267
ac18ead9965d
(cancel-function-timers): Renamed from spurious duplicate
Richard M. Stallman <rms@gnu.org>
parents:
2447
diff
changeset
|
145 (defun cancel-function-timers (function) |
1577 | 146 "Cancel all events scheduled by `run-at-time' which would run FUNCTION." |
3267
ac18ead9965d
(cancel-function-timers): Renamed from spurious duplicate
Richard M. Stallman <rms@gnu.org>
parents:
2447
diff
changeset
|
147 (interactive "aCancel timers of function: ") |
45 | 148 (let ((alist timer-alist)) |
149 (while alist | |
150 (if (eq (nth 2 (car alist)) function) | |
151 (setq timer-alist (delq (car alist) timer-alist))) | |
152 (setq alist (cdr alist)))) | |
153 (or timer-alist timer-dont-exit (process-send-eof timer-process))) | |
154 | |
155 (provide 'timer) | |
657
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
156 |
fec3f9a1e3e5
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
157 ;;; timer.el ends here |