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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
;;; 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.
;;; Commentary:
;; 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)
;; Local variable in finder buffer.
(defvar finder-headmark)
(defvar finder-known-keywords
'(
(abbrev . "abbreviation handling, typing shortcuts, macros")
(bib . "code related to the `bib' bibliography processor")
(c . "C and C++ language support")
(calendar . "calendar and time management support")
(comm . "communications, networking, remote access to files")
(data . "support editing files of data")
(docs . "support for Emacs documentation")
(emulations . "emulations of other editors")
(extensions . "Emacs Lisp language extensions")
(faces . "support for multiple fonts")
(games . "games, jokes and amusements")
(hardware . "support for interfacing with exotic hardware")
(help . "support for on-line help systems")
(i18n . "internationalization and alternate character-set support")
(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")
(matching . "various sorts of searching and matching")
(mouse . "mouse support")
(news . "support for netnews reading and posting")
(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")
))
(defvar finder-mode-map nil)
;(if finder-mode-map
; nil
(setq finder-mode-map (make-sparse-keymap))
(define-key finder-mode-map " " 'finder-select)
(define-key finder-mode-map "?" 'finder-summary)
(define-key finder-mode-map "q" 'finder-exit)
(define-key finder-mode-map "f" 'finder-list-keywords)
; )
;;; 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)
"Regenerate the keywords association list into the file `finder-inf.el'.
Optional arguments are a list of Emacs Lisp directories to compile from; no
arguments compiles from `load-path'."
(save-excursion
(let ((processed nil))
(find-file "finder-inf.el")
(erase-buffer)
(insert ";;; finder-inf.el --- keyword-to-package mapping\n")
(insert ";; Keywords: help\n")
(insert ";;; Commentary:\n")
(insert ";; Don't edit this file. It's generated by finder.el\n\n")
(insert ";;; Code:\n")
(insert "\n(setq finder-package-info '(\n")
(mapcar
(function
(lambda (d)
(mapcar
(function
(lambda (f)
(if (and (string-match "^[^=].*\\.el$" f)
(not (member f processed)))
(let (summary keystart keywords)
(setq processed (cons f processed))
(save-excursion
(set-buffer (get-buffer-create "*finder-scratch*"))
(buffer-disable-undo (current-buffer))
(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) ?, ? )
)
)))
(directory-files (or d ".")))
))
(or dirs load-path))
(insert "))\n\n(provide 'finder-inf)\n\n;;; finder-inf.el ends here\n")
(kill-buffer "*finder-scratch*")
(eval-current-buffer) ;; So we get the new keyword list immediately
(basic-save-buffer)
)))
;;; Now the retrieval code
(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))
(setq finder-headmark (point))
(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")
(setq finder-headmark (point))
(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)))
;; 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)))
(defun finder-commentary (file)
(interactive)
(let* ((str (lm-commentary (finder-find-library file))))
(if (null str)
(error "Can't find any Commentary section."))
(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 ()
(if (and finder-headmark (< (point) finder-headmark))
(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))))
(defun finder-by-keyword ()
"Find packages matching a given keyword."
(interactive)
(finder-mode)
(finder-list-keywords))
(defun finder-mode ()
"Major mode for browsing package documentation.
\\<finder-mode-map>
\\[finder-select] more help for the item on the current line
\\[finder-exit] exit Finder mode and fill the Finder buffer.
"
(interactive)
(pop-to-buffer "*Finder*")
(setq buffer-read-only nil)
(erase-buffer)
(use-local-map finder-mode-map)
(set-syntax-table emacs-lisp-mode-syntax-table)
(setq mode-name "Finder")
(setq major-mode 'finder-mode)
(make-local-variable 'finder-headmark)
(setq finder-headmark nil)
)
(defun finder-summary ()
"Summarize basic Finder commands."
(interactive)
(message
(substitute-command-keys
"\\<finder-mode-map>\\[finder-select] = select, \\[finder-list-keywords] = back to finder, \\[finder-exit] = quit, \\[finder-summary] = help")))
(defun finder-exit ()
"Exit Finder mode and kill the buffer"
(interactive)
(delete-window)
(kill-buffer "*Finder*"))
(provide 'finder)
;;; finder.el ends here
|
