savehist.el 14.1 KB
Newer Older
1
;;; savehist.el --- Save minibuffer history.
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Stefan Monnier's avatar
Stefan Monnier committed
3
;; Copyright (C) 1997,2005 Free Software Foundation
Richard M. Stallman's avatar
Richard M. Stallman committed
4 5 6

;; Author: Hrvoje Niksic <hniksic@xemacs.org>
;; Keywords: minibuffer
7
;; Version: 24
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.

;;; Commentary:

28 29
;; Many editors (e.g. Vim) have the feature of saving minibuffer
;; history to an external file after exit.  This package provides the
Stefan Monnier's avatar
Stefan Monnier committed
30 31 32 33
;; same feature in Emacs.  When set up, it saves recorded minibuffer
;; histories to a file (`~/.emacs-history' by default).  Additional
;; variables may be specified by customizing
;; `savehist-additional-variables'.
Richard M. Stallman's avatar
Richard M. Stallman committed
34

Stefan Monnier's avatar
Stefan Monnier committed
35 36
;; To use savehist, turn on savehist-mode by putting the following in
;; `~/.emacs':
Richard M. Stallman's avatar
Richard M. Stallman committed
37
;;
Stefan Monnier's avatar
Stefan Monnier committed
38 39 40 41 42
;;     (savehist-mode 1)
;;
;; or with customize: `M-x customize-option RET savehist-mode RET'.
;;
;; You can also explicitly save history with `M-x savehist-save' and
43
;; load it by loading the `savehist-file' with `M-x load-file'.
Richard M. Stallman's avatar
Richard M. Stallman committed
44

Stefan Monnier's avatar
Stefan Monnier committed
45 46 47
;; If you are using a version of Emacs that does not ship with this
;; package, be sure to have `savehist.el' in a directory that is in
;; your load-path, and to byte-compile it.
48

Richard M. Stallman's avatar
Richard M. Stallman committed
49 50
;;; Code:

51
(require 'custom)
Stefan Monnier's avatar
Stefan Monnier committed
52 53
(eval-when-compile
  (require 'cl))
54

Richard M. Stallman's avatar
Richard M. Stallman committed
55 56 57 58 59 60
;; User variables

(defgroup savehist nil
  "Save minibuffer history."
  :group 'minibuffer)

Stefan Monnier's avatar
Stefan Monnier committed
61 62 63 64 65 66
;;;###autoload
(defcustom savehist-mode nil
  "Mode for automatic saving of minibuffer history.
Set this by calling the `savehist-mode' function or using the customize
interface."
  :type 'boolean
67
  :set (lambda (symbol value) (savehist-mode (or value 0)))
Stefan Monnier's avatar
Stefan Monnier committed
68 69 70 71
  :initialize 'custom-initialize-default
  :require 'savehist
  :group 'savehist)

Stefan Monnier's avatar
Stefan Monnier committed
72
(defcustom savehist-save-minibuffer-history t
Stefan Monnier's avatar
Stefan Monnier committed
73 74 75
  "*If non-nil, save all recorded minibuffer histories.
If you want to save only specific histories, use `savehist-save-hook' to
modify the value of `savehist-minibuffer-history-variables'."
Stefan Monnier's avatar
Stefan Monnier committed
76 77 78 79
  :type 'boolean
  :group 'savehist)

(defcustom savehist-additional-variables ()
Stefan Monnier's avatar
Stefan Monnier committed
80
  "*List of additional variables to save.
Stefan Monnier's avatar
Stefan Monnier committed
81 82
Each element is a symbol whose value will be persisted across Emacs
sessions that use savehist.  The contents of variables should be
Stefan Monnier's avatar
Stefan Monnier committed
83 84 85 86 87 88 89 90 91
printable with the Lisp printer.  You don't need to add minibuffer
history variables to this list, all minibuffer histories will be
saved automatically as long as `savehist-save-minibuffer-history' is
non-nil.

User options should be saved with the customize interface.  This
list is useful for saving automatically updated variables that are not
minibuffer histories, such as `compile-command' or `kill-ring'."
  :type '(repeat variable)
Richard M. Stallman's avatar
Richard M. Stallman committed
92 93
  :group 'savehist)

Stefan Monnier's avatar
Stefan Monnier committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
(defcustom savehist-file
  (cond
   ;; Backward compatibility with previous versions of savehist.
   ((file-exists-p "~/.emacs-history") "~/.emacs-history")
   ((and (not (featurep 'xemacs)) (file-directory-p "~/.emacs.d/"))
    "~/.emacs.d/history")
   ((and (featurep 'xemacs) (file-directory-p "~/.xemacs/"))
    "~/.xemacs/history")
   ;; For users without `~/.emacs.d/' or `~/.xemacs/'.
   (t "~/.emacs-history"))
  "*File name where minibuffer history is saved to and loaded from.
The minibuffer history is a series of Lisp expressions loaded
automatically when `savehist-mode' is turned on.  See `savehist-mode'
for more details.

If you want your minibuffer history shared between Emacs and XEmacs,
customize this value and make sure that `savehist-coding-system' is
set to a coding system that exists in both emacsen."
Richard M. Stallman's avatar
Richard M. Stallman committed
112 113 114
  :type 'file
  :group 'savehist)

Stefan Monnier's avatar
Stefan Monnier committed
115 116
(defcustom savehist-file-modes #o600
  "*Default permissions of the history file.
117 118 119 120
This is decimal, not octal.  The default is 384 (0600 in octal).
Set to nil to use the default permissions that Emacs uses, typically
mandated by umask.  The default is a bit more restrictive to protect
the user's privacy."
Richard M. Stallman's avatar
Richard M. Stallman committed
121 122 123
  :type 'integer
  :group 'savehist)

124
(defcustom savehist-autosave-interval (* 5 60)
Stefan Monnier's avatar
Stefan Monnier committed
125 126
  "*The interval between autosaves of minibuffer history.
If set to nil, disables timer-based autosaving."
127 128 129
  :type 'integer
  :group 'savehist)

130 131 132 133
(defcustom savehist-mode-hook nil
  "Hook called when `savehist-mode' is turned on."
  :type 'hook)

Stefan Monnier's avatar
Stefan Monnier committed
134
(defcustom savehist-save-hook nil
135
  "Hook called by `savehist-save' before saving the variables.
Stefan Monnier's avatar
Stefan Monnier committed
136 137 138 139
You can use this hook to influence choice and content of variables to
save."
  :type 'hook)

140 141 142 143 144 145 146 147
;; This should be capable of representing characters used by Emacs.
;; We prefer UTF-8 over ISO 2022 because it is well-known outside
;; Mule.  XEmacs prir to 21.5 had UTF-8 provided by an external
;; package which may not be loaded, which is why we check for version.
(defvar savehist-coding-system (if (and (featurep 'xemacs)
					(<= emacs-major-version 21)
					(< emacs-minor-version 5))
				   'iso-2022-8 'utf-8)
148 149 150 151 152 153 154 155 156 157
  "The coding system savehist uses for saving the minibuffer history.
Changing this value while Emacs is running is supported, but considered
unwise, unless you know what you are doing.")

;; Internal variables.

(defvar savehist-timer nil)

(defvar savehist-last-checksum nil)

Stefan Monnier's avatar
Stefan Monnier committed
158 159 160 161 162
(defvar savehist-minibuffer-history-variables nil
  "List of minibuffer histories.
The contents of this variable is built while Emacs is running, and saved
along with minibuffer history.  You can change its value off
`savehist-save-hook' to influence which variables are saved.")
Stefan Monnier's avatar
Stefan Monnier committed
163

164 165 166 167 168
(defconst savehist-no-conversion (if (featurep 'xemacs) 'binary 'no-conversion)
  "Coding system without any conversion.
This is used for calculating an internal checksum.  Should be as fast
as possible, ideally simply exposing the internal representation of
buffer text.")
Stefan Monnier's avatar
Stefan Monnier committed
169

170 171 172 173
(defvar savehist-loaded nil
  "Whether the history has already been loaded.
This prevents toggling savehist-mode from destroying existing
minibuffer history.")
Stefan Monnier's avatar
Stefan Monnier committed
174

175 176 177 178
(when (featurep 'xemacs)
  ;; Must declare this under XEmacs, which doesn't have built-in
  ;; minibuffer history truncation.
  (defvar history-length 100))
Richard M. Stallman's avatar
Richard M. Stallman committed
179

Stefan Monnier's avatar
Stefan Monnier committed
180 181
;; Functions.

Stefan Monnier's avatar
Stefan Monnier committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
;;;###autoload
(defun savehist-mode (arg)
  "Toggle savehist-mode.
Positive ARG turns on `savehist-mode'.  When on, savehist-mode causes
minibuffer history to be saved periodically and when exiting Emacs.
When turned on for the first time in an Emacs session, it causes the
previous minibuffer history to be loaded from `savehist-file'.

This mode should normally be turned on from your Emacs init file.
Calling it at any other time replaces your current minibuffer histories,
which is probably undesirable."
  (interactive "P")
  (setq savehist-mode
	(if (null arg)
	    (not savehist-mode)
	  (> (prefix-numeric-value arg) 0)))
  (if (not savehist-mode)
      (savehist-uninstall)
    (when (and (not savehist-loaded)
	       (file-exists-p savehist-file))
      (condition-case errvar
	  (progn
	    ;; Don't set coding-system-for-read -- we rely on the
	    ;; coding cookie to convey that information.  That way, if
	    ;; the user changes the value of savehist-coding-system,
	    ;; we can still correctly load the old file.
	    (load savehist-file nil (not (interactive-p)))
	    (setq savehist-loaded t))
	(error
	 ;; Don't install the mode if reading failed.  Doing so would
	 ;; effectively destroy the user's data at the next save.
	 (setq savehist-mode nil)
	 (savehist-uninstall)
	 (signal (car errvar) (cdr errvar)))))
216 217
    (savehist-install)
    (run-hooks 'savehist-mode-hook))
218 219
  ;; Return the new setting.
  savehist-mode)
Stefan Monnier's avatar
Stefan Monnier committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
(add-minor-mode 'savehist-mode "")

(defun savehist-load ()
  "Obsolete function provided for transition from old versions of savehist.
Don't call this from new code, use (savehist-mode 1) instead.

This function loads the variables stored in `savehist-file' and turns on
savehist-mode.  If savehist-file is in the old format that doesn't record
the value of `savehist-minibuffer-history-variables', that value is
deducted from the contents of the file."
  (savehist-mode 1)
  ;; Old versions of savehist distributed with XEmacs didn't save
  ;; savehist-minibuffer-history-variables.  If that variable is nil
  ;; after loading the file, try to intuit the intended value.
  (when (null savehist-minibuffer-history-variables)
    (setq savehist-minibuffer-history-variables
          (with-temp-buffer
	    (ignore-errors
	      (insert-file-contents savehist-file))
            (let ((vars ()) form)
              (while (setq form (condition-case nil
				    (read (current-buffer)) (error nil)))
		;; Each form read is of the form (setq VAR VALUE).
		;; Collect VAR, i.e. (nth form 1).
                (push (nth 1 form) vars))
              vars)))))
(make-obsolete 'savehist-load 'savehist-mode)

Stefan Monnier's avatar
Stefan Monnier committed
248 249
(defun savehist-install ()
  "Hook savehist into Emacs.
Stefan Monnier's avatar
Stefan Monnier committed
250 251 252
Normally invoked by calling `savehist-mode' to set the minor mode.
Installs `savehist-autosave' in `kill-emacs-hook' and on a timer.   To
undo this, call `savehist-uninstall'."
Stefan Monnier's avatar
Stefan Monnier committed
253 254 255 256 257
  (add-hook 'minibuffer-setup-hook 'savehist-minibuffer-hook)
  (add-hook 'kill-emacs-hook 'savehist-autosave)
  ;; Install an invocation of savehist-autosave on a timer.  This
  ;; should not cause noticeable delays for users -- savehist-autosave
  ;; executes in under 5 ms on my system.
Stefan Monnier's avatar
Stefan Monnier committed
258 259
  (when (and savehist-autosave-interval
	     (null savehist-timer))
Stefan Monnier's avatar
Stefan Monnier committed
260 261 262 263 264
    (setq savehist-timer
	  (if (featurep 'xemacs)
	      (start-itimer
	       "savehist" 'savehist-autosave savehist-autosave-interval
	       savehist-autosave-interval)
Stefan Monnier's avatar
Stefan Monnier committed
265 266
	    (run-with-timer savehist-autosave-interval
			    savehist-autosave-interval 'savehist-autosave)))))
Stefan Monnier's avatar
Stefan Monnier committed
267 268

(defun savehist-uninstall ()
Stefan Monnier's avatar
Stefan Monnier committed
269 270
  "Undo installing savehist.
Normally invoked by calling `savehist-mode' to unset the minor mode."
Stefan Monnier's avatar
Stefan Monnier committed
271 272 273 274 275 276 277
  (remove-hook 'minibuffer-setup-hook 'savehist-minibuffer-hook)
  (remove-hook 'kill-emacs-hook 'savehist-autosave)
  (when savehist-timer
    (if (featurep 'xemacs)
	(delete-itimer savehist-timer)
      (cancel-timer savehist-timer))
    (setq savehist-timer nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
278

279
(defun savehist-save (&optional auto-save)
Stefan Monnier's avatar
Stefan Monnier committed
280 281
  "Save the values of minibuffer history variables.
Unbound symbols referenced in `savehist-additional-variables' are ignored.
282 283
If AUTO-SAVE is non-nil, compare the saved contents to the one last saved,
 and don't save the buffer if they are the same."
Richard M. Stallman's avatar
Richard M. Stallman committed
284
  (interactive)
285 286 287 288
  (with-temp-buffer
    (insert
     (format ";; -*- mode: emacs-lisp; coding: %s -*-\n" savehist-coding-system)
     ";; Minibuffer history file, automatically generated by `savehist'.\n\n")
Stefan Monnier's avatar
Stefan Monnier committed
289
    (run-hooks 'savehist-save-hook)
290 291 292 293
    (let ((print-length nil)
	  (print-string-length nil)
	  (print-level nil)
	  (print-readably t)
Stefan Monnier's avatar
Stefan Monnier committed
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
	  (print-quoted t))
      ;; Save the minibuffer histories, along with the value of
      ;; savehist-minibuffer-history-variables itself.
      (when savehist-save-minibuffer-history
	(prin1 `(setq savehist-minibuffer-history-variables
		      ',savehist-minibuffer-history-variables)
	       (current-buffer))
	(insert ?\n)
	(dolist (symbol savehist-minibuffer-history-variables)
	  (when (boundp symbol)
	    (let ((value (savehist-trim-history (symbol-value symbol))))
	      (when value		; don't save empty histories
		(prin1 `(setq ,symbol ',value) (current-buffer))
		(insert ?\n))))))
      ;; Save the additional variables.
      (dolist (symbol savehist-additional-variables)
	(when (boundp symbol)
	  (let ((value (symbol-value symbol)))
	    (when (savehist-printable value)
	      (prin1 `(setq ,symbol ',value) (current-buffer))
	      (insert ?\n))))))
315 316 317 318 319 320
    ;; If autosaving, avoid writing if nothing has changed since the
    ;; last write.
    (let ((checksum (md5 (current-buffer) nil nil savehist-no-conversion)))
      (unless (and auto-save (equal checksum savehist-last-checksum))
	;; Set file-precious-flag when saving the buffer because we
	;; don't want a half-finished write ruining the entire
Stefan Monnier's avatar
Stefan Monnier committed
321 322 323
	;; history.  Remember that this is run from a timer and from
	;; kill-emacs-hook, and also that multiple Emacs instances
	;; could write to this file at once.
324 325 326 327
	(let ((file-precious-flag t)
	      (coding-system-for-write savehist-coding-system))
	  (write-region (point-min) (point-max) savehist-file nil
			(unless (interactive-p) 'quiet)))
Stefan Monnier's avatar
Stefan Monnier committed
328 329
	(when savehist-file-modes
	  (set-file-modes savehist-file savehist-file-modes))
330 331 332
	(setq savehist-last-checksum checksum)))))

(defun savehist-autosave ()
Stefan Monnier's avatar
Stefan Monnier committed
333 334 335 336 337 338
  "Save the minibuffer history if it has been modified since the last save.
Does nothing if savehist-mode is off."
  (when savehist-mode
    (savehist-save t)))

(defun savehist-trim-history (value)
339 340 341
  "Retain only the first history-length items in VALUE.
Only used under XEmacs, which doesn't (yet) implement automatic
trimming of history lists to history-length items."
Stefan Monnier's avatar
Stefan Monnier committed
342 343 344 345 346 347 348
  (if (and (featurep 'xemacs)
	   (natnump history-length)
	   (> (length value) history-length))
      ;; Equivalent to `(subseq value 0 history-length)', but doesn't
      ;; need cl-extra at run-time.
      (loop repeat history-length collect (pop value))
    value))
349 350

(defun savehist-printable (value)
Stefan Monnier's avatar
Stefan Monnier committed
351
  "Return non-nil if VALUE is printable."
352
  (cond
Stefan Monnier's avatar
Stefan Monnier committed
353
   ;; Quick response for oft-encountered types known to be printable.
354 355 356 357 358
   ((stringp value))
   ((numberp value))
   ((symbolp value))
   (t
    ;; For others, check explicitly.
Stefan Monnier's avatar
Stefan Monnier committed
359 360 361 362 363
    (with-temp-buffer
      (condition-case nil
	  (let ((print-readably t) (print-level nil))
	  ;; Print the value into a buffer...
	  (prin1 value (current-buffer))
364
	  ;; ...and attempt to read it.
Stefan Monnier's avatar
Stefan Monnier committed
365
	  (read (point-min-marker))
366 367
	  ;; The attempt worked: the object is printable.
	  t)
Stefan Monnier's avatar
Stefan Monnier committed
368 369
	;; The attempt failed: the object is not printable.
	(error nil))))))
Richard M. Stallman's avatar
Richard M. Stallman committed
370

Stefan Monnier's avatar
Stefan Monnier committed
371
(defun savehist-minibuffer-hook ()
372 373 374 375 376
  ;; XEmacs sets minibuffer-history-variable to t to mean "no history
  ;; is being recorded".
  (unless (eq minibuffer-history-variable t)
    (add-to-list 'savehist-minibuffer-history-variables
		 minibuffer-history-variable)))
Stefan Monnier's avatar
Stefan Monnier committed
377

Richard M. Stallman's avatar
Richard M. Stallman committed
378
(provide 'savehist)
Stefan Monnier's avatar
Stefan Monnier committed
379

Miles Bader's avatar
Miles Bader committed
380
;; arch-tag: b3ce47f4-c5ad-4ebc-ad02-73aba705cf9f
Stefan Monnier's avatar
Stefan Monnier committed
381

Richard M. Stallman's avatar
Richard M. Stallman committed
382
;;; savehist.el ends here