timer.el 21.8 KB
Newer Older
Juanma Barranquero's avatar
Juanma Barranquero committed
1 2
;;; timer.el --- run a function with args at some time in future

3
;; Copyright (C) 1996, 2001-2014 Free Software Foundation, Inc.
Juanma Barranquero's avatar
Juanma Barranquero committed
4

5
;; Maintainer: emacs-devel@gnu.org
6
;; Package: emacs
Juanma Barranquero's avatar
Juanma Barranquero committed
7 8 9

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Juanma Barranquero's avatar
Juanma Barranquero committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Juanma Barranquero's avatar
Juanma Barranquero committed
14 15 16 17 18 19 20

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Juanma Barranquero's avatar
Juanma Barranquero committed
22 23 24 25 26 27 28 29

;;; Commentary:

;; This package gives you the capability to run Emacs Lisp commands at
;; specified times in the future, either as one-shots or periodically.

;;; Code:

30
(eval-when-compile (require 'cl-lib))
31

32
(cl-defstruct (timer
33 34 35 36 37 38 39
               (:constructor nil)
               (:copier nil)
               (:constructor timer-create ())
               (:type vector)
               (:conc-name timer--))
  ;; nil if the timer is active (waiting to be triggered),
  ;; non-nil if it is inactive ("already triggered", in theory).
40
  (triggered t)
41 42 43 44 45 46 47 48 49
  ;; Time of next trigger: for normal timers, absolute time, for idle timers,
  ;; time relative to idle-start.
  high-seconds low-seconds usecs
  ;; For normal timers, time between repetitions, or nil.  For idle timers,
  ;; non-nil iff repeated.
  repeat-delay
  function args                         ;What to do when triggered.
  idle-delay                            ;If non-nil, this is an idle-timer.
  psecs)
Juanma Barranquero's avatar
Juanma Barranquero committed
50 51 52

(defun timerp (object)
  "Return t if OBJECT is a timer."
53
  (and (vectorp object) (= (length object) 9)))
Juanma Barranquero's avatar
Juanma Barranquero committed
54

55 56 57
(defsubst timer--check (timer)
  (or (timerp timer) (signal 'wrong-type-argument (list #'timerp timer))))

58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
(defun timer--time-setter (timer time)
  (timer--check timer)
  (setf (timer--high-seconds timer) (pop time))
  (let ((low time) (usecs 0) (psecs 0))
    (when (consp time)
      (setq low (pop time))
      (when time
        (setq usecs (pop time))
        (when time
          (setq psecs (car time)))))
    (setf (timer--low-seconds timer) low)
    (setf (timer--usecs timer) usecs)
    (setf (timer--psecs timer) psecs)
    time))

73 74
;; Pseudo field `time'.
(defun timer--time (timer)
75
  (declare (gv-setter timer--time-setter))
76 77
  (list (timer--high-seconds timer)
        (timer--low-seconds timer)
78 79
	(timer--usecs timer)
	(timer--psecs timer)))
80

Juanma Barranquero's avatar
Juanma Barranquero committed
81 82 83 84 85
(defun timer-set-time (timer time &optional delta)
  "Set the trigger time of TIMER to TIME.
TIME must be in the internal format returned by, e.g., `current-time'.
If optional third argument DELTA is a positive number, make the timer
fire repeatedly that many seconds apart."
86 87
  (setf (timer--time timer) time)
  (setf (timer--repeat-delay timer) (and (numberp delta) (> delta 0) delta))
Juanma Barranquero's avatar
Juanma Barranquero committed
88 89 90
  timer)

