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