* viper-ex.el: Patch by Samuel Padgett. Copyright papers received.
[emacs.git] / lisp / emulation / viper.el
blob27bcf021e803e88c75ca474341e061823bbf43ea
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.
6 ;; Copyright (C) 1994, 95, 96, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc.
8 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
9 ;; Keywords: emulations
11 (defconst viper-version "3.11.2 of January 4, 2002"
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)
357 (defcustom viper-mode (cond (noninteractive nil)
358 (t 'ask))
359 "To Viperize or not to Viperize.
360 If t, viperize emacs. If nil -- don't. If `ask', ask the user.
361 This variable is used primatily when Viper is being loaded.
363 Must be set in `~/.emacs' before Viper is loaded.
364 DO NOT set this variable interactively, unless you are using the customization
365 widget."
366 :type '(choice (const nil) (const t) (const ask))
367 :tag "Set Viper Mode on Loading"
368 :group 'viper-misc)
370 (defcustom viper-vi-state-mode-list
371 '(fundamental-mode
372 makefile-mode
373 help-mode
375 awk-mode
376 m4-mode
377 xrdb-mode
378 winmgr-mode
379 autoconf-mode
380 cvs-edit-mode
382 html-mode html-helper-mode
383 emacs-lisp-mode lisp-mode lisp-interaction-mode
385 jde-mode java-mode
386 cc-mode c-mode c++-mode objc-mode
387 fortran-mode f90-mode
388 basic-mode
389 bat-mode
390 asm-mode
391 prolog-mode
392 flora-mode
393 sql-mode
395 text-mode indented-text-mode
396 tex-mode latex-mode bibtex-mode
397 ps-mode
399 completion-list-mode
400 diff-mode
401 idl-mode
403 perl-mode
404 cperl-mode
405 javascript-mode
406 tcl-mode
407 python-mode
409 sh-mode ksh-mode csh-mode
411 gnus-article-mode
412 mh-show-mode
414 "Major modes that require Vi command state."
415 :type '(repeat symbol)
416 :group 'viper-misc)
418 (defcustom viper-emacs-state-mode-list
419 '(custom-mode
421 dired-mode
422 efs-mode
423 tar-mode
425 mh-folder-mode
426 mail-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 inferior-emacs-lisp-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 ;; We change standard bindings in some major mode, making them slightly
466 ;; different than in "normal" vi/insert/emacs states
467 (defcustom viper-major-mode-modifier-list
468 '((help-mode emacs-state viper-slash-and-colon-map)
469 (comint-mode insert-state viper-comint-mode-modifier-map)
470 (comint-mode vi-state viper-comint-mode-modifier-map)
471 (shell-mode insert-state viper-comint-mode-modifier-map)
472 (inferior-emacs-lisp-mode insert-state viper-comint-mode-modifier-map)
473 (shell-mode vi-state viper-comint-mode-modifier-map)
474 (ange-ftp-shell-mode insert-state viper-comint-mode-modifier-map)
475 (ange-ftp-shell-mode vi-state viper-comint-mode-modifier-map)
476 (internal-ange-ftp-mode insert-state viper-comint-mode-modifier-map)
477 (internal-ange-ftp-mode vi-state viper-comint-mode-modifier-map)
478 (dired-mode emacs-state viper-dired-modifier-map)
479 (tar-mode emacs-state viper-slash-and-colon-map)
480 (mh-folder-mode emacs-state viper-slash-and-colon-map)
481 (gnus-group-mode emacs-state viper-slash-and-colon-map)
482 (gnus-summary-mode emacs-state viper-slash-and-colon-map)
483 (Info-mode emacs-state viper-slash-and-colon-map)
484 (Buffer-menu-mode emacs-state viper-slash-and-colon-map)
486 "List specifying how to modify the various major modes to enable some Viperisms.
487 The list has the structure: ((mode viper-state keymap) (mode viper-state
488 keymap) ...). If `mode' is on the list, the `kemap' will be made active (on
489 the minor-mode-map-alist) in the specified viper state.
490 If you change this list, have to restart emacs for the change to take effect.
491 However, if you did the change through the customization widget, then emacs
492 needs to be restarted only if you deleted a triple mode-state-keymap from the
493 list. No need to restart emacs in case of insertion or modification of an
494 existing triple."
495 :type '(repeat
496 (list symbol
497 (choice (const emacs-state)
498 (const vi-state)
499 (const insert-state))
500 symbol))
501 :set 'viper-apply-major-mode-modifiers
502 :group 'viper-misc)
508 ;;;###autoload
509 (defun toggle-viper-mode ()
510 "Toggle Viper on/off.
511 If Viper is enabled, turn it off. Otherwise, turn it on."
512 (interactive)
513 (if (eq viper-mode t)
514 (viper-go-away)
515 (setq viper-mode nil)
516 (viper-mode)))
518 ;;;###autoload
519 (defun viper-mode ()
520 "Turn on Viper emulation of Vi."
521 (interactive)
522 (if (not noninteractive)
523 (progn
524 ;; if the user requested viper-mode explicitly
525 (if viper-mode
527 (setq viper-mode t)
528 (load-library "viper"))
530 (if viper-first-time ; Important check. Prevents mix-up of startup
531 (progn ; and expert-level msgs when viper-mode recurses
532 (setq viper-first-time nil)
533 (setq viper-vi-state-cursor-color
534 (viper-get-cursor-color))
535 (if (not viper-inhibit-startup-message)
536 (save-window-excursion
537 (setq viper-inhibit-startup-message t)
538 (delete-other-windows)
539 (switch-to-buffer "Viper Startup Message")
540 (erase-buffer)
541 (insert
542 (substitute-command-keys
543 "Viper Is a Package for Emacs Rebels,
544 a VI Plan for Emacs Rescue, and a venomous VI PERil.
546 Incidentally, Viper emulates Vi under GNU Emacs 20 and XEmacs 20.
547 It supports all of what is good in Vi and Ex, while extending
548 and improving upon much of it.
550 1. Viper supports Vi at several levels. Level 1 is the closest to Vi,
551 level 5 provides the most flexibility to depart from many Vi conventions.
553 You will be asked to specify your user level in a following screen.
555 If you select user level 1 then the keys ^X, ^C, ^Z, and ^G will behave
556 as in VI, to smooth transition to Viper for the beginners. However, to
557 use Emacs productively, you are advised to reach user level 3 or higher.
559 At user level 2 or higher, ^X and ^C have Emacs, not Vi, bindings;
560 ^Z toggles Vi/Emacs states; ^G is Emacs' keyboard-quit (like ^C in Vi).
562 2. Vi exit functions (e.g., :wq, ZZ) work on INDIVIDUAL files -- they
563 do not cause Emacs to quit, except at user level 1 (for a novice).
564 3. ^X^C EXITS EMACS.
565 4. Viper supports multiple undo: `u' will undo. Typing `.' will repeat
566 undo. Another `u' changes direction.
568 6. Emacs Meta key is `C-\\' (in all modes) or `\\ ESC' (in Vi command mode).
569 On a window system, the best way is to use the Meta-key on your keyboard.
570 7. Try \\[keyboard-quit] and \\[abort-recursive-edit] repeatedly,if
571 something funny happens. This would abort the current editing command.
573 For more information on Viper:
575 a. Type `:help' in Vi command mode
576 b. Print Viper manual, found in ./etc/viper.dvi
577 c. Print the Quick Reference, found in ./etc/viperCard.dvi
579 To submit a bug report or to contact the author, type :submitReport in Vi
580 command mode. To shoo Viper away and return to pure Emacs (horror!), type:
582 M-x viper-go-away
584 This startup message appears whenever you load Viper, unless you type `y' now."
586 (goto-char (point-min))
587 (if (y-or-n-p "Inhibit Viper startup message? ")
588 (viper-save-setting
589 'viper-inhibit-startup-message
590 "Viper startup message inhibited"
591 viper-custom-file-name t))
592 ;;(kill-buffer (current-buffer))
593 (message
594 "The last message is in buffer `Viper Startup Message'")
595 (sit-for 4)
597 (viper-set-expert-level 'dont-change-unless)))
599 (if viper-xemacs-p
600 (make-variable-buffer-local 'bar-cursor))
601 (if (eq major-mode 'viper-mode)
602 (setq major-mode 'fundamental-mode))
604 (or (memq major-mode viper-emacs-state-mode-list) ; don't switch to Vi
605 (memq major-mode viper-insert-state-mode-list) ; don't switch
606 (viper-change-state-to-vi)))))
609 ;; Apply a little heuristic to invoke vi state on major-modes
610 ;; that are not listed in viper-vi-state-mode-list
611 (defun this-major-mode-requires-vi-state (mode)
612 (cond ((memq mode viper-vi-state-mode-list) t)
613 ((memq mode viper-emacs-state-mode-list) nil)
614 ((memq mode viper-insert-state-mode-list) nil)
615 (t (and (eq (key-binding "a") 'self-insert-command)
616 (eq (key-binding " ") 'self-insert-command)))))
619 ;; This hook designed to enable Vi-style editing in comint-based modes."
620 (defun viper-comint-mode-hook ()
621 (setq require-final-newline nil
622 viper-ex-style-editing nil
623 viper-ex-style-motion nil)
624 (viper-change-state-to-insert))
627 ;; remove viper hooks from SYMBOL
628 (defun viper-remove-hooks (symbol)
629 (cond ((not (boundp symbol)) nil)
630 ((not (listp (eval symbol))) nil)
631 ((string-match "-hook" (symbol-name symbol))
632 (remove-hook symbol 'viper-mode)
633 (remove-hook symbol 'viper-change-state-to-emacs)
634 (remove-hook symbol 'viper-change-state-to-insert)
635 (remove-hook symbol 'viper-change-state-to-vi)
638 ;; Remove local value in all existing buffers
639 ;; This doesn't delocalize vars (which would have been desirable)
640 (defun viper-delocalize-var (symbol)
641 (mapcar (lambda (buf) (save-excursion
642 (set-buffer buf)
643 (kill-local-variable symbol)))
644 (buffer-list)))
647 (defun viper-go-away ()
648 "De-Viperize Emacs.
649 This function tries to do as good a job as possible. However, it may undo some
650 user customization, unrelated to Viper. For instance, if the user advised
651 `read-file-name', `describe-key', and some others, then this advice will be
652 undone.
653 It also doesn't undo some Viper settings. For instance, `minor-mode-map-alist'
654 remains buffer-local."
655 (interactive)
657 ;; restore non-viper vars
658 (setq-default
659 next-line-add-newlines
660 (viper-standard-value
661 'next-line-add-newlines viper-saved-non-viper-variables)
662 require-final-newline
663 (viper-standard-value
664 'require-final-newline viper-saved-non-viper-variables)
665 scroll-step
666 (viper-standard-value 'scroll-step viper-saved-non-viper-variables)
667 mode-line-buffer-identification
668 (viper-standard-value
669 'mode-line-buffer-identification viper-saved-non-viper-variables)
670 global-mode-string
671 (delq 'viper-mode-string global-mode-string))
673 (if viper-emacs-p
674 (setq-default
675 mark-even-if-inactive
676 (viper-standard-value
677 'mark-even-if-inactive viper-saved-non-viper-variables)))
679 ;; Ideally, we would like to be able to de-localize local variables
680 (viper-delocalize-var 'minor-mode-map-alist)
681 (viper-delocalize-var 'require-final-newline)
682 (if viper-xemacs-p (viper-delocalize-var 'bar-cursor))
685 ;; deactivate all advices done by Viper.
686 (ad-deactivate-regexp "viper-")
688 (setq viper-mode nil)
690 (viper-delocalize-var 'viper-vi-minibuffer-minor-mode)
691 (viper-delocalize-var 'viper-insert-minibuffer-minor-mode)
692 (viper-delocalize-var 'viper-vi-intercept-minor-mode)
693 (viper-delocalize-var 'viper-insert-intercept-minor-mode)
695 (viper-delocalize-var 'viper-vi-local-user-minor-mode)
696 (viper-delocalize-var 'viper-vi-kbd-minor-mode)
697 (viper-delocalize-var 'viper-vi-global-user-minor-mode)
698 (viper-delocalize-var 'viper-vi-state-modifier-minor-mode)
699 (viper-delocalize-var 'viper-vi-diehard-minor-mode)
700 (viper-delocalize-var 'viper-vi-basic-minor-mode)
702 (viper-delocalize-var 'viper-replace-minor-mode)
704 (viper-delocalize-var 'viper-insert-local-user-minor-mode)
705 (viper-delocalize-var 'viper-insert-kbd-minor-mode)
706 (viper-delocalize-var 'viper-insert-global-user-minor-mode)
707 (viper-delocalize-var 'viper-insert-state-modifier-minor-mode)
708 (viper-delocalize-var 'viper-insert-diehard-minor-mode)
709 (viper-delocalize-var 'viper-insert-basic-minor-mode)
711 (viper-delocalize-var 'viper-emacs-intercept-minor-mode)
712 (viper-delocalize-var 'viper-emacs-local-user-minor-mode)
713 (viper-delocalize-var 'viper-emacs-kbd-minor-mode)
714 (viper-delocalize-var 'viper-emacs-global-user-minor-mode)
715 (viper-delocalize-var 'viper-emacs-state-modifier-minor-mode)
717 (viper-delocalize-var 'viper-current-state)
718 (viper-delocalize-var 'viper-mode-string)
720 (setq-default viper-vi-minibuffer-minor-mode nil
721 viper-insert-minibuffer-minor-mode nil
722 viper-vi-intercept-minor-mode nil
723 viper-insert-intercept-minor-mode nil
725 viper-vi-local-user-minor-mode nil
726 viper-vi-kbd-minor-mode nil
727 viper-vi-global-user-minor-mode nil
728 viper-vi-state-modifier-minor-mode nil
729 viper-vi-diehard-minor-mode nil
730 viper-vi-basic-minor-mode nil
732 viper-replace-minor-mode nil
734 viper-insert-local-user-minor-mode nil
735 viper-insert-kbd-minor-mode nil
736 viper-insert-global-user-minor-mode nil
737 viper-insert-state-modifier-minor-mode nil
738 viper-insert-diehard-minor-mode nil
739 viper-insert-basic-minor-mode nil
741 viper-emacs-intercept-minor-mode nil
742 viper-emacs-local-user-minor-mode nil
743 viper-emacs-kbd-minor-mode nil
744 viper-emacs-global-user-minor-mode nil
745 viper-emacs-state-modifier-minor-mode nil
747 viper-current-state 'emacs-state
748 viper-mode-string viper-emacs-state-id
751 ;; remove all hooks set by viper
752 (mapatoms 'viper-remove-hooks)
753 (remove-hook 'comint-mode-hook 'viper-comint-mode-hook)
754 (remove-hook 'minibuffer-setup-hook 'viper-minibuffer-setup-sentinel)
755 (remove-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
757 ;; unbind Viper mouse bindings
758 (viper-unbind-mouse-search-key)
759 (viper-unbind-mouse-insert-key)
760 ;; In emacs, we have to advice handle-switch-frame
761 ;; This advice is undone earlier, when all advices matchine "viper-" are
762 ;; deactivated.
763 (if viper-xemacs-p
764 (remove-hook 'mouse-leave-frame-hook 'viper-remember-current-frame))
765 ) ; end viper-go-away
768 ;; list of buffers that just changed their major mode
769 ;; used in a hack that triggers vi command mode whenever needed
770 (defvar viper-new-major-mode-buffer-list nil)
772 ;; set appropriate Viper state in buffers that changed major mode
773 (defun set-viper-state-in-major-mode ()
774 (mapcar
775 (lambda (buf)
776 (if (viper-buffer-live-p buf)
777 (with-current-buffer buf
778 (cond ((and (this-major-mode-requires-vi-state major-mode)
779 (eq viper-current-state 'emacs-state))
780 (viper-mode))
781 ((memq major-mode viper-emacs-state-mode-list)
782 ;; not checking (eq viper-current-state 'emacs-state)
783 ;; because viper-current-state could have gotten it by
784 ;; default. We need viper-change-state-to-emacs here to have
785 ;; the keymaps take effect.
786 (viper-change-state-to-emacs))
787 ((and (memq major-mode viper-insert-state-mode-list)
788 (not (eq viper-current-state 'insert-state)))
789 (viper-change-state-to-insert))
790 )) ; with-current-buffer
791 )) ; function
792 viper-new-major-mode-buffer-list)
793 ;; clear the list of bufs that changed major mode
794 (setq viper-new-major-mode-buffer-list nil)
795 ;; change the global value of hook
796 (remove-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode))
798 ;; sets up post-command-hook to turn viper-mode, if the current mode is
799 ;; fundamental
800 (defun viper-major-mode-change-sentinel ()
801 (save-match-data
802 (or (string-match "\*Minibuf-" (buffer-name))
803 (setq viper-new-major-mode-buffer-list
804 (cons (current-buffer) viper-new-major-mode-buffer-list))))
805 ;; change the global value of hook
806 (add-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode t))
810 ;; This sets major mode hooks to make them come up in vi-state.
811 (defun viper-set-hooks ()
812 ;; It is of course a misnomer to call viper-mode a `major mode'.
813 ;; However, this has the effect that if the user didn't specify the
814 ;; default mode, new buffers that fall back on the default will come up
815 ;; in Fundamental Mode and Vi state.
816 ;; When viper-mode is executed in such a case, it will set the major mode
817 ;; back to fundamental-mode.
818 (if (eq default-major-mode 'fundamental-mode)
819 (setq default-major-mode 'viper-mode))
821 (add-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
822 (add-hook 'find-file-hooks 'set-viper-state-in-major-mode)
824 ;; keep this because many modes we don't know about use this hook
825 (defvar text-mode-hook)
826 (add-hook 'text-mode-hook 'viper-mode)
828 (defvar emerge-startup-hook)
829 (add-hook 'emerge-startup-hook 'viper-change-state-to-emacs)
831 ;; Zap bad bindings in flyspell-mouse-map, which prevent ESC from working
832 ;; over misspelled words (due to the overlay keymaps)
833 (defvar flyspell-mode-hook)
834 (add-hook 'flyspell-mode-hook
835 '(lambda ()
836 (define-key flyspell-mouse-map viper-ESC-key nil)))
837 ;; if viper is started from .emacs, it might be impossible to get certain
838 ;; info about the display and windows until emacs initialization is complete
839 ;; So do it via the window-setup-hook
840 (add-hook 'window-setup-hook
841 '(lambda ()
842 (setq viper-vi-state-cursor-color (viper-get-cursor-color))))
844 ;; Tell vc-diff to put *vc* in Vi mode
845 (if (featurep 'vc)
846 (defadvice vc-diff (after viper-vc-ad activate)
847 "Force Vi state in VC diff buffer."
848 (viper-change-state-to-vi))
849 (eval-after-load
850 "vc"
851 '(defadvice vc-diff (after viper-vc-ad activate)
852 "Force Vi state in VC diff buffer."
853 (viper-change-state-to-vi))))
855 (eval-after-load
856 "emerge"
857 '(defadvice emerge-quit (after viper-emerge-advice activate)
858 "Run `viper-change-state-to-vi' after quitting emerge."
859 (viper-change-state-to-vi)))
860 ;; In case Emerge was loaded before Viper.
861 (defadvice emerge-quit (after viper-emerge-advice activate)
862 "Run `viper-change-state-to-vi' after quitting emerge."
863 (viper-change-state-to-vi))
865 ;; passwd.el sets up its own buffer, which turns up in Vi mode,
866 ;; thus overriding the local map. We don't need Vi mode here.
867 (eval-after-load
868 "passwd"
869 '(defadvice read-passwd-1 (before viper-passwd-ad activate)
870 "Switch to emacs state while reading password."
871 (viper-change-state-to-emacs)))
873 ;; Emacs shell, ange-ftp, and comint-based modes
874 (add-hook 'comint-mode-hook 'viper-comint-mode-hook) ; comint
876 (viper-set-emacs-state-searchstyle-macros nil 'dired-mode) ; dired
877 (viper-set-emacs-state-searchstyle-macros nil 'tar-mode) ; tar
878 (viper-set-emacs-state-searchstyle-macros nil 'mh-folder-mode) ; mhe
879 (viper-set-emacs-state-searchstyle-macros nil 'gnus-group-mode) ; gnus
880 (viper-set-emacs-state-searchstyle-macros nil 'gnus-summary-mode)
881 (viper-set-emacs-state-searchstyle-macros nil 'Info-mode) ; info
882 (viper-set-emacs-state-searchstyle-macros nil 'Buffer-menu-mode) ;buffer-menu
884 ;; Modify major modes according to viper-major-mode-modifier-list
885 (viper-apply-major-mode-modifiers)
887 ;; For RMAIL users.
888 ;; Put buf in Emacs state after edit.
889 (eval-after-load
890 "rmailedit"
891 '(defadvice rmail-cease-edit (after viper-rmail-advice activate)
892 "Switch to emacs state when done editing message."
893 (viper-change-state-to-emacs)))
894 ;; In case RMAIL was loaded before Viper.
895 (defadvice rmail-cease-edit (after viper-rmail-advice activate)
896 "Switch to emacs state when done editing message."
897 (viper-change-state-to-emacs))
899 ;; ISO accents
900 ;; Need to do it after loading iso-acc, or else this loading will wipe out
901 ;; the advice.
902 (eval-after-load
903 "iso-acc"
904 (defadvice iso-accents-mode (around viper-iso-accents-advice activate)
905 "Set viper-automatic-iso-accents to iso-accents-mode."
906 (let ((arg (ad-get-arg 0)))
907 ad-do-it
908 (setq viper-automatic-iso-accents
909 (if (eq viper-current-state 'vi-state)
910 (if arg
911 ;; if iso-accents-mode was called with positive arg, turn
912 ;; accents on
913 (> (prefix-numeric-value arg) 0)
914 ;; else: toggle viper-automatic-iso-accents
915 (not viper-automatic-iso-accents))
916 ;; other states: accept what iso-accents-mode has done
917 iso-accents-mode))
918 ;; turn off ISO accents in vi-state
919 (if (eq viper-current-state 'vi-state)
920 (viper-set-iso-accents-mode nil))
921 (if (memq viper-current-state '(vi-state insert-state replace-state))
922 (message "Viper ISO accents mode: %s"
923 (if viper-automatic-iso-accents "on" "off")))
926 ;; International input methods
927 (if viper-emacs-p
928 (eval-after-load "mule-cmds"
929 (progn
930 (defadvice inactivate-input-method (after viper-mule-advice activate)
931 "Set viper-special-input-method to disable intl. input methods."
932 (viper-inactivate-input-method-action))
933 (defadvice activate-input-method (after viper-mule-advice activate)
934 "Set viper-special-input-method to enable intl. input methods."
935 (viper-activate-input-method-action))
937 ;; XEmacs Although these hooks exist in Emacs, they don't seem to be always
938 ;; called on input-method activation/deactivation, so we the above advise
939 ;; functions instead.
940 (eval-after-load "mule-cmds"
941 (progn
942 (add-hook 'input-method-activate-hook
943 'viper-activate-input-method-action t)
944 (add-hook 'input-method-inactivate-hook
945 'viper-inactivate-input-method-action t)))
947 (eval-after-load "mule-cmds"
948 (defadvice toggle-input-method (around viper-mule-advice activate)
949 "Adjust input-method toggling in vi-state."
950 (if (and viper-special-input-method (eq viper-current-state 'vi-state))
951 (viper-inactivate-input-method)
952 ad-do-it)))
954 ) ; viper-set-hooks
957 ;; these are primarily advices and Vi-ish variable settings
958 (defun viper-non-hook-settings ()
960 ;; This var is not local in Emacs, so we make it local. It must be local
961 ;; because although the stack of minor modes can be the same for all buffers,
962 ;; the associated *keymaps* can be different. In Viper,
963 ;; viper-vi-local-user-map, viper-insert-local-user-map, and others can have
964 ;; different keymaps for different buffers. Also, the keymaps associated
965 ;; with viper-vi/insert-state-modifier-minor-mode can be different.
966 (make-variable-buffer-local 'minor-mode-map-alist)
968 ;; Viper changes the default mode-line-buffer-identification
969 (setq-default mode-line-buffer-identification '(" %b"))
971 ;; setup emacs-supported vi-style feel
972 (setq next-line-add-newlines nil
973 require-final-newline t)
975 (make-variable-buffer-local 'require-final-newline)
977 ;; don't bark when mark is inactive
978 (if viper-emacs-p
979 (setq mark-even-if-inactive t))
981 (setq scroll-step 1)
983 ;; Variable displaying the current Viper state in the mode line.
984 (viper-deflocalvar viper-mode-string viper-emacs-state-id)
985 (or (memq 'viper-mode-string global-mode-string)
986 (setq global-mode-string
987 (append '("" viper-mode-string) (cdr global-mode-string))))
989 (defadvice describe-key (before viper-read-keyseq-ad protect activate)
990 "Force to read key via `viper-read-key-sequence'."
991 (interactive (list (viper-read-key-sequence "Describe key: "))))
993 (defadvice describe-key-briefly
994 (before viper-read-keyseq-ad protect activate)
995 "Force to read key via `viper-read-key-sequence'."
996 (interactive (list (viper-read-key-sequence "Describe key briefly: "))))
999 (defadvice find-file (before viper-add-suffix-advice activate)
1000 "Use `read-file-name' for reading arguments."
1001 (interactive (cons (read-file-name "Find file: " nil default-directory)
1002 ;; XEmacs: if Mule & prefix arg, ask for coding system
1003 (cond ((and viper-xemacs-p (featurep 'mule))
1004 (list
1005 (and current-prefix-arg
1006 (read-coding-system "Coding-system: "))))
1007 ;; Emacs: do wildcards
1008 ((and viper-emacs-p (boundp 'find-file-wildcards))
1009 (list find-file-wildcards))))
1012 (defadvice find-file-other-window (before viper-add-suffix-advice activate)
1013 "Use `read-file-name' for reading arguments."
1014 (interactive (cons (read-file-name "Find file in other window: "
1015 nil default-directory)
1016 ;; XEmacs: if Mule & prefix arg, ask for coding system
1017 (cond ((and viper-xemacs-p (featurep 'mule))
1018 (list
1019 (and current-prefix-arg
1020 (read-coding-system "Coding-system: "))))
1021 ;; Emacs: do wildcards
1022 ((and viper-emacs-p (boundp 'find-file-wildcards))
1023 (list find-file-wildcards))))
1027 (defadvice find-file-other-frame (before viper-add-suffix-advice activate)
1028 "Use `read-file-name' for reading arguments."
1029 (interactive (cons (read-file-name "Find file in other frame: "
1030 nil default-directory)
1031 ;; XEmacs: if Mule & prefix arg, ask for coding system
1032 (cond ((and viper-xemacs-p (featurep 'mule))
1033 (list
1034 (and current-prefix-arg
1035 (read-coding-system "Coding-system: "))))
1036 ;; Emacs: do wildcards
1037 ((and viper-emacs-p (boundp 'find-file-wildcards))
1038 (list find-file-wildcards))))
1042 (defadvice read-file-name (around viper-suffix-advice activate)
1043 "Tell `exit-minibuffer' to run `viper-file-add-suffix' as a hook."
1044 (let ((viper-minibuffer-exit-hook
1045 (append viper-minibuffer-exit-hook
1046 '(viper-minibuffer-trim-tail viper-file-add-suffix))))
1047 ad-do-it))
1049 (defadvice start-kbd-macro (after viper-kbd-advice activate)
1050 "Remove Viper's intercepting bindings for C-x ).
1051 This may be needed if the previous `:map' command terminated abnormally."
1052 (define-key viper-vi-intercept-map "\C-x)" nil)
1053 (define-key viper-insert-intercept-map "\C-x)" nil)
1054 (define-key viper-emacs-intercept-map "\C-x)" nil))
1056 ;; catch frame switching event
1057 (if (viper-window-display-p)
1058 (if viper-xemacs-p
1059 (add-hook 'mouse-leave-frame-hook
1060 'viper-remember-current-frame)
1061 (defadvice handle-switch-frame (before viper-frame-advice activate)
1062 "Remember the selected frame before the switch-frame event."
1063 (viper-remember-current-frame (selected-frame)))) )
1065 ) ; end viper-non-hook-settings
1069 ;; Ask only if this-command/last-command are nil, i.e., when loading
1070 (cond ((and (eq viper-mode 'ask) (null this-command) (null last-command))
1071 (save-window-excursion
1072 (with-output-to-temp-buffer " *viper-info*"
1073 (princ "
1074 You have loaded Viper, and are about to Viperize your emacs!
1076 Viper is a Package for Emacs Rebels and a venomous VI PERil,
1078 It's time to decide: to Viperize or not to Viperize...
1080 If you wish to Viperize AND make this your way of life, please put
1082 (setq viper-mode t)
1083 (require 'viper)
1085 in your .emacs file (preferably, close to the top).
1086 These two lines must come in the order given.
1088 ** Viper users:
1089 **** The startup file name has been changed from .vip to .viper
1090 **** All vip-* style names have been converted to viper-* style."))
1091 (if (y-or-n-p "Viperize? ")
1092 (setq viper-mode t)
1093 (setq viper-mode nil))
1094 (message "")
1095 (kill-buffer " *viper-info*")))
1097 ;; If viper-mode is t, then just continue. Viper will kick in.
1098 ((eq viper-mode t))
1099 ;; Otherwise, it was asking Viper was not loaded through .emacs
1100 ;; In this case, it was either through M-x viper-mode or via something
1101 ;; else, like the custom widget. If Viper was loaded through
1102 ;; M-x viper-mode, then viper will kick in anyway.
1103 (t (setq viper-mode nil)))
1105 (defun viper-load-custom-file ()
1106 (if (and (file-exists-p viper-custom-file-name)
1107 (not noninteractive))
1108 (load viper-custom-file-name)))
1115 ;; save non-viper vars that Viper might change
1116 (if (null viper-saved-non-viper-variables)
1117 (setq viper-saved-non-viper-variables
1118 (list
1119 (cons 'next-line-add-newlines (list next-line-add-newlines))
1120 (cons 'require-final-newline (list require-final-newline))
1121 (cons 'scroll-step (list scroll-step))
1122 (cons 'mode-line-buffer-identification
1123 (list (default-value 'mode-line-buffer-identification)))
1124 (cons 'global-mode-string (list global-mode-string))
1125 (if viper-emacs-p
1126 (cons 'mark-even-if-inactive (list mark-even-if-inactive)))
1130 ;; Set some useful macros, advices
1131 ;; These must be BEFORE ~/.viper is loaded,
1132 ;; so the user can unrecord them in ~/.viper.
1133 (if viper-mode
1134 (progn
1135 ;; set advices and some variables that give emacs Vi look.
1136 (viper-non-hook-settings)
1138 ;; repeat the 2nd previous command without rotating the command history
1139 (viper-record-kbd-macro
1140 (vector viper-repeat-from-history-key '\1) 'vi-state
1141 [(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)
1142 ;; repeat the 3d previous command without rotating the command history
1143 (viper-record-kbd-macro
1144 (vector viper-repeat-from-history-key '\2) 'vi-state
1145 [(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)
1147 ;; set macros for toggling case sensitivity and regexp search
1148 (viper-set-searchstyle-toggling-macros nil)
1149 ;; Make %%% toggle parsing comments for matching parentheses
1150 (viper-set-parsing-style-toggling-macro nil)
1152 ;; ~/.viper is loaded if exists
1153 (viper-load-custom-file)
1155 ;; should be after loading custom file to avoid the pesky msg that
1156 ;; mouse-search/insert keys are already bound
1157 (viper-bind-mouse-search-key)
1158 (viper-bind-mouse-insert-key)
1163 ;; Applying Viper customization -- runs after (load .viper)
1165 ;; Save user settings or Viper defaults for vars controlled by
1166 ;; viper-expert-level
1167 (if (null viper-saved-user-settings)
1168 (setq viper-saved-user-settings
1169 (list (cons 'viper-want-ctl-h-help (list viper-want-ctl-h-help))
1170 (cons 'viper-always (list viper-always))
1171 (cons 'viper-no-multiple-ESC (list viper-no-multiple-ESC))
1172 (cons 'viper-ex-style-motion (list viper-ex-style-motion))
1173 (cons 'viper-ex-style-editing
1174 (list viper-ex-style-editing))
1175 (cons 'viper-want-emacs-keys-in-vi
1176 (list viper-want-emacs-keys-in-vi))
1177 (cons 'viper-electric-mode (list viper-electric-mode))
1178 (cons 'viper-want-emacs-keys-in-insert
1179 (list viper-want-emacs-keys-in-insert))
1180 (cons 'viper-re-search (list viper-re-search)))))
1183 (if viper-mode
1184 (progn
1185 (viper-set-minibuffer-style)
1186 (if viper-buffer-search-char
1187 (viper-buffer-search-enable))
1188 (viper-update-syntax-classes 'set-default)
1192 ;;; Familiarize Viper with some minor modes that have their own keymaps
1193 (if viper-mode
1194 (progn
1195 (viper-harness-minor-mode "compile")
1196 (viper-harness-minor-mode "outline")
1197 (viper-harness-minor-mode "allout")
1198 (viper-harness-minor-mode "xref")
1199 (viper-harness-minor-mode "lmenu")
1200 (viper-harness-minor-mode "vc")
1201 (viper-harness-minor-mode "ltx-math") ; LaTeX-math-mode in AUC-TeX, which
1202 (viper-harness-minor-mode "latex") ; sits in one of these two files
1203 (viper-harness-minor-mode "cyrillic")
1204 (viper-harness-minor-mode "russian")
1205 (viper-harness-minor-mode "view-less")
1206 (viper-harness-minor-mode "view")
1207 (viper-harness-minor-mode "reftex")
1208 (viper-harness-minor-mode "flyspell")
1212 ;; Intercept maps could go in viper-keym.el
1213 ;; We keep them here in case someone redefines them in ~/.viper
1215 (define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1216 (define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1218 ;; This is taken care of by viper-insert-global-user-map.
1219 ;;(define-key viper-replace-map viper-ESC-key 'viper-intercept-ESC-key)
1222 ;; The default viper-toggle-key is \C-z; for the novice, it suspends or
1223 ;; iconifies Emacs
1224 (define-key viper-vi-intercept-map viper-toggle-key 'viper-toggle-key-action)
1225 (define-key
1226 viper-emacs-intercept-map viper-toggle-key 'viper-change-state-to-vi)
1228 ;;; Escape from Emacs and Insert modes to Vi for one command
1229 (define-key
1230 viper-emacs-intercept-map "\C-c\\" 'viper-escape-to-vi)
1231 (define-key
1232 viper-insert-intercept-map "\C-c\\" 'viper-escape-to-vi)
1234 (if viper-mode
1235 (setq-default 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))
1240 (if (and viper-mode (eq viper-current-state 'emacs-state))
1241 (setq viper-emacs-intercept-minor-mode t
1242 viper-emacs-local-user-minor-mode t
1243 viper-emacs-global-user-minor-mode t
1244 viper-emacs-kbd-minor-mode t
1245 viper-emacs-state-modifier-minor-mode t))
1248 (if (and viper-mode
1249 (or viper-always
1250 (and (< viper-expert-level 5) (> viper-expert-level 0))))
1251 (viper-set-hooks))
1253 ;; Let all minor modes take effect after loading.
1254 ;; This may not be enough, so we also set default minor-mode-alist.
1255 ;; Without setting the default, new buffers that come up in emacs mode have
1256 ;; minor-mode-map-alist = nil, unless we call viper-change-state-*
1257 (if (and viper-mode (eq viper-current-state 'emacs-state))
1258 (progn
1259 (viper-change-state-to-emacs)
1260 (setq-default minor-mode-map-alist minor-mode-map-alist)
1263 (if (and viper-mode (this-major-mode-requires-vi-state major-mode))
1264 (viper-mode))
1266 (if viper-mode
1267 (setq initial-major-mode
1268 `(lambda ()
1269 (funcall (quote ,initial-major-mode))
1270 (set-viper-state-in-major-mode))
1275 (run-hooks 'viper-load-hook) ; the last chance to change something
1277 (provide 'viper)
1280 ;;; Local Variables:
1281 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1282 ;;; End:
1284 ;;; viper.el ends here