Skip to content


Subversion checkout URL

You can clone with
Download ZIP
tag: unicode-post-f…
Fetching contributors…

Cannot retrieve contributors at this time

377 lines (338 sloc) 13.084 kB
;;; finder.el --- topic & keyword-based code finder
;; Copyright (C) 1992, 1997, 1998, 1999, 2001, 2002, 2003,
;; 2004, 2005, 2006 Free Software Foundation, Inc.
;; Author: Eric S. Raymond <>
;; 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 2, 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
;; 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, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, 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 'find-func) ;for find-library(-suffixes)
;; Use `load' rather than `require' so that it doesn't get loaded
;; during byte-compilation (at which point it might be missing).
(load "finder-inf" t t)
(defvar finder-mode-hook nil
"*Hook run when function `finder-mode' is called.")
;; Local variable in finder buffer.
(defvar finder-headmark)
;; These are supposed to correspond to top-level customization groups,
;; says rms.
(defvar finder-known-keywords
(abbrev . "abbreviation handling, typing shortcuts, macros")
;; Too specific:
(bib . "code related to the `bib' bibliography processor")
(c . "support for the C language and related languages")
(calendar . "calendar and time management support")
(comm . "communications, networking, remote access to files")
(convenience . "convenience features for faster editing")
(data . "support for editing files of data")
(docs . "support for Emacs documentation")
(emulations . "emulations of other editors")
(extensions . "Emacs Lisp language extensions")
(faces . "support for multiple fonts")
(files . "support for editing and manipulating files")
(frames . "support for Emacs frames and window systems")
(games . "games, jokes and amusements")
(hardware . "support for interfacing with exotic hardware")
(help . "support for on-line help systems")
(hypermedia . "support for links between text or other media types")
(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")
(multimedia . "images and sound support")
(news . "support for netnews reading and posting")
(oop . "support for object-oriented programming")
(outlines . "support for hierarchical outlining")
(processes . "process, subshell, compilation, and job control support")
(terminals . "support for terminal types")
(tex . "supporting code for the TeX formatter")
(tools . "programming tools")
(unix . "front-ends/assistants for, or emulators of, UNIX-like features")
;; Not a custom group and not currently useful.
;; (vms . "support code for vms")
(wp . "word processing")
(defvar finder-mode-map
(let ((map (make-sparse-keymap)))
(define-key map " " 'finder-select)
(define-key map "f" 'finder-select)
(define-key map [follow-link] 'mouse-face)
(define-key map [mouse-2] 'finder-mouse-select)
(define-key map "\C-m" 'finder-select)
(define-key map "?" 'finder-summary)
(define-key map "n" 'next-line)
(define-key map "p" 'previous-line)
(define-key map "q" 'finder-exit)
(define-key map "d" 'finder-list-keywords)
;;; Code for regenerating the keyword list.
(defvar finder-package-info nil
"Assoc list mapping file names to description & keyword lists.")
(defvar generated-finder-keywords-file "finder-inf.el"
"File \\[finder-compile-keywords] puts finder keywords into.")
(defun finder-compile-keywords (&rest dirs)
"Regenerate the keywords association list into `generated-finder-keywords-file'.
Optional arguments DIRS are a list of Emacs Lisp directories to compile from;
no arguments compiles from `load-path'."
(let ((processed nil))
(find-file generated-finder-keywords-file)
(insert ";;; " (file-name-nondirectory generated-finder-keywords-file)
" --- keyword-to-package mapping\n")
(insert ";; This file is part of GNU Emacs.\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")
(lambda (d)
(when (file-exists-p (directory-file-name d))
(message "Directory %s" d)
(lambda (f)
(if (and (or (string-match "^[^=].*\\.el$" f)
;; Allow compressed files also. Fixme:
;; generalize this, especially for
;; MS-DOG-type filenames.
(and (string-match "^[^=].*\\.el\\.\\(gz\\|Z\\)$" f)
(require 'jka-compr)))
;; Ignore lock files.
(not (string-match "^.#" f))
(not (member f processed)))
(let (summary keystart keywords)
(setq processed (cons f processed))
(set-buffer (get-buffer-create "*finder-scratch*"))
(buffer-disable-undo (current-buffer))
(concat (file-name-as-directory (or d ".")) f))
(setq summary (lm-synopsis))
(setq keywords (lm-keywords)))
(format " (\"%s\"\n "
(if (string-match "\\.\\(gz\\|Z\\)$" f)
(file-name-sans-extension f)
(prin1 summary (current-buffer))
"\n ")
(setq keystart (point))
(if keywords (format "(%s)" keywords) "nil")
(subst-char-in-region keystart (point) ?, ? )
(directory-files (or d ".")))))
(or dirs load-path))
(insert "))\n
\(provide '" (file-name-sans-extension
(file-name-nondirectory generated-finder-keywords-file)) ")
;;; Local Variables:
;;; version-control: never
;;; no-byte-compile: t
;;; no-update-autoloads: t
;;; End:
;;; " (file-name-nondirectory generated-finder-keywords-file) " ends here\n")
(kill-buffer "*finder-scratch*")
(eval-buffer) ;; So we get the new keyword list immediately
(defun finder-compile-keywords-make-dist ()
"Regenerate `finder-inf.el' for the Emacs distribution."
(apply 'finder-compile-keywords command-line-args-left)
;;; Now the retrieval code
(defun finder-insert-at-column (column &rest strings)
"Insert, at column COLUMN, other args STRINGS."
(if (>= (current-column) column) (insert "\n"))
(move-to-column column t)
(apply 'insert strings))
(defvar finder-help-echo nil)
(defun finder-mouse-face-on-line ()
"Put `mouse-face' and `help-echo' properties on the previous line."
(previous-line 1)
(unless finder-help-echo
(setq finder-help-echo
(let* ((keys1 (where-is-internal 'finder-select
(keys (nconc (where-is-internal
'finder-mouse-select finder-mode-map)
(concat (mapconcat 'key-description keys ", ")
": select item"))))
(line-beginning-position) (line-end-position)
'(mouse-face highlight
help-echo finder-help-echo))))
(defun finder-list-keywords ()
"Display descriptions of the keywords in the Finder buffer."
(if (get-buffer "*Finder*")
(pop-to-buffer "*Finder*")
(pop-to-buffer (set-buffer (get-buffer-create "*Finder*")))
(setq buffer-read-only nil)
(lambda (assoc)
(let ((keyword (car assoc)))
(insert (symbol-name keyword))
(finder-insert-at-column 14 (concat (cdr assoc) "\n"))
(goto-char (point-min))
(setq finder-headmark (point))
(setq buffer-read-only t)
(set-buffer-modified-p nil)
(defun finder-list-matches (key)
(pop-to-buffer (set-buffer (get-buffer-create "*Finder Category*")))
(setq buffer-read-only nil)
(let ((id (intern key)))
"The following packages match the keyword `" key "':\n\n")
(setq finder-headmark (point))
(lambda (x)
(if (memq id (car (cdr (cdr x))))
(insert (car x))
(finder-insert-at-column 16 (concat (nth 1 x) "\n"))
(goto-char (point-min))
(setq buffer-read-only t)
(set-buffer-modified-p nil)
(defun finder-commentary (file)
"Display FILE's commentary section.
FILE should be in a form suitable for passing to `locate-library'."
(completing-read "Library name: "
(cons (or find-function-source-path load-path)
(let* ((str (lm-commentary (find-library-name file))))
(if (null str)
(error "Can't find any Commentary section"))
;; This used to use *Finder* but that would clobber the
;; directory of categories.
(pop-to-buffer "*Finder-package*")
(setq buffer-read-only nil)
(insert str)
(goto-char (point-min))
(goto-char (point-max))
(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)
(defun finder-current-item ()
(let ((key (save-excursion
(if (or (and finder-headmark (< (point) finder-headmark))
(= (length key) 0))
(error "No keyword or filename on this line")
(defun finder-select ()
"Select item on current line in a finder buffer."
(let ((key (finder-current-item)))
(if (string-match "\\.el$" key)
(finder-commentary key)
(finder-list-matches key))))
(defun finder-mouse-select (event)
"Select item in a finder buffer with the mouse."
(interactive "e")
(set-buffer (window-buffer (posn-window (event-start event))))
(goto-char (posn-point (event-start event)))
(defun finder-by-keyword ()
"Find packages matching a given keyword."
(defun finder-mode ()
"Major mode for browsing package documentation.
\\[finder-select] more help for the item on the current line
\\[finder-exit] exit Finder mode and kill the Finder buffer."
(use-local-map finder-mode-map)
(set-syntax-table emacs-lisp-mode-syntax-table)
(setq mode-name "Finder")
(setq major-mode 'finder-mode)
(set (make-local-variable 'finder-headmark) nil)
(run-mode-hooks 'finder-mode-hook))
(defun finder-summary ()
"Summarize basic Finder commands."
(message "%s"
"\\<finder-mode-map>\\[finder-select] = select, \
\\[finder-mouse-select] = select, \\[finder-list-keywords] = to \
finder directory, \\[finder-exit] = quit, \\[finder-summary] = help")))
(defun finder-exit ()
"Exit Finder mode and kill the buffer."
(or (one-window-p t)
;; Can happen in either buffer -- kill each of the two that exists
(and (get-buffer "*Finder*")
(kill-buffer "*Finder*"))
(and (get-buffer "*Finder Category*")
(kill-buffer "*Finder Category*")))
(provide 'finder)
;;; arch-tag: ec85ff49-8cb8-41f5-a63f-9131d53ce2c5
;;; finder.el ends here
Jump to Line
Something went wrong with that request. Please try again.