lisp/echistory.el

   1 ;;; echistory.el --- Electric Command History Mode
   2
   3 ;; Copyright (C) 1985, 2001, 2002, 2003, 2004, 2005,
   4 ;;   2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
   5
   6 ;; Author: K. Shane Hartman
   7 ;; Maintainer: FSF
   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 3 of the License, or
  14 ;; (at your option) 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.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (require 'electric)                     ; command loop
  29 (require 'chistory)                     ; history lister
  30
  31 ;;;###autoload
  32 (defun Electric-command-history-redo-expression (&optional noconfirm)
  33   "Edit current history line in minibuffer and execute result.
  34 With prefix arg NOCONFIRM, execute current line as-is without editing."
  35   (interactive "P")
  36   (let (todo)
  37     (with-current-buffer "*Command History*"
  38       (beginning-of-line)
  39       (setq todo (read (current-buffer)))
  40       (if (boundp 'electric-history-in-progress)
  41           (if todo (throw 'electric-history-quit (list noconfirm todo)))))))
  42
  43 (defvar electric-history-map
  44   (let ((map (make-sparse-keymap)))
  45     (define-key map [t] 'Electric-history-undefined)
  46     (define-key map "\e" (make-sparse-keymap))
  47     (define-key map [?\e t] 'Electric-history-undefined)
  48     (define-key map "\C-u" 'universal-argument)
  49     (define-key map " " 'Electric-command-history-redo-expression)
  50     (define-key map "!" 'Electric-command-history-redo-expression)
  51     (define-key map "\e\C-x" 'eval-sexp)
  52     (define-key map "\e\C-d" 'down-list)
  53     (define-key map "\e\C-u" 'backward-up-list)
  54     (define-key map "\e\C-b" 'backward-sexp)
  55     (define-key map "\e\C-f" 'forward-sexp)
  56     (define-key map "\e\C-a" 'beginning-of-defun)
  57     (define-key map "\e\C-e" 'end-of-defun)
  58     (define-key map "\e\C-n" 'forward-list)
  59     (define-key map "\e\C-p" 'backward-list)
  60     (define-key map "q" 'Electric-history-quit)
  61     (define-key map "\C-c" nil)
  62     (define-key map "\C-c\C-c" 'Electric-history-quit)
  63     (define-key map "\C-]" 'Electric-history-quit)
  64     (define-key map "\C-z" 'suspend-frame)
  65     (define-key map (char-to-string help-char) 'Helper-help)
  66     (define-key map "?" 'Helper-describe-bindings)
  67     (define-key map "\e>" 'end-of-buffer)
  68     (define-key map "\e<" 'beginning-of-buffer)
  69     (define-key map "\n" 'next-line)
  70     (define-key map "\r" 'next-line)
  71     (define-key map "\177" 'previous-line)
  72     (define-key map "\C-n" 'next-line)
  73     (define-key map "\C-p" 'previous-line)
  74     (define-key map "\ev" 'scroll-down)
  75     (define-key map "\C-v" 'scroll-up)
  76     (define-key map [home] 'beginning-of-buffer)
  77     (define-key map [down] 'next-line)
  78     (define-key map [up] 'previous-line)
  79     (define-key map [prior] 'scroll-down)
  80     (define-key map [next] 'scroll-up)
  81     (define-key map "\C-l" 'recenter)
  82     (define-key map "\e\C-v" 'scroll-other-window)
  83     map)
  84   "Keymap for Electric Command History mode.")
  85
  86 (defvar electric-command-history-hook nil
  87   "If non-nil, its value is called by `electric-command-history'.")
  88
  89 (defun electric-command-history ()
  90   "\\<electric-history-map>Major mode for examining and redoing commands from `command-history'.
  91 This pops up a window with the Command History listing.
  92 The number of command listed is controlled by `list-command-history-max'.
  93 The command history is filtered by `list-command-history-filter' if non-nil.
  94 Combines typeout Command History list window with menu like selection
  95 of an expression from the history for re-evaluation in the *original* buffer.
  96
  97 The history displayed is filtered by `list-command-history-filter' if non-nil.
  98
  99 Like Emacs-Lisp mode except that characters do not insert themselves and
 100 Tab and Linefeed do not indent.  Instead these commands are provided:
 101 \\{electric-history-map}
 102
 103 Calls the value of `electric-command-history-hook' if that is non-nil.
 104 The Command History listing is recomputed each time this mode is invoked."
 105   (interactive)
 106   (let ((electric-history-in-progress t)
 107         (old-buffer (current-buffer))
 108         (todo))
 109     (unwind-protect
 110         (setq todo
 111               (catch 'electric-history-quit
 112                 (save-window-excursion
 113                   (save-window-excursion
 114                     (list-command-history)
 115                     (set-buffer "*Command History*")
 116                     (Command-history-setup)
 117                     (setq major-mode 'electric-command-history)
 118                     (setq mode-name "Electric History")
 119                     (use-local-map electric-history-map))
 120                   (Electric-pop-up-window "*Command History*")
 121                   (run-hooks 'electric-command-history-hook)
 122                   (if (eobp)
 123                       (progn (ding)
 124                              (message "No command history.")
 125                              (throw 'electric-history-quit nil))
 126                     (let ((Helper-return-blurb "return to History"))
 127                       (Electric-command-loop 'electric-history-quit
 128                                              "->" t))))))
 129       (set-buffer "*Command History*")
 130       (command-history-mode)
 131       (bury-buffer (current-buffer)))
 132     (if (consp todo)
 133         (progn (set-buffer old-buffer)
 134                (if (car todo)
 135                    (apply (car (car (cdr todo))) (cdr (car (cdr todo))))
 136                  (edit-and-eval-command "Redo: " (car (cdr todo))))))))
 137
 138 (defun Electric-history-undefined ()
 139   (interactive)
 140   (ding)
 141   (message "%s" (substitute-command-keys "Type \\[Helper-help] for help, ? for commands, C-c C-c to quit, Space to execute"))
 142   (sit-for 4))
 143
 144 (defun Electric-history-quit ()
 145   "Quit Electric Command History, restoring previous window configuration."
 146   (interactive)
 147   (if (boundp 'electric-history-in-progress)
 148       (progn (message "")
 149              (throw 'electric-history-quit nil))))
 150
 151 (provide 'echistory)
 152
 153 ;;; echistory.el ends here