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