;;; saveplace.el --- automatically save place in files
-;; Copyright (C) 1993-1994, 2001-2012 Free Software Foundation, Inc.
+;; Copyright (C) 1993-1994, 2001-2016 Free Software Foundation, Inc.
;; Author: Karl Fogel <kfogel@red-bean.com>
-;; Maintainer: FSF
+;; Maintainer: emacs-devel@gnu.org
;; Created: July, 1993
;; Keywords: bookmarks, placeholders
rather than the beginning of the buffer.
This alist is saved between Emacs sessions.")
-(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.
-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:
-
-\(setq-default save-place t)
-\(require 'saveplace)
-
-or else use the Custom facility to set this option."
- :type 'boolean
- :require 'saveplace
- :group 'save-place)
-
-(make-variable-buffer-local 'save-place)
-
-(defcustom save-place-file (convert-standard-filename "~/.emacs-places")
+(defcustom save-place-file (locate-user-emacs-file "places" ".emacs-places")
"Name of the file that records `save-place-alist' value."
- :type 'file
- :group 'save-place)
+ :version "24.4" ; added locate-user-emacs-file
+ :type 'file)
(defcustom save-place-version-control nil
"Controls whether to make numbered backups of master save-place file.
: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)
+ (const :tag "Use value of `version-control'" nospecial)))
(defvar save-place-loaded nil
"Non-nil means that the `save-place-file' has been loaded.")
"Maximum number of entries to retain in the list; nil means no limit."
:version "24.1" ; nil -> 400
:type '(choice (integer :tag "Entries" :value 1)
- (const :tag "No Limit" nil))
- :group 'save-place)
+ (const :tag "No Limit" nil)))
(defcustom save-place-forget-unreadable-files t
"Non-nil means forget place in unreadable files.
The filenames in `save-place-alist' that do not match
`save-place-skip-check-regexp' are filtered through
-`file-readable-p'. if nil, their alist entries are removed.
+`file-readable-p'. If nil, their alist entries are removed.
You may do this anytime by calling the complementary function,
`save-place-forget-unreadable-files'. When this option is turned on,
this happens automatically before saving `save-place-alist' to
`save-place-file'."
- :type 'boolean :group 'save-place)
+ :type 'boolean)
(defcustom save-place-save-skipped t
"If non-nil, remember files matching `save-place-skip-check-regexp'.
When filtering `save-place-alist' for unreadable files, some will not
be checked, based on said regexp, and instead saved or forgotten based
on this flag."
- :type 'boolean :group 'save-place)
+ :type 'boolean)
(defcustom save-place-skip-check-regexp
;; thanks to ange-ftp-name-format
Files for which such a check may be inconvenient include those on
removable and network volumes."
- :type 'regexp :group 'save-place)
+ :type 'regexp)
(defcustom save-place-ignore-files-regexp
"\\(?:COMMIT_EDITMSG\\|hg-editor-[[:alnum:]]+\\.txt\\|svn-commit\\.tmp\\|bzr_log\\.[[:alnum:]]+\\)$"
- "Regexp matching files for which no location should be recorded.
+ "Regexp matching files for which no position should be recorded.
Useful for temporary file such as commit message files that are
-automatically created by the VCS."
+automatically created by the VCS. If set to nil, this feature is
+disabled, i.e., the position is recorded for all files."
:version "24.1"
- :type 'regexp :group 'save-place)
+ :type 'regexp)
+
+(declare-function dired-current-directory "dired" (&optional localp))
+
+(defun save-place--setup-hooks (add)
+ (cond
+ (add
+ (add-hook 'find-file-hook #'save-place-find-file-hook t)
+ (add-hook 'dired-initial-position-hook #'save-place-dired-hook)
+ (unless noninteractive
+ (add-hook 'kill-emacs-hook #'save-place-kill-emacs-hook))
+ (add-hook 'kill-buffer-hook #'save-place-to-alist))
+ (t
+ ;; We should remove the hooks, but only if save-place-mode
+ ;; is nil everywhere. Is it worth the trouble, tho?
+ ;; (unless (or (default-value 'save-place-mode)
+ ;; (cl-some <save-place-local-mode-p> (buffer-list)))
+ ;; (remove-hook 'find-file-hook #'save-place-find-file-hook)
+ ;; (remove-hook 'dired-initial-position-hook #'save-place-dired-hook)
+ ;; (remove-hook 'kill-emacs-hook #'save-place-kill-emacs-hook)
+ ;; (remove-hook 'kill-buffer-hook #'save-place-to-alist))
+ )))
+
+(define-obsolete-variable-alias 'save-place 'save-place-mode "25.1")
+;;;###autoload
+(define-minor-mode save-place-mode
+ "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."
+ :global t
+ :group 'save-place
+ (save-place--setup-hooks save-place-mode))
-(defun toggle-save-place (&optional parg)
+(make-variable-buffer-local 'save-place-mode)
+
+(define-obsolete-function-alias 'toggle-save-place
+ #'save-place-local-mode "25.1")
+;;;###autoload
+(define-minor-mode save-place-local-mode
"Toggle whether to save your place in this file between sessions.
If this mode is enabled, point is recorded when you kill the buffer
or exit Emacs. Visiting this file again will go to that position,
If called with a prefix arg, the mode is enabled if and only if
the argument is positive.
-To save places automatically in all files, put this in your `.emacs' file:
+To save places automatically in all files, put this in your init
+file:
-\(setq-default save-place t\)"
- (interactive "P")
- (if (not buffer-file-name)
- (message "Buffer `%s' not visiting a file" (buffer-name))
- (if (and save-place (or (not parg) (<= parg 0)))
- (progn
- (message "No place will be saved in this file")
- (setq save-place nil))
- (message "Place will be saved")
- (setq save-place t))))
+\(save-place-mode 1)"
+ :variable save-place-mode
+ (if (not (or buffer-file-name (and (derived-mode-p 'dired-mode)
+ (boundp 'dired-subdir-alist)
+ dired-subdir-alist
+ (dired-current-directory))))
+ (message "Buffer `%s' not visiting a file or directory" (buffer-name))
+ (save-place--setup-hooks save-place-mode)))
+
+(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
(defun save-place-to-alist ()
;; put filename and point in a cons box and then cons that onto the
;; file. If not, do so, then feel free to modify the alist. It
;; will be saved again when Emacs is killed.
(or save-place-loaded (load-save-place-alist-from-file))
- (when (and buffer-file-name
- (not (string-match save-place-ignore-files-regexp
- buffer-file-name)))
- (let ((cell (assoc buffer-file-name save-place-alist))
- (position (if (not (eq major-mode 'hexl-mode))
- (point)
- (with-no-warnings
- (1+ (hexl-current-address))))))
- (if cell
- (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))))))
+ (let* ((directory (and (derived-mode-p 'dired-mode)
+ (boundp 'dired-subdir-alist)
+ dired-subdir-alist
+ (dired-current-directory)))
+ (item (or buffer-file-name
+ (and directory
+ (expand-file-name (if (consp directory)
+ (car directory)
+ directory))))))
+ (when (and item
+ (or (not save-place-ignore-files-regexp)
+ (not (string-match save-place-ignore-files-regexp
+ item))))
+ (let ((cell (assoc item save-place-alist))
+ (position (cond ((eq major-mode 'hexl-mode)
+ (with-no-warnings
+ (1+ (hexl-current-address))))
+ ((and (derived-mode-p 'dired-mode) directory)
+ (let ((filename (dired-get-filename nil t)))
+ (if filename
+ `((dired-filename . ,filename))
+ (point))))
+ (t (point)))))
+ (if cell
+ (setq save-place-alist (delq cell save-place-alist)))
+ (if (and save-place
+ (not (and (integerp position)
+ (= position 1)))) ;; Optimize out the degenerate case.
+ (setq save-place-alist
+ (cons (cons item position)
+ save-place-alist)))))))
(defun save-place-forget-unreadable-files ()
"Remove unreadable files from `save-place-alist'.
For each entry in the alist, if `file-readable-p' returns nil for the
-filename, remove the entry. Save the new alist \(as the first pair
-may have changed\) back to `save-place-alist'."
+filename, remove the entry. Save the new alist (as the first pair
+may have changed) back to `save-place-alist'."
(interactive)
;; the following was adapted from an in-place filtering function,
;; `filter-mod', used in the original.
(symbol-name coding-system-for-write)))
(let ((print-length nil)
(print-level nil))
- (pp (sort save-place-alist
- (lambda (a b) (string< (car a) (car b))))
- (current-buffer)))
+ (pp save-place-alist (current-buffer)))
(let ((version-control
(cond
((null save-place-version-control) nil)
(insert-file-contents file)
(goto-char (point-min))
(setq save-place-alist
- (car (read-from-string
- (buffer-substring (point-min) (point-max)))))
+ (with-demoted-errors "Error reading save-place-file: %S"
+ (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:
(with-current-buffer (car buf-list)
;; save-place checks buffer-file-name too, but we can avoid
;; overhead of function call by checking here too.
- (and buffer-file-name (save-place-to-alist))
+ (and (or buffer-file-name (and (derived-mode-p 'dired-mode)
+ (boundp 'dired-subdir-alist)
+ dired-subdir-alist
+ (dired-current-directory)))
+ (save-place-to-alist))
(setq buf-list (cdr buf-list))))))
(defun save-place-find-file-hook ()
(if cell
(progn
(or revert-buffer-in-progress-p
- (goto-char (cdr cell)))
+ (and (integerp (cdr cell))
+ (goto-char (cdr cell))))
+ ;; and make sure it will be saved again for later
+ (setq save-place t)))))
+
+(declare-function dired-goto-file "dired" (file))
+
+(defun save-place-dired-hook ()
+ "Position the point in a Dired buffer."
+ (or save-place-loaded (load-save-place-alist-from-file))
+ (let* ((directory (and (derived-mode-p 'dired-mode)
+ (boundp 'dired-subdir-alist)
+ dired-subdir-alist
+ (dired-current-directory)))
+ (cell (assoc (and directory
+ (expand-file-name (if (consp directory)
+ (car directory)
+ directory)))
+ save-place-alist)))
+ (if cell
+ (progn
+ (or revert-buffer-in-progress-p
+ (cond
+ ((integerp (cdr cell))
+ (goto-char (cdr cell)))
+ ((and (listp (cdr cell)) (assq 'dired-filename (cdr cell)))
+ (dired-goto-file (cdr (assq 'dired-filename (cdr cell)))))))
;; and make sure it will be saved again for later
(setq save-place t)))))
(if save-place-loaded
(save-place-alist-to-file)))
-(add-hook 'find-file-hook 'save-place-find-file-hook t)
-
-(unless noninteractive
- (add-hook 'kill-emacs-hook 'save-place-kill-emacs-hook))
-
-(add-hook 'kill-buffer-hook 'save-place-to-alist)
-
-(provide 'saveplace) ; why not...
-
+(provide 'saveplace)
;;; saveplace.el ends here