(diary-face, holiday-face): Add dark-background variants.
[bpt/emacs.git] / lisp / finder.el
index 07d79f8..037083e 100644 (file)
@@ -1,6 +1,6 @@
 ;;; finder.el --- topic & keyword-based code finder
 
-;; Copyright (C) 1992, 1997, 1998 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1997, 1998, 1999 Free Software Foundation, Inc.
 
 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
 ;; Created: 16 Jun 1992
@@ -44,6 +44,8 @@
 ;; Local variable in finder buffer.
 (defvar finder-headmark)
 
+;; These are supposed to correspond to top-level customization groups,
+;; says rms.
 (defvar finder-known-keywords
   '(
     (abbrev    . "abbreviation handling, typing shortcuts, macros")
@@ -71,6 +73,7 @@
     (mail      . "modes for electronic-mail handling")
     (matching  . "various sorts of searching and matching")
     (mouse     . "mouse support")
+    (multimedia . "images and sound support")
     (news      . "support for netnews reading and posting")
     (oop        . "support for object-oriented programming")
     (outlines   . "support for hierarchical outlining")
 
 (defun finder-compile-keywords (&rest dirs)
   "Regenerate the keywords association list into the file `finder-inf.el'.
-Optional arguments are a list of Emacs Lisp directories to compile from; no
-arguments compiles from `load-path'."
+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")
@@ -120,7 +123,7 @@ arguments compiles from `load-path'."
         (when (file-exists-p (directory-file-name d))
           (message "Directory %s" d)
           (mapcar
-           (lambda (f) 
+           (lambda (f)
              (if (and (or (string-match "^[^=].*\\.el$" f)
                           ;; Allow compressed files also.  Fixme:
                           ;; generalize this, especially for
@@ -143,7 +146,7 @@ arguments compiles from `load-path'."
                    (insert
                     (format "    (\"%s\"\n        "
                             (if (string-match "\\.\\(gz\\|Z\\)$" f)
-                                (file-name-sans-extension f) 
+                                (file-name-sans-extension f)
                               f)))
                    (prin1 summary (current-buffer))
                    (insert
@@ -156,7 +159,15 @@ arguments compiles from `load-path'."
                    )))
            (directory-files (or d ".")))))
        (or dirs load-path))
-      (insert "))\n\n(provide 'finder-inf)\n\n;;; finder-inf.el ends here\n")
+      (insert "))\n
+\(provide 'finder-inf)
+
+;;; Local Variables:
+;;; version-control: never
+;;; no-byte-compile: t
+;;; no-update-autoloads: t
+;;; End:
+;;; finder-inf.el ends here\n")
       (kill-buffer "*finder-scratch*")
       (eval-current-buffer) ;; So we get the new keyword list immediately
       (basic-save-buffer))))
@@ -182,6 +193,7 @@ arguments compiles from `load-path'."
                       (progn (end-of-line) (point))
                       'mouse-face 'highlight)))
 
+;;;###autoload
 (defun finder-list-keywords ()
   "Display descriptions of the keywords in the Finder buffer."
   (interactive)
@@ -229,9 +241,9 @@ arguments compiles from `load-path'."
     (shrink-window-if-larger-than-buffer)
     (finder-summary)))
 
-;; Search for a file named FILE on `load-path', also trying compressed
-;; versions if jka-compr is in use.
 (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)
@@ -239,10 +251,14 @@ arguments compiles from `load-path'."
             ;; last resort for MS-DOG et al
             (locate-library (concat library "z"))))))
 
+;;;###autoload
 (defun finder-commentary (file)
-  "Display FILE's commentary section."
-  (interactive)
-  (let* ((str (lm-commentary (finder-find-library 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)))))
     (if (null str)
        (error "Can't find any Commentary section"))
     (pop-to-buffer "*Finder*")
@@ -260,6 +276,7 @@ arguments compiles from `load-path'."
     (setq buffer-read-only t)
     (set-buffer-modified-p nil)
     (shrink-window-if-larger-than-buffer)
+    (finder-mode)
     (finder-summary)))
 
 (defun finder-current-item ()
@@ -285,6 +302,7 @@ arguments compiles from `load-path'."
     (goto-char (posn-point (event-start event)))
     (finder-select)))
 
+;;;###autoload
 (defun finder-by-keyword ()
   "Find packages matching a given keyword."
   (interactive)
@@ -294,8 +312,7 @@ arguments compiles from `load-path'."
   "Major mode for browsing package documentation.
 \\<finder-mode-map>
 \\[finder-select]      more help for the item on the current line
-\\[finder-exit]        exit Finder mode and kill the Finder buffer.
-"
+\\[finder-exit]        exit Finder mode and kill the Finder buffer."
   (interactive)
   (use-local-map finder-mode-map)
   (set-syntax-table emacs-lisp-mode-syntax-table)
@@ -324,6 +341,7 @@ finder directory, \\[finder-exit] = quit, \\[finder-summary] = help")))
   (and (get-buffer "*Finder Category*")
        (kill-buffer "*Finder Category*")))
 
+\f
 (provide 'finder)
 
 ;;; finder.el ends here