| blob | d0f89751d5767e2cac5f2ba00df648fab8fcbb91 |
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, 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:
29 ;; compiler pacifier
42 ;; end pacifier
45 ;; Viper version
50 ;; Tell whether we are running as a window application or on a TTY
52 ;; This is used to avoid compilation warnings. When emacs/xemacs forms can
53 ;; generate compile time warnings, we use this macro.
54 ;; In this case, the macro will expand into the form that is appropriate to the
55 ;; compiler at hand.
56 ;; Suggested by rms.
59 xemacs-form emacs-form))
65 window-system
66 ))
75 )
78 ;; in XEmacs: device-type is tty on tty and stream in batch.
84 "Tells if Emacs is running under an MS-style OS: ms-dos, windows-nt, W95."
89 "Tells if Emacs is running under VMS."
95 "If t, the message notifying about changes in the input method is not displayed.
96 Normally, a message is displayed each time on enters the vi, insert or replace
97 state."
102 "If t, Viper will think that it is running on a display that supports faces.
103 This is provided as a temporary relief for users of graphics-capable terminals
104 that Viper doesn't know about.
105 In all likelihood, you don't need to bother with this setting."
116 \f
117 ;;; Macros
125 ;; (viper-loop COUNT BODY) Execute BODY COUNT times.
129 ,@body
135 ;; return buffer-specific macro definition, given a full macro definition
138 ;; get a pair: (curr-buffer . macro-definition)
141 ;; get macro definition for current buffer
145 ;; return mode-specific macro definitions, given a full macro definition
148 ;; get a pair: (major-mode . macro-definition)
151 ;; get macro definition for the current major mode
155 ;; return global macro definition, given a full macro definition
158 ;; get global macro definition from an elt of macro-alist
162 ;; last elt of a sequence
172 ;; like char-after/before, but saves typing
179 \f
184 \f
185 ;;; Viper minor modes
187 ;; Mode for vital things like \e, C-z.
206 "Minor mode for Ex command macros in Vi state.
207 The corresponding keymap stores key bindings of Vi macros defined with
210 ;; Mode for vital things like \e, C-z.
217 "Auxiliary minor mode for buffer-local user-defined bindings in Insert state.
218 This is a way to overshadow normal Insert mode bindings locally to certain
228 "Minor mode that simulates Vi very closely.
232 "Minor mode for Ex command macros Insert state.
233 The corresponding keymap stores key bindings of Vi macros defined with
239 ;; Mode for vital things like \C-z and \C-x) This is set to t, when viper-mode
240 ;; is invoked. So, any new buffer will have C-z defined as switch to Vi,
241 ;; unless we switched states in this buffer
245 "Minor mode for local user bindings effective in Emacs state.
246 Users can use it to override Emacs bindings when Viper is in its Emacs
250 "Minor mode for global user bindings in effect in Emacs state.
251 Users can use it to override Emacs bindings when Viper is in its Emacs
255 "Minor mode for Vi style macros in Emacs state.
256 The corresponding keymap stores key bindings of Vi macros defined with
257 `viper-record-kbd-macro' command. There is no Ex-level command to do this
261 "Minor mode used to make major-mode-specific modification to Emacs state.
262 For instance, a Vi purist may want to bind `dd' in Dired mode to a function
271 \f
273 ;; Some common error messages
288 ;; Is t until viper-mode executes for the very first time.
289 ;; Prevents recursive descend into startup messages.
293 "User's expert level.
294 The minor mode viper-vi-diehard-minor-mode is in effect when
295 viper-expert-level is 1 or 2 or when viper-want-emacs-keys-in-vi is t.
296 The minor mode viper-insert-diehard-minor-mode is in effect when
297 viper-expert-level is 1 or 2 or if viper-want-emacs-keys-in-insert is t.
300 ;; Max expert level supported by Viper. This is NOT a user option.
301 ;; It is here to make it hard for the user from resetting it.
305 ;;; ISO characters and MULE
307 ;; If non-nil, ISO accents will be turned on in insert/replace emacs states and
308 ;; turned off in vi-state. For some users, this behavior may be too
309 ;; primitive. In this case, use insert/emacs/vi state hooks.
311 ;; Set iso-accents-mode to ARG. Check if it is bound first
316 ;; Internal flag used to control when viper mule hooks are run.
317 ;; Don't change this!
319 ;; If non-nil, the default intl. input method is turned on.
322 ;; viper hook to run on input-method activation
325 ()
327 ;; turn off special input methods in vi-state
337 ))
339 ;; viper hook to run on input-method deactivation
342 ()
356 ;; XEmacs had broken quil-mode for some time, so we are working around
357 ;; it here
365 ))
372 ;; Set quail-mode to ARG
377 ;; activate input method
381 ))
384 ;; VI-style Undo
386 ;; Used to 'undo' complex commands, such as replace and insert commands.
390 ;; A mark that Viper puts on buffer-undo-list. Marks the beginning of a
391 ;; complex command that must be undone atomically. If inserted, it is
392 ;; erased by viper-change-state-to-vi and viper-repeat.
396 "*Non-nil means not to move point while undoing commands.
397 This style is different from Emacs and Vi. Try it to see if
398 it better fits your working style."
403 ;; Replace mode and changing text
405 ;; Hack used to pass global states around for short period of time
408 ;; This is used to pass the right Vi command key sequence to
409 ;; viper-set-destructive-command whenever (this-command-keys) doesn't give the
410 ;; right result. For instance, in commands like c/bla<RET>,
411 ;; (this-command-keys) will return ^M, which invoked exit-minibuffer, while we
412 ;; need "c/"
415 ;; Indicates that the current destructive command has started in replace mode.
419 "If non-nil, Viper will allow multi-line replace regions.
420 This is an extension to standard Vi.
421 If nil, commands that attempt to replace text spanning multiple lines first
422 delete the text being replaced, as in standard Vi."
427 "*Cursor color when Viper is in Replace state."
432 "Cursor color when Viper is in insert state."
436 ;; viper-emacs-state-cursor-color doesn't work well. Causes cursor colors to be
437 ;; confused in some cases. So, this var is nulled for now.
438 ;; (defcustom viper-emacs-state-cursor-color "Magenta"
440 "Cursor color when Viper is in Emacs state."
444 ;; internal var, used to remember the default cursor color of emacs frames
449 viper-insert-state-cursor-color viper-emacs-state-cursor-color
450 viper-vi-state-cursor-color))
457 "A string marking the end of replacement regions.
458 It is used only with TTYs or if `viper-use-replace-region-delimiters'
459 is non-nil."
463 "A string marking the beginning of replacement regions.
464 It is used only with TTYs or if `viper-use-replace-region-delimiters'
465 is non-nil."
471 "*If non-nil, Viper will always use `viper-replace-region-end-delimiter' and
472 `viper-replace-region-start-delimiter' to delimit replacement regions, even on
473 color displays. By default, the delimiters are used only on TTYs."
478 "Function to use for prompting the user for a buffer name."
482 ;; XEmacs requires glyphs
491 )
492 nil ; emacs
493 )
497 ;; These are local marker that must be initialized to nil and moved with
498 ;; `viper-move-marker-locally'
499 ;;
500 ;; Remember the last position inside the replace region.
502 ;; Remember the last position while inserting
510 ;; Remember the number of characters that have to be deleted in replace
511 ;; mode to compensate for the inserted characters.
513 ;; This variable is used internally by the before/after changed functions to
514 ;; determine how many chars were deleted by the change. This can't be
515 ;; determined inside after-change-functions because those get the length of the
516 ;; deleted region, not the number of chars deleted (which are two different
517 ;; things under MULE).
520 ;; Insertion ring and command ring
522 "The size of history of inserted text.
523 This is a list where Viper keeps the history of previously inserted pieces of
524 text."
527 ;; The insertion ring.
529 ;; This is temp insertion ring. Used to do rotation for display purposes.
530 ;; When rotation just started, it is initialized to viper-insertion-ring.
535 "The size of history of Vi commands repeatable with dot."
538 ;; The command ring.
540 ;; This is temp command ring. Used to do rotation for display purposes.
541 ;; When rotation just started, it is initialized to viper-command-ring.
544 ;; Fast keyseq and ESC keyseq timeouts
546 "*Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined.
547 Setting this too high may slow down your typing. Setting this value too low
548 will make it hard to use Vi-style timeout macros."
554 "*Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key.
555 Setting this too high may slow down switching from insert to vi state. Setting
556 this value too low will make it impossible to use function keys in insert mode
557 on a dumb terminal."
562 "Allow translation of all key sequences into commands.
563 Normally, Viper lets Emacs translate only those ESC key sequences that are
564 defined in the low-level key-translation-map or function-key-map, such as those
566 treated as ESC command followed by a `/'. This is done for people who type fast
567 and tend to hit other characters right after they hit ESC. Other people like
568 Emacs to translate ESC sequences all the time.
569 The default is to translate all sequences only when using a dumb terminal.
570 This permits you to use ESC as a meta key in insert mode."
574 ;; Modes and related variables
576 ;; Current mode. One of: `emacs-state', `vi-state', `insert-state'
580 ;; Autoindent in insert
582 ;; Variable that keeps track of whether C-t has been pressed.
585 ;; Preserve the indent value, used by C-d in insert mode.
588 ;; Whether to preserve the indent, used by C-d in insert mode.
593 "*Enable autoindent, if t.
594 This is a buffer-local variable."
600 "*If t, electrify Viper.
601 Currently, this only electrifies auto-indentation, making it appropriate to the
602 mode of the buffer.
603 This means that auto-indentation will depart from standard Vi and will indent
604 appropriate to the mode of the buffer. This is especially useful for editing
605 programs and LaTeX documents."
610 "*The value of the shiftwidth.
611 This determines the number of columns by which the Ctl-t moves the cursor in
612 the Insert state."
616 ;; Variables for repeating destructive commands
619 "*If t, don't move point when repeating previous command.
620 This is useful for doing repeated changes with the '.' key.
621 The user can change this to nil, if she likes when the cursor moves
622 to a new place after repeating previous Vi command."
626 ;; Remember insert point as a marker. This is a local marker that must be
627 ;; initialized to nil and moved with `viper-move-marker-locally'.
631 ;; This remembers the point before dabbrev-expand was called.
632 ;; If viper-insert-point turns out to be bigger than that, it is reset
633 ;; back to viper-pre-command-point.
634 ;; The reason this is needed is because dabbrev-expand (and possibly
635 ;; others) may jump to before the insertion point, delete something and
636 ;; then reinsert a bigger piece. For instance: bla^blo
637 ;; If dabbrev-expand is called after `blo' and ^ undicates viper-insert-point,
638 ;; then point jumps to the beginning of `blo'. If expansion is found, `blablo'
639 ;; is deleted, and we have |^, where | denotes point. Next, dabbrev-expand
640 ;; will insert the expansion, and we get: blablo^
641 ;; Whatever we insert next goes before the ^, i.e., before the
642 ;; viper-insert-point marker. So, Viper will think that nothing was
643 ;; inserted. Remembering the orig position of the marker circumvents the
644 ;; problem.
645 ;; We don't know of any command, except dabbrev-expand, that has the same
646 ;; problem. However, the same trick can be used if such a command is
647 ;; discovered later.
648 ;;
652 ;; This is used for saving inserted text.
655 ;; Remembers the last replaced region.
658 ;; Remember com point as a marker.
659 ;; This is a local marker. Should be moved with `viper-move-marker-locally'
662 ;; If non-nil, the value is a list (M-COM VAL COM REG inserted-text cmd-keys)
663 ;; It is used to re-execute last destructive command.
664 ;; M-COM is a Lisp symbol representing the function to be executed.
665 ;; VAL is the prefix argument that was used with that command.
666 ;; COM is an internal descriptor, such as ?r, ?c, ?C, which contains
667 ;; additional information on how the function in M-COM is to be handled.
668 ;; REG is the register used by command
669 ;; INSERTED-TEXT is text inserted by that command (in case of o, c, C, i, r
670 ;; commands).
671 ;; COMMAND-KEYS are the keys that were typed to invoke the command.
674 ;; The character remembered by the Vi `r' command.
677 ;; Name of register to store deleted or yanked strings
681 ;;; Variables for Moves and Searches
684 "Variables that define the search and query-replace behavior of Viper."
688 ;; For use by `;' command.
691 ;; For use by `.' command.
694 ;; For use by `;' command.
697 ;; For use by `;' command.
700 ;; Last search string
704 "String inserted at the beginning of quoted region."
708 ;; If t, search is forward.
712 "*If not nil, search ignores cases."
717 "*If not nil, search is regexp search, otherwise vanilla search."
723 "*If search lands within this threshnold from the window top/bottom,
724 the window will be scrolled up or down appropriately, to reveal context.
725 If you want Viper search to behave as usual in Vi, set this variable to a
726 negative number."
731 "*If t then do regexp replace, if nil then do string replace."
737 "*If t, do regexp replace. nil means do string replace."
743 "*If t, `%' ignores the parentheses that occur inside comments."
749 "*If t, the commands l,h do not cross lines, etc (Ex-style).
750 If nil, these commands cross line boundaries."
756 "*If t, Ex-style behavior while editing in Vi command and insert states.
757 `Backspace' and `Delete' don't cross line boundaries in insert.
758 `X' and `x' can't delete characters across line boundary in Vi, etc.
759 Note: this doesn't preclude `Backspace' and `Delete' from deleting characters
760 by moving past the insertion point. This is a feature, not a bug.
762 If nil, the above commands can work across lines."
768 "*If t, ESC moves cursor back when changing from insert to vi state.
769 If nil, the cursor stays where it was when ESC was hit."
775 "*If t, DEL key will delete characters while moving the cursor backwards.
776 If nil, the cursor will move backwards without deleting anything."
781 "*Key used for buffer-searching. Must be a character type, e.g., ?g."
786 "*If t, search wraps around."
793 "*List of file and buffer names that are considered to be related to the current buffer.
794 Related buffers can be cycled through via :R and :P commands."
799 ;; Used to find out if we are done with searching the current buffer.
801 ;; As above, but global
804 ;; the search overlay
826 ;; These two vars control the interaction of jumps performed by ' and `.
827 ;; In this new version, '' doesn't erase the marks set by ``, so one can
828 ;; use both kinds of jumps interchangeably and without loosing positions
829 ;; inside the lines.
831 ;; Remembers position of the last jump done using ``'.
833 ;; Remembers position of the last jump done using `''.
836 ;; History variables
838 ;; History of search strings.
840 ;; History of query-replace strings used as a source.
842 ;; History of query-replace strings used as replacement.
844 ;; History of region quoting strings.
846 ;; History of Ex-style commands.
848 ;; History of shell commands.
852 ;; Last shell command. There are two of these, one for Ex (in viper-ex)
853 ;; and one for Vi.
855 ;; Last shell command executed with ! command.
858 \f
859 ;;; Face-saving tricks
862 "Hilighting of replace region, search pattern, minibuffer, etc."
870 "*Face used to flash out the search pattern."
872 ;; An internal variable. Viper takes the face from here.
874 "Face used to flash out the search pattern.
875 DO NOT CHANGE this variable. Instead, use the customization widget
876 to customize the actual face object `viper-search'
882 "*Face for highlighting replace regions on a window display."
884 ;; An internal variable. Viper takes the face from here.
886 "Face for highlighting replace regions on a window display.
887 DO NOT CHANGE this variable. Instead, use the customization widget
888 to customize the actual face object `viper-replace-overlay'
894 "Face used in the Minibuffer when it is in Emacs state."
896 ;; An internal variable. Viper takes the face from here.
898 "Face used in the Minibuffer when it is in Emacs state.
899 DO NOT CHANGE this variable. Instead, use the customization widget
900 to customize the actual face object `viper-minibuffer-emacs'
906 "Face used in the Minibuffer when it is in Insert state."
908 ;; An internal variable. Viper takes the face from here.
910 "Face used in the Minibuffer when it is in Insert state.
911 DO NOT CHANGE this variable. Instead, use the customization widget
912 to customize the actual face object `viper-minibuffer-insert'
918 "Face used in the Minibuffer when it is in Vi state."
920 ;; An internal variable. Viper takes the face from here.
922 "Face used in the Minibuffer when it is in Vi state.
923 DO NOT CHANGE this variable. Instead, use the customization widget
924 to customize the actual face object `viper-minibuffer-vi'
927 ;; the current face to be used in the minibuffer
931 \f
932 ;;; Miscellaneous
938 "Spell function used by #s<move> command to spell."
943 "The tags file used by Viper."
948 "Notify the user when this many lines or characters have been deleted/yanked.
949 For line-deleting/yanking commands (like `dd', `yy'), the value denotes the
950 number of lines. For character-based commands (such as `x', `dw', etc.), the
951 value refers to the number of characters affected."
955 ;; Minibuffer
958 "If t, use vi-style editing in minibuffer.
959 Should be set in `~/.viper' file."
963 ;; overlay used in the minibuffer to indicate which state it is in
967 ;; Hook, specific to Viper, which is run just *before* exiting the minibuffer.
968 ;; This is needed because beginning with Emacs 19.26, the standard
969 ;; `minibuffer-exit-hook' is run *after* exiting the minibuffer
973 ;; Mode line
985 "Viper hooks."
990 "*Hooks run just before the switch to Vi mode is completed."
994 "*Hooks run just before the switch to Insert mode is completed."
998 "*Hooks run just before the switch to Replace mode is completed."
1002 "*Hooks run just before the switch to Emacs mode is completed."
1007 "Hooks run just after loading Viper."
1027 ;; Local Variables:
1028 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1029 ;; End:
1031 ;; arch-tag: 4efa2416-1fcb-4690-be10-1a2a0248d250
1032 ;;; viper-init.el ends here