-;;; time.el --- display time, load and mail indicator in mode line of Emacs.
+;;; time.el --- display time, load and mail indicator in mode line of Emacs
-;; Copyright (C) 1985, 86, 87, 93, 94, 96, 2000 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 86, 87, 93, 94, 96, 2000, 2001, 2002
+;; Free Software Foundation, Inc.
;; Maintainer: FSF
: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."
- :type '(choice (const :tag "(None)" none)
+ :type '(choice (const :tag "None" none)
(const :tag "Default" nil)
(file :format "%v"))
:group 'display-time)
+(defcustom display-time-mail-directory nil
+ "*Name of mail inbox directory, for indicating existence of new mail.
+Any nonempty regular file in the directory is regarded as newly arrived mail.
+If nil, do not check a directory for arriving mail."
+ :type '(choice (const :tag "None" nil)
+ (directory :format "%v"))
+ :group 'display-time)
+
+(defcustom display-time-mail-function nil
+ "*Function to call, for indicating existence of new mail.
+If nil, that means use the default method: check that the file
+specified by `display-time-mail-file' is nonempty or that the
+directory `display-time-mail-directory' contains nonempty files."
+ :type '(choice (const :tag "Default" nil)
+ (function))
+ :group 'display-time)
+
+(defcustom display-time-default-load-average 0
+ "*Which load-average value will be shown in the mode line.
+Almost every system can provide values of load for past 1 minute, past 5 or
+past 15 minutes. The default is to display 1 minute load average."
+ :type '(choice (const :tag "1 minute load" 0)
+ (const :tag "5 minutes load" 1)
+ (const :tag "15 minutes load" 2)
+ (const :tag "None" nil))
+ :group 'display-time)
+
+(defvar display-time-load-average nil
+ "Load average currently being shown in mode line")
+
+(defcustom display-time-load-average-threshold 0.1
+ "*Load-average values below this value won't be shown in the mode line."
+ :type 'number
+ :group 'display-time)
+
;;;###autoload
(defcustom display-time-day-and-date nil "\
*Non-nil means \\[display-time] should display day and date as well as time."
(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)
(interactive)
(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))))
- (setq display-time-mode on)
- (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
- (or (memq 'display-time-string global-mode-string)
- (setq global-mode-string
- (append global-mode-string '(display-time-string))))
- ;; 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))))
-
(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
:type 'face)
(defvar display-time-mail-icon
- (find-image '((:type xbm :file "letter.xbm" :ascent center)))
+ (find-image '((:type xpm :file "letter.xpm" :ascent center)
+ (: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'.")
,@(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)))
+ 'help-echo "You have new mail; mouse-2: Read mail"
+ 'local-map (make-mode-line-mouse-map 'mouse-2
+ 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'
display-time-interval)
(timer-activate timer)))))
+(defun display-time-next-load-average ()
+ (interactive)
+ (if (= 3 (setq display-time-load-average (1+ display-time-load-average)))
+ (setq display-time-load-average 0))
+ (display-time-update)
+ (sit-for 0))
+
+(defun display-time-mail-check-directory ()
+ (let ((mail-files (directory-files display-time-mail-directory t))
+ (size 0))
+ (while (and mail-files (= size 0))
+ ;; Count size of regular files only.
+ (setq size (+ size (or (and (file-regular-p (car mail-files))
+ (nth 7 (file-attributes (car mail-files))))
+ 0)))
+ (setq mail-files (cdr mail-files)))
+ (if (> size 0)
+ size
+ nil)))
+
;; 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
(defun display-time-update ()
(let* ((now (current-time))
(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)))))
- (propertize
- (concat (substring str 0 -2) "." (substring str -2))
- 'help-echo "System load average")))
- (error "")))
+ (load (if (null display-time-load-average)
+ ""
+ (condition-case ()
+ ;; Do not show values less than
+ ;; `display-time-load-average-threshold'.
+ (if (> (* display-time-load-average-threshold 100)
+ (nth display-time-load-average (load-average)))
+ ""
+ ;; The load average number is mysterious, so
+ ;; provide some help.
+ (let ((str (format " %03d" (nth display-time-load-average (load-average)))))
+ (propertize
+ (concat (substring str 0 -2) "." (substring str -2))
+ 'local-map (make-mode-line-mouse-map 'mouse-2
+ 'display-time-next-load-average)
+ 'help-echo (concat "System load average for past "
+ (if (= 0 display-time-load-average)
+ "1 minute"
+ (if (= 1 display-time-load-average)
+ "5 minutes"
+ "15 minutes")) "; mouse-2: next" ))))
+ (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 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))))))
+ (mail (or (and display-time-mail-function
+ (funcall display-time-mail-function))
+ (and display-time-mail-directory
+ (display-time-mail-check-directory))
+ (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))
+;;;###autoload
+(define-minor-mode display-time-mode
+ "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."
+ :global t :group 'display-time
+ (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 '("")))
+ (setq display-time-load-average display-time-default-load-average)
+ (if display-time-mode
+ (progn
+ (or (memq 'display-time-string global-mode-string)
+ (setq global-mode-string
+ (append global-mode-string '(display-time-string))))
+ ;; 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)))
(provide 'time)
HCoop / bpt / emacs.git / blobdiff