Doc fixes.

[gnu-emacs] / lisp / saveplace.el

diff --git a/lisp/saveplace.el b/lisp/saveplace.el
index c2927526eaf9020c3e9b6ed448111d4bd2a811a6..5ac3f344c62ddf64e9de550de50945b518b03ad3 100644 (file)
--- a/lisp/saveplace.el
+++ b/lisp/saveplace.el
@@ -5,7 +5,6 @@
 ;; Author: Karl Fogel <kfogel@cs.oberlin.edu>
 ;; Maintainer: FSF
 ;; Created: July, 1993
 ;; Author: Karl Fogel <kfogel@cs.oberlin.edu>
 ;; Maintainer: FSF
 ;; Created: July, 1993

-;; Version: 1.2

 ;; Keywords: bookmarks, placeholders
 
 ;; This file is part of GNU Emacs.
 ;; Keywords: bookmarks, placeholders
 
 ;; This file is part of GNU Emacs.


@@ -21,8 +20,11 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
 ;; 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., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
+
+;;; Commentary:

 
 ;; Automatically save place in files, so that visiting them later
 ;; (even during a different Emacs session) automatically moves point
 
 ;; Automatically save place in files, so that visiting them later
 ;; (even during a different Emacs session) automatically moves point


@@ -33,9 +35,16 @@
 ;; Thanks to Stefan Schoef, who sent a patch with the
 ;; `save-place-version-control' stuff in it.
 
 ;; Thanks to Stefan Schoef, who sent a patch with the
 ;; `save-place-version-control' stuff in it.
 

