|
0
|
1 ;;; viper.el --- A full-featured Vi emulator for GNU Emacs 19 and XEmacs 19,
|
|
|
2 ;; a VI Plan for Emacs Rescue,
|
|
|
3 ;; and a venomous VI PERil.
|
|
|
4 ;; Viper Is also a Package for Emacs Rebels.
|
|
|
5 ;;
|
|
|
6 ;; Keywords: emulations
|
|
|
7 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
|
|
|
8
|
|
82
|
9 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
|
|
|
10
|
|
175
|
11 (defconst viper-version "2.95 of July 9, 1997"
|
|
0
|
12 "The current version of Viper")
|
|
|
13
|
|
|
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
|
|
78
|
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.
|
|
0
|
30
|
|
|
31 ;;; Commentary:
|
|
|
32
|
|
|
33 ;; Viper is a full-featured Vi emulator for Emacs 19. It emulates and
|
|
|
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.
|
|
78
|
92 ;; Buffer-specific definitions override mode-specific
|
|
0
|
93 ;; definitions, which, in turn, override global definitions.
|
|
|
94 ;;
|
|
|
95 ;;
|
|
|
96 ;;; Installation:
|
|
|
97 ;; -------------
|
|
|
98 ;;
|
|
|
99 ;; (require 'viper)
|
|
|
100 ;;
|
|
|
101
|
|
|
102 ;;; Acknowledgements:
|
|
|
103 ;; -----------------
|
|
78
|
104 ;; Bug reports and ideas contributed by many users have helped
|
|
|
105 ;; improve Viper and the various versions of VIP.
|
|
0
|
106 ;; See the on-line manual for a complete list of contributors.
|
|
|
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
|
|
|
118 ;; use kill-all-local-variables when they start). Some major modes
|
|
|
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
|
|
|
127 ;; (add-hook 'your-favorite-mode 'vip-change-state-to-emacs)
|
|
|
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
|
|
|
134 ;; Because Emacs 19 has an elegant mechanism for turning minor mode keymaps
|
|
|
135 ;; on and off, implementation of Viper has been greatly simplified. Viper
|
|
|
136 ;; has several minor modes.
|
|
|
137 ;;
|
|
|
138 ;; Viper's Vi state consists of seven minor modes:
|
|
|
139 ;;
|
|
|
140 ;; vip-vi-intercept-minor-mode
|
|
|
141 ;; vip-vi-local-user-minor-mode
|
|
|
142 ;; vip-vi-global-user-minor-mode
|
|
|
143 ;; vip-vi-kbd-minor-mode
|
|
|
144 ;; vip-vi-state-modifier-minor-mode
|
|
|
145 ;; vip-vi-diehard-minor-mode
|
|
|
146 ;; vip-vi-basic-minor-mode
|
|
|
147 ;;
|
|
|
148 ;; Bindings done to the keymap of the first mode overshadow those done to
|
|
|
149 ;; the second, which, in turn, overshadows those done to the third, etc.
|
|
|
150 ;;
|
|
|
151 ;; The last vip-vi-basic-minor-mode contains most of the usual Vi bindings
|
|
|
152 ;; in its edit mode. This mode provides access to all Emacs facilities.
|
|
175
|
153 ;; Novice users, however, may want to set their viper-expert-level to 1
|
|
0
|
154 ;; in their .vip file. This will enable vip-vi-diehard-minor-mode. This
|
|
|
155 ;; minor mode's bindings make Viper simulate the usual Vi very closely.
|
|
|
156 ;; For instance, C-c will not have its standard Emacs binding
|
|
|
157 ;; and so many of the goodies of Emacs are not available.
|
|
|
158 ;;
|
|
175
|
159 ;; A skilled user should set viper-expert-level to at least 3. This will
|
|
80
|
160 ;; enable `C-c' and many Emacs facilities will become available.
|
|
0
|
161 ;; In this case, vip-vi-diehard-minor-mode is inactive.
|
|
|
162 ;;
|
|
|
163 ;; Viper gurus should have at least
|
|
175
|
164 ;; (setq viper-expert-level 4)
|
|
|
165 ;; in their ~/.viper files. This will unsuppress all Emacs keys that are not
|
|
0
|
166 ;; essential for VI-style editing.
|
|
|
167 ;; Pick-and-choose users may want to put
|
|
175
|
168 ;; (setq viper-expert-level 5)
|
|
|
169 ;; in ~/.viper. Viper will then leave it up to the user to set the variables
|
|
|
170 ;; vip-want-* See viper-set-expert-level for details.
|
|
0
|
171 ;;
|
|
|
172 ;; The very first minor mode, vip-vi-intercept-minor-mode, is of no
|
|
|
173 ;; concern for the user. It is needed to bind Viper's vital keys, such as
|
|
|
174 ;; ESC and C-z.
|
|
|
175 ;;
|
|
|
176 ;; The second mode, vip-vi-local-user-minor-mode, usually has an
|
|
|
177 ;; empty keymap. However, the user can set bindings in this keymap, which
|
|
|
178 ;; will overshadow the corresponding bindings in the other two minor
|
|
|
179 ;; modes. This is useful, for example, for setting up ZZ in gnus,
|
|
|
180 ;; rmail, mh-e, etc., to send message instead of saving it in a file.
|
|
|
181 ;; Likewise, in Dired mode, you may want to bind ZN and ZP to commands
|
|
|
182 ;; that would visit the next or the previous file in the Dired buffer.
|
|
|
183 ;; Setting local keys is tricky, so don't do it directly. Instead, use
|
|
|
184 ;; vip-add-local-keys function (see its doc).
|
|
|
185 ;;
|
|
|
186 ;; The third minor mode, vip-vi-global-user-minor-mode, is also intended
|
|
|
187 ;; for the users but, unlike vip-vi-local-user-minor-mode, its key
|
|
|
188 ;; bindings are seen in all Viper buffers. This mode keys can be done
|
|
|
189 ;; with define-key command.
|
|
|
190 ;;
|
|
|
191 ;; The fourth minor mode, vip-vi-kbd-minor-mode, is used by keyboard
|
|
|
192 ;; macros. Users are NOT supposed to modify this keymap directly.
|
|
|
193 ;;
|
|
|
194 ;; The fifth mode, vip-vi-state-modifier-minor-mode, can be used to set
|
|
|
195 ;; key bindings that are visible in some major modes but not in others.
|
|
|
196 ;;
|
|
|
197 ;; Users are allowed to modify keymaps that belong to
|
|
|
198 ;; vip-vi-local-user-minor-mode, vip-vi-global-user-minor-mode,
|
|
|
199 ;; and vip-vi-state-modifier-minor-mode only.
|
|
|
200 ;;
|
|
|
201 ;; Viper's Insert state also has seven minor modes:
|
|
|
202 ;;
|
|
|
203 ;; vip-insert-intercept-minor-mode
|
|
|
204 ;; vip-insert-local-user-minor-mode
|
|
|
205 ;; vip-insert-global-user-minor-mode
|
|
|
206 ;; vip-insert-kbd-minor-mode
|
|
|
207 ;; vip-insert-state-modifier-minor-mode
|
|
|
208 ;; vip-insert-diehard-minor-mode
|
|
|
209 ;; vip-insert-basic-minor-mode
|
|
|
210 ;;
|
|
|
211 ;; As with VI's editing modes, the first mode, vip-insert-intercept-minor-mode
|
|
|
212 ;; is used to bind vital keys that are not to be changed by the user.
|
|
|
213 ;;
|
|
|
214 ;; The next mode, vip-insert-local-user-minor-mode, is used to customize
|
|
|
215 ;; bindings in the insert state of Viper. The third mode,
|
|
|
216 ;; vip-insert-global-user-minor-mode is like
|
|
|
217 ;; vip-insert-local-user-minor-mode, except that its bindings are seen in
|
|
|
218 ;; all Viper buffers. As with vip-vi-local-user-minor-mode, its bindings
|
|
|
219 ;; should be done via the function vip-add-local-keys. Bindings for
|
|
|
220 ;; vip-insert-global-user-minor-mode can be set with the define-key command.
|
|
|
221 ;;
|
|
|
222 ;; The next minor mode, vip-insert-kbd-minor-mode,
|
|
|
223 ;; is used for keyboard VI-style macros defined with :map!.
|
|
|
224 ;;
|
|
|
225 ;; The fifth minor mode, vip-insert-state-modifier-minor-mode, is like
|
|
|
226 ;; vip-vi-state-modifier-minor-mode, except that it is used in the Insert
|
|
|
227 ;; state; it can be used to modify keys in a mode-specific fashion.
|
|
|
228 ;;
|
|
|
229 ;; The minor mode vip-insert-diehard-minor-mode is in effect when
|
|
|
230 ;; the user wants a high degree of Vi compatibility (a bad idea, really!).
|
|
|
231 ;; The last minor mode, vip-insert-basic-minor-mode, is always in effect
|
|
|
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 ;;
|
|
|
238 ;; vip-emacs-local-user-minor-mode
|
|
|
239 ;; vip-emacs-global-user-minor-mode
|
|
|
240 ;; vip-emacs-kbd-minor-mode
|
|
|
241 ;; vip-emacs-state-modifier-minor-mode
|
|
|
242 ;;
|
|
|
243 ;; These minor modes are in effect when Viper is in Emacs state. The keymap
|
|
|
244 ;; associated with vip-emacs-global-user-minor-mode,
|
|
|
245 ;; vip-emacs-global-user-map, overrides the global and local keymaps as
|
|
|
246 ;; well as the minor mode keymaps set by other modes. The keymap of
|
|
|
247 ;; vip-emacs-local-user-minor-mode, vip-emacs-local-user-map, overrides
|
|
|
248 ;; everything, but it is used on a per buffer basis.
|
|
|
249 ;; The keymap associated with vip-emacs-state-modifier-minor-mode
|
|
|
250 ;; overrides keys on a per-major-mode basis. The mode
|
|
|
251 ;; vip-emacs-kbd-minor-mode is used to define Vi-style macros in Emacs
|
|
|
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 ;;
|
|
|
258 ;; vip-replace-minor-mode
|
|
|
259 ;;
|
|
|
260 ;; and its keymap is vip-replace-map. Replace minor mode is always
|
|
|
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.
|
|
|
267 ;; Viper provides a special function, vip-add-local-keys, to do precisely
|
|
|
268 ;; this. For instance, is you need to add couple of mode-specific bindings
|
|
|
269 ;; to Insert mode, you can put
|
|
|
270 ;;
|
|
|
271 ;; (vip-add-local-keys 'insert-state '((key1 . func1) (key2 .func2)))
|
|
|
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
|
|
|
275 ;; buffer that was current at the time of the call to vip-add-local-keys.
|
|
|
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
|
|
|
278 ;; (kill-all-local-variables). See vip-add-local-keys for more details.
|
|
|
279 ;;
|
|
|
280 ;;
|
|
|
281 ;; TO DO (volunteers?):
|
|
|
282 ;;
|
|
|
283 ;; 1. Some of the code that is inherited from VIP-3.5 is rather
|
|
|
284 ;; convoluted. Instead of vip-command-argument, keymaps should bind the
|
|
|
285 ;; actual commands. E.g., "dw" should be bound to a generic command
|
|
|
286 ;; vip-delete that will delete things based on the value of
|
|
|
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
|
|
|
297 ;; Code
|
|
|
298
|
|
|
299 (require 'advice)
|
|
|
300 (require 'cl)
|
|
|
301 (require 'ring)
|
|
|
302
|
|
163
|
303 ;; compiler pacifier
|
|
80
|
304 (defvar mark-even-if-inactive)
|
|
175
|
305 (defvar viper-expert-level)
|
|
|
306 (defvar vip-expert-level)
|
|
80
|
307
|
|
163
|
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)))
|
|
177
|
313 (or (featurep 'viper-init)
|
|
|
314 (load "viper-init.el" nil nil 'nosuffix))
|
|
163
|
315 (or (featurep 'viper-cmd)
|
|
|
316 (load "viper-cmd.el" nil nil 'nosuffix))
|
|
|
317 )))
|
|
0
|
318 ;; end pacifier
|
|
|
319
|
|
177
|
320 (require 'viper-init)
|
|
|
321
|
|
175
|
322 ;; better be defined before Viper custom group.
|
|
|
323 (defvar vip-custom-file-name (vip-convert-standard-file-name "~/.viper")
|
|
|
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.
|
|
|
329 NOTE: Viper customization should be saved in `vip-custom-file-name', which
|
|
|
330 defaults to `~/.viper'."
|
|
|
331 :prefix "vip-"
|
|
|
332 :group 'emulations)
|
|
|
333
|
|
163
|
334 (require 'viper-cmd)
|
|
0
|
335
|
|
163
|
336 (defvar vip-always t
|
|
|
337 "See `viper-always'. This variable is for compatibility with older Vipers.")
|
|
175
|
338 (defcustom viper-always vip-always
|
|
163
|
339 "Non-nil means, arrange for vi-state to be a default when appropriate.
|
|
|
340 This is different from `viper-mode' variable in that `viper-mode' determines
|
|
|
341 whether to use Viper in the first place, while `viper-always', if nil, lets
|
|
175
|
342 user decide when to invoke Viper in a major mode."
|
|
|
343 :type 'boolean
|
|
|
344 :tag "Always Invoke Viper"
|
|
|
345 :group 'viper)
|
|
0
|
346
|
|
175
|
347 ;; Non-viper variables that need to be saved in case the user decides to
|
|
|
348 ;; de-viperize emacs.
|
|
|
349 (defvar viper-saved-non-viper-variables nil)
|
|
|
350 ;; Contains user settings for vars affected by viper-set-expert-level function.
|
|
|
351 ;; Not a user option.
|
|
|
352 (defvar viper-saved-user-settings nil)
|
|
|
353
|
|
|
354 (defcustom viper-mode (cond (noninteractive nil)
|
|
|
355 (t 'ask))
|
|
|
356 "To Viperize or not to Viperize.
|
|
163
|
357 If t, viperize emacs. If nil -- don't. If `ask', ask the user.
|
|
|
358 This variable is used primatily when Viper is being loaded.
|
|
0
|
359
|
|
163
|
360 Must be set in `~/.emacs' before Viper is loaded.
|
|
175
|
361 DO NOT set this variable interactively."
|
|
|
362 :type '(choice (const nil) (const t) (const ask))
|
|
|
363 :tag "Set Viper Mode on Loading"
|
|
|
364 :group 'viper)
|
|
0
|
365
|
|
|
366
|
|
163
|
367 ;; The following are provided for compatibility with older VIP's
|
|
0
|
368
|
|
163
|
369 ;;;###autoload
|
|
|
370 (defalias 'vip-mode 'viper-mode)
|
|
0
|
371
|
|
163
|
372 (defalias 'vip-change-mode-to-vi 'vip-change-state-to-vi)
|
|
|
373 (defalias 'vip-change-mode-to-insert 'vip-change-state-to-insert)
|
|
|
374 (defalias 'vip-change-mode-to-emacs 'vip-change-state-to-emacs)
|
|
0
|
375
|
|
175
|
376
|
|
0
|
377
|
|
|
378
|
|
|
379 ;;;###autoload
|
|
|
380 (defun viper-mode ()
|
|
|
381 "Turn on Viper emulation of Vi."
|
|
|
382 (interactive)
|
|
|
383 (if (not noninteractive)
|
|
|
384 (progn
|
|
163
|
385 ;; if the user requested viper-mode explicitly
|
|
|
386 (if viper-mode
|
|
|
387 ()
|
|
|
388 (setq viper-mode 1)
|
|
|
389 (load-library "viper"))
|
|
|
390
|
|
0
|
391 (if vip-first-time ; This check is important. Without it, startup and
|
|
|
392 (progn ; expert-level msgs mix up when viper-mode recurses
|
|
|
393 (setq vip-first-time nil)
|
|
|
394 (if (not vip-inhibit-startup-message)
|
|
|
395 (save-window-excursion
|
|
|
396 (setq vip-inhibit-startup-message t)
|
|
|
397 (delete-other-windows)
|
|
|
398 (switch-to-buffer "Viper Startup Message")
|
|
|
399 (erase-buffer)
|
|
|
400 (insert
|
|
|
401 (substitute-command-keys
|
|
175
|
402 "Viper Is a Package for Emacs Rebels,
|
|
|
403 a VI Plan for Emacs Rescue, and a venomous VI PERil.
|
|
0
|
404
|
|
175
|
405 Incidentally, Viper emulates Vi under GNU Emacs 20 and XEmacs 20.
|
|
|
406 It supports all of what is good in Vi and Ex, while extending
|
|
0
|
407 and improving upon much of it.
|
|
|
408
|
|
|
409 1. Viper supports Vi at several levels. Level 1 is the closest to Vi,
|
|
|
410 level 5 provides the most flexibility to depart from many Vi conventions.
|
|
|
411
|
|
|
412 You will be asked to specify your user level in a following screen.
|
|
|
413
|
|
|
414 If you select user level 1 then the keys ^X, ^C, ^Z, and ^G will behave
|
|
|
415 as in VI, to smooth transition to Viper for the beginners. However, to
|
|
|
416 use Emacs productively, you are advised to reach user level 3 or higher.
|
|
|
417
|
|
175
|
418 At user level 2 or higher, ^X and ^C have Emacs, not Vi, bindings;
|
|
|
419 ^Z toggles Vi/Emacs states; ^G is Emacs' keyboard-quit (like ^C in Vi).
|
|
0
|
420
|
|
|
421 2. Vi exit functions (e.g., :wq, ZZ) work on INDIVIDUAL files -- they
|
|
175
|
422 do not cause Emacs to quit, except at user level 1 (for a novice).
|
|
0
|
423 3. ^X^C EXITS EMACS.
|
|
|
424 4. Viper supports multiple undo: `u' will undo. Typing `.' will repeat
|
|
|
425 undo. Another `u' changes direction.
|
|
|
426
|
|
175
|
427 6. Emacs Meta key is `C-\\' (in all modes) or `\\ ESC' (in Vi command mode).
|
|
|
428 On a window system, the best way is to use the Meta-key on your keyboard.
|
|
0
|
429 7. Try \\[keyboard-quit] and \\[abort-recursive-edit] repeatedly,if
|
|
|
430 something funny happens. This would abort the current editing command.
|
|
|
431
|
|
175
|
432 For more information on Viper:
|
|
0
|
433
|
|
175
|
434 a. Type `:help' in Vi command mode
|
|
|
435 b. Print Viper manual, found in ./etc/viper.dvi
|
|
|
436 c. Print the Quick Reference, found in ./etc/viperCard.dvi
|
|
|
437
|
|
|
438 To submit a bug report or to contact the author, type :submitReport in Vi
|
|
|
439 command mode. To shoo Viper away and return to pure Emacs (horror!), type:
|
|
|
440
|
|
|
441 M-x viper-go-away
|
|
0
|
442
|
|
|
443 This startup message appears whenever you load Viper, unless you type `y' now."
|
|
|
444 ))
|
|
|
445 (goto-char (point-min))
|
|
|
446 (if (y-or-n-p "Inhibit Viper startup message? ")
|
|
|
447 (vip-save-setting
|
|
|
448 'vip-inhibit-startup-message
|
|
|
449 "Viper startup message inhibited"
|
|
|
450 vip-custom-file-name t))
|
|
|
451 ;;(kill-buffer (current-buffer))
|
|
|
452 (message
|
|
|
453 "The last message is in buffer `Viper Startup Message'")
|
|
|
454 (sit-for 4)
|
|
|
455 ))
|
|
175
|
456 (viper-set-expert-level 'dont-change-unless)))
|
|
0
|
457 (vip-change-state-to-vi))))
|
|
163
|
458
|
|
0
|
459
|
|
|
460 ;; This hook designed to enable Vi-style editing in comint-based modes."
|
|
|
461 (defun vip-comint-mode-hook ()
|
|
78
|
462 (setq require-final-newline nil
|
|
|
463 vip-ex-style-editing-in-insert nil
|
|
0
|
464 vip-ex-style-motion nil)
|
|
78
|
465 (vip-change-state-to-insert))
|
|
|
466
|
|
0
|
467
|
|
175
|
468 ;; remove viper hooks from SYMBOL
|
|
|
469 (defun viper-remove-hooks (symbol)
|
|
|
470 (cond ((not (boundp symbol)) nil)
|
|
|
471 ((not (listp (eval symbol))) nil)
|
|
|
472 ((string-match "-hook" (symbol-name symbol))
|
|
|
473 (remove-hook symbol 'viper-mode)
|
|
|
474 (remove-hook symbol 'vip-change-state-to-emacs)
|
|
|
475 (remove-hook symbol 'vip-change-state-to-insert)
|
|
|
476 (remove-hook symbol 'vip-change-state-to-vi)
|
|
|
477 )))
|
|
|
478
|
|
|
479 ;; Remove local value in all existing buffers
|
|
|
480 ;; This doesn't delocalize vars (which would have been desirable)
|
|
|
481 (defun viper-delocalize-var (symbol)
|
|
|
482 (mapcar (function (lambda (buf)
|
|
|
483 (save-excursion
|
|
|
484 (set-buffer buf)
|
|
|
485 (kill-local-variable symbol))))
|
|
|
486 (buffer-list)))
|
|
|
487
|
|
|
488
|
|
|
489 (defun viper-go-away ()
|
|
|
490 "De-Viperize Emacs.
|
|
|
491 This function tries to do as good a job as possible. However, it may undo some
|
|
|
492 user customization, unrelated to Viper. For instance, if the user advised
|
|
|
493 `read-file-name', `describe-key', and some others, then this advice will be
|
|
|
494 undone.
|
|
|
495 It also doesn't undo some Viper settings. For instance, `minor-mode-map-alist'
|
|
|
496 remains buffer-local."
|
|
|
497 (interactive)
|
|
|
498
|
|
|
499 ;; restore non-viper vars
|
|
|
500 (setq-default
|
|
|
501 default-major-mode
|
|
|
502 (viper-standard-value 'default-major-mode viper-saved-non-viper-variables)
|
|
|
503 next-line-add-newlines
|
|
|
504 (viper-standard-value
|
|
|
505 'next-line-add-newlines viper-saved-non-viper-variables)
|
|
|
506 require-final-newline
|
|
|
507 (viper-standard-value
|
|
|
508 'require-final-newline viper-saved-non-viper-variables)
|
|
|
509 scroll-step
|
|
|
510 (viper-standard-value 'scroll-step viper-saved-non-viper-variables)
|
|
|
511 mode-line-buffer-identification
|
|
|
512 (viper-standard-value
|
|
|
513 'mode-line-buffer-identification viper-saved-non-viper-variables)
|
|
|
514 global-mode-string
|
|
|
515 (viper-standard-value 'global-mode-string viper-saved-non-viper-variables))
|
|
|
516
|
|
|
517 (if vip-emacs-p
|
|
|
518 (setq-default
|
|
|
519 mark-even-if-inactive
|
|
|
520 (viper-standard-value
|
|
|
521 'mark-even-if-inactive viper-saved-non-viper-variables)))
|
|
|
522
|
|
|
523 ;; Ideally, we would like to be able to de-localize local variables
|
|
|
524 (viper-delocalize-var 'minor-mode-map-alist)
|
|
|
525 (viper-delocalize-var 'require-final-newline)
|
|
|
526
|
|
|
527
|
|
|
528 ;; deactivate all advices done by Viper.
|
|
|
529 (ad-deactivate-regexp "vip-")
|
|
|
530
|
|
|
531 (setq viper-mode nil)
|
|
|
532
|
|
|
533 (viper-delocalize-var 'vip-vi-minibuffer-minor-mode)
|
|
|
534 (viper-delocalize-var 'vip-insert-minibuffer-minor-mode)
|
|
|
535 (viper-delocalize-var 'vip-vi-intercept-minor-mode)
|
|
|
536 (viper-delocalize-var 'vip-insert-intercept-minor-mode)
|
|
|
537
|
|
|
538 (viper-delocalize-var 'vip-vi-local-user-minor-mode)
|
|
|
539 (viper-delocalize-var 'vip-vi-kbd-minor-mode)
|
|
|
540 (viper-delocalize-var 'vip-vi-global-user-minor-mode)
|
|
|
541 (viper-delocalize-var 'vip-vi-state-modifier-minor-mode)
|
|
|
542 (viper-delocalize-var 'vip-vi-diehard-minor-mode)
|
|
|
543 (viper-delocalize-var 'vip-vi-basic-minor-mode)
|
|
|
544
|
|
|
545 (viper-delocalize-var 'vip-replace-minor-mode)
|
|
|
546
|
|
|
547 (viper-delocalize-var 'vip-insert-local-user-minor-mode)
|
|
|
548 (viper-delocalize-var 'vip-insert-kbd-minor-mode)
|
|
|
549 (viper-delocalize-var 'vip-insert-global-user-minor-mode)
|
|
|
550 (viper-delocalize-var 'vip-insert-state-modifier-minor-mode)
|
|
|
551 (viper-delocalize-var 'vip-insert-diehard-minor-mode)
|
|
|
552 (viper-delocalize-var 'vip-insert-basic-minor-mode)
|
|
|
553
|
|
|
554 (viper-delocalize-var 'vip-emacs-intercept-minor-mode)
|
|
|
555 (viper-delocalize-var 'vip-emacs-local-user-minor-mode)
|
|
|
556 (viper-delocalize-var 'vip-emacs-kbd-minor-mode)
|
|
|
557 (viper-delocalize-var 'vip-emacs-global-user-minor-mode)
|
|
|
558 (viper-delocalize-var 'vip-emacs-state-modifier-minor-mode)
|
|
|
559
|
|
|
560 (setq-default vip-vi-minibuffer-minor-mode nil
|
|
|
561 vip-insert-minibuffer-minor-mode nil
|
|
|
562 vip-vi-intercept-minor-mode nil
|
|
|
563 vip-insert-intercept-minor-mode nil
|
|
|
564
|
|
|
565 vip-vi-local-user-minor-mode nil
|
|
|
566 vip-vi-kbd-minor-mode nil
|
|
|
567 vip-vi-global-user-minor-mode nil
|
|
|
568 vip-vi-state-modifier-minor-mode nil
|
|
|
569 vip-vi-diehard-minor-mode nil
|
|
|
570 vip-vi-basic-minor-mode nil
|
|
|
571
|
|
|
572 vip-replace-minor-mode nil
|
|
|
573
|
|
|
574 vip-insert-local-user-minor-mode nil
|
|
|
575 vip-insert-kbd-minor-mode nil
|
|
|
576 vip-insert-global-user-minor-mode nil
|
|
|
577 vip-insert-state-modifier-minor-mode nil
|
|
|
578 vip-insert-diehard-minor-mode nil
|
|
|
579 vip-insert-basic-minor-mode nil
|
|
|
580
|
|
|
581 vip-emacs-intercept-minor-mode nil
|
|
|
582 vip-emacs-local-user-minor-mode nil
|
|
|
583 vip-emacs-kbd-minor-mode nil
|
|
|
584 vip-emacs-global-user-minor-mode nil
|
|
|
585 vip-emacs-state-modifier-minor-mode nil
|
|
|
586 )
|
|
|
587
|
|
|
588 ;; remove all hooks set by viper
|
|
|
589 (mapatoms 'viper-remove-hooks)
|
|
|
590 (remove-hook 'comint-mode-hook 'vip-comint-mode-hook)
|
|
|
591 (remove-hook 'minibuffer-setup-hook 'vip-minibuffer-setup-sentinel)
|
|
|
592 )
|
|
|
593
|
|
|
594
|
|
|
595
|
|
|
596
|
|
0
|
597 ;; This sets major mode hooks to make them come up in vi-state.
|
|
|
598 (defun vip-set-hooks ()
|
|
|
599
|
|
|
600 ;; It is of course a misnomer to call viper-mode a `major mode'.
|
|
|
601 ;; However, this has the effect that if the user didn't specify the
|
|
|
602 ;; default mode, new buffers that fall back on the default will come up
|
|
|
603 ;; in Fundamental Mode and Vi state.
|
|
|
604 (setq default-major-mode 'viper-mode)
|
|
|
605
|
|
|
606 ;; The following major modes should come up in vi-state
|
|
|
607 (defadvice fundamental-mode (after vip-fundamental-mode-ad activate)
|
|
|
608 "Run `vip-change-state-to-vi' on entry."
|
|
|
609 (vip-change-state-to-vi))
|
|
|
610
|
|
|
611 (defvar makefile-mode-hook)
|
|
|
612 (add-hook 'makefile-mode-hook 'viper-mode)
|
|
|
613
|
|
|
614 (defvar help-mode-hook)
|
|
|
615 (add-hook 'help-mode-hook 'viper-mode)
|
|
100
|
616 (vip-modify-major-mode 'help-mode 'vi-state vip-help-modifier-map)
|
|
0
|
617
|
|
|
618 (defvar awk-mode-hook)
|
|
|
619 (add-hook 'awk-mode-hook 'viper-mode)
|
|
|
620
|
|
|
621 (defvar html-mode-hook)
|
|
|
622 (add-hook 'html-mode-hook 'viper-mode)
|
|
|
623 (defvar html-helper-mode-hook)
|
|
|
624 (add-hook 'html-helper-mode-hook 'viper-mode)
|
|
163
|
625
|
|
78
|
626 (defvar java-mode-hook)
|
|
|
627 (add-hook 'java-mode-hook 'viper-mode)
|
|
80
|
628
|
|
175
|
629 (defvar javascript-mode-hook)
|
|
|
630 (add-hook 'javascript-mode-hook 'viper-mode)
|
|
|
631
|
|
0
|
632 (defvar emacs-lisp-mode-hook)
|
|
|
633 (add-hook 'emacs-lisp-mode-hook 'viper-mode)
|
|
|
634 (defvar lisp-mode-hook)
|
|
|
635 (add-hook 'lisp-mode-hook 'viper-mode)
|
|
163
|
636 (defvar lisp-interaction-mode-hook)
|
|
|
637 (add-hook 'lisp-interaction-mode-hook 'viper-mode)
|
|
0
|
638
|
|
|
639 (defvar bibtex-mode-hook)
|
|
|
640 (add-hook 'bibtex-mode-hook 'viper-mode)
|
|
|
641
|
|
|
642 (defvar cc-mode-hook)
|
|
|
643 (add-hook 'cc-mode-hook 'viper-mode)
|
|
|
644
|
|
|
645 (defvar c-mode-hook)
|
|
|
646 (add-hook 'c-mode-hook 'viper-mode)
|
|
|
647
|
|
|
648 (defvar c++-mode-hook)
|
|
|
649 (add-hook 'c++-mode-hook 'viper-mode)
|
|
|
650
|
|
|
651 (defvar fortran-mode-hook)
|
|
163
|
652 (add-hook 'fortran-mode-hook 'viper-mode)
|
|
|
653 (defvar f90-mode-hook)
|
|
|
654 (add-hook 'f90-mode-hook 'viper-mode)
|
|
80
|
655
|
|
78
|
656 (defvar basic-mode-hook)
|
|
163
|
657 (add-hook 'basic-mode-hook 'viper-mode)
|
|
78
|
658 (defvar bat-mode-hook)
|
|
163
|
659 (add-hook 'bat-mode-hook 'viper-mode)
|
|
|
660
|
|
|
661 (defvar asm-mode-hook)
|
|
|
662 (add-hook 'asm-mode-hook 'viper-mode)
|
|
|
663
|
|
|
664 (defvar prolog-mode-hook)
|
|
|
665 (add-hook 'prolog-mode-hook 'viper-mode)
|
|
80
|
666
|
|
0
|
667 (defvar text-mode-hook)
|
|
|
668 (add-hook 'text-mode-hook 'viper-mode)
|
|
|
669
|
|
|
670 (add-hook 'completion-list-mode-hook 'viper-mode)
|
|
|
671 (add-hook 'compilation-mode-hook 'viper-mode)
|
|
|
672
|
|
175
|
673 (defvar perl-mode-hook)
|
|
|
674 (add-hook 'perl-mode-hook 'viper-mode)
|
|
|
675
|
|
|
676 (defvar tcl-mode-hook)
|
|
|
677 (add-hook 'tcl-mode-hook 'viper-mode)
|
|
|
678
|
|
|
679 (defvar python-mode-hook)
|
|
|
680 (add-hook 'python-mode-hook 'viper-mode)
|
|
0
|
681
|
|
|
682 (defvar emerge-startup-hook)
|
|
|
683 (add-hook 'emerge-startup-hook 'vip-change-state-to-emacs)
|
|
78
|
684
|
|
|
685 ;; Tell vc-diff to put *vc* in Vi mode
|
|
|
686 (if (featurep 'vc)
|
|
|
687 (defadvice vc-diff (after vip-vc-ad activate)
|
|
|
688 "Force Vi state in VC diff buffer."
|
|
|
689 (vip-change-state-to-vi))
|
|
|
690 (vip-eval-after-load
|
|
|
691 "vc"
|
|
|
692 '(defadvice vc-diff (after vip-vc-ad activate)
|
|
|
693 "Force Vi state in VC diff buffer."
|
|
|
694 (vip-change-state-to-vi))))
|
|
80
|
695
|
|
0
|
696 (vip-eval-after-load
|
|
|
697 "emerge"
|
|
|
698 '(defadvice emerge-quit (after vip-emerge-advice activate)
|
|
|
699 "Run `vip-change-state-to-vi' after quitting emerge."
|
|
|
700 (vip-change-state-to-vi)))
|
|
|
701 ;; In case Emerge was loaded before Viper.
|
|
|
702 (defadvice emerge-quit (after vip-emerge-advice activate)
|
|
|
703 "Run `vip-change-state-to-vi' after quitting emerge."
|
|
|
704 (vip-change-state-to-vi))
|
|
|
705
|
|
|
706 ;; passwd.el sets up its own buffer, which turns up in Vi mode,
|
|
|
707 ;; thus overriding the local map. We don't need Vi mode here.
|
|
|
708 (vip-eval-after-load
|
|
|
709 "passwd"
|
|
|
710 '(defadvice read-passwd-1 (before vip-passwd-ad activate)
|
|
|
711 "Switch to emacs state while reading password."
|
|
|
712 (vip-change-state-to-emacs)))
|
|
|
713
|
|
|
714 ;; Emacs shell, ange-ftp, and comint-based modes
|
|
|
715 (defvar comint-mode-hook)
|
|
78
|
716 (vip-modify-major-mode
|
|
|
717 'comint-mode 'insert-state vip-comint-mode-modifier-map)
|
|
|
718 (vip-modify-major-mode
|
|
|
719 'comint-mode 'vi-state vip-comint-mode-modifier-map)
|
|
|
720 (vip-modify-major-mode
|
|
|
721 'shell-mode 'insert-state vip-comint-mode-modifier-map)
|
|
|
722 (vip-modify-major-mode
|
|
|
723 'shell-mode 'vi-state vip-comint-mode-modifier-map)
|
|
|
724 ;; ange-ftp in XEmacs
|
|
|
725 (vip-modify-major-mode
|
|
|
726 'ange-ftp-shell-mode 'insert-state vip-comint-mode-modifier-map)
|
|
|
727 (vip-modify-major-mode
|
|
|
728 'ange-ftp-shell-mode 'vi-state vip-comint-mode-modifier-map)
|
|
|
729 ;; ange-ftp in Emacs
|
|
|
730 (vip-modify-major-mode
|
|
|
731 'internal-ange-ftp-mode 'insert-state vip-comint-mode-modifier-map)
|
|
|
732 (vip-modify-major-mode
|
|
|
733 'internal-ange-ftp-mode 'vi-state vip-comint-mode-modifier-map)
|
|
|
734 ;; set hook
|
|
0
|
735 (add-hook 'comint-mode-hook 'vip-comint-mode-hook)
|
|
80
|
736
|
|
0
|
737 ;; Shell scripts
|
|
|
738 (defvar sh-mode-hook)
|
|
|
739 (add-hook 'sh-mode-hook 'viper-mode)
|
|
|
740 (defvar ksh-mode-hook)
|
|
|
741 (add-hook 'ksh-mode-hook 'viper-mode)
|
|
|
742
|
|
|
743 ;; Dired
|
|
78
|
744 (vip-modify-major-mode 'dired-mode 'emacs-state vip-dired-modifier-map)
|
|
175
|
745 (vip-set-emacs-state-searchstyle-macros nil 'dired-mode)
|
|
0
|
746 (add-hook 'dired-mode-hook 'vip-change-state-to-emacs)
|
|
|
747
|
|
78
|
748 ;; Tar
|
|
|
749 (vip-modify-major-mode 'tar-mode 'emacs-state vip-slash-and-colon-map)
|
|
175
|
750 (vip-set-emacs-state-searchstyle-macros nil 'tar-mode)
|
|
78
|
751
|
|
|
752 ;; MH-E
|
|
|
753 (vip-modify-major-mode 'mh-folder-mode 'emacs-state vip-slash-and-colon-map)
|
|
175
|
754 (vip-set-emacs-state-searchstyle-macros nil 'mh-folder-mode)
|
|
78
|
755 ;; changing state to emacs is needed so the preceding will take hold
|
|
|
756 (add-hook 'mh-folder-mode-hook 'vip-change-state-to-emacs)
|
|
|
757 (add-hook 'mh-show-mode-hook 'viper-mode)
|
|
|
758
|
|
|
759 ;; Gnus
|
|
|
760 (vip-modify-major-mode 'gnus-group-mode 'emacs-state vip-slash-and-colon-map)
|
|
175
|
761 (vip-set-emacs-state-searchstyle-macros nil 'gnus-group-mode)
|
|
78
|
762 (vip-modify-major-mode
|
|
|
763 'gnus-summary-mode 'emacs-state vip-slash-and-colon-map)
|
|
175
|
764 (vip-set-emacs-state-searchstyle-macros nil 'gnus-summary-mode)
|
|
78
|
765 ;; changing state to emacs is needed so the preceding will take hold
|
|
|
766 (add-hook 'gnus-group-mode-hook 'vip-change-state-to-emacs)
|
|
|
767 (add-hook 'gnus-summary-mode-hook 'vip-change-state-to-emacs)
|
|
|
768 (add-hook 'gnus-article-mode-hook 'viper-mode)
|
|
|
769
|
|
|
770 ;; Info
|
|
|
771 (vip-modify-major-mode 'Info-mode 'emacs-state vip-slash-and-colon-map)
|
|
175
|
772 (vip-set-emacs-state-searchstyle-macros nil 'Info-mode)
|
|
78
|
773 ;; Switching to emacs is needed so the above will take hold
|
|
|
774 (defadvice Info-mode (after vip-Info-ad activate)
|
|
|
775 "Switch to emacs mode."
|
|
|
776 (vip-change-state-to-emacs))
|
|
|
777
|
|
|
778 ;; Buffer menu
|
|
|
779 (vip-modify-major-mode
|
|
|
780 'Buffer-menu-mode 'emacs-state vip-slash-and-colon-map)
|
|
175
|
781 (vip-set-emacs-state-searchstyle-macros nil 'Buffer-menu-mode)
|
|
78
|
782 ;; Switching to emacs is needed so the above will take hold
|
|
|
783 (defadvice Buffer-menu-mode (after vip-Buffer-menu-ad activate)
|
|
|
784 "Switch to emacs mode."
|
|
|
785 (vip-change-state-to-emacs))
|
|
|
786
|
|
|
787 ;; View mode
|
|
163
|
788 (defvar view-mode-hook)
|
|
|
789 (defvar view-hook)
|
|
|
790 (add-hook 'view-hook 'vip-change-state-to-emacs)
|
|
|
791 (add-hook 'view-mode-hook 'vip-change-state-to-emacs)
|
|
0
|
792
|
|
|
793 ;; For VM users.
|
|
|
794 ;; Put summary and other VM buffers in Emacs state.
|
|
|
795 (defvar vm-mode-hooks)
|
|
|
796 (defvar vm-summary-mode-hooks)
|
|
|
797 (add-hook 'vm-mode-hooks 'vip-change-state-to-emacs)
|
|
|
798 (add-hook 'vm-summary-mode-hooks 'vip-change-state-to-emacs)
|
|
|
799
|
|
|
800 ;; For RMAIL users.
|
|
|
801 ;; Put buf in Emacs state after edit.
|
|
|
802 (vip-eval-after-load
|
|
|
803 "rmailedit"
|
|
|
804 '(defadvice rmail-cease-edit (after vip-rmail-advice activate)
|
|
|
805 "Switch to emacs state when done editing message."
|
|
|
806 (vip-change-state-to-emacs)))
|
|
|
807 ;; In case RMAIL was loaded before Viper.
|
|
|
808 (defadvice rmail-cease-edit (after vip-rmail-advice activate)
|
|
|
809 "Switch to emacs state when done editing message."
|
|
|
810 (vip-change-state-to-emacs))
|
|
|
811 ) ; vip-set-hooks
|
|
163
|
812
|
|
|
813
|
|
|
814 ;; these are primarily advices and Vi-ish variable settings
|
|
|
815 (defun vip-non-hook-settings ()
|
|
|
816
|
|
|
817 ;; This var is not local in Emacs, so we make it local.
|
|
|
818 ;; It must be local because although the stack of minor modes can be the same
|
|
|
819 ;; for all buffers, the associated *keymaps* can be different. In Viper,
|
|
|
820 ;; vip-vi-local-user-map, vip-insert-local-user-map, and others can have
|
|
|
821 ;; different keymaps for different buffers.
|
|
|
822 ;; Also, the keymaps associated with vip-vi/insert-state-modifier-minor-mode
|
|
|
823 ;; can be different.
|
|
|
824 (make-variable-buffer-local 'minor-mode-map-alist)
|
|
|
825
|
|
|
826 ;; Viper changes the default mode-line-buffer-identification
|
|
|
827 (setq-default mode-line-buffer-identification '(" %b"))
|
|
|
828
|
|
|
829 ;; setup emacs-supported vi-style feel
|
|
|
830 (setq next-line-add-newlines nil
|
|
|
831 require-final-newline t)
|
|
|
832
|
|
|
833 (make-variable-buffer-local 'require-final-newline)
|
|
|
834
|
|
|
835 ;; don't bark when mark is inactive
|
|
175
|
836 (if vip-emacs-p
|
|
|
837 (setq mark-even-if-inactive t))
|
|
163
|
838
|
|
|
839 (setq scroll-step 1)
|
|
|
840
|
|
|
841 ;; Variable displaying the current Viper state in the mode line.
|
|
|
842 (vip-deflocalvar vip-mode-string vip-emacs-state-id)
|
|
|
843 (or (memq 'vip-mode-string global-mode-string)
|
|
|
844 (setq global-mode-string
|
|
|
845 (append '("" vip-mode-string) (cdr global-mode-string))))
|
|
0
|
846
|
|
163
|
847 (defadvice read-key-sequence (around vip-read-keyseq-ad activate)
|
|
|
848 "Harness to work for Viper. This advice is harmless---don't worry!"
|
|
|
849 (let (inhibit-quit event keyseq)
|
|
|
850 (setq keyseq ad-do-it)
|
|
|
851 (setq event (if vip-xemacs-p
|
|
|
852 (elt keyseq 0) ; XEmacs returns vector of events
|
|
|
853 (elt (listify-key-sequence keyseq) 0)))
|
|
|
854 (if (vip-ESC-event-p event)
|
|
|
855 (let (unread-command-events)
|
|
|
856 (vip-set-unread-command-events keyseq)
|
|
|
857 (if (vip-fast-keysequence-p)
|
|
|
858 (let ((vip-vi-global-user-minor-mode nil)
|
|
|
859 (vip-vi-local-user-minor-mode nil)
|
|
|
860 (vip-replace-minor-mode nil) ; actually unnecessary
|
|
|
861 (vip-insert-global-user-minor-mode nil)
|
|
|
862 (vip-insert-local-user-minor-mode nil))
|
|
|
863 (setq keyseq ad-do-it))
|
|
|
864 (setq keyseq ad-do-it))))
|
|
|
865 keyseq))
|
|
|
866
|
|
|
867 (defadvice describe-key (before vip-read-keyseq-ad protect activate)
|
|
|
868 "Force to read key via `read-key-sequence'."
|
|
|
869 (interactive (list (vip-events-to-keys
|
|
|
870 (read-key-sequence "Describe key: ")))))
|
|
|
871
|
|
|
872 (defadvice describe-key-briefly (before vip-read-keyseq-ad protect activate)
|
|
|
873 "Force to read key via `read-key-sequence'."
|
|
|
874 (interactive (list (vip-events-to-keys
|
|
|
875 (read-key-sequence "Describe key briefly: ")))))
|
|
|
876
|
|
|
877
|
|
|
878 ;; Advice for use in find-file and read-file-name commands.
|
|
|
879 (defadvice exit-minibuffer (before vip-exit-minibuffer-advice activate)
|
|
|
880 "Run `vip-minibuffer-exit-hook' just before exiting the minibuffer."
|
|
|
881 (run-hooks 'vip-minibuffer-exit-hook))
|
|
|
882
|
|
|
883 (defadvice find-file (before vip-add-suffix-advice activate)
|
|
|
884 "Use `read-file-name' for reading arguments."
|
|
|
885 (interactive (cons (read-file-name "Find file: " nil default-directory)
|
|
|
886 ;; if Mule and prefix argument, ask for coding system
|
|
175
|
887 (cond ((and vip-emacs-p
|
|
|
888 (boundp 'MULE)) ; Emacs 20 with MULE
|
|
|
889 nil)
|
|
|
890 ((and vip-xemacs-p
|
|
|
891 (featurep 'mule)) ; XEmacs 20 with MULE
|
|
|
892 (list
|
|
|
893 (and current-prefix-arg
|
|
|
894 (read-coding-system
|
|
|
895 "Coding-system: "))))
|
|
|
896 )
|
|
163
|
897 )))
|
|
|
898
|
|
|
899 (defadvice find-file-other-window (before vip-add-suffix-advice activate)
|
|
|
900 "Use `read-file-name' for reading arguments."
|
|
|
901 (interactive (cons (read-file-name "Find file in other window: "
|
|
|
902 nil default-directory)
|
|
|
903 ;; if Mule and prefix argument, ask for coding system
|
|
175
|
904 (cond ((and vip-emacs-p
|
|
|
905 (boundp 'MULE)) ; Emacs 20 with MULE
|
|
|
906 nil)
|
|
|
907 ((and vip-xemacs-p
|
|
|
908 (featurep 'mule)) ; XEmacs 20 with MULE
|
|
|
909 (list
|
|
|
910 (and current-prefix-arg
|
|
|
911 (read-coding-system
|
|
|
912 "Coding-system: "))))
|
|
|
913 )
|
|
163
|
914 )))
|
|
|
915
|
|
175
|
916
|
|
163
|
917 (defadvice find-file-other-frame (before vip-add-suffix-advice activate)
|
|
|
918 "Use `read-file-name' for reading arguments."
|
|
|
919 (interactive (cons (read-file-name "Find file in other frame: "
|
|
|
920 nil default-directory)
|
|
|
921 ;; if Mule and prefix argument, ask for coding system
|
|
175
|
922 (cond ((and vip-emacs-p
|
|
|
923 (boundp 'MULE)) ; Emacs 20 with MULE
|
|
|
924 nil)
|
|
|
925 ((and vip-xemacs-p
|
|
|
926 (featurep 'mule)) ; XEmacs 20 with MULE
|
|
|
927 (list
|
|
|
928 (and current-prefix-arg
|
|
|
929 (read-coding-system
|
|
|
930 "Coding-system: "))))
|
|
|
931 )
|
|
163
|
932 )))
|
|
175
|
933
|
|
163
|
934
|
|
|
935 (defadvice read-file-name (around vip-suffix-advice activate)
|
|
|
936 "Tell `exit-minibuffer' to run `vip-file-add-suffix' as a hook."
|
|
|
937 (let ((vip-minibuffer-exit-hook 'vip-file-add-suffix))
|
|
|
938 ad-do-it))
|
|
|
939
|
|
|
940 (defadvice start-kbd-macro (after vip-kbd-advice activate)
|
|
|
941 "Remove Viper's intercepting bindings for C-x ).
|
|
|
942 This may be needed if the previous `:map' command terminated abnormally."
|
|
|
943 (define-key vip-vi-intercept-map "\C-x)" nil)
|
|
|
944 (define-key vip-insert-intercept-map "\C-x)" nil)
|
|
|
945 (define-key vip-emacs-intercept-map "\C-x)" nil))
|
|
|
946
|
|
|
947 (cond ((vip-window-display-p)
|
|
|
948 (let* ((search-key (if vip-xemacs-p
|
|
|
949 [(meta shift button1up)] [M-S-mouse-1]))
|
|
|
950 (search-key-catch
|
|
|
951 (if vip-xemacs-p [(meta shift button1)] [M-S-down-mouse-1]))
|
|
|
952 (insert-key (if vip-xemacs-p
|
|
|
953 [(meta shift button2up)] [M-S-mouse-2]))
|
|
|
954 (insert-key-catch
|
|
|
955 (if vip-xemacs-p [(meta shift button2)] [M-S-down-mouse-2]))
|
|
|
956 (search-key-unbound (and (not (key-binding search-key))
|
|
|
957 (not (key-binding search-key-catch))))
|
|
|
958 (insert-key-unbound (and (not (key-binding insert-key))
|
|
|
959 (not (key-binding insert-key-catch))))
|
|
|
960 )
|
|
|
961
|
|
|
962 (if search-key-unbound
|
|
|
963 (global-set-key search-key 'vip-mouse-click-search-word))
|
|
|
964 (if insert-key-unbound
|
|
|
965 (global-set-key insert-key 'vip-mouse-click-insert-word))
|
|
|
966
|
|
|
967 ;; The following would be needed if you want to use the above two
|
|
|
968 ;; while clicking in another frame. If you only want to use them
|
|
|
969 ;; by clicking in another window, not frame, the bindings below
|
|
|
970 ;; aren't necessary.
|
|
|
971
|
|
|
972 ;; These must be bound to mouse-down event for the same mouse
|
|
|
973 ;; buttons as 'vip-mouse-click-search-word and
|
|
|
974 ;; 'vip-mouse-click-insert-word
|
|
|
975 (if search-key-unbound
|
|
|
976 (global-set-key search-key-catch 'vip-mouse-catch-frame-switch))
|
|
|
977 (if insert-key-unbound
|
|
|
978 (global-set-key insert-key-catch 'vip-mouse-catch-frame-switch))
|
|
|
979
|
|
|
980 (if vip-xemacs-p
|
|
|
981 (add-hook 'mouse-leave-frame-hook
|
|
|
982 'vip-remember-current-frame)
|
|
|
983 (defadvice handle-switch-frame (before vip-frame-advice activate)
|
|
|
984 "Remember the selected frame before the switch-frame event."
|
|
|
985 (vip-remember-current-frame (selected-frame))))
|
|
|
986 )))
|
|
|
987 ) ; end vip-non-hook-settings
|
|
155
|
988
|
|
163
|
989
|
|
|
990 (if (eq viper-mode 'ask)
|
|
|
991 (progn
|
|
|
992 (save-window-excursion
|
|
|
993 (with-output-to-temp-buffer " *vip-info*"
|
|
|
994 (princ "
|
|
|
995 You have loaded Viper, and are about to Viperize your emacs!
|
|
|
996
|
|
|
997 Viper is a Package for Emacs Rebels
|
|
|
998 and a venomous VI PERil,
|
|
|
999
|
|
|
1000 It's time to decide: to Viperize or not to Viperize...
|
|
|
1001
|
|
|
1002 If you wish to Viperize AND make this your way of life, please put
|
|
|
1003
|
|
|
1004 (setq viper-mode t)
|
|
|
1005 (require 'viper)
|
|
|
1006
|
|
|
1007 in your .emacs file (preferably, close to the top).
|
|
|
1008 These two lines must come in the order given.
|
|
|
1009
|
|
175
|
1010 Also, the startup file name has been changed from .vip to .viper"))
|
|
163
|
1011 (if (y-or-n-p "Viperize? ")
|
|
|
1012 (setq viper-mode t)
|
|
|
1013 (setq viper-mode nil))
|
|
|
1014 (message "")
|
|
|
1015 (kill-buffer " *vip-info*"))))
|
|
|
1016
|
|
|
1017
|
|
|
1018
|
|
|
1019
|
|
175
|
1020 ;; Get viper standard value of SYMBOL. If symbol is customized, get its
|
|
|
1021 ;; standard value. Otherwise, get the value saved in the alist STORAGE. If
|
|
|
1022 ;; STORAGE is nil, use viper-saved-user-settings.
|
|
|
1023 (defun viper-standard-value (symbol &optional storage)
|
|
|
1024 (or (eval (car (get symbol 'customized-value)))
|
|
|
1025 (eval (car (get symbol 'saved-value)))
|
|
|
1026 (nth 1 (assoc symbol (or storage viper-saved-user-settings)))))
|
|
|
1027
|
|
|
1028
|
|
|
1029
|
|
|
1030 ;; save non-viper vars that Viper might change
|
|
|
1031 (if (null viper-saved-non-viper-variables)
|
|
|
1032 (setq viper-saved-non-viper-variables
|
|
|
1033 (list
|
|
|
1034 (cons 'default-major-mode (list default-major-mode))
|
|
|
1035 (cons 'next-line-add-newlines (list next-line-add-newlines))
|
|
|
1036 (cons 'require-final-newline (list require-final-newline))
|
|
|
1037 (cons 'scroll-step (list scroll-step))
|
|
|
1038 (cons 'mode-line-buffer-identification
|
|
|
1039 (list (default-value 'mode-line-buffer-identification)))
|
|
|
1040 (cons 'global-mode-string (list global-mode-string))
|
|
|
1041 (if vip-emacs-p
|
|
|
1042 (cons 'mark-even-if-inactive (list mark-even-if-inactive)))
|
|
|
1043 )))
|
|
|
1044
|
|
163
|
1045
|
|
|
1046 ;; Set some useful macros, advices
|
|
175
|
1047 ;; These must be BEFORE ~/.viper is loaded,
|
|
|
1048 ;; so the user can unrecord them in ~/.viper.
|
|
163
|
1049 (if viper-mode
|
|
|
1050 (progn
|
|
|
1051 ;; set advices and some variables that give emacs Vi look.
|
|
|
1052 (vip-non-hook-settings)
|
|
|
1053
|
|
|
1054 ;; repeat the 2nd previous command without rotating the command history
|
|
|
1055 (vip-record-kbd-macro
|
|
|
1056 (vector vip-repeat-from-history-key '\1) 'vi-state
|
|
|
1057 [(meta x) v i p - r e p e a t - f r o m - h i s t o r y return] 't)
|
|
|
1058 ;; repeat the 3d previous command without rotating the command history
|
|
|
1059 (vip-record-kbd-macro
|
|
|
1060 (vector vip-repeat-from-history-key '\2) 'vi-state
|
|
|
1061 [(meta x) v i p - r e p e a t - f r o m - h i s t o r y return] 't)
|
|
|
1062
|
|
175
|
1063 ;; set macros for toggling case sensitivity and regexp search
|
|
|
1064 (vip-set-searchstyle-toggling-macros nil)
|
|
163
|
1065 ;; Make %%% toggle parsing comments for matching parentheses
|
|
175
|
1066 (vip-set-parsing-style-toggling-macro nil)
|
|
163
|
1067 ))
|
|
80
|
1068
|
|
0
|
1069
|
|
175
|
1070 ;; ~/.viper is loaded if it exists
|
|
0
|
1071 (if (and (file-exists-p vip-custom-file-name)
|
|
163
|
1072 viper-mode
|
|
0
|
1073 (not noninteractive))
|
|
|
1074 (load vip-custom-file-name))
|
|
|
1075
|
|
|
1076 ;; VIP compatibility: merge whatever the user has in vip-mode-map into
|
|
|
1077 ;; Viper's basic map.
|
|
|
1078 (vip-add-keymap vip-mode-map vip-vi-global-user-map)
|
|
|
1079
|
|
175
|
1080 (if (boundp 'vip-expert-level)
|
|
|
1081 (setq viper-expert-level vip-expert-level))
|
|
|
1082
|
|
|
1083
|
|
0
|
1084
|
|
|
1085 ;; Applying Viper customization -- runs after (load .vip)
|
|
|
1086
|
|
175
|
1087 ;; Save user settings or Viper defaults for vars controled by
|
|
|
1088 ;; viper-expert-level
|
|
|
1089 (if (null viper-saved-user-settings)
|
|
|
1090 (setq viper-saved-user-settings
|
|
|
1091 (list (cons 'vip-want-ctl-h-help (list vip-want-ctl-h-help))
|
|
|
1092 (cons 'viper-always (list viper-always))
|
|
|
1093 (cons 'vip-no-multiple-ESC (list vip-no-multiple-ESC))
|
|
|
1094 (cons 'vip-ex-style-motion (list vip-ex-style-motion))
|
|
|
1095 (cons 'vip-ex-style-editing-in-insert
|
|
|
1096 (list vip-ex-style-editing-in-insert))
|
|
|
1097 (cons 'vip-want-emacs-keys-in-vi
|
|
|
1098 (list vip-want-emacs-keys-in-vi))
|
|
|
1099 (cons 'vip-electric-mode (list vip-electric-mode))
|
|
|
1100 (cons 'vip-want-emacs-keys-in-insert
|
|
|
1101 (list vip-want-emacs-keys-in-insert))
|
|
|
1102 (cons 'vip-re-search (list vip-re-search)))))
|
|
0
|
1103
|
|
|
1104
|
|
163
|
1105 (if viper-mode
|
|
|
1106 (progn
|
|
|
1107 (vip-set-minibuffer-style)
|
|
|
1108 (if vip-buffer-search-char
|
|
|
1109 (vip-buffer-search-enable))
|
|
|
1110 (vip-update-alphanumeric-class)
|
|
|
1111 ))
|
|
0
|
1112
|
|
163
|
1113
|
|
0
|
1114 ;;; Familiarize Viper with some minor modes that have their own keymaps
|
|
163
|
1115 (if viper-mode
|
|
|
1116 (progn
|
|
|
1117 (vip-harness-minor-mode "compile")
|
|
|
1118 (vip-harness-minor-mode "outline")
|
|
|
1119 (vip-harness-minor-mode "allout")
|
|
|
1120 (vip-harness-minor-mode "xref")
|
|
|
1121 (vip-harness-minor-mode "lmenu")
|
|
|
1122 (vip-harness-minor-mode "vc")
|
|
|
1123 (vip-harness-minor-mode "ltx-math") ; LaTeX-math-mode in AUC-TeX
|
|
|
1124 (vip-harness-minor-mode "latex") ; which is in one of these two files
|
|
|
1125 (vip-harness-minor-mode "cyrillic")
|
|
|
1126 (vip-harness-minor-mode "russian")
|
|
|
1127 (vip-harness-minor-mode "view-less")
|
|
|
1128 (vip-harness-minor-mode "view")
|
|
|
1129 ))
|
|
0
|
1130
|
|
|
1131
|
|
|
1132 ;; Intercept maps could go in viper-keym.el
|
|
175
|
1133 ;; We keep them here in case someone redefines them in ~/.viper
|
|
0
|
1134
|
|
|
1135 (define-key vip-vi-intercept-map vip-ESC-key 'vip-intercept-ESC-key)
|
|
|
1136 (define-key vip-insert-intercept-map vip-ESC-key 'vip-intercept-ESC-key)
|
|
|
1137
|
|
|
1138 ;; This is taken care of by vip-insert-global-user-map.
|
|
|
1139 ;;(define-key vip-replace-map vip-ESC-key 'vip-intercept-ESC-key)
|
|
|
1140
|
|
78
|
1141
|
|
0
|
1142 ;; The default vip-toggle-key is \C-z; for the novice, it suspends or
|
|
|
1143 ;; iconifies Emacs
|
|
78
|
1144 (define-key vip-vi-intercept-map vip-toggle-key 'vip-toggle-key-action)
|
|
0
|
1145 (define-key vip-emacs-intercept-map vip-toggle-key 'vip-change-state-to-vi)
|
|
|
1146
|
|
|
1147
|
|
163
|
1148 (if (and viper-mode
|
|
|
1149 (or viper-always
|
|
175
|
1150 (and (< viper-expert-level 5) (> viper-expert-level 0))))
|
|
0
|
1151 (vip-set-hooks))
|
|
|
1152
|
|
|
1153 ;; Let all minor modes take effect after loading
|
|
|
1154 ;; this may not be enough, so we also set default minor-mode-alist.
|
|
|
1155 ;; Without setting the default, new buffers that come up in emacs mode have
|
|
|
1156 ;; minor-mode-map-alist = nil, unless we call vip-change-state-*
|
|
|
1157 (if (eq vip-current-state 'emacs-state)
|
|
|
1158 (progn
|
|
|
1159 (vip-change-state-to-emacs)
|
|
|
1160 (setq-default minor-mode-map-alist minor-mode-map-alist)
|
|
|
1161 ))
|
|
|
1162
|
|
|
1163
|
|
163
|
1164
|
|
0
|
1165 (run-hooks 'vip-load-hook) ; the last chance to change something
|
|
|
1166
|
|
|
1167 (provide 'vip)
|
|
163
|
1168 (provide 'viper)
|
|
0
|
1169
|
|
175
|
1170
|
|
|
1171 ;;; Local Variables:
|
|
|
1172 ;;; eval: (put 'vip-deflocalvar 'lisp-indent-hook 'defun)
|
|
|
1173 ;;; End:
|
|
|
1174
|
|
0
|
1175 ;;; viper.el ends here
|
