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