| blob | ec31aeef42844ae3f6907e0ea025e8aab189dac0 |
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, 2008, 2009, 2010 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 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
35 ;; loading happens only in non-interactive compilation
36 ;; in order to spare non-viperized emacs from being viperized
40 ))
41 ;; end pacifier
47 ;;; Variables
49 ;; Register holding last macro.
52 ;; format of the elements of kbd alists:
53 ;; (name ((buf . macr)...(buf . macr)) ((maj-mode . macr)...) (t . macr))
54 ;; kbd macro alist for Vi state
56 ;; same for insert/replace state
58 ;; same for emacs state
61 ;; Internal var that passes info between start-kbd-macro and end-kbd-macro
62 ;; in :map and :map!
71 "Prefix key for accessing previously typed Vi commands.
73 The previous command is accessible, as usual, via `.'. The command before this
74 can be invoked as `<this key> 1', and the command before that, and the command
75 before that one is accessible as `<this key> 2'.
76 The notation for these keys is borrowed from XEmacs. Basically,
78 `(meta control f1)'."
83 \f
84 ;;; Code
86 ;; Ex map command
89 macro-name macro-body map-args ins)
105 ;; if defining macro for insert, switch there for authentic WYSIWYG
114 ))
117 ;; Ex unmap
120 temp macro-name ins)
134 ))
137 ;; read arguments for ex-map
141 temp key event message
142 macro-name macro-body args)
152 'error
155 ;; We expect macro-name to be a vector, a string, or a quoted string.
156 ;; In the second case, it will emerge as a symbol when read from
157 ;; the above read-from-string. So we need to convert it into a string
168 ;; the only keys available for editing are these-- no help while there
170 key
175 ":map%s %s"
181 ;;(setq event (viper-read-event))
186 message)
188 nil)
190 )
209 ;; read arguments for ex-unmap
213 viper-insert-kbd-macro-alist
214 viper-vi-kbd-macro-alist))
215 ;; these are disabled just in case, to avoid surprises when doing
216 ;; completing-read
217 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
218 viper-emacs-kbd-minor-mode
219 viper-vi-intercept-minor-mode viper-insert-intercept-minor-mode
220 viper-emacs-intercept-minor-mode
221 event message
222 key key-seq macro-name)
226 ()
232 ;; the only keys available for editing are these-- no help while there
234 key
241 ":unmap%s %s"
248 ))
251 ":unmap%s %s"
258 ;;(setq event (viper-read-event))
263 message)
265 nil)
267 )
273 ;; convert macro names into vector, if starts with a `['
277 ))
280 ;; Terminate a Vi kbd macro.
281 ;; optional argument IGNORE, if t, indicates that we are dealing with an
282 ;; existing macro that needs to be registered, but there is no need to
283 ;; terminate a kbd macro.
302 ;; always go back to Vi, since this is where we started
303 ;; defining macro
313 ))
317 \f
318 ;;; Recording, unrecording, executing
320 ;; Accepts as macro names: strings and vectors.
321 ;; strings must be strings of characters; vectors must be vectors of keys
322 ;; in canonic form. The canonic form is essentially the form used in XEmacs
323 ;; More general definitions are inherited by more specific scopes:
324 ;; global->major mode->buffer. More specific definitions override more general
326 "Record a Vi macro. Can be used in `.viper' file 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 may be recorded as strings. So, convert to
356 ;; 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.
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 by Viper
488 internally, but the user can also use it in ~/.viper to delete pre-defined
489 macros supplied with Viper. The best way to avoid mistakes in macro names to
490 be passed to this function is to use viper-describe-kbd-macros and copy the
491 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 may appear as strings. So, convert to vectors.
543 major-mode))))
549 "Global mapping for %S in %s is removed"
563 keymap
565 nil))
566 ))
567 ))
569 ;; Check if MACRO-ALIST has an entry for a macro name starting with
570 ;; CHAR. If not, this indicates that the binding for this char
571 ;; in viper-vi/insert-kbd-map can be released.
575 macro-name)
582 can-release))
586 "Dispatch kbd macro."
589 viper-vi-kbd-macro-alist)
592 viper-insert-kbd-macro-alist)
594 viper-emacs-kbd-macro-alist)))
596 ;; Macros and keys are executed with other macros turned off
597 ;; For macros, this is done to avoid macro recursion
598 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
599 viper-emacs-kbd-minor-mode
600 next-best-match keyseq event-seq
601 macro-first-char macro-alist-elt macro-body
602 command)
619 ;; when defining keyboard macro, don't use the macro mappings
621 ;; block cmd executed as part of a macro from entering command history
628 ;; If not a macro, or the macro is suppressed while defining another
629 ;; macro, put keyseq back on the event queue
631 ;; if the user typed arg, then use it if prefix arg is not set by
632 ;; some other command (setting prefix arg can happen if we do, say,
633 ;; 2dw and there is a macro starting with 2. Then control will go to
634 ;; this routine
640 ))
643 \f
644 ;;; Displaying and completing macros
647 "Show currently defined keyboard macros."
656 ))
682 ;; check if SEQ is a prefix of some car of an element in ALIST
690 ;; whether SEQ1 is a prefix of SEQ2
697 ;; find the longest common prefix
703 len)
710 rest)))
713 pref))
715 ;; get all sequences that match PREFIX from a given A-LIST
723 )
737 new-seq))
748 ;; alist is the alist of macros
749 ;; str is the fast key sequence entered
750 ;; returns: (matching-macro-def . unmatched-suffix-start-index)
755 match unmatched-start-idx found macro-def)
765 )
770 unmatched-start-idx def-len)
778 ;; returns a list of names of macros defined for the current buffer
787 macro-alist))
791 ;; if seq of Viper key symbols (representing a macro) can be converted to a
792 ;; string--do so. Otherwise, do nothing.
800 ;; convert sequence of events (that came presumably from emacs kbd macro) into
801 ;; Viper's macro, which is a vector of the form
802 ;; [ desc desc ... ]
803 ;; Each desc is either a symbol of (meta symb), (shift symb), etc.
804 ;; Here we purge events that happen to be lists. In most cases, these events
805 ;; got into a macro definition unintentionally; say, when the user moves mouse
806 ;; during a macro definition, then something like (switch-frame ...) might get
807 ;; in. Another reason for purging lists-events is that we can't store them in
808 ;; textual form (say, in .emacs) and then read them back.
811 nil
813 event-seq))))
815 ;; convert strings or arrays of characters to Viper macro form
818 macro)
824 ;; For macros bodies and names, goes over MACRO and checks if all members are
825 ;; names of keys (actually, it only checks if they are symbols or lists
826 ;; if a digit is found, it is converted into a symbol (e.g., 0 -> \0, etc).
827 ;; If MACRO is not a list or vector -- doesn't change MACRO.
831 elt break)
836 ;; fix number
840 idx
845 )))
854 macro)))
860 \f
861 ;;; Reading fast key sequences
863 ;; Assuming that CHAR was the first character in a fast succession of key
864 ;; strokes, read the rest. Return the vector of keys that was entered in
865 ;; this fast succession of key strokes.
866 ;; A fast keysequence is one that is terminated by a pause longer than
867 ;; viper-fast-keyseq-timeout.
870 next-event)
873 ;; Seems that viper-read-event is more robust here. We need to be able to
874 ;; place these events on unread-command-events list. If we use
875 ;; viper-read-key then events will be converted to keys, and sometimes
876 ;; (e.g., (control \[)) those keys differ from the corresponding events.
877 ;; So, do not use (setq next-event (viper-read-key))
881 lis))
883 \f
884 ;;; Keyboard macros in registers
886 ;; sets register to last-kbd-macro carefully.
890 ()
896 "Keyboard macros in registers - a modified \@ command."
908 nil
924 "Call last keyboad macro for each line in the region."
934 ;; arch-tag: ecd3cc5c-8cd0-4bbe-b2ec-7e75a4b7d0aa
935 ;;; viper-macs.el ends here