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

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1985, 1993, 1994 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
Eric S. Raymond's avatar
Eric S. Raymond committed
7

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

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

;; 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
Erik Naggum's avatar
Erik Naggum committed
21 22 23
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
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.

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

(defvar register-alist nil
  "Alist of elements (NAME . CONTENTS), one for each Emacs register.
Karl Heuer's avatar
Karl Heuer committed
36
NAME is a character (a number).  CONTENTS is a string, number, marker or list.
37
A list of strings represents a rectangle.
38 39
A list of the form (file . NAME) represents the file named NAME.
A list of the form (file-query NAME POSITION) represents position POSITION
Karl Heuer's avatar
Karl Heuer committed
40 41 42 43 44
 in the file named NAME, but query before visiting it.
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
45

46 47 48
(defun get-register (reg)
  "Return contents of Emacs register named REG, or nil if none."
  (cdr (assq reg register-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
49

50 51
(defun set-register (register value)
  "Set contents of Emacs register named REGISTER to VALUE.  Returns VALUE.
52
See the documentation of the variable `register-alist' for possible VALUE."
53
  (let ((aelt (assq register register-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
54 55
    (if aelt
	(setcdr aelt value)
56
      (setq aelt (cons register value))
Richard M. Stallman's avatar
Richard M. Stallman committed
57 58 59
      (setq register-alist (cons aelt register-alist)))
    value))

60
(defun point-to-register (register &optional arg)
61
  "Store current location of point in register REGISTER.
Jim Blandy's avatar
Jim Blandy committed
62
With prefix argument, store current frame configuration.
63
Use \\[jump-to-register] to go to that location or restore that configuration.
Richard M. Stallman's avatar
Richard M. Stallman committed
64
Argument is a character, naming the register."
65
  (interactive "cPoint to register: \nP")
66
  (set-register register
Karl Heuer's avatar
Karl Heuer committed
67 68
		(if arg (list (current-frame-configuration) (point-marker))
		  (point-marker))))
Richard M. Stallman's avatar
Richard M. Stallman committed
69

70
(defun window-configuration-to-register (register &optional arg)
71 72 73
  "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."
74
  (interactive "cWindow configuration to register: \nP")
75 76
  ;; 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
77
  (set-register register (list (current-window-configuration) (point-marker))))
78

79
(defun frame-configuration-to-register (register &optional arg)
80 81 82
  "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."
83
  (interactive "cFrame configuration to register: \nP")
84 85
  ;; 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
86
  (set-register register (list (current-frame-configuration) (point-marker))))
87

88
(defalias 'register-to-point 'jump-to-register)
89
(defun jump-to-register (register &optional delete)
Richard M. Stallman's avatar
Richard M. Stallman committed
90
  "Move point to location stored in a register.
91 92
If the register contains a file name, find that file.
 \(To put a file name in a register, you must use `set-register'.)
93 94
If the register contains a window configuration (one frame) or a frame
configuration (all frames), restore that frame or all frames accordingly.
95
First argument is a character, naming the register.
96 97
Optional second arg non-nil (interactively, prefix argument) says to
delete any existing frames that the frame configuration doesn't mention.
98
\(Otherwise, these frames are iconified.)"
99
  (interactive "cJump to register: \nP")
100
  (let ((val (get-register register)))
101
    (cond
102 103 104 105 106 107
     ((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)))
108
     ((markerp val)
109 110
      (or (marker-buffer val)
	  (error "That register's buffer no longer exists"))
111 112
      (switch-to-buffer (marker-buffer val))
      (goto-char val))
113 114
     ((and (consp val) (eq (car val) 'file))
      (find-file (cdr val)))
115 116 117 118 119 120
     ((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)))
121 122
     (t
      (error "Register doesn't contain a buffer position or configuration")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
123

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
;; Turn markers into file-query references when a buffer is killed.
(defun register-swap-out ()
  (and buffer-file-name
       (let ((tail register-alist))
	 (while tail
	   (and (markerp (cdr (car tail)))
		(eq (marker-buffer (cdr (car tail))) (current-buffer))
		(setcdr (car tail)
			(list 'file-query
			      buffer-file-name
			      (marker-position (cdr (car tail))))))
	   (setq tail (cdr tail))))))

(add-hook 'kill-buffer-hook 'register-swap-out)

139
(defun number-to-register (number register)
Karl Heuer's avatar
Karl Heuer committed
140 141
  "Store a number in a register.
Two args, NUMBER and REGISTER (a character, naming the register).
142 143
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
144 145
Interactively, NUMBER is the prefix arg (none means nil)."
  (interactive "P\ncNumber to register: ")
146 147 148
  (set-register register 
		(if number
		    (prefix-numeric-value number)
149 150 151 152
		  (if (looking-at "\\s-*-?[0-9]+")
		      (progn
			(goto-char (match-end 0))
			(string-to-int (match-string 0)))
Karl Heuer's avatar
Karl Heuer committed
153 154
		    0))))

155
(defun increment-register (number register)
Karl Heuer's avatar
Karl Heuer committed
156
  "Add NUMBER to the contents of register REGISTER.
157
Interactively, NUMBER is the prefix arg."
Karl Heuer's avatar
Karl Heuer committed
158
  (interactive "p\ncIncrement register: ")
159
  (or (numberp (get-register register))
Karl Heuer's avatar
Karl Heuer committed
160
      (error "Register does not contain a number"))
161
  (set-register register (+ number (get-register register))))
Richard M. Stallman's avatar
Richard M. Stallman committed
162

163
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
164
  "Display what is contained in register named REGISTER.
165
The Lisp value REGISTER is a character."
Richard M. Stallman's avatar
Richard M. Stallman committed
166
  (interactive "cView register: ")
167
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
168
    (if (null val)
169
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
170
      (with-output-to-temp-buffer "*Output*"
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
	(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 ")
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
  (let ((val (get-register register)))
    (cond
     ((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)
233 234 235
      (setq val
	    (remove-list-of-text-properties 0 (length val)
					    yank-excluded-properties val))
236 237 238 239 240 241 242 243 244 245
      (if verbose
	  (progn
	    (princ "the text:\n")
	    (princ val))
	(princ "text starting with\n    ")
	(string-match "[^ \t\n].\\{,20\\}" val)
	(princ (match-string 0 val))))
     (t
      (princ "Garbage:\n")
      (if verbose (prin1 val))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
246

247 248
(defun insert-register (register &optional arg)
  "Insert contents of register REGISTER.  (REGISTER is a character.)
Richard M. Stallman's avatar
Richard M. Stallman committed
249 250 251
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."
252
  (interactive "*cInsert register: \nP")
Richard M. Stallman's avatar
Richard M. Stallman committed
253
  (push-mark)
254
  (let ((val (get-register register)))
255 256 257 258
    (cond
     ((consp val)
      (insert-rectangle val))
     ((stringp val)
259
      (insert-for-yank val))
Karl Heuer's avatar
Karl Heuer committed
260
     ((numberp val)
261 262 263 264 265
      (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
266 267
  (if (not arg) (exchange-point-and-mark)))

268 269 270
(defun copy-to-register (register start end &optional delete-flag)
  "Copy region into 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
271 272
START and END are buffer positions indicating what to copy."
  (interactive "cCopy to register: \nr\nP")
273
  (set-register register (buffer-substring start end))
Richard M. Stallman's avatar
Richard M. Stallman committed
274 275
  (if delete-flag (delete-region start end)))

276 277 278 279
(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
280 281
START and END are buffer positions indicating what to append."
  (interactive "cAppend to register: \nr\nP")
282
  (or (stringp (get-register register))
Richard M. Stallman's avatar
Richard M. Stallman committed
283
      (error "Register does not contain text"))
284 285
  (set-register register (concat (get-register register)
			    (buffer-substring start end)))
Richard M. Stallman's avatar
Richard M. Stallman committed
286 287
  (if delete-flag (delete-region start end)))

288 289 290 291
(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
292 293
START and END are buffer positions indicating what to prepend."
  (interactive "cPrepend to register: \nr\nP")
294
  (or (stringp (get-register register))
Richard M. Stallman's avatar
Richard M. Stallman committed
295
      (error "Register does not contain text"))
296 297
  (set-register register (concat (buffer-substring start end)
			    (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
298 299
  (if delete-flag (delete-region start end)))

300 301 302 303
(defun copy-rectangle-to-register (register start end &optional delete-flag)
  "Copy rectangular region into 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
304 305
START and END are buffer positions giving two corners of rectangle."
  (interactive "cCopy rectangle to register: \nr\nP")
306
  (set-register register
Richard M. Stallman's avatar
Richard M. Stallman committed
307 308 309
		(if delete-flag
		    (delete-extract-rectangle start end)
		  (extract-rectangle start end))))
Eric S. Raymond's avatar
Eric S. Raymond committed
310 311

;;; register.el ends here