Commit | Line | Data |
---|---|---|
1164bae9 ER |
1 | ;;; finder.el --- topic & keyword-based code finder |
2 | ||
0dab5068 | 3 | ;; Copyright (C) 1992, 1997-1999, 2001-2014 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") |
0dab5068 GM |
75 | (wp . "word processing")) |
76 | "Association list of the standard \"Keywords:\" headers. | |
77 | Each element has the form (KEYWORD . DESCRIPTION).") | |
1164bae9 | 78 | |
79760fb2 | 79 | (defvar finder-mode-map |
2643c7aa DN |
80 | (let ((map (make-sparse-keymap)) |
81 | (menu-map (make-sparse-keymap "Finder"))) | |
79760fb2 SM |
82 | (define-key map " " 'finder-select) |
83 | (define-key map "f" 'finder-select) | |
24bdbffe | 84 | (define-key map [follow-link] 'mouse-face) |
79760fb2 SM |
85 | (define-key map [mouse-2] 'finder-mouse-select) |
86 | (define-key map "\C-m" 'finder-select) | |
87 | (define-key map "?" 'finder-summary) | |
c9fdebdf RS |
88 | (define-key map "n" 'next-line) |
89 | (define-key map "p" 'previous-line) | |
79760fb2 SM |
90 | (define-key map "q" 'finder-exit) |
91 | (define-key map "d" 'finder-list-keywords) | |
2643c7aa DN |
92 | |
93 | (define-key map [menu-bar finder-mode] | |
94 | (cons "Finder" menu-map)) | |
95 | (define-key menu-map [finder-exit] | |
96 | '(menu-item "Quit" finder-exit | |
97 | :help "Exit Finder mode")) | |
98 | (define-key menu-map [finder-summary] | |
99 | '(menu-item "Summary" finder-summary | |
100 | :help "Summary item on current line in a finder buffer")) | |
101 | (define-key menu-map [finder-list-keywords] | |
102 | '(menu-item "List keywords" finder-list-keywords | |
103 | :help "Display descriptions of the keywords in the Finder buffer")) | |
104 | (define-key menu-map [finder-select] | |
105 | '(menu-item "Select" finder-select | |
106 | :help "Select item on current line in a finder buffer")) | |
0dab5068 | 107 | map) |
43977c23 | 108 | "Keymap used in Finder mode.") |
e141acb3 | 109 | |
89e2d476 SM |
110 | (defvar finder-mode-syntax-table |
111 | (let ((st (make-syntax-table emacs-lisp-mode-syntax-table))) | |
112 | (modify-syntax-entry ?\; ". " st) | |
113 | st) | |
43977c23 | 114 | "Syntax table used while in Finder mode.") |
89e2d476 SM |
115 | |
116 | (defvar finder-font-lock-keywords | |
54e05660 | 117 | '(("`\\([^'`]+\\)'" 1 font-lock-constant-face prepend)) |
89e2d476 SM |
118 | "Font-lock keywords for Finder mode.") |
119 | ||
228b7396 | 120 | (defvar finder-headmark nil |
43977c23 | 121 | "Internal Finder mode variable, local in Finder buffer.") |
101dad14 | 122 | |
1164bae9 ER |
123 | ;;; Code for regenerating the keyword list. |
124 | ||
96ae4c8f CY |
125 | (defvar finder-keywords-hash nil |
126 | "Hash table mapping keywords to lists of package names. | |
127 | Keywords and package names both should be symbols.") | |
1164bae9 | 128 | |
9bd0d71a | 129 | (defvar generated-finder-keywords-file "finder-inf.el" |
228b7396 GM |
130 | "The function `finder-compile-keywords' writes keywords into this file.") |
131 | ||
132 | ;; Skip autogenerated files, because they will never contain anything | |
133 | ;; useful, and because in parallel builds of Emacs they may get | |
134 | ;; modified while we are trying to read them. | |
135 | ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-01/msg00469.html | |
276f10b7 GM |
136 | ;; ldefs-boot is not auto-generated, but has nothing useful. |
137 | (defvar finder-no-scan-regexp "\\(^\\.#\\|\\(loaddefs\\|ldefs-boot\\|\ | |
138 | cus-load\\|finder-inf\\|esh-groups\\|subdirs\\)\\.el$\\)" | |
228b7396 GM |
139 | "Regexp matching file names not to scan for keywords.") |
140 | ||
141 | (autoload 'autoload-rubric "autoload") | |
9bd0d71a | 142 | |
96ae4c8f CY |
143 | (defvar finder--builtins-alist |
144 | '(("calc" . calc) | |
145 | ("ede" . ede) | |
146 | ("erc" . erc) | |
147 | ("eshell" . eshell) | |
148 | ("gnus" . gnus) | |
149 | ("international" . emacs) | |
150 | ("language" . emacs) | |
151 | ("mh-e" . mh-e) | |
152 | ("semantic" . semantic) | |
153 | ("analyze" . semantic) | |
154 | ("bovine" . semantic) | |
155 | ("decorate" . semantic) | |
156 | ("symref" . semantic) | |
157 | ("wisent" . semantic) | |
158 | ("nxml" . nxml) | |
159 | ("org" . org) | |
160 | ("srecode" . srecode) | |
161 | ("term" . emacs) | |
162 | ("url" . url)) | |
163 | "Alist of built-in package directories. | |
164 | Each element should have the form (DIR . PACKAGE), where DIR is a | |
165 | directory name and PACKAGE is the name of a package (a symbol). | |
166 | When generating `package--builtins', Emacs assumes any file in | |
167 | DIR is part of the package PACKAGE.") | |
168 | ||
1164bae9 | 169 | (defun finder-compile-keywords (&rest dirs) |
96ae4c8f CY |
170 | "Regenerate list of built-in Emacs packages. |
171 | This recomputes `package--builtins' and `finder-keywords-hash', | |
172 | and prints them into the file `generated-finder-keywords-file'. | |
173 | ||
174 | Optional DIRS is a list of Emacs Lisp directories to compile | |
175 | from; the default is `load-path'." | |
176 | ;; Allow compressed files also. | |
177 | (setq package--builtins nil) | |
178 | (setq finder-keywords-hash (make-hash-table :test 'eq)) | |
179 | (let ((el-file-regexp "^\\([^=].*\\)\\.el\\(\\.\\(gz\\|Z\\)\\)?$") | |
180 | package-override files base-name processed | |
181 | summary keywords package version entry desc) | |
182 | (dolist (d (or dirs load-path)) | |
183 | (when (file-exists-p (directory-file-name d)) | |
184 | (message "Directory %s" d) | |
185 | (setq package-override | |
186 | (intern-soft | |
187 | (cdr-safe | |
188 | (assoc (file-name-nondirectory (directory-file-name d)) | |
189 | finder--builtins-alist)))) | |
190 | (setq files (directory-files d nil el-file-regexp)) | |
191 | (dolist (f files) | |
192 | (unless (or (string-match finder-no-scan-regexp f) | |
193 | (null (setq base-name | |
194 | (and (string-match el-file-regexp f) | |
195 | (intern (match-string 1 f))))) | |
196 | (memq base-name processed)) | |
197 | (push base-name processed) | |
198 | (with-temp-buffer | |
199 | (insert-file-contents (expand-file-name f d)) | |
200 | (setq summary (lm-synopsis) | |
201 | keywords (mapcar 'intern (lm-keywords-list)) | |
202 | package (or package-override | |
693c9d15 CY |
203 | (let ((str (lm-header "package"))) |
204 | (if str (intern str))) | |
96ae4c8f CY |
205 | base-name) |
206 | version (lm-header "version"))) | |
207 | (when summary | |
208 | (setq version (ignore-errors (version-to-list version))) | |
209 | (setq entry (assq package package--builtins)) | |
210 | (cond ((null entry) | |
f56be016 SM |
211 | (push (cons package |
212 | (package-make-builtin version summary)) | |
96ae4c8f CY |
213 | package--builtins)) |
214 | ((eq base-name package) | |
215 | (setq desc (cdr entry)) | |
216 | (aset desc 0 version) | |
217 | (aset desc 2 summary))) | |
218 | (dolist (kw keywords) | |
219 | (puthash kw | |
220 | (cons package | |
221 | (delq package | |
222 | (gethash kw finder-keywords-hash))) | |
223 | finder-keywords-hash)))))))) | |
224 | ||
225 | (setq package--builtins | |
226 | (sort package--builtins | |
227 | (lambda (a b) (string< (symbol-name (car a)) | |
228 | (symbol-name (car b)))))) | |
229 | ||
fde38d49 SM |
230 | (with-current-buffer |
231 | (find-file-noselect generated-finder-keywords-file) | |
54e05660 GM |
232 | (setq buffer-undo-list t) |
233 | (erase-buffer) | |
234 | (insert (autoload-rubric generated-finder-keywords-file | |
60878f2d | 235 | "keyword-to-package mapping" t)) |
54e05660 | 236 | (search-backward "\f") |
66bd25ab SM |
237 | ;; FIXME: Now that we have package--builtin-versions, package--builtins is |
238 | ;; only needed to get the list of unversioned packages and to get the | |
239 | ;; summary description of each package. | |
96ae4c8f CY |
240 | (insert "(setq package--builtins '(\n") |
241 | (dolist (package package--builtins) | |
187d3296 CY |
242 | (insert " ") |
243 | (prin1 package (current-buffer)) | |
244 | (insert "\n")) | |
245 | (insert "))\n\n") | |
96ae4c8f CY |
246 | ;; Insert hash table. |
247 | (insert "(setq finder-keywords-hash\n ") | |
248 | (prin1 finder-keywords-hash (current-buffer)) | |
249 | (insert ")\n") | |
54e05660 | 250 | (basic-save-buffer))) |
1164bae9 | 251 | |
1c6425ea RS |
252 | (defun finder-compile-keywords-make-dist () |
253 | "Regenerate `finder-inf.el' for the Emacs distribution." | |
644f58eb RS |
254 | (apply 'finder-compile-keywords command-line-args-left) |
255 | (kill-emacs)) | |
1c6425ea | 256 | |
1164bae9 ER |
257 | ;;; Now the retrieval code |
258 | ||
e6fb4d11 | 259 | (defun finder-insert-at-column (column &rest strings) |
eb4df0c3 | 260 | "Insert, at column COLUMN, other args STRINGS." |
ff524b84 | 261 | (if (>= (current-column) column) (insert "\n")) |
eb4df0c3 | 262 | (move-to-column column t) |
e6fb4d11 EN |
263 | (apply 'insert strings)) |
264 | ||
f06f7416 DL |
265 | (defvar finder-help-echo nil) |
266 | ||
eb4df0c3 | 267 | (defun finder-mouse-face-on-line () |
f06f7416 | 268 | "Put `mouse-face' and `help-echo' properties on the previous line." |
eb4df0c3 | 269 | (save-excursion |
bf8aa901 | 270 | (forward-line -1) |
54e05660 GM |
271 | ;; If finder-insert-at-column moved us to a new line, go back one more. |
272 | (if (looking-at "[ \t]") (forward-line -1)) | |
f06f7416 DL |
273 | (unless finder-help-echo |
274 | (setq finder-help-echo | |
275 | (let* ((keys1 (where-is-internal 'finder-select | |
276 | finder-mode-map)) | |
277 | (keys (nconc (where-is-internal | |
278 | 'finder-mouse-select finder-mode-map) | |
279 | keys1))) | |
280 | (concat (mapconcat 'key-description keys ", ") | |
281 | ": select item")))) | |
282 | (add-text-properties | |
283 | (line-beginning-position) (line-end-position) | |
284 | '(mouse-face highlight | |
285 | help-echo finder-help-echo)))) | |
eb4df0c3 | 286 | |
57938a79 | 287 | (defun finder-unknown-keywords () |
40b1a3a9 | 288 | "Return an alist of unknown keywords and number of their occurrences. |
96ae4c8f CY |
289 | Unknown keywords are those present in `finder-keywords-hash' but |
290 | not `finder-known-keywords'." | |
291 | (let (alist) | |
292 | (maphash (lambda (kw packages) | |
293 | (unless (assq kw finder-known-keywords) | |
294 | (push (cons kw (length packages)) alist))) | |
295 | finder-keywords-hash) | |
296 | (sort alist (lambda (a b) (string< (car a) (car b)))))) | |
57938a79 | 297 | |
706239c7 | 298 | ;;;###autoload |
101dad14 ER |
299 | (defun finder-list-keywords () |
300 | "Display descriptions of the keywords in the Finder buffer." | |
301 | (interactive) | |
5acc847d RS |
302 | (if (get-buffer "*Finder*") |
303 | (pop-to-buffer "*Finder*") | |
228b7396 | 304 | (pop-to-buffer (get-buffer-create "*Finder*")) |
5acc847d | 305 | (finder-mode) |
96ae4c8f CY |
306 | (let ((inhibit-read-only t)) |
307 | (erase-buffer) | |
308 | (dolist (assoc finder-known-keywords) | |
309 | (let ((keyword (car assoc))) | |
310 | (insert (propertize (symbol-name keyword) | |
311 | 'font-lock-face 'font-lock-constant-face)) | |
312 | (finder-insert-at-column 14 (concat (cdr assoc) "\n")) | |
313 | (finder-mouse-face-on-line))) | |
314 | (goto-char (point-min)) | |
315 | (setq finder-headmark (point) | |
316 | buffer-read-only t) | |
317 | (set-buffer-modified-p nil) | |
318 | (balance-windows) | |
319 | (finder-summary)))) | |
101dad14 ER |
320 | |
321 | (defun finder-list-matches (key) | |
96ae4c8f CY |
322 | (let* ((id (intern key)) |
323 | (packages (gethash id finder-keywords-hash))) | |
324 | (unless packages | |
325 | (error "No packages matching key `%s'" key)) | |
512e3ae1 | 326 | (package-show-package-list packages))) |
101dad14 | 327 | |
54e05660 GM |
328 | (define-button-type 'finder-xref 'action #'finder-goto-xref) |
329 | ||
330 | (defun finder-goto-xref (button) | |
331 | "Jump to a lisp file for the BUTTON at point." | |
332 | (let* ((file (button-get button 'xref)) | |
333 | (lib (locate-library file))) | |
334 | (if lib (finder-commentary lib) | |
335 | (message "Unable to locate `%s'" file)))) | |
336 | ||
706239c7 | 337 | ;;;###autoload |
101dad14 | 338 | (defun finder-commentary (file) |
2d212d87 DL |
339 | "Display FILE's commentary section. |
340 | FILE should be in a form suitable for passing to `locate-library'." | |
24d30c03 SM |
341 | (interactive |
342 | (list | |
343 | (completing-read "Library name: " | |
6a021917 SM |
344 | (apply-partially 'locate-file-completion-table |
345 | (or find-function-source-path load-path) | |
346 | (find-library-suffixes))))) | |
228b7396 GM |
347 | (let ((str (lm-commentary (find-library-name file)))) |
348 | (or str (error "Can't find any Commentary section")) | |
63fe0a98 RS |
349 | ;; This used to use *Finder* but that would clobber the |
350 | ;; directory of categories. | |
351 | (pop-to-buffer "*Finder-package*") | |
228b7396 GM |
352 | (setq buffer-read-only nil |
353 | buffer-undo-list t) | |
101dad14 ER |
354 | (erase-buffer) |
355 | (insert str) | |
356 | (goto-char (point-min)) | |
357 | (delete-blank-lines) | |
358 | (goto-char (point-max)) | |
359 | (delete-blank-lines) | |
360 | (goto-char (point-min)) | |
361 | (while (re-search-forward "^;+ ?" nil t) | |
362 | (replace-match "" nil nil)) | |
363 | (goto-char (point-min)) | |
54e05660 GM |
364 | (while (re-search-forward "\\<\\([-[:alnum:]]+\\.el\\)\\>" nil t) |
365 | (if (locate-library (match-string 1)) | |
366 | (make-text-button (match-beginning 1) (match-end 1) | |
367 | 'xref (match-string-no-properties 1) | |
368 | 'help-echo "Read this file's commentary" | |
369 | :type 'finder-xref))) | |
370 | (goto-char (point-min)) | |
101dad14 ER |
371 | (setq buffer-read-only t) |
372 | (set-buffer-modified-p nil) | |
373 | (shrink-window-if-larger-than-buffer) | |
8f713f53 | 374 | (finder-mode) |
e6fb4d11 | 375 | (finder-summary))) |
101dad14 ER |
376 | |
377 | (defun finder-current-item () | |
62832105 EZ |
378 | (let ((key (save-excursion |
379 | (beginning-of-line) | |
380 | (current-word)))) | |
381 | (if (or (and finder-headmark (< (point) finder-headmark)) | |
228b7396 | 382 | (zerop (length key))) |
62832105 EZ |
383 | (error "No keyword or filename on this line") |
384 | key))) | |
101dad14 ER |
385 | |
386 | (defun finder-select () | |
43977c23 | 387 | "Select item on current line in a Finder buffer." |
101dad14 ER |
388 | (interactive) |
389 | (let ((key (finder-current-item))) | |
f3b330d6 KH |
390 | (if (string-match "\\.el$" key) |
391 | (finder-commentary key) | |
392 | (finder-list-matches key)))) | |
393 | ||
394 | (defun finder-mouse-select (event) | |
43977c23 | 395 | "Select item in a Finder buffer with the mouse." |
f3b330d6 | 396 | (interactive "e") |
7fdbcd83 | 397 | (with-current-buffer (window-buffer (posn-window (event-start event))) |
eb4df0c3 DL |
398 | (goto-char (posn-point (event-start event))) |
399 | (finder-select))) | |
101dad14 | 400 | |
706239c7 | 401 | ;;;###autoload |
1164bae9 ER |
402 | (defun finder-by-keyword () |
403 | "Find packages matching a given keyword." | |
404 | (interactive) | |
101dad14 ER |
405 | (finder-list-keywords)) |
406 | ||
228b7396 | 407 | (define-derived-mode finder-mode nil "Finder" |
101dad14 | 408 | "Major mode for browsing package documentation. |
527da106 | 409 | \\<finder-mode-map> |
101dad14 | 410 | \\[finder-select] more help for the item on the current line |
2d212d87 | 411 | \\[finder-exit] exit Finder mode and kill the Finder buffer." |
228b7396 | 412 | :syntax-table finder-mode-syntax-table |
96ae4c8f CY |
413 | (setq buffer-read-only t |
414 | buffer-undo-list t) | |
228b7396 | 415 | (set (make-local-variable 'finder-headmark) nil)) |
101dad14 ER |
416 | |
417 | (defun finder-summary () | |
418 | "Summarize basic Finder commands." | |
419 | (interactive) | |
90f061c7 | 420 | (message "%s" |
527da106 | 421 | (substitute-command-keys |
eb4df0c3 DL |
422 | "\\<finder-mode-map>\\[finder-select] = select, \ |
423 | \\[finder-mouse-select] = select, \\[finder-list-keywords] = to \ | |
424 | finder directory, \\[finder-exit] = quit, \\[finder-summary] = help"))) | |
f5a16823 | 425 | |
101dad14 | 426 | (defun finder-exit () |
89e2d476 | 427 | "Exit Finder mode. |
228b7396 | 428 | Delete the window and kill all Finder-related buffers." |
101dad14 | 429 | (interactive) |
228b7396 | 430 | (ignore-errors (delete-window)) |
96ae4c8f CY |
431 | (let ((buf "*Finder*")) |
432 | (and (get-buffer buf) (kill-buffer buf)))) | |
1164bae9 | 433 | |
6a7ceddc | 434 | \f |
1164bae9 ER |
435 | (provide 'finder) |
436 | ||
437 | ;;; finder.el ends here |