| blob | e28c67a531518c70eca8cb4d3eb6fd24dca90c92 |
1 ;;; viper-init.el --- some common definitions for Viper
3 ;; Copyright (C) 1997-2015 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
99 "Define VAR as a buffer-local variable.
100 DEFAULT-VALUE is the default value, and DOCUMENTATION is the
101 docstring. The variable becomes buffer-local whenever set."
108 ;; (viper-loop COUNT BODY) Execute BODY COUNT times.
113 ,@body
119 ;; return buffer-specific macro definition, given a full macro definition
122 ;; get a pair: (curr-buffer . macro-definition)
125 ;; get macro definition for current buffer
129 ;; return mode-specific macro definitions, given a full macro definition
132 ;; get a pair: (major-mode . macro-definition)
135 ;; get macro definition for the current major mode
139 ;; return global macro definition, given a full macro definition
142 ;; get global macro definition from an elt of macro-alist
146 ;; last elt of a sequence
156 ;; like char-after/before, but saves typing
163 \f
168 \f
169 ;;; Viper minor modes
171 ;; Mode for vital things like \e, C-z.
190 "Minor mode for Ex command macros in Vi state.
191 The corresponding keymap stores key bindings of Vi macros defined with
194 ;; Mode for vital things like \e, C-z.
201 "Auxiliary minor mode for buffer-local user-defined bindings in Insert state.
202 This is a way to overshadow normal Insert mode bindings locally to certain
212 "Minor mode that simulates Vi very closely.
216 "Minor mode for Ex command macros Insert state.
217 The corresponding keymap stores key bindings of Vi macros defined with
223 ;; Mode for vital things like \C-z and \C-x) This is set to t, when viper-mode
224 ;; is invoked. So, any new buffer will have C-z defined as switch to Vi,
225 ;; unless we switched states in this buffer
229 "Minor mode for local user bindings effective in Emacs state.
230 Users can use it to override Emacs bindings when Viper is in its Emacs
234 "Minor mode for global user bindings in effect in Emacs state.
235 Users can use it to override Emacs bindings when Viper is in its Emacs
239 "Minor mode for Vi style macros in Emacs state.
240 The corresponding keymap stores key bindings of Vi macros defined with
241 `viper-record-kbd-macro' command. There is no Ex-level command to do this
245 "Minor mode used to make major-mode-specific modification to Emacs state.
246 For instance, a Vi purist may want to bind `dd' in Dired mode to a function
255 \f
257 ;; Some common error messages
272 ;; Is t until viper-mode executes for the very first time.
273 ;; Prevents recursive descend into startup messages.
277 "User's expert level.
278 The minor mode viper-vi-diehard-minor-mode is in effect when
279 viper-expert-level is 1 or 2 or when viper-want-emacs-keys-in-vi is t.
280 The minor mode viper-insert-diehard-minor-mode is in effect when
281 viper-expert-level is 1 or 2 or if viper-want-emacs-keys-in-insert is t.
284 ;; Max expert level supported by Viper. This is NOT a user option.
285 ;; It is here to make it hard for the user from resetting it.
289 ;;; ISO characters and MULE
291 ;; If non-nil, ISO accents will be turned on in insert/replace emacs states and
292 ;; turned off in vi-state. For some users, this behavior may be too
293 ;; primitive. In this case, use insert/emacs/vi state hooks.
295 ;; Set iso-accents-mode to ARG. Check if it is bound first
300 ;; Internal flag used to control when viper mule hooks are run.
301 ;; Don't change this!
303 ;; If non-nil, the default intl. input method is turned on.
306 ;; viper hook to run on input-method activation
309 ()
311 ;; turn off special input methods in vi-state
321 ))
323 ;; viper hook to run on input-method deactivation
326 ()
340 ;; XEmacs had broken quail-mode for some time, so we are working around
341 ;; it here
351 ))
358 ;; Set quail-mode to ARG
363 ;; activate input method
367 ))
370 ;; VI-style Undo
372 ;; Used to 'undo' complex commands, such as replace and insert commands.
376 ;; A mark that Viper puts on buffer-undo-list. Marks the beginning of a
377 ;; complex command that must be undone atomically. If inserted, it is
378 ;; erased by viper-change-state-to-vi and viper-repeat.
382 "Non-nil means not to move point while undoing commands.
383 This style is different from Emacs and Vi. Try it to see if
384 it better fits your working style."
389 ;; Replace mode and changing text
391 ;; Hack used to pass global states around for short period of time
394 ;; This is used to pass the right Vi command key sequence to
395 ;; viper-set-destructive-command whenever (this-command-keys) doesn't give the
396 ;; right result. For instance, in commands like c/bla<RET>,
397 ;; (this-command-keys) will return ^M, which invoked exit-minibuffer, while we
398 ;; need "c/"
401 ;; Indicates that the current destructive command has started in replace mode.
405 "If non-nil, Viper will allow multi-line replace regions.
406 This is an extension to standard Vi.
407 If nil, commands that attempt to replace text spanning multiple lines first
408 delete the text being replaced, as in standard Vi."
413 "Cursor color when Viper is in Replace state."
418 "Cursor color when Viper is in insert state."
422 ;; viper-emacs-state-cursor-color doesn't work well. Causes cursor colors to be
423 ;; confused in some cases. So, this var is nulled for now.
424 ;; (defcustom viper-emacs-state-cursor-color "Magenta"
426 "Cursor color when Viper is in Emacs state."
430 ;; internal var, used to remember the default cursor color of emacs frames
433 ;; Frame-local variables are obsolete from Emacs 22.2 onwards, so we
434 ;; do it by hand with viper-frame-value (qv).
446 "A string marking the end of replacement regions.
447 It is used only with TTYs or if `viper-use-replace-region-delimiters'
448 is non-nil."
452 "A string marking the beginning of replacement regions.
453 It is used only with TTYs or if `viper-use-replace-region-delimiters'
454 is non-nil."
460 "If non-nil, Viper will always use `viper-replace-region-end-delimiter' and
461 `viper-replace-region-start-delimiter' to delimit replacement regions, even on
462 color displays. By default, the delimiters are used only on TTYs."
467 "Function to use for prompting the user for a buffer name."
471 ;; XEmacs requires glyphs
480 ;; These are local marker that must be initialized to nil and moved with
481 ;; `viper-move-marker-locally'
482 ;;
483 ;; Remember the last position inside the replace region.
485 ;; Remember the last position while inserting
493 ;; Remember the number of characters that have to be deleted in replace
494 ;; mode to compensate for the inserted characters.
496 ;; This variable is used internally by the before/after changed functions to
497 ;; determine how many chars were deleted by the change. This can't be
498 ;; determined inside after-change-functions because those get the length of the
499 ;; deleted region, not the number of chars deleted (which are two different
500 ;; things under MULE).
503 ;; Insertion ring and command ring
505 "The size of history of inserted text.
506 This is a list where Viper keeps the history of previously inserted pieces of
507 text."
510 ;; The insertion ring.
512 ;; This is temp insertion ring. Used to do rotation for display purposes.
513 ;; When rotation just started, it is initialized to viper-insertion-ring.
518 "The size of history of Vi commands repeatable with dot."
521 ;; The command ring.
523 ;; This is temp command ring. Used to do rotation for display purposes.
524 ;; When rotation just started, it is initialized to viper-command-ring.
527 ;; Fast keyseq and ESC keyseq timeouts
529 "Key sequence separated by no more than this many milliseconds is viewed as a Vi-style macro, if such a macro is defined.
530 Setting this too high may slow down your typing. Setting this value too low
531 will make it hard to use Vi-style timeout macros."
535 ;; This function determines if ESC key sequences are to be translated into
536 ;; commands.
540 ;; Modes and related variables
542 ;; Current mode. One of: `emacs-state', `vi-state', `insert-state'
546 ;; Autoindent in insert
548 ;; Variable that keeps track of whether C-t has been pressed.
551 ;; Preserve the indent value, used by C-d in insert mode.
554 ;; Whether to preserve the indent, used by C-d in insert mode.
559 "Enable autoindent, if t.
560 This is a buffer-local variable."
566 "If t, electrify Viper.
567 Currently, this only electrifies auto-indentation, making it appropriate to the
568 mode of the buffer.
569 This means that auto-indentation will depart from standard Vi and will indent
570 appropriate to the mode of the buffer. This is especially useful for editing
571 programs and LaTeX documents."
576 "The value of the shiftwidth.
577 This determines the number of columns by which the Ctl-t moves the cursor in
578 the Insert state."
582 ;; Variables for repeating destructive commands
585 "If t, don't move point when repeating previous command.
586 This is useful for doing repeated changes with the ‘.’ key.
587 The user can change this to nil, if she likes when the cursor moves
588 to a new place after repeating previous Vi command."
592 ;; Remember insert point as a marker. This is a local marker that must be
593 ;; initialized to nil and moved with `viper-move-marker-locally'.
597 ;; This remembers the point before dabbrev-expand was called.
598 ;; If viper-insert-point turns out to be bigger than that, it is reset
599 ;; back to viper-pre-command-point.
600 ;; The reason this is needed is because dabbrev-expand (and possibly
601 ;; others) may jump to before the insertion point, delete something and
602 ;; then reinsert a bigger piece. For instance: bla^blo
603 ;; If dabbrev-expand is called after `blo' and ^ indicates viper-insert-point,
604 ;; then point jumps to the beginning of `blo'. If expansion is found, `blablo'
605 ;; is deleted, and we have |^, where | denotes point. Next, dabbrev-expand
606 ;; will insert the expansion, and we get: blablo^
607 ;; Whatever we insert next goes before the ^, i.e., before the
608 ;; viper-insert-point marker. So, Viper will think that nothing was
609 ;; inserted. Remembering the orig position of the marker circumvents the
610 ;; problem.
611 ;; We don't know of any command, except dabbrev-expand, that has the same
612 ;; problem. However, the same trick can be used if such a command is
613 ;; discovered later.
614 ;;
618 ;; This is used for saving inserted text.
621 ;; Remembers the last replaced region.
624 ;; Remember com point as a marker.
625 ;; This is a local marker. Should be moved with `viper-move-marker-locally'
628 ;; If non-nil, the value is a list (M-COM VAL COM REG inserted-text cmd-keys)
629 ;; It is used to re-execute last destructive command.
630 ;; M-COM is a Lisp symbol representing the function to be executed.
631 ;; VAL is the prefix argument that was used with that command.
632 ;; COM is an internal descriptor, such as ?r, ?c, ?C, which contains
633 ;; additional information on how the function in M-COM is to be handled.
634 ;; REG is the register used by command
635 ;; INSERTED-TEXT is text inserted by that command (in case of o, c, C, i, r
636 ;; commands).
637 ;; COMMAND-KEYS are the keys that were typed to invoke the command.
640 ;; The character remembered by the Vi `r' command.
643 ;; Name of register to store deleted or yanked strings
647 ;;; Variables for Moves and Searches
650 "Variables that define the search and query-replace behavior of Viper."
654 ;; For use by `;' command.
657 ;; For use by `.' command.
660 ;; For use by `;' command.
663 ;; For use by `;' command.
666 ;; Last search string
670 "String inserted at the beginning of quoted region."
674 ;; If t, search is forward.
678 "If not nil, search ignores cases."
683 "If not nil, search is regexp search, otherwise vanilla search."
689 "If search lands within this threshold from the window top/bottom,
690 the window will be scrolled up or down appropriately, to reveal context.
691 If you want Viper search to behave as usual in Vi, set this variable to a
692 negative number."
697 "If t then do regexp replace, if nil then do string replace."
703 "If t, do regexp replace. nil means do string replace."
709 "If t, `%' ignores the parentheses that occur inside comments."
715 "If t, the commands l,h do not cross lines, etc (Ex-style).
716 If nil, these commands cross line boundaries."
722 "If t, Ex-style behavior while editing in Vi command and insert states.
723 `Backspace' and `Delete' don't cross line boundaries in insert.
724 `X' and `x' can't delete characters across line boundary in Vi, etc.
725 Note: this doesn't preclude `Backspace' and `Delete' from deleting characters
726 by moving past the insertion point. This is a feature, not a bug.
728 If nil, the above commands can work across lines."
734 "If t, ESC moves cursor back when changing from insert to vi state.
735 If nil, the cursor stays where it was when ESC was hit."
741 "If t, DEL key will delete characters while moving the cursor backwards.
742 If nil, the cursor will move backwards without deleting anything."
747 "Key used for buffer-searching. Must be a character type, e.g., ?g."
752 "If t, search wraps around."
759 "List of file and buffer names that are considered to be related to the current buffer.
760 Related buffers can be cycled through via :R and :P commands."
765 ;; Used to find out if we are done with searching the current buffer.
767 ;; As above, but global
770 ;; the search overlay
792 ;; These two vars control the interaction of jumps performed by ' and `.
793 ;; In this new version, '' doesn't erase the marks set by ``, so one can
794 ;; use both kinds of jumps interchangeably and without losing positions
795 ;; inside the lines.
797 ;; Remembers position of the last jump done using ``'.
799 ;; Remembers position of the last jump done using `''.
802 ;; History variables
804 ;; History of search strings.
806 ;; History of query-replace strings used as a source.
808 ;; History of query-replace strings used as replacement.
810 ;; History of region quoting strings.
812 ;; History of Ex-style commands.
814 ;; History of shell commands.
818 ;; Last shell command. There are two of these, one for Ex (in viper-ex)
819 ;; and one for Vi.
821 ;; Last shell command executed with ! command.
824 \f
825 ;;; Face-saving tricks
828 "Highlighting of replace region, search pattern, minibuffer, etc."
836 "Face used to flash out the search pattern."
838 ;; An internal variable. Viper takes the face from here.
840 "Face used to flash out the search pattern.
841 DO NOT CHANGE this variable. Instead, use the customization widget
842 to customize the actual face object `viper-search'
848 "Face for highlighting replace regions on a window display."
850 ;; An internal variable. Viper takes the face from here.
852 "Face for highlighting replace regions on a window display.
853 DO NOT CHANGE this variable. Instead, use the customization widget
854 to customize the actual face object `viper-replace-overlay'
860 "Face used in the Minibuffer when it is in Emacs state."
862 ;; An internal variable. Viper takes the face from here.
864 "Face used in the Minibuffer when it is in Emacs state.
865 DO NOT CHANGE this variable. Instead, use the customization widget
866 to customize the actual face object `viper-minibuffer-emacs'
872 "Face used in the Minibuffer when it is in Insert state."
874 ;; An internal variable. Viper takes the face from here.
876 "Face used in the Minibuffer when it is in Insert state.
877 DO NOT CHANGE this variable. Instead, use the customization widget
878 to customize the actual face object `viper-minibuffer-insert'
884 "Face used in the Minibuffer when it is in Vi state."
886 ;; An internal variable. Viper takes the face from here.
888 "Face used in the Minibuffer when it is in Vi state.
889 DO NOT CHANGE this variable. Instead, use the customization widget
890 to customize the actual face object `viper-minibuffer-vi'
893 ;; the current face to be used in the minibuffer
897 \f
898 ;;; Miscellaneous
904 "Spell function used by #s<move> command to spell."
909 "The tags file used by Viper."
914 "Notify the user when this many lines or characters have been deleted/yanked.
915 For line-deleting/yanking commands (like `dd', `yy'), the value denotes the
916 number of lines. For character-based commands (such as `x', `dw', etc.), the
917 value refers to the number of characters affected."
921 ;; Minibuffer
924 "If t, use vi-style editing in minibuffer.
925 Should be set in `viper-custom-file-name'."
929 ;; overlay used in the minibuffer to indicate which state it is in
933 ;; Hook, specific to Viper, which is run just *before* exiting the minibuffer.
934 ;; This is needed because beginning with Emacs 19.26, the standard
935 ;; `minibuffer-exit-hook' is run *after* exiting the minibuffer
939 ;; Mode line
951 "Viper hooks."
956 "Hooks run just before the switch to Vi mode is completed."
960 "Hooks run just before the switch to Insert mode is completed."
964 "Hooks run just before the switch to Replace mode is completed."
968 "Hooks run just before the switch to Emacs mode is completed."
973 "Hooks run just after loading Viper."
990 "Key sequence beginning with ESC and separated by no more than this many milliseconds is considered to be generated by a keyboard function key.
991 Setting this too high may slow down switching from insert to vi state. Setting
992 this value too low will make it impossible to use function keys in insert mode
993 on a dumb terminal."
1002 ;; Local Variables:
1003 ;; eval: (put 'viper-deflocalvar 'lisp-indent-hook 'defun)
1004 ;; End:
1006 ;;; viper-init.el ends here