(defun timer-set-idle-time (timer secs &optional repeat)
91
  ;; FIXME: Merge with timer-set-time.
Juanma Barranquero's avatar
Juanma Barranquero committed
92
  "Set the trigger idle time of TIMER to SECS.
93
SECS may be an integer, floating point number, or the internal
94
time format returned by, e.g., `current-idle-time'.
Juanma Barranquero's avatar
Juanma Barranquero committed
95 96
If optional third argument REPEAT is non-nil, make the timer
fire each time Emacs is idle for that many seconds."
97
  (setf (timer--time timer) (if (consp secs) secs (seconds-to-time secs)))
98
  (setf (timer--repeat-delay timer) repeat)
Juanma Barranquero's avatar
Juanma Barranquero committed
99 100 101 102 103 104
  timer)

(defun timer-next-integral-multiple-of-time (time secs)
  "Yield the next value after TIME that is an integral multiple of SECS.
More precisely, the next value, after TIME, that is an integral multiple
of SECS seconds since the epoch.  SECS may be a fraction."
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
  (let* ((trillion 1e12)
	 (time-sec (+ (nth 1 time)
		      (* 65536.0 (nth 0 time))))
	 (delta-sec (mod (- time-sec) secs))
	 (next-sec (+ time-sec (ffloor delta-sec)))
	 (next-sec-psec (ffloor (* trillion (mod delta-sec 1))))
	 (sub-time-psec (+ (or (nth 3 time) 0)
			   (* 1e6 (nth 2 time))))
	 (psec-diff (- sub-time-psec next-sec-psec)))
    (if (and (<= next-sec time-sec) (< 0 psec-diff))
	(setq next-sec-psec (+ sub-time-psec
			       (mod (- psec-diff) (* trillion secs)))))
    (setq next-sec (+ next-sec (floor next-sec-psec trillion)))
    (setq next-sec-psec (mod next-sec-psec trillion))
    (list (floor next-sec 65536)
	  (floor (mod next-sec 65536))
	  (floor next-sec-psec 1000000)
	  (floor (mod next-sec-psec 1000000)))))

(defun timer-relative-time (time secs &optional usecs psecs)
125
  "Advance TIME by SECS seconds and optionally USECS microseconds
126 127
and PSECS picoseconds.  SECS may be either an integer or a
floating point number."
128
  (let ((delta secs))
129 130
    (if (or usecs psecs)
	(setq delta (time-add delta (list 0 0 (or usecs 0) (or psecs 0)))))
131
    (time-add time delta)))
Juanma Barranquero's avatar
Juanma Barranquero committed
132

133 134
(defun timer--time-less-p (t1 t2)
  "Say whether time value T1 is less than time value T2."
135
  (time-less-p (timer--time t1) (timer--time t2)))
136

137
(defun timer-inc-time (timer secs &optional usecs psecs)
138
  "Increment the time set in TIMER by SECS seconds, USECS microseconds,
139 140
and PSECS picoseconds.  SECS may be a fraction.  If USECS or PSECS are
omitted, they are treated as zero."
141
  (setf (timer--time timer)
142
        (timer-relative-time (timer--time timer) secs usecs psecs)))
Juanma Barranquero's avatar
Juanma Barranquero committed
143 144 145 146 147 148 149

(defun timer-set-time-with-usecs (timer time usecs &optional delta)
  "Set the trigger time of TIMER to TIME plus USECS.
TIME must be in the internal format returned by, e.g., `current-time'.
The microsecond count from TIME is ignored, and USECS is used instead.
If optional fourth argument DELTA is a positive number, make the timer
fire repeatedly that many seconds apart."
150 151
  (declare (obsolete "use `timer-set-time' and `timer-inc-time' instead."
		     "22.1"))
152 153
  (setf (timer--time timer) time)
  (setf (timer--usecs timer) usecs)
154
  (setf (timer--psecs timer) 0)
155
  (setf (timer--repeat-delay timer) (and (numberp delta) (> delta 0) delta))
Juanma Barranquero's avatar
Juanma Barranquero committed
156 157 158 159
  timer)

(defun timer-set-function (timer function &optional args)
  "Make TIMER call FUNCTION with optional ARGS when triggering."
160
  (timer--check timer)
161 162
  (setf (timer--function timer) function)
  (setf (timer--args timer) args)
Juanma Barranquero's avatar
Juanma Barranquero committed
163 164
  timer)

