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