| blob | 9f0826bf515304fb4bcc4a941f8b697ceb79cf74 |
1 ;;; viper-init.el --- some common definitions for Viper
3 ;; Copyright (C) 1997-2012 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
6 ;; Package: viper
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/>.
23 ;;; Commentary:
25 ;;; Code:
27 ;; compiler pacifier
39 ;; end pacifier
42 ;; Viper version
47 ;; Tell whether we are running as a window application or on a TTY
52 window-system))
61 ;; in XEmacs: device-type is tty on tty and stream in batch.
68 "Non-nil if Emacs is running under an MS-style OS: MS-DOS, or MS-Windows."
74 "If t, the message notifying about changes in the input method is not displayed.
75 Normally, a message is displayed each time on enters the vi, insert or replace
76 state."
81 "If t, Viper will think that it is running on a display that supports faces.
82 This is provided as a temporary relief for users of graphics-capable terminals
83 that Viper doesn't know about.
84 In all likelihood, you don't need to bother with this setting."
95 \f
96 ;;; Macros
104 ;; (viper-loop COUNT BODY) Execute BODY COUNT times.
108 ,@body
114 ;; return buffer-specific macro definition, given a full macro definition
117 ;; get a pair: (curr-buffer . macro-definition)
120 ;; get macro definition for current buffer
124 ;; return mode-specific macro definitions, given a full macro definition
127 ;; get a pair: (major-mode . macro-definition)
130 ;; get macro definition for the current major mode
134 ;; return global macro definition, given a full macro definition
137 ;; get global macro definition from an elt of macro-alist
141 ;; last elt of a sequence
151 ;; like char-after/before, but saves typing
158 \f
163 \f
164 ;;; Viper minor modes
166 ;; Mode for vital things like \e, C-z.
185 "Minor mode for Ex command macros in Vi state.
186 The corresponding keymap stores key bindings of Vi macros defined with
189 ;; Mode for vital things like \e, C-z.
196 "Auxiliary minor mode for buffer-local user-defined bindings in Insert state.
197 This is a way to overshadow normal Insert mode bindings locally to certain
207 "Minor mode that simulates Vi very closely.
211 "Minor mode for Ex command macros Insert state.
212 The corresponding keymap stores key bindings of Vi macros defined with
218 ;; Mode for vital things like \C-z and \C-x) This is set to t, when viper-mode
219 ;; is invoked. So, any new buffer will have C-z defined as switch to Vi,
220 ;; unless we switched states in this buffer
224 "Minor mode for local user bindings effective in Emacs state.
225 Users can use it to override Emacs bindings when Viper is in its Emacs
229 "Minor mode for global user bindings in effect in Emacs state.
230 Users can use it to override Emacs bindings when Viper is in its Emacs
234 "Minor mode for Vi style macros in Emacs state.
235 The corresponding keymap stores key bindings of Vi macros defined with
236 `viper-record-kbd-macro' command. There is no Ex-level command to do this
240 "Minor mode used to make major-mode-specific modification to Emacs state.
241 For instance, a Vi purist may want to bind `dd' in Dired mode to a function
250 \f
252 ;; Some common error messages
267 ;; Is t until viper-mode executes for the very first time.
268 ;; Prevents recursive descend into startup messages.
272 "User's expert level.
273 The minor mode viper-vi-diehard-minor-mode is in effect when
274 viper-expert-level is 1 or 2 or when viper-want-emacs-keys-in-vi is t.
275 The minor mode viper-insert-diehard-minor-mode is in effect when
276 viper-expert-level is 1 or 2 or if viper-want-emacs-keys-in-insert is t.
279 ;; Max expert level supported by Viper. This is NOT a user option.
280 ;; It is here to make it hard for the user from resetting it.
284 ;;; ISO characters and MULE
286 ;; If non-nil, ISO accents will be turned on in insert/replace emacs states and
287 ;; turned off in vi-state. For some users, this behavior may be too
288 ;; primitive. In this case, use insert/emacs/vi state hooks.
290 ;; Set iso-accents-mode to ARG. Check if it is bound first
295 ;; Internal flag used to control when viper mule hooks are run.
296 ;; Don't change this!
298 ;; If non-nil, the default intl. input method is turned on.
301 ;; viper hook to run on input-method activation
304 ()
306 ;; turn off special input methods in vi-state
316 ))
318 ;; viper hook to run on input-method deactivation
321 ()
335 ;; XEmacs had broken quail-mode for some time, so we are working around
336 ;; it here
346 ))
353 ;; Set quail-mode to ARG
358 ;; activate input method
362 ))
365 ;; VI-style Undo
367 ;; Used to 'undo' complex commands, such as replace and insert commands.
371 ;; A mark that Viper puts on buffer-undo-list. Marks the beginning of a
372 ;; complex command that must be undone atomically. If inserted, it is
373 ;; erased by viper-change-state-to-vi and viper-repeat.
377 "Non-nil means not to move point while undoing commands.
378 This style is different from Emacs and Vi. Try it to see if
379 it better fits your working style."
384 ;; Replace mode and changing text
386 ;; Hack used to pass global states around for short period of time
389 ;; This is used to pass the right Vi command key sequence to
390 ;; viper-set-destructive-command whenever (this-command-keys) doesn't give the
391 ;; right result. For instance, in commands like c/bla<RET>,
392 ;; (this-command-keys) will return ^M, which invoked exit-minibuffer, while we
393 ;; need "c/"
396 ;; Indicates that the current destructive command has started in replace mode.
400 "If non-nil, Viper will allow multi-line replace regions.
401 This is an extension to standard Vi.
402 If nil, commands that attempt to replace text spanning multiple lines first
403 delete the text being replaced, as in standard Vi."
408 "Cursor color when Viper is in Replace state."
413 "Cursor color when Viper is in insert state."
417 ;; viper-emacs-state-cursor-color doesn't work well. Causes cursor colors to be
418 ;; confused in some cases. So, this var is nulled for now.
419 ;; (defcustom viper-emacs-state-cursor-color "Magenta"
421 "Cursor color when Viper is in Emacs state."
425 ;; internal var, used to remember the default cursor color of emacs frames
428 ;; Frame-local variables are obsolete from Emacs 22.2 onwards, so we
429 ;; do it by hand with viper-frame-value (qv).
441 "A string marking the end of replacement regions.
442 It is used only with TTYs or if `viper-use-replace-region-delimiters'
443 is non-nil."
447 "A string marking the beginning of replacement regions.
448 It is used only with TTYs or if `viper-use-replace-region-delimiters'
449 is non-nil."
455 "If non-nil, Viper will always use `viper-replace-region-end-delimiter' and
456 `viper-replace-region-start-delimiter' to delimit replacement regions, even on
457 color displays. By default, the delimiters are used only on TTYs."
462 "Function to use for prompting the user for a buffer name."
466 ;; XEmacs requires glyphs
475 ;; These are local marker that must be initialized to nil and moved with
476 ;; `viper-move-marker-locally'
477 ;;
478 ;; Remember the last position inside the replace region.
480 ;; Remember the last position while inserting
488 ;; Remember the number of characters that have to be deleted in replace
489 ;; mode to compensate for the inserted characters.
491 ;; This variable is used internally by the before/after changed functions to
492 ;; determine how many chars were deleted by the change. This can't be
493 ;; determined inside after-change-functions because those get the length of the
494 ;; deleted region, not the number of chars deleted (which are two different
495 ;; things under MULE).
498 ;; Insertion ring and command ring
500 "The size of history of inserted text.
501 This is a list where Viper keeps the history of previously inserted pieces of
502 text."
505 ;; The insertion ring.
507 ;; This is temp insertion ring. Used to do rotation for display purposes.
508 ;; When rotation just started, it is initialized to viper-insertion-ring.
513 "The size of history of Vi commands repeatable with dot."
516 ;; The command ring.
518 ;; This is temp command ring. Used to do rotation for display purposes.
519 ;; When rotation just started, it is initialized to viper-command-ring.
522 ;; Fast keyseq and ESC keyseq timeouts
524 "Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined.
525 Setting this too high may slow down your typing. Setting this value too low
526 will make it hard to use Vi-style timeout macros."
530 ;; This function determines if ESC key sequences are to be translated into
531 ;; commands.
535 ;; Modes and related variables
537 ;; Current mode. One of: `emacs-state', `vi-state', `insert-state'
541 ;; Autoindent in insert
543 ;; Variable that keeps track of whether C-t has been pressed.
546 ;; Preserve the indent value, used by C-d in insert mode.
549 ;; Whether to preserve the indent, used by C-d in insert mode.
554 "Enable autoindent, if t.
555 This is a buffer-local variable."
561 "If t, electrify Viper.
562 Currently, this only electrifies auto-indentation, making it appropriate to the
563 mode of the buffer.
564 This means that auto-indentation will depart from standard Vi and will indent
565 appropriate to the mode of the buffer. This is especially useful for editing
566 programs and LaTeX documents."
571 "The value of the shiftwidth.
572 This determines the number of columns by which the Ctl-t moves the cursor in
573 the Insert state."
577 ;; Variables for repeating destructive commands
580 "If t, don't move point when repeating previous command.
581 This is useful for doing repeated changes with the '.' key.
582 The user can change this to nil, if she likes when the cursor moves
583 to a new place after repeating previous Vi command."
587 ;; Remember insert point as a marker. This is a local marker that must be
588 ;; initialized to nil and moved with `viper-move-marker-locally'.
592 ;; This remembers the point before dabbrev-expand was called.
593 ;; If viper-insert-point turns out to be bigger than that, it is reset
594 ;; back to viper-pre-command-point.
595 ;; The reason this is needed is because dabbrev-expand (and possibly
596 ;; others) may jump to before the insertion point, delete something and
597 ;; then reinsert a bigger piece. For instance: bla^blo
598 ;; If dabbrev-expand is called after `blo' and ^ indicates viper-insert-point,
599 ;; then point jumps to the beginning of `blo'. If expansion is found, `blablo'
600 ;; is deleted, and we have |^, where | denotes point. Next, dabbrev-expand
601 ;; will insert the expansion, and we get: blablo^
602 ;; Whatever we insert next goes before the ^, i.e., before the
603 ;; viper-insert-point marker. So, Viper will think that nothing was
604 ;; inserted. Remembering the orig position of the marker circumvents the
605 ;; problem.
606 ;; We don't know of any command, except dabbrev-expand, that has the same
607 ;; problem. However, the same trick can be used if such a command is
608 ;; discovered later.
609 ;;
613 ;; This is used for saving inserted text.
616 ;; Remembers the last replaced region.
619 ;; Remember com point as a marker.
620 ;; This is a local marker. Should be moved with `viper-move-marker-locally'
623 ;; If non-nil, the value is a list (M-COM VAL COM REG inserted-text cmd-keys)
624 ;; It is used to re-execute last destructive command.
625 ;; M-COM is a Lisp symbol representing the function to be executed.
626 ;; VAL is the prefix argument that was used with that command.
627 ;; COM is an internal descriptor, such as ?r, ?c, ?C, which contains
628 ;; additional information on how the function in M-COM is to be handled.
629 ;; REG is the register used by command
630 ;; INSERTED-TEXT is text inserted by that command (in case of o, c, C, i, r
631 ;; commands).
632 ;; COMMAND-KEYS are the keys that were typed to invoke the command.
635 ;; The character remembered by the Vi `r' command.
638 ;; Name of register to store deleted or yanked strings
642 ;;; Variables for Moves and Searches
645 "Variables that define the search and query-replace behavior of Viper."
649 ;; For use by `;' command.
652 ;; For use by `.' command.
655 ;; For use by `;' command.
658 ;; For use by `;' command.
661 ;; Last search string
665 "String inserted at the beginning of quoted region."
669 ;; If t, search is forward.
673 "If not nil, search ignores cases."
678 "If not nil, search is regexp search, otherwise vanilla search."
684 "If search lands within this threshold from the window top/bottom,
685 the window will be scrolled up or down appropriately, to reveal context.
686 If you want Viper search to behave as usual in Vi, set this variable to a
687 negative number."
692 "If t then do regexp replace, if nil then do string replace."
698 "If t, do regexp replace. nil means do string replace."
704 "If t, `%' ignores the parentheses that occur inside comments."
710 "If t, the commands l,h do not cross lines, etc (Ex-style).
711 If nil, these commands cross line boundaries."
717 "If t, Ex-style behavior while editing in Vi command and insert states.
718 `Backspace' and `Delete' don't cross line boundaries in insert.
719 `X' and `x' can't delete characters across line boundary in Vi, etc.
720 Note: this doesn't preclude `Backspace' and `Delete' from deleting characters
721 by moving past the insertion point. This is a feature, not a bug.
723 If nil, the above commands can work across lines."
729 "If t, ESC moves cursor back when changing from insert to vi state.
730 If nil, the cursor stays where it was when ESC was hit."
736 "If t, DEL key will delete characters while moving the cursor backwards.
737 If nil, the cursor will move backwards without deleting anything."
742 "Key used for buffer-searching. Must be a character type, e.g., ?g."
747 "If t, search wraps around."
754 "List of file and buffer names that are considered to be related to the current buffer.
755 Related buffers can be cycled through via :R and :P commands."
760 ;; Used to find out if we are done with searching the current buffer.
762 ;; As above, but global
765 ;; the search overlay
787 ;; These two vars control the interaction of jumps performed by ' and `.
788 ;; In this new version, '' doesn't erase the marks set by ``, so one can
789 ;; use both kinds of jumps interchangeably and without losing positions
790 ;; inside the lines.
792 ;; Remembers position of the last jump done using ``'.
794 ;; Remembers position of the last jump done using `''.
797 ;; History variables
799 ;; History of search strings.
801 ;; History of query-replace strings used as a source.
803 ;; History of query-replace strings used as replacement.
805 ;; History of region quoting strings.
807 ;; History of Ex-style commands.
809 ;; History of shell commands.
813 ;; Last shell command. There are two of these, one for Ex (in viper-ex)
814 ;; and one for Vi.
816 ;; Last shell command executed with ! command.
819 \f
820 ;;; Face-saving tricks
823 "Highlighting of replace region, search pattern, minibuffer, etc."
831 "Face used to flash out the search pattern."
833 ;; An internal variable. Viper takes the face from here.
835 "Face used to flash out the search pattern.
836 DO NOT CHANGE this variable. Instead, use the customization widget
837 to customize the actual face object `viper-search'
843 "Face for highlighting replace regions on a window display."
845 ;; An internal variable. Viper takes the face from here.
847 "Face for highlighting replace regions on a window display.
848 DO NOT CHANGE this variable. Instead, use the customization widget
849 to customize the actual face object `viper-replace-overlay'
855 "Face used in the Minibuffer when it is in Emacs state."
857 ;; An internal variable. Viper takes the face from here.
859 "Face used in the Minibuffer when it is in Emacs state.
860 DO NOT CHANGE this variable. Instead, use the customization widget
861 to customize the actual face object `viper-minibuffer-emacs'
867 "Face used in the Minibuffer when it is in Insert state."
869 ;; An internal variable. Viper takes the face from here.
871 "Face used in the Minibuffer when it is in Insert state.
872 DO NOT CHANGE this variable. Instead, use the customization widget
873 to customize the actual face object `viper-minibuffer-insert'
879 "Face used in the Minibuffer when it is in Vi state."
881 ;; An internal variable. Viper takes the face from here.
883 "Face used in the Minibuffer when it is in Vi state.
884 DO NOT CHANGE this variable. Instead, use the customization widget
885 to customize the actual face object `viper-minibuffer-vi'
888 ;; the current face to be used in the minibuffer
892 \f
893 ;;; Miscellaneous
899 "Spell function used by #s<move> command to spell."
904 "The tags file used by Viper."
909 "Notify the user when this many lines or characters have been deleted/yanked.
910 For line-deleting/yanking commands (like `dd', `yy'), the value denotes the
911 number of lines. For character-based commands (such as `x', `dw', etc.), the
912 value refers to the number of characters affected."
916 ;; Minibuffer
919 "If t, use vi-style editing in minibuffer.
920 Should be set in `~/.viper' file."
924 ;; overlay used in the minibuffer to indicate which state it is in
928 ;; Hook, specific to Viper, which is run just *before* exiting the minibuffer.
929 ;; This is needed because beginning with Emacs 19.26, the standard
930 ;; `minibuffer-exit-hook' is run *after* exiting the minibuffer
934 ;; Mode line
946 "Viper hooks."
951 "Hooks run just before the switch to Vi mode is completed."
955 "Hooks run just before the switch to Insert mode is completed."
959 "Hooks run just before the switch to Replace mode is completed."
963 "Hooks run just before the switch to Emacs mode is completed."
968 "Hooks run just after loading Viper."
985 "Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key.
986 Setting this too high may slow down switching from insert to vi state. Setting
987 this value too low will make it impossible to use function keys in insert mode
988 on a dumb terminal."
997 ;; Local Variables:
998 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
999 ;; End:
1001 ;;; viper-init.el ends here