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