(shell-mode): Use define-derived-mode.
[emacs.git] / lisp / emulation / viper-macs.el
blob92f5f013093e3ead18a69fa8c2e0a4e8e034cee5
1 ;;; viper-macs.el --- functions implementing keyboard macros for Viper
3 ;; Copyright (C) 1994, 1995, 1996, 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
24 (provide 'viper-macs)
26 ;; compiler pacifier
27 (defvar viper-ex-work-buf)
28 (defvar viper-custom-file-name)
29 (defvar viper-current-state)
30 (defvar viper-fast-keyseq-timeout)
32 ;; loading happens only in non-interactive compilation
33 ;; in order to spare non-viperized emacs from being viperized
34 (if noninteractive
35 (eval-when-compile
36 (let ((load-path (cons (expand-file-name ".") load-path)))
37 (or (featurep 'viper-util)
38 (load "viper-util.el" nil nil 'nosuffix))
39 (or (featurep 'viper-keym)
40 (load "viper-keym.el" nil nil 'nosuffix))
41 (or (featurep 'viper-mous)
42 (load "viper-mous.el" nil nil 'nosuffix))
43 (or (featurep 'viper-cmd)
44 (load "viper-cmd.el" nil nil 'nosuffix))
45 )))
46 ;; end pacifier
48 (require 'viper-util)
49 (require 'viper-keym)
52 ;;; Variables
54 ;; Register holding last macro.
55 (defvar viper-last-macro-reg nil)
57 ;; format of the elements of kbd alists:
58 ;; (name ((buf . macr)...(buf . macr)) ((maj-mode . macr)...) (t . macr))
59 ;; kbd macro alist for Vi state
60 (defvar viper-vi-kbd-macro-alist nil)
61 ;; same for insert/replace state
62 (defvar viper-insert-kbd-macro-alist nil)
63 ;; same for emacs state
64 (defvar viper-emacs-kbd-macro-alist nil)
66 ;; Internal var that passes info between start-kbd-macro and end-kbd-macro
67 ;; in :map and :map!
68 (defvar viper-kbd-macro-parameters nil)
70 (defvar viper-this-kbd-macro nil
71 "Vector of keys representing the name of currently running Viper kbd macro.")
72 (defvar viper-last-kbd-macro nil
73 "Vector of keys representing the name of last Viper keyboard macro.")
75 (defcustom viper-repeat-from-history-key 'f12
76 "Prefix key for accessing previously typed Vi commands.
78 The previous command is accessible, as usual, via `.'. The command before this
79 can be invoked as `<this key> 1', and the command before that, and the command
80 before that one is accessible as `<this key> 2'.
81 The notation for these keys is borrowed from XEmacs. Basically,
82 a key is a symbol, e.g., `a', `\\1', `f2', etc., or a list, e.g.,
83 `(meta control f1)'."
84 :type 'sexp
85 :group 'viper)
89 ;;; Code
91 ;; Ex map command
92 (defun ex-map ()
93 (let ((mod-char "")
94 macro-name macro-body map-args ins)
95 (save-window-excursion
96 (set-buffer viper-ex-work-buf)
97 (if (looking-at "!")
98 (progn
99 (setq ins t
100 mod-char "!")
101 (forward-char 1))))
102 (setq map-args (ex-map-read-args mod-char)
103 macro-name (car map-args)
104 macro-body (cdr map-args))
105 (setq viper-kbd-macro-parameters (list ins mod-char macro-name macro-body))
106 (if macro-body
107 (viper-end-mapping-kbd-macro 'ignore)
108 (ex-fixup-history (format "map%s %S" mod-char
109 (viper-display-macro macro-name)))
110 ;; if defining macro for insert, switch there for authentic WYSIWYG
111 (if ins (viper-change-state-to-insert))
112 (start-kbd-macro nil)
113 (define-key viper-vi-intercept-map "\C-x)" 'viper-end-mapping-kbd-macro)
114 (define-key viper-insert-intercept-map "\C-x)" 'viper-end-mapping-kbd-macro)
115 (define-key viper-emacs-intercept-map "\C-x)" 'viper-end-mapping-kbd-macro)
116 (message "Mapping %S in %s state. Hit `C-x )' to complete the mapping"
117 (viper-display-macro macro-name)
118 (if ins "Insert" "Vi")))
122 ;; Ex unmap
123 (defun ex-unmap ()
124 (let ((mod-char "")
125 temp macro-name ins)
126 (save-window-excursion
127 (set-buffer viper-ex-work-buf)
128 (if (looking-at "!")
129 (progn
130 (setq ins t
131 mod-char "!")
132 (forward-char 1))))
134 (setq macro-name (ex-unmap-read-args mod-char))
135 (setq temp (viper-fixup-macro (vconcat macro-name))) ;; copy and fixup
136 (ex-fixup-history (format "unmap%s %S" mod-char
137 (viper-display-macro temp)))
138 (viper-unrecord-kbd-macro macro-name (if ins 'insert-state 'vi-state))
142 ;; read arguments for ex-map
143 (defun ex-map-read-args (variant)
144 (let ((cursor-in-echo-area t)
145 (key-seq [])
146 temp key event message
147 macro-name macro-body args)
149 (condition-case nil
150 (setq args (concat (ex-get-inline-cmd-args ".*map[!]*[ \t]?" "\n\C-m")
151 " nil nil ")
152 temp (read-from-string args)
153 macro-name (car temp)
154 macro-body (car (read-from-string args (cdr temp))))
155 (error
156 (signal
157 'error
158 '("map: Macro name and body must be a quoted string or a vector"))))
160 ;; We expect macro-name to be a vector, a string, or a quoted string.
161 ;; In the second case, it will emerge as a symbol when read from
162 ;; the above read-from-string. So we need to convert it into a string
163 (if macro-name
164 (cond ((vectorp macro-name) nil)
165 ((stringp macro-name)
166 (setq macro-name (vconcat macro-name)))
167 (t (setq macro-name (vconcat (prin1-to-string macro-name)))))
168 (message ":map%s <Name>" variant)(sit-for 2)
169 (while
170 (not (member key
171 '(?\C-m ?\n (control m) (control j) return linefeed)))
172 (setq key-seq (vconcat key-seq (if key (vector key) [])))
173 ;; the only keys available for editing are these-- no help while there
174 (if (member
176 '(?\b ?\d '^? '^H (control h) (control \?) backspace delete))
177 (setq key-seq (subseq key-seq 0 (- (length key-seq) 2))))
178 (setq message
179 (format
180 ":map%s %s"
181 variant (if (> (length key-seq) 0)
182 (prin1-to-string (viper-display-macro key-seq))
183 "")))
184 (message message)
185 (setq event (viper-read-key))
186 ;;(setq event (viper-read-event))
187 (setq key
188 (if (viper-mouse-event-p event)
189 (progn
190 (message "%s (No mouse---only keyboard keys, please)"
191 message)
192 (sit-for 2)
193 nil)
194 (viper-event-key event)))
196 (setq macro-name key-seq))
198 (if (= (length macro-name) 0)
199 (error "Can't map an empty macro name"))
200 (setq macro-name (viper-fixup-macro macro-name))
201 (if (viper-char-array-p macro-name)
202 (setq macro-name (viper-char-array-to-macro macro-name)))
204 (if macro-body
205 (cond ((viper-char-array-p macro-body)
206 (setq macro-body (viper-char-array-to-macro macro-body)))
207 ((vectorp macro-body) nil)
208 (t (error "map: Invalid syntax in macro definition"))))
209 (setq cursor-in-echo-area nil)(sit-for 0) ; this overcomes xemacs tty bug
210 (cons macro-name macro-body)))
214 ;; read arguments for ex-unmap
215 (defun ex-unmap-read-args (variant)
216 (let ((cursor-in-echo-area t)
217 (macro-alist (if (string= variant "!")
218 viper-insert-kbd-macro-alist
219 viper-vi-kbd-macro-alist))
220 ;; these are disabled just in case, to avoid surprises when doing
221 ;; completing-read
222 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
223 viper-emacs-kbd-minor-mode
224 viper-vi-intercept-minor-mode viper-insert-intercept-minor-mode
225 viper-emacs-intercept-minor-mode
226 event message
227 key key-seq macro-name)
228 (setq macro-name (ex-get-inline-cmd-args ".*unma?p?[!]*[ \t]*"))
230 (if (> (length macro-name) 0)
232 (message ":unmap%s <Name>" variant) (sit-for 2)
233 (while
234 (not
235 (member key '(?\C-m ?\n (control m) (control j) return linefeed)))
236 (setq key-seq (vconcat key-seq (if key (vector key) [])))
237 ;; the only keys available for editing are these-- no help while there
238 (cond ((member
240 '(?\b ?\d '^? '^H (control h) (control \?) backspace delete))
241 (setq key-seq (subseq key-seq 0 (- (length key-seq) 2))))
242 ((member key '(tab (control i) ?\t))
243 (setq key-seq (subseq key-seq 0 (1- (length key-seq))))
244 (setq message
245 (format
246 ":unmap%s %s"
247 variant (if (> (length key-seq) 0)
248 (prin1-to-string
249 (viper-display-macro key-seq))
250 "")))
251 (setq key-seq
252 (viper-do-sequence-completion key-seq macro-alist message))
254 (setq message
255 (format
256 ":unmap%s %s"
257 variant (if (> (length key-seq) 0)
258 (prin1-to-string
259 (viper-display-macro key-seq))
260 "")))
261 (message message)
262 (setq event (viper-read-key))
263 ;;(setq event (viper-read-event))
264 (setq key
265 (if (viper-mouse-event-p event)
266 (progn
267 (message "%s (No mouse---only keyboard keys, please)"
268 message)
269 (sit-for 2)
270 nil)
271 (viper-event-key event)))
273 (setq macro-name key-seq))
275 (if (= (length macro-name) 0)
276 (error "Can't unmap an empty macro name"))
278 ;; convert macro names into vector, if starts with a `['
279 (if (memq (elt macro-name 0) '(?\[ ?\"))
280 (car (read-from-string macro-name))
281 (vconcat macro-name))
285 ;; Terminate a Vi kbd macro.
286 ;; optional argument IGNORE, if t, indicates that we are dealing with an
287 ;; existing macro that needs to be registered, but there is no need to
288 ;; terminate a kbd macro.
289 (defun viper-end-mapping-kbd-macro (&optional ignore)
290 (interactive)
291 (define-key viper-vi-intercept-map "\C-x)" nil)
292 (define-key viper-insert-intercept-map "\C-x)" nil)
293 (define-key viper-emacs-intercept-map "\C-x)" nil)
294 (if (and (not ignore)
295 (or (not viper-kbd-macro-parameters)
296 (not defining-kbd-macro)))
297 (error "Not mapping a kbd-macro"))
298 (let ((mod-char (nth 1 viper-kbd-macro-parameters))
299 (ins (nth 0 viper-kbd-macro-parameters))
300 (macro-name (nth 2 viper-kbd-macro-parameters))
301 (macro-body (nth 3 viper-kbd-macro-parameters)))
302 (setq viper-kbd-macro-parameters nil)
303 (or ignore
304 (progn
305 (end-kbd-macro nil)
306 (setq macro-body (viper-events-to-macro last-kbd-macro))
307 ;; always go back to Vi, since this is where we started
308 ;; defining macro
309 (viper-change-state-to-vi)))
311 (viper-record-kbd-macro macro-name
312 (if ins 'insert-state 'vi-state)
313 (viper-display-macro macro-body))
315 (ex-fixup-history (format "map%s %S %S" mod-char
316 (viper-display-macro macro-name)
317 (viper-display-macro macro-body)))
323 ;;; Recording, unrecording, executing
325 ;; Accepts as macro names: strings and vectors.
326 ;; strings must be strings of characters; vectors must be vectors of keys
327 ;; in canonic form. The canonic form is essentially the form used in XEmacs
328 (defun viper-record-kbd-macro (macro-name state macro-body &optional scope)
329 "Record a Vi macro. Can be used in `.viper' file to define permanent macros.
330 MACRO-NAME is a string of characters or a vector of keys. STATE is
331 either `vi-state' or `insert-state'. It specifies the Viper state in which to
332 define the macro. MACRO-BODY is a string that represents the keyboard macro.
333 Optional SCOPE says whether the macro should be global \(t\), mode-specific
334 \(a major-mode symbol\), or buffer-specific \(buffer name, a string\).
335 If SCOPE is nil, the user is asked to specify the scope."
336 (let* (state-name keymap
337 (macro-alist-var
338 (cond ((eq state 'vi-state)
339 (setq state-name "Vi state"
340 keymap viper-vi-kbd-map)
341 'viper-vi-kbd-macro-alist)
342 ((memq state '(insert-state replace-state))
343 (setq state-name "Insert state"
344 keymap viper-insert-kbd-map)
345 'viper-insert-kbd-macro-alist)
347 (setq state-name "Emacs state"
348 keymap viper-emacs-kbd-map)
349 'viper-emacs-kbd-macro-alist)
351 new-elt old-elt old-sub-elt msg
352 temp lis lis2)
354 (if (= (length macro-name) 0)
355 (error "Can't map an empty macro name"))
357 ;; Macro-name is usually a vector. However, command history or macros
358 ;; recorded in ~/.viper may be recorded as strings. So, convert to
359 ;; vectors.
360 (setq macro-name (viper-fixup-macro macro-name))
361 (if (viper-char-array-p macro-name)
362 (setq macro-name (viper-char-array-to-macro macro-name)))
363 (setq macro-body (viper-fixup-macro macro-body))
364 (if (viper-char-array-p macro-body)
365 (setq macro-body (viper-char-array-to-macro macro-body)))
367 ;; don't ask if scope is given and is of the right type
368 (or (eq scope t)
369 (stringp scope)
370 (and scope (symbolp scope))
371 (progn
372 (setq scope
373 (cond
374 ((y-or-n-p
375 (format
376 "Map this macro for buffer `%s' only? "
377 (buffer-name)))
378 (setq msg
379 (format
380 "%S is mapped to %s for %s in `%s'"
381 (viper-display-macro macro-name)
382 (viper-abbreviate-string
383 (format
384 "%S"
385 (setq temp (viper-display-macro macro-body)))
386 14 "" ""
387 (if (stringp temp) " ....\"" " ....]"))
388 state-name (buffer-name)))
389 (buffer-name))
390 ((y-or-n-p
391 (format
392 "Map this macro for the major mode `%S' only? "
393 major-mode))
394 (setq msg
395 (format
396 "%S is mapped to %s for %s in `%S'"
397 (viper-display-macro macro-name)
398 (viper-abbreviate-string
399 (format
400 "%S"
401 (setq temp (viper-display-macro macro-body)))
402 14 "" ""
403 (if (stringp macro-body) " ....\"" " ....]"))
404 state-name major-mode))
405 major-mode)
407 (setq msg
408 (format
409 "%S is globally mapped to %s in %s"
410 (viper-display-macro macro-name)
411 (viper-abbreviate-string
412 (format
413 "%S"
414 (setq temp (viper-display-macro macro-body)))
415 14 "" ""
416 (if (stringp macro-body) " ....\"" " ....]"))
417 state-name))
418 t)))
419 (if (y-or-n-p
420 (format "Save this macro in %s? "
421 (viper-abbreviate-file-name viper-custom-file-name)))
422 (viper-save-string-in-file
423 (format "\n(viper-record-kbd-macro %S '%S %s '%S)"
424 (viper-display-macro macro-name)
425 state
426 ;; if we don't let vector macro-body through %S,
427 ;; the symbols `\.' `\[' etc will be converted into
428 ;; characters, causing invalid read error on recorded
429 ;; macros in .viper.
430 ;; I am not sure is macro-body can still be a string at
431 ;; this point, but I am preserving this option anyway.
432 (if (vectorp macro-body)
433 (format "%S" macro-body)
434 macro-body)
435 scope)
436 viper-custom-file-name))
438 (message msg)
441 (setq new-elt
442 (cons macro-name
443 (cond ((eq scope t) (list nil nil (cons t nil)))
444 ((symbolp scope)
445 (list nil (list (cons scope nil)) (cons t nil)))
446 ((stringp scope)
447 (list (list (cons scope nil)) nil (cons t nil))))))
448 (setq old-elt (assoc macro-name (eval macro-alist-var)))
450 (if (null old-elt)
451 (progn
452 ;; insert new-elt in macro-alist-var and keep the list sorted
453 (define-key
454 keymap
455 (vector (viper-key-to-emacs-key (aref macro-name 0)))
456 'viper-exec-mapped-kbd-macro)
457 (setq lis (eval macro-alist-var))
458 (while (and lis (string< (viper-array-to-string (car (car lis)))
459 (viper-array-to-string macro-name)))
460 (setq lis2 (cons (car lis) lis2))
461 (setq lis (cdr lis)))
463 (setq lis2 (reverse lis2))
464 (set macro-alist-var (append lis2 (cons new-elt lis)))
465 (setq old-elt new-elt)))
466 (setq old-sub-elt
467 (cond ((eq scope t) (viper-kbd-global-pair old-elt))
468 ((symbolp scope) (assoc scope (viper-kbd-mode-alist old-elt)))
469 ((stringp scope) (assoc scope (viper-kbd-buf-alist old-elt)))))
470 (if old-sub-elt
471 (setcdr old-sub-elt macro-body)
472 (cond ((symbolp scope) (setcar (cdr (cdr old-elt))
473 (cons (cons scope macro-body)
474 (viper-kbd-mode-alist old-elt))))
475 ((stringp scope) (setcar (cdr old-elt)
476 (cons (cons scope macro-body)
477 (viper-kbd-buf-alist old-elt))))))
482 ;; macro name must be a vector of viper-style keys
483 (defun viper-unrecord-kbd-macro (macro-name state)
484 "Delete macro MACRO-NAME from Viper STATE.
485 MACRO-NAME must be a vector of viper-style keys. This command is used by Viper
486 internally, but the user can also use it in ~/.viper to delete pre-defined
487 macros supplied with Viper. The best way to avoid mistakes in macro names to
488 be passed to this function is to use viper-describe-kbd-macros and copy the
489 name from there."
490 (let* (state-name keymap
491 (macro-alist-var
492 (cond ((eq state 'vi-state)
493 (setq state-name "Vi state"
494 keymap viper-vi-kbd-map)
495 'viper-vi-kbd-macro-alist)
496 ((memq state '(insert-state replace-state))
497 (setq state-name "Insert state"
498 keymap viper-insert-kbd-map)
499 'viper-insert-kbd-macro-alist)
501 (setq state-name "Emacs state"
502 keymap viper-emacs-kbd-map)
503 'viper-emacs-kbd-macro-alist)
505 buf-mapping mode-mapping global-mapping
506 macro-pair macro-entry)
508 ;; Macro-name is usually a vector. However, command history or macros
509 ;; recorded in ~/.viper may appear as strings. So, convert to vectors.
510 (setq macro-name (viper-fixup-macro macro-name))
511 (if (viper-char-array-p macro-name)
512 (setq macro-name (viper-char-array-to-macro macro-name)))
514 (setq macro-entry (assoc macro-name (eval macro-alist-var)))
515 (if (= (length macro-name) 0)
516 (error "Can't unmap an empty macro name"))
517 (if (null macro-entry)
518 (error "%S is not mapped to a macro for %s in `%s'"
519 (viper-display-macro macro-name)
520 state-name (buffer-name)))
522 (setq buf-mapping (viper-kbd-buf-pair macro-entry)
523 mode-mapping (viper-kbd-mode-pair macro-entry)
524 global-mapping (viper-kbd-global-pair macro-entry))
526 (cond ((and (cdr buf-mapping)
527 (or (and (not (cdr mode-mapping)) (not (cdr global-mapping)))
528 (y-or-n-p
529 (format "Unmap %S for `%s' only? "
530 (viper-display-macro macro-name)
531 (buffer-name)))))
532 (setq macro-pair buf-mapping)
533 (message "%S is unmapped for %s in `%s'"
534 (viper-display-macro macro-name)
535 state-name (buffer-name)))
536 ((and (cdr mode-mapping)
537 (or (not (cdr global-mapping))
538 (y-or-n-p
539 (format "Unmap %S for the major mode `%S' only? "
540 (viper-display-macro macro-name)
541 major-mode))))
542 (setq macro-pair mode-mapping)
543 (message "%S is unmapped for %s in %S"
544 (viper-display-macro macro-name) state-name major-mode))
545 ((cdr (setq macro-pair (viper-kbd-global-pair macro-entry)))
546 (message
547 "Global mapping for %S in %s is removed"
548 (viper-display-macro macro-name) state-name))
549 (t (error "%S is not mapped to a macro for %s in `%s'"
550 (viper-display-macro macro-name)
551 state-name (buffer-name))))
552 (setcdr macro-pair nil)
553 (or (cdr buf-mapping)
554 (cdr mode-mapping)
555 (cdr global-mapping)
556 (progn
557 (set macro-alist-var (delq macro-entry (eval macro-alist-var)))
558 (if (viper-can-release-key (aref macro-name 0)
559 (eval macro-alist-var))
560 (define-key
561 keymap
562 (vector (viper-key-to-emacs-key (aref macro-name 0)))
563 nil))
567 ;; Check if MACRO-ALIST has an entry for a macro name starting with
568 ;; CHAR. If not, this indicates that the binding for this char
569 ;; in viper-vi/insert-kbd-map can be released.
570 (defun viper-can-release-key (char macro-alist)
571 (let ((lis macro-alist)
572 (can-release t)
573 macro-name)
575 (while (and lis can-release)
576 (setq macro-name (car (car lis)))
577 (if (eq char (aref macro-name 0))
578 (setq can-release nil))
579 (setq lis (cdr lis)))
580 can-release))
583 (defun viper-exec-mapped-kbd-macro (count)
584 "Dispatch kbd macro."
585 (interactive "P")
586 (let* ((macro-alist (cond ((eq viper-current-state 'vi-state)
587 viper-vi-kbd-macro-alist)
588 ((memq viper-current-state
589 '(insert-state replace-state))
590 viper-insert-kbd-macro-alist)
592 viper-emacs-kbd-macro-alist)))
593 (unmatched-suffix "")
594 ;; Macros and keys are executed with other macros turned off
595 ;; For macros, this is done to avoid macro recursion
596 viper-vi-kbd-minor-mode viper-insert-kbd-minor-mode
597 viper-emacs-kbd-minor-mode
598 next-best-match keyseq event-seq
599 macro-first-char macro-alist-elt macro-body
600 command)
602 (setq macro-first-char last-command-event
603 event-seq (viper-read-fast-keysequence macro-first-char macro-alist)
604 keyseq (viper-events-to-macro event-seq)
605 macro-alist-elt (assoc keyseq macro-alist)
606 next-best-match (viper-find-best-matching-macro macro-alist keyseq))
608 (if (null macro-alist-elt)
609 (setq macro-alist-elt (car next-best-match)
610 unmatched-suffix (subseq event-seq (cdr next-best-match))))
612 (cond ((null macro-alist-elt))
613 ((setq macro-body (viper-kbd-buf-definition macro-alist-elt)))
614 ((setq macro-body (viper-kbd-mode-definition macro-alist-elt)))
615 ((setq macro-body (viper-kbd-global-definition macro-alist-elt))))
617 ;; when defining keyboard macro, don't use the macro mappings
618 (if (and macro-body (not defining-kbd-macro))
619 ;; block cmd executed as part of a macro from entering command history
620 (let ((command-history command-history))
621 (setq viper-this-kbd-macro (car macro-alist-elt))
622 (execute-kbd-macro (viper-macro-to-events macro-body) count)
623 (setq viper-this-kbd-macro nil
624 viper-last-kbd-macro (car macro-alist-elt))
625 (viper-set-unread-command-events unmatched-suffix))
626 ;; If not a macro, or the macro is suppressed while defining another
627 ;; macro, put keyseq back on the event queue
628 (viper-set-unread-command-events event-seq)
629 ;; if the user typed arg, then use it if prefix arg is not set by
630 ;; some other command (setting prefix arg can happen if we do, say,
631 ;; 2dw and there is a macro starting with 2. Then control will go to
632 ;; this routine
633 (or prefix-arg (setq prefix-arg count))
634 (setq command (key-binding (read-key-sequence nil)))
635 (if (commandp command)
636 (command-execute command)
637 (beep 1)))
642 ;;; Displaying and completing macros
644 (defun viper-describe-kbd-macros ()
645 "Show currently defined keyboard macros."
646 (interactive)
647 (with-output-to-temp-buffer " *viper-info*"
648 (princ "Macros in Vi state:\n===================\n")
649 (mapcar 'viper-describe-one-macro viper-vi-kbd-macro-alist)
650 (princ "\n\nMacros in Insert and Replace states:\n====================================\n")
651 (mapcar 'viper-describe-one-macro viper-insert-kbd-macro-alist)
652 (princ "\n\nMacros in Emacs state:\n======================\n")
653 (mapcar 'viper-describe-one-macro viper-emacs-kbd-macro-alist)
656 (defun viper-describe-one-macro (macro)
657 (princ (format "\n *** Mappings for %S:\n ------------\n"
658 (viper-display-macro (car macro))))
659 (princ " ** Buffer-specific:")
660 (if (viper-kbd-buf-alist macro)
661 (mapcar 'viper-describe-one-macro-elt (viper-kbd-buf-alist macro))
662 (princ " none\n"))
663 (princ "\n ** Mode-specific:")
664 (if (viper-kbd-mode-alist macro)
665 (mapcar 'viper-describe-one-macro-elt (viper-kbd-mode-alist macro))
666 (princ " none\n"))
667 (princ "\n ** Global:")
668 (if (viper-kbd-global-definition macro)
669 (princ (format "\n %S" (cdr (viper-kbd-global-pair macro))))
670 (princ " none"))
671 (princ "\n"))
673 (defun viper-describe-one-macro-elt (elt)
674 (let ((name (car elt))
675 (defn (cdr elt)))
676 (princ (format "\n * %S:\n %S\n" name defn))))
680 ;; check if SEQ is a prefix of some car of an element in ALIST
681 (defun viper-keyseq-is-a-possible-macro (seq alist)
682 (let ((converted-seq (viper-events-to-macro seq)))
683 (eval (cons 'or
684 (mapcar
685 (lambda (elt) (viper-prefix-subseq-p converted-seq elt))
686 (viper-this-buffer-macros alist))))))
688 ;; whether SEQ1 is a prefix of SEQ2
689 (defun viper-prefix-subseq-p (seq1 seq2)
690 (let ((len1 (length seq1))
691 (len2 (length seq2)))
692 (if (<= len1 len2)
693 (equal seq1 (subseq seq2 0 len1)))))
695 ;; find the longest common prefix
696 (defun viper-common-seq-prefix (&rest seqs)
697 (let* ((first (car seqs))
698 (rest (cdr seqs))
699 (pref [])
700 (idx 0)
701 len)
702 (if (= (length seqs) 0)
703 (setq len 0)
704 (setq len (apply 'min (mapcar 'length seqs))))
705 (while (< idx len)
706 (if (eval (cons 'and
707 (mapcar (lambda (s) (equal (elt first idx) (elt s idx)))
708 rest)))
709 (setq pref (vconcat pref (vector (elt first idx)))))
710 (setq idx (1+ idx)))
711 pref))
713 ;; get all sequences that match PREFIX from a given A-LIST
714 (defun viper-extract-matching-alist-members (pref alist)
715 (delq nil (mapcar (lambda (elt) (if (viper-prefix-subseq-p pref elt) elt))
716 (viper-this-buffer-macros alist))))
718 (defun viper-do-sequence-completion (seq alist compl-message)
719 (let* ((matches (viper-extract-matching-alist-members seq alist))
720 (new-seq (apply 'viper-common-seq-prefix matches))
722 (cond ((and (equal seq new-seq) (= (length matches) 1))
723 (message "%s (Sole completion)" compl-message)
724 (sit-for 2))
725 ((null matches)
726 (message "%s (No match)" compl-message)
727 (sit-for 2)
728 (setq new-seq seq))
729 ((member seq matches)
730 (message "%s (Complete, but not unique)" compl-message)
731 (sit-for 2)
732 (viper-display-vector-completions matches))
733 ((equal seq new-seq)
734 (viper-display-vector-completions matches)))
735 new-seq))
738 (defun viper-display-vector-completions (list)
739 (with-output-to-temp-buffer "*Completions*"
740 (display-completion-list
741 (mapcar 'prin1-to-string
742 (mapcar 'viper-display-macro list)))))
746 ;; alist is the alist of macros
747 ;; str is the fast key sequence entered
748 ;; returns: (matching-macro-def . unmatched-suffix-start-index)
749 (defun viper-find-best-matching-macro (alist str)
750 (let ((lis alist)
751 (def-len 0)
752 (str-len (length str))
753 match unmatched-start-idx found macro-def)
754 (while (and (not found) lis)
755 (setq macro-def (car lis)
756 def-len (length (car macro-def)))
757 (if (and (>= str-len def-len)
758 (equal (car macro-def) (subseq str 0 def-len)))
759 (if (or (viper-kbd-buf-definition macro-def)
760 (viper-kbd-mode-definition macro-def)
761 (viper-kbd-global-definition macro-def))
762 (setq found t))
764 (setq lis (cdr lis)))
766 (if found
767 (setq match macro-def
768 unmatched-start-idx def-len)
769 (setq match nil
770 unmatched-start-idx 0))
772 (cons match unmatched-start-idx)))
776 ;; returns a list of names of macros defined for the current buffer
777 (defun viper-this-buffer-macros (macro-alist)
778 (let (candidates)
779 (setq candidates
780 (mapcar (lambda (elt)
781 (if (or (viper-kbd-buf-definition elt)
782 (viper-kbd-mode-definition elt)
783 (viper-kbd-global-definition elt))
784 (car elt)))
785 macro-alist))
786 (setq candidates (delq nil candidates))))
789 ;; if seq of Viper key symbols (representing a macro) can be converted to a
790 ;; string--do so. Otherwise, do nothing.
791 (defun viper-display-macro (macro-name-or-body)
792 (cond ((viper-char-symbol-sequence-p macro-name-or-body)
793 (mapconcat 'symbol-name macro-name-or-body ""))
794 ((viper-char-array-p macro-name-or-body)
795 (mapconcat 'char-to-string macro-name-or-body ""))
796 (t macro-name-or-body)))
798 ;; convert sequence of events (that came presumably from emacs kbd macro) into
799 ;; Viper's macro, which is a vector of the form
800 ;; [ desc desc ... ]
801 ;; Each desc is either a symbol of (meta symb), (shift symb), etc.
802 ;; Here we purge events that happen to be lists. In most cases, these events
803 ;; got into a macro definition unintentionally; say, when the user moves mouse
804 ;; during a macro definition, then something like (switch-frame ...) might get
805 ;; in. Another reason for purging lists-events is that we can't store them in
806 ;; textual form (say, in .emacs) and then read them back.
807 (defun viper-events-to-macro (event-seq)
808 (vconcat (delq nil (mapcar (lambda (elt) (if (consp elt)
810 (viper-event-key elt)))
811 event-seq))))
813 ;; convert strings or arrays of characters to Viper macro form
814 (defun viper-char-array-to-macro (array)
815 (let ((vec (vconcat array))
816 macro)
817 (if viper-xemacs-p
818 (setq macro (mapcar 'character-to-event vec))
819 (setq macro vec))
820 (vconcat (mapcar 'viper-event-key macro))))
822 ;; For macros bodies and names, goes over MACRO and checks if all members are
823 ;; names of keys (actually, it only checks if they are symbols or lists
824 ;; if a digit is found, it is converted into a symbol (e.g., 0 -> \0, etc).
825 ;; If MACRO is not a list or vector -- doesn't change MACRO.
826 (defun viper-fixup-macro (macro)
827 (let ((len (length macro))
828 (idx 0)
829 elt break)
830 (if (or (vectorp macro) (listp macro))
831 (while (and (< idx len) (not break))
832 (setq elt (elt macro idx))
833 (cond ((numberp elt)
834 ;; fix number
835 (if (and (<= 0 elt) (<= elt 9))
836 (cond ((arrayp macro)
837 (aset macro
839 (intern (char-to-string (+ ?0 elt)))))
840 ((listp macro)
841 (setcar (nthcdr idx macro)
842 (intern (char-to-string (+ ?0 elt)))))
844 ((listp elt)
845 (viper-fixup-macro elt))
846 ((symbolp elt) nil)
847 (t (setq break t)))
848 (setq idx (1+ idx))))
850 (if break
851 (error "Wrong type macro component, symbol-or-listp, %S" elt)
852 macro)))
854 (defun viper-char-array-p (array)
855 (eval (cons 'and (mapcar 'viper-characterp array))))
857 (defun viper-macro-to-events (macro-body)
858 (vconcat (mapcar 'viper-key-to-emacs-key macro-body)))
861 ;; check if vec is a vector of character symbols
862 (defun viper-char-symbol-sequence-p (vec)
863 (and
864 (sequencep vec)
865 (eval
866 (cons 'and
867 (mapcar (lambda (elt)
868 (and (symbolp elt) (= (length (symbol-name elt)) 1)))
869 vec)))))
872 ;; Check if vec is a vector of key-press events representing characters
873 ;; XEmacs only
874 (defun viper-event-vector-p (vec)
875 (and (vectorp vec)
876 (eval (cons 'and (mapcar '(lambda (elt) (if (eventp elt) t)) vec)))))
879 ;;; Reading fast key sequences
881 ;; Assuming that CHAR was the first character in a fast succession of key
882 ;; strokes, read the rest. Return the vector of keys that was entered in
883 ;; this fast succession of key strokes.
884 ;; A fast keysequence is one that is terminated by a pause longer than
885 ;; viper-fast-keyseq-timeout.
886 (defun viper-read-fast-keysequence (event macro-alist)
887 (let ((lis (vector event))
888 next-event)
889 (while (and (viper-fast-keysequence-p)
890 (viper-keyseq-is-a-possible-macro lis macro-alist))
891 (setq next-event (viper-read-key))
892 ;;(setq next-event (viper-read-event))
893 (or (viper-mouse-event-p next-event)
894 (setq lis (vconcat lis (vector next-event)))))
895 lis))
898 ;;; Keyboard macros in registers
900 ;; sets register to last-kbd-macro carefully.
901 (defun viper-set-register-macro (reg)
902 (if (get-register reg)
903 (if (y-or-n-p "Register contains data. Overwrite? ")
905 (error
906 "Macro not saved in register. Can still be invoked via `C-x e'")))
907 (set-register reg last-kbd-macro))
909 (defun viper-register-macro (count)
910 "Keyboard macros in registers - a modified \@ command."
911 (interactive "P")
912 (let ((reg (downcase (read-char))))
913 (cond ((or (and (<= ?a reg) (<= reg ?z)))
914 (setq viper-last-macro-reg reg)
915 (if defining-kbd-macro
916 (progn
917 (end-kbd-macro)
918 (viper-set-register-macro reg))
919 (execute-kbd-macro (get-register reg) count)))
920 ((or (= ?@ reg) (= ?\^j reg) (= ?\^m reg))
921 (if viper-last-macro-reg
923 (error "No previous kbd macro"))
924 (execute-kbd-macro (get-register viper-last-macro-reg) count))
925 ((= ?\# reg)
926 (start-kbd-macro count))
927 ((= ?! reg)
928 (setq reg (downcase (read-char)))
929 (if (or (and (<= ?a reg) (<= reg ?z)))
930 (progn
931 (setq viper-last-macro-reg reg)
932 (viper-set-register-macro reg))))
934 (error "`%c': Unknown register" reg)))))
937 (defun viper-global-execute ()
938 "Call last keyboad macro for each line in the region."
939 (if (> (point) (mark t)) (exchange-point-and-mark))
940 (beginning-of-line)
941 (call-last-kbd-macro)
942 (while (< (point) (mark t))
943 (forward-line 1)
944 (beginning-of-line)
945 (call-last-kbd-macro)))
948 ;;; viper-macs.el ends here