Comment fixes.
[bpt/emacs.git] / lisp / time.el
index eaab09e..371d815 100644 (file)
@@ -1,6 +1,6 @@
 ;;; time.el --- display time and load in mode line of Emacs.
 
-;; Copyright (C) 1985, 1986, 1987 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1986, 1987, 1993, 1994 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 
@@ -29,7 +29,8 @@
 
 (defvar display-time-mail-file nil
   "*File name of mail inbox file, for indicating existence of new mail.
-Default is system-dependent, and is the same as used by Rmail.")
+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.")
 
 ;;;###autoload
 (defvar display-time-day-and-date nil "\
@@ -41,7 +42,7 @@ Default is system-dependent, and is the same as used by Rmail.")
   "*Seconds between updates of time in the mode line.")
 
 (defvar display-time-24hr-format nil
-  "*Non-nill indicates time should be displayed as hh:mm, 0 <= hh <= 23.
+  "*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.")
 
 (defvar display-time-string nil)
@@ -49,6 +50,10 @@ Nil means 1 <= hh <= 12, and an AM/PM suffix is used.")
 (defvar display-time-hook nil
   "* List of functions to be called when the time is updated on the mode line.")
 
+(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 ()
   "Display current time, load level, and mail flag in mode line of each buffer.
@@ -57,8 +62,9 @@ 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'."
   (interactive)
-  (let ((live (and display-time-process
-                  (eq (process-status display-time-process) 'run))))
+  (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)
        (progn
          (if display-time-process
@@ -68,68 +74,112 @@ After each update, `display-time-hook' is run with `run-hooks'."
              (setq global-mode-string
                    (append global-mode-string '(display-time-string))))
          (setq display-time-string "")
-         (setq display-time-process
-               (start-process "display-time" nil
-                              (concat exec-directory "wakeup")
-                              (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)))))
+         (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
-  (save-excursion (set-buffer (other-buffer)))
-  (set-buffer-modified-p (buffer-modified-p))
+  (force-mode-line-update t)
   (sit-for 0))
 
+(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))
+    load
+    (if mail " Mail" ""))
+  "*A list of expressions governing display of the time in the mode line.
+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)'.")
+
 (defun display-time-filter (proc string)
-  (let ((time (current-time-string))
-       (load (condition-case ()
-                 (if (zerop (car (load-average))) ""
-                   (let ((str (format " %03d" (car (load-average)))))
-                     (concat (substring str 0 -2) "." (substring str -2))))
-               (error "")))
-       (mail-spool-file (or display-time-mail-file
-                            (getenv "MAIL")
-                            (concat rmail-spool-directory
-                                    (or (getenv "LOGNAME")
-                                        (getenv "USER")
-                                        (user-login-name)))))
-       hour am-pm-flag)
-    (setq hour (read (substring time 11 13)))
-    (if (not display-time-24hr-format)
-       (progn
-         (setq am-pm-flag (if (>= hour 12) "pm" "am"))
-         (if (> hour 12)
-             (setq hour (- hour 12))
-           (if (= hour 0)
-               (setq hour 12))))
-      (setq am-pm-flag ""))
+  (let* ((now (current-time))
+        (time (current-time-string now))
+         (load (condition-case ()
+                   (if (zerop (car (load-average))) ""
+                     (let ((str (format " %03d" (car (load-average)))))
+                       (concat (substring str 0 -2) "." (substring str -2))))
+                 (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))))))
+         (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
-         (concat (format "%d" hour) (substring time 13 16)
-                 am-pm-flag
-                 load
-                 (if (and (file-exists-p mail-spool-file)
-                          ;; file not empty?
-                          (display-time-file-nonempty-p mail-spool-file))
-                     " Mail"
-                   "")))
-    ;; Append the date if desired.
-    (if display-time-day-and-date
-       (setq display-time-string
-             (concat (substring time 0 11) display-time-string))))
-  (run-hooks 'display-time-hook)
-  ;; Force redisplay of all buffers' mode lines to be considered.
-  (save-excursion (set-buffer (other-buffer)))
-  (set-buffer-modified-p (buffer-modified-p))
+          (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)
   ;; Do redisplay right now, if no input pending.
   (sit-for 0))
 
 (defun display-time-file-nonempty-p (file)
-  (while (file-symlink-p file)
-    (setq file (file-symlink-p file)))
-  (> (nth 7 (file-attributes file)) 0))
+  (and (file-exists-p file)
+       (< 0 (nth 7 (file-attributes (file-chase-links file))))))
 
 ;;; time.el ends here