*** empty log message ***
[bpt/emacs.git] / lisp / finder.el
index 57c5995..037083e 100644 (file)
@@ -1,6 +1,6 @@
 ;;; finder.el --- topic & keyword-based code finder
 
-;; Copyright (C) 1992 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
@@ -11,7 +11,7 @@
 
 ;; GNU Emacs is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 1, or (at your option)
+;; the Free Software Foundation; either version 2, or (at your option)
 ;; any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; 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:
+;;; Commentary:
 
 ;; This mode uses the Keywords library header to provide code-finding
 ;; services by keyword.
 
 (require 'lisp-mnt)
 (require 'finder-inf)
-(require 'picture)
 
+;; 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")
-    (bib       . "code related to the bib(1) bibliography processor")
-    (c         . "C and C++ language support")
+    (bib       . "code related to the `bib' bibliography processor")
+    (c         . "support for the C language and related languages")
     (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")
     (docs      . "support for Emacs documentation")
     (emulations        . "emulations of other editors")
     (extensions        . "Emacs Lisp language extensions")
+    (faces     . "support for multiple fonts")
+    (frames     . "support for Emacs frames and window systems")
     (games     . "games, jokes and amusements")
     (hardware  . "support for interfacing with exotic hardware")
     (help      . "support for on-line help systems")
-    (i14n      . "internationalization and alternate character-set support")
+    (hypermedia . "support for links between text or other media types")
+    (i18n      . "internationalization and alternate character-set support")
     (internal  . "code for Emacs internals, build process, defaults")
     (languages . "specialized modes for editing programming languages")
     (lisp      . "Lisp support, including Emacs Lisp")
     (local     . "code local to your site")
     (maint     . "maintenance aids for the Emacs development group")
     (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")
     (processes . "process, subshell, compilation, and job control support")
     (terminals . "support for terminal types")
     (tex       . "code related to the TeX formatter")
     (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)))
+
+
 ;;; Code for regenerating the keyword list.
 
 (defvar finder-package-info nil
   "Assoc list mapping file names to description & keyword lists.")
 
 (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'."
+  "Regenerate the keywords association list into the file `finder-inf.el'.
+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")
@@ -91,23 +119,35 @@ arguments compiles from `load-path'."
       (insert ";;; Code:\n")
       (insert "\n(setq finder-package-info '(\n")
       (mapcar
-       (function
-       (lambda (d)
-         (mapcar
-          (function
-           (lambda (f) 
-             (if (and (string-match "\\.el$" f) (not (member f processed)))
-                 (let (summary keystart)
+       (lambda (d)
+        (when (file-exists-p (directory-file-name d))
+          (message "Directory %s" d)
+          (mapcar
+           (lambda (f)
+             (if (and (or (string-match "^[^=].*\\.el$" f)
+                          ;; Allow compressed files also.  Fixme:
+                          ;; generalize this, especially for
+                          ;; MS-DOG-type filenames.
+                          (and (string-match "^[^=].*\\.el\\.\\(gz\\|Z\\)$" f)
+                               (require 'jka-compr)))
+                      ;; Ignore lock files.
+                      (not (string-match "^.#" f))
+                      (not (member f processed)))
+                 (let (summary keystart keywords)
                    (setq processed (cons f processed))
                    (save-excursion
                      (set-buffer (get-buffer-create "*finder-scratch*"))
+                     (buffer-disable-undo (current-buffer))
                      (erase-buffer)
                      (insert-file-contents
                       (concat (file-name-as-directory (or d ".")) f))
                      (setq summary (lm-synopsis))
                      (setq keywords (lm-keywords)))
                    (insert
-                    (format "    (\"%s\"\n        " f))
+                    (format "    (\"%s\"\n        "
+                            (if (string-match "\\.\\(gz\\|Z\\)$" f)
+                                (file-name-sans-extension f)
+                              f)))
                    (prin1 summary (current-buffer))
                    (insert
                     "\n        ")
@@ -116,59 +156,192 @@ arguments compiles from `load-path'."
                     (if keywords (format "(%s)" keywords) "nil")
                     ")\n")
                    (subst-char-in-region keystart (point) ?, ? )
-                   )
-               )))
-          (directory-files (or d ".")))
-         ))
+                   )))
+           (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)
-      )))
+      (basic-save-buffer))))
+
+(defun finder-compile-keywords-make-dist ()
+  "Regenerate `finder-inf.el' for the Emacs distribution."
+  (apply 'finder-compile-keywords command-line-args-left)
+  (kill-emacs))
 
 ;;; Now the retrieval code
 
+(defun finder-insert-at-column (column &rest strings)
+  "Insert, at column COLUMN, other args STRINGS."
+  (if (> (current-column) column) (insert "\n"))
+  (move-to-column column t)
+  (apply 'insert strings))
+
+(defun finder-mouse-face-on-line ()
+  "Put a `mouse-face' property on the previous line."
+  (save-excursion
+    (previous-line 1)
+    (put-text-property (save-excursion (beginning-of-line) (point))
+                      (progn (end-of-line) (point))
+                      'mouse-face 'highlight)))
+
+;;;###autoload
+(defun finder-list-keywords ()
+  "Display descriptions of the keywords in the Finder buffer."
+  (interactive)
+  (if (get-buffer "*Finder*")
+      (pop-to-buffer "*Finder*")
+    (pop-to-buffer (set-buffer (get-buffer-create "*Finder*")))
+    (finder-mode)
+    (setq buffer-read-only nil)
+    (erase-buffer)
+    (mapcar
+     (lambda (assoc)
+       (let ((keyword (car assoc)))
+        (insert (symbol-name keyword))
+        (finder-insert-at-column 14 (concat (cdr assoc) "\n"))
+        (finder-mouse-face-on-line)))
+     finder-known-keywords)
+    (goto-char (point-min))
+    (setq finder-headmark (point))
+    (setq buffer-read-only t)
+    (set-buffer-modified-p nil)
+    (balance-windows)
+    (finder-summary)))
+
+(defun finder-list-matches (key)
+  (pop-to-buffer (set-buffer (get-buffer-create "*Finder Category*")))
+  (finder-mode)
+  (setq buffer-read-only nil)
+  (erase-buffer)
+  (let ((id (intern key)))
+    (insert
+     "The following packages match the keyword `" key "':\n\n")
+    (setq finder-headmark (point))
+    (mapcar
+     (lambda (x)
+       (if (memq id (car (cdr (cdr x))))
+          (progn
+            (insert (car x))
+            (finder-insert-at-column 16 (concat (nth 1 x) "\n"))
+            (finder-mouse-face-on-line))))
+     finder-package-info)
+    (goto-char (point-min))
+    (forward-line)
+    (setq buffer-read-only t)
+    (set-buffer-modified-p nil)
+    (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)))))
+    (if (null str)
+       (error "Can't find any Commentary section"))
+    (pop-to-buffer "*Finder*")
+    (setq buffer-read-only nil)
+    (erase-buffer)
+    (insert str)
+    (goto-char (point-min))
+    (delete-blank-lines)
+    (goto-char (point-max))
+    (delete-blank-lines)
+    (goto-char (point-min))
+    (while (re-search-forward "^;+ ?" nil t)
+      (replace-match "" nil nil))
+    (goto-char (point-min))
+    (setq buffer-read-only t)
+    (set-buffer-modified-p nil)
+    (shrink-window-if-larger-than-buffer)
+    (finder-mode)
+    (finder-summary)))
+
+(defun finder-current-item ()
+  (if (and finder-headmark (< (point) finder-headmark))
+      (error "No keyword or filename on this line")
+    (save-excursion
+      (beginning-of-line)
+      (current-word))))
+
+(defun finder-select ()
+  "Select item on current line in a finder buffer."
+  (interactive)
+  (let ((key (finder-current-item)))
+      (if (string-match "\\.el$" key)
+         (finder-commentary key)
+       (finder-list-matches key))))
+
+(defun finder-mouse-select (event)
+  "Select item in a finder buffer with the mouse."
+  (interactive "e")
+  (save-excursion
+    (set-buffer (window-buffer (posn-window (event-start event))))
+    (goto-char (posn-point (event-start event)))
+    (finder-select)))
+
+;;;###autoload
 (defun finder-by-keyword ()
   "Find packages matching a given keyword."
   (interactive)
-  (set-buffer (get-buffer-create "*Help*"))
-  (erase-buffer)
+  (finder-list-keywords))
+
+(defun finder-mode ()
+  "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."
+  (interactive)
+  (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))
 
