Mercurial > emacs
annotate lisp/saveplace.el @ 15155:b86cf87b8277
(OBJDIR, BLD): Remove macro definitions.
,
author | Geoff Voelker <voelker@cs.washington.edu> |
---|---|
date | Fri, 03 May 1996 19:09:36 +0000 |
parents | ba3525471dae |
children | dc5aa17e7910 |
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 | |
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
8 ;; Version: 1.2 |
4596 | 9 ;; Keywords: bookmarks, placeholders |
10 | |
11 ;; This file is part of GNU Emacs. | |
12 | |
13 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 ;; it under the terms of the GNU General Public License as published by | |
15 ;; the Free Software Foundation; either version 2, or (at your option) | |
16 ;; any later version. | |
17 | |
18 ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 ;; GNU General Public License for more details. | |
22 | |
23 ;; You should have received a copy of the GNU General Public License | |
14169 | 24 ;; along with GNU Emacs; see the file COPYING. If not, write to the |
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
26 ;; Boston, MA 02111-1307, USA. | |
27 | |
28 ;;; Commentary: | |
4596 | 29 |
30 ;; Automatically save place in files, so that visiting them later | |
31 ;; (even during a different Emacs session) automatically moves point | |
32 ;; to the saved position, when the file is first found. Uses the | |
33 ;; value of buffer-local variable save-place to determine whether to | |
34 ;; save position or not. | |
35 ;; | |
6662
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
36 ;; 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
|
37 ;; `save-place-version-control' stuff in it. |
4596 | 38 |
14169 | 39 ;;; Code: |
40 | |
4596 | 41 ;; this is what I was using during testing: |
42 ;; (define-key ctl-x-map "p" 'toggle-save-place) | |
43 | |
44 (defvar save-place-alist nil | |
45 "Alist of saved places to go back to when revisiting files. | |
46 Each element looks like (FILENAME . POSITION); | |
47 visiting file FILENAME goes automatically to position POSITION | |
48 rather than the beginning of the buffer. | |
49 This alist is saved between Emacs sessions.") | |
50 | |
51 (defvar save-place nil | |
52 "*Non-nil means automatically save place in each file. | |
53 This means when you visit a file, point goes to the last place | |
54 where it was when you previously visited the same file. | |
55 This variable is automatically buffer-local. | |
56 | |
57 If you wish your place in any file to always be automatically saved, | |
58 simply put this in your `~/.emacs' file: | |
59 | |
60 \(setq-default save-place t\)") | |
61 | |
62 (make-variable-buffer-local 'save-place) | |
63 | |
13908
ce0d475e3e77
(save-place-file): Use convert-standard-filename.
Richard M. Stallman <rms@gnu.org>
parents:
13665
diff
changeset
|
64 (defvar save-place-file (convert-standard-filename "~/.emacs-places") |
4596 | 65 "*Name of the file that records `save-place-alist' value.") |
66 | |
6662
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
67 (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
|
68 "*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
|
69 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
|
70 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
|
71 `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
|
72 value of `version-control'.") |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
73 |
4596 | 74 (defvar save-place-loaded nil |
75 "Non-nil means that the `save-place-file' has been loaded.") | |
76 | |
13665
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
77 (defvar save-place-limit nil |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
78 "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
|
79 |
4596 | 80 (defun toggle-save-place (&optional parg) |
81 "Toggle whether to save your place in this file between sessions. | |
82 If this mode is enabled, point is recorded when you kill the buffer | |
83 or exit Emacs. Visiting this file again will go to that position, | |
84 even in a later Emacs session. | |
85 | |
86 If called with a prefix arg, the mode is enabled if and only if | |
87 the argument is positive. | |
88 | |
89 To save places automatically in all files, put this in your `.emacs' file: | |
90 | |
91 \(setq-default save-place t\)" | |
92 (interactive "P") | |
93 (if (not buffer-file-name) | |
14357
31d994fe3123
(toggle-save-place): Fix message text.
Karl Heuer <kwzh@gnu.org>
parents:
14342
diff
changeset
|
94 (message "Buffer `%s' not visiting a file" (buffer-name)) |
4596 | 95 (if (and save-place (or (not parg) (<= parg 0))) |
96 (progn | |
14357
31d994fe3123
(toggle-save-place): Fix message text.
Karl Heuer <kwzh@gnu.org>
parents:
14342
diff
changeset
|
97 (message "No place will be saved in this file") |
4596 | 98 (setq save-place nil)) |
14357
31d994fe3123
(toggle-save-place): Fix message text.
Karl Heuer <kwzh@gnu.org>
parents:
14342
diff
changeset
|
99 (message "Place will be saved") |
4596 | 100 (setq save-place t)))) |
101 | |
102 (defun save-place-to-alist () | |
103 ;; put filename and point in a cons box and then cons that onto the | |
104 ;; front of the save-place-alist, if save-place is non-nil. | |
105 ;; Otherwise, just delete that file from the alist. | |
106 ;; first check to make sure alist has been loaded in from the master | |
107 ;; file. If not, do so, then feel free to modify the alist. It | |
108 ;; will be saved again when Emacs is killed. | |
109 (or save-place-loaded (load-save-place-alist-from-file)) | |
110 (if buffer-file-name | |
111 (progn | |
112 (let ((cell (assoc buffer-file-name save-place-alist))) | |
113 (if cell | |
114 (setq save-place-alist (delq cell save-place-alist)))) | |
115 (if save-place | |
116 (setq save-place-alist | |
13600
4c8f65a17dc9
(save-place-to-alist): Handle hexl-mode specially.
Richard M. Stallman <rms@gnu.org>
parents:
8711
diff
changeset
|
117 (cons (cons buffer-file-name |
4c8f65a17dc9
(save-place-to-alist): Handle hexl-mode specially.
Richard M. Stallman <rms@gnu.org>
parents:
8711
diff
changeset
|
118 (if (not (eq major-mode 'hexl-mode)) |
4c8f65a17dc9
(save-place-to-alist): Handle hexl-mode specially.
Richard M. Stallman <rms@gnu.org>
parents:
8711
diff
changeset
|
119 (point) |
4c8f65a17dc9
(save-place-to-alist): Handle hexl-mode specially.
Richard M. Stallman <rms@gnu.org>
parents:
8711
diff
changeset
|
120 (1+ (hexl-current-address)))) |
4596 | 121 save-place-alist)))))) |
122 | |
123 (defun save-place-alist-to-file () | |
124 (let ((file (expand-file-name save-place-file))) | |
125 (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
|
126 (message "Saving places to %s..." file) |
4596 | 127 (set-buffer (get-buffer-create " *Saved Places*")) |
128 (delete-region (point-min) (point-max)) | |
129 (if (file-readable-p file) | |
130 (insert-file-contents file)) | |
131 (delete-region (point-min) (point-max)) | |
132 (goto-char (point-min)) | |
133 (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
|
134 (let ((version-control |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
135 (cond |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
136 ((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
|
137 ((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
|
138 ((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
|
139 (t |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
140 t)))) |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
141 (write-file file) |
bc7bc2a395c6
(save-place-version-control): New var, for determining
Richard M. Stallman <rms@gnu.org>
parents:
4596
diff
changeset
|
142 (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
|
143 (message "Saving places to %s...done" file))))) |
4596 | 144 |
145 (defun load-save-place-alist-from-file () | |
146 (if (not save-place-loaded) | |
147 (progn | |
148 (setq save-place-loaded t) | |
149 (let ((file (expand-file-name save-place-file))) | |
150 ;; make sure that the alist does not get overwritten, and then | |
151 ;; load it if it exists: | |
152 (if (file-readable-p file) | |
153 (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
|
154 (message "Loading places from %s..." save-place-file) |
4596 | 155 ;; don't want to use find-file because we have been |
156 ;; adding hooks to it. | |
157 (set-buffer (get-buffer-create " *Saved Places*")) | |
158 (delete-region (point-min) (point-max)) | |
159 (insert-file-contents file) | |
160 (goto-char (point-min)) | |
161 (setq save-place-alist | |
162 (car (read-from-string | |
163 (buffer-substring (point-min) (point-max))))) | |
13665
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
164 |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
165 ;; 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
|
166 ;; have to truncate the end of the list: |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
167 (if save-place-limit |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
168 (if (<= save-place-limit 0) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
169 ;; Zero gets special cased. I'm not thrilled |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
170 ;; 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
|
171 (setq save-place-alist nil) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
172 ;; 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
|
173 ;; counting and then `setcdr'ing. |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
174 (let ((s save-place-alist) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
175 (count 1)) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
176 (while s |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
177 (if (>= count save-place-limit) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
178 (setcdr s nil) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
179 (setq count (1+ count))) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
180 (setq s (cdr s)))))) |
abc765f9bee3
(save-place-limit): New variable.
Richard M. Stallman <rms@gnu.org>
parents:
13600
diff
changeset
|
181 |
4596 | 182 (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
|
183 (message "Loading places from %s...done" file) |
4596 | 184 t) |
185 t) | |
186 nil)))) | |
187 | |
188 (defun save-places-to-alist () | |
189 ;; go through buffer-list, saving places to alist if save-place is | |
190 ;; non-nil, deleting them from alist if it is nil. | |
191 (let ((buf-list (buffer-list))) | |
192 (while buf-list | |
193 ;; put this into a save-excursion in case someone is counting on | |
194 ;; another function in kill-emacs-hook to act on the last buffer | |
195 ;; they were in: | |
196 (save-excursion | |
197 (set-buffer (car buf-list)) | |
198 ;; save-place checks buffer-file-name too, but we can avoid | |
199 ;; overhead of function call by checking here too. | |
200 (and buffer-file-name (save-place-to-alist)) | |
201 (setq buf-list (cdr buf-list)))))) | |
202 | |
6700
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
203 (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
|
204 (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
|
205 (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
|
206 (if cell |
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
207 (progn |
8711
5554c5e451ae
(save-place-find-file-hook): Check after-find-file-from-revert-buffer.
Richard M. Stallman <rms@gnu.org>
parents:
6877
diff
changeset
|
208 (or after-find-file-from-revert-buffer |
5554c5e451ae
(save-place-find-file-hook): Check after-find-file-from-revert-buffer.
Richard M. Stallman <rms@gnu.org>
parents:
6877
diff
changeset
|
209 (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
|
210 ;; 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
|
211 (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
|
212 |
6877
6347a8d838c8
(save-place-kill-emacs-hook): Fix typo.
Richard M. Stallman <rms@gnu.org>
parents:
6700
diff
changeset
|
213 (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
|
214 ;; 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
|
215 (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
|
216 ;; 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
|
217 ;; (including just now). |
14753
cf8ad47dc610
(save-place-kill-emacs-hook): Don't save
Richard M. Stallman <rms@gnu.org>
parents:
14357
diff
changeset
|
218 (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
|
219 (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
|
220 |
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
221 (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
|
222 |
db2292ce4894
(save-place-find-file-hook, save-place-kill-emacs-hook): New functions.
Richard M. Stallman <rms@gnu.org>
parents:
6662
diff
changeset
|
223 (add-hook 'kill-emacs-hook 'save-place-kill-emacs-hook) |
4596 | 224 |
225 (add-hook 'kill-buffer-hook 'save-place-to-alist) | |
226 | |
227 (provide 'saveplace) ; why not... | |
228 | |
229 ;;; 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
|
230 |