viper-keym.el 29.2 KB
Newer Older
Michael Kifer's avatar
Michael Kifer committed
1
;;; viper-keym.el --- Viper keymaps
Richard M. Stallman's avatar
Richard M. Stallman committed
2

3
;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 Free Software Foundation, Inc.
Karl Heuer's avatar
Karl Heuer committed
5

6
;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
7

Karl Heuer's avatar
Karl Heuer committed
8 9 10 11
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
12
;; the Free Software Foundation; either version 3, or (at your option)
Karl Heuer's avatar
Karl Heuer committed
13 14 15 16 17 18 19 20
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
21
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
22 23
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Karl Heuer's avatar
Karl Heuer committed
24

25 26 27
;;; Commentary:

;;; Code:
Michael Kifer's avatar
Michael Kifer committed
28

Michael Kifer's avatar
Michael Kifer committed
29
;; compiler pacifier
Michael Kifer's avatar
Michael Kifer committed
30
(defvar viper-always)
Michael Kifer's avatar
Michael Kifer committed
31 32
(defvar viper-current-state)
(defvar viper-mode-string)
Michael Kifer's avatar
Michael Kifer committed
33
(defvar viper-expert-level)
Michael Kifer's avatar
Michael Kifer committed
34
(defvar viper-ex-style-editing)
Michael Kifer's avatar
Michael Kifer committed
35
(defvar viper-ex-style-motion)
36 37 38

