]> code.delx.au - gnu-emacs/blobdiff - lisp/time.el
Say "standard settings" instead of "factory settings".
[gnu-emacs] / lisp / time.el
index 08c2f86c82c08cd41d198282ad7cee24571cb87d..8f798fa08a26827a8d4b2ff9081169f805a4bfef 100644 (file)
@@ -57,38 +57,66 @@ 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.
-Updates automatically every minute.
+  "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.
-After each update, `display-time-hook' is run with `run-hooks'."
+This runs the normal hook `display-time-hook' after each update."
   (interactive)
-  (setq display-time-string "")
-  (or global-mode-string (setq global-mode-string '("")))
-  (or (memq 'display-time-string global-mode-string)
-      (setq global-mode-string
-           (append global-mode-string '(display-time-string))))
-  ;; Setup the time timer.
-  (and display-time-timer (cancel-timer display-time-timer))
-  (setq display-time-timer
-        ;; Start timer at the beginning of the current minute so that
-        ;; it updates as soon as the minute changes.
-       (run-at-time (apply 'encode-time 0 (cdr (decode-time)))
-                     display-time-interval 'display-time-event-handler))
-  ;; When you get new mail, clear "Mail" from the mode line.
-  (add-hook 'rmail-after-get-new-mail-hook 'display-time-event-handler))
+  (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))))
+    (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))))
+
+
+(defvar display-time-format
+  (concat 
+   (if display-time-day-and-date
+       "%a %b %e" "")
+   (if display-time-24hr-format "%H:%m" "%-I:%M%p"))
+  "*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.")
 
 (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))
+  '((format-time-string display-time-format 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',
@@ -106,7 +134,27 @@ would give mode line times like `94/12/30 21:07:48 (UTC)'.")
 (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