master 32db168290: Prefer defvar-keymap in some trivial cases

[Stefan Kangas]

branch: master
commit 32db1682903a3a6a59f81426ab699531f08acd2f
Author: Stefan Kangas <stefan@marxist.se>
Commit: Stefan Kangas <stefan@marxist.se>

    Prefer defvar-keymap in some trivial cases
    
    * lisp/calendar/diary-lib.el (diary-fancy-overriding-map):
    * lisp/emacs-lisp/chart.el (chart-mode-map):
    * lisp/emulation/cua-base.el (cua-global-keymap)
    (cua--cua-keys-keymap, cua--prefix-override-keymap)
    (cua--prefix-repeat-keymap, cua--global-mark-keymap)
    (cua--rectangle-keymap, cua--region-keymap):
    * lisp/emulation/viper-keym.el (viper-vi-intercept-map)
    (viper-insert-intercept-map, viper-emacs-intercept-map)
    (viper-vi-global-user-map, viper-vi-basic-map, viper-vi-kbd-map)
    (viper-vi-diehard-map, viper-insert-global-user-map)
    (viper-insert-basic-map, viper-insert-diehard-map)
    (viper-insert-kbd-map, viper-replace-map)
    (viper-emacs-global-user-map, viper-emacs-kbd-map)
    (viper-empty-keymap, viper-mode-map, viper-minibuffer-map)
    (viper-ex-cmd-map, ex-read-filename-map)
    (viper-slash-and-colon-map, viper-comint-mode-modifier-map)
    (viper-dired-modifier-map, viper-gnus-modifier-map):
    * lisp/gnus/gnus-sum.el (gnus-summary-generic-mark-map):
    * lisp/menu-bar.el (global-buffers-menu-map)
    (menu-bar-preferences-menu):
    * lisp/mh-e/mh-e.el (mh-folder-mode-map, mh-inc-spool-map)
    (mh-search-mode-map, mh-show-mode-map):
    * lisp/play/dunnet.el (dungeon-batch-map):
    * lisp/progmodes/autoconf.el (autoconf-mode-map):
    * lisp/tool-bar.el (tool-bar-map):
    * lisp/vc/ediff-help.el (ediff-help-region-map):
    * lisp/vc/ediff-hook.el (menu-bar-epatch-menu)
    (menu-bar-ediff-merge-menu, menu-bar-ediff-menu):
    * lisp/windmove.el (windmove-mode-map):
    * lisp/xwidget.el (xwidget-webkit-isearch-mode-map)
    (xwidget-webkit-edit-mode-map): Prefer defvar-keymap.
---
 lisp/calendar/diary-lib.el   |  4 +--
 lisp/emacs-lisp/chart.el     |  2 +-
 lisp/emulation/cua-base.el   | 18 +++++-----
 lisp/emulation/viper-keym.el | 86 ++++++++++++++++++++++----------------------
 lisp/font-lock.el            |  2 +-
 lisp/gnus/gnus-sum.el        |  2 +-
 lisp/menu-bar.el             |  4 +--
 lisp/mh-e/mh-e.el            | 17 ++++-----
 lisp/play/dunnet.el          |  2 +-
 lisp/progmodes/autoconf.el   |  2 +-
 lisp/tool-bar.el             |  4 +--
 lisp/vc/ediff-help.el        |  2 +-
 lisp/vc/ediff-hook.el        |  6 ++--
 lisp/windmove.el             |  4 +--
 lisp/xwidget.el              |  7 ++--
 15 files changed, 83 insertions(+), 79 deletions(-)

diff --git a/lisp/calendar/diary-lib.el b/lisp/calendar/diary-lib.el
index 084d2d7d55..98e91aaa75 100644
--- a/lisp/calendar/diary-lib.el
+++ b/lisp/calendar/diary-lib.el
@@ -2465,8 +2465,8 @@ Fontify the region between BEG and END, quietly unless 
VERBOSE is non-nil."
       (setq end (line-beginning-position 2)))
   (font-lock-default-fontify-region beg end verbose))
 
