xemacs-beta: lisp/prim/itimer.el comparison

comparison lisp/prim/itimer.el @ 100:4be1180a9e89 r20-1b2

Import from CVS: tag r20-1b2

author	cvs
date	Mon, 13 Aug 2007 09:15:11 +0200
parents	131b0175ea99
children	a145efe76779

comparison

equal deleted inserted replaced

-:2d83cbd90d8d
+:4be1180a9e89
-;;; Interval timers for XEmacs
+;;; itimer.el -- Interval timers for XEmacs
-;;; Copyright (C) 1988, 1991, 1993 Kyle E. Jones
-;;; Modified 5 Feb 91 by Jamie Zawinski <jwz@lucid.com> for Lucid Emacs
+;; Copyright (C) 1988, 1991, 1993, 1997 Kyle E. Jones
-;;; And again, 15 Dec 93.
-;;;
+;; Author: Kyle Jones <kyle_jones@wonderworks.com>
-;; This file is part of XEmacs.
+;; Keywords: extensions
+;; This file is part of XEmacs
 ;; XEmacs is free software; you can redistribute it and/or modify it
 ;; under the terms of the GNU General Public License as published by
 ;; the Free Software Foundation; either version 2, or (at your option)
 ;; any later version.
 ;; XEmacs 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
+;; A copy of the GNU General Public License can be obtained from this
-;; along with XEmacs; see the file COPYING.  If not, write to the
+;; program's author (send electronic mail to kyle@uunet.uu.net) or
-;; Free Software Foundation, 59 Temple Place - Suite 330,
+;; from the Free Software Foundation, Inc., 59 Temple Place - Suite
-;; Boston, MA 02111-1307, USA.
+;; 330, Boston, MA  02111-1307, USA.
-;;; Synched up with: Not in FSF.
+;;; Synched up with:  Not in FSF
-;;;
+;;; Commentary:
-;;; Send bug reports to kyle@uunet.uu.net.
+;; Send bug reports to kyle_jones@wonderworks.com
-;; The original v18 version of this file worked by having an external program
-;; wake up once a second to generate an interrupt for emacs; then an emacs
+;;; Code:
-;; process filter was used to schedule timers.
-;;
+(provide 'itimer)
-;; This version works by associating with each timer a "timeout" object,
-;; since the XEmacs/Lucid Emacs event loop has the concept of timers built
+;; `itimer' feature means Emacs-Lisp programmers get:
-;; in to it.  There is no single scheduler function; instead, each timer
+;;    itimerp
-;; re-sets itself as it is invoked.
+;;    itimer-value
+;;    itimer-restart
-;; `itimer' feature means Emacs-Lisp programers get:
+;;    itimer-function
-;;    itimerp, itimer-value, itimer-restart, itimer-function,
+;;    itimer-function-argument
-;;    set-itimer-value, set-itimer-restart, set-itimer-function
+;;    set-itimer-value
-;;    get-itimer, start-itimer, read-itimer, delete-itimer
+;;    set-itimer-restart
+;;    set-itimer-function
+;;    set-itimer-uses-argument
+;;    set-itimer-function-argument
+;;    get-itimer
+;;    start-itimer
+;;    read-itimer
+;;    delete-itimer
 ;;
 ;; Interactive users get these commands:
-;;    edit-itimers, list-itimers, start-itimer
+;;    edit-itimers
+;;    list-itimers
+;;    start-itimer
 ;;
 ;; See the doc strings of these functions for more information.
-(defvar itimer-version "1.00"
+(defvar itimer-version "1.01"
 "Version number of the itimer package.")
 (defvar itimer-list nil
 "List of all active itimers.")
-;; not needed in XEmacs
+(defvar itimer-process nil
-;(defvar itimer-process nil
+"Process that drives all itimers, if a subprocess is being used.")
-;  "Process that drives all itimers.")
+(defvar itimer-timer nil
-;; This value is maintained internally; it does not determine itimer
+"Emacs internal timer that drives the itimer system, if a subprocess
-;; granularity.  Itimer granularity is 1 second, plus delays due to
+is not being used to drive the system.")
-;; system and Emacs internal activity that delay dealing with process
-;; output.
+(defvar itimer-timer-last-wakeup nil
-;; not needed in XEmacs
+"The time the timer driver function last ran.")
-;(defvar itimer-process-next-wakeup 1
-;  "Itimer process will wakeup to service running itimers within this
+(defvar itimer-short-interval (if (featurep 'lisp-float-type) 1e-3 1)
-;many seconds.")
+"Interval used for scheduling an event a very short time in the future.
+Used internally to make the scheduler wake up early.
+Unit is seconds.")
+;; This value is maintained internally; it does not determine
+;; itimer granularity.  Itimer granularity is 1 second if your
+;; Emacs doens't support floats or your system doesn't have a
+;; clock with microsecond granularity.  Otherwise granularity is
+;; to the microsend, although you can't possibly get timers to be
+;; executed with this kind of accuracy in practice.  There will
+;; be delays due to system and Emacs internal activity that delay
+;; dealing with syunchronous events and process output.
+(defvar itimer-next-wakeup itimer-short-interval
+"Itimer process will wakeup to service running itimers within this
+many seconds.")
 (defvar itimer-edit-map nil
 "Keymap used when in Itimer Edit mode.")
 (if itimer-edit-map
 (defvar itimer-edit-start-marker nil)
 ;; macros must come first... or byte-compile'd code will throw back its
 ;; head and scream.
-(defmacro itimer-decf (variable)
+(defmacro itimer-decrement (variable)
 (list 'setq variable (list '1- variable)))
-(defmacro itimer-incf (variable)
+(defmacro itimer-increment (variable)
 (list 'setq variable (list '1+ variable)))
 (defmacro itimer-signum (n)
 (list 'if (list '> n 0) 1
 (list 'if (list 'zerop n) 0 -1)))
 	      (list (list 'itimerp var) var)
 	      (list (list 'stringp var) (list 'get-itimer var))
 	      (list t (list 'signal ''wrong-type-argument
 			    (list 'list ''string-or-itimer-p var))))))
-(defmacro itimer-check-natnum (var)
+(defmacro check-nonnegative-number (var)
-"If VAR is not bound to a non-negative number, signal wrong-type-argument.
+"If VAR is not bound to a number, signal wrong-type-argument.
+If VAR is not bound to a positive number, signal args-out-of-range.
 This is a macro."
 (list 'setq var
-	(list 'if (list 'natnump var) var
+	(list 'if (list 'not (list 'numberp var))
 	      (list 'signal ''wrong-type-argument
-		    (list 'list ''natnump var)))))
+		    (list 'list ''natnump var))
+	      (list 'if (list '< var 0)
-(defmacro itimer-check-string (var)
+		    (list 'signal ''args-out-of-range (list 'list var))
+		    var))))
+(defmacro check-string (var)
 "If VAR is not bound to a string, signal wrong-type-argument.
 This is a macro."
 (list 'setq var
 	(list 'if (list 'stringp var) var
 	      (list 'signal ''wrong-type-argument
 ;; Functions to access and modify itimer attributes.
 (defun itimerp (obj)
 "Returns non-nil iff OBJ is an itimer."
-(and (consp obj) (stringp (car obj)) (eq (length obj)
+(and (consp obj) (stringp (car obj)) (eq (length obj) 6)))
-					   5 ; for XEmacs
-					   ;4 ; original version
-					   )))
 (defun itimer-name (itimer)
 "Returns the name of ITIMER."
 (check-itimer itimer)
 (car itimer))
 "Returns the function of ITIMER.
 This function is called each time ITIMER expires."
 (check-itimer itimer)
 (nth 3 itimer))
-;; XEmacs-specific
+(defun itimer-uses-argument (itimer)
-(defun itimer-id (itimer)
+"Returns non-nil if the function of ITIMER will be called with an argment.
-"Returns the timeout-id of ITIMER."
+ITIMER's function is called with this argument each timer ITIMER expires."
 (check-itimer itimer)
 (nth 4 itimer))
-(defun set-itimer-value (itimer value
+(defun itimer-function-argument (itimer)
-				;; XEmacs doesn't need this
+"Returns the function argument of ITIMER.
-				;; &optional nowakeup
+ITIMER's function is called with this argument each timer ITIMER expires."
-				)
+(check-itimer itimer)
+(nth 5 itimer))
+(defun set-itimer-value (itimer value)
 "Set the timeout value of ITIMER to be VALUE.
 Itimer will expire is this many seconds.
+If your version of Emacs supports floating point numbers then
+VALUE can be a floating point number.  Otherwise it
+must be an integer.
 Returns VALUE."
-;; Optional third arg NOWAKEUP non-nil means do not wakeup the itimer
+(check-itimer itimer)
-;; process to recompute a correct wakeup time, even if it means this
+(check-nonnegative-number value)
-;; itimer will expire late.  itimer-process-filter uses this option.
-;; This is not meant for ordinary usage, which is why it is not
-;; mentioned in the doc string.
-(check-itimer itimer)
-(itimer-check-natnum value)
 (let ((inhibit-quit t))
+;; If the itimer is in the active list, and under the new
-;    ;; If we're allowed to wakeup the itimer process,
+;; timeout value would expire before we would normally
-;    ;; and the itimer process's next wakeup needs to be recomputed,
+;; wakeup, wakeup now and recompute a new wakeup time.
-;    ;; and the itimer is running, then we wakeup the itimer process.
+(or (and (< value itimer-next-wakeup)
-;    (or (and (not nowakeup) (< value itimer-process-next-wakeup)
+	     (get-itimer (itimer-name itimer))
-;	     (get-itimer (itimer-name itimer))
+	     (progn (itimer-driver-wakeup)
-;	     (progn (itimer-process-wakeup)
+		    (setcar (cdr itimer) value)
-;		    (setcar (cdr itimer) value)
+		    (itimer-driver-wakeup)
-;		    (itimer-process-wakeup)))
+		    t ))
-;	(setcar (cdr itimer) value))
+	(setcar (cdr itimer) value))
-;; the XEmacs way:
-(if (itimer-id itimer)
-	(deactivate-itimer itimer))
-(setcar (cdr itimer) value)
-(activate-itimer itimer)
 value))
+;; Same as set-itimer-value but does not wakeup the driver.
+;; Only should be used by the drivers when processing expired timers.
+(defun set-itimer-value-internal (itimer value)
+(check-itimer itimer)
+(check-nonnegative-number value)
+(setcar (cdr itimer) value))
 (defun set-itimer-restart (itimer restart)
 "Set the restart value of ITIMER to be RESTART.
 If RESTART is nil, ITIMER will not restart when it expires.
+If your version of Emacs supports floating point numbers then
+RESTART can be a floating point number.  Otherwise it
+must be an integer.
 Returns RESTART."
 (check-itimer itimer)
-(if restart (itimer-check-natnum restart))
+(if restart (check-nonnegative-number restart))
-(and restart (< restart 1) (signal 'args-out-of-range (list restart)))
+(setcar (cdr (cdr itimer)) restart))
-;;  (setcar (cdr (cdr itimer)) restart)
-;; the XEmacs way
-(let ((was-active (itimer-id itimer))
-	(inhibit-quit t))
-(if was-active
-	(deactivate-itimer itimer))
-(setcar (cdr (cdr itimer)) restart)
-(if was-active
-	(progn
-	  (setcar (cdr itimer) restart)
-	  (if restart
-	      (activate-itimer itimer)))))
-restart)
 (defun set-itimer-function (itimer function)
 "Set the function of ITIMER to be FUNCTION.
 FUNCTION will be called when itimer expires.
 Returns FUNCTION."
 (check-itimer itimer)
 (setcar (cdr (cdr (cdr itimer))) function))
-;; XEmacs-specific
+(defun set-itimer-uses-argument (itimer flag)
-(defun set-itimer-id (itimer id)
+"Sets when the function of ITIMER is called with an argument.
-(check-itimer itimer)
+If FLAG is non-nil, then the function will be called with one argument,
-(setcar (cdr (cdr (cdr (cdr itimer)))) id))
+otherwise the function will be called with no arguments.
+Returns FLAG."
+(check-itimer itimer)
+(setcar (nthcdr 4 itimer) flag))
+(defun set-itimer-function-argument (itimer argument)
+"Set the function of ITIMER to be ARGUMENT.
+The function of ITIMER will be called with ARGUMENT as its solt argument
+when itimer expires.
+Returns ARGUMENT."
+(check-itimer itimer)
+(setcar (nthcdr 5 itimer) argument))
 (defun get-itimer (name)
 "Return itimer named NAME, or nil if there is none."
-(itimer-check-string name)
+(check-string name)
 (assoc name itimer-list))
 (defun read-itimer (prompt &optional initial-input)
 "Read the name of an itimer from the minibuffer and return the itimer
 associated with that name.  The user is prompted with PROMPT.
 (get-itimer (completing-read prompt itimer-list nil 'confirm initial-input)))
 (defun delete-itimer (itimer)
 "Deletes ITIMER.  ITIMER may be an itimer or the name of one."
 (check-itimer-coerce-string itimer)
-(deactivate-itimer itimer)  ;; for XEmacs
 (setq itimer-list (delq itimer itimer-list)))
-;jwz: this is preloaded so don't ;;;###autoload
+(defun start-itimer (name function value &optional restart
-(defun start-itimer (name function value &optional restart)
+		     with-arg function-argument)
 "Start an itimer.
-Args are NAME, FUNCTION, VALUE &optional RESTART.
+Args are NAME, FUNCTION, VALUE &optional RESTART, WITH-ARG, FUNCTION-ARGUMENT.
 NAME is an identifier for the itimer.  It must be a string.  If an itimer
 already exists with this name, NAME will be modified slightly to until
 it is unique.
-FUNCTION should be a function (or symbol naming one) of no arguments.  It
+FUNCTION should be a function (or symbol naming one) of one argument.  It
-will be called each time the itimer expires.  The function can access
+will be called each time the itimer expires with an argument of
-itimer that invoked it through the variable `current-itimer'.
+FUNCTION-ARGUMENT.  The function can access the itimer that
+invoked it through the variable `current-itimer'.  If WITH-ARG
+is nil then FUNCTION is called with no arguments.  This is for
+backward compatibility with older versions of the itimer
+package which always called FUNCTION with no arguments.
 VALUE is the number of seconds until this itimer expires.
+If your version of Emacs supports floating point numbers then
+you can VALUE can be a floating point number.  Otherwise it
+must be an integer.
 Optional fourth arg RESTART non-nil means that this itimer should be
 restarted automatically after its function is called.  Normally an itimer
 is deleted at expiration after its function has returned.
 If non-nil RESTART should be a number indicating the value at which the
 itimer should be set at restart time.
 Returns the newly created itimer."
 (interactive
 (list (completing-read "Start itimer: " itimer-list)
 	 (read (completing-read "Itimer function: " obarray 'fboundp))
 	 (let (value)
-	   (while (not (natnump value))
+	   (while (or (not (numberp value)) (< value 0))
 	     (setq value (read-from-minibuffer "Itimer value: " nil nil t)))
 	   value)
 	 (let ((restart t))
-	   (while (and restart (not (natnump restart)))
+	   (while (and restart (or (not (numberp restart)) (< restart 0)))
-	     (setq restart (read-from-minibuffer "Itimer restart: " nil nil t)))
+	     (setq restart (read-from-minibuffer "Itimer restart: "
-	   restart)))
+						 nil nil t)))
-(itimer-check-string name)
+	   restart)
-(itimer-check-natnum value)
+	 ;; hard to imagine the user specifying these interactively
-(if restart (itimer-check-natnum restart))
+	 nil
+	 nil ))
+(check-string name)
+(check-nonnegative-number value)
+(if restart (check-nonnegative-number restart))
 ;; Make proposed itimer name unique if it's not already.
 (let ((oname name)
 	(num 2))
 (while (get-itimer name)
 (setq name (concat oname "<" num ">"))
-(itimer-incf num)))
+(itimer-increment num)))
-;  ;; If there's no itimer process, start one now.
+;; If there's no itimer process, start one now.
-;  ;; Otherwise wake up the itimer process so that seconds slept before
+;; Otherwise wake up the itimer process so that seconds slept before
-;  ;; the new itimer is created won't be counted against it.
+;; the new itimer is created won't be counted against it.
-;  (if itimer-process
+(if (or itimer-process itimer-timer)
-;      (itimer-process-wakeup)
+(itimer-driver-wakeup)
-;    (itimer-process-start))
+(itimer-driver-start))
 (let ((inhibit-quit t))
 ;; add the itimer to the global list
 (setq itimer-list
-	  (cons (list name value restart function nil) ; extra slot for XEmacs
+	  (cons (list name value restart function with-arg function-argument)
 		itimer-list))
-;    ;; If the itimer process is scheduled to wake up too late for the itimer
+;; If the itimer process is scheduled to wake up too late for the itimer
-;    ;; we wake it up to calculate a correct wakeup value giving consideration
+;; we wake it up to calculate a correct wakeup value giving consideration
-;    ;; to the newly added itimer.
+;; to the newly added itimer.
-;    (if (< value itimer-process-next-wakeup)
+(if (< value itimer-next-wakeup)
-;	(itimer-process-wakeup)))
+	(itimer-driver-wakeup)))
-;; for XEmacs
-(activate-itimer (car itimer-list))
-)
 (car itimer-list))
 ;; User level functions to list and modify existing itimers.
 ;; Itimer Edit major mode, and the editing commands thereof.
 	 (itimers (reverse itimer-list)))
 (set-buffer buf)
 (itimer-edit-mode)
 (setq buffer-read-only nil)
 (erase-buffer)
-(insert "Name                  Value     Restart   Function\n"
+(insert
-	    "----                  -----     -------   --------")
+"Name                  Value   Restart   Function                   Argument\n"
+"----                  -----   -------   --------                   --------")
 (if (null itimer-edit-start-marker)
 	(setq itimer-edit-start-marker (point)))
 (while itimers
 (newline 1)
 (prin1 (itimer-name (car itimers)))
 (tab-to-tab-stop)
-(prin1 (itimer-value (car itimers)))
+(insert (itimer-truncate-string
+	       (format "%5.5s" (itimer-value (car itimers))) 5))
 (tab-to-tab-stop)
-(prin1 (itimer-restart (car itimers)))
+(insert (itimer-truncate-string
+	       (format "%5.5s" (itimer-restart (car itimers))) 5))
 (tab-to-tab-stop)
-(prin1 (itimer-function (car itimers)))
+(insert (itimer-truncate-string
+	       (format "%.26s" (itimer-function (car itimers))) 26))
+(tab-to-tab-stop)
+(if (itimer-uses-argument (car itimers))
+	  (prin1 (itimer-function-argument (car itimers)))
+	(prin1 'NONE))
 (setq itimers (cdr itimers)))
 ;; restore point
 (goto-char opoint)
 (if (< (point) itimer-edit-start-marker)
 	(goto-char itimer-edit-start-marker))
 The major mode of the buffer containing the listing is Itimer Edit mode.
 This major mode provides commands to manipulate itimers; see the documentation
 for `itimer-edit-mode' for more information."
 (interactive)
 ;; since user is editing, make sure displayed data is reasonably up-to-date
-;  (if itimer-process
+(if (or itimer-process itimer-timer)
-;      (itimer-process-wakeup))
+(itimer-driver-wakeup))
 (list-itimers)
 (select-window (get-buffer-window "*Itimer List*"))
 (goto-char itimer-edit-start-marker)
 (if itimer-list
 (progn
 (kill-all-local-variables)
 (make-local-variable 'tab-stop-list)
 (setq major-mode 'itimer-edit-mode
 	mode-name "Itimer Edit"
 	truncate-lines t
-	tab-stop-list '(22 32 42))
+	tab-stop-list '(22 32 40 67))
 (abbrev-mode 0)
 (auto-fill-mode 0)
-(buffer-disable-undo (current-buffer))
+(buffer-flush-undo (current-buffer))
 (use-local-map itimer-edit-map)
-(and lisp-mode-syntax-table (set-syntax-table lisp-mode-syntax-table)))
+(set-syntax-table emacs-lisp-mode-syntax-table))
 (put 'itimer-edit-mode 'mode-class 'special)
 (defun itimer-edit-help ()
 "Help function for Itimer Edit."
 			(n 0))
 		    ;; count the number of sexprs until we reach the cursor
 		    ;; and use this info to determine which field the user
 		    ;; wants to modify.
 		    (beginning-of-line)
-		    (while (and (>= opoint (point)) (< n 4))
+		    (while (and (>= opoint (point)) (< n 5))
 		      (forward-sexp 2)
 		      (backward-sexp)
-		      (itimer-incf n))
+		      (itimer-increment n))
 		    (cond ((eq n 1) (error "Cannot change itimer name."))
 			  ((eq n 2) 'value)
 			  ((eq n 3) 'restart)
-			  ((eq n 4) 'function)))))
+			  ((eq n 4) 'function)
+			  (t 'function-argument)))))
 (cond ((eq field 'value)
-	   ;; XEmacs: rewritten for I18N3 snarfing
+	   (let ((prompt "Set itimer value: "))
-	   (while (not (natnump field-value))
+	     (while (not (natnump field-value))
-	     (setq field-value (read-from-minibuffer "Set itimer value: "
+	       (setq field-value (read-from-minibuffer prompt nil nil t)))))
-						     nil nil t))))
 	  ((eq field 'restart)
-	   (while (and field-value (not (natnump field-value)))
+	   (let ((prompt "Set itimer restart: "))
-	     (setq field-value (read-from-minibuffer "Set itimer restart: "
+	     (while (and field-value (not (natnump field-value)))
-						     nil nil t))))
+	       (setq field-value (read-from-minibuffer prompt nil nil t)))))
 	  ((eq field 'function)
-	   (while (not (or (and (symbolp field-value) (fboundp field-value))
+	   (let ((prompt "Set itimer function: "))
-			   (and (consp field-value)
+	     (while (not (or (and (symbolp field-value) (fboundp field-value))
-				(memq (car field-value) '(lambda macro)))))
+			     (and (consp field-value)
-	     (setq field-value
+				  (memq (car field-value) '(lambda macro)))))
-		   (read (completing-read "Set itimer function: "
+	       (setq field-value
-					  obarray 'fboundp nil))))))
+		     (read (completing-read prompt obarray 'fboundp nil))))))
+	  ((eq field 'function-argument)
+	   (let ((prompt "Set itimer function argument: "))
+	     (setq field-value (read-expression prompt))
+	     (set-itimer-uses-argument itimer t))))
 ;; set the itimer field
 (funcall (intern (concat "set-itimer-" (symbol-name field)))
 	     itimer field-value)
 ;; move to beginning of field to be changed
 (itimer-edit-beginning-of-field)
 	   ;; treat fields at beginning of line as if they weren't there.
 	   (if (bolp)
 	       (progn
 		 (forward-sexp 2)
 		 (backward-sexp)))
-	   (itimer-decf count)))
+	   (itimer-decrement count)))
 	((< (itimer-signum count) 0)
 	 (while (not (zerop count))
 	   (backward-sexp)
 	   ;; treat fields at beginning of line as if they weren't there.
 	   (if (bolp)
 	   ;; wrap from itimer-edit-start-marker to field at eob.
 	   (if (<= (point) itimer-edit-start-marker)
 	       (progn
 		 (goto-char (point-max))
 		 (backward-sexp)))
-	   (itimer-incf count)))))
+	   (itimer-increment count)))))
 (defun itimer-edit-previous-field (count)
 (interactive "p")
 (itimer-edit-next-field (- count)))
 	(back (save-excursion (backward-sexp) (point))))
 (cond ((eq forw-back back) (backward-sexp))
 	  ((eq forw-back (point)) t)
 	  (t (backward-sexp)))))
+(defun itimer-truncate-string (str len)
+(if (<= (length str) len)
+str
+(substring str 0 len)))
 ;; internals of the itimer implementation.
+(defun itimer-run-expired-timers (time-elapsed)
+(let ((itimers (copy-sequence itimer-list))
+	(itimer)
+	(next-wakeup 600)
+	;; process filters can be hit by stray C-g's from the user,
+	;; so we must protect this stuff appropriately.
+	;; Quit's are allowed from within itimer functions, but we
+	;; catch them and print a message.
+	(inhibit-quit t))
+(setq next-wakeup 600)
+(while itimers
+(setq itimer (car itimers))
+(set-itimer-value-internal itimer (max 0 (- (itimer-value itimer)
+						  time-elapsed)))
+(if (> (itimer-value itimer) 0)
+	  (setq next-wakeup
+		(min next-wakeup (itimer-value itimer)))
+	;; itimer has expired, we must call its function.
+	;; protect our local vars from the itimer function.
+	;; allow keyboard quit to occur, but catch and report it.
+	;; provide the variable `current-itimer' in case the function
+	;; is interested.
+	(condition-case condition-data
+	    (save-match-data
+	      (let* ((current-itimer itimer)
+		     (quit-flag nil)
+		     (inhibit-quit nil)
+		     itimer itimers time-elapsed)
+		(if (itimer-uses-argument current-itimer)
+		    (funcall (itimer-function current-itimer)
+			     (itimer-function-argument current-itimer))
+		  (funcall (itimer-function current-itimer)))))
+	  (error (message "itimer \"%s\" signaled: %s" (itimer-name itimer)
+			  (prin1-to-string condition-data)))
+	  (quit (message "itimer \"%s\" quit" (itimer-name itimer))))
+	;; restart the itimer if we should, otherwise delete it.
+	(if (null (itimer-restart itimer))
+	    (delete-itimer itimer)
+	  (set-itimer-value-internal itimer (itimer-restart itimer))
+	  (setq next-wakeup (min next-wakeup (itimer-value itimer)))))
+(setq itimers (cdr itimers)))
+;; if user is editing itimers, update displayed info
+(if (eq major-mode 'itimer-edit-mode)
+	(list-itimers))
+next-wakeup ))
 (defun itimer-process-filter (process string)
-(error "itimer-process-filter is not used in XEmacs")
+;; If the itimer process dies and generates output while doing
-;  ;; If the itimer process dies and generates output while doing
+;; so, we may be called before the process-sentinel.  Sanity
-;  ;; so, we may be called before the process-sentinel.  Sanity
+;; check the output just in case...
-;  ;; check the output just in case...
+(if (not (string-match "^[0-9]" string))
-;  (if (not (string-match "^[0-9]" string))
+(progn (message "itimer process gave odd output: %s" string)
-;      (progn (message "itimer process gave odd output: %s" string)
+	     ;; it may be still alive and waiting for input
-;	     ;; it may be still alive and waiting for input
+	     (process-send-string itimer-process "3\n"))
-;	     (process-send-string itimer-process "3\n"))
+;; if there are no active itimers, return quickly.
-;    ;; if there are no active itimers, return quickly.
+(if itimer-list
-;    (if itimer-list
+	(setq itimer-next-wakeup
-;	(let ((time-elapsed (string-to-int string))
+	      (itimer-run-expired-timers (string-to-int string)))
-;	      (itimers itimer-list)
+(setq itimer-next-wakeup 600))
-;	      (itimer)
+;; tell itimer-process when to wakeup again
-;	      ;; process filters can be hit by stray C-g's from the user,
+(process-send-string itimer-process
-;	      ;; so we must protect this stuff appropriately.
+			 (concat (int-to-string itimer-next-wakeup)
-;	      ;; Quit's are allowed from within itimer functions, but we
+				 "\n"))))
-;	      ;; catch them.
-;	      (inhibit-quit t))
-;	  (setq itimer-process-next-wakeup 600)
-;	  (while itimers
-;	    (setq itimer (car itimers))
-;	    (set-itimer-value itimer (max 0 (- (itimer-value itimer) time-elapsed)) t)
-;	    (if (> (itimer-value itimer) 0)
-;		(setq itimer-process-next-wakeup
-;		      (min itimer-process-next-wakeup (itimer-value itimer)))
-;	      ;; itimer has expired, we must call its function.
-;	      ;; protect our local vars from the itimer function.
-;	      ;; allow keyboard quit to occur, but catch and report it.
-;	      ;; provide the variable `current-itimer' in case the function
-;	      ;; is interested.
-;	      (condition-case condition-data
-;		  (let* ((current-itimer itimer)
-;			 itimer itimers time-elapsed
-;			 quit-flag inhibit-quit)
-;		    (funcall (itimer-function current-itimer)))
-;		(error (message "itimer \"%s\" signaled: %s" (itimer-name itimer)
-;				(prin1-to-string condition-data)))
-;		(quit (message "itimer \"%s\" quit" (itimer-name itimer))))
-;	      ;; restart the itimer if we should, otherwise delete it.
-;	      (if (null (itimer-restart itimer))
-;		  (delete-itimer itimer)
-;		(set-itimer-value itimer (itimer-restart itimer) t)
-;		(setq itimer-process-next-wakeup
-;		      (min itimer-process-next-wakeup (itimer-value itimer)))))
-;	    (setq itimers (cdr itimers)))
-;	  ;; if user is editing itimers, update displayed info
-;	  (if (eq major-mode 'itimer-edit-mode)
-;	      (list-itimers)))
-;      (setq itimer-process-next-wakeup 600))
-;    ;; tell itimer-process when to wakeup again
-;    (process-send-string itimer-process
-;			 (concat (int-to-string itimer-process-next-wakeup)
-;				 "\n")))
-)
 (defun itimer-process-sentinel (process message)
-(error "itimer-process-sentinel is not used in XEmacs")
+(let ((inhibit-quit t))
-;  (let ((inhibit-quit t))
+(if (eq (process-status process) 'stop)
-;    (if (eq (process-status process) 'stop)
+	(continue-process process)
-;	(continue-process process)
+;; not stopped, so it must have died.
-;      ;; not stopped, so it must have died.
+;; cleanup first...
-;      ;; cleanup first...
+(delete-process process)
-;      (delete-process process)
+(setq itimer-process nil)
-;      (setq itimer-process nil)
+;; now, if there are any active itimers then we need to immediately
-;      ;; now, if there are any active itimers then we need to immediately
+;; start another itimer process, otherwise we can wait until the next
-;      ;; start another itimer process, otherwise we can wait until the next
+;; start-itimer call, which will start one automatically.
-;      ;; start-itimer call,  which will start one automatically.
+(if (null itimer-list)
-;      (if (null itimer-list)
+	  ()
-;	  ()
+	;; there may have been an error message in the echo area;
-;	;; there may have been an error message in the echo area;
+	;; give the user at least a little time to read it.
-;	;; give the user at least a little time to read it.
+	(sit-for 2)
-;	(sit-for 2)
+	(message "itimer process %s... respawning." (substring message 0 -1))
-;	(message "itimer process %s... respawning." (substring message 0 -1))
+	(itimer-process-start)))))
-;	(itimer-process-start))))
-)
 (defun itimer-process-start ()
-(error "itimer-process-start is not used in XEmacs")
+(let ((inhibit-quit t)
-;  (let ((inhibit-quit t)
+	(process-connection-type nil))
-;	(process-connection-type nil))
+(setq itimer-process (start-process "itimer" nil "itimer"))
-;    (setq itimer-process (start-process "itimer" nil "itimer"))
+(process-kill-without-query itimer-process)
-;    (process-kill-without-query itimer-process)
+(set-process-filter itimer-process 'itimer-process-filter)
-;    (set-process-filter itimer-process 'itimer-process-filter)
+(set-process-sentinel itimer-process 'itimer-process-sentinel)
-;    (set-process-sentinel itimer-process 'itimer-process-sentinel)
+;; Tell itimer process to wake up quickly, so that a correct
-;    ;; Tell itimer process to wake up quickly, so that a correct wakeup
+;; wakeup time can be computed.  Zero loses because of
-;    ;; time can be computed.  Zero instead of one here loses because of
+;; underlying itimer implementations that use 0 to mean
-;    ;; underlying itimer implementations that use 0 to mean `disable the
+;; `disable the itimer'.
-;    ;; itimer'.
+(setq itimer-next-wakeup itimer-short-interval)
-;    (setq itimer-process-next-wakeup 1)
+(process-send-string itimer-process
-;    (process-send-string itimer-process "1\n"))
+			 (format "%s\n" itimer-next-wakeup))))
-)
 (defun itimer-process-wakeup ()
-(error "itimer-process-wakeup is not used in XEmacs")
+(interrupt-process itimer-process)
-;  (interrupt-process itimer-process)
+(accept-process-output))
-;  (accept-process-output)
-)
+(defun itimer-timer-start ()
-;; XEmacs-specific code
-(defun activate-itimer (itimer)
 (let ((inhibit-quit t))
-(set-itimer-id itimer
+(setq itimer-next-wakeup itimer-short-interval
-		  (add-timeout (itimer-value itimer)
+	  itimer-timer-last-wakeup (current-time)
-			       'itimer-callback
+	  itimer-timer (add-timeout itimer-short-interval
-			       itimer
+				    'itimer-timer-driver nil nil))))
-			       (itimer-restart itimer))))
-itimer)
+(defun itimer-timer-wakeup ()
+(let ((inhibit-quit t))
-(defun deactivate-itimer (itimer)
+(cond ((fboundp 'cancel-timer)
-(let ((inhibit-quit t)
+	   (cancel-timer itimer-timer))
-	(id (itimer-id itimer)))
+	  ((fboundp 'disable-timeout)
-(and id (disable-timeout id))
+	   (disable-timeout itimer-timer)))
-(set-itimer-id itimer nil))
+(setq itimer-timer (add-timeout itimer-short-interval
-itimer)
+				    'itimer-timer-driver nil nil))))
-(defun itimer-callback (current-itimer)
+(defun itimer-time-difference (t1 t2)
-(funcall (itimer-function current-itimer)))
+;; ignore high 16 bits since we will never be dealing with
+;; times that long.
+(setq t1 (cdr t1)
-;;; itimer-driven auto-saves
+	t2 (cdr t2))
+(let ((usecs (- (nth 1 t1) (nth 1 t2)))
-;jwz: this is preloaded so don't ;;;###autoload
+	(secs (- (car t1) (car t2))))
-(defvar auto-save-timeout 30
+(if (< usecs 0)
-"*Number of seconds idle time before auto-save.
+	 (setq secs (1- secs)
-Zero or nil means disable auto-saving due to idleness.
+	       usecs (+ usecs 1000000)))
+(+ secs (/ usecs (if (featurep 'lisp-float-type) 1e6 1000000)))))
-The actual amount of idle time between auto-saves is logarithmically related
-to the size of the current buffer.  This variable is the number of seconds
+(defun itimer-timer-driver (&rest ignored)
-after which an auto-save will happen when the current buffer is 50k or less;
+;; inhibit quit because if the user quits at an inopportune
-the timeout will be 2 1/4 times this in a 200k buffer, 3 3/4 times this in a
+;; time, the timer process won't bne launched again and the
-1000k buffer, and 4 1/2 times this in a 2000k buffer.
+;; system stops working.  itimer-run-expired-timers allows
+;; individual timer function to be aborted, so the user can
-See also the variable `auto-save-interval', which controls auto-saving based
+;; escape a feral timer function.
-on the number of characters typed.")
+(let* ((inhibit-quit t)
+	 (now (current-time))
-;jwz: this is preloaded so don't ;;;###autoload
+	 (elapsed (itimer-time-difference now itimer-timer-last-wakeup))
-(defvar auto-gc-threshold (/ gc-cons-threshold 3)
+	 sleep)
-"*GC when this many bytes have been consed since the last GC,
+(setq itimer-timer-last-wakeup now
-and the user has been idle for `auto-save-timeout' seconds.")
+	  sleep (itimer-run-expired-timers elapsed)
+	  itimer-next-wakeup sleep
-(defun auto-save-itimer ()
+	  itimer-timer (add-timeout sleep 'itimer-timer-driver nil nil))))
-"For use as a itimer callback function.
-Auto-saves and garbage-collects based on the size of the current buffer
+(defun itimer-driver-start ()
-and the value of `auto-save-timeout', `auto-gc-threshold', and the current
+(if (fboundp 'add-timeout)
-keyboard idle-time."
+(itimer-timer-start)
-(if (or (null auto-save-timeout)
+(itimer-process-start)))
-	  (<= auto-save-timeout 0)
-	  (eq (minibuffer-window) (selected-window)))
+(defun itimer-driver-wakeup ()
-nil
+(if (fboundp 'add-timeout)
-(let ((buf-size (1+ (ash (buffer-size) -8)))
+(itimer-timer-wakeup)
-	  (delay-level 0)
+(itimer-process-wakeup)))
-	  (now (current-time))
-	  delay)
+;;; itimer.el ends here
-(while (> buf-size 64)
-	(setq delay-level (1+ delay-level)
-	      buf-size (- buf-size (ash buf-size -2))))
-(if (< delay-level 4)
-	  (setq delay-level 4))
-;; delay_level is 4 for files under around 50k, 7 at 100k, 9 at 200k,
-;; 11 at 300k, and 12 at 500k, 15 at 1 meg, and 17 at 2 meg.
-(setq delay (/ (* delay-level auto-save-timeout) 4))
-(let ((idle-time (if (or (not (consp last-input-time))
-			       (/= (car now) (car last-input-time)))
-			   (1+ delay)
-			 (- (car (cdr now)) (cdr last-input-time)))))
-	(and (> idle-time delay)
-	     (do-auto-save))
-	(and (> idle-time auto-save-timeout)
-	     (> (consing-since-gc) auto-gc-threshold)
-	     (garbage-collect)))))
-;; Look at the itimer that's currently running; if the user has changed
-;; the value of auto-save-timeout, modify this itimer to have the correct
-;; restart time.  There will be some latency between when the user changes
-;; this variable and when it takes effect, but it will happen eventually.
-(let ((self (get-itimer "auto-save")))
-(or self (error "auto-save-itimer can't find itself"))
-(if (and auto-save-timeout (> auto-save-timeout 4))
-	(or (= (itimer-restart self) (/ auto-save-timeout 4))
-	    (set-itimer-restart self (/ auto-save-timeout 4)))))
-nil)
-(defun itimer-init-auto-gc ()
-(or noninteractive ; may be being run from after-init-hook in -batch mode.
-(get-itimer "auto-save")
-;; the time here is just the first interval; if the user changes it
-;; later, it will adjust.
-(let ((time (max 2 (/ (or auto-save-timeout 30) 4))))
-	(start-itimer "auto-save" 'auto-save-itimer time time))))
-(cond (purify-flag
-;; This file is being preloaded into an emacs about to be dumped.
-;; So arrange for the auto-save itimer to be started once emacs
-;; is launched.
-(add-hook 'after-init-hook 'itimer-init-auto-gc))
-(t
-;; Otherwise, this file is being loaded into a normal, interactive
-;; emacs.  Start the auto-save timer now.
-(itimer-init-auto-gc)))
-(provide 'itimer)

Mercurial > hg > xemacs-beta

comparison lisp/prim/itimer.el @ 100:4be1180a9e89 r20-1b2