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