;;; saveplace.el --- automatically save place in files
-;; Copyright (C) 1993, 1994, 2001, 2002, 2003, 2004,
-;; 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 1993-1994, 2001-2014 Free Software Foundation, Inc.
;; Author: Karl Fogel <kfogel@red-bean.com>
-;; Maintainer: FSF
+;; Maintainer: emacs-devel@gnu.org
;; Created: July, 1993
;; Keywords: bookmarks, placeholders
;; This file is part of GNU Emacs.
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; 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, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
;; this is what I was using during testing:
-;; (define-key ctl-x-map "p" 'toggle-save-place)
+;; (define-key ctl-x-map "p" 'toggle-save-place-globally)
(defgroup save-place nil
"Automatically save place in files."
This alist is saved between Emacs sessions.")
(defcustom save-place nil
- "*Non-nil means automatically save place in each 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.
-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, set this to t using the Customize facility, or put the
+following code in your init file:
\(setq-default save-place t)
-\(require 'saveplace)
-
-or else use the Custom facility to set this option."
+\(require 'saveplace)"
:type 'boolean
:require 'saveplace
:group 'save-place)
(make-variable-buffer-local 'save-place)
-(defcustom save-place-file (convert-standard-filename "~/.emacs-places")
- "*Name of the file that records `save-place-alist' value."
+(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)
(defcustom save-place-version-control nil
- "*Controls whether to make numbered backups of master save-place file.
+ "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
(defvar save-place-loaded nil
"Non-nil means that the `save-place-file' has been loaded.")
-(defcustom save-place-limit nil
+(defcustom save-place-limit 400
"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)
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,
removable and network volumes."
:type 'regexp :group 'save-place)
+(defcustom save-place-ignore-files-regexp
+ "\\(?:COMMIT_EDITMSG\\|hg-editor-[[:alnum:]]+\\.txt\\|svn-commit\\.tmp\\|bzr_log\\.[[:alnum:]]+\\)$"
+ "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. 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)
+
(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
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\)"
+\(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))))
+ (if (not (or buffer-file-name (and (derived-mode-p 'dired-mode)
+ dired-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"))))
+
+(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))
- (if buffer-file-name
- (progn
- (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 ((item (or buffer-file-name
+ (and (derived-mode-p 'dired-mode)
+ dired-directory
+ (expand-file-name (if (consp dired-directory)
+ (car dired-directory)
+ dired-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)
+ dired-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.
(defun save-place-alist-to-file ()
(let ((file (expand-file-name save-place-file))
(coding-system-for-write 'utf-8))
- (save-excursion
- (set-buffer (get-buffer-create " *Saved Places*"))
+ (with-current-buffer (get-buffer-create " *Saved Places*")
(delete-region (point-min) (point-max))
(when save-place-forget-unreadable-files
(save-place-forget-unreadable-files))
(symbol-name coding-system-for-write)))
(let ((print-length nil)
(print-level nil))
- (print save-place-alist (current-buffer)))
+ (pp save-place-alist (current-buffer)))
(let ((version-control
(cond
((null save-place-version-control) nil)
;; make sure that the alist does not get overwritten, and then
;; load it if it exists:
(if (file-readable-p file)
- (save-excursion
- ;; 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.
+ (with-current-buffer (get-buffer-create " *Saved Places*")
(delete-region (point-min) (point-max))
(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:
;; put this into a save-excursion in case someone is counting on
;; another function in kill-emacs-hook to act on the last buffer
;; they were in:
- (save-excursion
- (set-buffer (car buf-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)
+ dired-directory))
+ (save-place-to-alist))
(setq buf-list (cdr buf-list))))))
(defun save-place-find-file-hook ()
(let ((cell (assoc buffer-file-name save-place-alist)))
(if cell
(progn
- (or after-find-file-from-revert-buffer
- (goto-char (cdr cell)))
+ (or revert-buffer-in-progress-p
+ (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 ((cell (assoc (and (derived-mode-p 'dired-mode)
+ dired-directory
+ (expand-file-name (if (consp dired-directory)
+ (car dired-directory)
+ dired-directory)))
+ save-place-alist)))
+ (if cell
+ (progn
+ (or revert-buffer-in-progress-p
+ (if (integerp (cdr cell))
+ (goto-char (cdr cell))
+ (and (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)))))
(add-hook 'find-file-hook 'save-place-find-file-hook t)
-(add-hook 'kill-emacs-hook 'save-place-kill-emacs-hook)
+(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...
-;;; arch-tag: 3c2ef47b-0a22-4558-b116-118c9ef454a0
;;; saveplace.el ends here
HCoop / bpt / emacs.git / blobdiff