165
(defun timer--activate (timer &optional triggered-p reuse-cell idle)
Juanma Barranquero's avatar
Juanma Barranquero committed
166
  (if (and (timerp timer)
167 168 169
	   (integerp (timer--high-seconds timer))
	   (integerp (timer--low-seconds timer))
	   (integerp (timer--usecs timer))
170
	   (integerp (timer--psecs timer))
171 172
	   (timer--function timer))
      (let ((timers (if idle timer-idle-list timer-list))
Juanma Barranquero's avatar
Juanma Barranquero committed
173 174
	    last)
	;; Skip all timers to trigger before the new one.
175
	(while (and timers (timer--time-less-p (car timers) timer))
Juanma Barranquero's avatar
Juanma Barranquero committed
176 177
	  (setq last timers
		timers (cdr timers)))
178 179 180 181 182
	(if reuse-cell
	    (progn
	      (setcar reuse-cell timer)
	      (setcdr reuse-cell timers))
	  (setq reuse-cell (cons timer timers)))
Juanma Barranquero's avatar
Juanma Barranquero committed
183
	;; Insert new timer after last which possibly means in front of queue.
184 185 186 187
        (setf (cond (last (cdr last))
                    (idle timer-idle-list)
                    (t    timer-list))
              reuse-cell)
188 189
	(setf (timer--triggered timer) triggered-p)
	(setf (timer--idle-delay timer) idle)
Juanma Barranquero's avatar
Juanma Barranquero committed
190 191 192
	nil)
    (error "Invalid or uninitialized timer")))

193 194 195 196
(defun timer-activate (timer &optional triggered-p reuse-cell)
  "Insert TIMER into `timer-list'.
If TRIGGERED-P is t, make TIMER inactive (put it on the list, but
mark it as already triggered).  To remove it, use `cancel-timer'.
197

198 199 200 201
REUSE-CELL, if non-nil, is a cons cell to reuse when inserting
TIMER into `timer-list' (usually a cell removed from that list by
`cancel-timer-internal'; using this reduces consing for repeat
timers).  If nil, allocate a new cell."
202 203
  (timer--activate timer triggered-p reuse-cell nil))

204
(defun timer-activate-when-idle (timer &optional dont-wait reuse-cell)
205 206 207
  "Insert TIMER into `timer-idle-list'.
This arranges to activate TIMER whenever Emacs is next idle.
If optional argument DONT-WAIT is non-nil, set TIMER to activate
Paul Eggert's avatar
Paul Eggert committed
208
immediately \(see below\), or at the right time, if Emacs is
209
already idle.
210 211 212 213

REUSE-CELL, if non-nil, is a cons cell to reuse when inserting
TIMER into `timer-idle-list' (usually a cell removed from that
list by `cancel-timer-internal'; using this reduces consing for
214 215 216 217 218 219 220
repeat timers).  If nil, allocate a new cell.

