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