lisp/emulation/viper-keym.el

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