Commit | Line | Data |
---|---|---|
1164bae9 ER |
1 | ;;; finder.el --- topic & keyword-based code finder |
2 | ||
2d212d87 | 3 | ;; Copyright (C) 1992, 1997, 1998, 1999 Free Software Foundation, Inc. |
1164bae9 ER |
4 | |
5 | ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
6 | ;; Created: 16 Jun 1992 | |
7 | ;; Version: 1.0 | |
8 | ;; Keywords: help | |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
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 | |
7c938215 | 14 | ;; the Free Software Foundation; either version 2, or (at your option) |
1164bae9 ER |
15 | ;; any later version. |
16 | ||
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. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
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. | |
1164bae9 | 26 | |
101dad14 | 27 | ;;; Commentary: |
1164bae9 ER |
28 | |
29 | ;; This mode uses the Keywords library header to provide code-finding | |
30 | ;; services by keyword. | |
31 | ;; | |
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. | |
38 | ||
39 | ;;; Code: | |
40 | ||
41 | (require 'lisp-mnt) | |
42 | (require 'finder-inf) | |
1164bae9 | 43 | |
14931973 RS |
44 | ;; Local variable in finder buffer. |
45 | (defvar finder-headmark) | |
46 | ||
4f451c3f DL |
47 | ;; These are supposed to correspond to top-level customization groups, |
48 | ;; says rms. | |
1164bae9 ER |
49 | (defvar finder-known-keywords |
50 | '( | |
dea24479 | 51 | (abbrev . "abbreviation handling, typing shortcuts, macros") |
be2c35e4 | 52 | (bib . "code related to the `bib' bibliography processor") |
68f8f37f | 53 | (c . "support for the C language and related languages") |
1164bae9 | 54 | (calendar . "calendar and time management support") |
e9571d2a | 55 | (comm . "communications, networking, remote access to files") |
35e9c644 | 56 | (convenience . "convenience features for faster editing") |
be2c35e4 | 57 | (data . "support editing files of data") |
1164bae9 ER |
58 | (docs . "support for Emacs documentation") |
59 | (emulations . "emulations of other editors") | |
60 | (extensions . "Emacs Lisp language extensions") | |
be2c35e4 | 61 | (faces . "support for multiple fonts") |
f1aabce0 | 62 | (frames . "support for Emacs frames and window systems") |
1164bae9 ER |
63 | (games . "games, jokes and amusements") |
64 | (hardware . "support for interfacing with exotic hardware") | |
65 | (help . "support for on-line help systems") | |
f1aabce0 | 66 | (hypermedia . "support for links between text or other media types") |
14931973 | 67 | (i18n . "internationalization and alternate character-set support") |
1164bae9 ER |
68 | (internal . "code for Emacs internals, build process, defaults") |
69 | (languages . "specialized modes for editing programming languages") | |
70 | (lisp . "Lisp support, including Emacs Lisp") | |
71 | (local . "code local to your site") | |
72 | (maint . "maintenance aids for the Emacs development group") | |
73 | (mail . "modes for electronic-mail handling") | |
be2c35e4 RS |
74 | (matching . "various sorts of searching and matching") |
75 | (mouse . "mouse support") | |
1226dd0b | 76 | (multimedia . "images and sound support") |
1164bae9 | 77 | (news . "support for netnews reading and posting") |
f1aabce0 RS |
78 | (oop . "support for object-oriented programming") |
79 | (outlines . "support for hierarchical outlining") | |
1164bae9 ER |
80 | (processes . "process, subshell, compilation, and job control support") |
81 | (terminals . "support for terminal types") | |
82 | (tex . "code related to the TeX formatter") | |
83 | (tools . "programming tools") | |
84 | (unix . "front-ends/assistants for, or emulators of, UNIX features") | |
85 | (vms . "support code for vms") | |
86 | (wp . "word processing") | |
87 | )) | |
88 | ||
101dad14 | 89 | (defvar finder-mode-map nil) |
e141acb3 RS |
90 | (or finder-mode-map |
91 | (let ((map (make-sparse-keymap))) | |
92 | (define-key map " " 'finder-select) | |
93 | (define-key map "f" 'finder-select) | |
f3b330d6 | 94 | (define-key map [mouse-2] 'finder-mouse-select) |
e141acb3 RS |
95 | (define-key map "\C-m" 'finder-select) |
96 | (define-key map "?" 'finder-summary) | |
97 | (define-key map "q" 'finder-exit) | |
98 | (define-key map "d" 'finder-list-keywords) | |
99 | (setq finder-mode-map map))) | |
100 | ||
101dad14 | 101 | |
1164bae9 ER |
102 | ;;; Code for regenerating the keyword list. |
103 | ||
104 | (defvar finder-package-info nil | |
105 | "Assoc list mapping file names to description & keyword lists.") | |
106 | ||
107 | (defun finder-compile-keywords (&rest dirs) | |
14931973 | 108 | "Regenerate the keywords association list into the file `finder-inf.el'. |
2d212d87 DL |
109 | Optional arguments DIRS are a list of Emacs Lisp directories to compile from; |
110 | no arguments compiles from `load-path'." | |
1164bae9 | 111 | (save-excursion |
c5d87135 ER |
112 | (let ((processed nil)) |
113 | (find-file "finder-inf.el") | |
114 | (erase-buffer) | |
e9571d2a ER |
115 | (insert ";;; finder-inf.el --- keyword-to-package mapping\n") |
116 | (insert ";; Keywords: help\n") | |
0cbe967f ER |
117 | (insert ";;; Commentary:\n") |
118 | (insert ";; Don't edit this file. It's generated by finder.el\n\n") | |
119 | (insert ";;; Code:\n") | |
c5d87135 ER |
120 | (insert "\n(setq finder-package-info '(\n") |
121 | (mapcar | |
e6fb4d11 | 122 | (lambda (d) |
5b64ebe8 RS |
123 | (when (file-exists-p (directory-file-name d)) |
124 | (message "Directory %s" d) | |
125 | (mapcar | |
2d212d87 | 126 | (lambda (f) |
5b64ebe8 RS |
127 | (if (and (or (string-match "^[^=].*\\.el$" f) |
128 | ;; Allow compressed files also. Fixme: | |
129 | ;; generalize this, especially for | |
130 | ;; MS-DOG-type filenames. | |
131 | (and (string-match "^[^=].*\\.el\\.\\(gz\\|Z\\)$" f) | |
132 | (require 'jka-compr))) | |
133 | ;; Ignore lock files. | |
134 | (not (string-match "^.#" f)) | |
135 | (not (member f processed))) | |
136 | (let (summary keystart keywords) | |
137 | (setq processed (cons f processed)) | |
138 | (save-excursion | |
139 | (set-buffer (get-buffer-create "*finder-scratch*")) | |
140 | (buffer-disable-undo (current-buffer)) | |
141 | (erase-buffer) | |
142 | (insert-file-contents | |
143 | (concat (file-name-as-directory (or d ".")) f)) | |
144 | (setq summary (lm-synopsis)) | |
145 | (setq keywords (lm-keywords))) | |
146 | (insert | |
147 | (format " (\"%s\"\n " | |
148 | (if (string-match "\\.\\(gz\\|Z\\)$" f) | |
2d212d87 | 149 | (file-name-sans-extension f) |
5b64ebe8 RS |
150 | f))) |
151 | (prin1 summary (current-buffer)) | |
152 | (insert | |
153 | "\n ") | |
154 | (setq keystart (point)) | |
155 | (insert | |
156 | (if keywords (format "(%s)" keywords) "nil") | |
157 | ")\n") | |
158 | (subst-char-in-region keystart (point) ?, ? ) | |
159 | ))) | |
160 | (directory-files (or d "."))))) | |
c5d87135 | 161 | (or dirs load-path)) |
6a7ceddc SM |
162 | (insert "))\n |
163 | \(provide 'finder-inf) | |
164 | ||
165 | ;;; Local Variables: | |
166 | ;;; version-control: never | |
167 | ;;; no-byte-compile: t | |
168 | ;;; no-update-autoloads: t | |
169 | ;;; End: | |
170 | ;;; finder-inf.el ends here\n") | |
c5d87135 | 171 | (kill-buffer "*finder-scratch*") |
3688bf22 | 172 | (eval-current-buffer) ;; So we get the new keyword list immediately |
e6fb4d11 | 173 | (basic-save-buffer)))) |
1164bae9 | 174 | |
1c6425ea RS |
175 | (defun finder-compile-keywords-make-dist () |
176 | "Regenerate `finder-inf.el' for the Emacs distribution." | |
644f58eb RS |
177 | (apply 'finder-compile-keywords command-line-args-left) |
178 | (kill-emacs)) | |
1c6425ea | 179 | |
1164bae9 ER |
180 | ;;; Now the retrieval code |
181 | ||
e6fb4d11 | 182 | (defun finder-insert-at-column (column &rest strings) |
eb4df0c3 | 183 | "Insert, at column COLUMN, other args STRINGS." |
e6fb4d11 | 184 | (if (> (current-column) column) (insert "\n")) |
eb4df0c3 | 185 | (move-to-column column t) |
e6fb4d11 EN |
186 | (apply 'insert strings)) |
187 | ||
eb4df0c3 DL |
188 | (defun finder-mouse-face-on-line () |
189 | "Put a `mouse-face' property on the previous line." | |
190 | (save-excursion | |
191 | (previous-line 1) | |
192 | (put-text-property (save-excursion (beginning-of-line) (point)) | |
193 | (progn (end-of-line) (point)) | |
194 | 'mouse-face 'highlight))) | |
195 | ||
706239c7 | 196 | ;;;###autoload |
101dad14 ER |
197 | (defun finder-list-keywords () |
198 | "Display descriptions of the keywords in the Finder buffer." | |
199 | (interactive) | |
5acc847d RS |
200 | (if (get-buffer "*Finder*") |
201 | (pop-to-buffer "*Finder*") | |
b3241066 | 202 | (pop-to-buffer (set-buffer (get-buffer-create "*Finder*"))) |
5acc847d RS |
203 | (finder-mode) |
204 | (setq buffer-read-only nil) | |
205 | (erase-buffer) | |
206 | (mapcar | |
207 | (lambda (assoc) | |
208 | (let ((keyword (car assoc))) | |
209 | (insert (symbol-name keyword)) | |
210 | (finder-insert-at-column 14 (concat (cdr assoc) "\n")) | |
eb4df0c3 | 211 | (finder-mouse-face-on-line))) |
5acc847d RS |
212 | finder-known-keywords) |
213 | (goto-char (point-min)) | |
214 | (setq finder-headmark (point)) | |
215 | (setq buffer-read-only t) | |
216 | (set-buffer-modified-p nil) | |
217 | (balance-windows) | |
218 | (finder-summary))) | |
101dad14 ER |
219 | |
220 | (defun finder-list-matches (key) | |
2d7b0db7 | 221 | (pop-to-buffer (set-buffer (get-buffer-create "*Finder Category*"))) |
5acc847d | 222 | (finder-mode) |
101dad14 ER |
223 | (setq buffer-read-only nil) |
224 | (erase-buffer) | |
225 | (let ((id (intern key))) | |
226 | (insert | |
227 | "The following packages match the keyword `" key "':\n\n") | |
14931973 | 228 | (setq finder-headmark (point)) |
101dad14 | 229 | (mapcar |
e6fb4d11 EN |
230 | (lambda (x) |
231 | (if (memq id (car (cdr (cdr x)))) | |
232 | (progn | |
233 | (insert (car x)) | |
eb4df0c3 DL |
234 | (finder-insert-at-column 16 (concat (nth 1 x) "\n")) |
235 | (finder-mouse-face-on-line)))) | |
101dad14 ER |
236 | finder-package-info) |
237 | (goto-char (point-min)) | |
238 | (forward-line) | |
239 | (setq buffer-read-only t) | |
240 | (set-buffer-modified-p nil) | |
241 | (shrink-window-if-larger-than-buffer) | |
242 | (finder-summary))) | |
243 | ||
35863d77 | 244 | (defun finder-find-library (library) |
2d212d87 DL |
245 | "Search for file LIBRARY on `load-path'. |
246 | Try compressed versions if jka-compr is in use." | |
35863d77 KH |
247 | (or (locate-library library t) |
248 | (if (rassq 'jka-compr-handler file-name-handler-alist) | |
249 | (or (locate-library (concat library ".gz") t) | |
250 | (locate-library (concat library ".Z") t) | |
251 | ;; last resort for MS-DOG et al | |
252 | (locate-library (concat library "z")))))) | |
253 | ||
706239c7 | 254 | ;;;###autoload |
101dad14 | 255 | (defun finder-commentary (file) |
2d212d87 DL |
256 | "Display FILE's commentary section. |
257 | FILE should be in a form suitable for passing to `locate-library'." | |
258 | (interactive "sLibrary name: ") | |
259 | (let* ((str (lm-commentary (or (finder-find-library file) | |
260 | (finder-find-library (concat file ".el")) | |
261 | (error "Can't find library %s" file))))) | |
101dad14 | 262 | (if (null str) |
67a69ba6 | 263 | (error "Can't find any Commentary section")) |
101dad14 ER |
264 | (pop-to-buffer "*Finder*") |
265 | (setq buffer-read-only nil) | |
266 | (erase-buffer) | |
267 | (insert str) | |
268 | (goto-char (point-min)) | |
269 | (delete-blank-lines) | |
270 | (goto-char (point-max)) | |
271 | (delete-blank-lines) | |
272 | (goto-char (point-min)) | |
273 | (while (re-search-forward "^;+ ?" nil t) | |
274 | (replace-match "" nil nil)) | |
275 | (goto-char (point-min)) | |
276 | (setq buffer-read-only t) | |
277 | (set-buffer-modified-p nil) | |
278 | (shrink-window-if-larger-than-buffer) | |
8f713f53 | 279 | (finder-mode) |
e6fb4d11 | 280 | (finder-summary))) |
101dad14 ER |
281 | |
282 | (defun finder-current-item () | |
14931973 | 283 | (if (and finder-headmark (< (point) finder-headmark)) |
101dad14 ER |
284 | (error "No keyword or filename on this line") |
285 | (save-excursion | |
286 | (beginning-of-line) | |
287 | (current-word)))) | |
288 | ||
289 | (defun finder-select () | |
eb4df0c3 | 290 | "Select item on current line in a finder buffer." |
101dad14 ER |
291 | (interactive) |
292 | (let ((key (finder-current-item))) | |
f3b330d6 KH |
293 | (if (string-match "\\.el$" key) |
294 | (finder-commentary key) | |
295 | (finder-list-matches key)))) | |
296 | ||
297 | (defun finder-mouse-select (event) | |
eb4df0c3 | 298 | "Select item in a finder buffer with the mouse." |
f3b330d6 KH |
299 | (interactive "e") |
300 | (save-excursion | |
eb4df0c3 DL |
301 | (set-buffer (window-buffer (posn-window (event-start event)))) |
302 | (goto-char (posn-point (event-start event))) | |
303 | (finder-select))) | |
101dad14 | 304 | |
706239c7 | 305 | ;;;###autoload |
1164bae9 ER |
306 | (defun finder-by-keyword () |
307 | "Find packages matching a given keyword." | |
308 | (interactive) | |
101dad14 ER |
309 | (finder-list-keywords)) |
310 | ||
311 | (defun finder-mode () | |
312 | "Major mode for browsing package documentation. | |
527da106 | 313 | \\<finder-mode-map> |
101dad14 | 314 | \\[finder-select] more help for the item on the current line |
2d212d87 | 315 | \\[finder-exit] exit Finder mode and kill the Finder buffer." |
101dad14 | 316 | (interactive) |
101dad14 ER |
317 | (use-local-map finder-mode-map) |
318 | (set-syntax-table emacs-lisp-mode-syntax-table) | |
319 | (setq mode-name "Finder") | |
320 | (setq major-mode 'finder-mode) | |
14931973 | 321 | (make-local-variable 'finder-headmark) |
e6fb4d11 | 322 | (setq finder-headmark nil)) |
101dad14 ER |
323 | |
324 | (defun finder-summary () | |
325 | "Summarize basic Finder commands." | |
326 | (interactive) | |
90f061c7 | 327 | (message "%s" |
527da106 | 328 | (substitute-command-keys |
eb4df0c3 DL |
329 | "\\<finder-mode-map>\\[finder-select] = select, \ |
330 | \\[finder-mouse-select] = select, \\[finder-list-keywords] = to \ | |
331 | finder directory, \\[finder-exit] = quit, \\[finder-summary] = help"))) | |
f5a16823 | 332 | |
101dad14 | 333 | (defun finder-exit () |
35863d77 | 334 | "Exit Finder mode and kill the buffer." |
101dad14 | 335 | (interactive) |
b26f4fbd KH |
336 | (or (one-window-p t) |
337 | (delete-window)) | |
f3b330d6 | 338 | ;; Can happen in either buffer -- kill each of the two that exists |
b26f4fbd KH |
339 | (and (get-buffer "*Finder*") |
340 | (kill-buffer "*Finder*")) | |
341 | (and (get-buffer "*Finder Category*") | |
342 | (kill-buffer "*Finder Category*"))) | |
1164bae9 | 343 | |
6a7ceddc | 344 | \f |
1164bae9 ER |
345 | (provide 'finder) |
346 | ||
347 | ;;; finder.el ends here |