1 ;;; info.el --- info package for Emacs.
3 ;; Copyright (C) 1985, 1986, 1992 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;;; Note that nowadays we expect info files to be made using makeinfo.
30 (defvar Info-history nil
31 "List of info nodes user has visited.
32 Each element of list is a list (FILENAME NODENAME BUFFERPOS).")
34 (defvar Info-enable-edit nil
35 "*Non-nil means the \\<Info-mode-map>\\[Info-edit] command in Info can edit the current node.
36 This is convenient if you want to write info files by hand.
37 However, we recommend that you not do this.
38 It is better to write a Texinfo file and generate the Info file from that,
39 because that gives you a printed manual as well.")
41 (defvar Info-enable-active-nodes t
42 "Non-nil allows Info to execute Lisp code associated with nodes.
43 The Lisp code is executed when the node is selected.")
45 (defvar Info-default-directory-list nil
46 "List of default directories to search for Info documentation files.
47 This value is used as the default for `Info-directory-list'. It is set
50 (defvar Info-directory-list
51 (let ((path (getenv "INFOPATH")))
55 (while (> (length path
) 0)
56 (setq idx
(or (string-match ":" path
) (length path
))
57 list
(cons (substring path
0 idx
) list
)
58 path
(substring path
(min (1+ idx
)
61 Info-default-directory-list
))
62 "List of directories to search for Info documentation files.
63 nil means not yet initialized. In this case, Info uses the environment
64 variable INFOPATH to initialize it, or `Info-default-directory-list'
65 if there is no INFOPATH variable in the environment.")
67 (defvar Info-current-file nil
68 "Info file that Info is now looking at, or nil.")
70 (defvar Info-current-subfile nil
71 "Info subfile that is actually in the *info* buffer now,
72 or nil if current info file is not split into subfiles.")
74 (defvar Info-current-node nil
75 "Name of node that Info is now looking at, or nil.")
77 (defvar Info-tag-table-marker
(make-marker)
78 "Marker pointing at beginning of current Info file's tag table.
79 Marker points nowhere if file has no tag table.")
81 (defvar Info-index-alternatives nil
82 "List of possible matches for last Info-index command.")
84 (defvar Info-suffix-list
'( ("" . nil
)
90 (".info.Z" .
"uncompress")
91 (".info.Y" .
"unyabba")
92 (".info.gz" .
"gunzip")
93 (".info.z" .
"gunzip"))
94 "List of file name suffixes and associated decoding commands.
95 Each entry should be (SUFFIX . STRING); the file is given to
96 the command as standard input. If STRING is nil, no decoding is done.")
98 (defun info-insert-file-contents (filename &optional visit
)
99 "Insert the contents of an info file in the current buffer.
100 Do the right thing if the file has been compressed or zipped."
105 (let ((compressed (concat filename
(car x
))))
106 (if (file-exists-p compressed
)
108 (insert-file-contents compressed visit
)
110 (let ((buffer-read-only nil
))
111 (shell-command-on-region
112 (point-min) (point-max) (cdr x
) t
)))
116 (error "Can't find %s or any compressed version of it!" filename
)))
119 (defun info (&optional file
)
120 "Enter Info, the documentation browser.
121 Optional argument FILE specifies the file to examine;
122 the default is the top-level directory of Info.
124 In interactive use, a prefix argument directs this command
125 to read a file name from the minibuffer."
126 (interactive (if current-prefix-arg
127 (list (read-file-name "Info file name: " nil nil t
))))
129 (Info-goto-node (concat "(" file
")"))
130 (if (get-buffer "*info*")
131 (switch-to-buffer "*info*")
134 ;; Go to an info node specified as separate filename and nodename.
135 ;; no-going-back is non-nil if recovering from an error in this function;
136 ;; it says do not attempt further (recursive) error recovery.
137 (defun Info-find-node (filename nodename
&optional no-going-back
)
138 ;; Convert filename to lower case if not found as specified.
141 (let (temp temp-downcase found
)
142 (setq filename
(substitute-in-file-name filename
))
143 (if (string= (downcase (file-name-nondirectory filename
)) "dir")
145 (let ((dirs (if (string-match "^\\./" filename
)
146 ;; If specified name starts with `./'
147 ;; then just try current directory.
149 Info-directory-list
)))
150 ;; Search the directory list for file FILENAME.
151 (while (and dirs
(not found
))
152 (setq temp
(expand-file-name filename
(car dirs
)))
154 (expand-file-name (downcase filename
) (car dirs
)))
155 ;; Try several variants of specified name.
160 (if (file-exists-p (concat temp
(car x
)))
163 (throw 'foundit nil
)))
164 (if (file-exists-p (concat temp-downcase
(car x
)))
166 (setq found temp-downcase
)
167 (throw 'foundit nil
)))))
169 (setq dirs
(cdr dirs
)))))
171 (setq filename found
)
172 (error "Info file %s does not exist" filename
))))
173 ;; Record the node we are leaving.
174 (if (and Info-current-file
(not no-going-back
))
176 (cons (list Info-current-file Info-current-node
(point))
178 ;; Go into info buffer.
179 (switch-to-buffer "*info*")
180 (buffer-disable-undo (current-buffer))
181 (or (eq major-mode
'Info-mode
)
184 (setq Info-current-node nil
)
187 ;; Switch files if necessary
189 (equal Info-current-file filename
)
190 (let ((buffer-read-only nil
))
191 (setq Info-current-file nil
192 Info-current-subfile nil
193 Info-index-alternatives nil
194 buffer-file-name nil
)
198 (info-insert-file-contents filename t
)
199 (setq default-directory
(file-name-directory filename
)))
200 (set-buffer-modified-p nil
)
201 ;; See whether file has a tag table. Record the location if yes.
202 (set-marker Info-tag-table-marker nil
)
203 (goto-char (point-max))
205 (or (equal nodename
"*")
206 (not (search-forward "\^_\nEnd tag table\n" nil t
))
208 ;; We have a tag table. Find its beginning.
209 ;; Is this an indirect file?
210 (search-backward "\nTag table:\n")
214 (looking-at "(Indirect)\n"))
215 ;; It is indirect. Copy it to another buffer
216 ;; and record that the tag table is in that buffer.
218 (let ((buf (current-buffer)))
219 (set-buffer (get-buffer-create " *info tag table*"))
220 (buffer-disable-undo (current-buffer))
221 (setq case-fold-search t
)
223 (insert-buffer-substring buf
)
224 (set-marker Info-tag-table-marker
226 (set-marker Info-tag-table-marker pos
))))
227 (setq Info-current-file
228 (if (eq filename t
) "dir"
229 (file-name-sans-versions buffer-file-name
)))))
230 (if (equal nodename
"*")
231 (progn (setq Info-current-node nodename
)
232 (Info-set-mode-line))
233 ;; Search file for a suitable node.
234 (let ((guesspos (point-min))
235 (regexp (concat "Node: *" (regexp-quote nodename
) " *[,\t\n\177]")))
236 ;; First get advice from tag table if file has one.
237 ;; Also, if this is an indirect info file,
238 ;; read the proper subfile into this buffer.
239 (if (marker-position Info-tag-table-marker
)
241 (set-buffer (marker-buffer Info-tag-table-marker
))
242 (goto-char Info-tag-table-marker
)
243 (if (re-search-forward regexp nil t
)
245 (setq guesspos
(read (current-buffer)))
246 ;; If this is an indirect file,
247 ;; determine which file really holds this node
249 (if (not (eq (current-buffer) (get-buffer "*info*")))
251 (Info-read-subfile guesspos
))))
252 (error "No such node: \"%s\"" nodename
))))
253 (goto-char (max (point-min) (- guesspos
1000)))
254 ;; Now search from our advised position (or from beg of buffer)
255 ;; to find the actual node.
257 (while (search-forward "\n\^_" nil t
)
261 (if (re-search-backward regexp beg t
)
263 (error "No such node: %s" nodename
)))
265 ;; If we did not finish finding the specified node,
266 ;; go back to the previous one.
267 (or Info-current-node no-going-back
268 (let ((hist (car Info-history
)))
269 (setq Info-history
(cdr Info-history
))
270 (Info-find-node (nth 0 hist
) (nth 1 hist
) t
)
271 (goto-char (nth 2 hist
)))))
272 (goto-char (point-min)))
274 ;; Cache the contents of the (virtual) dir file, once we have merged
275 ;; it for the first time, so we can save time subsequently.
276 (defvar Info-dir-contents nil
)
278 ;; Cache for the directory we decided to use for the default-directory
279 ;; of the merged dir text.
280 (defvar Info-dir-contents-directory nil
)
282 ;; Record the file attributes of all the files from which we
283 ;; constructed Info-dir-contents.
284 (defvar Info-dir-file-attributes nil
)
286 ;; Construct the Info directory node by merging the files named `dir'
287 ;; from various directories. Set the *info* buffer's
288 ;; default-directory to the first directory we actually get any text
290 (defun Info-insert-dir ()
291 (if (and Info-dir-contents Info-dir-file-attributes
292 ;; Verify that none of the files we used has changed
295 (mapcar '(lambda (elt)
297 (file-attributes (car elt
))))
298 Info-dir-file-attributes
))))
299 (insert Info-dir-contents
)
300 (let ((dirs Info-directory-list
)
301 buffers buffer others nodes dirs-done
)
303 ;; Search the directory list for the directory file.
305 (or (member (file-truename (expand-file-name (car dirs
))) dirs-done
)
306 (member (directory-file-name (file-truename (expand-file-name (car dirs
))))
308 ;; Try several variants of specified name.
309 ;; Try upcasing, appending `.info', or both.
313 ((progn (setq temp
(expand-file-name "DIR" (car dirs
)))
314 (file-exists-p temp
))
315 (find-file-noselect temp
))
316 ((progn (setq temp
(expand-file-name "dir" (car dirs
)))
317 (file-exists-p temp
))
318 (find-file-noselect temp
))
319 ((progn (setq temp
(expand-file-name "DIR.INFO" (car dirs
)))
320 (file-exists-p temp
))
321 (find-file-noselect temp
))
322 ((progn (setq temp
(expand-file-name "dir.info" (car dirs
)))
323 (file-exists-p temp
))
324 (find-file-noselect temp
)))))
326 (cons (file-truename (expand-file-name (car dirs
)))
327 (cons (directory-file-name
328 (file-truename (expand-file-name (car dirs
))))
330 (if buffer
(setq buffers
(cons buffer buffers
)
331 Info-dir-file-attributes
332 (cons (cons (buffer-file-name buffer
)
333 (file-attributes (buffer-file-name buffer
)))
334 Info-dir-file-attributes
)))))
335 (setq dirs
(cdr dirs
)))
337 ;; Distinguish the dir file that comes with Emacs from all the
338 ;; others. Yes, that is really what this is supposed to do.
339 ;; If it doesn't work, fix it.
340 (setq buffer
(car buffers
)
341 others
(cdr buffers
))
343 ;; Insert the entire original dir file as a start; use its
344 ;; default directory as the default directory for the whole
346 (insert-buffer buffer
)
347 (setq Info-dir-contents-directory
(save-excursion
351 ;; Look at each of the other buffers one by one.
353 (let ((other (car others
)))
354 ;; In each, find all the menus.
357 (goto-char (point-min))
358 ;; Find each menu, and add an elt to NODES for it.
359 (while (re-search-forward "^\\* Menu:" nil t
)
360 (let (beg nodename end
)
363 (search-backward "\n\x1f")
364 (search-forward "Node: ")
365 (setq nodename
(Info-following-node-name))
366 (search-forward "\n\x1f" nil
'move
)
369 (setq nodes
(cons (list nodename other beg end
) nodes
))))))
370 (setq others
(cdr others
)))
371 ;; Add to the main menu a menu item for each other node.
372 (re-search-forward "^\\* Menu:")
374 (let ((menu-items '("top"))
377 (end (save-excursion (search-forward "\x1f" nil t
) (point))))
379 (let ((nodename (car (car nodes
))))
380 (or (member (downcase nodename
) menu-items
)
381 (re-search-forward (concat "^\\* " (regexp-quote nodename
) ":")
384 (insert "* " nodename
"\n")
385 (setq menu-items
(cons nodename menu-items
)))))
386 (setq nodes
(cdr nodes
))))
387 ;; Now take each node of each of the other buffers
388 ;; and merge it into the main buffer.
390 (let ((nodename (car (car nodes
))))
391 (goto-char (point-min))
392 ;; Find the like-named node in the main buffer.
393 (if (re-search-forward (concat "\n\x1f.*\n.*Node: "
394 (regexp-quote nodename
)
398 (search-forward "\n\x1f" nil
'move
)
400 ;; If none exists, add one.
401 (goto-char (point-max))
402 (insert "\x1f\nFile: dir\tnode: " nodename
"\n\n* Menu:\n\n"))
403 ;; Merge the text from the other buffer's menu
404 ;; into the menu in the like-named node in the main buffer.
405 (apply 'insert-buffer-substring
(cdr (car nodes
)))
407 (setq nodes
(cdr nodes
)))
408 ;; Kill all the buffers we just made.
410 (kill-buffer (car buffers
))
411 (setq buffers
(cdr buffers
))))
412 (setq Info-dir-contents
(buffer-string)))
413 (setq default-directory Info-dir-contents-directory
))
415 (defun Info-read-subfile (nodepos)
416 (set-buffer (marker-buffer Info-tag-table-marker
))
417 (goto-char (point-min))
418 (search-forward "\n\^_")
423 (while (not (looking-at "\^_"))
426 thisfilepos thisfilename
)
427 (search-forward ": ")
428 (setq thisfilename
(buffer-substring beg
(- (point) 2)))
429 (setq thisfilepos
(read (current-buffer)))
430 ;; read in version 19 stops at the end of number.
431 ;; Advance to the next line.
433 (if (> thisfilepos nodepos
)
435 (setq lastfilename thisfilename
)
436 (setq lastfilepos thisfilepos
))
438 (set-buffer (get-buffer "*info*"))
439 (or (equal Info-current-subfile lastfilename
)
440 (let ((buffer-read-only nil
))
441 (setq buffer-file-name nil
)
444 (info-insert-file-contents lastfilename
)
445 (set-buffer-modified-p nil
)
446 (setq Info-current-subfile lastfilename
)))
447 (goto-char (point-min))
448 (search-forward "\n\^_")
449 (+ (- nodepos lastfilepos
) (point))))
451 ;; Select the info node that point is in.
452 (defun Info-select-node ()
454 ;; Find beginning of node.
455 (search-backward "\n\^_")
457 ;; Get nodename spelled as it is in the node.
458 (re-search-forward "Node:[ \t]*")
459 (setq Info-current-node
460 (buffer-substring (point)
462 (skip-chars-forward "^,\t\n")
465 ;; Find the end of it, and narrow.
467 (let (active-expression)
468 (narrow-to-region (point)
469 (if (re-search-forward "\n[\^_\f]" nil t
)
472 (if (looking-at "[\n\^_\f]*execute: ")
474 (goto-char (match-end 0))
475 (setq active-expression
476 (read (current-buffer))))))
478 (if Info-enable-active-nodes
(eval active-expression
))
479 (run-hooks 'Info-selection-hook
))))
481 (defun Info-set-mode-line ()
482 (setq mode-line-buffer-identification
485 (if Info-current-file
486 (file-name-nondirectory Info-current-file
)
489 (or Info-current-node
""))))
491 ;; Go to an info node specified with a filename-and-nodename string
492 ;; of the sort that is found in pointers in nodes.
494 (defun Info-goto-node (nodename)
495 "Go to info node named NAME. Give just NODENAME or (FILENAME)NODENAME."
496 (interactive "sGoto node: ")
498 (string-match "\\s *\\((\\s *\\([^\t)]*\\)\\s *)\\s *\\|\\)\\(.*\\)"
500 (setq filename
(if (= (match-beginning 1) (match-end 1))
502 (substring nodename
(match-beginning 2) (match-end 2)))
503 nodename
(substring nodename
(match-beginning 3) (match-end 3)))
504 (let ((trim (string-match "\\s *\\'" filename
)))
505 (if trim
(setq filename
(substring filename
0 trim
))))
506 (let ((trim (string-match "\\s *\\'" nodename
)))
507 (if trim
(setq nodename
(substring nodename
0 trim
))))
508 (Info-find-node (if (equal filename
"") nil filename
)
509 (if (equal nodename
"") "Top" nodename
))))
511 (defun Info-restore-point (hl)
512 "If this node has been visited, restore the point value when we left."
514 (if (and (equal (nth 0 (car hl
)) Info-current-file
)
515 (equal (nth 1 (car hl
)) Info-current-node
))
516 (goto-char (nth 2 (car hl
)))
517 (Info-restore-point (cdr hl
)))))
519 (defvar Info-last-search nil
520 "Default regexp for \\<Info-mode-map>\\[Info-search] command to search for.")
522 (defun Info-search (regexp)
523 "Search for REGEXP, starting from point, and select node it's found in."
524 (interactive "sSearch (regexp): ")
525 (if (equal regexp
"")
526 (setq regexp Info-last-search
)
527 (setq Info-last-search regexp
))
528 (let ((found ()) current
529 (onode Info-current-node
)
530 (ofile Info-current-file
)
532 (osubfile Info-current-subfile
))
536 (if (null Info-current-subfile
)
537 (progn (re-search-forward regexp
) (setq found
(point)))
539 (progn (re-search-forward regexp
) (setq found
(point)))
540 (search-failed nil
)))))
541 (if (not found
) ;can only happen in subfile case -- else would have erred
544 (set-buffer (marker-buffer Info-tag-table-marker
))
545 (goto-char (point-min))
546 (search-forward "\n\^_\nIndirect:")
548 (narrow-to-region (point)
549 (progn (search-forward "\n\^_")
551 (goto-char (point-min))
552 (search-forward (concat "\n" osubfile
": "))
555 (re-search-forward "\\(^.*\\): [0-9]+$")
556 (goto-char (+ (match-end 1) 2))
557 (setq list
(cons (cons (read (current-buffer))
558 (buffer-substring (match-beginning 1)
561 (goto-char (1+ (match-end 0))))
562 (setq list
(nreverse list
)
563 current
(car (car list
))
566 (message "Searching subfile %s..." (cdr (car list
)))
567 (Info-read-subfile (car (car list
)))
568 (setq list
(cdr list
))
569 (goto-char (point-min))
570 (if (re-search-forward regexp nil t
)
571 (setq found
(point) list
())))
574 (signal 'search-failed
(list regexp
))))
576 (progn (Info-read-subfile opoint
)
578 (Info-select-node)))))
582 (or (and (equal onode Info-current-node
)
583 (equal ofile Info-current-file
))
584 (setq Info-history
(cons (list ofile onode opoint
)
587 ;; Extract the value of the node-pointer named NAME.
588 ;; If there is none, use ERRORNAME in the error message;
589 ;; if ERRORNAME is nil, just return nil.
590 (defun Info-extract-pointer (name &optional errorname
)
592 (goto-char (point-min))
594 (if (re-search-backward (concat name
":") nil t
)
596 (goto-char (match-end 0))
597 (Info-following-node-name))
600 (error (concat "Node has no " (capitalize (or errorname name
))))))))
602 ;; Return the node name in the buffer following point.
603 ;; ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
604 ;; saying which chas may appear in the node name.
605 (defun Info-following-node-name (&optional allowedchars
)
606 (skip-chars-forward " \t")
610 (while (looking-at (concat "[" (or allowedchars
"^,\t\n") "]"))
611 (skip-chars-forward (concat (or allowedchars
"^,\t\n") "("))
613 (skip-chars-forward "^)")))
614 (skip-chars-backward " ")
618 "Go to the next node of this node."
620 (Info-goto-node (Info-extract-pointer "next")))
623 "Go to the previous node of this node."
625 (Info-goto-node (Info-extract-pointer "prev[ious]*" "previous")))
628 "Go to the superior node of this node."
630 (Info-goto-node (Info-extract-pointer "up"))
631 (Info-restore-point Info-history
))
634 "Go back to the last node visited."
637 (error "This is the first Info node you looked at"))
638 (let (filename nodename opoint
)
639 (setq filename
(car (car Info-history
)))
640 (setq nodename
(car (cdr (car Info-history
))))
641 (setq opoint
(car (cdr (cdr (car Info-history
)))))
642 (setq Info-history
(cdr Info-history
))
643 (Info-find-node filename nodename
)
644 (setq Info-history
(cdr Info-history
))
647 (defun Info-directory ()
648 "Go to the Info directory node."
650 (Info-find-node "dir" "top"))
652 (defun Info-follow-reference (footnotename)
653 "Follow cross reference named NAME to the node it refers to.
654 NAME may be an abbreviation of the reference name."
656 (let ((completion-ignore-case t
)
657 completions default
(start-point (point)) str i
)
659 (goto-char (point-min))
660 (while (re-search-forward "\\*note[ \n\t]*\\([^:]*\\):" nil t
)
661 (setq str
(buffer-substring
664 ;; See if this one should be the default.
666 (< (match-beginning 0) start-point
)
667 (<= start-point
(point))
670 (while (setq i
(string-match "[ \n\t]+" str i
))
671 (setq str
(concat (substring str
0 i
) " "
672 (substring str
(match-end 0))))
674 ;; Record as a completion and perhaps as default.
675 (if (eq default t
) (setq default str
))
680 (let ((input (completing-read (if default
681 (concat "Follow reference named: ("
683 "Follow reference named: ")
685 (list (if (equal input
"")
687 (error "No cross-references in this node"))))
688 (let (target beg i
(str (concat "\\*note " footnotename
)))
689 (while (setq i
(string-match " " str i
))
690 (setq str
(concat (substring str
0 i
) "[ \t\n]+" (substring str
(1+ i
))))
693 (goto-char (point-min))
694 (or (re-search-forward str nil t
)
695 (error "No cross-reference named %s" footnotename
))
696 (goto-char (+ (match-beginning 0) 5))
698 (Info-extract-menu-node-name "Bad format cross reference" t
)))
699 (while (setq i
(string-match "[ \t\n]+" target i
))
700 (setq target
(concat (substring target
0 i
) " "
701 (substring target
(match-end 0))))
703 (Info-goto-node target
)))
705 (defun Info-extract-menu-node-name (&optional errmessage multi-line
)
706 (skip-chars-forward " \t\n")
709 (skip-chars-forward "^:")
713 (buffer-substring beg
(1- (point)))
714 (skip-chars-forward " \t\n")
715 (Info-following-node-name (if multi-line
"^.,\t" "^.,\t\n"))))
716 (while (setq i
(string-match "\n" str i
))
720 ;; No one calls this and Info-menu-item doesn't exist.
721 ;;(defun Info-menu-item-sequence (list)
723 ;; (Info-menu-item (car list))
724 ;; (setq list (cdr list))))
726 (defun Info-menu (menu-item)
727 "Go to node for menu item named (or abbreviated) NAME.
728 Completion is allowed, and the menu item point is on is the default."
730 (let ((completions '())
731 ;; If point is within a menu item, use that item as the default
736 (goto-char (point-min))
737 (if (not (search-forward "\n* menu:" nil t
))
738 (error "No menu in this node"))
739 (while (re-search-forward
740 "\n\\* \\([^:\t\n]*\\):" nil t
)
741 (if (and (null default
)
742 (prog1 (if last
(< last p
) nil
)
743 (setq last
(match-beginning 0)))
745 (setq default
(car (car completions
))))
746 (setq completions
(cons (cons (buffer-substring
751 (if (and (null default
) last
753 (<= p
(progn (end-of-line) (point))))
754 (setq default
(car (car completions
)))))
757 (setq item
(let ((completion-ignore-case t
))
758 (completing-read (if default
759 (format "Menu item (default %s): "
763 ;; we rely on the fact that completing-read accepts an input
764 ;; of "" even when the require-match argument is true and ""
765 ;; is not a valid possibility
766 (if (string= item
"")
772 ;; there is a problem here in that if several menu items have the same
773 ;; name you can only go to the node of the first with this command.
774 (Info-goto-node (Info-extract-menu-item menu-item
)))
776 (defun Info-extract-menu-item (menu-item)
777 (setq menu-item
(regexp-quote menu-item
))
779 (goto-char (point-min))
780 (or (search-forward "\n* menu:" nil t
)
781 (error "No menu in this node"))
782 (or (re-search-forward (concat "\n* " menu-item
":") nil t
)
783 (re-search-forward (concat "\n* " menu-item
) nil t
)
784 (error "No such item in menu"))
787 (Info-extract-menu-node-name)))
789 ;; If COUNT is nil, use the last item in the menu.
790 (defun Info-extract-menu-counting (count)
792 (goto-char (point-min))
793 (or (search-forward "\n* menu:" nil t
)
794 (error "No menu in this node"))
796 (or (search-forward "\n* " nil t count
)
797 (error "Too few items in menu"))
798 (while (search-forward "\n* " nil t
)
800 (Info-extract-menu-node-name)))
802 (defun Info-nth-menu-item ()
803 "Go to the node of the Nth menu item.
804 N is the digit argument used to invoke this command."
807 (Info-extract-menu-counting
808 (- (aref (this-command-keys) (1- (length (this-command-keys)))) ?
0))))
810 (defun Info-top-node ()
811 "Go to the Top node of this file."
813 (Info-goto-node "Top"))
815 (defun Info-final-node ()
816 "Go to the final node in this file."
818 (Info-goto-node "Top")
820 ;; Go to the last node in the menu of Top.
821 (Info-goto-node (Info-extract-menu-counting nil
))
822 ;; If the last node in the menu is not last in pointer structure,
823 ;; move forward until we can't go any farther.
824 (while (Info-forward-node t t
) nil
)
825 ;; Then keep moving down to last subnode, unless we reach an index.
826 (while (and (not (string-match "\\<index\\>" Info-current-node
))
827 (save-excursion (search-forward "\n* Menu:" nil t
)))
828 (Info-goto-node (Info-extract-menu-counting nil
)))))
830 (defun Info-forward-node (&optional not-down no-error
)
831 "Go forward one node, considering all nodes as forming one sequence."
833 (goto-char (point-min))
835 ;; three possibilities, in order of priority:
836 ;; 1. next node is in a menu in this node (but not in an index)
837 ;; 2. next node is next at same level
838 ;; 3. next node is up and next
839 (cond ((and (not not-down
)
840 (save-excursion (search-forward "\n* menu:" nil t
))
841 (not (string-match "\\<index\\>" Info-current-node
)))
842 (Info-goto-node (Info-extract-menu-counting 1))
844 ((save-excursion (search-backward "next:" nil t
))
847 ((and (save-excursion (search-backward "up:" nil t
))
848 (not (equal (downcase (Info-extract-pointer "up")) "top")))
849 (let ((old-node Info-current-node
))
851 (let (Info-history success
)
853 (setq success
(Info-forward-node t no-error
))
854 (or success
(Info-goto-node old-node
))))))
856 (t (error "No pointer forward from this node"))))
858 (defun Info-backward-node ()
859 "Go backward one node, considering all nodes as forming one sequence."
861 (let ((prevnode (Info-extract-pointer "prev[ious]*" t
))
862 (upnode (Info-extract-pointer "up" t
)))
863 (cond ((and upnode
(string-match "(" upnode
))
864 (error "First node in file"))
865 ((and upnode
(or (null prevnode
)
866 (equal (downcase prevnode
) (downcase upnode
))))
869 ;; If we move back at the same level,
870 ;; go down to find the last subnode*.
873 (while (and (not (string-match "\\<index\\>" Info-current-node
))
874 (save-excursion (search-forward "\n* Menu:" nil t
)))
875 (Info-goto-node (Info-extract-menu-counting nil
)))))
877 (error "No pointer backward from this node")))))
880 "Exit Info by selecting some other buffer."
882 (switch-to-buffer (prog1 (other-buffer (current-buffer))
883 (bury-buffer (current-buffer)))))
885 (defun Info-next-menu-item ()
889 (search-forward "\n* menu:" nil t
)
890 (or (search-forward "\n* " nil t
)
891 (error "No more items in menu"))
892 (Info-goto-node (Info-extract-menu-node-name))))
894 (defun Info-last-menu-item ()
898 (search-backward "\n* menu:" nil t
)
899 (or (search-backward "\n* " nil t
)
900 (error "No previous items in menu"))
901 (Info-goto-node (Info-extract-menu-node-name))))
903 (defmacro no-error
(&rest body
)
904 (list 'condition-case nil
(cons 'progn
(append body
'(t))) '(error nil
)))
906 (defun Info-next-preorder ()
907 "Go to the next node, popping up a level if there is none."
909 (cond ((no-error (Info-next-menu-item)) )
910 ((no-error (Info-up)) (forward-line 1))
911 (t (error "No more nodes"))))
913 (defun Info-last-preorder ()
914 "Go to the last node, popping up a level if there is none."
916 (cond ((no-error (Info-last-menu-item)) )
917 ((no-error (Info-up)) (forward-line -
1))
918 (t (error "No previous nodes"))))
920 (defun Info-scroll-up ()
921 "Read the next screen. If end of buffer is visible, go to next entry."
923 (if (pos-visible-in-window-p (point-max))
928 (defun Info-scroll-down ()
929 "Read the previous screen. If start of buffer is visible, go to last entry."
931 (if (pos-visible-in-window-p (point-min))
936 (defun Info-index (topic)
937 "Look up a string in the index for this file.
938 The index is defined as the first node in the top-level menu whose
939 name contains the word \"Index\", plus any immediately following
940 nodes whose names also contain the word \"Index\".
941 If there are no exact matches to the specified topic, this chooses
942 the first match which is a case-insensitive substring of a topic.
943 Use the `,' command to see the other matches.
944 Give a blank topic name to go to the Index node itself."
945 (interactive "sIndex topic: ")
946 (let ((orignode Info-current-node
)
948 (pattern (format "\n\\* \\([^\n:]*%s[^\n:]*\\):[ \t]*\\([^.\n]*\\)\\.[ t]*\\([0-9]*\\)"
949 (regexp-quote topic
)))
951 (Info-goto-node "Top")
952 (or (search-forward "\n* menu:" nil t
)
954 (or (re-search-forward "\n\\* \\(.*\\<Index\\>\\)" nil t
)
956 (goto-char (match-beginning 1))
957 (let ((Info-keeping-history nil
))
958 (Info-goto-node (Info-extract-menu-node-name)))
962 (Info-keeping-history nil
)
966 (goto-char (point-min))
967 (while (re-search-forward pattern nil t
)
969 (cons (list (buffer-substring (match-beginning 1)
971 (buffer-substring (match-beginning 2)
974 (string-to-int (concat "0"
979 (and (setq node
(Info-extract-pointer "next" t
))
980 (string-match "\\<Index\\>" node
)))
981 (Info-goto-node node
))
985 (error "No \"%s\" in index" topic
)))
986 ;; Here it is a feature that assoc is case-sensitive.
987 (while (setq found
(assoc topic matches
))
988 (setq exact
(cons found exact
)
989 matches
(delq found matches
)))
990 (setq Info-index-alternatives
(nconc exact
(nreverse matches
)))
991 (Info-index-next 0)))))
993 (defun Info-index-next (num)
994 "Go to the next matching index item from the last `i' command."
996 (or Info-index-alternatives
997 (error "No previous `i' command in this file"))
999 (setq num
(+ num
(length Info-index-alternatives
))))
1001 (setq Info-index-alternatives
1002 (nconc (cdr Info-index-alternatives
)
1003 (list (car Info-index-alternatives
)))
1005 (Info-goto-node (nth 1 (car Info-index-alternatives
)))
1006 (if (> (nth 3 (car Info-index-alternatives
)) 0)
1007 (forward-line (nth 3 (car Info-index-alternatives
)))
1008 (forward-line 3) ; don't search in headers
1009 (let ((name (car (car Info-index-alternatives
))))
1010 (if (or (re-search-forward (format
1011 "\\(Function\\|Command\\): %s\\( \\|$\\)"
1012 (regexp-quote name
)) nil t
)
1013 (search-forward (format "`%s'" name
) nil t
)
1014 (and (string-match "\\`.*\\( (.*)\\)\\'" name
)
1016 (format "`%s'" (substring name
0 (match-beginning 1)))
1018 (search-forward name nil t
))
1020 (goto-char (point-min)))))
1021 (message "Found \"%s\" in %s. %s"
1022 (car (car Info-index-alternatives
))
1023 (nth 2 (car Info-index-alternatives
))
1024 (if (cdr Info-index-alternatives
)
1025 "(Press `,' for more)"
1028 (defun Info-undefined ()
1029 "Make command be undefined in Info."
1034 "Enter the Info tutorial."
1036 (delete-other-windows)
1037 (Info-find-node "info"
1038 (if (< (window-height) 23)
1042 (defun Info-summary ()
1043 "Display a brief summary of all Info commands."
1045 (save-window-excursion
1046 (switch-to-buffer "*Help*")
1048 (insert (documentation 'Info-mode
))
1049 (goto-char (point-min))
1051 (while (progn (setq flag
(not (pos-visible-in-window-p (point-max))))
1052 (message (if flag
"Type Space to see more"
1053 "Type Space to return to Info"))
1054 (if (not (eq ?\
(setq ch
(read-event))))
1055 (progn (setq unread-command-events
(list ch
)) nil
)
1059 (defun Info-get-token (pos start all
&optional errorstring
)
1060 "Return the token around POS,
1061 POS must be somewhere inside the token
1062 START is a regular expression which will match the
1063 beginning of the tokens delimited string
1064 ALL is a regular expression with a single
1065 parenthized subpattern which is the token to be
1066 returned. E.g. '{\(.*\)}' would return any string
1067 enclosed in braces around POS.
1068 SIG optional fourth argument, controls action on no match
1071 a string: signal an error, using that string."
1074 (re-search-backward start
(max (point-min) (- pos
200)) 'yes
)
1076 (while (and (re-search-forward all
(min (point-max) (+ pos
200)) 'yes
)
1077 (not (setq found
(and (<= (match-beginning 0) pos
)
1078 (> (match-end 0) pos
))))))
1079 (if (and found
(<= (match-beginning 0) pos
)
1080 (> (match-end 0) pos
))
1081 (buffer-substring (match-beginning 1) (match-end 1))
1082 (cond ((null errorstring
)
1088 (error "No %s around position %d" errorstring pos
)))))))
1090 (defun Info-follow-nearest-node (click)
1091 "\\<Info-mode-map>Follow a node reference near point.
1092 Like \\[Info-menu], \\[Info-follow-reference], \\[Info-next], \\[Info-prev] or \\[Info-up] command, depending on where you click.
1093 At end of the node's text, moves to the next node."
1095 (let* ((start (event-start click
))
1096 (window (car start
))
1097 (pos (car (cdr start
))))
1098 (select-window window
)
1102 ((setq node
(Info-get-token (point) "\\*note[ \n]" "\\*note[ \n]\\([^:]*\\):"))
1103 (Info-follow-reference node
))
1104 ((setq node
(Info-get-token (point) "\\* " "\\* \\([^:]*\\)::"))
1105 (Info-goto-node node
))
1106 ((setq node
(Info-get-token (point) "\\* " "\\* \\([^:]*\\):"))
1108 ((setq node
(Info-get-token (point) "Up: " "Up: \\([^,\n\t]*\\)"))
1109 (Info-goto-node node
))
1110 ((setq node
(Info-get-token (point) "Next: " "Next: \\([^,\n\t]*\\)"))
1111 (Info-goto-node node
))
1112 ((setq node
(Info-get-token (point) "File: " "File: \\([^,\n\t]*\\)"))
1113 (Info-goto-node "Top"))
1114 ((setq node
(Info-get-token (point) "Prev: " "Prev: \\([^,\n\t]*\\)"))
1115 (Info-goto-node node
))
1116 ((save-excursion (forward-line 1) (eobp))
1120 (defvar Info-mode-map nil
1121 "Keymap containing Info commands.")
1124 (setq Info-mode-map
(make-keymap))
1125 (suppress-keymap Info-mode-map
)
1126 (define-key Info-mode-map
"." 'beginning-of-buffer
)
1127 (define-key Info-mode-map
" " 'Info-scroll-up
)
1128 (define-key Info-mode-map
"\C-m" 'Info-next-preorder
)
1129 (define-key Info-mode-map
"1" 'Info-nth-menu-item
)
1130 (define-key Info-mode-map
"2" 'Info-nth-menu-item
)
1131 (define-key Info-mode-map
"3" 'Info-nth-menu-item
)
1132 (define-key Info-mode-map
"4" 'Info-nth-menu-item
)
1133 (define-key Info-mode-map
"5" 'Info-nth-menu-item
)
1134 (define-key Info-mode-map
"6" 'Info-nth-menu-item
)
1135 (define-key Info-mode-map
"7" 'Info-nth-menu-item
)
1136 (define-key Info-mode-map
"8" 'Info-nth-menu-item
)
1137 (define-key Info-mode-map
"9" 'Info-nth-menu-item
)
1138 (define-key Info-mode-map
"0" 'undefined
)
1139 (define-key Info-mode-map
"?" 'Info-summary
)
1140 (define-key Info-mode-map
"]" 'Info-forward-node
)
1141 (define-key Info-mode-map
"[" 'Info-backward-node
)
1142 (define-key Info-mode-map
"<" 'Info-top-node
)
1143 (define-key Info-mode-map
">" 'Info-final-node
)
1144 (define-key Info-mode-map
"b" 'beginning-of-buffer
)
1145 (define-key Info-mode-map
"d" 'Info-directory
)
1146 (define-key Info-mode-map
"e" 'Info-edit
)
1147 (define-key Info-mode-map
"f" 'Info-follow-reference
)
1148 (define-key Info-mode-map
"g" 'Info-goto-node
)
1149 (define-key Info-mode-map
"h" 'Info-help
)
1150 (define-key Info-mode-map
"i" 'Info-index
)
1151 (define-key Info-mode-map
"l" 'Info-last
)
1152 (define-key Info-mode-map
"m" 'Info-menu
)
1153 (define-key Info-mode-map
"n" 'Info-next
)
1154 (define-key Info-mode-map
"p" 'Info-prev
)
1155 (define-key Info-mode-map
"q" 'Info-exit
)
1156 (define-key Info-mode-map
"s" 'Info-search
)
1157 (define-key Info-mode-map
"t" 'Info-top-node
)
1158 (define-key Info-mode-map
"u" 'Info-up
)
1159 (define-key Info-mode-map
"," 'Info-index-next
)
1160 (define-key Info-mode-map
"\177" 'Info-scroll-down
)
1161 (define-key Info-mode-map
[mouse-2
] 'Info-follow-nearest-node
)
1164 ;; Info mode is suitable only for specially formatted data.
1165 (put 'info-mode
'mode-class
'special
)
1169 Info mode provides commands for browsing through the Info documentation tree.
1170 Documentation in Info is divided into \"nodes\", each of which discusses
1171 one topic and contains references to other nodes which discuss related
1172 topics. Info has commands to follow the references and show you other nodes.
1174 \\[Info-help] Invoke the Info tutorial.
1176 Selecting other nodes:
1177 \\[Info-next] Move to the \"next\" node of this node.
1178 \\[Info-prev] Move to the \"previous\" node of this node.
1179 \\[Info-up] Move \"up\" from this node.
1180 \\[Info-menu] Pick menu item specified by name (or abbreviation).
1181 Picking a menu item causes another node to be selected.
1182 \\[Info-directory] Go to the Info directory node.
1183 \\[Info-follow-reference] Follow a cross reference. Reads name of reference.
1184 \\[Info-last] Move to the last node you were at.
1185 \\[Info-index] Look up a topic in this file's Index and move to that node.
1186 \\[Info-index-next] (comma) Move to the next match from a previous `i' command.
1188 Moving within a node:
1189 \\[scroll-up] Normally, scroll forward a full screen. If the end of the buffer is
1190 already visible, try to go to the next menu entry, or up if there is none.
1191 \\[scroll-down] Normally, scroll backward. If the beginning of the buffer is
1192 already visible, try to go to the previous menu entry, or up if there is none.
1193 \\[beginning-of-buffer] Go to beginning of node.
1196 \\[Info-exit] Quit Info: reselect previously selected buffer.
1197 \\[Info-edit] Edit contents of selected node.
1198 1 Pick first item in node's menu.
1199 2, 3, 4, 5 Pick second ... fifth item in node's menu.
1200 \\[Info-goto-node] Move to node specified by name.
1201 You may include a filename as well, as (FILENAME)NODENAME.
1202 \\[Info-search] Search through this Info file for specified regexp,
1203 and select the node in which the next occurrence is found.
1204 \\[Info-next-preorder] Next-preorder; that is, try to go to the next menu item,
1205 and if that fails try to move up, and if that fails, tell user
1206 he/she is done reading."
1207 (kill-all-local-variables)
1208 (setq major-mode
'Info-mode
)
1209 (setq mode-name
"Info")
1210 (use-local-map Info-mode-map
)
1211 (set-syntax-table text-mode-syntax-table
)
1212 (setq local-abbrev-table text-mode-abbrev-table
)
1213 (setq case-fold-search t
)
1214 (setq buffer-read-only t
)
1215 (make-local-variable 'Info-current-file
)
1216 (make-local-variable 'Info-current-subfile
)
1217 (make-local-variable 'Info-current-node
)
1218 (make-local-variable 'Info-tag-table-marker
)
1219 (make-local-variable 'Info-history
)
1220 (make-local-variable 'Info-index-alternatives
)
1221 (Info-set-mode-line)
1222 (run-hooks 'Info-mode-hook
))
1224 (defvar Info-edit-map nil
1225 "Local keymap used within `e' command of Info.")
1228 (setq Info-edit-map
(nconc (make-sparse-keymap) text-mode-map
))
1229 (define-key Info-edit-map
"\C-c\C-c" 'Info-cease-edit
))
1231 ;; Info-edit mode is suitable only for specially formatted data.
1232 (put 'info-edit-mode
'mode-class
'special
)
1234 (defun Info-edit-mode ()
1235 "Major mode for editing the contents of an Info node.
1236 Like text mode with the addition of `Info-cease-edit'
1237 which returns to Info mode for browsing.
1242 "Edit the contents of this Info node.
1243 Allowed only if variable `Info-enable-edit' is non-nil."
1245 (or Info-enable-edit
1246 (error "Editing info nodes is not enabled"))
1247 (use-local-map Info-edit-map
)
1248 (setq major-mode
'Info-edit-mode
)
1249 (setq mode-name
"Info Edit")
1250 (kill-local-variable 'mode-line-buffer-identification
)
1251 (setq buffer-read-only nil
)
1252 ;; Make mode line update.
1253 (set-buffer-modified-p (buffer-modified-p))
1254 (message (substitute-command-keys
1255 "Editing: Type \\<Info-mode-map>\\[Info-cease-edit] to return to info")))
1257 (defun Info-cease-edit ()
1258 "Finish editing Info node; switch back to Info proper."
1260 ;; Do this first, so nothing has changed if user C-g's at query.
1261 (and (buffer-modified-p)
1262 (y-or-n-p "Save the file? ")
1264 (use-local-map Info-mode-map
)
1265 (setq major-mode
'Info-mode
)
1266 (setq mode-name
"Info")
1267 (Info-set-mode-line)
1268 (setq buffer-read-only t
)
1269 ;; Make mode line update.
1270 (set-buffer-modified-p (buffer-modified-p))
1271 (and (marker-position Info-tag-table-marker
)
1273 (message "Tags may have changed. Use Info-tagify if necessary")))
1275 (defun Info-find-emacs-command-nodes (command)
1276 "Return a list of locations documenting COMMAND in the Emacs Info manual.
1277 The locations are of the format used in Info-history, i.e.
1278 \(FILENAME NODENAME BUFFERPOS\)."
1281 (cmd-desc (concat "^\\* " (regexp-quote (symbol-name command
))
1282 ":\\s *\\(.*\\)\\.$")))
1284 (Info-find-node "emacs" "Command Index")
1285 ;; Take the index node off the Info history.
1286 (setq Info-history
(cdr Info-history
))
1287 (goto-char (point-max))
1288 (while (re-search-backward cmd-desc nil t
)
1289 (setq where
(cons (list Info-current-file
1298 (defun Info-goto-emacs-command-node (command)
1299 "Go to the Info node in the Emacs manual for command COMMAND."
1300 (interactive "CFind documentation for command: ")
1301 (or (commandp command
)
1302 (signal 'wrong-type-argument
(list 'commandp command
)))
1303 (let ((where (Info-find-emacs-command-nodes command
)))
1305 (let ((num-matches (length where
)))
1306 ;; Get Info running, and pop to it in another window.
1307 (save-window-excursion
1309 (pop-to-buffer "*info*")
1310 (Info-find-node (car (car where
))
1311 (car (cdr (car where
))))
1312 (if (> num-matches
1)
1314 ;; Info-find-node already pushed (car where) onto
1315 ;; Info-history. Put the other nodes that were found on
1317 (setq Info-history
(nconc (cdr where
) Info-history
))
1318 (message (substitute-command-keys
1319 "Found %d other entr%. Use \\[Info-last] to see %s."
1321 (if (> num-matches
2) "ies" "y")
1322 (if (> num-matches
2) "them" "it"))))))
1323 (error "Couldn't find documentation for %s." command
))))
1326 (defun Info-goto-emacs-key-command-node (key)
1327 "Go to the Info node in the Emacs manual the command bound to KEY, a string.
1328 Interactively, if the binding is execute-extended-command, a command is read."
1329 (interactive "kFind documentation for key:")
1330 (let ((command (key-binding key
)))
1331 (cond ((null command
)
1332 (message "%s is undefined" (key-description key
)))
1333 ((and (interactive-p)
1334 (eq command
'execute-extended-command
))
1335 (Info-goto-emacs-command-node
1336 (read-command "Find documentation for command: ")))
1338 (Info-goto-emacs-command-node command
)))))
1342 ;;; info.el ends here