master 1d5eb67c6a 2/2: Add a new user option battery-update-functions

[Lars Ingebrigtsen]

branch: master
commit 1d5eb67c6a87bcf155429b11af98de913e901dd9
Author: Lars Ingebrigtsen <larsi@gnus.org>
Commit: Lars Ingebrigtsen <larsi@gnus.org>

    Add a new user option battery-update-functions
    
    * doc/emacs/display.texi (Optional Mode Line): Document it.
    * lisp/battery.el (battery-update-functions): New user option
    (bug#55770).
    (battery-update): Use it.
---
 doc/emacs/display.texi |  4 +++-
 etc/NEWS               |  6 ++++++
 lisp/battery.el        | 43 +++++++++++++++++++++++++++++++++++++++++--
 3 files changed, 50 insertions(+), 3 deletions(-)

diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index 2fea79b2bb..16d6d5567e 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -1594,7 +1594,9 @@ charge on the mode-line, by using the command
 @code{battery-mode-line-format} determines the way the battery charge
 is displayed; the exact mode-line message depends on the operating
 system, and it usually shows the current battery charge as a
-percentage of the total charge.
+percentage of the total charge.  The functions in
+@code{battery-update-functions} are run after updating the mode line,
+and can be used to trigger actions based on the battery status.
 
 @cindex mode line, 3D appearance
 @cindex attributes of mode line, changing
diff --git a/etc/NEWS b/etc/NEWS
index 352f575bee..3870e937df 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -862,6 +862,12 @@ so automatically.
 
 * Changes in Specialized Modes and Packages in Emacs 29.1
 
+** Battery
+
++++
+*** New user option 'battery-update-functions'.
+This can be used to trigger actions based on the battery status.
+
 ** Enriched Mode
 
 +++
diff --git a/lisp/battery.el b/lisp/battery.el
index b7b81a11a1..cd68d7601f 100644
--- a/lisp/battery.el
+++ b/lisp/battery.el
@@ -232,6 +232,40 @@ The text being displayed in the echo area is controlled by 
the variables
                                    (funcall battery-status-function))
                  "Battery status not available")))
 
+(defcustom battery-update-functions nil
+  "Functions run by `display-battery-mode' after updating the status.
+These functions will be called with one parameter: An alist that
+contains data about the current battery status.  The key in the
+alist is a character, and the values in the alist are strings.
+Different battery backends deliver different information, so the
+following information may or may not be available:
+
+    v: driver-version
+    V: bios-version
+    I: bios-interface
+    L: line-status
+    B: battery-status
+    b: battery-status-symbol
+    p: load-percentage
+    s: seconds
+    m: minutes
+    h: hours
+    t: remaining-time
+
+For instance, to play an alarm when the battery power dips below
+10%, you could use a function like the following:
+
+(defvar my-prev-battery nil)
+(defun my-battery-alarm (data)
+  (when (and my-prev-battery
+             (equal (alist-get ?L data) \"off-line\")
+             (< (string-to-number (alist-get ?p data)) 10)
+             (>= (string-to-number (alist-get ?p my-prev-battery)) 10))
+    (play-sound-file \"~/alarm.wav\" 5))
+  (setq my-prev-battery data))"
+  :version "29.1"
+  :type '(repeat function))
+
 ;;;###autoload
 (define-minor-mode display-battery-mode
   "Toggle battery status display in mode line (Display Battery mode).
@@ -239,7 +273,11 @@ The text being displayed in the echo area is controlled by 
the variables
 The text displayed in the mode line is controlled by
 `battery-mode-line-format' and `battery-status-function'.
 The mode line is be updated every `battery-update-interval'
-seconds."
+seconds.
+
+The update function will call the functions in
+`battery-update-functions', which can be used to trigger actions
+based on battery events."
   :global t
   (setq battery-mode-line-string "")
   (or global-mode-string (setq global-mode-string '("")))
@@ -279,7 +317,8 @@ seconds."
             ((< percentage battery-load-low)
              (add-face-text-property 0 len 'battery-load-low t res)))
       (put-text-property 0 len 'help-echo "Battery status information" res))
-    (setq battery-mode-line-string (or res "")))
+    (setq battery-mode-line-string (or res ""))
+    (run-hook-with-args 'battery-update-functions data))
   (force-mode-line-update t))