lisp/emulation/viper-keym.el

   1 ;;; viper-keym.el --- Viper keymaps
   2
   3 ;; Copyright (C) 1994-1997, 2000-2017 Free Software Foundation, Inc.
   4
   5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
   6 ;; Package: viper
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software: you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation, either version 3 of the License, or
  13 ;; (at your option) any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  22
  23 ;;; Commentary:
  24
  25 ;;; Code:
  26
  27 ;; compiler pacifier
  28 (defvar viper-always)
  29 (defvar viper-current-state)
  30 (defvar viper-mode-string)
  31 (defvar viper-expert-level)
  32 (defvar viper-ex-style-editing)
  33 (defvar viper-ex-style-motion)
  34
  35 (eval-and-compile
  36   (unless (fboundp 'declare-function) (defmacro declare-function (&rest  r))))
  37 ;; end pacifier
  38
  39 (require 'viper-util)
  40
  41 (declare-function viper-ex "viper-ex" (arg &optional string))
  42 (declare-function viper-normalize-minor-mode-map-alist "viper-cmd" ())
  43 (declare-function viper-set-mode-vars-for "viper-cmd" (state))
  44
  45 ;;; Variables
  46
  47
  48 ;;; Emacs keys in other states.
  49
  50 (defcustom viper-want-emacs-keys-in-insert t
  51   "Set to nil if you want complete Vi compatibility in insert mode.
  52 Complete compatibility with Vi is not recommended for power use of Viper."
  53   :type 'boolean
  54   :group 'viper)
  55
  56 (defcustom viper-want-emacs-keys-in-vi t
  57   "Set to nil if you want complete Vi compatibility in Vi mode.
  58 Full Vi compatibility is not recommended for power use of Viper."
  59   :type 'boolean
  60   :group 'viper)
  61
  62 (defcustom viper-no-multiple-ESC  t
  63   "If non-nil, multiple ESC in Vi mode will cause bell to ring.
  64 This is set to t on a windowing terminal and to `twice' on a dumb
  65 terminal (unless the user level is 1, 2, or 5).  On a dumb terminal, this
  66 enables cursor keys and is generally more convenient, as terminals usually
  67 don't have a convenient Meta key.
  68 Setting it to nil will allow as many multiple ESC, as is allowed by the
  69 major mode in effect."
  70   :type 'boolean
  71   :group 'viper)
  72
  73 (defcustom viper-want-ctl-h-help nil
  74   "If non-nil, C-h gets bound to help-command; otherwise, C-h gets the usual Vi bindings."
  75   :type 'boolean
  76   :group 'viper)
  77
  78
  79 ;;; Keymaps
  80
  81 ;; Keymaps for vital things like \e and C-z.
  82 ;; Not for users
  83 (defvar viper-vi-intercept-map (make-sparse-keymap))
  84 (defvar viper-insert-intercept-map (make-sparse-keymap))
  85 (defvar viper-emacs-intercept-map (make-sparse-keymap))
  86
  87 ;; keymap used to zap all keymaps other than function-key-map,
  88 ;; device-function-key-map, etc.
  89 (defvar viper-overriding-map (make-sparse-keymap))
  90
  91 (viper-deflocalvar viper-vi-local-user-map (make-sparse-keymap)
  92   "Keymap for user-defined local bindings.
  93 Useful for changing bindings such as ZZ in certain major modes.
  94 For instance, in letter-mode, one may want to bind ZZ to
  95 mh-send-letter.  In a newsreader such as gnus, tin, or rn, ZZ could be bound
  96 to save-buffers-kill-emacs then post article, etc.")
  97 (put 'viper-vi-local-user-map 'permanent-local t)
  98
  99 (defvar viper-vi-global-user-map (make-sparse-keymap)
 100   "Keymap for user-defined global bindings.
 101 These bindings are seen in all Viper buffers.")
 102
 103 (defvar viper-vi-basic-map (make-keymap)
 104   "This is the main keymap in effect in Viper's Vi state.
 105 This map is global, shared by all buffers.")
 106
 107 (defvar  viper-vi-kbd-map (make-sparse-keymap)
 108   "This keymap keeps keyboard macros defined via the :map command.")
 109
 110 (defvar viper-vi-diehard-map (make-sparse-keymap)
 111   "This keymap is in use when the user asks Viper to simulate Vi very closely.
 112 This happens when viper-expert-level is 1 or 2.  See viper-set-expert-level.")
 113
 114
 115 (viper-deflocalvar viper-insert-local-user-map (make-sparse-keymap)
 116   "Auxiliary map for per-buffer user-defined keybindings in Insert state.")
 117 (put 'viper-insert-local-user-map 'permanent-local t)
 118
 119 (defvar viper-insert-global-user-map (make-sparse-keymap)
 120   "Auxiliary map for global user-defined bindings in Insert state.")
 121
 122 (defvar viper-insert-basic-map (make-sparse-keymap)
 123   "The basic insert-mode keymap.")
 124
 125 (defvar viper-insert-diehard-map (make-keymap)
 126   "Map used when user wants vi-style keys in insert mode.
 127 Most of the Emacs keys are suppressed.  This map overshadows
 128 viper-insert-basic-map.  Not recommended, except for novice users.")
 129
 130 (defvar  viper-insert-kbd-map  (make-sparse-keymap)
 131   "This keymap keeps VI-style kbd macros for insert mode.")
 132
 133 (defvar viper-replace-map (make-sparse-keymap)
 134   "Map used in Viper's replace state.")
 135
 136 (defvar viper-emacs-global-user-map (make-sparse-keymap)
 137   "Auxiliary map for global user-defined bindings in Emacs state.")
 138
 139 (defvar  viper-emacs-kbd-map  (make-sparse-keymap)
 140   "This keymap keeps Vi-style kbd macros for Emacs mode.")
 141
 142 (viper-deflocalvar viper-emacs-local-user-map  (make-sparse-keymap)
 143   "Auxiliary map for local user-defined bindings in Emacs state.")
 144 (put 'viper-emacs-local-user-map 'permanent-local t)
 145
 146 ;; This keymap should stay empty
 147 (defvar viper-empty-keymap (make-sparse-keymap))
 148
 149 ;; This was the main Vi mode in old versions of VIP which may have been
 150 ;; extensively used by VIP users.  We declare it as a global var and, after
 151 ;; viper-custom-file-name is loaded, we add this keymap to viper-vi-basic-map.
 152 (defvar viper-mode-map (make-sparse-keymap))
 153
 154 ;; Some important keys used in viper
 155 (defcustom viper-toggle-key [(control ?z)]  ; "\C-z"
 156   "The key used to change states from Emacs to Vi and back.
 157 In insert mode, this key also functions as Meta."
 158   :type 'key-sequence
 159   :group 'viper
 160   :set (lambda (symbol value)
 161          (let ((old-value (if (boundp 'viper-toggle-key)
 162                               viper-toggle-key
 163                             [(control ?z)])))
 164            (mapc
 165             (lambda (buf)
 166               (with-current-buffer buf
 167                 (when (and (boundp 'viper-insert-basic-map)
 168                            (keymapp viper-insert-basic-map))
 169                   (when old-value
 170                     (define-key viper-insert-basic-map old-value nil))
 171                   (define-key viper-insert-basic-map value 'viper-escape-to-vi))
 172                 (when (and (boundp 'viper-vi-intercept-map)
 173                            (keymapp viper-vi-intercept-map))
 174                   (when old-value
 175                     (define-key viper-vi-intercept-map old-value nil))
 176                   (define-key
 177                     viper-vi-intercept-map value 'viper-toggle-key-action))
 178                 (when (and (boundp 'viper-emacs-intercept-map)
 179                            (keymapp viper-emacs-intercept-map))
 180                   (define-key viper-emacs-intercept-map old-value nil)
 181                   (define-key
 182                     viper-emacs-intercept-map value 'viper-change-state-to-vi))
 183                 ))
 184             (buffer-list))
 185            (set-default symbol value)
 186            )))
 187
 188 (defcustom viper-quoted-insert-key "\C-v"
 189   "The key used to quote special characters when inserting them in Insert state."
 190   :type 'string
 191   :group 'viper)
 192
 193 (defconst viper-ESC-key [escape]
 194   "Key used to ESC.")
 195
 196
 197 ;;; Variables used by minor modes
 198
 199 ;; Association list of the form
 200 ;; ((major-mode . keymap) (major-mode . keymap) ...)
 201 ;; Viper uses these keymaps to make user-requested adjustments
 202 ;; to its Vi state in various major modes.")
 203 (defvar viper-vi-state-modifier-alist nil)
 204
 205 ;; Association list of the form
 206 ;; ((major-mode . keymap) (major-mode . keymap) ...)
 207 ;; Viper uses these keymaps to make user-requested adjustments
 208 ;; to its Insert state in various major modes.")
 209 (defvar viper-insert-state-modifier-alist nil)
 210
 211 ;; Association list of the form
 212 ;; ((major-mode . keymap) (major-mode . keymap) ...)
 213 ;; Viper uses these keymaps to make user-requested adjustments
 214 ;; to its Emacs state in various major modes.
 215 (defvar viper-emacs-state-modifier-alist nil)
 216
 217 ;; The list of viper keymaps. Set by viper-normalize-minor-mode-map-alist
 218 (viper-deflocalvar viper--key-maps nil)
 219 (viper-deflocalvar viper--intercept-key-maps nil)
 220
 221 ;; Tells viper-add-local-keys to create a new viper-vi-local-user-map for new
 222 ;; buffers.  Not a user option.
 223 (viper-deflocalvar viper-need-new-vi-local-map t "")
 224 (put 'viper-need-new-vi-local-map  'permanent-local t)
 225
 226 ;; Tells viper-add-local-keys to create a new viper-insert-local-user-map for
 227 ;; new buffers.  Not a user option.
 228 (viper-deflocalvar viper-need-new-insert-local-map t "")
 229 (put 'viper-need-new-insert-local-map  'permanent-local t)
 230
 231 ;; Tells viper-add-local-keys to create a new viper-emacs-local-user-map for
 232 ;; new buffers.  Not a user option.
 233 (viper-deflocalvar viper-need-new-emacs-local-map t "")
 234 (put 'viper-need-new-emacs-local-map  'permanent-local t)
 235
 236
 237 \f
 238 ;; Insert mode keymap
 239
 240 ;; for novice users, pretend you are the real vi.
 241 (define-key viper-insert-diehard-map "\t"   'viper-insert-tab)
 242 (define-key viper-insert-diehard-map "\C-a" 'self-insert-command)
 243 (define-key viper-insert-diehard-map "\C-b" 'self-insert-command)
 244 (define-key viper-insert-diehard-map "\C-c" 'viper-change-state-to-vi)
 245 (define-key viper-insert-diehard-map "\C-e" 'self-insert-command)
 246 (define-key viper-insert-diehard-map "\C-f" 'self-insert-command)
 247 (define-key viper-insert-diehard-map "\C-g" 'self-insert-command)
 248 (define-key viper-insert-diehard-map "\C-i" 'self-insert-command)
 249 (define-key viper-insert-diehard-map "\C-k" 'self-insert-command)
 250 (define-key viper-insert-diehard-map "\C-l" 'self-insert-command)
 251 (define-key viper-insert-diehard-map "\C-n" 'self-insert-command)
 252 (define-key viper-insert-diehard-map "\C-o" 'self-insert-command)
 253 (define-key viper-insert-diehard-map "\C-p" 'self-insert-command)
 254 (define-key viper-insert-diehard-map "\C-q" 'self-insert-command)
 255 (define-key viper-insert-diehard-map "\C-r" 'self-insert-command)
 256 (define-key viper-insert-diehard-map "\C-s" 'self-insert-command)
 257 (define-key viper-insert-diehard-map "\C-u" 'viper-erase-line)
 258 (define-key viper-insert-diehard-map "\C-x" 'self-insert-command)
 259 (define-key viper-insert-diehard-map "\C-y" 'self-insert-command)
 260 (define-key viper-insert-diehard-map "\C-z" 'self-insert-command)
 261 (define-key viper-insert-diehard-map "\C-]" 'self-insert-command)
 262 (define-key viper-insert-diehard-map "\C-_" 'self-insert-command)
 263
 264 (let ((i ?\ ))
 265   (while (<= i ?~)
 266     (define-key viper-insert-diehard-map (make-string 1 i) 'self-insert-command)
 267     (setq i (1+ i))))
 268
 269 ;; Insert mode map when user wants emacs style
 270 (define-key viper-insert-basic-map "\C-d" 'viper-backward-indent)
 271 (define-key viper-insert-basic-map "\C-w" 'viper-delete-backward-word)
 272 (define-key viper-insert-basic-map "\C-t" 'viper-forward-indent)
 273 (define-key viper-insert-basic-map viper-quoted-insert-key 'quoted-insert)
 274 (define-key viper-insert-basic-map "\C-?" 'viper-del-backward-char-in-insert)
 275 (define-key viper-insert-basic-map [backspace] 'viper-del-backward-char-in-insert)
 276 (define-key viper-insert-basic-map "\C-\\" 'viper-alternate-Meta-key)
 277 (define-key viper-insert-basic-map viper-toggle-key 'viper-escape-to-vi)
 278 (define-key viper-insert-basic-map "\C-c\M-p"
 279   'viper-insert-prev-from-insertion-ring)
 280 (define-key viper-insert-basic-map "\C-c\M-n"
 281   'viper-insert-next-from-insertion-ring)
 282
 283
 284 ;; Replace keymap
 285 (define-key viper-replace-map "\C-t" 'viper-forward-indent)
 286 (define-key viper-replace-map "\C-j" 'viper-replace-state-carriage-return)
 287 (define-key viper-replace-map "\C-m" 'viper-replace-state-carriage-return)
 288 (define-key viper-replace-map "\C-?" 'viper-del-backward-char-in-replace)
 289 (define-key viper-replace-map [backspace] 'viper-del-backward-char-in-replace)
 290
 291
 292 \f
 293 ;; Vi keymaps
 294
 295 (define-key viper-vi-basic-map "\C-^" (lambda ()
 296                                         (interactive) (viper-ex nil "e#")))
 297 (define-key viper-vi-basic-map "\C-b" 'viper-scroll-screen-back)
 298 (define-key viper-vi-basic-map "\C-d" 'viper-scroll-up)
 299 (define-key viper-vi-basic-map "\C-e" 'viper-scroll-up-one)
 300 (define-key viper-vi-basic-map "\C-f" 'viper-scroll-screen)
 301 (define-key viper-vi-basic-map "\C-m" 'viper-next-line-at-bol)
 302 (define-key viper-vi-basic-map "\C-u" 'viper-scroll-down)
 303 (define-key viper-vi-basic-map "\C-y" 'viper-scroll-down-one)
 304 ;;(define-key viper-vi-basic-map "\C-s" 'viper-isearch-forward)
 305 ;;(define-key viper-vi-basic-map "\C-r" 'viper-isearch-backward)
 306 (define-key viper-vi-basic-map "\C-c/" 'viper-toggle-search-style)
 307 (define-key viper-vi-basic-map "\C-c\C-g" 'viper-info-on-file)
 308
 309 (define-key viper-vi-basic-map "\C-c\M-p" 'viper-prev-destructive-command)
 310 (define-key viper-vi-basic-map "\C-c\M-n" 'viper-next-destructive-command)
 311
 312
 313 (define-key viper-vi-basic-map " " 'viper-forward-char)
 314 (define-key viper-vi-basic-map "!" 'viper-command-argument)
 315 (define-key viper-vi-basic-map "\"" 'viper-command-argument)
 316 (define-key viper-vi-basic-map "#" 'viper-command-argument)
 317 (define-key viper-vi-basic-map "$" 'viper-goto-eol)
 318 (define-key viper-vi-basic-map "%" 'viper-paren-match)
 319 (define-key viper-vi-basic-map "&" (lambda ()
 320                                      (interactive) (viper-ex nil "&")))
 321 (define-key viper-vi-basic-map "'" 'viper-goto-mark-and-skip-white)
 322 (define-key viper-vi-basic-map "(" 'viper-backward-sentence)
 323 (define-key viper-vi-basic-map ")" 'viper-forward-sentence)
 324 (define-key viper-vi-basic-map "*" 'call-last-kbd-macro)
 325 (define-key viper-vi-basic-map "+" 'viper-next-line-at-bol)
 326 (define-key viper-vi-basic-map "," 'viper-repeat-find-opposite)
 327 (define-key viper-vi-basic-map "-" 'viper-previous-line-at-bol)
 328 (define-key viper-vi-basic-map "." 'viper-repeat)
 329 (define-key viper-vi-basic-map "/" 'viper-search-forward)
 330
 331 (define-key viper-vi-basic-map "0" 'viper-beginning-of-line)
 332 (define-key viper-vi-basic-map "1" 'viper-digit-argument)
 333 (define-key viper-vi-basic-map "2" 'viper-digit-argument)
 334 (define-key viper-vi-basic-map "3" 'viper-digit-argument)
 335 (define-key viper-vi-basic-map "4" 'viper-digit-argument)
 336 (define-key viper-vi-basic-map "5" 'viper-digit-argument)
 337 (define-key viper-vi-basic-map "6" 'viper-digit-argument)
 338 (define-key viper-vi-basic-map "7" 'viper-digit-argument)
 339 (define-key viper-vi-basic-map "8" 'viper-digit-argument)
 340 (define-key viper-vi-basic-map "9" 'viper-digit-argument)
 341
 342 (define-key viper-vi-basic-map ":" 'viper-ex)
 343 (define-key viper-vi-basic-map ";" 'viper-repeat-find)
 344 (define-key viper-vi-basic-map "<" 'viper-command-argument)
 345 (define-key viper-vi-basic-map "=" 'viper-command-argument)
 346 (define-key viper-vi-basic-map ">" 'viper-command-argument)
 347 (define-key viper-vi-basic-map "?" 'viper-search-backward)
 348 (define-key viper-vi-basic-map "@" 'viper-register-macro)
 349
 350 (define-key viper-vi-basic-map "A" 'viper-Append)
 351 (define-key viper-vi-basic-map "B" 'viper-backward-Word)
 352 (define-key viper-vi-basic-map "C" 'viper-change-to-eol)
 353 (define-key viper-vi-basic-map "D" 'viper-kill-line)
 354 (define-key viper-vi-basic-map "E" 'viper-end-of-Word)
 355 (define-key viper-vi-basic-map "F" 'viper-find-char-backward)
 356 (define-key viper-vi-basic-map "G" 'viper-goto-line)
 357 (define-key viper-vi-basic-map "H" 'viper-window-top)
 358 (define-key viper-vi-basic-map "I" 'viper-Insert)
 359 (define-key viper-vi-basic-map "J" 'viper-join-lines)
 360 (define-key viper-vi-basic-map "K" 'viper-nil)
 361 (define-key viper-vi-basic-map "L" 'viper-window-bottom)
 362 (define-key viper-vi-basic-map "M" 'viper-window-middle)
 363 (define-key viper-vi-basic-map "N" 'viper-search-Next)
 364 (define-key viper-vi-basic-map "O" 'viper-Open-line)
 365 (define-key viper-vi-basic-map "P" 'viper-Put-back)
 366 (define-key viper-vi-basic-map "Q" 'viper-query-replace)
 367 (define-key viper-vi-basic-map "R" 'viper-overwrite)
 368 (define-key viper-vi-basic-map "S" 'viper-substitute-line)
 369 (define-key viper-vi-basic-map "T" 'viper-goto-char-backward)
 370 (define-key viper-vi-basic-map "U" 'viper-undo)
 371 (define-key viper-vi-basic-map "V" 'find-file-other-window)
 372 (define-key viper-vi-basic-map "W" 'viper-forward-Word)
 373 (define-key viper-vi-basic-map "X" 'viper-delete-backward-char)
 374 (define-key viper-vi-basic-map "Y" 'viper-yank-line)
 375 (define-key viper-vi-basic-map "ZZ" 'viper-save-kill-buffer)
 376
 377 (define-key viper-vi-basic-map "\\" 'viper-escape-to-emacs)
 378 (define-key viper-vi-basic-map "[" 'viper-brac-function)
 379 (define-key viper-vi-basic-map "]" 'viper-ket-function)
 380 (define-key viper-vi-basic-map "\C-\\" 'viper-alternate-Meta-key)
 381 (define-key viper-vi-basic-map "^" 'viper-bol-and-skip-white)
 382 (define-key viper-vi-basic-map "`" 'viper-goto-mark)
 383
 384 (define-key viper-vi-basic-map "a" 'viper-append)
 385 (define-key viper-vi-basic-map "b" 'viper-backward-word)
 386 (define-key viper-vi-basic-map "c" 'viper-command-argument)
 387 (define-key viper-vi-basic-map "d" 'viper-command-argument)
 388 (define-key viper-vi-basic-map "e" 'viper-end-of-word)
 389 (define-key viper-vi-basic-map "f" 'viper-find-char-forward)
 390 (define-key viper-vi-basic-map "g" 'viper-nil)
 391 (define-key viper-vi-basic-map "h" 'viper-backward-char)
 392 (define-key viper-vi-basic-map [backspace] 'viper-backward-char)
 393 (define-key viper-vi-basic-map "i" 'viper-insert)
 394 (define-key viper-vi-basic-map "j" 'viper-next-line)
 395 (define-key viper-vi-basic-map "k" 'viper-previous-line)
 396 (define-key viper-vi-basic-map "l" 'viper-forward-char)
 397 (define-key viper-vi-basic-map "m" 'viper-mark-point)
 398 (define-key viper-vi-basic-map "n" 'viper-search-next)
 399 (define-key viper-vi-basic-map "o" 'viper-open-line)
 400 (define-key viper-vi-basic-map "p" 'viper-put-back)
 401 (define-key viper-vi-basic-map "q" 'viper-nil)
 402 (define-key viper-vi-basic-map "r" 'viper-replace-char)
 403 (define-key viper-vi-basic-map "s" 'viper-substitute)
 404 (define-key viper-vi-basic-map "t" 'viper-goto-char-forward)
 405 (define-key viper-vi-basic-map "u" 'viper-undo)
 406 (define-key viper-vi-basic-map "v" 'find-file)
 407 (define-key viper-vi-basic-map "\C-v" 'find-file-other-frame)
 408 (define-key viper-vi-basic-map "w" 'viper-forward-word)
 409 (define-key viper-vi-basic-map "x" 'viper-delete-char)
 410 (define-key viper-vi-basic-map "y" 'viper-command-argument)
 411 (define-key viper-vi-basic-map "zH" 'viper-line-to-top)
 412 (define-key viper-vi-basic-map "zM" 'viper-line-to-middle)
 413 (define-key viper-vi-basic-map "zL" 'viper-line-to-bottom)
 414 (define-key viper-vi-basic-map "z\C-m" 'viper-line-to-top)
 415 (define-key viper-vi-basic-map "z." 'viper-line-to-middle)
 416 (define-key viper-vi-basic-map "z-" 'viper-line-to-bottom)
 417
 418 (define-key viper-vi-basic-map "{" 'viper-backward-paragraph)
 419 (define-key viper-vi-basic-map "|" 'viper-goto-col)
 420 (define-key viper-vi-basic-map "}" 'viper-forward-paragraph)
 421 (define-key viper-vi-basic-map "~" 'viper-toggle-case)
 422 (define-key viper-vi-basic-map "\C-?" 'viper-backward-char)
 423 (define-key viper-vi-basic-map "_" 'viper-nil)
 424
 425 ;;; This is viper-vi-diehard-map.  Used when viper-vi-diehard-minor-mode is on.
 426
 427 (define-key viper-vi-diehard-map "\C-a" 'viper-nil)
 428 (define-key viper-vi-diehard-map "\C-c" 'viper-nil)
 429 (define-key viper-vi-diehard-map "\C-g" 'viper-info-on-file)
 430 (define-key viper-vi-diehard-map "\C-i" 'viper-nil)
 431 (define-key viper-vi-diehard-map "\C-k" 'viper-nil)
 432 (define-key viper-vi-diehard-map "\C-l" 'redraw-display)
 433 (define-key viper-vi-diehard-map "\C-n" 'viper-next-line)
 434 (define-key viper-vi-diehard-map "\C-o" 'viper-nil)
 435 (define-key viper-vi-diehard-map "\C-p" 'viper-previous-line)
 436 (define-key viper-vi-diehard-map "\C-q" 'viper-nil)
 437 (define-key viper-vi-diehard-map "\C-r" 'redraw-display)
 438 (define-key viper-vi-diehard-map "\C-s" 'viper-nil)
 439 (define-key viper-vi-diehard-map "\C-t" 'viper-nil)
 440 (define-key viper-vi-diehard-map "\C-v" 'viper-nil)
 441 (define-key viper-vi-diehard-map "\C-w" 'viper-nil)
 442 (define-key viper-vi-diehard-map "@" 'viper-nil)
 443 (define-key viper-vi-diehard-map "_" 'viper-nil)
 444 (define-key viper-vi-diehard-map "*" 'viper-nil)
 445 (define-key viper-vi-diehard-map "#" 'viper-nil)
 446 (define-key viper-vi-diehard-map "\C-_" 'viper-nil)
 447 (define-key viper-vi-diehard-map "\C-]" 'viper-nil) ; This is actually tags.
 448
 449 \f
 450 ;;; Minibuffer keymap
 451
 452
 453 (defvar viper-minibuffer-map (make-sparse-keymap)
 454   "Keymap used to modify keys when Minibuffer is in Insert state.")
 455
 456 (define-key viper-minibuffer-map "\C-m" 'viper-exit-minibuffer)
 457 (define-key viper-minibuffer-map "\C-j" 'viper-exit-minibuffer)
 458
 459 ;; Map used to read Ex-style commands.
 460 (defvar viper-ex-cmd-map (make-sparse-keymap))
 461 (define-key viper-ex-cmd-map " "  'ex-cmd-read-exit)
 462 (define-key viper-ex-cmd-map "\t" 'ex-cmd-complete)
 463
 464 ;; Keymap for reading file names in Ex-style commands.
 465 (defvar ex-read-filename-map (make-sparse-keymap))
 466 (define-key ex-read-filename-map " " 'viper-complete-filename-or-exit)
 467 (define-key ex-read-filename-map "!" 'viper-handle-!)
 468
 469 ;; Some other maps
 470 (defvar viper-slash-and-colon-map (make-sparse-keymap)
 471   "This map redefines `/' and `:' to behave as in Vi.
 472 Useful in some modes, such as Gnus, MH, etc.")
 473 (define-key viper-slash-and-colon-map ":" 'viper-ex)
 474 (define-key viper-slash-and-colon-map "/" 'viper-search-forward)
 475
 476 (defvar viper-comint-mode-modifier-map (make-sparse-keymap)
 477   "This map modifies comint mode.")
 478 (define-key viper-comint-mode-modifier-map "\C-m" 'viper-exec-key-in-emacs)
 479 (define-key viper-comint-mode-modifier-map "\C-d" 'viper-exec-key-in-emacs)
 480
 481 (defvar viper-dired-modifier-map (make-sparse-keymap)
 482   "This map modifies Dired behavior.")
 483 (define-key viper-dired-modifier-map ":" 'viper-ex)
 484 (define-key viper-dired-modifier-map "/" 'viper-search-forward)
 485
 486 (defvar viper-gnus-modifier-map (make-sparse-keymap)
 487   "This map modifies Gnus behavior.")
 488 (define-key viper-gnus-modifier-map ":" 'viper-ex)
 489
 490
 491 \f
 492 ;;; Code
 493
 494 (defun viper-add-local-keys (state alist)
 495   "Override some vi-state or insert-state bindings in the current buffer.
 496 The effect is seen in the current buffer only.
 497 Useful for customizing  mailer buffers, gnus, etc.
 498 STATE is `vi-state', `insert-state', or `emacs-state'.
 499 ALIST is of the form ((key . func) (key . func) ...)
 500 Normally, this would be called from a hook to a major mode or
 501 on a per buffer basis.
 502 Usage:
 503       (viper-add-local-keys state \\='((key-str . func) (key-str . func)...))   "
 504
 505   (let (map)
 506     (cond ((eq state 'vi-state)
 507            (if viper-need-new-vi-local-map
 508                (setq viper-vi-local-user-map (make-sparse-keymap)))
 509            (setq viper-need-new-vi-local-map nil
 510                  map viper-vi-local-user-map))
 511           ((eq state 'insert-state)
 512            (if viper-need-new-insert-local-map
 513                (setq viper-insert-local-user-map (make-sparse-keymap)))
 514            (setq viper-need-new-insert-local-map nil
 515                  map viper-insert-local-user-map))
 516           ((eq state 'emacs-state)
 517            (if viper-need-new-emacs-local-map
 518                (setq viper-emacs-local-user-map (make-sparse-keymap)))
 519            (setq viper-need-new-emacs-local-map nil
 520                  map viper-emacs-local-user-map))
 521           (t
 522            (error
 523             "Invalid state in viper-add-local-keys: %S.  Valid states: vi-state, insert-state or emacs-state" state)))
 524
 525     (viper-modify-keymap map alist)
 526     (viper-normalize-minor-mode-map-alist)
 527     (viper-set-mode-vars-for viper-current-state)))
 528
 529 (defun viper-zap-local-keys ()
 530   "Unconditionally reset Viper viper-*-local-user-map's.
 531 Rarely useful, but if you made a mistake by switching to a mode that adds
 532 undesirable local keys, e.g., comint-mode, then this function can restore
 533 sanity."
 534   (interactive)
 535   (setq viper-vi-local-user-map (make-sparse-keymap)
 536         viper-need-new-vi-local-map nil
 537         viper-insert-local-user-map (make-sparse-keymap)
 538         viper-need-new-insert-local-map nil
 539         viper-emacs-local-user-map (make-sparse-keymap)
 540         viper-need-new-emacs-local-map nil)
 541   (viper-normalize-minor-mode-map-alist))
 542
 543
 544 (defun viper-modify-major-mode (mode state keymap)
 545   "Modify key bindings in a major-mode in a Viper state using a keymap.
 546
 547 If the default for a major mode is emacs-state, then modifications to this
 548 major mode may not take effect until the buffer switches state to Vi,
 549 Insert or Emacs.  If this happens, add viper-change-state-to-emacs to this
 550 major mode's hook.  If no such hook exists, you may have to put an advice on
 551 the function that invokes the major mode.  See viper-set-hooks for hints.
 552
 553 The above needs not to be done for major modes that come up in Vi or Insert
 554 state by default.
 555
 556 Arguments: (major-mode viper-state keymap)"
 557   (let ((alist
 558          (cond ((eq state 'vi-state) 'viper-vi-state-modifier-alist)
 559                ((eq state 'insert-state) 'viper-insert-state-modifier-alist)
 560                ((eq state 'emacs-state) 'viper-emacs-state-modifier-alist)))
 561         elt)
 562     (if (setq elt (assoc mode (eval alist)))
 563         (set alist (delq elt (eval alist))))
 564     (set alist (cons (cons mode keymap) (eval alist)))
 565
 566     ;; Normalization usually doesn't help here, since one needs to
 567     ;; normalize in the actual buffer where changes to the keymap are
 568     ;; to take place.  However, it doesn't hurt, and it helps whenever this
 569     ;; function is actually called from within the affected buffer.
 570     (viper-normalize-minor-mode-map-alist)
 571
 572     (viper-set-mode-vars-for viper-current-state)))
 573
 574
 575 ;; Displays variables that control Viper's keymaps
 576 (defun viper-debug-keymaps ()
 577   (interactive)
 578   (with-output-to-temp-buffer " *viper-debug*"
 579     (princ (format "Buffer name:  %s\n\n" (buffer-name)))
 580     (princ "Variables:  \n")
 581     (princ (format "major-mode:  %S\n" major-mode))
 582     (princ (format "viper-current-state:  %S\n" viper-current-state))
 583     (princ (format "viper-mode-string:  %S\n\n" viper-mode-string))
 584     (princ (format "viper-vi-intercept-minor-mode:  %S\n"
 585                    viper-vi-intercept-minor-mode))
 586     (princ (format "viper-insert-intercept-minor-mode:  %S\n"
 587                    viper-insert-intercept-minor-mode))
 588     (princ (format "viper-emacs-intercept-minor-mode:  %S\n"
 589                    viper-emacs-intercept-minor-mode))
 590     (princ (format "viper-vi-minibuffer-minor-mode:  %S\n"
 591                    viper-vi-minibuffer-minor-mode))
 592     (princ (format "viper-insert-minibuffer-minor-mode:  %S\n\n"
 593                    viper-insert-minibuffer-minor-mode))
 594     (princ (format "viper-vi-local-user-minor-mode:  %S\n"
 595                    viper-vi-local-user-minor-mode))
 596     (princ (format "viper-vi-global-user-minor-mode:  %S\n"
 597                    viper-vi-global-user-minor-mode))
 598     (princ (format "viper-vi-kbd-minor-mode:  %S\n" viper-vi-kbd-minor-mode))
 599     (princ (format "viper-vi-state-modifier-minor-mode:  %S\n"
 600                    viper-vi-state-modifier-minor-mode))
 601     (princ (format "viper-vi-diehard-minor-mode:  %S\n"
 602                    viper-vi-diehard-minor-mode))
 603     (princ (format "viper-vi-basic-minor-mode:  %S\n" viper-vi-basic-minor-mode))
 604     (princ (format "viper-replace-minor-mode:  %S\n" viper-replace-minor-mode))
 605     (princ (format "viper-insert-local-user-minor-mode:  %S\n"
 606                    viper-insert-local-user-minor-mode))
 607     (princ (format "viper-insert-global-user-minor-mode:  %S\n"
 608                    viper-insert-global-user-minor-mode))
 609     (princ (format "viper-insert-kbd-minor-mode:  %S\n"
 610                    viper-insert-kbd-minor-mode))
 611     (princ (format "viper-insert-state-modifier-minor-mode:  %S\n"
 612                    viper-insert-state-modifier-minor-mode))
 613     (princ (format "viper-insert-diehard-minor-mode:  %S\n"
 614                    viper-insert-diehard-minor-mode))
 615     (princ (format "viper-insert-basic-minor-mode:  %S\n"
 616                    viper-insert-basic-minor-mode))
 617     (princ (format "viper-emacs-local-user-minor-mode:  %S\n"
 618                    viper-emacs-local-user-minor-mode))
 619     (princ (format "viper-emacs-kbd-minor-mode:  %S\n"
 620                    viper-emacs-kbd-minor-mode))
 621     (princ (format "viper-emacs-global-user-minor-mode:  %S\n"
 622                    viper-emacs-global-user-minor-mode))
 623     (princ (format "viper-emacs-state-modifier-minor-mode:  %S\n"
 624                    viper-emacs-state-modifier-minor-mode))
 625
 626     (princ (format "\nviper-expert-level  %S\n" viper-expert-level))
 627     (princ (format "viper-no-multiple-ESC  %S\n" viper-no-multiple-ESC))
 628     (princ (format "viper-always  %S\n" viper-always))
 629     (princ (format "viper-ex-style-motion  %S\n"
 630                    viper-ex-style-motion))
 631     (princ (format "viper-ex-style-editing  %S\n"
 632                    viper-ex-style-editing))
 633     (princ (format "viper-want-emacs-keys-in-vi  %S\n"
 634                    viper-want-emacs-keys-in-vi))
 635     (princ (format "viper-want-emacs-keys-in-insert  %S\n"
 636                    viper-want-emacs-keys-in-insert))
 637     (princ (format "viper-want-ctl-h-help  %S\n" viper-want-ctl-h-help))
 638
 639     (princ "\n\n\n")
 640     (princ (format "Default value for minor-mode-map-alist:  \n%S\n\n"
 641                    (default-value 'minor-mode-map-alist)))
 642     (princ (format "Actual value for minor-mode-map-alist:  \n%S\n"
 643                    minor-mode-map-alist))
 644     ))
 645
 646
 647 ;;; Keymap utils
 648
 649 (defun viper-add-keymap (mapsrc mapdst)
 650   "Add contents of mapsrc to mapdst.  It is assumed that mapsrc is sparse."
 651   (if (featurep 'xemacs)
 652       ;; Emacs 22 has map-keymap.
 653       (map-keymap (lambda (key binding) (define-key mapdst key binding))
 654                   mapsrc)
 655     (mapc (lambda (p) (define-key mapdst (vector (car p)) (cdr p)))
 656           (cdr mapsrc))))
 657
 658 (defun viper-modify-keymap (map alist)
 659    "Modifies MAP with bindings specified in the ALIST.  The alist has the
 660 form ((key . function) (key . function) ... )."
 661    (mapcar (lambda (p) (define-key map (eval (car p)) (cdr p)))
 662            alist))
 663
 664
 665 (provide 'viper-keym)
 666
 667
 668 ;; Local Variables:
 669 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
 670 ;; End:
 671
 672
 673 ;;; viper-keym.el ends here