time.el 21.4 KB
Newer Older
Dave Love's avatar
Dave Love committed
1
;;; time.el --- display time, load and mail indicator in mode line of Emacs -*-coding: utf-8 -*-
2

3
;; Copyright (C) 1985-1987, 1993-1994, 1996, 2000-2012
4
;;   Free Software Foundation, Inc.
5 6 7 8 9

;; Maintainer: FSF

;; This file is part of GNU Emacs.

10
;; GNU Emacs is free software: you can redistribute it and/or modify
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
14 15 16 17 18 19 20

;; 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
21
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
22 23 24 25

;;; Commentary:

;; Facilities to display current time/date and a new-mail indicator
26 27 28 29
;; in the Emacs mode line.  The entry point is `display-time'.

;; Display time world in a buffer, the entry point is
;; `display-time-world'.
30 31 32 33 34

;;; Code:

(defgroup display-time nil
  "Display time and load in mode line of Emacs."
35
  :group 'mode-line
36 37 38 39
  :group 'mail)


(defcustom display-time-mail-file nil
Lute Kamstra's avatar
Lute Kamstra committed
40
  "File name of mail inbox file, for indicating existence of new mail.
41
Non-nil and not a string means don't check for mail; nil means use
42
default, which is system-dependent, and is the same as used by Rmail."
43
  :type '(choice (const :tag "None" none)
44 45 46 47
		 (const :tag "Default" nil)
		 (file :format "%v"))
  :group 'display-time)

48
(defcustom display-time-mail-directory nil
Lute Kamstra's avatar
Lute Kamstra committed
49
  "Name of mail inbox directory, for indicating existence of new mail.
50 51
Any nonempty regular file in the directory is regarded as newly arrived mail.
If nil, do not check a directory for arriving mail."
52 53 54 55
  :type '(choice (const :tag "None" nil)
		 (directory :format "%v"))
  :group 'display-time)

56
(defcustom display-time-mail-function nil
Lute Kamstra's avatar
Lute Kamstra committed
57
  "Function to call, for indicating existence of new mail.
58 59 60
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."
61 62 63 64
  :type '(choice (const :tag "Default" nil)
		 (function))
  :group 'display-time)

65
(defcustom display-time-default-load-average 0
Lute Kamstra's avatar
Lute Kamstra committed
66
  "Which load average value will be shown in the mode line.
67 68
Almost every system can provide values of load for the past 1 minute,
past 5 or past 15 minutes.  The default is to display 1-minute load average.
69 70 71 72
The value can be one of:

  0   => 1 minute load
  1   => 5 minutes load
73 74
  2   => 15 minutes load
  nil => None (do not display the load average)"
75 76
  :type '(choice (const :tag "1 minute load" 0)
		 (const :tag "5 minutes load" 1)
77 78
		 (const :tag "15 minutes load" 2)
		 (const :tag "None" nil))
79 80
  :group 'display-time)

81
(defvar display-time-load-average nil
82 83 84 85
  "Value of the system's load average currently shown on the mode line.
See `display-time-default-load-average'.

This is an internal variable; setting it has no effect.")
86 87

(defcustom display-time-load-average-threshold 0.1
Lute Kamstra's avatar
Lute Kamstra committed
88
  "Load-average values below this value won't be shown in the mode line."
89 90
  :type 'number
  :group 'display-time)
91

92 93
;;;###autoload
(defcustom display-time-day-and-date nil "\
94
Non-nil means \\[display-time] should display day and date as well as time."
95 96 97 98 99 100
  :type 'boolean
  :group 'display-time)

(defvar display-time-timer nil)

(defcustom display-time-interval 60
Lute Kamstra's avatar
Lute Kamstra committed
101
  "Seconds between updates of time in the mode line."
102 103 104 105
  :type 'integer
  :group 'display-time)

(defcustom display-time-24hr-format nil
Lute Kamstra's avatar
Lute Kamstra committed
106
  "Non-nil indicates time should be displayed as hh:mm, 0 <= hh <= 23.
107
A value of nil means 1 <= hh <= 12, and an AM/PM suffix is used."
108 109 110 111
  :type 'boolean
  :group 'display-time)

(defvar display-time-string nil)
112
;;;###autoload(put 'display-time-string 'risky-local-variable t)
113 114

(defcustom display-time-hook nil
Lute Kamstra's avatar
Lute Kamstra committed
115
  "List of functions to be called when the time is updated on the mode line."
116 117 118 119 120 121 122
  :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.")

123
(defcustom zoneinfo-style-world-list
124 125 126 127 128 129
  '(("America/Los_Angeles" "Seattle")
    ("America/New_York" "New York")
    ("Europe/London" "London")
    ("Europe/Paris" "Paris")
    ("Asia/Calcutta" "Bangalore")
    ("Asia/Tokyo" "Tokyo"))
130 131 132 133 134 135 136 137 138 139 140 141 142
  "Alist of zoneinfo-style time zones and places for `display-time-world'.
Each element has the form (TIMEZONE LABEL).
TIMEZONE should be a string of the form AREA/LOCATION, where AREA is
the name of a region -- a continent or ocean, and LOCATION is the name
of a specific location, e.g., a city, within that region.
LABEL is a string to display as the label of that TIMEZONE's time."
  :group 'display-time
  :type '(repeat (list string string))
  :version "23.1")

(defcustom legacy-style-world-list
  '(("PST8PDT" "Seattle")
    ("EST5EDT" "New York")
143
    ("GMT0BST" "London")
144
    ("CET-1CDT" "Paris")
145 146
    ("IST-5:30" "Bangalore")
    ("JST-9" "Tokyo"))
147 148 149 150 151 152 153 154 155 156 157 158 159 160
  "Alist of traditional-style time zones and places for `display-time-world'.
Each element has the form (TIMEZONE LABEL).
TIMEZONE should be a string of the form:

     std[+|-]offset[dst[offset][,date[/time],date[/time]]]

See the documentation of the TZ environment variable on your system,
for more details about the format of TIMEZONE.
LABEL is a string to display as the label of that TIMEZONE's time."
  :group 'display-time
  :type '(repeat (list string string))
  :version "23.1")

