summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKim F. Storm <storm@cua.dk>2002-08-19 23:05:29 +0000
committerKim F. Storm <storm@cua.dk>2002-08-19 23:05:29 +0000
commit1fa13bd434079b98ce6b0c8e65dda1ea83670d41 (patch)
tree9258802ff8205cec17745759a2ff7ea0592dff19
parent1c7c032c12de4ac4a96676af24ee4e13376382de (diff)
downloademacs-1fa13bd434079b98ce6b0c8e65dda1ea83670d41.tar.gz
Major rework based on discussions with RMS.
Most important change is that C-x C-k is now bound to a keymap with keyboard macro related commands. The original binding on C-x C-k is moved to C-x C-k e.
-rw-r--r--lisp/kmacro.el688
1 files changed, 490 insertions, 198 deletions
diff --git a/lisp/kmacro.el b/lisp/kmacro.el
index c1d89386497..15e7a076d1f 100644
--- a/lisp/kmacro.el
+++ b/lisp/kmacro.el
@@ -43,6 +43,29 @@
;; terminates when point reaches the end of the buffer or if an error
;; is signalled by ringing the bell.
+;; When you define a macro with F7/F8, it is automatically added to
+;; the head of the "keyboard macro ring", and F8 actually executes the
+;; first element of the macro ring.
+;;
+;; Note: an empty macro is never added to the macro ring.
+;;
+;; You can execute the second element on the macro ring with C-u F8 or
+;; C-x C-k C-l, you can use C-x C-k C-p and C-x C-k C-n to cycle
+;; through the macro ring, and you can swap the first and second
+;; elements with C-x C-k C-t. To delete the first element in the
+;; macro ring, use C-x C-k C-d.
+;;
+;;
+;; You can also use C-x C-k C-s to start a macro, and C-x C-k C-k to
+;; end it; then use C-k to execute it immediately, or C-x C-k C-k to
+;; execute it later.
+;;
+;; In general, immediately after using C-x C-k followed by one of C-k,
+;; C-l, C-p, or C-n, you can further cycle the macro ring using C-p or
+;; C-n, execute the first or second macro using C-k or C-l, delete
+;; the head macro with C-d, or edit the current macro with C-e without
+;; repeating the C-x C-k prefix.
+
;; If you enter F7 while defining the macro, the numeric value of
;; `kmacro-counter' is inserted using the `kmacro-counter-format', and
;; `kmacro-counter' is incremented by 1 (or the numeric prefix value
@@ -63,18 +86,12 @@
;; A macro can also be called using a mouse click, default S-mouse-3.
;; This calls the macro at the point where you click the mouse.
-;; When you have defined another macro, which is thus called via F8,
-;; the previous macro is pushed onto a keyboard macro ring. The head
-;; macro on the ring can be executed using S-F8. You can cycle the
-;; macro ring using C-F8. You can also swap the last macro and the
-;; head of the macro ring using C-u F8.
-
-;; You can edit the last macro using M-F7.
+;; You can edit the last macro using C-x C-k C-e.
;; You can append to the last macro using C-u F7.
-;; You can set the macro counter using C-F7, and you can set
-;; the macro counter format with S-F7..
+;; You can set the macro counter using C-x C-k C-c, add to it using C-x C-k C-a,
+;; and you can set the macro counter format with C-x C-k C-f.
;; The following key bindings are performed:
;;
@@ -92,20 +109,6 @@
;;
;; C-u f8 Swap last and head of macro ring.
;;
-;; S-f7 Set the format of the macro Ditto, but notice that the
-;; counter (default: %d). format is reset at the next
-;; invocation of the macro.
-;;
-;; C-f7 Set the macro counter value Increase/decrease counter value
-;; to the prefix value. by the prefix value, or if prefix
-;; is C-u, set counter to 0.
-;;
-;; M-f7 Edit the last macro.
-;;
-;; S-f8 Call the previous macro.
-;;
-;; C-f8 Cycle the macro ring.
-;;
;; S-mouse-3 Set point at click and End macro and execute macro at
;; execute last macro. click.
@@ -120,38 +123,80 @@
:link '(emacs-commentary-link :tag "Commentary" "kmacro.el")
:link '(emacs-library-link :tag "Lisp File" "kmacro.el"))
-;;;###autoload
-(defcustom kmacro-initialize nil
- "Setting this variable turns on the kmacro functionality.
-This binds the kmacro function keys in the `global-map', so
-unsetting this variable does not have any effect!"
- :set #'(lambda (symbol value)
- (if value (kmacro-initialize))
- (set symbol value))
- :initialize 'custom-initialize-default
- :require 'kmacro
- :link '(emacs-commentary-link "kmacro.el")
- :set-after '(kmacro-start-key kmacro-call-key kmacro-mouse-button)
- :version "21.4"
- :type 'boolean
+(defcustom kmacro-call-mouse-event 'S-mouse-3
+ "The mouse event used by kmacro to call a macro.
+Set to nil if no mouse binding is desired."
+ :type 'symbol
:group 'kmacro)
-(defcustom kmacro-start-key 'f7
- "The function key used by kmacro to start a macro."
- :type 'symbol
+(defcustom kmacro-ring-max 8
+ "Maximum number of keyboard macros to save in macro ring."
+ :type 'integer
:group 'kmacro)
-(defcustom kmacro-call-key 'f8
- "The function key used by kmacro to end and call a macro."
- :type 'symbol
+
+(defcustom kmacro-execute-before-append t
+ "Controls whether appending to a macro starts by executing the macro.
+If non-nil, using a single \\[universal-argument] prefix executes the macro
+before appending, while more than one \\[universal-argument] prefix does not
+execute the macro.
+Otherwise, a single \\[universal-argument] prefix does not execute the
+macro, while more than one \\[universal-argument] prefix causes the
+macro to be executed before appending to it."
+ :type 'boolean
:group 'kmacro)
-(defcustom kmacro-call-mouse-event 'S-mouse-3
- "The mouse event used by kmacro to call a macro."
- :type 'symbol
+
+(defcustom kmacro-repeat-no-prefix t
+ "Allow repeating certain macro commands without entering the C-x C-k prefix."
+ :type 'boolean
:group 'kmacro)
-;; State variables
+
+;; Keymap
+
+(defvar kmacro-keymap
+ (let ((map (make-sparse-keymap)))
+ (define-key map "\C-s" 'kmacro-start-macro)
+ (define-key map "\C-k" 'kmacro-end-or-call-macro-rep)
+ (define-key map "\C-e" 'kmacro-edit-macro)
+ (define-key map "\r" 'kmacro-edit-macro-nr)
+ (define-key map "l" 'kmacro-edit-lossage)
+ (define-key map "\C-i" 'kmacro-insert-counter)
+ (define-key map "\C-a" 'kmacro-add-counter)
+ (define-key map "\C-v" 'kmacro-view-macro-rep)
+ (define-key map "\C-l" 'kmacro-call-ring-2nd-rep)
+ (define-key map "\C-r" 'kmacro-view-ring-2nd)
+ (define-key map "\C-n" 'kmacro-cycle-ring-next)
+ (define-key map "\C-p" 'kmacro-cycle-ring-previous)
+ (define-key map "\C-f" 'kmacro-set-format)
+ (define-key map "\C-c" 'kmacro-set-counter)
+ (define-key map "\C-t" 'kmacro-swap-ring)
+ (define-key map "\C-b" 'kmacro-bind-to-key)
+ (define-key map "\C-d" 'kmacro-delete-ring-head)
+ ;; Compatibility bindings
+ (define-key map "q" 'kbd-macro-query)
+ (define-key map "n" 'name-last-kbd-macro)
+ (define-key map "e" 'edit-kbd-macro)
+ map)
+ "Keymap for keyboard macro commands.")
+(defalias 'kmacro-keymap kmacro-keymap)
+
+;;; Provide some binding for startup:
+;;;###autoload (global-set-key "\C-x(" 'kmacro-start-macro)
+;;;###autoload (global-set-key "\C-x)" 'kmacro-end-macro)
+;;;###autoload (global-set-key "\C-xe" 'kmacro-call-macro)
+;;;###autoload (global-set-key [f7] 'kmacro-start-macro-or-insert-counter)
+;;;###autoload (global-set-key [f8] 'kmacro-end-or-call-macro)
+;;;###autoload (global-set-key "\C-x\C-k" 'kmacro-keymap)
+;;;###autoload (autoload 'kmacro-keymap "kmacro" "Keymap for keyboard macro commands." t 'keymap)
+
+(if kmacro-call-mouse-event
+ (global-set-key (vector kmacro-call-mouse-event) 'kmacro-end-call-mouse))
+
+
+
+;;; Keyboard macro counter
(defvar kmacro-counter 0
"*Current keyboard macro counter.")
@@ -162,37 +207,343 @@ unsetting this variable does not have any effect!"
(defvar kmacro-counter-format-start kmacro-counter-format
"Macro format at start of macro execution.")
+(defvar kmacro-counter-value-start kmacro-counter
+ "Macro counter at start of macro execution.")
+
(defvar kmacro-last-counter 0 "Last counter inserted by key macro.")
-(defvar kmacro-append-to nil "Last key macro if appending to macro.")
-(defvar kmacro-ring nil "Key macro ring.")
-(defvar kmacro-ring-max 4
- "*Maximum number of key macros to save in key macro ring.")
-(defun kmacro-display (macro)
+(defun kmacro-insert-counter (arg)
+ "Insert macro counter and increment with ARG or 1 if missing.
+With \\[universal-argument], insert previous kmacro-counter (but do not modify counter)."
+ (interactive "P")
+ (if (and arg (listp arg))
+ (insert (format kmacro-counter-format kmacro-last-counter))
+ (insert (format kmacro-counter-format kmacro-counter))
+ (kmacro-add-counter (prefix-numeric-value arg))))
+
+
+(defun kmacro-set-format (format)
+ "Set macro counter FORMAT."
+ (interactive "sMacro Counter Format (printf format): ")
+ (setq kmacro-counter-format
+ (if (equal format "") "%d" format))
+ ;; redefine initial macro counter if we are not executing a macro.
+ (if (not (or defining-kbd-macro executing-kbd-macro))
+ (setq kmacro-counter-format-start kmacro-counter-format)))
+
+
+(defun kmacro-display-counter (&optional value)
+ "Display current counter value."
+ (unless value (setq value kmacro-counter))
+ (message "New macro counter value: %s (%d)" (format kmacro-counter-format value) value))
+
+
+(defun kmacro-set-counter (arg)
+ "Set kmacro-counter to ARG or prompt if missing.
+With \\[universal-argument], reset counter to its value prior to this iteration of the macro."
+ (interactive "NMacro counter value: ")
+ (setq kmacro-last-counter kmacro-counter
+ kmacro-counter (if (and current-prefix-arg (listp current-prefix-arg))
+ kmacro-counter-value-start
+ arg))
+ (unless executing-kbd-macro
+ (kmacro-display-counter)))
+
+
+(defun kmacro-add-counter (arg)
+ "Add numeric prefix arg (prompt if missing) to macro counter.
+With \\[universal-argument], restore previous counter value."
+ (interactive "NAdd to macro counter: ")
+ (let ((last kmacro-last-counter))
+ (setq kmacro-last-counter kmacro-counter
+ kmacro-counter (if (and current-prefix-arg (listp current-prefix-arg))
+ last
+ kmacro-counter (+ kmacro-counter arg))))
+ (unless executing-kbd-macro
+ (kmacro-display-counter)))
+
+
+(defun kmacro-loop-setup-function ()
+ "Function called prior to each iteration of macro."
+ ;; Restore macro counter format to initial format, so it is ok to change
+ ;; counter format in the macro without restoring it.
+ (setq kmacro-counter-format kmacro-counter-format-start)
+ ;; Save initial counter value so we can restore it with C-u kmacro-set-counter.
+ (setq kmacro-counter-value-start kmacro-counter)
+ ;; Return non-nil to continue execution.
+ t)
+
+
+;;; Keyboard macro ring
+
+(defvar kmacro-ring nil
+ "The keyboard macro ring.
+Each element is a list (MACRO COUNTER FORMAT). Actually, the head of
+the macro ring (when defining or executing) is not stored in the ring;
+instead it is available in the variables `last-kbd-macro', `kmacro-counter',
+and `kmacro-counter-format'.")
+
+
+(defun kmacro-ring-head ()
+ "Return pseudo head element in macro ring."
+ (and last-kbd-macro
+ (list last-kbd-macro kmacro-counter kmacro-counter-format-start)))
+
+
+(defun kmacro-push-ring (&optional elt)
+ "Push ELT or current macro onto `kmacro-ring'."
+ (when (setq elt (or elt (kmacro-ring-head)))
+ (let ((len (length kmacro-ring)))
+ (setq kmacro-ring (cons elt kmacro-ring))
+ (if (>= len kmacro-ring-max)
+ (setcdr (nthcdr len kmacro-ring) nil)))))
+
+
+(defun kmacro-split-ring-element (elt)
+ (setq last-kbd-macro (car elt)
+ kmacro-counter (nth 1 elt)
+ kmacro-counter-format-start (nth 2 elt)))
+
+
+(defun kmacro-pop-ring1 (&optional raw)
+ "Pop head element off macro ring (no check).
+Non-nil arg RAW means just return raw first element."
+ (prog1 (car kmacro-ring)
+ (unless raw
+ (kmacro-split-ring-element (car kmacro-ring)))
+ (setq kmacro-ring (cdr kmacro-ring))))
+
+
+(defun kmacro-pop-ring (&optional raw)
+ "Pop head element off macro ring.
+Non-nil arg RAW means just return raw first element."
+ (unless (kmacro-ring-empty-p)
+ (kmacro-pop-ring1 raw)))
+
+
+(defun kmacro-ring-length ()
+ "Return length of macro ring, including pseudo head."
+ (+ (if last-kbd-macro 1 0) (length kmacro-ring)))
+
+
+(defun kmacro-ring-empty-p (&optional none)
+ "Tell user and return t if `last-kbd-macro' is nil or `kmacro-ring' is empty.
+Check only `last-kbd-macro' if optional arg NONE is non-nil."
+ (while (and (null last-kbd-macro) kmacro-ring)
+ (kmacro-pop-ring1))
+ (cond
+ ((null last-kbd-macro)
+ (message "No keyboard macro defined.")
+ t)
+ ((and (null none) (null kmacro-ring))
+ (message "Only one keyboard macro defined.")
+ t)
+ (t nil)))
+
+
+(defun kmacro-display (macro &optional trunc descr empty )
"Display a keyboard MACRO."
- (let (s)
- (if (stringp macro)
- (setq s (if (> (length macro) 50)
- (concat (substring macro 0 50) "...")
- macro))
- (if (vectorp macro)
- (let (v (i 0) (n (length macro)))
- (setq s "")
- (while (and (< i n) (< (length s) 50))
- (setq v (aref macro i))
- (setq s (cond
- ((numberp v) (concat s (char-to-string v)))
- ((stringp v) (concat s v))
- ((symbolp v) (concat s "[" (symbol-name v) "]"))
- (t s)))
- (setq i (1+ i)))
- (if (< i n)
- (setq s (concat s "..."))))))
- (message (format "Macro: %s" s))))
+ (if macro
+ (let* ((x 60)
+ (m (format-kbd-macro macro))
+ (l (length m))
+ (z (and nil trunc (> l x))))
+ (message (format "%s: %s%s" (or descr "Macro")
+ (if z (substring m 0 (1- x)) m) (if z "..." ""))))
+ (message (or empty "No keyboard macros defined"))))
+
+
+(defun kmacro-call-ring-2nd (arg)
+ "Execute second keyboard macro at in macro ring."
+ (interactive "P")
+ (unless (kmacro-ring-empty-p)
+ ;; should use counter format specific to the macro on the ring!
+ (let ((kmacro-counter (nth 1 (car kmacro-ring)))
+ (kmacro-counter-format-start (nth 2 (car kmacro-ring))))
+ (execute-kbd-macro (car (car kmacro-ring)) arg #'kmacro-loop-setup-function)
+ (setcar (cdr (car kmacro-ring)) kmacro-counter))))
+
+
+(defun kmacro-call-ring-2nd-rep (arg)
+ "Like `kmacro-call-ring-2nd', but allow repeat without kmacro prefix."
+ (interactive "P")
+ (kmacro-call-ring-2nd arg)
+ (if kmacro-ring
+ (kmacro-repeat-loop)))
+
+(put 'kmacro-call-ring-2nd-rep 'kmacro-repeat 'head)
+
+(defun kmacro-view-ring-2nd ()
+ "Display the current head of the keyboard macro ring."
+ (interactive)
+ (unless (kmacro-ring-empty-p)
+ (kmacro-display (car (car kmacro-ring)) "2nd macro")))
+
+
+(defun kmacro-repeat-loop ()
+ "Process kmacro commands keys immidiately after cycling the ring."
+ (when kmacro-repeat-no-prefix
+ (let (cmd done repeat)
+ (while (and last-kbd-macro
+ (not done)
+ (setq cmd (lookup-key kmacro-keymap (vector (read-event))))
+ (setq repeat (get cmd 'kmacro-repeat)))
+ (clear-this-command-keys t)
+ (cond
+ ((eq repeat 'ring)
+ (if kmacro-ring
+ (let ((kmacro-repeat-no-prefix nil))
+ (funcall cmd nil))
+ (kmacro-display last-kbd-macro t)))
+ ((eq repeat 'head)
+ (funcall cmd nil))
+ ((eq repeat 'stop)
+ (funcall cmd nil)
+ (setq done t)))
+ (setq last-input-event nil)))
+ (when last-input-event
+ (clear-this-command-keys t)
+ (setq unread-command-events (list last-input-event)))))
+
+
+(defun kmacro-cycle-ring-next (&optional arg)
+ "Move to next keyboard macro in keyboard macro ring.
+Displays the selected macro in the echo area."
+ (interactive)
+ (unless (kmacro-ring-empty-p)
+ (kmacro-push-ring)
+ (let* ((len (length kmacro-ring))
+ (tail (nthcdr (- len 2) kmacro-ring))
+ (elt (car (cdr tail))))
+ (setcdr tail nil)
+ (kmacro-split-ring-element elt))
+ (kmacro-display last-kbd-macro t)
+ (kmacro-repeat-loop)))
+
+(put 'kmacro-cycle-ring-next 'kmacro-repeat 'ring)
+
+
+(defun kmacro-cycle-ring-previous (&optional arg)
+ "Move to previous keyboard macro in keyboard macro ring.
+Displays the selected macro in the echo area."
+ (interactive)
+ (unless (kmacro-ring-empty-p)
+ (let ((cur (kmacro-ring-head)))
+ (kmacro-pop-ring1)
+ (if kmacro-ring
+ (nconc kmacro-ring (list cur))
+ (setq kmacro-ring (list cur))))
+ (kmacro-display last-kbd-macro t)
+ (kmacro-repeat-loop)))
+
+(put 'kmacro-cycle-ring-previous 'kmacro-repeat 'ring)
+
+(defun kmacro-swap-ring ()
+ "Swap first two elements on keyboard macro ring."
+ (interactive)
+ (unless (kmacro-ring-empty-p)
+ (let ((cur (kmacro-ring-head)))
+ (kmacro-pop-ring1)
+ (kmacro-push-ring cur))
+ (kmacro-display last-kbd-macro t)))
+
+
+(defun kmacro-delete-ring-head (&optional arg)
+ "Delete current macro from keyboard macro ring."
+ (interactive)
+ (unless (kmacro-ring-empty-p t)
+ (if (null kmacro-ring)
+ (setq last-kbd-macro nil)
+ (kmacro-pop-ring))
+ (kmacro-display last-kbd-macro t nil "Keyboard macro ring is now empty.")))
+
+(put 'kmacro-delete-ring-head 'kmacro-repeat 'head)
+
+;;; Traditional bindings:
+
+
+;;;###autoload
(defun kmacro-start-macro (arg)
+ "Record subsequent keyboard input, defining a keyboard macro.
+The commands are recorded even as they are executed.
+Use \\[end-kbd-macro] to finish recording and make the macro available.
+Use \\[call-last-kbd-macro] to execute the macro.
+Use \\[name-last-kbd-macro] to give it a permanent name.
+Non-nil arg (prefix arg) means append to last macro defined;
+
+With \\[universal-argument] prefix, append to last keyboard macro
+defined. Depending on `kmacro-execute-before-append', this may begin
+by re-executing the last macro as if you typed it again.
+
+Otherwise, it sets `kmacro-counter' to ARG or 0 if missing before
+defining the macro.
+
+Use \\[kmacro-insert-counter] to insert (and increment) the macro counter.
+The counter value can be set or modified via \\[kmacro-set-counter] and \\[kmacro-add-counter].
+The format of the counter can be modified via \\[kmacro-set-format]."
+ (interactive "P")
+ (if (or defining-kbd-macro executing-kbd-macro)
+ (message "Already defining keyboard macro.")
+ (let ((append (and arg (listp arg))))
+ (unless append
+ (if last-kbd-macro
+ (let ((len (length kmacro-ring)))
+ (setq kmacro-ring
+ (cons
+ (list last-kbd-macro kmacro-counter kmacro-counter-format-start)
+ kmacro-ring))
+ (if (>= len kmacro-ring-max)
+ (setcdr (nthcdr len kmacro-ring) nil))))
+ (setq kmacro-counter (if arg (prefix-numeric-value arg) 0)
+ kmacro-counter-value-start kmacro-counter
+ kmacro-last-counter kmacro-counter
+ kmacro-counter-format-start kmacro-counter-format))
+
+ (start-kbd-macro append
+ (and append
+ (if kmacro-execute-before-append
+ (> (car arg) 4)
+ (= (car arg) 4)))))))
+
+
+;;;###autoload
+(defun kmacro-end-macro (arg)
+ "Finish defining a keyboard macro.
+The definition was started by \\[kmacro-start-macro].
+The macro is now available for use via \\[kmacro-call-macro],
+or it can be given a name with \\[name-last-kbd-macro] and then invoked
+under that name.
+
+With numeric arg, repeat macro now that many times,
+counting the definition just completed as the first repetition.
+An argument of zero means repeat until error."
+ (interactive "P")
+ (end-kbd-macro arg #'kmacro-loop-setup-function)
+ (when (and last-kbd-macro (= (length last-kbd-macro) 0))
+ (message "Ignore empty macro")
+ (kmacro-pop-ring)))
+
+
+;;;###autoload
+(defun kmacro-call-macro (arg)
+ "Call the last keyboard macro that you defined with \\[kmacro-start-macro].
+
+A prefix argument serves as a repeat count. Zero means repeat until error.
+
+To make a macro permanent so you can call it even after
+defining others, use M-x name-last-kbd-macro."
+ (interactive "p")
+ (call-last-kbd-macro arg #'kmacro-loop-setup-function))
+
+
+
+;;; Combined function key bindings:
+
+;;;###autoload
+(defun kmacro-start-macro-or-insert-counter (arg)
"Set `kmacro-counter' to ARG or 0 if missing, and `start-kbd-macro'.
With \\[universal-argument], append to current keyboard macro (keep kmacro-counter).
@@ -200,158 +551,99 @@ When defining/executing macro, insert macro counter and increment with
ARG or 1 if missing.
With \\[universal-argument], insert previous kmacro-counter (but do not modify counter).
-The macro counter can be modified via \\[kmacro-set-counter].
+The macro counter can be modified via \\[kmacro-set-counter] and \\[kmacro-add-counter].
The format of the counter can be modified via \\[kmacro-set-format]."
- (interactive "p")
+ (interactive "P")
(if (or defining-kbd-macro executing-kbd-macro)
- (if (and current-prefix-arg (listp current-prefix-arg))
- (insert (format kmacro-counter-format kmacro-last-counter))
- (insert (format kmacro-counter-format kmacro-counter))
- (setq kmacro-last-counter kmacro-counter
- kmacro-counter (+ kmacro-counter arg)))
- (if (and current-prefix-arg (listp current-prefix-arg))
- (setq kmacro-append-to last-kbd-macro)
- (setq kmacro-append-to nil
- kmacro-counter (if current-prefix-arg arg 0)
- kmacro-last-counter kmacro-counter))
- (if last-kbd-macro
- (let ((len (length kmacro-ring)))
- (setq kmacro-ring (cons last-kbd-macro kmacro-ring))
- (if (>= len kmacro-ring-max)
- (setcdr (nthcdr len kmacro-ring) nil))))
- (setq kmacro-counter-format-start kmacro-counter-format)
- (start-kbd-macro nil)
- (if kmacro-append-to (message "Appending to keyboard macro..."))
-))
+ (kmacro-insert-counter arg)
+ (kmacro-start-macro arg)))
-(defun kmacro-call-macro (arg)
+
+;;;###autoload
+(defun kmacro-end-or-call-macro (arg)
"End kbd macro if currently being defined; else call last kbd macro.
With numeric prefix ARG, repeat macro that many times.
-With \\[universal-argument], swap current macro with head of macro ring."
- (interactive "p")
+With \\[universal-argument], call second macro in macro ring."
+ (interactive "P")
(cond
(defining-kbd-macro
- (end-kbd-macro)
- (if kmacro-append-to
- (setq last-kbd-macro (concat kmacro-append-to last-kbd-macro)
- kmacro-append-to nil)))
- ((and current-prefix-arg (listp current-prefix-arg))
- (when kmacro-ring
- (let ((head (car kmacro-ring)))
- (setq kmacro-ring (cons last-kbd-macro (cdr kmacro-ring)))
- (setq last-kbd-macro head)))
- (kmacro-display last-kbd-macro))
+ (kmacro-end-macro arg))
+ ((and arg (listp arg))
+ (kmacro-call-ring-2nd 1))
(t
- (setq kmacro-counter-format kmacro-counter-format-start)
- (call-last-kbd-macro arg))))
+ (kmacro-call-macro arg))))
+
+
+(defun kmacro-end-or-call-macro-rep (arg)
+ "As `kmacro-end-or-call-macro' but allows repeat without kmacro prefix."
+ (interactive "P")
+ (kmacro-end-or-call-macro arg)
+ (kmacro-repeat-loop))
+
+(put 'kmacro-end-or-call-macro-rep 'kmacro-repeat 'head)
-(defun kmacro-call-macro-ring (arg)
- "End kbd macro if currently being defined; else call last kbd macro.
-With \\[universal-argument], display current macro."
- (interactive "p")
- (if kmacro-ring
- (execute-kbd-macro (car kmacro-ring) arg)))
+;;;###autoload
(defun kmacro-end-call-mouse (event)
"Move point to the position clicked with the mouse and call last kbd macro.
If kbd macro currently being defined end it before activating it."
(interactive "e")
(when defining-kbd-macro
- (end-kbd-macro)
- (if kmacro-append-to
- (setq last-kbd-macro (concat kmacro-append-to last-kbd-macro)
- kmacro-append-to nil)))
+ (end-kbd-macro))
(mouse-set-point event)
- (call-last-kbd-macro nil))
+ (kmacro-call-macro nil))
-(defun kmacro-cycle-macro-ring (&optional previous)
- "Cycle the keyboard macro ring on \\[kmacro-call-macro-ring].
-Moves to the next element in the keyboard macro ring.
-With \\[universal-argument] prefix, move to the previous element in the ring.
-Displays the selected macro in the echo area."
- (interactive "p")
- (if (null kmacro-ring)
- (message "No keymacros in ring")
- (cond
- ((not (eq this-command last-command))
- nil)
- ((= (length kmacro-ring) 1)
- nil)
- (previous
- (let* ((len (length kmacro-ring))
- (tail (nthcdr (- len 2) kmacro-ring))
- (elt (car (cdr tail))))
- (setcdr tail nil)
- (setq kmacro-ring (cons elt kmacro-ring))))
- (t
- (let ((elt (car kmacro-ring)))
- (setq kmacro-ring (cdr kmacro-ring))
- (nconc kmacro-ring (list elt)))))
- (kmacro-display (car kmacro-ring))))
-
-(defun kmacro-save-macro-on-key (arg)
- "When not defining or executing a macro, offer to save last macro on a key."
+
+;;; Misc. commands
+
+(defun kmacro-bind-to-key (arg)
+ "When not defining or executing a macro, offer to bind last macro to a key."
(interactive "p")
(if (or defining-kbd-macro executing-kbd-macro)
- nil
- (or last-kbd-macro
- (error "No keyboard macro defined"))
- (let ((key-seq (read-key-sequence "Save last macro on key: ")))
- (or (equal key-seq "")
- (define-key global-map key-seq last-kbd-macro))))
-)
+ (if defining-kbd-macro
+ (message "Cannot save macro while defining it."))
+ (unless last-kbd-macro
+ (error "No keyboard macro defined"))
+ (let ((key-seq (read-key-sequence "Bind last macro to key: ")))
+ (unless (equal key-seq "")
+ (define-key global-map key-seq last-kbd-macro)))))
-(defun kmacro-set-counter (arg)
- "Set kmacro-counter to ARG or 0 if missing.
-While defining/executing key macro, increase or decrease counter.
-With \\[universal-argument], unconditionally set counter to 0."
- (interactive "p")
- (setq kmacro-counter
- (cond ((and current-prefix-arg (listp current-prefix-arg)) 0)
- ((or defining-kbd-macro executing-kbd-macro) (+ kmacro-counter arg))
- (current-prefix-arg arg)
- (t 0))))
-(defun kmacro-set-format (format)
- "Set macro counter FORMAT."
- (interactive "sMacro Counter Format (printf format): ")
- (setq kmacro-counter-format
- (if (equal format "")
- "%d"
- format))
+(defun kmacro-view-macro (&optional arg)
+ "Display the last keyboard macro."
+ (interactive)
+ (kmacro-display last-kbd-macro))
- ;; redefine initial macro counter if we are not executing a macro.
- (if (not (or defining-kbd-macro executing-kbd-macro))
- (setq kmacro-counter-format-start kmacro-counter-format))
-)
-(defun kmacro-edit-macro ()
- "Edit keyboard macro."
+(defun kmacro-view-macro-rep (&optional arg)
+ "Like `kmacro-view-macro', but allow repeat without kmacro prefix."
(interactive)
- (edit-kbd-macro "\r"))
+ (kmacro-view-macro arg)
+ (if last-kbd-macro
+ (kmacro-repeat-loop)))
+
+(put 'kmacro-view-macro-rep 'kmacro-repeat 'head)
+
+(defun kmacro-edit-macro (&optional arg)
+ "Edit last keyboard macro."
+ (interactive "P")
+ (edit-kbd-macro "\r" arg))
+
+(put 'kmacro-edit-macro 'kmacro-repeat 'stop)
+
+
+(defun kmacro-edit-macro-nr (&optional arg)
+ "As edit last keyboard macro, but without kmacro-repeat property."
+ (interactive "P")
+ (kmacro-edit-macro arg))
+
+
+(defun kmacro-edit-lossage ()
+ "Edit most recent 100 keystrokes as a keyboard macro."
+ (interactive)
+ (kmacro-push-ring)
+ (edit-kbd-macro "\C-hl"))
-;;;###autoload
-(defun kmacro-initialize (&optional start-key call-key call-mouse)
- "Setup key bindings for the keyboard macro package.
-If specified, use keys START-KEY, CALL-KEY, and CALL-MOUSE.
-Don't bind to any mouse event if CALL-MOUSE is t.
-Otherwise, use customized keys."
-
- (setq start-key (or start-key kmacro-start-key 'f7))
- (setq call-key (or call-key kmacro-call-key 'f8))
- (setq call-mouse (or call-mouse kmacro-call-mouse-event 'S-mouse-3))
-
- (global-set-key (vector start-key) 'kmacro-start-macro)
- (global-set-key (vector (list 'shift start-key)) 'kmacro-set-format)
- (global-set-key (vector (list 'control start-key)) 'kmacro-set-counter)
- (global-set-key (vector (list 'meta start-key)) 'kmacro-edit-macro)
-
- (global-set-key (vector call-key) 'kmacro-call-macro)
- (global-set-key (vector (list 'shift call-key)) 'kmacro-call-macro-ring)
- (global-set-key (vector (list 'control call-key)) 'kmacro-cycle-macro-ring)
-
- (unless (eq call-mouse t)
- (global-set-key (vector call-mouse) 'kmacro-end-call-mouse)))
(provide 'kmacro)
;;; kmacro.el ends here