-;;; battery.el --- display battery status information.
+;;; battery.el --- display battery status information
-;; Copyright (C) 1997, 1998 Free Software Foundation, Inc.
+;; Copyright (C) 1997, 1998, 2000, 2001 Free Software Foundation, Inc.
-;; Author: Ralph Schleicher <rs@purple.UL.BaWue.DE>
+;; Author: Ralph Schleicher <rs@nunatak.allgaeu.org>
;; Keywords: hardware
;; This file is part of GNU Emacs.
;; There is at present only a function interpreting the new `/proc/apm'
;; file format of Linux version 1.3.58 or newer. That is, what a lucky
-;; coincidence, exactly the interface provided by the author's labtop.
+;; coincidence, exactly the interface provided by the author's laptop.
;;; Code:
(require 'timer)
\f
-(defvar battery-status-function
+
+(defgroup battery nil
+ "Display battery status information."
+ :prefix "battery-"
+ :group 'hardware)
+
+(defcustom battery-status-function
(cond ((and (eq system-type 'gnu/linux)
(file-readable-p "/proc/apm"))
'battery-linux-proc-apm))
"*Function for getting battery status information.
-The function have to return an alist of conversion definitions.
-Cons cells are of the form
+The function has to return an alist of conversion definitions.
+Its cons cells are of the form
(CONVERSION . REPLACEMENT-TEXT)
CONVERSION is the character code of a \"conversion specification\"
-introduced by a `%' character in a control string.")
+introduced by a `%' character in a control string."
+ :type '(choice (const nil) function)
+ :group 'battery)
-(defvar battery-echo-area-format
+(defcustom battery-echo-area-format
(cond ((eq battery-status-function 'battery-linux-proc-apm)
"Power %L, battery %B (%p%% load, remaining time %t)"))
"*Control string formatting the string to display in the echo area.
Ordinary characters in the control string are printed as-is, while
conversion specifications introduced by a `%' character in the control
string are substituted as defined by the current value of the variable
-`battery-status-function'.")
+`battery-status-function'."
+ :type '(choice string (const nil))
+ :group 'battery)
(defvar battery-mode-line-string nil
"String to display in the mode line.")
-(defvar battery-mode-line-format
+(defcustom battery-mode-line-format
(cond ((eq battery-status-function 'battery-linux-proc-apm)
" [%b%p%%]"))
"*Control string formatting the string to display in the mode line.
Ordinary characters in the control string are printed as-is, while
conversion specifications introduced by a `%' character in the control
string are substituted as defined by the current value of the variable
-`battery-status-function'.")
+`battery-status-function'."
+ :type '(choice string (const nil))
+ :group 'battery)
-(defvar battery-update-interval 60
- "*Seconds after which the battery status will be updated.")
+(defcustom battery-update-interval 60
+ "*Seconds after which the battery status will be updated."
+ :type 'integer
+ :group 'battery)
(defvar battery-update-timer nil
"Interval timer object.")
-;;;### autoload
+;;;###autoload
(defun battery ()
"Display battery status information in the echo area.
-The text beeing displayed in the echo area is controlled by the variables
+The text being displayed in the echo area is controlled by the variables
`battery-echo-area-format' and `battery-status-function'."
(interactive)
(message "%s" (if (and battery-echo-area-format battery-status-function)
(funcall battery-status-function))
"Battery status not available")))
-;;;### autoload
+;;;###autoload
(defun display-battery ()
"Display battery status information in the mode line.
-The text beeing displayed in the mode line is controlled by the variables
+The text being displayed in the mode line is controlled by the variables
`battery-mode-line-format' and `battery-status-function'.
The mode line will be updated automatically every `battery-update-interval'
seconds."
(interactive)
(setq battery-mode-line-string "")
(or global-mode-string (setq global-mode-string '("")))
- (or (memq 'battery-mode-line-string global-mode-string)
- (setq global-mode-string (append global-mode-string
- '(battery-mode-line-string))))
+ (add-to-list 'global-mode-string 'battery-mode-line-string t)
(and battery-update-timer (cancel-timer battery-update-timer))
(setq battery-update-timer (run-at-time nil battery-update-interval
'battery-update-handler))
(defun battery-update ()
"Update battery status information in the mode line."
- (setq battery-mode-line-string (if (and battery-mode-line-format
- battery-status-function)
- (battery-format
- battery-mode-line-format
- (funcall battery-status-function))
- ""))
+ (setq battery-mode-line-string (propertize (if (and battery-mode-line-format
+ battery-status-function)
+ (battery-format
+ battery-mode-line-format
+ (funcall battery-status-function))
+ "")
+ 'help-echo "Battery status information"))
(force-mode-line-update))
\f
seconds minutes hours remaining-time buffer tem)
(unwind-protect
(save-excursion
- (setq buffer (generate-new-buffer " *battery*"))
- (buffer-disable-undo buffer)
+ (setq buffer (get-buffer-create " *battery*"))
(set-buffer buffer)
- (battery-insert-file-contents "/proc/apm")
+ (erase-buffer)
+ (insert-file-contents "/proc/apm")
(re-search-forward battery-linux-proc-apm-regexp)
(setq driver-version (match-string 1))
(setq bios-version (match-string 2))
(setq minutes (/ seconds 60)
hours (/ seconds 3600))
(setq remaining-time
- (format "%d:%02d" hours (- minutes (* 60 hours)))))))
- (and buffer (kill-buffer buffer)))
+ (format "%d:%02d" hours (- minutes (* 60 hours))))))))
(list (cons ?v (or driver-version "N/A"))
(cons ?V (or bios-version "N/A"))
(cons ?I (or bios-interface "N/A"))
(setq result (concat result "%")))
result))
-(defun battery-insert-file-contents (file-name)
- "Insert contents of file FILE-NAME after point.
-FILE-NAME can be a non-ordinary file, for example, a named pipe.
-Return t if file exists."
- (let ((load-read-function 'battery-read-function)
- (load-path '("."))
- (load-history nil))
- (save-excursion
- (load file-name nil t t))))
-
-(defun battery-read-function (&optional stream)
- "Function for reading expressions from STREAM.
-Value is always nil."
- (let (char)
- (while (not (< (setq char (get-file-char)) 0))
- (insert char))))
-
(defconst battery-hex-map '((?0 . 0) (?1 . 1) (?2 . 2) (?3 . 3)
(?4 . 4) (?5 . 5) (?6 . 6) (?7 . 7)
(?8 . 8) (?9 . 9) (?a . 10) (?b . 11)