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,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008, 2009 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.

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

35 36
;;; Global key bindings

37 38 39 40 41 42 43 44 45 46 47 48 49
(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)
50

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

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

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

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

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

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

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

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

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

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

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

185
(defun view-register (register)
Richard M. Stallman's avatar
Richard M. Stallman committed
186
  "Display what is contained in register named REGISTER.
187
The Lisp value REGISTER is a character."
Richard M. Stallman's avatar
Richard M. Stallman committed
188
  (interactive "cView register: ")
189
  (let ((val (get-register register)))
Richard M. Stallman's avatar
Richard M. Stallman committed
190
    (if (null val)
191
	(message "Register %s is empty" (single-key-description register))
Richard M. Stallman's avatar
Richard M. Stallman committed
192
      (with-output-to-temp-buffer "*Output*"
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
	(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 ")
210 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
  (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)
255 256 257 258
      (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))
259 260 261 262
      (if verbose
	  (progn
	    (princ "the text:\n")
	    (princ val))
263
	(cond
264 265 266 267 268 269 270 271 272 273 274
	 ;; 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")))))
275 276 277
     (t
      (princ "Garbage:\n")
      (if verbose (prin1 val))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
278

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

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

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

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

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

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

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