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