*** empty log message ***
[emacs.git] / lisp / finder.el
blobdc7343b9fb024e72587c8ba62a3f404504a80dd0
1 ;;; finder.el --- topic & keyword-based code finder
3 ;; Copyright (C) 1992,97,98,1999,2001,2004 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Created: 16 Jun 1992
7 ;; Version: 1.0
8 ;; Keywords: help
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Commentary:
29 ;; This mode uses the Keywords library header to provide code-finding
30 ;; services by keyword.
32 ;; Things to do:
33 ;; 1. Support multiple keywords per search. This could be extremely hairy;
34 ;; there doesn't seem to be any way to get completing-read to exit on
35 ;; an EOL with no substring pending, which is what we'd want to end the loop.
36 ;; 2. Search by string in synopsis line?
37 ;; 3. Function to check finder-package-info for unknown keywords.
39 ;;; Code:
41 (require 'lisp-mnt)
42 (require 'find-func) ;for find-library(-suffixes)
43 ;; Use `load' rather than `require' so that it doesn't get loaded
44 ;; during byte-compilation (at which point it might be missing).
45 (load "finder-inf" t t)
47 (defvar finder-mode-hook nil
48 "*Hook run when function `finder-mode' is called.")
50 ;; Local variable in finder buffer.
51 (defvar finder-headmark)
53 ;; These are supposed to correspond to top-level customization groups,
54 ;; says rms.
55 (defvar finder-known-keywords
57 (abbrev . "abbreviation handling, typing shortcuts, macros")
58 ;; Too specific:
59 (bib . "code related to the `bib' bibliography processor")
60 (c . "support for the C language and related languages")
61 (calendar . "calendar and time management support")
62 (comm . "communications, networking, remote access to files")
63 (convenience . "convenience features for faster editing")
64 (data . "support for editing files of data")
65 (docs . "support for Emacs documentation")
66 (emulations . "emulations of other editors")
67 (extensions . "Emacs Lisp language extensions")
68 (faces . "support for multiple fonts")
69 (files . "support for editing and manipulating files")
70 (frames . "support for Emacs frames and window systems")
71 (games . "games, jokes and amusements")
72 (hardware . "support for interfacing with exotic hardware")
73 (help . "support for on-line help systems")
74 (hypermedia . "support for links between text or other media types")
75 (i18n . "internationalization and alternate character-set support")
76 (internal . "code for Emacs internals, build process, defaults")
77 (languages . "specialized modes for editing programming languages")
78 (lisp . "Lisp support, including Emacs Lisp")
79 (local . "code local to your site")
80 (maint . "maintenance aids for the Emacs development group")
81 (mail . "modes for electronic-mail handling")
82 (matching . "various sorts of searching and matching")
83 (mouse . "mouse support")
84 (multimedia . "images and sound support")
85 (news . "support for netnews reading and posting")
86 (oop . "support for object-oriented programming")
87 (outlines . "support for hierarchical outlining")
88 (processes . "process, subshell, compilation, and job control support")
89 (terminals . "support for terminal types")
90 (tex . "supporting code for the TeX formatter")
91 (tools . "programming tools")
92 (unix . "front-ends/assistants for, or emulators of, UNIX-like features")
93 ;; Not a custom group and not currently useful.
94 ;; (vms . "support code for vms")
95 (wp . "word processing")
98 (defvar finder-mode-map
99 (let ((map (make-sparse-keymap)))
100 (define-key map " " 'finder-select)
101 (define-key map "f" 'finder-select)
102 (define-key map [mouse-2] 'finder-mouse-select)
103 (define-key map "\C-m" 'finder-select)
104 (define-key map "?" 'finder-summary)
105 (define-key map "q" 'finder-exit)
106 (define-key map "d" 'finder-list-keywords)
107 map))
110 ;;; Code for regenerating the keyword list.
112 (defvar finder-package-info nil
113 "Assoc list mapping file names to description & keyword lists.")
115 (defvar generated-finder-keywords-file "finder-inf.el"
116 "File \\[finder-compile-keywords] puts finder keywords into.")
118 (defun finder-compile-keywords (&rest dirs)
119 "Regenerate the keywords association list into `generated-finder-keywords-file'.
120 Optional arguments DIRS are a list of Emacs Lisp directories to compile from;
121 no arguments compiles from `load-path'."
122 (save-excursion
123 (let ((processed nil))
124 (find-file generated-finder-keywords-file)
125 (erase-buffer)
126 (insert ";;; " (file-name-nondirectory generated-finder-keywords-file)
127 " --- keyword-to-package mapping\n")
128 (insert ";; This file is part of GNU Emacs.\n")
129 (insert ";;; Commentary:\n")
130 (insert ";; Don't edit this file. It's generated by finder.el\n\n")
131 (insert ";;; Code:\n")
132 (insert "\n(setq finder-package-info '(\n")
133 (mapcar
134 (lambda (d)
135 (when (file-exists-p (directory-file-name d))
136 (message "Directory %s" d)
137 (mapcar
138 (lambda (f)
139 (if (and (or (string-match "^[^=].*\\.el$" f)
140 ;; Allow compressed files also. Fixme:
141 ;; generalize this, especially for
142 ;; MS-DOG-type filenames.
143 (and (string-match "^[^=].*\\.el\\.\\(gz\\|Z\\)$" f)
144 (require 'jka-compr)))
145 ;; Ignore lock files.
146 (not (string-match "^.#" f))
147 (not (member f processed)))
148 (let (summary keystart keywords)
149 (setq processed (cons f processed))
150 (save-excursion
151 (set-buffer (get-buffer-create "*finder-scratch*"))
152 (buffer-disable-undo (current-buffer))
153 (erase-buffer)
154 (insert-file-contents
155 (concat (file-name-as-directory (or d ".")) f))
156 (setq summary (lm-synopsis))
157 (setq keywords (lm-keywords)))
158 (insert
159 (format " (\"%s\"\n "
160 (if (string-match "\\.\\(gz\\|Z\\)$" f)
161 (file-name-sans-extension f)
162 f)))
163 (prin1 summary (current-buffer))
164 (insert
165 "\n ")
166 (setq keystart (point))
167 (insert
168 (if keywords (format "(%s)" keywords) "nil")
169 ")\n")
170 (subst-char-in-region keystart (point) ?, ? )
172 (directory-files (or d ".")))))
173 (or dirs load-path))
174 (insert "))\n
175 \(provide '" (file-name-sans-extension
176 (file-name-nondirectory generated-finder-keywords-file)) ")
178 ;;; Local Variables:
179 ;;; version-control: never
180 ;;; no-byte-compile: t
181 ;;; no-update-autoloads: t
182 ;;; End:
183 ;;; " (file-name-nondirectory generated-finder-keywords-file) " ends here\n")
184 (kill-buffer "*finder-scratch*")
185 (eval-current-buffer) ;; So we get the new keyword list immediately
186 (basic-save-buffer))))
188 (defun finder-compile-keywords-make-dist ()
189 "Regenerate `finder-inf.el' for the Emacs distribution."
190 (apply 'finder-compile-keywords command-line-args-left)
191 (kill-emacs))
193 ;;; Now the retrieval code
195 (defun finder-insert-at-column (column &rest strings)
196 "Insert, at column COLUMN, other args STRINGS."
197 (if (>= (current-column) column) (insert "\n"))
198 (move-to-column column t)
199 (apply 'insert strings))
201 (defvar finder-help-echo nil)
203 (defun finder-mouse-face-on-line ()
204 "Put `mouse-face' and `help-echo' properties on the previous line."
205 (save-excursion
206 (previous-line 1)
207 (unless finder-help-echo
208 (setq finder-help-echo
209 (let* ((keys1 (where-is-internal 'finder-select
210 finder-mode-map))
211 (keys (nconc (where-is-internal
212 'finder-mouse-select finder-mode-map)
213 keys1)))
214 (concat (mapconcat 'key-description keys ", ")
215 ": select item"))))
216 (add-text-properties
217 (line-beginning-position) (line-end-position)
218 '(mouse-face highlight
219 help-echo finder-help-echo))))
221 ;;;###autoload
222 (defun finder-list-keywords ()
223 "Display descriptions of the keywords in the Finder buffer."
224 (interactive)
225 (if (get-buffer "*Finder*")
226 (pop-to-buffer "*Finder*")
227 (pop-to-buffer (set-buffer (get-buffer-create "*Finder*")))
228 (finder-mode)
229 (setq buffer-read-only nil)
230 (erase-buffer)
231 (mapc
232 (lambda (assoc)
233 (let ((keyword (car assoc)))
234 (insert (symbol-name keyword))
235 (finder-insert-at-column 14 (concat (cdr assoc) "\n"))
236 (finder-mouse-face-on-line)))
237 finder-known-keywords)
238 (goto-char (point-min))
239 (setq finder-headmark (point))
240 (setq buffer-read-only t)
241 (set-buffer-modified-p nil)
242 (balance-windows)
243 (finder-summary)))
245 (defun finder-list-matches (key)
246 (pop-to-buffer (set-buffer (get-buffer-create "*Finder Category*")))
247 (finder-mode)
248 (setq buffer-read-only nil)
249 (erase-buffer)
250 (let ((id (intern key)))
251 (insert
252 "The following packages match the keyword `" key "':\n\n")
253 (setq finder-headmark (point))
254 (mapc
255 (lambda (x)
256 (if (memq id (car (cdr (cdr x))))
257 (progn
258 (insert (car x))
259 (finder-insert-at-column 16 (concat (nth 1 x) "\n"))
260 (finder-mouse-face-on-line))))
261 finder-package-info)
262 (goto-char (point-min))
263 (forward-line)
264 (setq buffer-read-only t)
265 (set-buffer-modified-p nil)
266 (shrink-window-if-larger-than-buffer)
267 (finder-summary)))
269 ;;;###autoload
270 (defun finder-commentary (file)
271 "Display FILE's commentary section.
272 FILE should be in a form suitable for passing to `locate-library'."
273 (interactive
274 (list
275 (completing-read "Library name: "
276 'locate-file-completion
277 (cons (or find-function-source-path load-path)
278 (find-library-suffixes)))))
279 (let* ((str (lm-commentary (find-library-name file))))
280 (if (null str)
281 (error "Can't find any Commentary section"))
282 ;; This used to use *Finder* but that would clobber the
283 ;; directory of categories.
284 (delete-other-windows)
285 (pop-to-buffer "*Finder-package*")
286 (setq buffer-read-only nil)
287 (erase-buffer)
288 (insert str)
289 (goto-char (point-min))
290 (delete-blank-lines)
291 (goto-char (point-max))
292 (delete-blank-lines)
293 (goto-char (point-min))
294 (while (re-search-forward "^;+ ?" nil t)
295 (replace-match "" nil nil))
296 (goto-char (point-min))
297 (setq buffer-read-only t)
298 (set-buffer-modified-p nil)
299 (shrink-window-if-larger-than-buffer)
300 (finder-mode)
301 (finder-summary)))
303 (defun finder-current-item ()
304 (if (and finder-headmark (< (point) finder-headmark))
305 (error "No keyword or filename on this line")
306 (save-excursion
307 (beginning-of-line)
308 (current-word))))
310 (defun finder-select ()
311 "Select item on current line in a finder buffer."
312 (interactive)
313 (let ((key (finder-current-item)))
314 (if (string-match "\\.el$" key)
315 (finder-commentary key)
316 (finder-list-matches key))))
318 (defun finder-mouse-select (event)
319 "Select item in a finder buffer with the mouse."
320 (interactive "e")
321 (save-excursion
322 (set-buffer (window-buffer (posn-window (event-start event))))
323 (goto-char (posn-point (event-start event)))
324 (finder-select)))
326 ;;;###autoload
327 (defun finder-by-keyword ()
328 "Find packages matching a given keyword."
329 (interactive)
330 (finder-list-keywords))
332 (defun finder-mode ()
333 "Major mode for browsing package documentation.
334 \\<finder-mode-map>
335 \\[finder-select] more help for the item on the current line
336 \\[finder-exit] exit Finder mode and kill the Finder buffer."
337 (interactive)
338 (kill-all-local-variables)
339 (use-local-map finder-mode-map)
340 (set-syntax-table emacs-lisp-mode-syntax-table)
341 (setq mode-name "Finder")
342 (setq major-mode 'finder-mode)
343 (set (make-local-variable 'finder-headmark) nil)
344 (run-mode-hooks 'finder-mode-hook))
346 (defun finder-summary ()
347 "Summarize basic Finder commands."
348 (interactive)
349 (message "%s"
350 (substitute-command-keys
351 "\\<finder-mode-map>\\[finder-select] = select, \
352 \\[finder-mouse-select] = select, \\[finder-list-keywords] = to \
353 finder directory, \\[finder-exit] = quit, \\[finder-summary] = help")))
355 (defun finder-exit ()
356 "Exit Finder mode and kill the buffer."
357 (interactive)
358 (or (one-window-p t)
359 (delete-window))
360 ;; Can happen in either buffer -- kill each of the two that exists
361 (and (get-buffer "*Finder*")
362 (kill-buffer "*Finder*"))
363 (and (get-buffer "*Finder Category*")
364 (kill-buffer "*Finder Category*")))
367 (provide 'finder)
369 ;;; arch-tag: ec85ff49-8cb8-41f5-a63f-9131d53ce2c5
370 ;;; finder.el ends here