X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/57938a7982e20e7d8b96171f19821876c98cb4dc..2d76405c5b7c189cb48348126f1ee4c8cea7ad39:/lisp/finder.el diff --git a/lisp/finder.el b/lisp/finder.el index 358c0a1fee..da537a59cc 100644 --- a/lisp/finder.el +++ b/lisp/finder.el @@ -1,7 +1,7 @@ ;;; finder.el --- topic & keyword-based code finder -;; Copyright (C) 1992, 1997, 1998, 1999, 2001, 2002, 2003, 2004, 2005, -;; 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. +;; Copyright (C) 1992, 1997-1999, 2001-2016 Free Software Foundation, +;; Inc. ;; Author: Eric S. Raymond ;; Created: 16 Jun 1992 @@ -27,63 +27,55 @@ ;; 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? ;;; Code: +(require 'package) (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) +(require 'find-func) ;for find-library(-suffixes) +(require 'finder-inf nil t) ;; 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") + '((abbrev . "abbreviation handling, typing shortcuts, and macros") + (bib . "bibliography processors") + (c . "C and related programming languages") + (calendar . "calendar and time management tools") + (comm . "communications, networking, and remote file access") (convenience . "convenience features for faster editing") - (data . "support for editing files of data") - (docs . "support for Emacs documentation") + (data . "editing data (non-text) files") + (docs . "Emacs documentation facilities") (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") + (faces . "fonts and colors for text") + (files . "file editing and manipulation") + (frames . "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") + (hardware . "interfacing with system hardware") + (help . "Emacs help systems") + (hypermedia . "links between text or other media types") + (i18n . "internationalization and 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") + (maint . "Emacs development tools and aids") + (mail . "email reading and posting") + (matching . "searching, matching, and sorting") (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") + (multimedia . "images and sound") + (news . "USENET news reading and posting") + (outlines . "hierarchical outlining and note taking") + (processes . "processes, subshells, and compilation") + (terminals . "text terminals (ttys)") + (tex . "the TeX document formatter") (tools . "programming tools") - (unix . "front-ends/assistants for, or emulators of, UNIX-like features") - (wp . "word processing") - )) + (unix . "UNIX feature interfaces and emulators") + (vc . "version control") + (wp . "word processing")) + "Association list of the standard \"Keywords:\" headers. +Each element has the form (KEYWORD . DESCRIPTION).") (defvar finder-mode-map (let ((map (make-sparse-keymap)) @@ -113,7 +105,8 @@ (define-key menu-map [finder-select] '(menu-item "Select" finder-select :help "Select item on current line in a finder buffer")) - map)) + map) + "Keymap used in `finder-mode'.") (defvar finder-mode-syntax-table (let ((st (make-syntax-table emacs-lisp-mode-syntax-table))) @@ -121,17 +114,14 @@ st) "Syntax table used while in `finder-mode'.") -(defvar finder-font-lock-keywords - '(("`\\([^'`]+\\)'" 1 font-lock-constant-face prepend)) - "Font-lock keywords for Finder mode.") - (defvar finder-headmark nil - "Internal finder-mode variable, local in finder buffer.") + "Internal Finder mode variable, local in Finder buffer.") ;;; Code for regenerating the keyword list. -(defvar finder-package-info nil - "Assoc list mapping file names to description & keyword lists.") +(defvar finder-keywords-hash nil + "Hash table mapping keywords to lists of package names. +Keywords and package names both should be symbols.") (defvar generated-finder-keywords-file "finder-inf.el" "The function `finder-compile-keywords' writes keywords into this file.") @@ -142,56 +132,148 @@ ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-01/msg00469.html ;; ldefs-boot is not auto-generated, but has nothing useful. (defvar finder-no-scan-regexp "\\(^\\.#\\|\\(loaddefs\\|ldefs-boot\\|\ -cus-load\\|finder-inf\\|esh-groups\\|subdirs\\)\\.el$\\)" +cus-load\\|finder-inf\\|esh-groups\\|subdirs\\|leim-list\\)\\.el$\\)" "Regexp matching file names not to scan for keywords.") (autoload 'autoload-rubric "autoload") +(defconst finder--builtins-descriptions + ;; I have no idea whether these are supposed to be capitalized + ;; and/or end in a full-stop. Existing file headers are inconsistent, + ;; but mainly seem to not do so. + '((emacs . "the extensible text editor") + (nxml . "a new XML mode")) + "Alist of built-in package descriptions. +Entries have the form (PACKAGE-SYMBOL . DESCRIPTION). +When generating `package--builtins', this overrides what the description +would otherwise be.") + +(defvar finder--builtins-alist + '(("calc" . calc) + ("ede" . ede) + ("erc" . erc) + ("eshell" . eshell) + ("gnus" . gnus) + ("international" . emacs) + ("language" . emacs) + ("mh-e" . mh-e) + ("semantic" . semantic) + ("analyze" . semantic) + ("bovine" . semantic) + ("decorate" . semantic) + ("symref" . semantic) + ("wisent" . semantic) + ;; This should really be ("nxml" . nxml-mode), because nxml-mode.el + ;; is the main file for the package. Then we would not need an + ;; entry in finder--builtins-descriptions. But I do not know if + ;; it is safe to change this, in case it is already in use. + ("nxml" . nxml) + ("org" . org) + ("srecode" . srecode) + ("term" . emacs) + ("url" . url)) + "Alist of built-in package directories. +Each element should have the form (DIR . PACKAGE), where DIR is a +directory name and PACKAGE is the name of a package (a symbol). +When generating `package--builtins', Emacs assumes any file in +DIR is part of the package PACKAGE.") + (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'." - (save-excursion - (find-file generated-finder-keywords-file) + "Regenerate list of built-in Emacs packages. +This recomputes `package--builtins' and `finder-keywords-hash', +and prints them into the file `generated-finder-keywords-file'. + +Optional DIRS is a list of Emacs Lisp directories to compile +from; the default is `load-path'." + ;; Allow compressed files also. + (setq package--builtins nil) + (setq finder-keywords-hash (make-hash-table :test 'eq)) + (let ((el-file-regexp "^\\([^=].*\\)\\.el\\(\\.\\(gz\\|Z\\)\\)?$") + package-override files base-name ; processed + summary keywords package version entry desc) + (dolist (d (or dirs load-path)) + (when (file-exists-p (directory-file-name d)) + (message "Scanning %s for finder" d) + (setq package-override + (intern-soft + (cdr-safe + (assoc (file-name-nondirectory (directory-file-name d)) + finder--builtins-alist)))) + (setq files (directory-files d nil el-file-regexp)) + (dolist (f files) + (unless (or (string-match finder-no-scan-regexp f) + (null (setq base-name + (and (string-match el-file-regexp f) + (intern (match-string 1 f)))))) +;; (memq base-name processed)) +;; There are multiple files in the tree with the same basename. +;; So skipping files based on basename means you randomly (depending +;; on which order the files are traversed in) miss some packages. +;; http://debbugs.gnu.org/14010 +;; You might think this could lead to two files providing the same package, +;; but it does not, because the duplicates are (at time of writing) +;; all due to files in cedet, which end up with package-override set. +;; FIXME this is obviously fragile. +;; Make the (eq base-name package) case below issue a warning if +;; package-override is nil? +;; (push base-name processed) + (with-temp-buffer + (insert-file-contents (expand-file-name f d)) + (setq keywords (mapcar 'intern (lm-keywords-list)) + package (or package-override + (let ((str (lm-header "package"))) + (if str (intern str))) + base-name) + summary (or (cdr + (assq package finder--builtins-descriptions)) + (lm-synopsis)) + version (lm-header "version"))) + (when summary + (setq version (ignore-errors (version-to-list version))) + (setq entry (assq package package--builtins)) + (cond ((null entry) + (push (cons package + (package-make-builtin version summary)) + package--builtins)) + ;; The idea here is that eg calc.el gets to define + ;; the description of the calc package. + ;; This does not work for eg nxml-mode.el. + ((or (eq base-name package) version) + (setq desc (cdr entry)) + (aset desc 0 version) + (aset desc 2 summary))) + (dolist (kw keywords) + (puthash kw + (cons package + (delq package + (gethash kw finder-keywords-hash))) + finder-keywords-hash)))))))) + + (setq package--builtins + (sort package--builtins + (lambda (a b) (string< (symbol-name (car a)) + (symbol-name (car b)))))) + + (with-current-buffer + (find-file-noselect generated-finder-keywords-file) (setq buffer-undo-list t) (erase-buffer) (insert (autoload-rubric generated-finder-keywords-file "keyword-to-package mapping" t)) (search-backward " ") - (insert "(setq finder-package-info '(\n") - (let (processed summary keywords) - (mapc - (lambda (d) - (when (file-exists-p (directory-file-name d)) - (message "Directory %s" d) - (mapc - (lambda (f) - ;; FIXME should this not be using (expand-file-name f d)? - (unless (or (member f processed) - (string-match finder-no-scan-regexp f)) - (setq processed (cons f processed)) - (with-temp-buffer - (insert-file-contents (expand-file-name f d)) - (setq summary (lm-synopsis) - keywords (lm-keywords-list))) - (insert - (format " (\"%s\"\n " - (if (string-match "\\.\\(gz\\|Z\\)$" f) - (file-name-sans-extension f) - f))) - (prin1 summary (current-buffer)) - (insert "\n ") - (prin1 (mapcar 'intern keywords) (current-buffer)) - (insert ")\n"))) - (directory-files d nil - ;; Allow compressed files also. FIXME: - ;; generalize this, especially for - ;; MS-DOG-type filenames. - "^[^=].*\\.el\\(\\.\\(gz\\|Z\\)\\)?$" - )))) - (or dirs load-path))) - (insert " ))\n") - (eval-buffer) ; so we get the new keyword list immediately + ;; FIXME: Now that we have package--builtin-versions, package--builtins is + ;; only needed to get the list of unversioned packages and to get the + ;; summary description of each package. + (insert "(setq package--builtins '(\n") + (dolist (package package--builtins) + (insert " ") + (prin1 package (current-buffer)) + (insert "\n")) + (insert "))\n\n") + ;; Insert hash table. + (insert "(setq finder-keywords-hash\n ") + (prin1 finder-keywords-hash (current-buffer)) + (insert ")\n") (basic-save-buffer))) (defun finder-compile-keywords-make-dist () @@ -230,27 +312,15 @@ no arguments compiles from `load-path'." help-echo finder-help-echo)))) (defun finder-unknown-keywords () - "Return an alist of unknown keywords and number of their occurences. -Unknown are keywords that are present in `finder-package-info' -but absent in `finder-known-keywords'." - (let ((unknown-keywords-hash (make-hash-table))) - ;; Prepare a hash where key is a keyword - ;; and value is the number of keyword occurences. - (mapc (lambda (package) - (mapc (lambda (keyword) - (unless (assq keyword finder-known-keywords) - (puthash keyword - (1+ (gethash keyword unknown-keywords-hash 0)) - unknown-keywords-hash))) - (nth 2 package))) - finder-package-info) - ;; Make an alist from the hash and sort by the keyword name. - (sort (let (unknown-keywords-list) - (maphash (lambda (key value) - (push (cons key value) unknown-keywords-list)) - unknown-keywords-hash) - unknown-keywords-list) - (lambda (a b) (string< (car a) (car b)))))) + "Return an alist of unknown keywords and number of their occurrences. +Unknown keywords are those present in `finder-keywords-hash' but +not `finder-known-keywords'." + (let (alist) + (maphash (lambda (kw packages) + (unless (assq kw finder-known-keywords) + (push (cons kw (length packages)) alist))) + finder-keywords-hash) + (sort alist (lambda (a b) (string< (car a) (car b)))))) ;;;###autoload (defun finder-list-keywords () @@ -260,46 +330,28 @@ but absent in `finder-known-keywords'." (pop-to-buffer "*Finder*") (pop-to-buffer (get-buffer-create "*Finder*")) (finder-mode) - (setq buffer-read-only nil - buffer-undo-list t) - (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) - buffer-read-only t) - (set-buffer-modified-p nil) - (balance-windows) - (finder-summary))) + (let ((inhibit-read-only t)) + (erase-buffer) + (dolist (assoc finder-known-keywords) + (let ((keyword (car assoc))) + (insert (propertize (symbol-name keyword) + 'font-lock-face 'font-lock-constant-face)) + (finder-insert-at-column 14 (concat (cdr assoc) "\n")) + (finder-mouse-face-on-line))) + (goto-char (point-min)) + (setq finder-headmark (point) + 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 - buffer-undo-list t) - (erase-buffer) - (let ((id (intern key))) - (insert - "The following packages match the keyword `" key "':\n\n") - (setq finder-headmark (point)) - (mapc - (lambda (x) - (when (memq id (cadr (cdr x))) - (insert (car x)) - (finder-insert-at-column 16 (concat (cadr 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))) + (let* ((id (intern key)) + (packages (gethash id finder-keywords-hash))) + (unless packages + (error "No packages matching key `%s'" key)) + (let ((package-list-unversioned t)) + (package-show-package-list packages)))) (define-button-type 'finder-xref 'action #'finder-goto-xref) @@ -360,7 +412,7 @@ FILE should be in a form suitable for passing to `locate-library'." key))) (defun finder-select () - "Select item on current line in a finder buffer." + "Select item on current line in a Finder buffer." (interactive) (let ((key (finder-current-item))) (if (string-match "\\.el$" key) @@ -368,7 +420,7 @@ FILE should be in a form suitable for passing to `locate-library'." (finder-list-matches key)))) (defun finder-mouse-select (event) - "Select item in a finder buffer with the mouse." + "Select item in a Finder buffer with the mouse." (interactive "e") (with-current-buffer (window-buffer (posn-window (event-start event))) (goto-char (posn-point (event-start event))) @@ -386,8 +438,8 @@ FILE should be in a form suitable for passing to `locate-library'." \\[finder-select] more help for the item on the current line \\[finder-exit] exit Finder mode and kill the Finder buffer." :syntax-table finder-mode-syntax-table - (setq font-lock-defaults '(finder-font-lock-keywords nil nil - (("+-*/.<>=!?$%_&~^:@" . "w")) nil)) + (setq buffer-read-only t + buffer-undo-list t) (set (make-local-variable 'finder-headmark) nil)) (defun finder-summary () @@ -404,11 +456,16 @@ finder directory, \\[finder-exit] = quit, \\[finder-summary] = help"))) Delete the window and kill all Finder-related buffers." (interactive) (ignore-errors (delete-window)) - (dolist (buff '("*Finder*" "*Finder-package*" "*Finder Category*")) - (and (get-buffer buff) (kill-buffer buff)))) + (let ((buf "*Finder*")) + (and (get-buffer buf) (kill-buffer buf)))) + +(defun finder-unload-function () + "Unload the Finder library." + (with-demoted-errors (unload-feature 'finder-inf t)) + ;; continue standard unloading + nil) (provide 'finder) -;; arch-tag: ec85ff49-8cb8-41f5-a63f-9131d53ce2c5 ;;; finder.el ends here