| blob | bd1bddfebb013ffaf3fa468f1e06229cdb6b7d26 |
1 ;;; viper-init.el --- some common definitions for Viper
3 ;; Copyright (C) 1997 Free Software Foundation, Inc.
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation; either version 2, or (at your option)
10 ;; any later version.
12 ;; GNU Emacs is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs; see the file COPYING. If not, write to the
19 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 ;; Boston, MA 02111-1307, USA.
22 ;; Code
26 ;; compiler pacifier
33 ;; end pacifier
36 ;; Viper version
41 ;; Is it XEmacs?
43 ;; Is it Emacs?
45 ;; Tell whether we are running as a window application or on a TTY
48 window-system
50 ;; in XEmacs: device-type is tty on tty and stream in batch.
56 "Tells if Emacs is running under an MS-style OS: ms-dos, windows-nt, W95."
61 "Tells if Emacs is running under VMS."
67 "If t, Viper will think that it is running on a display that supports faces.
68 This is provided as a temporary relief for users of graphics-capable terminals
69 that Viper doesn't know about.
70 In all likelihood, you don't need to bother with this setting."
80 \f
81 ;;; Macros
88 )))
90 ;; (viper-loop COUNT BODY) Execute BODY COUNT times.
97 ))
98 )))
103 ;; return buffer-specific macro definition, given a full macro definition
106 ;; get a pair: (curr-buffer . macro-definition)
109 ;; get macro definition for current buffer
113 ;; return mode-specific macro definitions, given a full macro definition
116 ;; get a pair: (major-mode . macro-definition)
119 ;; get macro definition for the current major mode
123 ;; return global macro definition, given a full macro definition
126 ;; get global macro definition from an elt of macro-alist
130 ;; last elt of a sequence
140 ;; like char-after/before, but saves typing
147 \f
152 \f
153 ;;; Viper minor modes
155 ;; Mode for vital things like \e, C-z.
174 "Minor mode for Ex command macros in Vi state.
175 The corresponding keymap stores key bindings of Vi macros defined with
178 ;; Mode for vital things like \e, C-z.
185 "Auxiliary minor mode for buffer-local user-defined bindings in Insert state.
186 This is a way to overshadow normal Insert mode bindings locally to certain
196 "Minor mode that simulates Vi very closely.
200 "Minor mode for Ex command macros Insert state.
201 The corresponding keymap stores key bindings of Vi macros defined with
207 ;; Mode for vital things like \C-z and \C-x)
208 ;; This is t, by default. So, any new buffer will have C-z defined as
209 ;; switch to Vi, unless we switched states in this buffer
213 "Minor mode for local user bindings effective in Emacs state.
214 Users can use it to override Emacs bindings when Viper is in its Emacs
218 "Minor mode for global user bindings in effect in Emacs state.
219 Users can use it to override Emacs bindings when Viper is in its Emacs
223 "Minor mode for Vi style macros in Emacs state.
224 The corresponding keymap stores key bindings of Vi macros defined with
225 `viper-record-kbd-macro' command. There is no Ex-level command to do this
229 "Minor mode used to make major-mode-specific modification to Emacs state.
230 For instance, a Vi purist may want to bind `dd' in Dired mode to a function
239 \f
241 ;; Some common error messages
256 ;; Is t until viper-mode executes for the very first time.
257 ;; Prevents recursive descend into startup messages.
261 "User's expert level.
262 The minor mode viper-vi-diehard-minor-mode is in effect when
263 viper-expert-level is 1 or 2 or when viper-want-emacs-keys-in-vi is t.
264 The minor mode viper-insert-diehard-minor-mode is in effect when
265 viper-expert-level is 1 or 2 or if viper-want-emacs-keys-in-insert is t.
268 ;; Max expert level supported by Viper. This is NOT a user option.
269 ;; It is here to make it hard for the user from resetting it.
273 ;;; ISO characters and MULE
275 ;; If non-nil, ISO accents will be turned on in insert/replace emacs states and
276 ;; turned off in vi-state. For some users, this behavior may be too
277 ;; primitive. In this case, use insert/emacs/vi state hooks.
279 ;; Set iso-accents-mode to ARG. Check if it is bound first
284 ;; Internal flag used to control when viper mule hooks are run.
285 ;; Don't change this!
287 ;; If non-nil, the default intl. input method is turned on.
290 ;; viper hook to run on input-method activation
293 ()
295 ;; turn off special input methods in vi-state
304 ))
305 ;; viper hook to run on input-method deactivation
308 ()
321 ;; XEmacs had broken quil-mode for some time, so we are working around
322 ;; it here
330 ))
337 ;; Set quail-mode to ARG
342 ;; activate input method
346 ))
349 ;; VI-style Undo
351 ;; Used to 'undo' complex commands, such as replace and insert commands.
355 ;; A mark that Viper puts on buffer-undo-list. Marks the beginning of a
356 ;; complex command that must be undone atomically. If inserted, it is
357 ;; erased by viper-change-state-to-vi and viper-repeat.
361 "*Non-nil means not to move point while undoing commands.
362 This style is different from Emacs and Vi. Try it to see if
363 it better fits your working style."
368 ;; Replace mode and changing text
370 ;; Viper's own after/before change functions, which get viper-add-hook'ed to
371 ;; Emacs's
377 ;; Can be used to pass global states around for short period of time
380 ;; This is used to pass the right Vi command key sequence to
381 ;; viper-set-destructive-command whenever (this-command-keys) doesn't give the
382 ;; right result. For instance, in commands like c/bla<RET>, (this-command-keys)
383 ;; will return ^M, which invoked exit-minibuffer, while we need "c/"
386 ;; Indicates that the current destructive command has started in replace mode.
390 "If non-nil, Viper will allow multi-line replace regions.
391 This is an extension to standard Vi.
392 If nil, commands that attempt to replace text spanning multiple lines first
393 delete the text being replaced, as in standard Vi."
398 "*Cursor color when Viper is in Replace state."
402 "Cursor color when Viper is in insert state."
406 ;; place to save cursor colow when switching to insert mode
413 "A string marking the end of replacement regions.
414 It is used only with TTYs or if `viper-use-replace-region-delimiters'
415 is non-nil."
419 "A string marking the beginning of replacement regions.
420 It is used only with TTYs or if `viper-use-replace-region-delimiters'
421 is non-nil."
427 "*If non-nil, Viper will always use `viper-replace-region-end-delimiter' and
428 `viper-replace-region-start-delimiter' to delimit replacement regions, even on
429 color displays. By default, the delimiters are used only on TTYs."
433 ;; XEmacs requires glyphs
442 ))
445 ;; These are local marker that must be initialized to nil and moved with
446 ;; `viper-move-marker-locally'
447 ;;
448 ;; Remember the last position inside the replace region.
450 ;; Remember the last position while inserting
458 ;; Remember the number of characters that have to be deleted in replace
459 ;; mode to compensate for the inserted characters.
461 ;; This variable is used internally by the before/after changed functions to
462 ;; determine how many chars were deleted by the change. This can't be
463 ;; determined inside after-change-functions because those get the length of the
464 ;; deleted region, not the number of chars deleted (which are two different
465 ;; things under MULE).
468 ;; Insertion ring and command ring
470 "The size of history of inserted text.
471 This is a list where Viper keeps the history of previously inserted pieces of
472 text."
475 ;; The insertion ring.
477 ;; This is temp insertion ring. Used to do rotation for display purposes.
478 ;; When rotation just started, it is initialized to viper-insertion-ring.
483 "The size of history of Vi commands repeatable with dot."
486 ;; The command ring.
488 ;; This is temp command ring. Used to do rotation for display purposes.
489 ;; When rotation just started, it is initialized to viper-command-ring.
492 ;; Fast keyseq and ESC keyseq timeouts
494 "*Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined.
495 Setting this too high may slow down your typing. Setting this value too low
496 will make it hard to use Vi-stile timeout macros."
502 "*Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key.
503 Setting this too high may slow down switching from insert to vi state. Setting
504 this value too low will make it impossible to use function keys in insert mode
505 on a dumb terminal."
509 ;; Modes and related variables
511 ;; Current mode. One of: `emacs-state', `vi-state', `insert-state'
515 ;; Autoindent in insert
517 ;; Variable that keeps track of whether C-t has been pressed.
520 ;; Preserve the indent value, used by C-d in insert mode.
523 ;; Whether to preserve the indent, used by C-d in insert mode.
528 "*Enable autoindent, if t.
529 This is a buffer-local variable."
535 "*If t, electrify Viper.
536 Currently, this only electrifies auto-indentation, making it appropriate to the
537 mode of the buffer.
538 This means that auto-indentation will depart from standard Vi and will indent
539 appropriate to the mode of the buffer. This is especially useful for editing
540 programs and LaTeX documents."
545 "*The shiftwidth variable."
549 ;; Variables for repeating destructive commands
552 "*If t, don't move point when repeating previous command.
553 This is useful for doing repeated changes with the '.' key.
554 The user can change this to nil, if she likes when the cursor moves
555 to a new place after repeating previous Vi command."
559 ;; Remember insert point as a marker. This is a local marker that must be
560 ;; initialized to nil and moved with `viper-move-marker-locally'.
564 ;; This remembers the point before dabbrev-expand was called.
565 ;; If viper-insert-point turns out to be bigger than that, it is reset
566 ;; back to viper-pre-command-point.
567 ;; The reason this is needed is because dabbrev-expand (and possibly
568 ;; others) may jump to before the insertion point, delete something and
569 ;; then reinsert a bigger piece. For instance: bla^blo
570 ;; If dabbrev-expand is called after `blo' and ^ undicates viper-insert-point,
571 ;; then point jumps to the beginning of `blo'. If expansion is found, `blablo'
572 ;; is deleted, and we have |^, where | denotes point. Next, dabbrev-expand
573 ;; will insert the expansion, and we get: blablo^
574 ;; Whatever we insert next goes before the ^, i.e., before the
575 ;; viper-insert-point marker. So, Viper will think that nothing was
576 ;; inserted. Remembering the orig position of the marker circumvents the
577 ;; problem.
578 ;; We don't know of any command, except dabbrev-expand, that has the same
579 ;; problem. However, the same trick can be used if such a command is
580 ;; discovered later.
581 ;;
585 ;; This is used for saving inserted text.
588 ;; Remembers the last replaced region.
591 ;; Remember com point as a marker.
592 ;; This is a local marker. Should be moved with `viper-move-marker-locally'
595 ;; If non-nil, the value is a list (M-COM VAL COM REG inserted-text cmd-keys)
596 ;; It is used to re-execute last destructive command.
597 ;; M-COM is a Lisp symbol representing the function to be executed.
598 ;; VAL is the prefix argument that was used with that command.
599 ;; COM is an internal descriptor, such as ?r, ?c, ?C, which contains
600 ;; additional information on how the function in M-COM is to be handled.
601 ;; REG is the register used by command
602 ;; INSERTED-TEXT is text inserted by that command (in case of o, c, C, i, r
603 ;; commands).
604 ;; COMMAND-KEYS are the keys that were typed to invoke the command.
607 ;; The character remembered by the Vi `r' command.
610 ;; Name of register to store deleted or yanked strings
614 ;;; Variables for Moves and Searches
617 "Variables that define the search and query-replace behavior of Viper."
621 ;; For use by `;' command.
624 ;; For use by `.' command.
627 ;; For use by `;' command.
630 ;; For use by `;' command.
633 ;; Last search string
637 "String inserted at the beginning of quoted region."
641 ;; If t, search is forward.
645 "*If not nil, search ignores cases."
650 "*If not nil, search is regexp search, otherwise vanilla search."
656 "*If search lands within this threshnold from the window top/bottom,
657 the window will be scrolled up or down appropriately, to reveal context.
658 If you want Viper search to behave as usual in Vi, set this variable to a
659 negative number."
664 "*If t then do regexp replace, if nil then do string replace."
670 "*If t, do regexp replace. nil means do string replace."
676 "*If t, `%' ignores the parentheses that occur inside comments."
682 "*If t, the commands l,h do not cross lines, etc (Ex-style).
683 If nil, these commands cross line boundaries."
689 "*If t, Ex-style behavior while editing in Vi command and insert states.
690 `Backspace' and `Delete' don't cross line boundaries in insert.
691 `X' and `x' can't delete characters across line boundary in Vi, etc.
692 Note: this doesn't preclude `Backspace' and `Delete' from deleting characters
693 by moving past the insertion point. This is a feature, not a bug.
695 If nil, the above commands can work across lines."
701 "*If t, ESC moves cursor back when changing from insert to vi state.
702 If nil, the cursor stays where it was when ESC was hit."
708 "*If t, DEL key will delete characters while moving the cursor backwards.
709 If nil, the cursor will move backwards without deleting anything."
714 "*Key used for buffer-searching. Must be a character type, e.g., ?g."
719 "*If t, search wraps around."
726 "*List of file and buffer names that are considered to be related to the current buffer.
727 Related buffers can be cycled through via :R and :P commands."
732 ;; Used to find out if we are done with searching the current buffer.
734 ;; As above, but global
737 ;; the search overlay
759 ;; These two vars control the interaction of jumps performed by ' and `.
760 ;; In this new version, '' doesn't erase the marks set by ``, so one can
761 ;; use both kinds of jumps interchangeably and without loosing positions
762 ;; inside the lines.
764 ;; Remembers position of the last jump done using ``'.
766 ;; Remembers position of the last jump done using `''.
769 ;; History variables
771 ;; History of search strings.
773 ;; History of query-replace strings used as a source.
775 ;; History of query-replace strings used as replacement.
777 ;; History of region quoting strings.
779 ;; History of Ex-style commands.
781 ;; History of shell commands.
785 ;; Last shell command. There are two of these, one for Ex (in viper-ex)
786 ;; and one for Vi.
788 ;; Last shell command executed with ! command.
791 \f
792 ;;; Face-saving tricks
794 ;;(defcustom viper-replace-overlay-pixmap "gray3"
795 ;; "Pixmap to use for search face on non-color displays."
796 ;; :type 'string
797 ;; :group 'viper)
798 ;;(defcustom viper-search-face-pixmap "gray3"
799 ;; "Pixmap to use for search face on non-color displays."
800 ;; :type 'string
801 ;; :group 'viper)
809 "Hilighting of replace region, search pattern, minibuffer, etc."
813 ;;(defvar viper-search-face
814 ;; (if (viper-has-face-support-p)
815 ;; (progn
816 ;; (make-face 'viper-search-face)
817 ;; (or (face-differs-from-default-p 'viper-search-face)
818 ;; ;; face wasn't set in .viper or .Xdefaults
819 ;; (if (viper-can-use-colors "Black" "khaki")
820 ;; (progn
821 ;; (set-face-background 'viper-search-face "khaki")
822 ;; (set-face-foreground 'viper-search-face "Black"))
823 ;; (set-face-underline-p 'viper-search-face t)
824 ;; (viper-set-face-pixmap 'viper-search-face
825 ;; viper-search-face-pixmap)))
826 ;; 'viper-search-face))
827 ;; "*Face used to flash out the search pattern.")
832 "*Face used to flash out the search pattern."
834 ;; An internal variable. Viper takes the face from here.
836 "Face used to flash out the search pattern.
837 DO NOT CHANGE this variable. Instead, use the customization widget
838 to customize the actual face object `viper-search-face'
842 ;;(defvar viper-replace-overlay-face
843 ;; (if (viper-has-face-support-p)
844 ;; (progn
845 ;; (make-face 'viper-replace-overlay-face)
846 ;; (or (face-differs-from-default-p 'viper-replace-overlay-face)
847 ;; (progn
848 ;; (if (viper-can-use-colors "darkseagreen2" "Black")
849 ;; (progn
850 ;; (set-face-background
851 ;; 'viper-replace-overlay-face "darkseagreen2")
852 ;; (set-face-foreground 'viper-replace-overlay-face "Black")))
853 ;; (set-face-underline-p 'viper-replace-overlay-face t)
854 ;; (viper-set-face-pixmap
855 ;; 'viper-replace-overlay-face viper-replace-overlay-pixmap)))
856 ;; 'viper-replace-overlay-face))
857 ;; "*Face for highlighting replace regions on a window display.")
862 "*Face for highlighting replace regions on a window display."
864 ;; An internal variable. Viper takes the face from here.
866 "Face for highlighting replace regions on a window display.
867 DO NOT CHANGE this variable. Instead, use the customization widget
868 to customize the actual face object `viper-replace-overlay-face'
872 ;;(defvar viper-minibuffer-emacs-face
873 ;; (if (viper-has-face-support-p)
874 ;; (progn
875 ;; (make-face 'viper-minibuffer-emacs-face)
876 ;; (or (face-differs-from-default-p 'viper-minibuffer-emacs-face)
877 ;; ;; face wasn't set in .viper or .Xdefaults
878 ;; (if viper-vi-style-in-minibuffer
879 ;; ;; emacs state is an exception in the minibuffer
880 ;; (if (viper-can-use-colors "darkseagreen2" "Black")
881 ;; (progn
882 ;; (set-face-background
883 ;; 'viper-minibuffer-emacs-face "darkseagreen2")
884 ;; (set-face-foreground
885 ;; 'viper-minibuffer-emacs-face "Black"))
886 ;; (copy-face 'modeline 'viper-minibuffer-emacs-face))
887 ;; ;; emacs state is the main state in the minibuffer
888 ;; (if (viper-can-use-colors "Black" "pink")
889 ;; (progn
890 ;; (set-face-background 'viper-minibuffer-emacs-face "pink")
891 ;; (set-face-foreground
892 ;; 'viper-minibuffer-emacs-face "Black"))
893 ;; (copy-face 'italic 'viper-minibuffer-emacs-face))
894 ;; ))
895 ;; 'viper-minibuffer-emacs-face))
896 ;; "Face used in the Minibuffer when it is in Emacs state.")
901 "Face used in the Minibuffer when it is in Emacs state."
903 ;; An internal variable. Viper takes the face from here.
905 "Face used in the Minibuffer when it is in Emacs state.
906 DO NOT CHANGE this variable. Instead, use the customization widget
907 to customize the actual face object `viper-minibuffer-emacs-face'
911 ;;(defvar viper-minibuffer-insert-face
912 ;; (if (viper-has-face-support-p)
913 ;; (progn
914 ;; (make-face 'viper-minibuffer-insert-face)
915 ;; (or (face-differs-from-default-p 'viper-minibuffer-insert-face)
916 ;; (if viper-vi-style-in-minibuffer
917 ;; (if (viper-can-use-colors "Black" "pink")
918 ;; (progn
919 ;; (set-face-background 'viper-minibuffer-insert-face "pink")
920 ;; (set-face-foreground
921 ;; 'viper-minibuffer-insert-face "Black"))
922 ;; (copy-face 'italic 'viper-minibuffer-insert-face))
923 ;; ;; If Insert state is an exception
924 ;; (if (viper-can-use-colors "darkseagreen2" "Black")
925 ;; (progn
926 ;; (set-face-background
927 ;; 'viper-minibuffer-insert-face "darkseagreen2")
928 ;; (set-face-foreground
929 ;; 'viper-minibuffer-insert-face "Black"))
930 ;; (copy-face 'modeline 'viper-minibuffer-insert-face))
931 ;; (viper-italicize-face 'viper-minibuffer-insert-face)))
932 ;; 'viper-minibuffer-insert-face))
933 ;; "Face used in the Minibuffer when it is in Insert state.")
938 "Face used in the Minibuffer when it is in Insert state."
940 ;; An internal variable. Viper takes the face from here.
942 "Face used in the Minibuffer when it is in Insert state.
943 DO NOT CHANGE this variable. Instead, use the customization widget
944 to customize the actual face object `viper-minibuffer-insert-face'
948 ;;(defvar viper-minibuffer-vi-face
949 ;; (if (viper-has-face-support-p)
950 ;; (progn
951 ;; (make-face 'viper-minibuffer-vi-face)
952 ;; (or (face-differs-from-default-p 'viper-minibuffer-vi-face)
953 ;; (if viper-vi-style-in-minibuffer
954 ;; (if (viper-can-use-colors "Black" "grey")
955 ;; (progn
956 ;; (set-face-background 'viper-minibuffer-vi-face "grey")
957 ;; (set-face-foreground 'viper-minibuffer-vi-face "Black"))
958 ;; (copy-face 'bold 'viper-minibuffer-vi-face))
959 ;; (copy-face 'bold 'viper-minibuffer-vi-face)
960 ;; (invert-face 'viper-minibuffer-vi-face)))
961 ;; 'viper-minibuffer-vi-face))
962 ;; "Face used in the Minibuffer when it is in Vi state.")
967 "Face used in the Minibuffer when it is in Vi state."
969 ;; An internal variable. Viper takes the face from here.
971 "Face used in the Minibuffer when it is in Vi state.
972 DO NOT CHANGE this variable. Instead, use the customization widget
973 to customize the actual face object `viper-minibuffer-vi-face'
977 ;; the current face to be used in the minibuffer
981 \f
982 ;;; Miscellaneous
988 "Spell function used by #s<move> command to spell."
993 "The tags file used by Viper."
997 ;; Minibuffer
1000 "If t, use vi-style editing in minibuffer.
1001 Should be set in `~/.viper' file."
1005 ;; overlay used in the minibuffer to indicate which state it is in
1008 ;; Hook, specific to Viper, which is run just *before* exiting the minibuffer.
1009 ;; Beginning with Emacs 19.26, the standard `minibuffer-exit-hook' is run
1010 ;; *after* exiting the minibuffer
1014 ;; Mode line
1026 "Viper hooks."
1031 "*Hooks run just before the switch to Vi mode is completed."
1035 "*Hooks run just before the switch to Insert mode is completed."
1039 "*Hooks run just before the switch to Replace mode is completed."
1043 "*Hooks run just before the switch to Emacs mode is completed."
1048 "Hooks run just after loading Viper."
1053 ;;; Local Variables:
1054 ;;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1055 ;;; End:
1057 ;;; viper-ex.el ends here