38412
|
1 ;;; saveplace.el --- automatically save place in files
|
4596
|
2
|
40162
|
3 ;; Copyright (C) 1993, 1994, 2001 Free Software Foundation, Inc.
|
4596
|
4
|
38224
|
5 ;; Author: Karl Fogel <kfogel@red-bean.com>
|
4596
|
6 ;; Maintainer: FSF
|
|
7 ;; Created: July, 1993
|
|
8 ;; Keywords: bookmarks, placeholders
|
|
9
|
|
10 ;; This file is part of GNU Emacs.
|
|
11
|
|
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
|
|
13 ;; it under the terms of the GNU General Public License as published by
|
|
14 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
15 ;; any later version.
|
|
16
|
|
17 ;; GNU Emacs is distributed in the hope that it will be useful,
|
|
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
20 ;; GNU General Public License for more details.
|
|
21
|
|
22 ;; You should have received a copy of the GNU General Public License
|
14169
|
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
|
|
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
25 ;; Boston, MA 02111-1307, USA.
|
|
26
|
15192
|
27 ;;; Commentary:
|
|
28
|
4596
|
29 ;; Automatically save place in files, so that visiting them later
|
|
30 ;; (even during a different Emacs session) automatically moves point
|
|
31 ;; to the saved position, when the file is first found. Uses the
|
|
32 ;; value of buffer-local variable save-place to determine whether to
|
|
33 ;; save position or not.
|
|
34 ;;
|
6662
|
35 ;; Thanks to Stefan Schoef, who sent a patch with the
|
|
36 ;; `save-place-version-control' stuff in it.
|
4596
|
37
|
15192
|
38 ;;; Code:
|
|
39
|
4596
|
40 ;; this is what I was using during testing:
|
|
41 ;; (define-key ctl-x-map "p" 'toggle-save-place)
|
|
42
|
17481
|
43 (defgroup save-place nil
|
|
44 "Automatically save place in files."
|
|
45 :group 'data)
|
|
46
|
|
47
|
4596
|
48 (defvar save-place-alist nil
|
|
49 "Alist of saved places to go back to when revisiting files.
|
|
50 Each element looks like (FILENAME . POSITION);
|
|
51 visiting file FILENAME goes automatically to position POSITION
|
|
52 rather than the beginning of the buffer.
|
|
53 This alist is saved between Emacs sessions.")
|
|
54
|
17481
|
55 (defcustom save-place nil
|
4596
|
56 "*Non-nil means automatically save place in each file.
|
|
57 This means when you visit a file, point goes to the last place
|
|
58 where it was when you previously visited the same file.
|
|
59 This variable is automatically buffer-local.
|
|
60
|
|
61 If you wish your place in any file to always be automatically saved,
|
|
62 simply put this in your `~/.emacs' file:
|
|
63
|
58275
|
64 \(setq-default save-place t)
|
|
65 \(require 'saveplace)
|
|
66
|
|
67 or else use the Custom facility to set this option."
|
17481
|
68 :type 'boolean
|
40162
|
69 :require 'saveplace
|
17481
|
70 :group 'save-place)
|
4596
|
71
|
|
72 (make-variable-buffer-local 'save-place)
|
|
73
|
17481
|
74 (defcustom save-place-file (convert-standard-filename "~/.emacs-places")
|
|
75 "*Name of the file that records `save-place-alist' value."
|
|
76 :type 'file
|
|
77 :group 'save-place)
|
4596
|
78
|
19979
|
79 (defcustom save-place-version-control nil
|
6662
|
80 "*Controls whether to make numbered backups of master save-place file.
|
|
81 It can have four values: t, nil, `never', and `nospecial'. The first
|
|
82 three have the same meaning that they do for the variable
|
|
83 `version-control', and the final value `nospecial' means just use the
|
17481
|
84 value of `version-control'."
|
|
85 :type '(radio (const :tag "Unconditionally" t)
|
|
86 (const :tag "For VC Files" nil)
|
|
87 (const never)
|
19979
|
88 (const :tag "Use value of `version-control'" nospecial))
|
17481
|
89 :group 'save-place)
|
6662
|
90
|
4596
|
91 (defvar save-place-loaded nil
|
|
92 "Non-nil means that the `save-place-file' has been loaded.")
|
|
93
|
17481
|
94 (defcustom save-place-limit nil
|
|
95 "Maximum number of entries to retain in the list; nil means no limit."
|
|
96 :type '(choice (integer :tag "Entries" :value 1)
|
|
97 (const :tag "No Limit" nil))
|
|
98 :group 'save-place)
|
13665
|
99
|
54111
|
100 (defcustom save-place-forget-unreadable-files t
|
|
101 "Non-nil means forget place in unreadable files.
|
|
102
|
|
103 The filenames in `save-place-alist' that do not match
|
|
104 `save-place-skip-check-regexp' are filtered through
|
|
105 `file-readable-p'. if nil, their alist entries are removed.
|
|
106
|
|
107 You may do this anytime by calling the complementary function,
|
|
108 `save-place-forget-unreadable-files'. When this option is turned on,
|
|
109 this happens automatically before saving `save-place-alist' to
|
|
110 `save-place-file'."
|
|
111 :type 'boolean :group 'save-place)
|
|
112
|
|
113 (defcustom save-place-save-skipped t
|
|
114 "If non-nil, remember files matching `save-place-skip-check-regexp'.
|
|
115
|
|
116 When filtering `save-place-alist' for unreadable files, some will not
|
|
117 be checked, based on said regexp, and instead saved or forgotten based
|
|
118 on this flag."
|
|
119 :type 'boolean :group 'save-place)
|
|
120
|
|
121 (defcustom save-place-skip-check-regexp
|
|
122 ;; thanks to ange-ftp-name-format
|
|
123 "\\`/\\(?:cdrom\\|floppy\\|mnt\\|\\(?:[^@/:]*@\\)?[^@/:]*[^@/:.]:\\)"
|
|
124 "Regexp whose file names shall not be checked for readability.
|
|
125
|
|
126 When forgetting unreadable files, file names matching this regular
|
|
127 expression shall not be checked for readability, but instead be
|
|
128 subject to `save-place-save-skipped'.
|
|
129
|
|
130 Files for which such a check may be inconvenient include those on
|
|
131 removable and network volumes."
|
|
132 :type 'regexp :group 'save-place)
|
|
133
|
4596
|
134 (defun toggle-save-place (&optional parg)
|
|
135 "Toggle whether to save your place in this file between sessions.
|
|
136 If this mode is enabled, point is recorded when you kill the buffer
|
|
137 or exit Emacs. Visiting this file again will go to that position,
|
|
138 even in a later Emacs session.
|
|
139
|
|
140 If called with a prefix arg, the mode is enabled if and only if
|
|
141 the argument is positive.
|
|
142
|
|
143 To save places automatically in all files, put this in your `.emacs' file:
|
|
144
|
|
145 \(setq-default save-place t\)"
|
|
146 (interactive "P")
|
|
147 (if (not buffer-file-name)
|
14357
|
148 (message "Buffer `%s' not visiting a file" (buffer-name))
|
4596
|
149 (if (and save-place (or (not parg) (<= parg 0)))
|
|
150 (progn
|
14357
|
151 (message "No place will be saved in this file")
|
4596
|
152 (setq save-place nil))
|
14357
|
153 (message "Place will be saved")
|
4596
|
154 (setq save-place t))))
|
|
155
|
|
156 (defun save-place-to-alist ()
|
|
157 ;; put filename and point in a cons box and then cons that onto the
|
|
158 ;; front of the save-place-alist, if save-place is non-nil.
|
|
159 ;; Otherwise, just delete that file from the alist.
|
|
160 ;; first check to make sure alist has been loaded in from the master
|
|
161 ;; file. If not, do so, then feel free to modify the alist. It
|
|
162 ;; will be saved again when Emacs is killed.
|
|
163 (or save-place-loaded (load-save-place-alist-from-file))
|
|
164 (if buffer-file-name
|
|
165 (progn
|
19980
|
166 (let ((cell (assoc buffer-file-name save-place-alist))
|
|
167 (position (if (not (eq major-mode 'hexl-mode))
|
|
168 (point)
|
61766
|
169 (with-no-warnings
|
|
170 (1+ (hexl-current-address))))))
|
4596
|
171 (if cell
|
19980
|
172 (setq save-place-alist (delq cell save-place-alist)))
|
|
173 (if (and save-place
|
|
174 (not (= position 1))) ;; Optimize out the degenerate case.
|
|
175 (setq save-place-alist
|
|
176 (cons (cons buffer-file-name position)
|
|
177 save-place-alist)))))))
|
4596
|
178
|
54111
|
179 (defun save-place-forget-unreadable-files ()
|
|
180 "Remove unreadable files from `save-place-alist'.
|
|
181 For each entry in the alist, if `file-readable-p' returns nil for the
|
|
182 filename, remove the entry. Save the new alist \(as the first pair
|
|
183 may have changed\) back to `save-place-alist'."
|
|
184 (interactive)
|
|
185 ;; the following was adapted from an in-place filtering function,
|
|
186 ;; `filter-mod', used in the original.
|
|
187 (unless (null save-place-alist) ;says it better than `when'
|
|
188 ;; first, check all except first
|
|
189 (let ((fmprev save-place-alist) (fmcur (cdr save-place-alist)))
|
|
190 (while fmcur ;not null
|
|
191 ;; a value is only saved when it becomes FMPREV.
|
|
192 (if (if (string-match save-place-skip-check-regexp (caar fmcur))
|
|
193 save-place-save-skipped
|
|
194 (file-readable-p (caar fmcur)))
|
|
195 (setq fmprev fmcur)
|
|
196 (setcdr fmprev (cdr fmcur)))
|
|
197 (setq fmcur (cdr fmcur))))
|
|
198 ;; test first pair, keep it if OK, otherwise 2nd element, which
|
|
199 ;; may be '()
|
|
200 (unless (if (string-match save-place-skip-check-regexp
|
|
201 (caar save-place-alist))
|
|
202 save-place-save-skipped
|
|
203 (file-readable-p (caar save-place-alist)))
|
|
204 (setq save-place-alist (cdr save-place-alist)))))
|
|
205
|
4596
|
206 (defun save-place-alist-to-file ()
|
|
207 (let ((file (expand-file-name save-place-file)))
|
|
208 (save-excursion
|
14342
942b8cf37599
(toggle-save-place, save-place-alist-to-file, load-save-place-alist-from-file): Delete format call inside message.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
209 (message "Saving places to %s..." file)
|
4596
|
210 (set-buffer (get-buffer-create " *Saved Places*"))
|
|
211 (delete-region (point-min) (point-max))
|
54111
|
212 (when save-place-forget-unreadable-files
|
|
213 (save-place-forget-unreadable-files))
|
55981
|
214 (let ((print-length nil)
|
|
215 (print-level nil))
|
|
216 (print save-place-alist (current-buffer)))
|
6662
|
217 (let ((version-control
|
|
218 (cond
|
|
219 ((null save-place-version-control) nil)
|
|
220 ((eq 'never save-place-version-control) 'never)
|
|
221 ((eq 'nospecial save-place-version-control) version-control)
|
|
222 (t
|
|
223 t))))
|
61451
|
224 (condition-case nil
|
|
225 (write-file file)
|
|
226 (file-error (message "Can't write %s" file)))
|
6662
|
227 (kill-buffer (current-buffer))
|
14342
942b8cf37599
(toggle-save-place, save-place-alist-to-file, load-save-place-alist-from-file): Delete format call inside message.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
228 (message "Saving places to %s...done" file)))))
|
4596
|
229
|
|
230 (defun load-save-place-alist-from-file ()
|
|
231 (if (not save-place-loaded)
|
|
232 (progn
|
|
233 (setq save-place-loaded t)
|
|
234 (let ((file (expand-file-name save-place-file)))
|
|
235 ;; make sure that the alist does not get overwritten, and then
|
|
236 ;; load it if it exists:
|
|
237 (if (file-readable-p file)
|
|
238 (save-excursion
|
14342
942b8cf37599
(toggle-save-place, save-place-alist-to-file, load-save-place-alist-from-file): Delete format call inside message.
Karl Heuer <kwzh@gnu.org>
diff
changeset
|
239 (message "Loading places from %s..." save-place-file)
|
4596
|
240 ;; don't want to use find-file because we have been
|
|
241 ;; adding hooks to it.
|
|
242 (set-buffer (get-buffer-create " *Saved Places*"))
|
|
243 (delete-region (point-min) (point-max))
|
|
244 (insert-file-contents file)
|
|
245 (goto-char (point-min))
|
49597
|
246 (setq save-place-alist
|
4596
|
247 (car (read-from-string
|
|
248 (buffer-substring (point-min) (point-max)))))
|
13665
|
249
|
|
250 ;; If there is a limit, and we're over it, then we'll
|
|
251 ;; have to truncate the end of the list:
|
|
252 (if save-place-limit
|
|
253 (if (<= save-place-limit 0)
|
|
254 ;; Zero gets special cased. I'm not thrilled
|
|
255 ;; with this, but the loop for >= 1 is tight.
|
|
256 (setq save-place-alist nil)
|
|
257 ;; Else the limit is >= 1, so enforce it by
|
|
258 ;; counting and then `setcdr'ing.
|
|
259 (let ((s save-place-alist)
|
|
260 (count 1))
|
|
261 (while s
|
|
262 (if (>= count save-place-limit)
|
|
263 (setcdr s nil)
|
|
264 (setq count (1+ count)))
|
|
265 (setq s (cdr s))))))
|
49597
|
266
|
4596
|
267 (kill-buffer (current-buffer))
|
16948
|
268 (message "Loading places from %s...done" file)))
|
4596
|
269 nil))))
|
|
270
|
|
271 (defun save-places-to-alist ()
|
|
272 ;; go through buffer-list, saving places to alist if save-place is
|
|
273 ;; non-nil, deleting them from alist if it is nil.
|
|
274 (let ((buf-list (buffer-list)))
|
|
275 (while buf-list
|
|
276 ;; put this into a save-excursion in case someone is counting on
|
|
277 ;; another function in kill-emacs-hook to act on the last buffer
|
|
278 ;; they were in:
|
|
279 (save-excursion
|
|
280 (set-buffer (car buf-list))
|
|
281 ;; save-place checks buffer-file-name too, but we can avoid
|
|
282 ;; overhead of function call by checking here too.
|
|
283 (and buffer-file-name (save-place-to-alist))
|
|
284 (setq buf-list (cdr buf-list))))))
|
|
285
|
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
286 (defun save-place-find-file-hook ()
|
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
287 (or save-place-loaded (load-save-place-alist-from-file))
|
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
288 (let ((cell (assoc buffer-file-name save-place-alist)))
|
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
289 (if cell
|
15192
|
290 (progn
|
|
291 (or after-find-file-from-revert-buffer
|
|
292 (goto-char (cdr cell)))
|
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
293 ;; and make sure it will be saved again for later
|
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
294 (setq save-place t)))))
|
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
295
|
6877
|
296 (defun save-place-kill-emacs-hook ()
|
14768
ba3525471dae
(save-place-kill-emacs-hook): Always call save-places-to-alist.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
297 ;; First update the alist. This loads the old save-place-file if nec.
|
ba3525471dae
(save-place-kill-emacs-hook): Always call save-places-to-alist.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
298 (save-places-to-alist)
|
ba3525471dae
(save-place-kill-emacs-hook): Always call save-places-to-alist.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
299 ;; Now save the alist in the file, if we have ever loaded the file
|
ba3525471dae
(save-place-kill-emacs-hook): Always call save-places-to-alist.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
300 ;; (including just now).
|
14753
|
301 (if save-place-loaded
|
14768
ba3525471dae
(save-place-kill-emacs-hook): Always call save-places-to-alist.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
302 (save-place-alist-to-file)))
|
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
303
|
46899
|
304 (add-hook 'find-file-hook 'save-place-find-file-hook t)
|
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
305
|
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
diff
changeset
|
306 (add-hook 'kill-emacs-hook 'save-place-kill-emacs-hook)
|
4596
|
307
|
|
308 (add-hook 'kill-buffer-hook 'save-place-to-alist)
|
|
309
|
|
310 (provide 'saveplace) ; why not...
|
|
311
|
52401
|
312 ;;; arch-tag: 3c2ef47b-0a22-4558-b116-118c9ef454a0
|
4596
|
313 ;;; saveplace.el ends here
|