-;;; 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, 1996, 1997, 1998, 1999, 2001, 2002, 2003,
+;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
-;; Author: Ralph Schleicher <rs@purple.UL.BaWue.DE>
+;; Author: Ralph Schleicher <rs@nunatak.allgaeu.org>
+;; (did not show signs of life (Nov 2001) -stef)
;; Keywords: help languages
;; 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)
+;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; 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.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
+
+;; Really cool code to lookup info indexes.
+;; Try especially info-lookup-symbol (aka C-h S).
;;; 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."
"Non-nil means pop up the Info buffer in another window."
:group 'info-lookup :type 'boolean)
-(defcustom info-lookup-highlight-face 'highlight
+(defcustom info-lookup-highlight-face 'match
"Face for highlighting looked up help items.
Setting this variable to nil disables highlighting."
:group 'info-lookup :type 'face)
(defvar info-lookup-highlight-overlay nil
"Overlay object used for highlighting.")
+(defcustom info-lookup-file-name-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.")
(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
(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 if none is defined.
See the documentation of the function `info-lookup-add-help'
for more details."
(apply 'info-lookup-add-help* t arg))
(cons (cons topic nil)
info-lookup-cache)))))
-(defsubst info-lookup->topic-cache (topic)
+(defun info-lookup->topic-cache (topic)
(cdr (info-lookup->cache topic)))
-(defsubst info-lookup->mode-cache (topic mode)
+(defun info-lookup->mode-cache (topic mode)
(assoc mode (info-lookup->topic-cache topic)))
-(defsubst info-lookup->initialized (topic mode)
+(defun info-lookup->initialized (topic mode)
(nth 1 (info-lookup->mode-cache topic mode)))
-(defsubst info-lookup->completions (topic mode)
+(defun info-lookup->completions (topic mode)
(or (info-lookup->initialized topic mode)
(info-lookup-setup-mode topic mode))
(nth 2 (info-lookup->mode-cache topic mode)))
-(defsubst info-lookup->refer-modes (topic mode)
+(defun info-lookup->refer-modes (topic mode)
(or (info-lookup->initialized topic mode)
(info-lookup-setup-mode topic mode))
(nth 3 (info-lookup->mode-cache topic mode)))
-(defsubst info-lookup->all-modes (topic mode)
+(defun info-lookup->all-modes (topic mode)
(cons mode (info-lookup->refer-modes topic mode)))
-(defvar info-lookup-file-alist
- '((c-mode
- "[_a-zA-Z0-9./+-]+" nil
- (("(libc)File Index"))))
- "*Alist of help specifications for file names.
-See the documentation of the variable `info-lookup-alist' for more details.")
+(defun info-lookup-quick-all-modes (topic mode)
+ (cons mode (info-lookup->other-modes topic mode)))
;;;###autoload
(defun info-lookup-reset ()
(interactive)
(setq info-lookup-cache nil))
+;;;###autoload (put 'info-lookup-symbol 'info-file "emacs")
;;;###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 (put 'info-lookup-file 'info-file "emacs")
;;;###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)))
(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)
- (downcase item) item)
- (info-lookup->completions topic mode))
- (error "Not documented as a %s: %s" topic (or item ""))))
- (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)
- (info)
- (save-window-excursion (info))
- (switch-to-buffer-other-window "*info*"))
+ (let* ((completions (info-lookup->completions topic mode))
+ (ignore-case (info-lookup->ignore-case topic mode))
+ (entry (or (assoc (if ignore-case (downcase item) item) completions)
+ (assoc-string item completions t)
+ (error "Not documented as a %s: %s" topic (or item ""))))
+ (modes (info-lookup->all-modes topic mode))
+ (window (selected-window))
+ found doc-spec node prefix suffix doc-found)
+ (if (not (eq major-mode 'Info-mode))
+ (if (not info-lookup-other-window-flag)
+ (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))
+ (not (eq info-frame (selected-frame))))
+ (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)
prefix (nth 2 (car doc-spec))
suffix (nth 3 (car doc-spec)))
(when (condition-case error-data
- (progn
- (Info-goto-node node)
- (setq doc-found t))
- (error
+ (progn
+ ;; Don't need Index menu fontifications here, and
+ ;; they slow down the lookup.
+ (let (Info-fontify-maximum-menu-size)
+ (Info-goto-node node)
+ (setq doc-found t)))
+ (error
(message "Cannot access Info node %s" node)
(sit-for 1)
nil))
(condition-case nil
(progn
- (Info-menu (or (cdr entry) item))
+ ;; Don't use Info-menu, it forces case-fold-search to t
+ (let ((case-fold-search nil))
+ (re-search-forward
+ (concat "^\\* " (regexp-quote (or (cdr entry) (car entry)))
+ ":")))
+ (Info-follow-nearest-node)
(setq found t)
(if (or prefix suffix)
(let ((case-fold-search
(buffer-read-only nil))
(goto-char (point-min))
(re-search-forward
- (concat prefix (regexp-quote item) suffix))
+ (concat prefix (regexp-quote (car entry)) 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))
+ ;; occurrence of ITEM will be highlighted.
+ (re-search-forward (regexp-quote (car entry)))
(let ((start (match-beginning 0))
(end (match-end 0)))
(if (overlayp info-lookup-highlight-overlay)
(error nil)))
(setq doc-spec (cdr doc-spec)))
(setq modes (cdr modes)))
+ ;; Alert the user if case was munged, and do this after bringing up the
+ ;; info buffer since that can print messages
+ (unless (or ignore-case
+ (string-equal item (car entry)))
+ (message "Found in different case: %s" (car entry)))
(or doc-found
(error "Info documentation for lookup was not found"))
;; Don't leave the Info buffer if the help item couldn't be looked up.
(message "No %s help available for `%s'" topic mode)
;; Recursively setup cross references.
;; But refer only to non-void modes.
- (mapcar (lambda (arg)
- (or (info-lookup->initialized topic arg)
- (info-lookup-setup-mode topic arg))
- (and (eq (info-lookup->initialized topic arg) t)
- (setq refer-modes (cons arg refer-modes))))
- (info-lookup->other-modes topic mode))
+ (dolist (arg (info-lookup->other-modes topic mode))
+ (or (info-lookup->initialized topic arg)
+ (info-lookup-setup-mode topic arg))
+ (and (eq (info-lookup->initialized topic arg) t)
+ (setq refer-modes (cons arg refer-modes))))
(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))
(let ((doc-spec (info-lookup->doc-spec topic mode))
(regexp (concat "^\\(" (info-lookup->regexp topic mode)
"\\)\\([ \t].*\\)?$"))
+ Info-fontify-maximum-menu-size
node trans entry item prefix result doc-found
(buffer (get-buffer-create " temp-info-look")))
(with-current-buffer buffer
(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))
(progn
(goto-char (point-min))
(and (search-forward "\n* Menu:" nil t)
- (while (re-search-forward "\n\\* \\([^:\t\n]*\\):" nil t)
+ (while (re-search-forward "\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)))
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'.
(concat prefix name))))
(error nil)))
+(defun info-lookup-guess-custom-symbol ()
+ "Get symbol at point in custom buffers."
+ (condition-case nil
+ (save-excursion
+ (let ((case-fold-search t)
+ (ignored-chars "][()`',:.\" \t\n")
+ (significant-chars "^][()`',:.\" \t\n")
+ beg end)
+ (cond
+ ((and (memq (get-char-property (point) 'face)
+ '(custom-variable-tag custom-variable-tag-face))
+ (setq beg (previous-single-char-property-change
+ (point) 'face nil (line-beginning-position)))
+ (setq end (next-single-char-property-change
+ (point) 'face nil (line-end-position)))
+ (> end beg))
+ (subst-char-in-string
+ ?\s ?\- (buffer-substring-no-properties beg end)))
+ ((or (and (looking-at (concat "[" significant-chars "]"))
+ (save-excursion
+ (skip-chars-backward significant-chars)
+ (setq beg (point)))
+ (skip-chars-forward significant-chars)
+ (setq end (point))
+ (> end beg))
+ (and (looking-at "[ \t\n]")
+ (looking-back (concat "[" significant-chars "]"))
+ (setq end (point))
+ (skip-chars-backward significant-chars)
+ (setq beg (point))
+ (> end beg))
+ (and (skip-chars-forward ignored-chars)
+ (setq beg (point))
+ (skip-chars-forward significant-chars)
+ (setq end (point))
+ (> end beg)))
+ (buffer-substring-no-properties beg end)))))
+ (error nil)))
+
;;;###autoload
(defun info-complete-symbol (&optional mode)
"Perform completion on symbol preceding point."
(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
(defun info-complete-file (&optional mode)
"Perform completion on file preceding point."
- (interactive
- (list (if (info-lookup->mode-value
- 'file (or info-lookup-mode major-mode))
- (or info-lookup-mode major-mode)
- (info-lookup-change-mode 'file))))
- (info-complete 'file mode))
+ (interactive)
+ (info-complete 'file
+ (or mode
+ (if (info-lookup->mode-value
+ '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->all-modes topic mode))
- (completions (info-lookup->completions topic mode))
- (completion-ignore-case (info-lookup->ignore-case topic mode))
- (start (point)) try completion)
+ (let ((modes (info-lookup-quick-all-modes topic mode))
+ (start (point))
+ try)
(while (and (not try) modes)
(setq mode (car modes)
modes (cdr modes)
(goto-char start))
(and (not try)
(error "Found no %S to complete" topic))
- (setq completion (try-completion try completions))
- (cond ((not completion)
- (ding)
- (message "No match"))
- ((stringp completion)
- (or (assoc completion completions)
- (setq completion (completing-read
- (format "Complete %S: " topic)
- completions nil t completion
- info-lookup-history)))
- (delete-region (- start (length try)) start)
- (insert completion))
- (t
- (message "%s is complete" (capitalize (prin1-to-string topic)))))))
-
-\f
-;;; 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))
+ (let ((completions (info-lookup->completions topic mode))
+ (completion-ignore-case (info-lookup->ignore-case topic mode))
+ completion)
+ (setq completion (try-completion try completions))
+ (cond ((not completion)
+ (ding)
+ (message "No match"))
+ ((stringp completion)
+ (or (assoc completion completions)
+ (setq completion (completing-read
+ (format "Complete %S: " topic)
+ completions nil t completion
+ info-lookup-history)))
+ ;; 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))))))))
\f
;;; Initialize some common modes.
:mode 'c-mode :topic 'symbol
:regexp "\\(struct \\|union \\|enum \\)?[_a-zA-Z][_a-zA-Z0-9]*"
:doc-spec '(("(libc)Function Index" nil
- "^[ \t]+- \\(Function\\|Macro\\): .*\\<" "\\>")
+ "^[ \t]+-+ \\(Function\\|Macro\\): .*\\<" "\\>")
+ ;; prefix/suffix has to match things like
+ ;; " -- Macro: int F_DUPFD"
+ ;; " -- Variable: char * tzname [2]"
+ ;; "`DBL_MAX'" (texinfo @table)
+ ;; suffix "\\>" is not used because that sends DBL_MAX to
+ ;; DBL_MAX_EXP ("_" is a non-word char)
("(libc)Variable Index" nil
- "^[ \t]+- \\(Variable\\|Macro\\): .*\\<" "\\>")
+ "^\\([ \t]+-+ \\(Variable\\|Macro\\): .*\\<\\|`\\)"
+ "\\( \\|'?$\\)")
("(libc)Type Index" nil
- "^[ \t]+- Data Type: \\<" "\\>")
+ "^[ \t]+-+ Data Type: \\<" "\\>")
("(termcap)Var Index" nil
"^[ \t]*`" "'"))
:parse-rule 'info-lookup-guess-c-symbol)
: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
(lambda (item)
(if (string-match "^\\([a-zA-Z]+\\|[^a-zA-Z]\\)\\( .*\\)?$" item)
(concat "@" (match-string 1 item))))
- "`" "'")))
+ "`" "[' ]")))
(info-lookup-maybe-add-help
:mode 'm4-mode
(info-lookup-maybe-add-help
:mode 'autoconf-mode
:regexp "A[CM]_[_A-Z0-9]+"
- :doc-spec '(("(autoconf)Macro Index" "AC_"
- "^[ \t]+- \\(Macro\\|Variable\\): .*\\<" "\\>")
- ("(automake)Index" nil
+ :doc-spec '(;; Autoconf Macro Index entries are without an "AC_" prefix,
+ ;; but with "AH_" or "AU_" for those. So add "AC_" if there
+ ;; isn't already an "A._".
+ ("(autoconf)Autoconf Macro Index"
+ (lambda (item)
+ (if (string-match "^A._" item) item (concat "AC_" item)))
+ "^[ \t]+-+ \\(Macro\\|Variable\\): .*\\<" "\\>")
+ ;; M4 Macro Index entries are without "AS_" prefixes, and
+ ;; mostly without "m4_" prefixes. "dnl" is an exception, not
+ ;; wanting any prefix. So AS_ is added back to upper-case
+ ;; names, m4_ to others which don't already an m4_.
+ ("(autoconf)M4 Macro Index"
+ (lambda (item)
+ (let ((case-fold-search nil))
+ (cond ((or (string-equal item "dnl")
+ (string-match "^m4_" item))
+ item)
+ ((string-match "^[A-Z0-9_]+$" item)
+ (concat "AS_" item))
+ (t
+ (concat "m4_" item)))))
+ "^[ \t]+-+ Macro: .*\\<" "\\>")
+ ;; Autotest Macro Index entries are without "AT_".
+ ("(autoconf)Autotest Macro Index" "AT_"
+ "^[ \t]+-+ Macro: .*\\<" "\\>")
+ ;; This is for older versions (probably pre autoconf 2.5x):
+ ("(autoconf)Macro Index" "AC_"
+ "^[ \t]+-+ \\(Macro\\|Variable\\): .*\\<" "\\>")
+ ;; Automake has index entries for its notes on various autoconf
+ ;; macros (eg. AC_PROG_CC). Ensure this is after the autoconf
+ ;; index, so as to prefer the autoconf docs.
+ ("(automake)Macro and Variable Index" nil
"^[ \t]*`" "'"))
;; Autoconf symbols are M4 macros. Thus use M4's parser.
:parse-rule 'ignore
"^" "\\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 'emacs-lisp-mode
- :regexp "[^()' \t\n]+"
- :doc-spec '(("(emacs)Command Index")
- ("(emacs)Variable Index")))
+ :regexp "[^][()`',\" \t\n]+"
+ :doc-spec '(;; Commands with key sequences appear in nodes as `foo' and
+ ;; those without as `M-x foo'.
+ ("(emacs)Command Index" nil "`\\(M-x[ \t\n]+\\)?" "'")
+ ;; Variables normally appear in nodes as just `foo'.
+ ("(emacs)Variable Index" nil "`" "'")
+ ;; Almost all functions, variables, etc appear in nodes as
+ ;; " -- Function: foo" etc. A small number of aliases and
+ ;; symbols appear only as `foo', and will miss out on exact
+ ;; positions. Allowing `foo' would hit too many false matches
+ ;; for things that should go to Function: etc, and those latter
+ ;; are much more important. Perhaps this could change if some
+ ;; sort of fallback match scheme existed.
+ ("(elisp)Index" nil "^ -+ .*: " "\\( \\|$\\)")))
(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]+"
: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 <URL:ftp://ftp-swiss.ai.mit.edu/pub/scm>
+ :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)))
+
+(info-lookup-maybe-add-help
+ :mode 'maxima-mode
+ :ignore-case t
+ :regexp "[a-zA-Z0-9_%]+"
+ :doc-spec '( ("(maxima)Function and Variable Index" nil
+ "^ -+ [^:]+:[ ]+\\(\\[[^=]*=[ ]+\\)?" nil)))
+
+(info-lookup-maybe-add-help
+ :mode 'inferior-maxima-mode
+ :regexp "[a-zA-Z0-9_%]+"
+ :other-modes '(maxima-mode))
+
+;; coreutils and bash builtins overlap in places, eg. printf, so there's a
+;; question which should come first. Some of the coreutils descriptions are
+;; more detailed, but if bash is usually /bin/sh on a GNU system then the
+;; builtins will be what's normally run.
+;;
+;; Maybe special variables like $? should be matched as $?, not just ?.
+;; This would avoid a clash between variable $! and negation !, or variable
+;; $# and comment # (though comment # is not currently indexed in bash).
+;; Unfortunately if $? etc is the symbol, then we wouldn't be taken to the
+;; exact spot in the relevant node, since the bash manual has just `?' etc
+;; there. Maybe an extension to the prefix/suffix scheme could help this.
+
+(info-lookup-maybe-add-help
+ :mode 'sh-mode :topic 'symbol
+ ;; bash has "." and ":" in its index, but those chars will probably never
+ ;; work in info, so don't bother matching them in the regexp.
+ :regexp "\\([a-zA-Z0-9_-]+\\|[!{}@*#?$]\\|\\[\\[?\\|]]?\\)"
+ :doc-spec '(("(bash)Builtin Index" nil "^`" "[ .']")
+ ("(bash)Reserved Word Index" nil "^`" "[ .']")
+ ("(bash)Variable Index" nil "^`" "[ .']")
+ ;; coreutils (version 4.5.10) doesn't have a separate program
+ ;; index, so exclude extraneous stuff (most of it) by demanding
+ ;; "[a-z]+" in the trans-func.
+ ("(coreutils)Index"
+ (lambda (item) (if (string-match "\\`[a-z]+\\'" item) item)))
+ ;; diff (version 2.8.1) has only a few programs, index entries
+ ;; are things like "foo invocation".
+ ("(diff)Index"
+ (lambda (item)
+ (if (string-match "\\`\\([a-z]+\\) invocation\\'" item)
+ (match-string 1 item))))
+ ;; there's no plain "sed" index entry as such, mung another
+ ;; hopefully unique one to get to the invocation section
+ ("(sed)Concept Index"
+ (lambda (item)
+ (if (string-equal item "Standard input, processing as input")
+ "sed")))
+ ;; there's no plain "awk" or "gawk" index entries, mung other
+ ;; hopefully unique ones to get to the command line options
+ ("(gawk)Index"
+ (lambda (item)
+ (cond ((string-equal item "gawk, extensions, disabling")
+ "awk")
+ ((string-equal item "gawk, versions of, information about, printing")
+ "gawk"))))))
+
+;; This misses some things which occur as node names but not in the
+;; index. Unfortunately it also picks up the wrong one of multiple
+;; entries for the same term in some cases. --fx
+(info-lookup-maybe-add-help
+ :mode 'cfengine-mode
+ :regexp "[[:alnum:]_]+\\(?:()\\)?"
+ :doc-spec '(("(cfengine-Reference)Variable Index"
+ (lambda (item)
+ ;; Index entries may be like `IsPlain()'
+ (if (string-match "\\([[:alnum:]_]+\\)()" item)
+ (match-string 1 item)
+ item))
+ ;; This gets functions in evaluated classes. Other
+ ;; possible patterns don't seem to work too well.
+ "`" "(")))
+
+(info-lookup-maybe-add-help
+ :mode 'custom-mode
+ :ignore-case t
+ :regexp "[^][()`',:\" \t\n]+"
+ :parse-rule 'info-lookup-guess-custom-symbol
+ :other-modes '(emacs-lisp-mode))
+
+(info-lookup-maybe-add-help
+ :mode 'help-mode
+ :regexp "[^][()`',:\" \t\n]+"
+ :other-modes '(emacs-lisp-mode))
\f
(provide 'info-look)
+;;; arch-tag: 0f1e3ea3-32a2-4461-bbab-3cff93539a74
;;; info-look.el ends here