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