register.el 18.9 KB
Newer Older
1
;;; register.el --- register commands for Emacs      -*- lexical-binding: t; -*-
Eric S. Raymond's avatar
Eric S. Raymond committed
2

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

Eric S. Raymond's avatar
Eric S. Raymond committed
5
;; Maintainer: FSF
Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Keywords: internal
7
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Richard M. Stallman's avatar
Richard M. Stallman committed
9 10
;; This file is part of GNU Emacs.

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

;; 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
22
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
23

24 25 26 27 28 29 30
;;; Commentary:

;; This package of functions emulates and somewhat extends the venerable
;; TECO's `register' feature, which permits you to save various useful
;; pieces of buffer state to named variables.  The entry points are
;; documented in the Emacs user's manual.

Stefan Monnier's avatar
Stefan Monnier committed
31
(eval-when-compile (require 'cl-lib))
32

Eric S. Raymond's avatar
Eric S. Raymond committed
33
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
34

Stefan Monnier's avatar
Stefan Monnier committed
35
(cl-defstruct
36 37 38 39 40 41 42 43 44 45 46
  (registerv (:constructor nil)
	     (:constructor registerv--make (&optional data print-func
						      jump-func insert-func))
	     (:copier nil)
	     (:type vector)
	     :named)
  (data        nil :read-only t)
  (print-func  nil :read-only t)
  (jump-func   nil :read-only t)
  (insert-func nil :read-only t))

Stefan Monnier's avatar
Stefan Monnier committed
47
(cl-defun registerv-make (data &key print-func jump-func insert-func)
48 49 50 51 52
  "Create a register value object.

DATA can be any value.
PRINT-FUNC if provided controls how `list-registers' and
`view-register' print the register.  It should be a function
Juanma Barranquero's avatar
Juanma Barranquero committed
53
receiving one argument DATA and print text that completes
54 55 56 57 58 59 60
this sentence:
  Register X contains [TEXT PRINTED BY PRINT-FUNC]
JUMP-FUNC if provided, controls how `jump-to-register' jumps to the register.
INSERT-FUNC if provided, controls how `insert-register' insert the register.
They both receive DATA as argument."
  (registerv--make data print-func jump-func insert-func))

Richard M. Stallman's avatar
Richard M. Stallman committed
61 62
(defvar register-alist nil
  "Alist of elements (NAME . CONTENTS), one for each Emacs register.
63 64
NAME is a character (a number).  CONTENTS is a string, number, marker, list
or a struct returned by `registerv-make'.
65
A list of strings represents a rectangle.
66 67 68 69
A list of the form (file . FILE-NAME) represents the file named FILE-NAME.
A list of the form (file-query FILE-NAME POSITION) represents
 position POSITION in the file named FILE-NAME, but query before
 visiting it.
Karl Heuer's avatar
Karl Heuer committed
70 71 72
A list of the form (WINDOW-CONFIGURATION POSITION)
 represents a saved window configuration plus a saved value of point.
A list of the form (FRAME-CONFIGURATION POSITION)
73
 represents a saved frame configuration plus a saved value of point.")
Richard M. Stallman's avatar
Richard M. Stallman committed
74

75 76 77
(defgroup register nil
  "Register commands."
  :group 'convenience
78
  :version "24.3")
79

80 81
(defcustom register-separator nil
  "Register containing the text to put between collected texts, or nil if none.
82 83 84 85 86 87 88 89 90

When collecting text with
`append-to-register' (resp. `prepend-to-register') contents of
this register is added to the beginning (resp. end) of the marked
text."
  :group 'register
  :type '(choice (const :tag "None" nil)
		 (character :tag "Use register" :value ?+)))

