(te-escape): Use current-prefix-arg, not prefix-arg.
[bpt/emacs.git] / lisp / finder.el
index 81b88e6..aaac9df 100644 (file)
 (require 'finder-inf)
 (require 'picture)
 
+;; Local variable in finder buffer.
+(defvar finder-headmark)
+
 (defvar finder-known-keywords
   '(
     (abbrev    . "abbreviation handling, typing shortcuts, macros")
-    (bib       . "code related to the bib(1) bibliography processor")
+    (bib       . "code related to the `bib' bibliography processor")
     (c         . "C and C++ language support")
     (calendar  . "calendar and time management support")
     (comm      . "communications, networking, remote access to files")
+    (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")
     (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")
+    (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")
     (news      . "support for netnews reading and posting")
     (processes . "process, subshell, compilation, and job control support")
     (terminals . "support for terminal types")
     ))
 
 (defvar finder-mode-map nil)
-;(if finder-mode-map
-;    nil
-  (setq finder-mode-map (make-sparse-keymap))
-  (define-key finder-mode-map " "      'finder-select)
-  (define-key finder-mode-map "?"      'finder-summary)
-  (define-key finder-mode-map "x"      'finder-exit)
-  (define-key finder-mode-map "f"      'finder-list-keywords)
-;  )
+(or finder-mode-map
+    (let ((map (make-sparse-keymap)))
+      (define-key map " "      'finder-select)
+      (define-key map "f"      'finder-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.
 
@@ -87,7 +96,7 @@
   "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.
+  "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'."
   (save-excursion
@@ -106,11 +115,13 @@ arguments compiles from `load-path'."
          (mapcar
           (function
            (lambda (f) 
-             (if (and (string-match "\\.el$" f) (not (member f processed)))
-                 (let (summary keystart)
+             (if (and (string-match "^[^=].*\\.el$" 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))
@@ -152,7 +163,7 @@ arguments compiles from `load-path'."
                 (cons (symbol-name keyword) keyword))))
    finder-known-keywords)
   (goto-char (point-min))
-  (setq headmark (point))
+  (setq finder-headmark (point))
   (setq buffer-read-only t)
   (set-buffer-modified-p nil)
   (balance-windows)
@@ -164,7 +175,7 @@ arguments compiles from `load-path'."
   (let ((id (intern key)))
     (insert
      "The following packages match the keyword `" key "':\n\n")
-    (setq headmark (point))
+    (setq finder-headmark (point))
     (mapcar
      (function (lambda (x)
                 (if (memq id (car (cdr (cdr x))))
@@ -182,11 +193,25 @@ arguments compiles from `load-path'."
     (shrink-window-if-larger-than-buffer)
     (finder-summary)))
 
+;; Search for a file named FILE the same way `load' would search.
+(defun finder-find-library (file)
+  (if (file-name-absolute-p file)
+      file
+    (let ((dirs load-path)
+         found)
+      (while (and dirs (not found))
+       (if (file-exists-p (expand-file-name (concat file ".el") (car dirs)))
+           (setq found (expand-file-name file (car dirs)))
+         (if (file-exists-p (expand-file-name file (car dirs)))
+             (setq found (expand-file-name file (car dirs)))))
+       (setq dirs (cdr dirs)))
+      found)))
+
 (defun finder-commentary (file)
   (interactive)
-  (let* ((str (lm-commentary file)))
+  (let* ((str (lm-commentary (finder-find-library file))))
     (if (null str)
-       (error "Can't find any Commentary section."))
+       (error "Can't find any Commentary section"))
     (pop-to-buffer "*Finder*")
     (setq buffer-read-only nil)
     (erase-buffer)
@@ -206,7 +231,7 @@ arguments compiles from `load-path'."
     ))
 
 (defun finder-current-item ()
-  (if (and headmark (< (point) headmark))
+  (if (and finder-headmark (< (point) finder-headmark))
       (error "No keyword or filename on this line")
     (save-excursion
       (beginning-of-line)
@@ -227,9 +252,9 @@ arguments compiles from `load-path'."
 
 (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 fill the Finder buffer.
+\\[finder-exit]        exit Finder mode and kill the Finder buffer.
 "
   (interactive)
   (pop-to-buffer "*Finder*")
@@ -239,15 +264,16 @@ arguments compiles from `load-path'."
   (set-syntax-table emacs-lisp-mode-syntax-table)
   (setq mode-name "Finder")
   (setq major-mode 'finder-mode)
-  (make-local-variable 'headmark)
-  (setq headmark nil)
+  (make-local-variable 'finder-headmark)
+  (setq finder-headmark nil)
 )
 
 (defun finder-summary ()
   "Summarize basic Finder commands."
   (interactive)
   (message
-   "SPC = select, f = back to Finder, x = eXit, ? = help"))
+   (substitute-command-keys
+    "\\<finder-mode-map>\\[finder-select] = select, \\[finder-list-keywords] = to finder directory, \\[finder-exit] = quit, \\[finder-summary] = help")))
 
 (defun finder-exit ()
   "Exit Finder mode and kill the buffer"