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