register.el 13.5 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,
4
;;   2005, 2006, 2007, 2008, 2009, 2010, 2011 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
8
;; Package: emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
9

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

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; 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
16 17 18 19 20 21 22

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
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.

32 33 34 35
(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))

36 37
;;; Global key bindings

38 39 40 41 42 43 44 45 46 47 48 49 50
(define-key ctl-x-r-map "\C-@" 'point-to-register)
(define-key ctl-x-r-map [?\C-\ ] 'point-to-register)
(define-key ctl-x-r-map " " 'point-to-register)
(define-key ctl-x-r-map "j" 'jump-to-register)
(define-key ctl-x-r-map "s" 'copy-to-register)
(define-key ctl-x-r-map "x" 'copy-to-register)
(define-key ctl-x-r-map "i" 'insert-register)
(define-key ctl-x-r-map "g" 'insert-register)
(define-key ctl-x-r-map "r" 'copy-rectangle-to-register)
(define-key ctl-x-r-map "n" 'number-to-register)
(define-key ctl-x-r-map "+" 'increment-register)
(define-key ctl-x-r-map "w" 'window-configuration-to-register)
(define-key ctl-x-r-map "f" 'frame-configuration-to-register)
51

Eric S. Raymond's avatar
Eric S. Raymond committed
52
;;; Code:
Richard M. Stallman's avatar
Richard M. Stallman committed
53 54 55

(defvar register-alist nil
  "Alist of elements (NAME . CONTENTS), one for each Emacs register.
Karl Heuer's avatar
Karl Heuer committed
56
NAME is a character (a number).  CONTENTS is a string, number, marker or list.
57
A list of strings represents a rectangle.
58 59 60 61
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
62 63 64 65
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
66

67 68 69
(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
70

71 72
(defun set-register (register value)
  "Set contents of Emacs register named REGISTER to VALUE.  Returns VALUE.
73
See the documentation of the variable `register-alist' for possible VALUEs."
74
  (let ((aelt (assq register register-alist)))
Richard M. Stallman's avatar
Richard M. Stallman committed
75 76
    (if aelt
	(setcdr aelt value)
Stefan Monnier's avatar
Stefan Monnier committed
77
      (push (cons register value) register-alist))
Richard M. Stallman's avatar
Richard M. Stallman committed
78 79
    value))

80
(defun point-to-register (register &optional arg)
81
  "Store current location of point in register REGISTER.
Jim Blandy's avatar
Jim Blandy committed
82
With prefix argument, store current frame configuration.
83
Use \\[jump-to-register] to go to that location or restore that configuration.
Richard M. Stallman's avatar
Richard M. Stallman committed
84
Argument is a character, naming the register."
85
  (interactive "cPoint to register: \nP")
Stefan Monnier's avatar
Stefan Monnier committed
86 87
  ;; Turn the marker into a file-ref if the buffer is killed.
  (add-hook 'kill-buffer-hook 'register-swap-out nil t)
88
  (set-register register
Karl Heuer's avatar
Karl Heuer committed
89 90
		(if arg (list (current-frame-configuration) (point-marker))
		  (point-marker))))
Richard M. Stallman's avatar
Richard M. Stallman committed
91

92
(defun window-configuration-to-register (register &optional arg)
93 94 95
  "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."
96
  (interactive "cWindow configuration to register: \nP")
97 98
  ;; 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
99
  (set-register register (list (current-window-configuration) (point-marker))))
100

101
(defun frame-configuration-to-register (register &optional arg)
102 103 104
  "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."
105
  (interactive "cFrame configuration to register: \nP")
106 107
  ;; 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
108
  (set-register register (list (current-frame-configuration) (point-marker))))
109

110
(defalias 'register-to-point 'jump-to-register)
111
(defun jump-to-register (register &optional delete)
Richard M. Stallman's avatar
Richard M. Stallman committed
112
  "Move point to location stored in a register.
113
If the register contains a file name, find that file.
114
\(To put a file name in a register, you must use `set-register'.)
115 116
If the register contains a window configuration (one frame) or a frame
configuration (all frames), restore that frame or all frames accordingly.
117
First argument is a character, naming the register.
118 119
Optional second arg non-nil (interactively, prefix argument) says to
delete any existing frames that the frame configuration doesn't mention.
120
\(Otherwise, these frames are iconified.)"
121
  (interactive "cJump to register: \nP")
122
  (let ((val (get-register register)))
123
    (cond
124 125 126 127 128 129
     ((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)))
130
     ((markerp val)
131 132
      (or (marker-buffer val)
	  (error "That register's buffer no longer exists"))
133 134
      (switch-to-buffer (marker-buffer val))
      (goto-char val))
135 136
     ((and (consp val) (eq (car val) 'file))
      (find-file (cdr val)))
137 138 139 140 141 142
     ((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)))
143 144 145 146 147
     ((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)))
148 149
     (t
      (error "Register doesn't contain a buffer position or configuration")))))
Richard M. Stallman's avatar
Richard M. Stallman committed
150

151
(defun register-swap-out ()
Stefan Monnier's avatar
Stefan Monnier committed
152
  "Turn markers into file-query references when a buffer is killed."
153
  (and buffer-file-name
Stefan Monnier's avatar
Stefan Monnier committed
154 155 156 157 158 159 160
       (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))))))))
161

162
(defun number-to-register (number register)
Karl Heuer's avatar
Karl Heuer committed
163 164
  "Store a number in a register.
Two args, NUMBER and REGISTER (a character, naming the register).
165 166
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
167 168
Interactively, NUMBER is the prefix arg (none means nil)."
  (interactive "P\ncNumber to register: ")
169
  (set-register register
170 171
		(if number
		    (prefix-numeric-value number)
172 173 174
		  (if (looking-at "\\s-*-?[0-9]+")
		      (progn
			(goto-char (match-end 0))
175
			(string-to-number (match-string 0)))
Karl Heuer's avatar
Karl Heuer committed
176 177
		    0))))

178
(defun increment-register (number register)
Karl Heuer's avatar
Karl Heuer committed
179
  "Add NUMBER to the contents of register REGISTER.
180
Interactively, NUMBER is the prefix arg."
Karl Heuer's avatar
Karl Heuer committed
181
  (interactive "p\ncIncrement register: ")
182
  (or (numberp (get-register register))
Karl Heuer's avatar
Karl Heuer committed
183
      (error "Register does not contain a number"))
184
  (set-register register (+ number (get-register register))))
Richard M. Stallman's avatar
Richard M. Stallman committed
185

186
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
187
  "Display what is contained in register named REGISTER.
188
The Lisp value REGISTER is a character."
Richard M. Stallman's avatar
Richard M. Stallman committed
189
  (interactive "cView register: ")
190
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
191
    (if (null val)
192
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
193
      (with-output-to-temp-buffer "*Output*"
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
	(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 ")
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
  (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)
256 257 258 259
      (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))
260 261 262 263
      (if verbose
	  (progn
	    (princ "the text:\n")
	    (princ val))
264
	(cond
265 266 267 268 269 270 271 272 273 274 275
	 ;; 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")))))
276 277 278
     (t
      (princ "Garbage:\n")
      (if verbose (prin1 val))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
279

280 281
(defun insert-register (register &optional arg)
  "Insert contents of register REGISTER.  (REGISTER is a character.)
Richard M. Stallman's avatar
Richard M. Stallman committed
282 283 284
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."
285
  (interactive "*cInsert register: \nP")
Richard M. Stallman's avatar
Richard M. Stallman committed
286
  (push-mark)
287
  (let ((val (get-register register)))
288 289 290 291
    (cond
     ((consp val)
      (insert-rectangle val))
     ((stringp val)
292
      (insert-for-yank val))
Karl Heuer's avatar
Karl Heuer committed
293
     ((numberp val)
294 295 296
      (princ val (current-buffer)))
     ((and (markerp val) (marker-position val))
      (princ (marker-position val) (current-buffer)))
297 298 299 300
     ((and (fboundp 'semantic-foreign-tag-p)
	   semantic-mode
	   (semantic-foreign-tag-p val))
      (semantic-insert-foreign-tag val))
301 302
     (t
      (error "Register does not contain text"))))
Richard M. Stallman's avatar
Richard M. Stallman committed
303 304
  (if (not arg) (exchange-point-and-mark)))

305
(defun copy-to-register (register start end &optional delete-flag)
306 307
  "Copy region into register REGISTER.
With prefix arg, delete as well.
308
Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
309 310
START and END are buffer positions indicating what to copy."
  (interactive "cCopy to register: \nr\nP")
311
  (set-register register (filter-buffer-substring start end))
Richard M. Stallman's avatar
Richard M. Stallman committed
312 313
  (if delete-flag (delete-region start end)))

314 315 316 317
(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
318 319
START and END are buffer positions indicating what to append."
  (interactive "cAppend to register: \nr\nP")
320 321 322 323 324 325
  (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
326 327
  (if delete-flag (delete-region start end)))

328 329 330 331
(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
332 333
START and END are buffer positions indicating what to prepend."
  (interactive "cPrepend to register: \nr\nP")
334 335 336 337 338 339
  (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
340 341
  (if delete-flag (delete-region start end)))

342 343
(defun copy-rectangle-to-register (register start end &optional delete-flag)
  "Copy rectangular region into register REGISTER.
344 345
With prefix arg, delete as well.
To insert this register in the buffer, use \\[insert-register].
346 347

Called from a program, takes four args: REGISTER, START, END and DELETE-FLAG.
Richard M. Stallman's avatar
Richard M. Stallman committed
348 349
START and END are buffer positions giving two corners of rectangle."
  (interactive "cCopy rectangle to register: \nr\nP")
350
  (set-register register
Richard M. Stallman's avatar
Richard M. Stallman committed
351 352 353
		(if delete-flag
		    (delete-extract-rectangle start end)
		  (extract-rectangle start end))))
Eric S. Raymond's avatar
Eric S. Raymond committed
354

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