(setup-english-environment): Adjusted for the change of coding

[bpt/emacs.git] / lisp / time.el

diff --git a/lisp/time.el b/lisp/time.el
index 17abe7f..6708ef8 100644 (file)
--- a/lisp/time.el
+++ b/lisp/time.el
@@ -28,28 +28,45 @@
 
 ;;; Code:
 
-(defvar display-time-mail-file nil
+(defgroup display-time nil
+  "Display time and load in mode line of Emacs."
+  :group 'modeline
+  :group 'mail)
+
+
+(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 "Default" nil)
+                (file :format "%v"))
+  :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.
@@ -100,17 +117,28 @@ This runs the normal hook `display-time-hook' after each update."
                   'display-time-event-handler))))
 
 
-(defvar display-time-string-forms
-  '((if display-time-day-and-date
-        (format "%s %s %s " dayname monthname day)
+(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 "%s:%s%s"
-            (if display-time-24hr-format 24-hours 12-hours)
-            minutes
-            (if display-time-24hr-format "" am-pm))
+    (format-time-string (or display-time-format
+                           (if display-time-24hr-format "%H:%M" "%-I:%M%p"))
+                       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',
@@ -123,12 +151,34 @@ For example, the form
     (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))
+  (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
@@ -191,4 +241,6 @@ would give mode line times like `94/12/30 21:07:48 (UTC)'.")
   (and (file-exists-p file)
        (< 0 (nth 7 (file-attributes (file-chase-links file))))))
 
+(provide 'time)
+
 ;;; time.el ends here