annotate lisp/savehist.el @ 68365:72d2da82303c

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