91 92
(defcustom register-preview-delay 1
  "If non-nil delay in seconds to pop up the preview window."
93
  :version "24.4"
94 95 96
  :type '(choice number (const :tag "Indefinitely" nil))
  :group 'register)

97 98 99
(defun get-register (register)
  "Return contents of Emacs register named REGISTER, or nil if none."
  (cdr (assq register register-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
100

101 102
(defun set-register (register value)
  "Set contents of Emacs register named REGISTER to VALUE.  Returns VALUE.
103
See the documentation of the variable `register-alist' for possible VALUEs."
104
  (let ((aelt (assq register register-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
105 106
    (if aelt
	(setcdr aelt value)
Stefan Monnier's avatar
Stefan Monnier committed
107
      (push (cons register value) register-alist))
Richard M. Stallman's avatar
Richard M. Stallman committed
108 109
    value))

110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
(defun register-describe-oneline (c)
  "One-line description of register C."
  (let ((d (replace-regexp-in-string
            "\n[ \t]*" " "
            (with-output-to-string (describe-register-1 c)))))
    (if (string-match "Register.+? contains \\(?:an? \\|the \\)?" d)
        (substring d (match-end 0))
      d)))

(defvar register-preview-functions nil)

(defun register-preview (buffer &optional show-empty)
  "Pop up a window to show register preview in BUFFER.
If SHOW-EMPTY is non-nil show the window even if no registers."
  (when (or show-empty (consp register-alist))
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
    (with-temp-buffer-window
     buffer
     (cons 'display-buffer-below-selected
	   '((window-height . fit-window-to-buffer)))
     nil
     (with-current-buffer standard-output
       (setq cursor-in-non-selected-windows nil)
       (mapc
	(lambda (r)
	  (insert (or (run-hook-with-args-until-success
		       'register-preview-functions r)
		      (format "%s %s\n"
			      (concat (single-key-description (car r)) ":")
			      (register-describe-oneline (car r))))))
	register-alist)))))
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166

(defun register-read-with-preview (prompt)
  "Read an event with register preview using PROMPT.
Pop up a register preview window if the input is a help char but
is not a register. Alternatively if `register-preview-delay' is a
number the preview window is popped up after some delay."
  (let* ((buffer "*Register Preview*")
	 (timer (when (numberp register-preview-delay)
		  (run-with-timer register-preview-delay nil
				  (lambda ()
				    (unless (get-buffer-window buffer)
				      (register-preview buffer))))))
	 (help-chars (cl-loop for c in (cons help-char help-event-list)
			      when (not (get-register c))
			      collect c)))
    (unwind-protect
	(progn
	  (while (memq (read-event (propertize prompt 'face 'minibuffer-prompt))
		       help-chars)
	    (unless (get-buffer-window buffer)
	      (register-preview buffer 'show-empty)))
	  last-input-event)
      (and (timerp timer) (cancel-timer timer))
      (let ((w (get-buffer-window buffer)))
        (and (window-live-p w) (delete-window w)))
      (and (get-buffer buffer) (kill-buffer buffer)))))

167
(defun point-to-register (register &optional arg)
168
  "Store current location of point in register REGISTER.
Jim Blandy's avatar
Jim Blandy committed
169
With prefix argument, store current frame configuration.
170
Use \\[jump-to-register] to go to that location or restore that configuration.
Richard M. Stallman's avatar
Richard M. Stallman committed
171
Argument is a character, naming the register."
172 173
  (interactive (list (register-read-with-preview "Point to register: ")
		     current-prefix-arg))
Stefan Monnier's avatar
Stefan Monnier committed
174 175
  ;; Turn the marker into a file-ref if the buffer is killed.
  (add-hook 'kill-buffer-hook 'register-swap-out nil t)
176
  (set-register register
Karl Heuer's avatar
Karl Heuer committed
177 178
		(if arg (list (current-frame-configuration) (point-marker))
		  (point-marker))))
Richard M. Stallman's avatar
Richard M. Stallman committed
179

180
(defun window-configuration-to-register (register &optional _arg)
181 182 183
  "Store the window configuration of the selected frame in register REGISTER.
Use \\[jump-to-register] to restore the configuration.
Argument is a character, naming the register."
184 185 186
  (interactive (list (register-read-with-preview
		      "Window configuration to register: ")
		     current-prefix-arg))
187 188
  ;; current-window-configuration does not include the value
  ;; of point in the current buffer, so record that separately.
Karl Heuer's avatar
Karl Heuer committed
189
  (set-register register (list (current-window-configuration) (point-marker))))
190

191
(defun frame-configuration-to-register (register &optional _arg)
192 193 194
  "Store the window configuration of all frames in register REGISTER.
Use \\[jump-to-register] to restore the configuration.
Argument is a character, naming the register."
195 196 197
  (interactive (list (register-read-with-preview
		      "Frame configuration to register: ")
		     current-prefix-arg))
198 199
  ;; current-frame-configuration does not include the value
  ;; of point in the current buffer, so record that separately.
Karl Heuer's avatar
Karl Heuer committed
200
  (set-register register (list (current-frame-configuration) (point-marker))))
201

202
(defalias 'register-to-point 'jump-to-register)
203
(defun jump-to-register (register &optional delete)
Richard M. Stallman's avatar
Richard M. Stallman committed
204
  "Move point to location stored in a register.
205
If the register contains a file name, find that file.
206
\(To put a file name in a register, you must use `set-register'.)
207 208
If the register contains a window configuration (one frame) or a frameset
\(all frames), restore that frame or all frames accordingly.
209
First argument is a character, naming the register.
210
Optional second arg non-nil (interactively, prefix argument) says to
211
delete any existing frames that the frameset doesn't mention.
212
\(Otherwise, these frames are iconified.)"
213 214
  (interactive (list (register-read-with-preview "Jump to register: ")
		     current-prefix-arg))
215
  (let ((val (get-register register)))
216
    (cond
217
     ((registerv-p val)
Stefan Monnier's avatar
Stefan Monnier committed
218
      (cl-assert (registerv-jump-func val) nil
219 220 221
              "Don't know how to jump to register %s"
              (single-key-description register))
      (funcall (registerv-jump-func val) (registerv-data val)))
222 223 224 225 226 227
     ((and (consp val) (frame-configuration-p (car val)))
      (set-frame-configuration (car val) (not delete))
      (goto-char (cadr val)))
     ((and (consp val) (window-configuration-p (car val)))
      (set-window-configuration (car val))
      (goto-char (cadr val)))
228
     ((markerp val)
229 230
      (or (marker-buffer val)
	  (error "That register's buffer no longer exists"))
231 232
      (switch-to-buffer (marker-buffer val))
      (goto-char val))
233 234
     ((and (consp val) (eq (car val) 'file))
      (find-file (cdr val)))
235 236 237 238 239 240
     ((and (consp val) (eq (car val) 'file-query))
      (or (find-buffer-visiting (nth 1 val))
	  (y-or-n-p (format "Visit file %s again? " (nth 1 val)))
	  (error "Register access aborted"))
      (find-file (nth 1 val))
      (goto-char (nth 2 val)))
241 242
     (t
      (error "Register doesn't contain a buffer position or configuration")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
243

244
(defun register-swap-out ()
Stefan Monnier's avatar
Stefan Monnier committed
245
  "Turn markers into file-query references when a buffer is killed."
246
  (and buffer-file-name
Stefan Monnier's avatar
Stefan Monnier committed
247 248 249 250 251 252 253
       (dolist (elem register-alist)
	 (and (markerp (cdr elem))
	      (eq (marker-buffer (cdr elem)) (current-buffer))
	      (setcdr elem
		      (list 'file-query
			    buffer-file-name
			    (marker-position (cdr elem))))))))
254

255
(defun number-to-register (number register)
Karl Heuer's avatar
Karl Heuer committed
256 257
  "Store a number in a register.
Two args, NUMBER and REGISTER (a character, naming the register).
258 259
If NUMBER is nil, a decimal number is read from the buffer starting
at point, and point moves to the end of that number.
Karl Heuer's avatar
Karl Heuer committed
260
Interactively, NUMBER is the prefix arg (none means nil)."
261 262
  (interactive (list current-prefix-arg
		     (register-read-with-preview "Number to register: ")))
263
  (set-register register
264 265
		(if number
		    (prefix-numeric-value number)
266 267 268
		  (if (looking-at "\\s-*-?[0-9]+")
		      (progn
			(goto-char (match-end 0))
269
			(string-to-number (match-string 0)))
Karl Heuer's avatar
Karl Heuer committed
270 271
		    0))))

272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
(defun increment-register (prefix register)
  "Augment contents of REGISTER.
Interactively, PREFIX is in raw form.

If REGISTER contains a number, add `prefix-numeric-value' of
PREFIX to it.

If REGISTER is empty or if it contains text, call
`append-to-register' with `delete-flag' set to PREFIX."
  (interactive "P\ncIncrement register: ")
  (let ((register-val (get-register register)))
    (cond
     ((numberp register-val)
      (let ((number (prefix-numeric-value prefix)))
	(set-register register (+ number register-val))))
     ((or (not register-val) (stringp register-val))
      (append-to-register register (region-beginning) (region-end) prefix))
     (t (error "Register does not contain a number or text")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
290

291
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
292
  "Display what is contained in register named REGISTER.
293
The Lisp value REGISTER is a character."
294
  (interactive (list (register-read-with-preview "View register: ")))
295
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
296
    (if (null val)
297
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
298
      (with-output-to-temp-buffer "*Output*"
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
	(describe-register-1 register t)))))

(defun list-registers ()
  "Display a list of nonempty registers saying briefly what they contain."
  (interactive)
  (let ((list (copy-sequence register-alist)))
    (setq list (sort list (lambda (a b) (< (car a) (car b)))))
    (with-output-to-temp-buffer "*Output*"
      (dolist (elt list)
	(when (get-register (car elt))
	  (describe-register-1 (car elt))
	  (terpri))))))

(defun describe-register-1 (register &optional verbose)
  (princ "Register ")
  (princ (single-key-description register))
  (princ " contains ")
316 317
  (let ((val (get-register register)))
    (cond
318 319 320 321 322
     ((registerv-p val)
      (if (registerv-print-func val)
          (funcall (registerv-print-func val) (registerv-data val))
        (princ "[UNPRINTABLE CONTENTS].")))

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
     ((numberp val)
      (princ val))

     ((markerp val)
      (let ((buf (marker-buffer val)))
	(if (null buf)
	    (princ "a marker in no buffer")
	  (princ "a buffer position:\n    buffer ")
	  (princ (buffer-name buf))
	  (princ ", position ")
	  (princ (marker-position val)))))

     ((and (consp val) (window-configuration-p (car val)))
      (princ "a window configuration."))

     ((and (consp val) (frame-configuration-p (car val)))
      (princ "a frame configuration."))

     ((and (consp val) (eq (car val) 'file))
      (princ "the file ")
      (prin1 (cdr val))
      (princ "."))

     ((and (consp val) (eq (car val) 'file-query))
      (princ "a file-query reference:\n    file ")
      (prin1 (car (cdr val)))
      (princ ",\n    position ")
      (princ (car (cdr (cdr val))))
      (princ "."))

     ((consp val)
      (if verbose
	  (progn
	    (princ "the rectangle:\n")
	    (while val
	      (princ "    ")
	      (princ (car val))
	      (terpri)
	      (setq val (cdr val))))
	(princ "a rectangle starting with ")
	(princ (car val))))

     ((stringp val)
366
      (setq val (copy-sequence val))
367 368 369 370
      (if (eq yank-excluded-properties t)
	  (set-text-properties 0 (length val) nil val)
	(remove-list-of-text-properties 0 (length val)
					yank-excluded-properties val))
371 372 373 374
      (if verbose
	  (progn
	    (princ "the text:\n")
	    (princ val))
375
	(cond
376 377 378 379 380 381 382 383 384 385 386
	 ;; Extract first N characters starting with first non-whitespace.
	 ((string-match (format "[^ \t\n].\\{,%d\\}"
				;; Deduct 6 for the spaces inserted below.
				(min 20 (max 0 (- (window-width) 6))))
			val)
	  (princ "text starting with\n    ")
	  (princ (match-string 0 val)))
	 ((string-match "^[ \t\n]+$" val)
	  (princ "whitespace"))
	 (t
	  (princ "the empty string")))))
387 388 389
     (t
      (princ "Garbage:\n")
      (if verbose (prin1 val))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
390

391 392
(defun insert-register (register &optional arg)
  "Insert contents of register REGISTER.  (REGISTER is a character.)
Richard M. Stallman's avatar
Richard M. Stallman committed
393 394 395
Normally puts point before and mark after the inserted text.
If optional second arg is non-nil, puts mark before and point after.
Interactively, second arg is non-nil if prefix arg is supplied."
396 397
  (interactive (progn
		 (barf-if-buffer-read-only)
398 399
		 (list (register-read-with-preview "Insert register: ")
		       current-prefix-arg)))
Richard M. Stallman's avatar
Richard M. Stallman committed
400
  (push-mark)
401
  (let ((val (get-register register)))
402
    (cond
403
     ((registerv-p val)
Stefan Monnier's avatar
Stefan Monnier committed
404
      (cl-assert (registerv-insert-func val) nil
405 406 407
              "Don't know how to insert register %s"
              (single-key-description register))
      (funcall (registerv-insert-func val) (registerv-data val)))
408 409
     ((consp val)
      (insert-rectangle val))
410
     ((stringp val)
411
      (insert-for-yank val))
Karl Heuer's avatar
Karl Heuer committed
412
     ((numberp val)
413 414 415 416 417
      (princ val (current-buffer)))
     ((and (markerp val) (marker-position val))
      (princ (marker-position val) (current-buffer)))
     (t
      (error "Register does not contain text"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
418 419
  (if (not arg) (exchange-point-and-mark)))

420
(defun copy-to-register (register start end &optional delete-flag region)
421 422
  "Copy region into register REGISTER.
With prefix arg, delete as well.
423
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
424 425 426
START and END are buffer positions indicating what to copy.
The optional argument REGION if non-nil, indicates that we're not just copying
some text between START and END, but we're copying the region."
427 428 429
  (interactive (list (register-read-with-preview "Copy to register: ")
		     (region-beginning)
		     (region-end)
430 431 432 433 434 435
		     current-prefix-arg
		     t))
  (set-register register (if region
			     (funcall region-extract-function delete-flag)
			   (prog1 (filter-buffer-substring start end)
			     (if delete-flag (delete-region start end)))))
436
  (setq deactivate-mark t)
437
  (cond (delete-flag)
438 439
	((called-interactively-p 'interactive)
	 (indicate-copied-region))))
Richard M. Stallman's avatar
Richard M. Stallman committed
440

441 442 443 444
(defun append-to-register (register start end &optional delete-flag)
  "Append region to text in register REGISTER.
With prefix arg, delete as well.
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
445
START and END are buffer positions indicating what to append."
446 447 448 449
  (interactive (list (register-read-with-preview "Append to register: ")
		     (region-beginning)
		     (region-end)
		     current-prefix-arg))
450
  (let ((reg (get-register register))
451
        (text (filter-buffer-substring start end))
452
	(separator (and register-separator (get-register register-separator))))
453 454
    (set-register
     register (cond ((not reg) text)
455
                    ((stringp reg) (concat reg separator text))
456
                    (t (error "Register does not contain text")))))
457
  (setq deactivate-mark t)
458 459 460 461
  (cond (delete-flag
	 (delete-region start end))
	((called-interactively-p 'interactive)
	 (indicate-copied-region))))
Richard M. Stallman's avatar
Richard M. Stallman committed
462

463 464 465 466
(defun prepend-to-register (register start end &optional delete-flag)
  "Prepend region to text in register REGISTER.
With prefix arg, delete as well.
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
467
START and END are buffer positions indicating what to prepend."
468 469 470 471
  (interactive (list (register-read-with-preview "Prepend to register: ")
		     (region-beginning)
		     (region-end)
		     current-prefix-arg))
472
  (let ((reg (get-register register))
473
        (text (filter-buffer-substring start end))
474
	(separator (and register-separator (get-register register-separator))))
475 476
    (set-register
     register (cond ((not reg) text)
477
                    ((stringp reg) (concat text separator reg))
478
                    (t (error "Register does not contain text")))))
479
  (setq deactivate-mark t)
480 481 482 483
  (cond (delete-flag
	 (delete-region start end))
	((called-interactively-p 'interactive)
	 (indicate-copied-region))))
Richard M. Stallman's avatar
Richard M. Stallman committed
484

485 486
(defun copy-rectangle-to-register (register start end &optional delete-flag)
  "Copy rectangular region into register REGISTER.
487 488
With prefix arg, delete as well.
To insert this register in the buffer, use \\[insert-register].
489 490

Called from a program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
491
START and END are buffer positions giving two corners of rectangle."
492 493 494 495 496
  (interactive (list (register-read-with-preview
		      "Copy rectangle to register: ")
		     (region-beginning)
		     (region-end)
		     current-prefix-arg))
497 498 499 500 501 502 503 504 505
  (let ((rectangle (if delete-flag
		       (delete-extract-rectangle start end)
		     (extract-rectangle start end))))
    (set-register register rectangle)
    (when (and (null delete-flag)
	       (called-interactively-p 'interactive))
      (setq deactivate-mark t)
      (indicate-copied-region (length (car rectangle))))))

Masatake YAMATO's avatar
Masatake YAMATO committed
506
(provide 'register)
Eric S. Raymond's avatar
Eric S. Raymond committed
507
;;; register.el ends here