register.el 14.4 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
(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
82

83 84
(defun set-register (register value)
  "Set contents of Emacs register named REGISTER to VALUE.  Returns VALUE.
85
See the documentation of the variable `register-alist' for possible VALUEs."
86
  (let ((aelt (assq register register-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
87 88
    (if aelt
	(setcdr aelt value)
Stefan Monnier's avatar
Stefan Monnier committed
89
      (push (cons register value) register-alist))
Richard M. Stallman's avatar
Richard M. Stallman committed
90 91
    value))

92
(defun point-to-register (register &optional arg)
93
  "Store current location of point in register REGISTER.
Jim Blandy's avatar
Jim Blandy committed
94
With prefix argument, store current frame configuration.
95
Use \\[jump-to-register] to go to that location or restore that configuration.
Richard M. Stallman's avatar
Richard M. Stallman committed
96
Argument is a character, naming the register."
97
  (interactive "cPoint to register: \nP")
Stefan Monnier's avatar
Stefan Monnier committed
98 99
  ;; Turn the marker into a file-ref if the buffer is killed.
  (add-hook 'kill-buffer-hook 'register-swap-out nil t)
100
  (set-register register
Karl Heuer's avatar
Karl Heuer committed
101 102
		(if arg (list (current-frame-configuration) (point-marker))
		  (point-marker))))
Richard M. Stallman's avatar
Richard M. Stallman committed
103

104
(defun window-configuration-to-register (register &optional _arg)
105 106 107
  "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."
108
  (interactive "cWindow configuration to register: \nP")
109 110
  ;; 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
111
  (set-register register (list (current-window-configuration) (point-marker))))
112

113
(defun frame-configuration-to-register (register &optional _arg)
114 115 116
  "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."
117
  (interactive "cFrame configuration to register: \nP")
118 119
  ;; 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
120
  (set-register register (list (current-frame-configuration) (point-marker))))
121

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

168
(defun register-swap-out ()
Stefan Monnier's avatar
Stefan Monnier committed
169
  "Turn markers into file-query references when a buffer is killed."
170
  (and buffer-file-name
Stefan Monnier's avatar
Stefan Monnier committed
171 172 173 174 175 176 177
       (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))))))))
178

179
(defun number-to-register (number register)
Karl Heuer's avatar
Karl Heuer committed
180 181
  "Store a number in a register.
Two args, NUMBER and REGISTER (a character, naming the register).
182 183
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
184 185
Interactively, NUMBER is the prefix arg (none means nil)."
  (interactive "P\ncNumber to register: ")
186
  (set-register register
187 188
		(if number
		    (prefix-numeric-value number)
189 190 191
		  (if (looking-at "\\s-*-?[0-9]+")
		      (progn
			(goto-char (match-end 0))
192
			(string-to-number (match-string 0)))
Karl Heuer's avatar
Karl Heuer committed
193 194
		    0))))

195
(defun increment-register (number register)
Karl Heuer's avatar
Karl Heuer committed
196
  "Add NUMBER to the contents of register REGISTER.
197
Interactively, NUMBER is the prefix arg."
Karl Heuer's avatar
Karl Heuer committed
198
  (interactive "p\ncIncrement register: ")
199
  (or (numberp (get-register register))
Karl Heuer's avatar
Karl Heuer committed
200
      (error "Register does not contain a number"))
201
  (set-register register (+ number (get-register register))))
Richard M. Stallman's avatar
Richard M. Stallman committed
202

203
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
204
  "Display what is contained in register named REGISTER.
205
The Lisp value REGISTER is a character."
Richard M. Stallman's avatar
Richard M. Stallman committed
206
  (interactive "cView register: ")
207
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
208
    (if (null val)
209
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
210
      (with-output-to-temp-buffer "*Output*"
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
	(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 ")
228 229
  (let ((val (get-register register)))
    (cond
230 231 232 233 234
     ((registerv-p val)
      (if (registerv-print-func val)
          (funcall (registerv-print-func val) (registerv-data val))
        (princ "[UNPRINTABLE CONTENTS].")))

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
     ((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)
278 279 280 281
      (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))
282 283 284 285
      (if verbose
	  (progn
	    (princ "the text:\n")
	    (princ val))
286
	(cond
287 288 289 290 291 292 293 294 295 296 297
	 ;; 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")))))
298 299 300
     (t
      (princ "Garbage:\n")
      (if verbose (prin1 val))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
301

302 303
(defun insert-register (register &optional arg)
  "Insert contents of register REGISTER.  (REGISTER is a character.)
Richard M. Stallman's avatar
Richard M. Stallman committed
304 305 306
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."
307
  (interactive "*cInsert register: \nP")
Richard M. Stallman's avatar
Richard M. Stallman committed
308
  (push-mark)
309
  (let ((val (get-register register)))
310
    (cond
311
     ((registerv-p val)
Stefan Monnier's avatar
Stefan Monnier committed
312
      (cl-assert (registerv-insert-func val) nil
313 314 315
              "Don't know how to insert register %s"
              (single-key-description register))
      (funcall (registerv-insert-func val) (registerv-data val)))
316 317
     ((consp val)
      (insert-rectangle val))
318
     ((stringp val)
319
      (insert-for-yank val))
Karl Heuer's avatar
Karl Heuer committed
320
     ((numberp val)
321 322 323
      (princ val (current-buffer)))
     ((and (markerp val) (marker-position val))
      (princ (marker-position val) (current-buffer)))
324 325 326 327
     ((and (fboundp 'semantic-foreign-tag-p)
	   semantic-mode
	   (semantic-foreign-tag-p val))
      (semantic-insert-foreign-tag val))
328 329
     (t
      (error "Register does not contain text"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
330 331
  (if (not arg) (exchange-point-and-mark)))

332
(defun copy-to-register (register start end &optional delete-flag)
333 334
  "Copy region into register REGISTER.
With prefix arg, delete as well.
335
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
336 337
START and END are buffer positions indicating what to copy."
  (interactive "cCopy to register: \nr\nP")
338
  (set-register register (filter-buffer-substring start end))
Richard M. Stallman's avatar
Richard M. Stallman committed
339 340
  (if delete-flag (delete-region start end)))

341 342 343 344
(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
345 346
START and END are buffer positions indicating what to append."
  (interactive "cAppend to register: \nr\nP")
347 348 349 350 351 352
  (let ((reg (get-register register))
        (text (filter-buffer-substring start end)))
    (set-register
     register (cond ((not reg) text)
                    ((stringp reg) (concat reg text))
                    (t (error "Register does not contain text")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
353 354
  (if delete-flag (delete-region start end)))

355 356 357 358
(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
359 360
START and END are buffer positions indicating what to prepend."
  (interactive "cPrepend to register: \nr\nP")
361 362 363 364 365 366
  (let ((reg (get-register register))
        (text (filter-buffer-substring start end)))
    (set-register
     register (cond ((not reg) text)
                    ((stringp reg) (concat text reg))
                    (t (error "Register does not contain text")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
367 368
  (if delete-flag (delete-region start end)))

369 370
(defun copy-rectangle-to-register (register start end &optional delete-flag)
  "Copy rectangular region into register REGISTER.
371 372
With prefix arg, delete as well.
To insert this register in the buffer, use \\[insert-register].
373 374

Called from a program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376
START and END are buffer positions giving two corners of rectangle."
  (interactive "cCopy rectangle to register: \nr\nP")
377
  (set-register register
Richard M. Stallman's avatar
Richard M. Stallman committed
378 379 380
		(if delete-flag
		    (delete-extract-rectangle start end)
		  (extract-rectangle start end))))
Eric S. Raymond's avatar
Eric S. Raymond committed
381

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