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