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 XEmacs.
22 ;; XEmacs is free software; you can redistribute it and/or modify it
23 ;; under the terms of the GNU General Public License as published by
24 ;; the Free Software Foundation; either version 2, or (at your option)
27 ;; XEmacs is distributed in the hope that it will be useful, but
28 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
29 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
30 ;; General Public License for more details.
32 ;; You should have received a copy of the GNU General Public License
33 ;; along with XEmacs; see the file COPYING. If not, write to the Free
34 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
37 ;;; Synched up with: FSF 19.34.
41 ;; This mode uses the Keywords library header to provide code-finding
42 ;; services by keyword.
45 ;; 1. Support multiple keywords per search. This could be extremely hairy;
46 ;; there doesn't seem to be any way to get completing-read to exit on
47 ;; an EOL with no substring pending, which is what we'd want to end the loop.
48 ;; 2. Search by string in synopsis line?
49 ;; 3. Function to check finder-package-info for unknown keywords.
59 (require 'mode-motion)
61 (defvar finder-emacs-root-directory
62 (file-name-directory (directory-file-name data-directory))
63 "Root directory of current emacs tree.")
65 (defvar finder-abbreviate-directory-list
66 (list finder-emacs-root-directory)
67 "*List of directory roots to remove from finder-package-info directory entries.
68 The first element in the list is used when expanding relative package
69 directories to view or extract information from package source code.")
71 (defvar finder-file-regexp "\\.el$"
72 "Regexp which matches file names but not Emacs Lisp finder keywords.")
74 ;; Local variable in finder buffer.
75 (defvar finder-headmark)
77 (defvar finder-known-keywords
79 (abbrev . "abbreviation handling, typing shortcuts, macros")
80 (bib . "code related to the `bib' bibliography processor")
81 (c . "C, C++, and Objective-C language support")
82 (calendar . "calendar and time management support")
83 (comm . "communications, networking, remote access to files")
84 (data . "support for editing files of data")
85 (docs . "support for Emacs documentation")
86 (dumped . "files preloaded into Emacs")
87 (emulations . "emulations of other editors")
88 (extensions . "Emacs Lisp language extensions")
89 (faces . "support for multiple fonts")
90 (frames . "support for Emacs frames and window systems")
91 (games . "games, jokes and amusements")
92 (hardware . "support for interfacing with exotic hardware")
93 (help . "support for on-line help systems")
94 (hypermedia . "support for links between text or other media types")
95 (i18n . "internationalization and alternate character-set support")
96 (internal . "code for Emacs internals, build process, defaults")
97 (languages . "specialized modes for editing programming languages")
98 (lisp . "Lisp support, including Emacs Lisp")
99 (local . "code local to your site")
100 (maint . "maintenance aids for the Emacs development group")
101 (mail . "modes for electronic-mail handling")
102 (matching . "various sorts of searching and matching")
103 (mouse . "mouse support")
104 ,(when (featurep 'mule)
105 (cons 'mule "multi-language extensions"))
106 (news . "support for netnews reading and posting")
107 (oop . "support for object-oriented programming")
108 (outlines . "support for hierarchical outlining")
109 (processes . "process, subshell, compilation, and job control support")
110 (terminals . "support for terminal types")
111 (tex . "code related to the TeX formatter")
112 (tools . "programming tools")
113 (unix . "front-ends/assistants for, or emulators of, UNIX features")
114 (vms . "support code for vms")
115 (wp . "word processing")
118 (defvar finder-mode-map nil)
120 (let ((map (make-sparse-keymap)))
121 (define-key map " " 'finder-select)
122 (define-key map "f" 'finder-select)
123 (define-key map "\C-m" 'finder-select)
125 (define-key map "e" 'finder-edit)
126 (define-key map "v" 'finder-view)
127 (define-key map "?" 'finder-summary)
128 (define-key map "q" 'finder-exit)
129 (define-key map "d" 'finder-list-keywords)
131 (define-key map [button2] 'finder-mouse-select)
132 (setq finder-mode-map map)))
135 ;;; Code for regenerating the keyword list.
137 (defvar finder-package-info nil
138 "Assoc list mapping file names to description & keyword lists.")
140 (defvar finder-compile-keywords-quiet nil
141 "If non-nil finder-compile-keywords will not print any messages.")
143 (defun finder-compile-keywords (&rest dirs)
144 "Regenerate the keywords association list into the file `finder-inf.el'.
145 Optional arguments are a list of Emacs Lisp directories to compile from; no
146 arguments compiles from `load-path'."
149 (find-file "finder-inf.el")
150 (let ((processed nil)
151 (directory-abbrev-alist
153 (mapcar (function (lambda (dir) (cons dir "")))
154 finder-abbreviate-directory-list)
155 directory-abbrev-alist))
157 (or dirs (setq dirs load-path))
158 (setq using-load-path (equal dirs load-path))
160 (insert ";;; finder-inf.el --- keyword-to-package mapping\n")
161 (insert ";; Keywords: help\n")
162 (insert ";;; Commentary:\n")
163 (insert ";; Don't edit this file. It's generated by finder.el\n\n")
164 (insert ";;; Code:\n")
165 (insert "\n(defconst finder-package-info '(\n")
170 (when (and (not (member f processed)) (file-readable-p f))
171 (let (summary keystart keywords)
172 (setq processed (cons f processed))
173 (if (not finder-compile-keywords-quiet)
174 (message "Processing %s ..." f))
176 (set-buffer (get-buffer-create "*finder-scratch*"))
177 (buffer-disable-undo (current-buffer))
179 (insert-file-contents (expand-file-name f d))
181 (setq summary (lm-synopsis)
182 keywords (lm-keywords))
183 (t (message "finder: error processing %s %S" f err))))
185 (insert (format " (\"%s\"\n " f))
186 (prin1 summary (current-buffer))
188 (setq keystart (point))
189 (insert (if keywords (format "(%s)" keywords) "nil"))
190 (subst-char-in-region keystart (point) ?, ? )
192 (prin1 (abbreviate-file-name d) (current-buffer))
195 ;; Skip null, non-existent or relative pathnames, e.g. "./", if
196 ;; using load-path, so that they do not interfere with a scan of
197 ;; library directories only.
198 (if (and using-load-path
199 (not (and d (file-name-absolute-p d) (file-exists-p d))))
201 (setq d (file-name-as-directory (or d ".")))
202 (directory-files d nil "^[^=].*\\.el$"))))
204 (insert "))\n\n(provide 'finder-inf)\n\n;;; finder-inf.el ends here\n")
205 (kill-buffer "*finder-scratch*")
206 (unless noninteractive
207 (eval-current-buffer)) ; So we get the new keyword list immediately
208 (basic-save-buffer))))
210 (defun finder-compile-keywords-make-dist ()
211 "Regenerate `finder-inf.el' for the Emacs distribution."
212 (finder-compile-keywords default-directory))
214 ;;; Now the retrieval code
216 (defun finder-insert-at-column (column &rest strings)
217 "Insert list of STRINGS, at column COLUMN."
218 (if (>= (current-column) column) (insert "\n"))
219 (move-to-column column)
220 (let ((col (current-column)))
223 (if (and (/= col column)
224 (= (preceding-char) ?\t))
225 (let (indent-tabs-mode)
228 (move-to-column column)))))
229 (apply 'insert strings))
231 (defun finder-list-keywords ()
232 "Display descriptions of the keywords in the Finder buffer."
234 (setq buffer-read-only nil)
238 (let ((keyword (car assoc)))
239 (insert (symbol-name keyword))
240 (finder-insert-at-column 14 (concat (cdr assoc) "\n"))
241 (cons (symbol-name keyword) keyword)))
242 finder-known-keywords)
243 (goto-char (point-min))
244 (setq finder-headmark (point))
245 (setq buffer-read-only t)
246 (set-buffer-modified-p nil)
248 (if (not (one-window-p))
252 (defun finder-list-matches (key)
253 (setq buffer-read-only nil)
255 (let ((id (intern key)))
257 "The following packages match the keyword `" key "':\n\n")
258 (setq finder-headmark (point))
261 (if (memq id (car (cdr (cdr x))))
264 (finder-insert-at-column 16 (concat (car (cdr x)) "\n")))))
266 (goto-char (point-min))
268 (setq buffer-read-only t)
269 (set-buffer-modified-p nil)
270 (shrink-window-if-larger-than-buffer)
273 ;; Search for a file named FILE the same way `load' would search.
274 (defun finder-find-library (file)
275 (if (file-name-absolute-p file)
277 (let ((dirs load-path)
279 (while (and dirs (not found))
280 (if (file-exists-p (expand-file-name (concat file ".el") (car dirs)))
281 (setq found (expand-file-name file (car dirs)))
282 (if (file-exists-p (expand-file-name file (car dirs)))
283 (setq found (expand-file-name file (car dirs)))))
284 (setq dirs (cdr dirs)))
287 (defun finder-commentary (file)
288 "Display FILE's commentary section.
289 FILE should be in a form suitable for passing to `locate-library'."
290 (interactive "sLibrary name: ")
291 (let* ((str (lm-commentary (or (finder-find-library file)
292 (finder-find-library (concat file ".el"))
293 (error "Can't find library %s" file)))))
295 (error "Can't find any Commentary section"))
296 (pop-to-buffer "*Finder*")
298 (setq buffer-read-only nil
299 mode-motion-hook 'mode-motion-highlight-line)
302 (goto-char (point-min))
304 (goto-char (point-max))
306 (goto-char (point-min))
307 (while (re-search-forward "^;+ ?" nil t)
308 (replace-match "" nil nil))
309 (goto-char (point-min))
310 (setq buffer-read-only t)
311 (set-buffer-modified-p nil)
312 (shrink-window-if-larger-than-buffer)
315 (defun finder-current-item ()
316 (if (and finder-headmark (< (point) finder-headmark))
317 (error "No keyword or filename on this line")
323 (defun finder-edit ()
325 (let ((entry (finder-current-item)))
326 (if (string-match finder-file-regexp entry)
327 (let ((path (finder-find-library entry)))
329 (find-file-other-window path)
330 (error "Can't find Emacs Lisp library: '%s'" entry)))
332 (error "Finder-edit works on Emacs Lisp libraries only"))))
335 (defun finder-view ()
337 (let ((entry (finder-current-item)))
338 (if (string-match finder-file-regexp entry)
339 (let ((path (finder-find-library entry)))
341 (view-file-other-window path)
342 (error "Can't find Emacs Lisp library: '%s'" entry)))
344 (error "Finder-view works on Emacs Lisp libraries only"))))
346 (defun finder-select ()
348 (let ((key (finder-current-item)))
350 (if (string-match finder-file-regexp key)
351 (finder-commentary key)
352 (finder-list-matches key))))
355 (defun finder-mouse-select (ev)
357 (goto-char (event-point ev))
362 (defun finder-by-keyword ()
363 "Find packages matching a given keyword."
366 (finder-list-keywords))
368 (defun finder-mode ()
369 "Major mode for browsing package documentation.
371 \\[finder-select] more help for the item on the current line
372 \\[finder-edit] edit Lisp library in another window
373 \\[finder-view] view Lisp library in another window
374 \\[finder-exit] exit Finder mode and kill the Finder buffer.
377 (pop-to-buffer "*Finder*")
379 (setq buffer-read-only nil
380 mode-motion-hook 'mode-motion-highlight-line)
382 (use-local-map finder-mode-map)
383 (set-syntax-table emacs-lisp-mode-syntax-table)
384 (setq mode-name "Finder")
385 (setq major-mode 'finder-mode)
386 (make-local-variable 'finder-headmark)
387 (setq finder-headmark nil))
389 (defun finder-summary ()
390 "Summarize basic Finder commands."
393 (substitute-command-keys
395 "\\<finder-mode-map>\\[finder-select] = select, \\[finder-list-keywords] = keywords, \\[finder-edit] = edit, \\[finder-view] = view, \\[finder-exit] = quit, \\[finder-summary] = help")))
397 (defun finder-exit ()
398 "Exit Finder mode and kill the buffer"
401 (or (one-window-p t 0)
403 (kill-buffer "*Finder*"))
407 ;;; finder.el ends here