|
217
|
1 ;;; info.el --- info package for Emacs.
|
|
|
2 ;; Keywords: help
|
|
|
3
|
|
|
4 ;; Copyright (C) 1985, 1986, 1993, 1997 Free Software Foundation, Inc.
|
|
|
5
|
|
|
6 ;; Author: Dave Gillespie <daveg@synaptics.com>
|
|
|
7 ;; Richard Stallman <rms@gnu.ai.mit.edu>
|
|
|
8 ;; Maintainer: Dave Gillespie <daveg@synaptics.com>
|
|
|
9 ;; Version: 1.07 of 7/22/93
|
|
|
10 ;; Keywords: docs, help
|
|
|
11
|
|
|
12 ;; This file is part of XEmacs.
|
|
|
13
|
|
|
14 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
15 ;; under the terms of the GNU General Public License as published by
|
|
|
16 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
17 ;; any later version.
|
|
|
18
|
|
|
19 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
20 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
22 ;; General Public License for more details.
|
|
|
23
|
|
|
24 ;; You should have received a copy of the GNU General Public License
|
|
367
|
25 ;; along with XEmacs; see the file COPYING. If not, write to the
|
|
217
|
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
|
27 ;; Boston, MA 02111-1307, USA.
|
|
|
28
|
|
|
29 ;;; Synched up with: Not synched with FSF.
|
|
|
30
|
|
|
31 ;; Commentary:
|
|
|
32
|
|
|
33 ;; This is based on an early Emacs 19 info.el file.
|
|
|
34 ;;
|
|
|
35 ;; Note that Info-directory has been replaced by Info-directory-list,
|
|
|
36 ;; a search path of directories in which to find Info files.
|
|
|
37 ;; Also, Info tries adding ".info" to a file name if the name itself
|
|
|
38 ;; is not found.
|
|
|
39 ;;
|
|
|
40 ;; See the change log below for further details.
|
|
|
41
|
|
|
42
|
|
|
43 ;; LCD Archive Entry:
|
|
|
44 ;; info-dg|Dave Gillespie|daveg@synaptics.com
|
|
|
45 ;; |Info reader with many enhancements; replaces standard info.el.
|
|
|
46 ;; |93-07-22|1.07|~/modes/info.el
|
|
|
47
|
|
|
48 ;; Also available from anonymous FTP on csvax.cs.caltech.edu.
|
|
|
49
|
|
|
50
|
|
|
51 ;; Change Log:
|
|
|
52
|
|
|
53 ;; Modified 3/7/1991 by Dave Gillespie:
|
|
|
54 ;; (Author's address: daveg@synaptics.com or daveg@csvax.cs.caltech.edu)
|
|
|
55 ;;
|
|
|
56 ;; Added keys: i, t, <, >, [, ], {, }, 6, 7, 8, 9, 0.
|
|
|
57 ;; Look at help for info-mode (type ? in Info) for descriptions.
|
|
|
58 ;;
|
|
|
59 ;; If Info-directory-list is undefined and there is no INFOPATH
|
|
|
60 ;; in the environment, use value of Info-directory for compatibility
|
|
|
61 ;; with Emacs 18.57.
|
|
|
62 ;;
|
|
|
63 ;; All files named "localdir" found in the path are appended to "dir",
|
|
|
64 ;; the Info directory. For this to work, "dir" should contain only
|
|
|
65 ;; one node (Top), and each "localdir" should contain no ^_ or ^L
|
|
|
66 ;; characters. Generally they will contain only one or several
|
|
|
67 ;; additional lines for the top-level menu. Note that "dir" is
|
|
|
68 ;; modified in memory each time it is loaded, but not on disk.
|
|
|
69 ;;
|
|
|
70 ;; If "dir" contains a line of the form: "* Locals:"
|
|
|
71 ;; then the "localdir"s are inserted there instead of at the end.
|
|
|
72
|
|
|
73
|
|
|
74 ;; Modified 4/3/1991 by Dave Gillespie:
|
|
|
75 ;;
|
|
|
76 ;; Added Info-mode-hook (suggested by Sebastian Kremer).
|
|
|
77 ;; Also added epoch-info-startup/select-hooks from Simon Spero's info.el.
|
|
|
78 ;;
|
|
|
79 ;; Added automatic decoding of compressed Info files.
|
|
|
80 ;; See documentation for the variable Info-suffix-list. Default is to
|
|
|
81 ;; run "uncompress" on ".Z" files and "unyabba" on ".Y" files.
|
|
|
82 ;; (See comp.sources.unix v24i073-076 for yabba/unyabba, a free software
|
|
|
83 ;; alternative to compress/uncompress.)
|
|
|
84 ;; Note: "dir" and "localdir" files should not be compressed.
|
|
|
85 ;;
|
|
|
86 ;; Changed variables like Info-enable-edit to be settable by M-x set-variable.
|
|
|
87 ;;
|
|
|
88 ;; Added Info-auto-advance variable. If t, SPC and DEL will act like
|
|
|
89 ;; } and {, i.e., they advance to the next/previous node if at the end
|
|
|
90 ;; of the buffer.
|
|
|
91 ;;
|
|
|
92 ;; Changed `u' to restore point to most recent location in that node.
|
|
|
93 ;; Added `=' to do this manually at any time. (Suggested by David Fox).
|
|
|
94 ;;
|
|
|
95 ;; Changed `m' and `0-9' to try interpreting menu name as a file name
|
|
|
96 ;; if not found as a node name. This allows (dir) menus of the form,
|
|
|
97 ;; Emacs:: Cool text editor
|
|
|
98 ;; as a shorthand for
|
|
|
99 ;; Emacs:(emacs). Cool text editor
|
|
|
100 ;;
|
|
|
101 ;; Enhanced `i' to use line-number information in the index.
|
|
|
102 ;; Added `,' to move among all matches to a previous `i' command.
|
|
|
103 ;;
|
|
|
104 ;; Added `a' (Info-annotate) for adding personal notes to any Info node.
|
|
|
105 ;; Notes are not stored in the actual Info files, but in the user's own
|
|
|
106 ;; ~/.infonotes file.
|
|
|
107 ;;
|
|
|
108 ;; Added Info-footnote-tag, made default be "Ref" instead of "Note".
|
|
|
109 ;;
|
|
|
110 ;; Got mouse-click stuff to work under Emacs version 18. Check it out!
|
|
|
111 ;; Left and right clicks scroll the Info window.
|
|
|
112 ;; Middle click goes to clicked-on node, e.g., "Next:", a menu, or a note.
|
|
|
113
|
|
|
114
|
|
|
115 ;; Modified 6/29/1991 by Dave Gillespie:
|
|
|
116 ;;
|
|
|
117 ;; Renamed epoch-info-startup/select-hooks to Info-startup/select-hook.
|
|
|
118 ;;
|
|
|
119 ;; Made Info-select-node into a command on the `!' key.
|
|
|
120 ;;
|
|
|
121 ;; Added Info-mouse-support user option.
|
|
|
122 ;;
|
|
|
123 ;; Cleaned up the implementation of some routines.
|
|
|
124 ;;
|
|
|
125 ;; Added special treatment of quoted words in annotations: The `g'
|
|
|
126 ;; command for a nonexistent node name scans for an annotation
|
|
|
127 ;; (in any node of any file) containing that name in quotes: g foo RET
|
|
|
128 ;; looks for an annotation containing: "foo" or: <<foo>>
|
|
|
129 ;; If found, it goes to that file and node.
|
|
|
130 ;;
|
|
|
131 ;; Added a call to set up Info-directory-list in Info-find-node to
|
|
|
132 ;; work around a bug in GNUS where it calls Info-goto-node before info.
|
|
|
133 ;;
|
|
|
134 ;; Added completion for `g' command (inspired by Richard Kim's infox.el).
|
|
|
135 ;; Completion knows all node names for the current file, and all annotation
|
|
|
136 ;; tags (see above). It does not complete file names or node names in
|
|
|
137 ;; other files.
|
|
|
138 ;;
|
|
|
139 ;; Added `k' (Info-emacs-key) and `*' (Info-elisp-ref) commands. You may
|
|
|
140 ;; wish to bind these to global keys outside of Info mode.
|
|
|
141 ;;
|
|
|
142 ;; Allowed localdir files to be full dir-like files; only the menu part
|
|
|
143 ;; of each localdir is copied. Also, redundant menu items are omitted.
|
|
|
144 ;;
|
|
|
145 ;; Changed Info-history to hold only one entry at a time for each node,
|
|
|
146 ;; and to be circular so that multiple `l's come back again to the most
|
|
|
147 ;; recent node. Note that the format of Info-history entries has changed,
|
|
|
148 ;; which may interfere with external programs that try to operate on it.
|
|
|
149 ;; (Also inspired by Kim's infox.el).
|
|
|
150 ;;
|
|
|
151 ;; Changed `n', `]', `l', etc. to accept prefix arguments to move several
|
|
|
152 ;; steps at once. Most accept negative arguments to move oppositely.
|
|
|
153 ;;
|
|
|
154 ;; Changed `?' to bury *Help* buffer afterwards to keep it out of the way.
|
|
|
155 ;;
|
|
|
156 ;; Rearranged `?' key's display to be a little better for new users.
|
|
|
157 ;;
|
|
|
158 ;; Changed `a' to save whole window configuration and restore on C-c C-c.
|
|
|
159 ;;
|
|
|
160 ;; Fixed the bug reported by Bill Reynolds on gnu.emacs.bugs.
|
|
|
161 ;;
|
|
|
162 ;; Changed Info-last to restore window-start as well as cursor position.
|
|
|
163 ;;
|
|
|
164 ;; Changed middle mouse button in space after end of node to do Info-last
|
|
|
165 ;; if we got here by following a cross reference, else do Info-global-next.
|
|
|
166 ;;
|
|
|
167 ;; Added some new mouse bindings: shift-left = Info-global-next,
|
|
|
168 ;; shift-right = Info-global-prev, shift-middle = Info-last.
|
|
|
169 ;;
|
|
|
170 ;; Fixed Info-follow-reference not to make assumptions about length
|
|
|
171 ;; of Info-footnote-tag [Linus Tolke].
|
|
|
172 ;;
|
|
|
173 ;; Changed default for Info-auto-advance mode to be press-twice-for-next-node.
|
|
|
174 ;;
|
|
|
175 ;; Modified x-mouse-ignore to preserve last-command variable, so that
|
|
|
176 ;; press-twice Info-auto-advance mode works with the mouse.
|
|
|
177
|
|
|
178
|
|
|
179 ;; Modified 3/4/1992 by Dave Gillespie:
|
|
|
180 ;;
|
|
|
181 ;; Added an "autoload" command to help autoload.el.
|
|
|
182 ;;
|
|
|
183 ;; Changed `*' command to look for file `elisp' as well as for `lispref'.
|
|
|
184 ;;
|
|
|
185 ;; Fixed a bug involving footnote names containing regexp special characters.
|
|
|
186 ;;
|
|
|
187 ;; Fixed a bug in completion during `f' (or `r') command.
|
|
|
188 ;;
|
|
|
189 ;; Added TAB (Info-next-reference), M-TAB, and RET keys to Info mode.
|
|
|
190 ;;
|
|
|
191 ;; Added new bindings, `C-h C-k' for Info-emacs-key and `C-h C-f' for
|
|
|
192 ;; Info-elisp-ref. These bindings are made when info.el is loaded, and
|
|
|
193 ;; only if those key sequences were previously unbound. These bindings
|
|
|
194 ;; work at any time, not just when Info is already running.
|
|
|
195
|
|
|
196
|
|
|
197 ;; Modified 3/8/1992 by Dave Gillespie:
|
|
|
198 ;;
|
|
|
199 ;; Fixed some long lines that were causing trouble with mailers.
|
|
|
200
|
|
|
201
|
|
|
202 ;; Modified 3/9/1992 by Dave Gillespie:
|
|
|
203 ;;
|
|
|
204 ;; Added `C-h C-i' (Info-query).
|
|
|
205 ;;
|
|
|
206 ;; Added Info-novice mode, warns if the user attempts to switch to
|
|
|
207 ;; a different Info file.
|
|
|
208 ;;
|
|
|
209 ;; Fixed a bug that caused problems using compressed Info files
|
|
|
210 ;; and Info-directory-list at the same time.
|
|
|
211 ;;
|
|
|
212 ;; Disabled Info-mouse-support by default if Epoch or Hyperbole is in use.
|
|
|
213 ;;
|
|
|
214 ;; Added an expand-file-name call to Info-find-node to fix a small bug.
|
|
|
215
|
|
|
216
|
|
|
217 ;; Modified 5/22/1992 by Dave Gillespie:
|
|
|
218 ;;
|
|
|
219 ;; Added "standalone" operation: "emacs -f info" runs Emacs specifically
|
|
|
220 ;; for use as an Info browser. In this mode, the `q' key quits Emacs
|
|
|
221 ;; itself. Also, "emacs -f info arg" starts in Info file "arg" instead
|
|
|
222 ;; of "dir".
|
|
|
223 ;;
|
|
|
224 ;; Changed to prefer "foo.info" over "foo". If both exist, "foo" is
|
|
|
225 ;; probably a directory or executable program!
|
|
|
226 ;;
|
|
|
227 ;; Made control-mouse act like regular-mouse does in other buffers.
|
|
|
228 ;; (In most systems, this will be set-cursor for left-mouse, x-cut
|
|
|
229 ;; for right-mouse, and x-paste, which will be an error, for
|
|
|
230 ;; middle-mouse.)
|
|
|
231 ;;
|
|
|
232 ;; Improved prompting and searching for `,' key.
|
|
|
233 ;;
|
|
|
234 ;; Fixed a bug where some "* Menu:" lines disappeared when "dir"
|
|
|
235 ;; contained several nodes.
|
|
|
236
|
|
|
237
|
|
|
238 ;; Modified 9/10/1992 by Dave Gillespie:
|
|
|
239 ;;
|
|
|
240 ;; Mixed in support for XEmacs. Mouse works the same as in
|
|
|
241 ;; the other Emacs versions by default; added Info-lucid-mouse-style
|
|
|
242 ;; variable, which enables mouse operation similar to XEmacs's default.
|
|
|
243 ;;
|
|
|
244 ;; Fixed a bug where RET couldn't understand "* Foo::" if "Foo" was a
|
|
|
245 ;; file name instead of a node name.
|
|
|
246 ;;
|
|
|
247 ;; Added `x' (Info-bookmark), a simple interface to the annotation
|
|
|
248 ;; tags feature. Added `j' (Info-goto-bookmark), like `g' but only
|
|
|
249 ;; completes bookmarks.
|
|
|
250 ;;
|
|
|
251 ;; Added `<<tag>>' as alternate to `"tag"' in annotations.
|
|
|
252 ;;
|
|
|
253 ;; Added `v' (Info-visit-file), like Info-goto-node but specialized
|
|
|
254 ;; for going to a new Info file (with file name completion).
|
|
|
255 ;;
|
|
|
256 ;; Added recognition of gzip'd ".z" files.
|
|
|
257
|
|
|
258
|
|
|
259 ;; Modified 5/9/1993 by Dave Gillespie:
|
|
|
260 ;;
|
|
|
261 ;; Merged in various things from FSF's latest Emacs 19 info.el.
|
|
|
262
|
|
|
263 ;; Modified 6/2/1993 by Dave Gillespie:
|
|
|
264 ;;
|
|
|
265 ;; Changed to use new suffix ".gz" for gzip files.
|
|
|
266
|
|
|
267
|
|
|
268 ;; Modified 7/22/1993 by Dave Gillespie:
|
|
|
269 ;;
|
|
|
270 ;; Changed Info-footnote-tag to "See" instead of "Ref".
|
|
|
271 ;;
|
|
|
272 ;; Extended Info-fontify-node to work with FSF version of Emacs 19.
|
|
|
273
|
|
|
274 ;; Modified 7/30/1993 by Jamie Zawinski:
|
|
|
275 ;;
|
|
|
276 ;; Commented out the tty and fsf19 mouse support, because why bother.
|
|
|
277 ;; Commented out the politically incorrect version of XEmacs mouse support.
|
|
|
278 ;; Commented out mouse scrolling bindings because the party line on that
|
|
|
279 ;; is "scrollbars are coming soon."
|
|
|
280 ;; Commented out munging of help-for-help's doc; put it in help.el.
|
|
|
281 ;; Did Info-edit-map the modern XEmacs way.
|
|
|
282 ;; Pruned extra cruft from fontification and mouse handling code.
|
|
|
283 ;; Fixed ASCII-centric bogosity in unreading of events.
|
|
|
284
|
|
|
285 ;; Modified 8/11/95 by Chuck Thompson:
|
|
|
286 ;;
|
|
|
287 ;; Removed any pretense of ever referencing Info-directory since it
|
|
|
288 ;; wasn't working anyhow.
|
|
|
289
|
|
|
290 ;; Modified 4/5/97 by Tomasz J. Cholewo:
|
|
|
291 ;;
|
|
|
292 ;; Modified Info-search to use with-caps-disable-folding
|
|
|
293
|
|
|
294 ;; Modified 6/21/97 by Hrvoje Niksic
|
|
|
295 ;;
|
|
|
296 ;; Fixed up Info-next-reference to work sanely when n < 0.
|
|
|
297 ;; Added S-tab binding.
|
|
|
298
|
|
|
299 ;; Modified 1997-07-10 by Karl M. Hegbloom
|
|
|
300 ;;
|
|
|
301 ;; Added `Info-minibuffer-history'
|
|
|
302 ;; (also added to defaults in "lisp/utils/savehist.el")
|
|
|
303 ;; Other changes in main ChangeLog.
|
|
|
304
|
|
272
|
305 ;; Modified 1998-03-29 by Oscar Figueiredo
|
|
|
306 ;;
|
|
|
307 ;; Added automatic dir/localdir (re)building capability for directories that
|
|
|
308 ;; contain none or when it has become older than info files in the same
|
|
|
309 ;; directory.
|
|
|
310
|
|
217
|
311 ;; Code:
|
|
|
312
|
|
|
313 (defgroup info nil
|
|
|
314 "The info package for Emacs."
|
|
|
315 :group 'help
|
|
|
316 :group 'docs)
|
|
|
317
|
|
|
318 (defgroup info-faces nil
|
|
|
319 "The faces used by info browser."
|
|
|
320 :group 'info
|
|
|
321 :group 'faces)
|
|
|
322
|
|
|
323
|
|
|
324 (defcustom Info-inhibit-toolbar nil
|
|
|
325 "*Non-nil means don't use the specialized Info toolbar."
|
|
|
326 :type 'boolean
|
|
|
327 :group 'info)
|
|
|
328
|
|
|
329 (defcustom Info-novice nil
|
|
|
330 "*Non-nil means to ask for confirmation before switching Info files."
|
|
|
331 :type 'boolean
|
|
|
332 :group 'info)
|
|
|
333
|
|
|
334 (defvar Info-history nil
|
|
|
335 "List of info nodes user has visited.
|
|
|
336 Each element of list is a list (\"(FILENAME)NODENAME\" BUFPOS WINSTART).")
|
|
|
337
|
|
|
338 (defvar Info-keeping-history t
|
|
|
339 "Non-nil if Info-find-node should modify Info-history.
|
|
|
340 This is for use only by certain internal Info routines.")
|
|
|
341
|
|
|
342 (defvar Info-minibuffer-history nil
|
|
|
343 "Minibuffer history for Info.")
|
|
|
344
|
|
|
345 (defcustom Info-enable-edit nil
|
|
|
346 "*Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info
|
|
|
347 can edit the current node.
|
|
|
348 This is convenient if you want to write info files by hand.
|
|
|
349 However, we recommend that you not do this.
|
|
|
350 It is better to write a Texinfo file and generate the Info file from that,
|
|
|
351 because that gives you a printed manual as well."
|
|
|
352 :type 'boolean
|
|
|
353 :group 'info)
|
|
|
354
|
|
|
355 (defcustom Info-enable-active-nodes t
|
|
|
356 "*Non-nil allows Info to execute Lisp code associated with nodes.
|
|
|
357 The Lisp code is executed when the node is selected."
|
|
|
358 :type 'boolean
|
|
|
359 :group 'info)
|
|
|
360
|
|
|
361 (defcustom Info-restoring-point t
|
|
|
362 "*Non-nil means to restore the cursor position when re-entering a node."
|
|
|
363 :type 'boolean
|
|
|
364 :group 'info)
|
|
|
365
|
|
|
366 (defcustom Info-auto-advance 'twice
|
|
|
367 "*Control what SPC and DEL do when they can't scroll any further.
|
|
|
368 If nil, they beep and remain in the current node.
|
|
|
369 If t, they move to the next node (like Info-global-next/prev).
|
|
|
370 If anything else, they must be pressed twice to move to the next node."
|
|
|
371 :type '(choice (const :tag "off" nil)
|
|
|
372 (const :tag "advance" t)
|
|
|
373 (const :tag "confirm" twice))
|
|
|
374 :group 'info)
|
|
|
375
|
|
|
376 (defcustom Info-fontify t
|
|
|
377 "*Non-nil enables font features in XEmacs.
|
|
|
378 This variable is ignored unless running under XEmacs."
|
|
|
379 :type 'boolean
|
|
|
380 :group 'info)
|
|
|
381
|
|
|
382 (defcustom Info-additional-search-directory-list nil
|
|
|
383 "*List of additional directories to search for Info documentation
|
|
|
384 files. These directories are not searched for merging the `dir'
|
|
|
385 file. An example might be something like:
|
|
|
386 \"/usr/local/lib/xemacs/packages/lisp/calc/\""
|
|
|
387 :type '(repeat directory)
|
|
|
388 :group 'info)
|
|
|
389
|
|
292
|
390 (defcustom Info-auto-generate-directory 'if-missing
|
|
|
391 "*When to auto generate an info directory listing.
|
|
272
|
392 Possible values are:
|
|
292
|
393 nil or `never' never auto-generate a directory listing,
|
|
|
394 use any existing `dir' or `localdir' file and ignore info
|
|
|
395 directories containing none
|
|
|
396 `always' auto-generate a directory listing ignoring existing
|
|
|
397 `dir' and `localdir' files
|
|
|
398 `if-missing', the default, auto-generates a directory listing
|
|
367
|
399 if no `dir' or `localdir' file is present. Otherwise the
|
|
292
|
400 contents of any of these files is used instead.
|
|
|
401 `if-outdated' auto-generates a directory listing if the `dir'
|
|
367
|
402 and `localdir' are either inexistent or outdated (touched
|
|
292
|
403 less recently than an info file in the same directory)."
|
|
272
|
404 :type '(choice (const :tag "never" never)
|
|
|
405 (const :tag "always" always)
|
|
292
|
406 (const :tag "if-missing" if-missing)
|
|
|
407 (const :tag "if-outdated" if-outdated))
|
|
|
408 :group 'info)
|
|
|
409
|
|
|
410 (defcustom Info-save-auto-generated-dir nil
|
|
|
411 "*Whether an auto-generated info directory listing should be saved.
|
|
|
412 Possible values are:
|
|
367
|
413 nil or `never', the default, auto-generated info directory
|
|
292
|
414 information will never be saved.
|
|
|
415 `always', auto-generated info directory information will be saved to
|
|
|
416 a `dir' file in the same directory overwriting it if it exists
|
|
|
417 `conservative', auto-generated info directory information will be saved
|
|
367
|
418 to a `dir' file in the same directory but the user is asked before
|
|
292
|
419 overwriting any existing file."
|
|
|
420 :type '(choice (const :tag "never" never)
|
|
|
421 (const :tag "always" always)
|
|
274
|
422 (const :tag "conservative" conservative))
|
|
272
|
423 :group 'info)
|
|
|
424
|
|
367
|
425 (defconst Info-emacs-info-file-name "xemacs.info"
|
|
|
426 "The filename of the XEmacs info for `Info-goto-emacs-command-node'
|
|
|
427 (`\\<help-mode-map>\\[Info-goto-emacs-command-node]')")
|
|
239
|
428
|
|
269
|
429 ;;;###autoload
|
|
|
430 (defvar Info-directory-list nil
|
|
217
|
431 "List of directories to search for Info documentation files.
|
|
243
|
432
|
|
269
|
433 The first directory in this list, the \"dir\" file there will become
|
|
359
|
434 the (dir)Top node of the Info documentation tree.
|
|
|
435
|
|
|
436 Note: DO NOT use the `customize' interface to change the value of this
|
|
|
437 variable. Its value is created dynamically on each startup, depending
|
|
|
438 on XEmacs packages installed on the system. If you want to change the
|
|
|
439 search path, make the needed modifications on the variable's value
|
|
|
440 from .emacs. For instance:
|
|
|
441
|
|
|
442 (setq Info-directory-list (cons \"~/info\" Info-directory-list))")
|
|
217
|
443
|
|
367
|
444 ;; This could as well be hard-coded since ${srcdir}/info/dir is in CVS --dv
|
|
|
445 (defconst Info-localdir-heading-regexp "^Local Packages:$"
|
|
217
|
446 "The menu part of localdir files will be inserted below this topic
|
|
367
|
447 heading.")
|
|
217
|
448
|
|
|
449 (defface info-node '((t (:bold t :italic t)))
|
|
|
450 "Face used for node links in info."
|
|
|
451 :group 'info-faces)
|
|
|
452
|
|
|
453 (defface info-xref '((t (:bold t)))
|
|
|
454 "Face used for cross-references in info."
|
|
|
455 :group 'info-faces)
|
|
|
456
|
|
367
|
457 ;; This list is based on Karl Berry-s advice about extensions `info' itself
|
|
|
458 ;; might encounter. --dv
|
|
|
459 (defcustom Info-suffix-list '(("" . nil)
|
|
|
460 (".info" . nil)
|
|
|
461 (".gz" . "gzip -dc %s")
|
|
|
462 (".info.gz" . "gzip -dc %s")
|
|
|
463 (".z" . "gzip -dc %s")
|
|
|
464 (".info.z" . "gzip -dc %s")
|
|
|
465 (".bz2" . "bzip2 -dc %s")
|
|
|
466 (".info.bz2" . "bzip2 -dc %s")
|
|
|
467 (".Z" . "uncompress -c %s")
|
|
|
468 (".info.Z" . "uncompress -c %s")
|
|
|
469 (".zip" . "unzip -c %s")
|
|
|
470 (".info.zip" . "unzip -c %s")
|
|
|
471 (".y" . "cat %s | unyabba")
|
|
|
472 ("info.y" . "cat %s | unyabba")
|
|
|
473 ;; These ones are for MS-DOS filenames.
|
|
|
474 (".inf" . nil)
|
|
|
475 (".igz" . "gzip -dc %s")
|
|
|
476 (".inz" . "gzip -c %s"))
|
|
|
477 "*List of file name suffixes and associated decoding commands.
|
|
217
|
478 Each entry should be (SUFFIX . STRING); if STRING contains %s, that is
|
|
|
479 changed to name of the file to decode, otherwise the file is given to
|
|
367
|
480 the command as standard input. If STRING is nil, no decoding is done."
|
|
|
481 :type '(repeat (cons (string :tag "suffix")
|
|
|
482 (choice :tag "command"
|
|
|
483 (const :tag "none" :value nil)
|
|
|
484 (string :tag ""))))
|
|
|
485 :group 'info)
|
|
217
|
486
|
|
367
|
487 (defcustom Info-footnote-tag "Note"
|
|
217
|
488 "*Symbol that identifies a footnote or cross-reference.
|
|
367
|
489 All \"*Note\" references will be changed to use this word instead."
|
|
|
490 :type 'string
|
|
|
491 :group 'info)
|
|
217
|
492
|
|
|
493 (defvar Info-current-file nil
|
|
|
494 "Info file that Info is now looking at, or nil.
|
|
|
495 This is the name that was specified in Info, not the actual file name.
|
|
|
496 It doesn't contain directory names or file name extensions added by Info.")
|
|
|
497
|
|
|
498 (defvar Info-current-subfile nil
|
|
|
499 "Info subfile that is actually in the *info* buffer now,
|
|
|
500 or nil if current info file is not split into subfiles.")
|
|
|
501
|
|
|
502 (defvar Info-current-node nil
|
|
|
503 "Name of node that Info is now looking at, or nil.")
|
|
|
504
|
|
|
505 (defvar Info-tag-table-marker (make-marker)
|
|
|
506 "Marker pointing at beginning of current Info file's tag table.
|
|
|
507 Marker points nowhere if file has no tag table.")
|
|
|
508
|
|
|
509 (defvar Info-current-file-completions nil
|
|
|
510 "Cached completion list for current Info file.")
|
|
|
511
|
|
|
512 (defvar Info-current-annotation-completions nil
|
|
|
513 "Cached completion list for current annotation files.")
|
|
|
514
|
|
|
515 (defvar Info-index-alternatives nil
|
|
|
516 "List of possible matches for last Info-index command.")
|
|
367
|
517
|
|
217
|
518 (defvar Info-index-first-alternative nil)
|
|
|
519
|
|
|
520 (defcustom Info-annotations-path '("~/.xemacs/info.notes"
|
|
|
521 "~/.infonotes"
|
|
|
522 "/usr/lib/info.notes")
|
|
|
523 "*Names of files that contain annotations for different Info nodes.
|
|
|
524 By convention, the first one should reside in your personal directory.
|
|
|
525 The last should be a world-writable \"public\" annotations file."
|
|
|
526 :type '(repeat file)
|
|
|
527 :group 'info)
|
|
|
528
|
|
|
529 (defcustom Info-button1-follows-hyperlink nil
|
|
|
530 "*Non-nil means mouse button1 click will follow hyperlink."
|
|
|
531 :type 'boolean
|
|
|
532 :group 'info)
|
|
|
533
|
|
|
534 (defvar Info-standalone nil
|
|
|
535 "Non-nil if Emacs was started solely as an Info browser.")
|
|
|
536
|
|
|
537 (defvar Info-in-cross-reference nil)
|
|
|
538 (defvar Info-window-configuration nil)
|
|
|
539
|
|
272
|
540 (defvar Info-dir-prologue "-*- Text -*-
|
|
|
541 This is the file .../info/dir, which contains the topmost node of the
|
|
|
542 Info hierarchy. The first time you invoke Info you start off
|
|
|
543 looking at that node, which is (dir)Top.
|
|
|
544
|
|
|
545 File: dir Node: Top This is the top of the INFO tree
|
|
367
|
546 This (the Directory node) gives a menu of major topics.
|
|
272
|
547
|
|
|
548 * Menu: The list of major topics begins on the next line.
|
|
|
549
|
|
|
550 ")
|
|
|
551
|
|
367
|
552 (defcustom Info-no-description-string "[No description available]"
|
|
|
553 "*Description string for info files that have none"
|
|
|
554 :type 'string
|
|
|
555 :group 'info)
|
|
274
|
556
|
|
217
|
557 ;;;###autoload
|
|
|
558 (defun info (&optional file)
|
|
|
559 "Enter Info, the documentation browser.
|
|
|
560 Optional argument FILE specifies the file to examine;
|
|
|
561 the default is the top-level directory of Info.
|
|
|
562
|
|
|
563 In interactive use, a prefix argument directs this command
|
|
|
564 to read a file name from the minibuffer."
|
|
|
565 (interactive (if current-prefix-arg
|
|
|
566 (list (read-file-name "Info file name: " nil nil t))))
|
|
|
567 (let ((p command-line-args))
|
|
|
568 (while p
|
|
|
569 (and (string-match "^-[fe]" (car p))
|
|
|
570 (equal (nth 1 p) "info")
|
|
|
571 (not Info-standalone)
|
|
|
572 (setq Info-standalone t)
|
|
|
573 (= (length p) 3)
|
|
|
574 (not (string-match "^-" (nth 2 p)))
|
|
|
575 (setq file (nth 2 p))
|
|
|
576 (setq command-line-args-left nil))
|
|
|
577 (setq p (cdr p))))
|
|
|
578 ; (Info-setup-x) ??? What was this going to be? Can anyone tell karlheg?
|
|
|
579 (if file
|
|
|
580 (unwind-protect
|
|
|
581 (Info-goto-node (concat "(" file ")"))
|
|
|
582 (and Info-standalone (info)))
|
|
|
583 (if (get-buffer "*info*")
|
|
|
584 (switch-to-buffer "*info*")
|
|
|
585 (Info-directory))))
|
|
|
586
|
|
|
587 ;;;###autoload
|
|
|
588 (defun Info-query (file)
|
|
|
589 "Enter Info, the documentation browser. Prompt for name of Info file."
|
|
|
590 (interactive "sInfo topic (default = menu): ")
|
|
|
591 (info)
|
|
|
592 (if (equal file "")
|
|
|
593 (Info-goto-node "(dir)")
|
|
|
594 (Info-goto-node (concat "(" file ")"))))
|
|
|
595
|
|
|
596 (defun Info-setup-initial ()
|
|
|
597 (let ((f Info-annotations-path))
|
|
|
598 (while f
|
|
|
599 (if (and (file-exists-p (car f)) (not (get-file-buffer (car f))))
|
|
|
600 (bury-buffer (find-file-noselect (car f))))
|
|
|
601 (setq f (cdr f)))))
|
|
|
602
|
|
|
603 (defun Info-find-node (filename &optional nodename no-going-back tryfile line)
|
|
|
604 "Go to an info node specified as separate FILENAME and NODENAME.
|
|
|
605 Look for a plausible filename, or if not found then look for URL's and
|
|
|
606 dispatch to the appropriate fn. NO-GOING-BACK is non-nil if
|
|
|
607 recovering from an error in this function; it says do not attempt
|
|
|
608 further (recursive) error recovery. TRYFILE is ??"
|
|
|
609
|
|
|
610 (Info-setup-initial)
|
|
|
611
|
|
|
612 (cond
|
|
|
613 ;; empty filename is simple case
|
|
|
614 ((null filename)
|
|
|
615 (Info-find-file-node nil nodename no-going-back tryfile line))
|
|
|
616 ;; Convert filename to lower case if not found as specified.
|
|
|
617 ;; Expand it, look harder...
|
|
367
|
618 ((let ((fname (substitute-in-file-name filename))
|
|
|
619 temp found)
|
|
217
|
620 (let ((dirs (cond
|
|
367
|
621 ;; If specified name starts with `./', then just try
|
|
|
622 ;; current directory. No point in searching for an absolute
|
|
|
623 ;; file name
|
|
|
624 ((string-match "^\\./" fname)
|
|
|
625 (list default-directory))
|
|
217
|
626 ((file-name-absolute-p fname)
|
|
367
|
627 '(nil))
|
|
217
|
628 (Info-additional-search-directory-list
|
|
|
629 (append Info-directory-list
|
|
|
630 Info-additional-search-directory-list))
|
|
|
631 (t Info-directory-list))))
|
|
|
632 ;; Search the directory list for file FNAME.
|
|
|
633 (while (and dirs (not found))
|
|
|
634 (setq temp (expand-file-name fname (car dirs)))
|
|
367
|
635 (setq found (Info-suffixed-file temp))
|
|
217
|
636 (setq dirs (cdr dirs)))
|
|
367
|
637 (if found
|
|
217
|
638 (progn (setq filename (expand-file-name found))
|
|
|
639 t))))
|
|
|
640 (Info-find-file-node filename nodename no-going-back tryfile line))
|
|
|
641 ;; Look for a URL. This pattern is stolen from w3.el to prevent
|
|
|
642 ;; loading it if we won't need it.
|
|
|
643 ((string-match (concat "^\\(wais\\|solo\\|x-exec\\|newspost\\|www\\|"
|
|
|
644 "mailto\\|news\\|tn3270\\|ftp\\|http\\|file\\|"
|
|
|
645 "telnet\\|gopher\\):")
|
|
|
646 filename)
|
|
219
|
647 (if (fboundp 'browse-url)
|
|
|
648 (browse-url filename)
|
|
|
649 (error "Cannot follow URLs in this XEmacs")))
|
|
217
|
650 (t
|
|
|
651 (error "Info file %s does not exist" filename))))
|
|
|
652
|
|
|
653 (defun Info-find-file-node (filename nodename
|
|
|
654 &optional no-going-back tryfile line)
|
|
|
655 ;; This is the guts of what was Info-find-node. Whoever wrote this
|
|
|
656 ;; should be locked up where they can't do any more harm.
|
|
|
657
|
|
|
658 ;; Go into info buffer.
|
|
|
659 (switch-to-buffer "*info*")
|
|
|
660 (buffer-disable-undo (current-buffer))
|
|
|
661 (run-hooks 'Info-startup-hook)
|
|
|
662 (or (eq major-mode 'Info-mode)
|
|
|
663 (Info-mode))
|
|
|
664 (or (null filename)
|
|
|
665 (equal Info-current-file filename)
|
|
|
666 (not Info-novice)
|
|
|
667 (string= "dir" (file-name-nondirectory Info-current-file))
|
|
|
668 (if (y-or-n-p-maybe-dialog-box
|
|
|
669 (format "Leave Info file `%s'? "
|
|
|
670 (file-name-nondirectory Info-current-file)))
|
|
|
671 (message "")
|
|
|
672 (keyboard-quit)))
|
|
|
673 ;; Record the node we are leaving.
|
|
|
674 (if (and Info-current-file (not no-going-back))
|
|
|
675 (Info-history-add Info-current-file Info-current-node (point)))
|
|
|
676 (widen)
|
|
|
677 (setq Info-current-node nil
|
|
|
678 Info-in-cross-reference nil)
|
|
|
679 (unwind-protect
|
|
|
680 (progn
|
|
|
681 ;; Switch files if necessary
|
|
|
682 (or (null filename)
|
|
|
683 (equal Info-current-file filename)
|
|
|
684 (let ((buffer-read-only nil))
|
|
|
685 (setq Info-current-file nil
|
|
|
686 Info-current-subfile nil
|
|
|
687 Info-current-file-completions nil
|
|
|
688 Info-index-alternatives nil
|
|
|
689 buffer-file-name nil)
|
|
|
690 (erase-buffer)
|
|
|
691 (if (string= "dir" (file-name-nondirectory filename))
|
|
|
692 (Info-insert-dir)
|
|
|
693 (Info-insert-file-contents filename t)
|
|
|
694 (setq default-directory (file-name-directory filename)))
|
|
|
695 (set-buffer-modified-p nil)
|
|
|
696 ;; See whether file has a tag table. Record the location if yes.
|
|
|
697 (set-marker Info-tag-table-marker nil)
|
|
|
698 (goto-char (point-max))
|
|
|
699 (forward-line -8)
|
|
|
700 (or (equal nodename "*")
|
|
|
701 (not (search-forward "\^_\nEnd tag table\n" nil t))
|
|
|
702 (let (pos)
|
|
|
703 ;; We have a tag table. Find its beginning.
|
|
|
704 ;; Is this an indirect file?
|
|
|
705 (search-backward "\nTag table:\n")
|
|
|
706 (setq pos (point))
|
|
|
707 (if (save-excursion
|
|
|
708 (forward-line 2)
|
|
|
709 (looking-at "(Indirect)\n"))
|
|
|
710 ;; It is indirect. Copy it to another buffer
|
|
|
711 ;; and record that the tag table is in that buffer.
|
|
|
712 (save-excursion
|
|
|
713 (let ((buf (current-buffer)))
|
|
|
714 (set-buffer
|
|
|
715 (get-buffer-create " *info tag table*"))
|
|
|
716 (buffer-disable-undo (current-buffer))
|
|
|
717 (setq case-fold-search t)
|
|
|
718 (erase-buffer)
|
|
|
719 (insert-buffer-substring buf)
|
|
|
720 (set-marker Info-tag-table-marker
|
|
|
721 (match-end 0))))
|
|
|
722 (set-marker Info-tag-table-marker pos))))
|
|
|
723 (setq Info-current-file
|
|
|
724 (file-name-sans-versions buffer-file-name))))
|
|
|
725 (if (equal nodename "*")
|
|
|
726 (progn (setq Info-current-node nodename)
|
|
|
727 (Info-set-mode-line)
|
|
|
728 (goto-char (point-min)))
|
|
|
729 ;; Search file for a suitable node.
|
|
|
730 (let* ((qnode (regexp-quote nodename))
|
|
|
731 (regexp (concat "Node: *" qnode " *[,\t\n\177]"))
|
|
|
732 (guesspos (point-min))
|
|
|
733 (found t))
|
|
|
734 ;; First get advice from tag table if file has one.
|
|
|
735 ;; Also, if this is an indirect info file,
|
|
|
736 ;; read the proper subfile into this buffer.
|
|
|
737 (if (marker-position Info-tag-table-marker)
|
|
|
738 (save-excursion
|
|
|
739 (set-buffer (marker-buffer Info-tag-table-marker))
|
|
|
740 (goto-char Info-tag-table-marker)
|
|
|
741 (if (re-search-forward regexp nil t)
|
|
|
742 (progn
|
|
|
743 (setq guesspos (read (current-buffer)))
|
|
|
744 ;; If this is an indirect file,
|
|
|
745 ;; determine which file really holds this node
|
|
|
746 ;; and read it in.
|
|
|
747 (if (not (eq (current-buffer) (get-buffer "*info*")))
|
|
|
748 (setq guesspos
|
|
|
749 (Info-read-subfile guesspos)))))))
|
|
|
750 (goto-char (max (point-min) (- guesspos 1000)))
|
|
|
751 ;; Now search from our advised position (or from beg of buffer)
|
|
|
752 ;; to find the actual node.
|
|
|
753 (catch 'foo
|
|
|
754 (while (search-forward "\n\^_" nil t)
|
|
|
755 (forward-line 1)
|
|
|
756 (let ((beg (point)))
|
|
|
757 (forward-line 1)
|
|
|
758 (if (re-search-backward regexp beg t)
|
|
|
759 (throw 'foo t))))
|
|
|
760 (setq found nil)
|
|
|
761 (let ((bufs (delq nil (mapcar 'get-file-buffer
|
|
|
762 Info-annotations-path)))
|
|
|
763 (pattern (if (string-match "\\`<<.*>>\\'" qnode) qnode
|
|
|
764 (format "\"%s\"\\|<<%s>>" qnode qnode)))
|
|
|
765 (pat2 (concat "------ *File: *\\([^ ].*[^ ]\\) *Node: "
|
|
|
766 "*\\([^ ].*[^ ]\\) *Line: *\\([0-9]+\\)"))
|
|
|
767 (afile nil) anode aline)
|
|
|
768 (while (and bufs (not anode))
|
|
|
769 (save-excursion
|
|
|
770 (set-buffer (car bufs))
|
|
|
771 (goto-char (point-min))
|
|
|
772 (if (re-search-forward pattern nil t)
|
|
|
773 (if (re-search-backward pat2 nil t)
|
|
|
774 (setq afile (buffer-substring (match-beginning 1)
|
|
|
775 (match-end 1))
|
|
|
776 anode (buffer-substring (match-beginning 2)
|
|
|
777 (match-end 2))
|
|
|
778 aline (string-to-int
|
|
|
779 (buffer-substring (match-beginning 3)
|
|
|
780 (match-end 3)))))))
|
|
|
781 (setq bufs (cdr bufs)))
|
|
|
782 (if anode
|
|
|
783 (Info-find-node afile anode t nil aline)
|
|
|
784 (if tryfile
|
|
|
785 (condition-case nil
|
|
|
786 (Info-find-node nodename "Top" t)
|
|
|
787 (error nil)))))
|
|
|
788 (or Info-current-node
|
|
|
789 (error "No such node: %s" nodename)))
|
|
|
790 (if found
|
|
|
791 (progn
|
|
|
792 (Info-select-node)
|
|
|
793 (goto-char (point-min))
|
|
|
794 (if line (forward-line line)))))))
|
|
|
795 ;; If we did not finish finding the specified node,
|
|
|
796 ;; go back to the previous one.
|
|
|
797 (or Info-current-node no-going-back
|
|
|
798 (let ((hist (car Info-history)))
|
|
|
799 ;; The following is no longer safe with new Info-history system
|
|
|
800 ;; (setq Info-history (cdr Info-history))
|
|
|
801 (Info-goto-node (car hist) t)
|
|
|
802 (goto-char (+ (point-min) (nth 1 hist)))))))
|
|
|
803
|
|
|
804 ;; Cache the contents of the (virtual) dir file, once we have merged
|
|
|
805 ;; it for the first time, so we can save time subsequently.
|
|
|
806 (defvar Info-dir-contents nil)
|
|
|
807
|
|
|
808 ;; Cache for the directory we decided to use for the default-directory
|
|
|
809 ;; of the merged dir text.
|
|
|
810 (defvar Info-dir-contents-directory nil)
|
|
|
811
|
|
|
812 ;; Record the file attributes of all the files from which we
|
|
|
813 ;; constructed Info-dir-contents.
|
|
|
814 (defvar Info-dir-file-attributes nil)
|
|
|
815
|
|
|
816 (defun Info-insert-dir ()
|
|
|
817 "Construct the Info directory node by merging the files named
|
|
367
|
818 \"dir\" or \"localdir\" from the directories in `Info-directory-list'.
|
|
217
|
819 The \"dir\" files will take precedence in cases where both exist. It
|
|
|
820 sets the *info* buffer's `default-directory' to the first directory we
|
|
|
821 actually get any text from."
|
|
|
822 (if (and Info-dir-contents Info-dir-file-attributes
|
|
|
823 ;; Verify that none of the files we used has changed
|
|
|
824 ;; since we used it.
|
|
|
825 (eval (cons 'and
|
|
|
826 (mapcar '(lambda (elt)
|
|
|
827 (let ((curr (file-attributes (car elt))))
|
|
|
828 ;; Don't compare the access time.
|
|
|
829 (if curr (setcar (nthcdr 4 curr) 0))
|
|
|
830 (setcar (nthcdr 4 (cdr elt)) 0)
|
|
|
831 (equal (cdr elt) curr)))
|
|
|
832 Info-dir-file-attributes))))
|
|
|
833 (insert Info-dir-contents)
|
|
|
834 (let ((dirs (reverse Info-directory-list))
|
|
|
835 buffers lbuffers buffer others nodes dirs-done)
|
|
|
836
|
|
|
837 (setq Info-dir-file-attributes nil)
|
|
|
838
|
|
|
839 ;; Search the directory list for the directory file.
|
|
|
840 (while dirs
|
|
|
841 (let ((truename (file-truename (expand-file-name (car dirs)))))
|
|
|
842 (or (member truename dirs-done)
|
|
|
843 (member (directory-file-name truename) dirs-done)
|
|
367
|
844 ;; Karl Berry recently added the ability all possibilities for
|
|
|
845 ;; extension as for normal info files. This code however is
|
|
|
846 ;; still unsatisfactory: if one day, we find a compressed dir
|
|
|
847 ;; file (which looks possible), we should be able to handle it
|
|
|
848 ;; (which means decompress and read it, update it, save and
|
|
|
849 ;; recompress it). --dv
|
|
|
850 (let ((trials '("dir" "DIR"
|
|
|
851 "dir.info" "DIR.INFO"
|
|
|
852 "dir.inf" "DIR.INF"
|
|
|
853 "localdir" "LOCALDIR"
|
|
|
854 "localdir.info" "LOCALDIR.INFO"
|
|
|
855 "localdir.inf" "LOCALDIR.INF"))
|
|
|
856 buf file attrs)
|
|
|
857 (catch 'found
|
|
|
858 (while (setq file (pop trials))
|
|
|
859 (setq file (expand-file-name file truename))
|
|
|
860 (and (setq attrs (file-attributes file))
|
|
|
861 (throw 'found t))))
|
|
|
862 (unless file
|
|
|
863 (setq file (expand-file-name "dir" truename)))
|
|
217
|
864 (setq dirs-done
|
|
|
865 (cons truename
|
|
|
866 (cons (directory-file-name truename)
|
|
|
867 dirs-done)))
|
|
274
|
868 (Info-maybe-update-dir file)
|
|
272
|
869 (setq attrs (file-attributes file))
|
|
|
870 (if (or (setq buf (find-buffer-visiting file))
|
|
|
871 attrs)
|
|
217
|
872 (save-excursion
|
|
|
873 (or buffers
|
|
|
874 (message "Composing main Info directory..."))
|
|
272
|
875 (set-buffer (or buf
|
|
|
876 (generate-new-buffer
|
|
|
877 (if (string-match "localdir" file)
|
|
|
878 "localdir"
|
|
|
879 "info dir"))))
|
|
367
|
880 (if (not buf)
|
|
272
|
881 (insert-file-contents file))
|
|
217
|
882 (if (string-match "localdir" (buffer-name))
|
|
|
883 (setq lbuffers (cons (current-buffer) lbuffers))
|
|
|
884 (setq buffers (cons (current-buffer) buffers)))
|
|
274
|
885 (if attrs
|
|
|
886 (setq Info-dir-file-attributes
|
|
|
887 (cons (cons file attrs)
|
|
|
888 Info-dir-file-attributes)))))))
|
|
217
|
889 (or (cdr dirs) (setq Info-dir-contents-directory (car dirs)))
|
|
|
890 (setq dirs (cdr dirs))))
|
|
367
|
891
|
|
217
|
892 ;; ensure that the localdir files are inserted last, and reverse
|
|
|
893 ;; the list of them so that when they get pushed in, they appear
|
|
|
894 ;; in the same order they got specified in the path, from top to
|
|
|
895 ;; bottom.
|
|
294
|
896 (nconc buffers (reverse lbuffers))
|
|
367
|
897
|
|
217
|
898 (or buffers
|
|
|
899 (error "Can't find the Info directory node"))
|
|
|
900 ;; Distinguish the dir file that comes with Emacs from all the
|
|
|
901 ;; others. Yes, that is really what this is supposed to do.
|
|
|
902 ;; If it doesn't work, fix it.
|
|
|
903 (setq buffer (car buffers)
|
|
|
904 ;; reverse it since they are pushed down from the top. the
|
|
269
|
905 ;; `Info-directory-list can be specified in natural order
|
|
|
906 ;; this way.
|
|
294
|
907 others (reverse (cdr buffers)))
|
|
217
|
908
|
|
|
909 ;; Insert the entire original dir file as a start; note that we've
|
|
|
910 ;; already saved its default directory to use as the default
|
|
|
911 ;; directory for the whole concatenation.
|
|
|
912 (insert-buffer buffer)
|
|
|
913
|
|
|
914 ;; Look at each of the other buffers one by one.
|
|
|
915 (while others
|
|
|
916 (let ((other (car others))
|
|
|
917 (info-buffer (current-buffer)))
|
|
|
918 (if (string-match "localdir" (buffer-name other))
|
|
|
919 (save-excursion
|
|
|
920 (set-buffer info-buffer)
|
|
|
921 (goto-char (point-max))
|
|
|
922 (cond
|
|
|
923 ((re-search-backward "^ *\\* *Locals *: *$" nil t)
|
|
|
924 (delete-region (match-beginning 0) (match-end 0)))
|
|
|
925 ;; look for a line like |Local XEmacs packages:
|
|
|
926 ;; or mismatch on some text ...
|
|
|
927 ((re-search-backward Info-localdir-heading-regexp nil t)
|
|
|
928 ;; This is for people who underline topic headings with
|
|
|
929 ;; equal signs or dashes.
|
|
|
930 (when (save-excursion
|
|
|
931 (forward-line 1)
|
|
|
932 (beginning-of-line)
|
|
|
933 (looking-at "^[ \t]*[-=*]+"))
|
|
|
934 (forward-line 1))
|
|
|
935 (forward-line 1)
|
|
|
936 (beginning-of-line))
|
|
|
937 (t (search-backward "\^L" nil t)))
|
|
|
938 ;; Insert menu part of the file
|
|
|
939 (let* ((pt (point))
|
|
|
940 (len (length (buffer-string nil nil other))))
|
|
|
941 (insert (buffer-string nil nil other))
|
|
|
942 (goto-char (+ pt len))
|
|
|
943 (save-excursion
|
|
|
944 (goto-char pt)
|
|
|
945 (if (search-forward "* Menu:" (+ pt len) t)
|
|
|
946 (progn
|
|
|
947 (forward-line 1)
|
|
|
948 (delete-region pt (point)))))))
|
|
|
949 ;; In each, find all the menus.
|
|
|
950 (save-excursion
|
|
|
951 (set-buffer other)
|
|
|
952 (goto-char (point-min))
|
|
|
953 ;; Find each menu, and add an elt to NODES for it.
|
|
|
954 (while (re-search-forward "^\\* Menu:" nil t)
|
|
|
955 (let (beg nodename end)
|
|
|
956 (forward-line 1)
|
|
|
957 (setq beg (point))
|
|
|
958 (search-backward "\n\^_")
|
|
|
959 (search-forward "Node: ")
|
|
|
960 (setq nodename (Info-following-node-name))
|
|
|
961 (search-forward "\n\^_" nil 'move)
|
|
|
962 (beginning-of-line)
|
|
|
963 (setq end (point))
|
|
|
964 (setq nodes (cons (list nodename other beg end) nodes))))))
|
|
|
965 (setq others (cdr others))))
|
|
367
|
966
|
|
217
|
967 ;; Add to the main menu a menu item for each other node.
|
|
|
968 (re-search-forward "^\\* Menu:" nil t)
|
|
|
969 (forward-line 1)
|
|
|
970 (let ((menu-items '("top"))
|
|
|
971 (nodes nodes)
|
|
|
972 (case-fold-search t)
|
|
|
973 (end (save-excursion (search-forward "\^_" nil t) (point))))
|
|
|
974 (while nodes
|
|
|
975 (let ((nodename (car (car nodes))))
|
|
|
976 (save-excursion
|
|
|
977 (or (member (downcase nodename) menu-items)
|
|
|
978 (re-search-forward (concat "^\\* "
|
|
|
979 (regexp-quote nodename)
|
|
|
980 "::")
|
|
|
981 end t)
|
|
|
982 (progn
|
|
|
983 (insert "* " nodename "::" "\n")
|
|
|
984 (setq menu-items (cons nodename menu-items))))))
|
|
|
985 (setq nodes (cdr nodes))))
|
|
|
986 ;; Now take each node of each of the other buffers
|
|
|
987 ;; and merge it into the main buffer.
|
|
|
988 (while nodes
|
|
|
989 (let ((nodename (car (car nodes))))
|
|
|
990 (goto-char (point-min))
|
|
|
991 ;; Find the like-named node in the main buffer.
|
|
|
992 (if (re-search-forward (concat "\n\^_.*\n.*Node: "
|
|
|
993 (regexp-quote nodename)
|
|
|
994 "[,\n\t]")
|
|
|
995 nil t)
|
|
|
996 (progn
|
|
|
997 (search-forward "\n\^_" nil 'move)
|
|
|
998 (beginning-of-line)
|
|
|
999 (insert "\n"))
|
|
|
1000 ;; If none exists, add one.
|
|
|
1001 (goto-char (point-max))
|
|
|
1002 (insert "\^_\nFile: dir\tNode: " nodename "\n\n* Menu:\n\n"))
|
|
|
1003 ;; Merge the text from the other buffer's menu
|
|
|
1004 ;; into the menu in the like-named node in the main buffer.
|
|
|
1005 (apply 'insert-buffer-substring (cdr (car nodes))))
|
|
|
1006 (setq nodes (cdr nodes)))
|
|
|
1007 ;; Kill all the buffers we just made.
|
|
|
1008 (while buffers
|
|
|
1009 (kill-buffer (car buffers))
|
|
|
1010 (setq buffers (cdr buffers)))
|
|
|
1011 (while lbuffers
|
|
|
1012 (kill-buffer (car lbuffers))
|
|
|
1013 (setq lbuffers (cdr lbuffers)))
|
|
|
1014 (message "Composing main Info directory...done"))
|
|
|
1015 (setq Info-dir-contents (buffer-string)))
|
|
|
1016 (setq default-directory Info-dir-contents-directory)
|
|
|
1017 (setq buffer-file-name (caar Info-dir-file-attributes)))
|
|
|
1018
|
|
367
|
1019 (defmacro Info-directory-files (dir-file &optional all full nosort files-only)
|
|
|
1020 "Return a list of Info files living in the same directory as DIR-FILE.
|
|
|
1021 This list actually contains the files living in this directory, except for
|
|
|
1022 the dir file itself and the secondary info files (foo-1 foo-2 etc).
|
|
|
1023
|
|
|
1024 If the optional argument ALL is non nil, the secondary info files are also
|
|
|
1025 included in the list.
|
|
|
1026
|
|
|
1027 Please refer to the function `directory-files' for the meaning of the other
|
|
|
1028 optional arguments."
|
|
|
1029 `(let* ((dir (file-name-directory ,dir-file))
|
|
|
1030 (all-files (remove ,dir-file (directory-files dir ',full nil ',nosort
|
|
|
1031 ',files-only))))
|
|
|
1032 (setq all-files
|
|
|
1033 (if ,full
|
|
|
1034 (remove (concat dir ".")
|
|
|
1035 (remove (concat dir "..") all-files))
|
|
|
1036 (remove "."
|
|
|
1037 (remove ".." all-files))))
|
|
|
1038 (if ,all
|
|
|
1039 all-files
|
|
|
1040 (let ((suff-match
|
|
|
1041 (concat "-[0-9]+\\("
|
|
|
1042 ;; Extract all known compression suffixes from
|
|
|
1043 ;; Info-suffix-list. These suffixes can typically be
|
|
|
1044 ;; found in entries of the form `.info.something'.
|
|
|
1045 (let ((suff-list Info-suffix-list)
|
|
|
1046 suff regexp)
|
|
|
1047 (while (setq suff (pop suff-list))
|
|
|
1048 (and (string-match "^\\.info" (car suff))
|
|
|
1049 (setq regexp (concat regexp
|
|
|
1050 (regexp-quote
|
|
|
1051 (substring
|
|
|
1052 (car suff) 5))
|
|
|
1053 (and suff-list "\\|")))))
|
|
|
1054 regexp)
|
|
|
1055 "\\)?$"))
|
|
|
1056 info-files file)
|
|
|
1057 (while (setq file (pop all-files))
|
|
|
1058 (or (string-match suff-match file)
|
|
|
1059 (push file info-files)))
|
|
|
1060 (reverse info-files)
|
|
|
1061 ))
|
|
|
1062 ))
|
|
|
1063
|
|
272
|
1064 (defun Info-maybe-update-dir (file)
|
|
292
|
1065 "Rebuild dir or localdir according to `Info-auto-generate-directory'."
|
|
|
1066 (unless (or (not (file-exists-p (file-name-directory file)))
|
|
367
|
1067 (null (Info-directory-files file 'all)))
|
|
272
|
1068 (if (not (find-buffer-visiting file))
|
|
|
1069 (if (not (file-exists-p file))
|
|
292
|
1070 (if (or (eq Info-auto-generate-directory 'always)
|
|
367
|
1071 (eq Info-auto-generate-directory 'if-missing))
|
|
292
|
1072 (Info-build-dir-anew (file-name-directory file)))
|
|
|
1073 (if (or (eq Info-auto-generate-directory 'always)
|
|
|
1074 (and (eq Info-auto-generate-directory 'if-outdated)
|
|
|
1075 (Info-dir-outdated-p file)))
|
|
|
1076 (Info-rebuild-dir file))))))
|
|
272
|
1077
|
|
|
1078 ;; Record which *.info files are newer than the dir file
|
|
|
1079 (defvar Info-dir-newer-info-files nil)
|
|
|
1080
|
|
|
1081 (defun Info-dir-outdated-p (file)
|
|
|
1082 "Return non-nil if dir or localdir is outdated.
|
|
278
|
1083 dir or localdir are outdated when an info file in the same
|
|
272
|
1084 directory has been modified more recently."
|
|
|
1085 (let ((dir-mod-time (nth 5 (file-attributes file)))
|
|
367
|
1086 f-mod-time newer)
|
|
272
|
1087 (setq Info-dir-newer-info-files nil)
|
|
367
|
1088 (mapcar
|
|
272
|
1089 '(lambda (f)
|
|
|
1090 (prog2
|
|
|
1091 (setq f-mod-time (nth 5 (file-attributes f)))
|
|
|
1092 (setq newer (or (> (car f-mod-time) (car dir-mod-time))
|
|
|
1093 (and (= (car f-mod-time) (car dir-mod-time))
|
|
367
|
1094 (> (car (cdr f-mod-time))
|
|
|
1095 (car (cdr dir-mod-time))))))
|
|
|
1096 (if (and (file-readable-p f) newer)
|
|
|
1097 (setq Info-dir-newer-info-files
|
|
272
|
1098 (cons f Info-dir-newer-info-files)))))
|
|
367
|
1099 (Info-directory-files file nil 'fullname 'nosort t))
|
|
272
|
1100 Info-dir-newer-info-files))
|
|
|
1101
|
|
274
|
1102 (defun Info-extract-dir-entry-from (file)
|
|
|
1103 "Extract the dir entry from the info FILE.
|
|
|
1104 The dir entry is delimited by the markers `START-INFO-DIR-ENTRY'
|
|
272
|
1105 and `END-INFO-DIR-ENTRY'"
|
|
|
1106 (save-excursion
|
|
|
1107 (set-buffer (get-buffer-create " *Info-tmp*"))
|
|
|
1108 (when (file-readable-p file)
|
|
|
1109 (insert-file-contents file nil nil nil t)
|
|
|
1110 (goto-char (point-min))
|
|
|
1111 (let (beg)
|
|
|
1112 (unless (null (re-search-forward "^START-INFO-DIR-ENTRY" nil t))
|
|
|
1113 (forward-line 1)
|
|
|
1114 (setq beg (point))
|
|
|
1115 (unless (null (re-search-forward "^END-INFO-DIR-ENTRY" nil t))
|
|
|
1116 (goto-char (match-beginning 0))
|
|
274
|
1117 (car (Info-parse-dir-entries beg (point)))))))))
|
|
|
1118
|
|
|
1119 ;; Parse dir entries contained between BEG and END into a list of the form
|
|
|
1120 ;; (filename topic node (description-line-1 description-line-2 ...))
|
|
|
1121 (defun Info-parse-dir-entries (beg end)
|
|
|
1122 (let (entry entries)
|
|
|
1123 (save-excursion
|
|
|
1124 (save-restriction
|
|
|
1125 (narrow-to-region beg end)
|
|
|
1126 (goto-char beg)
|
|
367
|
1127 (while (re-search-forward
|
|
|
1128 "^\\* \\([^:]+\\):\\([ \t]*(\\([^)]*\\))\\w*\\.\\|:\\)" nil t)
|
|
274
|
1129 (setq entry (list (match-string 2)
|
|
|
1130 (match-string 1)
|
|
|
1131 (downcase (or (match-string 3)
|
|
|
1132 (match-string 1)))))
|
|
367
|
1133 (setq entry
|
|
|
1134 (cons (nreverse
|
|
|
1135 (cdr
|
|
|
1136 (nreverse
|
|
|
1137 (split-string
|
|
|
1138 (buffer-substring
|
|
278
|
1139 (re-search-forward "[ \t]*" nil t)
|
|
|
1140 (or (and (re-search-forward "^[^ \t]" nil t)
|
|
|
1141 (goto-char (match-beginning 0)))
|
|
|
1142 (point-max)))
|
|
|
1143 "[ \t]*\n[ \t]*"))))
|
|
|
1144 entry))
|
|
274
|
1145 (setq entries (cons (nreverse entry) entries)))))
|
|
|
1146 (nreverse entries)))
|
|
|
1147
|
|
|
1148 (defun Info-dump-dir-entries (entries)
|
|
|
1149 (let ((tab-width 8)
|
|
|
1150 (description-col 0)
|
|
|
1151 len)
|
|
|
1152 (mapcar '(lambda (e)
|
|
|
1153 (setq e (cdr e)) ; Drop filename
|
|
|
1154 (setq len (length (concat (car e)
|
|
|
1155 (car (cdr e)))))
|
|
|
1156 (if (> len description-col)
|
|
|
1157 (setq description-col len)))
|
|
|
1158 entries)
|
|
367
|
1159 (setq description-col (+ 5 description-col))
|
|
274
|
1160 (mapcar '(lambda (e)
|
|
|
1161 (setq e (cdr e)) ; Drop filename
|
|
|
1162 (insert "* " (car e) ":" (car (cdr e)))
|
|
|
1163 (setq e (car (cdr (cdr e))))
|
|
|
1164 (while e
|
|
|
1165 (indent-to-column description-col)
|
|
|
1166 (insert (car e) "\n")
|
|
|
1167 (setq e (cdr e))))
|
|
278
|
1168 entries)
|
|
|
1169 (insert "\n")))
|
|
274
|
1170
|
|
272
|
1171
|
|
292
|
1172 (defun Info-build-dir-anew (directory)
|
|
|
1173 "Build info directory information for DIRECTORY.
|
|
367
|
1174 The generated directory listing may be saved to a `dir' according
|
|
292
|
1175 to the value of `Info-save-auto-generated-dir'"
|
|
272
|
1176 (save-excursion
|
|
292
|
1177 (let* ((dirfile (expand-file-name "dir" directory))
|
|
|
1178 (to-temp (or (null Info-save-auto-generated-dir)
|
|
|
1179 (eq Info-save-auto-generated-dir 'never)
|
|
|
1180 (and (not (file-writable-p dirfile))
|
|
367
|
1181 (message "File not writable %s. Using temporary."
|
|
|
1182 dirfile))))
|
|
|
1183 (info-files (Info-directory-files dirfile nil 'fullname nil t)))
|
|
272
|
1184 (if to-temp
|
|
292
|
1185 (message "Creating temporary dir in %s..." directory)
|
|
272
|
1186 (message "Creating %s..." dirfile))
|
|
274
|
1187 (set-buffer (find-file-noselect dirfile t))
|
|
|
1188 (setq buffer-read-only nil)
|
|
272
|
1189 (erase-buffer)
|
|
367
|
1190 (insert Info-dir-prologue "Info files in " directory ":\n\n")
|
|
|
1191 (Info-dump-dir-entries
|
|
|
1192 (mapcar
|
|
274
|
1193 '(lambda (f)
|
|
|
1194 (or (Info-extract-dir-entry-from f)
|
|
|
1195 (list 'dummy
|
|
367
|
1196 (progn (string-match "\\([^.]*\\)\\(\\..*\\)?$"
|
|
|
1197 (file-name-nondirectory f))
|
|
|
1198 (capitalize
|
|
|
1199 (match-string 1 (file-name-nondirectory f))))
|
|
274
|
1200 ":"
|
|
|
1201 (list Info-no-description-string))))
|
|
|
1202 info-files))
|
|
272
|
1203 (if to-temp
|
|
|
1204 (set-buffer-modified-p nil)
|
|
|
1205 (save-buffer))
|
|
|
1206 (if to-temp
|
|
292
|
1207 (message "Creating temporary dir in %s...done" directory)
|
|
272
|
1208 (message "Creating %s...done" dirfile)))))
|
|
|
1209
|
|
|
1210
|
|
292
|
1211 (defun Info-rebuild-dir (file)
|
|
|
1212 "Build info directory information in the directory of dir FILE.
|
|
367
|
1213 Description of info files are merged from the info files in the
|
|
292
|
1214 directory and the contents of FILE with the description in info files
|
|
367
|
1215 taking precedence over descriptions in FILE.
|
|
|
1216 The generated directory listing may be saved to a `dir' according to
|
|
292
|
1217 the value of `Info-save-auto-generated-dir' "
|
|
272
|
1218 (save-excursion
|
|
274
|
1219 (save-restriction
|
|
|
1220 (let (dir-section-contents dir-full-contents
|
|
|
1221 dir-entry
|
|
|
1222 file-dir-entry
|
|
|
1223 mark next-section
|
|
292
|
1224 not-first-section
|
|
367
|
1225 (to-temp
|
|
292
|
1226 (or (null Info-save-auto-generated-dir)
|
|
|
1227 (eq Info-save-auto-generated-dir 'never)
|
|
|
1228 (and (eq Info-save-auto-generated-dir 'always)
|
|
|
1229 (not (file-writable-p file))
|
|
|
1230 (message "File not writable %s. Using temporary." file))
|
|
|
1231 (and (eq Info-save-auto-generated-dir 'conservative)
|
|
|
1232 (or (and (not (file-writable-p file))
|
|
367
|
1233 (message
|
|
|
1234 "File not writable %s. Using temporary." file))
|
|
|
1235 (not (y-or-n-p
|
|
|
1236 (message "%s is outdated. Overwrite ? "
|
|
292
|
1237 file))))))))
|
|
274
|
1238 (set-buffer (find-file-noselect file t))
|
|
|
1239 (setq buffer-read-only nil)
|
|
|
1240 (if to-temp
|
|
292
|
1241 (message "Rebuilding temporary %s..." file)
|
|
274
|
1242 (message "Rebuilding %s..." file))
|
|
|
1243 (catch 'done
|
|
|
1244 (setq buffer-read-only nil)
|
|
|
1245 (goto-char (point-min))
|
|
|
1246 (unless (and (search-forward "\^_")
|
|
|
1247 (re-search-forward "^\\* Menu:.*$" nil t)
|
|
|
1248 (setq mark (and (re-search-forward "^\\* " nil t)
|
|
|
1249 (match-beginning 0))))
|
|
|
1250 (throw 'done nil))
|
|
|
1251 (setq dir-full-contents (Info-parse-dir-entries mark (point-max)))
|
|
367
|
1252 (setq next-section (or (and (re-search-forward
|
|
|
1253 "^[^* \t].*:[ \t]*$" nil t)
|
|
274
|
1254 (match-beginning 0))
|
|
|
1255 (point-max)))
|
|
|
1256 (while next-section
|
|
|
1257 (narrow-to-region mark next-section)
|
|
367
|
1258 (setq dir-section-contents (nreverse (Info-parse-dir-entries
|
|
|
1259 (point-min) (point-max))))
|
|
|
1260 (mapcar
|
|
|
1261 '(lambda (file)
|
|
|
1262 (setq dir-entry (assoc (downcase
|
|
|
1263 (file-name-sans-extension
|
|
|
1264 (file-name-nondirectory file)))
|
|
|
1265 dir-section-contents)
|
|
|
1266 file-dir-entry (Info-extract-dir-entry-from file))
|
|
|
1267 (if dir-entry
|
|
|
1268 (if file-dir-entry
|
|
|
1269 ;; A dir entry in the info file takes precedence over
|
|
|
1270 ;; an existing entry in the dir file
|
|
|
1271 (setcdr dir-entry (cdr file-dir-entry)))
|
|
|
1272 (unless (or not-first-section
|
|
|
1273 (assoc (downcase
|
|
|
1274 (file-name-sans-extension
|
|
|
1275 (file-name-nondirectory file)))
|
|
|
1276 dir-full-contents))
|
|
|
1277 (if file-dir-entry
|
|
|
1278 (setq dir-section-contents
|
|
|
1279 (cons file-dir-entry dir-section-contents))
|
|
|
1280 (setq dir-section-contents
|
|
|
1281 (cons (list 'dummy
|
|
|
1282 (capitalize (file-name-sans-extension
|
|
|
1283 (file-name-nondirectory
|
|
|
1284 file)))
|
|
|
1285 ":"
|
|
|
1286 (list Info-no-description-string))
|
|
|
1287 dir-section-contents))))))
|
|
|
1288 Info-dir-newer-info-files)
|
|
274
|
1289 (delete-region (point-min) (point-max))
|
|
|
1290 (Info-dump-dir-entries (nreverse dir-section-contents))
|
|
|
1291 (widen)
|
|
|
1292 (if (= next-section (point-max))
|
|
|
1293 (setq next-section nil)
|
|
|
1294 (or (setq mark (and (re-search-forward "^\\* " nil t)
|
|
|
1295 (match-beginning 0)))
|
|
|
1296 (throw 'done nil))
|
|
367
|
1297 (setq next-section (or (and (re-search-forward
|
|
|
1298 "^[^* \t].*:[ \t]*$" nil t)
|
|
274
|
1299 (match-beginning 0))
|
|
|
1300 (point-max))))
|
|
|
1301 (setq not-first-section t)))
|
|
|
1302 (if to-temp
|
|
292
|
1303 (progn
|
|
|
1304 (set-buffer-modified-p nil)
|
|
|
1305 (message "Rebuilding temporary %s...done" file))
|
|
|
1306 (save-buffer)
|
|
274
|
1307 (message "Rebuilding %s...done" file))))))
|
|
278
|
1308
|
|
367
|
1309 ;;;###autoload
|
|
278
|
1310 (defun Info-batch-rebuild-dir ()
|
|
367
|
1311 "(Re)build `dir' files in the directories remaining on the command line.
|
|
|
1312 Use this from the command line, with `-batch', it won't work in an
|
|
|
1313 interactive XEmacs.
|
|
|
1314
|
|
|
1315 Each file is processed even if an error occurred previously. For example,
|
|
|
1316 invoke \"xemacs -batch -f Info-batch-rebuild-dir /usr/local/info\""
|
|
278
|
1317 ;; command-line-args-left is what is left of the command line (from
|
|
|
1318 ;; startup.el)
|
|
|
1319 (defvar command-line-args-left) ; Avoid 'free variable' warning
|
|
|
1320 (if (not noninteractive)
|
|
|
1321 (error "`Info-batch-rebuild-dir' is to be used only with -batch"))
|
|
292
|
1322 (let ((Info-save-auto-generated-dir 'always)
|
|
|
1323 dir localdir)
|
|
|
1324 (while command-line-args-left
|
|
|
1325 (if (not (file-directory-p (car command-line-args-left)))
|
|
|
1326 (message "Warning: Skipped %s. Not a directory."
|
|
|
1327 (car command-line-args-left))
|
|
|
1328 (setq dir (expand-file-name "dir" (car command-line-args-left)))
|
|
367
|
1329 (setq localdir (expand-file-name "localdir"
|
|
|
1330 (car command-line-args-left)))
|
|
|
1331 (cond
|
|
292
|
1332 ((file-exists-p dir)
|
|
|
1333 (Info-rebuild-dir dir))
|
|
|
1334 ((file-exists-p localdir)
|
|
|
1335 (Info-rebuild-dir localdir))
|
|
|
1336 (t
|
|
|
1337 (Info-build-dir-anew (car command-line-args-left)))))
|
|
|
1338 (setq command-line-args-left (cdr command-line-args-left)))
|
|
|
1339 (message "Done")
|
|
|
1340 (kill-emacs 0)))
|
|
272
|
1341
|
|
217
|
1342 (defun Info-history-add (file node point)
|
|
|
1343 (if Info-keeping-history
|
|
|
1344 (let* ((name (format "(%s)%s" (Info-file-name-only file) node))
|
|
|
1345 (found (assoc name Info-history)))
|
|
|
1346 (if found
|
|
|
1347 (setq Info-history (delq found Info-history)))
|
|
|
1348 (setq Info-history (cons (list name (- point (point-min))
|
|
|
1349 (and (eq (window-buffer)
|
|
|
1350 (current-buffer))
|
|
|
1351 (- (window-start) (point-min))))
|
|
|
1352 Info-history)))))
|
|
|
1353
|
|
|
1354 (defun Info-file-name-only (file)
|
|
|
1355 (let ((dir (file-name-directory file))
|
|
|
1356 (p Info-directory-list))
|
|
|
1357 (while (and p (not (equal (car p) dir)))
|
|
|
1358 (setq p (cdr p)))
|
|
|
1359 (if p (file-name-nondirectory file) file)))
|
|
|
1360
|
|
|
1361 (defun Info-read-subfile (nodepos)
|
|
|
1362 (set-buffer (marker-buffer Info-tag-table-marker))
|
|
|
1363 (goto-char (point-min))
|
|
|
1364 (search-forward "\n\^_")
|
|
|
1365 (let (lastfilepos
|
|
|
1366 lastfilename)
|
|
|
1367 (forward-line 2)
|
|
|
1368 (catch 'foo
|
|
|
1369 (while (not (looking-at "\^_"))
|
|
|
1370 (if (not (eolp))
|
|
|
1371 (let ((beg (point))
|
|
|
1372 thisfilepos thisfilename)
|
|
|
1373 (search-forward ": ")
|
|
|
1374 (setq thisfilename (buffer-substring beg (- (point) 2)))
|
|
|
1375 (setq thisfilepos (read (current-buffer)))
|
|
|
1376 ;; read in version 19 stops at the end of number.
|
|
|
1377 ;; Advance to the next line.
|
|
|
1378 (if (eolp)
|
|
|
1379 (forward-line 1))
|
|
|
1380 (if (> thisfilepos nodepos)
|
|
|
1381 (throw 'foo t))
|
|
|
1382 (setq lastfilename thisfilename)
|
|
|
1383 (setq lastfilepos thisfilepos))
|
|
|
1384 (throw 'foo t))))
|
|
|
1385 (set-buffer (get-buffer "*info*"))
|
|
|
1386 (or (equal Info-current-subfile lastfilename)
|
|
|
1387 (let ((buffer-read-only nil))
|
|
|
1388 (setq buffer-file-name nil)
|
|
|
1389 (widen)
|
|
|
1390 (erase-buffer)
|
|
|
1391 (Info-insert-file-contents (Info-suffixed-file
|
|
|
1392 (expand-file-name lastfilename
|
|
|
1393 (file-name-directory
|
|
367
|
1394 Info-current-file))
|
|
|
1395 'exact)
|
|
217
|
1396 t)
|
|
|
1397 (set-buffer-modified-p nil)
|
|
|
1398 (setq Info-current-subfile lastfilename)))
|
|
|
1399 (goto-char (point-min))
|
|
|
1400 (search-forward "\n\^_")
|
|
|
1401 (+ (- nodepos lastfilepos) (point))))
|
|
|
1402
|
|
367
|
1403 (defun Info-all-case-regexp (str)
|
|
|
1404 (let ((regexp "")
|
|
|
1405 (len (length str))
|
|
|
1406 (i 0)
|
|
|
1407 c)
|
|
|
1408 (while (< i len)
|
|
|
1409 (setq c (aref str i))
|
|
|
1410 (cond ((or (and (>= c ?A) (<= c ?Z))
|
|
|
1411 (and (>= c ?a) (<= c ?z)))
|
|
|
1412 (setq regexp (concat regexp
|
|
|
1413 "["
|
|
|
1414 (char-to-string (downcase c))
|
|
|
1415 "\\|"
|
|
|
1416 (char-to-string (upcase c))
|
|
|
1417 "]")))
|
|
217
|
1418 (t
|
|
367
|
1419 (setq regexp (concat regexp (char-to-string c)))))
|
|
|
1420 (setq i (1+ i)))
|
|
|
1421 regexp))
|
|
|
1422
|
|
|
1423 (defun Info-suffixed-file (name &optional exact)
|
|
|
1424 "Look for an info file named NAME. This function tries to be smart in
|
|
|
1425 finding the file corresponding to NAME: if it doesn't exist, several
|
|
|
1426 variants are looked for, notably by appending suffixes from
|
|
|
1427 `Info-suffix-list' and by trying to change the characters case in NAME.
|
|
|
1428
|
|
|
1429 The optional argument EXACT prevents this function from trying different case
|
|
|
1430 versions of NAME. Only the suffixes are tried."
|
|
|
1431 (catch 'found
|
|
|
1432 ;; First, try NAME alone:
|
|
|
1433 (and (file-regular-p name) (throw 'found name))
|
|
|
1434 ;; Then, try different variants
|
|
|
1435 (let ((suff-match (concat "\\("
|
|
|
1436 (let ((suff-list Info-suffix-list)
|
|
|
1437 suff regexp)
|
|
|
1438 (while (setq suff (pop suff-list))
|
|
|
1439 (setq regexp
|
|
|
1440 (concat regexp
|
|
|
1441 (regexp-quote (car suff))
|
|
|
1442 (and suff-list "\\|"))))
|
|
|
1443 regexp)
|
|
|
1444 "\\)?$"))
|
|
|
1445 (dir (file-name-directory name))
|
|
|
1446 file files)
|
|
|
1447 (setq name (file-name-nondirectory name))
|
|
|
1448 (setq files
|
|
|
1449 (condition-case data ;; protect against invalid directory
|
|
|
1450 ;; First, try NAME[.<suffix>]
|
|
|
1451 (append
|
|
|
1452 (directory-files dir 'fullname
|
|
|
1453 (concat "^" (regexp-quote name) suff-match)
|
|
|
1454 nil t)
|
|
|
1455 (if exact
|
|
|
1456 nil
|
|
|
1457 ;; Then, try to match the name independantly of the
|
|
|
1458 ;; characters case.
|
|
|
1459 (directory-files dir 'fullname
|
|
|
1460 (Info-all-case-regexp
|
|
|
1461 (concat "^"
|
|
|
1462 (regexp-quote name)
|
|
|
1463 suff-match))
|
|
|
1464 nil t)))
|
|
|
1465 (t
|
|
|
1466 (display-warning 'info
|
|
|
1467 (format "directory `%s' error: %s" dir data))
|
|
|
1468 nil)))
|
|
|
1469 (while (setq file (pop files))
|
|
|
1470 (and (file-regular-p file)
|
|
|
1471 (throw 'found file)))
|
|
|
1472 )))
|
|
217
|
1473
|
|
|
1474 (defun Info-insert-file-contents (file &optional visit)
|
|
|
1475 (setq file (expand-file-name file default-directory))
|
|
367
|
1476 (let ((suff Info-suffix-list)
|
|
|
1477 len)
|
|
|
1478 (while (and suff
|
|
|
1479 (setq len (length (car (car suff))))
|
|
|
1480 (or (<= (length file) len)
|
|
|
1481 (not (or
|
|
|
1482 (equal (substring file (- len))
|
|
|
1483 (car (car suff)))
|
|
|
1484 (equal (substring file (- len))
|
|
|
1485 (upcase (car (car suff)))))
|
|
|
1486 )))
|
|
217
|
1487 (setq suff (cdr suff)))
|
|
|
1488 (if (stringp (cdr (car suff)))
|
|
|
1489 (let ((command (if (string-match "%s" (cdr (car suff)))
|
|
|
1490 (format (cdr (car suff)) file)
|
|
|
1491 (concat (cdr (car suff)) " < " file))))
|
|
|
1492 (message "%s..." command)
|
|
|
1493 (if (eq system-type 'vax-vms)
|
|
|
1494 (call-process command nil t nil)
|
|
|
1495 (call-process shell-file-name nil t nil "-c" command))
|
|
|
1496 (message "")
|
|
|
1497 (if visit
|
|
|
1498 (progn
|
|
|
1499 (setq buffer-file-name file)
|
|
|
1500 (set-buffer-modified-p nil)
|
|
|
1501 (clear-visited-file-modtime))))
|
|
|
1502 (insert-file-contents file visit))))
|
|
|
1503
|
|
|
1504 (defun Info-select-node ()
|
|
|
1505 "Select the node that point is in, after using `g *' to select whole file."
|
|
|
1506 (interactive)
|
|
|
1507 (widen)
|
|
|
1508 (save-excursion
|
|
|
1509 ;; Find beginning of node.
|
|
|
1510 (search-backward "\n\^_")
|
|
|
1511 (forward-line 2)
|
|
|
1512 ;; Get nodename spelled as it is in the node.
|
|
|
1513 (re-search-forward "Node:[ \t]*")
|
|
|
1514 (setq Info-current-node
|
|
|
1515 (buffer-substring (point)
|
|
|
1516 (progn
|
|
|
1517 (skip-chars-forward "^,\t\n")
|
|
|
1518 (point))))
|
|
|
1519 (Info-set-mode-line)
|
|
|
1520 ;; Find the end of it, and narrow.
|
|
|
1521 (beginning-of-line)
|
|
|
1522 (let (active-expression)
|
|
|
1523 (narrow-to-region (point)
|
|
|
1524 (if (re-search-forward "\n[\^_\f]" nil t)
|
|
|
1525 (prog1
|
|
|
1526 (1- (point))
|
|
|
1527 (if (looking-at "[\n\^_\f]*execute: ")
|
|
|
1528 (progn
|
|
|
1529 (goto-char (match-end 0))
|
|
|
1530 (setq active-expression
|
|
|
1531 (read (current-buffer))))))
|
|
|
1532 (point-max)))
|
|
|
1533 (or (equal Info-footnote-tag "Note")
|
|
|
1534 (progn
|
|
|
1535 (goto-char (point-min))
|
|
|
1536 (let ((buffer-read-only nil)
|
|
|
1537 (bufmod (buffer-modified-p))
|
|
|
1538 (case-fold-search t))
|
|
|
1539 (while (re-search-forward "\\*[Nn]ote\\([ \n]\\)" nil t)
|
|
|
1540 (replace-match (concat "*" Info-footnote-tag "\ ")))
|
|
|
1541 (set-buffer-modified-p bufmod))))
|
|
|
1542 (Info-reannotate-node)
|
|
|
1543 ;; XEmacs: remove v19 test
|
|
|
1544 (and Info-fontify
|
|
|
1545 (Info-fontify-node))
|
|
|
1546 (run-hooks 'Info-select-hook)
|
|
|
1547 (if Info-enable-active-nodes (eval active-expression)))))
|
|
|
1548
|
|
|
1549 (defun Info-set-mode-line ()
|
|
|
1550 (setq modeline-buffer-identification
|
|
|
1551 (list (cons modeline-buffer-id-left-extent "Info: ")
|
|
|
1552 (cons modeline-buffer-id-right-extent
|
|
|
1553 (concat
|
|
|
1554 "("
|
|
|
1555 (if Info-current-file
|
|
367
|
1556 (let ((name (file-name-nondirectory
|
|
|
1557 Info-current-file)))
|
|
|
1558 (if (string-match "^\\([^.]*\\)\\..*$" name)
|
|
|
1559 (match-string 1 name)
|
|
217
|
1560 name))
|
|
|
1561 "")
|
|
|
1562 ")"
|
|
|
1563 (or Info-current-node ""))))))
|
|
|
1564
|
|
|
1565 ;; Go to an info node specified with a filename-and-nodename string
|
|
|
1566 ;; of the sort that is found in pointers in nodes.
|
|
|
1567
|
|
|
1568 ;;;###autoload
|
|
|
1569 (defun Info-goto-node (nodename &optional no-going-back tryfile)
|
|
|
1570 "Go to info node named NAME. Give just NODENAME or (FILENAME)NODENAME.
|
|
|
1571 Actually, the following interpretations of NAME are tried in order:
|
|
|
1572 (FILENAME)NODENAME
|
|
|
1573 (FILENAME) (using Top node)
|
|
|
1574 NODENAME (in current file)
|
|
|
1575 TAGNAME (see below)
|
|
|
1576 FILENAME (using Top node)
|
|
|
1577 where TAGNAME is a string that appears in quotes: \"TAGNAME\", in an
|
|
|
1578 annotation for any node of any file. (See `a' and `x' commands.)"
|
|
|
1579 (interactive (list (Info-read-node-name "Goto node, file or tag: ")
|
|
|
1580 nil t))
|
|
|
1581 (let (filename)
|
|
|
1582 (string-match "\\s *\\((\\s *\\([^\t)]*\\)\\s *)\\s *\\|\\)\\(.*\\)"
|
|
|
1583 nodename)
|
|
|
1584 (setq filename (if (= (match-beginning 1) (match-end 1))
|
|
|
1585 ""
|
|
|
1586 (substring nodename (match-beginning 2) (match-end 2)))
|
|
|
1587 nodename (substring nodename (match-beginning 3) (match-end 3)))
|
|
|
1588 (let ((trim (string-match "\\s *\\'" filename)))
|
|
|
1589 (if trim (setq filename (substring filename 0 trim))))
|
|
|
1590 (let ((trim (string-match "\\s *\\'" nodename)))
|
|
|
1591 (if trim (setq nodename (substring nodename 0 trim))))
|
|
|
1592 (Info-find-node (if (equal filename "") nil filename)
|
|
|
1593 (if (equal nodename "") "Top" nodename)
|
|
|
1594 no-going-back (and tryfile (equal filename "")))))
|
|
|
1595
|
|
|
1596 (defun Info-goto-bookmark ()
|
|
|
1597 (interactive)
|
|
|
1598 (let ((completion-ignore-case nil)
|
|
|
1599 (tag (completing-read "Goto tag: "
|
|
|
1600 (Info-build-annotation-completions)
|
|
|
1601 nil t nil
|
|
|
1602 'Info-minibuffer-history)))
|
|
|
1603 (or (equal tag "") (Info-find-node nil (format "<<%s>>" tag)))))
|
|
|
1604
|
|
|
1605 ;;;###autoload
|
|
|
1606 (defun Info-visit-file ()
|
|
|
1607 "Directly visit an info file."
|
|
|
1608 (interactive)
|
|
|
1609 (let* ((insert-default-directory nil)
|
|
|
1610 (file (read-file-name "Goto Info file: " "" "")))
|
|
|
1611 (or (equal file "") (Info-find-node (expand-file-name file) "Top"))))
|
|
|
1612
|
|
|
1613 (defun Info-restore-point (&optional always)
|
|
|
1614 "Restore point to same location it had last time we were in this node."
|
|
|
1615 (interactive "p")
|
|
|
1616 (if (or Info-restoring-point always)
|
|
|
1617 (let* ((name (format "(%s)%s"
|
|
|
1618 (Info-file-name-only Info-current-file)
|
|
|
1619 Info-current-node))
|
|
|
1620 (p (assoc name Info-history)))
|
|
|
1621 (if p (Info-restore-history-entry p)))))
|
|
|
1622
|
|
|
1623 (defun Info-restore-history-entry (entry)
|
|
|
1624 (goto-char (+ (nth 1 entry) (point-min)))
|
|
|
1625 (and (nth 2 entry)
|
|
|
1626 (get-buffer-window (current-buffer))
|
|
|
1627 (set-window-start (get-buffer-window (current-buffer))
|
|
|
1628 (+ (nth 2 entry) (point-min)))))
|
|
|
1629
|
|
|
1630 (defun Info-read-node-name (prompt &optional default)
|
|
|
1631 (Info-setup-initial)
|
|
|
1632 (let* ((completion-ignore-case t)
|
|
|
1633 (nodename (completing-read prompt
|
|
|
1634 (Info-build-node-completions)
|
|
|
1635 nil nil nil
|
|
|
1636 'Info-minibuffer-history)))
|
|
|
1637 (if (equal nodename "")
|
|
|
1638 (or default
|
|
|
1639 (Info-read-node-name prompt))
|
|
|
1640 nodename)))
|
|
|
1641
|
|
|
1642 (defun Info-build-annotation-completions ()
|
|
|
1643 (or Info-current-annotation-completions
|
|
|
1644 (save-excursion
|
|
|
1645 (let ((bufs (delq nil (mapcar 'get-file-buffer
|
|
|
1646 Info-annotations-path)))
|
|
|
1647 (compl nil))
|
|
|
1648 (while bufs
|
|
|
1649 (set-buffer (car bufs))
|
|
|
1650 (goto-char (point-min))
|
|
|
1651 (while (re-search-forward "<<\\(.*\\)>>" nil t)
|
|
|
1652 (setq compl (cons (list (buffer-substring (match-beginning 1)
|
|
|
1653 (match-end 1)))
|
|
|
1654 compl)))
|
|
|
1655 (setq bufs (cdr bufs)))
|
|
|
1656 (setq Info-current-annotation-completions compl)))))
|
|
|
1657
|
|
|
1658 (defun Info-build-node-completions ()
|
|
|
1659 (or Info-current-file-completions
|
|
|
1660 (let ((compl (Info-build-annotation-completions)))
|
|
|
1661 (save-excursion
|
|
|
1662 (save-restriction
|
|
335
|
1663 (widen)
|
|
217
|
1664 (if (marker-buffer Info-tag-table-marker)
|
|
|
1665 (progn
|
|
|
1666 (set-buffer (marker-buffer Info-tag-table-marker))
|
|
|
1667 (goto-char Info-tag-table-marker)
|
|
|
1668 (while (re-search-forward "\nNode: \\(.*\\)\177" nil t)
|
|
|
1669 (setq compl
|
|
|
1670 (cons (list (buffer-substring (match-beginning 1)
|
|
|
1671 (match-end 1)))
|
|
|
1672 compl))))
|
|
|
1673 (goto-char (point-min))
|
|
|
1674 (while (search-forward "\n\^_" nil t)
|
|
|
1675 (forward-line 1)
|
|
|
1676 (let ((beg (point)))
|
|
|
1677 (forward-line 1)
|
|
|
1678 (if (re-search-backward "Node: *\\([^,\n]*\\) *[,\n\t]"
|
|
|
1679 beg t)
|
|
367
|
1680 (setq compl
|
|
217
|
1681 (cons (list (buffer-substring (match-beginning 1)
|
|
|
1682 (match-end 1)))
|
|
|
1683 compl))))))))
|
|
|
1684 (setq Info-current-file-completions compl))))
|
|
|
1685
|
|
|
1686 (defvar Info-last-search nil
|
|
|
1687 "Default regexp for \\<Info-mode-map>\\[Info-search] command to search for.")
|
|
|
1688
|
|
|
1689
|
|
|
1690 ;;;###autoload
|
|
|
1691 (defun Info-search (regexp)
|
|
|
1692 "Search for REGEXP, starting from point, and select node it's found in."
|
|
|
1693 (interactive "sSearch (regexp): ")
|
|
|
1694 (if (equal regexp "")
|
|
|
1695 (setq regexp Info-last-search)
|
|
|
1696 (setq Info-last-search regexp))
|
|
|
1697 (with-caps-disable-folding regexp
|
|
|
1698 (let ((found ())
|
|
|
1699 (onode Info-current-node)
|
|
|
1700 (ofile Info-current-file)
|
|
|
1701 (opoint (point))
|
|
|
1702 (osubfile Info-current-subfile))
|
|
|
1703 (save-excursion
|
|
|
1704 (save-restriction
|
|
|
1705 (widen)
|
|
|
1706 (if (null Info-current-subfile)
|
|
|
1707 (progn (re-search-forward regexp) (setq found (point)))
|
|
|
1708 (condition-case nil
|
|
|
1709 (progn (re-search-forward regexp) (setq found (point)))
|
|
|
1710 (search-failed nil)))))
|
|
367
|
1711 (if (not found)
|
|
|
1712 ;; can only happen in subfile case -- else would have erred
|
|
217
|
1713 (unwind-protect
|
|
|
1714 (let ((list ()))
|
|
|
1715 (set-buffer (marker-buffer Info-tag-table-marker))
|
|
|
1716 (goto-char (point-min))
|
|
|
1717 (search-forward "\n\^_\nIndirect:")
|
|
|
1718 (save-restriction
|
|
|
1719 (narrow-to-region (point)
|
|
|
1720 (progn (search-forward "\n\^_")
|
|
|
1721 (1- (point))))
|
|
|
1722 (goto-char (point-min))
|
|
|
1723 (search-forward (concat "\n" osubfile ": "))
|
|
|
1724 (beginning-of-line)
|
|
|
1725 (while (not (eobp))
|
|
|
1726 (re-search-forward "\\(^.*\\): [0-9]+$")
|
|
|
1727 (goto-char (+ (match-end 1) 2))
|
|
|
1728 (setq list (cons (cons (read (current-buffer))
|
|
367
|
1729 (buffer-substring
|
|
|
1730 (match-beginning 1)
|
|
|
1731 (match-end 1)))
|
|
217
|
1732 list))
|
|
|
1733 (goto-char (1+ (match-end 0))))
|
|
|
1734 (setq list (nreverse list)
|
|
|
1735 list (cdr list)))
|
|
|
1736 (while list
|
|
|
1737 (message "Searching subfile %s..." (cdr (car list)))
|
|
|
1738 (Info-read-subfile (car (car list)))
|
|
|
1739 (setq list (cdr list))
|
|
|
1740 (goto-char (point-min))
|
|
|
1741 (if (re-search-forward regexp nil t)
|
|
|
1742 (setq found (point) list ())))
|
|
|
1743 (if found
|
|
|
1744 (message "")
|
|
|
1745 (signal 'search-failed (list regexp))))
|
|
|
1746 (if (not found)
|
|
|
1747 (progn (Info-read-subfile opoint)
|
|
|
1748 (goto-char opoint)
|
|
|
1749 (Info-select-node)))))
|
|
|
1750 (widen)
|
|
|
1751 (goto-char found)
|
|
|
1752 (Info-select-node)
|
|
|
1753 (or (and (equal onode Info-current-node)
|
|
|
1754 (equal ofile Info-current-file))
|
|
|
1755 (Info-history-add ofile onode opoint)))))
|
|
|
1756
|
|
|
1757 ;; Extract the value of the node-pointer named NAME.
|
|
367
|
1758 ;; If there is none, use ERRORNAME in the error message;
|
|
217
|
1759 ;; if ERRORNAME is nil, just return nil.
|
|
|
1760 (defun Info-extract-pointer (name &optional errorname)
|
|
|
1761 (save-excursion
|
|
|
1762 (goto-char (point-min))
|
|
|
1763 (forward-line 4)
|
|
|
1764 (let ((case-fold-search t))
|
|
|
1765 (if (re-search-backward (concat name ":") nil t)
|
|
|
1766 (progn
|
|
|
1767 (goto-char (match-end 0))
|
|
|
1768 (Info-following-node-name))
|
|
|
1769 (if (eq errorname t)
|
|
|
1770 nil
|
|
|
1771 (error (concat "Node has no " (capitalize (or errorname name)))))))))
|
|
|
1772
|
|
|
1773 ;; Return the node name in the buffer following point.
|
|
|
1774 ;; ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
|
|
|
1775 ;; saying which chas may appear in the node name.
|
|
|
1776 (defun Info-following-node-name (&optional allowedchars)
|
|
|
1777 (skip-chars-forward " \t")
|
|
|
1778 (buffer-substring
|
|
|
1779 (point)
|
|
|
1780 (progn
|
|
|
1781 (while (looking-at (concat "[" (or allowedchars "^,\t\n") "]"))
|
|
|
1782 (skip-chars-forward (concat (or allowedchars "^,\t\n") "("))
|
|
|
1783 (if (looking-at "(")
|
|
|
1784 (skip-chars-forward "^)")))
|
|
|
1785 (skip-chars-backward " ")
|
|
|
1786 (point))))
|
|
|
1787
|
|
|
1788 (defun Info-next (&optional n)
|
|
|
1789 "Go to the next node of this node.
|
|
|
1790 A positive or negative prefix argument moves by multiple nodes."
|
|
|
1791 (interactive "p")
|
|
|
1792 (or n (setq n 1))
|
|
|
1793 (if (< n 0)
|
|
|
1794 (Info-prev (- n))
|
|
|
1795 (while (>= (setq n (1- n)) 0)
|
|
|
1796 (Info-goto-node (Info-extract-pointer "next")))))
|
|
|
1797
|
|
|
1798 (defun Info-prev (&optional n)
|
|
|
1799 "Go to the previous node of this node.
|
|
|
1800 A positive or negative prefix argument moves by multiple nodes."
|
|
|
1801 (interactive "p")
|
|
|
1802 (or n (setq n 1))
|
|
|
1803 (if (< n 0)
|
|
|
1804 (Info-next (- n))
|
|
|
1805 (while (>= (setq n (1- n)) 0)
|
|
|
1806 (Info-goto-node (Info-extract-pointer "prev[ious]*" "previous")))))
|
|
|
1807
|
|
|
1808 (defun Info-up (&optional n)
|
|
|
1809 "Go to the superior node of this node.
|
|
|
1810 A positive prefix argument moves up several times."
|
|
|
1811 (interactive "p")
|
|
|
1812 (or n (setq n 1))
|
|
|
1813 (while (>= (setq n (1- n)) 0)
|
|
|
1814 (Info-goto-node (Info-extract-pointer "up")))
|
|
|
1815 (if (interactive-p) (Info-restore-point)))
|
|
|
1816
|
|
|
1817 (defun Info-last (&optional n)
|
|
|
1818 "Go back to the last node visited.
|
|
|
1819 With a prefix argument, go to Nth most recently visited node. History is
|
|
|
1820 circular; after oldest node, history comes back around to most recent one.
|
|
|
1821 Argument can be negative to go through the circle in the other direction.
|
|
|
1822 \(In other words, `l' is like \"undo\" and `C-u - l' is like \"redo\".)"
|
|
|
1823 (interactive "p")
|
|
|
1824 (or n (setq n 1))
|
|
|
1825 (or Info-history
|
|
|
1826 (error "This is the first Info node you looked at"))
|
|
|
1827 (let ((len (1+ (length Info-history))))
|
|
|
1828 (setq n (% (+ n (* len 100)) len)))
|
|
|
1829 (if (> n 0)
|
|
|
1830 (let ((entry (nth (1- n) Info-history)))
|
|
|
1831 (Info-history-add Info-current-file Info-current-node (point))
|
|
|
1832 (while (>= (setq n (1- n)) 0)
|
|
|
1833 (setq Info-history (nconc (cdr Info-history)
|
|
|
1834 (list (car Info-history)))))
|
|
|
1835 (setq Info-history (cdr Info-history))
|
|
|
1836 (let ((Info-keeping-history nil))
|
|
|
1837 (Info-goto-node (car entry)))
|
|
|
1838 (Info-restore-history-entry entry))))
|
|
|
1839
|
|
|
1840 (defun Info-directory ()
|
|
|
1841 "Go to the Info directory node."
|
|
|
1842 (interactive)
|
|
|
1843 (Info-find-node "dir" "top"))
|
|
|
1844
|
|
|
1845 (defun Info-follow-reference (footnotename)
|
|
|
1846 "Follow cross reference named NAME to the node it refers to.
|
|
|
1847 NAME may be an abbreviation of the reference name."
|
|
|
1848 (interactive
|
|
|
1849 (let ((completion-ignore-case t)
|
|
|
1850 completions default (start-point (point)) str i)
|
|
|
1851 (save-excursion
|
|
|
1852 (goto-char (point-min))
|
|
|
1853 (while (re-search-forward (format "\\*%s[ \n\t]*\\([^:]*\\):"
|
|
|
1854 Info-footnote-tag)
|
|
|
1855 nil t)
|
|
|
1856 (setq str (buffer-substring
|
|
|
1857 (match-beginning 1)
|
|
|
1858 (1- (point))))
|
|
|
1859 ;; See if this one should be the default.
|
|
|
1860 (and (null default)
|
|
|
1861 (< (match-beginning 0) start-point)
|
|
|
1862 (<= start-point (point))
|
|
|
1863 (setq default t))
|
|
|
1864 (setq i 0)
|
|
|
1865 (while (setq i (string-match "[ \n\t]+" str i))
|
|
|
1866 (setq str (concat (substring str 0 i) " "
|
|
|
1867 (substring str (match-end 0))))
|
|
|
1868 (setq i (1+ i)))
|
|
|
1869 ;; Record as a completion and perhaps as default.
|
|
|
1870 (if (eq default t) (setq default str))
|
|
|
1871 (setq completions
|
|
|
1872 (cons (cons str nil)
|
|
|
1873 completions))))
|
|
|
1874 (if completions
|
|
|
1875 (let ((item (completing-read (if default
|
|
|
1876 (concat "Follow reference named: ("
|
|
|
1877 default ") ")
|
|
|
1878 "Follow reference named: ")
|
|
|
1879 completions nil t nil
|
|
|
1880 'Info-minibuffer-history)))
|
|
|
1881 (if (and (string= item "") default)
|
|
|
1882 (list default)
|
|
|
1883 (list item)))
|
|
|
1884 (error "No cross-references in this node"))))
|
|
|
1885 (let (target i (str (concat "\\*" Info-footnote-tag " "
|
|
|
1886 (regexp-quote footnotename))))
|
|
|
1887 (while (setq i (string-match " " str i))
|
|
|
1888 (setq str (concat (substring str 0 i) "\\([ \t\n]+\\)"
|
|
|
1889 (substring str (1+ i))))
|
|
|
1890 (setq i (+ i 10)))
|
|
|
1891 (save-excursion
|
|
|
1892 (goto-char (point-min))
|
|
|
1893 (or (re-search-forward str nil t)
|
|
|
1894 (error "No cross-reference named %s" footnotename))
|
|
|
1895 (goto-char (match-end 1))
|
|
|
1896 (setq target
|
|
|
1897 (Info-extract-menu-node-name "Bad format cross reference" t)))
|
|
|
1898 (while (setq i (string-match "[ \t\n]+" target i))
|
|
|
1899 (setq target (concat (substring target 0 i) " "
|
|
|
1900 (substring target (match-end 0))))
|
|
|
1901 (setq i (+ i 1)))
|
|
|
1902 (Info-goto-node target)
|
|
|
1903 (setq Info-in-cross-reference t)))
|
|
|
1904
|
|
|
1905 (defun Info-next-reference (n)
|
|
|
1906 (interactive "p")
|
|
|
1907 (let ((pat (format "\\*%s[ \n\t]*\\([^:]*\\):\\|^\\* .*:\\|<<.*>>"
|
|
|
1908 Info-footnote-tag))
|
|
|
1909 (old-pt (point))
|
|
|
1910 wrapped found-nomenu)
|
|
|
1911 (while (< n 0)
|
|
|
1912 (unless (re-search-backward pat nil t)
|
|
|
1913 ;; Don't wrap more than once in a buffer where only the
|
|
|
1914 ;; menu references are found.
|
|
|
1915 (when (and wrapped (not found-nomenu))
|
|
|
1916 (goto-char old-pt)
|
|
|
1917 (error "No cross references in this node"))
|
|
|
1918 (setq wrapped t)
|
|
|
1919 (goto-char (point-max))
|
|
|
1920 (unless (re-search-backward pat nil t)
|
|
|
1921 (goto-char old-pt)
|
|
|
1922 (error "No cross references in this node")))
|
|
|
1923 (unless (save-excursion
|
|
|
1924 (goto-char (match-beginning 0))
|
|
|
1925 (when (looking-at "\\* Menu:")
|
|
|
1926 (decf n)))
|
|
|
1927 (setq found-nomenu t))
|
|
|
1928 (incf n))
|
|
|
1929 (while (> n 0)
|
|
|
1930 (or (eobp) (forward-char 1))
|
|
|
1931 (unless (re-search-forward pat nil t)
|
|
|
1932 (when (and wrapped (not found-nomenu))
|
|
|
1933 (goto-char old-pt)
|
|
|
1934 (error "No cross references in this node"))
|
|
|
1935 (setq wrapped t)
|
|
|
1936 (goto-char (point-min))
|
|
|
1937 (unless (re-search-forward pat nil t)
|
|
|
1938 (goto-char old-pt)
|
|
|
1939 (error "No cross references in this node")))
|
|
|
1940 (unless (save-excursion
|
|
|
1941 (goto-char (match-beginning 0))
|
|
|
1942 (when (looking-at "\\* Menu:")
|
|
|
1943 (incf n)))
|
|
|
1944 (setq found-nomenu t))
|
|
|
1945 (decf n))
|
|
|
1946 (when (looking-at "\\* Menu:")
|
|
|
1947 (error "No cross references in this node"))
|
|
|
1948 (goto-char (match-beginning 0))))
|
|
|
1949
|
|
|
1950 (defun Info-prev-reference (n)
|
|
|
1951 (interactive "p")
|
|
|
1952 (Info-next-reference (- n)))
|
|
|
1953
|
|
|
1954 (defun Info-extract-menu-node-name (&optional errmessage multi-line)
|
|
|
1955 (skip-chars-forward " \t\n")
|
|
|
1956 (let ((beg (point))
|
|
|
1957 str i)
|
|
|
1958 (skip-chars-forward "^:")
|
|
|
1959 (forward-char 1)
|
|
|
1960 (setq str
|
|
|
1961 (if (looking-at ":")
|
|
|
1962 (buffer-substring beg (1- (point)))
|
|
|
1963 (skip-chars-forward " \t\n")
|
|
|
1964 (Info-following-node-name (if multi-line "^.,\t" "^.,\t\n"))))
|
|
|
1965 (while (setq i (string-match "\n" str i))
|
|
|
1966 (aset str i ?\ ))
|
|
|
1967 str))
|
|
|
1968
|
|
|
1969 (defun Info-menu (menu-item)
|
|
|
1970 "Go to node for menu item named (or abbreviated) NAME.
|
|
|
1971 Completion is allowed, and the menu item point is on is the default."
|
|
|
1972 (interactive
|
|
|
1973 (let ((completions '())
|
|
|
1974 ;; If point is within a menu item, use that item as the default
|
|
|
1975 (default nil)
|
|
|
1976 (p (point))
|
|
|
1977 (last nil))
|
|
|
1978 (save-excursion
|
|
|
1979 (goto-char (point-min))
|
|
|
1980 (let ((case-fold-search t))
|
|
|
1981 (if (not (search-forward "\n* menu:" nil t))
|
|
|
1982 (error "No menu in this node")))
|
|
|
1983 (while (re-search-forward
|
|
|
1984 "\n\\* \\([^:\t\n]*\\):" nil t)
|
|
|
1985 (if (and (null default)
|
|
|
1986 (prog1 (if last (< last p) nil)
|
|
|
1987 (setq last (match-beginning 0)))
|
|
|
1988 (<= p last))
|
|
|
1989 (setq default (car (car completions))))
|
|
|
1990 (setq completions (cons (cons (buffer-substring
|
|
|
1991 (match-beginning 1)
|
|
|
1992 (match-end 1))
|
|
|
1993 (match-beginning 1))
|
|
|
1994 completions)))
|
|
|
1995 (if (and (null default) last
|
|
|
1996 (< last p)
|
|
|
1997 (<= p (progn (end-of-line) (point))))
|
|
|
1998 (setq default (car (car completions)))))
|
|
|
1999 (let ((item nil))
|
|
|
2000 (while (null item)
|
|
|
2001 (setq item (let ((completion-ignore-case t))
|
|
|
2002 (completing-read (if default
|
|
|
2003 (format "Menu item (default %s): "
|
|
|
2004 default)
|
|
|
2005 "Menu item: ")
|
|
|
2006 completions nil t nil
|
|
|
2007 'Info-minibuffer-history)))
|
|
|
2008 ;; we rely on the fact that completing-read accepts an input
|
|
|
2009 ;; of "" even when the require-match argument is true and ""
|
|
|
2010 ;; is not a valid possibility
|
|
|
2011 (if (string= item "")
|
|
|
2012 (if default
|
|
|
2013 (setq item default)
|
|
|
2014 ;; ask again
|
|
|
2015 (setq item nil))))
|
|
|
2016 (list item))))
|
|
|
2017 ;; there is a problem here in that if several menu items have the same
|
|
|
2018 ;; name you can only go to the node of the first with this command.
|
|
|
2019 (Info-goto-node (Info-extract-menu-item menu-item) nil t))
|
|
367
|
2020
|
|
217
|
2021 (defun Info-extract-menu-item (menu-item &optional noerror)
|
|
|
2022 (save-excursion
|
|
|
2023 (goto-char (point-min))
|
|
|
2024 (if (let ((case-fold-search t))
|
|
|
2025 (search-forward "\n* menu:" nil t))
|
|
|
2026 (if (or (search-forward (concat "\n* " menu-item ":") nil t)
|
|
|
2027 (search-forward (concat "\n* " menu-item) nil t))
|
|
|
2028 (progn
|
|
|
2029 (beginning-of-line)
|
|
|
2030 (forward-char 2)
|
|
|
2031 (Info-extract-menu-node-name))
|
|
|
2032 (and (not noerror) (error "No such item in menu")))
|
|
|
2033 (and (not noerror) (error "No menu in this node")))))
|
|
|
2034
|
|
|
2035 ;; If COUNT is nil, use the last item in the menu.
|
|
|
2036 (defun Info-extract-menu-counting (count &optional noerror noindex)
|
|
|
2037 (save-excursion
|
|
|
2038 (goto-char (point-min))
|
|
|
2039 (if (let ((case-fold-search t))
|
|
|
2040 (and (search-forward "\n* menu:" nil t)
|
|
|
2041 (or (not noindex)
|
|
|
2042 (not (string-match "\\<Index\\>" Info-current-node)))))
|
|
|
2043 (if (search-forward "\n* " nil t count)
|
|
|
2044 (progn
|
|
|
2045 (or count
|
|
|
2046 (while (search-forward "\n* " nil t)))
|
|
|
2047 (Info-extract-menu-node-name))
|
|
|
2048 (and (not noerror) (error "Too few items in menu")))
|
|
|
2049 (and (not noerror) (error "No menu in this node")))))
|
|
|
2050
|
|
|
2051 (defun Info-nth-menu-item (n)
|
|
|
2052 "Go to the node of the Nth menu item."
|
|
|
2053 (interactive "P")
|
|
|
2054 (or n (setq n (- last-command-char ?0)))
|
|
|
2055 (if (< n 1) (error "Index must be at least 1"))
|
|
|
2056 (Info-goto-node (Info-extract-menu-counting n) nil t))
|
|
|
2057
|
|
|
2058 (defun Info-last-menu-item ()
|
|
|
2059 "Go to the node of the tenth menu item."
|
|
|
2060 (interactive)
|
|
|
2061 (Info-goto-node (Info-extract-menu-counting nil) nil t))
|
|
|
2062
|
|
|
2063 (defun Info-top ()
|
|
|
2064 "Go to the Top node of this file."
|
|
|
2065 (interactive)
|
|
|
2066 (Info-goto-node "Top"))
|
|
|
2067
|
|
|
2068 (defun Info-end ()
|
|
|
2069 "Go to the final node in this file."
|
|
|
2070 (interactive)
|
|
|
2071 (Info-top)
|
|
|
2072 (let ((Info-keeping-history nil)
|
|
|
2073 node)
|
|
|
2074 (Info-last-menu-item)
|
|
|
2075 (while (setq node (or (Info-extract-pointer "next" t)
|
|
|
2076 (Info-extract-menu-counting nil t t)))
|
|
|
2077 (Info-goto-node node))
|
|
|
2078 (or (equal (Info-extract-pointer "up" t) "Top")
|
|
|
2079 (let ((executing-kbd-macro "")) ; suppress messages
|
|
|
2080 (condition-case nil
|
|
|
2081 (Info-global-next 10000)
|
|
|
2082 (error nil))))))
|
|
|
2083
|
|
|
2084 (defun Info-global-next (&optional n)
|
|
|
2085 "Go to the next node in this file, traversing node structure as necessary.
|
|
|
2086 This works only if the Info file is structured as a hierarchy of nodes.
|
|
|
2087 A positive or negative prefix argument moves by multiple nodes."
|
|
|
2088 (interactive "p")
|
|
|
2089 (or n (setq n 1))
|
|
|
2090 (if (< n 0)
|
|
|
2091 (Info-global-prev (- n))
|
|
|
2092 (while (>= (setq n (1- n)) 0)
|
|
|
2093 (let (node)
|
|
|
2094 (cond ((and (string-match "^Top$" Info-current-node)
|
|
|
2095 (setq node (Info-extract-pointer "next" t))
|
|
|
2096 (Info-extract-menu-item node t))
|
|
|
2097 (Info-goto-node node))
|
|
|
2098 ((setq node (Info-extract-menu-counting 1 t t))
|
|
|
2099 (message "Going down...")
|
|
|
2100 (Info-goto-node node))
|
|
|
2101 (t
|
|
|
2102 (let ((Info-keeping-history Info-keeping-history)
|
|
|
2103 (orignode Info-current-node)
|
|
|
2104 (ups ""))
|
|
|
2105 (while (not (Info-extract-pointer "next" t))
|
|
|
2106 (if (and (setq node (Info-extract-pointer "up" t))
|
|
|
2107 (not (equal node "Top")))
|
|
|
2108 (progn
|
|
|
2109 (message "Going%s..." (setq ups (concat ups " up")))
|
|
|
2110 (Info-goto-node node)
|
|
|
2111 (setq Info-keeping-history nil))
|
|
|
2112 (if orignode
|
|
|
2113 (let ((Info-keeping-history nil))
|
|
|
2114 (Info-goto-node orignode)))
|
|
|
2115 (error "Last node in file")))
|
|
|
2116 (Info-next))))))))
|
|
|
2117
|
|
|
2118 (defun Info-page-next (&optional n)
|
|
|
2119 "Scroll forward one screenful, or go to next global node.
|
|
|
2120 A positive or negative prefix argument moves by multiple screenfuls."
|
|
|
2121 (interactive "p")
|
|
|
2122 (or n (setq n 1))
|
|
|
2123 (if (< n 0)
|
|
|
2124 (Info-page-prev (- n))
|
|
|
2125 (while (>= (setq n (1- n)) 0)
|
|
|
2126 (if (pos-visible-in-window-p (point-max))
|
|
|
2127 (progn
|
|
|
2128 (Info-global-next)
|
|
|
2129 (message "Node: %s" Info-current-node))
|
|
|
2130 (scroll-up)))))
|
|
|
2131
|
|
|
2132 (defun Info-scroll-next (arg)
|
|
|
2133 (interactive "P")
|
|
|
2134 (if Info-auto-advance
|
|
|
2135 (if (and (pos-visible-in-window-p (point-max))
|
|
|
2136 (not (eq Info-auto-advance t))
|
|
|
2137 (not (eq last-command this-command)))
|
|
|
2138 (message "Hit %s again to go to next node"
|
|
|
2139 (if (= last-command-char 0)
|
|
|
2140 "mouse button"
|
|
|
2141 (key-description (char-to-string last-command-char))))
|
|
|
2142 (Info-page-next)
|
|
|
2143 (setq this-command 'Info))
|
|
|
2144 (scroll-up arg)))
|
|
|
2145
|
|
|
2146 (defun Info-global-prev (&optional n)
|
|
|
2147 "Go to the previous node in this file, traversing structure as necessary.
|
|
|
2148 This works only if the Info file is structured as a hierarchy of nodes.
|
|
|
2149 A positive or negative prefix argument moves by multiple nodes."
|
|
|
2150 (interactive "p")
|
|
|
2151 (or n (setq n 1))
|
|
|
2152 (if (< n 0)
|
|
|
2153 (Info-global-next (- n))
|
|
|
2154 (while (>= (setq n (1- n)) 0)
|
|
|
2155 (let ((upnode (Info-extract-pointer "up" t))
|
|
|
2156 (prevnode (Info-extract-pointer "prev[ious]*" t)))
|
|
|
2157 (if (or (not prevnode)
|
|
|
2158 (equal prevnode upnode))
|
|
|
2159 (if (string-match "^Top$" Info-current-node)
|
|
|
2160 (error "First node in file")
|
|
|
2161 (message "Going up...")
|
|
|
2162 (Info-up))
|
|
|
2163 (Info-goto-node prevnode)
|
|
|
2164 (let ((downs "")
|
|
|
2165 (Info-keeping-history nil)
|
|
|
2166 node)
|
|
|
2167 (while (setq node (Info-extract-menu-counting nil t t))
|
|
|
2168 (message "Going%s..." (setq downs (concat downs " down")))
|
|
|
2169 (Info-goto-node node))))))))
|
|
|
2170
|
|
|
2171 (defun Info-page-prev (&optional n)
|
|
|
2172 "Scroll backward one screenful, or go to previous global node.
|
|
|
2173 A positive or negative prefix argument moves by multiple screenfuls."
|
|
|
2174 (interactive "p")
|
|
|
2175 (or n (setq n 1))
|
|
|
2176 (if (< n 0)
|
|
|
2177 (Info-page-next (- n))
|
|
|
2178 (while (>= (setq n (1- n)) 0)
|
|
|
2179 (if (pos-visible-in-window-p (point-min))
|
|
|
2180 (progn
|
|
|
2181 (Info-global-prev)
|
|
|
2182 (message "Node: %s" Info-current-node)
|
|
357
|
2183 (goto-char (point-max))
|
|
|
2184 (recenter -1)
|
|
|
2185 (move-to-window-line 0))
|
|
217
|
2186 (scroll-down)))))
|
|
|
2187
|
|
|
2188 (defun Info-scroll-prev (arg)
|
|
|
2189 (interactive "P")
|
|
|
2190 (if Info-auto-advance
|
|
|
2191 (if (and (pos-visible-in-window-p (point-min))
|
|
|
2192 (not (eq Info-auto-advance t))
|
|
|
2193 (not (eq last-command this-command)))
|
|
|
2194 (message "Hit %s again to go to previous node"
|
|
347
|
2195 (if (mouse-event-p last-command-event)
|
|
217
|
2196 "mouse button"
|
|
347
|
2197 (key-description (event-key last-command-event))))
|
|
217
|
2198 (Info-page-prev)
|
|
|
2199 (setq this-command 'Info))
|
|
|
2200 (scroll-down arg)))
|
|
|
2201
|
|
|
2202 (defun Info-index (topic)
|
|
|
2203 "Look up a string in the index for this file.
|
|
|
2204 The index is defined as the first node in the top-level menu whose
|
|
|
2205 name contains the word \"Index\", plus any immediately following
|
|
|
2206 nodes whose names also contain the word \"Index\".
|
|
|
2207 If there are no exact matches to the specified topic, this chooses
|
|
|
2208 the first match which is a case-insensitive substring of a topic.
|
|
|
2209 Use the `,' command to see the other matches.
|
|
|
2210 Give a blank topic name to go to the Index node itself."
|
|
|
2211 (interactive "sIndex topic: ")
|
|
|
2212 (let ((pattern (format "\n\\* \\([^\n:]*%s[^\n:]*\\):[ \t]*%s"
|
|
|
2213 (regexp-quote topic)
|
|
|
2214 "\\([^.\n]*\\)\\.[ t]*\\([0-9]*\\)"))
|
|
|
2215 node)
|
|
|
2216 (message "Searching index for `%s'..." topic)
|
|
|
2217 (Info-goto-node "Top")
|
|
|
2218 (let ((case-fold-search t))
|
|
|
2219 (or (search-forward "\n* menu:" nil t)
|
|
|
2220 (error "No index"))
|
|
|
2221 (or (re-search-forward "\n\\* \\(.*\\<Index\\>\\)" nil t)
|
|
|
2222 (error "No index")))
|
|
|
2223 (goto-char (match-beginning 1))
|
|
|
2224 (let ((Info-keeping-history nil)
|
|
|
2225 (Info-fontify (and Info-fontify (equal topic ""))))
|
|
|
2226 (Info-goto-node (Info-extract-menu-node-name)))
|
|
|
2227 (or (equal topic "")
|
|
|
2228 (let ((matches nil)
|
|
|
2229 (exact nil)
|
|
|
2230 (Info-keeping-history nil)
|
|
|
2231 found)
|
|
|
2232 (while
|
|
|
2233 (progn
|
|
|
2234 (goto-char (point-min))
|
|
|
2235 (while (re-search-forward pattern nil t)
|
|
|
2236 (setq matches
|
|
|
2237 (cons (list (buffer-substring (match-beginning 1)
|
|
|
2238 (match-end 1))
|
|
|
2239 (buffer-substring (match-beginning 2)
|
|
|
2240 (match-end 2))
|
|
|
2241 Info-current-node
|
|
|
2242 (string-to-int (concat "0"
|
|
|
2243 (buffer-substring
|
|
|
2244 (match-beginning 3)
|
|
|
2245 (match-end 3)))))
|
|
|
2246 matches)))
|
|
|
2247 (and (setq node (Info-extract-pointer "next" t))
|
|
|
2248 (string-match "\\<Index\\>" node)))
|
|
|
2249 (let ((Info-fontify nil))
|
|
|
2250 (Info-goto-node node)))
|
|
|
2251 (or matches
|
|
|
2252 (progn
|
|
|
2253 (Info-last)
|
|
|
2254 (error "No \"%s\" in index" topic)))
|
|
|
2255 ;; Here it is a feature that assoc is case-sensitive.
|
|
|
2256 (while (setq found (assoc topic matches))
|
|
|
2257 (setq exact (cons found exact)
|
|
|
2258 matches (delq found matches)))
|
|
|
2259 (setq Info-index-alternatives (nconc exact (nreverse matches))
|
|
|
2260 Info-index-first-alternative (car Info-index-alternatives))
|
|
|
2261 (Info-index-next 0)))))
|
|
|
2262
|
|
|
2263 (defun Info-index-next (num)
|
|
|
2264 "Go to the next matching index item from the last `i' command."
|
|
|
2265 (interactive "p")
|
|
|
2266 (or Info-index-alternatives
|
|
|
2267 (error "No previous `i' command in this file"))
|
|
|
2268 (while (< num 0)
|
|
|
2269 (setq num (+ num (length Info-index-alternatives))))
|
|
|
2270 (while (> num 0)
|
|
|
2271 (setq Info-index-alternatives
|
|
|
2272 (nconc (cdr Info-index-alternatives)
|
|
|
2273 (list (car Info-index-alternatives)))
|
|
|
2274 num (1- num)))
|
|
|
2275 (Info-goto-node (nth 1 (car Info-index-alternatives)))
|
|
|
2276 (if (> (nth 3 (car Info-index-alternatives)) 0)
|
|
|
2277 (forward-line (nth 3 (car Info-index-alternatives)))
|
|
|
2278 (forward-line 3) ; don't search in headers
|
|
|
2279 (let ((name (car (car Info-index-alternatives))))
|
|
|
2280 (if (or (re-search-forward (format
|
|
|
2281 "\\(Function\\|Command\\): %s\\( \\|$\\)"
|
|
|
2282 (regexp-quote name)) nil t)
|
|
|
2283 (re-search-forward (format "^`%s[ ']" (regexp-quote name)) nil t)
|
|
|
2284 (search-forward (format "`%s'" name) nil t)
|
|
|
2285 (and (string-match "\\`.*\\( (.*)\\)\\'" name)
|
|
|
2286 (search-forward
|
|
|
2287 (format "`%s'" (substring name 0 (match-beginning 1)))
|
|
|
2288 nil t))
|
|
|
2289 (search-forward name nil t))
|
|
|
2290 (beginning-of-line)
|
|
|
2291 (goto-char (point-min)))))
|
|
|
2292 (message "Found \"%s\" in %s. %s"
|
|
|
2293 (car (car Info-index-alternatives))
|
|
|
2294 (nth 2 (car Info-index-alternatives))
|
|
|
2295 (if (cdr Info-index-alternatives)
|
|
|
2296 (if (eq (car (cdr Info-index-alternatives))
|
|
|
2297 Info-index-first-alternative)
|
|
|
2298 "(Press `,' to repeat)"
|
|
|
2299 (format "(Press `,' for %d more)"
|
|
|
2300 (- (1- (length Info-index-alternatives))
|
|
|
2301 (length (memq Info-index-first-alternative
|
|
|
2302 (cdr Info-index-alternatives))))))
|
|
|
2303 "(Only match)")))
|
|
|
2304
|
|
|
2305
|
|
|
2306 ;;;###autoload
|
|
|
2307 (defun Info-emacs-command (command)
|
|
|
2308 "Look up an Emacs command in the Emacs manual in the Info system.
|
|
|
2309 This command is designed to be used whether you are already in Info or not."
|
|
|
2310 (interactive "CLook up command in Emacs manual: ")
|
|
|
2311 (save-window-excursion
|
|
|
2312 (info)
|
|
|
2313 (Info-find-node Info-emacs-info-file-name "Top")
|
|
|
2314 (Info-index (symbol-name command)))
|
|
|
2315 (pop-to-buffer "*info*"))
|
|
|
2316
|
|
|
2317
|
|
|
2318 ;;;###autoload
|
|
|
2319 (defun Info-goto-emacs-command-node (key)
|
|
|
2320 "Look up an Emacs command in the Emacs manual in the Info system.
|
|
|
2321 This command is designed to be used whether you are already in Info or not."
|
|
|
2322 (interactive "CLook up command in Emacs manual: ")
|
|
|
2323 (Info-emacs-command key))
|
|
|
2324
|
|
|
2325 ;;;###autoload
|
|
|
2326 (defun Info-goto-emacs-key-command-node (key)
|
|
|
2327 "Look up an Emacs key sequence in the Emacs manual in the Info system.
|
|
|
2328 This command is designed to be used whether you are already in Info or not."
|
|
|
2329 (interactive "kLook up key in Emacs manual: ")
|
|
|
2330 (let ((command (key-binding key)))
|
|
|
2331 (cond ((eq command 'keyboard-quit)
|
|
|
2332 (keyboard-quit))
|
|
|
2333 ((null command)
|
|
|
2334 (error "%s is undefined" (key-description key)))
|
|
|
2335 ((and (interactive-p) (eq command 'execute-extended-command))
|
|
|
2336 (call-interactively 'Info-goto-emacs-command-node))
|
|
|
2337 (t
|
|
|
2338 (Info-goto-emacs-command-node command)))))
|
|
|
2339
|
|
|
2340 ;;;###autoload
|
|
|
2341 (defun Info-emacs-key (key)
|
|
|
2342 "Look up an Emacs key sequence in the Emacs manual in the Info system.
|
|
|
2343 This command is designed to be used whether you are already in Info or not."
|
|
|
2344 (interactive "kLook up key in Emacs manual: ")
|
|
|
2345 (cond ((eq (key-binding key) 'keyboard-quit)
|
|
|
2346 (keyboard-quit))
|
|
|
2347 ((and (interactive-p) (eq (key-binding key) 'execute-extended-command))
|
|
|
2348 (call-interactively 'Info-goto-emacs-command-node))
|
|
|
2349 (t
|
|
|
2350 (save-window-excursion
|
|
|
2351 (info)
|
|
|
2352 (Info-find-node Info-emacs-info-file-name "Top")
|
|
|
2353 (setq key (key-description key))
|
|
|
2354 (let (p)
|
|
|
2355 (if (setq p (string-match "[@{}]" key))
|
|
|
2356 (setq key (concat (substring key 0 p) "@" (substring key p))))
|
|
|
2357 (if (string-match "^ESC " key)
|
|
|
2358 (setq key (concat "M-" (substring key 4))))
|
|
|
2359 (if (string-match "^M-C-" key)
|
|
|
2360 (setq key (concat "C-M-" (substring key 4)))))
|
|
|
2361 (Info-index key))
|
|
|
2362 (pop-to-buffer "*info*"))))
|
|
|
2363
|
|
|
2364 ;;;###autoload
|
|
|
2365 (defun Info-elisp-ref (func)
|
|
|
2366 "Look up an Emacs Lisp function in the Elisp manual in the Info system.
|
|
|
2367 This command is designed to be used whether you are already in Info or not."
|
|
|
2368 (interactive (let ((fn (function-at-point))
|
|
367
|
2369 (enable-recursive-minibuffers t)
|
|
217
|
2370 val)
|
|
|
2371 (setq val (completing-read
|
|
|
2372 (format "Look up Emacs Lisp function%s: "
|
|
|
2373 (if fn
|
|
|
2374 (format " (default %s)" fn)
|
|
|
2375 ""))
|
|
|
2376 obarray 'fboundp t))
|
|
|
2377 (list (if (equal val "")
|
|
|
2378 fn (intern val)))))
|
|
|
2379 (save-window-excursion
|
|
|
2380 (info)
|
|
|
2381 (condition-case nil
|
|
|
2382 (Info-find-node "lispref" "Top")
|
|
|
2383 (error (Info-find-node "elisp" "Top")))
|
|
|
2384 (Info-index (symbol-name func)))
|
|
|
2385 (pop-to-buffer "*info*"))
|
|
|
2386
|
|
|
2387 (defun Info-reannotate-node ()
|
|
|
2388 (let ((bufs (delq nil (mapcar 'get-file-buffer Info-annotations-path))))
|
|
|
2389 (if bufs
|
|
|
2390 (let ((ibuf (current-buffer))
|
|
|
2391 (file (concat "\\(" (regexp-quote
|
|
|
2392 (file-name-nondirectory Info-current-file))
|
|
|
2393 "\\|" (regexp-quote Info-current-file) "\\)"))
|
|
|
2394 (node (regexp-quote Info-current-node))
|
|
|
2395 (savept (point)))
|
|
|
2396 (goto-char (point-min))
|
|
|
2397 (if (search-forward "\n------ NOTE:\n" nil t)
|
|
|
2398 (let ((buffer-read-only nil)
|
|
|
2399 (bufmod (buffer-modified-p))
|
|
|
2400 top)
|
|
|
2401 (setq savept (copy-marker savept))
|
|
|
2402 (goto-char (point-min))
|
|
|
2403 (while (search-forward "\n------ NOTE:" nil t)
|
|
|
2404 (setq top (1+ (match-beginning 0)))
|
|
|
2405 (if (search-forward "\n------\n" nil t)
|
|
|
2406 (delete-region top (point)))
|
|
|
2407 (backward-char 1))
|
|
|
2408 (set-buffer-modified-p bufmod)))
|
|
|
2409 (save-excursion
|
|
|
2410 (while bufs
|
|
|
2411 (set-buffer (car bufs))
|
|
|
2412 (goto-char (point-min))
|
|
|
2413 (while (re-search-forward
|
|
|
2414 (format
|
|
|
2415 "------ *File: *%s *Node: *%s *Line: *\\([0-9]+\\) *\n"
|
|
|
2416 file node)
|
|
|
2417 nil t)
|
|
|
2418 (let ((line (string-to-int
|
|
|
2419 (buffer-substring (match-beginning 2)
|
|
|
2420 (match-end 2))))
|
|
|
2421 (top (point))
|
|
|
2422 bot)
|
|
|
2423 (search-forward "\n------\n" nil t)
|
|
|
2424 (setq bot (point))
|
|
|
2425 (save-excursion
|
|
|
2426 (set-buffer ibuf)
|
|
|
2427 (if (integerp savept) (setq savept (copy-marker savept)))
|
|
|
2428 (if (= line 0)
|
|
|
2429 (goto-char (point-max))
|
|
|
2430 (goto-char (point-min))
|
|
|
2431 (forward-line line))
|
|
|
2432 (let ((buffer-read-only nil)
|
|
|
2433 (bufmod (buffer-modified-p)))
|
|
|
2434 (insert "------ NOTE:\n")
|
|
|
2435 (insert-buffer-substring (car bufs) top bot)
|
|
|
2436 (set-buffer-modified-p bufmod)))))
|
|
|
2437 (setq bufs (cdr bufs))))
|
|
|
2438 (goto-char savept)))))
|
|
|
2439
|
|
|
2440 (defvar Info-annotate-map nil
|
|
|
2441 "Local keymap used within `a' command of Info.")
|
|
367
|
2442
|
|
217
|
2443 (if Info-annotate-map
|
|
|
2444 nil
|
|
|
2445 ;; (setq Info-annotate-map (nconc (make-sparse-keymap) text-mode-map))
|
|
|
2446 (setq Info-annotate-map (copy-keymap text-mode-map))
|
|
|
2447 (define-key Info-annotate-map "\C-c\C-c" 'Info-cease-annotate))
|
|
|
2448
|
|
|
2449 (defun Info-annotate-mode ()
|
|
|
2450 "Major mode for adding an annotation to an Info node.
|
|
|
2451 Like text mode with the addition of Info-cease-annotate
|
|
|
2452 which returns to Info mode for browsing.
|
|
|
2453 \\{Info-annotate-map}")
|
|
|
2454
|
|
|
2455 (defun Info-annotate (arg)
|
|
|
2456 "Add a personal annotation to the current Info node.
|
|
|
2457 Only you will be able to see this annotation. Annotations are stored
|
|
|
2458 in the file \"~/.xemacs/info.notes\" by default. If point is inside
|
|
|
2459 an existing annotation, edit that annotation. A prefix argument
|
|
|
2460 specifies which annotations file (from `Info-annotations-path') is to
|
|
|
2461 be edited; default is 1."
|
|
|
2462 (interactive "p")
|
|
|
2463 (setq arg (1- arg))
|
|
|
2464 (if (or (< arg 0) (not (nth arg Info-annotations-path)))
|
|
|
2465 (if (= arg 0)
|
|
|
2466 (setq Info-annotations-path
|
|
|
2467 (list (read-file-name
|
|
|
2468 "Annotations file: " "~/" "~/.infonotes")))
|
|
|
2469 (error "File number must be in the range from 1 to %d"
|
|
|
2470 (length Info-annotations-path))))
|
|
|
2471 (let ((which nil)
|
|
|
2472 (file (file-name-nondirectory Info-current-file))
|
|
|
2473 (d Info-directory-list)
|
|
|
2474 where pt)
|
|
|
2475 (while (and d (not (equal (expand-file-name file (car d))
|
|
|
2476 Info-current-file)))
|
|
|
2477 (setq d (cdr d)))
|
|
|
2478 (or d (setq file Info-current-file))
|
|
|
2479 (if (and (save-excursion
|
|
|
2480 (goto-char (min (point-max) (+ (point) 13)))
|
|
|
2481 (and (search-backward "------ NOTE:\n" nil t)
|
|
|
2482 (setq pt (match-end 0))
|
|
|
2483 (search-forward "\n------\n" nil t)))
|
|
|
2484 (< (point) (match-end 0)))
|
|
|
2485 (setq which (format "File: *%s *Node: *%s *Line:.*\n%s"
|
|
|
2486 (regexp-quote file)
|
|
|
2487 (regexp-quote Info-current-node)
|
|
|
2488 (regexp-quote
|
|
|
2489 (buffer-substring pt (match-beginning 0))))
|
|
|
2490 where (max (- (point) pt) 0)))
|
|
|
2491 (let ((node Info-current-node)
|
|
|
2492 (line (if (looking-at "[ \n]*\\'") 0
|
|
|
2493 (count-lines (point-min) (point)))))
|
|
|
2494 (or which
|
|
|
2495 (let ((buffer-read-only nil)
|
|
|
2496 (bufmod (buffer-modified-p)))
|
|
|
2497 (beginning-of-line)
|
|
|
2498 (if (bobp) (goto-char (point-max)))
|
|
|
2499 (insert "------ NOTE:\n------\n")
|
|
|
2500 (backward-char 20)
|
|
|
2501 (set-buffer-modified-p bufmod)))
|
|
|
2502 ;; (setq Info-window-start (window-start))
|
|
|
2503 (setq Info-window-configuration (current-window-configuration))
|
|
|
2504 (pop-to-buffer (find-file-noselect (nth arg Info-annotations-path)))
|
|
|
2505 (use-local-map Info-annotate-map)
|
|
|
2506 (setq major-mode 'Info-annotate-mode)
|
|
|
2507 (setq mode-name "Info Annotate")
|
|
|
2508 (if which
|
|
|
2509 (if (save-excursion
|
|
|
2510 (goto-char (point-min))
|
|
|
2511 (re-search-forward which nil t))
|
|
|
2512 (progn
|
|
|
2513 (goto-char (match-beginning 0))
|
|
|
2514 (forward-line 1)
|
|
|
2515 (forward-char where)))
|
|
|
2516 (let ((bufmod (buffer-modified-p)))
|
|
|
2517 (goto-char (point-max))
|
|
|
2518 (insert (format "\n------ File: %s Node: %s Line: %d\n"
|
|
|
2519 file node line))
|
|
|
2520 (setq pt (point))
|
|
|
2521 (insert "\n------\n"
|
|
|
2522 "\nPress C-c C-c to save and return to Info.\n")
|
|
|
2523 (goto-char pt)
|
|
|
2524 (set-buffer-modified-p bufmod))))))
|
|
|
2525
|
|
|
2526 (defun Info-cease-annotate ()
|
|
|
2527 (interactive)
|
|
|
2528 (let ((bufmod (buffer-modified-p)))
|
|
|
2529 (while (save-excursion
|
|
|
2530 (goto-char (point-min))
|
|
|
2531 (re-search-forward "\n\n?Press .* to save and return to Info.\n"
|
|
|
2532 nil t))
|
|
|
2533 (delete-region (1+ (match-beginning 0)) (match-end 0)))
|
|
|
2534 (while (save-excursion
|
|
|
2535 (goto-char (point-min))
|
|
|
2536 (re-search-forward "\n------ File:.*Node:.*Line:.*\n+------\n"
|
|
|
2537 nil t))
|
|
|
2538 (delete-region (match-beginning 0) (match-end 0)))
|
|
|
2539 (set-buffer-modified-p bufmod))
|
|
|
2540 (save-buffer)
|
|
|
2541 (fundamental-mode)
|
|
|
2542 (bury-buffer)
|
|
|
2543 (or (one-window-p) (delete-window))
|
|
|
2544 (info)
|
|
|
2545 (setq Info-current-annotation-completions nil)
|
|
|
2546 (set-window-configuration Info-window-configuration)
|
|
|
2547 (Info-reannotate-node))
|
|
|
2548
|
|
|
2549 (defun Info-bookmark (arg tag)
|
|
|
2550 (interactive "p\nsBookmark name: ")
|
|
|
2551 (Info-annotate arg)
|
|
|
2552 (if (or (string-match "^\"\\(.*\\)\"$" tag)
|
|
|
2553 (string-match "^<<\\(.*\\)>>$" tag))
|
|
|
2554 (setq tag (substring tag (match-beginning 1) (match-end 1))))
|
|
|
2555 (let ((pt (point)))
|
|
|
2556 (search-forward "\n------\n")
|
|
|
2557 (let ((end (- (point) 8)))
|
|
|
2558 (goto-char pt)
|
|
|
2559 (if (re-search-forward "<<[^>\n]*>>" nil t)
|
|
|
2560 (delete-region (match-beginning 0) (match-end 0))
|
|
|
2561 (goto-char end))
|
|
|
2562 (or (equal tag "")
|
|
|
2563 (insert "<<" tag ">>"))))
|
|
|
2564 (Info-cease-annotate))
|
|
|
2565
|
|
|
2566 (defun Info-exit ()
|
|
|
2567 "Exit Info by selecting some other buffer."
|
|
|
2568 (interactive)
|
|
|
2569 (if Info-standalone
|
|
|
2570 (save-buffers-kill-emacs)
|
|
|
2571 (bury-buffer (current-buffer))
|
|
|
2572 (if (and (featurep 'toolbar)
|
|
278
|
2573 (boundp 'toolbar-info-frame)
|
|
217
|
2574 (eq toolbar-info-frame (selected-frame)))
|
|
|
2575 (condition-case ()
|
|
|
2576 (delete-frame toolbar-info-frame)
|
|
|
2577 (error (bury-buffer)))
|
|
|
2578 (switch-to-buffer (other-buffer (current-buffer))))))
|
|
|
2579
|
|
|
2580 (defun Info-undefined ()
|
|
|
2581 "Make command be undefined in Info."
|
|
|
2582 (interactive)
|
|
|
2583 (ding))
|
|
|
2584
|
|
|
2585 (defun Info-help ()
|
|
|
2586 "Enter the Info tutorial."
|
|
|
2587 (interactive)
|
|
|
2588 (delete-other-windows)
|
|
|
2589 (Info-find-node "info"
|
|
|
2590 (if (< (window-height) 23)
|
|
|
2591 "Help-Small-Screen"
|
|
|
2592 "Help")))
|
|
|
2593
|
|
|
2594 (defun Info-summary ()
|
|
|
2595 "Display a brief summary of all Info commands."
|
|
|
2596 (interactive)
|
|
|
2597 (save-window-excursion
|
|
|
2598 (switch-to-buffer "*Help*")
|
|
|
2599 (erase-buffer)
|
|
|
2600 (insert (documentation 'Info-mode))
|
|
|
2601 (goto-char (point-min))
|
|
|
2602 (let (flag)
|
|
|
2603 (while (progn (setq flag (not (pos-visible-in-window-p (point-max))))
|
|
|
2604 (message (if flag "Type Space to see more"
|
|
|
2605 "Type Space to return to Info"))
|
|
|
2606 (let ((e (next-command-event)))
|
|
|
2607 (if (/= ?\ (event-to-character e))
|
|
|
2608 (progn (setq unread-command-event e) nil)
|
|
|
2609 flag)))
|
|
|
2610 (scroll-up)))
|
|
|
2611 (message "")
|
|
|
2612 (bury-buffer "*Help*")))
|
|
|
2613
|
|
|
2614 (defun Info-get-token (pos start all &optional errorstring)
|
|
|
2615 "Return the token around POS,
|
|
|
2616 POS must be somewhere inside the token
|
|
|
2617 START is a regular expression which will match the
|
|
|
2618 beginning of the tokens delimited string
|
|
|
2619 ALL is a regular expression with a single
|
|
|
2620 parenthized subpattern which is the token to be
|
|
|
2621 returned. E.g. '{\(.*\)}' would return any string
|
|
|
2622 enclosed in braces around POS.
|
|
|
2623 SIG optional fourth argument, controls action on no match
|
|
|
2624 nil: return nil
|
|
|
2625 t: beep
|
|
|
2626 a string: signal an error, using that string."
|
|
|
2627 (save-excursion
|
|
|
2628 (goto-char (point-min))
|
|
|
2629 (re-search-backward "\\`") ; Bug fix due to Nicholas J. Foskett.
|
|
|
2630 (goto-char pos)
|
|
|
2631 (re-search-backward start (max (point-min) (- pos 200)) 'yes)
|
|
|
2632 (let (found)
|
|
|
2633 (while (and (re-search-forward all (min (point-max) (+ pos 200)) 'yes)
|
|
|
2634 (not (setq found (and (<= (match-beginning 0) pos)
|
|
|
2635 (> (match-end 0) pos))))))
|
|
|
2636 (if (and found (<= (match-beginning 0) pos)
|
|
|
2637 (> (match-end 0) pos))
|
|
|
2638 (buffer-substring (match-beginning 1) (match-end 1))
|
|
|
2639 (cond ((null errorstring)
|
|
|
2640 nil)
|
|
|
2641 ((eq errorstring t)
|
|
|
2642 (beep)
|
|
|
2643 nil)
|
|
|
2644 (t
|
|
|
2645 (error "No %s around position %d" errorstring pos)))))))
|
|
|
2646
|
|
|
2647 (defun Info-follow-clicked-node (event)
|
|
|
2648 "Follow a node reference near clicked point. Like M, F, N, P or U command.
|
|
|
2649 At end of the node's text, moves to the next node."
|
|
|
2650 (interactive "@e")
|
|
|
2651 (or (and (event-point event)
|
|
|
2652 (Info-follow-nearest-node
|
|
|
2653 (max (progn
|
|
|
2654 (select-window (event-window event))
|
|
|
2655 (event-point event))
|
|
|
2656 (1+ (point-min)))))
|
|
|
2657 (error "click on a cross-reference to follow")))
|
|
|
2658
|
|
|
2659 (defun Info-maybe-follow-clicked-node (event &optional click-count)
|
|
|
2660 "Follow a node reference (if any) near clicked point.
|
|
|
2661 Like M, F, N, P or U command. At end of the node's text, moves to the
|
|
|
2662 next node. No error is given if there is no node to follow."
|
|
|
2663 (interactive "@e")
|
|
|
2664 (and Info-button1-follows-hyperlink
|
|
|
2665 (event-point event)
|
|
|
2666 (Info-follow-nearest-node
|
|
|
2667 (max (progn
|
|
|
2668 (select-window (event-window event))
|
|
|
2669 (event-point event))
|
|
|
2670 (1+ (point-min))))))
|
|
|
2671
|
|
|
2672 (defun Info-find-nearest-node (point)
|
|
|
2673 (let (node)
|
|
|
2674 (cond
|
|
|
2675 ((= point (point-min)) nil) ; don't trigger on accidental RET.
|
|
|
2676 ((setq node (Info-get-token point
|
|
|
2677 (format "\\*%s[ \n]" Info-footnote-tag)
|
|
|
2678 (format "\\*%s[ \n]\\([^:]*\\):"
|
|
|
2679 Info-footnote-tag)))
|
|
|
2680 (list "Following cross-reference %s..."
|
|
|
2681 (list 'Info-follow-reference node)))
|
|
|
2682 ((setq node (Info-get-token point "\\* " "\\* \\([^:]*\\)::"))
|
|
|
2683 (list "Selecting menu item %s..."
|
|
|
2684 (list 'Info-goto-node node nil t)))
|
|
|
2685 ((setq node (Info-get-token point "\\* " "\\* \\([^:]*\\):"))
|
|
|
2686 (list "Selecting menu item %s..."
|
|
|
2687 (list 'Info-menu node)))
|
|
|
2688 ((setq node (Info-get-token point "Up: " "Up: \\([^,\n\t]*\\)"))
|
|
|
2689 (list "Going up..."
|
|
|
2690 (list 'Info-goto-node node)))
|
|
|
2691 ((setq node (Info-get-token point "Next: " "Next: \\([^,\n\t]*\\)"))
|
|
|
2692 (list "Next node..."
|
|
|
2693 (list 'Info-goto-node node)))
|
|
|
2694 ((setq node (Info-get-token point "File: " "File: \\([^,\n\t]*\\)"))
|
|
|
2695 (list "Top node..."
|
|
|
2696 (list 'Info-goto-node "Top")))
|
|
|
2697 ((setq node (Info-get-token point "Prev[ious]*: "
|
|
|
2698 "Prev[ious]*: \\([^,\n\t]*\\)"))
|
|
|
2699 (list "Previous node..."
|
|
|
2700 (list 'Info-goto-node node)))
|
|
|
2701 ((setq node (Info-get-token point "Node: " "Node: \\([^,\n\t]*\\)"))
|
|
|
2702 (list "Reselecting %s..."
|
|
|
2703 (list 'Info-goto-node node)))
|
|
|
2704 ((save-excursion (goto-char point) (looking-at "[ \n]*\\'"))
|
|
|
2705 (if Info-in-cross-reference
|
|
|
2706 (list "Back to last node..."
|
|
|
2707 '(Info-last))
|
|
|
2708 (list "Next node..."
|
|
|
2709 '(Info-global-next)))))
|
|
|
2710 ))
|
|
|
2711
|
|
|
2712 (defun Info-follow-nearest-node (point)
|
|
|
2713 "Follow a node reference near point. Like M, F, N, P or U command.
|
|
|
2714 At end of the node's text, moves to the next node."
|
|
|
2715 (interactive "d")
|
|
|
2716 (let ((data (Info-find-nearest-node point)))
|
|
|
2717 (if (null data)
|
|
|
2718 nil
|
|
|
2719 (let ((msg (format (car data) (nth 1 (nth 1 data)))))
|
|
|
2720 (message "%s" msg)
|
|
|
2721 (eval (nth 1 data))
|
|
|
2722 (message "%sdone" msg))
|
|
|
2723 t)))
|
|
|
2724
|
|
|
2725 (defun Info-indicated-node (event)
|
|
|
2726 (condition-case ()
|
|
|
2727 (save-excursion
|
|
|
2728 (cond ((eventp event)
|
|
|
2729 (set-buffer (event-buffer event))
|
|
|
2730 (setq event (event-point event))))
|
|
|
2731 (let* ((data (Info-find-nearest-node event))
|
|
|
2732 (name (nth 1 (nth 1 data))))
|
|
|
2733 (and name (nth 1 data))))
|
|
|
2734 (error nil)))
|
|
|
2735
|
|
|
2736 (defun Info-mouse-track-double-click-hook (event click-count)
|
|
|
2737 "Handle double-clicks by turning pages, like the `gv' ghostscript viewer"
|
|
|
2738 (if (/= click-count 2)
|
|
|
2739 ;; Return nil so any other hooks are performed.
|
|
|
2740 nil
|
|
318
|
2741 (let* ((fw (face-width 'default))
|
|
|
2742 (fh (face-height 'default))
|
|
|
2743 (x (/ (event-x-pixel event) fw))
|
|
|
2744 (y (/ (event-y-pixel event) fw))
|
|
|
2745 (w (/ (window-pixel-width (event-window event)) fw))
|
|
|
2746 (h (/ (window-pixel-height (event-window event)) fh))
|
|
|
2747 (bx 3)
|
|
|
2748 (by 2))
|
|
217
|
2749 (cond
|
|
318
|
2750 ((<= y by) (Info-up) t)
|
|
|
2751 ((>= y (- h by)) (Info-nth-menu-item 1) t)
|
|
|
2752 ((<= x bx) (Info-prev) t)
|
|
|
2753 ((>= x (- w bx)) (Info-next) t)
|
|
|
2754 (t nil)))))
|
|
217
|
2755
|
|
|
2756 (defvar Info-mode-map nil
|
|
|
2757 "Keymap containing Info commands.")
|
|
367
|
2758
|
|
217
|
2759 (if Info-mode-map
|
|
|
2760 nil
|
|
|
2761 (setq Info-mode-map (make-sparse-keymap))
|
|
|
2762 (suppress-keymap Info-mode-map)
|
|
|
2763 (define-key Info-mode-map "." 'beginning-of-buffer)
|
|
|
2764 (define-key Info-mode-map " " 'Info-scroll-next)
|
|
|
2765 (define-key Info-mode-map "1" 'Info-nth-menu-item)
|
|
|
2766 (define-key Info-mode-map "2" 'Info-nth-menu-item)
|
|
|
2767 (define-key Info-mode-map "3" 'Info-nth-menu-item)
|
|
|
2768 (define-key Info-mode-map "4" 'Info-nth-menu-item)
|
|
|
2769 (define-key Info-mode-map "5" 'Info-nth-menu-item)
|
|
|
2770 (define-key Info-mode-map "6" 'Info-nth-menu-item)
|
|
|
2771 (define-key Info-mode-map "7" 'Info-nth-menu-item)
|
|
|
2772 (define-key Info-mode-map "8" 'Info-nth-menu-item)
|
|
|
2773 (define-key Info-mode-map "9" 'Info-nth-menu-item)
|
|
|
2774 (define-key Info-mode-map "0" 'Info-last-menu-item)
|
|
|
2775 (define-key Info-mode-map "?" 'Info-summary)
|
|
|
2776 (define-key Info-mode-map "a" 'Info-annotate)
|
|
|
2777 (define-key Info-mode-map "b" 'beginning-of-buffer)
|
|
|
2778 (define-key Info-mode-map "d" 'Info-directory)
|
|
|
2779 (define-key Info-mode-map "e" 'Info-edit)
|
|
|
2780 (define-key Info-mode-map "f" 'Info-follow-reference)
|
|
|
2781 (define-key Info-mode-map "g" 'Info-goto-node)
|
|
|
2782 (define-key Info-mode-map "h" 'Info-help)
|
|
|
2783 (define-key Info-mode-map "i" 'Info-index)
|
|
|
2784 (define-key Info-mode-map "j" 'Info-goto-bookmark)
|
|
|
2785 (define-key Info-mode-map "k" 'Info-emacs-key)
|
|
|
2786 (define-key Info-mode-map "l" 'Info-last)
|
|
|
2787 (define-key Info-mode-map "m" 'Info-menu)
|
|
|
2788 (define-key Info-mode-map "n" 'Info-next)
|
|
|
2789 (define-key Info-mode-map "p" 'Info-prev)
|
|
|
2790 (define-key Info-mode-map "q" 'Info-exit)
|
|
|
2791 (define-key Info-mode-map "r" 'Info-follow-reference)
|
|
|
2792 (define-key Info-mode-map "s" 'Info-search)
|
|
|
2793 (define-key Info-mode-map "t" 'Info-top)
|
|
|
2794 (define-key Info-mode-map "u" 'Info-up)
|
|
|
2795 (define-key Info-mode-map "v" 'Info-visit-file)
|
|
|
2796 (define-key Info-mode-map "x" 'Info-bookmark)
|
|
|
2797 (define-key Info-mode-map "<" 'Info-top)
|
|
|
2798 (define-key Info-mode-map ">" 'Info-end)
|
|
|
2799 (define-key Info-mode-map "[" 'Info-global-prev)
|
|
|
2800 (define-key Info-mode-map "]" 'Info-global-next)
|
|
|
2801 (define-key Info-mode-map "{" 'Info-page-prev)
|
|
|
2802 (define-key Info-mode-map "}" 'Info-page-next)
|
|
|
2803 (define-key Info-mode-map "=" 'Info-restore-point)
|
|
|
2804 (define-key Info-mode-map "!" 'Info-select-node)
|
|
|
2805 (define-key Info-mode-map "@" 'Info-follow-nearest-node)
|
|
|
2806 (define-key Info-mode-map "," 'Info-index-next)
|
|
|
2807 (define-key Info-mode-map "*" 'Info-elisp-ref)
|
|
|
2808 (define-key Info-mode-map [tab] 'Info-next-reference)
|
|
|
2809 (define-key Info-mode-map [(meta tab)] 'Info-prev-reference)
|
|
|
2810 (define-key Info-mode-map [(shift tab)] 'Info-prev-reference)
|
|
|
2811 (define-key Info-mode-map "\r" 'Info-follow-nearest-node)
|
|
|
2812 ;; XEmacs addition
|
|
|
2813 (define-key Info-mode-map 'backspace 'Info-scroll-prev)
|
|
|
2814 (define-key Info-mode-map 'delete 'Info-scroll-prev)
|
|
|
2815 (define-key Info-mode-map 'button2 'Info-follow-clicked-node)
|
|
|
2816 (define-key Info-mode-map 'button3 'Info-select-node-menu))
|
|
|
2817
|
|
|
2818
|
|
|
2819 ;; Info mode is suitable only for specially formatted data.
|
|
|
2820 (put 'info-mode 'mode-class 'special)
|
|
|
2821
|
|
|
2822 (defun Info-mode ()
|
|
|
2823 "Info mode is for browsing through the Info documentation tree.
|
|
|
2824 Documentation in Info is divided into \"nodes\", each of which
|
|
|
2825 discusses one topic and contains references to other nodes
|
|
|
2826 which discuss related topics. Info has commands to follow
|
|
|
2827 the references and show you other nodes.
|
|
|
2828
|
|
|
2829 h Invoke the Info tutorial.
|
|
|
2830 q Quit Info: return to the previously selected file or buffer.
|
|
|
2831
|
|
|
2832 Selecting other nodes:
|
|
|
2833 n Move to the \"next\" node of this node.
|
|
|
2834 p Move to the \"previous\" node of this node.
|
|
|
2835 m Pick menu item specified by name (or abbreviation).
|
|
|
2836 1-9, 0 Pick first..ninth, last item in node's menu.
|
|
|
2837 Menu items select nodes that are \"subsections\" of this node.
|
|
|
2838 u Move \"up\" from this node (i.e., from a subsection to a section).
|
|
|
2839 f or r Follow a cross reference by name (or abbrev). Type `l' to get back.
|
|
|
2840 RET Follow cross reference or menu item indicated by cursor.
|
|
|
2841 i Look up a topic in this file's Index and move to that node.
|
|
|
2842 , (comma) Move to the next match from a previous `i' command.
|
|
|
2843 l (letter L) Move back to the last node you were in.
|
|
|
2844
|
|
|
2845 Moving within a node:
|
|
|
2846 Space Scroll forward a full screen. DEL Scroll backward.
|
|
|
2847 b Go to beginning of node. Meta-> Go to end of node.
|
|
|
2848 TAB Go to next cross-reference. Meta-TAB Go to previous ref.
|
|
|
2849
|
|
|
2850 Mouse commands:
|
|
318
|
2851 Left Button Set point (usual text-mode functionality)
|
|
217
|
2852 Middle Button Click on a highlighted node reference to go to it.
|
|
|
2853 Right Button Pop up a menu of applicable Info commands.
|
|
|
2854
|
|
318
|
2855 Left Button Double Click in window edges:
|
|
|
2856 Top edge: Go up to the parent node, like `u'.
|
|
|
2857 Left edge: Go to the previous node, like `p'.
|
|
|
2858 Right edge: Go to the next node, like `n'.
|
|
|
2859 Bottom edge: Follow first menu item, like `1'.
|
|
|
2860
|
|
217
|
2861 Advanced commands:
|
|
|
2862 g Move to node, file, or annotation tag specified by name.
|
|
|
2863 Examples: `g Rectangles' `g (Emacs)Rectangles' `g Emacs'.
|
|
|
2864 v Move to file, with filename completion.
|
|
|
2865 k Look up a key sequence in Emacs manual (also C-h C-k at any time).
|
|
|
2866 * Look up a function name in Emacs Lisp manual (also C-h C-f).
|
|
|
2867 d Go to the main directory of Info files.
|
|
|
2868 < or t Go to Top (first) node of this file.
|
|
|
2869 > Go to last node in this file.
|
|
|
2870 \[ Go to previous node, treating file as one linear document.
|
|
|
2871 \] Go to next node, treating file as one linear document.
|
|
|
2872 { Scroll backward, or go to previous node if at top.
|
|
|
2873 } Scroll forward, or go to next node if at bottom.
|
|
|
2874 = Restore cursor position from last time in this node.
|
|
|
2875 a Add a private note (annotation) to the current node.
|
|
|
2876 x, j Add, jump to a bookmark (annotation tag).
|
|
|
2877 s Search this Info file for a node containing the specified regexp.
|
|
|
2878 e Edit the contents of the current node."
|
|
|
2879 (kill-all-local-variables)
|
|
|
2880 (setq major-mode 'Info-mode)
|
|
|
2881 (setq mode-name "Info")
|
|
|
2882 (use-local-map Info-mode-map)
|
|
|
2883 (set-syntax-table text-mode-syntax-table)
|
|
|
2884 (setq local-abbrev-table text-mode-abbrev-table)
|
|
|
2885 (setq case-fold-search t)
|
|
|
2886 (setq buffer-read-only t)
|
|
|
2887 ; (setq buffer-mouse-map Info-mode-mouse-map)
|
|
|
2888 (make-local-variable 'Info-current-file)
|
|
|
2889 (make-local-variable 'Info-current-subfile)
|
|
|
2890 (make-local-variable 'Info-current-node)
|
|
|
2891 (make-local-variable 'Info-tag-table-marker)
|
|
|
2892 (make-local-variable 'Info-current-file-completions)
|
|
|
2893 (make-local-variable 'Info-current-annotation-completions)
|
|
|
2894 (make-local-variable 'Info-index-alternatives)
|
|
|
2895 (make-local-variable 'Info-history)
|
|
|
2896 ;; Faces are now defined by `defface'...
|
|
|
2897 (make-local-variable 'mouse-track-click-hook)
|
|
|
2898 (add-hook 'mouse-track-click-hook 'Info-maybe-follow-clicked-node)
|
|
|
2899 (add-hook 'mouse-track-click-hook 'Info-mouse-track-double-click-hook)
|
|
|
2900 ;; #### The console-on-window-system-p check is to allow this to
|
|
|
2901 ;; work on tty's. The real problem here is that featurep really
|
|
|
2902 ;; needs to have some device/console domain knowledge added to it.
|
|
|
2903 (if (and (featurep 'toolbar)
|
|
|
2904 (console-on-window-system-p)
|
|
|
2905 (not Info-inhibit-toolbar))
|
|
|
2906 (set-specifier default-toolbar (cons (current-buffer) info::toolbar)))
|
|
|
2907 (if (featurep 'menubar)
|
|
|
2908 (progn
|
|
|
2909 ;; make a local copy of the menubar, so our modes don't
|
|
|
2910 ;; change the global menubar
|
|
284
|
2911 (easy-menu-add '("Info" :filter Info-menu-filter))))
|
|
217
|
2912 (run-hooks 'Info-mode-hook)
|
|
|
2913 (Info-set-mode-line))
|
|
|
2914
|
|
|
2915 (defvar Info-edit-map nil
|
|
|
2916 "Local keymap used within `e' command of Info.")
|
|
367
|
2917
|
|
217
|
2918 (if Info-edit-map
|
|
|
2919 nil
|
|
|
2920 ;; XEmacs: remove FSF stuff
|
|
|
2921 (setq Info-edit-map (make-sparse-keymap))
|
|
|
2922 (set-keymap-name Info-edit-map 'Info-edit-map)
|
|
|
2923 (set-keymap-parents Info-edit-map (list text-mode-map))
|
|
|
2924 (define-key Info-edit-map "\C-c\C-c" 'Info-cease-edit))
|
|
|
2925
|
|
|
2926 ;; Info-edit mode is suitable only for specially formatted data.
|
|
|
2927 (put 'info-edit-mode 'mode-class 'special)
|
|
|
2928
|
|
|
2929 (defun Info-edit-mode ()
|
|
|
2930 "Major mode for editing the contents of an Info node.
|
|
|
2931 Like text mode with the addition of `Info-cease-edit'
|
|
|
2932 which returns to Info mode for browsing.
|
|
|
2933 \\{Info-edit-map}"
|
|
|
2934 )
|
|
|
2935
|
|
|
2936 (defun Info-edit ()
|
|
|
2937 "Edit the contents of this Info node.
|
|
|
2938 Allowed only if variable `Info-enable-edit' is non-nil."
|
|
|
2939 (interactive)
|
|
|
2940 (or Info-enable-edit
|
|
|
2941 (error "Editing info nodes is not enabled"))
|
|
|
2942 (use-local-map Info-edit-map)
|
|
|
2943 (setq major-mode 'Info-edit-mode)
|
|
|
2944 (setq mode-name "Info Edit")
|
|
|
2945 (kill-local-variable 'modeline-buffer-identification)
|
|
|
2946 (setq buffer-read-only nil)
|
|
|
2947 ;; Make mode line update.
|
|
|
2948 (set-buffer-modified-p (buffer-modified-p))
|
|
|
2949 (message (substitute-command-keys
|
|
|
2950 "Editing: Type \\[Info-cease-edit] to return to info")))
|
|
|
2951
|
|
|
2952 (defun Info-cease-edit ()
|
|
|
2953 "Finish editing Info node; switch back to Info proper."
|
|
|
2954 (interactive)
|
|
|
2955 ;; Do this first, so nothing has changed if user C-g's at query.
|
|
|
2956 (and (buffer-modified-p)
|
|
|
2957 (y-or-n-p-maybe-dialog-box "Save the file? ")
|
|
|
2958 (save-buffer))
|
|
|
2959 (use-local-map Info-mode-map)
|
|
|
2960 (setq major-mode 'Info-mode)
|
|
|
2961 (setq mode-name "Info")
|
|
|
2962 (Info-set-mode-line)
|
|
|
2963 (setq buffer-read-only t)
|
|
|
2964 ;; Make mode line update.
|
|
|
2965 (set-buffer-modified-p (buffer-modified-p))
|
|
|
2966 (and (marker-position Info-tag-table-marker)
|
|
|
2967 (buffer-modified-p)
|
|
|
2968 (message "Tags may have changed. Use Info-tagify if necessary")))
|
|
|
2969
|
|
|
2970 (defun Info-find-emacs-command-nodes (command)
|
|
|
2971 "Return a list of locations documenting COMMAND in the XEmacs Info manual.
|
|
|
2972 The locations are of the format used in Info-history, i.e.
|
|
|
2973 \(FILENAME NODENAME BUFFERPOS\)."
|
|
|
2974 (let ((where '())
|
|
|
2975 (cmd-desc (concat "^\\* " (regexp-quote (symbol-name command))
|
|
|
2976 ":\\s *\\(.*\\)\\.$")))
|
|
|
2977 (save-excursion
|
|
|
2978 (Info-find-node "XEmacs" "Command Index")
|
|
|
2979 ;; Take the index node off the Info history.
|
|
|
2980 ;; ??? says this isn't safe someplace else... hmmm.
|
|
|
2981 (setq Info-history (cdr Info-history))
|
|
|
2982 (goto-char (point-max))
|
|
|
2983 (while (re-search-backward cmd-desc nil t)
|
|
|
2984 (setq where (cons (list Info-current-file
|
|
|
2985 (buffer-substring
|
|
|
2986 (match-beginning 1)
|
|
|
2987 (match-end 1))
|
|
|
2988 0)
|
|
|
2989 where)))
|
|
|
2990 where)))
|
|
|
2991
|
|
|
2992 ;;; fontification and mousability for info
|
|
|
2993
|
|
|
2994 (defun Info-highlight-region (start end face)
|
|
|
2995 (let ((extent nil)
|
|
|
2996 (splitp (string-match "\n[ \t]+" (buffer-substring start end))))
|
|
|
2997 (if splitp
|
|
|
2998 (save-excursion
|
|
|
2999 (setq extent (make-extent start (progn (goto-char start)
|
|
|
3000 (end-of-line)
|
|
|
3001 (point))))
|
|
|
3002 (set-extent-face extent face)
|
|
|
3003 (set-extent-property extent 'info t)
|
|
|
3004 (set-extent-property extent 'highlight t)
|
|
|
3005 (skip-chars-forward "\n\t ")
|
|
|
3006 (setq extent (make-extent (point) end)))
|
|
|
3007 (setq extent (make-extent start end)))
|
|
|
3008 (set-extent-face extent face)
|
|
|
3009 (set-extent-property extent 'info t)
|
|
|
3010 (set-extent-property extent 'highlight t)))
|
|
|
3011
|
|
|
3012 (defun Info-fontify-node ()
|
|
|
3013 (save-excursion
|
|
|
3014 (let ((case-fold-search t)
|
|
|
3015 (xref-regexp (concat "\\*"
|
|
|
3016 (regexp-quote Info-footnote-tag)
|
|
|
3017 "[ \n\t]*\\([^:]*\\):")))
|
|
|
3018 ;; Clear the old extents
|
|
|
3019 (map-extents #'(lambda (x y) (delete-extent x))
|
|
|
3020 (current-buffer) (point-min) (point-max) nil)
|
|
|
3021 ;; Break the top line iff it is > 79 characters. Some info nodes
|
|
|
3022 ;; have top lines that span 3 lines because of long node titles.
|
|
|
3023 ;; eg: (Info-find-node "lispref.info" "Window-Level Event Position Info")
|
|
|
3024 (toggle-read-only -1)
|
|
|
3025 (let ((extent nil)
|
|
|
3026 (len 0)
|
|
|
3027 (done nil)
|
|
|
3028 (p (point-min)))
|
|
|
3029 (goto-char (point-min))
|
|
|
3030 (re-search-forward "Node: *[^,]+, " nil t)
|
|
|
3031 (setq len (- (point) (point-min))
|
|
|
3032 extent (make-extent (point-min) (point)))
|
|
|
3033 (set-extent-property extent 'invisible t)
|
|
|
3034 (while (not done)
|
|
|
3035 (goto-char p)
|
|
|
3036 (end-of-line)
|
|
|
3037 (if (< (current-column) (+ 78 len))
|
|
|
3038 (setq done t)
|
|
|
3039 (goto-char p)
|
|
|
3040 (forward-char (+ 79 len))
|
|
|
3041 (re-search-backward "," nil t)
|
|
|
3042 (forward-char 1)
|
|
|
3043 (insert "\n")
|
|
|
3044 (just-one-space)
|
|
|
3045 (backward-delete-char 1)
|
|
|
3046 (setq p (point)
|
|
|
3047 len 0))))
|
|
|
3048 (toggle-read-only 1)
|
|
|
3049 ;; Highlight xrefs in the top few lines of the node
|
|
|
3050 (goto-char (point-min))
|
|
|
3051 (if (looking-at "^File: [^,: \t]+,?[ \t]+")
|
|
|
3052 (progn
|
|
|
3053 (goto-char (match-end 0))
|
|
|
3054 (while
|
|
|
3055 (looking-at "[ \t]*[^:, \t\n]+:[ \t]+\\([^:,\t\n]+\\),?\n?")
|
|
|
3056 (goto-char (match-end 0))
|
|
367
|
3057 (Info-highlight-region (match-beginning 1) (match-end 1)
|
|
|
3058 'info-xref))))
|
|
217
|
3059 ;; Now get the xrefs in the body
|
|
|
3060 (goto-char (point-min))
|
|
|
3061 (while (re-search-forward xref-regexp nil t)
|
|
|
3062 (if (= (char-after (1- (match-beginning 0))) ?\") ; hack
|
|
|
3063 nil
|
|
367
|
3064 (Info-highlight-region (match-beginning 1) (match-end 1)
|
|
|
3065 'info-xref)))
|
|
217
|
3066 ;; then highlight the nodes in the menu.
|
|
|
3067 (goto-char (point-min))
|
|
|
3068 (if (and (search-forward "\n* menu:" nil t))
|
|
|
3069 (while (re-search-forward
|
|
|
3070 "^\\* \\([^:\t\n]*\\):?:[ \t\n]" nil t)
|
|
367
|
3071 (Info-highlight-region (match-beginning 1) (match-end 1)
|
|
|
3072 'info-node)))
|
|
217
|
3073 (set-buffer-modified-p nil))))
|
|
|
3074
|
|
|
3075 (defun Info-construct-menu (&optional event)
|
|
|
3076 "Construct a menu of Info commands.
|
|
|
3077 Adds an entry for the node at EVENT, or under point if EVENT is omitted.
|
|
|
3078 Used to construct the menubar submenu and popup menu."
|
|
|
3079 (or event (setq event (point)))
|
|
|
3080 (let ((case-fold-search t)
|
|
367
|
3081 (xref-regexp (concat "\\*"
|
|
217
|
3082 (regexp-quote Info-footnote-tag)
|
|
|
3083 "[ \n\t]*\\([^:]*\\):"))
|
|
|
3084 up-p prev-p next-p menu xrefs subnodes in)
|
|
|
3085 (save-excursion
|
|
|
3086 ;; `one-space' fixes "Notes:" xrefs that are split across lines.
|
|
|
3087 (flet
|
|
|
3088 ((one-space (text)
|
|
|
3089 (let (i)
|
|
|
3090 (while (setq i (string-match "[ \n\t]+" text i))
|
|
|
3091 (setq text (concat (substring text 0 i) " "
|
|
|
3092 (substring text (match-end 0))))
|
|
|
3093 (setq i (1+ i)))
|
|
|
3094 text)))
|
|
|
3095 (goto-char (point-min))
|
|
|
3096 (if (looking-at ".*\\bNext:") (setq next-p t))
|
|
|
3097 (if (looking-at ".*\\bPrev:") (setq prev-p t))
|
|
|
3098 (if (looking-at ".*Up:") (setq up-p t))
|
|
|
3099 (setq menu (nconc
|
|
|
3100 (if (setq in (Info-indicated-node event))
|
|
|
3101 (list (vector (one-space (cadr in)) in t)
|
|
|
3102 "--:shadowEtchedIn"))
|
|
|
3103 (list
|
|
263
|
3104 ["Goto Info Top-level" Info-directory]
|
|
|
3105 (vector "Next Node" 'Info-next :active next-p)
|
|
|
3106 (vector "Previous Node" 'Info-prev :active prev-p)
|
|
|
3107 (vector "Parent Node (Up)" 'Info-up :active up-p)
|
|
|
3108 ["Goto Node..." Info-goto-node]
|
|
|
3109 ["Goto Last Visited Node " Info-last])))
|
|
217
|
3110 ;; Find the xrefs and make a list
|
|
|
3111 (while (re-search-forward xref-regexp nil t)
|
|
|
3112 (setq xrefs (cons (one-space (buffer-substring (match-beginning 1)
|
|
|
3113 (match-end 1)))
|
|
|
3114 xrefs))))
|
|
|
3115 (setq xrefs (nreverse xrefs))
|
|
|
3116 (if (> (length xrefs) 21) (setcdr (nthcdr 20 xrefs) '(more)))
|
|
|
3117 ;; Find the subnodes and make a list
|
|
|
3118 (goto-char (point-min))
|
|
|
3119 (if (search-forward "\n* menu:" nil t)
|
|
|
3120 (while (re-search-forward "^\\* \\([^:\t\n]*\\):" nil t)
|
|
|
3121 (setq subnodes (cons (buffer-substring (match-beginning 1)
|
|
|
3122 (match-end 1))
|
|
|
3123 subnodes))))
|
|
|
3124 (setq subnodes (nreverse subnodes))
|
|
|
3125 (if (> (length subnodes) 21) (setcdr (nthcdr 20 subnodes) '(more))))
|
|
|
3126 (if xrefs
|
|
|
3127 (nconc menu (list "--:shadowDoubleEtchedIn"
|
|
|
3128 " Cross-References"
|
|
|
3129 "--:singleLine")
|
|
|
3130 (mapcar #'(lambda (xref)
|
|
|
3131 (if (eq xref 'more)
|
|
|
3132 "...more..."
|
|
|
3133 (vector xref
|
|
263
|
3134 (list 'Info-follow-reference xref))))
|
|
217
|
3135 xrefs)))
|
|
|
3136 (if subnodes
|
|
|
3137 (nconc menu (list "--:shadowDoubleEtchedIn"
|
|
|
3138 " Sub-Nodes"
|
|
|
3139 "--:singleLine")
|
|
|
3140 (mapcar #'(lambda (node)
|
|
|
3141 (if (eq node 'more)
|
|
|
3142 "...more..."
|
|
263
|
3143 (vector node (list 'Info-menu node))))
|
|
217
|
3144 subnodes)))
|
|
|
3145 menu))
|
|
|
3146
|
|
|
3147 (defun Info-menu-filter (menu)
|
|
|
3148 "This is the menu filter for the \"Info\" submenu."
|
|
|
3149 (Info-construct-menu))
|
|
|
3150
|
|
|
3151 (defun Info-select-node-menu (event)
|
|
|
3152 "Pops up a menu of applicable Info commands."
|
|
|
3153 (interactive "e")
|
|
|
3154 (select-window (event-window event))
|
|
|
3155 (let ((menu (Info-construct-menu event)))
|
|
|
3156 (setq menu (nconc (list "Info" ; title: not displayed
|
|
|
3157 " Info Commands"
|
|
|
3158 "--:shadowDoubleEtchedOut")
|
|
|
3159 menu))
|
|
|
3160 (let ((popup-menu-titles nil))
|
|
|
3161 (popup-menu menu))))
|
|
|
3162
|
|
|
3163 ;;; Info toolbar support
|
|
|
3164
|
|
|
3165 ;; exit icon taken from GNUS
|
|
|
3166 (defvar info::toolbar-exit-icon
|
|
|
3167 (if (featurep 'toolbar)
|
|
|
3168 (toolbar-make-button-list
|
|
|
3169 (expand-file-name (if (featurep 'xpm) "info-exit.xpm" "info-exit.xbm")
|
|
|
3170 toolbar-icon-directory)))
|
|
|
3171 "Exit Info icon")
|
|
|
3172
|
|
|
3173 (defvar info::toolbar-up-icon
|
|
|
3174 (if (featurep 'toolbar)
|
|
|
3175 (toolbar-make-button-list
|
|
|
3176 (expand-file-name (if (featurep 'xpm) "info-up.xpm" "info-up.xbm")
|
|
|
3177 toolbar-icon-directory)))
|
|
|
3178 "Up icon")
|
|
|
3179
|
|
|
3180 (defvar info::toolbar-next-icon
|
|
|
3181 (if (featurep 'toolbar)
|
|
|
3182 (toolbar-make-button-list
|
|
|
3183 (expand-file-name (if (featurep 'xpm) "info-next.xpm" "info-next.xbm")
|
|
|
3184 toolbar-icon-directory)))
|
|
|
3185 "Next icon")
|
|
|
3186
|
|
|
3187 (defvar info::toolbar-prev-icon
|
|
|
3188 (if (featurep 'toolbar)
|
|
|
3189 (toolbar-make-button-list
|
|
|
3190 (expand-file-name (if (featurep 'xpm) "info-prev.xpm" "info-prev.xbm")
|
|
|
3191 toolbar-icon-directory)))
|
|
|
3192 "Prev icon")
|
|
|
3193
|
|
|
3194 (defvar info::toolbar
|
|
|
3195 (if (featurep 'toolbar)
|
|
|
3196 ; disabled until we get the next/prev-win icons working again.
|
|
|
3197 ; (cons (first initial-toolbar-spec)
|
|
|
3198 ; (cons (second initial-toolbar-spec)
|
|
|
3199 '([info::toolbar-exit-icon
|
|
|
3200 Info-exit
|
|
|
3201 t
|
|
|
3202 "Exit info"]
|
|
|
3203 [info::toolbar-next-icon
|
|
|
3204 Info-next
|
|
|
3205 t
|
|
|
3206 "Next entry in same section"]
|
|
|
3207 [info::toolbar-prev-icon
|
|
|
3208 Info-prev
|
|
|
3209 t
|
|
|
3210 "Prev entry in same section"]
|
|
|
3211 [info::toolbar-up-icon
|
|
|
3212 Info-up
|
|
|
3213 t
|
|
|
3214 "Up entry to enclosing section"]
|
|
|
3215 )))
|
|
|
3216 ;))
|
|
|
3217
|
|
|
3218 (provide 'info)
|
|
|
3219
|
|
|
3220 (run-hooks 'Info-load-hook)
|
|
|
3221
|
|
|
3222 ;;; info.el ends here
|
