lisp/emulation/viper-keym.el

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