2019-05-14 18:00:58 +00:00
|
|
|
|
;;; savehist.el --- Save minibuffer history -*- lexical-binding:t -*-
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2019-01-01 00:59:58 +00:00
|
|
|
|
;; Copyright (C) 1997, 2005-2019 Free Software Foundation, Inc.
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2019-05-26 07:58:28 +00:00
|
|
|
|
;; Author: Hrvoje Nikšić <hrvoje.niksic@avl.com>
|
2019-05-25 20:43:06 +00:00
|
|
|
|
;; Maintainer: emacs-devel@gnu.org
|
2005-10-16 02:10:39 +00:00
|
|
|
|
;; Keywords: minibuffer
|
2005-11-16 17:20:25 +00:00
|
|
|
|
;; Version: 24
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
2008-05-06 08:06:51 +00:00
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2005-10-16 02:10:39 +00:00
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2008-05-06 08:06:51 +00:00
|
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
;; (at your option) any later version.
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
|
|
|
|
;; 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
|
2017-09-13 22:52:52 +00:00
|
|
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
2005-10-16 15:02:39 +00:00
|
|
|
|
;; Many editors (e.g. Vim) have the feature of saving minibuffer
|
|
|
|
|
;; history to an external file after exit. This package provides the
|
2005-10-24 17:21:30 +00:00
|
|
|
|
;; 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'.
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2005-11-01 05:49:46 +00:00
|
|
|
|
;; To use savehist, turn on savehist-mode by putting the following in
|
|
|
|
|
;; `~/.emacs':
|
2005-10-16 02:10:39 +00:00
|
|
|
|
;;
|
2005-11-01 05:49:46 +00:00
|
|
|
|
;; (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
|
2005-11-01 06:09:32 +00:00
|
|
|
|
;; load it by loading the `savehist-file' with `M-x load-file'.
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2005-10-24 17:21:30 +00:00
|
|
|
|
;; 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.
|
2005-10-16 15:02:39 +00:00
|
|
|
|
|
2005-10-16 02:10:39 +00:00
|
|
|
|
;;; Code:
|
|
|
|
|
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(require 'custom)
|
|
|
|
|
|
2005-10-16 02:10:39 +00:00
|
|
|
|
;; User variables
|
|
|
|
|
|
|
|
|
|
(defgroup savehist nil
|
|
|
|
|
"Save minibuffer history."
|
2006-04-03 17:32:28 +00:00
|
|
|
|
:version "22.1"
|
2005-10-16 02:10:39 +00:00
|
|
|
|
:group 'minibuffer)
|
|
|
|
|
|
2005-10-24 17:21:30 +00:00
|
|
|
|
(defcustom savehist-save-minibuffer-history t
|
* completion.el (add-completion-to-head, add-completion): Doc fixes.
(completion-search-next, add-completions-from-file):
Fix typos in docstrings.
* filesets.el (filesets-menu-ensure-use-cached)
(filesets-ingroup-patterns, filesets-filetype-property):
* tutorial.el (get-lang-string):
* play/gamegrid.el (gamegrid-score-file-length, gamegrid-add-score):
Fix typos in docstrings.
* image-dired.el (image-dired-dired-after-readin-hook): Doc fix.
(image-dired-line-up-method, image-dired-thumb-size)
(image-dired-cmd-write-exif-data-options, image-dired-write-tags)
(image-dired-track-original-file, image-dired-track-thumbnail)
(image-dired-dired-next-line, image-dired-dired-previous-line)
(image-dired-write-comments): Reflow docstrings.
(image-dired-show-all-from-dir-max-files)
(image-dired-format-properties-string, image-dired-create-thumbs)
(image-dired-mark-tagged-files, image-dired-gallery-generate):
Fix typos in docstrings.
* savehist.el (savehist-save-minibuffer-history, savehist-file)
(savehist-additional-variables, savehist-ignored-variables)
(savehist-file-modes, savehist-autosave-interval):
* startup.el (inhibit-startup-echo-area-message, inhibit-default-init)
(inhibit-startup-buffer-menu, mail-host-address, user-mail-address)
(fancy-splash-image):
* thumbs.el (thumbs-thumbsdir, thumbs-geometry, thumbs-relief)
(thumbs-conversion-program, thumbs-margin):
Remove spurious * in docstrings.
2008-10-25 00:46:25 +00:00
|
|
|
|
"If non-nil, save all recorded minibuffer histories.
|
2014-02-21 00:47:17 +00:00
|
|
|
|
If you want to save only specific histories, use `savehist-save-hook'
|
|
|
|
|
to modify the value of `savehist-minibuffer-history-variables'."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
:type 'boolean)
|
2005-10-24 17:21:30 +00:00
|
|
|
|
|
|
|
|
|
(defcustom savehist-additional-variables ()
|
* completion.el (add-completion-to-head, add-completion): Doc fixes.
(completion-search-next, add-completions-from-file):
Fix typos in docstrings.
* filesets.el (filesets-menu-ensure-use-cached)
(filesets-ingroup-patterns, filesets-filetype-property):
* tutorial.el (get-lang-string):
* play/gamegrid.el (gamegrid-score-file-length, gamegrid-add-score):
Fix typos in docstrings.
* image-dired.el (image-dired-dired-after-readin-hook): Doc fix.
(image-dired-line-up-method, image-dired-thumb-size)
(image-dired-cmd-write-exif-data-options, image-dired-write-tags)
(image-dired-track-original-file, image-dired-track-thumbnail)
(image-dired-dired-next-line, image-dired-dired-previous-line)
(image-dired-write-comments): Reflow docstrings.
(image-dired-show-all-from-dir-max-files)
(image-dired-format-properties-string, image-dired-create-thumbs)
(image-dired-mark-tagged-files, image-dired-gallery-generate):
Fix typos in docstrings.
* savehist.el (savehist-save-minibuffer-history, savehist-file)
(savehist-additional-variables, savehist-ignored-variables)
(savehist-file-modes, savehist-autosave-interval):
* startup.el (inhibit-startup-echo-area-message, inhibit-default-init)
(inhibit-startup-buffer-menu, mail-host-address, user-mail-address)
(fancy-splash-image):
* thumbs.el (thumbs-thumbsdir, thumbs-geometry, thumbs-relief)
(thumbs-conversion-program, thumbs-margin):
Remove spurious * in docstrings.
2008-10-25 00:46:25 +00:00
|
|
|
|
"List of additional variables to save.
|
2005-10-24 17:21:30 +00:00
|
|
|
|
Each element is a symbol whose value will be persisted across Emacs
|
2014-02-21 00:47:17 +00:00
|
|
|
|
sessions that use Savehist. The contents of variables should be
|
2005-11-01 05:49:46 +00:00
|
|
|
|
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.
|
|
|
|
|
|
2014-02-21 00:47:17 +00:00
|
|
|
|
User options should be saved with the Customize interface. This
|
2005-11-01 05:49:46 +00:00
|
|
|
|
list is useful for saving automatically updated variables that are not
|
|
|
|
|
minibuffer histories, such as `compile-command' or `kill-ring'."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
:type '(repeat variable))
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2006-04-03 17:32:28 +00:00
|
|
|
|
(defcustom savehist-ignored-variables nil ;; '(command-history)
|
* completion.el (add-completion-to-head, add-completion): Doc fixes.
(completion-search-next, add-completions-from-file):
Fix typos in docstrings.
* filesets.el (filesets-menu-ensure-use-cached)
(filesets-ingroup-patterns, filesets-filetype-property):
* tutorial.el (get-lang-string):
* play/gamegrid.el (gamegrid-score-file-length, gamegrid-add-score):
Fix typos in docstrings.
* image-dired.el (image-dired-dired-after-readin-hook): Doc fix.
(image-dired-line-up-method, image-dired-thumb-size)
(image-dired-cmd-write-exif-data-options, image-dired-write-tags)
(image-dired-track-original-file, image-dired-track-thumbnail)
(image-dired-dired-next-line, image-dired-dired-previous-line)
(image-dired-write-comments): Reflow docstrings.
(image-dired-show-all-from-dir-max-files)
(image-dired-format-properties-string, image-dired-create-thumbs)
(image-dired-mark-tagged-files, image-dired-gallery-generate):
Fix typos in docstrings.
* savehist.el (savehist-save-minibuffer-history, savehist-file)
(savehist-additional-variables, savehist-ignored-variables)
(savehist-file-modes, savehist-autosave-interval):
* startup.el (inhibit-startup-echo-area-message, inhibit-default-init)
(inhibit-startup-buffer-menu, mail-host-address, user-mail-address)
(fancy-splash-image):
* thumbs.el (thumbs-thumbsdir, thumbs-geometry, thumbs-relief)
(thumbs-conversion-program, thumbs-margin):
Remove spurious * in docstrings.
2008-10-25 00:46:25 +00:00
|
|
|
|
"List of additional variables not to save."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
:type '(repeat variable))
|
2006-04-03 17:32:28 +00:00
|
|
|
|
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(defcustom savehist-file
|
2008-10-24 09:39:27 +00:00
|
|
|
|
(locate-user-emacs-file "history" ".emacs-history")
|
* completion.el (add-completion-to-head, add-completion): Doc fixes.
(completion-search-next, add-completions-from-file):
Fix typos in docstrings.
* filesets.el (filesets-menu-ensure-use-cached)
(filesets-ingroup-patterns, filesets-filetype-property):
* tutorial.el (get-lang-string):
* play/gamegrid.el (gamegrid-score-file-length, gamegrid-add-score):
Fix typos in docstrings.
* image-dired.el (image-dired-dired-after-readin-hook): Doc fix.
(image-dired-line-up-method, image-dired-thumb-size)
(image-dired-cmd-write-exif-data-options, image-dired-write-tags)
(image-dired-track-original-file, image-dired-track-thumbnail)
(image-dired-dired-next-line, image-dired-dired-previous-line)
(image-dired-write-comments): Reflow docstrings.
(image-dired-show-all-from-dir-max-files)
(image-dired-format-properties-string, image-dired-create-thumbs)
(image-dired-mark-tagged-files, image-dired-gallery-generate):
Fix typos in docstrings.
* savehist.el (savehist-save-minibuffer-history, savehist-file)
(savehist-additional-variables, savehist-ignored-variables)
(savehist-file-modes, savehist-autosave-interval):
* startup.el (inhibit-startup-echo-area-message, inhibit-default-init)
(inhibit-startup-buffer-menu, mail-host-address, user-mail-address)
(fancy-splash-image):
* thumbs.el (thumbs-thumbsdir, thumbs-geometry, thumbs-relief)
(thumbs-conversion-program, thumbs-margin):
Remove spurious * in docstrings.
2008-10-25 00:46:25 +00:00
|
|
|
|
"File name where minibuffer history is saved to and loaded from.
|
2005-11-01 05:49:46 +00:00
|
|
|
|
The minibuffer history is a series of Lisp expressions loaded
|
2014-02-21 00:47:17 +00:00
|
|
|
|
automatically when Savehist mode is turned on. See `savehist-mode'
|
2005-11-01 05:49:46 +00:00
|
|
|
|
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."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
:type 'file)
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(defcustom savehist-file-modes #o600
|
* completion.el (add-completion-to-head, add-completion): Doc fixes.
(completion-search-next, add-completions-from-file):
Fix typos in docstrings.
* filesets.el (filesets-menu-ensure-use-cached)
(filesets-ingroup-patterns, filesets-filetype-property):
* tutorial.el (get-lang-string):
* play/gamegrid.el (gamegrid-score-file-length, gamegrid-add-score):
Fix typos in docstrings.
* image-dired.el (image-dired-dired-after-readin-hook): Doc fix.
(image-dired-line-up-method, image-dired-thumb-size)
(image-dired-cmd-write-exif-data-options, image-dired-write-tags)
(image-dired-track-original-file, image-dired-track-thumbnail)
(image-dired-dired-next-line, image-dired-dired-previous-line)
(image-dired-write-comments): Reflow docstrings.
(image-dired-show-all-from-dir-max-files)
(image-dired-format-properties-string, image-dired-create-thumbs)
(image-dired-mark-tagged-files, image-dired-gallery-generate):
Fix typos in docstrings.
* savehist.el (savehist-save-minibuffer-history, savehist-file)
(savehist-additional-variables, savehist-ignored-variables)
(savehist-file-modes, savehist-autosave-interval):
* startup.el (inhibit-startup-echo-area-message, inhibit-default-init)
(inhibit-startup-buffer-menu, mail-host-address, user-mail-address)
(fancy-splash-image):
* thumbs.el (thumbs-thumbsdir, thumbs-geometry, thumbs-relief)
(thumbs-conversion-program, thumbs-margin):
Remove spurious * in docstrings.
2008-10-25 00:46:25 +00:00
|
|
|
|
"Default permissions of the history file.
|
2005-10-16 15:02:39 +00:00
|
|
|
|
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."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
:type 'integer)
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(defcustom savehist-autosave-interval (* 5 60)
|
* completion.el (add-completion-to-head, add-completion): Doc fixes.
(completion-search-next, add-completions-from-file):
Fix typos in docstrings.
* filesets.el (filesets-menu-ensure-use-cached)
(filesets-ingroup-patterns, filesets-filetype-property):
* tutorial.el (get-lang-string):
* play/gamegrid.el (gamegrid-score-file-length, gamegrid-add-score):
Fix typos in docstrings.
* image-dired.el (image-dired-dired-after-readin-hook): Doc fix.
(image-dired-line-up-method, image-dired-thumb-size)
(image-dired-cmd-write-exif-data-options, image-dired-write-tags)
(image-dired-track-original-file, image-dired-track-thumbnail)
(image-dired-dired-next-line, image-dired-dired-previous-line)
(image-dired-write-comments): Reflow docstrings.
(image-dired-show-all-from-dir-max-files)
(image-dired-format-properties-string, image-dired-create-thumbs)
(image-dired-mark-tagged-files, image-dired-gallery-generate):
Fix typos in docstrings.
* savehist.el (savehist-save-minibuffer-history, savehist-file)
(savehist-additional-variables, savehist-ignored-variables)
(savehist-file-modes, savehist-autosave-interval):
* startup.el (inhibit-startup-echo-area-message, inhibit-default-init)
(inhibit-startup-buffer-menu, mail-host-address, user-mail-address)
(fancy-splash-image):
* thumbs.el (thumbs-thumbsdir, thumbs-geometry, thumbs-relief)
(thumbs-conversion-program, thumbs-margin):
Remove spurious * in docstrings.
2008-10-25 00:46:25 +00:00
|
|
|
|
"The interval between autosaves of minibuffer history.
|
2005-11-01 05:49:46 +00:00
|
|
|
|
If set to nil, disables timer-based autosaving."
|
2009-11-30 23:39:04 +00:00
|
|
|
|
:type '(choice (const :tag "Disabled" nil)
|
2019-05-14 18:00:58 +00:00
|
|
|
|
(integer :tag "Seconds")))
|
2005-10-16 15:02:39 +00:00
|
|
|
|
|
2005-11-16 17:20:25 +00:00
|
|
|
|
(defcustom savehist-mode-hook nil
|
2014-02-21 00:47:17 +00:00
|
|
|
|
"Hook called when Savehist mode is turned on."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
:type 'hook)
|
2005-11-16 17:20:25 +00:00
|
|
|
|
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(defcustom savehist-save-hook nil
|
2005-11-01 06:09:32 +00:00
|
|
|
|
"Hook called by `savehist-save' before saving the variables.
|
2014-02-21 00:47:17 +00:00
|
|
|
|
You can use this hook to influence choice and content of variables
|
|
|
|
|
to save."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
:type 'hook)
|
2005-11-01 05:49:46 +00:00
|
|
|
|
|
2005-11-14 22:30:35 +00:00
|
|
|
|
;; This should be capable of representing characters used by Emacs.
|
|
|
|
|
;; We prefer UTF-8 over ISO 2022 because it is well-known outside
|
2019-06-22 09:36:43 +00:00
|
|
|
|
;; Mule.
|
|
|
|
|
(defvar savehist-coding-system 'utf-8-unix
|
2014-02-21 00:47:17 +00:00
|
|
|
|
"The coding system Savehist uses for saving the minibuffer history.
|
2005-10-16 15:02:39 +00:00
|
|
|
|
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)
|
|
|
|
|
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(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.")
|
2005-10-24 17:21:30 +00:00
|
|
|
|
|
2005-11-16 17:20:25 +00:00
|
|
|
|
(defvar savehist-loaded nil
|
|
|
|
|
"Whether the history has already been loaded.
|
2014-02-21 00:47:17 +00:00
|
|
|
|
This prevents toggling Savehist mode from destroying existing
|
2005-11-16 17:20:25 +00:00
|
|
|
|
minibuffer history.")
|
2005-11-01 05:49:46 +00:00
|
|
|
|
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2005-10-24 17:21:30 +00:00
|
|
|
|
;; Functions.
|
|
|
|
|
|
2005-11-01 05:49:46 +00:00
|
|
|
|
;;;###autoload
|
2010-05-03 02:29:46 +00:00
|
|
|
|
(define-minor-mode savehist-mode
|
Fix minor mode docstrings for the new meaning of a nil ARG.
* abbrev.el (abbrev-mode):
* allout.el (allout-mode):
* autoinsert.el (auto-insert-mode):
* autoarg.el (autoarg-mode, autoarg-kp-mode):
* autorevert.el (auto-revert-mode, auto-revert-tail-mode)
(global-auto-revert-mode):
* battery.el (display-battery-mode):
* composite.el (global-auto-composition-mode)
(auto-composition-mode):
* delsel.el (delete-selection-mode):
* desktop.el (desktop-save-mode):
* dired-x.el (dired-omit-mode):
* dirtrack.el (dirtrack-mode):
* doc-view.el (doc-view-minor-mode):
* double.el (double-mode):
* electric.el (electric-indent-mode, electric-pair-mode):
* emacs-lock.el (emacs-lock-mode):
* epa-hook.el (auto-encryption-mode):
* follow.el (follow-mode):
* font-core.el (font-lock-mode):
* frame.el (auto-raise-mode, auto-lower-mode, blink-cursor-mode):
* help.el (temp-buffer-resize-mode):
* hilit-chg.el (highlight-changes-mode)
(highlight-changes-visible-mode):
* hi-lock.el (hi-lock-mode):
* hl-line.el (hl-line-mode, global-hl-line-mode):
* icomplete.el (icomplete-mode):
* ido.el (ido-everywhere):
* image-file.el (auto-image-file-mode):
* image-mode.el (image-minor-mode):
* iswitchb.el (iswitchb-mode):
* jka-cmpr-hook.el (auto-compression-mode):
* linum.el (linum-mode):
* longlines.el (longlines-mode):
* master.el (master-mode):
* mb-depth.el (minibuffer-depth-indicate-mode):
* menu-bar.el (menu-bar-mode):
* minibuf-eldef.el (minibuffer-electric-default-mode):
* mouse-sel.el (mouse-sel-mode):
* msb.el (msb-mode):
* mwheel.el (mouse-wheel-mode):
* outline.el (outline-minor-mode):
* paren.el (show-paren-mode):
* recentf.el (recentf-mode):
* reveal.el (reveal-mode, global-reveal-mode):
* rfn-eshadow.el (file-name-shadow-mode):
* ruler-mode.el (ruler-mode):
* savehist.el (savehist-mode):
* scroll-all.el (scroll-all-mode):
* scroll-bar.el (scroll-bar-mode):
* server.el (server-mode):
* shell.el (shell-dirtrack-mode):
* simple.el (auto-fill-mode, transient-mark-mode)
(visual-line-mode, overwrite-mode, binary-overwrite-mode)
(line-number-mode, column-number-mode, size-indication-mode)
(auto-save-mode, normal-erase-is-backspace-mode, visible-mode):
* strokes.el (strokes-mode):
* time.el (display-time-mode):
* t-mouse.el (gpm-mouse-mode):
* tool-bar.el (tool-bar-mode):
* tooltip.el (tooltip-mode):
* type-break.el (type-break-mode-line-message-mode)
(type-break-query-mode):
* view.el (view-mode):
* whitespace.el (whitespace-mode, whitespace-newline-mode)
(global-whitespace-mode, global-whitespace-newline-mode):
* xt-mouse.el (xterm-mouse-mode): Doc fix.
* emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Fix
autogenerated docstring.
2011-10-19 12:54:24 +00:00
|
|
|
|
"Toggle saving of minibuffer history (Savehist mode).
|
|
|
|
|
|
|
|
|
|
When Savehist mode is enabled, minibuffer history is saved
|
2018-10-01 07:45:33 +00:00
|
|
|
|
to `savehist-file' periodically and when exiting Emacs. When
|
|
|
|
|
Savehist mode is enabled for the first time in an Emacs session,
|
|
|
|
|
it loads the previous minibuffer histories from `savehist-file'.
|
|
|
|
|
The variable `savehist-autosave-interval' controls the
|
|
|
|
|
periodicity of saving minibuffer histories.
|
|
|
|
|
|
|
|
|
|
If `savehist-save-minibuffer-history' is non-nil (the default),
|
|
|
|
|
all recorded minibuffer histories will be saved. You can arrange
|
|
|
|
|
for additional history variables to be saved and restored by
|
|
|
|
|
customizing `savehist-additional-variables', which by default is
|
|
|
|
|
an empty list. For example, to save the history of commands
|
|
|
|
|
invoked via \\[execute-extended-command], add `command-history' to the list in
|
|
|
|
|
`savehist-additional-variables'.
|
|
|
|
|
|
|
|
|
|
Alternatively, you could customize `savehist-save-minibuffer-history'
|
|
|
|
|
to nil, and add to `savehist-additional-variables' only those
|
|
|
|
|
history variables you want to save.
|
|
|
|
|
|
|
|
|
|
To ignore some history variables, add their symbols to the list
|
|
|
|
|
in `savehist-ignored-variables'.
|
2005-11-01 05:49:46 +00:00
|
|
|
|
|
|
|
|
|
This mode should normally be turned on from your Emacs init file.
|
Fix minor mode docstrings for the new meaning of a nil ARG.
* abbrev.el (abbrev-mode):
* allout.el (allout-mode):
* autoinsert.el (auto-insert-mode):
* autoarg.el (autoarg-mode, autoarg-kp-mode):
* autorevert.el (auto-revert-mode, auto-revert-tail-mode)
(global-auto-revert-mode):
* battery.el (display-battery-mode):
* composite.el (global-auto-composition-mode)
(auto-composition-mode):
* delsel.el (delete-selection-mode):
* desktop.el (desktop-save-mode):
* dired-x.el (dired-omit-mode):
* dirtrack.el (dirtrack-mode):
* doc-view.el (doc-view-minor-mode):
* double.el (double-mode):
* electric.el (electric-indent-mode, electric-pair-mode):
* emacs-lock.el (emacs-lock-mode):
* epa-hook.el (auto-encryption-mode):
* follow.el (follow-mode):
* font-core.el (font-lock-mode):
* frame.el (auto-raise-mode, auto-lower-mode, blink-cursor-mode):
* help.el (temp-buffer-resize-mode):
* hilit-chg.el (highlight-changes-mode)
(highlight-changes-visible-mode):
* hi-lock.el (hi-lock-mode):
* hl-line.el (hl-line-mode, global-hl-line-mode):
* icomplete.el (icomplete-mode):
* ido.el (ido-everywhere):
* image-file.el (auto-image-file-mode):
* image-mode.el (image-minor-mode):
* iswitchb.el (iswitchb-mode):
* jka-cmpr-hook.el (auto-compression-mode):
* linum.el (linum-mode):
* longlines.el (longlines-mode):
* master.el (master-mode):
* mb-depth.el (minibuffer-depth-indicate-mode):
* menu-bar.el (menu-bar-mode):
* minibuf-eldef.el (minibuffer-electric-default-mode):
* mouse-sel.el (mouse-sel-mode):
* msb.el (msb-mode):
* mwheel.el (mouse-wheel-mode):
* outline.el (outline-minor-mode):
* paren.el (show-paren-mode):
* recentf.el (recentf-mode):
* reveal.el (reveal-mode, global-reveal-mode):
* rfn-eshadow.el (file-name-shadow-mode):
* ruler-mode.el (ruler-mode):
* savehist.el (savehist-mode):
* scroll-all.el (scroll-all-mode):
* scroll-bar.el (scroll-bar-mode):
* server.el (server-mode):
* shell.el (shell-dirtrack-mode):
* simple.el (auto-fill-mode, transient-mark-mode)
(visual-line-mode, overwrite-mode, binary-overwrite-mode)
(line-number-mode, column-number-mode, size-indication-mode)
(auto-save-mode, normal-erase-is-backspace-mode, visible-mode):
* strokes.el (strokes-mode):
* time.el (display-time-mode):
* t-mouse.el (gpm-mouse-mode):
* tool-bar.el (tool-bar-mode):
* tooltip.el (tooltip-mode):
* type-break.el (type-break-mode-line-message-mode)
(type-break-query-mode):
* view.el (view-mode):
* whitespace.el (whitespace-mode, whitespace-newline-mode)
(global-whitespace-mode, global-whitespace-newline-mode):
* xt-mouse.el (xterm-mouse-mode): Doc fix.
* emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Fix
autogenerated docstring.
2011-10-19 12:54:24 +00:00
|
|
|
|
Calling it at any other time replaces your current minibuffer
|
|
|
|
|
histories, which is probably undesirable."
|
2010-05-03 02:29:46 +00:00
|
|
|
|
:global t
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(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.
|
2009-10-02 03:48:36 +00:00
|
|
|
|
(load savehist-file nil (not (called-interactively-p 'interactive)))
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(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)))))
|
2010-05-03 02:29:46 +00:00
|
|
|
|
(savehist-install)))
|
2005-11-01 05:49:46 +00:00
|
|
|
|
|
2005-10-24 17:21:30 +00:00
|
|
|
|
(defun savehist-install ()
|
2014-02-21 00:47:17 +00:00
|
|
|
|
"Hook Savehist into Emacs.
|
2005-11-01 05:49:46 +00:00
|
|
|
|
Normally invoked by calling `savehist-mode' to set the minor mode.
|
2006-02-02 12:02:14 +00:00
|
|
|
|
Installs `savehist-autosave' in `kill-emacs-hook' and on a timer.
|
|
|
|
|
To undo this, call `savehist-uninstall'."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
(add-hook 'minibuffer-setup-hook #'savehist-minibuffer-hook)
|
|
|
|
|
(add-hook 'kill-emacs-hook #'savehist-autosave)
|
2005-10-24 17:21:30 +00:00
|
|
|
|
;; 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.
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(when (and savehist-autosave-interval
|
|
|
|
|
(null savehist-timer))
|
2005-10-24 17:21:30 +00:00
|
|
|
|
(setq savehist-timer
|
2019-06-22 09:36:43 +00:00
|
|
|
|
(run-with-timer savehist-autosave-interval
|
|
|
|
|
savehist-autosave-interval #'savehist-autosave))))
|
2005-10-24 17:21:30 +00:00
|
|
|
|
|
|
|
|
|
(defun savehist-uninstall ()
|
2005-11-01 05:49:46 +00:00
|
|
|
|
"Undo installing savehist.
|
|
|
|
|
Normally invoked by calling `savehist-mode' to unset the minor mode."
|
2019-05-14 18:00:58 +00:00
|
|
|
|
(remove-hook 'minibuffer-setup-hook #'savehist-minibuffer-hook)
|
|
|
|
|
(remove-hook 'kill-emacs-hook #'savehist-autosave)
|
2005-10-24 17:21:30 +00:00
|
|
|
|
(when savehist-timer
|
2019-06-22 09:36:43 +00:00
|
|
|
|
(cancel-timer savehist-timer)
|
2005-10-24 17:21:30 +00:00
|
|
|
|
(setq savehist-timer nil)))
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(defun savehist-save (&optional auto-save)
|
2005-10-24 17:21:30 +00:00
|
|
|
|
"Save the values of minibuffer history variables.
|
|
|
|
|
Unbound symbols referenced in `savehist-additional-variables' are ignored.
|
2005-10-16 15:02:39 +00:00
|
|
|
|
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."
|
2005-10-16 02:10:39 +00:00
|
|
|
|
(interactive)
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(with-temp-buffer
|
|
|
|
|
(insert
|
Top-level elisp files respect ‘text-quoting-style’
In top-level elisp files, use format-message in diagnostic formats,
so that they follow user preference as per ‘text-quoting-style’
rather than being hard-coded to quote `like this'.
* lisp/allout.el (allout-get-configvar-values):
* lisp/apropos.el (apropos-symbols-internal):
* lisp/dired-aux.el (dired-do-shell-command, dired-create-files)
(dired-do-create-files-regexp, dired-create-files-non-directory):
* lisp/dired-x.el (dired-do-run-mail):
* lisp/dired.el (dired-log, dired-dnd-handle-local-file):
* lisp/disp-table.el (standard-display-european):
* lisp/find-dired.el (find-dired):
* lisp/forms.el (forms-mode):
* lisp/ido.el (ido-buffer-internal):
* lisp/info.el (Info-index-next):
* lisp/outline.el (outline-invent-heading):
* lisp/printing.el (pr-ps-outfile-preprint, pr-i-ps-send):
* lisp/proced.el (proced-log):
* lisp/ps-print.el (ps-print-preprint, ps-get-size):
* lisp/recentf.el (recentf-open-files, recentf-save-list):
* lisp/savehist.el (savehist-save):
* lisp/server.el (server-ensure-safe-dir):
* lisp/ses.el (ses-rename-cell):
* lisp/simple.el (list-processes--refresh):
* lisp/startup.el (command-line):
* lisp/strokes.el (strokes-unset-last-stroke)
(strokes-execute-stroke):
Use format-message so that quotes are restyled.
* lisp/cus-edit.el (custom-raised-buttons, customize-browse):
Don’t quote ‘raised’.
* lisp/descr-text.el (describe-char):
* lisp/dirtrack.el (dirtrack-debug-message):
* lisp/hexl.el (hexl-insert-multibyte-char):
Apply substitute-command-keys to help string.
* lisp/wdired.el (wdired-do-renames, wdired-do-symlink-changes)
(wdired-do-perm-changes):
Let dired-log do the formatting.
2015-08-26 08:30:29 +00:00
|
|
|
|
(format-message
|
|
|
|
|
(concat
|
|
|
|
|
";; -*- mode: emacs-lisp; coding: %s -*-\n"
|
|
|
|
|
";; Minibuffer history file, automatically generated by `savehist'.\n"
|
|
|
|
|
"\n")
|
|
|
|
|
savehist-coding-system))
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(run-hooks 'savehist-save-hook)
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(let ((print-length nil)
|
|
|
|
|
(print-level nil)
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(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)
|
2007-10-30 08:24:30 +00:00
|
|
|
|
(when (and (boundp symbol)
|
|
|
|
|
(not (memq symbol savehist-ignored-variables)))
|
2019-06-22 09:36:43 +00:00
|
|
|
|
(let ((value (symbol-value symbol))
|
2007-10-24 08:15:03 +00:00
|
|
|
|
excess-space)
|
|
|
|
|
(when value ; Don't save empty histories.
|
|
|
|
|
(insert "(setq ")
|
|
|
|
|
(prin1 symbol (current-buffer))
|
|
|
|
|
(insert " '(")
|
|
|
|
|
;; We will print an extra space before the first element.
|
|
|
|
|
;; Record where that is.
|
|
|
|
|
(setq excess-space (point))
|
|
|
|
|
;; Print elements of VALUE one by one, carefully.
|
|
|
|
|
(dolist (elt value)
|
|
|
|
|
(let ((start (point)))
|
|
|
|
|
(insert " ")
|
2008-09-20 19:48:38 +00:00
|
|
|
|
;; Try to print and then to read an element.
|
2007-10-24 08:15:03 +00:00
|
|
|
|
(condition-case nil
|
2008-09-20 19:47:07 +00:00
|
|
|
|
(progn
|
|
|
|
|
(prin1 elt (current-buffer))
|
|
|
|
|
(save-excursion
|
|
|
|
|
(goto-char start)
|
|
|
|
|
(read (current-buffer))))
|
2007-10-24 08:15:03 +00:00
|
|
|
|
(error
|
2008-09-20 19:48:38 +00:00
|
|
|
|
;; If writing or reading gave an error, comment it out.
|
2007-10-24 08:15:03 +00:00
|
|
|
|
(goto-char start)
|
|
|
|
|
(insert "\n")
|
|
|
|
|
(while (not (eobp))
|
|
|
|
|
(insert ";;; ")
|
|
|
|
|
(forward-line 1))
|
|
|
|
|
(insert "\n")))
|
|
|
|
|
(goto-char (point-max))))
|
|
|
|
|
;; Delete the extra space before the first element.
|
|
|
|
|
(save-excursion
|
|
|
|
|
(goto-char excess-space)
|
|
|
|
|
(if (eq (following-char) ?\s)
|
|
|
|
|
(delete-region (point) (1+ (point)))))
|
|
|
|
|
(insert "))\n"))))))
|
2005-11-01 05:49:46 +00:00
|
|
|
|
;; 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))))))
|
2005-10-16 15:02:39 +00:00
|
|
|
|
;; If autosaving, avoid writing if nothing has changed since the
|
|
|
|
|
;; last write.
|
2019-05-14 18:00:58 +00:00
|
|
|
|
(let ((checksum (md5 (current-buffer) nil nil savehist-coding-system)))
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(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
|
2005-10-24 17:21:30 +00:00
|
|
|
|
;; 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.
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(let ((file-precious-flag t)
|
2019-07-13 15:13:12 +00:00
|
|
|
|
(coding-system-for-write savehist-coding-system)
|
|
|
|
|
(dir (file-name-directory savehist-file)))
|
|
|
|
|
;; Ensure that the directory exists before saving.
|
|
|
|
|
(unless (file-exists-p dir)
|
|
|
|
|
(make-directory dir t))
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(write-region (point-min) (point-max) savehist-file nil
|
2009-10-02 03:48:36 +00:00
|
|
|
|
(unless (called-interactively-p 'interactive) 'quiet)))
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(when savehist-file-modes
|
|
|
|
|
(set-file-modes savehist-file savehist-file-modes))
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(setq savehist-last-checksum checksum)))))
|
|
|
|
|
|
|
|
|
|
(defun savehist-autosave ()
|
2005-11-01 05:49:46 +00:00
|
|
|
|
"Save the minibuffer history if it has been modified since the last save.
|
2014-02-21 00:47:17 +00:00
|
|
|
|
Does nothing if Savehist mode is off."
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(when savehist-mode
|
|
|
|
|
(savehist-save t)))
|
|
|
|
|
|
2019-06-22 09:36:43 +00:00
|
|
|
|
(define-obsolete-function-alias 'savehist-trim-history #'identity "27.1")
|
2005-10-16 15:02:39 +00:00
|
|
|
|
|
|
|
|
|
(defun savehist-printable (value)
|
2005-10-16 15:22:37 +00:00
|
|
|
|
"Return non-nil if VALUE is printable."
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(cond
|
2005-11-01 05:49:46 +00:00
|
|
|
|
;; Quick response for oft-encountered types known to be printable.
|
2005-10-16 15:02:39 +00:00
|
|
|
|
((numberp value))
|
|
|
|
|
((symbolp value))
|
2012-03-09 18:09:46 +00:00
|
|
|
|
;; String without properties
|
|
|
|
|
((and (stringp value)
|
|
|
|
|
(equal-including-properties value (substring-no-properties value))))
|
2005-10-16 15:02:39 +00:00
|
|
|
|
(t
|
|
|
|
|
;; For others, check explicitly.
|
2005-11-01 05:49:46 +00:00
|
|
|
|
(with-temp-buffer
|
|
|
|
|
(condition-case nil
|
2019-06-22 09:36:43 +00:00
|
|
|
|
(let ((print-level nil))
|
|
|
|
|
;; Print the value into a buffer...
|
|
|
|
|
(prin1 value (current-buffer))
|
|
|
|
|
;; ...and attempt to read it.
|
|
|
|
|
(read (point-min-marker))
|
|
|
|
|
;; The attempt worked: the object is printable.
|
|
|
|
|
t)
|
2005-11-01 05:49:46 +00:00
|
|
|
|
;; The attempt failed: the object is not printable.
|
|
|
|
|
(error nil))))))
|
2005-10-16 02:10:39 +00:00
|
|
|
|
|
2005-10-24 17:21:30 +00:00
|
|
|
|
(defun savehist-minibuffer-hook ()
|
2019-06-21 16:51:14 +00:00
|
|
|
|
(unless (or (eq minibuffer-history-variable t)
|
2019-06-22 09:36:43 +00:00
|
|
|
|
;; If `read-string' is called with a t HISTORY argument
|
|
|
|
|
;; (which `read-password' does),
|
|
|
|
|
;; `minibuffer-history-variable' is bound to t to mean
|
|
|
|
|
;; "no history is being recorded".
|
2019-06-21 16:51:14 +00:00
|
|
|
|
(memq minibuffer-history-variable savehist-ignored-variables))
|
2005-11-14 22:30:35 +00:00
|
|
|
|
(add-to-list 'savehist-minibuffer-history-variables
|
|
|
|
|
minibuffer-history-variable)))
|
2005-10-24 17:21:30 +00:00
|
|
|
|
|
2005-10-16 02:10:39 +00:00
|
|
|
|
(provide 'savehist)
|
2005-11-01 05:49:46 +00:00
|
|
|
|
|
|
|
|
|
|
2005-10-16 02:10:39 +00:00
|
|
|
|
;;; savehist.el ends here
|