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 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, or (at your option)
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.
32 (defvar viper-ex-work-buf)
33 (defvar viper-custom-file-name)
34 (defvar viper-current-state)
35 (defvar viper-fast-keyseq-timeout)
37 ;; loading happens only in non-interactive compilation
38 ;; in order to spare non-viperized emacs from being viperized
41 (let ((load-path (cons (expand-file-name ".") load-path)))
42 (or (featurep 'viper-cmd)
43 (load "viper-cmd.el" nil t 'nosuffix))
53 ;; Register holding last macro.
54 (defvar viper-last-macro-reg nil)
56 ;; format of the elements of kbd alists:
57 ;; (name ((buf . macr)...(buf . macr)) ((maj-mode . macr)...) (t . macr))
58 ;; kbd macro alist for Vi state
59 (defvar viper-vi-kbd-macro-alist nil)
60 ;; same for insert/replace state
61 (defvar viper-insert-kbd-macro-alist nil)
62 ;; same for emacs state
63 (defvar viper-emacs-kbd-macro-alist nil)
65 ;; Internal var that passes info between start-kbd-macro and end-kbd-macro
67 (defvar viper-kbd-macro-parameters nil)
69 (defvar viper-this-kbd-macro nil
70 "Vector of keys representing the name of currently running Viper kbd macro.")
71 (defvar viper-last-kbd-macro nil
72 "Vector of keys representing the name of last Viper keyboard macro.")
74 (defcustom viper-repeat-from-history-key 'f12
75 "Prefix key for accessing previously typed Vi commands.
77 The previous command is accessible, as usual, via `.'. The command before this
78 can be invoked as `<this key> 1', and the command before that, and the command
79 before that one is accessible as `<this key> 2'.
80 The notation for these keys is borrowed from XEmacs. Basically,
81 a key is a symbol, e.g., `a', `\\1', `f2', etc., or a list, e.g.,
93 macro-name macro-body map-args ins)
94 (save-window-excursion
95 (set-buffer viper-ex-work-buf)
101 (setq map-args (ex-map-read-args mod-char)
102 macro-name (car map-args)
103 macro-body (cdr map-args))
104 (setq viper-kbd-macro-parameters (list ins mod-char macro-name macro-body))
106 (viper-end-mapping-kbd-macro 'ignore)
107 (ex-fixup-history (format "map%s %S" mod-char
108 (viper-display-macro macro-name)))
109 ;; if defining macro for insert, switch there for authentic WYSIWYG
110 (if ins (viper-change-state-to-insert))
111 (start-kbd-macro nil)
112 (define-key viper-vi-intercept-map "\C-x)" 'viper-end-mapping-kbd-macro)
113 (define-key viper-insert-intercept-map "\C-x)" 'viper-end-mapping-kbd-macro)
114 (define-key viper-emacs-intercept-map "\C-x)" 'viper-end-mapping-kbd-macro)
115 (message "Mapping %S in %s state. Type macro definition followed by `C-x )'"
116 (viper-display-macro macro-name)
117 (if ins "Insert" "Vi")))
125 (save-window-excursion
126 (set-buffer viper-ex-work-buf)
133 (setq macro-name (ex-unmap-read-args mod-char))
134 (setq temp (viper-fixup-macro (vconcat macro-name))) ;; copy and fixup
135 (ex-fixup-history (format "unmap%s %S" mod-char
136 (viper-display-macro temp)))
137 (viper-unrecord-kbd-macro macro-name (if ins 'insert-state 'vi-state))
141 ;; read arguments for ex-map
142 (defun ex-map-read-args (variant)
143 (let ((cursor-in-echo-area t)
145 temp key event message
146 macro-name macro-body args)
149 (setq args (concat (ex-get-inline-cmd-args ".*map[!]*[ \t]?" "\n\C-m")
151 temp (read-from-string args)
152 macro-name (car temp)
153 macro-body (car (read-from-string args (cdr temp))))
157 '("map: Macro name and body must be a quoted string or a vector"))))
159 ;; We expect macro-name to be a vector, a string, or a quoted string.
160 ;; In the second case, it will emerge as a symbol when read from
161 ;; the above read-from-string. So we need to convert it into a string
163 (cond ((vectorp macro-name) nil)
164 ((stringp macro-name)
165 (setq macro-name (vconcat macro-name)))
166 (t (setq macro-name (vconcat (prin1-to-string macro-name)))))
167 (message ":map%s <Macro Name>" variant)(sit-for 2)
170 '(?\C-m ?\n (control m) (control j) return linefeed)))
171 (setq key-seq (vconcat key-seq (if key (vector key) [])))
172 ;; the only keys available for editing are these-- no help while there
175 '(?\b ?\d '^? '^H (control h) (control \?) backspace delete))
176 (setq key-seq (viper-subseq key-seq 0 (- (length key-seq) 2))))
180 variant (if (> (length key-seq) 0)
181 (prin1-to-string (viper-display-macro key-seq))
183 (message "%s" message)
184 (setq event (viper-read-key))
185 ;;(setq event (viper-read-event))
187 (if (viper-mouse-event-p event)
189 (message "%s (No mouse---only keyboard keys, please)"
193 (viper-event-key event)))
195 (setq macro-name key-seq))
197 (if (= (length macro-name) 0)
198 (error "Can't map an empty macro name"))
199 (setq macro-name (viper-fixup-macro macro-name))
200 (if (viper-char-array-p macro-name)
201 (setq macro-name (viper-char-array-to-macro macro-name)))
204 (cond ((viper-char-array-p macro-body)
205 (setq macro-body (viper-char-array-to-macro macro-body)))
206 ((vectorp macro-body) nil)
207 (t (error "map: Invalid syntax in macro definition"))))
208 (setq cursor-in-echo-area nil)(sit-for 0) ; this overcomes xemacs tty bug
209 (cons macro-name macro-body)))
213 ;; read arguments for ex-unmap
214 (defun ex-unmap-read-args (variant)
215 (let ((cursor-in-echo-area t)
216 (macro-alist (if (string= variant "!")
217 viper-insert-kbd-macro-alist
218 viper-vi-kbd-macro-alist))
219 ;; these are disabled just in case, to avoid surprises when doing
221 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
222 viper-emacs-kbd-minor-mode
223 viper-vi-intercept-minor-mode viper-insert-intercept-minor-mode
224 viper-emacs-intercept-minor-mode
226 key key-seq macro-name)
227 (setq macro-name (ex-get-inline-cmd-args ".*unma?p?[!]*[ \t]*"))
229 (if (> (length macro-name) 0)
231 (message ":unmap%s <Name>" variant) (sit-for 2)
234 (member key '(?\C-m ?\n (control m) (control j) return linefeed)))
235 (setq key-seq (vconcat key-seq (if key (vector key) [])))
236 ;; the only keys available for editing are these-- no help while there
239 '(?\b ?\d '^? '^H (control h) (control \?) backspace delete))
240 (setq key-seq (viper-subseq key-seq 0 (- (length key-seq) 2))))
241 ((member key '(tab (control i) ?\t))
242 (setq key-seq (viper-subseq key-seq 0 (1- (length key-seq))))
246 variant (if (> (length key-seq) 0)
248 (viper-display-macro key-seq))
251 (viper-do-sequence-completion key-seq macro-alist message))
256 variant (if (> (length key-seq) 0)
258 (viper-display-macro key-seq))
260 (message "%s" message)
261 (setq event (viper-read-key))
262 ;;(setq event (viper-read-event))
264 (if (viper-mouse-event-p event)
266 (message "%s (No mouse---only keyboard keys, please)"
270 (viper-event-key event)))
272 (setq macro-name key-seq))
274 (if (= (length macro-name) 0)
275 (error "Can't unmap an empty macro name"))
277 ;; convert macro names into vector, if starts with a `['
278 (if (memq (elt macro-name 0) '(?\[ ?\"))
279 (car (read-from-string macro-name))
280 (vconcat macro-name))
284 ;; Terminate a Vi kbd macro.
285 ;; optional argument IGNORE, if t, indicates that we are dealing with an
286 ;; existing macro that needs to be registered, but there is no need to
287 ;; terminate a kbd macro.
288 (defun viper-end-mapping-kbd-macro (&optional ignore)
290 (define-key viper-vi-intercept-map "\C-x)" nil)
291 (define-key viper-insert-intercept-map "\C-x)" nil)
292 (define-key viper-emacs-intercept-map "\C-x)" nil)
293 (if (and (not ignore)
294 (or (not viper-kbd-macro-parameters)
295 (not defining-kbd-macro)))
296 (error "Not mapping a kbd-macro"))
297 (let ((mod-char (nth 1 viper-kbd-macro-parameters))
298 (ins (nth 0 viper-kbd-macro-parameters))
299 (macro-name (nth 2 viper-kbd-macro-parameters))
300 (macro-body (nth 3 viper-kbd-macro-parameters)))
301 (setq viper-kbd-macro-parameters nil)
305 (setq macro-body (viper-events-to-macro last-kbd-macro))
306 ;; always go back to Vi, since this is where we started
308 (viper-change-state-to-vi)))
310 (viper-record-kbd-macro macro-name
311 (if ins 'insert-state 'vi-state)
312 (viper-display-macro macro-body))
314 (ex-fixup-history (format "map%s %S %S" mod-char
315 (viper-display-macro macro-name)
316 (viper-display-macro macro-body)))
322 ;;; Recording, unrecording, executing
324 ;; Accepts as macro names: strings and vectors.
325 ;; strings must be strings of characters; vectors must be vectors of keys
326 ;; in canonic form. The canonic form is essentially the form used in XEmacs
327 ;; More general definitions are inherited by more specific scopes:
328 ;; global->major mode->buffer. More specific definitions override more general
329 (defun viper-record-kbd-macro (macro-name state macro-body &optional scope)
330 "Record a Vi macro. Can be used in `.viper' file to define permanent macros.
331 MACRO-NAME is a string of characters or a vector of keys. STATE is
332 either `vi-state' or `insert-state'. It specifies the Viper state in which to
333 define the macro. MACRO-BODY is a string that represents the keyboard macro.
334 Optional SCOPE says whether the macro should be global \(t\), mode-specific
335 \(a major-mode symbol\), or buffer-specific \(buffer name, a string\).
336 If SCOPE is nil, the user is asked to specify the scope."
337 (let* (state-name keymap
339 (cond ((eq state 'vi-state)
340 (setq state-name "Vi state"
341 keymap viper-vi-kbd-map)
342 'viper-vi-kbd-macro-alist)
343 ((memq state '(insert-state replace-state))
344 (setq state-name "Insert state"
345 keymap viper-insert-kbd-map)
346 'viper-insert-kbd-macro-alist)
348 (setq state-name "Emacs state"
349 keymap viper-emacs-kbd-map)
350 'viper-emacs-kbd-macro-alist)
352 new-elt old-elt old-sub-elt msg
355 (if (= (length macro-name) 0)
356 (error "Can't map an empty macro name"))
358 ;; Macro-name is usually a vector. However, command history or macros
359 ;; recorded in ~/.viper may be recorded as strings. So, convert to
361 (setq macro-name (viper-fixup-macro macro-name))
362 (if (viper-char-array-p macro-name)
363 (setq macro-name (viper-char-array-to-macro macro-name)))
364 (setq macro-body (viper-fixup-macro macro-body))
365 (if (viper-char-array-p macro-body)
366 (setq macro-body (viper-char-array-to-macro macro-body)))
368 ;; don't ask if scope is given and is of the right type
371 (and scope (symbolp scope))
377 "Map this macro for buffer `%s' only? "
381 "%S is mapped to %s for %s in `%s'"
382 (viper-display-macro macro-name)
383 (viper-abbreviate-string
386 (setq temp (viper-display-macro macro-body)))
388 (if (stringp temp) " ....\"" " ....]"))
389 state-name (buffer-name)))
393 "Map this macro for the major mode `%S' only? "
397 "%S is mapped to %s for %s in `%S'"
398 (viper-display-macro macro-name)
399 (viper-abbreviate-string
402 (setq temp (viper-display-macro macro-body)))
404 (if (stringp macro-body) " ....\"" " ....]"))
405 state-name major-mode))
410 "%S is globally mapped to %s in %s"
411 (viper-display-macro macro-name)
412 (viper-abbreviate-string
415 (setq temp (viper-display-macro macro-body)))
417 (if (stringp macro-body) " ....\"" " ....]"))
421 (format "Save this macro in %s? "
422 (viper-abbreviate-file-name viper-custom-file-name)))
423 (viper-save-string-in-file
424 (format "\n(viper-record-kbd-macro %S '%S %s '%S)"
425 (viper-display-macro macro-name)
427 ;; if we don't let vector macro-body through %S,
428 ;; the symbols `\.' `\[' etc will be converted into
429 ;; characters, causing invalid read error on recorded
431 ;; I am not sure is macro-body can still be a string at
432 ;; this point, but I am preserving this option anyway.
433 (if (vectorp macro-body)
434 (format "%S" macro-body)
437 viper-custom-file-name))
444 (cond ((eq scope t) (list nil nil (cons t nil)))
446 (list nil (list (cons scope nil)) (cons t nil)))
448 (list (list (cons scope nil)) nil (cons t nil))))))
449 (setq old-elt (assoc macro-name (eval macro-alist-var)))
453 ;; insert new-elt in macro-alist-var and keep the list sorted
456 (vector (viper-key-to-emacs-key (aref macro-name 0)))
457 'viper-exec-mapped-kbd-macro)
458 (setq lis (eval macro-alist-var))
459 (while (and lis (string< (viper-array-to-string (car (car lis)))
460 (viper-array-to-string macro-name)))
461 (setq lis2 (cons (car lis) lis2))
462 (setq lis (cdr lis)))
464 (setq lis2 (reverse lis2))
465 (set macro-alist-var (append lis2 (cons new-elt lis)))
466 (setq old-elt new-elt)))
468 (cond ((eq scope t) (viper-kbd-global-pair old-elt))
469 ((symbolp scope) (assoc scope (viper-kbd-mode-alist old-elt)))
470 ((stringp scope) (assoc scope (viper-kbd-buf-alist old-elt)))))
472 (setcdr old-sub-elt macro-body)
473 (cond ((symbolp scope) (setcar (cdr (cdr old-elt))
474 (cons (cons scope macro-body)
475 (viper-kbd-mode-alist old-elt))))
476 ((stringp scope) (setcar (cdr old-elt)
477 (cons (cons scope macro-body)
478 (viper-kbd-buf-alist old-elt))))))
483 ;; macro name must be a vector of viper-style keys
484 ;; viper-unrecord-kbd-macro doesn't have scope. Macro definitions are inherited
485 ;; from global -> major mode -> buffer
486 ;; More specific definition overrides more general
487 ;; Can't unrecord definition for more specific, if a more general definition is
489 (defun viper-unrecord-kbd-macro (macro-name state)
490 "Delete macro MACRO-NAME from Viper STATE.
491 MACRO-NAME must be a vector of viper-style keys. This command is used by Viper
492 internally, but the user can also use it in ~/.viper to delete pre-defined
493 macros supplied with Viper. The best way to avoid mistakes in macro names to
494 be passed to this function is to use viper-describe-kbd-macros and copy the
496 (let* (state-name keymap
498 (cond ((eq state 'vi-state)
499 (setq state-name "Vi state"
500 keymap viper-vi-kbd-map)
501 'viper-vi-kbd-macro-alist)
502 ((memq state '(insert-state replace-state))
503 (setq state-name "Insert state"
504 keymap viper-insert-kbd-map)
505 'viper-insert-kbd-macro-alist)
507 (setq state-name "Emacs state"
508 keymap viper-emacs-kbd-map)
509 'viper-emacs-kbd-macro-alist)
511 buf-mapping mode-mapping global-mapping
512 macro-pair macro-entry)
514 ;; Macro-name is usually a vector. However, command history or macros
515 ;; recorded in ~/.viper may appear as strings. So, convert to vectors.
516 (setq macro-name (viper-fixup-macro macro-name))
517 (if (viper-char-array-p macro-name)
518 (setq macro-name (viper-char-array-to-macro macro-name)))
520 (setq macro-entry (assoc macro-name (eval macro-alist-var)))
521 (if (= (length macro-name) 0)
522 (error "Can't unmap an empty macro name"))
523 (if (null macro-entry)
524 (error "%S is not mapped to a macro for %s in `%s'"
525 (viper-display-macro macro-name)
526 state-name (buffer-name)))
528 (setq buf-mapping (viper-kbd-buf-pair macro-entry)
529 mode-mapping (viper-kbd-mode-pair macro-entry)
530 global-mapping (viper-kbd-global-pair macro-entry))
532 (cond ((and (cdr buf-mapping)
533 (or (and (not (cdr mode-mapping)) (not (cdr global-mapping)))
535 (format "Unmap %S for `%s' only? "
536 (viper-display-macro macro-name)
538 (setq macro-pair buf-mapping)
539 (message "%S is unmapped for %s in `%s'"
540 (viper-display-macro macro-name)
541 state-name (buffer-name)))
542 ((and (cdr mode-mapping)
543 (or (not (cdr global-mapping))
545 (format "Unmap %S for the major mode `%S' only? "
546 (viper-display-macro macro-name)
548 (setq macro-pair mode-mapping)
549 (message "%S is unmapped for %s in %S"
550 (viper-display-macro macro-name) state-name major-mode))
551 ((cdr (setq macro-pair global-mapping))
553 "Global mapping for %S in %s is removed"
554 (viper-display-macro macro-name) state-name))
555 (t (error "%S is not mapped to a macro for %s in `%s'"
556 (viper-display-macro macro-name)
557 state-name (buffer-name))))
558 (setcdr macro-pair nil)
559 (or (cdr buf-mapping)
563 (set macro-alist-var (delq macro-entry (eval macro-alist-var)))
564 (if (viper-can-release-key (aref macro-name 0)
565 (eval macro-alist-var))
568 (vector (viper-key-to-emacs-key (aref macro-name 0)))
573 ;; Check if MACRO-ALIST has an entry for a macro name starting with
574 ;; CHAR. If not, this indicates that the binding for this char
575 ;; in viper-vi/insert-kbd-map can be released.
576 (defun viper-can-release-key (char macro-alist)
577 (let ((lis macro-alist)
581 (while (and lis can-release)
582 (setq macro-name (car (car lis)))
583 (if (eq char (aref macro-name 0))
584 (setq can-release nil))
585 (setq lis (cdr lis)))
589 (defun viper-exec-mapped-kbd-macro (count)
590 "Dispatch kbd macro."
592 (let* ((macro-alist (cond ((eq viper-current-state 'vi-state)
593 viper-vi-kbd-macro-alist)
594 ((memq viper-current-state
595 '(insert-state replace-state))
596 viper-insert-kbd-macro-alist)
598 viper-emacs-kbd-macro-alist)))
599 (unmatched-suffix "")
600 ;; Macros and keys are executed with other macros turned off
601 ;; For macros, this is done to avoid macro recursion
602 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
603 viper-emacs-kbd-minor-mode
604 next-best-match keyseq event-seq
605 macro-first-char macro-alist-elt macro-body
608 (setq macro-first-char last-command-event
609 event-seq (viper-read-fast-keysequence macro-first-char macro-alist)
610 keyseq (viper-events-to-macro event-seq)
611 macro-alist-elt (assoc keyseq macro-alist)
612 next-best-match (viper-find-best-matching-macro macro-alist keyseq))
614 (if (null macro-alist-elt)
615 (setq macro-alist-elt (car next-best-match)
616 unmatched-suffix (viper-subseq event-seq (cdr next-best-match))))
618 (cond ((null macro-alist-elt))
619 ((setq macro-body (viper-kbd-buf-definition macro-alist-elt)))
620 ((setq macro-body (viper-kbd-mode-definition macro-alist-elt)))
621 ((setq macro-body (viper-kbd-global-definition macro-alist-elt))))
623 ;; when defining keyboard macro, don't use the macro mappings
624 (if (and macro-body (not defining-kbd-macro))
625 ;; block cmd executed as part of a macro from entering command history
626 (let ((command-history command-history))
627 (setq viper-this-kbd-macro (car macro-alist-elt))
628 (execute-kbd-macro (viper-macro-to-events macro-body) count)
629 (setq viper-this-kbd-macro nil
630 viper-last-kbd-macro (car macro-alist-elt))
631 (viper-set-unread-command-events unmatched-suffix))
632 ;; If not a macro, or the macro is suppressed while defining another
633 ;; macro, put keyseq back on the event queue
634 (viper-set-unread-command-events event-seq)
635 ;; if the user typed arg, then use it if prefix arg is not set by
636 ;; some other command (setting prefix arg can happen if we do, say,
637 ;; 2dw and there is a macro starting with 2. Then control will go to
639 (or prefix-arg (setq prefix-arg count))
640 (setq command (key-binding (read-key-sequence nil)))
641 (if (commandp command)
642 (command-execute command)
648 ;;; Displaying and completing macros
650 (defun viper-describe-kbd-macros ()
651 "Show currently defined keyboard macros."
653 (with-output-to-temp-buffer " *viper-info*"
654 (princ "Macros in Vi state:\n===================\n")
655 (mapc 'viper-describe-one-macro viper-vi-kbd-macro-alist)
656 (princ "\n\nMacros in Insert and Replace states:\n====================================\n")
657 (mapc 'viper-describe-one-macro viper-insert-kbd-macro-alist)
658 (princ "\n\nMacros in Emacs state:\n======================\n")
659 (mapcar 'viper-describe-one-macro viper-emacs-kbd-macro-alist)
662 (defun viper-describe-one-macro (macro)
663 (princ (format "\n *** Mappings for %S:\n ------------\n"
664 (viper-display-macro (car macro))))
665 (princ " ** Buffer-specific:")
666 (if (viper-kbd-buf-alist macro)
667 (mapc 'viper-describe-one-macro-elt (viper-kbd-buf-alist macro))
669 (princ "\n ** Mode-specific:")
670 (if (viper-kbd-mode-alist macro)
671 (mapc 'viper-describe-one-macro-elt (viper-kbd-mode-alist macro))
673 (princ "\n ** Global:")
674 (if (viper-kbd-global-definition macro)
675 (princ (format "\n %S" (cdr (viper-kbd-global-pair macro))))
679 (defun viper-describe-one-macro-elt (elt)
680 (let ((name (car elt))
682 (princ (format "\n * %S:\n %S\n" name defn))))
686 ;; check if SEQ is a prefix of some car of an element in ALIST
687 (defun viper-keyseq-is-a-possible-macro (seq alist)
688 (let ((converted-seq (viper-events-to-macro seq)))
691 (lambda (elt) (viper-prefix-subseq-p converted-seq elt))
692 (viper-this-buffer-macros alist))))))
694 ;; whether SEQ1 is a prefix of SEQ2
695 (defun viper-prefix-subseq-p (seq1 seq2)
696 (let ((len1 (length seq1))
697 (len2 (length seq2)))
699 (equal seq1 (viper-subseq seq2 0 len1)))))
701 ;; find the longest common prefix
702 (defun viper-common-seq-prefix (&rest seqs)
703 (let* ((first (car seqs))
708 (if (= (length seqs) 0)
710 (setq len (apply 'min (mapcar 'length seqs))))
713 (mapcar (lambda (s) (equal (elt first idx) (elt s idx)))
715 (setq pref (vconcat pref (vector (elt first idx)))))
719 ;; get all sequences that match PREFIX from a given A-LIST
720 (defun viper-extract-matching-alist-members (pref alist)
721 (delq nil (mapcar (lambda (elt) (if (viper-prefix-subseq-p pref elt) elt))
722 (viper-this-buffer-macros alist))))
724 (defun viper-do-sequence-completion (seq alist compl-message)
725 (let* ((matches (viper-extract-matching-alist-members seq alist))
726 (new-seq (apply 'viper-common-seq-prefix matches))
728 (cond ((and (equal seq new-seq) (= (length matches) 1))
729 (message "%s (Sole completion)" compl-message)
732 (message "%s (No match)" compl-message)
735 ((member seq matches)
736 (message "%s (Complete, but not unique)" compl-message)
738 (viper-display-vector-completions matches))
740 (viper-display-vector-completions matches)))
744 (defun viper-display-vector-completions (list)
745 (with-output-to-temp-buffer "*Completions*"
746 (display-completion-list
747 (mapcar 'prin1-to-string
748 (mapcar 'viper-display-macro list)))))
752 ;; alist is the alist of macros
753 ;; str is the fast key sequence entered
754 ;; returns: (matching-macro-def . unmatched-suffix-start-index)
755 (defun viper-find-best-matching-macro (alist str)
758 (str-len (length str))
759 match unmatched-start-idx found macro-def)
760 (while (and (not found) lis)
761 (setq macro-def (car lis)
762 def-len (length (car macro-def)))
763 (if (and (>= str-len def-len)
764 (equal (car macro-def) (viper-subseq str 0 def-len)))
765 (if (or (viper-kbd-buf-definition macro-def)
766 (viper-kbd-mode-definition macro-def)
767 (viper-kbd-global-definition macro-def))
770 (setq lis (cdr lis)))
773 (setq match macro-def
774 unmatched-start-idx def-len)
776 unmatched-start-idx 0))
778 (cons match unmatched-start-idx)))
782 ;; returns a list of names of macros defined for the current buffer
783 (defun viper-this-buffer-macros (macro-alist)
786 (mapcar (lambda (elt)
787 (if (or (viper-kbd-buf-definition elt)
788 (viper-kbd-mode-definition elt)
789 (viper-kbd-global-definition elt))
792 (setq candidates (delq nil candidates))))
795 ;; if seq of Viper key symbols (representing a macro) can be converted to a
796 ;; string--do so. Otherwise, do nothing.
797 (defun viper-display-macro (macro-name-or-body)
798 (cond ((viper-char-symbol-sequence-p macro-name-or-body)
799 (mapconcat 'symbol-name macro-name-or-body ""))
800 ((viper-char-array-p macro-name-or-body)
801 (mapconcat 'char-to-string macro-name-or-body ""))
802 (t macro-name-or-body)))
804 ;; convert sequence of events (that came presumably from emacs kbd macro) into
805 ;; Viper's macro, which is a vector of the form
807 ;; Each desc is either a symbol of (meta symb), (shift symb), etc.
808 ;; Here we purge events that happen to be lists. In most cases, these events
809 ;; got into a macro definition unintentionally; say, when the user moves mouse
810 ;; during a macro definition, then something like (switch-frame ...) might get
811 ;; in. Another reason for purging lists-events is that we can't store them in
812 ;; textual form (say, in .emacs) and then read them back.
813 (defun viper-events-to-macro (event-seq)
814 (vconcat (delq nil (mapcar (lambda (elt) (if (consp elt)
816 (viper-event-key elt)))
819 ;; convert strings or arrays of characters to Viper macro form
820 (defun viper-char-array-to-macro (array)
821 (let ((vec (vconcat array))
823 (if (featurep 'xemacs)
824 (setq macro (mapcar 'character-to-event vec))
826 (vconcat (mapcar 'viper-event-key macro))))
828 ;; For macros bodies and names, goes over MACRO and checks if all members are
829 ;; names of keys (actually, it only checks if they are symbols or lists
830 ;; if a digit is found, it is converted into a symbol (e.g., 0 -> \0, etc).
831 ;; If MACRO is not a list or vector -- doesn't change MACRO.
832 (defun viper-fixup-macro (macro)
833 (let ((len (length macro))
836 (if (or (vectorp macro) (listp macro))
837 (while (and (< idx len) (not break))
838 (setq elt (elt macro idx))
841 (if (and (<= 0 elt) (<= elt 9))
842 (cond ((arrayp macro)
845 (intern (char-to-string (+ ?0 elt)))))
847 (setcar (nthcdr idx macro)
848 (intern (char-to-string (+ ?0 elt)))))
851 (viper-fixup-macro elt))
854 (setq idx (1+ idx))))
857 (error "Wrong type macro component, symbol-or-listp, %S" elt)
860 (defun viper-macro-to-events (macro-body)
861 (vconcat (mapcar 'viper-key-to-emacs-key macro-body)))
865 ;;; Reading fast key sequences
867 ;; Assuming that CHAR was the first character in a fast succession of key
868 ;; strokes, read the rest. Return the vector of keys that was entered in
869 ;; this fast succession of key strokes.
870 ;; A fast keysequence is one that is terminated by a pause longer than
871 ;; viper-fast-keyseq-timeout.
872 (defun viper-read-fast-keysequence (event macro-alist)
873 (let ((lis (vector event))
875 (while (and (viper-fast-keysequence-p)
876 (viper-keyseq-is-a-possible-macro lis macro-alist))
877 (setq next-event (viper-read-key))
878 ;;(setq next-event (viper-read-event))
879 (or (viper-mouse-event-p next-event)
880 (setq lis (vconcat lis (vector next-event)))))
884 ;;; Keyboard macros in registers
886 ;; sets register to last-kbd-macro carefully.
887 (defun viper-set-register-macro (reg)
888 (if (get-register reg)
889 (if (y-or-n-p "Register contains data. Overwrite? ")
892 "Macro not saved in register. Can still be invoked via `C-x e'")))
893 (set-register reg last-kbd-macro))
895 (defun viper-register-macro (count)
896 "Keyboard macros in registers - a modified \@ command."
898 (let ((reg (downcase (read-char))))
899 (cond ((or (and (<= ?a reg) (<= reg ?z)))
900 (setq viper-last-macro-reg reg)
901 (if defining-kbd-macro
904 (viper-set-register-macro reg))
905 (execute-kbd-macro (get-register reg) count)))
906 ((or (= ?@ reg) (= ?\^j reg) (= ?\^m reg))
907 (if viper-last-macro-reg
909 (error "No previous kbd macro"))
910 (execute-kbd-macro (get-register viper-last-macro-reg) count))
912 (start-kbd-macro count))
914 (setq reg (downcase (read-char)))
915 (if (or (and (<= ?a reg) (<= reg ?z)))
917 (setq viper-last-macro-reg reg)
918 (viper-set-register-macro reg))))
920 (error "`%c': Unknown register" reg)))))
923 (defun viper-global-execute ()
924 "Call last keyboad macro for each line in the region."
925 (if (> (point) (mark t)) (exchange-point-and-mark))
927 (call-last-kbd-macro)
928 (while (< (point) (mark t))
931 (call-last-kbd-macro)))
934 ;;; arch-tag: ecd3cc5c-8cd0-4bbe-b2ec-7e75a4b7d0aa
935 ;;; viper-macs.el ends here