(eval-and-compile
  (unless (fboundp 'declare-function) (defmacro declare-function (&rest  r))))
Michael Kifer's avatar
Michael Kifer committed
39 40
;; end pacifier

Karl Heuer's avatar
Karl Heuer committed
41 42
(require 'viper-util)

43 44 45
(declare-function viper-ex "viper-ex" (arg &optional string))
(declare-function viper-normalize-minor-mode-map-alist "viper-cmd" ())
(declare-function viper-set-mode-vars-for "viper-cmd" (state))
Michael Kifer's avatar
Michael Kifer committed
46

Karl Heuer's avatar
Karl Heuer committed
47 48
;;; Variables

49 50

;;; Emacs keys in other states.
Michael Kifer's avatar
Michael Kifer committed
51

Michael Kifer's avatar
Michael Kifer committed
52
(defcustom viper-want-emacs-keys-in-insert t
Michael Kifer's avatar
Michael Kifer committed
53
  "*Set to nil if you want complete Vi compatibility in insert mode.
Michael Kifer's avatar
Michael Kifer committed
54 55 56
Complete compatibility with Vi is not recommended for power use of Viper."
  :type 'boolean
  :group 'viper)
Michael Kifer's avatar
Michael Kifer committed
57

Michael Kifer's avatar
Michael Kifer committed
58
(defcustom viper-want-emacs-keys-in-vi t
Michael Kifer's avatar
Michael Kifer committed
59
  "*Set to nil if you want complete Vi compatibility in Vi mode.
Michael Kifer's avatar
Michael Kifer committed
60 61 62
Full Vi compatibility is not recommended for power use of Viper."
  :type 'boolean
  :group 'viper)
Michael Kifer's avatar
Michael Kifer committed
63

Michael Kifer's avatar
Michael Kifer committed
64
(defcustom viper-no-multiple-ESC  t
Michael Kifer's avatar
Michael Kifer committed
65 66
  "*If true, multiple ESC in Vi mode will cause bell to ring.
This is set to t on a windowing terminal and to 'twice on a dumb
Michael Kifer's avatar
Michael Kifer committed
67
terminal (unless the user level is 1, 2, or 5).  On a dumb terminal, this
Michael Kifer's avatar
Michael Kifer committed
68 69
enables cursor keys and is generally more convenient, as terminals usually
don't have a convenient Meta key.
Michael Kifer's avatar
Michael Kifer committed
70
Setting viper-no-multiple-ESC to nil will allow as many multiple ESC,
Michael Kifer's avatar
Michael Kifer committed
71 72
as is allowed by the major mode in effect."
  :type 'boolean
73
  :group 'viper)
Michael Kifer's avatar
Michael Kifer committed
74

Michael Kifer's avatar
Michael Kifer committed
75
(defcustom viper-want-ctl-h-help nil
Michael Kifer's avatar
Michael Kifer committed
76
  "*If non-nil, C-h gets bound to help-command; otherwise, C-h gets the usual Vi bindings."
Michael Kifer's avatar
Michael Kifer committed
77 78
  :type 'boolean
  :group 'viper)
Michael Kifer's avatar
Michael Kifer committed
79 80


Karl Heuer's avatar
Karl Heuer committed
81 82 83 84
;;; Keymaps

;; Keymaps for vital things like \e and C-z.
;; Not for users
Michael Kifer's avatar
Michael Kifer committed
85 86 87
(defvar viper-vi-intercept-map (make-sparse-keymap))
(defvar viper-insert-intercept-map (make-sparse-keymap))
(defvar viper-emacs-intercept-map (make-sparse-keymap))
88

Michael Kifer's avatar
Michael Kifer committed
89 90
;; keymap used to zap all keymaps other than function-key-map,
;; device-function-key-map, etc.
Michael Kifer's avatar
Michael Kifer committed
91
(defvar viper-overriding-map (make-sparse-keymap))
92

Michael Kifer's avatar
Michael Kifer committed
93
(viper-deflocalvar viper-vi-local-user-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
94 95 96
  "Keymap for user-defined local bindings.
Useful for changing bindings such as ZZ in certain major modes.
For instance, in letter-mode, one may want to bind ZZ to
Michael Kifer's avatar
Michael Kifer committed
97
mh-send-letter.  In a newsreader such as gnus, tin, or rn, ZZ could be bound
Karl Heuer's avatar
Karl Heuer committed
98
to save-buffers-kill-emacs then post article, etc.")
99
(put 'viper-vi-local-user-map 'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
100

Michael Kifer's avatar
Michael Kifer committed
101
(defvar viper-vi-global-user-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
102 103 104
  "Keymap for user-defined global bindings.
These bindings are seen in all Viper buffers.")

Michael Kifer's avatar
Michael Kifer committed
105
(defvar viper-vi-basic-map (make-keymap)
Karl Heuer's avatar
Karl Heuer committed
106 107 108
  "This is the main keymap in effect in Viper's Vi state.
This map is global, shared by all buffers.")

Michael Kifer's avatar
Michael Kifer committed
109
(defvar  viper-vi-kbd-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
110 111
  "This keymap keeps keyboard macros defined via the :map command.")

Michael Kifer's avatar
Michael Kifer committed
112
(defvar viper-vi-diehard-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
113
  "This keymap is in use when the user asks Viper to simulate Vi very closely.
Michael Kifer's avatar
Michael Kifer committed
114
This happens when viper-expert-level is 1 or 2.  See viper-set-expert-level.")
115

Karl Heuer's avatar
Karl Heuer committed
116

Michael Kifer's avatar
Michael Kifer committed
117
(viper-deflocalvar viper-insert-local-user-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
118
  "Auxiliary map for per-buffer user-defined keybindings in Insert state.")
119
(put 'viper-insert-local-user-map 'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
120

Michael Kifer's avatar
Michael Kifer committed
121
(defvar viper-insert-global-user-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
122 123
  "Auxiliary map for global user-defined bindings in Insert state.")

Michael Kifer's avatar
Michael Kifer committed
124
(defvar viper-insert-basic-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
125 126
  "The basic insert-mode keymap.")

Michael Kifer's avatar
Michael Kifer committed
127
(defvar viper-insert-diehard-map (make-keymap)
Karl Heuer's avatar
Karl Heuer committed
128
  "Map used when user wants vi-style keys in insert mode.
Michael Kifer's avatar
Michael Kifer committed
129 130
Most of the Emacs keys are suppressed.  This map overshadows
viper-insert-basic-map.  Not recommended, except for novice users.")
Karl Heuer's avatar
Karl Heuer committed
131

Michael Kifer's avatar
Michael Kifer committed
132
(defvar  viper-insert-kbd-map  (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
133 134
  "This keymap keeps VI-style kbd macros for insert mode.")

Michael Kifer's avatar
Michael Kifer committed
135
(defvar viper-replace-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
136
  "Map used in Viper's replace state.")
137

Michael Kifer's avatar
Michael Kifer committed
138
(defvar viper-emacs-global-user-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
139 140
  "Auxiliary map for global user-defined bindings in Emacs state.")

Michael Kifer's avatar
Michael Kifer committed
141
(defvar  viper-emacs-kbd-map  (make-sparse-keymap)
142
  "This keymap keeps Vi-style kbd macros for Emacs mode.")
143

Michael Kifer's avatar
Michael Kifer committed
144
(viper-deflocalvar viper-emacs-local-user-map  (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
145
  "Auxiliary map for local user-defined bindings in Emacs state.")
146
(put 'viper-emacs-local-user-map 'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
147 148

;; This keymap should stay empty
Michael Kifer's avatar
Michael Kifer committed
149
(defvar viper-empty-keymap (make-sparse-keymap))
Karl Heuer's avatar
Karl Heuer committed
150

151
;; This was the main Vi mode in old versions of VIP which may have been
Michael Kifer's avatar
Michael Kifer committed
152
;; extensively used by VIP users.  We declare it as a global var
Michael Kifer's avatar
Michael Kifer committed
153 154
;; and, after .viper is loaded, we add this keymap to viper-vi-basic-map.
(defvar viper-mode-map (make-sparse-keymap))
155

156 157
;; Some important keys used in viper
(defcustom viper-toggle-key [(control ?z)]  ; "\C-z"
158
  "The key used to change states from Emacs to Vi and back.
159 160
In insert mode, this key also functions as Meta.

161
Enter as a sexp.  Examples: \"\\C-z\", [(control ?z)]."
162 163 164 165 166 167
  :type 'sexp
  :group 'viper
  :set (lambda (symbol value)
	 (let ((old-value (if (boundp 'viper-toggle-key)
			      viper-toggle-key
			    [(control ?z)])))
168
	   (mapc
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
	    (lambda (buf)
	      (save-excursion
		(set-buffer buf)
		(when (and (boundp 'viper-insert-basic-map)
			   (keymapp viper-insert-basic-map))
		  (when old-value
		    (define-key viper-insert-basic-map old-value nil))
		  (define-key viper-insert-basic-map value 'viper-escape-to-vi))
		(when (and (boundp 'viper-vi-intercept-map)
			   (keymapp viper-vi-intercept-map))
		  (when old-value
		    (define-key viper-vi-intercept-map old-value nil))
		  (define-key
		    viper-vi-intercept-map value 'viper-toggle-key-action))
		(when (and (boundp 'viper-emacs-intercept-map)
			   (keymapp viper-emacs-intercept-map))
		  (define-key viper-emacs-intercept-map old-value nil)
		  (define-key
		    viper-emacs-intercept-map value 'viper-change-state-to-vi))
		))
	    (buffer-list))
	   (set-default symbol value)
           )))

(defcustom viper-quoted-insert-key "\C-v"
  "The key used to quote special characters when inserting them in Insert state."
  :type 'string
  :group 'viper)

198
(defcustom viper-ESC-key (if (viper-window-display-p) [(escape)] "\e")
199
  "Key used to ESC.
200 201
Enter as a sexp. Examples: \"\\e\", [(escape)].
If running in a terminal, [(escape)] is not understood, so must use \"\\e\"."
202 203 204 205 206 207
  :type 'sexp
  :group 'viper
  :set (lambda (symbol value)
	 (let ((old-value (if (boundp 'viper-ESC-key)
			      viper-ESC-key
			    [(escape)])))
208
	   (mapc
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
	    (lambda (buf)
	      (save-excursion
		(set-buffer buf)
		(when (and (boundp 'viper-insert-intercept-map)
			   (keymapp viper-insert-intercept-map))
		  (when old-value
		    (define-key viper-insert-intercept-map old-value nil))
		  (define-key
		    viper-insert-intercept-map value 'viper-intercept-ESC-key))
		(when (and (boundp 'viper-vi-intercept-map)
			   (keymapp viper-vi-intercept-map))
		  (when old-value
		    (define-key viper-vi-intercept-map old-value nil))
		  (define-key
		    viper-vi-intercept-map value 'viper-intercept-ESC-key))
		))
	    (buffer-list))
	   (set-default symbol value)
           )))

Karl Heuer's avatar
Karl Heuer committed
229 230 231

;;; Variables used by minor modes

232
;; Association list of the form
Karl Heuer's avatar
Karl Heuer committed
233 234 235
;; ((major-mode . keymap) (major-mode . keymap) ...)
;; Viper uses these keymaps to make user-requested adjustments
;; to its Vi state in various major modes.")
Michael Kifer's avatar
Michael Kifer committed
236
(defvar viper-vi-state-modifier-alist nil)
Karl Heuer's avatar
Karl Heuer committed
237

238
;; Association list of the form
Karl Heuer's avatar
Karl Heuer committed
239 240 241
;; ((major-mode . keymap) (major-mode . keymap) ...)
;; Viper uses these keymaps to make user-requested adjustments
;; to its Insert state in various major modes.")
Michael Kifer's avatar
Michael Kifer committed
242
(defvar viper-insert-state-modifier-alist nil)
Karl Heuer's avatar
Karl Heuer committed
243

244
;; Association list of the form
Karl Heuer's avatar
Karl Heuer committed
245 246 247
;; ((major-mode . keymap) (major-mode . keymap) ...)
;; Viper uses these keymaps to make user-requested adjustments
;; to its Emacs state in various major modes.
Michael Kifer's avatar
Michael Kifer committed
248
(defvar viper-emacs-state-modifier-alist nil)
Karl Heuer's avatar
Karl Heuer committed
249

250 251 252 253
;; The list of viper keymaps. Set by viper-normalize-minor-mode-map-alist
(viper-deflocalvar viper--key-maps nil)
(viper-deflocalvar viper--intercept-key-maps nil)

Michael Kifer's avatar
Michael Kifer committed
254
;; Tells viper-add-local-keys to create a new viper-vi-local-user-map for new
Michael Kifer's avatar
Michael Kifer committed
255
;; buffers.  Not a user option.
Michael Kifer's avatar
Michael Kifer committed
256 257
(viper-deflocalvar viper-need-new-vi-local-map t "")
(put 'viper-need-new-vi-local-map  'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
258

Michael Kifer's avatar
Michael Kifer committed
259
;; Tells viper-add-local-keys to create a new viper-insert-local-user-map for
Michael Kifer's avatar
Michael Kifer committed
260
;; new buffers.  Not a user option.
Michael Kifer's avatar
Michael Kifer committed
261 262
(viper-deflocalvar viper-need-new-insert-local-map t "")
(put 'viper-need-new-insert-local-map  'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
263

Michael Kifer's avatar
Michael Kifer committed
264
;; Tells viper-add-local-keys to create a new viper-emacs-local-user-map for
Michael Kifer's avatar
Michael Kifer committed
265
;; new buffers.  Not a user option.
Michael Kifer's avatar
Michael Kifer committed
266 267
(viper-deflocalvar viper-need-new-emacs-local-map t "")
(put 'viper-need-new-emacs-local-map  'permanent-local t)
Karl Heuer's avatar
Karl Heuer committed
268 269 270 271 272 273



;; Insert mode keymap

;; for novice users, pretend you are the real vi.
Michael Kifer's avatar
Michael Kifer committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
(define-key viper-insert-diehard-map "\t"   'viper-insert-tab)
(define-key viper-insert-diehard-map "\C-a" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-b" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-c" 'viper-change-state-to-vi)
(define-key viper-insert-diehard-map "\C-e" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-f" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-g" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-i" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-k" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-l" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-n" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-o" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-p" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-q" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-r" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-s" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-u" 'viper-erase-line)
(define-key viper-insert-diehard-map "\C-x" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-y" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-z" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-]" 'self-insert-command)
(define-key viper-insert-diehard-map "\C-_" 'self-insert-command)
Karl Heuer's avatar
Karl Heuer committed
296 297 298

(let ((i ?\ ))
  (while (<= i ?~)
Michael Kifer's avatar
Michael Kifer committed
299
    (define-key viper-insert-diehard-map (make-string 1 i) 'self-insert-command)
Karl Heuer's avatar
Karl Heuer committed
300 301 302
    (setq i (1+ i))))

;; Insert mode map when user wants emacs style
Michael Kifer's avatar
Michael Kifer committed
303 304 305
(define-key viper-insert-basic-map "\C-d" 'viper-backward-indent)
(define-key viper-insert-basic-map "\C-w" 'viper-delete-backward-word)
(define-key viper-insert-basic-map "\C-t" 'viper-forward-indent)
306
(define-key viper-insert-basic-map viper-quoted-insert-key 'quoted-insert)
Michael Kifer's avatar
Michael Kifer committed
307
(define-key viper-insert-basic-map "\C-?" 'viper-del-backward-char-in-insert)
Michael Kifer's avatar
Michael Kifer committed
308
(define-key viper-insert-basic-map [backspace] 'viper-del-backward-char-in-insert)
Michael Kifer's avatar
Michael Kifer committed
309 310 311 312 313 314
(define-key viper-insert-basic-map "\C-\\" 'viper-alternate-Meta-key)
(define-key viper-insert-basic-map viper-toggle-key 'viper-escape-to-vi)
(define-key viper-insert-basic-map "\C-c\M-p"
  'viper-insert-prev-from-insertion-ring)
(define-key viper-insert-basic-map "\C-c\M-n"
  'viper-insert-next-from-insertion-ring)
Karl Heuer's avatar
Karl Heuer committed
315 316 317


;; Replace keymap
Michael Kifer's avatar
Michael Kifer committed
318 319 320 321
(define-key viper-replace-map "\C-t" 'viper-forward-indent)
(define-key viper-replace-map "\C-j" 'viper-replace-state-carriage-return)
(define-key viper-replace-map "\C-m" 'viper-replace-state-carriage-return)
(define-key viper-replace-map "\C-?" 'viper-del-backward-char-in-replace)
Michael Kifer's avatar
Michael Kifer committed
322
(define-key viper-replace-map [backspace] 'viper-del-backward-char-in-replace)
Karl Heuer's avatar
Karl Heuer committed
323 324 325 326 327



;; Vi keymaps

Michael Kifer's avatar
Michael Kifer committed
328 329
(define-key viper-vi-basic-map "\C-^" (lambda ()
					(interactive) (viper-ex nil "e#")))
Michael Kifer's avatar
Michael Kifer committed
330 331 332 333 334 335 336
(define-key viper-vi-basic-map "\C-b" 'viper-scroll-screen-back)
(define-key viper-vi-basic-map "\C-d" 'viper-scroll-up)
(define-key viper-vi-basic-map "\C-e" 'viper-scroll-up-one)
(define-key viper-vi-basic-map "\C-f" 'viper-scroll-screen)
(define-key viper-vi-basic-map "\C-m" 'viper-next-line-at-bol)
(define-key viper-vi-basic-map "\C-u" 'viper-scroll-down)
(define-key viper-vi-basic-map "\C-y" 'viper-scroll-down-one)
337 338
;;(define-key viper-vi-basic-map "\C-s" 'viper-isearch-forward)
;;(define-key viper-vi-basic-map "\C-r" 'viper-isearch-backward)
Michael Kifer's avatar
Michael Kifer committed
339
(define-key viper-vi-basic-map "\C-c/" 'viper-toggle-search-style)
Michael Kifer's avatar
Michael Kifer committed
340
(define-key viper-vi-basic-map "\C-c\C-g" 'viper-info-on-file)
Michael Kifer's avatar
Michael Kifer committed
341 342 343 344 345 346 347 348 349 350 351

(define-key viper-vi-basic-map "\C-c\M-p" 'viper-prev-destructive-command)
(define-key viper-vi-basic-map "\C-c\M-n" 'viper-next-destructive-command)


(define-key viper-vi-basic-map " " 'viper-forward-char)
(define-key viper-vi-basic-map "!" 'viper-command-argument)
(define-key viper-vi-basic-map "\"" 'viper-command-argument)
(define-key viper-vi-basic-map "#" 'viper-command-argument)
(define-key viper-vi-basic-map "$" 'viper-goto-eol)
(define-key viper-vi-basic-map "%" 'viper-paren-match)
Michael Kifer's avatar
Michael Kifer committed
352 353
(define-key viper-vi-basic-map "&" (lambda ()
				     (interactive) (viper-ex nil "&")))
Michael Kifer's avatar
Michael Kifer committed
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
(define-key viper-vi-basic-map "'" 'viper-goto-mark-and-skip-white)
(define-key viper-vi-basic-map "(" 'viper-backward-sentence)
(define-key viper-vi-basic-map ")" 'viper-forward-sentence)
(define-key viper-vi-basic-map "*" 'call-last-kbd-macro)
(define-key viper-vi-basic-map "+" 'viper-next-line-at-bol)
(define-key viper-vi-basic-map "," 'viper-repeat-find-opposite)
(define-key viper-vi-basic-map "-" 'viper-previous-line-at-bol)
(define-key viper-vi-basic-map "." 'viper-repeat)
(define-key viper-vi-basic-map "/" 'viper-search-forward)

(define-key viper-vi-basic-map "0" 'viper-beginning-of-line)
(define-key viper-vi-basic-map "1" 'viper-digit-argument)
(define-key viper-vi-basic-map "2" 'viper-digit-argument)
(define-key viper-vi-basic-map "3" 'viper-digit-argument)
(define-key viper-vi-basic-map "4" 'viper-digit-argument)
(define-key viper-vi-basic-map "5" 'viper-digit-argument)
(define-key viper-vi-basic-map "6" 'viper-digit-argument)
(define-key viper-vi-basic-map "7" 'viper-digit-argument)
(define-key viper-vi-basic-map "8" 'viper-digit-argument)
(define-key viper-vi-basic-map "9" 'viper-digit-argument)

(define-key viper-vi-basic-map ":" 'viper-ex)
(define-key viper-vi-basic-map ";" 'viper-repeat-find)
(define-key viper-vi-basic-map "<" 'viper-command-argument)
(define-key viper-vi-basic-map "=" 'viper-command-argument)
(define-key viper-vi-basic-map ">" 'viper-command-argument)
(define-key viper-vi-basic-map "?" 'viper-search-backward)
(define-key viper-vi-basic-map "@" 'viper-register-macro)

(define-key viper-vi-basic-map "A" 'viper-Append)
(define-key viper-vi-basic-map "B" 'viper-backward-Word)
(define-key viper-vi-basic-map "C" 'viper-change-to-eol)
(define-key viper-vi-basic-map "D" 'viper-kill-line)
(define-key viper-vi-basic-map "E" 'viper-end-of-Word)
(define-key viper-vi-basic-map "F" 'viper-find-char-backward)
(define-key viper-vi-basic-map "G" 'viper-goto-line)
(define-key viper-vi-basic-map "H" 'viper-window-top)
(define-key viper-vi-basic-map "I" 'viper-Insert)
(define-key viper-vi-basic-map "J" 'viper-join-lines)
(define-key viper-vi-basic-map "K" 'viper-nil)
(define-key viper-vi-basic-map "L" 'viper-window-bottom)
(define-key viper-vi-basic-map "M" 'viper-window-middle)
(define-key viper-vi-basic-map "N" 'viper-search-Next)
(define-key viper-vi-basic-map "O" 'viper-Open-line)
(define-key viper-vi-basic-map "P" 'viper-Put-back)
(define-key viper-vi-basic-map "Q" 'viper-query-replace)
(define-key viper-vi-basic-map "R" 'viper-overwrite)
(define-key viper-vi-basic-map "S" 'viper-substitute-line)
(define-key viper-vi-basic-map "T" 'viper-goto-char-backward)
(define-key viper-vi-basic-map "U" 'viper-undo)
(define-key viper-vi-basic-map "V" 'find-file-other-window)
(define-key viper-vi-basic-map "W" 'viper-forward-Word)
(define-key viper-vi-basic-map "X" 'viper-delete-backward-char)
(define-key viper-vi-basic-map "Y" 'viper-yank-line)
(define-key viper-vi-basic-map "ZZ" 'viper-save-kill-buffer)

(define-key viper-vi-basic-map "\\" 'viper-escape-to-emacs)
(define-key viper-vi-basic-map "[" 'viper-brac-function)
(define-key viper-vi-basic-map "]" 'viper-ket-function)
(define-key viper-vi-basic-map "\C-\\" 'viper-alternate-Meta-key)
(define-key viper-vi-basic-map "^" 'viper-bol-and-skip-white)
(define-key viper-vi-basic-map "`" 'viper-goto-mark)

(define-key viper-vi-basic-map "a" 'viper-append)
(define-key viper-vi-basic-map "b" 'viper-backward-word)
(define-key viper-vi-basic-map "c" 'viper-command-argument)
(define-key viper-vi-basic-map "d" 'viper-command-argument)
(define-key viper-vi-basic-map "e" 'viper-end-of-word)
(define-key viper-vi-basic-map "f" 'viper-find-char-forward)
(define-key viper-vi-basic-map "g" 'viper-nil)
(define-key viper-vi-basic-map "h" 'viper-backward-char)
Michael Kifer's avatar
Michael Kifer committed
425
(define-key viper-vi-basic-map [backspace] 'viper-backward-char)
Michael Kifer's avatar
Michael Kifer committed
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
(define-key viper-vi-basic-map "i" 'viper-insert)
(define-key viper-vi-basic-map "j" 'viper-next-line)
(define-key viper-vi-basic-map "k" 'viper-previous-line)
(define-key viper-vi-basic-map "l" 'viper-forward-char)
(define-key viper-vi-basic-map "m" 'viper-mark-point)
(define-key viper-vi-basic-map "n" 'viper-search-next)
(define-key viper-vi-basic-map "o" 'viper-open-line)
(define-key viper-vi-basic-map "p" 'viper-put-back)
(define-key viper-vi-basic-map "q" 'viper-nil)
(define-key viper-vi-basic-map "r" 'viper-replace-char)
(define-key viper-vi-basic-map "s" 'viper-substitute)
(define-key viper-vi-basic-map "t" 'viper-goto-char-forward)
(define-key viper-vi-basic-map "u" 'viper-undo)
(define-key viper-vi-basic-map "v" 'find-file)
(define-key viper-vi-basic-map "\C-v" 'find-file-other-frame)
(define-key viper-vi-basic-map "w" 'viper-forward-word)
(define-key viper-vi-basic-map "x" 'viper-delete-char)
(define-key viper-vi-basic-map "y" 'viper-command-argument)
(define-key viper-vi-basic-map "zH" 'viper-line-to-top)
(define-key viper-vi-basic-map "zM" 'viper-line-to-middle)
(define-key viper-vi-basic-map "zL" 'viper-line-to-bottom)
(define-key viper-vi-basic-map "z\C-m" 'viper-line-to-top)
(define-key viper-vi-basic-map "z." 'viper-line-to-middle)
(define-key viper-vi-basic-map "z-" 'viper-line-to-bottom)

(define-key viper-vi-basic-map "{" 'viper-backward-paragraph)
(define-key viper-vi-basic-map "|" 'viper-goto-col)
(define-key viper-vi-basic-map "}" 'viper-forward-paragraph)
(define-key viper-vi-basic-map "~" 'viper-toggle-case)
(define-key viper-vi-basic-map "\C-?" 'viper-backward-char)
(define-key viper-vi-basic-map "_" 'viper-nil)

Michael Kifer's avatar
Michael Kifer committed
458
;;; This is viper-vi-diehard-map.  Used when viper-vi-diehard-minor-mode is on.
Michael Kifer's avatar
Michael Kifer committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480

(define-key viper-vi-diehard-map "\C-a" 'viper-nil)
(define-key viper-vi-diehard-map "\C-c" 'viper-nil)
(define-key viper-vi-diehard-map "\C-g" 'viper-info-on-file)
(define-key viper-vi-diehard-map "\C-i" 'viper-nil)
(define-key viper-vi-diehard-map "\C-k" 'viper-nil)
(define-key viper-vi-diehard-map "\C-l" 'redraw-display)
(define-key viper-vi-diehard-map "\C-n" 'viper-next-line)
(define-key viper-vi-diehard-map "\C-o" 'viper-nil)
(define-key viper-vi-diehard-map "\C-p" 'viper-previous-line)
(define-key viper-vi-diehard-map "\C-q" 'viper-nil)
(define-key viper-vi-diehard-map "\C-r" 'redraw-display)
(define-key viper-vi-diehard-map "\C-s" 'viper-nil)
(define-key viper-vi-diehard-map "\C-t" 'viper-nil)
(define-key viper-vi-diehard-map "\C-v" 'viper-nil)
(define-key viper-vi-diehard-map "\C-w" 'viper-nil)
(define-key viper-vi-diehard-map "@" 'viper-nil)
(define-key viper-vi-diehard-map "_" 'viper-nil)
(define-key viper-vi-diehard-map "*" 'viper-nil)
(define-key viper-vi-diehard-map "#" 'viper-nil)
(define-key viper-vi-diehard-map "\C-_" 'viper-nil)
(define-key viper-vi-diehard-map "\C-]" 'viper-nil) ; This is actually tags.
Karl Heuer's avatar
Karl Heuer committed
481 482 483


;;; Minibuffer keymap
484

Karl Heuer's avatar
Karl Heuer committed
485

Michael Kifer's avatar
Michael Kifer committed
486
(defvar viper-minibuffer-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
487
  "Keymap used to modify keys when Minibuffer is in Insert state.")
488

Michael Kifer's avatar
Michael Kifer committed
489 490
(define-key viper-minibuffer-map "\C-m" 'viper-exit-minibuffer)
(define-key viper-minibuffer-map "\C-j" 'viper-exit-minibuffer)
Karl Heuer's avatar
Karl Heuer committed
491 492

;; Map used to read Ex-style commands.
Michael Kifer's avatar
Michael Kifer committed
493 494 495
(defvar viper-ex-cmd-map (make-sparse-keymap))
(define-key viper-ex-cmd-map " "  'ex-cmd-read-exit)
(define-key viper-ex-cmd-map "\t" 'ex-cmd-complete)
Karl Heuer's avatar
Karl Heuer committed
496 497 498

;; Keymap for reading file names in Ex-style commands.
(defvar ex-read-filename-map (make-sparse-keymap))
Michael Kifer's avatar
Michael Kifer committed
499 500
(define-key ex-read-filename-map " " 'viper-complete-filename-or-exit)
(define-key ex-read-filename-map "!" 'viper-handle-!)
Karl Heuer's avatar
Karl Heuer committed
501

Michael Kifer's avatar
Michael Kifer committed
502
;; Some other maps
Michael Kifer's avatar
Michael Kifer committed
503
(defvar viper-slash-and-colon-map (make-sparse-keymap)
Michael Kifer's avatar
Michael Kifer committed
504 505
  "This map redefines `/' and `:' to behave as in Vi.
Useful in some modes, such as Gnus, MH, etc.")
Michael Kifer's avatar
Michael Kifer committed
506 507
(define-key viper-slash-and-colon-map ":" 'viper-ex)
(define-key viper-slash-and-colon-map "/" 'viper-search-forward)
Michael Kifer's avatar
Michael Kifer committed
508

Michael Kifer's avatar
Michael Kifer committed
509
(defvar viper-comint-mode-modifier-map (make-sparse-keymap)
Michael Kifer's avatar
Michael Kifer committed
510
  "This map modifies comint mode.")
511 512
(define-key viper-comint-mode-modifier-map "\C-m" 'viper-exec-key-in-emacs)
(define-key viper-comint-mode-modifier-map "\C-d" 'viper-exec-key-in-emacs)
Michael Kifer's avatar
Michael Kifer committed
513

Michael Kifer's avatar
Michael Kifer committed
514
(defvar viper-dired-modifier-map (make-sparse-keymap)
Michael Kifer's avatar
Michael Kifer committed
515
  "This map modifies Dired behavior.")
Michael Kifer's avatar
Michael Kifer committed
516 517
(define-key viper-dired-modifier-map ":" 'viper-ex)
(define-key viper-dired-modifier-map "/" 'viper-search-forward)
Michael Kifer's avatar
Michael Kifer committed
518

519 520 521 522
(defvar viper-gnus-modifier-map (make-sparse-keymap)
  "This map modifies Gnus behavior.")
(define-key viper-gnus-modifier-map ":" 'viper-ex)

Karl Heuer's avatar
Karl Heuer committed
523 524 525 526


;;; Code

Michael Kifer's avatar
Michael Kifer committed
527
(defun viper-add-local-keys (state alist)
Karl Heuer's avatar
Karl Heuer committed
528 529 530 531 532 533 534 535
  "Override some vi-state or insert-state bindings in the current buffer.
The effect is seen in the current buffer only.
Useful for customizing  mailer buffers, gnus, etc.
STATE is 'vi-state, 'insert-state, or 'emacs-state
ALIST is of the form ((key . func) (key . func) ...)
Normally, this would be called from a hook to a major mode or
on a per buffer basis.
Usage:
Michael Kifer's avatar
Michael Kifer committed
536
      (viper-add-local-keys state '((key-str . func) (key-str . func)...))   "
537

Karl Heuer's avatar
Karl Heuer committed
538 539
  (let (map)
    (cond ((eq state 'vi-state)
Michael Kifer's avatar
Michael Kifer committed
540 541 542 543
	   (if viper-need-new-vi-local-map
	       (setq viper-vi-local-user-map (make-sparse-keymap)))
	   (setq viper-need-new-vi-local-map nil
		 map viper-vi-local-user-map))
Karl Heuer's avatar
Karl Heuer committed
544
	  ((eq state 'insert-state)
Michael Kifer's avatar
Michael Kifer committed
545 546 547 548
	   (if viper-need-new-insert-local-map
	       (setq viper-insert-local-user-map (make-sparse-keymap)))
	   (setq viper-need-new-insert-local-map nil
		 map viper-insert-local-user-map))
Karl Heuer's avatar
Karl Heuer committed
549
	  ((eq state 'emacs-state)
Michael Kifer's avatar
Michael Kifer committed
550 551 552 553
	   (if viper-need-new-emacs-local-map
	       (setq viper-emacs-local-user-map (make-sparse-keymap)))
	   (setq viper-need-new-emacs-local-map nil
		 map viper-emacs-local-user-map))
554
	  (t
Karl Heuer's avatar
Karl Heuer committed
555
	   (error
Michael Kifer's avatar
Michael Kifer committed
556
	    "Invalid state in viper-add-local-keys: %S.  Valid states: vi-state, insert-state or emacs-state" state)))
Karl Heuer's avatar
Karl Heuer committed
557

Michael Kifer's avatar
Michael Kifer committed
558 559 560
    (viper-modify-keymap map alist)
    (viper-normalize-minor-mode-map-alist)
    (viper-set-mode-vars-for viper-current-state)))
Michael Kifer's avatar
Michael Kifer committed
561

Michael Kifer's avatar
Michael Kifer committed
562 563
(defun viper-zap-local-keys ()
  "Unconditionally reset Viper viper-*-local-user-map's.
564
Rarely useful, but if you made a mistake by switching to a mode that adds
Michael Kifer's avatar
Michael Kifer committed
565 566
undesirable local keys, e.g., comint-mode, then this function can restore
sanity."
Michael Kifer's avatar
Michael Kifer committed
567
  (interactive)
Michael Kifer's avatar
Michael Kifer committed
568 569 570 571 572 573 574
  (setq viper-vi-local-user-map (make-sparse-keymap)
	viper-need-new-vi-local-map nil
	viper-insert-local-user-map (make-sparse-keymap)
	viper-need-new-insert-local-map nil
	viper-emacs-local-user-map (make-sparse-keymap)
	viper-need-new-emacs-local-map nil)
  (viper-normalize-minor-mode-map-alist))
575

Karl Heuer's avatar
Karl Heuer committed
576

Michael Kifer's avatar
Michael Kifer committed
577
(defun viper-modify-major-mode (mode state keymap)
Karl Heuer's avatar
Karl Heuer committed
578 579 580 581
  "Modify key bindings in a major-mode in a Viper state using a keymap.

If the default for a major mode is emacs-state, then modifications to this
major mode may not take effect until the buffer switches state to Vi,
Michael Kifer's avatar
Michael Kifer committed
582 583 584
Insert or Emacs.  If this happens, add viper-change-state-to-emacs to this
major mode's hook.  If no such hook exists, you may have to put an advice on
the function that invokes the major mode.  See viper-set-hooks for hints.
Karl Heuer's avatar
Karl Heuer committed
585 586 587 588

The above needs not to be done for major modes that come up in Vi or Insert
state by default.

Michael Kifer's avatar
Michael Kifer committed
589
Arguments: (major-mode viper-state keymap)"
Karl Heuer's avatar
Karl Heuer committed
590
  (let ((alist
Michael Kifer's avatar
Michael Kifer committed
591 592 593
	 (cond ((eq state 'vi-state) 'viper-vi-state-modifier-alist)
	       ((eq state 'insert-state) 'viper-insert-state-modifier-alist)
	       ((eq state 'emacs-state) 'viper-emacs-state-modifier-alist)))
Karl Heuer's avatar
Karl Heuer committed
594 595 596 597
	elt)
    (if (setq elt (assoc mode (eval alist)))
	(set alist (delq elt (eval alist))))
    (set alist (cons (cons mode keymap) (eval alist)))
598

Karl Heuer's avatar
Karl Heuer committed
599 600
    ;; Normalization usually doesn't help here, since one needs to
    ;; normalize in the actual buffer where changes to the keymap are
Michael Kifer's avatar
Michael Kifer committed
601
    ;; to take place.  However, it doesn't hurt, and it helps whenever this
Michael Kifer's avatar
Michael Kifer committed
602
    ;; function is actually called from within the affected buffer.
Michael Kifer's avatar
Michael Kifer committed
603
    (viper-normalize-minor-mode-map-alist)
604

Michael Kifer's avatar
Michael Kifer committed
605
    (viper-set-mode-vars-for viper-current-state)))
Karl Heuer's avatar
Karl Heuer committed
606

607

608
;; Displays variables that control Viper's keymaps
Michael Kifer's avatar
Michael Kifer committed
609
(defun viper-debug-keymaps ()
Karl Heuer's avatar
Karl Heuer committed
610
  (interactive)
Michael Kifer's avatar
Michael Kifer committed
611
  (with-output-to-temp-buffer " *viper-debug*"
Karl Heuer's avatar
Karl Heuer committed
612 613 614
    (princ (format "Buffer name:  %s\n\n" (buffer-name)))
    (princ "Variables:  \n")
    (princ (format "major-mode:  %S\n" major-mode))
Michael Kifer's avatar
Michael Kifer committed
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
    (princ (format "viper-current-state:  %S\n" viper-current-state))
    (princ (format "viper-mode-string:  %S\n\n" viper-mode-string))
    (princ (format "viper-vi-intercept-minor-mode:  %S\n"
		   viper-vi-intercept-minor-mode))
    (princ (format "viper-insert-intercept-minor-mode:  %S\n"
		   viper-insert-intercept-minor-mode))
    (princ (format "viper-emacs-intercept-minor-mode:  %S\n"
		   viper-emacs-intercept-minor-mode))
    (princ (format "viper-vi-minibuffer-minor-mode:  %S\n"
		   viper-vi-minibuffer-minor-mode))
    (princ (format "viper-insert-minibuffer-minor-mode:  %S\n\n"
		   viper-insert-minibuffer-minor-mode))
    (princ (format "viper-vi-local-user-minor-mode:  %S\n"
		   viper-vi-local-user-minor-mode))
    (princ (format "viper-vi-global-user-minor-mode:  %S\n"
		   viper-vi-global-user-minor-mode))
    (princ (format "viper-vi-kbd-minor-mode:  %S\n" viper-vi-kbd-minor-mode))
    (princ (format "viper-vi-state-modifier-minor-mode:  %S\n"
		   viper-vi-state-modifier-minor-mode))
    (princ (format "viper-vi-diehard-minor-mode:  %S\n"
		   viper-vi-diehard-minor-mode))
    (princ (format "viper-vi-basic-minor-mode:  %S\n" viper-vi-basic-minor-mode))
    (princ (format "viper-replace-minor-mode:  %S\n" viper-replace-minor-mode))
    (princ (format "viper-insert-local-user-minor-mode:  %S\n"
		   viper-insert-local-user-minor-mode))
    (princ (format "viper-insert-global-user-minor-mode:  %S\n"
		   viper-insert-global-user-minor-mode))
    (princ (format "viper-insert-kbd-minor-mode:  %S\n"
643
		   viper-insert-kbd-minor-mode))
Michael Kifer's avatar
Michael Kifer committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657
    (princ (format "viper-insert-state-modifier-minor-mode:  %S\n"
		   viper-insert-state-modifier-minor-mode))
    (princ (format "viper-insert-diehard-minor-mode:  %S\n"
		   viper-insert-diehard-minor-mode))
    (princ (format "viper-insert-basic-minor-mode:  %S\n"
		   viper-insert-basic-minor-mode))
    (princ (format "viper-emacs-local-user-minor-mode:  %S\n"
		   viper-emacs-local-user-minor-mode))
    (princ (format "viper-emacs-kbd-minor-mode:  %S\n"
		   viper-emacs-kbd-minor-mode))
    (princ (format "viper-emacs-global-user-minor-mode:  %S\n"
		   viper-emacs-global-user-minor-mode))
    (princ (format "viper-emacs-state-modifier-minor-mode:  %S\n"
		   viper-emacs-state-modifier-minor-mode))
658

Michael Kifer's avatar
Michael Kifer committed
659
    (princ (format "\nviper-expert-level  %S\n" viper-expert-level))
Michael Kifer's avatar
Michael Kifer committed
660
    (princ (format "viper-no-multiple-ESC  %S\n" viper-no-multiple-ESC))
Michael Kifer's avatar
Michael Kifer committed
661
    (princ (format "viper-always  %S\n" viper-always))
Michael Kifer's avatar
Michael Kifer committed
662 663
    (princ (format "viper-ex-style-motion  %S\n"
		   viper-ex-style-motion))
Michael Kifer's avatar
Michael Kifer committed
664 665
    (princ (format "viper-ex-style-editing  %S\n"
		   viper-ex-style-editing))
Michael Kifer's avatar
Michael Kifer committed
666
    (princ (format "viper-want-emacs-keys-in-vi  %S\n"
667
		   viper-want-emacs-keys-in-vi))
Michael Kifer's avatar
Michael Kifer committed
668
    (princ (format "viper-want-emacs-keys-in-insert  %S\n"
669
		   viper-want-emacs-keys-in-insert))
Michael Kifer's avatar
Michael Kifer committed
670
    (princ (format "viper-want-ctl-h-help  %S\n" viper-want-ctl-h-help))
671

Karl Heuer's avatar
Karl Heuer committed
672 673 674 675 676 677
    (princ "\n\n\n")
    (princ (format "Default value for minor-mode-map-alist:  \n%S\n\n"
		   (default-value 'minor-mode-map-alist)))
    (princ (format "Actual value for minor-mode-map-alist:  \n%S\n"
		   minor-mode-map-alist))
    ))
678

Karl Heuer's avatar
Karl Heuer committed
679 680

;;; Keymap utils
681 682

(defun viper-add-keymap (mapsrc mapdst)
Michael Kifer's avatar
Michael Kifer committed
683
  "Add contents of mapsrc to mapdst.  It is assumed that mapsrc is sparse."
684 685 686 687 688 689
  (if (featurep 'xemacs)
      ;; Emacs 22 has map-keymap.
      (map-keymap (lambda (key binding) (define-key mapdst key binding))
		  mapsrc)
    (mapc (lambda (p) (define-key mapdst (vector (car p)) (cdr p)))
	  (cdr mapsrc))))
690

Michael Kifer's avatar
Michael Kifer committed
691
(defun viper-modify-keymap (map alist)
Michael Kifer's avatar
Michael Kifer committed
692
   "Modifies MAP with bindings specified in the ALIST.  The alist has the
Karl Heuer's avatar
Karl Heuer committed
693
form ((key . function) (key . function) ... )."
694
   (mapcar (lambda (p) (define-key map (eval (car p)) (cdr p)))
Karl Heuer's avatar
Karl Heuer committed
695 696 697
	   alist))


698 699 700
(provide 'viper-keym)


Michael Kifer's avatar
Michael Kifer committed
701
;;; Local Variables:
Michael Kifer's avatar
Michael Kifer committed
702
;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
Michael Kifer's avatar
Michael Kifer committed
703 704 705
;;; End:


706
;; arch-tag: 43af4b2f-0bea-400b-889e-221ebc00acb1
707
;;; viper-keym.el ends here