| blob | 5bd43a29a0cfe0c0099912f92a2a2de017d43bd0 |
1 ;;; viper-macs.el --- functions implementing keyboard macros for Viper
3 ;; Copyright (C) 1994, 1995, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007 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 2, 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:
31 ;; compiler pacifier
37 ;; loading happens only in non-interactive compilation
38 ;; in order to spare non-viperized emacs from being viperized
50 )))
51 ;; end pacifier
57 ;;; Variables
59 ;; Register holding last macro.
62 ;; format of the elements of kbd alists:
63 ;; (name ((buf . macr)...(buf . macr)) ((maj-mode . macr)...) (t . macr))
64 ;; kbd macro alist for Vi state
66 ;; same for insert/replace state
68 ;; same for emacs state
71 ;; Internal var that passes info between start-kbd-macro and end-kbd-macro
72 ;; in :map and :map!
81 "Prefix key for accessing previously typed Vi commands.
83 The previous command is accessible, as usual, via `.'. The command before this
84 can be invoked as `<this key> 1', and the command before that, and the command
85 before that one is accessible as `<this key> 2'.
86 The notation for these keys is borrowed from XEmacs. Basically,
88 `(meta control f1)'."
93 \f
94 ;;; Code
96 ;; Ex map command
99 macro-name macro-body map-args ins)
115 ;; if defining macro for insert, switch there for authentic WYSIWYG
124 ))
127 ;; Ex unmap
130 temp macro-name ins)
144 ))
147 ;; read arguments for ex-map
151 temp key event message
152 macro-name macro-body args)
162 'error
165 ;; We expect macro-name to be a vector, a string, or a quoted string.
166 ;; In the second case, it will emerge as a symbol when read from
167 ;; the above read-from-string. So we need to convert it into a string
178 ;; the only keys available for editing are these-- no help while there
180 key
185 ":map%s %s"
191 ;;(setq event (viper-read-event))
196 message)
198 nil)
200 )
219 ;; read arguments for ex-unmap
223 viper-insert-kbd-macro-alist
224 viper-vi-kbd-macro-alist))
225 ;; these are disabled just in case, to avoid surprises when doing
226 ;; completing-read
227 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
228 viper-emacs-kbd-minor-mode
229 viper-vi-intercept-minor-mode viper-insert-intercept-minor-mode
230 viper-emacs-intercept-minor-mode
231 event message
232 key key-seq macro-name)
236 ()
242 ;; the only keys available for editing are these-- no help while there
244 key
251 ":unmap%s %s"
258 ))
261 ":unmap%s %s"
268 ;;(setq event (viper-read-event))
273 message)
275 nil)
277 )
283 ;; convert macro names into vector, if starts with a `['
287 ))
290 ;; Terminate a Vi kbd macro.
291 ;; optional argument IGNORE, if t, indicates that we are dealing with an
292 ;; existing macro that needs to be registered, but there is no need to
293 ;; terminate a kbd macro.
312 ;; always go back to Vi, since this is where we started
313 ;; defining macro
323 ))
327 \f
328 ;;; Recording, unrecording, executing
330 ;; Accepts as macro names: strings and vectors.
331 ;; strings must be strings of characters; vectors must be vectors of keys
332 ;; in canonic form. The canonic form is essentially the form used in XEmacs
333 ;; More general definitions are inherited by more specific scopes:
334 ;; global->major mode->buffer. More specific definitions override more general
336 "Record a Vi macro. Can be used in `.viper' file to define permanent macros.
337 MACRO-NAME is a string of characters or a vector of keys. STATE is
338 either `vi-state' or `insert-state'. It specifies the Viper state in which to
339 define the macro. MACRO-BODY is a string that represents the keyboard macro.
340 Optional SCOPE says whether the macro should be global \(t\), mode-specific
341 \(a major-mode symbol\), or buffer-specific \(buffer name, a string\).
342 If SCOPE is nil, the user is asked to specify the scope."
347 keymap viper-vi-kbd-map)
351 keymap viper-insert-kbd-map)
355 keymap viper-emacs-kbd-map)
357 ))
358 new-elt old-elt old-sub-elt msg
359 temp lis lis2)
364 ;; Macro-name is usually a vector. However, command history or macros
365 ;; recorded in ~/.viper may be recorded as strings. So, convert to
366 ;; vectors.
374 ;; don't ask if scope is given and is of the right type
383 "Map this macro for buffer `%s' only? "
387 "%S is mapped to %s for %s in `%s'"
391 "%S"
399 "Map this macro for the major mode `%S' only? "
400 major-mode))
403 "%S is mapped to %s for %s in `%S'"
407 "%S"
411 state-name major-mode))
412 major-mode)
416 "%S is globally mapped to %s in %s"
420 "%S"
424 state-name))
425 t)))
432 state
433 ;; if we don't let vector macro-body through %S,
434 ;; the symbols `\.' `\[' etc will be converted into
435 ;; characters, causing invalid read error on recorded
436 ;; macros in .viper.
437 ;; I am not sure is macro-body can still be a string at
438 ;; this point, but I am preserving this option anyway.
441 macro-body)
442 scope)
443 viper-custom-file-name))
446 ))
459 ;; insert new-elt in macro-alist-var and keep the list sorted
461 keymap
485 ))
489 ;; macro name must be a vector of viper-style keys
490 ;; viper-unrecord-kbd-macro doesn't have scope. Macro definitions are inherited
491 ;; from global -> major mode -> buffer
492 ;; More specific definition overrides more general
493 ;; Can't unrecord definition for more specific, if a more general definition is
494 ;; in effect
496 "Delete macro MACRO-NAME from Viper STATE.
497 MACRO-NAME must be a vector of viper-style keys. This command is used by Viper
498 internally, but the user can also use it in ~/.viper to delete pre-defined
499 macros supplied with Viper. The best way to avoid mistakes in macro names to
500 be passed to this function is to use viper-describe-kbd-macros and copy the
501 name from there."
506 keymap viper-vi-kbd-map)
510 keymap viper-insert-kbd-map)
514 keymap viper-emacs-kbd-map)
516 ))
517 buf-mapping mode-mapping global-mapping
518 macro-pair macro-entry)
520 ;; Macro-name is usually a vector. However, command history or macros
521 ;; recorded in ~/.viper may appear as strings. So, convert to vectors.
553 major-mode))))
559 "Global mapping for %S in %s is removed"
573 keymap
575 nil))
576 ))
577 ))
579 ;; Check if MACRO-ALIST has an entry for a macro name starting with
580 ;; CHAR. If not, this indicates that the binding for this char
581 ;; in viper-vi/insert-kbd-map can be released.
585 macro-name)
592 can-release))
596 "Dispatch kbd macro."
599 viper-vi-kbd-macro-alist)
602 viper-insert-kbd-macro-alist)
604 viper-emacs-kbd-macro-alist)))
606 ;; Macros and keys are executed with other macros turned off
607 ;; For macros, this is done to avoid macro recursion
608 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
609 viper-emacs-kbd-minor-mode
610 next-best-match keyseq event-seq
611 macro-first-char macro-alist-elt macro-body
612 command)
629 ;; when defining keyboard macro, don't use the macro mappings
631 ;; block cmd executed as part of a macro from entering command history
638 ;; If not a macro, or the macro is suppressed while defining another
639 ;; macro, put keyseq back on the event queue
641 ;; if the user typed arg, then use it if prefix arg is not set by
642 ;; some other command (setting prefix arg can happen if we do, say,
643 ;; 2dw and there is a macro starting with 2. Then control will go to
644 ;; this routine
650 ))
653 \f
654 ;;; Displaying and completing macros
657 "Show currently defined keyboard macros."
666 ))
692 ;; check if SEQ is a prefix of some car of an element in ALIST
700 ;; whether SEQ1 is a prefix of SEQ2
707 ;; find the longest common prefix
713 len)
720 rest)))
723 pref))
725 ;; get all sequences that match PREFIX from a given A-LIST
733 )
747 new-seq))
758 ;; alist is the alist of macros
759 ;; str is the fast key sequence entered
760 ;; returns: (matching-macro-def . unmatched-suffix-start-index)
765 match unmatched-start-idx found macro-def)
775 )
780 unmatched-start-idx def-len)
788 ;; returns a list of names of macros defined for the current buffer
797 macro-alist))
801 ;; if seq of Viper key symbols (representing a macro) can be converted to a
802 ;; string--do so. Otherwise, do nothing.
810 ;; convert sequence of events (that came presumably from emacs kbd macro) into
811 ;; Viper's macro, which is a vector of the form
812 ;; [ desc desc ... ]
813 ;; Each desc is either a symbol of (meta symb), (shift symb), etc.
814 ;; Here we purge events that happen to be lists. In most cases, these events
815 ;; got into a macro definition unintentionally; say, when the user moves mouse
816 ;; during a macro definition, then something like (switch-frame ...) might get
817 ;; in. Another reason for purging lists-events is that we can't store them in
818 ;; textual form (say, in .emacs) and then read them back.
821 nil
823 event-seq))))
825 ;; convert strings or arrays of characters to Viper macro form
828 macro)
834 ;; For macros bodies and names, goes over MACRO and checks if all members are
835 ;; names of keys (actually, it only checks if they are symbols or lists
836 ;; if a digit is found, it is converted into a symbol (e.g., 0 -> \0, etc).
837 ;; If MACRO is not a list or vector -- doesn't change MACRO.
841 elt break)
846 ;; fix number
850 idx
855 )))
864 macro)))
870 \f
871 ;;; Reading fast key sequences
873 ;; Assuming that CHAR was the first character in a fast succession of key
874 ;; strokes, read the rest. Return the vector of keys that was entered in
875 ;; this fast succession of key strokes.
876 ;; A fast keysequence is one that is terminated by a pause longer than
877 ;; viper-fast-keyseq-timeout.
880 next-event)
884 ;;(setq next-event (viper-read-event))
887 lis))
889 \f
890 ;;; Keyboard macros in registers
892 ;; sets register to last-kbd-macro carefully.
896 ()
902 "Keyboard macros in registers - a modified \@ command."
914 nil
930 "Call last keyboad macro for each line in the region."
940 ;;; arch-tag: ecd3cc5c-8cd0-4bbe-b2ec-7e75a4b7d0aa
941 ;;; viper-macs.el ends here