Add :set attribute to winner-dont-bind-my-keys

* lisp/winner.el (winner--set-dont-bind-my-keys): New function.
(winner-dont-bind-my-keys): Allow setting with setopt.
(winner-mode-map): Use defvar-keymap.
* test/lisp/winner-tests.el: New file.

(cherry picked from commit 33cc5427cbec224d55fac9d76b7c2978fdd5034b)

diff --git a/lisp/winner.el b/lisp/winner.el
index fa1d53b5b6fad6ad8f50b85f93b0357dc71ea028..4e314cc1b1189706a1a4f12d4d0f4830dbd9d286 100644 (file)
--- a/lisp/winner.el
+++ b/lisp/winner.el
@@ -24,11 +24,11 @@
 ;;; Commentary:
 
 ;; Winner mode is a global minor mode that records the changes in the
-;; window configuration (i.e. how the frames are partitioned into
-;; windows) so that the changes can be "undone" using the command
-;; `winner-undo'.  By default this one is bound to the key sequence
-;; ctrl-c left.  If you change your mind (while undoing), you can
-;; press ctrl-c right (calling `winner-redo').
+;; window configuration (in other words, how the frames are partitioned
+;; into windows), so that the changes can be "undone" using the command
+;; `winner-undo'.  By default, it is bound to the key sequence `C-c
+;; <left>'.  If you change your mind (while undoing), you can press
+;; `C-c <right>' (`winner-redo').
 
 ;;; Code:
 
@@ -44,9 +44,21 @@
   "Restoring window configurations."
   :group 'windows)
 
+(defun winner--set-dont-bind-my-keys (symbol value)
+  (defvar winner-mode-map)
+  (when (boundp 'winner-mode-map)
+    (if value
+        (progn (keymap-unset winner-mode-map "C-c <left>")
+               (keymap-unset winner-mode-map "C-c <left>"))
+      ;; Default bindings.
+      (keymap-set winner-mode-map "C-c <left>" #'winner-undo)
+      (keymap-set winner-mode-map "C-c <right>" #'winner-redo)))
+  (set-default symbol value))
+
 (defcustom winner-dont-bind-my-keys nil
-  "Non-nil means do not bind keys in Winner mode."
-  :type 'boolean)
+  "Non-nil means do not bind default keys in Winner mode."
+  :type 'boolean
+  :set #'winner--set-dont-bind-my-keys)
 
 (defcustom winner-ring-size 200
   "Maximum number of stored window configurations per frame."
@@ -321,13 +333,9 @@ You may want to include buffer names such as *Help*, *Buffer List*,
   "Functions to run whenever Winner mode is turned off."
   :type 'hook)
 
-(defvar winner-mode-map
-  (let ((map (make-sparse-keymap)))
-    (unless winner-dont-bind-my-keys
-      (define-key map [(control c) left] #'winner-undo)
-      (define-key map [(control c) right] #'winner-redo))
-    map)
-  "Keymap for Winner mode.")
+(defvar-keymap winner-mode-map
+  :doc "Keymap for Winner mode.")
+(setopt winner-dont-bind-my-keys winner-dont-bind-my-keys)
 
 (defvar-keymap winner-repeat-map
   :doc "Keymap to repeat winner key sequences.  Used in `repeat-mode'."

diff --git a/test/lisp/winner-tests.el b/test/lisp/winner-tests.el
new file mode 100644 (file)
index 0000000..549ab2c
--- /dev/null
+++ b/test/lisp/winner-tests.el
@@ -0,0 +1,32 @@
+;;; winner-tests.el --- Tests for winner.el  -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2025 Free Software Foundation, Inc.
+
+;; This file is part of GNU Emacs.
+
+;; 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 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
+;; 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
+;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Code:
+
+(require 'winner)
+
+(ert-deftest winner-dont-bind-my-keys ()
+  (should (keymap-lookup winner-mode-map "C-c <left>"))
+  (setopt winner-dont-bind-my-keys t)
+  (should-not (keymap-lookup winner-mode-map "C-c <left>"))
+  (setopt winner-dont-bind-my-keys nil)
+  (should (keymap-lookup winner-mode-map "C-c <left>")))
+
+(provide 'winner-tests)
+;;; winner-tests.el ends here