Mercurial > emacs
view lisp/finder.el @ 39625:e441240482b2
(add-change-log-entry): Skip copyright notice
and copying permission notice at start of file, if any.
Make use of terms "entry" and "item" accord with Emacs manual.
Simplify the logic for moving point while entering or creating
an entry and then an item.
(add-change-log-entry-other-window): Doc fix.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Sat, 06 Oct 2001 02:32:54 +0000 |
parents | b174db545cfd |
children | 70f755b6a5c9 |
line wrap: on
line source
;;; finder.el --- topic & keyword-based code finder ;; Copyright (C) 1992, 1997, 1998, 1999, 2001 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 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 ;; 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, Inc., 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, 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) ;; 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 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 . "code related to the TeX formatter") (tools . "programming tools") (unix . "front-ends/assistants for, or emulators of, UNIX features") ;; Not a custom group and not currently useful. ;; (vms . "support code for vms") (wp . "word processing") )) (defvar finder-mode-map nil) (or finder-mode-map (let ((map (make-sparse-keymap))) (define-key map " " 'finder-select) (define-key map "f" 'finder-select) (define-key map [mouse-2] 'finder-mouse-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))) ;;; 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 DIRS 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 ";; This file is part of GNU Emacs.\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 (lambda (d) (when (file-exists-p (directory-file-name d)) (message "Directory %s" d) (mapcar (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)) (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 " (if (string-match "\\.\\(gz\\|Z\\)$" f) (file-name-sans-extension f) 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 \(provide 'finder-inf) ;;; Local Variables: ;;; version-control: never ;;; no-byte-compile: t ;;; no-update-autoloads: t ;;; End: ;;; finder-inf.el ends here\n") (kill-buffer "*finder-scratch*") (eval-current-buffer) ;; So we get the new keyword list immediately (basic-save-buffer)))) (defun finder-compile-keywords-make-dist () "Regenerate `finder-inf.el' for the Emacs distribution." (apply 'finder-compile-keywords command-line-args-left) (kill-emacs)) ;;; 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." (save-excursion (previous-line 1) (unless finder-help-echo (setq finder-help-echo (let* ((keys1 (where-is-internal 'finder-select finder-mode-map)) (keys (nconc (where-is-internal 'finder-mouse-select finder-mode-map) keys1))) (concat (mapconcat 'key-description keys ", ") ": select item")))) (add-text-properties (line-beginning-position) (line-end-position) '(mouse-face highlight help-echo finder-help-echo)))) ;;;###autoload (defun finder-list-keywords () "Display descriptions of the keywords in the Finder buffer." (interactive) (if (get-buffer "*Finder*") (pop-to-buffer "*Finder*") (pop-to-buffer (set-buffer (get-buffer-create "*Finder*"))) (finder-mode) (setq buffer-read-only nil) (erase-buffer) (mapc (lambda (assoc) (let ((keyword (car assoc))) (insert (symbol-name keyword)) (finder-insert-at-column 14 (concat (cdr assoc) "\n")) (finder-mouse-face-on-line))) 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) (pop-to-buffer (set-buffer (get-buffer-create "*Finder Category*"))) (finder-mode) (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)) (mapc (lambda (x) (if (memq id (car (cdr (cdr x)))) (progn (insert (car x)) (finder-insert-at-column 16 (concat (nth 1 x) "\n")) (finder-mouse-face-on-line)))) 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))) (defun finder-find-library (library) "Search for file LIBRARY on `load-path'. Try compressed versions if jka-compr is in use." (or (locate-library library t) (if (rassq 'jka-compr-handler file-name-handler-alist) (or (locate-library (concat library ".gz") t) (locate-library (concat library ".Z") t) ;; last resort for MS-DOG et al (locate-library (concat library "z")))))) ;;;###autoload (defun finder-commentary (file) "Display FILE's commentary section. FILE should be in a form suitable for passing to `locate-library'." (interactive "sLibrary name: ") (let* ((str (lm-commentary (or (finder-find-library file) (finder-find-library (concat file ".el")) (error "Can't find library %s" 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-mode) (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 () "Select item on current line in a finder buffer." (interactive) (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") (save-excursion (set-buffer (window-buffer (posn-window (event-start event)))) (goto-char (posn-point (event-start event))) (finder-select))) ;;;###autoload (defun finder-by-keyword () "Find packages matching a given keyword." (interactive) (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) (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 "%s" (substitute-command-keys "\\<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." (interactive) (or (one-window-p t) (delete-window)) ;; 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) ;;; finder.el ends here