Using non-nil DONT-WAIT is not recommended when activating an
idle timer from an idle timer handler, if the timer being
activated has an idleness time that is smaller or equal to
the time of the current timer.  That's because the activated
timer will fire right away."
221
  (timer--activate timer (not dont-wait) reuse-cell 'idle))
Juanma Barranquero's avatar
Juanma Barranquero committed
222 223

(defalias 'disable-timeout 'cancel-timer)
224

Juanma Barranquero's avatar
Juanma Barranquero committed
225 226
(defun cancel-timer (timer)
  "Remove TIMER from the list of active timers."
227
  (timer--check timer)
Juanma Barranquero's avatar
Juanma Barranquero committed
228 229 230 231
  (setq timer-list (delq timer timer-list))
  (setq timer-idle-list (delq timer timer-idle-list))
  nil)

232
(defun cancel-timer-internal (timer)
233 234 235
  "Remove TIMER from the list of active timers or idle timers.
Only to be used in this file.  It returns the cons cell
that was removed from the timer list."
236 237 238 239 240 241 242 243
  (let ((cell1 (memq timer timer-list))
	(cell2 (memq timer timer-idle-list)))
    (if cell1
	(setq timer-list (delq timer timer-list)))
    (if cell2
	(setq timer-idle-list (delq timer timer-idle-list)))
    (or cell1 cell2)))

Juanma Barranquero's avatar
Juanma Barranquero committed
244
(defun cancel-function-timers (function)
245 246 247
  "Cancel all timers which would run FUNCTION.
This affects ordinary timers such as are scheduled by `run-at-time',
and idle timers such as are scheduled by `run-with-idle-timer'."
Juanma Barranquero's avatar
Juanma Barranquero committed
248
  (interactive "aCancel timers of function: ")
249 250 251 252 253 254
  (dolist (timer timer-list)
    (if (eq (timer--function timer) function)
        (setq timer-list (delq timer timer-list))))
  (dolist (timer timer-idle-list)
    (if (eq (timer--function timer) function)
        (setq timer-idle-list (delq timer timer-idle-list)))))
Juanma Barranquero's avatar
Juanma Barranquero committed
255 256

;; Record the last few events, for debugging.
257 258 259 260 261 262
(defvar timer-event-last nil
  "Last timer that was run.")
(defvar timer-event-last-1 nil
  "Next-to-last timer that was run.")
(defvar timer-event-last-2 nil
  "Third-to-last timer that was run.")
Juanma Barranquero's avatar
Juanma Barranquero committed
263

264
(defcustom timer-max-repeats 10
265
  "Maximum number of times to repeat a timer, if many repeats are delayed.
266 267 268
Timer invocations can be delayed because Emacs is suspended or busy,
or because the system's time changes.  If such an occurrence makes it
appear that many invocations are overdue, this variable controls
269 270 271
how many will really happen."
  :type 'integer
  :group 'internal)
Juanma Barranquero's avatar
Juanma Barranquero committed
272 273 274 275 276

(defun timer-until (timer time)
  "Calculate number of seconds from when TIMER will run, until TIME.
TIMER is a timer, and stands for the time when its next repeat is scheduled.
TIME is a time-list."
277
  (- (float-time time) (float-time (timer--time timer))))
Juanma Barranquero's avatar
Juanma Barranquero committed
278 279 280 281 282 283 284 285

(defun timer-event-handler (timer)
  "Call the handler for the timer TIMER.
This function is called, by name, directly by the C code."
  (setq timer-event-last-2 timer-event-last-1)
  (setq timer-event-last-1 timer-event-last)
  (setq timer-event-last timer)
  (let ((inhibit-quit t))
286 287 288 289 290
    (timer--check timer)
    (let ((retrigger nil)
          (cell
           ;; Delete from queue.  Record the cons cell that was used.
           (cancel-timer-internal timer)))
291 292 293 294 295 296 297
      ;; If `cell' is nil, it means the timer was already canceled, so we
      ;; shouldn't be running it at all.  This can happen for example with the
      ;; following scenario (bug#17392):
      ;; - we run timers, starting with A (and remembering the rest as (B C)).
      ;; - A runs and a does a sit-for.
      ;; - during sit-for we run timer D which cancels timer B.
      ;; - timer A finally finishes, so we move on to timers B and C.
298
      (when cell
299 300 301 302 303 304 305 306 307
        ;; Re-schedule if requested.
        (if (timer--repeat-delay timer)
            (if (timer--idle-delay timer)
                (timer-activate-when-idle timer nil cell)
              (timer-inc-time timer (timer--repeat-delay timer) 0)
              ;; If real time has jumped forward,
              ;; perhaps because Emacs was suspended for a long time,
              ;; limit how many times things get repeated.
              (if (and (numberp timer-max-repeats)
308 309
                       (< 0 (timer-until timer nil)))
                  (let ((repeats (/ (timer-until timer nil)
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
                                    (timer--repeat-delay timer))))
                    (if (> repeats timer-max-repeats)
                        (timer-inc-time timer (* (timer--repeat-delay timer)
                                                 repeats)))))
              ;; Place it back on the timer-list before running
              ;; timer--function, so it can cancel-timer itself.
              (timer-activate timer t cell)
              (setq retrigger t)))
        ;; Run handler.
        (condition-case-unless-debug err
            ;; Timer functions should not change the current buffer.
            ;; If they do, all kinds of nasty surprises can happen,
            ;; and it can be hellish to track down their source.
            (save-current-buffer
              (apply (timer--function timer) (timer--args timer)))
          (error (message "Error running timer%s: %S"
                          (if (symbolp (timer--function timer))
                              (format " `%s'" (timer--function timer)) "")
                          err)))
        (when (and retrigger
                   ;; If the timer's been canceled, don't "retrigger" it
                   ;; since it might still be in the copy of timer-list kept
                   ;; by keyboard.c:timer_check (bug#14156).
                   (memq timer timer-list))
          (setf (timer--triggered timer) nil))))))
