;;; saveplace.el --- automatically save place in files
-;; Copyright (C) 1993-1994, 2001-2014 Free Software Foundation, Inc.
+;; Copyright (C) 1993-1994, 2001-2016 Free Software Foundation, Inc.
;; Author: Karl Fogel <kfogel@red-bean.com>
;; Maintainer: emacs-devel@gnu.org
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.
-
-If you wish your place in any file to always be automatically
-saved, set this to t using the Customize facility, or put the
-following code in your init file:
-
-\(setq-default save-place t)
-\(require 'saveplace)"
- :type 'boolean
- :require 'saveplace
- :group 'save-place)
-
-(make-variable-buffer-local 'save-place)
-
(defcustom save-place-file (locate-user-emacs-file "places" ".emacs-places")
"Name of the file that records `save-place-alist' value."
:version "24.4" ; added locate-user-emacs-file
- :type 'file
- :group 'save-place)
+ :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.
`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:]]+\\)$"
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 toggle-save-place (&optional parg)
+(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))
+
+(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,
To save places automatically in all files, put this in your init
file:
-\(setq-default save-place t)"
- (interactive "P")
+\(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))
- (setq save-place (if parg
- (> (prefix-numeric-value parg) 0)
- (not save-place)))
- (message (if save-place
- "Place will be saved"
- "No place will be saved in this file"))))
+ (save-place--setup-hooks save-place-mode)))
(declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
;; will be saved again when Emacs is killed.
(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)))
(item (or buffer-file-name
(and directory
;; save-place checks buffer-file-name too, but we can avoid
;; overhead of function call by checking here too.
(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))))))
"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)
(if save-place-loaded
(save-place-alist-to-file)))
-(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)
-
-(provide 'saveplace) ; why not...
-
+(provide 'saveplace)
;;; saveplace.el ends here