lisp/chistory.el

   1 ;;; chistory.el --- list command history
   2
   3 ;; Copyright (C) 1985, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
   4
   5 ;; Author: K. Shane Hartman
   6 ;; Maintainer: FSF
   7 ;; Keywords: convenience
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 2, or (at your option)
  14 ;; any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26 ;;; Commentary:
  27
  28 ;; This really has nothing to do with list-command-history per se, but
  29 ;; its a nice alternative to C-x ESC ESC (repeat-complex-command) and
  30 ;; functions as a lister if given no pattern.  It's not important
  31 ;; enough to warrant a file of its own.
  32
  33 ;;; Code:
  34
  35 (defgroup chistory nil
  36   "List command history."
  37   :group 'keyboard)
  38
  39 ;;;###autoload
  40 (defun repeat-matching-complex-command (&optional pattern)
  41   "Edit and re-evaluate complex command with name matching PATTERN.
  42 Matching occurrences are displayed, most recent first, until you select
  43 a form for evaluation.  If PATTERN is empty (or nil), every form in the
  44 command history is offered.  The form is placed in the minibuffer for
  45 editing and the result is evaluated."
  46   (interactive "sRedo Command (regexp): ")
  47   (if pattern
  48       (if (string-match "[^ \t]" pattern)
  49           (setq pattern (substring pattern (match-beginning 0)))
  50         (setq pattern nil)))
  51   (let ((history command-history)
  52         (temp)
  53         (what))
  54     (while (and history (not what))
  55       (setq temp (car history))
  56       (if (and (or (not pattern) (string-match pattern (symbol-name (car temp))))
  57                (y-or-n-p (format "Redo %S? " temp)))
  58           (setq what (car history))
  59         (setq history (cdr history))))
  60     (if (not what)
  61         (error "Command history exhausted")
  62       ;; Try to remove any useless command history element for this command.
  63       (if (eq (car (car command-history)) 'repeat-matching-complex-command)
  64           (setq command-history (cdr command-history)))
  65       (edit-and-eval-command "Redo: " what))))
  66
  67 (defcustom default-command-history-filter-garbage
  68   '(command-history-mode
  69     list-command-history
  70     electric-command-history)
  71   "*A list of symbols to be ignored by `default-command-history-filter'.
  72 If that function is given a list whose car is an element of this list,
  73 then it will return non-nil (indicating the list should be discarded from
  74 the history).
  75 Initially, all commands related to the command history are discarded."
  76   :type '(repeat symbol)
  77   :group 'chistory)
  78
  79 (defvar list-command-history-filter 'default-command-history-filter
  80   "Predicate to test which commands should be excluded from the history listing.
  81 If non-nil, should be the name of a function of one argument.
  82 It is passed each element of the command history when
  83 \\[list-command-history] is called.  If the filter returns non-nil for
  84 some element, that element is excluded from the history listing.  The
  85 default filter removes commands associated with the command-history.")
  86
  87 (defun default-command-history-filter (frob)
  88   "Filter commands matching `default-command-history-filter-garbage' list
  89 from the command history."
  90   (or (not (consp frob))
  91       (memq (car frob) default-command-history-filter-garbage)))
  92
  93 (defcustom list-command-history-max 32
  94   "*If non-nil, maximum length of the listing produced by `list-command-history'."
  95   :type '(choice integer (const nil))
  96   :group 'chistory)
  97
  98 ;;;###autoload
  99 (defun list-command-history ()
 100   "List history of commands typed to minibuffer.
 101 The number of commands listed is controlled by `list-command-history-max'.
 102 Calls value of `list-command-history-filter' (if non-nil) on each history
 103 element to judge if that element should be excluded from the list.
 104
 105 The buffer is left in Command History mode."
 106   (interactive)
 107   (with-output-to-temp-buffer
 108       "*Command History*"
 109     (let ((history command-history)
 110           (buffer-read-only nil)
 111           (count (or list-command-history-max -1)))
 112       (while (and (/= count 0) history)
 113         (if (and (boundp 'list-command-history-filter)
 114                  list-command-history-filter
 115                  (funcall list-command-history-filter (car history)))
 116             nil
 117           (setq count (1- count))
 118           (prin1 (car history))
 119           (terpri))
 120         (setq history (cdr history))))
 121     (save-excursion
 122       (set-buffer "*Command History*")
 123       (goto-char (point-min))
 124       (if (eobp)
 125           (error "No command history")
 126         (command-history-mode)))))
 127
 128 (defvar command-history-map nil)
 129 (unless command-history-map
 130   (setq command-history-map (make-sparse-keymap))
 131   (set-keymap-parent command-history-map lisp-mode-shared-map)
 132   (suppress-keymap command-history-map)
 133   (define-key command-history-map "x" 'command-history-repeat)
 134   (define-key command-history-map "\n" 'next-line)
 135   (define-key command-history-map "\r" 'next-line)
 136   (define-key command-history-map "\177" 'previous-line))
 137
 138 (defun command-history-mode ()
 139   "Major mode for listing and repeating recent commands.
 140
 141 Keybindings:
 142 \\{command-history-map}"
 143   (interactive)
 144   (Command-history-setup)
 145   (setq major-mode 'command-history-mode)
 146   (setq mode-name "Command History")
 147   (use-local-map command-history-map)
 148   (run-mode-hooks 'command-history-mode-hook))
 149
 150 (defun Command-history-setup ()
 151   (kill-all-local-variables)
 152   (use-local-map command-history-map)
 153   (lisp-mode-variables nil)
 154   (set-syntax-table emacs-lisp-mode-syntax-table)
 155   (setq buffer-read-only t))
 156
 157 (defcustom command-history-hook nil
 158   "If non-nil, its value is called on entry to `command-history-mode'."
 159   :type 'hook
 160   :group 'chistory)
 161
 162 (defun command-history-repeat ()
 163   "Repeat the command shown on the current line.
 164 The buffer for that command is the previous current buffer."
 165   (interactive)
 166   (save-excursion
 167     (eval (prog1
 168               (save-excursion
 169                 (beginning-of-line)
 170                 (read (current-buffer)))
 171             (set-buffer
 172              (car (cdr (buffer-list))))))))
 173
 174 ;;;###autoload
 175 (defun command-history ()
 176   "Examine commands from `command-history' in a buffer.
 177 The number of commands listed is controlled by `list-command-history-max'.
 178 The command history is filtered by `list-command-history-filter' if non-nil.
 179 Use \\<command-history-map>\\[command-history-repeat] to repeat the command on the current line.
 180
 181 Otherwise much like Emacs-Lisp Mode except that there is no self-insertion
 182 and digits provide prefix arguments.  Tab does not indent.
 183 \\{command-history-map}
 184
 185 This command always recompiles the Command History listing
 186 and runs the normal hook `command-history-hook'."
 187   (interactive)
 188   (list-command-history)
 189   (pop-to-buffer "*Command History*")
 190   (run-hooks 'command-history-hook))
 191
 192 (provide 'chistory)
 193
 194 ;;; arch-tag: c201a0cd-89f2-4d39-a532-4cb309391dbd
 195 ;;; chistory.el ends here