| blob | 86e0e0446416ad8b539275eee6bd743969effaee |
1 ;;; viper-init.el --- some common definitions for Viper
3 ;; Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 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 2, or (at your option)
13 ;; 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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;;; Code:
31 ;; compiler pacifier
44 ;; end pacifier
47 ;; Viper version
52 ;; Is it XEmacs?
54 ;; Is it Emacs?
56 ;; Tell whether we are running as a window application or on a TTY
58 ;; This is used to avoid compilation warnings. When emacs/xemacs forms can
59 ;; generate compile time warnings, we use this macro.
60 ;; In this case, the macro will expand into the form that is appropriate to the
61 ;; compiler at hand.
62 ;; Suggested by rms.
65 xemacs-form emacs-form))
71 window-system
72 ))
81 )
84 ;; in XEmacs: device-type is tty on tty and stream in batch.
90 "Tells if Emacs is running under an MS-style OS: ms-dos, windows-nt, W95."
95 "Tells if Emacs is running under VMS."
101 "If t, Viper will think that it is running on a display that supports faces.
102 This is provided as a temporary relief for users of graphics-capable terminals
103 that Viper doesn't know about.
104 In all likelihood, you don't need to bother with this setting."
115 \f
116 ;;; Macros
124 ;; (viper-loop COUNT BODY) Execute BODY COUNT times.
128 ,@body
134 ;; return buffer-specific macro definition, given a full macro definition
137 ;; get a pair: (curr-buffer . macro-definition)
140 ;; get macro definition for current buffer
144 ;; return mode-specific macro definitions, given a full macro definition
147 ;; get a pair: (major-mode . macro-definition)
150 ;; get macro definition for the current major mode
154 ;; return global macro definition, given a full macro definition
157 ;; get global macro definition from an elt of macro-alist
161 ;; last elt of a sequence
171 ;; like char-after/before, but saves typing
178 \f
183 \f
184 ;;; Viper minor modes
186 ;; Mode for vital things like \e, C-z.
205 "Minor mode for Ex command macros in Vi state.
206 The corresponding keymap stores key bindings of Vi macros defined with
209 ;; Mode for vital things like \e, C-z.
216 "Auxiliary minor mode for buffer-local user-defined bindings in Insert state.
217 This is a way to overshadow normal Insert mode bindings locally to certain
227 "Minor mode that simulates Vi very closely.
231 "Minor mode for Ex command macros Insert state.
232 The corresponding keymap stores key bindings of Vi macros defined with
238 ;; Mode for vital things like \C-z and \C-x) This is set to t, when viper-mode
239 ;; is invoked. So, any new buffer will have C-z defined as switch to Vi,
240 ;; unless we switched states in this buffer
244 "Minor mode for local user bindings effective in Emacs state.
245 Users can use it to override Emacs bindings when Viper is in its Emacs
249 "Minor mode for global user bindings in effect in Emacs state.
250 Users can use it to override Emacs bindings when Viper is in its Emacs
254 "Minor mode for Vi style macros in Emacs state.
255 The corresponding keymap stores key bindings of Vi macros defined with
256 `viper-record-kbd-macro' command. There is no Ex-level command to do this
260 "Minor mode used to make major-mode-specific modification to Emacs state.
261 For instance, a Vi purist may want to bind `dd' in Dired mode to a function
270 \f
272 ;; Some common error messages
287 ;; Is t until viper-mode executes for the very first time.
288 ;; Prevents recursive descend into startup messages.
292 "User's expert level.
293 The minor mode viper-vi-diehard-minor-mode is in effect when
294 viper-expert-level is 1 or 2 or when viper-want-emacs-keys-in-vi is t.
295 The minor mode viper-insert-diehard-minor-mode is in effect when
296 viper-expert-level is 1 or 2 or if viper-want-emacs-keys-in-insert is t.
299 ;; Max expert level supported by Viper. This is NOT a user option.
300 ;; It is here to make it hard for the user from resetting it.
304 ;;; ISO characters and MULE
306 ;; If non-nil, ISO accents will be turned on in insert/replace emacs states and
307 ;; turned off in vi-state. For some users, this behavior may be too
308 ;; primitive. In this case, use insert/emacs/vi state hooks.
310 ;; Set iso-accents-mode to ARG. Check if it is bound first
315 ;; Internal flag used to control when viper mule hooks are run.
316 ;; Don't change this!
318 ;; If non-nil, the default intl. input method is turned on.
321 ;; viper hook to run on input-method activation
324 ()
326 ;; turn off special input methods in vi-state
335 ))
337 ;; viper hook to run on input-method deactivation
340 ()
353 ;; XEmacs had broken quil-mode for some time, so we are working around
354 ;; it here
362 ))
369 ;; Set quail-mode to ARG
374 ;; activate input method
378 ))
381 ;; VI-style Undo
383 ;; Used to 'undo' complex commands, such as replace and insert commands.
387 ;; A mark that Viper puts on buffer-undo-list. Marks the beginning of a
388 ;; complex command that must be undone atomically. If inserted, it is
389 ;; erased by viper-change-state-to-vi and viper-repeat.
393 "*Non-nil means not to move point while undoing commands.
394 This style is different from Emacs and Vi. Try it to see if
395 it better fits your working style."
400 ;; Replace mode and changing text
402 ;; Hack used to pass global states around for short period of time
405 ;; This is used to pass the right Vi command key sequence to
406 ;; viper-set-destructive-command whenever (this-command-keys) doesn't give the
407 ;; right result. For instance, in commands like c/bla<RET>,
408 ;; (this-command-keys) will return ^M, which invoked exit-minibuffer, while we
409 ;; need "c/"
412 ;; Indicates that the current destructive command has started in replace mode.
416 "If non-nil, Viper will allow multi-line replace regions.
417 This is an extension to standard Vi.
418 If nil, commands that attempt to replace text spanning multiple lines first
419 delete the text being replaced, as in standard Vi."
424 "*Cursor color when Viper is in Replace state."
431 "Cursor color when Viper is in insert state."
437 ;; viper-emacs-state-cursor-color doesn't work well. Causes cursor colors to be
438 ;; confused in some cases. So, this var is nulled for now.
439 ;; (defcustom viper-emacs-state-cursor-color "Magenta"
441 "Cursor color when Viper is in Emacs state."
447 ;; internal var, used to remember the default cursor color of emacs frames
456 "A string marking the end of replacement regions.
457 It is used only with TTYs or if `viper-use-replace-region-delimiters'
458 is non-nil."
462 "A string marking the beginning of replacement regions.
463 It is used only with TTYs or if `viper-use-replace-region-delimiters'
464 is non-nil."
470 "*If non-nil, Viper will always use `viper-replace-region-end-delimiter' and
471 `viper-replace-region-start-delimiter' to delimit replacement regions, even on
472 color displays. By default, the delimiters are used only on TTYs."
477 "Function to use for prompting the user for a buffer name."
481 ;; XEmacs requires glyphs
490 )
491 nil ; emacs
492 )
496 ;; These are local marker that must be initialized to nil and moved with
497 ;; `viper-move-marker-locally'
498 ;;
499 ;; Remember the last position inside the replace region.
501 ;; Remember the last position while inserting
509 ;; Remember the number of characters that have to be deleted in replace
510 ;; mode to compensate for the inserted characters.
512 ;; This variable is used internally by the before/after changed functions to
513 ;; determine how many chars were deleted by the change. This can't be
514 ;; determined inside after-change-functions because those get the length of the
515 ;; deleted region, not the number of chars deleted (which are two different
516 ;; things under MULE).
519 ;; Insertion ring and command ring
521 "The size of history of inserted text.
522 This is a list where Viper keeps the history of previously inserted pieces of
523 text."
526 ;; The insertion ring.
528 ;; This is temp insertion ring. Used to do rotation for display purposes.
529 ;; When rotation just started, it is initialized to viper-insertion-ring.
534 "The size of history of Vi commands repeatable with dot."
537 ;; The command ring.
539 ;; This is temp command ring. Used to do rotation for display purposes.
540 ;; When rotation just started, it is initialized to viper-command-ring.
543 ;; Fast keyseq and ESC keyseq timeouts
545 "*Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined.
546 Setting this too high may slow down your typing. Setting this value too low
547 will make it hard to use Vi-style timeout macros."
553 "*Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key.
554 Setting this too high may slow down switching from insert to vi state. Setting
555 this value too low will make it impossible to use function keys in insert mode
556 on a dumb terminal."
561 "Allow translation of all key sequences into commands.
562 Normally, Viper lets Emacs translate only those ESC key sequences that are
563 defined in the low-level key-translation-map or function-key-map, such as those
565 treated as ESC command followed by a `/'. This is done for people who type fast
566 and tend to hit other characters right after they hit ESC. Other people like
567 Emacs to translate ESC sequences all the time.
568 The default is to translate all sequences only when using a dumb terminal.
569 This permits you to use ESC as a meta key in insert mode."
573 ;; Modes and related variables
575 ;; Current mode. One of: `emacs-state', `vi-state', `insert-state'
579 ;; Autoindent in insert
581 ;; Variable that keeps track of whether C-t has been pressed.
584 ;; Preserve the indent value, used by C-d in insert mode.
587 ;; Whether to preserve the indent, used by C-d in insert mode.
592 "*Enable autoindent, if t.
593 This is a buffer-local variable."
599 "*If t, electrify Viper.
600 Currently, this only electrifies auto-indentation, making it appropriate to the
601 mode of the buffer.
602 This means that auto-indentation will depart from standard Vi and will indent
603 appropriate to the mode of the buffer. This is especially useful for editing
604 programs and LaTeX documents."
609 "*The value of the shiftwidth.
610 This determines the number of columns by which the Ctl-t moves the cursor in
611 the Insert state."
615 ;; Variables for repeating destructive commands
618 "*If t, don't move point when repeating previous command.
619 This is useful for doing repeated changes with the '.' key.
620 The user can change this to nil, if she likes when the cursor moves
621 to a new place after repeating previous Vi command."
625 ;; Remember insert point as a marker. This is a local marker that must be
626 ;; initialized to nil and moved with `viper-move-marker-locally'.
630 ;; This remembers the point before dabbrev-expand was called.
631 ;; If viper-insert-point turns out to be bigger than that, it is reset
632 ;; back to viper-pre-command-point.
633 ;; The reason this is needed is because dabbrev-expand (and possibly
634 ;; others) may jump to before the insertion point, delete something and
635 ;; then reinsert a bigger piece. For instance: bla^blo
636 ;; If dabbrev-expand is called after `blo' and ^ undicates viper-insert-point,
637 ;; then point jumps to the beginning of `blo'. If expansion is found, `blablo'
638 ;; is deleted, and we have |^, where | denotes point. Next, dabbrev-expand
639 ;; will insert the expansion, and we get: blablo^
640 ;; Whatever we insert next goes before the ^, i.e., before the
641 ;; viper-insert-point marker. So, Viper will think that nothing was
642 ;; inserted. Remembering the orig position of the marker circumvents the
643 ;; problem.
644 ;; We don't know of any command, except dabbrev-expand, that has the same
645 ;; problem. However, the same trick can be used if such a command is
646 ;; discovered later.
647 ;;
651 ;; This is used for saving inserted text.
654 ;; Remembers the last replaced region.
657 ;; Remember com point as a marker.
658 ;; This is a local marker. Should be moved with `viper-move-marker-locally'
661 ;; If non-nil, the value is a list (M-COM VAL COM REG inserted-text cmd-keys)
662 ;; It is used to re-execute last destructive command.
663 ;; M-COM is a Lisp symbol representing the function to be executed.
664 ;; VAL is the prefix argument that was used with that command.
665 ;; COM is an internal descriptor, such as ?r, ?c, ?C, which contains
666 ;; additional information on how the function in M-COM is to be handled.
667 ;; REG is the register used by command
668 ;; INSERTED-TEXT is text inserted by that command (in case of o, c, C, i, r
669 ;; commands).
670 ;; COMMAND-KEYS are the keys that were typed to invoke the command.
673 ;; The character remembered by the Vi `r' command.
676 ;; Name of register to store deleted or yanked strings
680 ;;; Variables for Moves and Searches
683 "Variables that define the search and query-replace behavior of Viper."
687 ;; For use by `;' command.
690 ;; For use by `.' command.
693 ;; For use by `;' command.
696 ;; For use by `;' command.
699 ;; Last search string
703 "String inserted at the beginning of quoted region."
707 ;; If t, search is forward.
711 "*If not nil, search ignores cases."
716 "*If not nil, search is regexp search, otherwise vanilla search."
722 "*If search lands within this threshnold from the window top/bottom,
723 the window will be scrolled up or down appropriately, to reveal context.
724 If you want Viper search to behave as usual in Vi, set this variable to a
725 negative number."
730 "*If t then do regexp replace, if nil then do string replace."
736 "*If t, do regexp replace. nil means do string replace."
742 "*If t, `%' ignores the parentheses that occur inside comments."
748 "*If t, the commands l,h do not cross lines, etc (Ex-style).
749 If nil, these commands cross line boundaries."
755 "*If t, Ex-style behavior while editing in Vi command and insert states.
756 `Backspace' and `Delete' don't cross line boundaries in insert.
757 `X' and `x' can't delete characters across line boundary in Vi, etc.
758 Note: this doesn't preclude `Backspace' and `Delete' from deleting characters
759 by moving past the insertion point. This is a feature, not a bug.
761 If nil, the above commands can work across lines."
767 "*If t, ESC moves cursor back when changing from insert to vi state.
768 If nil, the cursor stays where it was when ESC was hit."
774 "*If t, DEL key will delete characters while moving the cursor backwards.
775 If nil, the cursor will move backwards without deleting anything."
780 "*Key used for buffer-searching. Must be a character type, e.g., ?g."
785 "*If t, search wraps around."
792 "*List of file and buffer names that are considered to be related to the current buffer.
793 Related buffers can be cycled through via :R and :P commands."
798 ;; Used to find out if we are done with searching the current buffer.
800 ;; As above, but global
803 ;; the search overlay
825 ;; These two vars control the interaction of jumps performed by ' and `.
826 ;; In this new version, '' doesn't erase the marks set by ``, so one can
827 ;; use both kinds of jumps interchangeably and without loosing positions
828 ;; inside the lines.
830 ;; Remembers position of the last jump done using ``'.
832 ;; Remembers position of the last jump done using `''.
835 ;; History variables
837 ;; History of search strings.
839 ;; History of query-replace strings used as a source.
841 ;; History of query-replace strings used as replacement.
843 ;; History of region quoting strings.
845 ;; History of Ex-style commands.
847 ;; History of shell commands.
851 ;; Last shell command. There are two of these, one for Ex (in viper-ex)
852 ;; and one for Vi.
854 ;; Last shell command executed with ! command.
857 \f
858 ;;; Face-saving tricks
861 "Hilighting of replace region, search pattern, minibuffer, etc."
869 "*Face used to flash out the search pattern."
871 ;; An internal variable. Viper takes the face from here.
873 "Face used to flash out the search pattern.
874 DO NOT CHANGE this variable. Instead, use the customization widget
875 to customize the actual face object `viper-search'
881 "*Face for highlighting replace regions on a window display."
883 ;; An internal variable. Viper takes the face from here.
885 "Face for highlighting replace regions on a window display.
886 DO NOT CHANGE this variable. Instead, use the customization widget
887 to customize the actual face object `viper-replace-overlay'
893 "Face used in the Minibuffer when it is in Emacs state."
895 ;; An internal variable. Viper takes the face from here.
897 "Face used in the Minibuffer when it is in Emacs state.
898 DO NOT CHANGE this variable. Instead, use the customization widget
899 to customize the actual face object `viper-minibuffer-emacs'
905 "Face used in the Minibuffer when it is in Insert state."
907 ;; An internal variable. Viper takes the face from here.
909 "Face used in the Minibuffer when it is in Insert state.
910 DO NOT CHANGE this variable. Instead, use the customization widget
911 to customize the actual face object `viper-minibuffer-insert'
917 "Face used in the Minibuffer when it is in Vi state."
919 ;; An internal variable. Viper takes the face from here.
921 "Face used in the Minibuffer when it is in Vi state.
922 DO NOT CHANGE this variable. Instead, use the customization widget
923 to customize the actual face object `viper-minibuffer-vi'
926 ;; the current face to be used in the minibuffer
930 \f
931 ;;; Miscellaneous
937 "Spell function used by #s<move> command to spell."
942 "The tags file used by Viper."
947 "Notify the user when this many lines or characters have been deleted/yanked.
948 For line-deleting/yanking commands (like `dd', `yy'), the value denotes the
949 number of lines. For character-based commands (such as `x', `dw', etc.), the
950 value refers to the number of characters affected."
954 ;; Minibuffer
957 "If t, use vi-style editing in minibuffer.
958 Should be set in `~/.viper' file."
962 ;; overlay used in the minibuffer to indicate which state it is in
966 ;; Hook, specific to Viper, which is run just *before* exiting the minibuffer.
967 ;; This is needed because beginning with Emacs 19.26, the standard
968 ;; `minibuffer-exit-hook' is run *after* exiting the minibuffer
972 ;; Mode line
984 "Viper hooks."
989 "*Hooks run just before the switch to Vi mode is completed."
993 "*Hooks run just before the switch to Insert mode is completed."
997 "*Hooks run just before the switch to Replace mode is completed."
1001 "*Hooks run just before the switch to Emacs mode is completed."
1006 "Hooks run just after loading Viper."
1023 ;; Local Variables:
1024 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1025 ;; End:
1027 ;; arch-tag: 4efa2416-1fcb-4690-be10-1a2a0248d250
1028 ;;; viper-init.el ends here