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

3
;; Copyright (C) 1985, 1993-1994, 2001-2012 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

33 34 35 36
(declare-function semantic-insert-foreign-tag "semantic/tag" (foreign-tag))
(declare-function semantic-tag-buffer "semantic/tag" (tag))
(declare-function semantic-tag-start "semantic/tag" (tag))

Eric S. Raymond's avatar
Eric S. Raymond committed
37
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
38

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

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
(defgroup register nil
  "Register commands."
  :group 'convenience
  :version "24.2.50")

(defcustom separator-register nil
  "Use contents of this register to separate collected text.

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

95 96 97
(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
98

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

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

120
(defun window-configuration-to-register (register &optional _arg)
121 122 123
  "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."
124
  (interactive "cWindow configuration to register: \nP")
125 126
  ;; 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
127
  (set-register register (list (current-window-configuration) (point-marker))))
128

129
(defun frame-configuration-to-register (register &optional _arg)
130 131 132
  "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."
133
  (interactive "cFrame configuration to register: \nP")
134 135
  ;; 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
136
  (set-register register (list (current-frame-configuration) (point-marker))))
137

138
(defalias 'register-to-point 'jump-to-register)
139
(defun jump-to-register (register &optional delete)
Richard M. Stallman's avatar
Richard M. Stallman committed
140
  "Move point to location stored in a register.
141
If the register contains a file name, find that file.
142
\(To put a file name in a register, you must use `set-register'.)
143 144
If the register contains a window configuration (one frame) or a frame
configuration (all frames), restore that frame or all frames accordingly.
145
First argument is a character, naming the register.
146 147
Optional second arg non-nil (interactively, prefix argument) says to
delete any existing frames that the frame configuration doesn't mention.
148
\(Otherwise, these frames are iconified.)"
149
  (interactive "cJump to register: \nP")
150
  (let ((val (get-register register)))
151
    (cond
152
     ((registerv-p val)
Stefan Monnier's avatar
Stefan Monnier committed
153
      (cl-assert (registerv-jump-func val) nil
154 155 156
              "Don't know how to jump to register %s"
              (single-key-description register))
      (funcall (registerv-jump-func val) (registerv-data val)))
157 158 159 160 161 162
     ((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)))
163
     ((markerp val)
164 165
      (or (marker-buffer val)
	  (error "That register's buffer no longer exists"))
166 167
      (switch-to-buffer (marker-buffer val))
      (goto-char val))
168 169
     ((and (consp val) (eq (car val) 'file))
      (find-file (cdr val)))
170 171 172 173 174 175
     ((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)))
176 177 178 179 180
     ((and (fboundp 'semantic-foreign-tag-p)
	   semantic-mode
	   (semantic-foreign-tag-p val))
      (switch-to-buffer (semantic-tag-buffer val))
      (goto-char (semantic-tag-start val)))
181 182
     (t
      (error "Register doesn't contain a buffer position or configuration")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
183

184
(defun register-swap-out ()
Stefan Monnier's avatar
Stefan Monnier committed
185
  "Turn markers into file-query references when a buffer is killed."
186
  (and buffer-file-name
Stefan Monnier's avatar
Stefan Monnier committed
187 188 189 190 191 192 193
       (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))))))))
194

195
(defun number-to-register (number register)
Karl Heuer's avatar
Karl Heuer committed
196 197
  "Store a number in a register.
Two args, NUMBER and REGISTER (a character, naming the register).
198 199
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
200 201
Interactively, NUMBER is the prefix arg (none means nil)."
  (interactive "P\ncNumber to register: ")
202
  (set-register register
203 204
		(if number
		    (prefix-numeric-value number)
205 206 207
		  (if (looking-at "\\s-*-?[0-9]+")
		      (progn
			(goto-char (match-end 0))
208
			(string-to-number (match-string 0)))
Karl Heuer's avatar
Karl Heuer committed
209 210
		    0))))

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
(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
229

230
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
231
  "Display what is contained in register named REGISTER.
232
The Lisp value REGISTER is a character."
Richard M. Stallman's avatar
Richard M. Stallman committed
233
  (interactive "cView register: ")
234
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
235
    (if (null val)
236
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
237
      (with-output-to-temp-buffer "*Output*"
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
	(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 ")
255 256
  (let ((val (get-register register)))
    (cond
257 258 259 260 261
     ((registerv-p val)
      (if (registerv-print-func val)
          (funcall (registerv-print-func val) (registerv-data val))
        (princ "[UNPRINTABLE CONTENTS].")))

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
     ((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)
305 306 307 308
      (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))
309 310 311 312
      (if verbose
	  (progn
	    (princ "the text:\n")
	    (princ val))
313
	(cond
314 315 316 317 318 319 320 321 322 323 324
	 ;; 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")))))
325 326 327
     (t
      (princ "Garbage:\n")
      (if verbose (prin1 val))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
328

329 330
(defun insert-register (register &optional arg)
  "Insert contents of register REGISTER.  (REGISTER is a character.)
Richard M. Stallman's avatar
Richard M. Stallman committed
331 332 333
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."
334
  (interactive "*cInsert register: \nP")
Richard M. Stallman's avatar
Richard M. Stallman committed
335
  (push-mark)
336
  (let ((val (get-register register)))
337
    (cond
338
     ((registerv-p val)
Stefan Monnier's avatar
Stefan Monnier committed
339
      (cl-assert (registerv-insert-func val) nil
340 341 342
              "Don't know how to insert register %s"
              (single-key-description register))
      (funcall (registerv-insert-func val) (registerv-data val)))
343 344
     ((consp val)
      (insert-rectangle val))
345
     ((stringp val)
346
      (insert-for-yank val))
Karl Heuer's avatar
Karl Heuer committed
347
     ((numberp val)
348 349 350
      (princ val (current-buffer)))
     ((and (markerp val) (marker-position val))
      (princ (marker-position val) (current-buffer)))
351 352 353 354
     ((and (fboundp 'semantic-foreign-tag-p)
	   semantic-mode
	   (semantic-foreign-tag-p val))
      (semantic-insert-foreign-tag val))
355 356
     (t
      (error "Register does not contain text"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
357 358
  (if (not arg) (exchange-point-and-mark)))

359
(defun copy-to-register (register start end &optional delete-flag)
360 361
  "Copy region into register REGISTER.
With prefix arg, delete as well.
362
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
363 364
START and END are buffer positions indicating what to copy."
  (interactive "cCopy to register: \nr\nP")
365
  (set-register register (filter-buffer-substring start end))
366 367 368 369 370
  (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
371

372 373 374 375
(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
376 377
START and END are buffer positions indicating what to append."
  (interactive "cAppend to register: \nr\nP")
378
  (let ((reg (get-register register))
379 380
        (text (filter-buffer-substring start end))
	(separator (and separator-register (get-register separator-register))))
381 382
    (set-register
     register (cond ((not reg) text)
383
                    ((stringp reg) (concat reg separator text))
384
                    (t (error "Register does not contain text")))))
385 386 387 388
  (cond (delete-flag
	 (delete-region start end))
	((called-interactively-p 'interactive)
	 (indicate-copied-region))))
Richard M. Stallman's avatar
Richard M. Stallman committed
389

390 391 392 393
(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
394 395
START and END are buffer positions indicating what to prepend."
  (interactive "cPrepend to register: \nr\nP")
396
  (let ((reg (get-register register))
397 398
        (text (filter-buffer-substring start end))
	(separator (and separator-register (get-register separator-register))))
399 400
    (set-register
     register (cond ((not reg) text)
401
                    ((stringp reg) (concat text separator reg))
402
                    (t (error "Register does not contain text")))))
403 404 405 406
  (cond (delete-flag
	 (delete-region start end))
	((called-interactively-p 'interactive)
	 (indicate-copied-region))))
Richard M. Stallman's avatar
Richard M. Stallman committed
407

408 409
(defun copy-rectangle-to-register (register start end &optional delete-flag)
  "Copy rectangular region into register REGISTER.
410 411
With prefix arg, delete as well.
To insert this register in the buffer, use \\[insert-register].
412 413

Called from a program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
414 415
START and END are buffer positions giving two corners of rectangle."
  (interactive "cCopy rectangle to register: \nr\nP")
416 417 418 419 420 421 422 423 424
  (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
425

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