Juanma Barranquero's avatar
Juanma Barranquero committed
335 336 337 338 339 340

;; This function is incompatible with the one in levents.el.
(defun timeout-event-p (event)
  "Non-nil if EVENT is a timeout event."
  (and (listp event) (eq (car event) 'timer-event)))

341

342
(declare-function diary-entry-time "diary-lib" (s))
343

Juanma Barranquero's avatar
Juanma Barranquero committed
344 345 346
(defun run-at-time (time repeat function &rest args)
  "Perform an action at time TIME.
Repeat the action every REPEAT seconds, if REPEAT is non-nil.
Glenn Morris's avatar
Glenn Morris committed
347 348 349 350 351 352 353 354 355 356
TIME should be one of: a string giving an absolute time like
\"11:23pm\" (the acceptable formats are those recognized by
`diary-entry-time'; note that such times are interpreted as times
today, even if in the past); a string giving a relative time like
\"2 hours 35 minutes\" (the acceptable formats are those
recognized by `timer-duration'); nil meaning now; a number of
seconds from now; a value from `encode-time'; or t (with non-nil
REPEAT) meaning the next integral multiple of REPEAT.  REPEAT may
be an integer or floating point number.  The action is to call
FUNCTION with arguments ARGS.
Juanma Barranquero's avatar
Juanma Barranquero committed
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374

This function returns a timer object which you can use in `cancel-timer'."
  (interactive "sRun at time: \nNRepeat interval: \naFunction: ")

  (or (null repeat)
      (and (numberp repeat) (< 0 repeat))
      (error "Invalid repetition interval"))

  ;; Special case: nil means "now" and is useful when repeating.
  (if (null time)
      (setq time (current-time)))

  ;; Special case: t means the next integral multiple of REPEAT.
  (if (and (eq time t) repeat)
      (setq time (timer-next-integral-multiple-of-time (current-time) repeat)))

  ;; Handle numbers as relative times in seconds.
  (if (numberp time)
375
      (setq time (timer-relative-time nil time)))
Juanma Barranquero's avatar
Juanma Barranquero committed
376

Glenn Morris's avatar
Glenn Morris committed
377
  ;; Handle relative times like "2 hours 35 minutes"
Juanma Barranquero's avatar
Juanma Barranquero committed
378 379 380
  (if (stringp time)
      (let ((secs (timer-duration time)))
	(if secs
381
	    (setq time (timer-relative-time nil secs)))))
Juanma Barranquero's avatar
Juanma Barranquero committed
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423

  ;; Handle "11:23pm" and the like.  Interpret it as meaning today
  ;; which admittedly is rather stupid if we have passed that time
  ;; already.  (Though only Emacs hackers hack Emacs at that time.)
  (if (stringp time)
      (progn
	(require 'diary-lib)
	(let ((hhmm (diary-entry-time time))
	      (now (decode-time)))
	  (if (>= hhmm 0)
	      (setq time
		    (encode-time 0 (% hhmm 100) (/ hhmm 100) (nth 3 now)
				 (nth 4 now) (nth 5 now) (nth 8 now)))))))

  (or (consp time)
      (error "Invalid time format"))

  (let ((timer (timer-create)))
    (timer-set-time timer time repeat)
    (timer-set-function timer function args)
    (timer-activate timer)
    timer))

(defun run-with-timer (secs repeat function &rest args)
  "Perform an action after a delay of SECS seconds.
Repeat the action every REPEAT seconds, if REPEAT is non-nil.
SECS and REPEAT may be integers or floating point numbers.
The action is to call FUNCTION with arguments ARGS.

This function returns a timer object which you can use in `cancel-timer'."
  (interactive "sRun after delay (seconds): \nNRepeat interval: \naFunction: ")
  (apply 'run-at-time secs repeat function args))

(defun add-timeout (secs function object &optional repeat)
  "Add a timer to run SECS seconds from now, to call FUNCTION on OBJECT.
If REPEAT is non-nil, repeat the timer every REPEAT seconds.
This function is for compatibility; see also `run-with-timer'."
  (run-with-timer secs repeat function object))

(defun run-with-idle-timer (secs repeat function &rest args)
  "Perform an action the next time Emacs is idle for SECS seconds.
The action is to call FUNCTION with arguments ARGS.
424
SECS may be an integer, a floating point number, or the internal
425
time format returned by, e.g., `current-idle-time'.
426
If Emacs is currently idle, and has been idle for N seconds (N < SECS),
427 428 429
then it will call FUNCTION in SECS - N seconds from now.  Using
SECS <= N is not recommended if this function is invoked from an idle
timer, because FUNCTION will then be called immediately.
Juanma Barranquero's avatar
Juanma Barranquero committed
430 431 432 433 434 435 436 437 438 439 440 441

If REPEAT is non-nil, do the action each time Emacs has been idle for
exactly SECS seconds (that is, only once for each time Emacs becomes idle).

This function returns a timer object which you can use in `cancel-timer'."
  (interactive
   (list (read-from-minibuffer "Run after idle (seconds): " nil nil t)
	 (y-or-n-p "Repeat each time Emacs is idle? ")
	 (intern (completing-read "Function: " obarray 'fboundp t))))
  (let ((timer (timer-create)))
    (timer-set-function timer function args)
    (timer-set-idle-time timer secs repeat)
442
    (timer-activate-when-idle timer t)
Juanma Barranquero's avatar
Juanma Barranquero committed
443 444
    timer))

445 446 447
(defvar with-timeout-timers nil
  "List of all timers used by currently pending `with-timeout' calls.")

Juanma Barranquero's avatar
Juanma Barranquero committed
448 449 450 451
(defmacro with-timeout (list &rest body)
  "Run BODY, but if it doesn't finish in SECONDS seconds, give up.
If we give up, we run the TIMEOUT-FORMS and return the value of the last one.
The timeout is checked whenever Emacs waits for some kind of external
452
event (such as keyboard input, input from subprocesses, or a certain time);
Juanma Barranquero's avatar
Juanma Barranquero committed
453
if the program loops without waiting in any way, the timeout will not
454 455
be detected.
\n(fn (SECONDS TIMEOUT-FORMS...) BODY)"
456
  (declare (indent 1) (debug ((form body) body)))
Juanma Barranquero's avatar
Juanma Barranquero committed
457
  (let ((seconds (car list))
458 459 460 461 462 463 464 465 466 467
	(timeout-forms (cdr list))
        (timeout (make-symbol "timeout")))
    `(let ((-with-timeout-value-
            (catch ',timeout
              (let* ((-with-timeout-timer-
                      (run-with-timer ,seconds nil
                                      (lambda () (throw ',timeout ',timeout))))
                     (with-timeout-timers
                         (cons -with-timeout-timer- with-timeout-timers)))
                (unwind-protect
468
                    (progn ,@body)
469 470 471 472 473 474 475 476
                  (cancel-timer -with-timeout-timer-))))))
       ;; It is tempting to avoid the `if' altogether and instead run
       ;; timeout-forms in the timer, just before throwing `timeout'.
       ;; But that would mean that timeout-forms are run in the deeper
       ;; dynamic context of the timer, with inhibit-quit set etc...
       (if (eq -with-timeout-value- ',timeout)
           (progn ,@timeout-forms)
         -with-timeout-value-))))
Juanma Barranquero's avatar
Juanma Barranquero committed
477

478 479 480 481 482 483 484 485 486
(defun with-timeout-suspend ()
  "Stop the clock for `with-timeout'.  Used by debuggers.
The idea is that the time you spend in the debugger should not
count against these timeouts.

The value is a list that the debugger can pass to `with-timeout-unsuspend'
when it exits, to make these timers start counting again."
  (mapcar (lambda (timer)
	    (cancel-timer timer)
487
	    (list timer (time-subtract (timer--time timer) nil)))
488 489 490 491 492 493 494 495
	  with-timeout-timers))

(defun with-timeout-unsuspend (timer-spec-list)
  "Restart the clock for `with-timeout'.
The argument should be a value previously returned by `with-timeout-suspend'."
  (dolist (elt timer-spec-list)
    (let ((timer (car elt))
	  (delay (cadr elt)))
496
      (timer-set-time timer (time-add nil delay))
497 498
      (timer-activate timer))))

Juanma Barranquero's avatar
Juanma Barranquero committed
499 500 501 502 503 504
(defun y-or-n-p-with-timeout (prompt seconds default-value)
  "Like (y-or-n-p PROMPT), with a timeout.
If the user does not answer after SECONDS seconds, return DEFAULT-VALUE."
  (with-timeout (seconds default-value)
    (y-or-n-p prompt)))

505
(defconst timer-duration-words
Juanma Barranquero's avatar
Juanma Barranquero committed
506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
  (list (cons "microsec" 0.000001)
	(cons "microsecond" 0.000001)
        (cons "millisec" 0.001)
	(cons "millisecond" 0.001)
        (cons "sec" 1)
	(cons "second" 1)
	(cons "min" 60)
	(cons "minute" 60)
	(cons "hour" (* 60 60))
	(cons "day" (* 24 60 60))
	(cons "week" (* 7 24 60 60))
	(cons "fortnight" (* 14 24 60 60))
	(cons "month" (* 30 24 60 60))	  ; Approximation
	(cons "year" (* 365.25 24 60 60)) ; Approximation
	)
521
  "Alist mapping temporal words to durations in seconds.")
Juanma Barranquero's avatar
Juanma Barranquero committed
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542

(defun timer-duration (string)
  "Return number of seconds specified by STRING, or nil if parsing fails."
  (let ((secs 0)
	(start 0)
	(case-fold-search t))
    (while (string-match
	    "[ \t]*\\([0-9.]+\\)?[ \t]*\\([a-z]+[a-rt-z]\\)s?[ \t]*"
	    string start)
      (let ((count (if (match-beginning 1)
		       (string-to-number (match-string 1 string))
		     1))
	    (itemsize (cdr (assoc (match-string 2 string)
				  timer-duration-words))))
	(if itemsize
	    (setq start (match-end 0)
		  secs (+ secs (* count itemsize)))
	  (setq secs nil
		start (length string)))))
    (if (= start (length string))
	secs
543
      (if (string-match-p "\\`[0-9.]+\\'" string)
Juanma Barranquero's avatar
Juanma Barranquero committed
544
	  (string-to-number string)))))
545 546 547 548 549 550

(defun internal-timer-start-idle ()
  "Mark all idle-time timers as once again candidates for running."
  (dolist (timer timer-idle-list)
    (if (timerp timer) ;; FIXME: Why test?
        (setf (timer--triggered timer) nil))))
Juanma Barranquero's avatar
Juanma Barranquero committed
551 552 553 554

(provide 'timer)

;;; timer.el ends here