lisp/emulation/viper-keym.el

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