Commit | Line | Data |
---|---|---|
8626cfa2 | 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 | ||
9b70a748 | 9 | ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc. |
151496c0 | 10 | |
985d0dad | 11 | (defconst viper-version "2.96 of August 7, 1997" |
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 | ||
8626cfa2 | 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 | |
37 | ;; Vi in many other ways. Viper is highly customizable through the various | |
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 | |
47 | ;; <sane@cs.uiuc.edu>. Some ideas from vip 4.4.2 by Aamod Sane | |
48 | ;; were also shamelessly plagiarized. | |
49 | ;; | |
50 | ;; Viper maintains some degree of compatibility with these older | |
51 | ;; packages. See the documentation for customization. | |
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 | |
85 | ;; macro, not just the Vi commands. Second, macros are defined in a | |
86 | ;; WYSYWYG mode, using an interface to Emacs' WYSIWYG style of defining | |
87 | ;; macros. Third, in Viper, one can define macros that are specific to | |
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 | |
113 | ;; in the right state (either vi-state or emacs-state). For instance, text | |
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 | |
d695b318 | 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 KH |
128 | ;; |
129 | ;; whichever applies. The right thing to do, however, is to complain to the | |
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 |
6c2e12f4 | 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 |
8626cfa2 | 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 | ;; | |
1e70790f | 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 MK |
163 | ;; (setq viper-expert-level 4) |
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 MK |
167 | ;; (setq viper-expert-level 5) |
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 |
6c2e12f4 KH |
172 | ;; concern for the user. It is needed to bind Viper's vital keys, such as |
173 | ;; ESC and C-z. | |
174 | ;; | |
8626cfa2 | 175 | ;; The second mode, viper-vi-local-user-minor-mode, usually has an |
6c2e12f4 KH |
176 | ;; empty keymap. However, the user can set bindings in this keymap, which |
177 | ;; will overshadow the corresponding bindings in the other two minor | |
178 | ;; modes. This is useful, for example, for setting up ZZ in gnus, | |
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. | |
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 | |
6c2e12f4 KH |
187 | ;; bindings are seen in all Viper buffers. This mode keys can be done |
188 | ;; with define-key command. | |
189 | ;; | |
8626cfa2 | 190 | ;; The fourth minor mode, viper-vi-kbd-minor-mode, is used by keyboard |
6c2e12f4 KH |
191 | ;; macros. Users are NOT supposed to modify this keymap directly. |
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 |
6c2e12f4 | 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 | |
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 | |
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 |
6c2e12f4 KH |
232 | ;; when Viper is in insert state. It binds a small number of keys needed for |
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 KH |
242 | ;; |
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 | |
6c2e12f4 | 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 |
6c2e12f4 | 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 | |
255 | ;; replace-state (used for commands like cw, C, etc.). This mode is | |
256 | ;; called | |
257 | ;; | |
8626cfa2 | 258 | ;; viper-replace-minor-mode |
6c2e12f4 | 259 | ;; |
8626cfa2 | 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 |
6c2e12f4 KH |
268 | ;; this. For instance, is you need to add couple of mode-specific bindings |
269 | ;; to Insert mode, you can put | |
270 | ;; | |
8626cfa2 | 271 | ;; (viper-add-local-keys 'insert-state '((key1 . func1) (key2 .func2))) |
6c2e12f4 KH |
272 | ;; |
273 | ;; somewhere in a hook of this major mode. If you put something like this | |
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 | |
8626cfa2 | 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 | |
8626cfa2 | 284 | ;; convoluted. Instead of viper-command-argument, keymaps should bind the |
6c2e12f4 | 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 |
6c2e12f4 KH |
287 | ;; last-command-char. This would greatly simplify the logic and the code. |
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 | |
292 | ;; starts with a '*'. Then, the user should be offered to save | |
293 | ;; variables that were changed. This will make user's customization job | |
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) | |
1e70790f | 305 | (defvar viper-expert-level) |
8626cfa2 | 306 | (defvar viper-expert-level) |
6c2e12f4 | 307 | |
726e270f MK |
308 | ;; loading happens only in non-interactive compilation |
309 | ;; in order to spare non-viperized emacs from being viperized | |
310 | (if noninteractive | |
311 | (eval-when-compile | |
312 | (let ((load-path (cons (expand-file-name ".") load-path))) | |
b484aa09 MK |
313 | (or (featurep 'viper-init) |
314 | (load "viper-init.el" nil nil 'nosuffix)) | |
726e270f MK |
315 | (or (featurep 'viper-cmd) |
316 | (load "viper-cmd.el" nil nil 'nosuffix)) | |
317 | ))) | |
318 | ;; end pacifier | |
6c2e12f4 | 319 | |
aca9b721 RS |
320 | (require 'viper-init) |
321 | ||
1e70790f | 322 | ;; better be defined before Viper custom group. |
8626cfa2 | 323 | (defvar viper-custom-file-name (convert-standard-filename "~/.viper") |
1e70790f MK |
324 | "Viper customisation file. |
325 | If set by the user, this must be done _before_ Viper is loaded in `~/.emacs'.") | |
326 | ||
327 | (defgroup viper nil | |
328 | "Vi emulation within Emacs. | |
8626cfa2 | 329 | NOTE: Viper customization should be saved in `viper-custom-file-name', which |
1e70790f | 330 | defaults to `~/.viper'." |
8626cfa2 | 331 | :prefix "viper-" |
1e70790f MK |
332 | :group 'emulations) |
333 | ||
726e270f | 334 | (require 'viper-cmd) |
6c2e12f4 | 335 | |
8626cfa2 | 336 | (defcustom viper-always t |
e36a387d MK |
337 | "Non-nil means, arrange for vi-state to be a default when appropriate. |
338 | This is different from `viper-mode' variable in that `viper-mode' determines | |
339 | whether to use Viper in the first place, while `viper-always', if nil, lets | |
1e70790f MK |
340 | user decide when to invoke Viper in a major mode." |
341 | :type 'boolean | |
342 | :tag "Always Invoke Viper" | |
343 | :group 'viper) | |
344 | ||
345 | ;; Non-viper variables that need to be saved in case the user decides to | |
346 | ;; de-viperize emacs. | |
347 | (defvar viper-saved-non-viper-variables nil) | |
348 | ;; Contains user settings for vars affected by viper-set-expert-level function. | |
349 | ;; Not a user option. | |
350 | (defvar viper-saved-user-settings nil) | |
351 | ||
352 | (defcustom viper-mode (cond (noninteractive nil) | |
353 | (t 'ask)) | |
354 | "To Viperize or not to Viperize. | |
e36a387d MK |
355 | If t, viperize emacs. If nil -- don't. If `ask', ask the user. |
356 | This variable is used primatily when Viper is being loaded. | |
6c2e12f4 | 357 | |
e36a387d | 358 | Must be set in `~/.emacs' before Viper is loaded. |
1e70790f MK |
359 | DO NOT set this variable interactively." |
360 | :type '(choice (const nil) (const t) (const ask)) | |
361 | :tag "Set Viper Mode on Loading" | |
362 | :group 'viper) | |
726e270f | 363 | |
41497c90 MK |
364 | (defcustom viper-non-vi-major-modes |
365 | '(custom-mode dired-mode efs-mode internal-ange-ftp-mode tar-mode | |
366 | mh-folder-mode gnus-group-mode gnus-summary-mode Info-mode | |
367 | Buffer-menu-mode view-mode vm-mode vm-summary-mode) | |
368 | "*A list of major modes that should never come up in Vi command mode. | |
c81246f3 MK |
369 | Viper automatically augments this list with some obvious modes, such as |
370 | `dired-mode', `tar-mode', etc. So, don't put modes on this list, unless | |
371 | it comes up in a wrong Viper state." | |
372 | :type 'list | |
373 | :group 'viper) | |
374 | ||
375 | ||
e36a387d | 376 | \f |
726e270f | 377 | |
e36a387d | 378 | ;;;###autoload |
8626cfa2 MK |
379 | (defun toggle-viper-mode () |
380 | (interactive) | |
381 | (if (eq viper-mode t) | |
382 | (viper-go-away) | |
383 | (setq viper-mode nil) | |
384 | (viper-mode))) | |
6c2e12f4 | 385 | |
e36a387d MK |
386 | ;;;###autoload |
387 | (defun viper-mode () | |
388 | "Turn on Viper emulation of Vi." | |
389 | (interactive) | |
390 | (if (not noninteractive) | |
391 | (progn | |
392 | ;; if the user requested viper-mode explicitly | |
393 | (if viper-mode | |
394 | () | |
8626cfa2 | 395 | (setq viper-mode t) |
e36a387d MK |
396 | (load-library "viper")) |
397 | ||
8626cfa2 MK |
398 | (if viper-first-time ; Important check. Prevents mix-up of startup and |
399 | (progn ; expert-level msgs when viper-mode recurses | |
400 | (setq viper-first-time nil) | |
401 | (if (not viper-inhibit-startup-message) | |
e36a387d | 402 | (save-window-excursion |
8626cfa2 | 403 | (setq viper-inhibit-startup-message t) |
e36a387d MK |
404 | (delete-other-windows) |
405 | (switch-to-buffer "Viper Startup Message") | |
406 | (erase-buffer) | |
407 | (insert | |
408 | (substitute-command-keys | |
1e70790f MK |
409 | "Viper Is a Package for Emacs Rebels, |
410 | a VI Plan for Emacs Rescue, and a venomous VI PERil. | |
e36a387d | 411 | |
1e70790f MK |
412 | Incidentally, Viper emulates Vi under GNU Emacs 20 and XEmacs 20. |
413 | It supports all of what is good in Vi and Ex, while extending | |
e36a387d MK |
414 | and improving upon much of it. |
415 | ||
416 | 1. Viper supports Vi at several levels. Level 1 is the closest to Vi, | |
417 | level 5 provides the most flexibility to depart from many Vi conventions. | |
418 | ||
419 | You will be asked to specify your user level in a following screen. | |
420 | ||
421 | If you select user level 1 then the keys ^X, ^C, ^Z, and ^G will behave | |
422 | as in VI, to smooth transition to Viper for the beginners. However, to | |
423 | use Emacs productively, you are advised to reach user level 3 or higher. | |
424 | ||
1e70790f MK |
425 | At user level 2 or higher, ^X and ^C have Emacs, not Vi, bindings; |
426 | ^Z toggles Vi/Emacs states; ^G is Emacs' keyboard-quit (like ^C in Vi). | |
e36a387d MK |
427 | |
428 | 2. Vi exit functions (e.g., :wq, ZZ) work on INDIVIDUAL files -- they | |
1e70790f | 429 | do not cause Emacs to quit, except at user level 1 (for a novice). |
e36a387d MK |
430 | 3. ^X^C EXITS EMACS. |
431 | 4. Viper supports multiple undo: `u' will undo. Typing `.' will repeat | |
432 | undo. Another `u' changes direction. | |
433 | ||
1e70790f MK |
434 | 6. Emacs Meta key is `C-\\' (in all modes) or `\\ ESC' (in Vi command mode). |
435 | On a window system, the best way is to use the Meta-key on your keyboard. | |
e36a387d MK |
436 | 7. Try \\[keyboard-quit] and \\[abort-recursive-edit] repeatedly,if |
437 | something funny happens. This would abort the current editing command. | |
438 | ||
1e70790f | 439 | For more information on Viper: |
726e270f | 440 | |
1e70790f MK |
441 | a. Type `:help' in Vi command mode |
442 | b. Print Viper manual, found in ./etc/viper.dvi | |
443 | c. Print the Quick Reference, found in ./etc/viperCard.dvi | |
444 | ||
445 | To submit a bug report or to contact the author, type :submitReport in Vi | |
446 | command mode. To shoo Viper away and return to pure Emacs (horror!), type: | |
447 | ||
448 | M-x viper-go-away | |
e36a387d MK |
449 | |
450 | This startup message appears whenever you load Viper, unless you type `y' now." | |
451 | )) | |
452 | (goto-char (point-min)) | |
453 | (if (y-or-n-p "Inhibit Viper startup message? ") | |
8626cfa2 MK |
454 | (viper-save-setting |
455 | 'viper-inhibit-startup-message | |
e36a387d | 456 | "Viper startup message inhibited" |
8626cfa2 | 457 | viper-custom-file-name t)) |
e36a387d MK |
458 | ;;(kill-buffer (current-buffer)) |
459 | (message | |
460 | "The last message is in buffer `Viper Startup Message'") | |
461 | (sit-for 4) | |
462 | )) | |
1e70790f | 463 | (viper-set-expert-level 'dont-change-unless))) |
c81246f3 MK |
464 | |
465 | (or (memq major-mode viper-non-vi-major-modes) ; don't switch to Vi | |
8626cfa2 | 466 | (viper-change-state-to-vi))))) |
e36a387d | 467 | |
6c2e12f4 | 468 | \f |
4af0c23b | 469 | ;; This hook designed to enable Vi-style editing in comint-based modes." |
8626cfa2 | 470 | (defun viper-comint-mode-hook () |
34da0a2b | 471 | (setq require-final-newline nil |
8626cfa2 MK |
472 | viper-ex-style-editing-in-insert nil |
473 | viper-ex-style-motion nil) | |
474 | (viper-change-state-to-insert)) | |
34da0a2b | 475 | |
6c2e12f4 | 476 | |
1e70790f MK |
477 | ;; remove viper hooks from SYMBOL |
478 | (defun viper-remove-hooks (symbol) | |
479 | (cond ((not (boundp symbol)) nil) | |
480 | ((not (listp (eval symbol))) nil) | |
481 | ((string-match "-hook" (symbol-name symbol)) | |
482 | (remove-hook symbol 'viper-mode) | |
8626cfa2 MK |
483 | (remove-hook symbol 'viper-change-state-to-emacs) |
484 | (remove-hook symbol 'viper-change-state-to-insert) | |
485 | (remove-hook symbol 'viper-change-state-to-vi) | |
1e70790f MK |
486 | ))) |
487 | ||
488 | ;; Remove local value in all existing buffers | |
489 | ;; This doesn't delocalize vars (which would have been desirable) | |
490 | (defun viper-delocalize-var (symbol) | |
491 | (mapcar (function (lambda (buf) | |
492 | (save-excursion | |
493 | (set-buffer buf) | |
494 | (kill-local-variable symbol)))) | |
495 | (buffer-list))) | |
496 | ||
497 | ||
498 | (defun viper-go-away () | |
499 | "De-Viperize Emacs. | |
500 | This function tries to do as good a job as possible. However, it may undo some | |
501 | user customization, unrelated to Viper. For instance, if the user advised | |
502 | `read-file-name', `describe-key', and some others, then this advice will be | |
503 | undone. | |
504 | It also doesn't undo some Viper settings. For instance, `minor-mode-map-alist' | |
505 | remains buffer-local." | |
506 | (interactive) | |
507 | ||
508 | ;; restore non-viper vars | |
509 | (setq-default | |
510 | default-major-mode | |
511 | (viper-standard-value 'default-major-mode viper-saved-non-viper-variables) | |
512 | next-line-add-newlines | |
513 | (viper-standard-value | |
514 | 'next-line-add-newlines viper-saved-non-viper-variables) | |
515 | require-final-newline | |
516 | (viper-standard-value | |
517 | 'require-final-newline viper-saved-non-viper-variables) | |
1e70790f MK |
518 | scroll-step |
519 | (viper-standard-value 'scroll-step viper-saved-non-viper-variables) | |
1e70790f MK |
520 | mode-line-buffer-identification |
521 | (viper-standard-value | |
5489c3d3 MK |
522 | 'mode-line-buffer-identification viper-saved-non-viper-variables) |
523 | global-mode-string | |
524 | (viper-standard-value 'global-mode-string viper-saved-non-viper-variables)) | |
525 | ||
8626cfa2 | 526 | (if viper-emacs-p |
5489c3d3 MK |
527 | (setq-default |
528 | mark-even-if-inactive | |
529 | (viper-standard-value | |
530 | 'mark-even-if-inactive viper-saved-non-viper-variables))) | |
1e70790f MK |
531 | |
532 | ;; Ideally, we would like to be able to de-localize local variables | |
533 | (viper-delocalize-var 'minor-mode-map-alist) | |
534 | (viper-delocalize-var 'require-final-newline) | |
535 | ||
536 | ||
537 | ;; deactivate all advices done by Viper. | |
8626cfa2 | 538 | (ad-deactivate-regexp "viper-") |
1e70790f MK |
539 | |
540 | (setq viper-mode nil) | |
541 | ||
8626cfa2 MK |
542 | (viper-delocalize-var 'viper-vi-minibuffer-minor-mode) |
543 | (viper-delocalize-var 'viper-insert-minibuffer-minor-mode) | |
544 | (viper-delocalize-var 'viper-vi-intercept-minor-mode) | |
545 | (viper-delocalize-var 'viper-insert-intercept-minor-mode) | |
1e70790f | 546 | |
8626cfa2 MK |
547 | (viper-delocalize-var 'viper-vi-local-user-minor-mode) |
548 | (viper-delocalize-var 'viper-vi-kbd-minor-mode) | |
549 | (viper-delocalize-var 'viper-vi-global-user-minor-mode) | |
550 | (viper-delocalize-var 'viper-vi-state-modifier-minor-mode) | |
551 | (viper-delocalize-var 'viper-vi-diehard-minor-mode) | |
552 | (viper-delocalize-var 'viper-vi-basic-minor-mode) | |
1e70790f | 553 | |
8626cfa2 | 554 | (viper-delocalize-var 'viper-replace-minor-mode) |
1e70790f | 555 | |
8626cfa2 MK |
556 | (viper-delocalize-var 'viper-insert-local-user-minor-mode) |
557 | (viper-delocalize-var 'viper-insert-kbd-minor-mode) | |
558 | (viper-delocalize-var 'viper-insert-global-user-minor-mode) | |
559 | (viper-delocalize-var 'viper-insert-state-modifier-minor-mode) | |
560 | (viper-delocalize-var 'viper-insert-diehard-minor-mode) | |
561 | (viper-delocalize-var 'viper-insert-basic-minor-mode) | |
1e70790f | 562 | |
8626cfa2 MK |
563 | (viper-delocalize-var 'viper-emacs-intercept-minor-mode) |
564 | (viper-delocalize-var 'viper-emacs-local-user-minor-mode) | |
565 | (viper-delocalize-var 'viper-emacs-kbd-minor-mode) | |
566 | (viper-delocalize-var 'viper-emacs-global-user-minor-mode) | |
567 | (viper-delocalize-var 'viper-emacs-state-modifier-minor-mode) | |
568 | ||
569 | (setq-default viper-vi-minibuffer-minor-mode nil | |
570 | viper-insert-minibuffer-minor-mode nil | |
571 | viper-vi-intercept-minor-mode nil | |
572 | viper-insert-intercept-minor-mode nil | |
1e70790f | 573 | |
8626cfa2 MK |
574 | viper-vi-local-user-minor-mode nil |
575 | viper-vi-kbd-minor-mode nil | |
576 | viper-vi-global-user-minor-mode nil | |
577 | viper-vi-state-modifier-minor-mode nil | |
578 | viper-vi-diehard-minor-mode nil | |
579 | viper-vi-basic-minor-mode nil | |
1e70790f | 580 | |
8626cfa2 | 581 | viper-replace-minor-mode nil |
1e70790f | 582 | |
8626cfa2 MK |
583 | viper-insert-local-user-minor-mode nil |
584 | viper-insert-kbd-minor-mode nil | |
585 | viper-insert-global-user-minor-mode nil | |
586 | viper-insert-state-modifier-minor-mode nil | |
587 | viper-insert-diehard-minor-mode nil | |
588 | viper-insert-basic-minor-mode nil | |
589 | ||
590 | viper-emacs-intercept-minor-mode nil | |
591 | viper-emacs-local-user-minor-mode nil | |
592 | viper-emacs-kbd-minor-mode nil | |
593 | viper-emacs-global-user-minor-mode nil | |
594 | viper-emacs-state-modifier-minor-mode nil | |
1e70790f MK |
595 | ) |
596 | ||
597 | ;; remove all hooks set by viper | |
598 | (mapatoms 'viper-remove-hooks) | |
8626cfa2 MK |
599 | (remove-hook 'comint-mode-hook 'viper-comint-mode-hook) |
600 | (remove-hook 'minibuffer-setup-hook 'viper-minibuffer-setup-sentinel) | |
601 | ||
602 | ;; unbind Viper mouse bindings | |
603 | (viper-unbind-mouse-search-key) | |
604 | (viper-unbind-mouse-insert-key) | |
41497c90 MK |
605 | ;; In emacs, we have to advice handle-switch-frame |
606 | ;; This advice is undone earlier, when all advices matchine "viper-" are | |
607 | ;; deactivated. | |
608 | (if viper-xemacs-p | |
609 | (remove-hook 'mouse-leave-frame-hook 'viper-remember-current-frame)) | |
610 | ) ; end viper-go-away | |
1e70790f MK |
611 | |
612 | ||
613 | ||
614 | ||
04090c34 | 615 | ;; This sets major mode hooks to make them come up in vi-state. |
8626cfa2 | 616 | (defun viper-set-hooks () |
6c2e12f4 KH |
617 | |
618 | ;; It is of course a misnomer to call viper-mode a `major mode'. | |
619 | ;; However, this has the effect that if the user didn't specify the | |
620 | ;; default mode, new buffers that fall back on the default will come up | |
621 | ;; in Fundamental Mode and Vi state. | |
622 | (setq default-major-mode 'viper-mode) | |
623 | ||
4af0c23b | 624 | ;; The following major modes should come up in vi-state |
8626cfa2 MK |
625 | (defadvice fundamental-mode (after viper-fundamental-mode-ad activate) |
626 | "Run `viper-change-state-to-vi' on entry." | |
627 | (viper-change-state-to-vi)) | |
4af0c23b | 628 | |
bbe6126c | 629 | (defvar makefile-mode-hook) |
151496c0 MK |
630 | (add-hook 'makefile-mode-hook 'viper-mode) |
631 | ||
bbe6126c | 632 | (defvar help-mode-hook) |
4af0c23b | 633 | (add-hook 'help-mode-hook 'viper-mode) |
8626cfa2 | 634 | (viper-modify-major-mode 'help-mode 'vi-state viper-help-modifier-map) |
151496c0 | 635 | |
bbe6126c | 636 | (defvar awk-mode-hook) |
151496c0 | 637 | (add-hook 'awk-mode-hook 'viper-mode) |
6c2e12f4 | 638 | |
bbe6126c | 639 | (defvar html-mode-hook) |
d695b318 | 640 | (add-hook 'html-mode-hook 'viper-mode) |
bbe6126c | 641 | (defvar html-helper-mode-hook) |
151496c0 | 642 | (add-hook 'html-helper-mode-hook 'viper-mode) |
e36a387d | 643 | |
34da0a2b MK |
644 | (defvar java-mode-hook) |
645 | (add-hook 'java-mode-hook 'viper-mode) | |
151496c0 | 646 | |
1e70790f MK |
647 | (defvar javascript-mode-hook) |
648 | (add-hook 'javascript-mode-hook 'viper-mode) | |
649 | ||
bbe6126c | 650 | (defvar emacs-lisp-mode-hook) |
151496c0 | 651 | (add-hook 'emacs-lisp-mode-hook 'viper-mode) |
bbe6126c | 652 | (defvar lisp-mode-hook) |
6c2e12f4 | 653 | (add-hook 'lisp-mode-hook 'viper-mode) |
e36a387d MK |
654 | (defvar lisp-interaction-mode-hook) |
655 | (add-hook 'lisp-interaction-mode-hook 'viper-mode) | |
6c2e12f4 | 656 | |
bbe6126c | 657 | (defvar bibtex-mode-hook) |
6c2e12f4 KH |
658 | (add-hook 'bibtex-mode-hook 'viper-mode) |
659 | ||
bbe6126c | 660 | (defvar cc-mode-hook) |
6c2e12f4 KH |
661 | (add-hook 'cc-mode-hook 'viper-mode) |
662 | ||
bbe6126c | 663 | (defvar c-mode-hook) |
6c2e12f4 KH |
664 | (add-hook 'c-mode-hook 'viper-mode) |
665 | ||
bbe6126c | 666 | (defvar c++-mode-hook) |
6c2e12f4 | 667 | (add-hook 'c++-mode-hook 'viper-mode) |
bbe6126c MK |
668 | |
669 | (defvar fortran-mode-hook) | |
e36a387d MK |
670 | (add-hook 'fortran-mode-hook 'viper-mode) |
671 | (defvar f90-mode-hook) | |
672 | (add-hook 'f90-mode-hook 'viper-mode) | |
bf5d92c5 MK |
673 | |
674 | (defvar basic-mode-hook) | |
e36a387d | 675 | (add-hook 'basic-mode-hook 'viper-mode) |
bf5d92c5 | 676 | (defvar bat-mode-hook) |
e36a387d | 677 | (add-hook 'bat-mode-hook 'viper-mode) |
f4ce0bd7 MK |
678 | |
679 | (defvar asm-mode-hook) | |
680 | (add-hook 'asm-mode-hook 'viper-mode) | |
681 | ||
682 | (defvar prolog-mode-hook) | |
683 | (add-hook 'prolog-mode-hook 'viper-mode) | |
6c2e12f4 | 684 | |
bbe6126c | 685 | (defvar text-mode-hook) |
6c2e12f4 KH |
686 | (add-hook 'text-mode-hook 'viper-mode) |
687 | ||
688 | (add-hook 'completion-list-mode-hook 'viper-mode) | |
689 | (add-hook 'compilation-mode-hook 'viper-mode) | |
151496c0 | 690 | |
1e70790f MK |
691 | (defvar perl-mode-hook) |
692 | (add-hook 'perl-mode-hook 'viper-mode) | |
693 | ||
694 | (defvar tcl-mode-hook) | |
695 | (add-hook 'tcl-mode-hook 'viper-mode) | |
696 | ||
697 | (defvar python-mode-hook) | |
698 | (add-hook 'python-mode-hook 'viper-mode) | |
6c2e12f4 | 699 | |
bbe6126c | 700 | (defvar emerge-startup-hook) |
8626cfa2 | 701 | (add-hook 'emerge-startup-hook 'viper-change-state-to-emacs) |
34da0a2b MK |
702 | |
703 | ;; Tell vc-diff to put *vc* in Vi mode | |
704 | (if (featurep 'vc) | |
8626cfa2 | 705 | (defadvice vc-diff (after viper-vc-ad activate) |
34da0a2b | 706 | "Force Vi state in VC diff buffer." |
8626cfa2 MK |
707 | (viper-change-state-to-vi)) |
708 | (eval-after-load | |
34da0a2b | 709 | "vc" |
8626cfa2 | 710 | '(defadvice vc-diff (after viper-vc-ad activate) |
34da0a2b | 711 | "Force Vi state in VC diff buffer." |
8626cfa2 | 712 | (viper-change-state-to-vi)))) |
34da0a2b | 713 | |
8626cfa2 | 714 | (eval-after-load |
4af0c23b | 715 | "emerge" |
8626cfa2 MK |
716 | '(defadvice emerge-quit (after viper-emerge-advice activate) |
717 | "Run `viper-change-state-to-vi' after quitting emerge." | |
718 | (viper-change-state-to-vi))) | |
6c2e12f4 | 719 | ;; In case Emerge was loaded before Viper. |
8626cfa2 MK |
720 | (defadvice emerge-quit (after viper-emerge-advice activate) |
721 | "Run `viper-change-state-to-vi' after quitting emerge." | |
722 | (viper-change-state-to-vi)) | |
6c2e12f4 | 723 | |
6c2e12f4 | 724 | ;; passwd.el sets up its own buffer, which turns up in Vi mode, |
27571f90 | 725 | ;; thus overriding the local map. We don't need Vi mode here. |
8626cfa2 | 726 | (eval-after-load |
6c2e12f4 | 727 | "passwd" |
8626cfa2 | 728 | '(defadvice read-passwd-1 (before viper-passwd-ad activate) |
4af0c23b | 729 | "Switch to emacs state while reading password." |
8626cfa2 | 730 | (viper-change-state-to-emacs))) |
6c2e12f4 | 731 | |
4af0c23b | 732 | ;; Emacs shell, ange-ftp, and comint-based modes |
bbe6126c | 733 | (defvar comint-mode-hook) |
8626cfa2 MK |
734 | (viper-modify-major-mode |
735 | 'comint-mode 'insert-state viper-comint-mode-modifier-map) | |
736 | (viper-modify-major-mode | |
737 | 'comint-mode 'vi-state viper-comint-mode-modifier-map) | |
738 | (viper-modify-major-mode | |
739 | 'shell-mode 'insert-state viper-comint-mode-modifier-map) | |
740 | (viper-modify-major-mode | |
741 | 'shell-mode 'vi-state viper-comint-mode-modifier-map) | |
bf5d92c5 | 742 | ;; ange-ftp in XEmacs |
8626cfa2 MK |
743 | (viper-modify-major-mode |
744 | 'ange-ftp-shell-mode 'insert-state viper-comint-mode-modifier-map) | |
745 | (viper-modify-major-mode | |
746 | 'ange-ftp-shell-mode 'vi-state viper-comint-mode-modifier-map) | |
bf5d92c5 | 747 | ;; ange-ftp in Emacs |
8626cfa2 MK |
748 | (viper-modify-major-mode |
749 | 'internal-ange-ftp-mode 'insert-state viper-comint-mode-modifier-map) | |
750 | (viper-modify-major-mode | |
751 | 'internal-ange-ftp-mode 'vi-state viper-comint-mode-modifier-map) | |
bf5d92c5 | 752 | ;; set hook |
8626cfa2 | 753 | (add-hook 'comint-mode-hook 'viper-comint-mode-hook) |
6c2e12f4 KH |
754 | |
755 | ;; Shell scripts | |
bbe6126c | 756 | (defvar sh-mode-hook) |
6c2e12f4 | 757 | (add-hook 'sh-mode-hook 'viper-mode) |
bbe6126c | 758 | (defvar ksh-mode-hook) |
151496c0 | 759 | (add-hook 'ksh-mode-hook 'viper-mode) |
6c2e12f4 KH |
760 | |
761 | ;; Dired | |
8626cfa2 MK |
762 | (viper-modify-major-mode 'dired-mode 'emacs-state viper-dired-modifier-map) |
763 | (viper-set-emacs-state-searchstyle-macros nil 'dired-mode) | |
764 | (add-hook 'dired-mode-hook 'viper-change-state-to-emacs) | |
6c2e12f4 | 765 | |
bf5d92c5 | 766 | ;; Tar |
8626cfa2 MK |
767 | (viper-modify-major-mode 'tar-mode 'emacs-state viper-slash-and-colon-map) |
768 | (viper-set-emacs-state-searchstyle-macros nil 'tar-mode) | |
bf5d92c5 | 769 | |
34da0a2b | 770 | ;; MH-E |
8626cfa2 MK |
771 | (viper-modify-major-mode |
772 | 'mh-folder-mode 'emacs-state viper-slash-and-colon-map) | |
773 | (viper-set-emacs-state-searchstyle-macros nil 'mh-folder-mode) | |
34da0a2b | 774 | ;; changing state to emacs is needed so the preceding will take hold |
8626cfa2 | 775 | (add-hook 'mh-folder-mode-hook 'viper-change-state-to-emacs) |
34da0a2b MK |
776 | (add-hook 'mh-show-mode-hook 'viper-mode) |
777 | ||
778 | ;; Gnus | |
8626cfa2 MK |
779 | (viper-modify-major-mode |
780 | 'gnus-group-mode 'emacs-state viper-slash-and-colon-map) | |
781 | (viper-set-emacs-state-searchstyle-macros nil 'gnus-group-mode) | |
782 | (viper-modify-major-mode | |
783 | 'gnus-summary-mode 'emacs-state viper-slash-and-colon-map) | |
784 | (viper-set-emacs-state-searchstyle-macros nil 'gnus-summary-mode) | |
34da0a2b | 785 | ;; changing state to emacs is needed so the preceding will take hold |
8626cfa2 MK |
786 | (add-hook 'gnus-group-mode-hook 'viper-change-state-to-emacs) |
787 | (add-hook 'gnus-summary-mode-hook 'viper-change-state-to-emacs) | |
34da0a2b MK |
788 | (add-hook 'gnus-article-mode-hook 'viper-mode) |
789 | ||
790 | ;; Info | |
8626cfa2 MK |
791 | (viper-modify-major-mode 'Info-mode 'emacs-state viper-slash-and-colon-map) |
792 | (viper-set-emacs-state-searchstyle-macros nil 'Info-mode) | |
34da0a2b | 793 | ;; Switching to emacs is needed so the above will take hold |
8626cfa2 | 794 | (defadvice Info-mode (after viper-Info-ad activate) |
34da0a2b | 795 | "Switch to emacs mode." |
8626cfa2 | 796 | (viper-change-state-to-emacs)) |
34da0a2b MK |
797 | |
798 | ;; Buffer menu | |
8626cfa2 MK |
799 | (viper-modify-major-mode |
800 | 'Buffer-menu-mode 'emacs-state viper-slash-and-colon-map) | |
801 | (viper-set-emacs-state-searchstyle-macros nil 'Buffer-menu-mode) | |
34da0a2b | 802 | ;; Switching to emacs is needed so the above will take hold |
8626cfa2 | 803 | (defadvice Buffer-menu-mode (after viper-Buffer-menu-ad activate) |
34da0a2b | 804 | "Switch to emacs mode." |
8626cfa2 | 805 | (viper-change-state-to-emacs)) |
34da0a2b MK |
806 | |
807 | ;; View mode | |
f4ce0bd7 MK |
808 | (defvar view-mode-hook) |
809 | (defvar view-hook) | |
8626cfa2 MK |
810 | (add-hook 'view-hook 'viper-change-state-to-emacs) |
811 | (add-hook 'view-mode-hook 'viper-change-state-to-emacs) | |
6c2e12f4 KH |
812 | |
813 | ;; For VM users. | |
814 | ;; Put summary and other VM buffers in Emacs state. | |
bbe6126c MK |
815 | (defvar vm-mode-hooks) |
816 | (defvar vm-summary-mode-hooks) | |
8626cfa2 MK |
817 | (add-hook 'vm-mode-hooks 'viper-change-state-to-emacs) |
818 | (add-hook 'vm-summary-mode-hooks 'viper-change-state-to-emacs) | |
6c2e12f4 KH |
819 | |
820 | ;; For RMAIL users. | |
821 | ;; Put buf in Emacs state after edit. | |
8626cfa2 | 822 | (eval-after-load |
6c2e12f4 | 823 | "rmailedit" |
8626cfa2 | 824 | '(defadvice rmail-cease-edit (after viper-rmail-advice activate) |
4af0c23b | 825 | "Switch to emacs state when done editing message." |
8626cfa2 | 826 | (viper-change-state-to-emacs))) |
6c2e12f4 | 827 | ;; In case RMAIL was loaded before Viper. |
8626cfa2 | 828 | (defadvice rmail-cease-edit (after viper-rmail-advice activate) |
4af0c23b | 829 | "Switch to emacs state when done editing message." |
8626cfa2 MK |
830 | (viper-change-state-to-emacs)) |
831 | ) ; viper-set-hooks | |
726e270f | 832 | |
e36a387d MK |
833 | |
834 | ;; these are primarily advices and Vi-ish variable settings | |
8626cfa2 MK |
835 | (defun viper-non-hook-settings () |
836 | ||
837 | ;; This var is not local in Emacs, so we make it local. It must be local | |
838 | ;; because although the stack of minor modes can be the same for all buffers, | |
839 | ;; the associated *keymaps* can be different. In Viper, | |
840 | ;; viper-vi-local-user-map, viper-insert-local-user-map, and others can have | |
841 | ;; different keymaps for different buffers. Also, the keymaps associated | |
842 | ;; with viper-vi/insert-state-modifier-minor-mode can be different. | |
e36a387d MK |
843 | (make-variable-buffer-local 'minor-mode-map-alist) |
844 | ||
845 | ;; Viper changes the default mode-line-buffer-identification | |
846 | (setq-default mode-line-buffer-identification '(" %b")) | |
847 | ||
848 | ;; setup emacs-supported vi-style feel | |
849 | (setq next-line-add-newlines nil | |
850 | require-final-newline t) | |
851 | ||
852 | (make-variable-buffer-local 'require-final-newline) | |
853 | ||
854 | ;; don't bark when mark is inactive | |
8626cfa2 | 855 | (if viper-emacs-p |
5489c3d3 | 856 | (setq mark-even-if-inactive t)) |
e36a387d MK |
857 | |
858 | (setq scroll-step 1) | |
859 | ||
860 | ;; Variable displaying the current Viper state in the mode line. | |
8626cfa2 MK |
861 | (viper-deflocalvar viper-mode-string viper-emacs-state-id) |
862 | (or (memq 'viper-mode-string global-mode-string) | |
e36a387d | 863 | (setq global-mode-string |
8626cfa2 | 864 | (append '("" viper-mode-string) (cdr global-mode-string)))) |
e36a387d | 865 | |
8626cfa2 | 866 | (defadvice read-key-sequence (around viper-read-keyseq-ad activate) |
e36a387d MK |
867 | "Harness to work for Viper. This advice is harmless---don't worry!" |
868 | (let (inhibit-quit event keyseq) | |
869 | (setq keyseq ad-do-it) | |
8626cfa2 | 870 | (setq event (if viper-xemacs-p |
e36a387d MK |
871 | (elt keyseq 0) ; XEmacs returns vector of events |
872 | (elt (listify-key-sequence keyseq) 0))) | |
8626cfa2 | 873 | (if (viper-ESC-event-p event) |
e36a387d | 874 | (let (unread-command-events) |
8626cfa2 MK |
875 | (viper-set-unread-command-events keyseq) |
876 | (if (viper-fast-keysequence-p) | |
877 | (let ((viper-vi-global-user-minor-mode nil) | |
878 | (viper-vi-local-user-minor-mode nil) | |
879 | (viper-replace-minor-mode nil) ; actually unnecessary | |
880 | (viper-insert-global-user-minor-mode nil) | |
881 | (viper-insert-local-user-minor-mode nil)) | |
e36a387d MK |
882 | (setq keyseq ad-do-it)) |
883 | (setq keyseq ad-do-it)))) | |
884 | keyseq)) | |
885 | ||
8626cfa2 | 886 | (defadvice describe-key (before viper-read-keyseq-ad protect activate) |
e36a387d | 887 | "Force to read key via `read-key-sequence'." |
8626cfa2 | 888 | (interactive (list (viper-events-to-keys |
e36a387d MK |
889 | (read-key-sequence "Describe key: "))))) |
890 | ||
8626cfa2 MK |
891 | (defadvice describe-key-briefly |
892 | (before viper-read-keyseq-ad protect activate) | |
e36a387d | 893 | "Force to read key via `read-key-sequence'." |
8626cfa2 | 894 | (interactive (list (viper-events-to-keys |
e36a387d MK |
895 | (read-key-sequence "Describe key briefly: "))))) |
896 | ||
897 | ||
898 | ;; Advice for use in find-file and read-file-name commands. | |
8626cfa2 MK |
899 | (defadvice exit-minibuffer (before viper-exit-minibuffer-advice activate) |
900 | "Run `viper-minibuffer-exit-hook' just before exiting the minibuffer." | |
901 | (run-hooks 'viper-minibuffer-exit-hook)) | |
e36a387d | 902 | |
8626cfa2 | 903 | (defadvice find-file (before viper-add-suffix-advice activate) |
e36a387d MK |
904 | "Use `read-file-name' for reading arguments." |
905 | (interactive (cons (read-file-name "Find file: " nil default-directory) | |
906 | ;; if Mule and prefix argument, ask for coding system | |
8626cfa2 | 907 | (cond ((and viper-emacs-p |
1e70790f MK |
908 | (boundp 'MULE)) ; Emacs 20 with MULE |
909 | nil) | |
8626cfa2 | 910 | ((and viper-xemacs-p |
1e70790f MK |
911 | (featurep 'mule)) ; XEmacs 20 with MULE |
912 | (list | |
913 | (and current-prefix-arg | |
914 | (read-coding-system | |
915 | "Coding-system: ")))) | |
916 | ) | |
e36a387d MK |
917 | ))) |
918 | ||
8626cfa2 | 919 | (defadvice find-file-other-window (before viper-add-suffix-advice activate) |
e36a387d MK |
920 | "Use `read-file-name' for reading arguments." |
921 | (interactive (cons (read-file-name "Find file in other window: " | |
922 | nil default-directory) | |
923 | ;; if Mule and prefix argument, ask for coding system | |
8626cfa2 | 924 | (cond ((and viper-emacs-p |
1e70790f MK |
925 | (boundp 'MULE)) ; Emacs 20 with MULE |
926 | nil) | |
8626cfa2 | 927 | ((and viper-xemacs-p |
1e70790f MK |
928 | (featurep 'mule)) ; XEmacs 20 with MULE |
929 | (list | |
930 | (and current-prefix-arg | |
931 | (read-coding-system | |
932 | "Coding-system: ")))) | |
933 | ) | |
e36a387d MK |
934 | ))) |
935 | ||
1e70790f | 936 | |
8626cfa2 | 937 | (defadvice find-file-other-frame (before viper-add-suffix-advice activate) |
e36a387d MK |
938 | "Use `read-file-name' for reading arguments." |
939 | (interactive (cons (read-file-name "Find file in other frame: " | |
940 | nil default-directory) | |
941 | ;; if Mule and prefix argument, ask for coding system | |
8626cfa2 | 942 | (cond ((and viper-emacs-p |
1e70790f MK |
943 | (boundp 'MULE)) ; Emacs 20 with MULE |
944 | nil) | |
8626cfa2 | 945 | ((and viper-xemacs-p |
1e70790f MK |
946 | (featurep 'mule)) ; XEmacs 20 with MULE |
947 | (list | |
948 | (and current-prefix-arg | |
949 | (read-coding-system | |
950 | "Coding-system: ")))) | |
951 | ) | |
e36a387d | 952 | ))) |
1e70790f | 953 | |
e36a387d | 954 | |
8626cfa2 MK |
955 | (defadvice read-file-name (around viper-suffix-advice activate) |
956 | "Tell `exit-minibuffer' to run `viper-file-add-suffix' as a hook." | |
957 | (let ((viper-minibuffer-exit-hook 'viper-file-add-suffix)) | |
e36a387d MK |
958 | ad-do-it)) |
959 | ||
8626cfa2 | 960 | (defadvice start-kbd-macro (after viper-kbd-advice activate) |
e36a387d MK |
961 | "Remove Viper's intercepting bindings for C-x ). |
962 | This may be needed if the previous `:map' command terminated abnormally." | |
8626cfa2 MK |
963 | (define-key viper-vi-intercept-map "\C-x)" nil) |
964 | (define-key viper-insert-intercept-map "\C-x)" nil) | |
965 | (define-key viper-emacs-intercept-map "\C-x)" nil)) | |
41497c90 MK |
966 | |
967 | ;; catch frame switching event | |
968 | (if (viper-window-display-p) | |
969 | (if viper-xemacs-p | |
970 | (add-hook 'mouse-leave-frame-hook | |
971 | 'viper-remember-current-frame) | |
972 | (defadvice handle-switch-frame (before viper-frame-advice activate) | |
973 | "Remember the selected frame before the switch-frame event." | |
974 | (viper-remember-current-frame (selected-frame)))) ) | |
975 | ||
8626cfa2 | 976 | ) ; end viper-non-hook-settings |
e36a387d | 977 | |
726e270f | 978 | \f |
41497c90 MK |
979 | ;; Ask only if this-command/last-command are nil, i.e., when loading |
980 | (cond ((and (eq viper-mode 'ask) (null this-command) (null last-command)) | |
981 | (save-window-excursion | |
982 | (with-output-to-temp-buffer " *viper-info*" | |
983 | (princ " | |
e36a387d MK |
984 | You have loaded Viper, and are about to Viperize your emacs! |
985 | ||
8626cfa2 | 986 | Viper is a Package for Emacs Rebels and a venomous VI PERil, |
e36a387d MK |
987 | |
988 | It's time to decide: to Viperize or not to Viperize... | |
989 | ||
990 | If you wish to Viperize AND make this your way of life, please put | |
991 | ||
992 | (setq viper-mode t) | |
993 | (require 'viper) | |
994 | ||
995 | in your .emacs file (preferably, close to the top). | |
996 | These two lines must come in the order given. | |
997 | ||
8626cfa2 MK |
998 | ** Viper users: |
999 | **** The startup file name has been changed from .vip to .viper | |
1000 | **** All vip-* style names have been converted to viper-* style.")) | |
41497c90 MK |
1001 | (if (y-or-n-p "Viperize? ") |
1002 | (setq viper-mode t) | |
1003 | (setq viper-mode nil)) | |
1004 | (message "") | |
1005 | (kill-buffer " *viper-info*"))) | |
1006 | ||
1007 | ;; If viper-mode is t, then just continue. Viper will kick in. | |
1008 | ((eq viper-mode t)) | |
1009 | ;; Otherwise, it was asking mode and Viper was not loaded through .emacs | |
1010 | ;; In this case, it was either through M-x viper-mode or via something | |
1011 | ;; else, like the custom widget. If Viper was loaded through | |
1012 | ;; M-x viper-mode, then viper will kick in anyway. | |
1013 | (t (setq viper-mode nil))) | |
8626cfa2 MK |
1014 | |
1015 | (defun viper-load-custom-file () | |
1016 | (if (and (file-exists-p viper-custom-file-name) | |
1017 | (not noninteractive)) | |
1018 | (load viper-custom-file-name))) | |
e36a387d | 1019 | |
726e270f MK |
1020 | |
1021 | ||
1022 | \f | |
1e70790f MK |
1023 | ;; Get viper standard value of SYMBOL. If symbol is customized, get its |
1024 | ;; standard value. Otherwise, get the value saved in the alist STORAGE. If | |
1025 | ;; STORAGE is nil, use viper-saved-user-settings. | |
1026 | (defun viper-standard-value (symbol &optional storage) | |
1027 | (or (eval (car (get symbol 'customized-value))) | |
1028 | (eval (car (get symbol 'saved-value))) | |
1029 | (nth 1 (assoc symbol (or storage viper-saved-user-settings))))) | |
1030 | ||
1031 | ||
1032 | ||
1033 | ;; save non-viper vars that Viper might change | |
1034 | (if (null viper-saved-non-viper-variables) | |
1035 | (setq viper-saved-non-viper-variables | |
1036 | (list | |
1037 | (cons 'default-major-mode (list default-major-mode)) | |
1038 | (cons 'next-line-add-newlines (list next-line-add-newlines)) | |
1039 | (cons 'require-final-newline (list require-final-newline)) | |
1e70790f MK |
1040 | (cons 'scroll-step (list scroll-step)) |
1041 | (cons 'mode-line-buffer-identification | |
1042 | (list (default-value 'mode-line-buffer-identification))) | |
1043 | (cons 'global-mode-string (list global-mode-string)) | |
8626cfa2 | 1044 | (if viper-emacs-p |
5489c3d3 | 1045 | (cons 'mark-even-if-inactive (list mark-even-if-inactive))) |
1e70790f MK |
1046 | ))) |
1047 | ||
6c2e12f4 | 1048 | |
e36a387d | 1049 | ;; Set some useful macros, advices |
1e70790f MK |
1050 | ;; These must be BEFORE ~/.viper is loaded, |
1051 | ;; so the user can unrecord them in ~/.viper. | |
e36a387d MK |
1052 | (if viper-mode |
1053 | (progn | |
1054 | ;; set advices and some variables that give emacs Vi look. | |
8626cfa2 | 1055 | (viper-non-hook-settings) |
e36a387d MK |
1056 | |
1057 | ;; repeat the 2nd previous command without rotating the command history | |
8626cfa2 MK |
1058 | (viper-record-kbd-macro |
1059 | (vector viper-repeat-from-history-key '\1) 'vi-state | |
1060 | [(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 | 1061 | ;; repeat the 3d previous command without rotating the command history |
8626cfa2 MK |
1062 | (viper-record-kbd-macro |
1063 | (vector viper-repeat-from-history-key '\2) 'vi-state | |
1064 | [(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 | 1065 | |
1e70790f | 1066 | ;; set macros for toggling case sensitivity and regexp search |
8626cfa2 | 1067 | (viper-set-searchstyle-toggling-macros nil) |
e36a387d | 1068 | ;; Make %%% toggle parsing comments for matching parentheses |
8626cfa2 MK |
1069 | (viper-set-parsing-style-toggling-macro nil) |
1070 | ||
1071 | ;; ~/.viper is loaded if exists | |
1072 | (viper-load-custom-file) | |
1073 | ||
1074 | ;; should be after loading custom file to avoid the pesky msg that | |
1075 | ;; mouse-search/insert keys are already bound | |
1076 | (viper-bind-mouse-search-key) | |
1077 | (viper-bind-mouse-insert-key) | |
e36a387d | 1078 | )) |
d695b318 | 1079 | |
6c2e12f4 | 1080 | |
6c2e12f4 | 1081 | \f |
8626cfa2 | 1082 | ;; Applying Viper customization -- runs after (load .viper) |
6c2e12f4 | 1083 | |
1e70790f MK |
1084 | ;; Save user settings or Viper defaults for vars controled by |
1085 | ;; viper-expert-level | |
1086 | (if (null viper-saved-user-settings) | |
1087 | (setq viper-saved-user-settings | |
8626cfa2 | 1088 | (list (cons 'viper-want-ctl-h-help (list viper-want-ctl-h-help)) |
1e70790f | 1089 | (cons 'viper-always (list viper-always)) |
8626cfa2 MK |
1090 | (cons 'viper-no-multiple-ESC (list viper-no-multiple-ESC)) |
1091 | (cons 'viper-ex-style-motion (list viper-ex-style-motion)) | |
1092 | (cons 'viper-ex-style-editing-in-insert | |
1093 | (list viper-ex-style-editing-in-insert)) | |
1094 | (cons 'viper-want-emacs-keys-in-vi | |
1095 | (list viper-want-emacs-keys-in-vi)) | |
1096 | (cons 'viper-electric-mode (list viper-electric-mode)) | |
1097 | (cons 'viper-want-emacs-keys-in-insert | |
1098 | (list viper-want-emacs-keys-in-insert)) | |
1099 | (cons 'viper-re-search (list viper-re-search))))) | |
6c2e12f4 KH |
1100 | |
1101 | ||
e36a387d MK |
1102 | (if viper-mode |
1103 | (progn | |
8626cfa2 MK |
1104 | (viper-set-minibuffer-style) |
1105 | (if viper-buffer-search-char | |
1106 | (viper-buffer-search-enable)) | |
1107 | (viper-update-alphanumeric-class) | |
e36a387d | 1108 | )) |
6c2e12f4 | 1109 | |
d5e52f99 | 1110 | \f |
6c2e12f4 | 1111 | ;;; Familiarize Viper with some minor modes that have their own keymaps |
e36a387d MK |
1112 | (if viper-mode |
1113 | (progn | |
8626cfa2 MK |
1114 | (viper-harness-minor-mode "compile") |
1115 | (viper-harness-minor-mode "outline") | |
1116 | (viper-harness-minor-mode "allout") | |
1117 | (viper-harness-minor-mode "xref") | |
1118 | (viper-harness-minor-mode "lmenu") | |
1119 | (viper-harness-minor-mode "vc") | |
1120 | (viper-harness-minor-mode "ltx-math") ; LaTeX-math-mode in AUC-TeX, which | |
1121 | (viper-harness-minor-mode "latex") ; sits in one of these two files | |
1122 | (viper-harness-minor-mode "cyrillic") | |
1123 | (viper-harness-minor-mode "russian") | |
1124 | (viper-harness-minor-mode "view-less") | |
1125 | (viper-harness-minor-mode "view") | |
e36a387d | 1126 | )) |
6c2e12f4 KH |
1127 | |
1128 | ||
1129 | ;; Intercept maps could go in viper-keym.el | |
1e70790f | 1130 | ;; We keep them here in case someone redefines them in ~/.viper |
6c2e12f4 | 1131 | |
8626cfa2 MK |
1132 | (define-key viper-vi-intercept-map viper-ESC-key 'viper-intercept-ESC-key) |
1133 | (define-key viper-insert-intercept-map viper-ESC-key 'viper-intercept-ESC-key) | |
6c2e12f4 | 1134 | |
8626cfa2 MK |
1135 | ;; This is taken care of by viper-insert-global-user-map. |
1136 | ;;(define-key viper-replace-map viper-ESC-key 'viper-intercept-ESC-key) | |
6c2e12f4 | 1137 | |
34da0a2b | 1138 | |
8626cfa2 | 1139 | ;; The default viper-toggle-key is \C-z; for the novice, it suspends or |
6c2e12f4 | 1140 | ;; iconifies Emacs |
8626cfa2 MK |
1141 | (define-key viper-vi-intercept-map viper-toggle-key 'viper-toggle-key-action) |
1142 | (define-key | |
1143 | viper-emacs-intercept-map viper-toggle-key 'viper-change-state-to-vi) | |
6c2e12f4 KH |
1144 | |
1145 | ||
e36a387d MK |
1146 | (if (and viper-mode |
1147 | (or viper-always | |
1e70790f | 1148 | (and (< viper-expert-level 5) (> viper-expert-level 0)))) |
8626cfa2 | 1149 | (viper-set-hooks)) |
6c2e12f4 KH |
1150 | |
1151 | ;; Let all minor modes take effect after loading | |
1152 | ;; this may not be enough, so we also set default minor-mode-alist. | |
1153 | ;; Without setting the default, new buffers that come up in emacs mode have | |
8626cfa2 MK |
1154 | ;; minor-mode-map-alist = nil, unless we call viper-change-state-* |
1155 | (if (eq viper-current-state 'emacs-state) | |
6c2e12f4 | 1156 | (progn |
8626cfa2 | 1157 | (viper-change-state-to-emacs) |
6c2e12f4 KH |
1158 | (setq-default minor-mode-map-alist minor-mode-map-alist) |
1159 | )) | |
1160 | ||
6c2e12f4 | 1161 | |
d5e52f99 | 1162 | |
8626cfa2 | 1163 | (run-hooks 'viper-load-hook) ; the last chance to change something |
6c2e12f4 | 1164 | |
d5e52f99 | 1165 | (provide 'viper) |
6c2e12f4 | 1166 | |
1e70790f MK |
1167 | |
1168 | ;;; Local Variables: | |
8626cfa2 | 1169 | ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun) |
1e70790f MK |
1170 | ;;; End: |
1171 | ||
6c2e12f4 | 1172 | ;;; viper.el ends here |