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

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 36

(defvar register-alist nil
  "Alist of elements (NAME . CONTENTS), one for each Emacs register.
NAME is a character (a number).  CONTENTS is a string, number,
Jim Blandy's avatar
Jim Blandy committed
37
frame configuration, mark or list.
38
A list of strings represents a rectangle.
39 40 41
A list of the form (file . NAME) represents the file named NAME.
A list of the form (file-query NAME POSITION) represents position POSITION
 in the file named NAME, but query before visiting it.")
Richard M. Stallman's avatar
Richard M. Stallman committed
42

43 44 45
(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
46

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

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

66
(defun window-configuration-to-register (register &optional arg)
67 68 69
  "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."
70
  (interactive "cWindow configuration to register: \nP")
71
  (set-register register (current-window-configuration)))
72

73
(defun frame-configuration-to-register (register &optional arg)
74 75 76
  "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."
77
  (interactive "cFrame configuration to register: \nP")
78
  (set-register register (current-frame-configuration)))
79

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

115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
;; 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)

Richard M. Stallman's avatar
Richard M. Stallman committed
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
;(defun number-to-register (arg char)
;  "Store a number in a register.
;Two args, NUMBER and REGISTER (a character, naming the register).
;If NUMBER is nil, digits in the buffer following point are read
;to get the number to store.
;Interactively, NUMBER is the prefix arg (none means nil)."
;  (interactive "P\ncNumber to register: ")
;  (set-register char 
;		(if arg
;		    (prefix-numeric-value arg)
;		  (if (looking-at "[0-9][0-9]*")
;		      (save-excursion
;		       (save-restriction
;			(narrow-to-region (point)
;					  (progn (skip-chars-forward "0-9")
;						 (point)))
;			(goto-char (point-min))
;			(read (current-buffer))))
;		    0))))

;(defun increment-register (arg char)
;  "Add NUMBER to the contents of register REGISTER.
;Interactively, NUMBER is the prefix arg (none means nil)." 
;  (interactive "p\ncNumber to register: ")
;  (or (integerp (get-register char))
;      (error "Register does not contain a number"))
;  (set-register char (+ arg (get-register char))))

158
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
159
  "Display what is contained in register named REGISTER.
160
The Lisp value REGISTER is a character."
Richard M. Stallman's avatar
Richard M. Stallman committed
161
  (interactive "cView register: ")
162
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
163
    (if (null val)
164
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
165 166
      (with-output-to-temp-buffer "*Output*"
	(princ "Register ")
167
	(princ (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
168
	(princ " contains ")
169 170 171 172 173
	(cond
	 ((integerp val)
	  (princ val))

	 ((markerp val)
174 175 176 177 178 179 180
	  (let ((buf (marker-buffer val)))
	    (if (null buf)
		(princ "a marker in no buffer")
	      (princ "a buffer position:\nbuffer ")
	      (princ (buffer-name buf))
	      (princ ", position ")
	      (princ (marker-position val)))))
181 182 183 184 185 186 187

	 ((window-configuration-p val)
	  (princ "a window configuration."))

	 ((frame-configuration-p val)
	  (princ "a frame configuration."))

188 189 190 191 192
	 ((and (consp val) (eq (car val) 'file))
	  (princ "the file ")
	  (prin1 (cdr val))
	  (princ "."))

193 194 195 196 197 198 199 200 201 202 203 204 205 206
	 ((consp val)
	  (princ "the rectangle:\n")
	  (while val
	    (princ (car val))
	    (terpri)
	    (setq val (cdr val))))

	 ((stringp val)
	  (princ "the text:\n")
	  (princ val))

	 (t
	  (princ "Garbage:\n")
	  (prin1 val)))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
207

208 209
(defun insert-register (register &optional arg)
  "Insert contents of register REGISTER.  (REGISTER is a character.)
Richard M. Stallman's avatar
Richard M. Stallman committed
210 211 212
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."
213
  (interactive "*cInsert register: \nP")
Richard M. Stallman's avatar
Richard M. Stallman committed
214
  (push-mark)
215
  (let ((val (get-register register)))
216 217 218 219 220 221 222 223 224 225 226
    (cond
     ((consp val)
      (insert-rectangle val))
     ((stringp val)
      (insert val))
     ((integerp val)
      (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
227 228
  (if (not arg) (exchange-point-and-mark)))

229 230 231
(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
232 233
START and END are buffer positions indicating what to copy."
  (interactive "cCopy to register: \nr\nP")
234
  (set-register register (buffer-substring start end))
Richard M. Stallman's avatar
Richard M. Stallman committed
235 236
  (if delete-flag (delete-region start end)))

237 238 239 240
(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
241 242
START and END are buffer positions indicating what to append."
  (interactive "cAppend to register: \nr\nP")
243
  (or (stringp (get-register register))
Richard M. Stallman's avatar
Richard M. Stallman committed
244
      (error "Register does not contain text"))
245 246
  (set-register register (concat (get-register register)
			    (buffer-substring start end)))
Richard M. Stallman's avatar
Richard M. Stallman committed
247 248
  (if delete-flag (delete-region start end)))

249 250 251 252
(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
253 254
START and END are buffer positions indicating what to prepend."
  (interactive "cPrepend to register: \nr\nP")
255
  (or (stringp (get-register register))
Richard M. Stallman's avatar
Richard M. Stallman committed
256
      (error "Register does not contain text"))
257 258
  (set-register register (concat (buffer-substring start end)
			    (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
259 260
  (if delete-flag (delete-region start end)))

261 262 263 264
(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
265 266
START and END are buffer positions giving two corners of rectangle."
  (interactive "cCopy rectangle to register: \nr\nP")
267
  (set-register register
Richard M. Stallman's avatar
Richard M. Stallman committed
268 269 270
		(if delete-flag
		    (delete-extract-rectangle start end)
		  (extract-rectangle start end))))
Eric S. Raymond's avatar
Eric S. Raymond committed
271 272

;;; register.el ends here