(encode_coding_iso2022): Don't skip a code following some invalid code.
[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
c004db97 11(defconst viper-version "3.004 (Polyglot) of November 11, 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
c004db97 534 (delq 'viper-mode-string global-mode-string))
5489c3d3 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
c004db97
MK
579 (viper-delocalize-var 'viper-current-state)
580 (viper-delocalize-var 'viper-mode-string)
581
8626cfa2
MK
582 (setq-default viper-vi-minibuffer-minor-mode nil
583 viper-insert-minibuffer-minor-mode nil
584 viper-vi-intercept-minor-mode nil
585 viper-insert-intercept-minor-mode nil
1e70790f 586
8626cfa2
MK
587 viper-vi-local-user-minor-mode nil
588 viper-vi-kbd-minor-mode nil
589 viper-vi-global-user-minor-mode nil
590 viper-vi-state-modifier-minor-mode nil
591 viper-vi-diehard-minor-mode nil
592 viper-vi-basic-minor-mode nil
1e70790f 593
8626cfa2 594 viper-replace-minor-mode nil
1e70790f 595
8626cfa2
MK
596 viper-insert-local-user-minor-mode nil
597 viper-insert-kbd-minor-mode nil
598 viper-insert-global-user-minor-mode nil
599 viper-insert-state-modifier-minor-mode nil
600 viper-insert-diehard-minor-mode nil
601 viper-insert-basic-minor-mode nil
602
603 viper-emacs-intercept-minor-mode nil
604 viper-emacs-local-user-minor-mode nil
605 viper-emacs-kbd-minor-mode nil
606 viper-emacs-global-user-minor-mode nil
607 viper-emacs-state-modifier-minor-mode nil
c004db97
MK
608
609 viper-current-state 'emacs-state
610 viper-mode-string viper-emacs-state-id
1e70790f
MK
611 )
612
613 ;; remove all hooks set by viper
614 (mapatoms 'viper-remove-hooks)
8626cfa2
MK
615 (remove-hook 'comint-mode-hook 'viper-comint-mode-hook)
616 (remove-hook 'minibuffer-setup-hook 'viper-minibuffer-setup-sentinel)
617
618 ;; unbind Viper mouse bindings
619 (viper-unbind-mouse-search-key)
620 (viper-unbind-mouse-insert-key)
41497c90
MK
621 ;; In emacs, we have to advice handle-switch-frame
622 ;; This advice is undone earlier, when all advices matchine "viper-" are
623 ;; deactivated.
624 (if viper-xemacs-p
625 (remove-hook 'mouse-leave-frame-hook 'viper-remember-current-frame))
626 ) ; end viper-go-away
1e70790f
MK
627
628
629
630
04090c34 631;; This sets major mode hooks to make them come up in vi-state.
8626cfa2 632(defun viper-set-hooks ()
6c2e12f4
KH
633
634 ;; It is of course a misnomer to call viper-mode a `major mode'.
635 ;; However, this has the effect that if the user didn't specify the
636 ;; default mode, new buffers that fall back on the default will come up
637 ;; in Fundamental Mode and Vi state.
638 (setq default-major-mode 'viper-mode)
639
4af0c23b 640 ;; The following major modes should come up in vi-state
8626cfa2
MK
641 (defadvice fundamental-mode (after viper-fundamental-mode-ad activate)
642 "Run `viper-change-state-to-vi' on entry."
643 (viper-change-state-to-vi))
4af0c23b 644
bbe6126c 645 (defvar makefile-mode-hook)
151496c0
MK
646 (add-hook 'makefile-mode-hook 'viper-mode)
647
73f52958 648 ;; Help mode is now for viewing only
bbe6126c 649 (defvar help-mode-hook)
73f52958
MK
650 (add-hook 'help-mode-hook 'viper-change-state-to-emacs)
651 (viper-modify-major-mode 'help-mode 'emacs-state viper-slash-and-colon-map)
151496c0 652
bbe6126c 653 (defvar awk-mode-hook)
151496c0 654 (add-hook 'awk-mode-hook 'viper-mode)
6c2e12f4 655
bbe6126c 656 (defvar html-mode-hook)
d695b318 657 (add-hook 'html-mode-hook 'viper-mode)
bbe6126c 658 (defvar html-helper-mode-hook)
151496c0 659 (add-hook 'html-helper-mode-hook 'viper-mode)
e36a387d 660
34da0a2b
MK
661 (defvar java-mode-hook)
662 (add-hook 'java-mode-hook 'viper-mode)
151496c0 663
1e70790f
MK
664 (defvar javascript-mode-hook)
665 (add-hook 'javascript-mode-hook 'viper-mode)
666
bbe6126c 667 (defvar emacs-lisp-mode-hook)
151496c0 668 (add-hook 'emacs-lisp-mode-hook 'viper-mode)
bbe6126c 669 (defvar lisp-mode-hook)
6c2e12f4 670 (add-hook 'lisp-mode-hook 'viper-mode)
e36a387d
MK
671 (defvar lisp-interaction-mode-hook)
672 (add-hook 'lisp-interaction-mode-hook 'viper-mode)
6c2e12f4 673
bbe6126c 674 (defvar bibtex-mode-hook)
6c2e12f4
KH
675 (add-hook 'bibtex-mode-hook 'viper-mode)
676
bbe6126c 677 (defvar cc-mode-hook)
6c2e12f4
KH
678 (add-hook 'cc-mode-hook 'viper-mode)
679
bbe6126c 680 (defvar c-mode-hook)
6c2e12f4
KH
681 (add-hook 'c-mode-hook 'viper-mode)
682
bbe6126c 683 (defvar c++-mode-hook)
6c2e12f4 684 (add-hook 'c++-mode-hook 'viper-mode)
bbe6126c
MK
685
686 (defvar fortran-mode-hook)
e36a387d
MK
687 (add-hook 'fortran-mode-hook 'viper-mode)
688 (defvar f90-mode-hook)
689 (add-hook 'f90-mode-hook 'viper-mode)
bf5d92c5
MK
690
691 (defvar basic-mode-hook)
e36a387d 692 (add-hook 'basic-mode-hook 'viper-mode)
bf5d92c5 693 (defvar bat-mode-hook)
e36a387d 694 (add-hook 'bat-mode-hook 'viper-mode)
f4ce0bd7
MK
695
696 (defvar asm-mode-hook)
697 (add-hook 'asm-mode-hook 'viper-mode)
698
699 (defvar prolog-mode-hook)
700 (add-hook 'prolog-mode-hook 'viper-mode)
6c2e12f4 701
bbe6126c 702 (defvar text-mode-hook)
6c2e12f4
KH
703 (add-hook 'text-mode-hook 'viper-mode)
704
705 (add-hook 'completion-list-mode-hook 'viper-mode)
706 (add-hook 'compilation-mode-hook 'viper-mode)
151496c0 707
1e70790f
MK
708 (defvar perl-mode-hook)
709 (add-hook 'perl-mode-hook 'viper-mode)
710
711 (defvar tcl-mode-hook)
712 (add-hook 'tcl-mode-hook 'viper-mode)
713
714 (defvar python-mode-hook)
715 (add-hook 'python-mode-hook 'viper-mode)
6c2e12f4 716
bbe6126c 717 (defvar emerge-startup-hook)
8626cfa2 718 (add-hook 'emerge-startup-hook 'viper-change-state-to-emacs)
34da0a2b
MK
719
720 ;; Tell vc-diff to put *vc* in Vi mode
721 (if (featurep 'vc)
8626cfa2 722 (defadvice vc-diff (after viper-vc-ad activate)
34da0a2b 723 "Force Vi state in VC diff buffer."
8626cfa2
MK
724 (viper-change-state-to-vi))
725 (eval-after-load
34da0a2b 726 "vc"
8626cfa2 727 '(defadvice vc-diff (after viper-vc-ad activate)
34da0a2b 728 "Force Vi state in VC diff buffer."
8626cfa2 729 (viper-change-state-to-vi))))
34da0a2b 730
8626cfa2 731 (eval-after-load
4af0c23b 732 "emerge"
8626cfa2
MK
733 '(defadvice emerge-quit (after viper-emerge-advice activate)
734 "Run `viper-change-state-to-vi' after quitting emerge."
735 (viper-change-state-to-vi)))
6c2e12f4 736 ;; In case Emerge was loaded before Viper.
8626cfa2
MK
737 (defadvice emerge-quit (after viper-emerge-advice activate)
738 "Run `viper-change-state-to-vi' after quitting emerge."
739 (viper-change-state-to-vi))
6c2e12f4 740
6c2e12f4 741 ;; passwd.el sets up its own buffer, which turns up in Vi mode,
27571f90 742 ;; thus overriding the local map. We don't need Vi mode here.
8626cfa2 743 (eval-after-load
6c2e12f4 744 "passwd"
8626cfa2 745 '(defadvice read-passwd-1 (before viper-passwd-ad activate)
4af0c23b 746 "Switch to emacs state while reading password."
8626cfa2 747 (viper-change-state-to-emacs)))
6c2e12f4 748
4af0c23b 749 ;; Emacs shell, ange-ftp, and comint-based modes
bbe6126c 750 (defvar comint-mode-hook)
8626cfa2
MK
751 (viper-modify-major-mode
752 'comint-mode 'insert-state viper-comint-mode-modifier-map)
753 (viper-modify-major-mode
754 'comint-mode 'vi-state viper-comint-mode-modifier-map)
755 (viper-modify-major-mode
756 'shell-mode 'insert-state viper-comint-mode-modifier-map)
757 (viper-modify-major-mode
758 'shell-mode 'vi-state viper-comint-mode-modifier-map)
bf5d92c5 759 ;; ange-ftp in XEmacs
8626cfa2
MK
760 (viper-modify-major-mode
761 'ange-ftp-shell-mode 'insert-state viper-comint-mode-modifier-map)
762 (viper-modify-major-mode
763 'ange-ftp-shell-mode 'vi-state viper-comint-mode-modifier-map)
bf5d92c5 764 ;; ange-ftp in Emacs
8626cfa2
MK
765 (viper-modify-major-mode
766 'internal-ange-ftp-mode 'insert-state viper-comint-mode-modifier-map)
767 (viper-modify-major-mode
768 'internal-ange-ftp-mode 'vi-state viper-comint-mode-modifier-map)
bf5d92c5 769 ;; set hook
8626cfa2 770 (add-hook 'comint-mode-hook 'viper-comint-mode-hook)
6c2e12f4
KH
771
772 ;; Shell scripts
bbe6126c 773 (defvar sh-mode-hook)
6c2e12f4 774 (add-hook 'sh-mode-hook 'viper-mode)
bbe6126c 775 (defvar ksh-mode-hook)
151496c0 776 (add-hook 'ksh-mode-hook 'viper-mode)
6c2e12f4
KH
777
778 ;; Dired
8626cfa2
MK
779 (viper-modify-major-mode 'dired-mode 'emacs-state viper-dired-modifier-map)
780 (viper-set-emacs-state-searchstyle-macros nil 'dired-mode)
781 (add-hook 'dired-mode-hook 'viper-change-state-to-emacs)
6c2e12f4 782
bf5d92c5 783 ;; Tar
8626cfa2
MK
784 (viper-modify-major-mode 'tar-mode 'emacs-state viper-slash-and-colon-map)
785 (viper-set-emacs-state-searchstyle-macros nil 'tar-mode)
bf5d92c5 786
34da0a2b 787 ;; MH-E
8626cfa2
MK
788 (viper-modify-major-mode
789 'mh-folder-mode 'emacs-state viper-slash-and-colon-map)
790 (viper-set-emacs-state-searchstyle-macros nil 'mh-folder-mode)
34da0a2b 791 ;; changing state to emacs is needed so the preceding will take hold
8626cfa2 792 (add-hook 'mh-folder-mode-hook 'viper-change-state-to-emacs)
34da0a2b
MK
793 (add-hook 'mh-show-mode-hook 'viper-mode)
794
795 ;; Gnus
8626cfa2
MK
796 (viper-modify-major-mode
797 'gnus-group-mode 'emacs-state viper-slash-and-colon-map)
798 (viper-set-emacs-state-searchstyle-macros nil 'gnus-group-mode)
799 (viper-modify-major-mode
800 'gnus-summary-mode 'emacs-state viper-slash-and-colon-map)
801 (viper-set-emacs-state-searchstyle-macros nil 'gnus-summary-mode)
34da0a2b 802 ;; changing state to emacs is needed so the preceding will take hold
8626cfa2
MK
803 (add-hook 'gnus-group-mode-hook 'viper-change-state-to-emacs)
804 (add-hook 'gnus-summary-mode-hook 'viper-change-state-to-emacs)
34da0a2b
MK
805 (add-hook 'gnus-article-mode-hook 'viper-mode)
806
807 ;; Info
8626cfa2
MK
808 (viper-modify-major-mode 'Info-mode 'emacs-state viper-slash-and-colon-map)
809 (viper-set-emacs-state-searchstyle-macros nil 'Info-mode)
34da0a2b 810 ;; Switching to emacs is needed so the above will take hold
8626cfa2 811 (defadvice Info-mode (after viper-Info-ad activate)
34da0a2b 812 "Switch to emacs mode."
8626cfa2 813 (viper-change-state-to-emacs))
34da0a2b
MK
814
815 ;; Buffer menu
8626cfa2
MK
816 (viper-modify-major-mode
817 'Buffer-menu-mode 'emacs-state viper-slash-and-colon-map)
818 (viper-set-emacs-state-searchstyle-macros nil 'Buffer-menu-mode)
34da0a2b 819 ;; Switching to emacs is needed so the above will take hold
8626cfa2 820 (defadvice Buffer-menu-mode (after viper-Buffer-menu-ad activate)
34da0a2b 821 "Switch to emacs mode."
8626cfa2 822 (viper-change-state-to-emacs))
34da0a2b
MK
823
824 ;; View mode
f4ce0bd7
MK
825 (defvar view-mode-hook)
826 (defvar view-hook)
8626cfa2
MK
827 (add-hook 'view-hook 'viper-change-state-to-emacs)
828 (add-hook 'view-mode-hook 'viper-change-state-to-emacs)
6c2e12f4
KH
829
830 ;; For VM users.
831 ;; Put summary and other VM buffers in Emacs state.
bbe6126c
MK
832 (defvar vm-mode-hooks)
833 (defvar vm-summary-mode-hooks)
8626cfa2
MK
834 (add-hook 'vm-mode-hooks 'viper-change-state-to-emacs)
835 (add-hook 'vm-summary-mode-hooks 'viper-change-state-to-emacs)
6c2e12f4
KH
836
837 ;; For RMAIL users.
838 ;; Put buf in Emacs state after edit.
8626cfa2 839 (eval-after-load
6c2e12f4 840 "rmailedit"
8626cfa2 841 '(defadvice rmail-cease-edit (after viper-rmail-advice activate)
4af0c23b 842 "Switch to emacs state when done editing message."
8626cfa2 843 (viper-change-state-to-emacs)))
6c2e12f4 844 ;; In case RMAIL was loaded before Viper.
8626cfa2 845 (defadvice rmail-cease-edit (after viper-rmail-advice activate)
4af0c23b 846 "Switch to emacs state when done editing message."
8626cfa2 847 (viper-change-state-to-emacs))
34317da2
MK
848
849 ;; ISO accents
850 ;; Need to do it after loading iso-acc, or else this loading will wipe out
851 ;; the advice.
852 (eval-after-load
853 "iso-acc"
854 (defadvice iso-accents-mode (around viper-iso-accents-advice activate)
855 "Set viper-automatic-iso-accents to iso-accents-mode."
856 (let ((arg (ad-get-arg 0)))
857 ad-do-it
858 (setq viper-automatic-iso-accents
859 (if (eq viper-current-state 'vi-state)
860 (if arg
861 ;; if iso-accents-mode was called with positive arg, turn
862 ;; accents on
863 (> (prefix-numeric-value arg) 0)
864 ;; else: toggle viper-automatic-iso-accents
865 (not viper-automatic-iso-accents))
866 ;; other states: accept what iso-accents-mode has done
867 iso-accents-mode))
868 ;; turn off ISO accents in vi-state
869 (if (eq viper-current-state 'vi-state)
870 (viper-set-iso-accents-mode nil))
871 (if (memq viper-current-state '(vi-state insert-state replace-state))
872 (message "Viper ISO accents mode: %s"
873 (if viper-automatic-iso-accents "on" "off")))
874 )))
875
876 ;; International input methods
877 (if viper-emacs-p
878 (eval-after-load "mule-cmds"
879 (progn
880 (defadvice inactivate-input-method (after viper-mule-advice activate)
881 "Set viper-special-input-method to disable intl. input methods."
882 (viper-inactivate-input-method-action))
883 (defadvice activate-input-method (after viper-mule-advice activate)
884 "Set viper-special-input-method to enable intl. input methods."
885 (viper-activate-input-method-action))
886 ))
887 ;; XEmacs Although these hooks exist in Emacs, they don't seem to be always
888 ;; called on input-method activation/deactivation, so we the above advise
889 ;; functions instead.
890 (eval-after-load "mule-cmds"
891 (progn
892 (add-hook 'input-method-activate-hook
893 'viper-activate-input-method-action t)
894 (add-hook 'input-method-inactivate-hook
895 'viper-inactivate-input-method-action t)))
896 )
897 (eval-after-load "mule-cmds"
898 (defadvice toggle-input-method (around viper-mule-advice activate)
899 "Adjust input-method toggling in vi-state."
900 (if (and viper-special-input-method (eq viper-current-state 'vi-state))
901 (viper-inactivate-input-method)
902 ad-do-it)))
903
8626cfa2 904 ) ; viper-set-hooks
726e270f 905
e36a387d
MK
906
907;; these are primarily advices and Vi-ish variable settings
8626cfa2
MK
908(defun viper-non-hook-settings ()
909
910 ;; This var is not local in Emacs, so we make it local. It must be local
911 ;; because although the stack of minor modes can be the same for all buffers,
912 ;; the associated *keymaps* can be different. In Viper,
913 ;; viper-vi-local-user-map, viper-insert-local-user-map, and others can have
914 ;; different keymaps for different buffers. Also, the keymaps associated
915 ;; with viper-vi/insert-state-modifier-minor-mode can be different.
e36a387d
MK
916 (make-variable-buffer-local 'minor-mode-map-alist)
917
918 ;; Viper changes the default mode-line-buffer-identification
919 (setq-default mode-line-buffer-identification '(" %b"))
920
921 ;; setup emacs-supported vi-style feel
922 (setq next-line-add-newlines nil
923 require-final-newline t)
924
925 (make-variable-buffer-local 'require-final-newline)
926
927 ;; don't bark when mark is inactive
8626cfa2 928 (if viper-emacs-p
5489c3d3 929 (setq mark-even-if-inactive t))
e36a387d
MK
930
931 (setq scroll-step 1)
932
933 ;; Variable displaying the current Viper state in the mode line.
8626cfa2
MK
934 (viper-deflocalvar viper-mode-string viper-emacs-state-id)
935 (or (memq 'viper-mode-string global-mode-string)
e36a387d 936 (setq global-mode-string
8626cfa2 937 (append '("" viper-mode-string) (cdr global-mode-string))))
e36a387d 938
8626cfa2 939 (defadvice read-key-sequence (around viper-read-keyseq-ad activate)
e36a387d
MK
940 "Harness to work for Viper. This advice is harmless---don't worry!"
941 (let (inhibit-quit event keyseq)
942 (setq keyseq ad-do-it)
8626cfa2 943 (setq event (if viper-xemacs-p
e36a387d
MK
944 (elt keyseq 0) ; XEmacs returns vector of events
945 (elt (listify-key-sequence keyseq) 0)))
8626cfa2 946 (if (viper-ESC-event-p event)
e36a387d 947 (let (unread-command-events)
8626cfa2
MK
948 (viper-set-unread-command-events keyseq)
949 (if (viper-fast-keysequence-p)
950 (let ((viper-vi-global-user-minor-mode nil)
951 (viper-vi-local-user-minor-mode nil)
952 (viper-replace-minor-mode nil) ; actually unnecessary
953 (viper-insert-global-user-minor-mode nil)
954 (viper-insert-local-user-minor-mode nil))
e36a387d
MK
955 (setq keyseq ad-do-it))
956 (setq keyseq ad-do-it))))
957 keyseq))
958
8626cfa2 959 (defadvice describe-key (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: ")))))
963
8626cfa2
MK
964 (defadvice describe-key-briefly
965 (before viper-read-keyseq-ad protect activate)
e36a387d 966 "Force to read key via `read-key-sequence'."
8626cfa2 967 (interactive (list (viper-events-to-keys
e36a387d
MK
968 (read-key-sequence "Describe key briefly: ")))))
969
970
96dffd25
MK
971 ;; This is now done in viper-minibuffer-exit-hook
972 ;;;; Advice for use in find-file and read-file-name commands.
973 ;;(defadvice exit-minibuffer (before viper-exit-minibuffer-advice activate)
974 ;; "Run `viper-minibuffer-exit-hook' just before exiting the minibuffer."
975 ;; (run-hooks 'viper-minibuffer-exit-hook))
e36a387d 976
8626cfa2 977 (defadvice find-file (before viper-add-suffix-advice activate)
e36a387d
MK
978 "Use `read-file-name' for reading arguments."
979 (interactive (cons (read-file-name "Find file: " nil default-directory)
980 ;; if Mule and prefix argument, ask for coding system
8626cfa2 981 (cond ((and viper-emacs-p
1e70790f
MK
982 (boundp 'MULE)) ; Emacs 20 with MULE
983 nil)
8626cfa2 984 ((and viper-xemacs-p
1e70790f
MK
985 (featurep 'mule)) ; XEmacs 20 with MULE
986 (list
987 (and current-prefix-arg
988 (read-coding-system
989 "Coding-system: "))))
990 )
e36a387d
MK
991 )))
992
8626cfa2 993 (defadvice find-file-other-window (before viper-add-suffix-advice activate)
e36a387d
MK
994 "Use `read-file-name' for reading arguments."
995 (interactive (cons (read-file-name "Find file in other window: "
996 nil default-directory)
997 ;; if Mule and prefix argument, ask for coding system
8626cfa2 998 (cond ((and viper-emacs-p
1e70790f
MK
999 (boundp 'MULE)) ; Emacs 20 with MULE
1000 nil)
8626cfa2 1001 ((and viper-xemacs-p
1e70790f
MK
1002 (featurep 'mule)) ; XEmacs 20 with MULE
1003 (list
1004 (and current-prefix-arg
1005 (read-coding-system
1006 "Coding-system: "))))
1007 )
e36a387d
MK
1008 )))
1009
1e70790f 1010
8626cfa2 1011 (defadvice find-file-other-frame (before viper-add-suffix-advice activate)
e36a387d
MK
1012 "Use `read-file-name' for reading arguments."
1013 (interactive (cons (read-file-name "Find file in other frame: "
1014 nil default-directory)
1015 ;; if Mule and prefix argument, ask for coding system
8626cfa2 1016 (cond ((and viper-emacs-p
1e70790f
MK
1017 (boundp 'MULE)) ; Emacs 20 with MULE
1018 nil)
8626cfa2 1019 ((and viper-xemacs-p
1e70790f
MK
1020 (featurep 'mule)) ; XEmacs 20 with MULE
1021 (list
1022 (and current-prefix-arg
1023 (read-coding-system
1024 "Coding-system: "))))
1025 )
e36a387d 1026 )))
1e70790f 1027
e36a387d 1028
8626cfa2
MK
1029 (defadvice read-file-name (around viper-suffix-advice activate)
1030 "Tell `exit-minibuffer' to run `viper-file-add-suffix' as a hook."
96dffd25
MK
1031 (let ((viper-minibuffer-exit-hook
1032 (append viper-minibuffer-exit-hook '(viper-file-add-suffix))))
e36a387d
MK
1033 ad-do-it))
1034
8626cfa2 1035 (defadvice start-kbd-macro (after viper-kbd-advice activate)
e36a387d
MK
1036 "Remove Viper's intercepting bindings for C-x ).
1037 This may be needed if the previous `:map' command terminated abnormally."
8626cfa2
MK
1038 (define-key viper-vi-intercept-map "\C-x)" nil)
1039 (define-key viper-insert-intercept-map "\C-x)" nil)
1040 (define-key viper-emacs-intercept-map "\C-x)" nil))
41497c90
MK
1041
1042 ;; catch frame switching event
1043 (if (viper-window-display-p)
1044 (if viper-xemacs-p
1045 (add-hook 'mouse-leave-frame-hook
1046 'viper-remember-current-frame)
1047 (defadvice handle-switch-frame (before viper-frame-advice activate)
1048 "Remember the selected frame before the switch-frame event."
1049 (viper-remember-current-frame (selected-frame)))) )
1050
8626cfa2 1051 ) ; end viper-non-hook-settings
e36a387d 1052
726e270f 1053\f
41497c90
MK
1054;; Ask only if this-command/last-command are nil, i.e., when loading
1055(cond ((and (eq viper-mode 'ask) (null this-command) (null last-command))
1056 (save-window-excursion
1057 (with-output-to-temp-buffer " *viper-info*"
1058 (princ "
e36a387d
MK
1059You have loaded Viper, and are about to Viperize your emacs!
1060
8626cfa2 1061Viper is a Package for Emacs Rebels and a venomous VI PERil,
e36a387d
MK
1062
1063It's time to decide: to Viperize or not to Viperize...
1064
1065If you wish to Viperize AND make this your way of life, please put
1066
1067 (setq viper-mode t)
1068 (require 'viper)
1069
1070in your .emacs file (preferably, close to the top).
1071These two lines must come in the order given.
1072
8626cfa2
MK
1073** Viper users:
1074 **** The startup file name has been changed from .vip to .viper
1075 **** All vip-* style names have been converted to viper-* style."))
41497c90
MK
1076 (if (y-or-n-p "Viperize? ")
1077 (setq viper-mode t)
1078 (setq viper-mode nil))
1079 (message "")
1080 (kill-buffer " *viper-info*")))
1081
1082 ;; If viper-mode is t, then just continue. Viper will kick in.
1083 ((eq viper-mode t))
1084 ;; Otherwise, it was asking mode and Viper was not loaded through .emacs
1085 ;; In this case, it was either through M-x viper-mode or via something
1086 ;; else, like the custom widget. If Viper was loaded through
1087 ;; M-x viper-mode, then viper will kick in anyway.
1088 (t (setq viper-mode nil)))
8626cfa2
MK
1089
1090(defun viper-load-custom-file ()
1091 (if (and (file-exists-p viper-custom-file-name)
1092 (not noninteractive))
1093 (load viper-custom-file-name)))
e36a387d 1094
726e270f
MK
1095
1096
1097\f
1e70790f
MK
1098;; Get viper standard value of SYMBOL. If symbol is customized, get its
1099;; standard value. Otherwise, get the value saved in the alist STORAGE. If
1100;; STORAGE is nil, use viper-saved-user-settings.
1101(defun viper-standard-value (symbol &optional storage)
1102 (or (eval (car (get symbol 'customized-value)))
1103 (eval (car (get symbol 'saved-value)))
1104 (nth 1 (assoc symbol (or storage viper-saved-user-settings)))))
1105
1106
1107
1108;; save non-viper vars that Viper might change
1109(if (null viper-saved-non-viper-variables)
1110 (setq viper-saved-non-viper-variables
1111 (list
1112 (cons 'default-major-mode (list default-major-mode))
1113 (cons 'next-line-add-newlines (list next-line-add-newlines))
1114 (cons 'require-final-newline (list require-final-newline))
1e70790f
MK
1115 (cons 'scroll-step (list scroll-step))
1116 (cons 'mode-line-buffer-identification
1117 (list (default-value 'mode-line-buffer-identification)))
1118 (cons 'global-mode-string (list global-mode-string))
8626cfa2 1119 (if viper-emacs-p
5489c3d3 1120 (cons 'mark-even-if-inactive (list mark-even-if-inactive)))
1e70790f
MK
1121 )))
1122
6c2e12f4 1123
e36a387d 1124;; Set some useful macros, advices
1e70790f
MK
1125;; These must be BEFORE ~/.viper is loaded,
1126;; so the user can unrecord them in ~/.viper.
e36a387d
MK
1127(if viper-mode
1128 (progn
1129 ;; set advices and some variables that give emacs Vi look.
8626cfa2 1130 (viper-non-hook-settings)
e36a387d
MK
1131
1132 ;; repeat the 2nd previous command without rotating the command history
8626cfa2
MK
1133 (viper-record-kbd-macro
1134 (vector viper-repeat-from-history-key '\1) 'vi-state
1135 [(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 1136 ;; repeat the 3d previous command without rotating the command history
8626cfa2
MK
1137 (viper-record-kbd-macro
1138 (vector viper-repeat-from-history-key '\2) 'vi-state
1139 [(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 1140
1e70790f 1141 ;; set macros for toggling case sensitivity and regexp search
8626cfa2 1142 (viper-set-searchstyle-toggling-macros nil)
e36a387d 1143 ;; Make %%% toggle parsing comments for matching parentheses
8626cfa2
MK
1144 (viper-set-parsing-style-toggling-macro nil)
1145
1146 ;; ~/.viper is loaded if exists
1147 (viper-load-custom-file)
1148
1149 ;; should be after loading custom file to avoid the pesky msg that
1150 ;; mouse-search/insert keys are already bound
1151 (viper-bind-mouse-search-key)
1152 (viper-bind-mouse-insert-key)
e36a387d 1153 ))
d695b318 1154
6c2e12f4 1155
6c2e12f4 1156\f
8626cfa2 1157;; Applying Viper customization -- runs after (load .viper)
6c2e12f4 1158
1e70790f
MK
1159;; Save user settings or Viper defaults for vars controled by
1160;; viper-expert-level
1161(if (null viper-saved-user-settings)
1162 (setq viper-saved-user-settings
8626cfa2 1163 (list (cons 'viper-want-ctl-h-help (list viper-want-ctl-h-help))
1e70790f 1164 (cons 'viper-always (list viper-always))
8626cfa2
MK
1165 (cons 'viper-no-multiple-ESC (list viper-no-multiple-ESC))
1166 (cons 'viper-ex-style-motion (list viper-ex-style-motion))
34317da2
MK
1167 (cons 'viper-ex-style-editing
1168 (list viper-ex-style-editing))
8626cfa2
MK
1169 (cons 'viper-want-emacs-keys-in-vi
1170 (list viper-want-emacs-keys-in-vi))
1171 (cons 'viper-electric-mode (list viper-electric-mode))
1172 (cons 'viper-want-emacs-keys-in-insert
1173 (list viper-want-emacs-keys-in-insert))
1174 (cons 'viper-re-search (list viper-re-search)))))
6c2e12f4
KH
1175
1176
e36a387d
MK
1177(if viper-mode
1178 (progn
8626cfa2
MK
1179 (viper-set-minibuffer-style)
1180 (if viper-buffer-search-char
1181 (viper-buffer-search-enable))
34317da2 1182 (viper-update-syntax-classes 'set-default)
e36a387d 1183 ))
6c2e12f4 1184
d5e52f99 1185\f
6c2e12f4 1186;;; Familiarize Viper with some minor modes that have their own keymaps
e36a387d
MK
1187(if viper-mode
1188 (progn
8626cfa2
MK
1189 (viper-harness-minor-mode "compile")
1190 (viper-harness-minor-mode "outline")
1191 (viper-harness-minor-mode "allout")
1192 (viper-harness-minor-mode "xref")
1193 (viper-harness-minor-mode "lmenu")
1194 (viper-harness-minor-mode "vc")
1195 (viper-harness-minor-mode "ltx-math") ; LaTeX-math-mode in AUC-TeX, which
1196 (viper-harness-minor-mode "latex") ; sits in one of these two files
1197 (viper-harness-minor-mode "cyrillic")
1198 (viper-harness-minor-mode "russian")
1199 (viper-harness-minor-mode "view-less")
1200 (viper-harness-minor-mode "view")
e36a387d 1201 ))
6c2e12f4
KH
1202
1203
1204;; Intercept maps could go in viper-keym.el
1e70790f 1205;; We keep them here in case someone redefines them in ~/.viper
6c2e12f4 1206
8626cfa2
MK
1207(define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
1208(define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key)
6c2e12f4 1209
8626cfa2
MK
1210;; This is taken care of by viper-insert-global-user-map.
1211;;(define-key viper-replace-map viper-ESC-key 'viper-intercept-ESC-key)
6c2e12f4 1212
34da0a2b 1213
8626cfa2 1214;; The default viper-toggle-key is \C-z; for the novice, it suspends or
6c2e12f4 1215;; iconifies Emacs
8626cfa2
MK
1216(define-key viper-vi-intercept-map viper-toggle-key 'viper-toggle-key-action)
1217(define-key
1218 viper-emacs-intercept-map viper-toggle-key 'viper-change-state-to-vi)
328b4b70
MK
1219
1220;;; Escape from Emacs and Insert modes to Vi for one command
1221(define-key
1222 viper-emacs-intercept-map "\C-c\\" 'viper-escape-to-vi)
1223(define-key
1224 viper-insert-intercept-map "\C-c\\" 'viper-escape-to-vi)
1225
1226(if viper-mode
c004db97
MK
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(if (and viper-mode (eq viper-current-state 'emacs-state))
1233 (setq viper-emacs-intercept-minor-mode t
1234 viper-emacs-local-user-minor-mode t
1235 viper-emacs-global-user-minor-mode t
1236 viper-emacs-kbd-minor-mode t
1237 viper-emacs-state-modifier-minor-mode t))
6c2e12f4
KH
1238
1239
e36a387d
MK
1240(if (and viper-mode
1241 (or viper-always
1e70790f 1242 (and (< viper-expert-level 5) (> viper-expert-level 0))))
8626cfa2 1243 (viper-set-hooks))
6c2e12f4
KH
1244
1245;; Let all minor modes take effect after loading
1246;; this may not be enough, so we also set default minor-mode-alist.
1247;; Without setting the default, new buffers that come up in emacs mode have
8626cfa2 1248;; minor-mode-map-alist = nil, unless we call viper-change-state-*
328b4b70 1249(if (and viper-mode (eq viper-current-state 'emacs-state))
6c2e12f4 1250 (progn
8626cfa2 1251 (viper-change-state-to-emacs)
6c2e12f4
KH
1252 (setq-default minor-mode-map-alist minor-mode-map-alist)
1253 ))
1254
6c2e12f4 1255
d5e52f99 1256
8626cfa2 1257(run-hooks 'viper-load-hook) ; the last chance to change something
6c2e12f4 1258
d5e52f99 1259(provide 'viper)
6c2e12f4 1260
1e70790f
MK
1261
1262;;; Local Variables:
8626cfa2 1263;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1e70790f
MK
1264;;; End:
1265
6c2e12f4 1266;;; viper.el ends here