Follow coding conventions.
[bpt/emacs.git] / lisp / chistory.el
index db04bea..56fef37 100644 (file)
@@ -4,6 +4,7 @@
 
 ;; Author: K. Shane Hartman
 ;; Maintainer: FSF
+;; Keywords: convenience
 
 ;; This file is part of GNU Emacs.
 
@@ -18,8 +19,9 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
 
 
 ;;; Code:
 
+(defgroup chistory nil
+  "List command history."
+  :group 'keyboard)
+
 ;;;###autoload
 (defun repeat-matching-complex-command (&optional pattern)
   "Edit and re-evaluate complex command with name matching PATTERN.
@@ -58,15 +64,17 @@ editing and the result is evaluated."
          (setq command-history (cdr command-history)))
       (edit-and-eval-command "Redo: " what))))
 
-(defvar default-command-history-filter-garbage
+(defcustom default-command-history-filter-garbage
   '(command-history-mode
     list-command-history
     electric-command-history)
   "*A list of symbols to be ignored by `default-command-history-filter'.
-It that function is given a list whose car is an element of this list,
+If that function is given a list whose car is an element of this list,
 then it will return non-nil (indicating the list should be discarded from
 the history).
-Initially, all commands related to the command history are discarded.")
+Initially, all commands related to the command history are discarded."
+  :type '(repeat symbol)
+  :group 'chistory)
 
 (defvar list-command-history-filter 'default-command-history-filter
   "Predicate to test which commands should be excluded from the history listing.
@@ -82,8 +90,10 @@ from the command history."
   (or (not (consp frob))
       (memq (car frob) default-command-history-filter-garbage)))
 
-(defvar list-command-history-max 32
-  "*If non-nil, maximum length of the listing produced by `list-command-history'.")
+(defcustom list-command-history-max 32
+  "*If non-nil, maximum length of the listing produced by `list-command-history'."
+  :type '(choice integer (const nil))
+  :group 'chistory)
 
 ;;;###autoload
 (defun list-command-history ()
@@ -113,26 +123,32 @@ The buffer is left in Command History mode."
       (goto-char (point-min))
       (if (eobp)
          (error "No command history")
-       (Command-history-setup)))))
+       (command-history-mode)))))
 
-(defun Command-history-setup (&optional majormode modename keymap)
-  (set-buffer "*Command History*")
-  (use-local-map (or keymap command-history-map))
+(defun command-history-mode ()
+  "Major mode for listing and repeating recent commands."
+  (Command-history-setup)
+  (setq major-mode 'command-history-mode)
+  (setq mode-name "Command History")
+  (use-local-map command-history-map)
+  (run-hooks 'command-history-mode-hook))
+
+(defun Command-history-setup ()
+  (kill-all-local-variables)
+  (use-local-map command-history-map)
   (lisp-mode-variables nil)
   (set-syntax-table emacs-lisp-mode-syntax-table)
-  (setq buffer-read-only t)
-  (use-local-map (or keymap command-history-map))
-  (setq major-mode (or majormode 'command-history-mode))
-  (setq mode-name (or modename "Command History")))
+  (setq buffer-read-only t))
 
-(defvar command-history-hook nil
-  "If non-nil, its value is called on entry to `command-history-mode'.")
+(defcustom command-history-hook nil
+  "If non-nil, its value is called on entry to `command-history-mode'."
+  :type 'hook
+  :group 'chistory)
 
 (defvar command-history-map nil)
-(if command-history-map
-    nil
-  (setq command-history-map
-       (nconc (make-sparse-keymap) shared-lisp-mode-map))
+(unless command-history-map
+  (setq command-history-map (make-sparse-keymap))
+  (set-keymap-parent command-history-map lisp-mode-shared-map)
   (suppress-keymap command-history-map)
   (define-key command-history-map "x" 'command-history-repeat)
   (define-key command-history-map "\n" 'next-line)
@@ -152,8 +168,8 @@ The buffer for that command is the previous current buffer."
             (car (cdr (buffer-list))))))))
 
 ;;;###autoload
-(defun command-history-mode ()
-  "Major mode for examining commands from `command-history'.
+(defun command-history ()
+  "Examine commands from `command-history' in a buffer.
 The number of commands listed is controlled by `list-command-history-max'.
 The command history is filtered by `list-command-history-filter' if non-nil.
 Use \\<command-history-map>\\[command-history-repeat] to repeat the command on the current line.
@@ -161,8 +177,9 @@ Use \\<command-history-map>\\[command-history-repeat] to repeat the command on t
 Otherwise much like Emacs-Lisp Mode except that there is no self-insertion
 and digits provide prefix arguments.  Tab does not indent.
 \\{command-history-map}
-Calls the value of `command-history-hook' if that is non-nil.
-The Command History listing is recomputed each time this mode is invoked."
+
+This command always recompiles the Command History listing
+and runs the normal hook `command-history-hook'."
   (interactive)
   (list-command-history)
   (pop-to-buffer "*Command History*")