1 ;;; finder.el --- topic & keyword-based code finder
3 ;; Copyright (C) 1992, 1997-1999, 2001-2014 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Created: 16 Jun 1992
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 3 of the License, or
15 ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>.
27 ;; This mode uses the Keywords library header to provide code-finding
28 ;; services by keyword.
34 (require 'find-func
) ;for find-library(-suffixes)
35 (require 'finder-inf nil t
)
37 ;; These are supposed to correspond to top-level customization groups,
39 (defvar finder-known-keywords
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")
45 (convenience .
"convenience features for faster editing")
46 (data .
"editing data (non-text) files")
47 (docs .
"Emacs documentation facilities")
48 (emulations .
"emulations of other editors")
49 (extensions .
"Emacs Lisp language extensions")
50 (faces .
"fonts and colors for text")
51 (files .
"file editing and manipulation")
52 (frames .
"Emacs frames and window systems")
53 (games .
"games, jokes and amusements")
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")
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")
62 (maint .
"Emacs development tools and aids")
63 (mail .
"email reading and posting")
64 (matching .
"searching, matching, and sorting")
65 (mouse .
"mouse support")
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")
72 (tools .
"programming tools")
73 (unix .
"UNIX feature interfaces and emulators")
74 (vc .
"version control")
75 (wp .
"word processing"))
76 "Association list of the standard \"Keywords:\" headers.
77 Each element has the form (KEYWORD . DESCRIPTION).")
79 (defvar finder-mode-map
80 (let ((map (make-sparse-keymap))
81 (menu-map (make-sparse-keymap "Finder")))
82 (define-key map
" " 'finder-select
)
83 (define-key map
"f" 'finder-select
)
84 (define-key map
[follow-link
] 'mouse-face
)
85 (define-key map
[mouse-2
] 'finder-mouse-select
)
86 (define-key map
"\C-m" 'finder-select
)
87 (define-key map
"?" 'finder-summary
)
88 (define-key map
"n" 'next-line
)
89 (define-key map
"p" 'previous-line
)
90 (define-key map
"q" 'finder-exit
)
91 (define-key map
"d" 'finder-list-keywords
)
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"))
108 "Keymap used in `finder-mode'.")
110 (defvar finder-mode-syntax-table
111 (let ((st (make-syntax-table emacs-lisp-mode-syntax-table
)))
112 (modify-syntax-entry ?\
; ". " st)
114 "Syntax table used while in `finder-mode'.")
116 (defvar finder-font-lock-keywords
117 '(("`\\([^'`]+\\)'" 1 font-lock-constant-face prepend
))
118 "Font-lock keywords for Finder mode.")
120 (defvar finder-headmark nil
121 "Internal Finder mode variable, local in Finder buffer.")
123 ;;; Code for regenerating the keyword list.
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.")
129 (defvar generated-finder-keywords-file
"finder-inf.el"
130 "The function `finder-compile-keywords' writes keywords into this file.")
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
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$\\)"
139 "Regexp matching file names not to scan for keywords.")
141 (autoload 'autoload-rubric
"autoload")
143 (defvar finder--builtins-alist
149 ("international" . emacs
)
152 ("semantic" . semantic
)
153 ("analyze" . semantic
)
154 ("bovine" . semantic
)
155 ("decorate" . semantic
)
156 ("symref" . semantic
)
157 ("wisent" . semantic
)
160 ("srecode" . srecode
)
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.")
169 (defun finder-compile-keywords (&rest dirs
)
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'.
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
188 (assoc (file-name-nondirectory (directory-file-name d
))
189 finder--builtins-alist
))))
190 (setq files
(directory-files d nil el-file-regexp
))
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
)
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
203 (let ((str (lm-header "package")))
204 (if str
(intern str
)))
206 version
(lm-header "version")))
208 (setq version
(ignore-errors (version-to-list version
)))
209 (setq entry
(assq package package--builtins
))
212 (package-make-builtin version summary
))
214 ((eq base-name package
)
215 (setq desc
(cdr entry
))
216 (aset desc
0 version
)
217 (aset desc
2 summary
)))
218 (dolist (kw keywords
)
222 (gethash kw finder-keywords-hash
)))
223 finder-keywords-hash
))))))))
225 (setq package--builtins
226 (sort package--builtins
227 (lambda (a b
) (string< (symbol-name (car a
))
228 (symbol-name (car b
))))))
231 (find-file-noselect generated-finder-keywords-file
)
232 (setq buffer-undo-list t
)
234 (insert (autoload-rubric generated-finder-keywords-file
235 "keyword-to-package mapping" t
))
236 (search-backward "\f")
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.
240 (insert "(setq package--builtins '(\n")
241 (dolist (package package--builtins
)
243 (prin1 package
(current-buffer))
246 ;; Insert hash table.
247 (insert "(setq finder-keywords-hash\n ")
248 (prin1 finder-keywords-hash
(current-buffer))
250 (basic-save-buffer)))
252 (defun finder-compile-keywords-make-dist ()
253 "Regenerate `finder-inf.el' for the Emacs distribution."
254 (apply 'finder-compile-keywords command-line-args-left
)
257 ;;; Now the retrieval code
259 (defun finder-insert-at-column (column &rest strings
)
260 "Insert, at column COLUMN, other args STRINGS."
261 (if (>= (current-column) column
) (insert "\n"))
262 (move-to-column column t
)
263 (apply 'insert strings
))
265 (defvar finder-help-echo nil
)
267 (defun finder-mouse-face-on-line ()
268 "Put `mouse-face' and `help-echo' properties on the previous line."
271 ;; If finder-insert-at-column moved us to a new line, go back one more.
272 (if (looking-at "[ \t]") (forward-line -
1))
273 (unless finder-help-echo
274 (setq finder-help-echo
275 (let* ((keys1 (where-is-internal 'finder-select
277 (keys (nconc (where-is-internal
278 'finder-mouse-select finder-mode-map
)
280 (concat (mapconcat 'key-description keys
", ")
283 (line-beginning-position) (line-end-position)
284 '(mouse-face highlight
285 help-echo finder-help-echo
))))
287 (defun finder-unknown-keywords ()
288 "Return an alist of unknown keywords and number of their occurrences.
289 Unknown keywords are those present in `finder-keywords-hash' but
290 not `finder-known-keywords'."
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
))))))
299 (defun finder-list-keywords ()
300 "Display descriptions of the keywords in the Finder buffer."
302 (if (get-buffer "*Finder*")
303 (pop-to-buffer "*Finder*")
304 (pop-to-buffer (get-buffer-create "*Finder*"))
306 (let ((inhibit-read-only t
))
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)
317 (set-buffer-modified-p nil
)
321 (defun finder-list-matches (key)
322 (let* ((id (intern key
))
323 (packages (gethash id finder-keywords-hash
)))
325 (error "No packages matching key `%s'" key
))
326 (package-show-package-list packages
)))
328 (define-button-type 'finder-xref
'action
#'finder-goto-xref
)
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
))))
338 (defun finder-commentary (file)
339 "Display FILE's commentary section.
340 FILE should be in a form suitable for passing to `locate-library'."
343 (completing-read "Library name: "
344 (apply-partially 'locate-file-completion-table
345 (or find-function-source-path load-path
)
346 (find-library-suffixes)))))
347 (let ((str (lm-commentary (find-library-name file
))))
348 (or str
(error "Can't find any Commentary section"))
349 ;; This used to use *Finder* but that would clobber the
350 ;; directory of categories.
351 (pop-to-buffer "*Finder-package*")
352 (setq buffer-read-only nil
356 (goto-char (point-min))
358 (goto-char (point-max))
360 (goto-char (point-min))
361 (while (re-search-forward "^;+ ?" nil t
)
362 (replace-match "" nil nil
))
363 (goto-char (point-min))
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))
371 (setq buffer-read-only t
)
372 (set-buffer-modified-p nil
)
373 (shrink-window-if-larger-than-buffer)
377 (defun finder-current-item ()
378 (let ((key (save-excursion
381 (if (or (and finder-headmark
(< (point) finder-headmark
))
382 (zerop (length key
)))
383 (error "No keyword or filename on this line")
386 (defun finder-select ()
387 "Select item on current line in a Finder buffer."
389 (let ((key (finder-current-item)))
390 (if (string-match "\\.el$" key
)
391 (finder-commentary key
)
392 (finder-list-matches key
))))
394 (defun finder-mouse-select (event)
395 "Select item in a Finder buffer with the mouse."
397 (with-current-buffer (window-buffer (posn-window (event-start event
)))
398 (goto-char (posn-point (event-start event
)))
402 (defun finder-by-keyword ()
403 "Find packages matching a given keyword."
405 (finder-list-keywords))
407 (define-derived-mode finder-mode nil
"Finder"
408 "Major mode for browsing package documentation.
410 \\[finder-select] more help for the item on the current line
411 \\[finder-exit] exit Finder mode and kill the Finder buffer."
412 :syntax-table finder-mode-syntax-table
413 (setq buffer-read-only t
415 (set (make-local-variable 'finder-headmark
) nil
))
417 (defun finder-summary ()
418 "Summarize basic Finder commands."
421 (substitute-command-keys
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")))
426 (defun finder-exit ()
428 Delete the window and kill all Finder-related buffers."
430 (ignore-errors (delete-window))
431 (let ((buf "*Finder*"))
432 (and (get-buffer buf
) (kill-buffer buf
))))
434 (defun finder-unload-function ()
435 "Unload the Finder library."
436 (with-demoted-errors (unload-feature 'finder-inf t
))
437 ;; continue standard unloading
443 ;;; finder.el ends here