finder.el 9.37 KB
Newer Older
Eric S. Raymond's avatar
Eric S. Raymond committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
;;; finder.el --- topic & keyword-based code finder

;; Copyright (C) 1992 Free Software Foundation, Inc.

;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
;; Created: 16 Jun 1992
;; Version: 1.0
;; Keywords: help

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 1, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

26
;;; Commentary:
Eric S. Raymond's avatar
Eric S. Raymond committed
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

;; This mode uses the Keywords library header to provide code-finding
;; services by keyword.
;;
;; Things to do:
;;    1. Support multiple keywords per search.  This could be extremely hairy;
;; there doesn't seem to be any way to get completing-read to exit on
;; an EOL with no substring pending, which is what we'd want to end the loop.
;;    2. Search by string in synopsis line?
;;    3. Function to check finder-package-info for unknown keywords.

;;; Code:

(require 'lisp-mnt)
(require 'finder-inf)
(require 'picture)

44 45 46
;; Local variable in finder buffer.
(defvar finder-headmark)

Eric S. Raymond's avatar
Eric S. Raymond committed
47 48
(defvar finder-known-keywords
  '(
Eric S. Raymond's avatar
Eric S. Raymond committed
49
    (abbrev	. "abbreviation handling, typing shortcuts, macros")
50
    (bib	. "code related to the `bib' bibliography processor")
51
    (c		. "support for the C language and related languages")
Eric S. Raymond's avatar
Eric S. Raymond committed
52
    (calendar	. "calendar and time management support")
Eric S. Raymond's avatar
Eric S. Raymond committed
53
    (comm	. "communications, networking, remote access to files")
54
    (data	. "support editing files of data")
Eric S. Raymond's avatar
Eric S. Raymond committed
55 56 57
    (docs	. "support for Emacs documentation")
    (emulations	. "emulations of other editors")
    (extensions	. "Emacs Lisp language extensions")
58
    (faces	. "support for multiple fonts")
Richard M. Stallman's avatar
Richard M. Stallman committed
59
    (frames     . "support for Emacs frames and window systems")
Eric S. Raymond's avatar
Eric S. Raymond committed
60 61 62
    (games	. "games, jokes and amusements")
    (hardware	. "support for interfacing with exotic hardware")
    (help	. "support for on-line help systems")
Richard M. Stallman's avatar
Richard M. Stallman committed
63
    (hypermedia . "support for links between text or other media types")
64
    (i18n	. "internationalization and alternate character-set support")
Eric S. Raymond's avatar
Eric S. Raymond committed
65 66 67 68 69 70
    (internal	. "code for Emacs internals, build process, defaults")
    (languages	. "specialized modes for editing programming languages")
    (lisp	. "Lisp support, including Emacs Lisp")
    (local	. "code local to your site")
    (maint	. "maintenance aids for the Emacs development group")
    (mail	. "modes for electronic-mail handling")
71 72
    (matching	. "various sorts of searching and matching")
    (mouse	. "mouse support")
Eric S. Raymond's avatar
Eric S. Raymond committed
73
    (news	. "support for netnews reading and posting")
Richard M. Stallman's avatar
Richard M. Stallman committed
74 75
    (oop        . "support for object-oriented programming")
    (outlines   . "support for hierarchical outlining")
Eric S. Raymond's avatar
Eric S. Raymond committed
76 77 78 79 80 81 82 83 84
    (processes	. "process, subshell, compilation, and job control support")
    (terminals	. "support for terminal types")
    (tex	. "code related to the TeX formatter")
    (tools	. "programming tools")
    (unix	. "front-ends/assistants for, or emulators of, UNIX features")
    (vms	. "support code for vms")
    (wp		. "word processing")
    ))

85
(defvar finder-mode-map nil)
86 87 88 89 90 91 92 93 94 95
(or finder-mode-map
    (let ((map (make-sparse-keymap)))
      (define-key map " "	'finder-select)
      (define-key map "f"	'finder-select)
      (define-key map "\C-m"	'finder-select)
      (define-key map "?"	'finder-summary)
      (define-key map "q"	'finder-exit)
      (define-key map "d"	'finder-list-keywords)
      (setq finder-mode-map map)))

96

Eric S. Raymond's avatar
Eric S. Raymond committed
97 98 99 100 101 102
;;; Code for regenerating the keyword list.

(defvar finder-package-info nil
  "Assoc list mapping file names to description & keyword lists.")

(defun finder-compile-keywords (&rest dirs)
103
  "Regenerate the keywords association list into the file `finder-inf.el'.
Eric S. Raymond's avatar
Eric S. Raymond committed
104
Optional arguments are a list of Emacs Lisp directories to compile from; no
Christopher Zaborsky's avatar
Christopher Zaborsky committed
105
arguments compiles from `load-path'."
Eric S. Raymond's avatar
Eric S. Raymond committed
106
  (save-excursion
107 108 109
    (let ((processed nil))
      (find-file "finder-inf.el")
      (erase-buffer)
Eric S. Raymond's avatar
Eric S. Raymond committed
110 111
      (insert ";;; finder-inf.el --- keyword-to-package mapping\n")
      (insert ";; Keywords: help\n")
112 113 114
      (insert ";;; Commentary:\n")
      (insert ";; Don't edit this file.  It's generated by finder.el\n\n")
      (insert ";;; Code:\n")
115 116 117 118 119 120 121
      (insert "\n(setq finder-package-info '(\n")
      (mapcar
       (function
	(lambda (d)
	  (mapcar
	   (function
	    (lambda (f) 
122 123 124
	      (if (and (string-match "^[^=].*\\.el$" f)
		       (not (member f processed)))
		  (let (summary keystart keywords)
125 126 127
		    (setq processed (cons f processed))
		    (save-excursion
		      (set-buffer (get-buffer-create "*finder-scratch*"))
128
		      (buffer-disable-undo (current-buffer))
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
		      (erase-buffer)
		      (insert-file-contents
		       (concat (file-name-as-directory (or d ".")) f))
		      (setq summary (lm-synopsis))
		      (setq keywords (lm-keywords)))
		    (insert
		     (format "    (\"%s\"\n        " f))
		    (prin1 summary (current-buffer))
		    (insert
		     "\n        ")
		    (setq keystart (point))
		    (insert
		     (if keywords (format "(%s)" keywords) "nil")
		     ")\n")
		    (subst-char-in-region keystart (point) ?, ? )
144
		    )
145 146 147 148
		)))
	   (directory-files (or d ".")))
	  ))
       (or dirs load-path))
149
      (insert "))\n\n(provide 'finder-inf)\n\n;;; finder-inf.el ends here\n")
150
      (kill-buffer "*finder-scratch*")
151
      (eval-current-buffer) ;; So we get the new keyword list immediately
152 153
      (basic-save-buffer)
      )))
Eric S. Raymond's avatar
Eric S. Raymond committed
154 155 156

;;; Now the retrieval code

157 158 159 160 161 162 163 164 165 166 167 168 169
(defun finder-list-keywords ()
  "Display descriptions of the keywords in the Finder buffer."
  (interactive)
  (setq buffer-read-only nil)
  (erase-buffer)
  (mapcar
   (function (lambda (assoc)
	       (let ((keyword (car assoc)))
		 (insert (symbol-name keyword))
		 (insert-at-column 14 (concat (cdr assoc) "\n"))
		 (cons (symbol-name keyword) keyword))))
   finder-known-keywords)
  (goto-char (point-min))
170
  (setq finder-headmark (point))
171 172 173 174 175 176 177 178 179 180 181
  (setq buffer-read-only t)
  (set-buffer-modified-p nil)
  (balance-windows)
  (finder-summary))

(defun finder-list-matches (key)
  (setq buffer-read-only nil)
  (erase-buffer)
  (let ((id (intern key)))
    (insert
     "The following packages match the keyword `" key "':\n\n")
182
    (setq finder-headmark (point))
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
    (mapcar
     (function (lambda (x)
		 (if (memq id (car (cdr (cdr x))))
		     (progn
		       (insert (car x))
		       (insert-at-column 16
					 (concat (car (cdr x)) "\n"))
		       ))
		 ))
     finder-package-info)
    (goto-char (point-min))
    (forward-line)
    (setq buffer-read-only t)
    (set-buffer-modified-p nil)
    (shrink-window-if-larger-than-buffer)
    (finder-summary)))

200 201 202 203 204 205 206 207 208 209 210 211 212 213
;; Search for a file named FILE the same way `load' would search.
(defun finder-find-library (file)
  (if (file-name-absolute-p file)
      file
    (let ((dirs load-path)
	  found)
      (while (and dirs (not found))
	(if (file-exists-p (expand-file-name (concat file ".el") (car dirs)))
	    (setq found (expand-file-name file (car dirs)))
	  (if (file-exists-p (expand-file-name file (car dirs)))
	      (setq found (expand-file-name file (car dirs)))))
	(setq dirs (cdr dirs)))
      found)))

214 215
(defun finder-commentary (file)
  (interactive)
216
  (let* ((str (lm-commentary (finder-find-library file))))
217
    (if (null str)
218
	(error "Can't find any Commentary section"))
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
    (pop-to-buffer "*Finder*")
    (setq buffer-read-only nil)
    (erase-buffer)
    (insert str)
    (goto-char (point-min))
    (delete-blank-lines)
    (goto-char (point-max))
    (delete-blank-lines)
    (goto-char (point-min))
    (while (re-search-forward "^;+ ?" nil t)
      (replace-match "" nil nil))
    (goto-char (point-min))
    (setq buffer-read-only t)
    (set-buffer-modified-p nil)
    (shrink-window-if-larger-than-buffer)
    (finder-summary)
    ))

(defun finder-current-item ()
238
  (if (and finder-headmark (< (point) finder-headmark))
239 240 241 242 243 244 245 246 247 248 249 250
      (error "No keyword or filename on this line")
    (save-excursion
      (beginning-of-line)
      (current-word))))

(defun finder-select ()
  (interactive)
  (let ((key (finder-current-item)))
    (if (string-match "\\.el$" key)
	(finder-commentary key)
      (finder-list-matches key))))

Eric S. Raymond's avatar
Eric S. Raymond committed
251 252 253
(defun finder-by-keyword ()
  "Find packages matching a given keyword."
  (interactive)
254 255 256 257 258
  (finder-mode)
  (finder-list-keywords))

(defun finder-mode ()
  "Major mode for browsing package documentation.
259
\\<finder-mode-map>
260
\\[finder-select]	more help for the item on the current line
Richard M. Stallman's avatar
Richard M. Stallman committed
261
\\[finder-exit]	exit Finder mode and kill the Finder buffer.
262 263 264 265
"
  (interactive)
  (pop-to-buffer "*Finder*")
  (setq buffer-read-only nil)
Eric S. Raymond's avatar
Eric S. Raymond committed
266
  (erase-buffer)
267 268 269 270
  (use-local-map finder-mode-map)
  (set-syntax-table emacs-lisp-mode-syntax-table)
  (setq mode-name "Finder")
  (setq major-mode 'finder-mode)
271 272
  (make-local-variable 'finder-headmark)
  (setq finder-headmark nil)
273 274 275 276 277 278
)

(defun finder-summary ()
  "Summarize basic Finder commands."
  (interactive)
  (message
279
   (substitute-command-keys
280
    "\\<finder-mode-map>\\[finder-select] = select, \\[finder-list-keywords] = to finder directory, \\[finder-exit] = quit, \\[finder-summary] = help")))
281

282 283 284 285 286
(defun finder-exit ()
  "Exit Finder mode and kill the buffer"
  (interactive)
  (delete-window)
  (kill-buffer "*Finder*"))
Eric S. Raymond's avatar
Eric S. Raymond committed
287 288 289 290

(provide 'finder)

;;; finder.el ends here