+;;; Code:
+

 ;; this is what I was using during testing:
 ;; (define-key ctl-x-map "p" 'toggle-save-place)
 
 ;; this is what I was using during testing:
 ;; (define-key ctl-x-map "p" 'toggle-save-place)
 

+(defgroup save-place nil
+  "Automatically save place in files."
+  :group 'data)
+
+

 (defvar save-place-alist nil
   "Alist of saved places to go back to when revisiting files.
 Each element looks like (FILENAME . POSITION);
 (defvar save-place-alist nil
   "Alist of saved places to go back to when revisiting files.
 Each element looks like (FILENAME . POSITION);


@@ -43,7 +52,7 @@ visiting file FILENAME goes automatically to position POSITION
 rather than the beginning of the buffer.
 This alist is saved between Emacs sessions.")
 
 rather than the beginning of the buffer.
 This alist is saved between Emacs sessions.")
 

-(defvar save-place nil
+(defcustom save-place nil

   "*Non-nil means automatically save place in each file.
 This means when you visit a file, point goes to the last place
 where it was when you previously visited the same file.
   "*Non-nil means automatically save place in each file.
 This means when you visit a file, point goes to the last place
 where it was when you previously visited the same file.


@@ -52,23 +61,38 @@ This variable is automatically buffer-local.
 If you wish your place in any file to always be automatically saved,
 simply put this in your `~/.emacs' file:
 
 If you wish your place in any file to always be automatically saved,
 simply put this in your `~/.emacs' file:
 

-\(setq-default save-place t\)")
+\(setq-default save-place t\)"
+  :type 'boolean
+  :group 'save-place)

 
 (make-variable-buffer-local 'save-place)
 
 
 (make-variable-buffer-local 'save-place)
 

-(defvar save-place-file "~/.emacs-places"
-  "*Name of the file that records `save-place-alist' value.")
+(defcustom save-place-file (convert-standard-filename "~/.emacs-places")
+  "*Name of the file that records `save-place-alist' value."
+  :type 'file
+  :group 'save-place)

 
 

-(defvar save-place-version-control 'nospecial
+(defcustom save-place-version-control nil

   "*Controls whether to make numbered backups of master save-place file.
 It can have four values: t, nil, `never', and `nospecial'.  The first
 three have the same meaning that they do for the variable
 `version-control', and the final value `nospecial' means just use the
   "*Controls whether to make numbered backups of master save-place file.
 It can have four values: t, nil, `never', and `nospecial'.  The first
 three have the same meaning that they do for the variable
 `version-control', and the final value `nospecial' means just use the

-value of `version-control'.")
+value of `version-control'."
+  :type '(radio (const :tag "Unconditionally" t)
+               (const :tag "For VC Files" nil)
+               (const never)
+               (const :tag "Use value of `version-control'" nospecial))
+  :group 'save-place)

 
 (defvar save-place-loaded nil
   "Non-nil means that the `save-place-file' has been loaded.")
 
 
 (defvar save-place-loaded nil
   "Non-nil means that the `save-place-file' has been loaded.")
 

+(defcustom save-place-limit nil
+  "Maximum number of entries to retain in the list; nil means no limit."
+  :type '(choice (integer :tag "Entries" :value 1)
+                (const :tag "No Limit" nil))
+  :group 'save-place)
+

 (defun toggle-save-place (&optional parg)
   "Toggle whether to save your place in this file between sessions.
 If this mode is enabled, point is recorded when you kill the buffer
 (defun toggle-save-place (&optional parg)
   "Toggle whether to save your place in this file between sessions.
 If this mode is enabled, point is recorded when you kill the buffer


@@ -83,13 +107,12 @@ To save places automatically in all files, put this in your `.emacs' file:
 \(setq-default save-place t\)"
   (interactive "P")
   (if (not buffer-file-name)
 \(setq-default save-place t\)"
   (interactive "P")
   (if (not buffer-file-name)

-      (message 
-       (format "Buffer \"%s\" not visiting a file." (buffer-name)))
+      (message "Buffer `%s' not visiting a file" (buffer-name))

     (if (and save-place (or (not parg) (<= parg 0)))
        (progn
     (if (and save-place (or (not parg) (<= parg 0)))
        (progn

-         (message "No place will be saved in this file.")
+         (message "No place will be saved in this file")

          (setq save-place nil))
          (setq save-place nil))

-      (message "Place will be saved.")
+      (message "Place will be saved")

       (setq save-place t))))
 
 (defun save-place-to-alist ()
       (setq save-place t))))
 
 (defun save-place-to-alist ()


@@ -102,18 +125,22 @@ To save places automatically in all files, put this in your `.emacs' file:
   (or save-place-loaded (load-save-place-alist-from-file))
   (if buffer-file-name
       (progn
   (or save-place-loaded (load-save-place-alist-from-file))
   (if buffer-file-name
       (progn

-        (let ((cell (assoc buffer-file-name save-place-alist)))
+        (let ((cell (assoc buffer-file-name save-place-alist))
+             (position (if (not (eq major-mode 'hexl-mode))
+                           (point)
+                         (1+ (hexl-current-address)))))

           (if cell
           (if cell

-              (setq save-place-alist (delq cell save-place-alist))))
-        (if save-place
-            (setq save-place-alist
-                  (cons (cons buffer-file-name (point))
-                        save-place-alist))))))
+              (setq save-place-alist (delq cell save-place-alist)))
+         (if (and save-place
+                  (not (= position 1)))  ;; Optimize out the degenerate case.
+             (setq save-place-alist
+                   (cons (cons buffer-file-name position)
+                         save-place-alist)))))))

 
 (defun save-place-alist-to-file ()
   (let ((file (expand-file-name save-place-file)))
     (save-excursion
 
 (defun save-place-alist-to-file ()
   (let ((file (expand-file-name save-place-file)))
     (save-excursion

-      (message (format "Saving places to %s..." file))
+      (message "Saving places to %s..." file)

       (set-buffer (get-buffer-create " *Saved Places*"))
       (delete-region (point-min) (point-max))
       (if (file-readable-p file)
       (set-buffer (get-buffer-create " *Saved Places*"))
       (delete-region (point-min) (point-max))
       (if (file-readable-p file)


@@ -130,7 +157,7 @@ To save places automatically in all files, put this in your `.emacs' file:
                t))))
         (write-file file)
         (kill-buffer (current-buffer))
                t))))
         (write-file file)
         (kill-buffer (current-buffer))

-        (message (format "Saving places to %s... done." file))))))
+        (message "Saving places to %s...done" file)))))

 
 (defun load-save-place-alist-from-file ()
   (if (not save-place-loaded)
 
 (defun load-save-place-alist-from-file ()
   (if (not save-place-loaded)


@@ -141,8 +168,7 @@ To save places automatically in all files, put this in your `.emacs' file:
           ;; load it if it exists:
           (if (file-readable-p file)
               (save-excursion
           ;; load it if it exists:
           (if (file-readable-p file)
               (save-excursion

-                (message (format "Loading places from %s..."
-                                 save-place-file))
+                (message "Loading places from %s..." save-place-file)

                 ;; don't want to use find-file because we have been
                 ;; adding hooks to it.
                 (set-buffer (get-buffer-create " *Saved Places*"))
                 ;; don't want to use find-file because we have been
                 ;; adding hooks to it.
                 (set-buffer (get-buffer-create " *Saved Places*"))


@@ -152,10 +178,26 @@ To save places automatically in all files, put this in your `.emacs' file:
                 (setq save-place-alist 
                       (car (read-from-string
                             (buffer-substring (point-min) (point-max)))))
                 (setq save-place-alist 
                       (car (read-from-string
                             (buffer-substring (point-min) (point-max)))))

+
+                ;; If there is a limit, and we're over it, then we'll
+                ;; have to truncate the end of the list:
+                (if save-place-limit
+                    (if (<= save-place-limit 0)
+                        ;; Zero gets special cased.  I'm not thrilled
+                        ;; with this, but the loop for >= 1 is tight.
+                        (setq save-place-alist nil)
+                      ;; Else the limit is >= 1, so enforce it by
+                      ;; counting and then `setcdr'ing.
+                      (let ((s save-place-alist)
+                            (count 1))
+                        (while s
+                          (if (>= count save-place-limit)
+                              (setcdr s nil)
+                            (setq count (1+ count)))
+                          (setq s (cdr s))))))
+                  

                 (kill-buffer (current-buffer))
                 (kill-buffer (current-buffer))

-                (message (format "Loading places from %s... done." file))
-                t)
-            t)
+                (message "Loading places from %s...done" file)))

           nil))))
 
 (defun save-places-to-alist ()
           nil))))
 
 (defun save-places-to-alist ()


@@ -177,14 +219,19 @@ To save places automatically in all files, put this in your `.emacs' file:
   (or save-place-loaded (load-save-place-alist-from-file))
   (let ((cell (assoc buffer-file-name save-place-alist)))
     (if cell
   (or save-place-loaded (load-save-place-alist-from-file))
   (let ((cell (assoc buffer-file-name save-place-alist)))
     (if cell

-        (progn
-          (goto-char (cdr cell))
+       (progn
+         (or after-find-file-from-revert-buffer
+             (goto-char (cdr cell)))

           ;; and make sure it will be saved again for later
           (setq save-place t)))))
 
 (defun save-place-kill-emacs-hook ()
           ;; and make sure it will be saved again for later
           (setq save-place t)))))
 
 (defun save-place-kill-emacs-hook ()

+  ;; First update the alist.  This loads the old save-place-file if nec.

   (save-places-to-alist)
   (save-places-to-alist)

-  (save-place-alist-to-file))
+  ;; Now save the alist in the file, if we have ever loaded the file
+  ;; (including just now).
+  (if save-place-loaded
+      (save-place-alist-to-file)))

 
 (add-hook 'find-file-hooks 'save-place-find-file-hook t)
 
 
 (add-hook 'find-file-hooks 'save-place-find-file-hook t)