-  ;; Display descriptions of the keywords in the help buffer, and
-  ;; build an assoc list mapping the names of known keywords to their
-  ;; symbols.
-  (let ((keyword-names
-        (mapcar (lambda (assoc)
-                  (let ((keyword (car assoc)))
-                    (insert (symbol-name keyword))
-                    (insert-at-column 14 (cdr assoc) "\n")
-                    (cons (symbol-name keyword) keyword)))
-                finder-known-keywords)))
-    (let ((key 
-          (save-window-excursion
-            (pop-to-buffer "*Help*")
-            (goto-char (point-min))
-            (completing-read "Package keyword: " keyword-names nil t)))
-         id)
-      (or (equal key "")
-         (progn
-           (erase-buffer)
-           (pop-to-buffer "*Help*")
-           (setq id (intern key))
-           (insert
-            "The following packages match the keyword `" key "':\n\n")
-           (mapcar
-            (function (lambda (x)
-                        (if (memq id (car (cdr (cdr x))))
-                            (progn
-                              (insert (car x))
-                              (insert-at-column 16 (car (cdr x)) "\n")
-                              ))
-                        ))
-            finder-package-info)
-           (goto-char (point-min)))))))
+(defun finder-summary ()
+  "Summarize basic Finder commands."
+  (interactive)
+  (message "%s"
+   (substitute-command-keys
+    "\\<finder-mode-map>\\[finder-select] = select, \
+\\[finder-mouse-select] = select, \\[finder-list-keywords] = to \
+finder directory, \\[finder-exit] = quit, \\[finder-summary] = help")))
+
+(defun finder-exit ()
+  "Exit Finder mode and kill the buffer."
+  (interactive)
+  (or (one-window-p t)
+      (delete-window))
+  ;; Can happen in either buffer -- kill each of the two that exists
+  (and (get-buffer "*Finder*")
+       (kill-buffer "*Finder*"))
+  (and (get-buffer "*Finder Category*")
+       (kill-buffer "*Finder Category*")))
 
+\f
 (provide 'finder)
 
 ;;; finder.el ends here