(battery-linux-proc-acpi): Look into battery
[bpt/emacs.git] / lisp / battery.el
index ccafa8b..3b44ff8 100644 (file)
@@ -1,6 +1,6 @@
-;;; battery.el --- display battery status information.
+;;; battery.el --- display battery status information
 
-;; Copyright (C) 1997, 1998, 2000 Free Software Foundation, Inc.
+;; Copyright (C) 1997, 1998, 2000, 2001, 2003 Free Software Foundation, Inc.
 
 ;; Author: Ralph Schleicher <rs@nunatak.allgaeu.org>
 ;; Keywords: hardware
@@ -24,9 +24,9 @@
 
 ;;; Commentary:
 
-;; 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.
+;; There is at present support for interpreting the new `/proc/apm'
+;; file format of Linux version 1.3.58 or newer and for the `/proc/acpi/'
+;; directory structure of Linux 2.4.20 and 2.6.
 
 ;;; Code:
 
 (defcustom battery-status-function
   (cond ((and (eq system-type 'gnu/linux)
              (file-readable-p "/proc/apm"))
-        'battery-linux-proc-apm))
+        'battery-linux-proc-apm)
+       ((and (eq system-type 'gnu/linux)
+             (file-directory-p "/proc/acpi/battery"))
+        'battery-linux-proc-acpi))
   "*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."
-  :type 'function
+  :type '(choice (const nil) function)
   :group 'battery)
 
 (defcustom battery-echo-area-format
   (cond ((eq battery-status-function 'battery-linux-proc-apm)
-        "Power %L, battery %B (%p%% load, remaining time %t)"))
+        "Power %L, battery %B (%p%% load, remaining time %t)")
+       ((eq battery-status-function 'battery-linux-proc-acpi)
+        "Power %L, battery %B at %r (%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
@@ -70,7 +75,9 @@ string are substituted as defined by the current value of the variable
 
 (defcustom battery-mode-line-format
   (cond ((eq battery-status-function 'battery-linux-proc-apm)
-        " [%b%p%%]"))
+        " [%b%p%%]")
+       ((eq battery-status-function 'battery-linux-proc-acpi)
+        " [%b%p%%,%d°C]"))
   "*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
@@ -120,12 +127,13 @@ seconds."
 
 (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
@@ -170,7 +178,7 @@ The following %-sequences are provided:
          (setq buffer (get-buffer-create " *battery*"))
          (set-buffer buffer)
          (erase-buffer)
-         (battery-insert-file-contents "/proc/apm")
+         (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))
@@ -217,6 +225,123 @@ The following %-sequences are provided:
          (cons ?t (or remaining-time "N/A")))))
 
 \f
+;;; `/proc/acpi/' interface for Linux.
+
+(defun battery-linux-proc-acpi ()
+  "Get ACPI status information from Linux kernel.
+This function works only with the new `/proc/acpi/' format introduced
+in Linux version 2.4.20 and 2.6.0.
+
+The following %-sequences are provided:
+%c Current capacity (mAh)
+%B Battery status (verbose)
+%b Battery status, empty means high, `-' means low,
+   `!' means critical, and `+' means charging
+%d Temperature (in degrees Celsius)
+%L AC line status (verbose)
+%p battery load percentage
+%m Remaining time in minutes
+%h Remaining time in hours
+%t Remaining time in the form `h:min'"
+  (let (capacity design-capacity rate rate-type charging-state warn low
+                minutes hours)
+    (when (file-directory-p "/proc/acpi/battery/")
+      ;; ACPI provides information about each battery present in the system in
+      ;; a separate subdirectory.  We are going to merge the available
+      ;; information together since displaying for a variable amount of
+      ;; batteries seems overkill for format-strings.
+      (mapc
+       (lambda (dir)
+        (with-temp-buffer
+          (insert-file-contents (expand-file-name "state" dir))
+          (when (re-search-forward "present: +yes$" nil t)
+            (and (re-search-forward "charging state: +\\(.*\\)$" nil t)
+                 (or (null charging-state) (string= charging-state
+                                                    "unknown"))
+                 ;; On most multi-battery systems, most of the time only one
+                 ;; battery is "charging"/"discharging", the others are
+                 ;; "unknown".
+                 (setq charging-state (match-string 1)))
+            (when (re-search-forward "present rate: +\\([0-9]+\\) \\(m[AW]\\)$"
+                                     nil t)
+              (setq rate (+ (or rate 0) (string-to-int (match-string 1)))
+                    rate-type (or (and rate-type
+                                       (if (string= rate-type (match-string 2))
+                                           rate-type
+                                         (error
+                                          "Inconsistent rate types (%s vs. %s)"
+                                          rate-type (match-string 2))))
+                                  (match-string 2))))
+            (when (re-search-forward "remaining capacity: +\\([0-9]+\\) m[AW]h$"
+                                     nil t)
+              (setq capacity
+                    (+ (or capacity 0) (string-to-int (match-string 1))))))
+          (goto-char (point-max))
+          (insert-file-contents (expand-file-name "info" dir))
+          (when (re-search-forward "present: +yes$" nil t)
+            (when (re-search-forward "design capacity: +\\([0-9]+\\) m[AW]h$"
+                                     nil t)
+              (setq design-capacity (+ (or design-capacity 0)
+                                       (string-to-int (match-string 1)))))
+            (when (re-search-forward "design capacity warning: +\\([0-9]+\\) m[AW]h$"
+                                     nil t)
+              (setq warn (+ (or warn 0) (string-to-int (match-string 1)))))
+            (when (re-search-forward "design capacity low: +\\([0-9]+\\) m[AW]h$"
+                                     nil t)
+              (setq low (+ (or low 0)
+                           (string-to-int (match-string 1))))))))
+       (directory-files "/proc/acpi/battery/" t "\\(BAT\\|CMB\\)")))
+    (and capacity rate
+        (setq minutes (if (zerop rate) 0
+                        (floor (* (/ (float (if (string= charging-state
+                                                         "charging")
+                                                (- design-capacity capacity)
+                                              capacity)) rate) 60)))
+              hours (/ minutes 60)))
+    (list (cons ?c (or (and capacity (number-to-string capacity)) "N/A"))
+         (cons ?L (or (when (file-exists-p "/proc/acpi/ac_adapter/AC/state")
+                        (with-temp-buffer
+                          (insert-file-contents
+                           "/proc/acpi/ac_adapter/AC/state")
+                          (when (re-search-forward "state: +\\(.*\\)$" nil t)
+                            (match-string 1))))
+                      "N/A"))
+         (cons ?d (or (when (file-exists-p
+                             "/proc/acpi/thermal_zone/THRM/temperature")
+                        (with-temp-buffer
+                          (insert-file-contents
+                           "/proc/acpi/thermal_zone/THRM/temperature")
+                          (when (re-search-forward
+                                 "temperature: +\\([0-9]+\\) C$" nil t)
+                            (match-string 1))))
+                      (when (file-exists-p
+                             "/proc/acpi/thermal_zone/THM/temperature")
+                        (with-temp-buffer
+                          (insert-file-contents
+                           "/proc/acpi/thermal_zone/THM/temperature")
+                          (when (re-search-forward
+                                 "temperature: +\\([0-9]+\\) C$" nil t)
+                            (match-string 1))))
+                      "N/A"))
+         (cons ?r (or (and rate (concat (number-to-string rate) " "
+                                        rate-type)) "N/A"))
+         (cons ?B (or charging-state "N/A"))
+         (cons ?b (or (and (string= charging-state "charging") "+")
+                      (and low (< capacity low) "!")
+                      (and warn (< capacity warn) "-")
+                      ""))
+         (cons ?h (or (and hours (number-to-string hours)) "N/A"))
+         (cons ?m (or (and minutes (number-to-string minutes)) "N/A"))
+         (cons ?t (or (and minutes
+                           (format "%d:%02d" hours (- minutes (* 60 hours))))
+                      "N/A"))
+         (cons ?p (or (and design-capacity capacity
+                           (number-to-string
+                            (floor (/ capacity
+                                      (/ (float design-capacity) 100)))))
+                      "N/A")))))
+
+\f
 ;;; Private functions.
 
 (defun battery-format (format alist)
@@ -241,24 +366,6 @@ The following %-sequences are provided:
        (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-source-file-function nil)
-       (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)
@@ -288,4 +395,5 @@ Value is always nil."
 \f
 (provide 'battery)
 
+;;; arch-tag: 65916f50-4754-4b6b-ac21-0b510f545a37
 ;;; battery.el ends here