-;;; time.el --- display time and load in mode line of Emacs.
+;;; time.el --- display time, load and mail indicator in mode line of Emacs.\r
-;; Copyright (C) 1985, 86, 87, 93, 94, 1996 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 86, 87, 93, 94, 96, 2000 Free Software Foundation, Inc.
;; Maintainer: FSF
;;; Code:
-(defvar display-time-mail-file nil
+(defgroup display-time nil
+ "Display time and load in mode line of Emacs."
+ :group 'modeline
+ :group 'mail)
+
+
+;;;###autoload
+(defcustom display-time-mode nil
+ "Toggle display of time, load level, and mail flag in mode lines.
+Setting this variable directly does not take effect;
+use either \\[customize] or the function `display-time-mode'."
+ :set (lambda (symbol value)
+ (display-time-mode (or value 0)))
+ :initialize 'custom-initialize-default
+ :type 'boolean
+ :group 'display-time
+ :require 'time
+ :version "20.3")
+
+
+(defcustom display-time-mail-file nil
"*File name of mail inbox file, for indicating existence of new mail.
Non-nil and not a string means don't check for mail. nil means use
-default, which is system-dependent, and is the same as used by Rmail.")
+default, which is system-dependent, and is the same as used by Rmail."
+ :type '(choice (const :tag "(None)" none)
+ (const :tag "Default" nil)
+ (file :format "%v"))
+ :group 'display-time)
+
+(defcustom display-time-mail-function nil
+ "*Function to call, for indicating existence of new mail.
+nil means use the default method of checking `display-time-mail-file'."
+ :type '(choice (const :tag "Default" nil)
+ (function))
+ :group 'display-time)
;;;###autoload
-(defvar display-time-day-and-date nil "\
-*Non-nil means \\[display-time] should display day and date as well as time.")
+(defcustom display-time-day-and-date nil "\
+*Non-nil means \\[display-time] should display day and date as well as time."
+ :type 'boolean
+ :group 'display-time)
(defvar display-time-timer nil)
-(defvar display-time-interval 60
- "*Seconds between updates of time in the mode line.")
+(defcustom display-time-interval 60
+ "*Seconds between updates of time in the mode line."
+ :type 'integer
+ :group 'display-time)
-(defvar display-time-24hr-format nil
+(defcustom display-time-24hr-format nil
"*Non-nil indicates time should be displayed as hh:mm, 0 <= hh <= 23.
-Nil means 1 <= hh <= 12, and an AM/PM suffix is used.")
+Nil means 1 <= hh <= 12, and an AM/PM suffix is used."
+ :type 'boolean
+ :group 'display-time)
(defvar display-time-string nil)
-(defvar display-time-hook nil
- "* List of functions to be called when the time is updated on the mode line.")
+(defcustom display-time-hook nil
+ "*List of functions to be called when the time is updated on the mode line."
+ :type 'hook
+ :group 'display-time)
(defvar display-time-server-down-time nil
"Time when mail file's file system was recorded to be down.
(let ((on (if (null arg)
(not display-time-timer)
(> (prefix-numeric-value arg) 0))))
+ (setq display-time-mode on)
(and display-time-timer (cancel-timer display-time-timer))
(setq display-time-timer nil)
(setq display-time-string "")
(remove-hook 'rmail-after-get-new-mail-hook
'display-time-event-handler))))
+(defcustom display-time-mail-face 'mode-line
+ "Face to use for `display-time-mail-string'.
+If `display-time-use-mail-icon' is non-nil, the image's background
+colour is the background of this face. Set this to a face other than
+`mode-line' to make the mail indicator stand out on a suitable
+display."
+ :group 'faces
+ :group 'display-time
+ :type 'face)
+
+(defvar display-time-mail-icon
+ (find-image '((:type xbm :file "letter.xbm" :ascent center)))
+ "Image specification to offer as the mail indicator on a graphic
+display. See `display-time-use-mail-icon' and
+`display-time-mail-face'.")
+
+(defcustom display-time-use-mail-icon nil
+ "Non-nil means use an icon as the mail indicator on a graphic display.
+Otherwise use the string \"Mail\". The icon may consume less of the
+mode line. It is specified by `display-time-mail-icon'."
+ :group 'display-time
+ :type 'boolean)
-(defvar display-time-format
- (concat
- (if display-time-day-and-date
- "%a %b %e" "")
- (if display-time-24hr-format "%H:%m" "%-I:%M%p"))
+(defcustom display-time-format nil
"*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.")
+how to write this string. If this is nil, the defaults
+depend on `display-time-day-and-date' and `display-time-24hr-format'."
+ :type '(choice (const :tag "Default" nil)
+ string)
+ :group 'display-time)
-(defvar display-time-string-forms
- '((format-time-string display-time-format now)
+(defcustom display-time-string-forms
+ '((if (and (not display-time-format) display-time-day-and-date)
+ (format-time-string "%a %b %e " now)
+ "")
+ (format-time-string (or display-time-format
+ (if display-time-24hr-format "%H:%M" "%-I:%M%p"))
+ now)
load
- (if mail " Mail" ""))
+ (if mail
+ ;; Build the string every time to act on customization.
+ (concat " "
+ (propertize
+ "Mail"
+ 'display `(when (and display-time-use-mail-icon
+ (display-graphic-p))
+ ,@display-time-mail-icon
+ ,@(list :background (face-attribute
+ display-time-mail-face
+ :background)))
+ 'help-echo "mouse-2: Read mail"
+ 'local-map (make-mode-line-mouse2-map read-mail-command)))
+ ""))
"*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.
(if time-zone \" (\") time-zone (if time-zone \")\")
(if mail \" Mail\" \"\"))
-would give mode line times like `94/12/30 21:07:48 (UTC)'.")
+would give mode line times like `94/12/30 21:07:48 (UTC)'."
+ :type 'sexp
+ :group 'display-time)
(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)))
+ (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.
(time (current-time-string now))
(load (condition-case ()
(if (zerop (car (load-average))) ""
+ ;; The load average number is mysterious, so
+ ;; propvide some help.
(let ((str (format " %03d" (car (load-average)))))
- (concat (substring str 0 -2) "." (substring str -2))))
+ (propertize
+ (concat (substring str 0 -2) "." (substring str -2))
+ 'help-echo "System load average")))
(error "")))
(mail-spool-file (or display-time-mail-file
(getenv "MAIL")
(concat rmail-spool-directory
(user-login-name))))
- (mail (and (stringp mail-spool-file)
- (or (null display-time-server-down-time)
- ;; If have been down for 20 min, try again.
- (> (- (nth 1 (current-time))
- display-time-server-down-time)
- 1200))
- (let ((start-time (current-time)))
- (prog1
- (display-time-file-nonempty-p mail-spool-file)
- (if (> (- (nth 1 (current-time)) (nth 1 start-time))
- 20)
- ;; Record that mail file is not accessible.
- (setq display-time-server-down-time
- (nth 1 (current-time)))
- ;; Record that mail file is accessible.
- (setq display-time-server-down-time nil))))))
+ (mail (or (and display-time-mail-function
+ (funcall display-time-mail-function))
+ (and (stringp mail-spool-file)
+ (or (null display-time-server-down-time)
+ ;; If have been down for 20 min, try again.
+ (> (- (nth 1 now) display-time-server-down-time)
+ 1200)
+ (and (< (nth 1 now) display-time-server-down-time)
+ (> (- (nth 1 now) display-time-server-down-time)
+ -64336)))
+ (let ((start-time (current-time)))
+ (prog1
+ (display-time-file-nonempty-p mail-spool-file)
+ (if (> (- (nth 1 (current-time)) (nth 1 start-time))
+ 20)
+ ;; Record that mail file is not accessible.
+ (setq display-time-server-down-time
+ (nth 1 (current-time)))
+ ;; Record that mail file is accessible.
+ (setq display-time-server-down-time nil)))))))
(24-hours (substring time 11 13))
(hour (string-to-int 24-hours))
(12-hours (int-to-string (1+ (% (+ hour 11) 12))))
(and (file-exists-p file)
(< 0 (nth 7 (file-attributes (file-chase-links file))))))
+(if display-time-mode
+ (display-time-mode t))
+
+(provide 'time)
+
;;; time.el ends here