X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/40f406674acfc16eb1f01fd23de83a0329e65eea..4d8ae757b2662eca9e0d49c3fb27e69fb85cab85:/lisp/info-look.el diff --git a/lisp/info-look.el b/lisp/info-look.el index 60410041b1..e7aedf47f5 100644 --- a/lisp/info-look.el +++ b/lisp/info-look.el @@ -1,9 +1,10 @@ -;;; info-look.el --- major-mode-sensitive Info index lookup facility. +;;; info-look.el --- major-mode-sensitive Info index lookup facility ;; An older version of this was known as libc.el. -;; Copyright (C) 1995, 1996, 1997, 1998 Free Software Foundation, Inc. +;; Copyright (C) 1995,96,97,98,99,2001 Free Software Foundation, Inc. -;; Author: Ralph Schleicher +;; Author: Ralph Schleicher +;; (did not show signs of life (Nov 2001) -stef) ;; Keywords: help languages ;; This file is part of GNU Emacs. @@ -23,17 +24,14 @@ ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, ;; Boston, MA 02111-1307, USA. +;;; Commentary: + +;; Really cool code to lookup info indexes. +;; Try especially info-lookup-symbol (aka C-h TAB). + ;;; Code: (require 'info) -(eval-and-compile - (condition-case nil - (require 'custom) - (error - (defmacro defgroup (&rest arg) - nil) - (defmacro defcustom (symbol value doc &rest arg) - `(defvar ,symbol ,value ,doc ,@arg))))) (defgroup info-lookup nil "Major mode sensitive help agent." @@ -57,6 +55,19 @@ Setting this variable to nil disables highlighting." (defvar info-lookup-highlight-overlay nil "Overlay object used for highlighting.") +(defcustom info-lookup-file-name-alist + '(("\\`configure\\.in\\'" . autoconf-mode) ;already covered by auto-mode-alist + ("\\`ac\\(local\\|site\\|include\\)\\.m4\\'" . autoconf-mode)) + "Alist of file names handled specially. +List elements are cons cells of the form + + (REGEXP . MODE) + +If a file name matches REGEXP, then use help mode MODE instead of the +buffer's major mode." + :group 'info-lookup :type '(repeat (cons (string :tag "Regexp") + (symbol :tag "Mode")))) + (defvar info-lookup-history nil "History of previous input lines.") @@ -117,13 +128,6 @@ OTHER-MODES is a list of cross references to other help modes.") (defsubst info-lookup->other-modes (topic mode) (nth 5 (info-lookup->mode-value topic mode))) -(eval-and-compile - (mapcar (lambda (keyword) - (or (boundp keyword) - (set keyword keyword))) - '(:topic :mode :regexp :ignore-case - :doc-spec :parse-rule :other-modes))) - (defun info-lookup-add-help (&rest arg) "Add or update a help specification. Function arguments are one or more options of the form @@ -140,7 +144,7 @@ to `symbol', and the help mode defaults to the current major mode." (apply 'info-lookup-add-help* nil arg)) (defun info-lookup-maybe-add-help (&rest arg) - "Add a help specification iff no one is defined. + "Add a help specification iff none is defined. See the documentation of the function `info-lookup-add-help' for more details." (apply 'info-lookup-add-help* t arg)) @@ -244,45 +248,59 @@ system." ;;;###autoload (defun info-lookup-symbol (symbol &optional mode) - "Display the documentation of a symbol. -If called interactively, SYMBOL will be read from the mini-buffer. -Prefix argument means unconditionally insert the default symbol name -into the mini-buffer so that it can be edited. -The default symbol is the one found at point." + "Display the definition of SYMBOL, as found in the relevant manual. +When this command is called interactively, it reads SYMBOL from the minibuffer. +In the minibuffer, use M-n to yank the default argument value +into the minibuffer so you can edit it. +The default symbol is the one found at point. + +With prefix arg a query for the symbol help mode is offered." (interactive - (info-lookup-interactive-arguments 'symbol)) + (info-lookup-interactive-arguments 'symbol current-prefix-arg)) (info-lookup 'symbol symbol mode)) ;;;###autoload (defun info-lookup-file (file &optional mode) "Display the documentation of a file. -If called interactively, FILE will be read from the mini-buffer. -Prefix argument means unconditionally insert the default file name -into the mini-buffer so that it can be edited. -The default file name is the one found at point." +When this command is called interactively, it reads FILE from the minibuffer. +In the minibuffer, use M-n to yank the default file name +into the minibuffer so you can edit it. +The default file name is the one found at point. + +With prefix arg a query for the file help mode is offered." (interactive - (info-lookup-interactive-arguments 'file)) + (info-lookup-interactive-arguments 'file current-prefix-arg)) (info-lookup 'file file mode)) -(defun info-lookup-interactive-arguments (topic) - "Return default value and help mode for help topic TOPIC." - (let* ((mode (if (info-lookup->mode-value - topic (or info-lookup-mode major-mode)) - (or info-lookup-mode major-mode) - (info-lookup-change-mode topic))) +(defun info-lookup-interactive-arguments (topic &optional query) + "Read and return argument value (and help mode) for help topic TOPIC. +If optional argument QUERY is non-nil, query for the help mode." + (let* ((mode (cond (query + (info-lookup-change-mode topic)) + ((info-lookup->mode-value topic (info-lookup-select-mode)) + info-lookup-mode) + ((info-lookup-change-mode topic)))) (completions (info-lookup->completions topic mode)) (default (info-lookup-guess-default topic mode)) - (input (if (or current-prefix-arg (not (assoc default completions))) - default)) (completion-ignore-case (info-lookup->ignore-case topic mode)) (enable-recursive-minibuffers t) (value (completing-read - (if (and default (not input)) + (if default (format "Describe %s (default %s): " topic default) (format "Describe %s: " topic)) - completions nil nil input 'info-lookup-history))) + completions nil nil nil 'info-lookup-history default))) (list (if (equal value "") default value) mode))) +(defun info-lookup-select-mode () + (when (and (not info-lookup-mode) (buffer-file-name)) + (let ((file-name (file-name-nondirectory (buffer-file-name))) + (file-name-alist info-lookup-file-name-alist)) + (while (and (not info-lookup-mode) file-name-alist) + (when (string-match (caar file-name-alist) file-name) + (setq info-lookup-mode (cdar file-name-alist))) + (setq file-name-alist (cdr file-name-alist))))) + (or info-lookup-mode (setq info-lookup-mode major-mode))) + (defun info-lookup-change-mode (topic) (let* ((completions (mapcar (lambda (arg) (cons (symbol-name (car arg)) (car arg))) @@ -298,8 +316,7 @@ The default file name is the one found at point." (defun info-lookup (topic item mode) "Display the documentation of a help item." - (if (not mode) - (setq mode (or info-lookup-mode major-mode))) + (or mode (setq mode (info-lookup-select-mode))) (or (info-lookup->mode-value topic mode) (error "No %s help available for `%s'" topic mode)) (let ((entry (or (assoc (if (info-lookup->ignore-case topic mode) @@ -309,10 +326,21 @@ The default file name is the one found at point." (modes (info-lookup->all-modes topic mode)) (window (selected-window)) found doc-spec node prefix suffix doc-found) - (if (not info-lookup-other-window-flag) + (if (or (not info-lookup-other-window-flag) + (eq (current-buffer) (get-buffer "*info*"))) (info) - (save-window-excursion (info)) - (switch-to-buffer-other-window "*info*")) + (progn + (save-window-excursion (info)) + ;; Determine whether or not the Info buffer is visible in + ;; another frame on the same display. If it is, simply raise + ;; that frame. Otherwise, display it in another window. + (let* ((window (get-buffer-window "*info*" t)) + (info-frame (and window (window-frame window)))) + (if (and info-frame + (display-multi-frame-p) + (memq info-frame (frames-on-display-list))) + (select-frame info-frame) + (switch-to-buffer-other-window "*info*"))))) (while (and (not found) modes) (setq doc-spec (info-lookup->doc-spec topic (car modes))) (while (and (not found) doc-spec) @@ -320,10 +348,10 @@ The default file name is the one found at point." prefix (nth 2 (car doc-spec)) suffix (nth 3 (car doc-spec))) (when (condition-case error-data - (progn + (progn (Info-goto-node node) (setq doc-found t)) - (error + (error (message "Cannot access Info node %s" node) (sit-for 1) nil)) @@ -339,7 +367,7 @@ The default file name is the one found at point." (re-search-forward (concat prefix (regexp-quote item) suffix)) (goto-char (match-beginning 0)) - (and window-system info-lookup-highlight-face + (and (display-color-p) info-lookup-highlight-face ;; Search again for ITEM so that the first ;; occurence of ITEM will be highlighted. (re-search-forward (regexp-quote item)) @@ -378,7 +406,9 @@ The default file name is the one found at point." (setq refer-modes (nreverse refer-modes)) ;; Build the full completion alist. (setq completions - (nconc (info-lookup-make-completions topic mode) + (nconc (condition-case nil + (info-lookup-make-completions topic mode) + (error nil)) (apply 'append (mapcar (lambda (arg) (info-lookup->completions topic arg)) @@ -417,10 +447,10 @@ The default file name is the one found at point." (with-current-buffer buffer (message "Processing Info node `%s'..." node) (when (condition-case error-data - (progn + (progn (Info-goto-node node) (setq doc-found t)) - (error + (error (message "Cannot access Info node `%s'" node) (sit-for 1) nil)) @@ -431,12 +461,17 @@ The default file name is the one found at point." (while (re-search-forward "\n\\* \\([^:\t\n]*\\):" nil t) (setq entry (match-string 1) item (funcall trans entry)) - (and (info-lookup->ignore-case topic mode) - (setq item (downcase item))) - (and (string-equal entry item) - (setq entry nil)) - (or (assoc item result) - (setq result (cons (cons item entry) result)))))) + ;; `trans' can return nil if the regexp doesn't match. + (when (and item + ;; Sometimes there's more than one Menu: + (not (string= entry "Menu"))) + (and (info-lookup->ignore-case topic mode) + (setq item (downcase item))) + (and (string-equal entry item) + (setq entry nil)) + (and (or (assoc item result) + (setq result (cons (cons item entry) + result)))))))) (error nil)))) (message "Processing Info node `%s'...done" node) (setq doc-spec (cdr doc-spec))) @@ -445,54 +480,57 @@ The default file name is the one found at point." result)) (defun info-lookup-guess-default (topic mode) - "Pick up default item at point (with favor to look back). -Return nil if there is nothing appropriate." + "Return a guess for a symbol to look up, based on text around point. +Try all related modes applicable to TOPIC and MODE. +Return nil if there is nothing appropriate in the buffer near point." (let ((modes (info-lookup->all-modes topic mode)) - (start (point)) guess whitespace) + guess) (while (and (not guess) modes) (setq guess (info-lookup-guess-default* topic (car modes)) - modes (cdr modes)) - (goto-char start)) + modes (cdr modes))) ;; Collapse whitespace characters. - (and guess (concat (delete nil (mapcar (lambda (ch) - (if (or (char-equal ch ? ) - (char-equal ch ?\t) - (char-equal ch ?\n)) - (if (not whitespace) - (setq whitespace ? )) - (setq whitespace nil) ch)) - guess)))))) + (when guess + (let ((pos 0)) + (while (string-match "[ \t\n]+" guess pos) + (setq pos (1+ (match-beginning 0))) + (setq guess (replace-match " " t t guess))))) + guess)) (defun info-lookup-guess-default* (topic mode) (let ((case-fold-search (info-lookup->ignore-case topic mode)) (rule (or (info-lookup->parse-rule topic mode) (info-lookup->regexp topic mode))) (start (point)) end regexp subexp result) - (if (symbolp rule) - (setq result (funcall rule)) - (if (consp rule) - (setq regexp (car rule) - subexp (cdr rule)) - (setq regexp rule - subexp 0)) - (skip-chars-backward " \t\n") (setq end (point)) - (while (and (re-search-backward regexp nil t) - (looking-at regexp) - (>= (match-end 0) end)) - (setq result (match-string subexp))) - (if (not result) - (progn - (goto-char start) - (skip-chars-forward " \t\n") - (and (looking-at regexp) - (setq result (match-string subexp)))))) + (save-excursion + (if (symbolp rule) + (setq result (funcall rule)) + (if (consp rule) + (setq regexp (car rule) + subexp (cdr rule)) + (setq regexp rule + subexp 0)) + ;; If at start of symbol, don't go back to end of previous one. + (if (save-match-data + (looking-at "[ \t\n]")) + (skip-chars-backward " \t\n")) + (setq end (point)) + (while (and (re-search-backward regexp nil t) + (looking-at regexp) + (>= (match-end 0) end)) + (setq result (match-string subexp))) + (if (not result) + (progn + (goto-char start) + (skip-chars-forward " \t\n") + (and (looking-at regexp) + (setq result (match-string subexp))))))) result)) (defun info-lookup-guess-c-symbol () "Get the C symbol at point." (condition-case nil (progn - (backward-sexp) + (skip-syntax-backward "w_") (let ((start (point)) prefix name) ;; Test for a leading `struct', `union', or `enum' keyword ;; but ignore names like `foo_struct'. @@ -522,8 +560,8 @@ Return nil if there is nothing appropriate." (info-complete 'symbol (or mode (if (info-lookup->mode-value - 'symbol (or info-lookup-mode major-mode)) - (or info-lookup-mode major-mode) + 'symbol (info-lookup-select-mode)) + info-lookup-mode (info-lookup-change-mode 'symbol))))) ;;;###autoload @@ -533,15 +571,14 @@ Return nil if there is nothing appropriate." (info-complete 'file (or mode (if (info-lookup->mode-value - 'file (or info-lookup-mode major-mode)) - (or info-lookup-mode major-mode) + 'file (info-lookup-select-mode)) + info-lookup-mode (info-lookup-change-mode 'file))))) (defun info-complete (topic mode) "Try to complete a help item." (barf-if-buffer-read-only) - (if (not mode) - (setq mode (or info-lookup-mode major-mode))) + (or mode (setq mode (info-lookup-select-mode))) (or (info-lookup->mode-value topic mode) (error "No %s completion available for `%s'" topic mode)) (let ((modes (info-lookup-quick-all-modes topic mode)) @@ -567,69 +604,16 @@ Return nil if there is nothing appropriate." (format "Complete %S: " topic) completions nil t completion info-lookup-history))) - (delete-region (- start (length try)) start) + ;; Find the original symbol and zap it. + (end-of-line) + (while (and (search-backward try nil t) + (< start (point)))) + (replace-match "") (insert completion)) (t (message "%s is complete" (capitalize (prin1-to-string topic)))))))) - -;;; Info-lookup minor mode. - -(defvar info-lookup-minor-mode nil - "Non-`nil' enables Info-lookup mode.") -(make-variable-buffer-local 'info-lookup-minor-mode) - -(defvar info-lookup-minor-mode-string " Info" - "Indicator included in the mode line when in Info-lookup mode.") - -(or (assq 'info-lookup-minor-mode minor-mode-alist) - (setq minor-mode-alist (cons '(info-lookup-minor-mode - info-lookup-minor-mode-string) - minor-mode-alist))) - -(defvar info-lookup-minor-mode-map (make-sparse-keymap) - "Minor mode map for Info-lookup mode.") - -(or (assq 'info-lookup-minor-mode minor-mode-map-alist) - (setq minor-mode-map-alist (cons (cons 'info-lookup-minor-mode - info-lookup-minor-mode-map) - minor-mode-map-alist))) - -;;;### autoload -(defun info-lookup-minor-mode (&optional arg) - "Minor mode for looking up the documentation of a symbol or file. -Special commands: - -\\{info-lookup-minor-mode-map}" - (interactive "P") - (setq info-lookup-minor-mode (if (null arg) - (not info-lookup-minor-mode) - (> (prefix-numeric-value arg) 0))) - (set-buffer-modified-p (buffer-modified-p))) - -(define-key info-lookup-minor-mode-map - "\C-c\C-hf" 'info-lookup-symbol) ; Describe function. -(define-key info-lookup-minor-mode-map - "\C-c\C-hv" 'info-lookup-symbol) ; Describe variable. -(define-key info-lookup-minor-mode-map - "\C-c\C-ht" 'info-lookup-symbol) ; Describe type. -(define-key info-lookup-minor-mode-map - "\C-c\C-hp" 'info-lookup-file) ; Describe program. -(define-key info-lookup-minor-mode-map - "\C-c\C-if" 'info-complete-symbol) ; Complete function. -(define-key info-lookup-minor-mode-map - "\C-c\C-iv" 'info-complete-symbol) ; Complete variable. -(define-key info-lookup-minor-mode-map - "\C-c\C-it" 'info-complete-symbol) ; Complete type. -(define-key info-lookup-minor-mode-map - "\C-c\C-ip" 'info-complete-file) ; Complete program. - -;;;### autoload -(defun turn-on-info-lookup () - "Unconditionally turn on Info-lookup mode." - (info-lookup-minor-mode 1)) - ;;; Initialize some common modes. @@ -663,8 +647,11 @@ Special commands: :mode 'makefile-mode :regexp "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z][_a-zA-Z0-9-]*" :doc-spec '(("(make)Name Index" nil + "^[ \t]*`" "'") + ("(automake)Macro and Variable Index" nil "^[ \t]*`" "'")) - :parse-rule "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z0-9-]+") + :parse-rule "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z0-9-]+" + :other-modes '(automake-mode)) (info-lookup-maybe-add-help :mode 'texinfo-mode @@ -687,7 +674,7 @@ Special commands: :regexp "A[CM]_[_A-Z0-9]+" :doc-spec '(("(autoconf)Macro Index" "AC_" "^[ \t]+- \\(Macro\\|Variable\\): .*\\<" "\\>") - ("(automake)Index" nil + ("(automake)Macro and Variable Index" nil "^[ \t]*`" "'")) ;; Autoconf symbols are M4 macros. Thus use M4's parser. :parse-rule 'ignore @@ -740,46 +727,59 @@ Special commands: "^" "\\b")) :parse-rule "[$@%]?\\([_a-zA-Z0-9]+\\|[^a-zA-Z]\\)") +(info-lookup-maybe-add-help + :mode 'cperl-mode + :regexp "[$@%][^a-zA-Z]\\|\\$\\^[A-Z]\\|[$@%]?[a-zA-Z][_a-zA-Z0-9]*" + :other-modes '(perl-mode)) + (info-lookup-maybe-add-help :mode 'latex-mode :regexp "\\\\\\([a-zA-Z]+\\|[^a-zA-Z]\\)" - :doc-spec '(("(latex2e)Command Index" nil + :doc-spec '(("(latex)Command Index" nil "`" "\\({[^}]*}\\)?'"))) -(info-lookup-maybe-add-help - :mode 'scheme-mode - :regexp ;; "\\(\\sw\\|\\s_\\)+" - "[^()' \t\n]+" - :ignore-case t - ;; Aubrey Jaffer's rendition from - :doc-spec '(("(r5rs)Index"))) - (info-lookup-maybe-add-help :mode 'emacs-lisp-mode - :regexp "[^()' \t\n]+" + :regexp "[^][()'\" \t\n]+" :doc-spec '(("(emacs)Command Index") ("(emacs)Variable Index") - ("(elisp)Index" - (lambda (item) - (let ((sym (intern-soft item))) - (cond ((null sym) - (if (string-equal item "nil") item)) - ((or (boundp sym) (fboundp sym)) - item)))) - "^[ \t]+- [^:]+:[ \t]*" "\\b"))) + ("(elisp)Index"))) (info-lookup-maybe-add-help :mode 'lisp-interaction-mode - :regexp "[^()' \t\n]+" + :regexp "[^][()'\" \t\n]+" :parse-rule 'ignore :other-modes '(emacs-lisp-mode)) (info-lookup-maybe-add-help :mode 'lisp-mode - :regexp "[^()' \t\n]+" + :regexp "[^()'\" \t\n]+" :parse-rule 'ignore :other-modes '(emacs-lisp-mode)) +(info-lookup-maybe-add-help + :mode 'scheme-mode + :regexp "[^()'\" \t\n]+" + :ignore-case t + ;; Aubrey Jaffer's rendition from + :doc-spec '(("(r5rs)Index" nil + "^[ \t]+- [^:]+:[ \t]*" "\\b"))) + +(info-lookup-maybe-add-help + :mode 'octave-mode + :regexp "[_a-zA-Z0-9]+" + :doc-spec '(("(octave)Function Index" nil + "^ - [^:]+:[ ]+\\(\\[[^=]*=[ ]+\\)?" nil) + ("(octave)Variable Index" nil "^ - [^:]+:[ ]+" nil) + ;; Catch lines of the form "xyz statement" + ("(octave)Concept Index" + (lambda (item) + (cond + ((string-match "^\\([A-Z]+\\) statement\\b" item) + (match-string 1 item)) + (t nil))) + nil; "^ - [^:]+:[ ]+" don't think this prefix is useful here. + nil))) (provide 'info-look)