(defcustom display-time-world-list
161 162
  ;; Determine if zoneinfo style timezones are supported by testing that
  ;; America/New York and Europe/London return different timezones.
163 164 165 166 167 168 169 170 171
  (let ((old-tz (getenv "TZ"))
	gmt nyt)
    (unwind-protect
	(progn
	  (setenv "TZ" "America/New_York")
	  (setq nyt (format-time-string "%z"))
	  (setenv "TZ" "Europe/London")
	  (setq gmt (format-time-string "%z")))
      (setenv "TZ" old-tz))
172 173 174
    (if (string-equal nyt gmt)
        legacy-style-world-list
      zoneinfo-style-world-list))
175
  "Alist of time zones and places for `display-time-world' to display.
176
Each element has the form (TIMEZONE LABEL).
177 178 179 180
TIMEZONE should be in a format supported by your system.  See the
documentation of `zoneinfo-style-world-list' and
\`legacy-style-world-list' for two widely used formats.  LABEL is
a string to display as the label of that TIMEZONE's time."
181 182 183 184
  :group 'display-time
  :type '(repeat (list string string))
  :version "23.1")

185
(defcustom display-time-world-time-format "%A %d %B %R %Z"
186 187 188 189 190 191
  "Format of the time displayed, see `format-time-string'."
  :group 'display-time
  :type 'string
  :version "23.1")

(defcustom display-time-world-buffer-name "*wclock*"
192
  "Name of the world clock buffer."
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
  :group 'display-time
  :type 'string
  :version "23.1")

(defcustom display-time-world-timer-enable t
  "If non-nil, a timer will update the world clock."
  :group 'display-time
  :type 'boolean
  :version "23.1")

(defcustom display-time-world-timer-second 60
  "Interval in seconds for updating the world clock."
  :group 'display-time
  :type 'integer
  :version "23.1")

(defvar display-time-world-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map "q" 'kill-this-buffer)
    map)
213
  "Keymap of Display Time World mode.")
214

215 216 217 218 219 220 221 222 223 224
;;;###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))

Dave Love's avatar
Dave Love committed
225 226 227 228 229 230
;; This business used to be simpler when all mode lines had the same
;; face and the image could just be pbm.  Now we try to rely on an xpm
;; image with a transparent background.  Otherwise, set the background
;; for pbm.

