2000-10-29 Michael Kifer <kifer@cs.sunysb.edu>
[emacs.git] / lisp / emulation / viper.el
blob4d8c74118b6b12dfa11c1824b3f45250bc7d0e62
1 ;;; viper.el --- A full-featured Vi emulator for GNU Emacs and XEmacs,
2 ;; a VI Plan for Emacs Rescue,
3 ;; and a venomous VI PERil.
4 ;; Viper Is also a Package for Emacs Rebels.
5 ;;
6 ;; Keywords: emulations
7 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
9 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000 Free Software Foundation, Inc.
11 (defconst viper-version "3.09 of October 29, 2000"
12 "The current version of Viper")
14 ;; This file is part of GNU Emacs.
16 ;; GNU Emacs is free software; you can redistribute it and/or modify
17 ;; it under the terms of the GNU General Public License as published by
18 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; any later version.
21 ;; GNU Emacs is distributed in the hope that it will be useful,
22 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
23 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 ;; GNU General Public License for more details.
26 ;; You should have received a copy of the GNU General Public License
27 ;; along with GNU Emacs; see the file COPYING. If not, write to the
28 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
29 ;; Boston, MA 02111-1307, USA.
31 ;;; Commentary:
33 ;; Viper is a full-featured Vi emulator for Emacs and XEmacs. It emulates and
34 ;; improves upon the standard features of Vi and, at the same time, allows
35 ;; full access to all Emacs facilities. Viper supports multiple undo,
36 ;; file name completion, command, file, and search history and it extends
37 ;; Vi in many other ways. Viper is highly customizable through the various
38 ;; hooks, user variables, and keymaps. It is implemented as a collection
39 ;; of minor modes and it is designed to provide full access to all Emacs
40 ;; major and minor modes.
42 ;;; History
44 ;; Viper is a new name for a package formerly known as VIP-19,
45 ;; which was a successor of VIP version 3.5 by Masahiko Sato
46 ;; <ms@sail.stanford.edu> and VIP version 4.2 by Aamod Sane
47 ;; <sane@cs.uiuc.edu>. Some ideas from vip 4.4.2 by Aamod Sane
48 ;; were also shamelessly plagiarized.
50 ;; Viper maintains some degree of compatibility with these older
51 ;; packages. See the documentation for customization.
53 ;; The main difference between Viper and these older packages are:
55 ;; 1. Viper emulates Vi at several levels, from almost complete conformity
56 ;; to a rather loose Vi-compliance.
58 ;; 2. Viper provides full access to all major and minor modes of Emacs
59 ;; without the need to type extra keys.
60 ;; The older versions of VIP (and other Vi emulators) do not work with
61 ;; some major and minor modes.
63 ;; 3. Viper supports vi-style undo.
65 ;; 4. Viper fully emulates (and improves upon) vi's replacement mode.
67 ;; 5. Viper has a better interface to ex, including command, variable, and
68 ;; file name completion.
70 ;; 6. Viper uses native Emacs history and completion features; it doesn't
71 ;; rely on other packages (such as gmhist.el and completer.el) to provide
72 ;; these features.
74 ;; 7. Viper supports Vi-style editing in the minibuffer, by allowing the
75 ;; user to switch from Insert state to Vi state to Replace state, etc.
77 ;; 8. Viper keeps history of recently inserted pieces of text and recently
78 ;; executed Vi-style destructive commands, such as `i', `d', etc.
79 ;; These pieces of text can be inserted in later insertion commands;
80 ;; the previous destructive commands can be re-executed.
82 ;; 9. Viper has Vi-style keyboard macros, which enhances the similar
83 ;; facility in the original Vi.
84 ;; First, one can execute any Emacs command while defining a
85 ;; macro, not just the Vi commands. Second, macros are defined in a
86 ;; WYSYWYG mode, using an interface to Emacs' WYSIWYG style of defining
87 ;; macros. Third, in Viper, one can define macros that are specific to
88 ;; a given buffer, a given major mode, or macros defined for all buffers.
89 ;; The same macro name can have several different definitions:
90 ;; one global, several definitions for various major modes, and
91 ;; definitions for specific buffers.
92 ;; Buffer-specific definitions override mode-specific
93 ;; definitions, which, in turn, override global definitions.
96 ;;; Installation:
97 ;; -------------
99 ;; (require 'viper)
102 ;;; Acknowledgements:
103 ;; -----------------
104 ;; Bug reports and ideas contributed by many users have helped
105 ;; improve Viper and the various versions of VIP.
106 ;; See the on-line manual for a complete list of contributors.
109 ;;; Notes:
111 ;; 1. Major modes.
112 ;; In most cases, Viper handles major modes correctly, i.e., they come up
113 ;; in the right state (either vi-state or emacs-state). For instance, text
114 ;; files come up in vi-state, while, say, Dired appears in emacs-state by
115 ;; default.
116 ;; However, some modes do not appear in the right mode in the beginning,
117 ;; usually because they neglect to follow Emacs conventions (e.g., they don't
118 ;; use kill-all-local-variables when they start). Some major modes
119 ;; may fail to come up in emacs-state if they call hooks, such as
120 ;; text-hook, for no good reason.
122 ;; As an immediate solution, you can hit C-z to bring about the right mode.
123 ;; An interim solution is to add an appropriate hook to the mode like this:
125 ;; (add-hook 'your-favorite-mode 'viper-mode)
126 ;; or
127 ;; (add-hook 'your-favorite-mode 'viper-change-state-to-emacs)
129 ;; whichever applies. The right thing to do, however, is to complain to the
130 ;; author of the respective package. (Sometimes they also neglect to equip
131 ;; their modes with hooks, which is one more reason for complaining.)
133 ;; 2. Keymap handling
134 ;; Each Viper state (insert, vi, replace) is implemented as a collection of
135 ;; several minor modes, each with its own keymap.
137 ;; Viper's Vi state consists of seven minor modes:
139 ;; viper-vi-intercept-minor-mode
140 ;; viper-vi-local-user-minor-mode
141 ;; viper-vi-global-user-minor-mode
142 ;; viper-vi-kbd-minor-mode
143 ;; viper-vi-state-modifier-minor-mode
144 ;; viper-vi-diehard-minor-mode
145 ;; viper-vi-basic-minor-mode
147 ;; Bindings done to the keymap of the first mode overshadow those done to
148 ;; the second, which, in turn, overshadows those done to the third, etc.
150 ;; The last viper-vi-basic-minor-mode contains most of the usual Vi bindings
151 ;; in its edit mode. This mode provides access to all Emacs facilities.
152 ;; Novice users, however, may want to set their viper-expert-level to 1
153 ;; in their .viper file. This will enable viper-vi-diehard-minor-mode. This
154 ;; minor mode's bindings make Viper simulate the usual Vi very closely.
155 ;; For instance, C-c will not have its standard Emacs binding
156 ;; and so many of the goodies of Emacs are not available.
158 ;; A skilled user should set viper-expert-level to at least 3. This will
159 ;; enable `C-c' and many Emacs facilities will become available.
160 ;; In this case, viper-vi-diehard-minor-mode is inactive.
162 ;; Viper gurus should have at least
163 ;; (setq viper-expert-level 4)
164 ;; in their ~/.viper files. This will unsuppress all Emacs keys that are not
165 ;; essential for VI-style editing.
166 ;; Pick-and-choose users may want to put
167 ;; (setq viper-expert-level 5)
168 ;; in ~/.viper. Viper will then leave it up to the user to set the variables
169 ;; viper-want-* See viper-set-expert-level for details.
171 ;; The very first minor mode, viper-vi-intercept-minor-mode, is of no
172 ;; concern for the user. It is needed to bind Viper's vital keys, such as
173 ;; ESC and C-z.
175 ;; The second mode, viper-vi-local-user-minor-mode, usually has an
176 ;; empty keymap. However, the user can set bindings in this keymap, which
177 ;; will overshadow the corresponding bindings in the other two minor
178 ;; modes. This is useful, for example, for setting up ZZ in gnus,
179 ;; rmail, mh-e, etc., to send message instead of saving it in a file.
180 ;; Likewise, in Dired mode, you may want to bind ZN and ZP to commands
181 ;; that would visit the next or the previous file in the Dired buffer.
182 ;; Setting local keys is tricky, so don't do it directly. Instead, use
183 ;; viper-add-local-keys function (see its doc).
185 ;; The third minor mode, viper-vi-global-user-minor-mode, is also intended
186 ;; for the users but, unlike viper-vi-local-user-minor-mode, its key
187 ;; bindings are seen in all Viper buffers. This mode keys can be done
188 ;; with define-key command.
190 ;; The fourth minor mode, viper-vi-kbd-minor-mode, is used by keyboard
191 ;; macros. Users are NOT supposed to modify this keymap directly.
193 ;; The fifth mode, viper-vi-state-modifier-minor-mode, can be used to set
194 ;; key bindings that are visible in some major modes but not in others.
196 ;; Users are allowed to modify keymaps that belong to
197 ;; viper-vi-local-user-minor-mode, viper-vi-global-user-minor-mode,
198 ;; and viper-vi-state-modifier-minor-mode only.
200 ;; Viper's Insert state also has seven minor modes:
202 ;; viper-insert-intercept-minor-mode
203 ;; viper-insert-local-user-minor-mode
204 ;; viper-insert-global-user-minor-mode
205 ;; viper-insert-kbd-minor-mode
206 ;; viper-insert-state-modifier-minor-mode
207 ;; viper-insert-diehard-minor-mode
208 ;; viper-insert-basic-minor-mode
210 ;; As with VI's editing modes, the first mode,
211 ;; viper-insert-intercept-minor-mode is used to bind vital keys that are not
212 ;; to be changed by the user.
214 ;; The next mode, viper-insert-local-user-minor-mode, is used to customize
215 ;; bindings in the insert state of Viper. The third mode,
216 ;; viper-insert-global-user-minor-mode is like
217 ;; viper-insert-local-user-minor-mode, except that its bindings are seen in
218 ;; all Viper buffers. As with viper-vi-local-user-minor-mode, its bindings
219 ;; should be done via the function viper-add-local-keys. Bindings for
220 ;; viper-insert-global-user-minor-mode can be set with the define-key command.
222 ;; The next minor mode, viper-insert-kbd-minor-mode,
223 ;; is used for keyboard VI-style macros defined with :map!.
225 ;; The fifth minor mode, viper-insert-state-modifier-minor-mode, is like
226 ;; viper-vi-state-modifier-minor-mode, except that it is used in the Insert
227 ;; state; it can be used to modify keys in a mode-specific fashion.
229 ;; The minor mode viper-insert-diehard-minor-mode is in effect when
230 ;; the user wants a high degree of Vi compatibility (a bad idea, really!).
231 ;; The last minor mode, viper-insert-basic-minor-mode, is always in effect
232 ;; when Viper is in insert state. It binds a small number of keys needed for
233 ;; Viper's operation.
235 ;; Finally, Viper provides minor modes for overriding bindings set by Emacs
236 ;; modes when Viper is in Emacs state:
238 ;; viper-emacs-local-user-minor-mode
239 ;; viper-emacs-global-user-minor-mode
240 ;; viper-emacs-kbd-minor-mode
241 ;; viper-emacs-state-modifier-minor-mode
243 ;; These minor modes are in effect when Viper is in Emacs state. The keymap
244 ;; associated with viper-emacs-global-user-minor-mode,
245 ;; viper-emacs-global-user-map, overrides the global and local keymaps as
246 ;; well as the minor mode keymaps set by other modes. The keymap of
247 ;; viper-emacs-local-user-minor-mode, viper-emacs-local-user-map, overrides
248 ;; everything, but it is used on a per buffer basis.
249 ;; The keymap associated with viper-emacs-state-modifier-minor-mode
250 ;; overrides keys on a per-major-mode basis. The mode
251 ;; viper-emacs-kbd-minor-mode is used to define Vi-style macros in Emacs
252 ;; state.
254 ;; 3. There is also one minor mode that is used when Viper is in its
255 ;; replace-state (used for commands like cw, C, etc.). This mode is
256 ;; called
258 ;; viper-replace-minor-mode
260 ;; and its keymap is viper-replace-map. Replace minor mode is always
261 ;; used in conjunction with the minor modes for insert-state, and its
262 ;; keymap overshadows the keymaps for insert minor modes.
264 ;; 4. Defining buffer-local bindings in Vi and Insert modes.
265 ;; As mentioned before, sometimes, it is convenient to have
266 ;; buffer-specific of mode-specific key bindings in Vi and insert modes.
267 ;; Viper provides a special function, viper-add-local-keys, to do precisely
268 ;; this. For instance, is you need to add couple of mode-specific bindings
269 ;; to Insert mode, you can put
271 ;; (viper-add-local-keys 'insert-state '((key1 . func1) (key2 .func2)))
273 ;; somewhere in a hook of this major mode. If you put something like this
274 ;; in your own elisp function, this will define bindings specific to the
275 ;; buffer that was current at the time of the call to viper-add-local-keys.
276 ;; The only thing to make sure here is that the major mode of this buffer
277 ;; is written according to Emacs conventions, which includes a call to
278 ;; (kill-all-local-variables). See viper-add-local-keys for more details.
281 ;; TO DO (volunteers?):
283 ;; 1. Some of the code that is inherited from VIP-3.5 is rather
284 ;; convoluted. Instead of viper-command-argument, keymaps should bind the
285 ;; actual commands. E.g., "dw" should be bound to a generic command
286 ;; viper-delete that will delete things based on the value of
287 ;; last-command-char. This would greatly simplify the logic and the code.
289 ;; 2. Somebody should venture to write a customization package a la
290 ;; options.el that would allow the user to change values of variables
291 ;; that meet certain specs (e.g., match a regexp) and whose doc string
292 ;; starts with a '*'. Then, the user should be offered to save
293 ;; variables that were changed. This will make user's customization job
294 ;; much easier.
297 ;; Code
299 (require 'advice)
300 (require 'cl)
301 (require 'ring)
303 ;; compiler pacifier
304 (defvar mark-even-if-inactive)
305 (defvar quail-mode)
306 (defvar viper-expert-level)
307 (defvar viper-mode-string)
308 (defvar viper-major-mode-modifier-list)
310 ;; loading happens only in non-interactive compilation
311 ;; in order to spare non-viperized emacs from being viperized
312 (if noninteractive
313 (eval-when-compile
314 (let ((load-path (cons (expand-file-name ".") load-path)))
315 (or (featurep 'viper-init)
316 (load "viper-init.el" nil nil 'nosuffix))
317 (or (featurep 'viper-cmd)
318 (load "viper-cmd.el" nil nil 'nosuffix))
320 ;; end pacifier
322 (require 'viper-init)
324 ;; better be defined before Viper custom group.
325 (defvar viper-custom-file-name (convert-standard-filename "~/.viper")
326 "Viper customisation file.
327 If set by the user, this must be done _before_ Viper is loaded in `~/.emacs'.")
329 (defgroup viper nil
330 "Vi emulation within Emacs.
331 NOTE: Viper customization should be saved in `viper-custom-file-name', which
332 defaults to `~/.viper'."
333 :prefix "viper-"
334 :group 'emulations)
336 (require 'viper-cmd)
338 (defgroup viper-misc nil
339 "Miscellaneous Viper customization."
340 :prefix "viper-"
341 :group 'viper)
344 (defcustom viper-always t
345 "Non-nil means, arrange for vi-state to be a default when appropriate.
346 This is different from `viper-mode' variable in that `viper-mode' determines
347 whether to use Viper in the first place, while `viper-always', if nil, lets
348 user decide when to invoke Viper in a major mode."
349 :type 'boolean
350 :tag "Always Invoke Viper"
351 :group 'viper-misc)
353 ;; Non-viper variables that need to be saved in case the user decides to
354 ;; de-viperize emacs.
355 (defvar viper-saved-non-viper-variables nil)
356 ;; Contains user settings for vars affected by viper-set-expert-level function.
357 ;; Not a user option.
358 (defvar viper-saved-user-settings nil)
360 (defcustom viper-mode (cond (noninteractive nil)
361 (t 'ask))
362 "To Viperize or not to Viperize.
363 If t, viperize emacs. If nil -- don't. If `ask', ask the user.
364 This variable is used primatily when Viper is being loaded.
366 Must be set in `~/.emacs' before Viper is loaded.
367 DO NOT set this variable interactively, unless you are using the customization
368 widget."
369 :type '(choice (const nil) (const t) (const ask))
370 :tag "Set Viper Mode on Loading"
371 :group 'viper-misc)
373 (defcustom viper-vi-state-mode-list
374 '(fundamental-mode
375 makefile-mode
376 help-mode
378 awk-mode
379 m4-mode
380 xrdb-mode
381 winmgr-mode
382 autoconf-mode
383 cvs-edit-mode
385 html-mode html-helper-mode
386 emacs-lisp-mode lisp-mode lisp-interaction-mode
388 jde-mode java-mode
389 cc-mode c-mode c++-mode objc-mode
390 fortran-mode f90-mode
391 basic-mode
392 bat-mode
393 asm-mode
394 prolog-mode
395 flora-mode
396 sql-mode
398 text-mode indented-text-mode
399 tex-mode latex-mode bibtex-mode
400 ps-mode
402 completion-list-mode
403 diff-mode
405 perl-mode
406 javascript-mode
407 tcl-mode
408 python-mode
410 sh-mode ksh-mode csh-mode
412 gnus-article-mode
413 mh-show-mode
415 "Major modes that require Vi command state."
416 :type '(repeat symbol)
417 :group 'viper-misc)
419 (defcustom viper-emacs-state-mode-list
420 '(custom-mode
422 dired-mode
423 efs-mode
424 tar-mode
426 mh-folder-mode
427 gnus-group-mode
428 gnus-summary-mode
430 Info-mode
431 Buffer-menu-mode
432 compilation-mode
434 view-mode
435 vm-mode
436 vm-summary-mode)
437 "*A list of major modes that should come up in Emacs state.
438 Normally, Viper would bring buffers up in Emacs state, unless the corresponding
439 major mode has been placed on `viper-vi-state-mode-list' or
440 `viper-insert-state-mode-list'. So, don't place a new mode on this list,
441 unless it is coming up in a wrong Viper state."
442 :type '(repeat symbol)
443 :group 'viper-misc)
445 (defcustom viper-insert-state-mode-list
446 '(internal-ange-ftp-mode
447 comint-mode
448 eshell-mode
449 shell-mode)
450 "*A list of major modes that should come up in Vi Insert state."
451 :type '(repeat symbol)
452 :group 'viper-misc)
455 ;; used to set viper-major-mode-modifier-list in defcustom
456 (defun viper-apply-major-mode-modifiers (&optional symbol value)
457 (if symbol
458 (set symbol value))
459 (mapcar (lambda (triple)
460 (viper-modify-major-mode
461 (nth 0 triple) (nth 1 triple) (eval (nth 2 triple))))
462 viper-major-mode-modifier-list))
464 (defcustom viper-major-mode-modifier-list
465 '((help-mode emacs-state viper-slash-and-colon-map)
466 (comint-mode insert-state viper-comint-mode-modifier-map)
467 (comint-mode vi-state viper-comint-mode-modifier-map)
468 (shell-mode insert-state viper-comint-mode-modifier-map)
469 (shell-mode vi-state viper-comint-mode-modifier-map)
470 (ange-ftp-shell-mode insert-state viper-comint-mode-modifier-map)
471 (ange-ftp-shell-mode vi-state viper-comint-mode-modifier-map)
472 (internal-ange-ftp-mode insert-state viper-comint-mode-modifier-map)
473 (internal-ange-ftp-mode vi-state viper-comint-mode-modifier-map)
474 (dired-mode emacs-state viper-dired-modifier-map)
475 (tar-mode emacs-state viper-slash-and-colon-map)
476 (mh-folder-mode emacs-state viper-slash-and-colon-map)
477 (gnus-group-mode emacs-state viper-slash-and-colon-map)
478 (gnus-summary-mode emacs-state viper-slash-and-colon-map)
479 (Info-mode emacs-state viper-slash-and-colon-map)
480 (Buffer-menu-mode emacs-state viper-slash-and-colon-map)
482 "List specifying how to modify the various major modes to enable some Viperisms.
483 The list has the structure: ((mode viper-state keymap) (mode viper-state
484 keymap) ...). If `mode' is on the list, the `kemap' will be made active (on
485 the minor-mode-map-alist) in the specified viper state.
486 If you change this list, have to restart emacs for the change to take effect.
487 However, if you did the change through the customization widget, then emacs
488 needs to be restarted only if you deleted a triple mode-state-keymap from the
489 list. No need to restart emacs in case of insertion or modification of an
490 existing triple."
491 :type '(repeat
492 (list symbol
493 (choice (const emacs-state)
494 (const vi-state)
495 (const insert-state))
496 symbol))
497 :set 'viper-apply-major-mode-modifiers
498 :group 'viper-misc)
504 ;;;###autoload
505 (defun toggle-viper-mode ()
506 "Toggle Viper on/off.
507 If Viper is enabled, turn it off. Otherwise, turn it on."
508 (interactive)
509 (if (eq viper-mode t)
510 (viper-go-away)
511 (setq viper-mode nil)
512 (viper-mode)))
514 ;;;###autoload
515 (defun viper-mode ()
516 "Turn on Viper emulation of Vi."
517 (interactive)
518 (if (not noninteractive)
519 (progn
520 ;; if the user requested viper-mode explicitly
521 (if viper-mode
523 (setq viper-mode t)
524 (load-library "viper"))
526 (if viper-first-time ; Important check. Prevents mix-up of startup
527 (progn ; and expert-level msgs when viper-mode recurses
528 (setq viper-first-time nil)
529 (setq viper-vi-state-cursor-color
530 (viper-get-cursor-color))
531 (if (not viper-inhibit-startup-message)
532 (save-window-excursion
533 (setq viper-inhibit-startup-message t)
534 (delete-other-windows)
535 (switch-to-buffer "Viper Startup Message")
536 (erase-buffer)
537 (insert
538 (substitute-command-keys
539 "Viper Is a Package for Emacs Rebels,
540 a VI Plan for Emacs Rescue, and a venomous VI PERil.
542 Incidentally, Viper emulates Vi under GNU Emacs 20 and XEmacs 20.
543 It supports all of what is good in Vi and Ex, while extending
544 and improving upon much of it.
546 1. Viper supports Vi at several levels. Level 1 is the closest to Vi,
547 level 5 provides the most flexibility to depart from many Vi conventions.
549 You will be asked to specify your user level in a following screen.
551 If you select user level 1 then the keys ^X, ^C, ^Z, and ^G will behave
552 as in VI, to smooth transition to Viper for the beginners. However, to
553 use Emacs productively, you are advised to reach user level 3 or higher.
555 At user level 2 or higher, ^X and ^C have Emacs, not Vi, bindings;
556 ^Z toggles Vi/Emacs states; ^G is Emacs' keyboard-quit (like ^C in Vi).
558 2. Vi exit functions (e.g., :wq, ZZ) work on INDIVIDUAL files -- they
559 do not cause Emacs to quit, except at user level 1 (for a novice).
560 3. ^X^C EXITS EMACS.
561 4. Viper supports multiple undo: `u' will undo. Typing `.' will repeat
562 undo. Another `u' changes direction.
564 6. Emacs Meta key is `C-\\' (in all modes) or `\\ ESC' (in Vi command mode).
565 On a window system, the best way is to use the Meta-key on your keyboard.
566 7. Try \\[keyboard-quit] and \\[abort-recursive-edit] repeatedly,if
567 something funny happens. This would abort the current editing command.
569 For more information on Viper:
571 a. Type `:help' in Vi command mode
572 b. Print Viper manual, found in ./etc/viper.dvi
573 c. Print the Quick Reference, found in ./etc/viperCard.dvi
575 To submit a bug report or to contact the author, type :submitReport in Vi
576 command mode. To shoo Viper away and return to pure Emacs (horror!), type:
578 M-x viper-go-away
580 This startup message appears whenever you load Viper, unless you type `y' now."
582 (goto-char (point-min))
583 (if (y-or-n-p "Inhibit Viper startup message? ")
584 (viper-save-setting
585 'viper-inhibit-startup-message
586 "Viper startup message inhibited"
587 viper-custom-file-name t))
588 ;;(kill-buffer (current-buffer))
589 (message
590 "The last message is in buffer `Viper Startup Message'")
591 (sit-for 4)
593 (viper-set-expert-level 'dont-change-unless)))
595 (or (memq major-mode viper-emacs-state-mode-list) ; don't switch to Vi
596 (memq major-mode viper-insert-state-mode-list) ; don't switch
597 (viper-change-state-to-vi)))))
600 ;; This hook designed to enable Vi-style editing in comint-based modes."
601 (defun viper-comint-mode-hook ()
602 (setq require-final-newline nil
603 viper-ex-style-editing nil
604 viper-ex-style-motion nil)
605 (viper-change-state-to-insert))
608 ;; remove viper hooks from SYMBOL
609 (defun viper-remove-hooks (symbol)
610 (cond ((not (boundp symbol)) nil)
611 ((not (listp (eval symbol))) nil)
612 ((string-match "-hook" (symbol-name symbol))
613 (remove-hook symbol 'viper-mode)
614 (remove-hook symbol 'viper-change-state-to-emacs)
615 (remove-hook symbol 'viper-change-state-to-insert)
616 (remove-hook symbol 'viper-change-state-to-vi)
619 ;; Remove local value in all existing buffers
620 ;; This doesn't delocalize vars (which would have been desirable)
621 (defun viper-delocalize-var (symbol)
622 (mapcar (lambda (buf) (save-excursion
623 (set-buffer buf)
624 (kill-local-variable symbol)))
625 (buffer-list)))
628 (defun viper-go-away ()
629 "De-Viperize Emacs.
630 This function tries to do as good a job as possible. However, it may undo some
631 user customization, unrelated to Viper. For instance, if the user advised
632 `read-file-name', `describe-key', and some others, then this advice will be
633 undone.
634 It also doesn't undo some Viper settings. For instance, `minor-mode-map-alist'
635 remains buffer-local."
636 (interactive)
638 ;; restore non-viper vars
639 (setq-default
640 next-line-add-newlines
641 (viper-standard-value
642 'next-line-add-newlines viper-saved-non-viper-variables)
643 require-final-newline
644 (viper-standard-value
645 'require-final-newline viper-saved-non-viper-variables)
646 scroll-step
647 (viper-standard-value 'scroll-step viper-saved-non-viper-variables)
648 mode-line-buffer-identification
649 (viper-standard-value
650 'mode-line-buffer-identification viper-saved-non-viper-variables)
651 global-mode-string
652 (delq 'viper-mode-string global-mode-string))
654 (if viper-emacs-p
655 (setq-default
656 mark-even-if-inactive
657 (viper-standard-value
658 'mark-even-if-inactive viper-saved-non-viper-variables)))
660 ;; Ideally, we would like to be able to de-localize local variables
661 (viper-delocalize-var 'minor-mode-map-alist)
662 (viper-delocalize-var 'require-final-newline)
665 ;; deactivate all advices done by Viper.
666 (ad-deactivate-regexp "viper-")
668 (setq viper-mode nil)
670 (viper-delocalize-var 'viper-vi-minibuffer-minor-mode)
671 (viper-delocalize-var 'viper-insert-minibuffer-minor-mode)
672 (viper-delocalize-var 'viper-vi-intercept-minor-mode)
673 (viper-delocalize-var 'viper-insert-intercept-minor-mode)
675 (viper-delocalize-var 'viper-vi-local-user-minor-mode)
676 (viper-delocalize-var 'viper-vi-kbd-minor-mode)
677 (viper-delocalize-var 'viper-vi-global-user-minor-mode)
678 (viper-delocalize-var 'viper-vi-state-modifier-minor-mode)
679 (viper-delocalize-var 'viper-vi-diehard-minor-mode)
680 (viper-delocalize-var 'viper-vi-basic-minor-mode)
682 (viper-delocalize-var 'viper-replace-minor-mode)
684 (viper-delocalize-var 'viper-insert-local-user-minor-mode)
685 (viper-delocalize-var 'viper-insert-kbd-minor-mode)
686 (viper-delocalize-var 'viper-insert-global-user-minor-mode)
687 (viper-delocalize-var 'viper-insert-state-modifier-minor-mode)
688 (viper-delocalize-var 'viper-insert-diehard-minor-mode)
689 (viper-delocalize-var 'viper-insert-basic-minor-mode)
691 (viper-delocalize-var 'viper-emacs-intercept-minor-mode)
692 (viper-delocalize-var 'viper-emacs-local-user-minor-mode)
693 (viper-delocalize-var 'viper-emacs-kbd-minor-mode)
694 (viper-delocalize-var 'viper-emacs-global-user-minor-mode)
695 (viper-delocalize-var 'viper-emacs-state-modifier-minor-mode)
697 (viper-delocalize-var 'viper-current-state)
698 (viper-delocalize-var 'viper-mode-string)
700 (setq-default viper-vi-minibuffer-minor-mode nil
701 viper-insert-minibuffer-minor-mode nil
702 viper-vi-intercept-minor-mode nil
703 viper-insert-intercept-minor-mode nil
705 viper-vi-local-user-minor-mode nil
706 viper-vi-kbd-minor-mode nil
707 viper-vi-global-user-minor-mode nil
708 viper-vi-state-modifier-minor-mode nil
709 viper-vi-diehard-minor-mode nil
710 viper-vi-basic-minor-mode nil
712 viper-replace-minor-mode nil
714 viper-insert-local-user-minor-mode nil
715 viper-insert-kbd-minor-mode nil
716 viper-insert-global-user-minor-mode nil
717 viper-insert-state-modifier-minor-mode nil
718 viper-insert-diehard-minor-mode nil
719 viper-insert-basic-minor-mode nil
721 viper-emacs-intercept-minor-mode nil
722 viper-emacs-local-user-minor-mode nil
723 viper-emacs-kbd-minor-mode nil
724 viper-emacs-global-user-minor-mode nil
725 viper-emacs-state-modifier-minor-mode nil
727 viper-current-state 'emacs-state
728 viper-mode-string viper-emacs-state-id
731 ;; remove all hooks set by viper
732 (mapatoms 'viper-remove-hooks)
733 (remove-hook 'comint-mode-hook 'viper-comint-mode-hook)
734 (remove-hook 'minibuffer-setup-hook 'viper-minibuffer-setup-sentinel)
735 (remove-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
737 ;; unbind Viper mouse bindings
738 (viper-unbind-mouse-search-key)
739 (viper-unbind-mouse-insert-key)
740 ;; In emacs, we have to advice handle-switch-frame
741 ;; This advice is undone earlier, when all advices matchine "viper-" are
742 ;; deactivated.
743 (if viper-xemacs-p
744 (remove-hook 'mouse-leave-frame-hook 'viper-remember-current-frame))
745 ) ; end viper-go-away
748 ;; list of buffers that just changed their major mode
749 ;; used in a hack that triggers vi command mode whenever needed
750 (defvar viper-new-major-mode-buffer-list nil)
752 ;; set appropriate Viper state in buffers that changed major mode
753 (defun set-viper-state-in-major-mode ()
754 (mapcar
755 (lambda (buf)
756 (if (viper-buffer-live-p buf)
757 (with-current-buffer buf
758 (cond ((and (memq major-mode viper-vi-state-mode-list)
759 (eq viper-current-state 'emacs-state))
760 (viper-mode))
761 ((memq major-mode viper-emacs-state-mode-list)
762 ;; not checking (eq viper-current-state 'emacs-state)
763 ;; because viper-current-state could have gotten it by
764 ;; default. We need viper-change-state-to-emacs here to have
765 ;; the keymaps take effect.
766 (viper-change-state-to-emacs))
767 ((and (memq major-mode viper-insert-state-mode-list)
768 (not (eq viper-current-state 'insert-state)))
769 (viper-change-state-to-insert))
770 )) ; with-current-buffer
771 )) ; function
772 viper-new-major-mode-buffer-list)
773 ;; clear the list of bufs that changed major mode
774 (setq viper-new-major-mode-buffer-list nil)
775 ;; change the global value of hook
776 (remove-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode))
778 ;; sets up post-command-hook to turn viper-mode, if the current mode is
779 ;; fundamental
780 (defun viper-major-mode-change-sentinel ()
781 (save-match-data
782 (or (string-match "\*Minibuf-" (buffer-name))
783 (setq viper-new-major-mode-buffer-list
784 (cons (current-buffer) viper-new-major-mode-buffer-list))))
785 ;; change the global value of hook
786 (add-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode t))
790 ;; This sets major mode hooks to make them come up in vi-state.
791 (defun viper-set-hooks ()
792 ;; It is of course a misnomer to call viper-mode a `major mode'.
793 ;; However, this has the effect that if the user didn't specify the
794 ;; default mode, new buffers that fall back on the default will come up
795 ;; in Fundamental Mode and Vi state.
796 (if (eq default-major-mode 'fundamental-mode)
797 (setq default-major-mode 'viper-mode))
799 (add-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
800 (add-hook 'find-file-hooks 'set-viper-state-in-major-mode)
802 ;; keep this because many modes we don't know about use this hook
803 (defvar text-mode-hook)
804 (add-hook 'text-mode-hook 'viper-mode)
806 (defvar emerge-startup-hook)
807 (add-hook 'emerge-startup-hook 'viper-change-state-to-emacs)
809 ;; Tell vc-diff to put *vc* in Vi mode
810 (if (featurep 'vc)
811 (defadvice vc-diff (after viper-vc-ad activate)
812 "Force Vi state in VC diff buffer."
813 (viper-change-state-to-vi))
814 (eval-after-load
815 "vc"
816 '(defadvice vc-diff (after viper-vc-ad activate)
817 "Force Vi state in VC diff buffer."
818 (viper-change-state-to-vi))))
820 (eval-after-load
821 "emerge"
822 '(defadvice emerge-quit (after viper-emerge-advice activate)
823 "Run `viper-change-state-to-vi' after quitting emerge."
824 (viper-change-state-to-vi)))
825 ;; In case Emerge was loaded before Viper.
826 (defadvice emerge-quit (after viper-emerge-advice activate)
827 "Run `viper-change-state-to-vi' after quitting emerge."
828 (viper-change-state-to-vi))
830 ;; passwd.el sets up its own buffer, which turns up in Vi mode,
831 ;; thus overriding the local map. We don't need Vi mode here.
832 (eval-after-load
833 "passwd"
834 '(defadvice read-passwd-1 (before viper-passwd-ad activate)
835 "Switch to emacs state while reading password."
836 (viper-change-state-to-emacs)))
838 ;; Emacs shell, ange-ftp, and comint-based modes
839 (add-hook 'comint-mode-hook 'viper-comint-mode-hook) ; comint
841 (viper-set-emacs-state-searchstyle-macros nil 'dired-mode) ; dired
842 (viper-set-emacs-state-searchstyle-macros nil 'tar-mode) ; tar
843 (viper-set-emacs-state-searchstyle-macros nil 'mh-folder-mode) ; mhe
844 (viper-set-emacs-state-searchstyle-macros nil 'gnus-group-mode) ; gnus
845 (viper-set-emacs-state-searchstyle-macros nil 'gnus-summary-mode)
846 (viper-set-emacs-state-searchstyle-macros nil 'Info-mode) ; info
847 (viper-set-emacs-state-searchstyle-macros nil 'Buffer-menu-mode) ;buffer-menu
849 ;; Modify major modes according to viper-major-mode-modifier-list
850 (viper-apply-major-mode-modifiers)
852 ;; For RMAIL users.
853 ;; Put buf in Emacs state after edit.
854 (eval-after-load
855 "rmailedit"
856 '(defadvice rmail-cease-edit (after viper-rmail-advice activate)
857 "Switch to emacs state when done editing message."
858 (viper-change-state-to-emacs)))
859 ;; In case RMAIL was loaded before Viper.
860 (defadvice rmail-cease-edit (after viper-rmail-advice activate)
861 "Switch to emacs state when done editing message."
862 (viper-change-state-to-emacs))
864 ;; ISO accents
865 ;; Need to do it after loading iso-acc, or else this loading will wipe out
866 ;; the advice.
867 (eval-after-load
868 "iso-acc"
869 (defadvice iso-accents-mode (around viper-iso-accents-advice activate)
870 "Set viper-automatic-iso-accents to iso-accents-mode."
871 (let ((arg (ad-get-arg 0)))
872 ad-do-it
873 (setq viper-automatic-iso-accents
874 (if (eq viper-current-state 'vi-state)
875 (if arg
876 ;; if iso-accents-mode was called with positive arg, turn
877 ;; accents on
878 (> (prefix-numeric-value arg) 0)
879 ;; else: toggle viper-automatic-iso-accents
880 (not viper-automatic-iso-accents))
881 ;; other states: accept what iso-accents-mode has done
882 iso-accents-mode))
883 ;; turn off ISO accents in vi-state
884 (if (eq viper-current-state 'vi-state)
885 (viper-set-iso-accents-mode nil))
886 (if (memq viper-current-state '(vi-state insert-state replace-state))
887 (message "Viper ISO accents mode: %s"
888 (if viper-automatic-iso-accents "on" "off")))
891 ;; International input methods
892 (if viper-emacs-p
893 (eval-after-load "mule-cmds"
894 (progn
895 (defadvice inactivate-input-method (after viper-mule-advice activate)
896 "Set viper-special-input-method to disable intl. input methods."
897 (viper-inactivate-input-method-action))
898 (defadvice activate-input-method (after viper-mule-advice activate)
899 "Set viper-special-input-method to enable intl. input methods."
900 (viper-activate-input-method-action))
902 ;; XEmacs Although these hooks exist in Emacs, they don't seem to be always
903 ;; called on input-method activation/deactivation, so we the above advise
904 ;; functions instead.
905 (eval-after-load "mule-cmds"
906 (progn
907 (add-hook 'input-method-activate-hook
908 'viper-activate-input-method-action t)
909 (add-hook 'input-method-inactivate-hook
910 'viper-inactivate-input-method-action t)))
912 (eval-after-load "mule-cmds"
913 (defadvice toggle-input-method (around viper-mule-advice activate)
914 "Adjust input-method toggling in vi-state."
915 (if (and viper-special-input-method (eq viper-current-state 'vi-state))
916 (viper-inactivate-input-method)
917 ad-do-it)))
919 ) ; viper-set-hooks
922 ;; these are primarily advices and Vi-ish variable settings
923 (defun viper-non-hook-settings ()
925 ;; This var is not local in Emacs, so we make it local. It must be local
926 ;; because although the stack of minor modes can be the same for all buffers,
927 ;; the associated *keymaps* can be different. In Viper,
928 ;; viper-vi-local-user-map, viper-insert-local-user-map, and others can have
929 ;; different keymaps for different buffers. Also, the keymaps associated
930 ;; with viper-vi/insert-state-modifier-minor-mode can be different.
931 (make-variable-buffer-local 'minor-mode-map-alist)
933 ;; Viper changes the default mode-line-buffer-identification
934 (setq-default mode-line-buffer-identification '(" %b"))
936 ;; setup emacs-supported vi-style feel
937 (setq next-line-add-newlines nil
938 require-final-newline t)
940 (make-variable-buffer-local 'require-final-newline)
942 ;; don't bark when mark is inactive
943 (if viper-emacs-p
944 (setq mark-even-if-inactive t))
946 (setq scroll-step 1)
948 ;; Variable displaying the current Viper state in the mode line.
949 (viper-deflocalvar viper-mode-string viper-emacs-state-id)
950 (or (memq 'viper-mode-string global-mode-string)
951 (setq global-mode-string
952 (append '("" viper-mode-string) (cdr global-mode-string))))
954 (defadvice read-key-sequence (around viper-read-keyseq-ad activate)
955 "Harness to work for Viper. This advice is harmless---don't worry!"
956 (let (inhibit-quit event keyseq)
957 (setq keyseq ad-do-it)
958 (setq event (if viper-xemacs-p
959 (elt keyseq 0) ; XEmacs returns vector of events
960 (elt (listify-key-sequence keyseq) 0)))
961 (if (viper-ESC-event-p event)
962 (let (unread-command-events)
963 (viper-set-unread-command-events keyseq)
964 (if (viper-fast-keysequence-p)
965 (let ((viper-vi-global-user-minor-mode nil)
966 (viper-vi-local-user-minor-mode nil)
967 (viper-replace-minor-mode nil) ; actually unnecessary
968 (viper-insert-global-user-minor-mode nil)
969 (viper-insert-local-user-minor-mode nil))
970 (setq keyseq ad-do-it))
971 (setq keyseq ad-do-it))))
972 keyseq))
974 (defadvice describe-key (before viper-read-keyseq-ad protect activate)
975 "Force to read key via `read-key-sequence'."
976 (interactive (list (viper-events-to-keys
977 (read-key-sequence "Describe key: ")))))
979 (defadvice describe-key-briefly
980 (before viper-read-keyseq-ad protect activate)
981 "Force to read key via `read-key-sequence'."
982 (interactive (list (viper-events-to-keys
983 (read-key-sequence "Describe key briefly: ")))))
986 (defadvice find-file (before viper-add-suffix-advice activate)
987 "Use `read-file-name' for reading arguments."
988 (interactive (cons (read-file-name "Find file: " nil default-directory)
989 ;; XEmacs: if Mule & prefix arg, ask for coding system
990 (cond ((and viper-xemacs-p (featurep 'mule))
991 (list
992 (and current-prefix-arg
993 (read-coding-system "Coding-system: "))))
994 ;; Emacs: do wildcards
995 ((and viper-emacs-p (boundp 'find-file-wildcards))
996 (list find-file-wildcards))))
999 (defadvice find-file-other-window (before viper-add-suffix-advice activate)
1000 "Use `read-file-name' for reading arguments."
1001 (interactive (cons (read-file-name "Find file in other window: "
1002 nil default-directory)
1003 ;; XEmacs: if Mule & prefix arg, ask for coding system
1004 (cond ((and viper-xemacs-p (featurep 'mule))
1005 (list
1006 (and current-prefix-arg
1007 (read-coding-system "Coding-system: "))))
1008 ;; Emacs: do wildcards
1009 ((and viper-emacs-p (boundp 'find-file-wildcards))
1010 (list find-file-wildcards))))
1014 (defadvice find-file-other-frame (before viper-add-suffix-advice activate)
1015 "Use `read-file-name' for reading arguments."
1016 (interactive (cons (read-file-name "Find file in other frame: "
1017 nil default-directory)
1018 ;; XEmacs: if Mule & prefix arg, ask for coding system
1019 (cond ((and viper-xemacs-p (featurep 'mule))
1020 (list
1021 (and current-prefix-arg
1022 (read-coding-system "Coding-system: "))))
1023 ;; Emacs: do wildcards
1024 ((and viper-emacs-p (boundp 'find-file-wildcards))
1025 (list find-file-wildcards))))
1029 (defadvice read-file-name (around viper-suffix-advice activate)
1030 "Tell `exit-minibuffer' to run `viper-file-add-suffix' as a hook."
1031 (let ((viper-minibuffer-exit-hook
1032 (append viper-minibuffer-exit-hook
1033 '(viper-minibuffer-trim-tail viper-file-add-suffix))))
1034 ad-do-it))
1036 (defadvice start-kbd-macro (after viper-kbd-advice activate)
1037 "Remove Viper's intercepting bindings for C-x ).
1038 This may be needed if the previous `:map' command terminated abnormally."
1039 (define-key viper-vi-intercept-map "\C-x)" nil)
1040 (define-key viper-insert-intercept-map "\C-x)" nil)
1041 (define-key viper-emacs-intercept-map "\C-x)" nil))
1043 ;; catch frame switching event
1044 (if (viper-window-display-p)
1045 (if viper-xemacs-p
1046 (add-hook 'mouse-leave-frame-hook
1047 'viper-remember-current-frame)
1048 (defadvice handle-switch-frame (before viper-frame-advice activate)
1049 "Remember the selected frame before the switch-frame event."
1050 (viper-remember-current-frame (selected-frame)))) )
1052 ) ; end viper-non-hook-settings
1055 ;; Ask only if this-command/last-command are nil, i.e., when loading
1056 (cond ((and (eq viper-mode 'ask) (null this-command) (null last-command))
1057 (save-window-excursion
1058 (with-output-to-temp-buffer " *viper-info*"
1059 (princ "
1060 You have loaded Viper, and are about to Viperize your emacs!
1062 Viper is a Package for Emacs Rebels and a venomous VI PERil,
1064 It's time to decide: to Viperize or not to Viperize...
1066 If you wish to Viperize AND make this your way of life, please put
1068 (setq viper-mode t)
1069 (require 'viper)
1071 in your .emacs file (preferably, close to the top).
1072 These two lines must come in the order given.
1074 ** Viper users:
1075 **** The startup file name has been changed from .vip to .viper
1076 **** All vip-* style names have been converted to viper-* style."))
1077 (if (y-or-n-p "Viperize? ")
1078 (setq viper-mode t)
1079 (setq viper-mode nil))
1080 (message "")
1081 (kill-buffer " *viper-info*")))
1083 ;; If viper-mode is t, then just continue. Viper will kick in.
1084 ((eq viper-mode t))
1085 ;; Otherwise, it was asking Viper was not loaded through .emacs
1086 ;; In this case, it was either through M-x viper-mode or via something
1087 ;; else, like the custom widget. If Viper was loaded through
1088 ;; M-x viper-mode, then viper will kick in anyway.
1089 (t (setq viper-mode nil)))
1091 (defun viper-load-custom-file ()
1092 (if (and (file-exists-p viper-custom-file-name)
1093 (not noninteractive))
1094 (load viper-custom-file-name)))
1099 ;; Get viper standard value of SYMBOL. If symbol is customized, get its
1100 ;; standard value. Otherwise, get the value saved in the alist STORAGE. If
1101 ;; STORAGE is nil, use viper-saved-user-settings.
1102 (defun viper-standard-value (symbol &optional storage)
1103 (or (eval (car (get symbol 'customized-value)))
1104 (eval (car (get symbol 'saved-value)))
1105 (nth 1 (assoc symbol (or storage viper-saved-user-settings)))))
1109 ;; save non-viper vars that Viper might change
1110 (if (null viper-saved-non-viper-variables)
1111 (setq viper-saved-non-viper-variables
1112 (list
1113 (cons 'next-line-add-newlines (list next-line-add-newlines))
1114 (cons 'require-final-newline (list require-final-newline))
1115 (cons 'scroll-step (list scroll-step))
1116 (cons 'mode-line-buffer-identification
1117 (list (default-value 'mode-line-buffer-identification)))
1118 (cons 'global-mode-string (list global-mode-string))
1119 (if viper-emacs-p
1120 (cons 'mark-even-if-inactive (list mark-even-if-inactive)))
1124 ;; Set some useful macros, advices
1125 ;; These must be BEFORE ~/.viper is loaded,
1126 ;; so the user can unrecord them in ~/.viper.
1127 (if viper-mode
1128 (progn
1129 ;; set advices and some variables that give emacs Vi look.
1130 (viper-non-hook-settings)
1132 ;; repeat the 2nd previous command without rotating the command history
1133 (viper-record-kbd-macro
1134 (vector viper-repeat-from-history-key '\1) 'vi-state
1135 [(meta x) v i p e r - r e p e a t - f r o m - h i s t o r y return] 't)
1136 ;; repeat the 3d previous command without rotating the command history
1137 (viper-record-kbd-macro
1138 (vector viper-repeat-from-history-key '\2) 'vi-state
1139 [(meta x) v i p e r - r e p e a t - f r o m - h i s t o r y return] 't)
1141 ;; set macros for toggling case sensitivity and regexp search
1142 (viper-set-searchstyle-toggling-macros nil)
1143 ;; Make %%% toggle parsing comments for matching parentheses
1144 (viper-set-parsing-style-toggling-macro nil)
1146 ;; ~/.viper is loaded if exists
1147 (viper-load-custom-file)
1149 ;; should be after loading custom file to avoid the pesky msg that
1150 ;; mouse-search/insert keys are already bound
1151 (viper-bind-mouse-search-key)
1152 (viper-bind-mouse-insert-key)
1157 ;; Applying Viper customization -- runs after (load .viper)
1159 ;; Save user settings or Viper defaults for vars controled by
1160 ;; viper-expert-level
1161 (if (null viper-saved-user-settings)
1162 (setq viper-saved-user-settings
1163 (list (cons 'viper-want-ctl-h-help (list viper-want-ctl-h-help))
1164 (cons 'viper-always (list viper-always))
1165 (cons 'viper-no-multiple-ESC (list viper-no-multiple-ESC))
1166 (cons 'viper-ex-style-motion (list viper-ex-style-motion))
1167 (cons 'viper-ex-style-editing
1168 (list viper-ex-style-editing))
1169 (cons 'viper-want-emacs-keys-in-vi
1170 (list viper-want-emacs-keys-in-vi))
1171 (cons 'viper-electric-mode (list viper-electric-mode))
1172 (cons 'viper-want-emacs-keys-in-insert
1173 (list viper-want-emacs-keys-in-insert))
1174 (cons 'viper-re-search (list viper-re-search)))))
1177 (if viper-mode
1178 (progn
1179 (viper-set-minibuffer-style)
1180 (if viper-buffer-search-char
1181 (viper-buffer-search-enable))
1182 (viper-update-syntax-classes 'set-default)
1186 ;;; Familiarize Viper with some minor modes that have their own keymaps
1187 (if viper-mode
1188 (progn
1189 (viper-harness-minor-mode "compile")
1190 (viper-harness-minor-mode "outline")
1191 (viper-harness-minor-mode "allout")
1192 (viper-harness-minor-mode "xref")
1193 (viper-harness-minor-mode "lmenu")
1194 (viper-harness-minor-mode "vc")
1195 (viper-harness-minor-mode "ltx-math") ; LaTeX-math-mode in AUC-TeX, which
1196 (viper-harness-minor-mode "latex") ; sits in one of these two files
1197 (viper-harness-minor-mode "cyrillic")
1198 (viper-harness-minor-mode "russian")
1199 (viper-harness-minor-mode "view-less")
1200 (viper-harness-minor-mode "view")
1201 (viper-harness-minor-mode "reftex")
1202 (viper-harness-minor-mode "flyspell")
1206 ;; Intercept maps could go in viper-keym.el
1207 ;; We keep them here in case someone redefines them in ~/.viper
1209 (define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1210 (define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1212 ;; This is taken care of by viper-insert-global-user-map.
1213 ;;(define-key viper-replace-map viper-ESC-key 'viper-intercept-ESC-key)
1216 ;; The default viper-toggle-key is \C-z; for the novice, it suspends or
1217 ;; iconifies Emacs
1218 (define-key viper-vi-intercept-map viper-toggle-key 'viper-toggle-key-action)
1219 (define-key
1220 viper-emacs-intercept-map viper-toggle-key 'viper-change-state-to-vi)
1222 ;;; Escape from Emacs and Insert modes to Vi for one command
1223 (define-key
1224 viper-emacs-intercept-map "\C-c\\" 'viper-escape-to-vi)
1225 (define-key
1226 viper-insert-intercept-map "\C-c\\" 'viper-escape-to-vi)
1228 (if viper-mode
1229 (setq-default viper-emacs-intercept-minor-mode t
1230 viper-emacs-local-user-minor-mode t
1231 viper-emacs-global-user-minor-mode t
1232 viper-emacs-kbd-minor-mode t
1233 viper-emacs-state-modifier-minor-mode t))
1234 (if (and viper-mode (eq viper-current-state 'emacs-state))
1235 (setq viper-emacs-intercept-minor-mode t
1236 viper-emacs-local-user-minor-mode t
1237 viper-emacs-global-user-minor-mode t
1238 viper-emacs-kbd-minor-mode t
1239 viper-emacs-state-modifier-minor-mode t))
1242 (if (and viper-mode
1243 (or viper-always
1244 (and (< viper-expert-level 5) (> viper-expert-level 0))))
1245 (viper-set-hooks))
1247 ;; Let all minor modes take effect after loading
1248 ;; this may not be enough, so we also set default minor-mode-alist.
1249 ;; Without setting the default, new buffers that come up in emacs mode have
1250 ;; minor-mode-map-alist = nil, unless we call viper-change-state-*
1251 (if (and viper-mode (eq viper-current-state 'emacs-state))
1252 (progn
1253 (viper-change-state-to-emacs)
1254 (setq-default minor-mode-map-alist minor-mode-map-alist)
1257 (if (and viper-mode (memq major-mode viper-vi-state-mode-list))
1258 (viper-mode))
1261 (run-hooks 'viper-load-hook) ; the last chance to change something
1263 (provide 'viper)
1266 ;;; Local Variables:
1267 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1268 ;;; End:
1270 ;;; viper.el ends here