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