;;; finder.el --- topic & keyword-based code finder
-;; Copyright (C) 1992, 1997 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
;; 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")
(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")
(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")
(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
(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
;;; Now the retrieval code
(defun finder-insert-at-column (column &rest strings)
- "Insert list of STRINGS, at column COLUMN."
+ "Insert, at column COLUMN, other args STRINGS."
(if (> (current-column) column) (insert "\n"))
- (move-to-column column)
- (let ((col (current-column)))
- (if (< col column)
- (indent-to column)
- (if (and (/= col column)
- (= (preceding-char) ?\t))
- (let (indent-tabs-mode)
- (delete-char -1)
- (indent-to col)
- (move-to-column column)))))
+ (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)
(let ((keyword (car assoc)))
(insert (symbol-name keyword))
(finder-insert-at-column 14 (concat (cdr assoc) "\n"))
- (cons (symbol-name keyword) keyword)))
+ (finder-mouse-face-on-line)))
finder-known-keywords)
(goto-char (point-min))
(setq finder-headmark (point))
(if (memq id (car (cdr (cdr x))))
(progn
(insert (car x))
- (finder-insert-at-column 16 (concat (car (cdr x)) "\n")))))
+ (finder-insert-at-column 16 (concat (nth 1 x) "\n"))
+ (finder-mouse-face-on-line))))
finder-package-info)
(goto-char (point-min))
(forward-line)
(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)
;; last resort for MS-DOG et al
(locate-library (concat library "z"))))))
+;;;###autoload
(defun finder-commentary (file)
- (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*")
(setq buffer-read-only t)
(set-buffer-modified-p nil)
(shrink-window-if-larger-than-buffer)
+ (finder-mode)
(finder-summary)))
(defun finder-current-item ()
(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-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)))
- (let ((key (finder-current-item)))
- (finder-select))))
+ (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)
"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)
(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")))
+ "\\<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."