|
0
|
1 ;;; saveplace.el --- automatically save place in files.
|
|
|
2
|
|
2
|
3 ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
|
|
0
|
4
|
|
|
5 ;; Author: Karl Fogel <kfogel@cs.oberlin.edu>
|
|
|
6 ;; Maintainer: FSF
|
|
|
7 ;; Created: July, 1993
|
|
2
|
8 ;; Version: >1.0 (RMS doesn't keep version numbers :-( )
|
|
0
|
9 ;; Keywords: bookmarks, placeholders
|
|
|
10
|
|
|
11 ;; This file is part of XEmacs.
|
|
|
12
|
|
|
13 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
14 ;; 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 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
21 ;; General Public License for more details.
|
|
|
22
|
|
|
23 ;; You should have received a copy of the GNU General Public License
|
|
|
24 ;; along with XEmacs; see the file COPYING. If not, write to the Free
|
|
2
|
25 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
|
26 ;; 02111-1307, USA.
|
|
0
|
27
|
|
2
|
28 ;;; Synched up with: FSF 19.34.
|
|
|
29
|
|
|
30 ;;; Commentary:
|
|
0
|
31
|
|
|
32 ;; Automatically save place in files, so that visiting them later
|
|
|
33 ;; (even during a different Emacs session) automatically moves point
|
|
|
34 ;; to the saved position, when the file is first found. Uses the
|
|
|
35 ;; value of buffer-local variable save-place to determine whether to
|
|
|
36 ;; save position or not.
|
|
|
37 ;;
|
|
2
|
38 ;; Thanks to Stefan Schoef, who sent a patch with the
|
|
|
39 ;; `save-place-version-control' stuff in it.
|
|
|
40
|
|
|
41 ;;; Code:
|
|
0
|
42
|
|
|
43 ;; this is what I was using during testing:
|
|
|
44 ;; (define-key ctl-x-map "p" 'toggle-save-place)
|
|
|
45
|
|
|
46 (defvar save-place-alist nil
|
|
|
47 "Alist of saved places to go back to when revisiting files.
|
|
|
48 Each element looks like (FILENAME . POSITION);
|
|
|
49 visiting file FILENAME goes automatically to position POSITION
|
|
|
50 rather than the beginning of the buffer.
|
|
|
51 This alist is saved between Emacs sessions.")
|
|
|
52
|
|
|
53 (defvar save-place nil
|
|
|
54 "*Non-nil means automatically save place in each file.
|
|
|
55 This means when you visit a file, point goes to the last place
|
|
|
56 where it was when you previously visited the same file.
|
|
|
57 This variable is automatically buffer-local.
|
|
|
58
|
|
|
59 If you wish your place in any file to always be automatically saved,
|
|
|
60 simply put this in your `~/.emacs' file:
|
|
|
61
|
|
|
62 \(setq-default save-place t\)")
|
|
|
63
|
|
|
64 (make-variable-buffer-local 'save-place)
|
|
|
65
|
|
2
|
66 (defvar save-place-file (convert-standard-filename "~/.emacs-places")
|
|
0
|
67 "*Name of the file that records `save-place-alist' value.")
|
|
|
68
|
|
2
|
69 (defvar save-place-version-control 'nospecial
|
|
|
70 "*Controls whether to make numbered backups of master save-place file.
|
|
|
71 It can have four values: t, nil, `never', and `nospecial'. The first
|
|
|
72 three have the same meaning that they do for the variable
|
|
|
73 `version-control', and the final value `nospecial' means just use the
|
|
|
74 value of `version-control'.")
|
|
|
75
|
|
0
|
76 (defvar save-place-loaded nil
|
|
|
77 "Non-nil means that the `save-place-file' has been loaded.")
|
|
|
78
|
|
2
|
79 (defvar save-place-limit nil
|
|
|
80 "Maximum number of entries to retain in the list; nil means no limit.")
|
|
|
81
|
|
0
|
82 (defun toggle-save-place (&optional parg)
|
|
|
83 "Toggle whether to save your place in this file between sessions.
|
|
|
84 If this mode is enabled, point is recorded when you kill the buffer
|
|
|
85 or exit Emacs. Visiting this file again will go to that position,
|
|
|
86 even in a later Emacs session.
|
|
|
87
|
|
|
88 If called with a prefix arg, the mode is enabled if and only if
|
|
|
89 the argument is positive.
|
|
|
90
|
|
|
91 To save places automatically in all files, put this in your `.emacs' file:
|
|
|
92
|
|
|
93 \(setq-default save-place t\)"
|
|
|
94 (interactive "P")
|
|
|
95 (if (not buffer-file-name)
|
|
2
|
96 (message "Buffer `%s' not visiting a file" (buffer-name))
|
|
0
|
97 (if (and save-place (or (not parg) (<= parg 0)))
|
|
|
98 (progn
|
|
2
|
99 (message "No place will be saved in this file")
|
|
0
|
100 (setq save-place nil))
|
|
2
|
101 (message "Place will be saved")
|
|
0
|
102 (setq save-place t))))
|
|
|
103
|
|
|
104 (defun save-place-to-alist ()
|
|
|
105 ;; put filename and point in a cons box and then cons that onto the
|
|
|
106 ;; front of the save-place-alist, if save-place is non-nil.
|
|
|
107 ;; Otherwise, just delete that file from the alist.
|
|
|
108 ;; first check to make sure alist has been loaded in from the master
|
|
|
109 ;; file. If not, do so, then feel free to modify the alist. It
|
|
|
110 ;; will be saved again when Emacs is killed.
|
|
|
111 (or save-place-loaded (load-save-place-alist-from-file))
|
|
|
112 (if buffer-file-name
|
|
|
113 (progn
|
|
|
114 (let ((cell (assoc buffer-file-name save-place-alist)))
|
|
|
115 (if cell
|
|
|
116 (setq save-place-alist (delq cell save-place-alist))))
|
|
|
117 (if save-place
|
|
|
118 (setq save-place-alist
|
|
2
|
119 (cons (cons buffer-file-name
|
|
|
120 (if (not (eq major-mode 'hexl-mode))
|
|
|
121 (point)
|
|
|
122 (1+ (hexl-current-address))))
|
|
0
|
123 save-place-alist))))))
|
|
|
124
|
|
|
125 (defun save-place-alist-to-file ()
|
|
|
126 (let ((file (expand-file-name save-place-file)))
|
|
|
127 (save-excursion
|
|
2
|
128 (message "Saving places to %s..." file)
|
|
0
|
129 (set-buffer (get-buffer-create " *Saved Places*"))
|
|
|
130 (delete-region (point-min) (point-max))
|
|
|
131 (if (file-readable-p file)
|
|
|
132 (insert-file-contents file))
|
|
|
133 (delete-region (point-min) (point-max))
|
|
|
134 (goto-char (point-min))
|
|
|
135 (print save-place-alist (current-buffer))
|
|
2
|
136 (let ((version-control
|
|
|
137 (cond
|
|
|
138 ((null save-place-version-control) nil)
|
|
|
139 ((eq 'never save-place-version-control) 'never)
|
|
|
140 ((eq 'nospecial save-place-version-control) version-control)
|
|
|
141 (t
|
|
|
142 t))))
|
|
|
143 (write-file file)
|
|
|
144 (kill-buffer (current-buffer))
|
|
|
145 (message "Saving places to %s...done" file)))))
|
|
0
|
146
|
|
|
147 (defun load-save-place-alist-from-file ()
|
|
|
148 (if (not save-place-loaded)
|
|
|
149 (progn
|
|
|
150 (setq save-place-loaded t)
|
|
|
151 (let ((file (expand-file-name save-place-file)))
|
|
|
152 ;; make sure that the alist does not get overwritten, and then
|
|
|
153 ;; load it if it exists:
|
|
|
154 (if (file-readable-p file)
|
|
|
155 (save-excursion
|
|
2
|
156 (message "Loading places from %s..." save-place-file)
|
|
0
|
157 ;; don't want to use find-file because we have been
|
|
|
158 ;; adding hooks to it.
|
|
|
159 (set-buffer (get-buffer-create " *Saved Places*"))
|
|
|
160 (delete-region (point-min) (point-max))
|
|
|
161 (insert-file-contents file)
|
|
|
162 (goto-char (point-min))
|
|
|
163 (setq save-place-alist
|
|
|
164 (car (read-from-string
|
|
|
165 (buffer-substring (point-min) (point-max)))))
|
|
2
|
166
|
|
|
167 ;; If there is a limit, and we're over it, then we'll
|
|
|
168 ;; have to truncate the end of the list:
|
|
|
169 (if save-place-limit
|
|
|
170 (if (<= save-place-limit 0)
|
|
|
171 ;; Zero gets special cased. I'm not thrilled
|
|
|
172 ;; with this, but the loop for >= 1 is tight.
|
|
|
173 (setq save-place-alist nil)
|
|
|
174 ;; Else the limit is >= 1, so enforce it by
|
|
|
175 ;; counting and then `setcdr'ing.
|
|
|
176 (let ((s save-place-alist)
|
|
|
177 (count 1))
|
|
|
178 (while s
|
|
|
179 (if (>= count save-place-limit)
|
|
|
180 (setcdr s nil)
|
|
|
181 (setq count (1+ count)))
|
|
|
182 (setq s (cdr s))))))
|
|
0
|
183 (kill-buffer (current-buffer))
|
|
2
|
184 (message "Loading places from %s...done" file)
|
|
0
|
185 t)
|
|
|
186 t)
|
|
|
187 nil))))
|
|
|
188
|
|
|
189 (defun save-places-to-alist ()
|
|
|
190 ;; go through buffer-list, saving places to alist if save-place is
|
|
|
191 ;; non-nil, deleting them from alist if it is nil.
|
|
|
192 (let ((buf-list (buffer-list)))
|
|
|
193 (while buf-list
|
|
|
194 ;; put this into a save-excursion in case someone is counting on
|
|
|
195 ;; another function in kill-emacs-hook to act on the last buffer
|
|
|
196 ;; they were in:
|
|
|
197 (save-excursion
|
|
|
198 (set-buffer (car buf-list))
|
|
|
199 ;; save-place checks buffer-file-name too, but we can avoid
|
|
|
200 ;; overhead of function call by checking here too.
|
|
|
201 (and buffer-file-name (save-place-to-alist))
|
|
|
202 (setq buf-list (cdr buf-list))))))
|
|
2
|
203
|
|
|
204 (defun save-place-find-file-hook ()
|
|
|
205 (or save-place-loaded (load-save-place-alist-from-file))
|
|
|
206 (let ((cell (assoc buffer-file-name save-place-alist)))
|
|
|
207 (if cell
|
|
|
208 (progn
|
|
|
209 (or after-find-file-from-revert-buffer
|
|
|
210 (goto-char (cdr cell)))
|
|
|
211 ;; and make sure it will be saved again for later
|
|
|
212 (setq save-place t)))))
|
|
0
|
213
|
|
2
|
214 (defun save-place-kill-emacs-hook ()
|
|
|
215 ;; First update the alist. This loads the old save-place-file if nec.
|
|
|
216 (save-places-to-alist)
|
|
|
217 ;; Now save the alist in the file, if we have ever loaded the file
|
|
|
218 ;; (including just now).
|
|
|
219 (if save-place-loaded
|
|
|
220 (save-place-alist-to-file)))
|
|
|
221
|
|
|
222 (add-hook 'find-file-hooks 'save-place-find-file-hook t)
|
|
|
223
|
|
|
224 (add-hook 'kill-emacs-hook 'save-place-kill-emacs-hook)
|
|
0
|
225
|
|
|
226 (add-hook 'kill-buffer-hook 'save-place-to-alist)
|
|
|
227
|
|
|
228 (provide 'saveplace) ; why not...
|
|
|
229
|
|
|
230 ;;; saveplace.el ends here
|
|
|
231
|
