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