;; along with GNU Emacs; see the file COPYING. If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
-;; Commentary:
+;;; Commentary:
;; This mode uses the Keywords library header to provide code-finding
;; services by keyword.
(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(1) bibliography processor")
+ (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")
- (i14n . "internationalization and alternate character-set support")
+ (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")
(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.
+ "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
(mapcar
(function
(lambda (f)
- (if (and (string-match "\\.el$" f) (not (member f processed)))
- (let (summary keystart)
+ (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))
;;; 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)
- (set-buffer (get-buffer-create "*Help*"))
+ (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 kill 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")))
- ;; Display descriptions of the keywords in the help buffer, and
- ;; build an assoc list mapping the names of known keywords to their
- ;; symbols.
- (let ((keyword-names
- (mapcar (lambda (assoc)
- (let ((keyword (car assoc)))
- (insert (symbol-name keyword))
- (insert-at-column 14 (cdr assoc) "\n")
- (cons (symbol-name keyword) keyword)))
- finder-known-keywords)))
- (let ((key
- (save-window-excursion
- (pop-to-buffer "*Help*")
- (goto-char (point-min))
- (completing-read "Package keyword: " keyword-names nil t)))
- id)
- (or (equal key "")
- (progn
- (erase-buffer)
- (pop-to-buffer "*Help*")
- (setq id (intern key))
- (insert
- "The following packages match the keyword `" key "':\n\n")
- (mapcar
- (function (lambda (x)
- (if (memq id (car (cdr (cdr x))))
- (progn
- (insert (car x))
- (insert-at-column 16 (car (cdr x)) "\n")
- ))
- ))
- finder-package-info)
- (goto-char (point-min)))))))
+(defun finder-exit ()
+ "Exit Finder mode and kill the buffer"
+ (interactive)
+ (delete-window)
+ (kill-buffer "*Finder*"))
(provide 'finder)
HCoop / bpt / emacs.git / blobdiff