annotate lisp/info-look.el @ 66424:86f81b226b02

*** empty log message ***
author Stefan Monnier <monnier@iro.umontreal.ca>
date Tue, 25 Oct 2005 04:58:35 +0000
parents 41bb365f41c4
children 3bd95f4f2941 2d92f5c9d6ae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38436
b174db545cfd Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents: 36605
diff changeset
1 ;;; info-look.el --- major-mode-sensitive Info index lookup facility
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 ;; An older version of this was known as libc.el.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
3
64762
41bb365f41c4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64091
diff changeset
4 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2001, 2002, 2003,
41bb365f41c4 Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 64091
diff changeset
5 ;; 2004, 2005 Free Software Foundation, Inc.
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6
30110
23cb074f9d88 Change author's mail address.
Gerd Moellmann <gerd@gnu.org>
parents: 28112
diff changeset
7 ;; Author: Ralph Schleicher <rs@nunatak.allgaeu.org>
41076
1be1f069f19f (makefile-mode): Add info for automake.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
8 ;; (did not show signs of life (Nov 2001) -stef)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 ;; Keywords: help languages
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 ;; This file is part of GNU Emacs.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 ;; it under the terms of the GNU General Public License as published by
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 ;; the Free Software Foundation; either version 2, or (at your option)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 ;; any later version.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 ;; GNU Emacs is distributed in the hope that it will be useful,
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 ;; GNU General Public License for more details.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 ;; You should have received a copy of the GNU General Public License
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
64091
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 59560
diff changeset
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
6fb026ad601f Update FSF's address.
Lute Kamstra <lute@gnu.org>
parents: 59560
diff changeset
26 ;; Boston, MA 02110-1301, USA.
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27
36605
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
28 ;;; Commentary:
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
29
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
30 ;; Really cool code to lookup info indexes.
53770
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
31 ;; Try especially info-lookup-symbol (aka C-h S).
36605
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
32
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 ;;; Code:
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35 (require 'info)
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
36
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
37 (defgroup info-lookup nil
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
38 "Major mode sensitive help agent."
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
39 :group 'help :group 'languages)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 (defvar info-lookup-mode nil
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
42 "Symbol of the current buffer's help mode.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
43 Help is provided according to the buffer's major mode if value is nil.
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 Automatically becomes buffer local when set in any fashion.")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 (make-variable-buffer-local 'info-lookup-mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
47 (defcustom info-lookup-other-window-flag t
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
48 "Non-nil means pop up the Info buffer in another window."
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
49 :group 'info-lookup :type 'boolean)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
50
58990
a009e1bf75be (info-lookup-highlight-face): Change default from `highlight' to `match'.
Juri Linkov <juri@jurta.org>
parents: 58798
diff changeset
51 (defcustom info-lookup-highlight-face 'match
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
52 "Face for highlighting looked up help items.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
53 Setting this variable to nil disables highlighting."
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
54 :group 'info-lookup :type 'face)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
55
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
56 (defvar info-lookup-highlight-overlay nil
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 "Overlay object used for highlighting.")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
59 (defcustom info-lookup-file-name-alist
46525
d09ed551daf4 Support current auto{conf,make} manuals.
Dave Love <fx@gnu.org>
parents: 42942
diff changeset
60 '(("\\`ac\\(local\\|site\\|include\\)\\.m4\\'" . autoconf-mode))
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
61 "Alist of file names handled specially.
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
62 List elements are cons cells of the form
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
63
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
64 (REGEXP . MODE)
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
65
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
66 If a file name matches REGEXP, then use help mode MODE instead of the
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
67 buffer's major mode."
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
68 :group 'info-lookup :type '(repeat (cons (string :tag "Regexp")
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
69 (symbol :tag "Mode"))))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
70
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 (defvar info-lookup-history nil
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72 "History of previous input lines.")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
74 (defvar info-lookup-alist nil
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
75 "Alist of known help topics.
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 Cons cells are of the form
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
78 (HELP-TOPIC . HELP-DATA)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 HELP-TOPIC is the symbol of a help topic.
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
81 HELP-DATA is a HELP-TOPIC's public data set.
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 Value is an alist with elements of the form
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 (HELP-MODE REGEXP IGNORE-CASE DOC-SPEC PARSE-RULE OTHER-MODES)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86 HELP-MODE is a mode's symbol.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 REGEXP is a regular expression matching those help items whose
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 documentation can be looked up via DOC-SPEC.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89 IGNORE-CASE is non-nil if help items are case insensitive.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
90 DOC-SPEC is a list of documentation specifications of the form
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
91
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92 (INFO-NODE TRANS-FUNC PREFIX SUFFIX)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 INFO-NODE is the name (including file name part) of an Info index.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95 TRANS-FUNC is a function translating index entries into help items;
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 nil means add only those index entries matching REGEXP, a string
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 means prepend string to the first word of all index entries.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98 PREFIX and SUFFIX are parts of a regular expression. If one of
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 them is non-nil then search the help item's Info node for the
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
100 first occurrence of the regular expression `PREFIX ITEM SUFFIX'.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 ITEM will be highlighted with `info-lookup-highlight-face' if this
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 variable is not nil.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 PARSE-RULE is either the symbol name of a function or a regular
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 expression for guessing the default help item at point. Fuzzy
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
105 regular expressions like \"[_a-zA-Z0-9]+\" do a better job if
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 there are no clear delimiters; do not try to write too complex
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 expressions. PARSE-RULE defaults to REGEXP.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108 OTHER-MODES is a list of cross references to other help modes.")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 (defsubst info-lookup->topic-value (topic)
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
111 (cdr (assoc topic info-lookup-alist)))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 (defsubst info-lookup->mode-value (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 (assoc mode (info-lookup->topic-value topic)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
116 (defsubst info-lookup->regexp (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 (nth 1 (info-lookup->mode-value topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 (defsubst info-lookup->ignore-case (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 (nth 2 (info-lookup->mode-value topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 (defsubst info-lookup->doc-spec (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 (nth 3 (info-lookup->mode-value topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 (defsubst info-lookup->parse-rule (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 (nth 4 (info-lookup->mode-value topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 (defsubst info-lookup->other-modes (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 (nth 5 (info-lookup->mode-value topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
131 (defun info-lookup-add-help (&rest arg)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
132 "Add or update a help specification.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
133 Function arguments are one or more options of the form
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
134
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
135 KEYWORD ARGUMENT
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
136
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
137 KEYWORD is either `:topic', `:mode', `:regexp', `:ignore-case',
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
138 `:doc-spec', `:parse-rule', or `:other-modes'.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
139 ARGUMENT has a value as explained in the documentation of the
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
140 variable `info-lookup-alist'.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
141
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
142 If no topic or mode option has been specified, then the help topic defaults
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
143 to `symbol', and the help mode defaults to the current major mode."
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
144 (apply 'info-lookup-add-help* nil arg))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
145
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
146 (defun info-lookup-maybe-add-help (&rest arg)
36605
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
147 "Add a help specification iff none is defined.
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
148 See the documentation of the function `info-lookup-add-help'
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
149 for more details."
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
150 (apply 'info-lookup-add-help* t arg))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
151
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
152 (defun info-lookup-add-help* (maybe &rest arg)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
153 (let (topic mode regexp ignore-case doc-spec
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
154 parse-rule other-modes keyword value)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
155 (setq topic 'symbol
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
156 mode major-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
157 regexp "\\w+")
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
158 (while arg
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
159 (setq keyword (car arg))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
160 (or (symbolp keyword)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
161 (error "Junk in argument list \"%S\"" arg))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
162 (setq arg (cdr arg))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
163 (and (null arg)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
164 (error "Keyword \"%S\" is missing an argument" keyword))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
165 (setq value (car arg)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
166 arg (cdr arg))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
167 (cond ((eq keyword :topic)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
168 (setq topic value))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
169 ((eq keyword :mode)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
170 (setq mode value))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
171 ((eq keyword :regexp)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
172 (setq regexp value))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
173 ((eq keyword :ignore-case)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
174 (setq ignore-case value))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
175 ((eq keyword :doc-spec)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
176 (setq doc-spec value))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
177 ((eq keyword :parse-rule)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
178 (setq parse-rule value))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
179 ((eq keyword :other-modes)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
180 (setq other-modes value))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
181 (t
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
182 (error "Unknown keyword \"%S\"" keyword))))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
183 (or (and maybe (info-lookup->mode-value topic mode))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
184 (let* ((data (list regexp ignore-case doc-spec parse-rule other-modes))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
185 (topic-cell (or (assoc topic info-lookup-alist)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
186 (car (setq info-lookup-alist
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
187 (cons (cons topic nil)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
188 info-lookup-alist)))))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
189 (mode-cell (assoc mode topic-cell)))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
190 (if (null mode-cell)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
191 (setcdr topic-cell (cons (cons mode data) (cdr topic-cell)))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
192 (setcdr mode-cell data))))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
193 nil))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
194
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 (defvar info-lookup-cache nil
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
196 "Cache storing data maintained automatically by the program.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
197 Value is an alist with cons cell of the form
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
198
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
199 (HELP-TOPIC . ((HELP-MODE INITIALIZED COMPLETIONS REFER-MODES) ...))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
200
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
201 HELP-TOPIC is the symbol of a help topic.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202 HELP-MODE is a mode's symbol.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 INITIALIZED is nil if HELP-MODE is uninitialized, t if
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 HELP-MODE is initialized, and `0' means HELP-MODE is
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 initialized but void.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 COMPLETIONS is an alist of documented help items.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 REFER-MODES is a list of other help modes to use.")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
208
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
209 (defsubst info-lookup->cache (topic)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210 (or (assoc topic info-lookup-cache)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
211 (car (setq info-lookup-cache
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 (cons (cons topic nil)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213 info-lookup-cache)))))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
215 (defun info-lookup->topic-cache (topic)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216 (cdr (info-lookup->cache topic)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
218 (defun info-lookup->mode-cache (topic mode)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 (assoc mode (info-lookup->topic-cache topic)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
221 (defun info-lookup->initialized (topic mode)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222 (nth 1 (info-lookup->mode-cache topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
224 (defun info-lookup->completions (topic mode)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 (or (info-lookup->initialized topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 (info-lookup-setup-mode topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
227 (nth 2 (info-lookup->mode-cache topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
228
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
229 (defun info-lookup->refer-modes (topic mode)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
230 (or (info-lookup->initialized topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231 (info-lookup-setup-mode topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 (nth 3 (info-lookup->mode-cache topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
234 (defun info-lookup->all-modes (topic mode)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
235 (cons mode (info-lookup->refer-modes topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
237 (defun info-lookup-quick-all-modes (topic mode)
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
238 (cons mode (info-lookup->other-modes topic mode)))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
239
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240 ;;;###autoload
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241 (defun info-lookup-reset ()
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
242 "Throw away all cached data.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243 This command is useful if the user wants to start at the beginning without
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
244 quitting Emacs, for example, after some Info documents were updated on the
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
245 system."
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246 (interactive)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247 (setq info-lookup-cache nil))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
248
57469
2967bbb0802b (info-lookup-file): Add info-file property.
Richard M. Stallman <rms@gnu.org>
parents: 55238
diff changeset
249 ;;;###autoload (put 'info-lookup-symbol 'info-file "emacs")
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
250 ;;;###autoload
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
251 (defun info-lookup-symbol (symbol &optional mode)
24829
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
252 "Display the definition of SYMBOL, as found in the relevant manual.
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
253 When this command is called interactively, it reads SYMBOL from the minibuffer.
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
254 In the minibuffer, use M-n to yank the default argument value
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
255 into the minibuffer so you can edit it.
25057
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
256 The default symbol is the one found at point.
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
257
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
258 With prefix arg a query for the symbol help mode is offered."
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 (interactive
25057
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
260 (info-lookup-interactive-arguments 'symbol current-prefix-arg))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 (info-lookup 'symbol symbol mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262
57469
2967bbb0802b (info-lookup-file): Add info-file property.
Richard M. Stallman <rms@gnu.org>
parents: 55238
diff changeset
263 ;;;###autoload (put 'info-lookup-file 'info-file "emacs")
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264 ;;;###autoload
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 (defun info-lookup-file (file &optional mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266 "Display the documentation of a file.
24829
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
267 When this command is called interactively, it reads FILE from the minibuffer.
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
268 In the minibuffer, use M-n to yank the default file name
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
269 into the minibuffer so you can edit it.
25057
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
270 The default file name is the one found at point.
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
271
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
272 With prefix arg a query for the file help mode is offered."
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
273 (interactive
25057
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
274 (info-lookup-interactive-arguments 'file current-prefix-arg))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
275 (info-lookup 'file file mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
276
25057
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
277 (defun info-lookup-interactive-arguments (topic &optional query)
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
278 "Read and return argument value (and help mode) for help topic TOPIC.
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
279 If optional argument QUERY is non-nil, query for the help mode."
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
280 (let* ((mode (cond (query
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
281 (info-lookup-change-mode topic))
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
282 ((info-lookup->mode-value topic (info-lookup-select-mode))
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
283 info-lookup-mode)
6019ba9c1a95 (info-lookup-interactive-arguments): Add optional
Karl Heuer <kwzh@gnu.org>
parents: 25041
diff changeset
284 ((info-lookup-change-mode topic))))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
285 (completions (info-lookup->completions topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286 (default (info-lookup-guess-default topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
287 (completion-ignore-case (info-lookup->ignore-case topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
288 (enable-recursive-minibuffers t)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
289 (value (completing-read
24829
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
290 (if default
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291 (format "Describe %s (default %s): " topic default)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
292 (format "Describe %s: " topic))
24829
749c12791859 (info-lookup-file, info-lookup-symbol): Doc fix.
Karl Heuer <kwzh@gnu.org>
parents: 24769
diff changeset
293 completions nil nil nil 'info-lookup-history default)))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
294 (list (if (equal value "") default value) mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
295
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
296 (defun info-lookup-select-mode ()
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
297 (when (and (not info-lookup-mode) (buffer-file-name))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
298 (let ((file-name (file-name-nondirectory (buffer-file-name)))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
299 (file-name-alist info-lookup-file-name-alist))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
300 (while (and (not info-lookup-mode) file-name-alist)
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
301 (when (string-match (caar file-name-alist) file-name)
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
302 (setq info-lookup-mode (cdar file-name-alist)))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
303 (setq file-name-alist (cdr file-name-alist)))))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
304 (or info-lookup-mode (setq info-lookup-mode major-mode)))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
305
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
306 (defun info-lookup-change-mode (topic)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
307 (let* ((completions (mapcar (lambda (arg)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
308 (cons (symbol-name (car arg)) (car arg)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
309 (info-lookup->topic-value topic)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
310 (mode (completing-read
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
311 (format "Use %s help mode: " topic)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
312 completions nil t nil 'info-lookup-history)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313 (or (setq mode (cdr (assoc mode completions)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314 (error "No %s help available" topic))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
315 (or (info-lookup->mode-value topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
316 (error "No %s help available for `%s'" topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
317 (setq info-lookup-mode mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
318
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
319 (defun info-lookup (topic item mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
320 "Display the documentation of a help item."
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
321 (or mode (setq mode (info-lookup-select-mode)))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
322 (or (info-lookup->mode-value topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
323 (error "No %s help available for `%s'" topic mode))
48940
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
324 (let* ((completions (info-lookup->completions topic mode))
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
325 (ignore-case (info-lookup->ignore-case topic mode))
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
326 (entry (or (assoc (if ignore-case (downcase item) item) completions)
53407
0e54e5e10501 (info-lookup): Use assoc-string.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
327 (assoc-string item completions t)
48940
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
328 (error "Not documented as a %s: %s" topic (or item ""))))
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
329 (modes (info-lookup->all-modes topic mode))
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
330 (window (selected-window))
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
331 found doc-spec node prefix suffix doc-found)
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
332 (if (not (eq major-mode 'Info-mode))
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
333 (if (not info-lookup-other-window-flag)
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
334 (info)
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
335 (progn
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
336 (save-window-excursion (info))
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
337 ;; Determine whether or not the Info buffer is visible in
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
338 ;; another frame on the same display. If it is, simply raise
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
339 ;; that frame. Otherwise, display it in another window.
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
340 (let* ((window (get-buffer-window "*info*" t))
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
341 (info-frame (and window (window-frame window))))
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
342 (if (and info-frame
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
343 (display-multi-frame-p)
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
344 (memq info-frame (frames-on-display-list))
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
345 (not (eq info-frame (selected-frame))))
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
346 (select-frame info-frame)
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
347 (switch-to-buffer-other-window "*info*"))))))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
348 (while (and (not found) modes)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 (setq doc-spec (info-lookup->doc-spec topic (car modes)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350 (while (and (not found) doc-spec)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351 (setq node (nth 0 (car doc-spec))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352 prefix (nth 2 (car doc-spec))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 suffix (nth 3 (car doc-spec)))
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
354 (when (condition-case error-data
25310
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
355 (progn
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
356 (Info-goto-node node)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
357 (setq doc-found t))
25310
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
358 (error
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
359 (message "Cannot access Info node %s" node)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
360 (sit-for 1)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
361 nil))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
362 (condition-case nil
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
363 (progn
48940
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
364 ;; Don't use Info-menu, it forces case-fold-search to t
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
365 (let ((case-fold-search nil))
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
366 (re-search-forward
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
367 (concat "^\\* " (regexp-quote (or (cdr entry) (car entry)))
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
368 ":")))
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
369 (Info-follow-nearest-node)
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
370 (setq found t)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
371 (if (or prefix suffix)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
372 (let ((case-fold-search
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
373 (info-lookup->ignore-case topic (car modes)))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
374 (buffer-read-only nil))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
375 (goto-char (point-min))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
376 (re-search-forward
48940
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
377 (concat prefix (regexp-quote (car entry)) suffix))
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
378 (goto-char (match-beginning 0))
28112
853a7fcaf7f0 (info-lookup): Use display-color-p.
Dave Love <fx@gnu.org>
parents: 25364
diff changeset
379 (and (display-color-p) info-lookup-highlight-face
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
380 ;; Search again for ITEM so that the first
42942
048fa049ccba Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 41076
diff changeset
381 ;; occurrence of ITEM will be highlighted.
48940
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
382 (re-search-forward (regexp-quote (car entry)))
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
383 (let ((start (match-beginning 0))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
384 (end (match-end 0)))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
385 (if (overlayp info-lookup-highlight-overlay)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
386 (move-overlay info-lookup-highlight-overlay
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
387 start end (current-buffer))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
388 (setq info-lookup-highlight-overlay
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
389 (make-overlay start end))))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
390 (overlay-put info-lookup-highlight-overlay
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
391 'face info-lookup-highlight-face)))))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
392 (error nil)))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393 (setq doc-spec (cdr doc-spec)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394 (setq modes (cdr modes)))
48940
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
395 ;; Alert the user if case was munged, and do this after bringing up the
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
396 ;; info buffer since that can print messages
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
397 (unless (or ignore-case
78987e4bee15 (info-lookup): For ease of use try item
Richard M. Stallman <rms@gnu.org>
parents: 46525
diff changeset
398 (string-equal item (car entry)))
48988
d50289791f55 (info-lookup): Fix error message typo.
Richard M. Stallman <rms@gnu.org>
parents: 48940
diff changeset
399 (message "Found in different case: %s" (car entry)))
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
400 (or doc-found
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
401 (error "Info documentation for lookup was not found"))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 ;; Don't leave the Info buffer if the help item couldn't be looked up.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 (if (and info-lookup-other-window-flag found)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 (select-window window))))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 (defun info-lookup-setup-mode (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407 "Initialize the internal data structure."
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 (or (info-lookup->initialized topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 (let (cell data (initialized 0) completions refer-modes)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410 (if (not (info-lookup->mode-value topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411 (message "No %s help available for `%s'" topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 ;; Recursively setup cross references.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 ;; But refer only to non-void modes.
55097
5c2770cd5506 Add support for cfengine-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54387
diff changeset
414 (dolist (arg (info-lookup->other-modes topic mode))
5c2770cd5506 Add support for cfengine-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54387
diff changeset
415 (or (info-lookup->initialized topic arg)
5c2770cd5506 Add support for cfengine-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54387
diff changeset
416 (info-lookup-setup-mode topic arg))
5c2770cd5506 Add support for cfengine-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54387
diff changeset
417 (and (eq (info-lookup->initialized topic arg) t)
5c2770cd5506 Add support for cfengine-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54387
diff changeset
418 (setq refer-modes (cons arg refer-modes))))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 (setq refer-modes (nreverse refer-modes))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 ;; Build the full completion alist.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421 (setq completions
25041
d45a32b777f6 (info-lookup-setup-mode): Don't give up, if
Karl Heuer <kwzh@gnu.org>
parents: 24829
diff changeset
422 (nconc (condition-case nil
d45a32b777f6 (info-lookup-setup-mode): Don't give up, if
Karl Heuer <kwzh@gnu.org>
parents: 24829
diff changeset
423 (info-lookup-make-completions topic mode)
d45a32b777f6 (info-lookup-setup-mode): Don't give up, if
Karl Heuer <kwzh@gnu.org>
parents: 24829
diff changeset
424 (error nil))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425 (apply 'append
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
426 (mapcar (lambda (arg)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
427 (info-lookup->completions topic arg))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428 refer-modes))))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429 (setq initialized t))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
430 ;; Update `info-lookup-cache'.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431 (setq cell (info-lookup->mode-cache topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432 data (list initialized completions refer-modes))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
433 (if (not cell)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
434 (setcdr (info-lookup->cache topic)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
435 (cons (cons mode data) (info-lookup->topic-cache topic)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
436 (setcdr cell data))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
437 initialized)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
438
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
439 (defun info-lookup-make-completions (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440 "Create a unique alist from all index entries."
20519
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
441 (let ((doc-spec (info-lookup->doc-spec topic mode))
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
442 (regexp (concat "^\\(" (info-lookup->regexp topic mode)
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
443 "\\)\\([ \t].*\\)?$"))
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
444 node trans entry item prefix result doc-found
20519
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
445 (buffer (get-buffer-create " temp-info-look")))
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
446 (with-current-buffer buffer
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
447 (Info-mode))
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
448 (while doc-spec
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
449 (setq node (nth 0 (car doc-spec))
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
450 trans (cond ((eq (nth 1 (car doc-spec)) nil)
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
451 (lambda (arg)
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
452 (if (string-match regexp arg)
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
453 (match-string 1 arg))))
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
454 ((stringp (nth 1 (car doc-spec)))
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
455 (setq prefix (nth 1 (car doc-spec)))
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
456 (lambda (arg)
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
457 (if (string-match "^\\([^: \t\n]+\\)" arg)
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
458 (concat prefix (match-string 1 arg)))))
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
459 (t (nth 1 (car doc-spec)))))
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
460 (with-current-buffer buffer
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
461 (message "Processing Info node `%s'..." node)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
462 (when (condition-case error-data
25310
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
463 (progn
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
464 (Info-goto-node node)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
465 (setq doc-found t))
25310
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
466 (error
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
467 (message "Cannot access Info node `%s'" node)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
468 (sit-for 1)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
469 nil))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
470 (condition-case nil
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
471 (progn
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
472 (goto-char (point-min))
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
473 (and (search-forward "\n* Menu:" nil t)
50950
a7b2bce87058 (info-lookup-make-completions): Allow colons in index entries by looking for ":
Juanma Barranquero <lekktu@gmail.com>
parents: 50451
diff changeset
474 (while (re-search-forward "\n\\* \\(.*\\): " nil t)
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
475 (setq entry (match-string 1)
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
476 item (funcall trans entry))
23365
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
477 ;; `trans' can return nil if the regexp doesn't match.
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
478 (when (and item
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
479 ;; Sometimes there's more than one Menu:
25310
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
480 (not (string= entry "Menu")))
23365
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
481 (and (info-lookup->ignore-case topic mode)
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
482 (setq item (downcase item)))
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
483 (and (string-equal entry item)
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
484 (setq entry nil))
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
485 (and (or (assoc item result)
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
486 (setq result (cons (cons item entry)
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
487 result))))))))
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
488 (error nil))))
20519
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
489 (message "Processing Info node `%s'...done" node)
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
490 (setq doc-spec (cdr doc-spec)))
20690
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
491 (or doc-found
a51c71dd5cda (info-lookup): Report if Info-goto-node fails.
Richard M. Stallman <rms@gnu.org>
parents: 20519
diff changeset
492 (error "Info documentation for lookup was not found"))
20519
c7b3ef0ed1ad (info-lookup-symbol-alist): Handle Emacs Lisp mode.
Richard M. Stallman <rms@gnu.org>
parents: 18323
diff changeset
493 result))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 (defun info-lookup-guess-default (topic mode)
25222
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
496 "Return a guess for a symbol to look up, based on text around point.
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
497 Try all related modes applicable to TOPIC and MODE.
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
498 Return nil if there is nothing appropriate in the buffer near point."
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 (let ((modes (info-lookup->all-modes topic mode))
25222
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
500 guess)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501 (while (and (not guess) modes)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502 (setq guess (info-lookup-guess-default* topic (car modes))
25222
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
503 modes (cdr modes)))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504 ;; Collapse whitespace characters.
25222
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
505 (when guess
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
506 (let ((pos 0))
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
507 (while (string-match "[ \t\n]+" guess pos)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
508 (setq pos (1+ (match-beginning 0)))
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
509 (setq guess (replace-match " " t t guess)))))
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
510 guess))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 (defun info-lookup-guess-default* (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 (let ((case-fold-search (info-lookup->ignore-case topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 (rule (or (info-lookup->parse-rule topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 (info-lookup->regexp topic mode)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516 (start (point)) end regexp subexp result)
25222
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
517 (save-excursion
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
518 (if (symbolp rule)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
519 (setq result (funcall rule))
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
520 (if (consp rule)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
521 (setq regexp (car rule)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
522 subexp (cdr rule))
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
523 (setq regexp rule
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
524 subexp 0))
25310
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
525 ;; If at start of symbol, don't go back to end of previous one.
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
526 (if (save-match-data
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
527 (looking-at "[ \t\n]"))
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
528 (skip-chars-backward " \t\n"))
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
529 (setq end (point))
25222
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
530 (while (and (re-search-backward regexp nil t)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
531 (looking-at regexp)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
532 (>= (match-end 0) end))
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
533 (setq result (match-string subexp)))
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
534 (if (not result)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
535 (progn
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
536 (goto-char start)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
537 (skip-chars-forward " \t\n")
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
538 (and (looking-at regexp)
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
539 (setq result (match-string subexp)))))))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 result))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542 (defun info-lookup-guess-c-symbol ()
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
543 "Get the C symbol at point."
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 (condition-case nil
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 (progn
25222
1802f1bb3285 (info-lookup-guess-c-symbol): Use skip-syntax-backward.
Karl Heuer <kwzh@gnu.org>
parents: 25057
diff changeset
546 (skip-syntax-backward "w_")
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 (let ((start (point)) prefix name)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 ;; Test for a leading `struct', `union', or `enum' keyword
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549 ;; but ignore names like `foo_struct'.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 (setq prefix (and (< (skip-chars-backward " \t\n") 0)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
551 (< (skip-chars-backward "_a-zA-Z0-9") 0)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
552 (looking-at "\\(struct\\|union\\|enum\\)\\s ")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
553 (concat (match-string 1) " ")))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
554 (goto-char start)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
555 (and (looking-at "[_a-zA-Z][_a-zA-Z0-9]*")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
556 (setq name (match-string 0)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557 ;; Caveat! Look forward if point is at `struct' etc.
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558 (and (not prefix)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 (or (string-equal name "struct")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 (string-equal name "union")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561 (string-equal name "enum"))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 (looking-at "[a-z]+\\s +\\([_a-zA-Z][_a-zA-Z0-9]*\\)")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 (setq prefix (concat name " ")
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 name (match-string 1)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 (and (or prefix name)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 (concat prefix name))))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 (error nil)))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 ;;;###autoload
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 (defun info-complete-symbol (&optional mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
571 "Perform completion on symbol preceding point."
18323
64d728fb396a (info-complete-symbol): If MODE is nil, use the default value.
Richard M. Stallman <rms@gnu.org>
parents: 18322
diff changeset
572 (interactive)
64d728fb396a (info-complete-symbol): If MODE is nil, use the default value.
Richard M. Stallman <rms@gnu.org>
parents: 18322
diff changeset
573 (info-complete 'symbol
64d728fb396a (info-complete-symbol): If MODE is nil, use the default value.
Richard M. Stallman <rms@gnu.org>
parents: 18322
diff changeset
574 (or mode
64d728fb396a (info-complete-symbol): If MODE is nil, use the default value.
Richard M. Stallman <rms@gnu.org>
parents: 18322
diff changeset
575 (if (info-lookup->mode-value
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
576 'symbol (info-lookup-select-mode))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
577 info-lookup-mode
18323
64d728fb396a (info-complete-symbol): If MODE is nil, use the default value.
Richard M. Stallman <rms@gnu.org>
parents: 18322
diff changeset
578 (info-lookup-change-mode 'symbol)))))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
579
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
580 ;;;###autoload
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
581 (defun info-complete-file (&optional mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
582 "Perform completion on file preceding point."
20973
b7e7f7c9685a Added support for the Emacs Lisp manual.
Karl Heuer <kwzh@gnu.org>
parents: 20909
diff changeset
583 (interactive)
b7e7f7c9685a Added support for the Emacs Lisp manual.
Karl Heuer <kwzh@gnu.org>
parents: 20909
diff changeset
584 (info-complete 'file
b7e7f7c9685a Added support for the Emacs Lisp manual.
Karl Heuer <kwzh@gnu.org>
parents: 20909
diff changeset
585 (or mode
b7e7f7c9685a Added support for the Emacs Lisp manual.
Karl Heuer <kwzh@gnu.org>
parents: 20909
diff changeset
586 (if (info-lookup->mode-value
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
587 'file (info-lookup-select-mode))
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
588 info-lookup-mode
20973
b7e7f7c9685a Added support for the Emacs Lisp manual.
Karl Heuer <kwzh@gnu.org>
parents: 20909
diff changeset
589 (info-lookup-change-mode 'file)))))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 (defun info-complete (topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 "Try to complete a help item."
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593 (barf-if-buffer-read-only)
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
594 (or mode (setq mode (info-lookup-select-mode)))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595 (or (info-lookup->mode-value topic mode)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 (error "No %s completion available for `%s'" topic mode))
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
597 (let ((modes (info-lookup-quick-all-modes topic mode))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
598 (start (point))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
599 try)
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600 (while (and (not try) modes)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 (setq mode (car modes)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 modes (cdr modes)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603 try (info-lookup-guess-default* topic mode))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604 (goto-char start))
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 (and (not try)
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
606 (error "Found no %S to complete" topic))
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
607 (let ((completions (info-lookup->completions topic mode))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
608 (completion-ignore-case (info-lookup->ignore-case topic mode))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
609 completion)
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
610 (setq completion (try-completion try completions))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
611 (cond ((not completion)
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
612 (ding)
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
613 (message "No match"))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
614 ((stringp completion)
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
615 (or (assoc completion completions)
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
616 (setq completion (completing-read
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
617 (format "Complete %S: " topic)
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
618 completions nil t completion
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
619 info-lookup-history)))
25310
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
620 ;; Find the original symbol and zap it.
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
621 (end-of-line)
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
622 (while (and (search-backward try nil t)
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
623 (< start (point))))
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
624 (replace-match "")
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
625 (insert completion))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
626 (t
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
627 (message "%s is complete"
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
628 (capitalize (prin1-to-string topic))))))))
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
629
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
630
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
631 ;;; Initialize some common modes.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
632
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
633 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
634 :mode 'c-mode :topic 'symbol
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
635 :regexp "\\(struct \\|union \\|enum \\)?[_a-zA-Z][_a-zA-Z0-9]*"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
636 :doc-spec '(("(libc)Function Index" nil
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
637 "^[ \t]+-+ \\(Function\\|Macro\\): .*\\<" "\\>")
59558
5d4f8c85454f (c-mode/symbol): Add ^` to prefix, and change
Eli Zaretskii <eliz@gnu.org>
parents: 58990
diff changeset
638 ;; prefix/suffix has to match things like
5d4f8c85454f (c-mode/symbol): Add ^` to prefix, and change
Eli Zaretskii <eliz@gnu.org>
parents: 58990
diff changeset
639 ;; " -- Macro: int F_DUPFD"
5d4f8c85454f (c-mode/symbol): Add ^` to prefix, and change
Eli Zaretskii <eliz@gnu.org>
parents: 58990
diff changeset
640 ;; " -- Variable: char * tzname [2]"
5d4f8c85454f (c-mode/symbol): Add ^` to prefix, and change
Eli Zaretskii <eliz@gnu.org>
parents: 58990
diff changeset
641 ;; "`DBL_MAX'" (texinfo @table)
5d4f8c85454f (c-mode/symbol): Add ^` to prefix, and change
Eli Zaretskii <eliz@gnu.org>
parents: 58990
diff changeset
642 ;; suffix "\\>" is not used because that sends DBL_MAX to
5d4f8c85454f (c-mode/symbol): Add ^` to prefix, and change
Eli Zaretskii <eliz@gnu.org>
parents: 58990
diff changeset
643 ;; DBL_MAX_EXP ("_" is a non-word char)
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
644 ("(libc)Variable Index" nil
59558
5d4f8c85454f (c-mode/symbol): Add ^` to prefix, and change
Eli Zaretskii <eliz@gnu.org>
parents: 58990
diff changeset
645 "^\\([ \t]+-+ \\(Variable\\|Macro\\): .*\\<\\|`\\)"
5d4f8c85454f (c-mode/symbol): Add ^` to prefix, and change
Eli Zaretskii <eliz@gnu.org>
parents: 58990
diff changeset
646 "\\( \\|'?$\\)")
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
647 ("(libc)Type Index" nil
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
648 "^[ \t]+-+ Data Type: \\<" "\\>")
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
649 ("(termcap)Var Index" nil
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
650 "^[ \t]*`" "'"))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
651 :parse-rule 'info-lookup-guess-c-symbol)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
652
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
653 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
654 :mode 'c-mode :topic 'file
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
655 :regexp "[_a-zA-Z0-9./+-]+"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
656 :doc-spec '(("(libc)File Index")))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
657
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
658 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
659 :mode 'bison-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
660 :regexp "[:;|]\\|%\\([%{}]\\|[_a-z]+\\)\\|YY[_A-Z]+\\|yy[_a-z]+"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
661 :doc-spec '(("(bison)Index" nil
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
662 "`" "'"))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
663 :parse-rule "[:;|]\\|%\\([%{}]\\|[_a-zA-Z][_a-zA-Z0-9]*\\)"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
664 :other-modes '(c-mode))
20899
d1f6ac340403 (info-complete): Display completions on second invocation at same point
Richard M. Stallman <rms@gnu.org>
parents: 20690
diff changeset
665
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
666 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
667 :mode 'makefile-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
668 :regexp "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z][_a-zA-Z0-9-]*"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
669 :doc-spec '(("(make)Name Index" nil
41076
1be1f069f19f (makefile-mode): Add info for automake.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
670 "^[ \t]*`" "'")
1be1f069f19f (makefile-mode): Add info for automake.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
671 ("(automake)Macro and Variable Index" nil
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
672 "^[ \t]*`" "'"))
41076
1be1f069f19f (makefile-mode): Add info for automake.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
673 :parse-rule "\\$[^({]\\|\\.[_A-Z]*\\|[_a-zA-Z0-9-]+"
1be1f069f19f (makefile-mode): Add info for automake.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
674 :other-modes '(automake-mode))
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
675
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
676 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
677 :mode 'texinfo-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
678 :regexp "@\\([a-zA-Z]+\\|[^a-zA-Z]\\)"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
679 :doc-spec '(("(texinfo)Command and Variable Index"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
680 ;; Ignore Emacs commands and prepend a `@'.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
681 (lambda (item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
682 (if (string-match "^\\([a-zA-Z]+\\|[^a-zA-Z]\\)\\( .*\\)?$" item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
683 (concat "@" (match-string 1 item))))
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
684 "`" "[' ]")))
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
685
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
686 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
687 :mode 'm4-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
688 :regexp "[_a-zA-Z][_a-zA-Z0-9]*"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
689 :doc-spec '(("(m4)Macro index"))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
690 :parse-rule "[_a-zA-Z0-9]+")
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
691
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
692 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
693 :mode 'autoconf-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
694 :regexp "A[CM]_[_A-Z0-9]+"
51242
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
695 :doc-spec '(;; Autoconf Macro Index entries are without an "AC_" prefix,
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
696 ;; but with "AH_" or "AU_" for those. So add "AC_" if there
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
697 ;; isn't already an "A._".
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
698 ("(autoconf)Autoconf Macro Index"
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
699 (lambda (item)
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
700 (if (string-match "^A._" item) item (concat "AC_" item)))
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
701 "^[ \t]+-+ \\(Macro\\|Variable\\): .*\\<" "\\>")
51242
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
702 ;; M4 Macro Index entries are without "AS_" prefixes, and
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
703 ;; mostly without "m4_" prefixes. "dnl" is an exception, not
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
704 ;; wanting any prefix. So AS_ is added back to upper-case
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
705 ;; names, m4_ to others which don't already an m4_.
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
706 ("(autoconf)M4 Macro Index"
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
707 (lambda (item)
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
708 (let ((case-fold-search nil))
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
709 (cond ((or (string-equal item "dnl")
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
710 (string-match "^m4_" item))
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
711 item)
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
712 ((string-match "^[A-Z0-9_]+$" item)
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
713 (concat "AS_" item))
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
714 (t
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
715 (concat "m4_" item)))))
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
716 "^[ \t]+-+ Macro: .*\\<" "\\>")
51242
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
717 ;; Autotest Macro Index entries are without "AT_".
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
718 ("(autoconf)Autotest Macro Index" "AT_"
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
719 "^[ \t]+-+ Macro: .*\\<" "\\>")
51242
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
720 ;; This is for older versions (probably pre autoconf 2.5x):
46525
d09ed551daf4 Support current auto{conf,make} manuals.
Dave Love <fx@gnu.org>
parents: 42942
diff changeset
721 ("(autoconf)Macro Index" "AC_"
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
722 "^[ \t]+-+ \\(Macro\\|Variable\\): .*\\<" "\\>")
51242
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
723 ;; Automake has index entries for its notes on various autoconf
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
724 ;; macros (eg. AC_PROG_CC). Ensure this is after the autoconf
661e2fe7e775 (autoconf-mode setups): Recognise AH_ and AU_ entries in "(autoconf)Autoconf
Juanma Barranquero <lekktu@gmail.com>
parents: 50950
diff changeset
725 ;; index, so as to prefer the autoconf docs.
41076
1be1f069f19f (makefile-mode): Add info for automake.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 38436
diff changeset
726 ("(automake)Macro and Variable Index" nil
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
727 "^[ \t]*`" "'"))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
728 ;; Autoconf symbols are M4 macros. Thus use M4's parser.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
729 :parse-rule 'ignore
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
730 :other-modes '(m4-mode))
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
731
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
732 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
733 :mode 'awk-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
734 :regexp "[_a-zA-Z]+"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
735 :doc-spec '(("(gawk)Index"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
736 (lambda (item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
737 (let ((case-fold-search nil))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
738 (cond
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
739 ;; `BEGIN' and `END'.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
740 ((string-match "^\\([A-Z]+\\) special pattern\\b" item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
741 (match-string 1 item))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
742 ;; `if', `while', `do', ...
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
743 ((string-match "^\\([a-z]+\\) statement\\b" item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
744 (if (not (string-equal (match-string 1 item) "control"))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
745 (match-string 1 item)))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
746 ;; `NR', `NF', ...
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
747 ((string-match "^[A-Z]+$" item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
748 item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
749 ;; Built-in functions (matches to many entries).
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
750 ((string-match "^[a-z]+$" item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
751 item))))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
752 "`" "\\([ \t]*([^)]*)\\)?'")))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
753
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
754 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
755 :mode 'perl-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
756 :regexp "[$@%][^a-zA-Z]\\|\\$\\^[A-Z]\\|[$@%]?[a-zA-Z][_a-zA-Z0-9]*"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
757 :doc-spec '(("(perl5)Function Index"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
758 (lambda (item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
759 (if (string-match "^\\([a-zA-Z0-9]+\\)" item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
760 (match-string 1 item)))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
761 "^" "\\b")
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
762 ("(perl5)Variable Index"
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
763 (lambda (item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
764 ;; Work around bad formatted array variables.
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
765 (let ((sym (cond ((or (string-match "^\\$\\(.\\|@@\\)$" item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
766 (string-match "^\\$\\^[A-Z]$" item))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
767 item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
768 ((string-match
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
769 "^\\([$%@]\\|@@\\)?[_a-zA-Z0-9]+" item)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
770 (match-string 0 item))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
771 (t ""))))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
772 (if (string-match "@@" sym)
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
773 (setq sym (concat (substring sym 0 (match-beginning 0))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
774 (substring sym (1- (match-end 0))))))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
775 (if (string-equal sym "") nil sym)))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
776 "^" "\\b"))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
777 :parse-rule "[$@%]?\\([_a-zA-Z0-9]+\\|[^a-zA-Z]\\)")
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
778
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
779 (info-lookup-maybe-add-help
36605
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
780 :mode 'cperl-mode
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
781 :regexp "[$@%][^a-zA-Z]\\|\\$\\^[A-Z]\\|[$@%]?[a-zA-Z][_a-zA-Z0-9]*"
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
782 :other-modes '(perl-mode))
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
783
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
784 (info-lookup-maybe-add-help
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
785 :mode 'latex-mode
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
786 :regexp "\\\\\\([a-zA-Z]+\\|[^a-zA-Z]\\)"
25041
d45a32b777f6 (info-lookup-setup-mode): Don't give up, if
Karl Heuer <kwzh@gnu.org>
parents: 24829
diff changeset
787 :doc-spec '(("(latex)Command Index" nil
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
788 "`" "\\({[^}]*}\\)?'")))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
789
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
790 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
791 :mode 'emacs-lisp-mode
36605
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
792 :regexp "[^][()'\" \t\n]+"
50451
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
793 :doc-spec '(;; Commands with key sequences appear in nodes as `foo' and
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
794 ;; those without as `M-x foo'.
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
795 ("(emacs)Command Index" nil "`\\(M-x[ \t\n]+\\)?" "'")
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
796 ;; Variables normally appear in nodes as just `foo'.
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
797 ("(emacs)Variable Index" nil "`" "'")
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
798 ;; Almost all functions, variables, etc appear in nodes as
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
799 ;; " -- Function: foo" etc. A small number of aliases and
50451
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
800 ;; symbols appear only as `foo', and will miss out on exact
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
801 ;; positions. Allowing `foo' would hit too many false matches
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
802 ;; for things that should go to Function: etc, and those latter
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
803 ;; are much more important. Perhaps this could change if some
fedb9513a26e (emacs-lisp-mode): Add prefix/suffix matching regexps.
Juanma Barranquero <lekktu@gmail.com>
parents: 50407
diff changeset
804 ;; sort of fallback match scheme existed.
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
805 ("(elisp)Index" nil "^ -+ .*: " "\\( \\|$\\)")))
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
806
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
807 (info-lookup-maybe-add-help
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
808 :mode 'lisp-interaction-mode
36605
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
809 :regexp "[^][()'\" \t\n]+"
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
810 :parse-rule 'ignore
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
811 :other-modes '(emacs-lisp-mode))
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
812
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
813 (info-lookup-maybe-add-help
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
814 :mode 'lisp-mode
36605
d29b9968e84f Docstring fixes and dead code eliminated.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 30348
diff changeset
815 :regexp "[^()'\" \t\n]+"
21334
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
816 :parse-rule 'ignore
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
817 :other-modes '(emacs-lisp-mode))
66b3b9fe3e3c (info-lookup->topic-cache): Use defun, not defsubst.
Richard M. Stallman <rms@gnu.org>
parents: 20973
diff changeset
818
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
819 (info-lookup-maybe-add-help
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
820 :mode 'scheme-mode
54160
815ea37f89e4 In scheme-mode symbol regexp, disallow backquote and
Eli Zaretskii <eliz@gnu.org>
parents: 53770
diff changeset
821 :regexp "[^()`',\" \t\n]+"
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
822 :ignore-case t
23365
d400637428d1 Remove duplicate scheme-mode entry.
Dave Love <fx@gnu.org>
parents: 23346
diff changeset
823 ;; Aubrey Jaffer's rendition from <URL:ftp://ftp-swiss.ai.mit.edu/pub/scm>
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
824 :doc-spec '(("(r5rs)Index" nil
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
825 "^[ \t]+-+ [^:]+:[ \t]*" "\\b")))
22281
fa2cf768a61a Added support for Scheme.
Karl Heuer <kwzh@gnu.org>
parents: 22266
diff changeset
826
23346
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
827 (info-lookup-maybe-add-help
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
828 :mode 'octave-mode
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
829 :regexp "[_a-zA-Z0-9]+"
50407
41c0eed9d556 *** empty log message ***
Juanma Barranquero <lekktu@gmail.com>
parents: 50347
diff changeset
830 :doc-spec '(("(octave)Function Index" nil
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
831 "^ -+ [^:]+:[ ]+\\(\\[[^=]*=[ ]+\\)?" nil)
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
832 ("(octave)Variable Index" nil "^ -+ [^:]+:[ ]+" nil)
23346
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
833 ;; Catch lines of the form "xyz statement"
25310
f38d26cd9b8f Remove compatibility code.
Dave Love <fx@gnu.org>
parents: 25222
diff changeset
834 ("(octave)Concept Index"
23346
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
835 (lambda (item)
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
836 (cond
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
837 ((string-match "^\\([A-Z]+\\) statement\\b" item)
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
838 (match-string 1 item))
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
839 (t nil)))
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
840 nil; "^ -+ [^:]+:[ ]+" don't think this prefix is useful here.
23346
4db659df7407 Add support for Octave.
Stephen Eglen <stephen@gnu.org>
parents: 22281
diff changeset
841 nil)))
50347
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
842
53770
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
843 (info-lookup-maybe-add-help
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
844 :mode 'maxima-mode
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
845 :ignore-case t
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
846 :regexp "[a-zA-Z_%]+"
58017
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
847 :doc-spec '( ("(maxima)Function and Variable Index" nil
57d5e5e2e4db (info-lookup): Allow reusing in the current buffer
Juri Linkov <juri@jurta.org>
parents: 57469
diff changeset
848 "^ -+ [^:]+:[ ]+\\(\\[[^=]*=[ ]+\\)?" nil)))
53770
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
849
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
850 (info-lookup-maybe-add-help
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
851 :mode 'inferior-maxima-mode
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
852 :other-modes '(maxima-mode))
293189a557d0 Add support for maxima-mode. Update commentary
Stephen Eglen <stephen@gnu.org>
parents: 53407
diff changeset
853
50347
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
854 ;; coreutils and bash builtins overlap in places, eg. printf, so there's a
50407
41c0eed9d556 *** empty log message ***
Juanma Barranquero <lekktu@gmail.com>
parents: 50347
diff changeset
855 ;; question which should come first. Some of the coreutils descriptions are
50347
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
856 ;; more detailed, but if bash is usually /bin/sh on a GNU system then the
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
857 ;; builtins will be what's normally run.
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
858 ;;
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
859 ;; Maybe special variables like $? should be matched as $?, not just ?.
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
860 ;; This would avoid a clash between variable $! and negation !, or variable
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
861 ;; $# and comment # (though comment # is not currently indexed in bash).
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
862 ;; Unfortunately if $? etc is the symbol, then we wouldn't be taken to the
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
863 ;; exact spot in the relevant node, since the bash manual has just `?' etc
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
864 ;; there. Maybe an extension to the prefix/suffix scheme could help this.
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
865
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
866 (info-lookup-maybe-add-help
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
867 :mode 'sh-mode :topic 'symbol
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
868 ;; bash has "." and ":" in its index, but those chars will probably never
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
869 ;; work in info, so don't bother matching them in the regexp.
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
870 :regexp "\\([a-zA-Z0-9_-]+\\|[!{}@*#?$]\\|\\[\\[?\\|]]?\\)"
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
871 :doc-spec '(("(bash)Builtin Index" nil "^`" "[ .']")
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
872 ("(bash)Reserved Word Index" nil "^`" "[ .']")
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
873 ("(bash)Variable Index" nil "^`" "[ .']")
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
874 ;; coreutils (version 4.5.10) doesn't have a separate program
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
875 ;; index, so exclude extraneous stuff (most of it) by demanding
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
876 ;; "[a-z]+" in the trans-func.
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
877 ("(coreutils)Index"
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
878 (lambda (item) (if (string-match "\\`[a-z]+\\'" item) item)))
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
879 ;; diff (version 2.8.1) has only a few programs, index entries
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
880 ;; are things like "foo invocation".
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
881 ("(diff)Index"
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
882 (lambda (item)
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
883 (if (string-match "\\`\\([a-z]+\\) invocation\\'" item)
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
884 (match-string 1 item))))
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
885 ;; there's no plain "sed" index entry as such, mung another
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
886 ;; hopefully unique one to get to the invocation section
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
887 ("(sed)Concept Index"
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
888 (lambda (item)
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
889 (if (string-equal item "Standard input, processing as input")
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
890 "sed")))
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
891 ;; there's no plain "awk" or "gawk" index entries, mung other
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
892 ;; hopefully unique ones to get to the command line options
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
893 ("(gawk)Index"
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
894 (lambda (item)
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
895 (cond ((string-equal item "gawk, extensions, disabling")
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
896 "awk")
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
897 ((string-equal item "gawk, versions of, information about, printing")
d6a0264d2fe2 (sh-mode): Add doc-specs for commands and variables.
Juanma Barranquero <lekktu@gmail.com>
parents: 48988
diff changeset
898 "gawk"))))))
55097
5c2770cd5506 Add support for cfengine-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54387
diff changeset
899
55238
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
900 ;; This misses some things which occur as node names but not in the
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
901 ;; index. Unfortunately it also picks up the wrong one of multiple
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
902 ;; entries for the same term in some cases. --fx
55097
5c2770cd5506 Add support for cfengine-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54387
diff changeset
903 (info-lookup-maybe-add-help
5c2770cd5506 Add support for cfengine-mode.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 54387
diff changeset
904 :mode 'cfengine-mode
58798
bcb4709c5b09 (info-lookup-maybe-add-help cfengine-mode): Regexp typo.
Richard M. Stallman <rms@gnu.org>
parents: 58017
diff changeset
905 :regexp "[[:alnum:]_]+\\(?:()\\)?"
55238
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
906 :doc-spec '(("(cfengine-Reference)Variable Index"
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
907 (lambda (item)
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
908 ;; Index entries may be like `IsPlain()'
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
909 (if (string-match "\\([[:alnum:]_]+\\)()" item)
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
910 (match-string 1 item)
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
911 item))
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
912 ;; This gets functions in evaluated classes. Other
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
913 ;; possible patterns don't seem to work too well.
373bc9e19710 (cfengine-mode): Accept a terminal ().
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 55097
diff changeset
914 "`" "(")))
20909
542ae65815fb (info-complete): Rewrite minibuffer completion code.
Richard M. Stallman <rms@gnu.org>
parents: 20899
diff changeset
915
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
916 (provide 'info-look)
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
917
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51242
diff changeset
918 ;;; arch-tag: 0f1e3ea3-32a2-4461-bbab-3cff93539a74
18322
02f932c91db2 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
919 ;;; info-look.el ends here