Commit | Line | Data |
---|---|---|
216ee1a4 | 1 | ;;; savehist.el --- Save minibuffer history. |
cb23c7c1 | 2 | |
7619d43b | 3 | ;; Copyright (C) 1997, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
cb23c7c1 RS |
4 | |
5 | ;; Author: Hrvoje Niksic <hniksic@xemacs.org> | |
6 | ;; Keywords: minibuffer | |
ed5a258a | 7 | ;; Version: 24 |
cb23c7c1 RS |
8 | |
9 | ;; This file is part of GNU Emacs. | |
10 | ||
11 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 | ;; it under the terms of the GNU General Public License as published by | |
b4aa6026 | 13 | ;; the Free Software Foundation; either version 3, or (at your option) |
cb23c7c1 RS |
14 | ;; any later version. |
15 | ||
16 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | ;; GNU General Public License for more details. | |
20 | ||
21 | ;; You should have received a copy of the GNU General Public License | |
22 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
23 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, | |
24 | ;; Boston, MA 02110-1301, USA. | |
25 | ||
26 | ;;; Commentary: | |
27 | ||
216ee1a4 SM |
28 | ;; Many editors (e.g. Vim) have the feature of saving minibuffer |
29 | ;; history to an external file after exit. This package provides the | |
2a2b5b29 SM |
30 | ;; same feature in Emacs. When set up, it saves recorded minibuffer |
31 | ;; histories to a file (`~/.emacs-history' by default). Additional | |
32 | ;; variables may be specified by customizing | |
33 | ;; `savehist-additional-variables'. | |
cb23c7c1 | 34 | |
b91f17dc SM |
35 | ;; To use savehist, turn on savehist-mode by putting the following in |
36 | ;; `~/.emacs': | |
cb23c7c1 | 37 | ;; |
b91f17dc SM |
38 | ;; (savehist-mode 1) |
39 | ;; | |
40 | ;; or with customize: `M-x customize-option RET savehist-mode RET'. | |
41 | ;; | |
42 | ;; You can also explicitly save history with `M-x savehist-save' and | |
b13e8fb3 | 43 | ;; load it by loading the `savehist-file' with `M-x load-file'. |
cb23c7c1 | 44 | |
2a2b5b29 SM |
45 | ;; If you are using a version of Emacs that does not ship with this |
46 | ;; package, be sure to have `savehist.el' in a directory that is in | |
47 | ;; your load-path, and to byte-compile it. | |
216ee1a4 | 48 | |
cb23c7c1 RS |
49 | ;;; Code: |
50 | ||
216ee1a4 | 51 | (require 'custom) |
2a2b5b29 SM |
52 | (eval-when-compile |
53 | (require 'cl)) | |
216ee1a4 | 54 | |
cb23c7c1 RS |
55 | ;; User variables |
56 | ||
57 | (defgroup savehist nil | |
58 | "Save minibuffer history." | |
cd4160e6 | 59 | :version "22.1" |
cb23c7c1 RS |
60 | :group 'minibuffer) |
61 | ||
b91f17dc SM |
62 | ;;;###autoload |
63 | (defcustom savehist-mode nil | |
64 | "Mode for automatic saving of minibuffer history. | |
65 | Set this by calling the `savehist-mode' function or using the customize | |
66 | interface." | |
67 | :type 'boolean | |
2d10b62b | 68 | :set (lambda (symbol value) (savehist-mode (or value 0))) |
b91f17dc SM |
69 | :initialize 'custom-initialize-default |
70 | :require 'savehist | |
71 | :group 'savehist) | |
72 | ||
2a2b5b29 | 73 | (defcustom savehist-save-minibuffer-history t |
b91f17dc SM |
74 | "*If non-nil, save all recorded minibuffer histories. |
75 | If you want to save only specific histories, use `savehist-save-hook' to | |
76 | modify the value of `savehist-minibuffer-history-variables'." | |
2a2b5b29 SM |
77 | :type 'boolean |
78 | :group 'savehist) | |
79 | ||
80 | (defcustom savehist-additional-variables () | |
b91f17dc | 81 | "*List of additional variables to save. |
2a2b5b29 SM |
82 | Each element is a symbol whose value will be persisted across Emacs |
83 | sessions that use savehist. The contents of variables should be | |
b91f17dc SM |
84 | printable with the Lisp printer. You don't need to add minibuffer |
85 | history variables to this list, all minibuffer histories will be | |
86 | saved automatically as long as `savehist-save-minibuffer-history' is | |
87 | non-nil. | |
88 | ||
89 | User options should be saved with the customize interface. This | |
90 | list is useful for saving automatically updated variables that are not | |
91 | minibuffer histories, such as `compile-command' or `kill-ring'." | |
92 | :type '(repeat variable) | |
cb23c7c1 RS |
93 | :group 'savehist) |
94 | ||
cd4160e6 RS |
95 | (defcustom savehist-ignored-variables nil ;; '(command-history) |
96 | "*List of additional variables not to save." | |
97 | :type '(repeat variable) | |
98 | :group 'savehist) | |
99 | ||
b91f17dc SM |
100 | (defcustom savehist-file |
101 | (cond | |
102 | ;; Backward compatibility with previous versions of savehist. | |
103 | ((file-exists-p "~/.emacs-history") "~/.emacs-history") | |
e3af1e5d CY |
104 | ((and (not (featurep 'xemacs)) (file-directory-p user-emacs-directory)) |
105 | (concat user-emacs-directory "history")) | |
b91f17dc SM |
106 | ((and (featurep 'xemacs) (file-directory-p "~/.xemacs/")) |
107 | "~/.xemacs/history") | |
108 | ;; For users without `~/.emacs.d/' or `~/.xemacs/'. | |
109 | (t "~/.emacs-history")) | |
110 | "*File name where minibuffer history is saved to and loaded from. | |
111 | The minibuffer history is a series of Lisp expressions loaded | |
112 | automatically when `savehist-mode' is turned on. See `savehist-mode' | |
113 | for more details. | |
114 | ||
115 | If you want your minibuffer history shared between Emacs and XEmacs, | |
116 | customize this value and make sure that `savehist-coding-system' is | |
117 | set to a coding system that exists in both emacsen." | |
cb23c7c1 RS |
118 | :type 'file |
119 | :group 'savehist) | |
120 | ||
b91f17dc SM |
121 | (defcustom savehist-file-modes #o600 |
122 | "*Default permissions of the history file. | |
216ee1a4 SM |
123 | This is decimal, not octal. The default is 384 (0600 in octal). |
124 | Set to nil to use the default permissions that Emacs uses, typically | |
125 | mandated by umask. The default is a bit more restrictive to protect | |
126 | the user's privacy." | |
cb23c7c1 RS |
127 | :type 'integer |
128 | :group 'savehist) | |
129 | ||
216ee1a4 | 130 | (defcustom savehist-autosave-interval (* 5 60) |
b91f17dc SM |
131 | "*The interval between autosaves of minibuffer history. |
132 | If set to nil, disables timer-based autosaving." | |
216ee1a4 SM |
133 | :type 'integer |
134 | :group 'savehist) | |
135 | ||
ed5a258a SM |
136 | (defcustom savehist-mode-hook nil |
137 | "Hook called when `savehist-mode' is turned on." | |
105744a3 JL |
138 | :type 'hook |
139 | :group 'savehist) | |
ed5a258a | 140 | |
b91f17dc | 141 | (defcustom savehist-save-hook nil |
b13e8fb3 | 142 | "Hook called by `savehist-save' before saving the variables. |
b91f17dc SM |
143 | You can use this hook to influence choice and content of variables to |
144 | save." | |
f6fbc344 RS |
145 | :type 'hook |
146 | :group 'savehist) | |
b91f17dc | 147 | |
2d10b62b SM |
148 | ;; This should be capable of representing characters used by Emacs. |
149 | ;; We prefer UTF-8 over ISO 2022 because it is well-known outside | |
150 | ;; Mule. XEmacs prir to 21.5 had UTF-8 provided by an external | |
151 | ;; package which may not be loaded, which is why we check for version. | |
152 | (defvar savehist-coding-system (if (and (featurep 'xemacs) | |
153 | (<= emacs-major-version 21) | |
154 | (< emacs-minor-version 5)) | |
7619d43b | 155 | 'iso-2022-8 'utf-8-unix) |
216ee1a4 SM |
156 | "The coding system savehist uses for saving the minibuffer history. |
157 | Changing this value while Emacs is running is supported, but considered | |
158 | unwise, unless you know what you are doing.") | |
159 | ||
160 | ;; Internal variables. | |
161 | ||
162 | (defvar savehist-timer nil) | |
163 | ||
164 | (defvar savehist-last-checksum nil) | |
165 | ||
b91f17dc SM |
166 | (defvar savehist-minibuffer-history-variables nil |
167 | "List of minibuffer histories. | |
168 | The contents of this variable is built while Emacs is running, and saved | |
169 | along with minibuffer history. You can change its value off | |
170 | `savehist-save-hook' to influence which variables are saved.") | |
2a2b5b29 | 171 | |
ed5a258a SM |
172 | (defconst savehist-no-conversion (if (featurep 'xemacs) 'binary 'no-conversion) |
173 | "Coding system without any conversion. | |
174 | This is used for calculating an internal checksum. Should be as fast | |
175 | as possible, ideally simply exposing the internal representation of | |
176 | buffer text.") | |
b91f17dc | 177 | |
ed5a258a SM |
178 | (defvar savehist-loaded nil |
179 | "Whether the history has already been loaded. | |
d33544d3 | 180 | This prevents toggling `savehist-mode' from destroying existing |
ed5a258a | 181 | minibuffer history.") |
b91f17dc | 182 | |
2d10b62b SM |
183 | (when (featurep 'xemacs) |
184 | ;; Must declare this under XEmacs, which doesn't have built-in | |
185 | ;; minibuffer history truncation. | |
186 | (defvar history-length 100)) | |
cb23c7c1 | 187 | \f |
2a2b5b29 SM |
188 | ;; Functions. |
189 | ||
b91f17dc SM |
190 | ;;;###autoload |
191 | (defun savehist-mode (arg) | |
192 | "Toggle savehist-mode. | |
193 | Positive ARG turns on `savehist-mode'. When on, savehist-mode causes | |
194 | minibuffer history to be saved periodically and when exiting Emacs. | |
195 | When turned on for the first time in an Emacs session, it causes the | |
196 | previous minibuffer history to be loaded from `savehist-file'. | |
197 | ||
198 | This mode should normally be turned on from your Emacs init file. | |
199 | Calling it at any other time replaces your current minibuffer histories, | |
200 | which is probably undesirable." | |
201 | (interactive "P") | |
202 | (setq savehist-mode | |
203 | (if (null arg) | |
204 | (not savehist-mode) | |
205 | (> (prefix-numeric-value arg) 0))) | |
206 | (if (not savehist-mode) | |
207 | (savehist-uninstall) | |
208 | (when (and (not savehist-loaded) | |
209 | (file-exists-p savehist-file)) | |
210 | (condition-case errvar | |
211 | (progn | |
212 | ;; Don't set coding-system-for-read -- we rely on the | |
213 | ;; coding cookie to convey that information. That way, if | |
214 | ;; the user changes the value of savehist-coding-system, | |
215 | ;; we can still correctly load the old file. | |
216 | (load savehist-file nil (not (interactive-p))) | |
217 | (setq savehist-loaded t)) | |
218 | (error | |
219 | ;; Don't install the mode if reading failed. Doing so would | |
220 | ;; effectively destroy the user's data at the next save. | |
221 | (setq savehist-mode nil) | |
222 | (savehist-uninstall) | |
223 | (signal (car errvar) (cdr errvar))))) | |
ed5a258a SM |
224 | (savehist-install) |
225 | (run-hooks 'savehist-mode-hook)) | |
b13e8fb3 SM |
226 | ;; Return the new setting. |
227 | savehist-mode) | |
b91f17dc SM |
228 | (add-minor-mode 'savehist-mode "") |
229 | ||
230 | (defun savehist-load () | |
231 | "Obsolete function provided for transition from old versions of savehist. | |
232 | Don't call this from new code, use (savehist-mode 1) instead. | |
233 | ||
234 | This function loads the variables stored in `savehist-file' and turns on | |
d33544d3 JB |
235 | `savehist-mode'. If `savehist-file' is in the old format that doesn't |
236 | record the value of `savehist-minibuffer-history-variables', that value | |
237 | is deducted from the contents of the file." | |
b91f17dc SM |
238 | (savehist-mode 1) |
239 | ;; Old versions of savehist distributed with XEmacs didn't save | |
240 | ;; savehist-minibuffer-history-variables. If that variable is nil | |
241 | ;; after loading the file, try to intuit the intended value. | |
242 | (when (null savehist-minibuffer-history-variables) | |
243 | (setq savehist-minibuffer-history-variables | |
244 | (with-temp-buffer | |
245 | (ignore-errors | |
246 | (insert-file-contents savehist-file)) | |
247 | (let ((vars ()) form) | |
248 | (while (setq form (condition-case nil | |
249 | (read (current-buffer)) (error nil))) | |
250 | ;; Each form read is of the form (setq VAR VALUE). | |
251 | ;; Collect VAR, i.e. (nth form 1). | |
252 | (push (nth 1 form) vars)) | |
253 | vars))))) | |
254 | (make-obsolete 'savehist-load 'savehist-mode) | |
255 | ||
2a2b5b29 SM |
256 | (defun savehist-install () |
257 | "Hook savehist into Emacs. | |
b91f17dc | 258 | Normally invoked by calling `savehist-mode' to set the minor mode. |
d33544d3 JB |
259 | Installs `savehist-autosave' in `kill-emacs-hook' and on a timer. |
260 | To undo this, call `savehist-uninstall'." | |
2a2b5b29 SM |
261 | (add-hook 'minibuffer-setup-hook 'savehist-minibuffer-hook) |
262 | (add-hook 'kill-emacs-hook 'savehist-autosave) | |
263 | ;; Install an invocation of savehist-autosave on a timer. This | |
264 | ;; should not cause noticeable delays for users -- savehist-autosave | |
265 | ;; executes in under 5 ms on my system. | |
b91f17dc SM |
266 | (when (and savehist-autosave-interval |
267 | (null savehist-timer)) | |
2a2b5b29 SM |
268 | (setq savehist-timer |
269 | (if (featurep 'xemacs) | |
270 | (start-itimer | |
271 | "savehist" 'savehist-autosave savehist-autosave-interval | |
272 | savehist-autosave-interval) | |
b91f17dc SM |
273 | (run-with-timer savehist-autosave-interval |
274 | savehist-autosave-interval 'savehist-autosave))))) | |
2a2b5b29 SM |
275 | |
276 | (defun savehist-uninstall () | |
b91f17dc SM |
277 | "Undo installing savehist. |
278 | Normally invoked by calling `savehist-mode' to unset the minor mode." | |
2a2b5b29 SM |
279 | (remove-hook 'minibuffer-setup-hook 'savehist-minibuffer-hook) |
280 | (remove-hook 'kill-emacs-hook 'savehist-autosave) | |
281 | (when savehist-timer | |
282 | (if (featurep 'xemacs) | |
283 | (delete-itimer savehist-timer) | |
284 | (cancel-timer savehist-timer)) | |
285 | (setq savehist-timer nil))) | |
cb23c7c1 | 286 | |
216ee1a4 | 287 | (defun savehist-save (&optional auto-save) |
2a2b5b29 SM |
288 | "Save the values of minibuffer history variables. |
289 | Unbound symbols referenced in `savehist-additional-variables' are ignored. | |
216ee1a4 SM |
290 | If AUTO-SAVE is non-nil, compare the saved contents to the one last saved, |
291 | and don't save the buffer if they are the same." | |
cb23c7c1 | 292 | (interactive) |
216ee1a4 SM |
293 | (with-temp-buffer |
294 | (insert | |
295 | (format ";; -*- mode: emacs-lisp; coding: %s -*-\n" savehist-coding-system) | |
296 | ";; Minibuffer history file, automatically generated by `savehist'.\n\n") | |
b91f17dc | 297 | (run-hooks 'savehist-save-hook) |
216ee1a4 SM |
298 | (let ((print-length nil) |
299 | (print-string-length nil) | |
300 | (print-level nil) | |
301 | (print-readably t) | |
b91f17dc SM |
302 | (print-quoted t)) |
303 | ;; Save the minibuffer histories, along with the value of | |
304 | ;; savehist-minibuffer-history-variables itself. | |
305 | (when savehist-save-minibuffer-history | |
306 | (prin1 `(setq savehist-minibuffer-history-variables | |
307 | ',savehist-minibuffer-history-variables) | |
308 | (current-buffer)) | |
309 | (insert ?\n) | |
310 | (dolist (symbol savehist-minibuffer-history-variables) | |
e2295672 RS |
311 | (when (and (boundp symbol) |
312 | (not (memq symbol savehist-ignored-variables))) | |
648db50d RS |
313 | (let ((value (savehist-trim-history (symbol-value symbol))) |
314 | excess-space) | |
315 | (when value ; Don't save empty histories. | |
316 | (insert "(setq ") | |
317 | (prin1 symbol (current-buffer)) | |
318 | (insert " '(") | |
319 | ;; We will print an extra space before the first element. | |
320 | ;; Record where that is. | |
321 | (setq excess-space (point)) | |
322 | ;; Print elements of VALUE one by one, carefully. | |
323 | (dolist (elt value) | |
324 | (let ((start (point))) | |
325 | (insert " ") | |
326 | (prin1 elt (current-buffer)) | |
327 | ;; Try to read the element we just printed. | |
328 | (condition-case nil | |
329 | (save-excursion | |
330 | (goto-char start) | |
331 | (read (current-buffer))) | |
332 | (error | |
333 | ;; If reading it gets an error, comment it out. | |
334 | (goto-char start) | |
335 | (insert "\n") | |
336 | (while (not (eobp)) | |
337 | (insert ";;; ") | |
338 | (forward-line 1)) | |
339 | (insert "\n"))) | |
340 | (goto-char (point-max)))) | |
341 | ;; Delete the extra space before the first element. | |
342 | (save-excursion | |
343 | (goto-char excess-space) | |
344 | (if (eq (following-char) ?\s) | |
345 | (delete-region (point) (1+ (point))))) | |
346 | (insert "))\n")))))) | |
b91f17dc SM |
347 | ;; Save the additional variables. |
348 | (dolist (symbol savehist-additional-variables) | |
349 | (when (boundp symbol) | |
350 | (let ((value (symbol-value symbol))) | |
351 | (when (savehist-printable value) | |
352 | (prin1 `(setq ,symbol ',value) (current-buffer)) | |
353 | (insert ?\n)))))) | |
216ee1a4 SM |
354 | ;; If autosaving, avoid writing if nothing has changed since the |
355 | ;; last write. | |
356 | (let ((checksum (md5 (current-buffer) nil nil savehist-no-conversion))) | |
357 | (unless (and auto-save (equal checksum savehist-last-checksum)) | |
358 | ;; Set file-precious-flag when saving the buffer because we | |
359 | ;; don't want a half-finished write ruining the entire | |
2a2b5b29 SM |
360 | ;; history. Remember that this is run from a timer and from |
361 | ;; kill-emacs-hook, and also that multiple Emacs instances | |
362 | ;; could write to this file at once. | |
216ee1a4 SM |
363 | (let ((file-precious-flag t) |
364 | (coding-system-for-write savehist-coding-system)) | |
365 | (write-region (point-min) (point-max) savehist-file nil | |
366 | (unless (interactive-p) 'quiet))) | |
b91f17dc SM |
367 | (when savehist-file-modes |
368 | (set-file-modes savehist-file savehist-file-modes)) | |
216ee1a4 SM |
369 | (setq savehist-last-checksum checksum))))) |
370 | ||
371 | (defun savehist-autosave () | |
b91f17dc | 372 | "Save the minibuffer history if it has been modified since the last save. |
d33544d3 | 373 | Does nothing if `savehist-mode' is off." |
b91f17dc SM |
374 | (when savehist-mode |
375 | (savehist-save t))) | |
376 | ||
377 | (defun savehist-trim-history (value) | |
d33544d3 | 378 | "Retain only the first `history-length' items in VALUE. |
ed5a258a | 379 | Only used under XEmacs, which doesn't (yet) implement automatic |
d33544d3 | 380 | trimming of history lists to `history-length' items." |
b91f17dc SM |
381 | (if (and (featurep 'xemacs) |
382 | (natnump history-length) | |
383 | (> (length value) history-length)) | |
384 | ;; Equivalent to `(subseq value 0 history-length)', but doesn't | |
385 | ;; need cl-extra at run-time. | |
386 | (loop repeat history-length collect (pop value)) | |
387 | value)) | |
216ee1a4 SM |
388 | |
389 | (defun savehist-printable (value) | |
3930b7e4 | 390 | "Return non-nil if VALUE is printable." |
216ee1a4 | 391 | (cond |
b91f17dc | 392 | ;; Quick response for oft-encountered types known to be printable. |
216ee1a4 SM |
393 | ((stringp value)) |
394 | ((numberp value)) | |
395 | ((symbolp value)) | |
396 | (t | |
397 | ;; For others, check explicitly. | |
b91f17dc SM |
398 | (with-temp-buffer |
399 | (condition-case nil | |
400 | (let ((print-readably t) (print-level nil)) | |
401 | ;; Print the value into a buffer... | |
402 | (prin1 value (current-buffer)) | |
216ee1a4 | 403 | ;; ...and attempt to read it. |
b91f17dc | 404 | (read (point-min-marker)) |
216ee1a4 SM |
405 | ;; The attempt worked: the object is printable. |
406 | t) | |
b91f17dc SM |
407 | ;; The attempt failed: the object is not printable. |
408 | (error nil)))))) | |
cb23c7c1 | 409 | |
2a2b5b29 | 410 | (defun savehist-minibuffer-hook () |
cd4160e6 RS |
411 | (unless (or (eq minibuffer-history-variable t) |
412 | ;; XEmacs sets minibuffer-history-variable to t to mean "no | |
413 | ;; history is being recorded". | |
414 | (memq minibuffer-history-variable savehist-ignored-variables)) | |
2d10b62b SM |
415 | (add-to-list 'savehist-minibuffer-history-variables |
416 | minibuffer-history-variable))) | |
2a2b5b29 | 417 | |
cb23c7c1 | 418 | (provide 'savehist) |
b91f17dc | 419 | \f |
16b52b61 | 420 | ;; arch-tag: b3ce47f4-c5ad-4ebc-ad02-73aba705cf9f |
b91f17dc | 421 | |
cb23c7c1 | 422 | ;;; savehist.el ends here |