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