Commit | Line | Data |
---|---|---|
1164bae9 ER |
1 | ;;; finder.el --- topic & keyword-based code finder |
2 | ||
73b0cd50 | 3 | ;; Copyright (C) 1992, 1997-1999, 2001-2011 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 | ||
eb3fa2cf | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
1164bae9 | 13 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
1164bae9 ER |
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 | |
eb3fa2cf | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
1164bae9 | 24 | |
101dad14 | 25 | ;;; Commentary: |
1164bae9 ER |
26 | |
27 | ;; This mode uses the Keywords library header to provide code-finding | |
28 | ;; services by keyword. | |
1164bae9 ER |
29 | |
30 | ;;; Code: | |
31 | ||
96ae4c8f | 32 | (require 'package) |
1164bae9 | 33 | (require 'lisp-mnt) |
187d3296 CY |
34 | (require 'find-func) ;for find-library(-suffixes) |
35 | (require 'finder-inf nil t) | |
1164bae9 | 36 | |
4f451c3f DL |
37 | ;; These are supposed to correspond to top-level customization groups, |
38 | ;; says rms. | |
1164bae9 | 39 | (defvar finder-known-keywords |
96ae4c8f CY |
40 | '((abbrev . "abbreviation handling, typing shortcuts, and macros") |
41 | (bib . "bibliography processors") | |
42 | (c . "C and related programming languages") | |
43 | (calendar . "calendar and time management tools") | |
44 | (comm . "communications, networking, and remote file access") | |
35e9c644 | 45 | (convenience . "convenience features for faster editing") |
96ae4c8f CY |
46 | (data . "editing data (non-text) files") |
47 | (docs . "Emacs documentation facilities") | |
1164bae9 ER |
48 | (emulations . "emulations of other editors") |
49 | (extensions . "Emacs Lisp language extensions") | |
96ae4c8f CY |
50 | (faces . "fonts and colors for text") |
51 | (files . "file editing and manipulation") | |
52 | (frames . "Emacs frames and window systems") | |
1164bae9 | 53 | (games . "games, jokes and amusements") |
96ae4c8f CY |
54 | (hardware . "interfacing with system hardware") |
55 | (help . "on-line help systems") | |
56 | (hypermedia . "links between text or other media types") | |
57 | (i18n . "internationalization and character-set support") | |
1164bae9 ER |
58 | (internal . "code for Emacs internals, build process, defaults") |
59 | (languages . "specialized modes for editing programming languages") | |
60 | (lisp . "Lisp support, including Emacs Lisp") | |
61 | (local . "code local to your site") | |
96ae4c8f CY |
62 | (maint . "Emacs development tools and aids") |
63 | (mail . "email reading and posting") | |
64 | (matching . "searching, matching, and sorting") | |
be2c35e4 | 65 | (mouse . "mouse support") |
96ae4c8f CY |
66 | (multimedia . "images and sound") |
67 | (news . "USENET news reading and posting") | |
68 | (outlines . "hierarchical outlining and note taking") | |
69 | (processes . "processes, subshells, and compilation") | |
70 | (terminals . "text terminals (ttys)") | |
71 | (tex . "the TeX document formatter") | |
1164bae9 | 72 | (tools . "programming tools") |
96ae4c8f | 73 | (unix . "UNIX feature interfaces and emulators") |
9766adfb | 74 | (vc . "version control") |
96ae4c8f | 75 | (wp . "word processing"))) |
1164bae9 | 76 | |
79760fb2 | 77 | (defvar finder-mode-map |
2643c7aa DN |
78 | (let ((map (make-sparse-keymap)) |
79 | (menu-map (make-sparse-keymap "Finder"))) | |
79760fb2 SM |
80 | (define-key map " " 'finder-select) |
81 | (define-key map "f" 'finder-select) | |
24bdbffe | 82 | (define-key map [follow-link] 'mouse-face) |
79760fb2 SM |
83 | (define-key map [mouse-2] 'finder-mouse-select) |
84 | (define-key map "\C-m" 'finder-select) | |
85 | (define-key map "?" 'finder-summary) | |
c9fdebdf RS |
86 | (define-key map "n" 'next-line) |
87 | (define-key map "p" 'previous-line) | |
79760fb2 SM |
88 | (define-key map "q" 'finder-exit) |
89 | (define-key map "d" 'finder-list-keywords) | |
2643c7aa DN |
90 | |
91 | (define-key map [menu-bar finder-mode] | |
92 | (cons "Finder" menu-map)) | |
93 | (define-key menu-map [finder-exit] | |
94 | '(menu-item "Quit" finder-exit | |
95 | :help "Exit Finder mode")) | |
96 | (define-key menu-map [finder-summary] | |
97 | '(menu-item "Summary" finder-summary | |
98 | :help "Summary item on current line in a finder buffer")) | |
99 | (define-key menu-map [finder-list-keywords] | |
100 | '(menu-item "List keywords" finder-list-keywords | |
101 | :help "Display descriptions of the keywords in the Finder buffer")) | |
102 | (define-key menu-map [finder-select] | |
103 | '(menu-item "Select" finder-select | |
104 | :help "Select item on current line in a finder buffer")) | |
79760fb2 | 105 | map)) |
e141acb3 | 106 | |
89e2d476 SM |
107 | (defvar finder-mode-syntax-table |
108 | (let ((st (make-syntax-table emacs-lisp-mode-syntax-table))) | |
109 | (modify-syntax-entry ?\; ". " st) | |
110 | st) | |
111 | "Syntax table used while in `finder-mode'.") | |
112 | ||
113 | (defvar finder-font-lock-keywords | |
54e05660 | 114 | '(("`\\([^'`]+\\)'" 1 font-lock-constant-face prepend)) |
89e2d476 SM |
115 | "Font-lock keywords for Finder mode.") |
116 | ||
228b7396 GM |
117 | (defvar finder-headmark nil |
118 | "Internal finder-mode variable, local in finder buffer.") | |
101dad14 | 119 | |
1164bae9 ER |
120 | ;;; Code for regenerating the keyword list. |
121 | ||
96ae4c8f CY |
122 | (defvar finder-keywords-hash nil |
123 | "Hash table mapping keywords to lists of package names. | |
124 | Keywords and package names both should be symbols.") | |
1164bae9 | 125 | |
9bd0d71a | 126 | (defvar generated-finder-keywords-file "finder-inf.el" |
228b7396 GM |
127 | "The function `finder-compile-keywords' writes keywords into this file.") |
128 | ||
129 | ;; Skip autogenerated files, because they will never contain anything | |
130 | ;; useful, and because in parallel builds of Emacs they may get | |
131 | ;; modified while we are trying to read them. | |
132 | ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-01/msg00469.html | |
276f10b7 GM |
133 | ;; ldefs-boot is not auto-generated, but has nothing useful. |
134 | (defvar finder-no-scan-regexp "\\(^\\.#\\|\\(loaddefs\\|ldefs-boot\\|\ | |
135 | cus-load\\|finder-inf\\|esh-groups\\|subdirs\\)\\.el$\\)" | |
228b7396 GM |
136 | "Regexp matching file names not to scan for keywords.") |
137 | ||
138 | (autoload 'autoload-rubric "autoload") | |
9bd0d71a | 139 | |
96ae4c8f CY |
140 | (defvar finder--builtins-alist |
141 | '(("calc" . calc) | |
142 | ("ede" . ede) | |
143 | ("erc" . erc) | |
144 | ("eshell" . eshell) | |
145 | ("gnus" . gnus) | |
146 | ("international" . emacs) | |
147 | ("language" . emacs) | |
148 | ("mh-e" . mh-e) | |
149 | ("semantic" . semantic) | |
150 | ("analyze" . semantic) | |
151 | ("bovine" . semantic) | |
152 | ("decorate" . semantic) | |
153 | ("symref" . semantic) | |
154 | ("wisent" . semantic) | |
155 | ("nxml" . nxml) | |
156 | ("org" . org) | |
157 | ("srecode" . srecode) | |
158 | ("term" . emacs) | |
159 | ("url" . url)) | |
160 | "Alist of built-in package directories. | |
161 | Each element should have the form (DIR . PACKAGE), where DIR is a | |
162 | directory name and PACKAGE is the name of a package (a symbol). | |
163 | When generating `package--builtins', Emacs assumes any file in | |
164 | DIR is part of the package PACKAGE.") | |
165 | ||
1164bae9 | 166 | (defun finder-compile-keywords (&rest dirs) |
96ae4c8f CY |
167 | "Regenerate list of built-in Emacs packages. |
168 | This recomputes `package--builtins' and `finder-keywords-hash', | |
169 | and prints them into the file `generated-finder-keywords-file'. | |
170 | ||
171 | Optional DIRS is a list of Emacs Lisp directories to compile | |
172 | from; the default is `load-path'." | |
173 | ;; Allow compressed files also. | |
174 | (setq package--builtins nil) | |
175 | (setq finder-keywords-hash (make-hash-table :test 'eq)) | |
176 | (let ((el-file-regexp "^\\([^=].*\\)\\.el\\(\\.\\(gz\\|Z\\)\\)?$") | |
177 | package-override files base-name processed | |
178 | summary keywords package version entry desc) | |
179 | (dolist (d (or dirs load-path)) | |
180 | (when (file-exists-p (directory-file-name d)) | |
181 | (message "Directory %s" d) | |
182 | (setq package-override | |
183 | (intern-soft | |
184 | (cdr-safe | |
185 | (assoc (file-name-nondirectory (directory-file-name d)) | |
186 | finder--builtins-alist)))) | |
187 | (setq files (directory-files d nil el-file-regexp)) | |
188 | (dolist (f files) | |
189 | (unless (or (string-match finder-no-scan-regexp f) | |
190 | (null (setq base-name | |
191 | (and (string-match el-file-regexp f) | |
192 | (intern (match-string 1 f))))) | |
193 | (memq base-name processed)) | |
194 | (push base-name processed) | |
195 | (with-temp-buffer | |
196 | (insert-file-contents (expand-file-name f d)) | |
197 | (setq summary (lm-synopsis) | |
198 | keywords (mapcar 'intern (lm-keywords-list)) | |
199 | package (or package-override | |
693c9d15 CY |
200 | (let ((str (lm-header "package"))) |
201 | (if str (intern str))) | |
96ae4c8f CY |
202 | base-name) |
203 | version (lm-header "version"))) | |
204 | (when summary | |
205 | (setq version (ignore-errors (version-to-list version))) | |
206 | (setq entry (assq package package--builtins)) | |
207 | (cond ((null entry) | |
208 | (push (cons package (vector version nil summary)) | |
209 | package--builtins)) | |
210 | ((eq base-name package) | |
211 | (setq desc (cdr entry)) | |
212 | (aset desc 0 version) | |
213 | (aset desc 2 summary))) | |
214 | (dolist (kw keywords) | |
215 | (puthash kw | |
216 | (cons package | |
217 | (delq package | |
218 | (gethash kw finder-keywords-hash))) | |
219 | finder-keywords-hash)))))))) | |
220 | ||
221 | (setq package--builtins | |
222 | (sort package--builtins | |
223 | (lambda (a b) (string< (symbol-name (car a)) | |
224 | (symbol-name (car b)))))) | |
225 | ||
1164bae9 | 226 | (save-excursion |
54e05660 GM |
227 | (find-file generated-finder-keywords-file) |
228 | (setq buffer-undo-list t) | |
229 | (erase-buffer) | |
230 | (insert (autoload-rubric generated-finder-keywords-file | |
60878f2d | 231 | "keyword-to-package mapping" t)) |
54e05660 | 232 | (search-backward "\f") |
96ae4c8f CY |
233 | (insert "(setq package--builtins '(\n") |
234 | (dolist (package package--builtins) | |
187d3296 CY |
235 | (insert " ") |
236 | (prin1 package (current-buffer)) | |
237 | (insert "\n")) | |
238 | (insert "))\n\n") | |
96ae4c8f CY |
239 | ;; Insert hash table. |
240 | (insert "(setq finder-keywords-hash\n ") | |
241 | (prin1 finder-keywords-hash (current-buffer)) | |
242 | (insert ")\n") | |
54e05660 | 243 | (basic-save-buffer))) |
1164bae9 | 244 | |
1c6425ea RS |
245 | (defun finder-compile-keywords-make-dist () |
246 | "Regenerate `finder-inf.el' for the Emacs distribution." | |
644f58eb RS |
247 | (apply 'finder-compile-keywords command-line-args-left) |
248 | (kill-emacs)) | |
1c6425ea | 249 | |
1164bae9 ER |
250 | ;;; Now the retrieval code |
251 | ||
e6fb4d11 | 252 | (defun finder-insert-at-column (column &rest strings) |
eb4df0c3 | 253 | "Insert, at column COLUMN, other args STRINGS." |
ff524b84 | 254 | (if (>= (current-column) column) (insert "\n")) |
eb4df0c3 | 255 | (move-to-column column t) |
e6fb4d11 EN |
256 | (apply 'insert strings)) |
257 | ||
f06f7416 DL |
258 | (defvar finder-help-echo nil) |
259 | ||
eb4df0c3 | 260 | (defun finder-mouse-face-on-line () |
f06f7416 | 261 | "Put `mouse-face' and `help-echo' properties on the previous line." |
eb4df0c3 | 262 | (save-excursion |
bf8aa901 | 263 | (forward-line -1) |
54e05660 GM |
264 | ;; If finder-insert-at-column moved us to a new line, go back one more. |
265 | (if (looking-at "[ \t]") (forward-line -1)) | |
f06f7416 DL |
266 | (unless finder-help-echo |
267 | (setq finder-help-echo | |
268 | (let* ((keys1 (where-is-internal 'finder-select | |
269 | finder-mode-map)) | |
270 | (keys (nconc (where-is-internal | |
271 | 'finder-mouse-select finder-mode-map) | |
272 | keys1))) | |
273 | (concat (mapconcat 'key-description keys ", ") | |
274 | ": select item")))) | |
275 | (add-text-properties | |
276 | (line-beginning-position) (line-end-position) | |
277 | '(mouse-face highlight | |
278 | help-echo finder-help-echo)))) | |
eb4df0c3 | 279 | |
57938a79 | 280 | (defun finder-unknown-keywords () |
40b1a3a9 | 281 | "Return an alist of unknown keywords and number of their occurrences. |
96ae4c8f CY |
282 | Unknown keywords are those present in `finder-keywords-hash' but |
283 | not `finder-known-keywords'." | |
284 | (let (alist) | |
285 | (maphash (lambda (kw packages) | |
286 | (unless (assq kw finder-known-keywords) | |
287 | (push (cons kw (length packages)) alist))) | |
288 | finder-keywords-hash) | |
289 | (sort alist (lambda (a b) (string< (car a) (car b)))))) | |
57938a79 | 290 | |
706239c7 | 291 | ;;;###autoload |
101dad14 ER |
292 | (defun finder-list-keywords () |
293 | "Display descriptions of the keywords in the Finder buffer." | |
294 | (interactive) | |
5acc847d RS |
295 | (if (get-buffer "*Finder*") |
296 | (pop-to-buffer "*Finder*") | |
228b7396 | 297 | (pop-to-buffer (get-buffer-create "*Finder*")) |
5acc847d | 298 | (finder-mode) |
96ae4c8f CY |
299 | (let ((inhibit-read-only t)) |
300 | (erase-buffer) | |
301 | (dolist (assoc finder-known-keywords) | |
302 | (let ((keyword (car assoc))) | |
303 | (insert (propertize (symbol-name keyword) | |
304 | 'font-lock-face 'font-lock-constant-face)) | |
305 | (finder-insert-at-column 14 (concat (cdr assoc) "\n")) | |
306 | (finder-mouse-face-on-line))) | |
307 | (goto-char (point-min)) | |
308 | (setq finder-headmark (point) | |
309 | buffer-read-only t) | |
310 | (set-buffer-modified-p nil) | |
311 | (balance-windows) | |
312 | (finder-summary)))) | |
101dad14 ER |
313 | |
314 | (defun finder-list-matches (key) | |
96ae4c8f CY |
315 | (let* ((id (intern key)) |
316 | (packages (gethash id finder-keywords-hash))) | |
317 | (unless packages | |
318 | (error "No packages matching key `%s'" key)) | |
512e3ae1 | 319 | (package-show-package-list packages))) |
101dad14 | 320 | |
54e05660 GM |
321 | (define-button-type 'finder-xref 'action #'finder-goto-xref) |
322 | ||
323 | (defun finder-goto-xref (button) | |
324 | "Jump to a lisp file for the BUTTON at point." | |
325 | (let* ((file (button-get button 'xref)) | |
326 | (lib (locate-library file))) | |
327 | (if lib (finder-commentary lib) | |
328 | (message "Unable to locate `%s'" file)))) | |
329 | ||
706239c7 | 330 | ;;;###autoload |
101dad14 | 331 | (defun finder-commentary (file) |
2d212d87 DL |
332 | "Display FILE's commentary section. |
333 | FILE should be in a form suitable for passing to `locate-library'." | |
24d30c03 SM |
334 | (interactive |
335 | (list | |
336 | (completing-read "Library name: " | |
6a021917 SM |
337 | (apply-partially 'locate-file-completion-table |
338 | (or find-function-source-path load-path) | |
339 | (find-library-suffixes))))) | |
228b7396 GM |
340 | (let ((str (lm-commentary (find-library-name file)))) |
341 | (or str (error "Can't find any Commentary section")) | |
63fe0a98 RS |
342 | ;; This used to use *Finder* but that would clobber the |
343 | ;; directory of categories. | |
344 | (pop-to-buffer "*Finder-package*") | |
228b7396 GM |
345 | (setq buffer-read-only nil |
346 | buffer-undo-list t) | |
101dad14 ER |
347 | (erase-buffer) |
348 | (insert str) | |
349 | (goto-char (point-min)) | |
350 | (delete-blank-lines) | |
351 | (goto-char (point-max)) | |
352 | (delete-blank-lines) | |
353 | (goto-char (point-min)) | |
354 | (while (re-search-forward "^;+ ?" nil t) | |
355 | (replace-match "" nil nil)) | |
356 | (goto-char (point-min)) | |
54e05660 GM |
357 | (while (re-search-forward "\\<\\([-[:alnum:]]+\\.el\\)\\>" nil t) |
358 | (if (locate-library (match-string 1)) | |
359 | (make-text-button (match-beginning 1) (match-end 1) | |
360 | 'xref (match-string-no-properties 1) | |
361 | 'help-echo "Read this file's commentary" | |
362 | :type 'finder-xref))) | |
363 | (goto-char (point-min)) | |
101dad14 ER |
364 | (setq buffer-read-only t) |
365 | (set-buffer-modified-p nil) | |
366 | (shrink-window-if-larger-than-buffer) | |
8f713f53 | 367 | (finder-mode) |
e6fb4d11 | 368 | (finder-summary))) |
101dad14 ER |
369 | |
370 | (defun finder-current-item () | |
62832105 EZ |
371 | (let ((key (save-excursion |
372 | (beginning-of-line) | |
373 | (current-word)))) | |
374 | (if (or (and finder-headmark (< (point) finder-headmark)) | |
228b7396 | 375 | (zerop (length key))) |
62832105 EZ |
376 | (error "No keyword or filename on this line") |
377 | key))) | |
101dad14 ER |
378 | |
379 | (defun finder-select () | |
eb4df0c3 | 380 | "Select item on current line in a finder buffer." |
101dad14 ER |
381 | (interactive) |
382 | (let ((key (finder-current-item))) | |
f3b330d6 KH |
383 | (if (string-match "\\.el$" key) |
384 | (finder-commentary key) | |
385 | (finder-list-matches key)))) | |
386 | ||
387 | (defun finder-mouse-select (event) | |
eb4df0c3 | 388 | "Select item in a finder buffer with the mouse." |
f3b330d6 | 389 | (interactive "e") |
7fdbcd83 | 390 | (with-current-buffer (window-buffer (posn-window (event-start event))) |
eb4df0c3 DL |
391 | (goto-char (posn-point (event-start event))) |
392 | (finder-select))) | |
101dad14 | 393 | |
706239c7 | 394 | ;;;###autoload |
1164bae9 ER |
395 | (defun finder-by-keyword () |
396 | "Find packages matching a given keyword." | |
397 | (interactive) | |
101dad14 ER |
398 | (finder-list-keywords)) |
399 | ||
228b7396 | 400 | (define-derived-mode finder-mode nil "Finder" |
101dad14 | 401 | "Major mode for browsing package documentation. |
527da106 | 402 | \\<finder-mode-map> |
101dad14 | 403 | \\[finder-select] more help for the item on the current line |
2d212d87 | 404 | \\[finder-exit] exit Finder mode and kill the Finder buffer." |
228b7396 | 405 | :syntax-table finder-mode-syntax-table |
96ae4c8f CY |
406 | (setq buffer-read-only t |
407 | buffer-undo-list t) | |
228b7396 | 408 | (set (make-local-variable 'finder-headmark) nil)) |
101dad14 ER |
409 | |
410 | (defun finder-summary () | |
411 | "Summarize basic Finder commands." | |
412 | (interactive) | |
90f061c7 | 413 | (message "%s" |
527da106 | 414 | (substitute-command-keys |
eb4df0c3 DL |
415 | "\\<finder-mode-map>\\[finder-select] = select, \ |
416 | \\[finder-mouse-select] = select, \\[finder-list-keywords] = to \ | |
417 | finder directory, \\[finder-exit] = quit, \\[finder-summary] = help"))) | |
f5a16823 | 418 | |
101dad14 | 419 | (defun finder-exit () |
89e2d476 | 420 | "Exit Finder mode. |
228b7396 | 421 | Delete the window and kill all Finder-related buffers." |
101dad14 | 422 | (interactive) |
228b7396 | 423 | (ignore-errors (delete-window)) |
96ae4c8f CY |
424 | (let ((buf "*Finder*")) |
425 | (and (get-buffer buf) (kill-buffer buf)))) | |
1164bae9 | 426 | |
6a7ceddc | 427 | \f |
1164bae9 ER |
428 | (provide 'finder) |
429 | ||
430 | ;;; finder.el ends here |