| blob | fa29b3add68c05052e82a0ea6c430800001148f4 |
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
28 ;; end pacifier
30 ;; Is it XEmacs?
32 ;; Is it Emacs?
34 ;; Tell whether we are running as a window application or on a TTY
37 window-system
39 ;; in XEmacs: device-type is tty on tty and stream in batch.
49 "If t, Viper will think that it is running on a display that supports faces.
50 This is provided as a temporary relief for users of face-capable displays
62 ;; hopefully, XEmacs adds this functionality
63 fname))
65 \f
66 ;;; Macros
73 )))
76 "(vip-loop COUNT BODY) Execute BODY COUNT times."
79 body
81 )))
86 ;; return buffer-specific macro definition, given a full macro definition
89 ;; get a pair: (curr-buffer . macro-definition)
92 ;; get macro definition for current buffer
96 ;; return mode-specific macro definitions, given a full macro definition
99 ;; get a pair: (major-mode . macro-definition)
102 ;; get macro definition for the current major mode
106 ;; return global macro definition, given a full macro definition
109 ;; get global macro definition from an elt of macro-alist
113 ;; last elt of a sequence
117 \f
122 \f
123 ;;; Viper minor modes
125 ;; This is not local in Emacs, so we make it local.
126 ;; This must be local because although the stack of minor modes can be the same
127 ;; for all buffers, the associated *keymaps* can be different. In Viper,
128 ;; vip-vi-local-user-map, vip-insert-local-user-map, and others can have
129 ;; different keymaps for different buffers.
130 ;; Also, the keymaps associated with vip-vi/insert-state-modifier-minor-mode
131 ;; can be different.
134 ;; Mode for vital things like \e, C-z.
153 "Minor mode for Ex command macros in Vi state.
154 The corresponding keymap stores key bindings of Vi macros defined with
157 ;; Mode for vital things like \e, C-z.
164 "Auxiliary minor mode for buffer-local user-defined bindings in Insert state.
165 This is a way to overshadow normal Insert mode bindings locally to certain
175 "Minor mode that simulates Vi very closely.
179 "Minor mode for Ex command macros Insert state.
180 The corresponding keymap stores key bindings of Vi macros defined with
186 ;; Mode for vital things like \C-z and \C-x)
187 ;; This is t, by default. So, any new buffer will have C-z defined as
188 ;; switch to Vi, unless we switched states in this buffer
192 "Minor mode for local user bindings effective in Emacs state.
193 Users can use it to override Emacs bindings when Viper is in its Emacs
197 "Minor mode for global user bindings in effect in Emacs state.
198 Users can use it to override Emacs bindings when Viper is in its Emacs
202 "Minor mode for Vi style macros in Emacs state.
203 The corresponding keymap stores key bindings of Vi macros defined with
204 `vip-record-kbd-macro' command. There is no Ex-level command to do this
208 "Minor mode used to make major-mode-specific modification to Emacs state.
209 For instance, a Vi purist may want to bind `dd' in Dired mode to a function
218 \f
220 ;; Some common error messages
235 ;; Is t until viper-mode executes for the very first time.
236 ;; Prevents recursive descend into startup messages.
240 "User's expert level.
241 The minor mode vip-vi-diehard-minor-mode is in effect when
242 vip-expert-level is 1 or 2 or when vip-want-emacs-keys-in-vi is t.
243 The minor mode vip-insert-diehard-minor-mode is in effect when
244 vip-expert-level is 1 or 2 or if vip-want-emacs-keys-in-insert is t.
247 ;; Max expert level supported by Viper. This is NOT a user option.
248 ;; It is here to make it hard for the user from resetting it.
251 ;; Contains user settings for vars affected by vip-set-expert-level function.
252 ;; Not a user option.
256 ;;; ISO characters
259 "*If non-nil, ISO accents will be turned on in insert/replace emacs states and turned off in vi-state.
260 For some users, this behavior may be too primitive. In this case, use
264 ;; VI-style Undo
266 ;; Used to 'undo' complex commands, such as replace and insert commands.
270 ;; A mark that Viper puts on buffer-undo-list. Marks the beginning of a
271 ;; complex command that must be undone atomically. If inserted, it is
272 ;; erased by vip-change-state-to-vi and vip-repeat.
276 "*Non-nil means not to move point while undoing commands.
277 This style is different from Emacs and Vi. Try it to see if
280 ;; Replace mode and changing text
282 ;; Viper's own after/before change functions, which get vip-add-hook'ed to
283 ;; Emacs's
289 ;; Can be used to pass global states around for short period of time
292 ;; Indicates that the current destructive command has started in replace mode.
296 "If non-nil, Viper will allow multi-line replace regions.
297 This is an extension to standard Vi.
298 If nil, commands that attempt to replace text spanning multiple lines first
306 ;; place to save cursor colow when switching to insert mode
319 "A string marking the end of replacement regions.
320 It is used only with TTYs or if `vip-use-replace-region-delimiters'
323 "A string marking the beginning of replacement regions.
324 It is used only with TTYs or if `vip-use-replace-region-delimiters'
327 "*If non-nil, Viper will always use `vip-replace-region-end-delimiter' and
328 `vip-replace-region-start-delimiter' to delimit replacement regions, even on
331 ;; XEmacs requires glyphs
340 ))
343 ;; These are local marker that must be initialized to nil and moved with
344 ;; `vip-move-marker-locally'
345 ;;
346 ;; Remember the last position inside the replace region.
348 ;; Remember the last position while inserting
356 ;; Remember the number of characters that have to be deleted in replace
357 ;; mode to compensate for the inserted characters.
361 ;; Insertion ring and command ring
364 ;; The insertion ring.
366 ;; This is temp insertion ring. Used to do rotation for display purposes.
367 ;; When rotation just started, it is initialized to vip-insertion-ring.
373 ;; The command ring.
375 ;; This is temp command ring. Used to do rotation for display purposes.
376 ;; When rotation just started, it is initialized to vip-command-ring.
379 ;; Modes and related variables
381 ;; Current mode. One of: `emacs-state', `vi-state', `insert-state'
385 ;; Autoindent in insert
387 ;; Variable that keeps track of whether C-t has been pressed.
390 ;; Preserve the indent value, used by C-d in insert mode.
393 ;; Whether to preserve the indent, used by C-d in insert mode.
399 "*If t, enable electric behavior.
405 ;; Variables for repeating destructive commands
408 "*If t, don't move point when repeating previous command.
409 This is useful for doing repeated changes with the '.' key.
410 The user can change this to nil, if she likes when the cursor moves
413 ;; Remember insert point as a marker. This is a local marker that must be
414 ;; initialized to nil and moved with `vip-move-marker-locally'.
418 ;; This remembers the point before dabbrev-expand was called.
419 ;; If vip-insert-point turns out to be bigger than that, it is reset
420 ;; back to vip-pre-command-point.
421 ;; The reason this is needed is because dabbrev-expand (and possibly
422 ;; others) may jump to before the insertion point, delete something and
423 ;; then reinsert a bigger piece. For instance: bla^blo
424 ;; If dabbrev-expand is called after `blo' and ^ undicates vip-insert-point,
425 ;; then point jumps to the beginning of `blo'. If expansion is found, `blablo'
426 ;; is deleted, and we have |^, where | denotes point. Next, dabbrev-expand
427 ;; will insert the expansion, and we get: blablo^
428 ;; Whatever we insert next goes before the ^, i.e., before the
429 ;; vip-insert-point marker. So, Viper will think that nothing was
430 ;; inserted. Remembering the orig position of the marker circumvents the
431 ;; problem.
432 ;; We don't know of any command, except dabbrev-expand, that has the same
433 ;; problem. However, the same trick can be used if such a command is
434 ;; discovered later.
435 ;;
439 ;; This is used for saving inserted text.
442 ;; Remembers the last replaced region.
445 ;; Remember com point as a marker.
446 ;; This is a local marker. Should be moved with `vip-move-marker-locally'
449 ;; If non-nil, the value is a list (M-COM VAL COM REG inserted-text cmd-keys)
450 ;; It is used to re-execute last destructive command.
451 ;; M-COM is a Lisp symbol representing the function to be executed.
452 ;; VAL is the prefix argument that was used with that command.
453 ;; COM is an internal descriptor, such as ?r, ?c, ?C, which contains
454 ;; additional information on how the function in M-COM is to be handled.
455 ;; REG is the register used by command
456 ;; INSERTED-TEXT is text inserted by that command (in case of o, c, C, i, r
457 ;; commands).
458 ;; COMMAND-KEYS are the keys that were typed to invoke the command.
461 ;; The character remembered by the Vi `r' command.
464 ;; Name of register to store deleted or yanked strings
469 ;; Variables for Moves and Searches
471 ;; For use by `;' command.
474 ;; For use by `.' command.
477 ;; For use by `;' command.
480 ;; For use by `;' command.
483 ;; Last search string
489 ;; If t, search is forward.
499 "*If search lands within this threshnold from the window top/bottom,
500 the window will be scrolled up or down appropriately, to reveal context.
501 If you want Viper search to behave as usual in Vi, set this variable to a
517 "*The keys ^H, ^? don't jump lines in insert, ESC moves cursor back, etc.
518 Note: this doesn't preclude ^H and ^? from deleting characters by moving
522 "*If t, DEL key will delete characters while moving the cursor backwards.
532 "*Ring of file and buffer names that are considered to be related to the
533 current buffer.
537 ;; Used to find out if we are done with searching the current buffer.
539 ;; As above, but global
542 ;; the search overlay
564 ;; These two vars control the interaction of jumps performed by ' and `.
565 ;; In this new version, '' doesn't erase the marks set by ``, so one can
566 ;; use both kinds of jumps interchangeably and without loosing positions
567 ;; inside the lines.
569 ;; Remembers position of the last jump done using ``'.
571 ;; Remembers position of the last jump done using `''.
574 ;; History variables
576 ;; History of search strings.
578 ;; History of query-replace strings used as a source.
580 ;; History of query-replace strings used as replacement.
582 ;; History of region quoting strings.
584 ;; History of Ex-style commands.
586 ;; History of shell commands.
590 ;; Last shell command. There are two of these, one for Ex (in viper-ex)
591 ;; and one for Vi.
593 ;; Last shell command executed with ! command.
597 \f
598 ;;; Miscellaneous
600 ;; don't bark when mark is inactive
610 "Viper customisation file.
620 ;; Indicates if we are in the middle of executing a command that takes another
621 ;; command as an argument, e.g., cw, dw, etc.
624 ;; Minibuffer
627 "If t, use vi-style editing in minibuffer.
630 ;; overlay used in the minibuffer to indicate which state it is in
633 ;; Hook, specific to Viper, which is run just *before* exiting the minibuffer.
634 ;; Beginning with Emacs 19.26, the standard `minibuffer-exit-hook' is run
635 ;; *after* exiting the minibuffer
638 ;; setup emacs-supported vi-style feel
640 require-final-newline t)
645 ;; Mode line
655 ;; Viper changes the default mode-line-buffer-identification
658 ;; Variable displaying the current Viper state in the mode line.
677 ;;; viper-ex.el ends here