]> code.delx.au - gnu-emacs/blobdiff - lisp/register.el
(Abbrevs): A @node line without explicit Prev, Next, and Up links.
[gnu-emacs] / lisp / register.el
index 461a517a0f66607a208b52314e472f78552342d2..8dea532410cc7ca189239414d983f470e6576cb6 100644 (file)
@@ -1,6 +1,7 @@
-;;; register.el --- register commands for Emacs.
+;;; register.el --- register commands for Emacs
 
-;; Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1993, 1994, 2002, 2003, 2004,
+;;   2005, 2006 Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: internal
@@ -18,8 +19,9 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
 
 ;;; Commentary:
 
 
 (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,
-frame configuration, mark or list.
+NAME is a character (a number).  CONTENTS is a string, number, marker or list.
 A list of strings represents a rectangle.
-A list of the form (file . NAME) represents the file named NAME.")
+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.
+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.")
 
 (defun get-register (reg)
   "Return contents of Emacs register named REG, or nil if none."
@@ -47,8 +54,7 @@ See the documentation of the variable `register-alist' for possible VALUE."
   (let ((aelt (assq register register-alist)))
     (if aelt
        (setcdr aelt value)
-      (setq aelt (cons register value))
-      (setq register-alist (cons aelt register-alist)))
+      (push (cons register value) register-alist))
     value))
 
 (defun point-to-register (register &optional arg)
@@ -57,22 +63,29 @@ With prefix argument, store current frame configuration.
 Use \\[jump-to-register] to go to that location or restore that configuration.
 Argument is a character, naming the register."
   (interactive "cPoint to register: \nP")
+  ;; Turn the marker into a file-ref if the buffer is killed.
+  (add-hook 'kill-buffer-hook 'register-swap-out nil t)
   (set-register register
-               (if arg (current-frame-configuration) (point-marker))))
+               (if arg (list (current-frame-configuration) (point-marker))
+                 (point-marker))))
 
 (defun window-configuration-to-register (register &optional arg)
   "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."
   (interactive "cWindow configuration to register: \nP")
-  (set-register register (current-window-configuration)))
+  ;; current-window-configuration does not include the value
+  ;; of point in the current buffer, so record that separately.
+  (set-register register (list (current-window-configuration) (point-marker))))
 
 (defun frame-configuration-to-register (register &optional arg)
   "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."
   (interactive "cFrame configuration to register: \nP")
-  (set-register register (current-frame-configuration)))
+  ;; current-frame-configuration does not include the value
+  ;; of point in the current buffer, so record that separately.
+  (set-register register (list (current-frame-configuration) (point-marker))))
 
 (defalias 'register-to-point 'jump-to-register)
 (defun jump-to-register (register &optional delete)
@@ -88,11 +101,12 @@ delete any existing frames that the frame configuration doesn't mention.
   (interactive "cJump to register: \nP")
   (let ((val (get-register register)))
     (cond
-     ((and (fboundp 'frame-configuration-p)
-          (frame-configuration-p val))
-      (set-frame-configuration val (not delete)))
-     ((window-configuration-p val)
-      (set-window-configuration val))
+     ((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)))
      ((markerp val)
       (or (marker-buffer val)
          (error "That register's buffer no longer exists"))
@@ -100,36 +114,49 @@ delete any existing frames that the frame configuration doesn't mention.
       (goto-char val))
      ((and (consp val) (eq (car val) 'file))
       (find-file (cdr val)))
+     ((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)))
      (t
       (error "Register doesn't contain a buffer position or configuration")))))
 
-;(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))))
+(defun register-swap-out ()
+  "Turn markers into file-query references when a buffer is killed."
+  (and buffer-file-name
+       (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))))))))
+
+(defun number-to-register (number register)
+  "Store a number in a register.
+Two args, NUMBER and REGISTER (a character, naming the register).
+If NUMBER is nil, a decimal number is read from the buffer starting
+at point, and point moves to the end of that number.
+Interactively, NUMBER is the prefix arg (none means nil)."
+  (interactive "P\ncNumber to register: ")
+  (set-register register
+               (if number
+                   (prefix-numeric-value number)
+                 (if (looking-at "\\s-*-?[0-9]+")
+                     (progn
+                       (goto-char (match-end 0))
+                       (string-to-number (match-string 0)))
+                   0))))
+
+(defun increment-register (number register)
+  "Add NUMBER to the contents of register REGISTER.
+Interactively, NUMBER is the prefix arg."
+  (interactive "p\ncIncrement register: ")
+  (or (numberp (get-register register))
+      (error "Register does not contain a number"))
+  (set-register register (+ number (get-register register))))
 
 (defun view-register (register)
   "Display what is contained in register named REGISTER.
@@ -139,47 +166,91 @@ The Lisp value REGISTER is a character."
     (if (null val)
        (message "Register %s is empty" (single-key-description register))
       (with-output-to-temp-buffer "*Output*"
-       (princ "Register ")
-       (princ (single-key-description register))
-       (princ " contains ")
-       (cond
-        ((integerp val)
-         (princ val))
-
-        ((markerp val)
-         (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)))))
-
-        ((window-configuration-p val)
-         (princ "a window configuration."))
-
-        ((frame-configuration-p val)
-         (princ "a frame configuration."))
-
-        ((and (consp val) (eq (car val) 'file))
-         (princ "the file ")
-         (prin1 (cdr val))
-         (princ "."))
-
-        ((consp val)
-         (princ "the rectangle:\n")
-         (while val
-           (princ (car val))
-           (terpri)
-           (setq val (cdr val))))
-
-        ((stringp val)
-         (princ "the text:\n")
-         (princ val))
+       (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 ")
+  (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)
+      (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))
+      (if verbose
+         (progn
+           (princ "the text:\n")
+           (princ val))
+       (cond
+        ;; 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 "Garbage:\n")
-         (prin1 val)))))))
+         (princ "the empty string")))))
+     (t
+      (princ "Garbage:\n")
+      (if verbose (prin1 val))))))
 
 (defun insert-register (register &optional arg)
   "Insert contents of register REGISTER.  (REGISTER is a character.)
@@ -193,8 +264,8 @@ Interactively, second arg is non-nil if prefix arg is supplied."
      ((consp val)
       (insert-rectangle val))
      ((stringp val)
-      (insert val))
-     ((integerp val)
+      (insert-for-yank val))
+     ((numberp val)
       (princ val (current-buffer)))
      ((and (markerp val) (marker-position val))
       (princ (marker-position val) (current-buffer)))
@@ -207,7 +278,7 @@ Interactively, second arg is non-nil if prefix arg is supplied."
 Called from program, takes four args: REGISTER, START, END and DELETE-FLAG.
 START and END are buffer positions indicating what to copy."
   (interactive "cCopy to register: \nr\nP")
-  (set-register register (buffer-substring start end))
+  (set-register register (filter-buffer-substring start end))
   (if delete-flag (delete-region start end)))
 
 (defun append-to-register (register start end &optional delete-flag)
@@ -219,7 +290,7 @@ START and END are buffer positions indicating what to append."
   (or (stringp (get-register register))
       (error "Register does not contain text"))
   (set-register register (concat (get-register register)
-                           (buffer-substring start end)))
+                           (filter-buffer-substring start end)))
   (if delete-flag (delete-region start end)))
 
 (defun prepend-to-register (register start end &optional delete-flag)
@@ -230,14 +301,16 @@ START and END are buffer positions indicating what to prepend."
   (interactive "cPrepend to register: \nr\nP")
   (or (stringp (get-register register))
       (error "Register does not contain text"))
-  (set-register register (concat (buffer-substring start end)
+  (set-register register (concat (filter-buffer-substring start end)
                            (get-register register)))
   (if delete-flag (delete-region start end)))
 
 (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.
+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.
 START and END are buffer positions giving two corners of rectangle."
   (interactive "cCopy rectangle to register: \nr\nP")
   (set-register register
@@ -245,4 +318,6 @@ START and END are buffer positions giving two corners of rectangle."
                    (delete-extract-rectangle start end)
                  (extract-rectangle start end))))
 
+(provide 'register)
+;;; arch-tag: ce14dd68-8265-475f-9341-5d4ec5a53035
 ;;; register.el ends here