viper-keym.el 26.8 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

Michael Kifer's avatar
Michael Kifer committed
3
;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
Karl Heuer's avatar
Karl Heuer committed
4

Karl Heuer's avatar
Karl Heuer committed
5 6 7 8 9 10 11 12 13 14 15 16 17
;; 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
;; the Free Software Foundation; either version 2, or (at your option)
;; 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
18 19 20
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Karl Heuer's avatar
Karl Heuer committed
21

22 23 24
;;; Commentary:

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

Michael Kifer's avatar
Michael Kifer committed
26 27 28
(provide 'viper-keym)

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

Michael Kifer's avatar
Michael Kifer committed
36 37 38 39 40 41 42 43
;; loading happens only in non-interactive compilation
;; in order to spare non-viperized emacs from being viperized
(if noninteractive
    (eval-when-compile
      (let ((load-path (cons (expand-file-name ".") load-path)))
	(or (featurep 'viper-util)
	    (load "viper-util.el" nil nil 'nosuffix))
	)))
Michael Kifer's avatar
Michael Kifer committed
44 45
;; end pacifier

Karl Heuer's avatar
Karl Heuer committed
46 47
(require 'viper-util)

Michael Kifer's avatar
Michael Kifer committed
48

Karl Heuer's avatar
Karl Heuer committed
49 50
;;; Variables

Michael Kifer's avatar
Michael Kifer committed
51
(defvar viper-toggle-key "\C-z"
Michael Kifer's avatar
Michael Kifer committed
52 53
  "The key used to change states from emacs to Vi and back.
In insert mode, this key also functions as Meta. 
Michael Kifer's avatar
Michael Kifer committed
54
Must be set in .viper file or prior to loading Viper.
Michael Kifer's avatar
Michael Kifer committed
55 56
This setting cannot be changed interactively.")

Michael Kifer's avatar
Michael Kifer committed
57
(defvar viper-ESC-key "\e" 
Michael Kifer's avatar
Michael Kifer committed
58
  "Key used to ESC. 
Michael Kifer's avatar
Michael Kifer committed
59
Must be set in .viper file or prior to loading Viper.
Michael Kifer's avatar
Michael Kifer committed
60
This setting cannot be changed interactively.")
Michael Kifer's avatar
Michael Kifer committed
61 62 63
  
;;; Emacs keys in other states.  

Michael Kifer's avatar
Michael Kifer committed
64
(defcustom viper-want-emacs-keys-in-insert t
Michael Kifer's avatar
Michael Kifer committed
65
  "*Set to nil if you want complete Vi compatibility in insert mode.
Michael Kifer's avatar
Michael Kifer committed
66 67 68
Complete compatibility with Vi is not recommended for power use of Viper."
  :type 'boolean
  :group 'viper)
Michael Kifer's avatar
Michael Kifer committed
69

Michael Kifer's avatar
Michael Kifer committed
70
(defcustom viper-want-emacs-keys-in-vi t
Michael Kifer's avatar
Michael Kifer committed
71
  "*Set to nil if you want complete Vi compatibility in Vi mode.
Michael Kifer's avatar
Michael Kifer committed
72 73 74
Full Vi compatibility is not recommended for power use of Viper."
  :type 'boolean
  :group 'viper)
Michael Kifer's avatar
Michael Kifer committed
75

Michael Kifer's avatar
Michael Kifer committed
76
(defcustom viper-no-multiple-ESC  t
Michael Kifer's avatar
Michael Kifer committed
77 78
  "*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
79
terminal (unless the user level is 1, 2, or 5).  On a dumb terminal, this
Michael Kifer's avatar
Michael Kifer committed
80 81
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
82
Setting viper-no-multiple-ESC to nil will allow as many multiple ESC,
Michael Kifer's avatar
Michael Kifer committed
83 84 85
as is allowed by the major mode in effect."
  :type 'boolean
  :group 'viper) 
Michael Kifer's avatar
Michael Kifer committed
86

Michael Kifer's avatar
Michael Kifer committed
87
(defcustom viper-want-ctl-h-help nil
Michael Kifer's avatar
Michael Kifer committed
88
  "*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
89 90
  :type 'boolean
  :group 'viper)
Michael Kifer's avatar
Michael Kifer committed
91 92


Karl Heuer's avatar
Karl Heuer committed
93 94 95 96
;;; Keymaps

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

Michael Kifer's avatar
Michael Kifer committed
101 102
;; keymap used to zap all keymaps other than function-key-map,
;; device-function-key-map, etc.
Michael Kifer's avatar
Michael Kifer committed
103
(defvar viper-overriding-map (make-sparse-keymap))
Karl Heuer's avatar
Karl Heuer committed
104
  
Michael Kifer's avatar
Michael Kifer committed
105
(viper-deflocalvar viper-vi-local-user-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
106 107 108
  "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
109
mh-send-letter.  In a newsreader such as gnus, tin, or rn, ZZ could be bound
Karl Heuer's avatar
Karl Heuer committed
110
to save-buffers-kill-emacs then post article, etc.")
Michael Kifer's avatar
Michael Kifer committed
111
(put 'viper-vi-local-user-map 'permanent-local t)	
Karl Heuer's avatar
Karl Heuer committed
112

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

Michael Kifer's avatar
Michael Kifer committed
117
(defvar viper-vi-basic-map (make-keymap)
Karl Heuer's avatar
Karl Heuer committed
118 119 120
  "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
121
(defvar  viper-vi-kbd-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
122 123
  "This keymap keeps keyboard macros defined via the :map command.")

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

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

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

Michael Kifer's avatar
Michael Kifer committed
136
(defvar viper-insert-basic-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
137 138
  "The basic insert-mode keymap.")

Michael Kifer's avatar
Michael Kifer committed
139
(defvar viper-insert-diehard-map (make-keymap)
Karl Heuer's avatar
Karl Heuer committed
140
  "Map used when user wants vi-style keys in insert mode.
Michael Kifer's avatar
Michael Kifer committed
141 142
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
143

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

Michael Kifer's avatar
Michael Kifer committed
147
(defvar viper-replace-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
148 149
  "Map used in Viper's replace state.")
  
Michael Kifer's avatar
Michael Kifer committed
150
(defvar viper-emacs-global-user-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
151 152
  "Auxiliary map for global user-defined bindings in Emacs state.")

Michael Kifer's avatar
Michael Kifer committed
153
(defvar  viper-emacs-kbd-map  (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
154 155
  "This keymap keeps Vi-style kbd macros for emacs mode.")
  
Michael Kifer's avatar
Michael Kifer committed
156
(viper-deflocalvar viper-emacs-local-user-map  (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
157
  "Auxiliary map for local user-defined bindings in Emacs state.")
Michael Kifer's avatar
Michael Kifer committed
158
(put 'viper-emacs-local-user-map 'permanent-local t)  
Karl Heuer's avatar
Karl Heuer committed
159 160

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

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

Karl Heuer's avatar
Karl Heuer committed
168 169 170 171 172 173 174

;;; Variables used by minor modes

;; Association list of the form 
;; ((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
175
(defvar viper-vi-state-modifier-alist nil)
Karl Heuer's avatar
Karl Heuer committed
176 177 178 179 180

;; Association list of the form 
;; ((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
181
(defvar viper-insert-state-modifier-alist nil)
Karl Heuer's avatar
Karl Heuer committed
182 183 184 185 186

;; Association list of the form 
;; ((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
187
(defvar viper-emacs-state-modifier-alist nil)
Karl Heuer's avatar
Karl Heuer committed
188

Michael Kifer's avatar
Michael Kifer committed
189
;; Tells viper-add-local-keys to create a new viper-vi-local-user-map for new
Michael Kifer's avatar
Michael Kifer committed
190
;; buffers.  Not a user option.
Michael Kifer's avatar
Michael Kifer committed
191 192
(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
193

Michael Kifer's avatar
Michael Kifer committed
194
;; Tells viper-add-local-keys to create a new viper-insert-local-user-map for
Michael Kifer's avatar
Michael Kifer committed
195
;; new buffers.  Not a user option.
Michael Kifer's avatar
Michael Kifer committed
196 197
(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
198

Michael Kifer's avatar
Michael Kifer committed
199
;; Tells viper-add-local-keys to create a new viper-emacs-local-user-map for
Michael Kifer's avatar
Michael Kifer committed
200
;; new buffers.  Not a user option.
Michael Kifer's avatar
Michael Kifer committed
201 202
(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
203 204 205 206 207 208



;; Insert mode keymap

;; for novice users, pretend you are the real vi.
Michael Kifer's avatar
Michael Kifer committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
(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
231 232 233

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

;; Insert mode map when user wants emacs style
Michael Kifer's avatar
Michael Kifer committed
238 239 240 241 242 243 244
(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)
(define-key viper-insert-basic-map 
  (if viper-xemacs-p [(shift tab)] [S-tab]) 'viper-insert-tab)
(define-key viper-insert-basic-map "\C-v" 'quoted-insert)
(define-key viper-insert-basic-map "\C-?" 'viper-del-backward-char-in-insert)
Michael Kifer's avatar
Michael Kifer committed
245
(define-key viper-insert-basic-map [backspace] 'viper-del-backward-char-in-insert)
Michael Kifer's avatar
Michael Kifer committed
246 247 248 249 250 251
(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
252 253 254


;; Replace keymap
Michael Kifer's avatar
Michael Kifer committed
255 256 257 258
(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
259
(define-key viper-replace-map [backspace] 'viper-del-backward-char-in-replace)
Karl Heuer's avatar
Karl Heuer committed
260 261 262 263 264



;; Vi keymaps

Michael Kifer's avatar
Michael Kifer committed
265 266
(define-key viper-vi-basic-map "\C-^" (lambda ()
					(interactive) (viper-ex nil "e#")))
Michael Kifer's avatar
Michael Kifer committed
267 268 269 270 271 272 273 274 275 276
(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)
(define-key viper-vi-basic-map "\C-s" 'viper-isearch-forward)
(define-key viper-vi-basic-map "\C-r" 'viper-isearch-backward)
(define-key viper-vi-basic-map "\C-c/" 'viper-toggle-search-style)
Michael Kifer's avatar
Michael Kifer committed
277
(define-key viper-vi-basic-map "\C-c\C-g" 'viper-info-on-file)
Michael Kifer's avatar
Michael Kifer committed
278 279 280 281 282 283 284 285 286 287 288

(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
289 290
(define-key viper-vi-basic-map "&" (lambda ()
				     (interactive) (viper-ex nil "&")))
Michael Kifer's avatar
Michael Kifer committed
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
(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
362
(define-key viper-vi-basic-map [backspace] 'viper-backward-char)
Michael Kifer's avatar
Michael Kifer committed
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
(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
395
;;; This is viper-vi-diehard-map.  Used when viper-vi-diehard-minor-mode is on.
Michael Kifer's avatar
Michael Kifer committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417

(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
418 419 420 421 422


;;; Minibuffer keymap
  

Michael Kifer's avatar
Michael Kifer committed
423
(defvar viper-minibuffer-map (make-sparse-keymap)
Karl Heuer's avatar
Karl Heuer committed
424 425
  "Keymap used to modify keys when Minibuffer is in Insert state.")
  
Michael Kifer's avatar
Michael Kifer committed
426 427
(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
428 429

;; Map used to read Ex-style commands.
Michael Kifer's avatar
Michael Kifer committed
430 431 432
(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
433 434 435

;; Keymap for reading file names in Ex-style commands.
(defvar ex-read-filename-map (make-sparse-keymap))
Michael Kifer's avatar
Michael Kifer committed
436 437
(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
438

Michael Kifer's avatar
Michael Kifer committed
439
;; Some other maps
Michael Kifer's avatar
Michael Kifer committed
440
(defvar viper-slash-and-colon-map (make-sparse-keymap)
Michael Kifer's avatar
Michael Kifer committed
441 442
  "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
443 444
(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
445

Michael Kifer's avatar
Michael Kifer committed
446
(defvar viper-comint-mode-modifier-map (make-sparse-keymap)
Michael Kifer's avatar
Michael Kifer committed
447
  "This map modifies comint mode.")
Michael Kifer's avatar
Michael Kifer committed
448 449
(define-key viper-comint-mode-modifier-map "\C-m" 'comint-send-input)
(define-key viper-comint-mode-modifier-map "\C-d" 'comint-delchar-or-maybe-eof)
Michael Kifer's avatar
Michael Kifer committed
450

Michael Kifer's avatar
Michael Kifer committed
451
(defvar viper-dired-modifier-map (make-sparse-keymap)
Michael Kifer's avatar
Michael Kifer committed
452
  "This map modifies Dired behavior.")
Michael Kifer's avatar
Michael Kifer committed
453 454
(define-key viper-dired-modifier-map ":" 'viper-ex)
(define-key viper-dired-modifier-map "/" 'viper-search-forward)
Michael Kifer's avatar
Michael Kifer committed
455

Karl Heuer's avatar
Karl Heuer committed
456 457 458 459


;;; Code

Michael Kifer's avatar
Michael Kifer committed
460
(defun viper-add-local-keys (state alist)
Karl Heuer's avatar
Karl Heuer committed
461 462 463 464 465 466 467 468
  "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
469
      (viper-add-local-keys state '((key-str . func) (key-str . func)...))   "
Karl Heuer's avatar
Karl Heuer committed
470 471 472
      
  (let (map)
    (cond ((eq state 'vi-state)
Michael Kifer's avatar
Michael Kifer committed
473 474 475 476
	   (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
477
	  ((eq state 'insert-state)
Michael Kifer's avatar
Michael Kifer committed
478 479 480 481
	   (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
482
	  ((eq state 'emacs-state)
Michael Kifer's avatar
Michael Kifer committed
483 484 485 486
	   (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))
Karl Heuer's avatar
Karl Heuer committed
487 488
	  (t 
	   (error
Michael Kifer's avatar
Michael Kifer committed
489
	    "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
490

Michael Kifer's avatar
Michael Kifer committed
491 492 493
    (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
494

Michael Kifer's avatar
Michael Kifer committed
495 496
(defun viper-zap-local-keys ()
  "Unconditionally reset Viper viper-*-local-user-map's.
Michael Kifer's avatar
Michael Kifer committed
497
Rarely useful, but if u made a mistake by switching to a mode that adds
Michael Kifer's avatar
Michael Kifer committed
498 499
undesirable local keys, e.g., comint-mode, then this function can restore
sanity."
Michael Kifer's avatar
Michael Kifer committed
500
  (interactive)
Michael Kifer's avatar
Michael Kifer committed
501 502 503 504 505 506 507
  (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))
Karl Heuer's avatar
Karl Heuer committed
508 509
    

Michael Kifer's avatar
Michael Kifer committed
510
(defun viper-modify-major-mode (mode state keymap)
Karl Heuer's avatar
Karl Heuer committed
511 512 513 514
  "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
515 516 517
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
518 519 520 521

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
522
Arguments: (major-mode viper-state keymap)"
Karl Heuer's avatar
Karl Heuer committed
523
  (let ((alist
Michael Kifer's avatar
Michael Kifer committed
524 525 526
	 (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
527 528 529 530 531 532 533
	elt)
    (if (setq elt (assoc mode (eval alist)))
	(set alist (delq elt (eval alist))))
    (set alist (cons (cons mode keymap) (eval alist)))
    
    ;; 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
534
    ;; to take place.  However, it doesn't hurt, and it helps whenever this
Michael Kifer's avatar
Michael Kifer committed
535
    ;; function is actually called from within the affected buffer.
Michael Kifer's avatar
Michael Kifer committed
536
    (viper-normalize-minor-mode-map-alist)
Karl Heuer's avatar
Karl Heuer committed
537
    
Michael Kifer's avatar
Michael Kifer committed
538
    (viper-set-mode-vars-for viper-current-state)))
Karl Heuer's avatar
Karl Heuer committed
539 540

    
541
;; Displays variables that control Viper's keymaps
Michael Kifer's avatar
Michael Kifer committed
542
(defun viper-debug-keymaps ()
Karl Heuer's avatar
Karl Heuer committed
543
  (interactive)
Michael Kifer's avatar
Michael Kifer committed
544
  (with-output-to-temp-buffer " *viper-debug*"
Karl Heuer's avatar
Karl Heuer committed
545 546 547
    (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
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
    (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"
		   viper-insert-kbd-minor-mode)) 
    (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))
Karl Heuer's avatar
Karl Heuer committed
591
    
Michael Kifer's avatar
Michael Kifer committed
592
    (princ (format "\nviper-expert-level  %S\n" viper-expert-level))
Michael Kifer's avatar
Michael Kifer committed
593
    (princ (format "viper-no-multiple-ESC  %S\n" viper-no-multiple-ESC))
Michael Kifer's avatar
Michael Kifer committed
594
    (princ (format "viper-always  %S\n" viper-always))
Michael Kifer's avatar
Michael Kifer committed
595 596
    (princ (format "viper-ex-style-motion  %S\n"
		   viper-ex-style-motion))
Michael Kifer's avatar
Michael Kifer committed
597 598
    (princ (format "viper-ex-style-editing  %S\n"
		   viper-ex-style-editing))
Michael Kifer's avatar
Michael Kifer committed
599 600 601 602 603
    (princ (format "viper-want-emacs-keys-in-vi  %S\n"
		   viper-want-emacs-keys-in-vi)) 
    (princ (format "viper-want-emacs-keys-in-insert  %S\n"
		   viper-want-emacs-keys-in-insert)) 
    (princ (format "viper-want-ctl-h-help  %S\n" viper-want-ctl-h-help))
Karl Heuer's avatar
Karl Heuer committed
604 605 606 607 608 609 610 611 612 613 614
    
    (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))
    ))
   

;;; Keymap utils
	     
Michael Kifer's avatar
Michael Kifer committed
615
(defun viper-add-keymap (mapsrc mapdst) 
Michael Kifer's avatar
Michael Kifer committed
616
  "Add contents of mapsrc to mapdst.  It is assumed that mapsrc is sparse."
Michael Kifer's avatar
Michael Kifer committed
617
  (if viper-xemacs-p
Michael Kifer's avatar
Michael Kifer committed
618
      (map-keymap (lambda (key binding) (define-key mapdst key binding))
Karl Heuer's avatar
Karl Heuer committed
619
		  mapsrc)
Michael Kifer's avatar
Michael Kifer committed
620 621
    (mapcar (lambda (p) (define-key mapdst (vector (car p)) (cdr p)))
	    (cdr mapsrc))))
Karl Heuer's avatar
Karl Heuer committed
622
  
Michael Kifer's avatar
Michael Kifer committed
623
(defun viper-modify-keymap (map alist)
Michael Kifer's avatar
Michael Kifer committed
624
   "Modifies MAP with bindings specified in the ALIST.  The alist has the
Karl Heuer's avatar
Karl Heuer committed
625
form ((key . function) (key . function) ... )."
Michael Kifer's avatar
Michael Kifer committed
626
   (mapcar (lambda (p) (define-key map (eval (car p)) (cdr p))) 
Karl Heuer's avatar
Karl Heuer committed
627 628 629
	   alist))


Michael Kifer's avatar
Michael Kifer committed
630
;;; Local Variables:
Michael Kifer's avatar
Michael Kifer committed
631
;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
Michael Kifer's avatar
Michael Kifer committed
632 633 634
;;; End:


635
;;; viper-keym.el ends here