1 ;;; finder.el --- topic & keyword-based code finder
3 ;; Copyright (C) 1992 Free Software Foundation, Inc.
5 ;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 ;; Created: 16 Jun 1992
9 ;; X-Modified-by: Bob Weiner <weiner@mot.com>, 4/18/95, to include Lisp
10 ;; library directory names in finder-program-info, for fast display of
11 ;; Lisp libraries and associated commentaries. Added {v}, finder-view,
12 ;; and {e}, finder-edit commands for displaying libraries.
14 ;; Added user variable, 'finder-abbreviate-directory-list', used to
15 ;; abbreviate directories before they are saved to finder-program-info.
16 ;; Such relative directories can be portable from one Emacs installation
17 ;; to another. Default value is based upon the value of Emacs'
18 ;; data-directory variable.
20 ;; This file is part of SXEmacs.
22 ;; SXEmacs is free software: you can redistribute it and/or modify
23 ;; it under the terms of the GNU General Public License as published by
24 ;; the Free Software Foundation, either version 3 of the License, or
25 ;; (at your option) any later version.
27 ;; SXEmacs is distributed in the hope that it will be useful,
28 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
29 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 ;; GNU General Public License for more details.
32 ;; You should have received a copy of the GNU General Public License
33 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
35 ;;; Synched up with: FSF 19.34.
39 ;; This mode uses the Keywords library header to provide code-finding
40 ;; services by keyword.
43 ;; 1. Support multiple keywords per search. This could be extremely hairy;
44 ;; there doesn't seem to be any way to get completing-read to exit on
45 ;; an EOL with no substring pending, which is what we'd want to end the loop.
46 ;; 2. Search by string in synopsis line?
47 ;; 3. Function to check finder-package-info for unknown keywords.
57 (require 'mode-motion)
59 (defvar finder-emacs-root-directory
60 (file-name-directory (directory-file-name data-directory))
61 "Root directory of current emacs tree.")
63 (defvar finder-abbreviate-directory-list
64 (list finder-emacs-root-directory)
65 "*List of directory roots to remove from finder-package-info directory entries.
66 The first element in the list is used when expanding relative package
67 directories to view or extract information from package source code.")
69 (defvar finder-file-regexp "\\.el$"
70 "Regexp which matches file names but not Emacs Lisp finder keywords.")
72 ;; Local variable in finder buffer.
73 (defvar finder-headmark)
75 (defvar finder-known-keywords
77 (abbrev . "abbreviation handling, typing shortcuts, macros")
78 (bib . "code related to the `bib' bibliography processor")
79 (build . "code used to build XEmacs")
80 (c . "C, C++, and Objective-C language support")
81 (calendar . "calendar and time management support")
82 (comm . "communications, networking, remote access to files")
83 (content . "contains content (menu/dialog box descs, text, images, &c)")
84 (data . "support for editing files of data")
85 (docs . "support for XEmacs documentation")
86 (dumped . "files preloaded into XEmacs")
87 (emulations . "emulations of other editors")
88 (extensions . "Emacs Lisp language extensions")
89 (faces . "support for multiple fonts")
90 ,(when (fboundp #'ffi-defun)
91 (cons 'ffi "foreign function interface"))
92 (frames . "support for XEmacs frames and window systems")
93 (games . "games, jokes and amusements")
94 (gui . "support for menubars, dialog boxes, and other GUI features")
95 (hardware . "support for interfacing with exotic hardware")
96 (help . "support for on-line help systems")
97 (hypermedia . "support for links between text or other media types")
98 (i18n . "internationalization and alternate character-set support")
99 (internal . "code implementing core functionality in XEmacs")
100 (languages . "specialized modes for editing programming languages")
101 (lisp . "Lisp support, including Emacs Lisp")
102 (local . "code local to your site")
103 (mail . "modes for electronic-mail handling")
104 (maint . "maintenance aids for the Emacs development group")
105 (matching . "various sorts of searching and matching")
106 (mouse . "mouse support")
107 ,(when (featurep 'mule)
108 (cons 'mule "multi-language extensions"))
109 (news . "support for netnews reading and posting")
110 (oop . "support for object-oriented programming")
111 (outlines . "support for hierarchical outlining")
112 (processes . "process, subshell, compilation, and job control support")
113 (services . "provides services for use by other programs (cf `user')")
114 (terminals . "support for terminal types")
115 (tex . "code related to the TeX formatter")
116 (tools . "programming tools")
117 (unix . "front-ends/assistants for, or emulators of, UNIX features")
118 (user . "program interacts directly with the user (cf `services'")
119 (vms . "support code for vms")
120 (wp . "word processing")
121 (www . "support for the Web (WWW, the World Wide Web)")
124 (defvar finder-mode-map nil)
126 (let ((map (make-sparse-keymap)))
127 (define-key map " " 'finder-select)
128 (define-key map "f" 'finder-select)
129 (define-key map "\C-m" 'finder-select)
131 (define-key map "e" 'finder-edit)
132 (define-key map "v" 'finder-view)
133 (define-key map "?" 'finder-summary)
134 (define-key map "q" 'finder-exit)
135 (define-key map "d" 'finder-list-keywords)
137 (define-key map [button2] 'finder-mouse-select)
138 (setq finder-mode-map map)))
141 ;;; Code for regenerating the keyword list.
143 (defvar finder-package-info nil
144 "Assoc list mapping file names to description & keyword lists.")
146 (defvar finder-compile-keywords-quiet nil
147 "If non-nil finder-compile-keywords will not print any messages.")
149 (defun finder-compile-keywords (&rest dirs)
150 "Regenerate the keywords association list into the file `finder-inf.el'.
151 Optional arguments are a list of Emacs Lisp directories to compile from; no
152 arguments compiles from `load-path'."
155 (find-file "finder-inf.el")
156 (let ((processed nil)
157 (directory-abbrev-alist
159 (mapcar (function (lambda (dir)
160 (cons (concat "^" (regexp-quote dir))
162 finder-abbreviate-directory-list)
163 directory-abbrev-alist))
165 (or dirs (setq dirs load-path))
166 (setq using-load-path (equal dirs load-path))
168 (insert ";;; finder-inf.el --- keyword-to-package mapping\n")
169 (insert ";; Keywords: help\n")
170 (insert ";;; Commentary:\n")
171 (insert ";; Don't edit this file. It's generated by finder.el\n\n")
172 (insert ";;; Code:\n")
173 (insert "\n(defconst finder-package-info '(\n")
178 (let ((exhau-f (expand-file-name f d)))
179 (when (and (not (member f processed))
180 (file-readable-p exhau-f))
181 (let (summary keystart keywords)
182 (setq processed (cons f processed))
183 (if (not finder-compile-keywords-quiet)
184 (message "Processing %s ..." f))
186 (set-buffer (get-buffer-create "*finder-scratch*"))
187 (buffer-disable-undo (current-buffer))
189 (insert-file-contents (expand-file-name f d))
191 (setq summary (lm-synopsis)
192 keywords (lm-keywords))
193 (t (message "finder: error processing %s %S" f err))))
195 (insert (format " (\"%s\"\n " f))
196 (prin1 summary (current-buffer))
198 (setq keystart (point))
199 (insert (if keywords (format "(%s)" keywords) "nil"))
200 (subst-char-in-region keystart (point) ?, ? )
202 (prin1 (abbreviate-file-name d) (current-buffer))
205 ;; Skip null, non-existent or relative pathnames, e.g. "./", if
206 ;; using load-path, so that they do not interfere with a scan of
207 ;; library directories only.
208 (if (and using-load-path
209 (not (and d (file-name-absolute-p d) (file-exists-p d))))
211 (setq d (file-name-as-directory (or d ".")))
212 (directory-files d nil "^[^=].*\\.el$"))))
214 (insert "))\n\n(provide 'finder-inf)\n\n;;; finder-inf.el ends here\n")
215 (kill-buffer "*finder-scratch*")
216 (unless noninteractive
217 (eval-current-buffer)) ; So we get the new keyword list immediately
218 (basic-save-buffer))))
220 (defun finder-compile-keywords-make-dist ()
221 "Regenerate `finder-inf.el' for the Emacs distribution."
222 (finder-compile-keywords default-directory))
224 ;;; Now the retrieval code
226 (defun finder-insert-at-column (column &rest strings)
227 "Insert list of STRINGS, at column COLUMN."
228 (if (>= (current-column) column) (insert "\n"))
229 (move-to-column column)
230 (let ((col (current-column)))
233 (if (and (/= col column)
234 (= (preceding-char) ?\t))
235 (let (indent-tabs-mode)
238 (move-to-column column)))))
239 (apply 'insert strings))
241 (defun finder-list-keywords ()
242 "Display descriptions of the keywords in the Finder buffer."
244 (setq buffer-read-only nil)
248 (let ((keyword (car assoc)))
249 (insert (symbol-name keyword))
250 (finder-insert-at-column 14 (concat (cdr assoc) "\n"))
251 (cons (symbol-name keyword) keyword)))
252 finder-known-keywords)
253 (goto-char (point-min))
254 (setq finder-headmark (point))
255 (setq buffer-read-only t)
256 (set-buffer-modified-p nil)
258 (if (not (one-window-p))
262 (defun finder-list-matches (key)
263 (setq buffer-read-only nil)
265 (let ((id (intern key)))
267 "The following packages match the keyword `" key "':\n\n")
268 (setq finder-headmark (point))
271 (if (memq id (car (cdr (cdr x))))
274 (finder-insert-at-column 16 (concat (car (cdr x)) "\n")))))
276 (goto-char (point-min))
278 (setq buffer-read-only t)
279 (set-buffer-modified-p nil)
280 (shrink-window-if-larger-than-buffer)
283 ;; Search for a file named FILE the same way `load' would search.
284 (defun finder-find-library (file)
285 (if (file-name-absolute-p file)
287 (let ((dirs load-path)
289 (while (and dirs (not found))
290 (if (file-exists-p (expand-file-name (concat file ".el") (car dirs)))
291 (setq found (expand-file-name file (car dirs)))
292 (if (file-exists-p (expand-file-name file (car dirs)))
293 (setq found (expand-file-name file (car dirs)))))
294 (setq dirs (cdr dirs)))
298 (defun finder-commentary (file)
299 "Display FILE's commentary section.
300 FILE should be in a form suitable for passing to `locate-library'."
301 (interactive "sLibrary name: ")
302 (let* ((str (lm-commentary (or (finder-find-library file)
303 (finder-find-library (concat file ".el"))
304 (error "Can't find library %s" file)))))
306 (error "Can't find any Commentary section"))
307 (pop-to-buffer "*Finder*")
309 (setq buffer-read-only nil
310 mode-motion-hook 'mode-motion-highlight-line)
313 (goto-char (point-min))
315 (goto-char (point-max))
317 (goto-char (point-min))
318 (while (re-search-forward "^;+ ?" nil t)
319 (replace-match "" nil nil))
320 (goto-char (point-min))
321 (setq buffer-read-only t)
322 (set-buffer-modified-p nil)
323 (shrink-window-if-larger-than-buffer)
326 (defun finder-current-item ()
327 (if (and finder-headmark (< (point) finder-headmark))
328 (error "No keyword or filename on this line")
334 (defun finder-edit ()
336 (let ((entry (finder-current-item)))
337 (if (string-match finder-file-regexp entry)
338 (let ((path (finder-find-library entry)))
340 (find-file-other-window path)
341 (error "Can't find Emacs Lisp library: '%s'" entry)))
343 (error "Finder-edit works on Emacs Lisp libraries only"))))
346 (defun finder-view ()
348 (let ((entry (finder-current-item)))
349 (if (string-match finder-file-regexp entry)
350 (let ((path (finder-find-library entry)))
352 (declare-fboundp (view-file-other-window path))
353 (error "Can't find Emacs Lisp library: '%s'" entry)))
355 (error "Finder-view works on Emacs Lisp libraries only"))))
357 (defun finder-select ()
359 (let ((key (finder-current-item)))
361 (if (string-match finder-file-regexp key)
362 (finder-commentary key)
363 (finder-list-matches key))))
366 (defun finder-mouse-select (ev)
368 (goto-char (event-point ev))
373 (defun finder-by-keyword ()
374 "Find packages matching a given keyword."
377 (finder-list-keywords))
379 (defun finder-mode ()
380 "Major mode for browsing package documentation.
382 \\[finder-select] more help for the item on the current line
383 \\[finder-edit] edit Lisp library in another window
384 \\[finder-view] view Lisp library in another window
385 \\[finder-exit] exit Finder mode and kill the Finder buffer.
388 (pop-to-buffer "*Finder*")
390 (setq buffer-read-only nil
391 mode-motion-hook 'mode-motion-highlight-line)
393 (use-local-map finder-mode-map)
394 (set-syntax-table emacs-lisp-mode-syntax-table)
395 (setq mode-name "Finder")
396 (setq major-mode 'finder-mode)
397 (make-local-variable 'finder-headmark)
398 (setq finder-headmark nil))
400 (defun finder-summary ()
401 "Summarize basic Finder commands."
404 (substitute-command-keys
406 "\\<finder-mode-map>\\[finder-select] = select, \\[finder-list-keywords] = keywords, \\[finder-edit] = edit, \\[finder-view] = view, \\[finder-exit] = quit, \\[finder-summary] = help")))
408 (defun finder-exit ()
409 "Exit Finder mode and kill the buffer."
412 (or (one-window-p t 0)
414 (kill-buffer "*Finder*"))
418 ;;; finder.el ends here