1 ;;; viper-init.el --- some common definitions for Viper
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 (defvar mark-even-if-inactive
)
30 (defvar iso-accents-mode
)
31 (defvar viper-current-state
)
32 (defvar viper-version
)
33 (defvar viper-expert-level
)
34 (defvar current-input-method
)
35 (defvar default-input-method
)
36 (defvar describe-current-input-method-function
)
38 (defvar default-cursor-type
)
44 (defun viper-version ()
46 (message "Viper version is %s" viper-version
))
48 ;; Tell whether we are running as a window application or on a TTY
50 (defsubst viper-device-type
()
51 (if (featurep 'xemacs
)
52 (device-type (selected-device))
55 (defun viper-color-display-p ()
57 (if (featurep 'xemacs
)
58 (eq (device-class (selected-device)) 'color
)
62 ;; in XEmacs: device-type is tty on tty and stream in batch.
63 (defun viper-window-display-p ()
64 (and (viper-device-type) (not (memq (viper-device-type) '(tty stream pc
)))))
66 (defcustom viper-ms-style-os-p
(memq system-type
67 '(ms-dos windows-nt windows-95
))
68 "Tells if Emacs is running under an MS-style OS: ms-dos, windows-nt, W95."
70 :tag
"Is it Microsoft-made OS?"
72 (defcustom viper-vms-os-p
(memq system-type
'(vax-vms axp-vms
))
73 "Tells if Emacs is running under VMS."
78 (defcustom viper-suppress-input-method-change-message nil
79 "If t, the message notifying about changes in the input method is not displayed.
80 Normally, a message is displayed each time on enters the vi, insert or replace
85 (defcustom viper-force-faces nil
86 "If t, Viper will think that it is running on a display that supports faces.
87 This is provided as a temporary relief for users of graphics-capable terminals
88 that Viper doesn't know about.
89 In all likelihood, you don't need to bother with this setting."
91 :group
'viper-highlighting
)
93 (defun viper-has-face-support-p ()
94 (cond ((viper-window-display-p))
96 ((viper-color-display-p))
97 ((featurep 'emacs
) (memq (viper-device-type) '(pc)))
98 ((featurep 'xemacs
) (memq (viper-device-type) '(tty pc
)))))
103 (defmacro viper-deflocalvar
(var default-value
&optional documentation
)
105 (defvar ,var
,default-value
106 ,(format "%s\n\(buffer local\)" documentation
))
107 (make-variable-buffer-local ',var
)))
109 ;; (viper-loop COUNT BODY) Execute BODY COUNT times.
110 (defmacro viper-loop
(count &rest body
)
111 `(let ((count ,count
))
114 (setq count
(1- count
)))))
116 (defmacro viper-buffer-live-p
(buf)
117 `(and ,buf
(get-buffer ,buf
) (buffer-name (get-buffer ,buf
))))
119 ;; return buffer-specific macro definition, given a full macro definition
120 (defmacro viper-kbd-buf-alist
(macro-elt)
122 ;; get a pair: (curr-buffer . macro-definition)
123 (defmacro viper-kbd-buf-pair
(macro-elt)
124 `(assoc (buffer-name) (viper-kbd-buf-alist ,macro-elt
)))
125 ;; get macro definition for current buffer
126 (defmacro viper-kbd-buf-definition
(macro-elt)
127 `(cdr (viper-kbd-buf-pair ,macro-elt
)))
129 ;; return mode-specific macro definitions, given a full macro definition
130 (defmacro viper-kbd-mode-alist
(macro-elt)
132 ;; get a pair: (major-mode . macro-definition)
133 (defmacro viper-kbd-mode-pair
(macro-elt)
134 `(assoc major-mode
(viper-kbd-mode-alist ,macro-elt
)))
135 ;; get macro definition for the current major mode
136 (defmacro viper-kbd-mode-definition
(macro-elt)
137 `(cdr (viper-kbd-mode-pair ,macro-elt
)))
139 ;; return global macro definition, given a full macro definition
140 (defmacro viper-kbd-global-pair
(macro-elt)
142 ;; get global macro definition from an elt of macro-alist
143 (defmacro viper-kbd-global-definition
(macro-elt)
144 `(cdr (viper-kbd-global-pair ,macro-elt
)))
146 ;; last elt of a sequence
147 (defsubst viper-seq-last-elt
(seq)
148 (elt seq
(1- (length seq
))))
150 (defsubst viper-string-to-list
(string)
151 (append (vconcat string
) nil
))
153 (defsubst viper-charlist-to-string
(list)
154 (mapconcat 'char-to-string list
""))
156 ;; like char-after/before, but saves typing
157 (defun viper-char-at-pos (direction &optional offset
)
158 (or (integerp offset
) (setq offset
0))
159 (if (eq direction
'forward
)
160 (char-after (+ (point) offset
))
161 (char-before (- (point) offset
))))
164 (defvar viper-minibuffer-overlay-priority
300)
165 (defvar viper-replace-overlay-priority
400)
166 (defvar viper-search-overlay-priority
500)
169 ;;; Viper minor modes
171 ;; Mode for vital things like \e, C-z.
172 (viper-deflocalvar viper-vi-intercept-minor-mode nil
)
174 (viper-deflocalvar viper-vi-basic-minor-mode nil
175 "Viper's minor mode for Vi bindings.")
177 (viper-deflocalvar viper-vi-local-user-minor-mode nil
178 "Auxiliary minor mode for user-defined local bindings in Vi state.")
180 (viper-deflocalvar viper-vi-global-user-minor-mode nil
181 "Auxiliary minor mode for user-defined global bindings in Vi state.")
183 (viper-deflocalvar viper-vi-state-modifier-minor-mode nil
184 "Minor mode used to make major-mode-specific modification to Vi state.")
186 (viper-deflocalvar viper-vi-diehard-minor-mode nil
187 "This minor mode is in effect when the user wants Viper to be Vi.")
189 (viper-deflocalvar viper-vi-kbd-minor-mode nil
190 "Minor mode for Ex command macros in Vi state.
191 The corresponding keymap stores key bindings of Vi macros defined with
192 the Ex command :map.")
194 ;; Mode for vital things like \e, C-z.
195 (viper-deflocalvar viper-insert-intercept-minor-mode nil
)
197 (viper-deflocalvar viper-insert-basic-minor-mode nil
198 "Viper's minor mode for bindings in Insert mode.")
200 (viper-deflocalvar viper-insert-local-user-minor-mode nil
201 "Auxiliary minor mode for buffer-local user-defined bindings in Insert state.
202 This is a way to overshadow normal Insert mode bindings locally to certain
203 designated buffers.")
205 (viper-deflocalvar viper-insert-global-user-minor-mode nil
206 "Auxiliary minor mode for global user-defined bindings in Insert state.")
208 (viper-deflocalvar viper-insert-state-modifier-minor-mode nil
209 "Minor mode used to make major-mode-specific modification to Insert state.")
211 (viper-deflocalvar viper-insert-diehard-minor-mode nil
212 "Minor mode that simulates Vi very closely.
213 Not recommened, except for the novice user.")
215 (viper-deflocalvar viper-insert-kbd-minor-mode nil
216 "Minor mode for Ex command macros Insert state.
217 The corresponding keymap stores key bindings of Vi macros defined with
218 the Ex command :map!.")
220 (viper-deflocalvar viper-replace-minor-mode nil
221 "Minor mode in effect in replace state (cw, C, and the like commands).")
223 ;; Mode for vital things like \C-z and \C-x) This is set to t, when viper-mode
224 ;; is invoked. So, any new buffer will have C-z defined as switch to Vi,
225 ;; unless we switched states in this buffer
226 (viper-deflocalvar viper-emacs-intercept-minor-mode nil
)
228 (viper-deflocalvar viper-emacs-local-user-minor-mode nil
229 "Minor mode for local user bindings effective in Emacs state.
230 Users can use it to override Emacs bindings when Viper is in its Emacs
233 (viper-deflocalvar viper-emacs-global-user-minor-mode nil
234 "Minor mode for global user bindings in effect in Emacs state.
235 Users can use it to override Emacs bindings when Viper is in its Emacs
238 (viper-deflocalvar viper-emacs-kbd-minor-mode nil
239 "Minor mode for Vi style macros in Emacs state.
240 The corresponding keymap stores key bindings of Vi macros defined with
241 `viper-record-kbd-macro' command. There is no Ex-level command to do this
244 (viper-deflocalvar viper-emacs-state-modifier-minor-mode nil
245 "Minor mode used to make major-mode-specific modification to Emacs state.
246 For instance, a Vi purist may want to bind `dd' in Dired mode to a function
247 that deletes a file.")
249 (viper-deflocalvar viper-vi-minibuffer-minor-mode nil
250 "Minor mode that forces Vi-style when the Minibuffer is in Vi state.")
252 (viper-deflocalvar viper-insert-minibuffer-minor-mode nil
253 "Minor mode that forces Vi-style when the Minibuffer is in Insert state.")
257 ;; Some common error messages
259 (defconst viper-SpuriousText
"Spurious text after command" "")
260 (defconst viper-BadExCommand
"Not an editor command" "")
261 (defconst viper-InvalidCommandArgument
"Invalid command argument" "")
262 (defconst viper-NoPrevSearch
"No previous search string" "")
263 (defconst viper-EmptyRegister
"`%c': Nothing in this register" "")
264 (defconst viper-InvalidRegister
"`%c': Invalid register" "")
265 (defconst viper-EmptyTextmarker
"`%c': Text marker doesn't point anywhere" "")
266 (defconst viper-InvalidTextmarker
"`%c': Invalid text marker" "")
267 (defconst viper-InvalidViCommand
"Invalid command" "")
268 (defconst viper-BadAddress
"Ill-formed address" "")
269 (defconst viper-FirstAddrExceedsSecond
"First address exceeds second" "")
270 (defconst viper-NoFileSpecified
"No file specified" "")
272 ;; Is t until viper-mode executes for the very first time.
273 ;; Prevents recursive descend into startup messages.
274 (defvar viper-first-time t
)
276 (defvar viper-expert-level
(if (boundp 'viper-expert-level
) viper-expert-level
0)
277 "User's expert level.
278 The minor mode viper-vi-diehard-minor-mode is in effect when
279 viper-expert-level is 1 or 2 or when viper-want-emacs-keys-in-vi is t.
280 The minor mode viper-insert-diehard-minor-mode is in effect when
281 viper-expert-level is 1 or 2 or if viper-want-emacs-keys-in-insert is t.
282 Use `M-x viper-set-expert-level' to change this.")
284 ;; Max expert level supported by Viper. This is NOT a user option.
285 ;; It is here to make it hard for the user from resetting it.
286 (defconst viper-max-expert-level
5)
289 ;;; ISO characters and MULE
291 ;; If non-nil, ISO accents will be turned on in insert/replace emacs states and
292 ;; turned off in vi-state. For some users, this behavior may be too
293 ;; primitive. In this case, use insert/emacs/vi state hooks.
294 (viper-deflocalvar viper-automatic-iso-accents nil
"")
295 ;; Set iso-accents-mode to ARG. Check if it is bound first
296 (defsubst viper-set-iso-accents-mode
(arg)
297 (if (boundp 'iso-accents-mode
)
298 (setq iso-accents-mode arg
)))
300 ;; Internal flag used to control when viper mule hooks are run.
301 ;; Don't change this!
302 (defvar viper-mule-hook-flag t
)
303 ;; If non-nil, the default intl. input method is turned on.
304 (viper-deflocalvar viper-special-input-method nil
"")
306 ;; viper hook to run on input-method activation
307 (defun viper-activate-input-method-action ()
308 (if (null viper-mule-hook-flag
)
310 (setq viper-special-input-method t
)
311 ;; turn off special input methods in vi-state
312 (if (eq viper-current-state
'vi-state
)
313 (viper-set-input-method nil
))
314 (if (and (memq viper-current-state
'(vi-state insert-state replace-state
))
315 (not viper-suppress-input-method-change-message
))
316 (message "Viper special input method%s: on"
317 (if (or current-input-method default-input-method
)
319 (or current-input-method default-input-method
))
323 ;; viper hook to run on input-method deactivation
324 (defun viper-inactivate-input-method-action ()
325 (if (null viper-mule-hook-flag
)
327 (setq viper-special-input-method nil
)
328 (if (and (memq viper-current-state
'(vi-state insert-state replace-state
))
329 (not viper-suppress-input-method-change-message
))
330 (message "Viper special input method%s: off"
331 (if (or current-input-method default-input-method
)
333 (or current-input-method default-input-method
))
336 (defun viper-inactivate-input-method ()
337 (cond ((and (featurep 'emacs
) (fboundp 'inactivate-input-method
))
338 (inactivate-input-method))
339 ((and (featurep 'xemacs
) (boundp 'current-input-method
))
340 ;; XEmacs had broken quail-mode for some time, so we are working around
342 (setq quail-mode nil
)
343 (if (featurep 'quail
)
344 (quail-delete-overlays))
345 (setq describe-current-input-method-function nil
)
346 (setq current-input-method nil
)
347 (run-hooks 'input-method-inactivate-hook
)
348 (force-mode-line-update))
350 (defun viper-activate-input-method ()
351 (cond ((and (featurep 'emacs
) (fboundp 'activate-input-method
))
352 (activate-input-method default-input-method
))
354 (if (fboundp 'quail-mode
) (quail-mode 1)))))
356 ;; Set quail-mode to ARG
357 (defun viper-set-input-method (arg)
358 (setq viper-mule-hook-flag t
) ; just a precaution
359 (let (viper-mule-hook-flag) ; temporarily deactivate viper mule hooks
360 (cond ((and arg
(> (prefix-numeric-value arg
) 0) default-input-method
)
361 ;; activate input method
362 (viper-activate-input-method))
363 (t ; deactivate input method
364 (viper-inactivate-input-method)))
370 ;; Used to 'undo' complex commands, such as replace and insert commands.
371 (viper-deflocalvar viper-undo-needs-adjustment nil
)
372 (put 'viper-undo-needs-adjustment
'permanent-local t
)
374 ;; A mark that Viper puts on buffer-undo-list. Marks the beginning of a
375 ;; complex command that must be undone atomically. If inserted, it is
376 ;; erased by viper-change-state-to-vi and viper-repeat.
377 (defconst viper-buffer-undo-list-mark
'viper
)
379 (defcustom viper-keep-point-on-undo nil
380 "*Non-nil means not to move point while undoing commands.
381 This style is different from Emacs and Vi. Try it to see if
382 it better fits your working style."
384 :tag
"Preserve Position of Point After Undo"
387 ;; Replace mode and changing text
389 ;; Hack used to pass global states around for short period of time
390 (viper-deflocalvar viper-intermediate-command nil
"")
392 ;; This is used to pass the right Vi command key sequence to
393 ;; viper-set-destructive-command whenever (this-command-keys) doesn't give the
394 ;; right result. For instance, in commands like c/bla<RET>,
395 ;; (this-command-keys) will return ^M, which invoked exit-minibuffer, while we
397 (defconst viper-this-command-keys nil
)
399 ;; Indicates that the current destructive command has started in replace mode.
400 (viper-deflocalvar viper-began-as-replace nil
"")
402 (defcustom viper-allow-multiline-replace-regions t
403 "If non-nil, Viper will allow multi-line replace regions.
404 This is an extension to standard Vi.
405 If nil, commands that attempt to replace text spanning multiple lines first
406 delete the text being replaced, as in standard Vi."
410 (defcustom viper-replace-overlay-cursor-color
"Red"
411 "*Cursor color when Viper is in Replace state."
415 (defcustom viper-insert-state-cursor-color
"Green"
416 "Cursor color when Viper is in insert state."
420 ;; viper-emacs-state-cursor-color doesn't work well. Causes cursor colors to be
421 ;; confused in some cases. So, this var is nulled for now.
422 ;; (defcustom viper-emacs-state-cursor-color "Magenta"
423 (defcustom viper-emacs-state-cursor-color nil
424 "Cursor color when Viper is in Emacs state."
428 ;; internal var, used to remember the default cursor color of emacs frames
429 (defvar viper-vi-state-cursor-color nil
)
431 ;; Frame-local variables are obsolete from Emacs 22.2 onwards, so we
432 ;; do it by hand with viper-frame-value (qv).
433 (when (and (featurep 'xemacs
)
434 (fboundp 'make-variable-frame-local
))
435 (make-variable-frame-local 'viper-replace-overlay-cursor-color
)
436 (make-variable-frame-local 'viper-insert-state-cursor-color
)
437 (make-variable-frame-local 'viper-emacs-state-cursor-color
)
438 (make-variable-frame-local 'viper-vi-state-cursor-color
))
440 (viper-deflocalvar viper-replace-overlay nil
"")
441 (put 'viper-replace-overlay
'permanent-local t
)
443 (defcustom viper-replace-region-end-delimiter
"$"
444 "A string marking the end of replacement regions.
445 It is used only with TTYs or if `viper-use-replace-region-delimiters'
449 (defcustom viper-replace-region-start-delimiter
""
450 "A string marking the beginning of replacement regions.
451 It is used only with TTYs or if `viper-use-replace-region-delimiters'
455 (defcustom viper-use-replace-region-delimiters
456 (or (not (viper-has-face-support-p))
457 (and (featurep 'xemacs
) (eq (viper-device-type) 'tty
)))
458 "*If non-nil, Viper will always use `viper-replace-region-end-delimiter' and
459 `viper-replace-region-start-delimiter' to delimit replacement regions, even on
460 color displays. By default, the delimiters are used only on TTYs."
464 (defcustom viper-read-buffer-function
'read-buffer
465 "Function to use for prompting the user for a buffer name."
469 ;; XEmacs requires glyphs
470 (when (featurep 'xemacs
)
471 (or (glyphp viper-replace-region-end-delimiter
)
472 (setq viper-replace-region-end-delimiter
473 (make-glyph viper-replace-region-end-delimiter
)))
474 (or (glyphp viper-replace-region-start-delimiter
)
475 (setq viper-replace-region-start-delimiter
476 (make-glyph viper-replace-region-start-delimiter
))))
478 ;; These are local marker that must be initialized to nil and moved with
479 ;; `viper-move-marker-locally'
481 ;; Remember the last position inside the replace region.
482 (viper-deflocalvar viper-last-posn-in-replace-region nil
)
483 ;; Remember the last position while inserting
484 (viper-deflocalvar viper-last-posn-while-in-insert-state nil
)
485 (put 'viper-last-posn-in-replace-region
'permanent-local t
)
486 (put 'viper-last-posn-while-in-insert-state
'permanent-local t
)
488 (viper-deflocalvar viper-sitting-in-replace nil
"")
489 (put 'viper-sitting-in-replace
'permanent-local t
)
491 ;; Remember the number of characters that have to be deleted in replace
492 ;; mode to compensate for the inserted characters.
493 (viper-deflocalvar viper-replace-chars-to-delete
0 "")
494 ;; This variable is used internally by the before/after changed functions to
495 ;; determine how many chars were deleted by the change. This can't be
496 ;; determined inside after-change-functions because those get the length of the
497 ;; deleted region, not the number of chars deleted (which are two different
498 ;; things under MULE).
499 (viper-deflocalvar viper-replace-region-chars-deleted
0 "")
501 ;; Insertion ring and command ring
502 (defcustom viper-insertion-ring-size
14
503 "The size of history of inserted text.
504 This is a list where Viper keeps the history of previously inserted pieces of
508 ;; The insertion ring.
509 (defvar viper-insertion-ring nil
)
510 ;; This is temp insertion ring. Used to do rotation for display purposes.
511 ;; When rotation just started, it is initialized to viper-insertion-ring.
512 (defvar viper-temp-insertion-ring nil
)
513 (defvar viper-last-inserted-string-from-insertion-ring
"")
515 (defcustom viper-command-ring-size
14
516 "The size of history of Vi commands repeatable with dot."
520 (defvar viper-command-ring nil
)
521 ;; This is temp command ring. Used to do rotation for display purposes.
522 ;; When rotation just started, it is initialized to viper-command-ring.
523 (defvar viper-temp-command-ring nil
)
525 ;; Fast keyseq and ESC keyseq timeouts
526 (defcustom viper-fast-keyseq-timeout
200
527 "*Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined.
528 Setting this too high may slow down your typing. Setting this value too low
529 will make it hard to use Vi-style timeout macros."
533 (defcustom viper-ESC-keyseq-timeout
(if (viper-window-display-p)
534 0 viper-fast-keyseq-timeout
)
535 "*Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key.
536 Setting this too high may slow down switching from insert to vi state. Setting
537 this value too low will make it impossible to use function keys in insert mode
542 (defcustom viper-translate-all-ESC-keysequences
(not (viper-window-display-p))
543 "Allow translation of all key sequences into commands.
544 Normally, Viper lets Emacs translate only those ESC key sequences that are
545 defined in the low-level key-translation-map or function-key-map, such as those
546 emitted by the arrow and function keys. Other sequences, e.g., \\e/, are
547 treated as ESC command followed by a `/'. This is done for people who type fast
548 and tend to hit other characters right after they hit ESC. Other people like
549 Emacs to translate ESC sequences all the time.
550 The default is to translate all sequences only when using a dumb terminal.
551 This permits you to use ESC as a meta key in insert mode."
555 ;; Modes and related variables
557 ;; Current mode. One of: `emacs-state', `vi-state', `insert-state'
558 (viper-deflocalvar viper-current-state
'emacs-state
)
561 ;; Autoindent in insert
563 ;; Variable that keeps track of whether C-t has been pressed.
564 (viper-deflocalvar viper-cted nil
"")
566 ;; Preserve the indent value, used by C-d in insert mode.
567 (viper-deflocalvar viper-current-indent
0)
569 ;; Whether to preserve the indent, used by C-d in insert mode.
570 (viper-deflocalvar viper-preserve-indent nil
)
572 (viper-deflocalvar viper-auto-indent nil
"")
573 (defcustom viper-auto-indent nil
574 "*Enable autoindent, if t.
575 This is a buffer-local variable."
579 (viper-deflocalvar viper-electric-mode t
"")
580 (defcustom viper-electric-mode t
581 "*If t, electrify Viper.
582 Currently, this only electrifies auto-indentation, making it appropriate to the
584 This means that auto-indentation will depart from standard Vi and will indent
585 appropriate to the mode of the buffer. This is especially useful for editing
586 programs and LaTeX documents."
590 (defcustom viper-shift-width
8
591 "*The value of the shiftwidth.
592 This determines the number of columns by which the Ctl-t moves the cursor in
597 ;; Variables for repeating destructive commands
599 (defcustom viper-keep-point-on-repeat t
600 "*If t, don't move point when repeating previous command.
601 This is useful for doing repeated changes with the '.' key.
602 The user can change this to nil, if she likes when the cursor moves
603 to a new place after repeating previous Vi command."
607 ;; Remember insert point as a marker. This is a local marker that must be
608 ;; initialized to nil and moved with `viper-move-marker-locally'.
609 (viper-deflocalvar viper-insert-point nil
)
610 (put 'viper-insert-point
'permanent-local t
)
612 ;; This remembers the point before dabbrev-expand was called.
613 ;; If viper-insert-point turns out to be bigger than that, it is reset
614 ;; back to viper-pre-command-point.
615 ;; The reason this is needed is because dabbrev-expand (and possibly
616 ;; others) may jump to before the insertion point, delete something and
617 ;; then reinsert a bigger piece. For instance: bla^blo
618 ;; If dabbrev-expand is called after `blo' and ^ undicates viper-insert-point,
619 ;; then point jumps to the beginning of `blo'. If expansion is found, `blablo'
620 ;; is deleted, and we have |^, where | denotes point. Next, dabbrev-expand
621 ;; will insert the expansion, and we get: blablo^
622 ;; Whatever we insert next goes before the ^, i.e., before the
623 ;; viper-insert-point marker. So, Viper will think that nothing was
624 ;; inserted. Remembering the orig position of the marker circumvents the
626 ;; We don't know of any command, except dabbrev-expand, that has the same
627 ;; problem. However, the same trick can be used if such a command is
630 (viper-deflocalvar viper-pre-command-point nil
)
631 (put 'viper-pre-command-point
'permanent-local t
) ; this is probably an overkill
633 ;; This is used for saving inserted text.
634 (defvar viper-last-insertion nil
)
636 ;; Remembers the last replaced region.
637 (defvar viper-last-replace-region
"")
639 ;; Remember com point as a marker.
640 ;; This is a local marker. Should be moved with `viper-move-marker-locally'
641 (viper-deflocalvar viper-com-point nil
)
643 ;; If non-nil, the value is a list (M-COM VAL COM REG inserted-text cmd-keys)
644 ;; It is used to re-execute last destructive command.
645 ;; M-COM is a Lisp symbol representing the function to be executed.
646 ;; VAL is the prefix argument that was used with that command.
647 ;; COM is an internal descriptor, such as ?r, ?c, ?C, which contains
648 ;; additional information on how the function in M-COM is to be handled.
649 ;; REG is the register used by command
650 ;; INSERTED-TEXT is text inserted by that command (in case of o, c, C, i, r
652 ;; COMMAND-KEYS are the keys that were typed to invoke the command.
653 (defvar viper-d-com nil
)
655 ;; The character remembered by the Vi `r' command.
656 (defvar viper-d-char nil
)
658 ;; Name of register to store deleted or yanked strings
659 (defvar viper-use-register nil
)
662 ;;; Variables for Moves and Searches
664 (defgroup viper-search nil
665 "Variables that define the search and query-replace behavior of Viper."
669 ;; For use by `;' command.
670 (defvar viper-f-char nil
)
672 ;; For use by `.' command.
673 (defvar viper-F-char nil
)
675 ;; For use by `;' command.
676 (defvar viper-f-forward nil
)
678 ;; For use by `;' command.
679 (defvar viper-f-offset nil
)
681 ;; Last search string
682 (defvar viper-s-string
"")
684 (defcustom viper-quote-string
"> "
685 "String inserted at the beginning of quoted region."
689 ;; If t, search is forward.
690 (defvar viper-s-forward nil
)
692 (defcustom viper-case-fold-search nil
693 "*If not nil, search ignores cases."
695 :group
'viper-search
)
697 (defcustom viper-re-search t
698 "*If not nil, search is regexp search, otherwise vanilla search."
701 :group
'viper-search
)
703 (defcustom viper-search-scroll-threshold
2
704 "*If search lands within this threshnold from the window top/bottom,
705 the window will be scrolled up or down appropriately, to reveal context.
706 If you want Viper search to behave as usual in Vi, set this variable to a
709 :group
'viper-search
)
711 (defcustom viper-re-query-replace t
712 "*If t then do regexp replace, if nil then do string replace."
714 :tag
"Regexp Query Replace"
715 :group
'viper-search
)
717 (defcustom viper-re-replace t
718 "*If t, do regexp replace. nil means do string replace."
720 :tag
"Regexp Replace"
721 :group
'viper-search
)
723 (defcustom viper-parse-sexp-ignore-comments t
724 "*If t, `%' ignores the parentheses that occur inside comments."
728 (viper-deflocalvar viper-ex-style-motion t
"")
729 (defcustom viper-ex-style-motion t
730 "*If t, the commands l,h do not cross lines, etc (Ex-style).
731 If nil, these commands cross line boundaries."
735 (viper-deflocalvar viper-ex-style-editing t
"")
736 (defcustom viper-ex-style-editing t
737 "*If t, Ex-style behavior while editing in Vi command and insert states.
738 `Backspace' and `Delete' don't cross line boundaries in insert.
739 `X' and `x' can't delete characters across line boundary in Vi, etc.
740 Note: this doesn't preclude `Backspace' and `Delete' from deleting characters
741 by moving past the insertion point. This is a feature, not a bug.
743 If nil, the above commands can work across lines."
747 (viper-deflocalvar viper-ESC-moves-cursor-back viper-ex-style-editing
"")
748 (defcustom viper-ESC-moves-cursor-back nil
749 "*If t, ESC moves cursor back when changing from insert to vi state.
750 If nil, the cursor stays where it was when ESC was hit."
754 (viper-deflocalvar viper-delete-backwards-in-replace nil
"")
755 (defcustom viper-delete-backwards-in-replace nil
756 "*If t, DEL key will delete characters while moving the cursor backwards.
757 If nil, the cursor will move backwards without deleting anything."
761 (defcustom viper-buffer-search-char nil
762 "*Key used for buffer-searching. Must be a character type, e.g., ?g."
763 :type
'(choice (const nil
) character
)
764 :group
'viper-search
)
766 (defcustom viper-search-wrap-around t
767 "*If t, search wraps around."
769 :tag
"Search Wraps Around"
770 :group
'viper-search
)
772 (viper-deflocalvar viper-related-files-and-buffers-ring nil
"")
773 (defcustom viper-related-files-and-buffers-ring nil
774 "*List of file and buffer names that are considered to be related to the current buffer.
775 Related buffers can be cycled through via :R and :P commands."
778 (put 'viper-related-files-and-buffers-ring
'permanent-local t
)
780 ;; Used to find out if we are done with searching the current buffer.
781 (viper-deflocalvar viper-local-search-start-marker nil
)
782 ;; As above, but global
783 (defvar viper-search-start-marker
(make-marker))
785 ;; the search overlay
786 (viper-deflocalvar viper-search-overlay nil
)
789 (defvar viper-heading-start
790 (concat "^\\s-*(\\s-*defun\\s-\\|" ; lisp
791 "^{\\s-*$\\|^[_a-zA-Z][^()]*[()].*{\\s-*$\\|" ; C/C++
792 "^\\s-*class.*{\\|^\\s-*struct.*{\\|^\\s-*enum.*{\\|"
793 "^\\\\[sb][a-z]*{.*}\\s-*$\\|" ; latex
794 "^@node\\|@table\\|^@m?enu\\|^@itemize\\|^@if\\|" ; texinfo
796 "*Regexps for Headings. Used by \[\[ and \]\].")
798 (defvar viper-heading-end
799 (concat "^}\\|" ; C/C++
800 "^\\\\end{\\|" ; latex
801 "^@end \\|" ; texinfo
802 ")\n\n[ \t\n]*\\|" ; lisp
803 "\\.\\s-*$") ; prolog
804 "*Regexps to end Headings/Sections. Used by \[\].")
807 ;; These two vars control the interaction of jumps performed by ' and `.
808 ;; In this new version, '' doesn't erase the marks set by ``, so one can
809 ;; use both kinds of jumps interchangeably and without loosing positions
812 ;; Remembers position of the last jump done using ``'.
813 (viper-deflocalvar viper-last-jump nil
)
814 ;; Remembers position of the last jump done using `''.
815 (viper-deflocalvar viper-last-jump-ignore
0)
819 ;; History of search strings.
820 (defvar viper-search-history
(list ""))
821 ;; History of query-replace strings used as a source.
822 (defvar viper-replace1-history nil
)
823 ;; History of query-replace strings used as replacement.
824 (defvar viper-replace2-history nil
)
825 ;; History of region quoting strings.
826 (defvar viper-quote-region-history
(list viper-quote-string
))
827 ;; History of Ex-style commands.
828 (defvar viper-ex-history nil
)
829 ;; History of shell commands.
830 (defvar viper-shell-history nil
)
833 ;; Last shell command. There are two of these, one for Ex (in viper-ex)
836 ;; Last shell command executed with ! command.
837 (defvar viper-last-shell-com nil
)
840 ;;; Face-saving tricks
842 (defgroup viper-highlighting nil
843 "Hilighting of replace region, search pattern, minibuffer, etc."
848 (defface viper-search
849 '((((class color
)) (:foreground
"Black" :background
"khaki"))
850 (t (:underline t
:stipple
"gray3")))
851 "*Face used to flash out the search pattern."
852 :group
'viper-highlighting
)
853 ;; An internal variable. Viper takes the face from here.
854 (defvar viper-search-face
'viper-search
855 "Face used to flash out the search pattern.
856 DO NOT CHANGE this variable. Instead, use the customization widget
857 to customize the actual face object `viper-search'
858 this variable represents.")
860 (defface viper-replace-overlay
861 '((((class color
)) (:foreground
"Black" :background
"darkseagreen2"))
862 (t (:underline t
:stipple
"gray3")))
863 "*Face for highlighting replace regions on a window display."
864 :group
'viper-highlighting
)
865 ;; An internal variable. Viper takes the face from here.
866 (defvar viper-replace-overlay-face
'viper-replace-overlay
867 "Face for highlighting replace regions on a window display.
868 DO NOT CHANGE this variable. Instead, use the customization widget
869 to customize the actual face object `viper-replace-overlay'
870 this variable represents.")
872 (defface viper-minibuffer-emacs
873 '((((class color
)) (:foreground
"Black" :background
"darkseagreen2"))
875 "Face used in the Minibuffer when it is in Emacs state."
876 :group
'viper-highlighting
)
877 ;; An internal variable. Viper takes the face from here.
878 (defvar viper-minibuffer-emacs-face
'viper-minibuffer-emacs
879 "Face used in the Minibuffer when it is in Emacs state.
880 DO NOT CHANGE this variable. Instead, use the customization widget
881 to customize the actual face object `viper-minibuffer-emacs'
882 this variable represents.")
884 (defface viper-minibuffer-insert
885 '((((class color
)) (:foreground
"Black" :background
"pink"))
887 "Face used in the Minibuffer when it is in Insert state."
888 :group
'viper-highlighting
)
889 ;; An internal variable. Viper takes the face from here.
890 (defvar viper-minibuffer-insert-face
'viper-minibuffer-insert
891 "Face used in the Minibuffer when it is in Insert state.
892 DO NOT CHANGE this variable. Instead, use the customization widget
893 to customize the actual face object `viper-minibuffer-insert'
894 this variable represents.")
896 (defface viper-minibuffer-vi
897 '((((class color
)) (:foreground
"DarkGreen" :background
"grey"))
898 (t (:inverse-video t
)))
899 "Face used in the Minibuffer when it is in Vi state."
900 :group
'viper-highlighting
)
901 ;; An internal variable. Viper takes the face from here.
902 (defvar viper-minibuffer-vi-face
'viper-minibuffer-vi
903 "Face used in the Minibuffer when it is in Vi state.
904 DO NOT CHANGE this variable. Instead, use the customization widget
905 to customize the actual face object `viper-minibuffer-vi'
906 this variable represents.")
908 ;; the current face to be used in the minibuffer
910 viper-minibuffer-current-face viper-minibuffer-emacs-face
"")
915 (defvar viper-inhibit-startup-message nil
916 "Whether Viper startup message should be inhibited.")
918 (defcustom viper-spell-function
'ispell-region
919 "Spell function used by #s<move> command to spell."
923 (defcustom viper-tags-file-name
"TAGS"
924 "The tags file used by Viper."
928 (defcustom viper-change-notification-threshold
1
929 "Notify the user when this many lines or characters have been deleted/yanked.
930 For line-deleting/yanking commands (like `dd', `yy'), the value denotes the
931 number of lines. For character-based commands (such as `x', `dw', etc.), the
932 value refers to the number of characters affected."
938 (defcustom viper-vi-style-in-minibuffer t
939 "If t, use vi-style editing in minibuffer.
940 Should be set in `~/.viper' file."
944 ;; overlay used in the minibuffer to indicate which state it is in
945 (viper-deflocalvar viper-minibuffer-overlay nil
)
946 (put 'viper-minibuffer-overlay
'permanent-local t
)
948 ;; Hook, specific to Viper, which is run just *before* exiting the minibuffer.
949 ;; This is needed because beginning with Emacs 19.26, the standard
950 ;; `minibuffer-exit-hook' is run *after* exiting the minibuffer
951 (defvar viper-minibuffer-exit-hook nil
)
955 (defconst viper-vi-state-id
"<V> "
956 "Mode line tag identifying the Vi mode of Viper.")
957 (defconst viper-emacs-state-id
"<E> "
958 "Mode line tag identifying the Emacs mode of Viper.")
959 (defconst viper-insert-state-id
"<I> "
960 "Mode line tag identifying the Insert mode of Viper.")
961 (defconst viper-replace-state-id
"<R> "
962 "Mode line tag identifying the Replace mode of Viper.")
965 (defgroup viper-hooks nil
970 (defcustom viper-vi-state-hook
'viper-restore-cursor-type
971 "*Hooks run just before the switch to Vi mode is completed."
974 (defcustom viper-insert-state-hook
'viper-set-insert-cursor-type
975 "*Hooks run just before the switch to Insert mode is completed."
978 (defcustom viper-replace-state-hook
'viper-restore-cursor-type
979 "*Hooks run just before the switch to Replace mode is completed."
982 (defcustom viper-emacs-state-hook
'viper-restore-cursor-type
983 "*Hooks run just before the switch to Emacs mode is completed."
987 (defcustom viper-load-hook nil
988 "Hooks run just after loading Viper."
992 (defun viper-restore-cursor-type ()
994 (if (featurep 'xemacs
)
995 (set (make-local-variable 'bar-cursor
) nil
)
996 (setq cursor-type default-cursor-type
))
999 (defun viper-set-insert-cursor-type ()
1000 (if (featurep 'xemacs
)
1001 (set (make-local-variable 'bar-cursor
) 2)
1002 (setq cursor-type
'(bar .
2))))
1005 (provide 'viper-init
)
1009 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1012 ;; arch-tag: 4efa2416-1fcb-4690-be10-1a2a0248d250
1013 ;;; viper-init.el ends here