Remove unnecessary leading-star in docstrings.
[emacs.git] / lisp / emulation / viper.el
blob754eff3906d425c78e959f19ee2c685143c24b94
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, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
7 ;; 2003, 2004, 2005 Free Software Foundation, Inc.
9 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
10 ;; Keywords: emulations
12 (defconst viper-version "3.11.5 of November 25, 2005"
13 "The current version of Viper")
15 ;; This file is part of GNU Emacs.
17 ;; GNU Emacs is free software; you can redistribute it and/or modify
18 ;; it under the terms of the GNU General Public License as published by
19 ;; the Free Software Foundation; either version 2, or (at your option)
20 ;; any later version.
22 ;; GNU Emacs is distributed in the hope that it will be useful,
23 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
24 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 ;; GNU General Public License for more details.
27 ;; You should have received a copy of the GNU General Public License
28 ;; along with GNU Emacs; see the file COPYING. If not, write to the
29 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
30 ;; Boston, MA 02110-1301, USA.
32 ;;; Commentary:
34 ;; Viper is a full-featured Vi emulator for Emacs and XEmacs. It emulates and
35 ;; improves upon the standard features of Vi and, at the same time, allows
36 ;; full access to all Emacs facilities. Viper supports multiple undo,
37 ;; file name completion, command, file, and search history and it extends
38 ;; Vi in many other ways. Viper is highly customizable through the various
39 ;; hooks, user variables, and keymaps. It is implemented as a collection
40 ;; of minor modes and it is designed to provide full access to all Emacs
41 ;; major and minor modes.
43 ;;; History:
45 ;; Viper is a new name for a package formerly known as VIP-19,
46 ;; which was a successor of VIP version 3.5 by Masahiko Sato
47 ;; <ms@sail.stanford.edu> and VIP version 4.2 by Aamod Sane
48 ;; <sane@cs.uiuc.edu>. Some ideas from vip 4.4.2 by Aamod Sane
49 ;; were also shamelessly plagiarized.
51 ;; Viper maintains some degree of compatibility with these older
52 ;; packages. See the documentation for customization.
54 ;; The main difference between Viper and these older packages are:
56 ;; 1. Viper emulates Vi at several levels, from almost complete conformity
57 ;; to a rather loose Vi-compliance.
59 ;; 2. Viper provides full access to all major and minor modes of Emacs
60 ;; without the need to type extra keys.
61 ;; The older versions of VIP (and other Vi emulators) do not work with
62 ;; some major and minor modes.
64 ;; 3. Viper supports vi-style undo.
66 ;; 4. Viper fully emulates (and improves upon) vi's replacement mode.
68 ;; 5. Viper has a better interface to ex, including command, variable, and
69 ;; file name completion.
71 ;; 6. Viper uses native Emacs history and completion features; it doesn't
72 ;; rely on other packages (such as gmhist.el and completer.el) to provide
73 ;; these features.
75 ;; 7. Viper supports Vi-style editing in the minibuffer, by allowing the
76 ;; user to switch from Insert state to Vi state to Replace state, etc.
78 ;; 8. Viper keeps history of recently inserted pieces of text and recently
79 ;; executed Vi-style destructive commands, such as `i', `d', etc.
80 ;; These pieces of text can be inserted in later insertion commands;
81 ;; the previous destructive commands can be re-executed.
83 ;; 9. Viper has Vi-style keyboard macros, which enhances the similar
84 ;; facility in the original Vi.
85 ;; First, one can execute any Emacs command while defining a
86 ;; macro, not just the Vi commands. Second, macros are defined in a
87 ;; WYSYWYG mode, using an interface to Emacs' WYSIWYG style of defining
88 ;; macros. Third, in Viper, one can define macros that are specific to
89 ;; a given buffer, a given major mode, or macros defined for all buffers.
90 ;; The same macro name can have several different definitions:
91 ;; one global, several definitions for various major modes, and
92 ;; definitions for specific buffers.
93 ;; Buffer-specific definitions override mode-specific
94 ;; definitions, which, in turn, override global definitions.
97 ;;; Installation:
98 ;; -------------
100 ;; (require 'viper)
103 ;;; Acknowledgements:
104 ;; -----------------
105 ;; Bug reports and ideas contributed by many users have helped
106 ;; improve Viper and the various versions of VIP.
107 ;; See the on-line manual for a complete list of contributors.
110 ;;; Notes:
112 ;; 1. Major modes.
113 ;; In most cases, Viper handles major modes correctly, i.e., they come up
114 ;; in the right state (either vi-state or emacs-state). For instance, text
115 ;; files come up in vi-state, while, say, Dired appears in emacs-state by
116 ;; default.
117 ;; However, some modes do not appear in the right mode in the beginning,
118 ;; usually because they neglect to follow Emacs conventions (e.g., they don't
119 ;; use kill-all-local-variables when they start). Some major modes
120 ;; may fail to come up in emacs-state if they call hooks, such as
121 ;; text-hook, for no good reason.
123 ;; As an immediate solution, you can hit C-z to bring about the right mode.
124 ;; An interim solution is to add an appropriate hook to the mode like this:
126 ;; (add-hook 'your-favorite-mode 'viper-mode)
127 ;; or
128 ;; (add-hook 'your-favorite-mode 'viper-change-state-to-emacs)
130 ;; whichever applies. The right thing to do, however, is to complain to the
131 ;; author of the respective package. (Sometimes they also neglect to equip
132 ;; their modes with hooks, which is one more reason for complaining.)
134 ;; 2. Keymap handling
135 ;; Each Viper state (insert, vi, replace) is implemented as a collection of
136 ;; several minor modes, each with its own keymap.
138 ;; Viper's Vi state consists of seven minor modes:
140 ;; viper-vi-intercept-minor-mode
141 ;; viper-vi-local-user-minor-mode
142 ;; viper-vi-global-user-minor-mode
143 ;; viper-vi-kbd-minor-mode
144 ;; viper-vi-state-modifier-minor-mode
145 ;; viper-vi-diehard-minor-mode
146 ;; viper-vi-basic-minor-mode
148 ;; Bindings done to the keymap of the first mode overshadow those done to
149 ;; the second, which, in turn, overshadows those done to the third, etc.
151 ;; The last viper-vi-basic-minor-mode contains most of the usual Vi bindings
152 ;; in its edit mode. This mode provides access to all Emacs facilities.
153 ;; Novice users, however, may want to set their viper-expert-level to 1
154 ;; in their .viper file. This will enable viper-vi-diehard-minor-mode. This
155 ;; minor mode's bindings make Viper simulate the usual Vi very closely.
156 ;; For instance, C-c will not have its standard Emacs binding
157 ;; and so many of the goodies of Emacs are not available.
159 ;; A skilled user should set viper-expert-level to at least 3. This will
160 ;; enable `C-c' and many Emacs facilities will become available.
161 ;; In this case, viper-vi-diehard-minor-mode is inactive.
163 ;; Viper gurus should have at least
164 ;; (setq viper-expert-level 4)
165 ;; in their ~/.viper files. This will unsuppress all Emacs keys that are not
166 ;; essential for VI-style editing.
167 ;; Pick-and-choose users may want to put
168 ;; (setq viper-expert-level 5)
169 ;; in ~/.viper. Viper will then leave it up to the user to set the variables
170 ;; viper-want-* See viper-set-expert-level for details.
172 ;; The very first minor mode, viper-vi-intercept-minor-mode, is of no
173 ;; concern for the user. It is needed to bind Viper's vital keys, such as
174 ;; ESC and C-z.
176 ;; The second mode, viper-vi-local-user-minor-mode, usually has an
177 ;; empty keymap. However, the user can set bindings in this keymap, which
178 ;; will overshadow the corresponding bindings in the other two minor
179 ;; modes. This is useful, for example, for setting up ZZ in gnus,
180 ;; rmail, mh-e, etc., to send message instead of saving it in a file.
181 ;; Likewise, in Dired mode, you may want to bind ZN and ZP to commands
182 ;; that would visit the next or the previous file in the Dired buffer.
183 ;; Setting local keys is tricky, so don't do it directly. Instead, use
184 ;; viper-add-local-keys function (see its doc).
186 ;; The third minor mode, viper-vi-global-user-minor-mode, is also intended
187 ;; for the users but, unlike viper-vi-local-user-minor-mode, its key
188 ;; bindings are seen in all Viper buffers. This mode keys can be done
189 ;; with define-key command.
191 ;; The fourth minor mode, viper-vi-kbd-minor-mode, is used by keyboard
192 ;; macros. Users are NOT supposed to modify this keymap directly.
194 ;; The fifth mode, viper-vi-state-modifier-minor-mode, can be used to set
195 ;; key bindings that are visible in some major modes but not in others.
197 ;; Users are allowed to modify keymaps that belong to
198 ;; viper-vi-local-user-minor-mode, viper-vi-global-user-minor-mode,
199 ;; and viper-vi-state-modifier-minor-mode only.
201 ;; Viper's Insert state also has seven minor modes:
203 ;; viper-insert-intercept-minor-mode
204 ;; viper-insert-local-user-minor-mode
205 ;; viper-insert-global-user-minor-mode
206 ;; viper-insert-kbd-minor-mode
207 ;; viper-insert-state-modifier-minor-mode
208 ;; viper-insert-diehard-minor-mode
209 ;; viper-insert-basic-minor-mode
211 ;; As with VI's editing modes, the first mode,
212 ;; viper-insert-intercept-minor-mode is used to bind vital keys that are not
213 ;; to be changed by the user.
215 ;; The next mode, viper-insert-local-user-minor-mode, is used to customize
216 ;; bindings in the insert state of Viper. The third mode,
217 ;; viper-insert-global-user-minor-mode is like
218 ;; viper-insert-local-user-minor-mode, except that its bindings are seen in
219 ;; all Viper buffers. As with viper-vi-local-user-minor-mode, its bindings
220 ;; should be done via the function viper-add-local-keys. Bindings for
221 ;; viper-insert-global-user-minor-mode can be set with the define-key command.
223 ;; The next minor mode, viper-insert-kbd-minor-mode,
224 ;; is used for keyboard VI-style macros defined with :map!.
226 ;; The fifth minor mode, viper-insert-state-modifier-minor-mode, is like
227 ;; viper-vi-state-modifier-minor-mode, except that it is used in the Insert
228 ;; state; it can be used to modify keys in a mode-specific fashion.
230 ;; The minor mode viper-insert-diehard-minor-mode is in effect when
231 ;; the user wants a high degree of Vi compatibility (a bad idea, really!).
232 ;; The last minor mode, viper-insert-basic-minor-mode, is always in effect
233 ;; when Viper is in insert state. It binds a small number of keys needed for
234 ;; Viper's operation.
236 ;; Finally, Viper provides minor modes for overriding bindings set by Emacs
237 ;; modes when Viper is in Emacs state:
239 ;; viper-emacs-local-user-minor-mode
240 ;; viper-emacs-global-user-minor-mode
241 ;; viper-emacs-kbd-minor-mode
242 ;; viper-emacs-state-modifier-minor-mode
244 ;; These minor modes are in effect when Viper is in Emacs state. The keymap
245 ;; associated with viper-emacs-global-user-minor-mode,
246 ;; viper-emacs-global-user-map, overrides the global and local keymaps as
247 ;; well as the minor mode keymaps set by other modes. The keymap of
248 ;; viper-emacs-local-user-minor-mode, viper-emacs-local-user-map, overrides
249 ;; everything, but it is used on a per buffer basis.
250 ;; The keymap associated with viper-emacs-state-modifier-minor-mode
251 ;; overrides keys on a per-major-mode basis. The mode
252 ;; viper-emacs-kbd-minor-mode is used to define Vi-style macros in Emacs
253 ;; state.
255 ;; 3. There is also one minor mode that is used when Viper is in its
256 ;; replace-state (used for commands like cw, C, etc.). This mode is
257 ;; called
259 ;; viper-replace-minor-mode
261 ;; and its keymap is viper-replace-map. Replace minor mode is always
262 ;; used in conjunction with the minor modes for insert-state, and its
263 ;; keymap overshadows the keymaps for insert minor modes.
265 ;; 4. Defining buffer-local bindings in Vi and Insert modes.
266 ;; As mentioned before, sometimes, it is convenient to have
267 ;; buffer-specific of mode-specific key bindings in Vi and insert modes.
268 ;; Viper provides a special function, viper-add-local-keys, to do precisely
269 ;; this. For instance, is you need to add couple of mode-specific bindings
270 ;; to Insert mode, you can put
272 ;; (viper-add-local-keys 'insert-state '((key1 . func1) (key2 .func2)))
274 ;; somewhere in a hook of this major mode. If you put something like this
275 ;; in your own elisp function, this will define bindings specific to the
276 ;; buffer that was current at the time of the call to viper-add-local-keys.
277 ;; The only thing to make sure here is that the major mode of this buffer
278 ;; is written according to Emacs conventions, which includes a call to
279 ;; (kill-all-local-variables). See viper-add-local-keys for more details.
282 ;; TO DO (volunteers?):
284 ;; 1. Some of the code that is inherited from VIP-3.5 is rather
285 ;; convoluted. Instead of viper-command-argument, keymaps should bind the
286 ;; actual commands. E.g., "dw" should be bound to a generic command
287 ;; viper-delete that will delete things based on the value of
288 ;; last-command-char. This would greatly simplify the logic and the code.
290 ;; 2. Somebody should venture to write a customization package a la
291 ;; options.el that would allow the user to change values of variables
292 ;; that meet certain specs (e.g., match a regexp) and whose doc string
293 ;; starts with a '*'. Then, the user should be offered to save
294 ;; variables that were changed. This will make user's customization job
295 ;; much easier.
298 ;;; Code:
300 (require 'advice)
301 (require 'cl)
302 (require 'ring)
304 ;; compiler pacifier
305 (defvar mark-even-if-inactive)
306 (defvar quail-mode)
307 (defvar viper-expert-level)
308 (defvar viper-mode-string)
309 (defvar viper-major-mode-modifier-list)
311 ;; loading happens only in non-interactive compilation
312 ;; in order to spare non-viperized emacs from being viperized
313 (if noninteractive
314 (eval-when-compile
315 (let ((load-path (cons (expand-file-name ".") load-path)))
316 (or (featurep 'viper-init)
317 (load "viper-init.el" nil nil 'nosuffix))
318 (or (featurep 'viper-cmd)
319 (load "viper-cmd.el" nil nil 'nosuffix))
321 ;; end pacifier
323 (require 'viper-init)
324 (require 'viper-keym)
326 ;; better be defined before Viper custom group.
327 (defvar viper-custom-file-name (convert-standard-filename "~/.viper")
328 "Viper customisation file.
329 If set by the user, this must be done _before_ Viper is loaded in `~/.emacs'.")
331 (defgroup viper nil
332 "Vi emulation within Emacs.
333 NOTE: Viper customization should be saved in `viper-custom-file-name', which
334 defaults to `~/.viper'."
335 :prefix "viper-"
336 :group 'emulations)
338 (require 'viper-cmd)
340 (defgroup viper-misc nil
341 "Miscellaneous Viper customization."
342 :prefix "viper-"
343 :group 'viper)
346 (defcustom viper-always t
347 "Non-nil means, arrange for vi-state to be a default when appropriate.
348 This is different from `viper-mode' variable in that `viper-mode' determines
349 whether to use Viper in the first place, while `viper-always', if nil, lets
350 user decide when to invoke Viper in a major mode."
351 :type 'boolean
352 :tag "Always Invoke Viper"
353 :group 'viper-misc)
355 ;; Non-viper variables that need to be saved in case the user decides to
356 ;; de-viperize emacs.
357 (defvar viper-saved-non-viper-variables nil)
359 (defcustom viper-mode (cond (noninteractive nil)
360 (t 'ask))
361 "To Viperize or not to Viperize.
362 If t, viperize emacs. If nil -- don't. If `ask', ask the user.
363 This variable is used primatily when Viper is being loaded.
365 Must be set in `~/.emacs' before Viper is loaded.
366 DO NOT set this variable interactively, unless you are using the customization
367 widget."
368 :type '(choice (const nil) (const t) (const ask))
369 :tag "Set Viper Mode on Loading"
370 :group 'viper-misc)
372 (defcustom viper-vi-state-mode-list
373 '(fundamental-mode
374 makefile-mode
376 awk-mode
377 m4-mode
378 xrdb-mode
379 winmgr-mode
380 autoconf-mode
381 cvs-edit-mode
383 html-mode html-helper-mode
384 emacs-lisp-mode lisp-mode lisp-interaction-mode
386 jde-mode java-mode
387 cc-mode c-mode c++-mode objc-mode
388 fortran-mode f90-mode
389 basic-mode
390 bat-mode
391 asm-mode
392 prolog-mode
393 flora-mode
394 sql-mode
396 text-mode indented-text-mode
397 tex-mode latex-mode bibtex-mode
398 ps-mode
400 ;; completion-list-mode
401 diff-mode
402 idl-mode
404 perl-mode
405 cperl-mode
406 javascript-mode
407 tcl-mode
408 python-mode
410 sh-mode ksh-mode csh-mode
412 gnus-article-mode
413 mh-show-mode
415 "Major modes that require Vi command state."
416 :type '(repeat symbol)
417 :group 'viper-misc)
419 (defcustom viper-emacs-state-mode-list
420 '(custom-mode
422 dired-mode
423 efs-mode
424 tar-mode
426 browse-kill-ring-mode
427 recentf-mode
428 recentf-dialog-mode
429 occur-mode
431 mh-folder-mode
432 gnus-group-mode
433 gnus-summary-mode
435 completion-list-mode
436 help-mode
438 Info-mode
439 Buffer-menu-mode
440 compilation-mode
442 rcirc-mode
444 jde-javadoc-checker-report-mode
446 view-mode
447 vm-mode
448 vm-summary-mode)
449 "*A list of major modes that should come up in Emacs state.
450 Normally, Viper would bring buffers up in Emacs state, unless the corresponding
451 major mode has been placed on `viper-vi-state-mode-list' or
452 `viper-insert-state-mode-list'. So, don't place a new mode on this list,
453 unless it is coming up in a wrong Viper state."
454 :type '(repeat symbol)
455 :group 'viper-misc)
457 (defcustom viper-insert-state-mode-list
458 '(internal-ange-ftp-mode
459 comint-mode
460 inferior-emacs-lisp-mode
461 eshell-mode
462 shell-mode)
463 "*A list of major modes that should come up in Vi Insert state."
464 :type '(repeat symbol)
465 :group 'viper-misc)
468 ;; used to set viper-major-mode-modifier-list in defcustom
469 (defun viper-apply-major-mode-modifiers (&optional symbol value)
470 (if symbol
471 (set symbol value))
472 (mapcar (lambda (triple)
473 (viper-modify-major-mode
474 (nth 0 triple) (nth 1 triple) (eval (nth 2 triple))))
475 viper-major-mode-modifier-list))
477 ;; We change standard bindings in some major modes, making them slightly
478 ;; different than in "normal" vi/insert/emacs states
479 (defcustom viper-major-mode-modifier-list
480 '((help-mode emacs-state viper-slash-and-colon-map)
481 (comint-mode insert-state viper-comint-mode-modifier-map)
482 (comint-mode vi-state viper-comint-mode-modifier-map)
483 (shell-mode insert-state viper-comint-mode-modifier-map)
484 (inferior-emacs-lisp-mode insert-state viper-comint-mode-modifier-map)
485 (shell-mode vi-state viper-comint-mode-modifier-map)
486 (ange-ftp-shell-mode insert-state viper-comint-mode-modifier-map)
487 (ange-ftp-shell-mode vi-state viper-comint-mode-modifier-map)
488 (internal-ange-ftp-mode insert-state viper-comint-mode-modifier-map)
489 (internal-ange-ftp-mode vi-state viper-comint-mode-modifier-map)
490 (dired-mode emacs-state viper-dired-modifier-map)
491 (tar-mode emacs-state viper-slash-and-colon-map)
492 (mh-folder-mode emacs-state viper-slash-and-colon-map)
493 (gnus-group-mode emacs-state viper-gnus-modifier-map)
494 (gnus-summary-mode emacs-state viper-gnus-modifier-map)
495 (Info-mode emacs-state viper-slash-and-colon-map)
496 (Buffer-menu-mode emacs-state viper-slash-and-colon-map)
498 "List specifying how to modify the various major modes to enable some Viperisms.
499 The list has the structure: ((mode viper-state keymap) (mode viper-state
500 keymap) ...). If `mode' is on the list, the `kemap' will be made active (on
501 the minor-mode-map-alist) in the specified viper state.
502 If you change this list, have to restart emacs for the change to take effect.
503 However, if you did the change through the customization widget, then emacs
504 needs to be restarted only if you deleted a triple mode-state-keymap from the
505 list. No need to restart emacs in case of insertion or modification of an
506 existing triple."
507 :type '(repeat
508 (list symbol
509 (choice (const emacs-state)
510 (const vi-state)
511 (const insert-state))
512 symbol))
513 :set 'viper-apply-major-mode-modifiers
514 :group 'viper-misc)
520 ;;;###autoload
521 (defun toggle-viper-mode ()
522 "Toggle Viper on/off.
523 If Viper is enabled, turn it off. Otherwise, turn it on."
524 (interactive)
525 (if (eq viper-mode t)
526 (viper-go-away)
527 (setq viper-mode nil)
528 (viper-mode)))
530 ;;;###autoload
531 (defun viper-mode ()
532 "Turn on Viper emulation of Vi in Emacs. See Info node `(viper)Viper'."
533 (interactive)
534 (if (not noninteractive)
535 (progn
536 ;; if the user requested viper-mode explicitly
537 (if viper-mode
539 (setq viper-mode t)
540 (load-library "viper"))
542 (if viper-first-time ; Important check. Prevents mix-up of startup
543 (progn ; and expert-level msgs when viper-mode recurses
544 (setq viper-first-time nil)
545 (setq viper-vi-state-cursor-color
546 (viper-get-cursor-color))
547 (if (not viper-inhibit-startup-message)
548 (save-window-excursion
549 (setq viper-inhibit-startup-message t)
550 (delete-other-windows)
551 (switch-to-buffer "Viper Startup Message")
552 (erase-buffer)
553 (insert
554 (substitute-command-keys
555 "Viper Is a Package for Emacs Rebels,
556 a VI Plan for Emacs Rescue, and a venomous VI PERil.
558 Incidentally, Viper emulates Vi under GNU Emacs 20 and XEmacs 20.
559 It supports all of what is good in Vi and Ex, while extending
560 and improving upon much of it.
562 1. Viper supports Vi at several levels. Level 1 is the closest to Vi,
563 level 5 provides the most flexibility to depart from many Vi conventions.
565 You will be asked to specify your user level in a following screen.
567 If you select user level 1 then the keys ^X, ^C, ^Z, and ^G will behave
568 as in VI, to smooth transition to Viper for the beginners. However, to
569 use Emacs productively, you are advised to reach user level 3 or higher.
571 At user level 2 or higher, ^X and ^C have Emacs, not Vi, bindings;
572 ^Z toggles Vi/Emacs states; ^G is Emacs' keyboard-quit (like ^C in Vi).
574 2. Vi exit functions (e.g., :wq, ZZ) work on INDIVIDUAL files -- they
575 do not cause Emacs to quit, except at user level 1 (for a novice).
576 3. ^X^C EXITS EMACS.
577 4. Viper supports multiple undo: `u' will undo. Typing `.' will repeat
578 undo. Another `u' changes direction.
580 6. Emacs Meta key is `C-\\' (in all modes) or `\\ ESC' (in Vi command mode).
581 On a window system, the best way is to use the Meta-key on your keyboard.
582 7. Try \\[keyboard-quit] and \\[abort-recursive-edit] repeatedly,if
583 something funny happens. This would abort the current editing command.
585 For more information on Viper:
587 a. Type `:help' in Vi command mode
588 b. Print Viper manual, found in ./etc/viper.dvi
589 c. Print the Quick Reference, found in ./etc/viperCard.dvi
591 To submit a bug report or to contact the author, type :submitReport in Vi
592 command mode. To shoo Viper away and return to pure Emacs (horror!), type:
594 M-x viper-go-away
596 This startup message appears whenever you load Viper, unless you type `y' now."
598 (goto-char (point-min))
599 (if (y-or-n-p "Inhibit Viper startup message? ")
600 (viper-save-setting
601 'viper-inhibit-startup-message
602 "Viper startup message inhibited"
603 viper-custom-file-name t))
604 ;;(kill-buffer (current-buffer))
605 (message
606 "The last message is in buffer `Viper Startup Message'")
607 (sit-for 4)
609 (viper-set-expert-level 'dont-change-unless)))
611 (if (eq major-mode 'viper-mode)
612 (setq major-mode 'fundamental-mode))
614 (or (memq major-mode viper-emacs-state-mode-list) ; don't switch to Vi
615 (memq major-mode viper-insert-state-mode-list) ; don't switch
616 (viper-change-state-to-vi)))))
619 ;; Apply a little heuristic to invoke vi state on major-modes
620 ;; that are not listed in viper-vi-state-mode-list
621 (defun this-major-mode-requires-vi-state (mode)
622 (cond ((memq mode viper-vi-state-mode-list) t)
623 ((memq mode viper-emacs-state-mode-list) nil)
624 ((memq mode viper-insert-state-mode-list) nil)
625 (t (and (eq (key-binding "a") 'self-insert-command)
626 (eq (key-binding " ") 'self-insert-command)))))
629 ;; This hook designed to enable Vi-style editing in comint-based modes."
630 (defun viper-comint-mode-hook ()
631 (set (make-local-variable 'require-final-newline) nil)
632 (setq viper-ex-style-editing nil
633 viper-ex-style-motion nil)
634 (viper-change-state-to-insert))
637 ;; remove viper hooks from SYMBOL
638 (defun viper-remove-hooks (symbol)
639 (cond ((not (boundp symbol)) nil)
640 ((not (listp (eval symbol))) nil)
641 ((string-match "-hook" (symbol-name symbol))
642 (remove-hook symbol 'viper-mode)
643 (remove-hook symbol 'viper-change-state-to-emacs)
644 (remove-hook symbol 'viper-change-state-to-insert)
645 (remove-hook symbol 'viper-change-state-to-vi)
648 ;; Remove local value in all existing buffers
649 ;; This doesn't delocalize vars (which would have been desirable)
650 (defun viper-delocalize-var (symbol)
651 (mapcar (lambda (buf) (save-excursion
652 (set-buffer buf)
653 (kill-local-variable symbol)))
654 (buffer-list)))
657 (defun viper-go-away ()
658 "De-Viperize Emacs.
659 This function tries to do as good a job as possible. However, it may undo some
660 user customization, unrelated to Viper. For instance, if the user advised
661 `read-file-name', `describe-key', and some others, then this advice will be
662 undone.
663 It also can't undo some Viper settings."
664 (interactive)
666 ;; restore non-viper vars
667 (setq-default
668 next-line-add-newlines
669 (viper-standard-value
670 'next-line-add-newlines viper-saved-non-viper-variables)
671 require-final-newline
672 (viper-standard-value
673 'require-final-newline viper-saved-non-viper-variables)
674 scroll-step
675 (viper-standard-value 'scroll-step viper-saved-non-viper-variables)
676 mode-line-buffer-identification
677 (viper-standard-value
678 'mode-line-buffer-identification viper-saved-non-viper-variables)
679 global-mode-string
680 (delq 'viper-mode-string global-mode-string))
682 (if viper-emacs-p
683 (setq-default
684 mark-even-if-inactive
685 (viper-standard-value
686 'mark-even-if-inactive viper-saved-non-viper-variables)))
688 ;; Ideally, we would like to be able to de-localize local variables
689 (unless
690 (and (fboundp 'add-to-ordered-list) (boundp 'emulation-mode-map-alists))
691 (viper-delocalize-var 'minor-mode-map-alist))
692 (viper-delocalize-var 'require-final-newline)
693 (if viper-xemacs-p (viper-delocalize-var 'bar-cursor))
696 ;; deactivate all advices done by Viper.
697 (ad-deactivate-regexp "viper-")
699 (setq viper-mode nil)
701 (when (and (fboundp 'add-to-ordered-list) (boundp 'emulation-mode-map-alists))
702 (setq emulation-mode-map-alists
703 (delq 'viper--intercept-key-maps
704 (delq 'viper--key-maps emulation-mode-map-alists))
707 (viper-delocalize-var 'viper-vi-minibuffer-minor-mode)
708 (viper-delocalize-var 'viper-insert-minibuffer-minor-mode)
709 (viper-delocalize-var 'viper-vi-intercept-minor-mode)
710 (viper-delocalize-var 'viper-insert-intercept-minor-mode)
712 (viper-delocalize-var 'viper-vi-local-user-minor-mode)
713 (viper-delocalize-var 'viper-vi-kbd-minor-mode)
714 (viper-delocalize-var 'viper-vi-global-user-minor-mode)
715 (viper-delocalize-var 'viper-vi-state-modifier-minor-mode)
716 (viper-delocalize-var 'viper-vi-diehard-minor-mode)
717 (viper-delocalize-var 'viper-vi-basic-minor-mode)
719 (viper-delocalize-var 'viper-replace-minor-mode)
721 (viper-delocalize-var 'viper-insert-local-user-minor-mode)
722 (viper-delocalize-var 'viper-insert-kbd-minor-mode)
723 (viper-delocalize-var 'viper-insert-global-user-minor-mode)
724 (viper-delocalize-var 'viper-insert-state-modifier-minor-mode)
725 (viper-delocalize-var 'viper-insert-diehard-minor-mode)
726 (viper-delocalize-var 'viper-insert-basic-minor-mode)
728 (viper-delocalize-var 'viper-emacs-intercept-minor-mode)
729 (viper-delocalize-var 'viper-emacs-local-user-minor-mode)
730 (viper-delocalize-var 'viper-emacs-kbd-minor-mode)
731 (viper-delocalize-var 'viper-emacs-global-user-minor-mode)
732 (viper-delocalize-var 'viper-emacs-state-modifier-minor-mode)
734 (viper-delocalize-var 'viper-current-state)
735 (viper-delocalize-var 'viper-mode-string)
737 (setq-default viper-vi-minibuffer-minor-mode nil
738 viper-insert-minibuffer-minor-mode nil
739 viper-vi-intercept-minor-mode nil
740 viper-insert-intercept-minor-mode nil
742 viper-vi-local-user-minor-mode nil
743 viper-vi-kbd-minor-mode nil
744 viper-vi-global-user-minor-mode nil
745 viper-vi-state-modifier-minor-mode nil
746 viper-vi-diehard-minor-mode nil
747 viper-vi-basic-minor-mode nil
749 viper-replace-minor-mode nil
751 viper-insert-local-user-minor-mode nil
752 viper-insert-kbd-minor-mode nil
753 viper-insert-global-user-minor-mode nil
754 viper-insert-state-modifier-minor-mode nil
755 viper-insert-diehard-minor-mode nil
756 viper-insert-basic-minor-mode nil
758 viper-emacs-intercept-minor-mode nil
759 viper-emacs-local-user-minor-mode nil
760 viper-emacs-kbd-minor-mode nil
761 viper-emacs-global-user-minor-mode nil
762 viper-emacs-state-modifier-minor-mode nil
764 viper-current-state 'emacs-state
765 viper-mode-string viper-emacs-state-id
768 ;; remove all hooks set by viper
769 (mapatoms 'viper-remove-hooks)
770 (remove-hook 'comint-mode-hook 'viper-comint-mode-hook)
771 (remove-hook 'minibuffer-setup-hook 'viper-minibuffer-setup-sentinel)
772 (remove-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
773 (remove-hook 'post-command-hook 'viper-minibuffer-post-command-hook)
775 ;; unbind Viper mouse bindings
776 (viper-unbind-mouse-search-key)
777 (viper-unbind-mouse-insert-key)
778 ;; In emacs, we have to advice handle-switch-frame
779 ;; This advice is undone earlier, when all advices matchine "viper-" are
780 ;; deactivated.
781 (if viper-xemacs-p
782 (remove-hook 'mouse-leave-frame-hook 'viper-remember-current-frame))
783 ) ; end viper-go-away
786 ;; list of buffers that just changed their major mode
787 ;; used in a hack that triggers vi command mode whenever needed
788 (defvar viper-new-major-mode-buffer-list nil)
790 ;; set appropriate Viper state in buffers that changed major mode
791 (defun set-viper-state-in-major-mode ()
792 (mapcar
793 (lambda (buf)
794 (if (viper-buffer-live-p buf)
795 (with-current-buffer buf
796 (cond ((and (this-major-mode-requires-vi-state major-mode)
797 (eq viper-current-state 'emacs-state))
798 (viper-mode))
799 ((memq major-mode viper-emacs-state-mode-list)
800 ;; not checking (eq viper-current-state 'emacs-state)
801 ;; because viper-current-state could have gotten it by
802 ;; default. We need viper-change-state-to-emacs here to have
803 ;; the keymaps take effect.
804 (viper-change-state-to-emacs))
805 ((and (memq major-mode viper-insert-state-mode-list)
806 (not (eq viper-current-state 'insert-state)))
807 (viper-change-state-to-insert))
808 )) ; with-current-buffer
809 )) ; function
810 viper-new-major-mode-buffer-list)
811 ;; clear the list of bufs that changed major mode
812 (setq viper-new-major-mode-buffer-list nil)
813 ;; change the global value of hook
814 (remove-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode))
816 ;; sets up post-command-hook to turn viper-mode, if the current mode is
817 ;; fundamental
818 (defun viper-major-mode-change-sentinel ()
819 (save-match-data
820 (or (string-match "\*Minibuf-" (buffer-name))
821 (setq viper-new-major-mode-buffer-list
822 (cons (current-buffer) viper-new-major-mode-buffer-list))))
823 ;; change the global value of hook
824 (add-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode t))
828 ;; This sets major mode hooks to make them come up in vi-state.
829 (defun viper-set-hooks ()
830 ;; It is of course a misnomer to call viper-mode a `major mode'.
831 ;; However, this has the effect that if the user didn't specify the
832 ;; default mode, new buffers that fall back on the default will come up
833 ;; in Fundamental Mode and Vi state.
834 ;; When viper-mode is executed in such a case, it will set the major mode
835 ;; back to fundamental-mode.
836 (if (eq default-major-mode 'fundamental-mode)
837 (setq default-major-mode 'viper-mode))
839 (add-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
840 (add-hook 'find-file-hooks 'set-viper-state-in-major-mode)
842 ;; keep this because many modes we don't know about use this hook
843 (defvar text-mode-hook)
844 (add-hook 'text-mode-hook 'viper-mode)
846 (defvar emerge-startup-hook)
847 (add-hook 'emerge-startup-hook 'viper-change-state-to-emacs)
849 ;; Zap bad bindings in flyspell-mouse-map, which prevent ESC from working
850 ;; over misspelled words (due to the overlay keymaps)
851 (defvar flyspell-mode-hook)
852 (add-hook 'flyspell-mode-hook
853 '(lambda ()
854 (define-key flyspell-mouse-map viper-ESC-key nil)))
855 ;; if viper is started from .emacs, it might be impossible to get certain
856 ;; info about the display and windows until emacs initialization is complete
857 ;; So do it via the window-setup-hook
858 (add-hook 'window-setup-hook
859 '(lambda ()
860 (setq viper-vi-state-cursor-color (viper-get-cursor-color))))
862 ;; Tell vc-diff to put *vc* in Vi mode
863 (if (featurep 'vc)
864 (defadvice vc-diff (after viper-vc-ad activate)
865 "Force Vi state in VC diff buffer."
866 (viper-change-state-to-vi))
867 (eval-after-load
868 "vc"
869 '(defadvice vc-diff (after viper-vc-ad activate)
870 "Force Vi state in VC diff buffer."
871 (viper-change-state-to-vi))))
873 (eval-after-load
874 "emerge"
875 '(defadvice emerge-quit (after viper-emerge-advice activate)
876 "Run `viper-change-state-to-vi' after quitting emerge."
877 (viper-change-state-to-vi)))
878 ;; In case Emerge was loaded before Viper.
879 (defadvice emerge-quit (after viper-emerge-advice activate)
880 "Run `viper-change-state-to-vi' after quitting emerge."
881 (viper-change-state-to-vi))
883 ;; passwd.el sets up its own buffer, which turns up in Vi mode,
884 ;; thus overriding the local map. We don't need Vi mode here.
885 (eval-after-load
886 "passwd"
887 '(defadvice read-passwd-1 (before viper-passwd-ad activate)
888 "Switch to emacs state while reading password."
889 (viper-change-state-to-emacs)))
891 (defadvice self-insert-command (around viper-self-insert-ad activate)
892 "Ignore all self-inserting keys in the vi-state."
893 (if (and (eq viper-current-state 'vi-state) (interactive-p))
894 (beep 1)
895 ad-do-it
898 (defadvice set-cursor-color (after viper-set-cursor-color-ad activate)
899 "Change cursor color in VI state."
900 ;;(setq viper-vi-state-cursor-color (ad-get-arg 0))
901 (modify-frame-parameters
902 (selected-frame)
903 (list (cons 'viper-vi-state-cursor-color (ad-get-arg 0))))
906 (when (and (fboundp 'add-to-ordered-list) (boundp 'emulation-mode-map-alists))
907 ;; needs to be as early as possible
908 (add-to-ordered-list
909 'emulation-mode-map-alists 'viper--intercept-key-maps 100)
910 ;; needs to be after cua-mode
911 (add-to-ordered-list 'emulation-mode-map-alists 'viper--key-maps 500)
914 ;; Emacs shell, ange-ftp, and comint-based modes
915 (add-hook 'comint-mode-hook 'viper-comint-mode-hook) ; comint
917 (add-hook 'eshell-mode-hook
918 (lambda () (setq viper-auto-indent nil)))
920 (viper-set-emacs-state-searchstyle-macros nil 'dired-mode) ; dired
921 (viper-set-emacs-state-searchstyle-macros nil 'tar-mode) ; tar
922 (viper-set-emacs-state-searchstyle-macros nil 'mh-folder-mode) ; mhe
923 (viper-set-emacs-state-searchstyle-macros nil 'gnus-group-mode) ; gnus
924 (viper-set-emacs-state-searchstyle-macros nil 'gnus-summary-mode)
925 (viper-set-emacs-state-searchstyle-macros nil 'Info-mode) ; info
926 (viper-set-emacs-state-searchstyle-macros nil 'Buffer-menu-mode) ;buffer-menu
928 ;; Modify major modes according to viper-major-mode-modifier-list
929 (viper-apply-major-mode-modifiers)
931 ;; For RMAIL users.
932 ;; Put buf in Emacs state after edit.
933 (eval-after-load
934 "rmailedit"
935 '(defadvice rmail-cease-edit (after viper-rmail-advice activate)
936 "Switch to emacs state when done editing message."
937 (viper-change-state-to-emacs)))
938 ;; In case RMAIL was loaded before Viper.
939 (defadvice rmail-cease-edit (after viper-rmail-advice activate)
940 "Switch to emacs state when done editing message."
941 (viper-change-state-to-emacs))
943 ;; ISO accents
944 ;; Need to do it after loading iso-acc, or else this loading will wipe out
945 ;; the advice.
946 (eval-after-load
947 "iso-acc"
948 '(defadvice iso-accents-mode (around viper-iso-accents-advice activate)
949 "Set viper-automatic-iso-accents to iso-accents-mode."
950 (let ((arg (ad-get-arg 0)))
951 ad-do-it
952 (setq viper-automatic-iso-accents
953 (if (eq viper-current-state 'vi-state)
954 (if arg
955 ;; if iso-accents-mode was called with positive arg, turn
956 ;; accents on
957 (> (prefix-numeric-value arg) 0)
958 ;; else: toggle viper-automatic-iso-accents
959 (not viper-automatic-iso-accents))
960 ;; other states: accept what iso-accents-mode has done
961 iso-accents-mode))
962 ;; turn off ISO accents in vi-state
963 (if (eq viper-current-state 'vi-state)
964 (viper-set-iso-accents-mode nil))
965 (if (memq viper-current-state '(vi-state insert-state replace-state))
966 (message "Viper ISO accents mode: %s"
967 (if viper-automatic-iso-accents "on" "off")))
970 ;; International input methods
971 (if viper-emacs-p
972 (eval-after-load "mule-cmds"
973 '(progn
974 (defadvice inactivate-input-method (after viper-mule-advice activate)
975 "Set viper-special-input-method to disable intl. input methods."
976 (viper-inactivate-input-method-action))
977 (defadvice activate-input-method (after viper-mule-advice activate)
978 "Set viper-special-input-method to enable intl. input methods."
979 (viper-activate-input-method-action))
981 ;; XEmacs Although these hooks exist in Emacs, they don't seem to be always
982 ;; called on input-method activation/deactivation, so we the above advise
983 ;; functions instead.
984 (eval-after-load "mule-cmds"
985 '(progn
986 (add-hook 'input-method-activate-hook
987 'viper-activate-input-method-action t)
988 (add-hook 'input-method-inactivate-hook
989 'viper-inactivate-input-method-action t)))
991 (eval-after-load "mule-cmds"
992 '(defadvice toggle-input-method (around viper-mule-advice activate)
993 "Adjust input-method toggling in vi-state."
994 (if (and viper-special-input-method (eq viper-current-state 'vi-state))
995 (viper-inactivate-input-method)
996 ad-do-it)))
998 ) ; viper-set-hooks
1001 ;; these are primarily advices and Vi-ish variable settings
1002 (defun viper-non-hook-settings ()
1004 ;; Viper changes the default mode-line-buffer-identification
1005 (setq-default mode-line-buffer-identification '(" %b"))
1007 ;; setup emacs-supported vi-style feel
1008 (setq next-line-add-newlines nil
1009 require-final-newline t)
1011 ;; don't bark when mark is inactive
1012 (if viper-emacs-p
1013 (setq mark-even-if-inactive t))
1015 (setq scroll-step 1)
1017 ;; Variable displaying the current Viper state in the mode line.
1018 (or (memq 'viper-mode-string global-mode-string)
1019 (setq global-mode-string
1020 (append '("" viper-mode-string) (cdr global-mode-string))))
1022 (defadvice describe-key (before viper-describe-key-ad protect activate)
1023 "Force to read key via `viper-read-key-sequence'."
1024 (interactive (list (viper-read-key-sequence "Describe key: "))
1027 (defadvice describe-key-briefly
1028 (before viper-describe-key-briefly-ad protect activate)
1029 "Force to read key via `viper-read-key-sequence'."
1030 (interactive (list (viper-read-key-sequence "Describe key briefly: "))))
1033 (defadvice find-file (before viper-add-suffix-advice activate)
1034 "Use `read-file-name' for reading arguments."
1035 (interactive (cons (read-file-name "Find file: " nil default-directory)
1036 ;; XEmacs: if Mule & prefix arg, ask for coding system
1037 (cond ((and viper-xemacs-p (featurep 'mule))
1038 (list
1039 (and current-prefix-arg
1040 (read-coding-system "Coding-system: "))))
1041 ;; Emacs: do wildcards
1042 ((and viper-emacs-p (boundp 'find-file-wildcards))
1043 (list find-file-wildcards))))
1046 (defadvice find-file-other-window (before viper-add-suffix-advice activate)
1047 "Use `read-file-name' for reading arguments."
1048 (interactive (cons (read-file-name "Find file in other window: "
1049 nil default-directory)
1050 ;; XEmacs: if Mule & prefix arg, ask for coding system
1051 (cond ((and viper-xemacs-p (featurep 'mule))
1052 (list
1053 (and current-prefix-arg
1054 (read-coding-system "Coding-system: "))))
1055 ;; Emacs: do wildcards
1056 ((and viper-emacs-p (boundp 'find-file-wildcards))
1057 (list find-file-wildcards))))
1061 (defadvice find-file-other-frame (before viper-add-suffix-advice activate)
1062 "Use `read-file-name' for reading arguments."
1063 (interactive (cons (read-file-name "Find file in other frame: "
1064 nil default-directory)
1065 ;; XEmacs: if Mule & prefix arg, ask for coding system
1066 (cond ((and viper-xemacs-p (featurep 'mule))
1067 (list
1068 (and current-prefix-arg
1069 (read-coding-system "Coding-system: "))))
1070 ;; Emacs: do wildcards
1071 ((and viper-emacs-p (boundp 'find-file-wildcards))
1072 (list find-file-wildcards))))
1076 (defadvice read-file-name (around viper-suffix-advice activate)
1077 "Tell `exit-minibuffer' to run `viper-file-add-suffix' as a hook."
1078 (let ((viper-minibuffer-exit-hook
1079 (append viper-minibuffer-exit-hook
1080 '(viper-minibuffer-trim-tail viper-file-add-suffix))))
1081 ad-do-it))
1083 (defadvice start-kbd-macro (after viper-kbd-advice activate)
1084 "Remove Viper's intercepting bindings for C-x ).
1085 This may be needed if the previous `:map' command terminated abnormally."
1086 (define-key viper-vi-intercept-map "\C-x)" nil)
1087 (define-key viper-insert-intercept-map "\C-x)" nil)
1088 (define-key viper-emacs-intercept-map "\C-x)" nil))
1090 (defadvice add-minor-mode (after
1091 viper-advice-add-minor-mode
1092 (toggle name &optional keymap after toggle-fun)
1093 activate)
1094 "Run viper-normalize-minor-mode-map-alist after adding a minor mode."
1095 (viper-normalize-minor-mode-map-alist)
1096 (unless
1097 (and (fboundp 'add-to-ordered-list) (boundp 'emulation-mode-map-alists))
1098 (setq-default minor-mode-map-alist minor-mode-map-alist)))
1100 ;; catch frame switching event
1101 (if (viper-window-display-p)
1102 (if viper-xemacs-p
1103 (add-hook 'mouse-leave-frame-hook
1104 'viper-remember-current-frame)
1105 (defadvice handle-switch-frame (before viper-frame-advice activate)
1106 "Remember the selected frame before the switch-frame event."
1107 (viper-remember-current-frame (selected-frame)))) )
1109 ) ; end viper-non-hook-settings
1113 ;; Ask only if this-command/last-command are nil, i.e., when loading
1114 (cond ((and (eq viper-mode 'ask) (null this-command) (null last-command))
1115 (save-window-excursion
1116 (with-output-to-temp-buffer " *viper-info*"
1117 (princ "
1118 You have loaded Viper, and are about to Viperize your emacs!
1120 Viper is a Package for Emacs Rebels and a venomous VI PERil,
1122 It's time to decide: to Viperize or not to Viperize...
1124 If you wish to Viperize AND make this your way of life, please put
1126 (setq viper-mode t)
1127 (require 'viper)
1129 in your .emacs file (preferably, close to the top).
1130 These two lines must come in the order given.
1132 ** Viper users:
1133 **** The startup file name has been changed from .vip to .viper
1134 **** All vip-* style names have been converted to viper-* style."))
1135 (if (y-or-n-p "Viperize? ")
1136 (setq viper-mode t)
1137 (setq viper-mode nil))
1138 (message "")
1139 (kill-buffer " *viper-info*")))
1141 ;; If viper-mode is t, then just continue. Viper will kick in.
1142 ((eq viper-mode t))
1143 ;; Otherwise, it was asking Viper was not loaded through .emacs
1144 ;; In this case, it was either through M-x viper-mode or via something
1145 ;; else, like the custom widget. If Viper was loaded through
1146 ;; M-x viper-mode, then viper will kick in anyway.
1147 (t (setq viper-mode nil)))
1149 (defun viper-load-custom-file ()
1150 (if (and (file-exists-p viper-custom-file-name)
1151 (not noninteractive))
1152 (load viper-custom-file-name)))
1159 ;; save non-viper vars that Viper might change
1160 (if (null viper-saved-non-viper-variables)
1161 (setq viper-saved-non-viper-variables
1162 (list
1163 (cons 'next-line-add-newlines (list next-line-add-newlines))
1164 (cons 'require-final-newline (list require-final-newline))
1165 (cons 'scroll-step (list scroll-step))
1166 (cons 'mode-line-buffer-identification
1167 (list (default-value 'mode-line-buffer-identification)))
1168 (cons 'global-mode-string (list global-mode-string))
1169 (if viper-emacs-p
1170 (cons 'mark-even-if-inactive (list mark-even-if-inactive)))
1174 ;; Set some useful macros, advices
1175 ;; These must be BEFORE ~/.viper is loaded,
1176 ;; so the user can unrecord them in ~/.viper.
1177 (if viper-mode
1178 (progn
1179 ;; set advices and some variables that give emacs Vi look.
1180 (viper-non-hook-settings)
1182 ;; repeat the 2nd previous command without rotating the command history
1183 (viper-record-kbd-macro
1184 (vector viper-repeat-from-history-key '\1) 'vi-state
1185 [(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)
1186 ;; repeat the 3d previous command without rotating the command history
1187 (viper-record-kbd-macro
1188 (vector viper-repeat-from-history-key '\2) 'vi-state
1189 [(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)
1191 ;; set macros for toggling case sensitivity and regexp search
1192 (viper-set-searchstyle-toggling-macros nil)
1193 ;; Make %%% toggle parsing comments for matching parentheses
1194 (viper-set-parsing-style-toggling-macro nil)
1196 ;; ~/.viper is loaded if exists
1197 (viper-load-custom-file)
1199 ;; should be after loading custom file to avoid the pesky msg that
1200 ;; mouse-search/insert keys are already bound
1201 (viper-bind-mouse-search-key)
1202 (viper-bind-mouse-insert-key)
1207 ;; Applying Viper customization -- runs after (load .viper)
1209 ;; Save user settings or Viper defaults for vars controlled by
1210 ;; viper-expert-level
1211 (if (null viper-saved-user-settings)
1212 (setq viper-saved-user-settings
1213 (list (cons 'viper-want-ctl-h-help (list viper-want-ctl-h-help))
1214 (cons 'viper-always (list viper-always))
1215 (cons 'viper-no-multiple-ESC (list viper-no-multiple-ESC))
1216 (cons 'viper-ex-style-motion (list viper-ex-style-motion))
1217 (cons 'viper-ex-style-editing
1218 (list viper-ex-style-editing))
1219 (cons 'viper-want-emacs-keys-in-vi
1220 (list viper-want-emacs-keys-in-vi))
1221 (cons 'viper-electric-mode (list viper-electric-mode))
1222 (cons 'viper-want-emacs-keys-in-insert
1223 (list viper-want-emacs-keys-in-insert))
1224 (cons 'viper-re-search (list viper-re-search)))))
1227 (if viper-mode
1228 (progn
1229 (viper-set-minibuffer-style)
1230 (if viper-buffer-search-char
1231 (viper-buffer-search-enable))
1232 (viper-update-syntax-classes 'set-default)
1236 ;;; Familiarize Viper with some minor modes that have their own keymaps
1237 (if viper-mode
1238 (progn
1239 (viper-harness-minor-mode "compile")
1240 (viper-harness-minor-mode "outline")
1241 (viper-harness-minor-mode "allout")
1242 (viper-harness-minor-mode "xref")
1243 (viper-harness-minor-mode "lmenu")
1244 (viper-harness-minor-mode "vc")
1245 (viper-harness-minor-mode "ltx-math") ; LaTeX-math-mode in AUC-TeX, which
1246 (viper-harness-minor-mode "latex") ; sits in one of these two files
1247 (viper-harness-minor-mode "cyrillic")
1248 (viper-harness-minor-mode "russian")
1249 (viper-harness-minor-mode "view-less")
1250 (viper-harness-minor-mode "view")
1251 (viper-harness-minor-mode "reftex")
1252 (viper-harness-minor-mode "flyspell")
1256 ;; Intercept maps could go in viper-keym.el
1257 ;; We keep them here in case someone redefines them in ~/.viper
1259 (define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1260 (define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1262 ;; This is taken care of by viper-insert-global-user-map.
1263 ;;(define-key viper-replace-map viper-ESC-key 'viper-intercept-ESC-key)
1266 ;; The default viper-toggle-key is \C-z; for the novice, it suspends or
1267 ;; iconifies Emacs
1268 (define-key viper-vi-intercept-map viper-toggle-key 'viper-toggle-key-action)
1269 (define-key
1270 viper-emacs-intercept-map viper-toggle-key 'viper-change-state-to-vi)
1272 ;;; Removed to avoid bad interaction with cua-mode.
1273 ;;; Escape from Emacs and Insert modes to Vi for one command
1274 ;;(define-key viper-emacs-intercept-map "\C-c\\" 'viper-escape-to-vi)
1275 ;;(define-key viper-insert-intercept-map "\C-c\\" 'viper-escape-to-vi)
1277 (if viper-mode
1278 (setq-default viper-emacs-intercept-minor-mode t
1279 viper-emacs-local-user-minor-mode t
1280 viper-emacs-global-user-minor-mode t
1281 viper-emacs-kbd-minor-mode t
1282 viper-emacs-state-modifier-minor-mode t))
1283 (if (and viper-mode (eq viper-current-state 'emacs-state))
1284 (setq viper-emacs-intercept-minor-mode t
1285 viper-emacs-local-user-minor-mode t
1286 viper-emacs-global-user-minor-mode t
1287 viper-emacs-kbd-minor-mode t
1288 viper-emacs-state-modifier-minor-mode t))
1291 (if (and viper-mode
1292 (or viper-always
1293 (and (< viper-expert-level 5) (> viper-expert-level 0))))
1294 (viper-set-hooks))
1296 ;; Let all minor modes take effect after loading.
1297 ;; This may not be enough, so we also set default minor-mode-alist.
1298 ;; Without setting the default, new buffers that come up in emacs mode have
1299 ;; minor-mode-map-alist = nil, unless we call viper-change-state-*
1300 (if (and viper-mode (eq viper-current-state 'emacs-state))
1301 (progn
1302 (viper-change-state-to-emacs)
1303 (unless
1304 (and (fboundp 'add-to-ordered-list)
1305 (boundp 'emulation-mode-map-alists))
1306 (setq-default minor-mode-map-alist minor-mode-map-alist))
1309 (if (and viper-mode (this-major-mode-requires-vi-state major-mode))
1310 (viper-mode))
1312 (if viper-mode
1313 (setq initial-major-mode
1314 `(lambda ()
1315 (funcall (quote ,initial-major-mode))
1316 (set-viper-state-in-major-mode))
1321 (run-hooks 'viper-load-hook) ; the last chance to change something
1323 (provide 'viper)
1326 ;; Local Variables:
1327 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1328 ;; End:
1330 ;; arch-tag: 5f3e844c-c4e6-4bbd-9b73-63bdc14e7d79
1331 ;;; viper.el ends here