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

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1985, 1993, 1994, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 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
;; 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.

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

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

45 46 47
(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
48

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

58
(defun point-to-register (register &optional arg)
59
  "Store current location of point in register REGISTER.
Jim Blandy's avatar
Jim Blandy committed
60
With prefix argument, store current frame configuration.
61
Use \\[jump-to-register] to go to that location or restore that configuration.
Richard M. Stallman's avatar
Richard M. Stallman committed
62
Argument is a character, naming the register."
63
  (interactive "cPoint to register: \nP")
Stefan Monnier's avatar
Stefan Monnier committed
64 65
  ;; Turn the marker into a file-ref if the buffer is killed.
  (add-hook 'kill-buffer-hook 'register-swap-out nil t)
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
(defun register-swap-out ()
Stefan Monnier's avatar
Stefan Monnier committed
125
  "Turn markers into file-query references when a buffer is killed."
126
  (and buffer-file-name
Stefan Monnier's avatar
Stefan Monnier committed
127 128 129 130 131 132 133
       (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))))))))
134

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

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

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

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

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

282 283 284 285
(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
286 287
START and END are buffer positions indicating what to append."
  (interactive "cAppend to register: \nr\nP")
288 289 290 291 292 293
  (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
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 303 304 305 306 307
  (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
308 309
  (if delete-flag (delete-region start end)))

310 311
(defun copy-rectangle-to-register (register start end &optional delete-flag)
  "Copy rectangular region into register REGISTER.
312 313 314 315
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
316 317
START and END are buffer positions giving two corners of rectangle."
  (interactive "cCopy rectangle to register: \nr\nP")
318
  (set-register register
Richard M. Stallman's avatar
Richard M. Stallman committed
319 320 321
		(if delete-flag
		    (delete-extract-rectangle start end)
		  (extract-rectangle start end))))
Eric S. Raymond's avatar
Eric S. Raymond committed
322

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