edmacro.el 27.1 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2
;;; edmacro.el --- keyboard macro editor

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1993-1994, 2001-2015 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

5 6 7
;; Author: Dave Gillespie <daveg@synaptics.com>
;; Maintainer: Dave Gillespie <daveg@synaptics.com>
;; Version: 2.01
Eric S. Raymond's avatar
Eric S. Raymond committed
8
;; Keywords: abbrev
David Lawrence's avatar
David Lawrence committed
9 10 11

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
David Lawrence's avatar
David Lawrence committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
David Lawrence's avatar
David Lawrence committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
David Lawrence's avatar
David Lawrence committed
24

Eric S. Raymond's avatar
Eric S. Raymond committed
25
;;; Commentary:
David Lawrence's avatar
David Lawrence committed
26

27 28
;;; Usage:
;;
29
;; The `C-x C-k e' (`edit-kbd-macro') command edits a keyboard macro
30 31 32
;; in a special buffer.  It prompts you to type a key sequence,
;; which should be one of:
;;
33
;;  * RET or `C-x e' (call-last-kbd-macro), to edit the most
34 35 36 37 38
;;    recently defined keyboard macro.
;;
;;  * `M-x' followed by a command name, to edit a named command
;;    whose definition is a keyboard macro.
;;
39
;;  * `C-h l' (view-lossage), to edit the 300 most recent keystrokes
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
;;    and install them as the "current" macro.
;;
;;  * any key sequence whose definition is a keyboard macro.
;;
;; This file includes a version of `insert-kbd-macro' that uses the
;; more readable format defined by these routines.
;;
;; Also, the `read-kbd-macro' command parses the region as
;; a keyboard macro, and installs it as the "current" macro.
;; This and `format-kbd-macro' can also be called directly as
;; Lisp functions.

;; Type `C-h m', or see the documentation for `edmacro-mode' below,
;; for information about the format of written keyboard macros.

;; `edit-kbd-macro' formats the macro with one command per line,
;; including the command names as comments on the right.  If the
;; formatter gets confused about which keymap was used for the
;; characters, the command-name comments will be wrong but that
;; won't hurt anything.

;; With a prefix argument, `edit-kbd-macro' will format the
;; macro in a more concise way that omits the comments.

Eric S. Raymond's avatar
Eric S. Raymond committed
64
;;; Code:
65

