]> code.delx.au - gnu-emacs/blob - lisp/emulation/viper.el
Update version number.
[gnu-emacs] / lisp / emulation / viper.el
1 ;;; viper.el --- A full-featured Vi emulator for GNU Emacs and XEmacs,
2 ;; a VI Plan for Emacs Rescue,
3 ;; and a venomous VI PERil.
4 ;; Viper Is also a Package for Emacs Rebels.
5 ;;
6 ;; Keywords: emulations
7 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
8
9 ;; Copyright (C) 1994, 1995, 1996, 1997, 1998 Free Software Foundation, Inc.
10
11 (defconst viper-version "3.03 (Polyglot) of May 21, 1998"
12 "The current version of Viper")
13
14 ;; This file is part of GNU Emacs.
15
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.
20
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.
25
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.
30
31 ;;; Commentary:
32
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.
41 ;;
42 ;;; History
43 ;;
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.
49 ;;
50 ;; Viper maintains some degree of compatibility with these older
51 ;; packages. See the documentation for customization.
52 ;;
53 ;; The main difference between Viper and these older packages are:
54 ;;
55 ;; 1. Viper emulates Vi at several levels, from almost complete conformity
56 ;; to a rather loose Vi-compliance.
57 ;;
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.
62 ;;
63 ;; 3. Viper supports vi-style undo.
64 ;;
65 ;; 4. Viper fully emulates (and improves upon) vi's replacement mode.
66 ;;
67 ;; 5. Viper has a better interface to ex, including command, variable, and
68 ;; file name completion.
69 ;;
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.
73 ;;
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.
76 ;;
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.
81 ;;
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.
94 ;;
95 ;;
96 ;;; Installation:
97 ;; -------------
98 ;;
99 ;; (require 'viper)
100 ;;
101
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.
107 ;;
108 ;;
109 ;;; Notes:
110 ;;
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.
121 ;;
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:
124 ;;
125 ;; (add-hook 'your-favorite-mode 'viper-mode)
126 ;; or
127 ;; (add-hook 'your-favorite-mode 'viper-change-state-to-emacs)
128 ;;
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.)
132 ;;
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.
136 ;;
137 ;; Viper's Vi state consists of seven minor modes:
138 ;;
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
146 ;;
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.
149 ;;
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.
157 ;;
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.
161 ;;
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.
170 ;;
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.
174 ;;
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).
184 ;;
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.
189 ;;
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.
192 ;;
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.
195 ;;
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.
199 ;;
200 ;; Viper's Insert state also has seven minor modes:
201 ;;
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
209 ;;
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.
213 ;;
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.
221 ;;
222 ;; The next minor mode, viper-insert-kbd-minor-mode,
223 ;; is used for keyboard VI-style macros defined with :map!.
224 ;;
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.
228 ;;
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.
234 ;;
235 ;; Finally, Viper provides minor modes for overriding bindings set by Emacs
236 ;; modes when Viper is in Emacs state:
237 ;;
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
242 ;;
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.
253 ;;
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
257 ;;
258 ;; viper-replace-minor-mode
259 ;;
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.
263 ;;
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
270 ;;
271 ;; (viper-add-local-keys 'insert-state '((key1 . func1) (key2 .func2)))
272 ;;
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.
279 ;;
280 ;;
281 ;; TO DO (volunteers?):
282 ;;
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.
288 ;;
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.
295 ;;
296
297 ;; Code
298
299 (require 'advice)
300 (require 'cl)
301 (require 'ring)
302
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)
309
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))
319 )))
320 ;; end pacifier
321
322 (require 'viper-init)
323
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'.")
328
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)
335
336 (require 'viper-cmd)
337
338 (defgroup viper-misc nil
339 "Miscellaneous Viper customization."
340 :prefix "viper-"
341 :group 'viper)
342
343
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)
352
353 ;; Non-viper variables that need to be saved in case the user decides to
354 ;; de-viperize emacs.
355 (defvar viper-saved-non-viper-variables nil)
356 ;; Contains user settings for vars affected by viper-set-expert-level function.
357 ;; Not a user option.
358 (defvar viper-saved-user-settings nil)
359
360 (defcustom viper-mode (cond (noninteractive nil)
361 (t 'ask))
362 "To Viperize or not to Viperize.
363 If t, viperize emacs. If nil -- don't. If `ask', ask the user.
364 This variable is used primatily when Viper is being loaded.
365
366 Must be set in `~/.emacs' before Viper is loaded.
367 DO NOT set this variable interactively, unless you are using the customization
368 widget."
369 :type '(choice (const nil) (const t) (const ask))
370 :tag "Set Viper Mode on Loading"
371 :group 'viper-misc)
372
373 (defcustom viper-vi-state-mode-list
374 '(fundamental-mode
375 makefile-mode
376 help-mode
377
378 awk-mode
379 m4-mode
380
381 html-mode html-helper-mode
382 emacs-lisp-mode lisp-mode lisp-interaction-mode
383
384 java-mode cc-mode c-mode c++-mode
385 fortran-mode f90-mode
386 basic-mode
387 bat-mode
388 asm-mode
389 prolog-mode
390
391 text-mode indented-text-mode
392 tex-mode latex-mode bibtex-mode
393
394 completion-list-mode
395 compilation-mode
396
397 perl-mode
398 javascript-mode
399 tcl-mode
400 python-mode
401
402 sh-mode ksh-mode csh-mode
403
404 gnus-article-mode
405 mh-show-mode
406 )
407 "Major modes that require Vi command state."
408 :type '(repeat symbol)
409 :group 'viper-misc)
410
411 (defcustom viper-emacs-state-mode-list
412 '(custom-mode
413
414 dired-mode
415 efs-mode
416 tar-mode
417
418 mh-folder-mode
419 gnus-group-mode
420 gnus-summary-mode
421
422 Info-mode
423 Buffer-menu-mode
424
425 view-mode
426 vm-mode
427 vm-summary-mode)
428 "*A list of major modes that should come up in Emacs state.
429 Normally, Viper would bring buffers up in Emacs state, unless the corresponding
430 major mode has been placed on `viper-vi-state-mode-list' or
431 `viper-insert-state-mode-list'. So, don't place a new mode on this list, unless
432 it is coming up in a wrong Viper state."
433 :type '(repeat symbol)
434 :group 'viper-misc)
435
436 (defcustom viper-insert-state-mode-list
437 '(internal-ange-ftp-mode comint-mode shell-mode)
438 "*A list of major modes that should come up in Vi Insert state."
439 :type '(repeat symbol)
440 :group 'viper-misc)
441
442
443 ;; used to set viper-major-mode-modifier-list in defcustom
444 (defun viper-apply-major-mode-modifiers (&optional symbol value)
445 (if symbol
446 (set symbol value))
447 (mapcar (function
448 (lambda (triple)
449 (viper-modify-major-mode
450 (nth 0 triple) (nth 1 triple) (eval (nth 2 triple)))))
451 viper-major-mode-modifier-list))
452
453 (defcustom viper-major-mode-modifier-list
454 '((help-mode emacs-state viper-slash-and-colon-map)
455 (comint-mode insert-state viper-comint-mode-modifier-map)
456 (comint-mode vi-state viper-comint-mode-modifier-map)
457 (shell-mode insert-state viper-comint-mode-modifier-map)
458 (shell-mode vi-state viper-comint-mode-modifier-map)
459 (ange-ftp-shell-mode insert-state viper-comint-mode-modifier-map)
460 (ange-ftp-shell-mode vi-state viper-comint-mode-modifier-map)
461 (internal-ange-ftp-mode insert-state viper-comint-mode-modifier-map)
462 (internal-ange-ftp-mode vi-state viper-comint-mode-modifier-map)
463 (dired-mode emacs-state viper-dired-modifier-map)
464 (tar-mode emacs-state viper-slash-and-colon-map)
465 (mh-folder-mode emacs-state viper-slash-and-colon-map)
466 (gnus-group-mode emacs-state viper-slash-and-colon-map)
467 (gnus-summary-mode emacs-state viper-slash-and-colon-map)
468 (Info-mode emacs-state viper-slash-and-colon-map)
469 (Buffer-menu-mode emacs-state viper-slash-and-colon-map)
470 )
471 "List specifying how to modify the various major modes to enable some Viperisms.
472 The list has the structure: ((mode viper-state keymap) (mode viper-state
473 keymap) ...). If `mode' is on the list, the `kemap' will be made active (on the
474 minor-mode-map-alist) in the specified viper state.
475 If you change this list, have to restart emacs for the change to take effect.
476 However, if you did the change through the customization widget, then emacs
477 needs to be restarted only if you deleted a triple mode-state-keymap from the
478 list. No need to restart emacs in case of insertion or modification of an
479 existing triple."
480 :type '(repeat
481 (list symbol
482 (choice (const emacs-state)
483 (const vi-state)
484 (const insert-state))
485 symbol))
486 :set 'viper-apply-major-mode-modifiers
487 :group 'viper-misc)
488
489
490
491 \f
492
493 ;;;###autoload
494 (defun toggle-viper-mode ()
495 "Toggle Viper on/off.
496 If Viper is enabled, turn it off. Otherwise, turn it on."
497 (interactive)
498 (if (eq viper-mode t)
499 (viper-go-away)
500 (setq viper-mode nil)
501 (viper-mode)))
502
503 ;;;###autoload
504 (defun viper-mode ()
505 "Turn on Viper emulation of Vi."
506 (interactive)
507 (if (not noninteractive)
508 (progn
509 ;; if the user requested viper-mode explicitly
510 (if viper-mode
511 ()
512 (setq viper-mode t)
513 (load-library "viper"))
514
515 (if viper-first-time ; Important check. Prevents mix-up of startup and
516 (progn ; expert-level msgs when viper-mode recurses
517 (setq viper-first-time nil)
518 (if (not viper-inhibit-startup-message)
519 (save-window-excursion
520 (setq viper-inhibit-startup-message t)
521 (delete-other-windows)
522 (switch-to-buffer "Viper Startup Message")
523 (erase-buffer)
524 (insert
525 (substitute-command-keys
526 "Viper Is a Package for Emacs Rebels,
527 a VI Plan for Emacs Rescue, and a venomous VI PERil.
528
529 Incidentally, Viper emulates Vi under GNU Emacs 20 and XEmacs 20.
530 It supports all of what is good in Vi and Ex, while extending
531 and improving upon much of it.
532
533 1. Viper supports Vi at several levels. Level 1 is the closest to Vi,
534 level 5 provides the most flexibility to depart from many Vi conventions.
535
536 You will be asked to specify your user level in a following screen.
537
538 If you select user level 1 then the keys ^X, ^C, ^Z, and ^G will behave
539 as in VI, to smooth transition to Viper for the beginners. However, to
540 use Emacs productively, you are advised to reach user level 3 or higher.
541
542 At user level 2 or higher, ^X and ^C have Emacs, not Vi, bindings;
543 ^Z toggles Vi/Emacs states; ^G is Emacs' keyboard-quit (like ^C in Vi).
544
545 2. Vi exit functions (e.g., :wq, ZZ) work on INDIVIDUAL files -- they
546 do not cause Emacs to quit, except at user level 1 (for a novice).
547 3. ^X^C EXITS EMACS.
548 4. Viper supports multiple undo: `u' will undo. Typing `.' will repeat
549 undo. Another `u' changes direction.
550
551 6. Emacs Meta key is `C-\\' (in all modes) or `\\ ESC' (in Vi command mode).
552 On a window system, the best way is to use the Meta-key on your keyboard.
553 7. Try \\[keyboard-quit] and \\[abort-recursive-edit] repeatedly,if
554 something funny happens. This would abort the current editing command.
555
556 For more information on Viper:
557
558 a. Type `:help' in Vi command mode
559 b. Print Viper manual, found in ./etc/viper.dvi
560 c. Print the Quick Reference, found in ./etc/viperCard.dvi
561
562 To submit a bug report or to contact the author, type :submitReport in Vi
563 command mode. To shoo Viper away and return to pure Emacs (horror!), type:
564
565 M-x viper-go-away
566
567 This startup message appears whenever you load Viper, unless you type `y' now."
568 ))
569 (goto-char (point-min))
570 (if (y-or-n-p "Inhibit Viper startup message? ")
571 (viper-save-setting
572 'viper-inhibit-startup-message
573 "Viper startup message inhibited"
574 viper-custom-file-name t))
575 ;;(kill-buffer (current-buffer))
576 (message
577 "The last message is in buffer `Viper Startup Message'")
578 (sit-for 4)
579 ))
580 (viper-set-expert-level 'dont-change-unless)))
581
582 (or (memq major-mode viper-emacs-state-mode-list) ; don't switch to Vi
583 (memq major-mode viper-insert-state-mode-list) ; don't switch
584 (viper-change-state-to-vi)))))
585
586 \f
587 ;; This hook designed to enable Vi-style editing in comint-based modes."
588 (defun viper-comint-mode-hook ()
589 (setq require-final-newline nil
590 viper-ex-style-editing nil
591 viper-ex-style-motion nil)
592 (viper-change-state-to-insert))
593
594
595 ;; remove viper hooks from SYMBOL
596 (defun viper-remove-hooks (symbol)
597 (cond ((not (boundp symbol)) nil)
598 ((not (listp (eval symbol))) nil)
599 ((string-match "-hook" (symbol-name symbol))
600 (remove-hook symbol 'viper-mode)
601 (remove-hook symbol 'viper-change-state-to-emacs)
602 (remove-hook symbol 'viper-change-state-to-insert)
603 (remove-hook symbol 'viper-change-state-to-vi)
604 )))
605
606 ;; Remove local value in all existing buffers
607 ;; This doesn't delocalize vars (which would have been desirable)
608 (defun viper-delocalize-var (symbol)
609 (mapcar (function (lambda (buf)
610 (save-excursion
611 (set-buffer buf)
612 (kill-local-variable symbol))))
613 (buffer-list)))
614
615
616 (defun viper-go-away ()
617 "De-Viperize Emacs.
618 This function tries to do as good a job as possible. However, it may undo some
619 user customization, unrelated to Viper. For instance, if the user advised
620 `read-file-name', `describe-key', and some others, then this advice will be
621 undone.
622 It also doesn't undo some Viper settings. For instance, `minor-mode-map-alist'
623 remains buffer-local."
624 (interactive)
625
626 ;; restore non-viper vars
627 (setq-default
628 next-line-add-newlines
629 (viper-standard-value
630 'next-line-add-newlines viper-saved-non-viper-variables)
631 require-final-newline
632 (viper-standard-value
633 'require-final-newline viper-saved-non-viper-variables)
634 scroll-step
635 (viper-standard-value 'scroll-step viper-saved-non-viper-variables)
636 mode-line-buffer-identification
637 (viper-standard-value
638 'mode-line-buffer-identification viper-saved-non-viper-variables)
639 global-mode-string
640 (delq 'viper-mode-string global-mode-string))
641
642 (if viper-emacs-p
643 (setq-default
644 mark-even-if-inactive
645 (viper-standard-value
646 'mark-even-if-inactive viper-saved-non-viper-variables)))
647
648 ;; Ideally, we would like to be able to de-localize local variables
649 (viper-delocalize-var 'minor-mode-map-alist)
650 (viper-delocalize-var 'require-final-newline)
651
652
653 ;; deactivate all advices done by Viper.
654 (ad-deactivate-regexp "viper-")
655
656 (setq viper-mode nil)
657
658 (viper-delocalize-var 'viper-vi-minibuffer-minor-mode)
659 (viper-delocalize-var 'viper-insert-minibuffer-minor-mode)
660 (viper-delocalize-var 'viper-vi-intercept-minor-mode)
661 (viper-delocalize-var 'viper-insert-intercept-minor-mode)
662
663 (viper-delocalize-var 'viper-vi-local-user-minor-mode)
664 (viper-delocalize-var 'viper-vi-kbd-minor-mode)
665 (viper-delocalize-var 'viper-vi-global-user-minor-mode)
666 (viper-delocalize-var 'viper-vi-state-modifier-minor-mode)
667 (viper-delocalize-var 'viper-vi-diehard-minor-mode)
668 (viper-delocalize-var 'viper-vi-basic-minor-mode)
669
670 (viper-delocalize-var 'viper-replace-minor-mode)
671
672 (viper-delocalize-var 'viper-insert-local-user-minor-mode)
673 (viper-delocalize-var 'viper-insert-kbd-minor-mode)
674 (viper-delocalize-var 'viper-insert-global-user-minor-mode)
675 (viper-delocalize-var 'viper-insert-state-modifier-minor-mode)
676 (viper-delocalize-var 'viper-insert-diehard-minor-mode)
677 (viper-delocalize-var 'viper-insert-basic-minor-mode)
678
679 (viper-delocalize-var 'viper-emacs-intercept-minor-mode)
680 (viper-delocalize-var 'viper-emacs-local-user-minor-mode)
681 (viper-delocalize-var 'viper-emacs-kbd-minor-mode)
682 (viper-delocalize-var 'viper-emacs-global-user-minor-mode)
683 (viper-delocalize-var 'viper-emacs-state-modifier-minor-mode)
684
685 (viper-delocalize-var 'viper-current-state)
686 (viper-delocalize-var 'viper-mode-string)
687
688 (setq-default viper-vi-minibuffer-minor-mode nil
689 viper-insert-minibuffer-minor-mode nil
690 viper-vi-intercept-minor-mode nil
691 viper-insert-intercept-minor-mode nil
692
693 viper-vi-local-user-minor-mode nil
694 viper-vi-kbd-minor-mode nil
695 viper-vi-global-user-minor-mode nil
696 viper-vi-state-modifier-minor-mode nil
697 viper-vi-diehard-minor-mode nil
698 viper-vi-basic-minor-mode nil
699
700 viper-replace-minor-mode nil
701
702 viper-insert-local-user-minor-mode nil
703 viper-insert-kbd-minor-mode nil
704 viper-insert-global-user-minor-mode nil
705 viper-insert-state-modifier-minor-mode nil
706 viper-insert-diehard-minor-mode nil
707 viper-insert-basic-minor-mode nil
708
709 viper-emacs-intercept-minor-mode nil
710 viper-emacs-local-user-minor-mode nil
711 viper-emacs-kbd-minor-mode nil
712 viper-emacs-global-user-minor-mode nil
713 viper-emacs-state-modifier-minor-mode nil
714
715 viper-current-state 'emacs-state
716 viper-mode-string viper-emacs-state-id
717 )
718
719 ;; remove all hooks set by viper
720 (mapatoms 'viper-remove-hooks)
721 (remove-hook 'comint-mode-hook 'viper-comint-mode-hook)
722 (remove-hook 'minibuffer-setup-hook 'viper-minibuffer-setup-sentinel)
723 (remove-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
724
725 ;; unbind Viper mouse bindings
726 (viper-unbind-mouse-search-key)
727 (viper-unbind-mouse-insert-key)
728 ;; In emacs, we have to advice handle-switch-frame
729 ;; This advice is undone earlier, when all advices matchine "viper-" are
730 ;; deactivated.
731 (if viper-xemacs-p
732 (remove-hook 'mouse-leave-frame-hook 'viper-remember-current-frame))
733 ) ; end viper-go-away
734
735
736 ;; list of buffers that just changed their major mode
737 ;; used in a hack that triggers vi command mode whenever needed
738 (defvar viper-new-major-mode-buffer-list nil)
739
740 ;; set appropriate Viper state in buffers that changed major mode
741 (defun set-viper-state-in-major-mode ()
742 (mapcar
743 (function
744 (lambda (buf)
745 (if (viper-buffer-live-p buf)
746 (with-current-buffer buf
747 (cond ((and (memq major-mode viper-vi-state-mode-list)
748 (eq viper-current-state 'emacs-state))
749 (viper-mode))
750 ((memq major-mode viper-emacs-state-mode-list)
751 ;; not checking (eq viper-current-state 'emacs-state)
752 ;; because viper-current-state could have gotten it by
753 ;; default. we need viper-change-state-to-emacs here to have
754 ;; the keymaps take effect.
755 (viper-change-state-to-emacs))
756 ((and (memq major-mode viper-insert-state-mode-list)
757 (not (eq viper-current-state 'insert-state)))
758 (viper-change-state-to-insert))
759 )) ; with-current-buffer
760 ))) ; function
761 viper-new-major-mode-buffer-list)
762 ;; clear the list of bufs that changed major mode
763 (setq viper-new-major-mode-buffer-list nil)
764 ;; change the global value of hook
765 (remove-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode))
766
767 ;; sets up post-command-hook to turn viper-mode, if the current mode is
768 ;; fundamental
769 (defun viper-major-mode-change-sentinel ()
770 (save-match-data
771 (or (string-match "\*Minibuf-" (buffer-name))
772 (setq viper-new-major-mode-buffer-list
773 (cons (current-buffer) viper-new-major-mode-buffer-list))))
774 ;; change the global value of hook
775 (add-hook 'viper-post-command-hooks 'set-viper-state-in-major-mode t))
776
777
778
779 ;; This sets major mode hooks to make them come up in vi-state.
780 (defun viper-set-hooks ()
781 ;; It is of course a misnomer to call viper-mode a `major mode'.
782 ;; However, this has the effect that if the user didn't specify the
783 ;; default mode, new buffers that fall back on the default will come up
784 ;; in Fundamental Mode and Vi state.
785 (if (eq default-major-mode 'fundamental-mode)
786 (setq default-major-mode 'viper-mode))
787
788 (add-hook 'change-major-mode-hook 'viper-major-mode-change-sentinel)
789 (add-hook 'find-file-hooks 'set-viper-state-in-major-mode)
790
791 ;; keep this because many modes we don't know about use this hook
792 (defvar text-mode-hook)
793 (add-hook 'text-mode-hook 'viper-mode)
794
795 (defvar emerge-startup-hook)
796 (add-hook 'emerge-startup-hook 'viper-change-state-to-emacs)
797
798 ;; Tell vc-diff to put *vc* in Vi mode
799 (if (featurep 'vc)
800 (defadvice vc-diff (after viper-vc-ad activate)
801 "Force Vi state in VC diff buffer."
802 (viper-change-state-to-vi))
803 (eval-after-load
804 "vc"
805 '(defadvice vc-diff (after viper-vc-ad activate)
806 "Force Vi state in VC diff buffer."
807 (viper-change-state-to-vi))))
808
809 (eval-after-load
810 "emerge"
811 '(defadvice emerge-quit (after viper-emerge-advice activate)
812 "Run `viper-change-state-to-vi' after quitting emerge."
813 (viper-change-state-to-vi)))
814 ;; In case Emerge was loaded before Viper.
815 (defadvice emerge-quit (after viper-emerge-advice activate)
816 "Run `viper-change-state-to-vi' after quitting emerge."
817 (viper-change-state-to-vi))
818
819 ;; passwd.el sets up its own buffer, which turns up in Vi mode,
820 ;; thus overriding the local map. We don't need Vi mode here.
821 (eval-after-load
822 "passwd"
823 '(defadvice read-passwd-1 (before viper-passwd-ad activate)
824 "Switch to emacs state while reading password."
825 (viper-change-state-to-emacs)))
826
827 ;; Emacs shell, ange-ftp, and comint-based modes
828 (add-hook 'comint-mode-hook 'viper-comint-mode-hook) ; comint
829
830 (viper-set-emacs-state-searchstyle-macros nil 'dired-mode) ; dired
831 (viper-set-emacs-state-searchstyle-macros nil 'tar-mode) ; tar
832 (viper-set-emacs-state-searchstyle-macros nil 'mh-folder-mode) ; mhe
833 (viper-set-emacs-state-searchstyle-macros nil 'gnus-group-mode) ; gnus
834 (viper-set-emacs-state-searchstyle-macros nil 'gnus-summary-mode)
835 (viper-set-emacs-state-searchstyle-macros nil 'Info-mode) ; info
836 (viper-set-emacs-state-searchstyle-macros nil 'Buffer-menu-mode) ;buffer-menu
837
838 ;; Modify major modes according to viper-major-mode-modifier-list
839 (viper-apply-major-mode-modifiers)
840
841 ;; For RMAIL users.
842 ;; Put buf in Emacs state after edit.
843 (eval-after-load
844 "rmailedit"
845 '(defadvice rmail-cease-edit (after viper-rmail-advice activate)
846 "Switch to emacs state when done editing message."
847 (viper-change-state-to-emacs)))
848 ;; In case RMAIL was loaded before Viper.
849 (defadvice rmail-cease-edit (after viper-rmail-advice activate)
850 "Switch to emacs state when done editing message."
851 (viper-change-state-to-emacs))
852
853 ;; ISO accents
854 ;; Need to do it after loading iso-acc, or else this loading will wipe out
855 ;; the advice.
856 (eval-after-load
857 "iso-acc"
858 (defadvice iso-accents-mode (around viper-iso-accents-advice activate)
859 "Set viper-automatic-iso-accents to iso-accents-mode."
860 (let ((arg (ad-get-arg 0)))
861 ad-do-it
862 (setq viper-automatic-iso-accents
863 (if (eq viper-current-state 'vi-state)
864 (if arg
865 ;; if iso-accents-mode was called with positive arg, turn
866 ;; accents on
867 (> (prefix-numeric-value arg) 0)
868 ;; else: toggle viper-automatic-iso-accents
869 (not viper-automatic-iso-accents))
870 ;; other states: accept what iso-accents-mode has done
871 iso-accents-mode))
872 ;; turn off ISO accents in vi-state
873 (if (eq viper-current-state 'vi-state)
874 (viper-set-iso-accents-mode nil))
875 (if (memq viper-current-state '(vi-state insert-state replace-state))
876 (message "Viper ISO accents mode: %s"
877 (if viper-automatic-iso-accents "on" "off")))
878 )))
879
880 ;; International input methods
881 (if viper-emacs-p
882 (eval-after-load "mule-cmds"
883 (progn
884 (defadvice inactivate-input-method (after viper-mule-advice activate)
885 "Set viper-special-input-method to disable intl. input methods."
886 (viper-inactivate-input-method-action))
887 (defadvice activate-input-method (after viper-mule-advice activate)
888 "Set viper-special-input-method to enable intl. input methods."
889 (viper-activate-input-method-action))
890 ))
891 ;; XEmacs Although these hooks exist in Emacs, they don't seem to be always
892 ;; called on input-method activation/deactivation, so we the above advise
893 ;; functions instead.
894 (eval-after-load "mule-cmds"
895 (progn
896 (add-hook 'input-method-activate-hook
897 'viper-activate-input-method-action t)
898 (add-hook 'input-method-inactivate-hook
899 'viper-inactivate-input-method-action t)))
900 )
901 (eval-after-load "mule-cmds"
902 (defadvice toggle-input-method (around viper-mule-advice activate)
903 "Adjust input-method toggling in vi-state."
904 (if (and viper-special-input-method (eq viper-current-state 'vi-state))
905 (viper-inactivate-input-method)
906 ad-do-it)))
907
908 ) ; viper-set-hooks
909
910
911 ;; these are primarily advices and Vi-ish variable settings
912 (defun viper-non-hook-settings ()
913
914 ;; This var is not local in Emacs, so we make it local. It must be local
915 ;; because although the stack of minor modes can be the same for all buffers,
916 ;; the associated *keymaps* can be different. In Viper,
917 ;; viper-vi-local-user-map, viper-insert-local-user-map, and others can have
918 ;; different keymaps for different buffers. Also, the keymaps associated
919 ;; with viper-vi/insert-state-modifier-minor-mode can be different.
920 (make-variable-buffer-local 'minor-mode-map-alist)
921
922 ;; Viper changes the default mode-line-buffer-identification
923 (setq-default mode-line-buffer-identification '(" %b"))
924
925 ;; setup emacs-supported vi-style feel
926 (setq next-line-add-newlines nil
927 require-final-newline t)
928
929 (make-variable-buffer-local 'require-final-newline)
930
931 ;; don't bark when mark is inactive
932 (if viper-emacs-p
933 (setq mark-even-if-inactive t))
934
935 (setq scroll-step 1)
936
937 ;; Variable displaying the current Viper state in the mode line.
938 (viper-deflocalvar viper-mode-string viper-emacs-state-id)
939 (or (memq 'viper-mode-string global-mode-string)
940 (setq global-mode-string
941 (append '("" viper-mode-string) (cdr global-mode-string))))
942
943 (defadvice read-key-sequence (around viper-read-keyseq-ad activate)
944 "Harness to work for Viper. This advice is harmless---don't worry!"
945 (let (inhibit-quit event keyseq)
946 (setq keyseq ad-do-it)
947 (setq event (if viper-xemacs-p
948 (elt keyseq 0) ; XEmacs returns vector of events
949 (elt (listify-key-sequence keyseq) 0)))
950 (if (viper-ESC-event-p event)
951 (let (unread-command-events)
952 (viper-set-unread-command-events keyseq)
953 (if (viper-fast-keysequence-p)
954 (let ((viper-vi-global-user-minor-mode nil)
955 (viper-vi-local-user-minor-mode nil)
956 (viper-replace-minor-mode nil) ; actually unnecessary
957 (viper-insert-global-user-minor-mode nil)
958 (viper-insert-local-user-minor-mode nil))
959 (setq keyseq ad-do-it))
960 (setq keyseq ad-do-it))))
961 keyseq))
962
963 (defadvice describe-key (before viper-read-keyseq-ad protect activate)
964 "Force to read key via `read-key-sequence'."
965 (interactive (list (viper-events-to-keys
966 (read-key-sequence "Describe key: ")))))
967
968 (defadvice describe-key-briefly
969 (before viper-read-keyseq-ad protect activate)
970 "Force to read key via `read-key-sequence'."
971 (interactive (list (viper-events-to-keys
972 (read-key-sequence "Describe key briefly: ")))))
973
974
975 (defadvice find-file (before viper-add-suffix-advice activate)
976 "Use `read-file-name' for reading arguments."
977 (interactive (cons (read-file-name "Find file: " nil default-directory)
978 ;; if Mule and prefix argument, ask for coding system
979 (cond ((and viper-emacs-p
980 (boundp 'MULE)) ; Emacs 20 with MULE
981 nil)
982 ((and viper-xemacs-p
983 (featurep 'mule)) ; XEmacs 20 with MULE
984 (list
985 (and current-prefix-arg
986 (read-coding-system
987 "Coding-system: "))))
988 )
989 )))
990
991 (defadvice find-file-other-window (before viper-add-suffix-advice activate)
992 "Use `read-file-name' for reading arguments."
993 (interactive (cons (read-file-name "Find file in other window: "
994 nil default-directory)
995 ;; if Mule and prefix argument, ask for coding system
996 (cond ((and viper-emacs-p
997 (boundp 'MULE)) ; Emacs 20 with MULE
998 nil)
999 ((and viper-xemacs-p
1000 (featurep 'mule)) ; XEmacs 20 with MULE
1001 (list
1002 (and current-prefix-arg
1003 (read-coding-system
1004 "Coding-system: "))))
1005 )
1006 )))
1007
1008
1009 (defadvice find-file-other-frame (before viper-add-suffix-advice activate)
1010 "Use `read-file-name' for reading arguments."
1011 (interactive (cons (read-file-name "Find file in other frame: "
1012 nil default-directory)
1013 ;; if Mule and prefix argument, ask for coding system
1014 (cond ((and viper-emacs-p
1015 (boundp 'MULE)) ; Emacs 20 with MULE
1016 nil)
1017 ((and viper-xemacs-p
1018 (featurep 'mule)) ; XEmacs 20 with MULE
1019 (list
1020 (and current-prefix-arg
1021 (read-coding-system
1022 "Coding-system: "))))
1023 )
1024 )))
1025
1026
1027 (defadvice read-file-name (around viper-suffix-advice activate)
1028 "Tell `exit-minibuffer' to run `viper-file-add-suffix' as a hook."
1029 (let ((viper-minibuffer-exit-hook
1030 (append viper-minibuffer-exit-hook
1031 '(viper-minibuffer-trim-tail viper-file-add-suffix))))
1032 ad-do-it))
1033
1034 (defadvice start-kbd-macro (after viper-kbd-advice activate)
1035 "Remove Viper's intercepting bindings for C-x ).
1036 This may be needed if the previous `:map' command terminated abnormally."
1037 (define-key viper-vi-intercept-map "\C-x)" nil)
1038 (define-key viper-insert-intercept-map "\C-x)" nil)
1039 (define-key viper-emacs-intercept-map "\C-x)" nil))
1040
1041 ;; catch frame switching event
1042 (if (viper-window-display-p)
1043 (if viper-xemacs-p
1044 (add-hook 'mouse-leave-frame-hook
1045 'viper-remember-current-frame)
1046 (defadvice handle-switch-frame (before viper-frame-advice activate)
1047 "Remember the selected frame before the switch-frame event."
1048 (viper-remember-current-frame (selected-frame)))) )
1049
1050 ) ; end viper-non-hook-settings
1051
1052 \f
1053 ;; Ask only if this-command/last-command are nil, i.e., when loading
1054 (cond ((and (eq viper-mode 'ask) (null this-command) (null last-command))
1055 (save-window-excursion
1056 (with-output-to-temp-buffer " *viper-info*"
1057 (princ "
1058 You have loaded Viper, and are about to Viperize your emacs!
1059
1060 Viper is a Package for Emacs Rebels and a venomous VI PERil,
1061
1062 It's time to decide: to Viperize or not to Viperize...
1063
1064 If you wish to Viperize AND make this your way of life, please put
1065
1066 (setq viper-mode t)
1067 (require 'viper)
1068
1069 in your .emacs file (preferably, close to the top).
1070 These two lines must come in the order given.
1071
1072 ** Viper users:
1073 **** The startup file name has been changed from .vip to .viper
1074 **** All vip-* style names have been converted to viper-* style."))
1075 (if (y-or-n-p "Viperize? ")
1076 (setq viper-mode t)
1077 (setq viper-mode nil))
1078 (message "")
1079 (kill-buffer " *viper-info*")))
1080
1081 ;; If viper-mode is t, then just continue. Viper will kick in.
1082 ((eq viper-mode t))
1083 ;; Otherwise, it was asking Viper was not loaded through .emacs
1084 ;; In this case, it was either through M-x viper-mode or via something
1085 ;; else, like the custom widget. If Viper was loaded through
1086 ;; M-x viper-mode, then viper will kick in anyway.
1087 (t (setq viper-mode nil)))
1088
1089 (defun viper-load-custom-file ()
1090 (if (and (file-exists-p viper-custom-file-name)
1091 (not noninteractive))
1092 (load viper-custom-file-name)))
1093
1094
1095
1096 \f
1097 ;; Get viper standard value of SYMBOL. If symbol is customized, get its
1098 ;; standard value. Otherwise, get the value saved in the alist STORAGE. If
1099 ;; STORAGE is nil, use viper-saved-user-settings.
1100 (defun viper-standard-value (symbol &optional storage)
1101 (or (eval (car (get symbol 'customized-value)))
1102 (eval (car (get symbol 'saved-value)))
1103 (nth 1 (assoc symbol (or storage viper-saved-user-settings)))))
1104
1105
1106
1107 ;; save non-viper vars that Viper might change
1108 (if (null viper-saved-non-viper-variables)
1109 (setq viper-saved-non-viper-variables
1110 (list
1111 (cons 'next-line-add-newlines (list next-line-add-newlines))
1112 (cons 'require-final-newline (list require-final-newline))
1113 (cons 'scroll-step (list scroll-step))
1114 (cons 'mode-line-buffer-identification
1115 (list (default-value 'mode-line-buffer-identification)))
1116 (cons 'global-mode-string (list global-mode-string))
1117 (if viper-emacs-p
1118 (cons 'mark-even-if-inactive (list mark-even-if-inactive)))
1119 )))
1120
1121
1122 ;; Set some useful macros, advices
1123 ;; These must be BEFORE ~/.viper is loaded,
1124 ;; so the user can unrecord them in ~/.viper.
1125 (if viper-mode
1126 (progn
1127 ;; set advices and some variables that give emacs Vi look.
1128 (viper-non-hook-settings)
1129
1130 ;; repeat the 2nd previous command without rotating the command history
1131 (viper-record-kbd-macro
1132 (vector viper-repeat-from-history-key '\1) 'vi-state
1133 [(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)
1134 ;; repeat the 3d previous command without rotating the command history
1135 (viper-record-kbd-macro
1136 (vector viper-repeat-from-history-key '\2) 'vi-state
1137 [(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)
1138
1139 ;; set macros for toggling case sensitivity and regexp search
1140 (viper-set-searchstyle-toggling-macros nil)
1141 ;; Make %%% toggle parsing comments for matching parentheses
1142 (viper-set-parsing-style-toggling-macro nil)
1143
1144 ;; ~/.viper is loaded if exists
1145 (viper-load-custom-file)
1146
1147 ;; should be after loading custom file to avoid the pesky msg that
1148 ;; mouse-search/insert keys are already bound
1149 (viper-bind-mouse-search-key)
1150 (viper-bind-mouse-insert-key)
1151 ))
1152
1153
1154 \f
1155 ;; Applying Viper customization -- runs after (load .viper)
1156
1157 ;; Save user settings or Viper defaults for vars controled by
1158 ;; viper-expert-level
1159 (if (null viper-saved-user-settings)
1160 (setq viper-saved-user-settings
1161 (list (cons 'viper-want-ctl-h-help (list viper-want-ctl-h-help))
1162 (cons 'viper-always (list viper-always))
1163 (cons 'viper-no-multiple-ESC (list viper-no-multiple-ESC))
1164 (cons 'viper-ex-style-motion (list viper-ex-style-motion))
1165 (cons 'viper-ex-style-editing
1166 (list viper-ex-style-editing))
1167 (cons 'viper-want-emacs-keys-in-vi
1168 (list viper-want-emacs-keys-in-vi))
1169 (cons 'viper-electric-mode (list viper-electric-mode))
1170 (cons 'viper-want-emacs-keys-in-insert
1171 (list viper-want-emacs-keys-in-insert))
1172 (cons 'viper-re-search (list viper-re-search)))))
1173
1174
1175 (if viper-mode
1176 (progn
1177 (viper-set-minibuffer-style)
1178 (if viper-buffer-search-char
1179 (viper-buffer-search-enable))
1180 (viper-update-syntax-classes 'set-default)
1181 ))
1182
1183 \f
1184 ;;; Familiarize Viper with some minor modes that have their own keymaps
1185 (if viper-mode
1186 (progn
1187 (viper-harness-minor-mode "compile")
1188 (viper-harness-minor-mode "outline")
1189 (viper-harness-minor-mode "allout")
1190 (viper-harness-minor-mode "xref")
1191 (viper-harness-minor-mode "lmenu")
1192 (viper-harness-minor-mode "vc")
1193 (viper-harness-minor-mode "ltx-math") ; LaTeX-math-mode in AUC-TeX, which
1194 (viper-harness-minor-mode "latex") ; sits in one of these two files
1195 (viper-harness-minor-mode "cyrillic")
1196 (viper-harness-minor-mode "russian")
1197 (viper-harness-minor-mode "view-less")
1198 (viper-harness-minor-mode "view")
1199 (viper-harness-minor-mode "reftex")
1200 ))
1201
1202
1203 ;; Intercept maps could go in viper-keym.el
1204 ;; We keep them here in case someone redefines them in ~/.viper
1205
1206 (define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1207 (define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1208
1209 ;; This is taken care of by viper-insert-global-user-map.
1210 ;;(define-key viper-replace-map viper-ESC-key 'viper-intercept-ESC-key)
1211
1212
1213 ;; The default viper-toggle-key is \C-z; for the novice, it suspends or
1214 ;; iconifies Emacs
1215 (define-key viper-vi-intercept-map viper-toggle-key 'viper-toggle-key-action)
1216 (define-key
1217 viper-emacs-intercept-map viper-toggle-key 'viper-change-state-to-vi)
1218
1219 ;;; Escape from Emacs and Insert modes to Vi for one command
1220 (define-key
1221 viper-emacs-intercept-map "\C-c\\" 'viper-escape-to-vi)
1222 (define-key
1223 viper-insert-intercept-map "\C-c\\" 'viper-escape-to-vi)
1224
1225 (if viper-mode
1226 (setq-default viper-emacs-intercept-minor-mode t
1227 viper-emacs-local-user-minor-mode t
1228 viper-emacs-global-user-minor-mode t
1229 viper-emacs-kbd-minor-mode t
1230 viper-emacs-state-modifier-minor-mode t))
1231 (if (and viper-mode (eq viper-current-state 'emacs-state))
1232 (setq viper-emacs-intercept-minor-mode t
1233 viper-emacs-local-user-minor-mode t
1234 viper-emacs-global-user-minor-mode t
1235 viper-emacs-kbd-minor-mode t
1236 viper-emacs-state-modifier-minor-mode t))
1237
1238
1239 (if (and viper-mode
1240 (or viper-always
1241 (and (< viper-expert-level 5) (> viper-expert-level 0))))
1242 (viper-set-hooks))
1243
1244 ;; Let all minor modes take effect after loading
1245 ;; this may not be enough, so we also set default minor-mode-alist.
1246 ;; Without setting the default, new buffers that come up in emacs mode have
1247 ;; minor-mode-map-alist = nil, unless we call viper-change-state-*
1248 (if (and viper-mode (eq viper-current-state 'emacs-state))
1249 (progn
1250 (viper-change-state-to-emacs)
1251 (setq-default minor-mode-map-alist minor-mode-map-alist)
1252 ))
1253
1254 (if (and viper-mode (memq major-mode viper-vi-state-mode-list))
1255 (viper-mode))
1256
1257
1258 (run-hooks 'viper-load-hook) ; the last chance to change something
1259
1260 (provide 'viper)
1261
1262
1263 ;;; Local Variables:
1264 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1265 ;;; End:
1266
1267 ;;; viper.el ends here