register.el 12.2 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, 2002, 2003, 2004,
4
;;   2005, 2006 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
Eric S. Raymond's avatar
Eric S. Raymond committed
8

Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11 12
;; 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
13
;; the Free Software Foundation; either version 2, or (at your option)
Richard M. Stallman's avatar
Richard M. Stallman committed
14 15 16 17 18 19 20 21
;; 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
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
25

26 27 28 29 30 31 32
;;; 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
33
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
34 35 36

(defvar register-alist nil
  "Alist of elements (NAME . CONTENTS), one for each Emacs register.
Karl Heuer's avatar
Karl Heuer committed
37
NAME is a character (a number).  CONTENTS is a string, number, marker or list.
38
A list of strings represents a rectangle.
39 40
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
41 42 43 44 45
 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
46

47 48 49
(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
50

51 52
(defun set-register (register value)
  "Set contents of Emacs register named REGISTER to VALUE.  Returns VALUE.
53
See the documentation of the variable `register-alist' for possible VALUE."
54
  (let ((aelt (assq register register-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
55 56
    (if aelt
	(setcdr aelt value)
Stefan Monnier's avatar
Stefan Monnier committed
57
      (push (cons register value) register-alist))
Richard M. Stallman's avatar
Richard M. Stallman committed
58 59
    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")
Stefan Monnier's avatar
Stefan Monnier committed
66 67
  ;; Turn the marker into a file-ref if the buffer is killed.
  (add-hook 'kill-buffer-hook 'register-swap-out nil t)
68
  (set-register register
Karl Heuer's avatar
Karl Heuer committed
69 70
		(if arg (list (current-frame-configuration) (point-marker))
		  (point-marker))))
Richard M. Stallman's avatar
Richard M. Stallman committed
71

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

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

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

126
(defun register-swap-out ()
Stefan Monnier's avatar
Stefan Monnier committed
127
  "Turn markers into file-query references when a buffer is killed."
128
  (and buffer-file-name
Stefan Monnier's avatar
Stefan Monnier committed
129 130 131 132 133 134 135
       (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))))))))
136

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

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

161
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
162
  "Display what is contained in register named REGISTER.
163
The Lisp value REGISTER is a character."
Richard M. Stallman's avatar
Richard M. Stallman committed
164
  (interactive "cView register: ")
165
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
166
    (if (null val)
167
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
168
      (with-output-to-temp-buffer "*Output*"
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
	(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 ")
186 187 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
  (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)
231 232 233 234
      (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))
235 236 237 238
      (if verbose
	  (progn
	    (princ "the text:\n")
	    (princ val))
239
	(cond
240 241 242 243 244 245 246 247 248 249 250
	 ;; 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")))))
251 252 253
     (t
      (princ "Garbage:\n")
      (if verbose (prin1 val))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
254

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

276 277 278
(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
279 280
START and END are buffer positions indicating what to copy."
  (interactive "cCopy to register: \nr\nP")
281
  (set-register register (filter-buffer-substring start end))
Richard M. Stallman's avatar
Richard M. Stallman committed
282 283
  (if delete-flag (delete-region start end)))

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

296 297 298 299
(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
300 301
START and END are buffer positions indicating what to prepend."
  (interactive "cPrepend to register: \nr\nP")
302
  (or (stringp (get-register register))
Richard M. Stallman's avatar
Richard M. Stallman committed
303
      (error "Register does not contain text"))
304
  (set-register register (concat (filter-buffer-substring start end)
305
			    (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
306 307
  (if delete-flag (delete-region start end)))

308 309
(defun copy-rectangle-to-register (register start end &optional delete-flag)
  "Copy rectangular region into register REGISTER.
310 311 312 313
With prefix arg, delete as well.  To insert this register
in the buffer, use \\[insert-register].

Called from a program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
314 315
START and END are buffer positions giving two corners of rectangle."
  (interactive "cCopy rectangle to register: \nr\nP")
316
  (set-register register
Richard M. Stallman's avatar
Richard M. Stallman committed
317 318 319
		(if delete-flag
		    (delete-extract-rectangle start end)
		  (extract-rectangle start end))))
Eric S. Raymond's avatar
Eric S. Raymond committed
320

Masatake YAMATO's avatar
Masatake YAMATO committed
321
(provide 'register)
Miles Bader's avatar
Miles Bader committed
322
;;; arch-tag: ce14dd68-8265-475f-9341-5d4ec5a53035
Eric S. Raymond's avatar
Eric S. Raymond committed
323
;;; register.el ends here