Add 2010 to copyright years.
[bpt/emacs.git] / lisp / battery.el
index 50edc8d..fc5926e 100644 (file)
@@ -1,17 +1,17 @@
-;;; battery.el --- display battery status information
+;;; battery.el --- display battery status information  -*- coding: iso-8859-1 -*-
 
 ;; Copyright (C) 1997, 1998, 2000, 2001, 2002, 2003, 2004,
-;;   2005, 2006 Free Software Foundation, Inc.
+;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
 
 ;; Author: Ralph Schleicher <rs@nunatak.allgaeu.org>
 ;; Keywords: hardware
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 2, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
-;; There is at present support for GNU/Linux and OS X.  This library
-;; supports both the `/proc/apm' file format of Linux version 1.3.58
-;; or newer and the `/proc/acpi/' directory structure of Linux 2.4.20
-;; and 2.6.  Darwin (OS X) is supported by using the `pmset' program.
+;; There is at present support for GNU/Linux, OS X and Windows.  This
+;; library supports both the `/proc/apm' file format of Linux version
+;; 1.3.58 or newer and the `/proc/acpi/' directory structure of Linux
+;; 2.4.20 and 2.6.  Darwin (OS X) is supported by using the `pmset'
+;; program.  Windows is supported by the GetSystemPowerStatus API call.
 
 ;;; Code:
 
        ((and (eq system-type 'gnu/linux)
              (file-directory-p "/proc/acpi/battery"))
         'battery-linux-proc-acpi)
+       ((and (eq system-type 'gnu/linux)
+             (file-directory-p "/sys/class/power_supply/")
+             (directory-files "/sys/class/power_supply/" nil "BAT[0-9]$"))
+        'battery-linux-sysfs)
        ((and (eq system-type 'darwin)
-             (condition-case nil  
-                 (with-temp-buffer 
+             (condition-case nil
+                 (with-temp-buffer
                    (and (eq (call-process "pmset" nil t nil "-g" "ps") 0)
                         (> (buffer-size) 0)))
                (error nil)))
-        'battery-pmset))
-  "*Function for getting battery status information.
+        'battery-pmset)
+       ((eq system-type 'windows-nt)
+        'w32-battery-status))
+  "Function for getting battery status information.
 The function has to return an alist of conversion definitions.
 Its cons cells are of the form
 
@@ -67,13 +72,15 @@ introduced by a `%' character in a control string."
   :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)")
-       ((eq battery-status-function 'battery-linux-proc-acpi)
+  (cond ((eq battery-status-function 'battery-linux-proc-acpi)
         "Power %L, battery %B at %r (%p%% load, remaining time %t)")
+       ((eq battery-status-function 'battery-linux-sysfs)
+        "Power %L, battery %B (%p%% load)")
        ((eq battery-status-function 'battery-pmset)
-        "%L power, battery %B (%p%% load, remaining time %t)"))
-  "*Control string formatting the string to display in the echo area.
+        "%L power, battery %B (%p%% load, remaining time %t)")
+       (battery-status-function
+        "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
@@ -97,13 +104,11 @@ string are substituted as defined by the current value of the variable
 ;;;###autoload (put 'battery-mode-line-string 'risky-local-variable t)
 
 (defcustom battery-mode-line-format
-  (cond ((eq battery-status-function 'battery-linux-proc-apm)
-        "[%b%p%%]")
-       ((eq battery-status-function 'battery-linux-proc-acpi)
+  (cond ((eq battery-status-function 'battery-linux-proc-acpi)
         "[%b%p%%,%d°C]")
-       ((eq battery-status-function 'battery-pmset)
+       (battery-status-function
         "[%b%p%%]"))
-  "*Control string formatting the string to display in the mode line.
+  "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
@@ -123,18 +128,18 @@ string are substituted as defined by the current value of the variable
   :group 'battery)
 
 (defcustom battery-update-interval 60
-  "*Seconds after which the battery status will be updated."
+  "Seconds after which the battery status will be updated."
   :type 'integer
   :group 'battery)
 
 (defcustom battery-load-low 25
-  "*Upper bound of low battery load percentage.
+  "Upper bound of low battery load percentage.
 A battery load percentage below this number is considered low."
   :type 'integer
   :group 'battery)
 
 (defcustom battery-load-critical 10
-  "*Upper bound of critical battery load percentage.
+  "Upper bound of critical battery load percentage.
 A battery load percentage below this number is considered critical."
   :type 'integer
   :group 'battery)
@@ -277,7 +282,7 @@ The following %-sequences are provided:
 
 (defun battery-linux-proc-acpi ()
   "Get ACPI status information from Linux kernel.
-This function works only with the new `/proc/acpi/' format introduced
+This function works only with the `/proc/acpi/' format introduced
 in Linux version 2.4.20 and 2.6.0.
 
 The following %-sequences are provided:
@@ -355,45 +360,21 @@ The following %-sequences are provided:
                                   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))))
+         (cons ?L (or (battery-search-for-one-match-in-files
+                       (mapcar (lambda (e) (concat e "/state"))
+                               (ignore-errors
+                                 (directory-files "/proc/acpi/ac_adapter/"
+                                                  t "\\`[^.]")))
+                       "state: +\\(.*\\)$" 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))))
-                      (when (file-exists-p
-                             "/proc/acpi/thermal_zone/THM0/temperature")
-                        (with-temp-buffer
-                          (insert-file-contents
-                           "/proc/acpi/thermal_zone/THM0/temperature")
-                          (when (re-search-forward
-                                 "temperature: +\\([0-9]+\\) C$" nil t)
-                            (match-string 1))))
-                      (when (file-exists-p
-                             "/proc/acpi/thermal_zone/THR2/temperature")
-                        (with-temp-buffer
-                          (insert-file-contents
-                           "/proc/acpi/thermal_zone/THR2/temperature")
-                          (when (re-search-forward
-                                 "temperature: +\\([0-9]+\\) C$" nil t)
-                            (match-string 1))))
+         (cons ?d (or (battery-search-for-one-match-in-files
+                       (mapcar (lambda (e) (concat e "/temperature"))
+                               (ignore-errors
+                                 (directory-files "/proc/acpi/thermal_zone/"
+                                                  t "\\`[^.]")))
+                       "temperature: +\\([0-9]+\\) C$" 1)
+
                       "N/A"))
          (cons ?r (or (and rate (concat (number-to-string rate) " "
                                         rate-type)) "N/A"))
@@ -408,12 +389,92 @@ The following %-sequences are provided:
                            (format "%d:%02d" hours (- minutes (* 60 hours))))
                       "N/A"))
          (cons ?p (or (and full-capacity capacity
+                           (> full-capacity 0)
                            (number-to-string
                             (floor (/ capacity
                                       (/ (float full-capacity) 100)))))
                       "N/A")))))
 
 \f