66
(require 'cl-lib)
67 68
(require 'kmacro)

David Lawrence's avatar
David Lawrence committed
69 70
;;; The user-level commands for editing macros.

Glenn Morris's avatar
Glenn Morris committed
71 72 73 74 75
(defcustom edmacro-eight-bits nil
  "Non-nil if `edit-kbd-macro' should leave 8-bit characters intact.
Default nil means to write characters above \\177 in octal notation."
  :type 'boolean
  :group 'kmacro)
76

77 78 79 80 81
(defvar edmacro-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map "\C-c\C-c" 'edmacro-finish-edit)
    (define-key map "\C-c\C-q" 'edmacro-insert-key)
    map))
82

83 84 85 86
(defvar edmacro-store-hook)
(defvar edmacro-finish-hook)
(defvar edmacro-original-buffer)

Jim Blandy's avatar
Jim Blandy committed
87
;;;###autoload
88 89 90 91
(defun edit-kbd-macro (keys &optional prefix finish-hook store-hook)
  "Edit a keyboard macro.
At the prompt, type any key sequence which is bound to a keyboard macro.
Or, type `C-x e' or RET to edit the last keyboard macro, `C-h l' to edit
92
the last 300 keystrokes as a keyboard macro, or `M-x' to edit a macro by
93 94 95 96 97
its command name.
With a prefix argument, format the macro in a more concise way."
  (interactive "kKeyboard macro to edit (C-x e, M-x, C-h l, or keys): \nP")
  (when keys
    (let ((cmd (if (arrayp keys) (key-binding keys) keys))
98 99
	  (mac nil) (mac-counter nil) (mac-format nil)
	  kmacro)
100 101 102
      (cond (store-hook
	     (setq mac keys)
	     (setq cmd nil))
103
	    ((or (memq cmd '(call-last-kbd-macro kmacro-call-macro
104
			     kmacro-end-or-call-macro kmacro-end-and-call-macro))
105 106 107 108 109
		 (member keys '("\r" [return])))
	     (or last-kbd-macro
		 (y-or-n-p "No keyboard macro defined.  Create one? ")
		 (keyboard-quit))
	     (setq mac (or last-kbd-macro ""))
110
	     (setq keys nil)
111 112 113
	     (setq cmd 'last-kbd-macro))
	    ((eq cmd 'execute-extended-command)
	     (setq cmd (read-command "Name of keyboard macro to edit: "))
114 115
	     (if (string-equal cmd "")
		 (error "No command name given"))
116
	     (setq keys nil)
117
	     (setq mac (symbol-function cmd)))
118
	    ((memq cmd '(view-lossage electric-view-lossage))
119
	     (setq mac (recent-keys))
120
	     (setq keys nil)
121
	     (setq cmd 'last-kbd-macro))
122 123
	    ((null cmd)
	     (error "Key sequence %s is not defined" (key-description keys)))
124 125 126 127 128
	    ((symbolp cmd)
	     (setq mac (symbol-function cmd)))
	    (t
	     (setq mac cmd)
	     (setq cmd nil)))
129 130 131 132
      (when (setq kmacro (kmacro-extract-lambda mac))
	(setq mac (car kmacro)
	      mac-counter (nth 1 kmacro)
	      mac-format (nth 2 kmacro)))
133
      (unless (arrayp mac)
134 135
	(error "Key sequence %s is not a keyboard macro"
	       (key-description keys)))
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
      (message "Formatting keyboard macro...")
      (let* ((oldbuf (current-buffer))
	     (mmac (edmacro-fix-menu-commands mac))
	     (fmt (edmacro-format-keys mmac 1))
	     (fmtv (edmacro-format-keys mmac (not prefix)))
	     (buf (get-buffer-create "*Edit Macro*")))
	(message "Formatting keyboard macro...done")
	(switch-to-buffer buf)
	(kill-all-local-variables)
	(use-local-map edmacro-mode-map)
	(setq buffer-read-only nil)
	(setq major-mode 'edmacro-mode)
	(setq mode-name "Edit Macro")
	(set (make-local-variable 'edmacro-original-buffer) oldbuf)
	(set (make-local-variable 'edmacro-finish-hook) finish-hook)
	(set (make-local-variable 'edmacro-store-hook) store-hook)
	(erase-buffer)
	(insert ";; Keyboard Macro Editor.  Press C-c C-c to finish; "
		"press C-x k RET to cancel.\n")
	(insert ";; Original keys: " fmt "\n")
	(unless store-hook
	  (insert "\nCommand: " (if cmd (symbol-name cmd) "none") "\n")
158 159 160 161 162 163 164 165 166
	  (let ((gkeys (where-is-internal (or cmd mac) '(keymap))))
	    (if (and keys (not (member keys gkeys)))
		(setq gkeys (cons keys gkeys)))
	    (if gkeys
		(while gkeys
		  (insert "Key: " (edmacro-format-keys (pop gkeys) 1) "\n"))
	      (insert "Key: none\n")))
	  (when (and mac-counter mac-format)
	    (insert (format "Counter: %d\nFormat: \"%s\"\n" mac-counter mac-format))))
167 168 169 170 171 172 173 174 175 176 177 178 179
	(insert "\nMacro:\n\n")
	(save-excursion
	  (insert fmtv "\n"))
	(recenter '(4))
	(when (eq mac mmac)
	  (set-buffer-modified-p nil))
	(run-hooks 'edmacro-format-hook)))))

;;; The next two commands are provided for convenience and backward
;;; compatibility.

;;;###autoload
(defun edit-last-kbd-macro (&optional prefix)
David Lawrence's avatar
David Lawrence committed
180 181
  "Edit the most recently defined keyboard macro."
  (interactive "P")
182
  (edit-kbd-macro 'call-last-kbd-macro prefix))
David Lawrence's avatar
David Lawrence committed
183

Jim Blandy's avatar
Jim Blandy committed
184
;;;###autoload
185 186 187 188
(defun edit-named-kbd-macro (&optional prefix)
  "Edit a keyboard macro which has been given a name by `name-last-kbd-macro'."
  (interactive "P")
  (edit-kbd-macro 'execute-extended-command prefix))
David Lawrence's avatar
David Lawrence committed
189

Jim Blandy's avatar
Jim Blandy committed
190
;;;###autoload
191
(defun read-kbd-macro (start &optional end)
David Lawrence's avatar
David Lawrence committed
192
  "Read the region as a keyboard macro definition.
193
The region is interpreted as spelled-out keystrokes, e.g., \"M-x abc RET\".
194 195
See documentation for `edmacro-mode' for details.
Leading/trailing \"C-x (\" and \"C-x )\" in the text are allowed and ignored.
David Lawrence's avatar
David Lawrence committed
196 197
The resulting macro is installed as the \"current\" keyboard macro.

198 199 200 201
In Lisp, may also be called with a single STRING argument in which case
the result is returned rather than being installed as the current macro.
The result will be a string if possible, otherwise an event vector.
Second argument NEED-VECTOR means to return an event vector always."
David Lawrence's avatar
David Lawrence committed
202
  (interactive "r")
203 204 205
  (if (stringp start)
      (edmacro-parse-keys start end)
    (setq last-kbd-macro (edmacro-parse-keys (buffer-substring start end)))))
David Lawrence's avatar
David Lawrence committed
206

207 208 209 210 211 212 213 214 215
;;;###autoload
(defun format-kbd-macro (&optional macro verbose)
  "Return the keyboard macro MACRO as a human-readable string.
This string is suitable for passing to `read-kbd-macro'.
Second argument VERBOSE means to put one command per line with comments.
If VERBOSE is `1', put everything on one line.  If VERBOSE is omitted
or nil, use a compact 80-column format."
  (and macro (symbolp macro) (setq macro (symbol-function macro)))
  (edmacro-format-keys (or macro last-kbd-macro) verbose))
David Lawrence's avatar
David Lawrence committed
216

217
;;; Commands for *Edit Macro* buffer.
David Lawrence's avatar
David Lawrence committed
218 219 220

(defun edmacro-finish-edit ()
  (interactive)
221 222 223 224 225
  (unless (eq major-mode 'edmacro-mode)
    (error
     "This command is valid only in buffers created by `edit-kbd-macro'"))
  (run-hooks 'edmacro-finish-hook)
  (let ((cmd nil) (keys nil) (no-keys nil)
226
	(mac-counter nil) (mac-format nil)
227 228 229 230 231 232 233 234 235 236 237
	(top (point-min)))
    (goto-char top)
    (let ((case-fold-search nil))
      (while (cond ((looking-at "[ \t]*\\($\\|;;\\|REM[ \t\n]\\)")
		    t)
		   ((looking-at "Command:[ \t]*\\([^ \t\n]*\\)[ \t]*$")
		    (when edmacro-store-hook
		      (error "\"Command\" line not allowed in this context"))
		    (let ((str (buffer-substring (match-beginning 1)
						 (match-end 1))))
		      (unless (equal str "")
238
			(setq cmd (and (not (equal str "none"))
239 240
				       (intern str)))
			(and (fboundp cmd) (not (arrayp (symbol-function cmd)))
241
			     (not (get cmd 'kmacro))
242 243 244 245 246 247 248 249 250 251 252 253
			     (not (y-or-n-p
				   (format "Command %s is already defined; %s"
					   cmd "proceed? ")))
			     (keyboard-quit))))
		    t)
		   ((looking-at "Key:\\(.*\\)$")
		    (when edmacro-store-hook
		      (error "\"Key\" line not allowed in this context"))
		    (let ((key (edmacro-parse-keys
				(buffer-substring (match-beginning 1)
						  (match-end 1)))))
		      (unless (equal key "")
254
			(if (equal key "none")
255 256 257 258
			    (setq no-keys t)
			  (push key keys)
			  (let ((b (key-binding key)))
			    (and b (commandp b) (not (arrayp b))
259
				 (not (kmacro-extract-lambda b))
260
				 (or (not (fboundp b))
261 262
				     (not (or (arrayp (symbol-function b))
					      (get b 'kmacro))))
263 264 265 266 267 268
				 (not (y-or-n-p
				       (format "Key %s is already defined; %s"
					       (edmacro-format-keys key 1)
					       "proceed? ")))
				 (keyboard-quit))))))
		    t)
269 270 271 272 273 274
		   ((looking-at "Counter:[ \t]*\\([^ \t\n]*\\)[ \t]*$")
		    (when edmacro-store-hook
		      (error "\"Counter\" line not allowed in this context"))
		    (let ((str (buffer-substring (match-beginning 1)
						 (match-end 1))))
		      (unless (equal str "")
275
			(setq mac-counter (string-to-number str))))
276 277 278 279 280 281 282 283 284
		    t)
		   ((looking-at "Format:[ \t]*\"\\([^\n]*\\)\"[ \t]*$")
		    (when edmacro-store-hook
		      (error "\"Format\" line not allowed in this context"))
		    (let ((str (buffer-substring (match-beginning 1)
						 (match-end 1))))
		      (unless (equal str "")
			(setq mac-format str)))
		    t)
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
		   ((looking-at "Macro:[ \t\n]*")
		    (goto-char (match-end 0))
		    nil)
		   ((eobp) nil)
		   (t (error "Expected a `Macro:' line")))
	(forward-line 1))
      (setq top (point)))
    (let* ((buf (current-buffer))
	   (str (buffer-substring top (point-max)))
	   (modp (buffer-modified-p))
	   (obuf edmacro-original-buffer)
	   (store-hook edmacro-store-hook)
	   (finish-hook edmacro-finish-hook))
      (unless (or cmd keys store-hook (equal str ""))
	(error "No command name or keys specified"))
      (when modp
	(when (buffer-name obuf)
	  (set-buffer obuf))
	(message "Compiling keyboard macro...")
	(let ((mac (edmacro-parse-keys str)))
	  (message "Compiling keyboard macro...done")
	  (if store-hook
	      (funcall store-hook mac)
	    (when (eq cmd 'last-kbd-macro)
	      (setq last-kbd-macro (and (> (length mac) 0) mac))
	      (setq cmd nil))
	    (when cmd
	      (if (= (length mac) 0)
		  (fmakunbound cmd)
314 315 316 317
		(fset cmd
		      (if (and mac-counter mac-format)
			  (kmacro-lambda-form mac mac-counter mac-format)
			mac))))
318 319
	    (if no-keys
		(when cmd
Stefan Monnier's avatar
Stefan Monnier committed
320 321
		  (cl-loop for key in (where-is-internal cmd '(keymap)) do
                           (global-unset-key key)))
322 323
	      (when keys
		(if (= (length mac) 0)
Stefan Monnier's avatar
Stefan Monnier committed
324 325 326 327 328 329 330 331
		    (cl-loop for key in keys do (global-unset-key key))
		  (cl-loop for key in keys do
                           (global-set-key key
                                           (or cmd
                                               (if (and mac-counter mac-format)
                                                   (kmacro-lambda-form
                                                    mac mac-counter mac-format)
                                                 mac))))))))))
332 333 334 335 336 337 338 339 340 341 342 343
      (kill-buffer buf)
      (when (buffer-name obuf)
	(switch-to-buffer obuf))
      (when finish-hook
	(funcall finish-hook)))))

(defun edmacro-insert-key (key)
  "Insert the written name of a key in the buffer."
  (interactive "kKey to insert: ")
  (if (bolp)
      (insert (edmacro-format-keys key t) "\n")
    (insert (edmacro-format-keys key) " ")))
David Lawrence's avatar
David Lawrence committed
344 345

(defun edmacro-mode ()
346
  "\\<edmacro-mode-map>Keyboard Macro Editing mode.  Press \
347
\\[edmacro-finish-edit] to save and exit.
348
To abort the edit, just kill this buffer with \\[kill-buffer] RET.
David Lawrence's avatar
David Lawrence committed
349

350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
Press \\[edmacro-insert-key] to insert the name of any key by typing the key.

The editing buffer contains a \"Command:\" line and any number of
\"Key:\" lines at the top.  These are followed by a \"Macro:\" line
and the macro itself as spelled-out keystrokes: `C-x C-f foo RET'.

The \"Command:\" line specifies the command name to which the macro
is bound, or \"none\" for no command name.  Write \"last-kbd-macro\"
to refer to the current keyboard macro (as used by \\[call-last-kbd-macro]).

The \"Key:\" lines specify key sequences to which the macro is bound,
or \"none\" for no key bindings.

You can edit these lines to change the places where the new macro
is stored.


Format of keyboard macros during editing:

Text is divided into \"words\" separated by whitespace.  Except for
the words described below, the characters of each word go directly
as characters of the macro.  The whitespace that separates words
is ignored.  Whitespace in the macro must be written explicitly,
as in \"foo SPC bar RET\".

 * The special words RET, SPC, TAB, DEL, LFD, ESC, and NUL represent
   special control characters.  The words must be written in uppercase.

 * A word in angle brackets, e.g., <return>, <down>, or <f1>, represents
   a function key.  (Note that in the standard configuration, the
   function key <return> and the control key RET are synonymous.)
   You can use angle brackets on the words RET, SPC, etc., but they
   are not required there.

 * Keys can be written by their ASCII code, using a backslash followed
   by up to six octal digits.  This is the only way to represent keys
   with codes above \\377.

 * One or more prefixes M- (meta), C- (control), S- (shift), A- (alt),
   H- (hyper), and s- (super) may precede a character or key notation.
   For function keys, the prefixes may go inside or outside of the
   brackets:  C-<down> = <C-down>.  The prefixes may be written in
   any order:  M-C-x = C-M-x.

   Prefixes are not allowed on multi-key words, e.g., C-abc, except
   that the Meta prefix is allowed on a sequence of digits and optional
   minus sign:  M--123 = M-- M-1 M-2 M-3.

 * The `^' notation for control characters also works:  ^M = C-m.

 * Double angle brackets enclose command names:  <<next-line>> is
   shorthand for M-x next-line RET.

 * Finally, REM or ;; causes the rest of the line to be ignored as a
   comment.

Any word may be prefixed by a multiplier in the form of a decimal
number and `*':  3*<right> = <right> <right> <right>, and
10*foo = foofoofoofoofoofoofoofoofoofoo.

Multiple text keys can normally be strung together to form a word,
but you may need to add whitespace if the word would look like one
of the above notations:  `; ; ;' is a keyboard macro with three
semicolons, but `;;;' is a comment.  Likewise, `\\ 1 2 3' is four
keys but `\\123' is a single key written in octal, and `< right >'
is seven keys but `<right>' is a single function key.  When in
doubt, use whitespace."
David Lawrence's avatar
David Lawrence committed
417
  (interactive)
418
  (error "This mode can be enabled only by `edit-kbd-macro'"))
David Lawrence's avatar
David Lawrence committed
419
(put 'edmacro-mode 'mode-class 'special)
420 421

;;; Formatting a keyboard macro as human-readable text.
David Lawrence's avatar
David Lawrence committed
422

423 424
(defun edmacro-format-keys (macro &optional verbose)
  (setq macro (edmacro-fix-menu-commands macro))
425
  (let* ((maps (current-active-maps))
426 427 428 429 430 431 432 433 434 435 436 437 438
	 (pkeys '(end-macro ?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9 ?- ?\C-u
		  ?\M-- ?\M-0 ?\M-1 ?\M-2 ?\M-3 ?\M-4 ?\M-5 ?\M-6
		  ?\M-7 ?\M-8 ?\M-9))
	 (mdigs (nthcdr 13 pkeys))
	 (maxkey (if edmacro-eight-bits 255 127))
	 (case-fold-search nil)
	 (res-words '("NUL" "TAB" "LFD" "RET" "ESC" "SPC" "DEL" "REM"))
	 (rest-mac (vconcat macro [end-macro]))
	 (res "")
	 (len 0)
	 (one-line (eq verbose 1)))
    (if one-line (setq verbose nil))
    (when (stringp macro)
Stefan Monnier's avatar
Stefan Monnier committed
439 440 441
      (cl-loop for i below (length macro) do
               (when (>= (aref rest-mac i) 128)
                 (cl-incf (aref rest-mac i) (- ?\M-\^@ 128)))))
442 443 444 445
    (while (not (eq (aref rest-mac 0) 'end-macro))
      (let* ((prefix
	      (or (and (integerp (aref rest-mac 0))
		       (memq (aref rest-mac 0) mdigs)
446
		       (memq (key-binding (cl-subseq rest-mac 0 1))
447 448 449
			     '(digit-argument negative-argument))
		       (let ((i 1))
			 (while (memq (aref rest-mac i) (cdr mdigs))
Stefan Monnier's avatar
Stefan Monnier committed
450
			   (cl-incf i))
451
			 (and (not (memq (aref rest-mac i) pkeys))
452 453
			      (prog1 (vconcat "M-" (cl-subseq rest-mac 0 i) " ")
				(cl-callf cl-subseq rest-mac i)))))
454 455 456 457
		  (and (eq (aref rest-mac 0) ?\C-u)
		       (eq (key-binding [?\C-u]) 'universal-argument)
		       (let ((i 1))
			 (while (eq (aref rest-mac i) ?\C-u)
Stefan Monnier's avatar
Stefan Monnier committed
458
			   (cl-incf i))
459
			 (and (not (memq (aref rest-mac i) pkeys))
Stefan Monnier's avatar
Stefan Monnier committed
460
			      (prog1 (cl-loop repeat i concat "C-u ")
461
				(cl-callf cl-subseq rest-mac i)))))
462 463 464 465
		  (and (eq (aref rest-mac 0) ?\C-u)
		       (eq (key-binding [?\C-u]) 'universal-argument)
		       (let ((i 1))
			 (when (eq (aref rest-mac i) ?-)
Stefan Monnier's avatar
Stefan Monnier committed
466
			   (cl-incf i))
467 468
			 (while (memq (aref rest-mac i)
				      '(?0 ?1 ?2 ?3 ?4 ?5 ?6 ?7 ?8 ?9))
Stefan Monnier's avatar
Stefan Monnier committed
469
			   (cl-incf i))
470
			 (and (not (memq (aref rest-mac i) pkeys))
471 472
			      (prog1 (vconcat "C-u " (cl-subseq rest-mac 1 i) " ")
				(cl-callf cl-subseq rest-mac i)))))))
473
	     (bind-len (apply 'max 1
Stefan Monnier's avatar
Stefan Monnier committed
474 475 476
			      (cl-loop for map in maps
                                       for b = (lookup-key map rest-mac)
                                       when b collect b)))
477
	     (key (cl-subseq rest-mac 0 bind-len))
478
	     (fkey nil) tlen tkey
Stefan Monnier's avatar
Stefan Monnier committed
479 480
	     (bind (or (cl-loop for map in maps for b = (lookup-key map key)
                                thereis (and (not (integerp b)) b))
481
		       (and (setq fkey (lookup-key local-function-key-map rest-mac))
482
			    (setq tlen fkey tkey (cl-subseq rest-mac 0 tlen)
483
				  fkey (lookup-key local-function-key-map tkey))
Stefan Monnier's avatar
Stefan Monnier committed
484 485 486 487 488 489
			    (cl-loop for map in maps
                                     for b = (lookup-key map fkey)
                                     when (and (not (integerp b)) b)
                                     do (setq bind-len tlen key tkey)
                                     and return b
                                     finally do (setq fkey nil)))))
490
	     (first (aref key 0))
Stefan Monnier's avatar
Stefan Monnier committed
491 492 493 494 495 496 497 498 499 500 501
	     (text
              (cl-loop for i from bind-len below (length rest-mac)
                       for ch = (aref rest-mac i)
                       while (and (integerp ch)
                                  (> ch 32) (< ch maxkey) (/= ch 92)
                                  (eq (key-binding (char-to-string ch))
                                      'self-insert-command)
                                  (or (> i (- (length rest-mac) 2))
                                      (not (eq ch (aref rest-mac (+ i 1))))
                                      (not (eq ch (aref rest-mac (+ i 2))))))
                       finally return i))
502 503 504 505 506 507 508
	     desc)
	(if (stringp bind) (setq bind nil))
	(cond ((and (eq bind 'self-insert-command) (not prefix)
		    (> text 1) (integerp first)
		    (> first 32) (<= first maxkey) (/= first 92)
		    (progn
		      (if (> text 30) (setq text 30))
509
		      (setq desc (concat (cl-subseq rest-mac 0 text)))
510 511
		      (when (string-match "^[ACHMsS]-." desc)
			(setq text 2)
Stefan Monnier's avatar
Stefan Monnier committed
512
			(cl-callf substring desc 0 2))
513 514 515 516 517 518 519 520 521 522 523 524 525
		      (not (string-match
			    "^;;\\|^<.*>$\\|^\\\\[0-9]+$\\|^[0-9]+\\*."
			    desc))))
	       (when (or (string-match "^\\^.$" desc)
			 (member desc res-words))
		 (setq desc (mapconcat 'char-to-string desc " ")))
	       (when verbose
		 (setq bind (format "%s * %d" bind text)))
	       (setq bind-len text))
	      ((and (eq bind 'execute-extended-command)
		    (> text bind-len)
		    (memq (aref rest-mac text) '(return 13))
		    (progn
526
		      (setq desc (concat (cl-subseq rest-mac bind-len text)))
527 528 529 530 531 532 533 534 535 536 537
		      (commandp (intern-soft desc))))
	       (if (commandp (intern-soft desc)) (setq bind desc))
	       (setq desc (format "<<%s>>" desc))
	       (setq bind-len (1+ text)))
	      (t
	       (setq desc (mapconcat
			   (function
			    (lambda (ch)
			      (cond
			       ((integerp ch)
				(concat
Stefan Monnier's avatar
Stefan Monnier committed
538 539 540 541 542
				 (cl-loop for pf across "ACHMsS"
                                          for bit in '(?\A-\^@ ?\C-\^@ ?\H-\^@
                                                       ?\M-\^@ ?\s-\^@ ?\S-\^@)
                                          when (/= (logand ch bit) 0)
                                          concat (format "%c-" pf))
543 544
				 (let ((ch2 (logand ch (1- (lsh 1 18)))))
				   (cond ((<= ch2 32)
Stefan Monnier's avatar
Stefan Monnier committed
545
					  (pcase ch2
546 547
					    (0 "NUL") (9 "TAB") (10 "LFD")
					    (13 "RET") (27 "ESC") (32 "SPC")
Stefan Monnier's avatar
Stefan Monnier committed
548
					    (_
549 550 551 552 553 554 555 556 557 558 559
					     (format "C-%c"
						     (+ (if (<= ch2 26) 96 64)
							ch2)))))
					 ((= ch2 127) "DEL")
					 ((<= ch2 maxkey) (char-to-string ch2))
					 (t (format "\\%o" ch2))))))
			       ((symbolp ch)
				(format "<%s>" ch))
			       (t
				(error "Unrecognized item in macro: %s" ch)))))
			   (or fkey key) " "))))
Kenichi Handa's avatar
Kenichi Handa committed
560 561
	(if prefix
	    (setq desc (concat (edmacro-sanitize-for-string prefix) desc)))
562 563
	(unless (string-match " " desc)
	  (let ((times 1) (pos bind-len))
564
	    (while (not (cl-mismatch rest-mac rest-mac
565 566
				     :start1 0 :end1 bind-len
				     :start2 pos :end2 (+ bind-len pos)))
Stefan Monnier's avatar
Stefan Monnier committed
567 568
	      (cl-incf times)
	      (cl-incf pos bind-len))
569 570 571
	    (when (> times 1)
	      (setq desc (format "%d*%s" times desc))
	      (setq bind-len (* bind-len times)))))
572
	(setq rest-mac (cl-subseq rest-mac bind-len))
573 574
	(if verbose
	    (progn
Stefan Monnier's avatar
Stefan Monnier committed
575 576
	      (unless (equal res "") (cl-callf concat res "\n"))
	      (cl-callf concat res desc)
577
	      (when (and bind (or (stringp bind) (symbolp bind)))
Stefan Monnier's avatar
Stefan Monnier committed
578
		(cl-callf concat res
579 580 581 582 583
		  (make-string (max (- 3 (/ (length desc) 8)) 1) 9)
		  ";; " (if (stringp bind) bind (symbol-name bind))))
	      (setq len 0))
	  (if (and (> (+ len (length desc) 2) 72) (not one-line))
	      (progn
Stefan Monnier's avatar
Stefan Monnier committed
584
		(cl-callf concat res "\n ")
585 586
		(setq len 1))
	    (unless (equal res "")
Stefan Monnier's avatar
Stefan Monnier committed
587 588 589 590
	      (cl-callf concat res " ")
	      (cl-incf len)))
	  (cl-callf concat res desc)
	  (cl-incf len (length desc)))))
591 592
    res))

Kenichi Handa's avatar
Kenichi Handa committed
593
(defun edmacro-sanitize-for-string (seq)
594
  "Convert a key sequence vector SEQ into a string.
Kenichi Handa's avatar
Kenichi Handa committed
595 596 597
The string represents the same events; Meta is indicated by bit 7.
This function assumes that the events can be stored in a string."
  (setq seq (copy-sequence seq))
Stefan Monnier's avatar
Stefan Monnier committed
598 599 600
  (cl-loop for i below (length seq) do
           (when (logand (aref seq i) 128)
             (setf (aref seq i) (logand (aref seq i) 127))))
Kenichi Handa's avatar
Kenichi Handa committed
601 602
  seq)

603 604 605 606 607 608 609 610 611
(defun edmacro-fix-menu-commands (macro &optional noerror)
  (if (vectorp macro)
      (let (result)
	;; Make a list of the elements.
	(setq macro (append macro nil))
	(dolist (ev macro)
	  (cond ((atom ev)
		 (push ev result))
		((eq (car ev) 'help-echo))
612
		((eq (car ev) 'switch-frame))
613 614
		((equal ev '(menu-bar))
		 (push 'menu-bar result))
615
		((equal (cadadr ev) '(menu-bar))
616
		 (push (vector 'menu-bar (car ev)) result))
617 618
		;; It would be nice to do pop-up menus, too, but not enough
		;; info is recorded in macros to make this possible.
619 620 621
		(noerror
		 ;; Just ignore mouse events.
		 nil)
622 623 624
		(t
		 (error "Macros with mouse clicks are not %s"
			"supported by this command"))))
625 626 627
	;; Reverse them again and make them back into a vector.
	(vconcat (nreverse result)))
    macro))
628 629 630 631 632

;;; Parsing a human-readable keyboard macro.

(defun edmacro-parse-keys (string &optional need-vector)
  (let ((case-fold-search nil)
633
	(len (length string)) ; We won't alter string in the loop below.
634 635
	(pos 0)
	(res []))
636
    (while (and (< pos len)
637
		(string-match "[^ \t\n\f]+" string pos))
638 639 640 641 642 643
      (let* ((word-beg (match-beginning 0))
	     (word-end (match-end 0))
	     (word (substring string word-beg len))
	     (times 1)
	     key)
	;; Try to catch events of the form "<as df>".
644
	(if (string-match "\\`<[^ <>\t\n\f][^>\t\n\f]*>" word)
645 646 647 648
	    (setq word (match-string 0 word)
		  pos (+ word-beg (match-end 0)))
	  (setq word (substring string word-beg word-end)
		pos word-end))
649
	(when (string-match "\\([0-9]+\\)\\*." word)
650
	  (setq times (string-to-number (substring word 0 (match-end 1))))
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
	  (setq word (substring word (1+ (match-end 1)))))
	(cond ((string-match "^<<.+>>$" word)
	       (setq key (vconcat (if (eq (key-binding [?\M-x])
					  'execute-extended-command)
				      [?\M-x]
				    (or (car (where-is-internal
					      'execute-extended-command))
					[?\M-x]))
				  (substring word 2 -2) "\r")))
	      ((and (string-match "^\\(\\([ACHMsS]-\\)*\\)<\\(.+\\)>$" word)
		    (progn
		      (setq word (concat (substring word (match-beginning 1)
						    (match-end 1))
					 (substring word (match-beginning 3)
						    (match-end 3))))
		      (not (string-match
			    "\\<\\(NUL\\|RET\\|LFD\\|ESC\\|SPC\\|DEL\\)$"
			    word))))
	       (setq key (list (intern word))))
	      ((or (equal word "REM") (string-match "^;;" word))
	       (setq pos (string-match "$" string pos)))
	      (t
	       (let ((orig-word word) (prefix 0) (bits 0))
		 (while (string-match "^[ACHMsS]-." word)
Stefan Monnier's avatar
Stefan Monnier committed
675
		   (cl-incf bits (cdr (assq (aref word 0)
676 677 678
					 '((?A . ?\A-\^@) (?C . ?\C-\^@)
					   (?H . ?\H-\^@) (?M . ?\M-\^@)
					   (?s . ?\s-\^@) (?S . ?\S-\^@)))))
Stefan Monnier's avatar
Stefan Monnier committed
679 680
		   (cl-incf prefix 2)
		   (cl-callf substring word 2))
681
		 (when (string-match "^\\^.$" word)
Stefan Monnier's avatar
Stefan Monnier committed
682 683 684
		   (cl-incf bits ?\C-\^@)
		   (cl-incf prefix)
		   (cl-callf substring word 1))
685 686 687 688 689 690
		 (let ((found (assoc word '(("NUL" . "\0") ("RET" . "\r")
					    ("LFD" . "\n") ("TAB" . "\t")
					    ("ESC" . "\e") ("SPC" . " ")
					    ("DEL" . "\177")))))
		   (when found (setq word (cdr found))))
		 (when (string-match "^\\\\[0-7]+$" word)
Stefan Monnier's avatar
Stefan Monnier committed
691 692 693
		   (cl-loop for ch across word
                            for n = 0 then (+ (* n 8) ch -48)
                            finally do (setq word (vector n))))
694 695
		 (cond ((= bits 0)
			(setq key word))
696
		       ((and (= bits ?\M-\^@) (stringp word)
697
			     (string-match "^-?[0-9]+$" word))
Stefan Monnier's avatar
Stefan Monnier committed
698 699
			(setq key (cl-loop for x across word
                                           collect (+ x bits))))
700 701 702
		       ((/= (length word) 1)
			(error "%s must prefix a single character, not %s"
			       (substring orig-word 0 prefix) word))
703
		       ((and (/= (logand bits ?\C-\^@) 0) (stringp word)
704 705 706 707
			     ;; We used to accept . and ? here,
			     ;; but . is simply wrong,
			     ;; and C-? is not used (we use DEL instead).
			     (string-match "[@-_a-z]" word))
708
			(setq key (list (+ bits (- ?\C-\^@)
709
					   (logand (aref word 0) 31)))))
710 711 712
		       (t
			(setq key (list (+ bits (aref word 0)))))))))
	(when key
Stefan Monnier's avatar
Stefan Monnier committed
713
	  (cl-loop repeat times do (cl-callf vconcat res key)))))
714 715 716 717 718
    (when (and (>= (length res) 4)
	       (eq (aref res 0) ?\C-x)
	       (eq (aref res 1) ?\()
	       (eq (aref res (- (length res) 2)) ?\C-x)
	       (eq (aref res (- (length res) 1)) ?\)))
719
      (setq res (cl-subseq res 2 -2)))
720
    (if (and (not need-vector)
Stefan Monnier's avatar
Stefan Monnier committed
721 722 723 724 725 726 727
	     (cl-loop for ch across res
                      always (and (characterp ch)
                                  (let ((ch2 (logand ch (lognot ?\M-\^@))))
                                    (and (>= ch2 0) (<= ch2 127))))))
	(concat (cl-loop for ch across res
                         collect (if (= (logand ch ?\M-\^@) 0)
                                     ch (+ ch 128))))
728 729 730
      res)))

(provide 'edmacro)
Eric S. Raymond's avatar
Eric S. Raymond committed
731 732

;;; edmacro.el ends here