(inhibit_eval_during_redisplay)
[emacs.git] / lisp / emulation / viper.el
blob9e8efaf8b0d1acba7fefd58a310a3648cfd162b5
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, 01 Free Software Foundation, Inc.
11 (defconst viper-version "3.10 of March 3, 2001"
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 cperl-mode
407 javascript-mode
408 tcl-mode
409 python-mode
411 sh-mode ksh-mode csh-mode
413 gnus-article-mode
414 mh-show-mode
416 "Major modes that require Vi command state."
417 :type '(repeat symbol)
418 :group 'viper-misc)
420 (defcustom viper-emacs-state-mode-list
421 '(custom-mode
423 dired-mode
424 efs-mode
425 tar-mode
427 mh-folder-mode
428 gnus-group-mode
429 gnus-summary-mode
431 Info-mode
432 Buffer-menu-mode
433 compilation-mode
435 view-mode
436 vm-mode
437 vm-summary-mode)
438 "*A list of major modes that should come up in Emacs state.
439 Normally, Viper would bring buffers up in Emacs state, unless the corresponding
440 major mode has been placed on `viper-vi-state-mode-list' or
441 `viper-insert-state-mode-list'. So, don't place a new mode on this list,
442 unless it is coming up in a wrong Viper state."
443 :type '(repeat symbol)
444 :group 'viper-misc)
446 (defcustom viper-insert-state-mode-list
447 '(internal-ange-ftp-mode
448 comint-mode
449 eshell-mode
450 shell-mode)
451 "*A list of major modes that should come up in Vi Insert state."
452 :type '(repeat symbol)
453 :group 'viper-misc)
456 ;; used to set viper-major-mode-modifier-list in defcustom
457 (defun viper-apply-major-mode-modifiers (&optional symbol value)
458 (if symbol
459 (set symbol value))
460 (mapcar (lambda (triple)
461 (viper-modify-major-mode
462 (nth 0 triple) (nth 1 triple) (eval (nth 2 triple))))
463 viper-major-mode-modifier-list))
465 (defcustom viper-major-mode-modifier-list
466 '((help-mode emacs-state viper-slash-and-colon-map)
467 (comint-mode insert-state viper-comint-mode-modifier-map)
468 (comint-mode vi-state viper-comint-mode-modifier-map)
469 (shell-mode insert-state viper-comint-mode-modifier-map)
470 (shell-mode vi-state viper-comint-mode-modifier-map)
471 (ange-ftp-shell-mode insert-state viper-comint-mode-modifier-map)
472 (ange-ftp-shell-mode vi-state viper-comint-mode-modifier-map)
473 (internal-ange-ftp-mode insert-state viper-comint-mode-modifier-map)
474 (internal-ange-ftp-mode vi-state viper-comint-mode-modifier-map)
475 (dired-mode emacs-state viper-dired-modifier-map)
476 (tar-mode emacs-state viper-slash-and-colon-map)
477 (mh-folder-mode emacs-state viper-slash-and-colon-map)
478 (gnus-group-mode emacs-state viper-slash-and-colon-map)
479 (gnus-summary-mode emacs-state viper-slash-and-colon-map)
480 (Info-mode emacs-state viper-slash-and-colon-map)
481 (Buffer-menu-mode emacs-state viper-slash-and-colon-map)
483 "List specifying how to modify the various major modes to enable some Viperisms.
484 The list has the structure: ((mode viper-state keymap) (mode viper-state
485 keymap) ...). If `mode' is on the list, the `kemap' will be made active (on
486 the minor-mode-map-alist) in the specified viper state.
487 If you change this list, have to restart emacs for the change to take effect.
488 However, if you did the change through the customization widget, then emacs
489 needs to be restarted only if you deleted a triple mode-state-keymap from the
490 list. No need to restart emacs in case of insertion or modification of an
491 existing triple."
492 :type '(repeat
493 (list symbol
494 (choice (const emacs-state)
495 (const vi-state)
496 (const insert-state))
497 symbol))
498 :set 'viper-apply-major-mode-modifiers
499 :group 'viper-misc)
505 ;;;###autoload
506 (defun toggle-viper-mode ()
507 "Toggle Viper on/off.
508 If Viper is enabled, turn it off. Otherwise, turn it on."
509 (interactive)
510 (if (eq viper-mode t)
511 (viper-go-away)
512 (setq viper-mode nil)
513 (viper-mode)))
515 ;;;###autoload
516 (defun viper-mode ()
517 "Turn on Viper emulation of Vi."
518 (interactive)
519 (if (not noninteractive)
520 (progn
521 ;; if the user requested viper-mode explicitly
522 (if viper-mode
524 (setq viper-mode t)
525 (load-library "viper"))
527 (if viper-first-time ; Important check. Prevents mix-up of startup
528 (progn ; and expert-level msgs when viper-mode recurses
529 (setq viper-first-time nil)
530 (setq viper-vi-state-cursor-color
531 (viper-get-cursor-color))
532 (if (not viper-inhibit-startup-message)
533 (save-window-excursion
534 (setq viper-inhibit-startup-message t)
535 (delete-other-windows)
536 (switch-to-buffer "Viper Startup Message")
537 (erase-buffer)
538 (insert
539 (substitute-command-keys
540 "Viper Is a Package for Emacs Rebels,
541 a VI Plan for Emacs Rescue, and a venomous VI PERil.
543 Incidentally, Viper emulates Vi under GNU Emacs 20 and XEmacs 20.
544 It supports all of what is good in Vi and Ex, while extending
545 and improving upon much of it.
547 1. Viper supports Vi at several levels. Level 1 is the closest to Vi,
548 level 5 provides the most flexibility to depart from many Vi conventions.
550 You will be asked to specify your user level in a following screen.
552 If you select user level 1 then the keys ^X, ^C, ^Z, and ^G will behave
553 as in VI, to smooth transition to Viper for the beginners. However, to
554 use Emacs productively, you are advised to reach user level 3 or higher.
556 At user level 2 or higher, ^X and ^C have Emacs, not Vi, bindings;
557 ^Z toggles Vi/Emacs states; ^G is Emacs' keyboard-quit (like ^C in Vi).
559 2. Vi exit functions (e.g., :wq, ZZ) work on INDIVIDUAL files -- they
560 do not cause Emacs to quit, except at user level 1 (for a novice).
561 3. ^X^C EXITS EMACS.
562 4. Viper supports multiple undo: `u' will undo. Typing `.' will repeat
563 undo. Another `u' changes direction.
565 6. Emacs Meta key is `C-\\' (in all modes) or `\\ ESC' (in Vi command mode).
566 On a window system, the best way is to use the Meta-key on your keyboard.
567 7. Try \\[keyboard-quit] and \\[abort-recursive-edit] repeatedly,if
568 something funny happens. This would abort the current editing command.
570 For more information on Viper:
572 a. Type `:help' in Vi command mode
573 b. Print Viper manual, found in ./etc/viper.dvi
574 c. Print the Quick Reference, found in ./etc/viperCard.dvi
576 To submit a bug report or to contact the author, type :submitReport in Vi
577 command mode. To shoo Viper away and return to pure Emacs (horror!), type:
579 M-x viper-go-away
581 This startup message appears whenever you load Viper, unless you type `y' now."
583 (goto-char (point-min))
584 (if (y-or-n-p "Inhibit Viper startup message? ")
585 (viper-save-setting
586 'viper-inhibit-startup-message
587 "Viper startup message inhibited"
588 viper-custom-file-name t))
589 ;;(kill-buffer (current-buffer))
590 (message
591 "The last message is in buffer `Viper Startup Message'")
592 (sit-for 4)
594 (viper-set-expert-level 'dont-change-unless)))
596 (if viper-xemacs-p
597 (make-variable-buffer-local 'bar-cursor))
599 (or (memq major-mode viper-emacs-state-mode-list) ; don't switch to Vi
600 (memq major-mode viper-insert-state-mode-list) ; don't switch
601 (viper-change-state-to-vi)))))
604 ;; This hook designed to enable Vi-style editing in comint-based modes."
605 (defun viper-comint-mode-hook ()
606 (setq require-final-newline nil
607 viper-ex-style-editing nil
608 viper-ex-style-motion nil)
609 (viper-change-state-to-insert))
612 ;; remove viper hooks from SYMBOL
613 (defun viper-remove-hooks (symbol)
614 (cond ((not (boundp symbol)) nil)
615 ((not (listp (eval symbol))) nil)
616 ((string-match "-hook" (symbol-name symbol))
617 (remove-hook symbol 'viper-mode)
618 (remove-hook symbol 'viper-change-state-to-emacs)
619 (remove-hook symbol 'viper-change-state-to-insert)
620 (remove-hook symbol 'viper-change-state-to-vi)
623 ;; Remove local value in all existing buffers
624 ;; This doesn't delocalize vars (which would have been desirable)
625 (defun viper-delocalize-var (symbol)
626 (mapcar (lambda (buf) (save-excursion
627 (set-buffer buf)
628 (kill-local-variable symbol)))
629 (buffer-list)))
632 (defun viper-go-away ()
633 "De-Viperize Emacs.
634 This function tries to do as good a job as possible. However, it may undo some
635 user customization, unrelated to Viper. For instance, if the user advised
636 `read-file-name', `describe-key', and some others, then this advice will be
637 undone.
638 It also doesn't undo some Viper settings. For instance, `minor-mode-map-alist'
639 remains buffer-local."
640 (interactive)
642 ;; restore non-viper vars
643 (setq-default
644 next-line-add-newlines
645 (viper-standard-value
646 'next-line-add-newlines viper-saved-non-viper-variables)
647 require-final-newline
648 (viper-standard-value
649 'require-final-newline viper-saved-non-viper-variables)
650 scroll-step
651 (viper-standard-value 'scroll-step viper-saved-non-viper-variables)
652 mode-line-buffer-identification
653 (viper-standard-value
654 'mode-line-buffer-identification viper-saved-non-viper-variables)
655 global-mode-string
656 (delq 'viper-mode-string global-mode-string))
658 (if viper-emacs-p
659 (setq-default
660 mark-even-if-inactive
661 (viper-standard-value
662 'mark-even-if-inactive viper-saved-non-viper-variables)))
664 ;; Ideally, we would like to be able to de-localize local variables
665 (viper-delocalize-var 'minor-mode-map-alist)
666 (viper-delocalize-var 'require-final-newline)
667 (if viper-xemacs-p (viper-delocalize-var 'bar-cursor))
670 ;; deactivate all advices done by Viper.
671 (ad-deactivate-regexp "viper-")
673 (setq viper-mode nil)
675 (viper-delocalize-var 'viper-vi-minibuffer-minor-mode)
676 (viper-delocalize-var 'viper-insert-minibuffer-minor-mode)
677 (viper-delocalize-var 'viper-vi-intercept-minor-mode)
678 (viper-delocalize-var 'viper-insert-intercept-minor-mode)
680 (viper-delocalize-var 'viper-vi-local-user-minor-mode)
681 (viper-delocalize-var 'viper-vi-kbd-minor-mode)
682 (viper-delocalize-var 'viper-vi-global-user-minor-mode)
683 (viper-delocalize-var 'viper-vi-state-modifier-minor-mode)
684 (viper-delocalize-var 'viper-vi-diehard-minor-mode)
685 (viper-delocalize-var 'viper-vi-basic-minor-mode)
687 (viper-delocalize-var 'viper-replace-minor-mode)
689 (viper-delocalize-var 'viper-insert-local-user-minor-mode)
690 (viper-delocalize-var 'viper-insert-kbd-minor-mode)
691 (viper-delocalize-var 'viper-insert-global-user-minor-mode)
692 (viper-delocalize-var 'viper-insert-state-modifier-minor-mode)
693 (viper-delocalize-var 'viper-insert-diehard-minor-mode)
694 (viper-delocalize-var 'viper-insert-basic-minor-mode)
696 (viper-delocalize-var 'viper-emacs-intercept-minor-mode)
697 (viper-delocalize-var 'viper-emacs-local-user-minor-mode)
698 (viper-delocalize-var 'viper-emacs-kbd-minor-mode)
699 (viper-delocalize-var 'viper-emacs-global-user-minor-mode)
700 (viper-delocalize-var 'viper-emacs-state-modifier-minor-mode)
702 (viper-delocalize-var 'viper-current-state)
703 (viper-delocalize-var 'viper-mode-string)
705 (setq-default viper-vi-minibuffer-minor-mode nil
706 viper-insert-minibuffer-minor-mode nil
707 viper-vi-intercept-minor-mode nil
708 viper-insert-intercept-minor-mode nil
710 viper-vi-local-user-minor-mode nil
711 viper-vi-kbd-minor-mode nil
712 viper-vi-global-user-minor-mode nil
713 viper-vi-state-modifier-minor-mode nil
714 viper-vi-diehard-minor-mode nil
715 viper-vi-basic-minor-mode nil
717 viper-replace-minor-mode nil
719 viper-insert-local-user-minor-mode nil
720 viper-insert-kbd-minor-mode nil
721 viper-insert-global-user-minor-mode nil
722 viper-insert-state-modifier-minor-mode nil
723 viper-insert-diehard-minor-mode nil
724 viper-insert-basic-minor-mode nil
726 viper-emacs-intercept-minor-mode nil
727 viper-emacs-local-user-minor-mode nil
728 viper-emacs-kbd-minor-mode nil
729 viper-emacs-global-user-minor-mode nil
730 viper-emacs-state-modifier-minor-mode nil
732 viper-current-state 'emacs-state
733 viper-mode-string viper-emacs-state-id
736 ;; remove all hooks set by viper
737 (mapatoms 'viper-remove-hooks)
738 (remove-hook 'comint-mode-hook 'viper-comint-mode-hook)
739 (remove-hook 'minibuffer-setup-hook 'viper-minibuffer-setup-sentinel)
740 (remove-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
742 ;; unbind Viper mouse bindings
743 (viper-unbind-mouse-search-key)
744 (viper-unbind-mouse-insert-key)
745 ;; In emacs, we have to advice handle-switch-frame
746 ;; This advice is undone earlier, when all advices matchine "viper-" are
747 ;; deactivated.
748 (if viper-xemacs-p
749 (remove-hook 'mouse-leave-frame-hook 'viper-remember-current-frame))
750 ) ; end viper-go-away
753 ;; list of buffers that just changed their major mode
754 ;; used in a hack that triggers vi command mode whenever needed
755 (defvar viper-new-major-mode-buffer-list nil)
757 ;; set appropriate Viper state in buffers that changed major mode
758 (defun set-viper-state-in-major-mode ()
759 (mapcar
760 (lambda (buf)
761 (if (viper-buffer-live-p buf)
762 (with-current-buffer buf
763 (cond ((and (memq major-mode viper-vi-state-mode-list)
764 (eq viper-current-state 'emacs-state))
765 (viper-mode))
766 ((memq major-mode viper-emacs-state-mode-list)
767 ;; not checking (eq viper-current-state 'emacs-state)
768 ;; because viper-current-state could have gotten it by
769 ;; default. We need viper-change-state-to-emacs here to have
770 ;; the keymaps take effect.
771 (viper-change-state-to-emacs))
772 ((and (memq major-mode viper-insert-state-mode-list)
773 (not (eq viper-current-state 'insert-state)))
774 (viper-change-state-to-insert))
775 )) ; with-current-buffer
776 )) ; function
777 viper-new-major-mode-buffer-list)
778 ;; clear the list of bufs that changed major mode
779 (setq viper-new-major-mode-buffer-list nil)
780 ;; change the global value of hook
781 (remove-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode))
783 ;; sets up post-command-hook to turn viper-mode, if the current mode is
784 ;; fundamental
785 (defun viper-major-mode-change-sentinel ()
786 (save-match-data
787 (or (string-match "\*Minibuf-" (buffer-name))
788 (setq viper-new-major-mode-buffer-list
789 (cons (current-buffer) viper-new-major-mode-buffer-list))))
790 ;; change the global value of hook
791 (add-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode t))
795 ;; This sets major mode hooks to make them come up in vi-state.
796 (defun viper-set-hooks ()
797 ;; It is of course a misnomer to call viper-mode a `major mode'.
798 ;; However, this has the effect that if the user didn't specify the
799 ;; default mode, new buffers that fall back on the default will come up
800 ;; in Fundamental Mode and Vi state.
801 (if (eq default-major-mode 'fundamental-mode)
802 (setq default-major-mode 'viper-mode))
804 (add-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
805 (add-hook 'find-file-hooks 'set-viper-state-in-major-mode)
807 ;; keep this because many modes we don't know about use this hook
808 (defvar text-mode-hook)
809 (add-hook 'text-mode-hook 'viper-mode)
811 (defvar emerge-startup-hook)
812 (add-hook 'emerge-startup-hook 'viper-change-state-to-emacs)
814 ;; Tell vc-diff to put *vc* in Vi mode
815 (if (featurep 'vc)
816 (defadvice vc-diff (after viper-vc-ad activate)
817 "Force Vi state in VC diff buffer."
818 (viper-change-state-to-vi))
819 (eval-after-load
820 "vc"
821 '(defadvice vc-diff (after viper-vc-ad activate)
822 "Force Vi state in VC diff buffer."
823 (viper-change-state-to-vi))))
825 (eval-after-load
826 "emerge"
827 '(defadvice emerge-quit (after viper-emerge-advice activate)
828 "Run `viper-change-state-to-vi' after quitting emerge."
829 (viper-change-state-to-vi)))
830 ;; In case Emerge was loaded before Viper.
831 (defadvice emerge-quit (after viper-emerge-advice activate)
832 "Run `viper-change-state-to-vi' after quitting emerge."
833 (viper-change-state-to-vi))
835 ;; passwd.el sets up its own buffer, which turns up in Vi mode,
836 ;; thus overriding the local map. We don't need Vi mode here.
837 (eval-after-load
838 "passwd"
839 '(defadvice read-passwd-1 (before viper-passwd-ad activate)
840 "Switch to emacs state while reading password."
841 (viper-change-state-to-emacs)))
843 ;; Emacs shell, ange-ftp, and comint-based modes
844 (add-hook 'comint-mode-hook 'viper-comint-mode-hook) ; comint
846 (viper-set-emacs-state-searchstyle-macros nil 'dired-mode) ; dired
847 (viper-set-emacs-state-searchstyle-macros nil 'tar-mode) ; tar
848 (viper-set-emacs-state-searchstyle-macros nil 'mh-folder-mode) ; mhe
849 (viper-set-emacs-state-searchstyle-macros nil 'gnus-group-mode) ; gnus
850 (viper-set-emacs-state-searchstyle-macros nil 'gnus-summary-mode)
851 (viper-set-emacs-state-searchstyle-macros nil 'Info-mode) ; info
852 (viper-set-emacs-state-searchstyle-macros nil 'Buffer-menu-mode) ;buffer-menu
854 ;; Modify major modes according to viper-major-mode-modifier-list
855 (viper-apply-major-mode-modifiers)
857 ;; For RMAIL users.
858 ;; Put buf in Emacs state after edit.
859 (eval-after-load
860 "rmailedit"
861 '(defadvice rmail-cease-edit (after viper-rmail-advice activate)
862 "Switch to emacs state when done editing message."
863 (viper-change-state-to-emacs)))
864 ;; In case RMAIL was loaded before Viper.
865 (defadvice rmail-cease-edit (after viper-rmail-advice activate)
866 "Switch to emacs state when done editing message."
867 (viper-change-state-to-emacs))
869 ;; ISO accents
870 ;; Need to do it after loading iso-acc, or else this loading will wipe out
871 ;; the advice.
872 (eval-after-load
873 "iso-acc"
874 (defadvice iso-accents-mode (around viper-iso-accents-advice activate)
875 "Set viper-automatic-iso-accents to iso-accents-mode."
876 (let ((arg (ad-get-arg 0)))
877 ad-do-it
878 (setq viper-automatic-iso-accents
879 (if (eq viper-current-state 'vi-state)
880 (if arg
881 ;; if iso-accents-mode was called with positive arg, turn
882 ;; accents on
883 (> (prefix-numeric-value arg) 0)
884 ;; else: toggle viper-automatic-iso-accents
885 (not viper-automatic-iso-accents))
886 ;; other states: accept what iso-accents-mode has done
887 iso-accents-mode))
888 ;; turn off ISO accents in vi-state
889 (if (eq viper-current-state 'vi-state)
890 (viper-set-iso-accents-mode nil))
891 (if (memq viper-current-state '(vi-state insert-state replace-state))
892 (message "Viper ISO accents mode: %s"
893 (if viper-automatic-iso-accents "on" "off")))
896 ;; International input methods
897 (if viper-emacs-p
898 (eval-after-load "mule-cmds"
899 (progn
900 (defadvice inactivate-input-method (after viper-mule-advice activate)
901 "Set viper-special-input-method to disable intl. input methods."
902 (viper-inactivate-input-method-action))
903 (defadvice activate-input-method (after viper-mule-advice activate)
904 "Set viper-special-input-method to enable intl. input methods."
905 (viper-activate-input-method-action))
907 ;; XEmacs Although these hooks exist in Emacs, they don't seem to be always
908 ;; called on input-method activation/deactivation, so we the above advise
909 ;; functions instead.
910 (eval-after-load "mule-cmds"
911 (progn
912 (add-hook 'input-method-activate-hook
913 'viper-activate-input-method-action t)
914 (add-hook 'input-method-inactivate-hook
915 'viper-inactivate-input-method-action t)))
917 (eval-after-load "mule-cmds"
918 (defadvice toggle-input-method (around viper-mule-advice activate)
919 "Adjust input-method toggling in vi-state."
920 (if (and viper-special-input-method (eq viper-current-state 'vi-state))
921 (viper-inactivate-input-method)
922 ad-do-it)))
924 ) ; viper-set-hooks
927 ;; these are primarily advices and Vi-ish variable settings
928 (defun viper-non-hook-settings ()
930 ;; This var is not local in Emacs, so we make it local. It must be local
931 ;; because although the stack of minor modes can be the same for all buffers,
932 ;; the associated *keymaps* can be different. In Viper,
933 ;; viper-vi-local-user-map, viper-insert-local-user-map, and others can have
934 ;; different keymaps for different buffers. Also, the keymaps associated
935 ;; with viper-vi/insert-state-modifier-minor-mode can be different.
936 (make-variable-buffer-local 'minor-mode-map-alist)
938 ;; Viper changes the default mode-line-buffer-identification
939 (setq-default mode-line-buffer-identification '(" %b"))
941 ;; setup emacs-supported vi-style feel
942 (setq next-line-add-newlines nil
943 require-final-newline t)
945 (make-variable-buffer-local 'require-final-newline)
947 ;; don't bark when mark is inactive
948 (if viper-emacs-p
949 (setq mark-even-if-inactive t))
951 (setq scroll-step 1)
953 ;; Variable displaying the current Viper state in the mode line.
954 (viper-deflocalvar viper-mode-string viper-emacs-state-id)
955 (or (memq 'viper-mode-string global-mode-string)
956 (setq global-mode-string
957 (append '("" viper-mode-string) (cdr global-mode-string))))
959 (defadvice read-key-sequence (around viper-read-keyseq-ad activate)
960 "Harness to work for Viper. This advice is harmless---don't worry!"
961 (let (inhibit-quit event keyseq)
962 (setq keyseq ad-do-it)
963 (setq event (if viper-xemacs-p
964 (elt keyseq 0) ; XEmacs returns vector of events
965 (elt (listify-key-sequence keyseq) 0)))
966 (if (viper-ESC-event-p event)
967 (let (unread-command-events)
968 (viper-set-unread-command-events keyseq)
969 (if (viper-fast-keysequence-p)
970 (let ((viper-vi-global-user-minor-mode nil)
971 (viper-vi-local-user-minor-mode nil)
972 (viper-replace-minor-mode nil) ; actually unnecessary
973 (viper-insert-global-user-minor-mode nil)
974 (viper-insert-local-user-minor-mode nil))
975 (setq keyseq ad-do-it))
976 (setq keyseq ad-do-it))))
977 keyseq))
979 (defadvice describe-key (before viper-read-keyseq-ad protect activate)
980 "Force to read key via `read-key-sequence'."
981 (interactive (list (viper-events-to-keys
982 (read-key-sequence "Describe key: ")))))
984 (defadvice describe-key-briefly
985 (before viper-read-keyseq-ad protect activate)
986 "Force to read key via `read-key-sequence'."
987 (interactive (list (viper-events-to-keys
988 (read-key-sequence "Describe key briefly: ")))))
991 (defadvice find-file (before viper-add-suffix-advice activate)
992 "Use `read-file-name' for reading arguments."
993 (interactive (cons (read-file-name "Find file: " nil default-directory)
994 ;; XEmacs: if Mule & prefix arg, ask for coding system
995 (cond ((and viper-xemacs-p (featurep 'mule))
996 (list
997 (and current-prefix-arg
998 (read-coding-system "Coding-system: "))))
999 ;; Emacs: do wildcards
1000 ((and viper-emacs-p (boundp 'find-file-wildcards))
1001 (list find-file-wildcards))))
1004 (defadvice find-file-other-window (before viper-add-suffix-advice activate)
1005 "Use `read-file-name' for reading arguments."
1006 (interactive (cons (read-file-name "Find file in other window: "
1007 nil default-directory)
1008 ;; XEmacs: if Mule & prefix arg, ask for coding system
1009 (cond ((and viper-xemacs-p (featurep 'mule))
1010 (list
1011 (and current-prefix-arg
1012 (read-coding-system "Coding-system: "))))
1013 ;; Emacs: do wildcards
1014 ((and viper-emacs-p (boundp 'find-file-wildcards))
1015 (list find-file-wildcards))))
1019 (defadvice find-file-other-frame (before viper-add-suffix-advice activate)
1020 "Use `read-file-name' for reading arguments."
1021 (interactive (cons (read-file-name "Find file in other frame: "
1022 nil default-directory)
1023 ;; XEmacs: if Mule & prefix arg, ask for coding system
1024 (cond ((and viper-xemacs-p (featurep 'mule))
1025 (list
1026 (and current-prefix-arg
1027 (read-coding-system "Coding-system: "))))
1028 ;; Emacs: do wildcards
1029 ((and viper-emacs-p (boundp 'find-file-wildcards))
1030 (list find-file-wildcards))))
1034 (defadvice read-file-name (around viper-suffix-advice activate)
1035 "Tell `exit-minibuffer' to run `viper-file-add-suffix' as a hook."
1036 (let ((viper-minibuffer-exit-hook
1037 (append viper-minibuffer-exit-hook
1038 '(viper-minibuffer-trim-tail viper-file-add-suffix))))
1039 ad-do-it))
1041 (defadvice start-kbd-macro (after viper-kbd-advice activate)
1042 "Remove Viper's intercepting bindings for C-x ).
1043 This may be needed if the previous `:map' command terminated abnormally."
1044 (define-key viper-vi-intercept-map "\C-x)" nil)
1045 (define-key viper-insert-intercept-map "\C-x)" nil)
1046 (define-key viper-emacs-intercept-map "\C-x)" nil))
1048 ;; catch frame switching event
1049 (if (viper-window-display-p)
1050 (if viper-xemacs-p
1051 (add-hook 'mouse-leave-frame-hook
1052 'viper-remember-current-frame)
1053 (defadvice handle-switch-frame (before viper-frame-advice activate)
1054 "Remember the selected frame before the switch-frame event."
1055 (viper-remember-current-frame (selected-frame)))) )
1057 ) ; end viper-non-hook-settings
1060 ;; Ask only if this-command/last-command are nil, i.e., when loading
1061 (cond ((and (eq viper-mode 'ask) (null this-command) (null last-command))
1062 (save-window-excursion
1063 (with-output-to-temp-buffer " *viper-info*"
1064 (princ "
1065 You have loaded Viper, and are about to Viperize your emacs!
1067 Viper is a Package for Emacs Rebels and a venomous VI PERil,
1069 It's time to decide: to Viperize or not to Viperize...
1071 If you wish to Viperize AND make this your way of life, please put
1073 (setq viper-mode t)
1074 (require 'viper)
1076 in your .emacs file (preferably, close to the top).
1077 These two lines must come in the order given.
1079 ** Viper users:
1080 **** The startup file name has been changed from .vip to .viper
1081 **** All vip-* style names have been converted to viper-* style."))
1082 (if (y-or-n-p "Viperize? ")
1083 (setq viper-mode t)
1084 (setq viper-mode nil))
1085 (message "")
1086 (kill-buffer " *viper-info*")))
1088 ;; If viper-mode is t, then just continue. Viper will kick in.
1089 ((eq viper-mode t))
1090 ;; Otherwise, it was asking Viper was not loaded through .emacs
1091 ;; In this case, it was either through M-x viper-mode or via something
1092 ;; else, like the custom widget. If Viper was loaded through
1093 ;; M-x viper-mode, then viper will kick in anyway.
1094 (t (setq viper-mode nil)))
1096 (defun viper-load-custom-file ()
1097 (if (and (file-exists-p viper-custom-file-name)
1098 (not noninteractive))
1099 (load viper-custom-file-name)))
1104 ;; Get viper standard value of SYMBOL. If symbol is customized, get its
1105 ;; standard value. Otherwise, get the value saved in the alist STORAGE. If
1106 ;; STORAGE is nil, use viper-saved-user-settings.
1107 (defun viper-standard-value (symbol &optional storage)
1108 (or (eval (car (get symbol 'customized-value)))
1109 (eval (car (get symbol 'saved-value)))
1110 (nth 1 (assoc symbol (or storage viper-saved-user-settings)))))
1114 ;; save non-viper vars that Viper might change
1115 (if (null viper-saved-non-viper-variables)
1116 (setq viper-saved-non-viper-variables
1117 (list
1118 (cons 'next-line-add-newlines (list next-line-add-newlines))
1119 (cons 'require-final-newline (list require-final-newline))
1120 (cons 'scroll-step (list scroll-step))
1121 (cons 'mode-line-buffer-identification
1122 (list (default-value 'mode-line-buffer-identification)))
1123 (cons 'global-mode-string (list global-mode-string))
1124 (if viper-emacs-p
1125 (cons 'mark-even-if-inactive (list mark-even-if-inactive)))
1129 ;; Set some useful macros, advices
1130 ;; These must be BEFORE ~/.viper is loaded,
1131 ;; so the user can unrecord them in ~/.viper.
1132 (if viper-mode
1133 (progn
1134 ;; set advices and some variables that give emacs Vi look.
1135 (viper-non-hook-settings)
1137 ;; repeat the 2nd previous command without rotating the command history
1138 (viper-record-kbd-macro
1139 (vector viper-repeat-from-history-key '\1) 'vi-state
1140 [(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 ;; repeat the 3d previous command without rotating the command history
1142 (viper-record-kbd-macro
1143 (vector viper-repeat-from-history-key '\2) 'vi-state
1144 [(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)
1146 ;; set macros for toggling case sensitivity and regexp search
1147 (viper-set-searchstyle-toggling-macros nil)
1148 ;; Make %%% toggle parsing comments for matching parentheses
1149 (viper-set-parsing-style-toggling-macro nil)
1151 ;; ~/.viper is loaded if exists
1152 (viper-load-custom-file)
1154 ;; should be after loading custom file to avoid the pesky msg that
1155 ;; mouse-search/insert keys are already bound
1156 (viper-bind-mouse-search-key)
1157 (viper-bind-mouse-insert-key)
1162 ;; Applying Viper customization -- runs after (load .viper)
1164 ;; Save user settings or Viper defaults for vars controled by
1165 ;; viper-expert-level
1166 (if (null viper-saved-user-settings)
1167 (setq viper-saved-user-settings
1168 (list (cons 'viper-want-ctl-h-help (list viper-want-ctl-h-help))
1169 (cons 'viper-always (list viper-always))
1170 (cons 'viper-no-multiple-ESC (list viper-no-multiple-ESC))
1171 (cons 'viper-ex-style-motion (list viper-ex-style-motion))
1172 (cons 'viper-ex-style-editing
1173 (list viper-ex-style-editing))
1174 (cons 'viper-want-emacs-keys-in-vi
1175 (list viper-want-emacs-keys-in-vi))
1176 (cons 'viper-electric-mode (list viper-electric-mode))
1177 (cons 'viper-want-emacs-keys-in-insert
1178 (list viper-want-emacs-keys-in-insert))
1179 (cons 'viper-re-search (list viper-re-search)))))
1182 (if viper-mode
1183 (progn
1184 (viper-set-minibuffer-style)
1185 (if viper-buffer-search-char
1186 (viper-buffer-search-enable))
1187 (viper-update-syntax-classes 'set-default)
1191 ;;; Familiarize Viper with some minor modes that have their own keymaps
1192 (if viper-mode
1193 (progn
1194 (viper-harness-minor-mode "compile")
1195 (viper-harness-minor-mode "outline")
1196 (viper-harness-minor-mode "allout")
1197 (viper-harness-minor-mode "xref")
1198 (viper-harness-minor-mode "lmenu")
1199 (viper-harness-minor-mode "vc")
1200 (viper-harness-minor-mode "ltx-math") ; LaTeX-math-mode in AUC-TeX, which
1201 (viper-harness-minor-mode "latex") ; sits in one of these two files
1202 (viper-harness-minor-mode "cyrillic")
1203 (viper-harness-minor-mode "russian")
1204 (viper-harness-minor-mode "view-less")
1205 (viper-harness-minor-mode "view")
1206 (viper-harness-minor-mode "reftex")
1207 (viper-harness-minor-mode "flyspell")
1211 ;; Intercept maps could go in viper-keym.el
1212 ;; We keep them here in case someone redefines them in ~/.viper
1214 (define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1215 (define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1217 ;; This is taken care of by viper-insert-global-user-map.
1218 ;;(define-key viper-replace-map viper-ESC-key 'viper-intercept-ESC-key)
1221 ;; The default viper-toggle-key is \C-z; for the novice, it suspends or
1222 ;; iconifies Emacs
1223 (define-key viper-vi-intercept-map viper-toggle-key 'viper-toggle-key-action)
1224 (define-key
1225 viper-emacs-intercept-map viper-toggle-key 'viper-change-state-to-vi)
1227 ;;; Escape from Emacs and Insert modes to Vi for one command
1228 (define-key
1229 viper-emacs-intercept-map "\C-c\\" 'viper-escape-to-vi)
1230 (define-key
1231 viper-insert-intercept-map "\C-c\\" 'viper-escape-to-vi)
1233 (if viper-mode
1234 (setq-default viper-emacs-intercept-minor-mode t
1235 viper-emacs-local-user-minor-mode t
1236 viper-emacs-global-user-minor-mode t
1237 viper-emacs-kbd-minor-mode t
1238 viper-emacs-state-modifier-minor-mode t))
1239 (if (and viper-mode (eq viper-current-state 'emacs-state))
1240 (setq viper-emacs-intercept-minor-mode t
1241 viper-emacs-local-user-minor-mode t
1242 viper-emacs-global-user-minor-mode t
1243 viper-emacs-kbd-minor-mode t
1244 viper-emacs-state-modifier-minor-mode t))
1247 (if (and viper-mode
1248 (or viper-always
1249 (and (< viper-expert-level 5) (> viper-expert-level 0))))
1250 (viper-set-hooks))
1252 ;; Let all minor modes take effect after loading.
1253 ;; This may not be enough, so we also set default minor-mode-alist.
1254 ;; Without setting the default, new buffers that come up in emacs mode have
1255 ;; minor-mode-map-alist = nil, unless we call viper-change-state-*
1256 (if (and viper-mode (eq viper-current-state 'emacs-state))
1257 (progn
1258 (viper-change-state-to-emacs)
1259 (setq-default minor-mode-map-alist minor-mode-map-alist)
1262 (if (and viper-mode (memq major-mode viper-vi-state-mode-list))
1263 (viper-mode))
1265 (if viper-mode
1266 (setq initial-major-mode
1267 `(lambda ()
1268 (funcall (quote ,initial-major-mode))
1269 (set-viper-state-in-major-mode))
1274 (run-hooks 'viper-load-hook) ; the last chance to change something
1276 (provide 'viper)
1279 ;;; Local Variables:
1280 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1281 ;;; End:
1283 ;;; viper.el ends here