+;;; `/sys/class/power_supply/BATN' interface for Linux.
+
+(defun battery-linux-sysfs ()
+  "Get ACPI status information from Linux kernel.
+This function works only with the new `/sys/class/power_supply/'
+format introduced in Linux version 2.4.25.
+
+The following %-sequences are provided:
+%c Current capacity (mAh or mWh)
+%B Battery status (verbose)
+%p Battery load percentage
+%L AC line status (verbose)"
+  (let (charging-state
+       (charge-full 0.0)
+       (charge-now 0.0)
+       (energy-full 0.0)
+       (energy-now 0.0))
+    ;; SysFS provides information about each battery present in the
+    ;; system in a separate subdirectory.  We are going to merge the
+    ;; available information together.
+    (with-temp-buffer
+      (dolist (dir (ignore-errors
+                   (directory-files
+                    "/sys/class/power_supply/" t "BAT[0-9]$")))
+       (erase-buffer)
+       (ignore-errors (insert-file-contents
+                       (expand-file-name "uevent" dir)))
+       (when (re-search-forward "POWER_SUPPLY_PRESENT=1$" nil t)
+         (goto-char (point-min))
+         (and (re-search-forward "POWER_SUPPLY_STATUS=\\(.*\\)$" nil t)
+              (member charging-state '("Unknown" "Full" nil))
+              (setq charging-state (match-string 1)))
+         (let (full-string now-string)
+           ;; Sysfs may list either charge (mAh) or energy (mWh).
+           ;; Keep track of both, and choose which to report later.
+           (cond ((and (re-search-forward
+                        "POWER_SUPPLY_CHARGE_FULL=\\([0-9]*\\)$" nil t)
+                       (setq full-string (match-string 1))
+                       (re-search-forward
+                        "POWER_SUPPLY_CHARGE_NOW=\\([0-9]*\\)$" nil t)
+                       (setq now-string (match-string 1)))
+                  (setq charge-full (+ charge-full
+                                       (string-to-number full-string))
+                        charge-now  (+ charge-now
+                                       (string-to-number now-string))))
+                 ((and (re-search-forward
+                        "POWER_SUPPLY_ENERGY_FULL=\\([0-9]*\\)$" nil t)
+                       (setq full-string (match-string 1))
+                       (re-search-forward
+                        "POWER_SUPPLY_ENERGY_NOW=\\([0-9]*\\)$" nil t)
+                       (setq now-string (match-string 1)))
+                  (setq energy-full (+ energy-full
+                                       (string-to-number full-string))
+                        energy-now  (+ energy-now
+                                       (string-to-number now-string)))))))))
+    (list (cons ?c (cond ((or (> charge-full 0) (> charge-now 0))
+                         (number-to-string charge-now))
+                        ((or (> energy-full 0) (> energy-now 0))
+                         (number-to-string energy-now))
+                        (t "N/A")))
+         (cons ?B (or charging-state "N/A"))
+         (cons ?p (cond ((> charge-full 0)
+                         (format "%.1f"
+                                 (/ (* 100 charge-now) charge-full)))
+                        ((> energy-full 0)
+                         (format "%.1f"
+                                 (/ (* 100 energy-now) energy-full)))
+                        (t "N/A")))
+         (cons ?L (if (file-readable-p "/sys/class/power_supply/AC/online")
+                      (if (battery-search-for-one-match-in-files
+                           (list "/sys/class/power_supply/AC/online"
+                                 "/sys/class/power_supply/ACAD/online")
+                           "1" 0)
+                          "AC"
+                        "BAT")
+                    "N/A")))))
+
+
+\f
 ;;; `pmset' interface for Darwin (OS X).
 
 (defun battery-pmset ()
@@ -478,6 +539,17 @@ The following %-sequences are provided:
         (or (cdr (assoc char alist)) ""))))
    format t t))
 
+(defun battery-search-for-one-match-in-files (files regexp match-num)
+  "Search REGEXP in the content of the files listed in FILES.
+If a match occurred, return the parenthesized expression numbered by
+MATCH-NUM in the match.  Otherwise, return nil."
+  (with-temp-buffer
+    (catch 'found
+      (dolist (file files)
+       (and (ignore-errors (insert-file-contents file nil nil nil 'replace))
+            (re-search-forward regexp nil t)
+            (throw 'found (match-string match-num)))))))
+
 \f
 (provide 'battery)