| blob | 2a13f00535e6137af23e393c8736448ac11dca29 |
1 ;;; viper-init.el --- some common definitions for Viper
3 ;; Copyright (C) 1997, 98, 99, 2000, 01, 02 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
24 ;;; Commentary:
26 ;;; Code:
30 ;; compiler pacifier
43 ;; end pacifier
46 ;; Viper version
51 ;; Is it XEmacs?
53 ;; Is it Emacs?
55 ;; Tell whether we are running as a window application or on a TTY
57 ;; This is used to avoid compilation warnings. When emacs/xemacs forms can
58 ;; generate compile time warnings, we use this macro.
59 ;; In this case, the macro will expand into the form that is appropriate to the
60 ;; compiler at hand.
61 ;; Suggested by rms.
64 xemacs-form emacs-form))
70 window-system
71 ))
73 ;; in XEmacs: device-type is tty on tty and stream in batch.
79 "Tells if Emacs is running under an MS-style OS: ms-dos, windows-nt, W95."
84 "Tells if Emacs is running under VMS."
90 "If t, Viper will think that it is running on a display that supports faces.
91 This is provided as a temporary relief for users of graphics-capable terminals
92 that Viper doesn't know about.
93 In all likelihood, you don't need to bother with this setting."
103 \f
104 ;;; Macros
112 ;; (viper-loop COUNT BODY) Execute BODY COUNT times.
116 ,@body
122 ;; return buffer-specific macro definition, given a full macro definition
125 ;; get a pair: (curr-buffer . macro-definition)
128 ;; get macro definition for current buffer
132 ;; return mode-specific macro definitions, given a full macro definition
135 ;; get a pair: (major-mode . macro-definition)
138 ;; get macro definition for the current major mode
142 ;; return global macro definition, given a full macro definition
145 ;; get global macro definition from an elt of macro-alist
149 ;; last elt of a sequence
159 ;; like char-after/before, but saves typing
166 \f
171 \f
172 ;;; Viper minor modes
174 ;; Mode for vital things like \e, C-z.
193 "Minor mode for Ex command macros in Vi state.
194 The corresponding keymap stores key bindings of Vi macros defined with
197 ;; Mode for vital things like \e, C-z.
204 "Auxiliary minor mode for buffer-local user-defined bindings in Insert state.
205 This is a way to overshadow normal Insert mode bindings locally to certain
215 "Minor mode that simulates Vi very closely.
219 "Minor mode for Ex command macros Insert state.
220 The corresponding keymap stores key bindings of Vi macros defined with
226 ;; Mode for vital things like \C-z and \C-x) This is set to t, when viper-mode
227 ;; is invoked. So, any new buffer will have C-z defined as switch to Vi,
228 ;; unless we switched states in this buffer
232 "Minor mode for local user bindings effective in Emacs state.
233 Users can use it to override Emacs bindings when Viper is in its Emacs
237 "Minor mode for global user bindings in effect in Emacs state.
238 Users can use it to override Emacs bindings when Viper is in its Emacs
242 "Minor mode for Vi style macros in Emacs state.
243 The corresponding keymap stores key bindings of Vi macros defined with
244 `viper-record-kbd-macro' command. There is no Ex-level command to do this
248 "Minor mode used to make major-mode-specific modification to Emacs state.
249 For instance, a Vi purist may want to bind `dd' in Dired mode to a function
258 \f
260 ;; Some common error messages
275 ;; Is t until viper-mode executes for the very first time.
276 ;; Prevents recursive descend into startup messages.
280 "User's expert level.
281 The minor mode viper-vi-diehard-minor-mode is in effect when
282 viper-expert-level is 1 or 2 or when viper-want-emacs-keys-in-vi is t.
283 The minor mode viper-insert-diehard-minor-mode is in effect when
284 viper-expert-level is 1 or 2 or if viper-want-emacs-keys-in-insert is t.
287 ;; Max expert level supported by Viper. This is NOT a user option.
288 ;; It is here to make it hard for the user from resetting it.
292 ;;; ISO characters and MULE
294 ;; If non-nil, ISO accents will be turned on in insert/replace emacs states and
295 ;; turned off in vi-state. For some users, this behavior may be too
296 ;; primitive. In this case, use insert/emacs/vi state hooks.
298 ;; Set iso-accents-mode to ARG. Check if it is bound first
303 ;; Internal flag used to control when viper mule hooks are run.
304 ;; Don't change this!
306 ;; If non-nil, the default intl. input method is turned on.
309 ;; viper hook to run on input-method activation
312 ()
314 ;; turn off special input methods in vi-state
323 ))
325 ;; viper hook to run on input-method deactivation
328 ()
341 ;; XEmacs had broken quil-mode for some time, so we are working around
342 ;; it here
350 ))
357 ;; Set quail-mode to ARG
362 ;; activate input method
366 ))
369 ;; VI-style Undo
371 ;; Used to 'undo' complex commands, such as replace and insert commands.
375 ;; A mark that Viper puts on buffer-undo-list. Marks the beginning of a
376 ;; complex command that must be undone atomically. If inserted, it is
377 ;; erased by viper-change-state-to-vi and viper-repeat.
381 "*Non-nil means not to move point while undoing commands.
382 This style is different from Emacs and Vi. Try it to see if
383 it better fits your working style."
388 ;; Replace mode and changing text
390 ;; Hack used to pass global states around for short period of time
393 ;; This is used to pass the right Vi command key sequence to
394 ;; viper-set-destructive-command whenever (this-command-keys) doesn't give the
395 ;; right result. For instance, in commands like c/bla<RET>,
396 ;; (this-command-keys) will return ^M, which invoked exit-minibuffer, while we
397 ;; need "c/"
400 ;; Indicates that the current destructive command has started in replace mode.
404 "If non-nil, Viper will allow multi-line replace regions.
405 This is an extension to standard Vi.
406 If nil, commands that attempt to replace text spanning multiple lines first
407 delete the text being replaced, as in standard Vi."
412 "*Cursor color when Viper is in Replace state."
416 "Cursor color when Viper is in insert state."
420 ;; internal var, used to remember the default cursor color of emacs frames
427 "A string marking the end of replacement regions.
428 It is used only with TTYs or if `viper-use-replace-region-delimiters'
429 is non-nil."
433 "A string marking the beginning of replacement regions.
434 It is used only with TTYs or if `viper-use-replace-region-delimiters'
435 is non-nil."
441 "*If non-nil, Viper will always use `viper-replace-region-end-delimiter' and
442 `viper-replace-region-start-delimiter' to delimit replacement regions, even on
443 color displays. By default, the delimiters are used only on TTYs."
448 "Function to use for prompting the user for a buffer name."
452 ;; XEmacs requires glyphs
461 )
462 nil ; emacs
463 )
467 ;; These are local marker that must be initialized to nil and moved with
468 ;; `viper-move-marker-locally'
469 ;;
470 ;; Remember the last position inside the replace region.
472 ;; Remember the last position while inserting
480 ;; Remember the number of characters that have to be deleted in replace
481 ;; mode to compensate for the inserted characters.
483 ;; This variable is used internally by the before/after changed functions to
484 ;; determine how many chars were deleted by the change. This can't be
485 ;; determined inside after-change-functions because those get the length of the
486 ;; deleted region, not the number of chars deleted (which are two different
487 ;; things under MULE).
490 ;; Insertion ring and command ring
492 "The size of history of inserted text.
493 This is a list where Viper keeps the history of previously inserted pieces of
494 text."
497 ;; The insertion ring.
499 ;; This is temp insertion ring. Used to do rotation for display purposes.
500 ;; When rotation just started, it is initialized to viper-insertion-ring.
505 "The size of history of Vi commands repeatable with dot."
508 ;; The command ring.
510 ;; This is temp command ring. Used to do rotation for display purposes.
511 ;; When rotation just started, it is initialized to viper-command-ring.
514 ;; Fast keyseq and ESC keyseq timeouts
516 "*Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined.
517 Setting this too high may slow down your typing. Setting this value too low
518 will make it hard to use Vi-style timeout macros."
524 "*Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key.
525 Setting this too high may slow down switching from insert to vi state. Setting
526 this value too low will make it impossible to use function keys in insert mode
527 on a dumb terminal."
532 "Allow translation of all key sequences into commands.
533 Normally, Viper lets Emacs translate only those ESC key sequences that are
534 defined in the low-level key-translation-map or function-key-map, such as those
536 treated as ESC command followed by a `/'. This is done for people who type fast
537 and tend to hit other characters right after they hit ESC. Other people like
538 Emacs to translate ESC sequences all the time.
539 The default is to translate all sequences only when using a dumb terminal.
540 This permits you to use ESC as a meta key in insert mode."
544 ;; Modes and related variables
546 ;; Current mode. One of: `emacs-state', `vi-state', `insert-state'
550 ;; Autoindent in insert
552 ;; Variable that keeps track of whether C-t has been pressed.
555 ;; Preserve the indent value, used by C-d in insert mode.
558 ;; Whether to preserve the indent, used by C-d in insert mode.
563 "*Enable autoindent, if t.
564 This is a buffer-local variable."
570 "*If t, electrify Viper.
571 Currently, this only electrifies auto-indentation, making it appropriate to the
572 mode of the buffer.
573 This means that auto-indentation will depart from standard Vi and will indent
574 appropriate to the mode of the buffer. This is especially useful for editing
575 programs and LaTeX documents."
580 "*The value of the shiftwidth.
581 This determines the number of columns by which the Ctl-t moves the cursor in
582 the Insert state."
586 ;; Variables for repeating destructive commands
589 "*If t, don't move point when repeating previous command.
590 This is useful for doing repeated changes with the '.' key.
591 The user can change this to nil, if she likes when the cursor moves
592 to a new place after repeating previous Vi command."
596 ;; Remember insert point as a marker. This is a local marker that must be
597 ;; initialized to nil and moved with `viper-move-marker-locally'.
601 ;; This remembers the point before dabbrev-expand was called.
602 ;; If viper-insert-point turns out to be bigger than that, it is reset
603 ;; back to viper-pre-command-point.
604 ;; The reason this is needed is because dabbrev-expand (and possibly
605 ;; others) may jump to before the insertion point, delete something and
606 ;; then reinsert a bigger piece. For instance: bla^blo
607 ;; If dabbrev-expand is called after `blo' and ^ undicates viper-insert-point,
608 ;; then point jumps to the beginning of `blo'. If expansion is found, `blablo'
609 ;; is deleted, and we have |^, where | denotes point. Next, dabbrev-expand
610 ;; will insert the expansion, and we get: blablo^
611 ;; Whatever we insert next goes before the ^, i.e., before the
612 ;; viper-insert-point marker. So, Viper will think that nothing was
613 ;; inserted. Remembering the orig position of the marker circumvents the
614 ;; problem.
615 ;; We don't know of any command, except dabbrev-expand, that has the same
616 ;; problem. However, the same trick can be used if such a command is
617 ;; discovered later.
618 ;;
622 ;; This is used for saving inserted text.
625 ;; Remembers the last replaced region.
628 ;; Remember com point as a marker.
629 ;; This is a local marker. Should be moved with `viper-move-marker-locally'
632 ;; If non-nil, the value is a list (M-COM VAL COM REG inserted-text cmd-keys)
633 ;; It is used to re-execute last destructive command.
634 ;; M-COM is a Lisp symbol representing the function to be executed.
635 ;; VAL is the prefix argument that was used with that command.
636 ;; COM is an internal descriptor, such as ?r, ?c, ?C, which contains
637 ;; additional information on how the function in M-COM is to be handled.
638 ;; REG is the register used by command
639 ;; INSERTED-TEXT is text inserted by that command (in case of o, c, C, i, r
640 ;; commands).
641 ;; COMMAND-KEYS are the keys that were typed to invoke the command.
644 ;; The character remembered by the Vi `r' command.
647 ;; Name of register to store deleted or yanked strings
651 ;;; Variables for Moves and Searches
654 "Variables that define the search and query-replace behavior of Viper."
658 ;; For use by `;' command.
661 ;; For use by `.' command.
664 ;; For use by `;' command.
667 ;; For use by `;' command.
670 ;; Last search string
674 "String inserted at the beginning of quoted region."
678 ;; If t, search is forward.
682 "*If not nil, search ignores cases."
687 "*If not nil, search is regexp search, otherwise vanilla search."
693 "*If search lands within this threshnold from the window top/bottom,
694 the window will be scrolled up or down appropriately, to reveal context.
695 If you want Viper search to behave as usual in Vi, set this variable to a
696 negative number."
701 "*If t then do regexp replace, if nil then do string replace."
707 "*If t, do regexp replace. nil means do string replace."
713 "*If t, `%' ignores the parentheses that occur inside comments."
719 "*If t, the commands l,h do not cross lines, etc (Ex-style).
720 If nil, these commands cross line boundaries."
726 "*If t, Ex-style behavior while editing in Vi command and insert states.
727 `Backspace' and `Delete' don't cross line boundaries in insert.
728 `X' and `x' can't delete characters across line boundary in Vi, etc.
729 Note: this doesn't preclude `Backspace' and `Delete' from deleting characters
730 by moving past the insertion point. This is a feature, not a bug.
732 If nil, the above commands can work across lines."
738 "*If t, ESC moves cursor back when changing from insert to vi state.
739 If nil, the cursor stays where it was when ESC was hit."
745 "*If t, DEL key will delete characters while moving the cursor backwards.
746 If nil, the cursor will move backwards without deleting anything."
751 "*Key used for buffer-searching. Must be a character type, e.g., ?g."
756 "*If t, search wraps around."
763 "*List of file and buffer names that are considered to be related to the current buffer.
764 Related buffers can be cycled through via :R and :P commands."
769 ;; Used to find out if we are done with searching the current buffer.
771 ;; As above, but global
774 ;; the search overlay
796 ;; These two vars control the interaction of jumps performed by ' and `.
797 ;; In this new version, '' doesn't erase the marks set by ``, so one can
798 ;; use both kinds of jumps interchangeably and without loosing positions
799 ;; inside the lines.
801 ;; Remembers position of the last jump done using ``'.
803 ;; Remembers position of the last jump done using `''.
806 ;; History variables
808 ;; History of search strings.
810 ;; History of query-replace strings used as a source.
812 ;; History of query-replace strings used as replacement.
814 ;; History of region quoting strings.
816 ;; History of Ex-style commands.
818 ;; History of shell commands.
822 ;; Last shell command. There are two of these, one for Ex (in viper-ex)
823 ;; and one for Vi.
825 ;; Last shell command executed with ! command.
828 \f
829 ;;; Face-saving tricks
837 "Hilighting of replace region, search pattern, minibuffer, etc."
845 "*Face used to flash out the search pattern."
847 ;; An internal variable. Viper takes the face from here.
849 "Face used to flash out the search pattern.
850 DO NOT CHANGE this variable. Instead, use the customization widget
851 to customize the actual face object `viper-search-face'
859 "*Face for highlighting replace regions on a window display."
861 ;; An internal variable. Viper takes the face from here.
863 "Face for highlighting replace regions on a window display.
864 DO NOT CHANGE this variable. Instead, use the customization widget
865 to customize the actual face object `viper-replace-overlay-face'
873 "Face used in the Minibuffer when it is in Emacs state."
875 ;; An internal variable. Viper takes the face from here.
877 "Face used in the Minibuffer when it is in Emacs state.
878 DO NOT CHANGE this variable. Instead, use the customization widget
879 to customize the actual face object `viper-minibuffer-emacs-face'
887 "Face used in the Minibuffer when it is in Insert state."
889 ;; An internal variable. Viper takes the face from here.
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-face'
901 "Face used in the Minibuffer when it is in Vi state."
903 ;; An internal variable. Viper takes the face from here.
905 "Face used in the Minibuffer when it is in Vi state.
906 DO NOT CHANGE this variable. Instead, use the customization widget
907 to customize the actual face object `viper-minibuffer-vi-face'
911 ;; the current face to be used in the minibuffer
915 \f
916 ;;; Miscellaneous
922 "Spell function used by #s<move> command to spell."
927 "The tags file used by Viper."
932 "Notify the user when this many lines or characters have been deleted/yanked.
933 For line-deleting/yanking commands (like `dd', `yy'), the value denotes the
934 number of lines. For character-based commands (such as `x', `dw', etc.), the
935 value refers to the number of characters affected."
939 ;; Minibuffer
942 "If t, use vi-style editing in minibuffer.
943 Should be set in `~/.viper' file."
947 ;; overlay used in the minibuffer to indicate which state it is in
951 ;; Hook, specific to Viper, which is run just *before* exiting the minibuffer.
952 ;; This is needed because beginning with Emacs 19.26, the standard
953 ;; `minibuffer-exit-hook' is run *after* exiting the minibuffer
957 ;; Mode line
969 "Viper hooks."
974 "*Hooks run just before the switch to Vi mode is completed."
978 "*Hooks run just before the switch to Insert mode is completed."
982 "*Hooks run just before the switch to Replace mode is completed."
986 "*Hooks run just before the switch to Emacs mode is completed."
991 "Hooks run just after loading Viper."
1008 ;;; Local Variables:
1009 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1010 ;;; End:
1012 ;;; arch-tag: 4efa2416-1fcb-4690-be10-1a2a0248d250
1013 ;;; viper-init.el ends here