register.el 16.9 KB
Newer Older
1
;;; register.el --- register commands for Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

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

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

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

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman 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.
Richard M. Stallman's avatar
Richard M. Stallman 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/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24

25 26 27 28 29 30 31
;;; 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
32
(eval-when-compile (require 'cl-lib))
33

34 35 36 37 38 39
(declare-function frameset-frame-id "frameset" (frame))
(declare-function frameset-frame-with-id "frameset" (id &optional frame-list))
(declare-function frameset-p "frameset" (frameset))
(declare-function frameset-restore "frameset" (frameset &rest keys) t)
(declare-function frameset-save "frameset" (frame-list &rest keys) t)

Eric S. Raymond's avatar
Eric S. Raymond committed
40
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
41

Stefan Monnier's avatar
Stefan Monnier committed
42
(cl-defstruct
43 44 45 46 47 48 49 50 51 52 53
  (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
54
(cl-defun registerv-make (data &key print-func jump-func insert-func)
55 56 57 58 59
  "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
60
receiving one argument DATA and print text that completes
61 62 63 64 65 66 67
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
68 69
(defvar register-alist nil
  "Alist of elements (NAME . CONTENTS), one for each Emacs register.
70 71
NAME is a character (a number).  CONTENTS is a string, number, marker, list
or a struct returned by `registerv-make'.
72
A list of strings represents a rectangle.
73 74 75 76
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
77 78 79
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)
80 81 82
 represents a saved frame configuration plus a saved value of point.
A list of the form (FRAMESET FRAME-ID POSITION)
 represents a saved frameset plus the value of point in frame FRAME-ID.")
Richard M. Stallman's avatar
Richard M. Stallman committed
83

84 85 86
(defgroup register nil
  "Register commands."
  :group 'convenience
87
  :version "24.3")
88

89 90
(defcustom register-separator nil
  "Register containing the text to put between collected texts, or nil if none.
91 92 93 94 95 96 97 98 99

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 ?+)))

100 101 102
(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
103

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

113
(defun point-to-register (register &optional arg)
114
  "Store current location of point in register REGISTER.
Jim Blandy's avatar
Jim Blandy committed
115
With prefix argument, store current frame configuration.
116
Use \\[jump-to-register] to go to that location or restore that configuration.
Richard M. Stallman's avatar
Richard M. Stallman committed
117
Argument is a character, naming the register."
118
  (interactive "cPoint to register: \nP")
Stefan Monnier's avatar
Stefan Monnier committed
119 120
  ;; Turn the marker into a file-ref if the buffer is killed.
  (add-hook 'kill-buffer-hook 'register-swap-out nil t)
121
  (set-register register
Karl Heuer's avatar
Karl Heuer committed
122 123
		(if arg (list (current-frame-configuration) (point-marker))
		  (point-marker))))
Richard M. Stallman's avatar
Richard M. Stallman committed
124

125
(defun window-configuration-to-register (register &optional _arg)
126 127 128
  "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."
129
  (interactive "cWindow configuration to register: \nP")
130 131
  ;; 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
132
  (set-register register (list (current-window-configuration) (point-marker))))
133

134
(defun frame-configuration-to-register (register &optional _arg)
135 136 137
  "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."
138
  (interactive "cFrame configuration to register: \nP")
139 140
  ;; 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
141
  (set-register register (list (current-frame-configuration) (point-marker))))
142

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
(defvar frameset-session-filter-alist)

(defun frameset-to-register (register &optional _arg)
  "Store the current frameset in register REGISTER.
Use \\[jump-to-register] to restore the frameset.
Argument is a character, naming the register."
  (interactive "cFrameset to register: \nP")
  (set-register register
		(list (frameset-save nil
				     :app 'register
				     :filters frameset-session-filter-alist)
		      ;; frameset-save does not include the value of point
		      ;; in the current buffer, so record that separately.
		      (frameset-frame-id nil)
		      (point-marker))))

159
(defalias 'register-to-point 'jump-to-register)
160
(defun jump-to-register (register &optional delete)
Richard M. Stallman's avatar
Richard M. Stallman committed
161
  "Move point to location stored in a register.
162
If the register contains a file name, find that file.
163
\(To put a file name in a register, you must use `set-register'.)
164 165
If the register contains a window configuration (one frame) or a frameset
\(all frames), restore that frame or all frames accordingly.
166
First argument is a character, naming the register.
167
Optional second arg non-nil (interactively, prefix argument) says to
168
delete any existing frames that the frameset doesn't mention.
169
\(Otherwise, these frames are iconified.)"
170
  (interactive "cJump to register: \nP")
171
  (let ((val (get-register register)))
172
    (cond
173
     ((registerv-p val)
Stefan Monnier's avatar
Stefan Monnier committed
174
      (cl-assert (registerv-jump-func val) nil
175 176 177
              "Don't know how to jump to register %s"
              (single-key-description register))
      (funcall (registerv-jump-func val) (registerv-data val)))
178 179 180 181 182 183
     ((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)))
184 185 186 187 188 189 190 191 192 193
     ((and (consp val) (frameset-p (car val)))
      (let ((iconify-list (if delete nil (frame-list)))
	    frame)
	(frameset-restore (car val)
			  :filters frameset-session-filter-alist
			  :reuse-frames (if delete t :keep))
	(mapc #'iconify-frame iconify-list)
	(when (setq frame (frameset-frame-with-id (cadr val)))
	  (select-frame-set-input-focus frame)
	  (goto-char (nth 2 val)))))
194
     ((markerp val)
195 196
      (or (marker-buffer val)
	  (error "That register's buffer no longer exists"))
197 198
      (switch-to-buffer (marker-buffer val))
      (goto-char val))
199 200
     ((and (consp val) (eq (car val) 'file))
      (find-file (cdr val)))
201 202 203 204 205 206
     ((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)))
207 208
     (t
      (error "Register doesn't contain a buffer position or configuration")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
209

210
(defun register-swap-out ()
Stefan Monnier's avatar
Stefan Monnier committed
211
  "Turn markers into file-query references when a buffer is killed."
212
  (and buffer-file-name
Stefan Monnier's avatar
Stefan Monnier committed
213 214 215 216 217 218 219
       (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))))))))
220

221
(defun number-to-register (number register)
Karl Heuer's avatar
Karl Heuer committed
222 223
  "Store a number in a register.
Two args, NUMBER and REGISTER (a character, naming the register).
224 225
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
226 227
Interactively, NUMBER is the prefix arg (none means nil)."
  (interactive "P\ncNumber to register: ")
228
  (set-register register
229 230
		(if number
		    (prefix-numeric-value number)
231 232 233
		  (if (looking-at "\\s-*-?[0-9]+")
		      (progn
			(goto-char (match-end 0))
234
			(string-to-number (match-string 0)))
Karl Heuer's avatar
Karl Heuer committed
235 236
		    0))))

237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
(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
255

256
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
257
  "Display what is contained in register named REGISTER.
258
The Lisp value REGISTER is a character."
Richard M. Stallman's avatar
Richard M. Stallman committed
259
  (interactive "cView register: ")
260
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
261
    (if (null val)
262
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
263
      (with-output-to-temp-buffer "*Output*"
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
	(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 ")
281 282
  (let ((val (get-register register)))
    (cond
283 284 285 286 287
     ((registerv-p val)
      (if (registerv-print-func val)
          (funcall (registerv-print-func val) (registerv-data val))
        (princ "[UNPRINTABLE CONTENTS].")))

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
     ((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."))

306 307 308
     ((and (consp val) (frameset-p (car val)))
      (princ "a frameset."))

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
     ((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)
334 335 336 337
      (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))
338 339 340 341
      (if verbose
	  (progn
	    (princ "the text:\n")
	    (princ val))
342
	(cond
343 344 345 346 347 348 349 350 351 352 353
	 ;; 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")))))
354 355 356
     (t
      (princ "Garbage:\n")
      (if verbose (prin1 val))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
357

358 359
(defun insert-register (register &optional arg)
  "Insert contents of register REGISTER.  (REGISTER is a character.)
Richard M. Stallman's avatar
Richard M. Stallman committed
360 361 362
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."
363
  (interactive "*cInsert register: \nP")
Richard M. Stallman's avatar
Richard M. Stallman committed
364
  (push-mark)
365
  (let ((val (get-register register)))
366
    (cond
367
     ((registerv-p val)
Stefan Monnier's avatar
Stefan Monnier committed
368
      (cl-assert (registerv-insert-func val) nil
369 370 371
              "Don't know how to insert register %s"
              (single-key-description register))
      (funcall (registerv-insert-func val) (registerv-data val)))
372 373
     ((consp val)
      (insert-rectangle val))
374
     ((stringp val)
375
      (insert-for-yank val))
Karl Heuer's avatar
Karl Heuer committed
376
     ((numberp val)
377 378 379 380 381
      (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
382 383
  (if (not arg) (exchange-point-and-mark)))

384
(defun copy-to-register (register start end &optional delete-flag)
385 386
  "Copy region into register REGISTER.
With prefix arg, delete as well.
387
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
388 389
START and END are buffer positions indicating what to copy."
  (interactive "cCopy to register: \nr\nP")
390
  (set-register register (filter-buffer-substring start end))
391 392 393 394 395
  (setq deactivate-mark t)
  (cond (delete-flag
	 (delete-region start end))
	((called-interactively-p 'interactive)
	 (indicate-copied-region))))
Richard M. Stallman's avatar
Richard M. Stallman committed
396

397 398 399 400
(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
401 402
START and END are buffer positions indicating what to append."
  (interactive "cAppend to register: \nr\nP")
403
  (let ((reg (get-register register))
404
        (text (filter-buffer-substring start end))
405
	(separator (and register-separator (get-register register-separator))))
406 407
    (set-register
     register (cond ((not reg) text)
408
                    ((stringp reg) (concat reg separator text))
409
                    (t (error "Register does not contain text")))))
410
  (setq deactivate-mark t)
411 412 413 414
  (cond (delete-flag
	 (delete-region start end))
	((called-interactively-p 'interactive)
	 (indicate-copied-region))))
Richard M. Stallman's avatar
Richard M. Stallman committed
415

416 417 418 419
(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
420 421
START and END are buffer positions indicating what to prepend."
  (interactive "cPrepend to register: \nr\nP")
422
  (let ((reg (get-register register))
423
        (text (filter-buffer-substring start end))
424
	(separator (and register-separator (get-register register-separator))))
425 426
    (set-register
     register (cond ((not reg) text)
427
                    ((stringp reg) (concat text separator reg))
428
                    (t (error "Register does not contain text")))))
429
  (setq deactivate-mark t)
430 431 432 433
  (cond (delete-flag
	 (delete-region start end))
	((called-interactively-p 'interactive)
	 (indicate-copied-region))))
Richard M. Stallman's avatar
Richard M. Stallman committed
434

435 436
(defun copy-rectangle-to-register (register start end &optional delete-flag)
  "Copy rectangular region into register REGISTER.
437 438
With prefix arg, delete as well.
To insert this register in the buffer, use \\[insert-register].
439 440

Called from a program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
441 442
START and END are buffer positions giving two corners of rectangle."
  (interactive "cCopy rectangle to register: \nr\nP")
443 444 445 446 447 448 449 450 451
  (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))))))

Eric S. Raymond's avatar
Eric S. Raymond committed
452

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