;;; finder.el --- topic & keyword-based code finder
-;; Copyright (C) 1992, 1997, 1998, 1999, 2001 Free Software Foundation, Inc.
+;; Copyright (C) 1992,97,98,1999,2001,2004 Free Software Foundation, Inc.
;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
;; Created: 16 Jun 1992
;;; Code:
(require 'lisp-mnt)
-(require 'finder-inf)
+(require 'find-func) ;for find-library(-suffixes)
+;; Use `load' rather than `require' so that it doesn't get loaded
+;; during byte-compilation (at which point it might be missing).
+(load "finder-inf" t t)
+
+(defvar finder-mode-hook nil
+ "*Hook run when function `finder-mode' is called.")
;; Local variable in finder buffer.
(defvar finder-headmark)
(calendar . "calendar and time management support")
(comm . "communications, networking, remote access to files")
(convenience . "convenience features for faster editing")
- (data . "support editing files of data")
+ (data . "support for editing files of data")
(docs . "support for Emacs documentation")
(emulations . "emulations of other editors")
(extensions . "Emacs Lisp language extensions")
(outlines . "support for hierarchical outlining")
(processes . "process, subshell, compilation, and job control support")
(terminals . "support for terminal types")
- (tex . "code related to the TeX formatter")
+ (tex . "supporting code for the TeX formatter")
(tools . "programming tools")
- (unix . "front-ends/assistants for, or emulators of, UNIX features")
+ (unix . "front-ends/assistants for, or emulators of, UNIX-like features")
;; Not a custom group and not currently useful.
;; (vms . "support code for vms")
(wp . "word processing")
))
-(defvar finder-mode-map nil)
-(or finder-mode-map
- (let ((map (make-sparse-keymap)))
- (define-key map " " 'finder-select)
- (define-key map "f" 'finder-select)
- (define-key map [mouse-2] 'finder-mouse-select)
- (define-key map "\C-m" 'finder-select)
- (define-key map "?" 'finder-summary)
- (define-key map "q" 'finder-exit)
- (define-key map "d" 'finder-list-keywords)
- (setq finder-mode-map map)))
+(defvar finder-mode-map
+ (let ((map (make-sparse-keymap)))
+ (define-key map " " 'finder-select)
+ (define-key map "f" 'finder-select)
+ (define-key map [mouse-2] 'finder-mouse-select)
+ (define-key map "\C-m" 'finder-select)
+ (define-key map "?" 'finder-summary)
+ (define-key map "q" 'finder-exit)
+ (define-key map "d" 'finder-list-keywords)
+ map))
;;; Code for regenerating the keyword list.
(defvar finder-package-info nil
"Assoc list mapping file names to description & keyword lists.")
+(defvar generated-finder-keywords-file "finder-inf.el"
+ "File \\[finder-compile-keywords] puts finder keywords into.")
+
(defun finder-compile-keywords (&rest dirs)
- "Regenerate the keywords association list into the file `finder-inf.el'.
+ "Regenerate the keywords association list into `generated-finder-keywords-file'.
Optional arguments DIRS are a list of Emacs Lisp directories to compile from;
no arguments compiles from `load-path'."
(save-excursion
(let ((processed nil))
- (find-file "finder-inf.el")
+ (find-file generated-finder-keywords-file)
(erase-buffer)
- (insert ";;; finder-inf.el --- keyword-to-package mapping\n")
+ (insert ";;; " (file-name-nondirectory generated-finder-keywords-file)
+ " --- keyword-to-package mapping\n")
(insert ";; This file is part of GNU Emacs.\n")
- (insert ";; Keywords: help\n")
(insert ";;; Commentary:\n")
(insert ";; Don't edit this file. It's generated by finder.el\n\n")
(insert ";;; Code:\n")
(directory-files (or d ".")))))
(or dirs load-path))
(insert "))\n
-\(provide 'finder-inf)
+\(provide '" (file-name-sans-extension
+ (file-name-nondirectory generated-finder-keywords-file)) ")
;;; Local Variables:
;;; version-control: never
;;; no-byte-compile: t
;;; no-update-autoloads: t
;;; End:
-;;; finder-inf.el ends here\n")
+;;; " (file-name-nondirectory generated-finder-keywords-file) " ends here\n")
(kill-buffer "*finder-scratch*")
(eval-current-buffer) ;; So we get the new keyword list immediately
(basic-save-buffer))))
(shrink-window-if-larger-than-buffer)
(finder-summary)))
-(defun finder-find-library (library)
- "Search for file LIBRARY on `load-path'.
-Try compressed versions if jka-compr is in use."
- (or (locate-library library t)
- (if (rassq 'jka-compr-handler file-name-handler-alist)
- (or (locate-library (concat library ".gz") t)
- (locate-library (concat library ".Z") t)
- ;; last resort for MS-DOG et al
- (locate-library (concat library "z"))))))
-
;;;###autoload
(defun finder-commentary (file)
"Display FILE's commentary section.
FILE should be in a form suitable for passing to `locate-library'."
- (interactive "sLibrary name: ")
- (let* ((str (lm-commentary (or (finder-find-library file)
- (finder-find-library (concat file ".el"))
- (error "Can't find library %s" file)))))
+ (interactive
+ (list
+ (completing-read "Library name: "
+ 'locate-file-completion
+ (cons (or find-function-source-path load-path)
+ (find-library-suffixes)))))
+ (let* ((str (lm-commentary (find-library-name file))))
(if (null str)
(error "Can't find any Commentary section"))
- (pop-to-buffer "*Finder*")
+ ;; This used to use *Finder* but that would clobber the
+ ;; directory of categories.
+ (delete-other-windows)
+ (pop-to-buffer "*Finder-package*")
(setq buffer-read-only nil)
(erase-buffer)
(insert str)
\\[finder-select] more help for the item on the current line
\\[finder-exit] exit Finder mode and kill the Finder buffer."
(interactive)
+ (kill-all-local-variables)
(use-local-map finder-mode-map)
(set-syntax-table emacs-lisp-mode-syntax-table)
(setq mode-name "Finder")
(setq major-mode 'finder-mode)
- (make-local-variable 'finder-headmark)
- (setq finder-headmark nil))
+ (set (make-local-variable 'finder-headmark) nil)
+ (run-mode-hooks 'finder-mode-hook))
(defun finder-summary ()
"Summarize basic Finder commands."
\f
(provide 'finder)
+;;; arch-tag: ec85ff49-8cb8-41f5-a63f-9131d53ce2c5
;;; finder.el ends here