-;;; 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.
-
-;; Maintainer: FSF
-
-;; This file is part of GNU Emacs.
-
-;; GNU Emacs 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.
-
-;; 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
-;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
-
-;;; Commentary:
-
-;; Facilities to display current time/date and a new-mail indicator
-;; in the Emacs mode line. The single entry point is `display-time'.
-
-;;; Code:
-
-(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."
- :type '(choice (const :tag "(None)" none)
- (const :tag "Default" nil)
- (file :format "%v"))
- :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."
- :type 'boolean
- :group 'display-time)
-
-(defvar display-time-timer nil)
-
-(defcustom display-time-interval 60
- "*Seconds between updates of time in the mode line."
- :type 'integer
- :group 'display-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."
- :type 'boolean
- :group 'display-time)
-
-(defvar display-time-string nil)
-
-(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.
-If that file system seems to be up, the value is nil.")
-
-;;;###autoload
-(defun display-time ()
- "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.
-This runs the normal hook `display-time-hook' after each update."
- (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
-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)
-
-(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. 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)
-
-(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
- ;; 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.
-
-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',
-and `time-zone' all alphabetic strings, and `mail' a true/nil value.
-
-For example, the form
-
- '((substring year -2) \"/\" month \"/\" day
- \" \" 24-hours \":\" minutes \":\" seconds
- (if time-zone \" (\") time-zone (if time-zone \")\")
- (if mail \" Mail\" \"\"))
-
-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)))
- ;; 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 ()
- (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 "")))
- (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))))))
- (24-hours (substring time 11 13))
- (hour (string-to-int 24-hours))
- (12-hours (int-to-string (1+ (% (+ hour 11) 12))))
- (am-pm (if (>= hour 12) "pm" "am"))
- (minutes (substring time 14 16))
- (seconds (substring time 17 19))
- (time-zone (car (cdr (current-time-zone now))))
- (day (substring time 8 10))
- (year (substring time 20 24))
- (monthname (substring time 4 7))
- (month
- (cdr
- (assoc
- monthname
- '(("Jan" . "1") ("Feb" . "2") ("Mar" . "3") ("Apr" . "4")
- ("May" . "5") ("Jun" . "6") ("Jul" . "7") ("Aug" . "8")
- ("Sep" . "9") ("Oct" . "10") ("Nov" . "11") ("Dec" . "12")))))
- (dayname (substring time 0 3)))
- (setq display-time-string
- (mapconcat 'eval display-time-string-forms ""))
- ;; 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))
-
-(defun display-time-file-nonempty-p (file)
- (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
+;;; time.el --- display time, load and mail indicator in mode line of Emacs.\r
+\r
+;; Copyright (C) 1985, 86, 87, 93, 94, 96, 2000 Free Software Foundation, Inc.\r
+\r
+;; Maintainer: FSF\r
+\r
+;; This file is part of GNU Emacs.\r
+\r
+;; GNU Emacs is free software; you can redistribute it and/or modify\r
+;; it under the terms of the GNU General Public License as published by\r
+;; the Free Software Foundation; either version 2, or (at your option)\r
+;; any later version.\r
+\r
+;; GNU Emacs is distributed in the hope that it will be useful,\r
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+;; GNU General Public License for more details.\r
+\r
+;; You should have received a copy of the GNU General Public License\r
+;; along with GNU Emacs; see the file COPYING. If not, write to the\r
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,\r
+;; Boston, MA 02111-1307, USA.\r
+\r
+;;; Commentary:\r
+\r
+;; Facilities to display current time/date and a new-mail indicator\r
+;; in the Emacs mode line. The single entry point is `display-time'.\r
+\r
+;;; Code:\r
+\r
+(defgroup display-time nil\r
+ "Display time and load in mode line of Emacs."\r
+ :group 'modeline\r
+ :group 'mail)\r
+\r
+\r
+;;;###autoload\r
+(defcustom display-time-mode nil\r
+ "Toggle display of time, load level, and mail flag in mode lines.\r
+Setting this variable directly does not take effect;\r
+use either \\[customize] or the function `display-time-mode'."\r
+ :set (lambda (symbol value)\r
+ (display-time-mode (or value 0)))\r
+ :initialize 'custom-initialize-default\r
+ :type 'boolean\r
+ :group 'display-time\r
+ :require 'time\r
+ :version "20.3")\r
+\r
+\r
+(defcustom display-time-mail-file nil\r
+ "*File name of mail inbox file, for indicating existence of new mail.\r
+Non-nil and not a string means don't check for mail. nil means use\r
+default, which is system-dependent, and is the same as used by Rmail."\r
+ :type '(choice (const :tag "(None)" none)\r
+ (const :tag "Default" nil)\r
+ (file :format "%v"))\r
+ :group 'display-time)\r
+\r
+(defcustom display-time-mail-function nil\r
+ "*Function to call, for indicating existence of new mail.\r
+nil means use the default method of checking `display-time-mail-file'."\r
+ :type '(choice (const :tag "Default" nil)\r
+ (function))\r
+ :group 'display-time)\r
+\r
+;;;###autoload\r
+(defcustom display-time-day-and-date nil "\\r
+*Non-nil means \\[display-time] should display day and date as well as time."\r
+ :type 'boolean\r
+ :group 'display-time)\r
+\r
+(defvar display-time-timer nil)\r
+\r
+(defcustom display-time-interval 60\r
+ "*Seconds between updates of time in the mode line."\r
+ :type 'integer\r
+ :group 'display-time)\r
+\r
+(defcustom display-time-24hr-format nil\r
+ "*Non-nil indicates time should be displayed as hh:mm, 0 <= hh <= 23.\r
+Nil means 1 <= hh <= 12, and an AM/PM suffix is used."\r
+ :type 'boolean\r
+ :group 'display-time)\r
+\r
+(defvar display-time-string nil)\r
+\r
+(defcustom display-time-hook nil\r
+ "*List of functions to be called when the time is updated on the mode line."\r
+ :type 'hook\r
+ :group 'display-time)\r
+\r
+(defvar display-time-server-down-time nil\r
+ "Time when mail file's file system was recorded to be down.\r
+If that file system seems to be up, the value is nil.")\r
+\r
+;;;###autoload\r
+(defun display-time ()\r
+ "Enable display of time, load level, and mail flag in mode lines.\r
+This display updates automatically every minute.\r
+If `display-time-day-and-date' is non-nil, the current day and date\r
+are displayed as well.\r
+This runs the normal hook `display-time-hook' after each update."\r
+ (interactive)\r
+ (display-time-mode 1))\r
+\r
+;;;###autoload\r
+(defun display-time-mode (arg)\r
+ "Toggle display of time, load level, and mail flag in mode lines.\r
+With a numeric arg, enable this display if arg is positive.\r
+\r
+When this display is enabled, it updates automatically every minute.\r
+If `display-time-day-and-date' is non-nil, the current day and date\r
+are displayed as well.\r
+This runs the normal hook `display-time-hook' after each update."\r
+ (interactive "P")\r
+ (let ((on (if (null arg)\r
+ (not display-time-timer)\r
+ (> (prefix-numeric-value arg) 0))))\r
+ (setq display-time-mode on)\r
+ (and display-time-timer (cancel-timer display-time-timer))\r
+ (setq display-time-timer nil)\r
+ (setq display-time-string "")\r
+ (or global-mode-string (setq global-mode-string '("")))\r
+ (if on\r
+ (progn\r
+ (or (memq 'display-time-string global-mode-string)\r
+ (setq global-mode-string\r
+ (append global-mode-string '(display-time-string))))\r
+ ;; Set up the time timer.\r
+ (setq display-time-timer\r
+ (run-at-time t display-time-interval\r
+ 'display-time-event-handler))\r
+ ;; Make the time appear right away.\r
+ (display-time-update)\r
+ ;; When you get new mail, clear "Mail" from the mode line.\r
+ (add-hook 'rmail-after-get-new-mail-hook\r
+ 'display-time-event-handler))\r
+ (remove-hook 'rmail-after-get-new-mail-hook\r
+ 'display-time-event-handler))))\r
+\r
+(defcustom display-time-mail-face 'mode-line\r
+ "Face to use for `display-time-mail-string'.\r
+If `display-time-use-mail-icon' is non-nil, the image's background\r
+colour is the background of this face. Set this to a face other than\r
+`mode-line' to make the mail indicator stand out on a suitable\r
+display."\r
+ :group 'faces\r
+ :group 'display-time\r
+ :type 'face)\r
+\r
+(defvar display-time-mail-icon\r
+ (find-image '((:type xbm :file "letter.xbm" :ascent center)))\r
+ "Image specification to offer as the mail indicator on a graphic\r
+display. See `display-time-use-mail-icon' and\r
+`display-time-mail-face'.")\r
+\r
+(defcustom display-time-use-mail-icon nil\r
+ "Non-nil means use an icon as the mail indicator on a graphic display.\r
+Otherwise use the string \"Mail\". The icon may consume less of the\r
+mode line. It is specified by `display-time-mail-icon'."\r
+ :group 'display-time\r
+ :type 'boolean)\r
+\r
+(defcustom display-time-format nil\r
+ "*A string specifying the format for displaying the time in the mode line.\r
+See the function `format-time-string' for an explanation of\r
+how to write this string. If this is nil, the defaults\r
+depend on `display-time-day-and-date' and `display-time-24hr-format'."\r
+ :type '(choice (const :tag "Default" nil)\r
+ string)\r
+ :group 'display-time)\r
+\r
+(defcustom display-time-string-forms\r
+ '((if (and (not display-time-format) display-time-day-and-date)\r
+ (format-time-string "%a %b %e " now)\r
+ "")\r
+ (format-time-string (or display-time-format\r
+ (if display-time-24hr-format "%H:%M" "%-I:%M%p"))\r
+ now)\r
+ load\r
+ (if mail\r
+ ;; Build the string every time to act on customization.\r
+ (concat " "\r
+ (propertize\r
+ "Mail"\r
+ 'display `(when (and display-time-use-mail-icon\r
+ (display-graphic-p))\r
+ ,@display-time-mail-icon\r
+ ,@(list :background (face-attribute\r
+ display-time-mail-face\r
+ :background)))\r
+ 'help-echo "mouse-2: Read mail"\r
+ 'local-map (make-mode-line-mouse2-map read-mail-command)))\r
+ ""))\r
+ "*A list of expressions governing display of the time in the mode line.\r
+For most purposes, you can control the time format using `display-time-format'\r
+which is a more standard interface.\r
+\r
+This expression is a list of expressions that can involve the keywords\r
+`load', `day', `month', and `year', `12-hours', `24-hours', `minutes',\r
+`seconds', all numbers in string form, and `monthname', `dayname', `am-pm',\r
+and `time-zone' all alphabetic strings, and `mail' a true/nil value.\r
+\r
+For example, the form\r
+\r
+ '((substring year -2) \"/\" month \"/\" day\r
+ \" \" 24-hours \":\" minutes \":\" seconds\r
+ (if time-zone \" (\") time-zone (if time-zone \")\")\r
+ (if mail \" Mail\" \"\"))\r
+\r
+would give mode line times like `94/12/30 21:07:48 (UTC)'."\r
+ :type 'sexp\r
+ :group 'display-time)\r
+\r
+(defun display-time-event-handler ()\r
+ (display-time-update)\r
+ ;; Do redisplay right now, if no input pending.\r
+ (sit-for 0)\r
+ (let* ((current (current-time))\r
+ (timer display-time-timer)\r
+ ;; Compute the time when this timer will run again, next.\r
+ (next-time (timer-relative-time\r
+ (list (aref timer 1) (aref timer 2) (aref timer 3))\r
+ (* 5 (aref timer 4)) 0)))\r
+ ;; If the activation time is far in the past,\r
+ ;; skip executions until we reach a time in the future.\r
+ ;; This avoids a long pause if Emacs has been suspended for hours.\r
+ (or (> (nth 0 next-time) (nth 0 current))\r
+ (and (= (nth 0 next-time) (nth 0 current))\r
+ (> (nth 1 next-time) (nth 1 current)))\r
+ (and (= (nth 0 next-time) (nth 0 current))\r
+ (= (nth 1 next-time) (nth 1 current))\r
+ (> (nth 2 next-time) (nth 2 current)))\r
+ (progn\r
+ (timer-set-time timer (timer-next-integral-multiple-of-time\r
+ current display-time-interval)\r
+ display-time-interval)\r
+ (timer-activate timer)))))\r
+\r
+;; Update the display-time info for the mode line\r
+;; but don't redisplay right now. This is used for\r
+;; things like Rmail `g' that want to force an update\r
+;; which can wait for the next redisplay.\r
+(defun display-time-update ()\r
+ (let* ((now (current-time))\r
+ (time (current-time-string now))\r
+ (load (condition-case ()\r
+ (if (zerop (car (load-average))) ""\r
+ ;; The load average number is mysterious, so\r
+ ;; propvide some help.\r
+ (let ((str (format " %03d" (car (load-average)))))\r
+ (propertize\r
+ (concat (substring str 0 -2) "." (substring str -2))\r
+ 'help-echo "System load average")))\r
+ (error "")))\r
+ (mail-spool-file (or display-time-mail-file\r
+ (getenv "MAIL")\r
+ (concat rmail-spool-directory\r
+ (user-login-name))))\r
+ (mail (or (and display-time-mail-function\r
+ (funcall display-time-mail-function))\r
+ (and (stringp mail-spool-file)\r
+ (or (null display-time-server-down-time)\r
+ ;; If have been down for 20 min, try again.\r
+ (> (- (nth 1 now) display-time-server-down-time)\r
+ 1200)\r
+ (and (< (nth 1 now) display-time-server-down-time)\r
+ (> (- (nth 1 now) display-time-server-down-time)\r
+ -64336)))\r
+ (let ((start-time (current-time)))\r
+ (prog1\r
+ (display-time-file-nonempty-p mail-spool-file)\r
+ (if (> (- (nth 1 (current-time)) (nth 1 start-time))\r
+ 20)\r
+ ;; Record that mail file is not accessible.\r
+ (setq display-time-server-down-time\r
+ (nth 1 (current-time)))\r
+ ;; Record that mail file is accessible.\r
+ (setq display-time-server-down-time nil)))))))\r
+ (24-hours (substring time 11 13))\r
+ (hour (string-to-int 24-hours))\r
+ (12-hours (int-to-string (1+ (% (+ hour 11) 12))))\r
+ (am-pm (if (>= hour 12) "pm" "am"))\r
+ (minutes (substring time 14 16))\r
+ (seconds (substring time 17 19))\r
+ (time-zone (car (cdr (current-time-zone now))))\r
+ (day (substring time 8 10))\r
+ (year (substring time 20 24))\r
+ (monthname (substring time 4 7))\r
+ (month\r
+ (cdr\r
+ (assoc\r
+ monthname\r
+ '(("Jan" . "1") ("Feb" . "2") ("Mar" . "3") ("Apr" . "4")\r
+ ("May" . "5") ("Jun" . "6") ("Jul" . "7") ("Aug" . "8")\r
+ ("Sep" . "9") ("Oct" . "10") ("Nov" . "11") ("Dec" . "12")))))\r
+ (dayname (substring time 0 3)))\r
+ (setq display-time-string\r
+ (mapconcat 'eval display-time-string-forms ""))\r
+ ;; This is inside the let binding, but we are not going to document\r
+ ;; what variables are available.\r
+ (run-hooks 'display-time-hook))\r
+ (force-mode-line-update))\r
+\r
+(defun display-time-file-nonempty-p (file)\r
+ (and (file-exists-p file)\r
+ (< 0 (nth 7 (file-attributes (file-chase-links file))))))\r
+\r
+(if display-time-mode\r
+ (display-time-mode t))\r
+\r
+(provide 'time)\r
+\r
+;;; time.el ends here\r
HCoop / bpt / emacs.git / blobdiff