;;; time.el --- display time and load in mode line of Emacs.
-;; Copyright (C) 1985, 1986, 1987, 1993, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 86, 87, 93, 94, 1996 Free Software Foundation, Inc.
;; Maintainer: FSF
(defvar display-time-day-and-date nil "\
*Non-nil means \\[display-time] should display day and date as well as time.")
-(defvar display-time-process nil)
+(defvar display-time-timer nil)
(defvar display-time-interval 60
"*Seconds between updates of time in the mode line.")
;;;###autoload
(defun display-time ()
- "Display current time, load level, and mail flag in mode line of each buffer.
-Updates automatically every minute.
+ "Enable display of time, load level, and mail flag in mode lines.
+This display updates automatically every minute.
If `display-time-day-and-date' is non-nil, the current day and date
are displayed as well.
-After each update, `display-time-hook' is run with `run-hooks'."
+This runs the normal hook `display-time-hook' after each update."
(interactive)
- (let ((live (or (and (eq system-type 'ms-dos) dos-display-time)
- (and display-time-process
- (eq (process-status display-time-process) 'run)))))
- (if (not live)
+ (display-time-mode 1))
+
+;;;###autoload
+(defun display-time-mode (arg)
+ "Toggle display of time, load level, and mail flag in mode lines.
+With a numeric arg, enable this display if arg is positive.
+
+When this display is enabled, it updates automatically every minute.
+If `display-time-day-and-date' is non-nil, the current day and date
+are displayed as well.
+This runs the normal hook `display-time-hook' after each update."
+ (interactive "P")
+ (let ((on (if (null arg)
+ (not display-time-timer)
+ (> (prefix-numeric-value arg) 0))))
+ (and display-time-timer (cancel-timer display-time-timer))
+ (setq display-time-timer nil)
+ (setq display-time-string "")
+ (or global-mode-string (setq global-mode-string '("")))
+ (if on
(progn
- (if display-time-process
- (delete-process display-time-process))
- (or global-mode-string (setq global-mode-string '("")))
(or (memq 'display-time-string global-mode-string)
(setq global-mode-string
(append global-mode-string '(display-time-string))))
- (setq display-time-string "")
- (if (eq system-type 'ms-dos)
- (setq dos-display-time t)
- ;; Using a pty is wasteful, and the separate session causes
- ;; annoyance sometimes (some systems kill idle sessions).
- (progn
- (let ((process-connection-type nil))
- (setq display-time-process
- (start-process "display-time" nil
- (expand-file-name
- "wakeup" exec-directory)
- (int-to-string display-time-interval))))
- (process-kill-without-query display-time-process)
- (set-process-sentinel display-time-process
- 'display-time-sentinel)
- (set-process-filter display-time-process
- 'display-time-filter)))))))
-
-(defun display-time-sentinel (proc reason)
- (or (eq (process-status proc) 'run)
- (setq display-time-string ""))
- ;; Force mode-line updates
- (force-mode-line-update t)
- (sit-for 0))
+ ;; Set up the time timer.
+ (setq display-time-timer
+ (run-at-time t display-time-interval
+ 'display-time-event-handler))
+ ;; Make the time appear right away.
+ (display-time-update)
+ ;; When you get new mail, clear "Mail" from the mode line.
+ (add-hook 'rmail-after-get-new-mail-hook
+ 'display-time-event-handler))
+ (remove-hook 'rmail-after-get-new-mail-hook
+ 'display-time-event-handler))))
+
+
+(defvar display-time-format
+ (concat
+ (if display-time-day-and-date
+ "%a %b %e" "")
+ (if display-time-24hr-format "%H:%m" "%-I:%M%p"))
+ "*A string specifying the format for displaying the time in the mode line.
+See the function `format-time-string' for an explanation of
+how to write this string.")
(defvar display-time-string-forms
- '((if display-time-day-and-date
- (format "%s %s %s " dayname monthname day)
- "")
- (format "%s:%s%s"
- (if display-time-24hr-format 24-hours 12-hours)
- minutes
- (if display-time-24hr-format "" am-pm))
+ '((format-time-string display-time-format now)
load
(if mail " Mail" ""))
"*A list of expressions governing display of the time in the mode line.
+For most purposes, you can control the time format using `display-time-format'
+which is a more standard interface.
+
This expression is a list of expressions that can involve the keywords
`load', `day', `month', and `year', `12-hours', `24-hours', `minutes',
`seconds', all numbers in string form, and `monthname', `dayname', `am-pm',
would give mode line times like `94/12/30 21:07:48 (UTC)'.")
-(defun display-time-filter (proc string)
+(defun display-time-event-handler ()
+ (display-time-update)
+ ;; Do redisplay right now, if no input pending.
+ (sit-for 0)
+ (let* ((current (current-time))
+ (timer display-time-timer)
+ ;; Compute the time when this timer will run again, next.
+ (next-time (timer-relative-time
+ (list (aref timer 1) (aref timer 2) (aref timer 3))
+ (* 5 (aref timer 4)) 0)))
+ ;; If the activation time is far in the past,
+ ;; skip executions until we reach a time in the future.
+ ;; This avoids a long pause if Emacs has been suspended for hours.
+ (or (> (nth 0 next-time) (nth 0 current))
+ (and (= (nth 0 next-time) (nth 0 current))
+ (> (nth 1 next-time) (nth 1 current)))
+ (and (= (nth 0 next-time) (nth 0 current))
+ (= (nth 1 next-time) (nth 1 current))
+ (> (nth 2 next-time) (nth 2 current)))
+ (progn
+ (timer-set-time timer (timer-next-integral-multiple-of-time
+ current display-time-interval)
+ display-time-interval)
+ (timer-activate timer)))))
+
+;; Update the display-time info for the mode line
+;; but don't redisplay right now. This is used for
+;; things like Rmail `g' that want to force an update
+;; which can wait for the next redisplay.
+(defun display-time-update ()
(let* ((now (current-time))
(time (current-time-string now))
(load (condition-case ()
;; This is inside the let binding, but we are not going to document
;; what variables are available.
(run-hooks 'display-time-hook))
- (force-mode-line-update)
- ;; Do redisplay right now, if no input pending.
- (sit-for 0))
+ (force-mode-line-update))
(defun display-time-file-nonempty-p (file)
(and (file-exists-p file)