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