(defcustom display-time-mail-face nil
231
  "Face to use for `display-time-mail-string'.
Dave Love's avatar
Dave Love committed
232
If `display-time-use-mail-icon' is non-nil, the image's
233 234
background color is the background of this face.  Set this to
make the mail indicator stand out on a color display."
235
  :group 'mode-line-faces
236
  :group 'display-time
237
  :version "22.1"
Dave Love's avatar
Dave Love committed
238
  :type '(choice (const :tag "None" nil) face))
239 240

(defvar display-time-mail-icon
241
  (find-image '((:type xpm :file "letter.xpm" :ascent center)
Dave Love's avatar
Dave Love committed
242 243 244
		(:type pbm :file "letter.pbm" :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'.")
245

Dave Love's avatar
Dave Love committed
246
;; Fixme: Default to icon on graphical display?
247
(defcustom display-time-use-mail-icon nil
248
  "Non-nil means use an icon as mail indicator on a graphic display.
Dave Love's avatar
Dave Love committed
249 250
Otherwise use `display-time-mail-string'.  The icon may consume less
of the mode line.  It is specified by `display-time-mail-icon'."
251 252 253
  :group 'display-time
  :type 'boolean)

Dave Love's avatar
Dave Love committed
254 255 256 257 258
;; Fixme: maybe default to the character if we can display Unicode.
(defcustom display-time-mail-string "Mail"
  "String to use as the mail indicator in `display-time-string-forms'.
This can use the Unicode letter character if you can display it."
  :group 'display-time
259
  :version "22.1"
Dave Love's avatar
Dave Love committed
260 261 262 263 264 265
  :type '(choice (const "Mail")
		 ;; Use :tag here because the Lucid menu won't display
		 ;; multibyte text.
		 (const :tag "Unicode letter character" "")
		 string))

266
(defcustom display-time-format nil
Lute Kamstra's avatar
Lute Kamstra committed
267
  "String specifying format for displaying the time in the mode line.
268 269 270 271 272 273 274 275 276 277 278
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)
      "")
279 280 281 282
    (propertize
     (format-time-string (or display-time-format
			     (if display-time-24hr-format "%H:%M" "%-I:%M%p"))
			 now)
283
     'help-echo (format-time-string "%a %b %e, %Y" now))
284 285 286
    load
    (if mail
	;; Build the string every time to act on customization.
Dave Love's avatar
Dave Love committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
	;; :set-after doesn't help for `customize-option'.  I think it
	;; should.
	(concat
	 " "
	 (propertize
	  display-time-mail-string
	  'display `(when (and display-time-use-mail-icon
			       (display-graphic-p))
		      ,@display-time-mail-icon
		      ,@(if (and display-time-mail-face
				 (memq (plist-get (cdr display-time-mail-icon)
						  :type)
				       '(pbm xbm)))
			    (let ((bg (face-attribute display-time-mail-face
						      :background)))
			      (if (stringp bg)
				  (list :background bg)))))
	  'face display-time-mail-face
	  'help-echo "You have new mail; mouse-2: Read mail"
306
	  'mouse-face 'mode-line-highlight
Dave Love's avatar
Dave Love committed
307 308
	  'local-map (make-mode-line-mouse-map 'mouse-2
					       read-mail-command)))
309
      ""))
Lute Kamstra's avatar
Lute Kamstra committed
310
  "List of expressions governing display of the time in the mode line.
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
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)))))

355
(defun display-time-next-load-average ()
Glenn Morris's avatar
Glenn Morris committed
356 357
  "Switch between different load averages in the mode line.
Switches from the 1 to 5 to 15 minute load average, and then back to 1."
358 359 360 361 362 363
  (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))

364 365 366 367 368 369 370 371 372 373 374 375 376
(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)))

377
(with-no-warnings
Paul Eggert's avatar
Paul Eggert committed
378
  ;; Warnings are suppressed to avoid "global/dynamic var `X' lacks a prefix".
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
  (defvar now)
  (defvar time)
  (defvar load)
  (defvar mail)
  (defvar 24-hours)
  (defvar hour)
  (defvar 12-hours)
  (defvar am-pm)
  (defvar minutes)
  (defvar seconds)
  (defvar time-zone)
  (defvar day)
  (defvar year)
  (defvar monthname)
  (defvar month)
  (defvar dayname))

396
(defun display-time-update ()
Dave Love's avatar
Dave Love committed
397 398 399 400 401
  "Update the display-time info for the mode line.
However, 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."
402 403
  (let* ((now (current-time))
	 (time (current-time-string now))
404 405 406 407 408 409 410 411 412 413
         (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.
Dave Love's avatar
Dave Love committed
414 415 416
		       (let ((str (format " %03d"
					  (nth display-time-load-average
					       (load-average)))))
417 418
			 (propertize
			  (concat (substring str 0 -2) "." (substring str -2))
Dave Love's avatar
Dave Love committed
419 420
			  'local-map (make-mode-line-mouse-map
				      'mouse-2 'display-time-next-load-average)
421
			  'mouse-face 'mode-line-highlight
Dave Love's avatar
Dave Love committed
422 423 424 425 426 427 428 429
			  '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"))))
430
		   (error ""))))
431 432 433 434
         (mail-spool-file (or display-time-mail-file
                              (getenv "MAIL")
                              (concat rmail-spool-directory
                                      (user-login-name))))
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
	 (mail (cond
		(display-time-mail-function
		 (funcall display-time-mail-function))
		(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)))))))
