| blob | 3aff0628b5f27a8259a424ccf5c9b4d8ae3f98d4 |
1 ;;; viper-macs.el --- functions implementing keyboard macros for Viper
3 ;; Copyright (C) 1994-1997, 2000-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:
29 ;; compiler pacifier
36 ;; end pacifier
42 ;;; Variables
44 ;; Register holding last macro.
47 ;; format of the elements of kbd alists:
48 ;; (name ((buf . macr)...(buf . macr)) ((maj-mode . macr)...) (t . macr))
49 ;; kbd macro alist for Vi state
51 ;; same for insert/replace state
53 ;; same for emacs state
56 ;; Internal var that passes info between start-kbd-macro and end-kbd-macro
57 ;; in :map and :map!
66 "Prefix key for accessing previously typed Vi commands.
68 The previous command is accessible, as usual, via `.'. The command before this
69 can be invoked as `<this key> 1', and the command before that, and the command
70 before that one is accessible as `<this key> 2'.
71 The notation for these keys is borrowed from XEmacs. Basically,
73 `(meta control f1)'."
78 \f
79 ;;; Code
83 ;; Ex map command
86 macro-name macro-body map-args ins)
102 ;; if defining macro for insert, switch there for authentic WYSIWYG
111 ))
114 ;; Ex unmap
117 temp macro-name ins)
131 ))
134 ;; read arguments for ex-map
138 temp key event message
139 macro-name macro-body args)
149 'error
152 ;; We expect macro-name to be a vector, a string, or a quoted string.
153 ;; In the second case, it will emerge as a symbol when read from
154 ;; the above read-from-string. So we need to convert it into a string
165 ;; the only keys available for editing are these-- no help while there
167 key
172 ":map%s %s"
178 ;;(setq event (viper-read-event))
183 message)
185 nil)
187 )
206 ;; read arguments for ex-unmap
210 viper-insert-kbd-macro-alist
211 viper-vi-kbd-macro-alist))
212 ;; these are disabled just in case, to avoid surprises when doing
213 ;; completing-read
214 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
215 viper-emacs-kbd-minor-mode
216 viper-vi-intercept-minor-mode viper-insert-intercept-minor-mode
217 viper-emacs-intercept-minor-mode
218 event message
219 key key-seq macro-name)
223 ()
229 ;; the only keys available for editing are these-- no help while there
231 key
238 ":unmap%s %s"
245 ))
248 ":unmap%s %s"
255 ;;(setq event (viper-read-event))
260 message)
262 nil)
264 )
270 ;; convert macro names into vector, if starts with a `['
274 ))
279 ;; Terminate a Vi kbd macro.
280 ;; optional argument IGNORE, if t, indicates that we are dealing with an
281 ;; existing macro that needs to be registered, but there is no need to
282 ;; terminate a kbd macro.
301 ;; always go back to Vi, since this is where we started
302 ;; defining macro
312 ))
316 \f
317 ;;; Recording, unrecording, executing
319 ;; Accepts as macro names: strings and vectors.
320 ;; strings must be strings of characters; vectors must be vectors of keys
321 ;; in canonical form, which is essentially the form used in XEmacs.
322 ;; More general definitions are inherited by more specific scopes:
323 ;; global->major mode->buffer. More specific definitions override more general
325 "Record a Vi macro.
326 Can be used in `viper-custom-file-name' to define permanent macros.
327 MACRO-NAME is a string of characters or a vector of keys. STATE is
328 either `vi-state' or `insert-state'. It specifies the Viper state in which to
329 define the macro. MACRO-BODY is a string that represents the keyboard macro.
330 Optional SCOPE says whether the macro should be global \(t), mode-specific
331 \(a major-mode symbol), or buffer-specific \(buffer name, a string).
332 If SCOPE is nil, the user is asked to specify the scope."
337 keymap viper-vi-kbd-map)
341 keymap viper-insert-kbd-map)
345 keymap viper-emacs-kbd-map)
347 ))
348 new-elt old-elt old-sub-elt msg
349 temp lis lis2)
354 ;; Macro-name is usually a vector. However, command history or macros
355 ;; recorded in viper-custom-file-name may be recorded as strings.
356 ;; So, convert to vectors.
364 ;; don't ask if scope is given and is of the right type
373 "Map this macro for buffer `%s' only? "
377 "%S is mapped to %s for %s in `%s'"
381 "%S"
389 "Map this macro for the major mode `%S' only? "
390 major-mode))
393 "%S is mapped to %s for %s in `%S'"
397 "%S"
401 state-name major-mode))
402 major-mode)
406 "%S is globally mapped to %s in %s"
410 "%S"
414 state-name))
415 t)))
422 state
423 ;; if we don't let vector macro-body through %S,
424 ;; the symbols `\.' `\[' etc will be converted into
425 ;; characters, causing invalid read error on recorded
426 ;; macros in viper-custom-file-name.
427 ;; I am not sure is macro-body can still be a string at
428 ;; this point, but I am preserving this option anyway.
431 macro-body)
432 scope)
433 viper-custom-file-name))
436 ))
449 ;; insert new-elt in macro-alist-var and keep the list sorted
451 keymap
475 ))
479 ;; macro name must be a vector of viper-style keys
480 ;; viper-unrecord-kbd-macro doesn't have scope. Macro definitions are inherited
481 ;; from global -> major mode -> buffer
482 ;; More specific definition overrides more general
483 ;; Can't unrecord definition for more specific, if a more general definition is
484 ;; in effect
486 "Delete macro MACRO-NAME from Viper STATE.
487 MACRO-NAME must be a vector of viper-style keys. This command is used
488 by Viper internally, but you can also use it in `viper-custom-file-name'
489 to delete pre-defined macros supplied with Viper. The best way to avoid
490 mistakes in macro names to be passed to this function is to use
491 `viper-describe-kbd-macros' and copy the name from there."
496 keymap viper-vi-kbd-map)
500 keymap viper-insert-kbd-map)
504 keymap viper-emacs-kbd-map)
506 ))
507 buf-mapping mode-mapping global-mapping
508 macro-pair macro-entry)
510 ;; Macro-name is usually a vector. However, command history or macros
511 ;; recorded in viper-custom-file-name may appear as strings.
512 ;; So, convert to vectors.
544 major-mode))))
550 "Global mapping for %S in %s is removed"
564 keymap
566 nil))
567 ))
568 ))
570 ;; Check if MACRO-ALIST has an entry for a macro name starting with
571 ;; CHAR. If not, this indicates that the binding for this char
572 ;; in viper-vi/insert-kbd-map can be released.
576 macro-name)
583 can-release))
587 "Dispatch kbd macro."
590 viper-vi-kbd-macro-alist)
593 viper-insert-kbd-macro-alist)
595 viper-emacs-kbd-macro-alist)))
597 ;; Macros and keys are executed with other macros turned off
598 ;; For macros, this is done to avoid macro recursion
599 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
600 viper-emacs-kbd-minor-mode
601 next-best-match keyseq event-seq
602 macro-first-char macro-alist-elt macro-body
603 command)
620 ;; when defining keyboard macro, don't use the macro mappings
622 ;; block cmd executed as part of a macro from entering command history
629 ;; If not a macro, or the macro is suppressed while defining another
630 ;; macro, put keyseq back on the event queue
632 ;; if the user typed arg, then use it if prefix arg is not set by
633 ;; some other command (setting prefix arg can happen if we do, say,
634 ;; 2dw and there is a macro starting with 2. Then control will go to
635 ;; this routine
641 ))
644 \f
645 ;;; Displaying and completing macros
648 "Show currently defined keyboard macros."
657 ))
683 ;; check if SEQ is a prefix of some car of an element in ALIST
691 ;; whether SEQ1 is a prefix of SEQ2
698 ;; find the longest common prefix
704 len)
711 rest)))
714 pref))
716 ;; get all sequences that match PREFIX from a given A-LIST
724 )
738 new-seq))
749 ;; alist is the alist of macros
750 ;; str is the fast key sequence entered
751 ;; returns: (matching-macro-def . unmatched-suffix-start-index)
756 match unmatched-start-idx found macro-def)
766 )
771 unmatched-start-idx def-len)
779 ;; returns a list of names of macros defined for the current buffer
788 macro-alist))
792 ;; if seq of Viper key symbols (representing a macro) can be converted to a
793 ;; string--do so. Otherwise, do nothing.
801 ;; convert sequence of events (that came presumably from emacs kbd macro) into
802 ;; Viper's macro, which is a vector of the form
803 ;; [ desc desc ... ]
804 ;; Each desc is either a symbol of (meta symb), (shift symb), etc.
805 ;; Here we purge events that happen to be lists. In most cases, these events
806 ;; got into a macro definition unintentionally; say, when the user moves mouse
807 ;; during a macro definition, then something like (switch-frame ...) might get
808 ;; in. Another reason for purging lists-events is that we can't store them in
809 ;; textual form (say, in .emacs) and then read them back.
812 nil
814 event-seq))))
816 ;; convert strings or arrays of characters to Viper macro form
819 macro)
825 ;; For macros bodies and names, goes over MACRO and checks if all members are
826 ;; names of keys (actually, it only checks if they are symbols or lists
827 ;; if a digit is found, it is converted into a symbol (e.g., 0 -> \0, etc).
828 ;; If MACRO is not a list or vector -- doesn't change MACRO.
832 elt break)
837 ;; fix number
841 idx
846 )))
855 macro)))
861 \f
862 ;;; Reading fast key sequences
864 ;; Assuming that CHAR was the first character in a fast succession of key
865 ;; strokes, read the rest. Return the vector of keys that was entered in
866 ;; this fast succession of key strokes.
867 ;; A fast keysequence is one that is terminated by a pause longer than
868 ;; viper-fast-keyseq-timeout.
871 next-event)
874 ;; Seems that viper-read-event is more robust here. We need to be able to
875 ;; place these events on unread-command-events list. If we use
876 ;; viper-read-key then events will be converted to keys, and sometimes
877 ;; (e.g., (control \[)) those keys differ from the corresponding events.
878 ;; So, do not use (setq next-event (viper-read-key))
882 lis))
884 \f
885 ;;; Keyboard macros in registers
887 ;; sets register to last-kbd-macro carefully.
891 ()
897 "Keyboard macros in registers - a modified @ command."
909 nil
925 "Call last keyboard macro for each line in the region."
935 ;;; viper-macs.el ends here