Mercurial > emacs
annotate lisp/saveplace.el @ 15899:4ee67c1476f4
Generate src/paths.h here.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Thu, 22 Aug 1996 19:29:12 +0000 |
parents | f2aaee52dfe1 |
children | 62b9178b858b |
rev | line source |
---|---|
4596 | 1 ;;; saveplace.el --- automatically save place in files. |
2 | |
6662
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
3 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc. |
4596 | 4 |
5 ;; Author: Karl Fogel <kfogel@cs.oberlin.edu> | |
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
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
35 ;; Thanks to Stefan Schoef, who sent a patch with the |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
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 | |
43 (defvar save-place-alist nil | |
44 "Alist of saved places to go back to when revisiting files. | |
45 Each element looks like (FILENAME . POSITION); | |
46 visiting file FILENAME goes automatically to position POSITION | |
47 rather than the beginning of the buffer. | |
48 This alist is saved between Emacs sessions.") | |
49 | |
50 (defvar save-place nil | |
51 "*Non-nil means automatically save place in each file. | |
52 This means when you visit a file, point goes to the last place | |
53 where it was when you previously visited the same file. | |
54 This variable is automatically buffer-local. | |
55 | |
56 If you wish your place in any file to always be automatically saved, | |
57 simply put this in your `~/.emacs' file: | |
58 | |
59 \(setq-default save-place t\)") | |
60 | |
61 (make-variable-buffer-local 'save-place) | |
62 | |
13908
ce0d475e3e77
(save-place-file): Use convert-standard-filename.
Richard M. Stallman <rms@gnu.org>
parents:
13665
diff
changeset
|
63 (defvar save-place-file (convert-standard-filename "~/.emacs-places") |
4596 | 64 "*Name of the file that records `save-place-alist' value.") |
65 | |
6662
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
66 (defvar save-place-version-control 'nospecial |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
67 "*Controls whether to make numbered backups of master save-place file. |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
68 It can have four values: t, nil, `never', and `nospecial'. The first |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
69 three have the same meaning that they do for the variable |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
70 `version-control', and the final value `nospecial' means just use the |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
71 value of `version-control'.") |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
72 |
4596 | 73 (defvar save-place-loaded nil |
74 "Non-nil means that the `save-place-file' has been loaded.") | |
75 | |
13665
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
76 (defvar save-place-limit nil |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
77 "Maximum number of entries to retain in the list; nil means no limit.") |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
78 |
4596 | 79 (defun toggle-save-place (&optional parg) |
80 "Toggle whether to save your place in this file between sessions. | |
81 If this mode is enabled, point is recorded when you kill the buffer | |
82 or exit Emacs. Visiting this file again will go to that position, | |
83 even in a later Emacs session. | |
84 | |
85 If called with a prefix arg, the mode is enabled if and only if | |
86 the argument is positive. | |
87 | |
88 To save places automatically in all files, put this in your `.emacs' file: | |
89 | |
90 \(setq-default save-place t\)" | |
91 (interactive "P") | |
92 (if (not buffer-file-name) | |
14357
31d994fe3123
(toggle-save-place): Fix message text.
Karl Heuer <kwzh@gnu.org>
parents:
14342
diff
changeset
|
93 (message "Buffer `%s' not visiting a file" (buffer-name)) |
4596 | 94 (if (and save-place (or (not parg) (<= parg 0))) |
95 (progn | |
14357
31d994fe3123
(toggle-save-place): Fix message text.
Karl Heuer <kwzh@gnu.org>
parents:
14342
diff
changeset
|
96 (message "No place will be saved in this file") |
4596 | 97 (setq save-place nil)) |
14357
31d994fe3123
(toggle-save-place): Fix message text.
Karl Heuer <kwzh@gnu.org>
parents:
14342
diff
changeset
|
98 (message "Place will be saved") |
4596 | 99 (setq save-place t)))) |
100 | |
101 (defun save-place-to-alist () | |
102 ;; put filename and point in a cons box and then cons that onto the | |
103 ;; front of the save-place-alist, if save-place is non-nil. | |
104 ;; Otherwise, just delete that file from the alist. | |
105 ;; first check to make sure alist has been loaded in from the master | |
106 ;; file. If not, do so, then feel free to modify the alist. It | |
107 ;; will be saved again when Emacs is killed. | |
108 (or save-place-loaded (load-save-place-alist-from-file)) | |
109 (if buffer-file-name | |
110 (progn | |
111 (let ((cell (assoc buffer-file-name save-place-alist))) | |
112 (if cell | |
113 (setq save-place-alist (delq cell save-place-alist)))) | |
114 (if save-place | |
115 (setq save-place-alist | |
15192 | 116 (cons (cons buffer-file-name |
117 (if (not (eq major-mode 'hexl-mode)) | |
13600
4c8f65a17dc9
(save-place-to-alist): Handle hexl-mode specially.
Richard M. Stallman <rms@gnu.org>
parents:
8711
diff
changeset
|
118 (point) |
4c8f65a17dc9
(save-place-to-alist): Handle hexl-mode specially.
Richard M. Stallman <rms@gnu.org>
parents:
8711
diff
changeset
|
119 (1+ (hexl-current-address)))) |
4596 | 120 save-place-alist)))))) |
121 | |
122 (defun save-place-alist-to-file () | |
123 (let ((file (expand-file-name save-place-file))) | |
124 (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>
parents:
14169
diff
changeset
|
125 (message "Saving places to %s..." file) |
4596 | 126 (set-buffer (get-buffer-create " *Saved Places*")) |
127 (delete-region (point-min) (point-max)) | |
128 (if (file-readable-p file) | |
129 (insert-file-contents file)) | |
130 (delete-region (point-min) (point-max)) | |
131 (goto-char (point-min)) | |
132 (print save-place-alist (current-buffer)) | |
6662
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
133 (let ((version-control |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
134 (cond |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
135 ((null save-place-version-control) nil) |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
136 ((eq 'never save-place-version-control) 'never) |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
137 ((eq 'nospecial save-place-version-control) version-control) |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
138 (t |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
139 t)))) |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
140 (write-file file) |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
141 (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>
parents:
14169
diff
changeset
|
142 (message "Saving places to %s...done" file))))) |
4596 | 143 |
144 (defun load-save-place-alist-from-file () | |
145 (if (not save-place-loaded) | |
146 (progn | |
147 (setq save-place-loaded t) | |
148 (let ((file (expand-file-name save-place-file))) | |
149 ;; make sure that the alist does not get overwritten, and then | |
150 ;; load it if it exists: | |
151 (if (file-readable-p file) | |
152 (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>
parents:
14169
diff
changeset
|
153 (message "Loading places from %s..." save-place-file) |
4596 | 154 ;; don't want to use find-file because we have been |
155 ;; adding hooks to it. | |
156 (set-buffer (get-buffer-create " *Saved Places*")) | |
157 (delete-region (point-min) (point-max)) | |
158 (insert-file-contents file) | |
159 (goto-char (point-min)) | |
160 (setq save-place-alist | |
161 (car (read-from-string | |
162 (buffer-substring (point-min) (point-max))))) | |
13665
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
163 |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
164 ;; If there is a limit, and we're over it, then we'll |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
165 ;; have to truncate the end of the list: |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
166 (if save-place-limit |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
167 (if (<= save-place-limit 0) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
168 ;; Zero gets special cased. I'm not thrilled |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
169 ;; with this, but the loop for >= 1 is tight. |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
170 (setq save-place-alist nil) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
171 ;; Else the limit is >= 1, so enforce it by |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
172 ;; counting and then `setcdr'ing. |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
173 (let ((s save-place-alist) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
174 (count 1)) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
175 (while s |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
176 (if (>= count save-place-limit) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
177 (setcdr s nil) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
178 (setq count (1+ count))) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
179 (setq s (cdr s)))))) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
180 |
4596 | 181 (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>
parents:
14169
diff
changeset
|
182 (message "Loading places from %s...done" file) |
4596 | 183 t) |
184 t) | |
185 nil)))) | |
186 | |
187 (defun save-places-to-alist () | |
188 ;; go through buffer-list, saving places to alist if save-place is | |
189 ;; non-nil, deleting them from alist if it is nil. | |
190 (let ((buf-list (buffer-list))) | |
191 (while buf-list | |
192 ;; put this into a save-excursion in case someone is counting on | |
193 ;; another function in kill-emacs-hook to act on the last buffer | |
194 ;; they were in: | |
195 (save-excursion | |
196 (set-buffer (car buf-list)) | |
197 ;; save-place checks buffer-file-name too, but we can avoid | |
198 ;; overhead of function call by checking here too. | |
199 (and buffer-file-name (save-place-to-alist)) | |
200 (setq buf-list (cdr buf-list)))))) | |
201 | |
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
202 (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>
parents:
6662
diff
changeset
|
203 (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>
parents:
6662
diff
changeset
|
204 (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>
parents:
6662
diff
changeset
|
205 (if cell |
15192 | 206 (progn |
207 (or after-find-file-from-revert-buffer | |
208 (goto-char (cdr cell))) | |
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
209 ;; 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>
parents:
6662
diff
changeset
|
210 (setq save-place t))))) |
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
211 |
6877
6347a8d838c8
(save-place-kill-emacs-hook): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents:
6700
diff
changeset
|
212 (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>
parents:
14753
diff
changeset
|
213 ;; 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>
parents:
14753
diff
changeset
|
214 (save-places-to-alist) |
ba3525471dae
(save-place-kill-emacs-hook): Always call save-places-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
14753
diff
changeset
|
215 ;; 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>
parents:
14753
diff
changeset
|
216 ;; (including just now). |
14753
cf8ad47dc610
(save-place-kill-emacs-hook): Don't save
Richard M. Stallman <rms@gnu.org>
parents:
14357
diff
changeset
|
217 (if save-place-loaded |
14768
ba3525471dae
(save-place-kill-emacs-hook): Always call save-places-to-alist.
Richard M. Stallman <rms@gnu.org>
parents:
14753
diff
changeset
|
218 (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>
parents:
6662
diff
changeset
|
219 |
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
220 (add-hook 'find-file-hooks 'save-place-find-file-hook t) |
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
221 |
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
222 (add-hook 'kill-emacs-hook 'save-place-kill-emacs-hook) |
4596 | 223 |
224 (add-hook 'kill-buffer-hook 'save-place-to-alist) | |
225 | |
226 (provide 'saveplace) ; why not... | |
227 | |
228 ;;; saveplace.el ends here | |
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
229 |