-(defvar diary-fancy-overriding-map (make-sparse-keymap)
-  "Keymap overriding minor-mode maps in `diary-fancy-display-mode'.")
+(defvar-keymap diary-fancy-overriding-map
+  :doc "Keymap overriding minor-mode maps in `diary-fancy-display-mode'.")
 
 (define-derived-mode diary-fancy-display-mode special-mode
   "Diary"
diff --git a/lisp/emacs-lisp/chart.el b/lisp/emacs-lisp/chart.el
index 716b236d3a..ac6cbb53a5 100644
--- a/lisp/emacs-lisp/chart.el
+++ b/lisp/emacs-lisp/chart.el
@@ -63,7 +63,7 @@
 (eval-when-compile (require 'cl-generic))
 
 ;;; Code:
-(defvar chart-mode-map (make-sparse-keymap) "Keymap used in chart mode.")
+(defvar-keymap chart-mode-map :doc "Keymap used in chart mode.")
 
 (defvar-local chart-local-object nil
   "Local variable containing the locally displayed chart object.")
diff --git a/lisp/emulation/cua-base.el b/lisp/emulation/cua-base.el
index 162d1bb641..297f7aba64 100644
--- a/lisp/emulation/cua-base.el
+++ b/lisp/emulation/cua-base.el
@@ -1144,15 +1144,15 @@ If ARG is the atom `-', scroll upward by nearly full 
screen."
            '(self-insert-command))
       def nil))
 
-(defvar cua-global-keymap (make-sparse-keymap)
-  "Global keymap for `cua-mode'; users may add to this keymap.")
-
-(defvar cua--cua-keys-keymap (make-sparse-keymap))
-(defvar cua--prefix-override-keymap (make-sparse-keymap))
-(defvar cua--prefix-repeat-keymap (make-sparse-keymap))
-(defvar cua--global-mark-keymap (make-sparse-keymap)) ; Initialized when 
cua-gmrk.el is loaded
-(defvar cua--rectangle-keymap (make-sparse-keymap))   ; Initialized when 
cua-rect.el is loaded
-(defvar cua--region-keymap (make-sparse-keymap))
+(defvar-keymap cua-global-keymap
+  :doc "Global keymap for `cua-mode'; users may add to this keymap.")
+
+(defvar-keymap cua--cua-keys-keymap)
+(defvar-keymap cua--prefix-override-keymap)
+(defvar-keymap cua--prefix-repeat-keymap)
+(defvar-keymap cua--global-mark-keymap) ; Initialized when cua-gmrk.el is 
loaded
+(defvar-keymap cua--rectangle-keymap)   ; Initialized when cua-rect.el is 
loaded
+(defvar-keymap cua--region-keymap)
 
 (defvar cua--ena-cua-keys-keymap nil)
 (defvar cua--ena-prefix-override-keymap nil)
diff --git a/lisp/emulation/viper-keym.el b/lisp/emulation/viper-keym.el
index ca175c140c..ed97880559 100644
--- a/lisp/emulation/viper-keym.el
+++ b/lisp/emulation/viper-keym.el
@@ -79,9 +79,9 @@ If nil, C-h gets the usual Vi bindings."
 
 ;; Keymaps for vital things like \e and C-z.
 ;; Not for users
-(defvar viper-vi-intercept-map (make-sparse-keymap))
-(defvar viper-insert-intercept-map (make-sparse-keymap))
-(defvar viper-emacs-intercept-map (make-sparse-keymap))
+(defvar-keymap viper-vi-intercept-map)
+(defvar-keymap viper-insert-intercept-map)
+(defvar-keymap viper-emacs-intercept-map)
 
 (defvar-local viper-vi-local-user-map (make-sparse-keymap)
   "Keymap for user-defined local bindings.
@@ -91,60 +91,62 @@ For instance, in letter-mode, one may want to bind ZZ to
 to `save-buffers-kill-emacs' then post article, etc.")
 (put 'viper-vi-local-user-map 'permanent-local t)
 
-(defvar viper-vi-global-user-map (make-sparse-keymap)
-  "Keymap for user-defined global bindings.
+(defvar-keymap viper-vi-global-user-map
+  :doc "Keymap for user-defined global bindings.
 These bindings are seen in all Viper buffers.")
 
-(defvar viper-vi-basic-map (make-keymap)
-  "This is the main keymap in effect in Viper's Vi state.
-This map is global, shared by all buffers.")
+(defvar-keymap viper-vi-basic-map
+  :doc "This is the main keymap in effect in Viper's Vi state.
+This map is global, shared by all buffers."
+  :full t)
 
-(defvar  viper-vi-kbd-map (make-sparse-keymap)
-  "This keymap keeps keyboard macros defined via the :map command.")
+(defvar-keymap viper-vi-kbd-map
+  :doc "This keymap keeps keyboard macros defined via the :map command.")
 
-(defvar viper-vi-diehard-map (make-sparse-keymap)
-  "This keymap is in use when the user asks Viper to simulate Vi very closely.
-This happens when viper-expert-level is 1 or 2.  See viper-set-expert-level.")
+(defvar-keymap viper-vi-diehard-map
+  :doc "This keymap is in use when the user asks Viper to simulate Vi very 
closely.
+This happens when `viper-expert-level' is 1 or 2.  See 
`viper-set-expert-level'.")
 
 
 (defvar-local viper-insert-local-user-map (make-sparse-keymap)
   "Auxiliary map for per-buffer user-defined keybindings in Insert state.")
 (put 'viper-insert-local-user-map 'permanent-local t)
 
-(defvar viper-insert-global-user-map (make-sparse-keymap)
-  "Auxiliary map for global user-defined bindings in Insert state.")
+(defvar-keymap viper-insert-global-user-map
+  :doc "Auxiliary map for global user-defined bindings in Insert state.")
 
-(defvar viper-insert-basic-map (make-sparse-keymap)
-  "The basic insert-mode keymap.")
+(defvar-keymap viper-insert-basic-map
+  :doc "The basic insert-mode keymap.")
 
-(defvar viper-insert-diehard-map (make-keymap)
-  "Map used when user wants vi-style keys in insert mode.
+(defvar-keymap viper-insert-diehard-map
+  :doc "Map used when user wants vi-style keys in insert mode.
 Most of the Emacs keys are suppressed.  This map overshadows
-viper-insert-basic-map.  Not recommended, except for novice users.")
+`viper-insert-basic-map'.  Not recommended, except for novice users."
+  :full t)
 
-(defvar  viper-insert-kbd-map  (make-sparse-keymap)
-  "This keymap keeps VI-style kbd macros for insert mode.")
+(defvar-keymap viper-insert-kbd-map
+  :doc "This keymap keeps VI-style kbd macros for insert mode.")
 
-(defvar viper-replace-map (make-sparse-keymap)
-  "Map used in Viper's replace state.")
+(defvar-keymap viper-replace-map
+  :doc "Map used in Viper's replace state.")
 
-(defvar viper-emacs-global-user-map (make-sparse-keymap)
-  "Auxiliary map for global user-defined bindings in Emacs state.")
+(defvar-keymap viper-emacs-global-user-map
+  :doc "Auxiliary map for global user-defined bindings in Emacs state.")
 
-(defvar  viper-emacs-kbd-map  (make-sparse-keymap)
-  "This keymap keeps Vi-style kbd macros for Emacs mode.")
+(defvar-keymap viper-emacs-kbd-map
+  :doc "This keymap keeps Vi-style kbd macros for Emacs mode.")
 
 (defvar-local viper-emacs-local-user-map  (make-sparse-keymap)
   "Auxiliary map for local user-defined bindings in Emacs state.")
 (put 'viper-emacs-local-user-map 'permanent-local t)
 
 ;; This keymap should stay empty
-(defvar viper-empty-keymap (make-sparse-keymap))
+(defvar-keymap viper-empty-keymap)
 
 ;; This was the main Vi mode in old versions of VIP which may have been
 ;; extensively used by VIP users.  We declare it as a global var and, after
 ;; viper-custom-file-name is loaded, we add this keymap to viper-vi-basic-map.
-(defvar viper-mode-map (make-sparse-keymap))
+(defvar-keymap viper-mode-map)
 
 ;; Some important keys used in viper
 (defcustom viper-toggle-key [(control ?z)]  ; "\C-z"
@@ -442,41 +444,41 @@ In insert mode, this key also functions as Meta."
 ;;; Minibuffer keymap
 
 
-(defvar viper-minibuffer-map (make-sparse-keymap)
-  "Keymap used to modify keys when Minibuffer is in Insert state.")
+(defvar-keymap viper-minibuffer-map
+  :doc "Keymap used to modify keys when Minibuffer is in Insert state.")
 
 (define-key viper-minibuffer-map "\C-m" 'viper-exit-minibuffer)
 (define-key viper-minibuffer-map "\C-j" 'viper-exit-minibuffer)
 
 ;; Map used to read Ex-style commands.
-(defvar viper-ex-cmd-map (make-sparse-keymap))
+(defvar-keymap viper-ex-cmd-map)
 (define-key viper-ex-cmd-map " "  'ex-cmd-read-exit)
 (define-key viper-ex-cmd-map "\t" 'ex-cmd-complete)
 
 ;; Keymap for reading file names in Ex-style commands.
-(defvar ex-read-filename-map (make-sparse-keymap))
+(defvar-keymap ex-read-filename-map)
 (define-key ex-read-filename-map " " 'viper-complete-filename-or-exit)
 (define-key ex-read-filename-map "!" 'viper-handle-!)
 
 ;; Some other maps
-(defvar viper-slash-and-colon-map (make-sparse-keymap)
-  "This map redefines `/' and `:' to behave as in Vi.
+(defvar-keymap viper-slash-and-colon-map
+  :doc "This map redefines \\`/' and \\`:' to behave as in Vi.
 Useful in some modes, such as Gnus, MH, etc.")
 (define-key viper-slash-and-colon-map ":" 'viper-ex)
 (define-key viper-slash-and-colon-map "/" 'viper-search-forward)
 
-(defvar viper-comint-mode-modifier-map (make-sparse-keymap)
-  "This map modifies comint mode.")
+(defvar-keymap viper-comint-mode-modifier-map
+  :doc "This map modifies comint mode.")
 (define-key viper-comint-mode-modifier-map "\C-m" 'viper-exec-key-in-emacs)
 (define-key viper-comint-mode-modifier-map "\C-d" 'viper-exec-key-in-emacs)
 
-(defvar viper-dired-modifier-map (make-sparse-keymap)
-  "This map modifies Dired behavior.")
+(defvar-keymap viper-dired-modifier-map
+  :doc "This map modifies Dired behavior.")
 (define-key viper-dired-modifier-map ":" 'viper-ex)
 (define-key viper-dired-modifier-map "/" 'viper-search-forward)
 
-(defvar viper-gnus-modifier-map (make-sparse-keymap)
-  "This map modifies Gnus behavior.")
+(defvar-keymap viper-gnus-modifier-map
+  :doc "This map modifies Gnus behavior.")
 (define-key viper-gnus-modifier-map ":" 'viper-ex)
 
 
diff --git a/lisp/font-lock.el b/lisp/font-lock.el
index 181a7dc90e..d815a9c9c4 100644
--- a/lisp/font-lock.el
+++ b/lisp/font-lock.el
@@ -2190,7 +2190,7 @@ as the constructs of Haddock, Javadoc and similar 
systems."
 ;;;;;###autoload
 ;;(progn
 ;;  ;; Make the Font Lock menu.
-;;  (defvar font-lock-menu (make-sparse-keymap "Syntax Highlighting"))
+;;  (defvar-keymap font-lock-menu :name "Syntax Highlighting")
 ;;  ;; Add the menu items in reverse order.
 ;;  (define-key font-lock-menu [fontify-less]
 ;;    '("Less In Current Buffer" . font-lock-fontify-less))
diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el
index 7f96e16c8a..bf2a083fec 100644
--- a/lisp/gnus/gnus-sum.el
+++ b/lisp/gnus/gnus-sum.el
@@ -12929,7 +12929,7 @@ treated as multipart/mixed."
     (expirable gnus-expirable-mark "e"))
   "An alist of names/marks/keystrokes.")
 
-(defvar gnus-summary-generic-mark-map (make-sparse-keymap))
+(defvar-keymap gnus-summary-generic-mark-map)
 (defvar gnus-summary-mark-map)
 
 (defun gnus-summary-make-all-marking-commands ()
diff --git a/lisp/menu-bar.el b/lisp/menu-bar.el
index 12a0b4d328..c2c18320b1 100644
--- a/lisp/menu-bar.el
+++ b/lisp/menu-bar.el
@@ -47,7 +47,7 @@
 
 ;; This definition is just to show what this looks like.
 ;; It gets modified in place when menu-bar-update-buffers is called.
-(defvar global-buffers-menu-map (make-sparse-keymap "Buffers"))
+(defvar-keymap global-buffers-menu-map :name "Buffers")
 
 (defvar menu-bar-print-menu
   (let ((menu (make-sparse-keymap "Print")))
@@ -680,7 +680,7 @@ Do the same for the keys of the same name."
       '(menu-item "Custom Themes" customize-themes
                   :help "Choose a pre-defined customization theme"))
     menu))
-;(defvar menu-bar-preferences-menu (make-sparse-keymap "Preferences"))
+;(defvar-keymap menu-bar-preferences-menu :name "Preferences")
 
 (defmacro menu-bar-make-mm-toggle (fname doc help &optional props)
   "Make a menu-item for a global minor mode toggle.
diff --git a/lisp/mh-e/mh-e.el b/lisp/mh-e/mh-e.el
index 872f0d79d2..a3a363e33f 100644
--- a/lisp/mh-e/mh-e.el
+++ b/lisp/mh-e/mh-e.el
@@ -163,8 +163,9 @@ User's mail folder directory.")
 
 ;; Maps declared here so that they can be used in docstrings.
 
-(defvar mh-folder-mode-map (make-keymap)
-  "Keymap for MH-Folder mode.")
+(defvar-keymap mh-folder-mode-map
+  :doc "Keymap for MH-Folder mode."
+  :full t)
 
 (defvar mh-folder-seq-tool-bar-map nil
   "Keymap for MH-Folder tool bar.")
@@ -172,8 +173,8 @@ User's mail folder directory.")
 (defvar mh-folder-tool-bar-map nil
   "Keymap for MH-Folder tool bar.")
 
-(defvar mh-inc-spool-map (make-sparse-keymap)
-  "Keymap for MH-E's mh-inc-spool commands.")
+(defvar-keymap mh-inc-spool-map
+  :doc "Keymap for MH-E's mh-inc-spool commands.")
 
 (defvar mh-letter-mode-map (copy-keymap text-mode-map)
   "Keymap for MH-Letter mode.")
@@ -181,11 +182,11 @@ User's mail folder directory.")
 (defvar mh-letter-tool-bar-map nil
   "Keymap for MH-Letter tool bar.")
 
-(defvar mh-search-mode-map (make-sparse-keymap)
-  "Keymap for MH-Search mode.")
+(defvar-keymap mh-search-mode-map
+  :doc "Keymap for MH-Search mode.")
 
-(defvar mh-show-mode-map (make-sparse-keymap)
-  "Keymap MH-Show mode.")
+(defvar-keymap mh-show-mode-map
+  :doc "Keymap for MH-Show mode.")
 
 (defvar mh-show-seq-tool-bar-map nil
   "Keymap for MH-Show tool bar.")
diff --git a/lisp/play/dunnet.el b/lisp/play/dunnet.el
index b859176bb4..94392901be 100644
--- a/lisp/play/dunnet.el
+++ b/lisp/play/dunnet.el
@@ -2324,7 +2324,7 @@ Also prints current score to let user know he has scored."
 ;;;;
 
 (define-key dun-mode-map "\r" 'dun-parse)
-(defvar dungeon-batch-map (make-keymap))
+(defvar-keymap dungeon-batch-map :full t)
 (let (n)
   (setq n 32)
   (while (< 0 (setq n (- n 1)))
diff --git a/lisp/progmodes/autoconf.el b/lisp/progmodes/autoconf.el
index d0acd36f4b..fd8bf1f7ec 100644
--- a/lisp/progmodes/autoconf.el
+++ b/lisp/progmodes/autoconf.el
@@ -35,7 +35,7 @@
 
 ;;; Code:
 
-(defvar autoconf-mode-map (make-sparse-keymap))
+(defvar-keymap autoconf-mode-map)
 
 (defvar autoconf-mode-hook nil
   "Hook run by `autoconf-mode'.")
diff --git a/lisp/tool-bar.el b/lisp/tool-bar.el
index 82b458e010..b1f7a70e33 100644
--- a/lisp/tool-bar.el
+++ b/lisp/tool-bar.el
@@ -75,8 +75,8 @@ See `tool-bar-mode' for more information."
       (tool-bar-mode (if (> (frame-parameter nil 'tool-bar-lines) 0) 0 1))
     (tool-bar-mode arg)))
 
-(defvar tool-bar-map (make-sparse-keymap)
-  "Keymap for the tool bar.
+(defvar-keymap tool-bar-map
+  :doc "Keymap for the tool bar.
 
 To override the global tool bar, define this variable
 buffer-locally and add the items you want to it with
diff --git a/lisp/vc/ediff-help.el b/lisp/vc/ediff-help.el
index 4e41204169..42fbde2165 100644
--- a/lisp/vc/ediff-help.el
+++ b/lisp/vc/ediff-help.el
@@ -152,7 +152,7 @@ the value of this variable and the variables 
`ediff-help-message-*' in
 
 
 ;; the keymap that defines clicks over the quick help regions
-(defvar ediff-help-region-map (make-sparse-keymap))
+(defvar-keymap ediff-help-region-map)
 
 (define-key ediff-help-region-map [mouse-2] #'ediff-help-for-quick-help)
 
diff --git a/lisp/vc/ediff-hook.el b/lisp/vc/ediff-hook.el
index cee376de30..0160d9f684 100644
--- a/lisp/vc/ediff-hook.el
+++ b/lisp/vc/ediff-hook.el
@@ -50,12 +50,12 @@
   (make-sparse-keymap "Ediff Miscellanea"))
 (fset 'menu-bar-ediff-misc-menu
       menu-bar-ediff-misc-menu)
-(defvar menu-bar-epatch-menu (make-sparse-keymap "Apply Patch"))
+(defvar-keymap menu-bar-epatch-menu :name "Apply Patch")
 (fset 'menu-bar-epatch-menu menu-bar-epatch-menu)
-(defvar menu-bar-ediff-merge-menu (make-sparse-keymap "Merge"))
+(defvar-keymap menu-bar-ediff-merge-menu :name "Merge")
 (fset 'menu-bar-ediff-merge-menu
       menu-bar-ediff-merge-menu)
-(defvar menu-bar-ediff-menu (make-sparse-keymap "Compare"))
+(defvar-keymap menu-bar-ediff-menu :name "Compare")
 (fset 'menu-bar-ediff-menu menu-bar-ediff-menu)
 
 ;; define ediff compare menu
diff --git a/lisp/windmove.el b/lisp/windmove.el
index 369c32c891..990b8f04c4 100644
--- a/lisp/windmove.el
+++ b/lisp/windmove.el
@@ -445,8 +445,8 @@ unless `windmove-create-window' is non-nil and a new window 
is created."
 ;; I don't think these bindings will work on non-X terminals; you
 ;; probably want to use different bindings in that case.
 
-(defvar windmove-mode-map (make-sparse-keymap)
-  "Map used by `windmove-install-defaults'.")
+(defvar-keymap windmove-mode-map
+  :doc "Map used by `windmove-install-defaults'.")
 
 ;;;###autoload
 (define-minor-mode windmove-mode
diff --git a/lisp/xwidget.el b/lisp/xwidget.el
index 0821760d99..8933fae310 100644
--- a/lisp/xwidget.el
+++ b/lisp/xwidget.el
@@ -965,7 +965,7 @@ You can retrieve the value with `xwidget-get'."
   (set-xwidget-plist xwidget
                      (plist-put (xwidget-plist xwidget) propname value)))
 
-(defvar xwidget-webkit-edit-mode-map (make-keymap))
+(defvar-keymap xwidget-webkit-edit-mode-map :full t)
 
 (define-key xwidget-webkit-edit-mode-map [backspace] 
'xwidget-webkit-pass-command-event)
 (define-key xwidget-webkit-edit-mode-map [tab] 
'xwidget-webkit-pass-command-event)
@@ -1111,8 +1111,9 @@ With argument, add COUNT copies of CHAR."
   (interactive)
   (xwidget-webkit-isearch-mode 0))
 
-(defvar xwidget-webkit-isearch-mode-map (make-keymap)
-  "The keymap used inside xwidget-webkit-isearch-mode.")
+(defvar-keymap xwidget-webkit-isearch-mode-map
+  :doc "The keymap used inside `xwidget-webkit-isearch-mode'."
+  :full t)
 
 (set-char-table-range (nth 1 xwidget-webkit-isearch-mode-map)
                       (cons 0 (max-char))