460
         (24-hours (substring time 11 13))
461
         (hour (string-to-number 24-hours))
462 463 464 465 466 467
         (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))
Paul Eggert's avatar
Paul Eggert committed
468
         (year (format-time-string "%Y" now))
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
         (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)
486 487
  (let ((remote-file-name-inhibit-cache (- display-time-interval 5)))
    (and (file-exists-p file)
488
	 (< 0 (nth 7 (file-attributes file nil t))))))
489

490 491 492
;;;###autoload
(define-minor-mode display-time-mode
  "Toggle display of time, load level, and mail flag in mode lines.
493 494 495 496 497 498 499 500 501
With a prefix argument ARG, enable Display Time mode if ARG is
positive, and disable it otherwise.  If called from Lisp, enable
it if ARG is omitted or nil.

When Display Time mode is enabled, it updates every minute (you
can control the number of seconds between updates by customizing
`display-time-interval').  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."
502
  :global t :group 'display-time
503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
  (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)))
524

525

526
(define-derived-mode display-time-world-mode nil "World clock"
527 528
  "Major mode for buffer that displays times in various time zones.
See `display-time-world'."
529
  (setq show-trailing-whitespace nil))
530 531 532 533

(defun display-time-world-display (alist)
  "Replace current buffer text with times in various zones, based on ALIST."
  (let ((inhibit-read-only t)
534 535 536 537
	(buffer-undo-list t)
	(old-tz (getenv "TZ"))
	(max-width 0)
	result fmt)
538
    (erase-buffer)
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
    (unwind-protect
	(dolist (zone alist)
	  (let* ((label (cadr zone))
		 (width (string-width label)))
	    (setenv "TZ" (car zone))
	    (push (cons label
			(format-time-string display-time-world-time-format))
		  result)
	    (when (> width max-width)
	      (setq max-width width))))
      (setenv "TZ" old-tz))
    (setq fmt (concat "%-" (int-to-string max-width) "s %s\n"))
    (dolist (timedata (nreverse result))
      (insert (format fmt (car timedata) (cdr timedata)))))
  (delete-char -1))
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577

;;;###autoload
(defun display-time-world ()
  "Enable updating display of times in various time zones.
`display-time-world-list' specifies the zones.
To turn off the world time display, go to that window and type `q'."
  (interactive)
  (when (and display-time-world-timer-enable
             (not (get-buffer display-time-world-buffer-name)))
    (run-at-time t display-time-world-timer-second 'display-time-world-timer))
  (with-current-buffer (get-buffer-create display-time-world-buffer-name)
    (display-time-world-display display-time-world-list))
  (pop-to-buffer display-time-world-buffer-name)
  (fit-window-to-buffer)
  (display-time-world-mode))

(defun display-time-world-timer ()
  (if (get-buffer display-time-world-buffer-name)
      (with-current-buffer (get-buffer display-time-world-buffer-name)
        (display-time-world-display display-time-world-list))
    ;; cancel timer
    (let ((list timer-list))
      (while list
        (let ((elt (pop list)))
578 579
          (when (equal (symbol-name (timer--function elt))
		       "display-time-world-timer")
580 581
            (cancel-timer elt)))))))

582
;;;###autoload
583 584 585 586
(defun emacs-uptime (&optional format)
  "Return a string giving the uptime of this instance of Emacs.
FORMAT is a string to format the result, using `format-seconds'.
For example, the Unix uptime command format is \"%D, %z%2h:%.2m\"."
587 588
  (interactive)
  (let ((str
589
         (format-seconds (or format "%Y, %D, %H, %M, %z%S")
590
                         (float-time
591
                          (time-subtract (current-time) before-init-time)))))
592
    (if (called-interactively-p 'interactive)
593 594 595
        (message "%s" str)
      str)))

Juri Linkov's avatar
Juri Linkov committed
596 597 598 599 600
;;;###autoload
(defun emacs-init-time ()
  "Return a string giving the duration of the Emacs initialization."
  (interactive)
  (let ((str
601
	 (format "%.1f seconds"
602
		 (float-time
603
		  (time-subtract after-init-time before-init-time)))))
604
    (if (called-interactively-p 'interactive)
Juri Linkov's avatar
Juri Linkov committed
605 606 607
        (message "%s" str)
      str)))

608 609 610
(provide 'time)

;;; time.el ends here