;;; finder.el --- topic & keyword-based code finder
-;; Copyright (C) 1992, 1997, 1998, 1999, 2001, 2002, 2003,
-;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1997, 1998, 1999, 2001, 2002, 2003, 2004, 2005,
+;; 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
;; Created: 16 Jun 1992
;; 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
(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)))
+ (let ((map (make-sparse-keymap))
+ (menu-map (make-sparse-keymap "Finder")))
(define-key map " " 'finder-select)
(define-key map "f" 'finder-select)
(define-key map [follow-link] 'mouse-face)
(define-key map "p" 'previous-line)
(define-key map "q" 'finder-exit)
(define-key map "d" 'finder-list-keywords)
+
+ (define-key map [menu-bar finder-mode]
+ (cons "Finder" menu-map))
+ (define-key menu-map [finder-exit]
+ '(menu-item "Quit" finder-exit
+ :help "Exit Finder mode"))
+ (define-key menu-map [finder-summary]
+ '(menu-item "Summary" finder-summary
+ :help "Summary item on current line in a finder buffer"))
+ (define-key menu-map [finder-list-keywords]
+ '(menu-item "List keywords" finder-list-keywords
+ :help "Display descriptions of the keywords in the Finder buffer"))
+ (define-key menu-map [finder-select]
+ '(menu-item "Select" finder-select
+ :help "Select item on current line in a finder buffer"))
map))
(defvar finder-mode-syntax-table
"Syntax table used while in `finder-mode'.")
(defvar finder-font-lock-keywords
- '(("`\\([^']+\\)'" 1 font-lock-constant-face prepend))
+ '(("`\\([^'`]+\\)'" 1 font-lock-constant-face prepend))
"Font-lock keywords for Finder mode.")
+(defvar finder-headmark nil
+ "Internal finder-mode variable, local in finder buffer.")
;;; Code for regenerating the keyword list.
"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.")
+ "The function `finder-compile-keywords' writes keywords into this file.")
+
+;; Skip autogenerated files, because they will never contain anything
+;; useful, and because in parallel builds of Emacs they may get
+;; modified while we are trying to read them.
+;; 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$\\)"
+ "Regexp matching file names not to scan for keywords.")
+
+(autoload 'autoload-rubric "autoload")
(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
- (let ((processed nil))
- (find-file generated-finder-keywords-file)
- (erase-buffer)
- (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")
+ (find-file 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 "\f")
+ (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)
- (mapcar
+ (mapc
(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 '" (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
- (basic-save-buffer))))
+ ;; 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 ")
+ (princ 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
+ (basic-save-buffer)))
(defun finder-compile-keywords-make-dist ()
"Regenerate `finder-inf.el' for the Emacs distribution."
"Put `mouse-face' and `help-echo' properties on the previous line."
(save-excursion
(forward-line -1)
+ ;; If finder-insert-at-column moved us to a new line, go back one more.
+ (if (looking-at "[ \t]") (forward-line -1))
(unless finder-help-echo
(setq finder-help-echo
(let* ((keys1 (where-is-internal 'finder-select
(interactive)
(if (get-buffer "*Finder*")
(pop-to-buffer "*Finder*")
- (pop-to-buffer (set-buffer (get-buffer-create "*Finder*")))
+ (pop-to-buffer (get-buffer-create "*Finder*"))
(finder-mode)
- (setq buffer-read-only nil)
+ (setq buffer-read-only nil
+ buffer-undo-list t)
(erase-buffer)
(mapc
(lambda (assoc)
(finder-mouse-face-on-line)))
finder-known-keywords)
(goto-char (point-min))
- (setq finder-headmark (point))
- (setq buffer-read-only t)
+ (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)
+ (setq buffer-read-only nil
+ buffer-undo-list t)
(erase-buffer)
(let ((id (intern key)))
(insert
(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))))
+ (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)
(shrink-window-if-larger-than-buffer)
(finder-summary)))
+(define-button-type 'finder-xref 'action #'finder-goto-xref)
+
+(defun finder-goto-xref (button)
+ "Jump to a lisp file for the BUTTON at point."
+ (let* ((file (button-get button 'xref))
+ (lib (locate-library file)))
+ (if lib (finder-commentary lib)
+ (message "Unable to locate `%s'" file))))
+
;;;###autoload
(defun finder-commentary (file)
"Display FILE's commentary section.
(apply-partially 'locate-file-completion-table
(or find-function-source-path load-path)
(find-library-suffixes)))))
- (let* ((str (lm-commentary (find-library-name file))))
- (if (null str)
- (error "Can't find any Commentary section"))
+ (let ((str (lm-commentary (find-library-name file))))
+ (or str (error "Can't find any Commentary section"))
;; This used to use *Finder* but that would clobber the
;; directory of categories.
- (delete-other-windows)
(pop-to-buffer "*Finder-package*")
- (setq buffer-read-only nil)
+ (setq buffer-read-only nil
+ buffer-undo-list t)
(erase-buffer)
(insert str)
(goto-char (point-min))
(while (re-search-forward "^;+ ?" nil t)
(replace-match "" nil nil))
(goto-char (point-min))
+ (while (re-search-forward "\\<\\([-[:alnum:]]+\\.el\\)\\>" nil t)
+ (if (locate-library (match-string 1))
+ (make-text-button (match-beginning 1) (match-end 1)
+ 'xref (match-string-no-properties 1)
+ 'help-echo "Read this file's commentary"
+ :type 'finder-xref)))
+ (goto-char (point-min))
(setq buffer-read-only t)
(set-buffer-modified-p nil)
(shrink-window-if-larger-than-buffer)
(beginning-of-line)
(current-word))))
(if (or (and finder-headmark (< (point) finder-headmark))
- (= (length key) 0))
+ (zerop (length key)))
(error "No keyword or filename on this line")
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))))
+ (with-current-buffer (window-buffer (posn-window (event-start event)))
(goto-char (posn-point (event-start event)))
(finder-select)))
(interactive)
(finder-list-keywords))
-(defun finder-mode ()
+(define-derived-mode finder-mode nil "Finder"
"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)
- (kill-all-local-variables)
- (use-local-map finder-mode-map)
- (set-syntax-table finder-mode-syntax-table)
+ :syntax-table finder-mode-syntax-table
(setq font-lock-defaults '(finder-font-lock-keywords nil nil
(("+-*/.<>=!?$%_&~^:@" . "w")) nil))
- (setq mode-name "Finder")
- (setq major-mode 'finder-mode)
- (set (make-local-variable 'finder-headmark) nil)
- (run-mode-hooks 'finder-mode-hook))
+ (set (make-local-variable 'finder-headmark) nil))
(defun finder-summary ()
"Summarize basic Finder commands."
(defun finder-exit ()
"Exit Finder mode.
-Delete the window and kill the buffer."
+Delete the window and kill all Finder-related buffers."
(interactive)
- (condition-case nil (delete-window) (error nil))
- (when (get-buffer "*Finder*") (kill-buffer "*Finder*"))
- (when (get-buffer "*Finder-package*") (kill-buffer "*Finder-package*"))
- (when (get-buffer "*Finder Category*") (kill-buffer "*Finder Category*")))
+ (ignore-errors (delete-window))
+ (dolist (buff '("*Finder*" "*Finder-package*" "*Finder Category*"))
+ (and (get-buffer buff) (kill-buffer buff))))
\f
(provide 'finder)
HCoop / bpt / emacs.git / blobdiff