Mercurial > emacs
annotate lisp/info.el @ 1060:af78c65921c8
*** empty log message ***
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Mon, 31 Aug 1992 08:32:48 +0000 |
parents | 61c6983219ff |
children | aa286e6e7bec |
rev | line source |
---|---|
754
b096f4af925c
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
732
diff
changeset
|
1 ;;; info.el --- info package for Emacs. |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
2 |
846
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
3 ;; Copyright (C) 1985, 1986 Free Software Foundation, Inc. |
20674ae6bf52
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
811
diff
changeset
|
4 |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
5 ;; Maintainer: FSF |
811
e694e0879463
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
807
diff
changeset
|
6 ;; Keywords: help |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
7 |
325 | 8 ;; This file is part of GNU Emacs. |
9 | |
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 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
12 ;; the Free Software Foundation; either version 2, or (at your option) |
325 | 13 ;; any later version. |
14 | |
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. | |
19 | |
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. | |
23 | |
807
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
24 ;;; Commentary: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
25 |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
26 ;;; Note that nowadays we expect info files to be made using makeinfo. |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
27 |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
28 ;;; Code: |
4f28bd14272c
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
754
diff
changeset
|
29 |
325 | 30 (defvar Info-history nil |
31 "List of info nodes user has visited. | |
32 Each element of list is a list (FILENAME NODENAME BUFFERPOS).") | |
33 | |
34 (defvar Info-enable-edit nil | |
680
f99c8512cd41
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
660
diff
changeset
|
35 "*Non-nil means the \\<info-mode-map>\\[Info-edit] command in Info can edit the current node. |
f99c8512cd41
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
660
diff
changeset
|
36 This is convenient if you want to write info files by hand. |
f99c8512cd41
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
660
diff
changeset
|
37 However, we recommend that you not do this. |
f99c8512cd41
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
660
diff
changeset
|
38 It is better to write a Texinfo file and generate the Info file from that, |
f99c8512cd41
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
660
diff
changeset
|
39 because that gives you a printed manual as well.") |
325 | 40 |
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.") | |
44 | |
540 | 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 | |
48 in paths.el.") | |
49 | |
50 (defvar Info-directory-list nil | |
325 | 51 "List of directories to search for Info documentation files. |
540 | 52 nil means not yet initialized. In this case, Info uses the environment |
53 variable INFODIR to initialize it, or `Info-default-directory-list' | |
54 if there is no INFODIR variable in the environment.") | |
325 | 55 |
56 (defvar Info-current-file nil | |
57 "Info file that Info is now looking at, or nil.") | |
58 | |
59 (defvar Info-current-subfile nil | |
60 "Info subfile that is actually in the *info* buffer now, | |
61 or nil if current info file is not split into subfiles.") | |
62 | |
63 (defvar Info-current-node nil | |
64 "Name of node that Info is now looking at, or nil.") | |
65 | |
66 (defvar Info-tag-table-marker (make-marker) | |
67 "Marker pointing at beginning of current Info file's tag table. | |
68 Marker points nowhere if file has no tag table.") | |
69 | |
70 ;;;###autoload | |
71 (defun info (&optional file) | |
72 "Enter Info, the documentation browser. | |
73 Optional argument FILE specifies the file to examine; | |
74 the default is the top-level directory of Info. | |
75 | |
76 In interactive use, a prefix argument directs this command | |
77 to read a file name from the minibuffer." | |
78 (interactive (if current-prefix-arg | |
79 (list (read-file-name "Info file name: " nil nil t)))) | |
540 | 80 (or Info-directory-list |
81 (setq Info-directory-list | |
82 (let ((path (getenv "INFOPATH"))) | |
83 (if path | |
84 (let ((list nil) | |
85 idx) | |
86 (while (> (length path) 0) | |
87 (setq idx (or (string-match ":" path) (length path)) | |
88 list (cons (substring path 0 idx) list) | |
89 path (substring path (min (1+ idx) | |
90 (length path))))) | |
91 (nreverse list)) | |
92 Info-default-directory-list)))) | |
325 | 93 (if file |
94 (Info-goto-node (concat "(" file ")")) | |
95 (if (get-buffer "*info*") | |
96 (switch-to-buffer "*info*") | |
97 (Info-directory)))) | |
98 | |
99 ;; Go to an info node specified as separate filename and nodename. | |
100 ;; no-going-back is non-nil if recovering from an error in this function; | |
101 ;; it says do not attempt further (recursive) error recovery. | |
102 (defun Info-find-node (filename nodename &optional no-going-back) | |
103 ;; Convert filename to lower case if not found as specified. | |
104 ;; Expand it. | |
105 (if filename | |
106 (let (temp temp-downcase found) | |
107 (setq filename (substitute-in-file-name filename)) | |
108 (let ((dirs (if (string-match "^\\./" filename) | |
109 ;; If specified name starts with `./' | |
110 ;; then just try current directory. | |
111 '("./") | |
112 Info-directory-list))) | |
113 ;; Search the directory list for file FILENAME. | |
114 (while (and dirs (not found)) | |
115 (setq temp (expand-file-name filename (car dirs))) | |
116 (setq temp-downcase | |
117 (expand-file-name (downcase filename) (car dirs))) | |
118 ;; Try several variants of specified name. | |
119 ;; Try downcasing, appending `.info', or both. | |
120 (cond ((file-exists-p temp) | |
121 (setq found temp)) | |
122 ((file-exists-p temp-downcase) | |
123 (setq found temp-downcase)) | |
124 ((file-exists-p (concat temp ".info")) | |
125 (setq found (concat temp ".info"))) | |
126 ((file-exists-p (concat temp-downcase ".info")) | |
127 (setq found (concat temp-downcase ".info")))) | |
128 (setq dirs (cdr dirs)))) | |
129 (if found | |
130 (setq filename found) | |
131 (error "Info file %s does not exist" filename)))) | |
132 ;; Record the node we are leaving. | |
133 (if (and Info-current-file (not no-going-back)) | |
134 (setq Info-history | |
135 (cons (list Info-current-file Info-current-node (point)) | |
136 Info-history))) | |
137 ;; Go into info buffer. | |
138 (switch-to-buffer "*info*") | |
139 (buffer-flush-undo (current-buffer)) | |
140 (or (eq major-mode 'Info-mode) | |
141 (Info-mode)) | |
142 (widen) | |
143 (setq Info-current-node nil) | |
144 (unwind-protect | |
145 (progn | |
146 ;; Switch files if necessary | |
147 (or (null filename) | |
148 (equal Info-current-file filename) | |
149 (let ((buffer-read-only nil)) | |
150 (setq Info-current-file nil | |
151 Info-current-subfile nil | |
152 buffer-file-name nil) | |
153 (erase-buffer) | |
154 (insert-file-contents filename t) | |
155 (set-buffer-modified-p nil) | |
156 (setq default-directory (file-name-directory filename)) | |
157 ;; See whether file has a tag table. Record the location if yes. | |
158 (set-marker Info-tag-table-marker nil) | |
159 (goto-char (point-max)) | |
160 (forward-line -8) | |
161 (or (equal nodename "*") | |
162 (not (search-forward "\^_\nEnd tag table\n" nil t)) | |
163 (let (pos) | |
164 ;; We have a tag table. Find its beginning. | |
165 ;; Is this an indirect file? | |
166 (search-backward "\nTag table:\n") | |
167 (setq pos (point)) | |
168 (if (save-excursion | |
169 (forward-line 2) | |
170 (looking-at "(Indirect)\n")) | |
171 ;; It is indirect. Copy it to another buffer | |
172 ;; and record that the tag table is in that buffer. | |
173 (save-excursion | |
174 (let ((buf (current-buffer))) | |
175 (set-buffer (get-buffer-create " *info tag table*")) | |
176 (buffer-flush-undo (current-buffer)) | |
177 (setq case-fold-search t) | |
178 (erase-buffer) | |
179 (insert-buffer-substring buf) | |
180 (set-marker Info-tag-table-marker | |
181 (match-end 0)))) | |
998 | 182 (set-marker Info-tag-table-marker pos)))) |
325 | 183 (setq Info-current-file |
184 (file-name-sans-versions buffer-file-name)))) | |
185 (if (equal nodename "*") | |
186 (progn (setq Info-current-node nodename) | |
187 (Info-set-mode-line)) | |
188 ;; Search file for a suitable node. | |
990
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
189 (let ((guesspos (point-min)) |
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
190 (regexp (concat "Node: *" (regexp-quote nodename) " *[,\t\n\177]"))) |
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
191 ;; First get advice from tag table if file has one. |
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
192 ;; Also, if this is an indirect info file, |
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
193 ;; read the proper subfile into this buffer. |
325 | 194 (if (marker-position Info-tag-table-marker) |
195 (save-excursion | |
196 (set-buffer (marker-buffer Info-tag-table-marker)) | |
197 (goto-char Info-tag-table-marker) | |
990
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
198 (if (re-search-forward regexp nil t) |
325 | 199 (progn |
200 (setq guesspos (read (current-buffer))) | |
201 ;; If this is an indirect file, | |
202 ;; determine which file really holds this node | |
203 ;; and read it in. | |
204 (if (not (eq (current-buffer) (get-buffer "*info*"))) | |
205 (setq guesspos | |
206 (Info-read-subfile guesspos)))) | |
207 (error "No such node: \"%s\"" nodename)))) | |
990
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
208 (goto-char (max (point-min) (- guesspos 1000))) |
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
209 ;; Now search from our advised position (or from beg of buffer) |
d76731ebdff0
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
930
diff
changeset
|
210 ;; to find the actual node. |
325 | 211 (catch 'foo |
212 (while (search-forward "\n\^_" nil t) | |
213 (forward-line 1) | |
214 (let ((beg (point))) | |
215 (forward-line 1) | |
216 (if (re-search-backward regexp beg t) | |
217 (throw 'foo t)))) | |
218 (error "No such node: %s" nodename))) | |
219 (Info-select-node))) | |
220 ;; If we did not finish finding the specified node, | |
221 ;; go back to the previous one. | |
222 (or Info-current-node no-going-back | |
223 (let ((hist (car Info-history))) | |
224 (setq Info-history (cdr Info-history)) | |
225 (Info-find-node (nth 0 hist) (nth 1 hist) t) | |
226 (goto-char (nth 2 hist))))) | |
227 (goto-char (point-min))) | |
228 | |
229 (defun Info-read-subfile (nodepos) | |
230 (set-buffer (marker-buffer Info-tag-table-marker)) | |
231 (goto-char (point-min)) | |
232 (search-forward "\n\^_") | |
233 (let (lastfilepos | |
234 lastfilename) | |
235 (forward-line 2) | |
236 (catch 'foo | |
237 (while (not (looking-at "\^_")) | |
238 (if (not (eolp)) | |
239 (let ((beg (point)) | |
240 thisfilepos thisfilename) | |
241 (search-forward ": ") | |
242 (setq thisfilename (buffer-substring beg (- (point) 2))) | |
243 (setq thisfilepos (read (current-buffer))) | |
244 ;; read in version 19 stops at the end of number. | |
245 ;; Advance to the next line. | |
246 (forward-line 1) | |
247 (if (> thisfilepos nodepos) | |
248 (throw 'foo t)) | |
249 (setq lastfilename thisfilename) | |
250 (setq lastfilepos thisfilepos)) | |
251 (forward-line 1)))) | |
252 (set-buffer (get-buffer "*info*")) | |
253 (or (equal Info-current-subfile lastfilename) | |
254 (let ((buffer-read-only nil)) | |
255 (setq buffer-file-name nil) | |
256 (widen) | |
257 (erase-buffer) | |
258 (insert-file-contents lastfilename) | |
259 (set-buffer-modified-p nil) | |
260 (setq Info-current-subfile lastfilename))) | |
261 (goto-char (point-min)) | |
262 (search-forward "\n\^_") | |
263 (+ (- nodepos lastfilepos) (point)))) | |
264 | |
265 ;; Select the info node that point is in. | |
266 (defun Info-select-node () | |
267 (save-excursion | |
268 ;; Find beginning of node. | |
269 (search-backward "\n\^_") | |
270 (forward-line 2) | |
271 ;; Get nodename spelled as it is in the node. | |
272 (re-search-forward "Node:[ \t]*") | |
273 (setq Info-current-node | |
274 (buffer-substring (point) | |
275 (progn | |
276 (skip-chars-forward "^,\t\n") | |
277 (point)))) | |
278 (Info-set-mode-line) | |
279 ;; Find the end of it, and narrow. | |
280 (beginning-of-line) | |
281 (let (active-expression) | |
282 (narrow-to-region (point) | |
283 (if (re-search-forward "\n[\^_\f]" nil t) | |
284 (prog1 | |
285 (1- (point)) | |
286 (if (looking-at "[\n\^_\f]*execute: ") | |
287 (progn | |
288 (goto-char (match-end 0)) | |
289 (setq active-expression | |
290 (read (current-buffer)))))) | |
291 (point-max))) | |
292 (if Info-enable-active-nodes (eval active-expression))))) | |
293 | |
294 (defun Info-set-mode-line () | |
295 (setq mode-line-buffer-identification | |
296 (concat | |
297 "Info: (" | |
298 (if Info-current-file | |
299 (file-name-nondirectory Info-current-file) | |
300 "") | |
301 ")" | |
302 (or Info-current-node "")))) | |
303 | |
304 ;; Go to an info node specified with a filename-and-nodename string | |
305 ;; of the sort that is found in pointers in nodes. | |
306 | |
307 (defun Info-goto-node (nodename) | |
308 "Go to info node named NAME. Give just NODENAME or (FILENAME)NODENAME." | |
309 (interactive "sGoto node: ") | |
310 (let (filename) | |
311 (string-match "\\s *\\((\\s *\\([^\t)]*\\)\\s *)\\s *\\|\\)\\(.*\\)" | |
312 nodename) | |
313 (setq filename (if (= (match-beginning 1) (match-end 1)) | |
314 "" | |
315 (substring nodename (match-beginning 2) (match-end 2))) | |
316 nodename (substring nodename (match-beginning 3) (match-end 3))) | |
317 (let ((trim (string-match "\\s *\\'" filename))) | |
318 (if trim (setq filename (substring filename 0 trim)))) | |
319 (let ((trim (string-match "\\s *\\'" nodename))) | |
320 (if trim (setq nodename (substring nodename 0 trim)))) | |
321 (Info-find-node (if (equal filename "") nil filename) | |
322 (if (equal nodename "") "Top" nodename)))) | |
323 | |
540 | 324 (defun Info-restore-point (hl) |
325 "If this node has been visited, restore the point value when we left." | |
326 (if hl | |
327 (if (and (equal (nth 0 (car hl)) Info-current-file) | |
328 (equal (nth 1 (car hl)) Info-current-node)) | |
329 (goto-char (nth 2 (car hl))) | |
330 (Info-restore-point (cdr hl))))) | |
331 | |
929
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
332 (defun Info-restore-point (hl) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
333 "If this node has been visited, restore the point value when we left." |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
334 (if hl |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
335 (if (and (equal (nth 0 (car hl)) Info-current-file) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
336 (equal (nth 1 (car hl)) Info-current-node)) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
337 (goto-char (nth 2 (car hl))) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
338 (Info-restore-point (cdr hl))))) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
339 |
325 | 340 (defvar Info-last-search nil |
341 "Default regexp for \\<info-mode-map>\\[Info-search] command to search for.") | |
342 | |
343 (defun Info-search (regexp) | |
344 "Search for REGEXP, starting from point, and select node it's found in." | |
345 (interactive "sSearch (regexp): ") | |
346 (if (equal regexp "") | |
347 (setq regexp Info-last-search) | |
348 (setq Info-last-search regexp)) | |
349 (let ((found ()) current | |
350 (onode Info-current-node) | |
351 (ofile Info-current-file) | |
352 (opoint (point)) | |
353 (osubfile Info-current-subfile)) | |
354 (save-excursion | |
355 (save-restriction | |
356 (widen) | |
357 (if (null Info-current-subfile) | |
358 (progn (re-search-forward regexp) (setq found (point))) | |
359 (condition-case err | |
360 (progn (re-search-forward regexp) (setq found (point))) | |
361 (search-failed nil))))) | |
362 (if (not found) ;can only happen in subfile case -- else would have erred | |
363 (unwind-protect | |
364 (let ((list ())) | |
365 (set-buffer (marker-buffer Info-tag-table-marker)) | |
366 (goto-char (point-min)) | |
367 (search-forward "\n\^_\nIndirect:") | |
368 (save-restriction | |
369 (narrow-to-region (point) | |
370 (progn (search-forward "\n\^_") | |
371 (1- (point)))) | |
372 (goto-char (point-min)) | |
373 (search-forward (concat "\n" osubfile ": ")) | |
374 (beginning-of-line) | |
375 (while (not (eobp)) | |
376 (re-search-forward "\\(^.*\\): [0-9]+$") | |
377 (goto-char (+ (match-end 1) 2)) | |
378 (setq list (cons (cons (read (current-buffer)) | |
379 (buffer-substring (match-beginning 1) | |
380 (match-end 1))) | |
381 list)) | |
382 (goto-char (1+ (match-end 0)))) | |
383 (setq list (nreverse list) | |
384 current (car (car list)) | |
385 list (cdr list))) | |
386 (while list | |
387 (message "Searching subfile %s..." (cdr (car list))) | |
388 (Info-read-subfile (car (car list))) | |
389 (setq list (cdr list)) | |
390 (goto-char (point-min)) | |
391 (if (re-search-forward regexp nil t) | |
392 (setq found (point) list ()))) | |
393 (if found | |
394 (message "") | |
395 (signal 'search-failed (list regexp)))) | |
396 (if (not found) | |
397 (progn (Info-read-subfile opoint) | |
398 (goto-char opoint) | |
399 (Info-select-node))))) | |
400 (widen) | |
401 (goto-char found) | |
402 (Info-select-node) | |
403 (or (and (equal onode Info-current-node) | |
404 (equal ofile Info-current-file)) | |
405 (setq Info-history (cons (list ofile onode opoint) | |
406 Info-history))))) | |
407 | |
408 ;; Extract the value of the node-pointer named NAME. | |
409 ;; If there is none, use ERRORNAME in the error message; | |
410 ;; if ERRORNAME is nil, just return nil. | |
411 (defun Info-extract-pointer (name &optional errorname) | |
412 (save-excursion | |
413 (goto-char (point-min)) | |
414 (forward-line 1) | |
415 (if (re-search-backward (concat name ":") nil t) | |
416 (progn | |
417 (goto-char (match-end 0)) | |
418 (Info-following-node-name)) | |
419 (if (eq errorname t) | |
420 nil | |
421 (error (concat "Node has no " (capitalize (or errorname name)))))))) | |
422 | |
423 (defun Info-following-node-name (&optional allowedchars) | |
424 (skip-chars-forward " \t") | |
425 (buffer-substring | |
426 (point) | |
427 (progn | |
428 (while (looking-at (concat "[" (or allowedchars "^,\t\n") "]")) | |
429 (skip-chars-forward (concat (or allowedchars "^,\t\n") "(")) | |
430 (if (looking-at "(") | |
431 (skip-chars-forward "^)"))) | |
432 (skip-chars-backward " ") | |
433 (point)))) | |
434 | |
435 (defun Info-next () | |
436 "Go to the next node of this node." | |
437 (interactive) | |
438 (Info-goto-node (Info-extract-pointer "next"))) | |
439 | |
440 (defun Info-prev () | |
441 "Go to the previous node of this node." | |
442 (interactive) | |
443 (Info-goto-node (Info-extract-pointer "prev[ious]*" "previous"))) | |
444 | |
445 (defun Info-up () | |
446 "Go to the superior node of this node." | |
447 (interactive) | |
540 | 448 (Info-goto-node (Info-extract-pointer "up")) |
449 (Info-restore-point Info-history)) | |
325 | 450 |
451 (defun Info-last () | |
452 "Go back to the last node visited." | |
453 (interactive) | |
454 (or Info-history | |
455 (error "This is the first Info node you looked at")) | |
456 (let (filename nodename opoint) | |
457 (setq filename (car (car Info-history))) | |
458 (setq nodename (car (cdr (car Info-history)))) | |
459 (setq opoint (car (cdr (cdr (car Info-history))))) | |
460 (setq Info-history (cdr Info-history)) | |
461 (Info-find-node filename nodename) | |
462 (setq Info-history (cdr Info-history)) | |
463 (goto-char opoint))) | |
464 | |
465 (defun Info-directory () | |
466 "Go to the Info directory node." | |
467 (interactive) | |
468 (Info-find-node "dir" "top")) | |
469 | |
470 (defun Info-follow-reference (footnotename) | |
471 "Follow cross reference named NAME to the node it refers to. | |
472 NAME may be an abbreviation of the reference name." | |
473 (interactive | |
474 (let ((completion-ignore-case t) | |
475 completions default (start-point (point)) str i) | |
476 (save-excursion | |
477 (goto-char (point-min)) | |
478 (while (re-search-forward "\\*note[ \n\t]*\\([^:]*\\):" nil t) | |
479 (setq str (buffer-substring | |
480 (match-beginning 1) | |
481 (1- (point)))) | |
482 ;; See if this one should be the default. | |
483 (and (null default) | |
484 (< (match-beginning 0) start-point) | |
485 (<= start-point (point)) | |
486 (setq default t)) | |
487 (setq i 0) | |
488 (while (setq i (string-match "[ \n\t]+" str i)) | |
489 (setq str (concat (substring str 0 i) " " | |
490 (substring str (match-end 0)))) | |
491 (setq i (1+ i))) | |
492 ;; Record as a completion and perhaps as default. | |
493 (if (eq default t) (setq default str)) | |
494 (setq completions | |
495 (cons (cons str nil) | |
496 completions)))) | |
497 (if completions | |
498 (list (completing-read (if default | |
499 (concat "Follow reference named: (" | |
500 default ") ") | |
501 "Follow reference named: ") | |
502 completions default t)) | |
503 (error "No cross-references in this node")))) | |
504 (let (target beg i (str (concat "\\*note " footnotename))) | |
505 (while (setq i (string-match " " str i)) | |
506 (setq str (concat (substring str 0 i) "[ \t\n]+" (substring str (1+ i)))) | |
507 (setq i (+ i 6))) | |
508 (save-excursion | |
509 (goto-char (point-min)) | |
510 (or (re-search-forward str nil t) | |
511 (error "No cross-reference named %s" footnotename)) | |
512 (goto-char (+ (match-beginning 0) 5)) | |
513 (setq target | |
514 (Info-extract-menu-node-name "Bad format cross reference" t))) | |
515 (while (setq i (string-match "[ \t\n]+" target i)) | |
516 (setq target (concat (substring target 0 i) " " | |
517 (substring target (match-end 0)))) | |
518 (setq i (+ i 1))) | |
519 (Info-goto-node target))) | |
520 | |
521 (defun Info-extract-menu-node-name (&optional errmessage multi-line) | |
522 (skip-chars-forward " \t\n") | |
523 (let ((beg (point)) | |
524 str i) | |
525 (skip-chars-forward "^:") | |
526 (forward-char 1) | |
527 (setq str | |
528 (if (looking-at ":") | |
529 (buffer-substring beg (1- (point))) | |
530 (skip-chars-forward " \t\n") | |
531 (Info-following-node-name (if multi-line "^.,\t" "^.,\t\n")))) | |
532 (while (setq i (string-match "\n" str i)) | |
533 (aset str i ?\ )) | |
534 str)) | |
535 | |
536 (defun Info-menu-item-sequence (list) | |
537 (while list | |
538 (Info-menu-item (car list)) | |
539 (setq list (cdr list)))) | |
540 | |
541 (defun Info-menu (menu-item) | |
542 "Go to node for menu item named (or abbreviated) NAME. | |
543 Completion is allowed, and the menu item point is on is the default." | |
544 (interactive | |
545 (let ((completions '()) | |
546 ;; If point is within a menu item, use that item as the default | |
547 (default nil) | |
548 (p (point)) | |
549 (last nil)) | |
550 (save-excursion | |
551 (goto-char (point-min)) | |
552 (if (not (search-forward "\n* menu:" nil t)) | |
553 (error "No menu in this node")) | |
554 (while (re-search-forward | |
555 "\n\\* \\([^:\t\n]*\\):" nil t) | |
556 (if (and (null default) | |
557 (prog1 (if last (< last p) nil) | |
558 (setq last (match-beginning 0))) | |
559 (<= p last)) | |
560 (setq default (car (car completions)))) | |
561 (setq completions (cons (cons (buffer-substring | |
562 (match-beginning 1) | |
563 (match-end 1)) | |
564 (match-beginning 1)) | |
565 completions))) | |
566 (if (and (null default) last | |
567 (< last p) | |
568 (<= p (progn (end-of-line) (point)))) | |
569 (setq default (car (car completions))))) | |
570 (let ((item nil)) | |
571 (while (null item) | |
572 (setq item (let ((completion-ignore-case t)) | |
573 (completing-read (if default | |
574 (format "Menu item (default %s): " | |
575 default) | |
576 "Menu item: ") | |
577 completions nil t))) | |
540 | 578 ;; we rely on the fact that completing-read accepts an input |
579 ;; of "" even when the require-match argument is true and "" | |
580 ;; is not a valid possibility | |
325 | 581 (if (string= item "") |
582 (if default | |
583 (setq item default) | |
584 ;; ask again | |
585 (setq item nil)))) | |
586 (list item)))) | |
587 ;; there is a problem here in that if several menu items have the same | |
588 ;; name you can only go to the node of the first with this command. | |
589 (Info-goto-node (Info-extract-menu-item menu-item))) | |
590 | |
591 (defun Info-extract-menu-item (menu-item) | |
592 (setq menu-item (regexp-quote menu-item)) | |
593 (save-excursion | |
594 (goto-char (point-min)) | |
595 (or (search-forward "\n* menu:" nil t) | |
596 (error "No menu in this node")) | |
597 (or (re-search-forward (concat "\n* " menu-item ":") nil t) | |
598 (re-search-forward (concat "\n* " menu-item) nil t) | |
599 (error "No such item in menu")) | |
600 (beginning-of-line) | |
601 (forward-char 2) | |
602 (Info-extract-menu-node-name))) | |
603 | |
604 ;; If COUNT is nil, use the last item in the menu. | |
605 (defun Info-extract-menu-counting (count) | |
606 (save-excursion | |
607 (goto-char (point-min)) | |
608 (or (search-forward "\n* menu:" nil t) | |
609 (error "No menu in this node")) | |
610 (if count | |
611 (or (search-forward "\n* " nil t count) | |
612 (error "Too few items in menu")) | |
613 (while (search-forward "\n* " nil t) | |
614 nil)) | |
615 (Info-extract-menu-node-name))) | |
616 | |
617 (defun Info-first-menu-item () | |
618 "Go to the node of the first menu item." | |
619 (interactive) | |
620 (Info-goto-node (Info-extract-menu-counting 1))) | |
621 | |
622 (defun Info-second-menu-item () | |
623 "Go to the node of the second menu item." | |
624 (interactive) | |
625 (Info-goto-node (Info-extract-menu-counting 2))) | |
626 | |
627 (defun Info-third-menu-item () | |
628 "Go to the node of the third menu item." | |
629 (interactive) | |
630 (Info-goto-node (Info-extract-menu-counting 3))) | |
631 | |
632 (defun Info-fourth-menu-item () | |
633 "Go to the node of the fourth menu item." | |
634 (interactive) | |
635 (Info-goto-node (Info-extract-menu-counting 4))) | |
636 | |
637 (defun Info-fifth-menu-item () | |
638 "Go to the node of the fifth menu item." | |
639 (interactive) | |
640 (Info-goto-node (Info-extract-menu-counting 5))) | |
641 | |
642 (defun Info-top-node () | |
643 "Go to the Top node of this file." | |
644 (interactive) | |
645 (Info-goto-node "Top")) | |
646 | |
647 (defun Info-final-node () | |
648 "Go to the final node in this file." | |
649 (interactive) | |
650 (Info-goto-node "Top") | |
651 (let (Info-history) | |
652 ;; Go to the last node in the menu of Top. | |
653 (Info-goto-node (Info-extract-menu-counting nil)) | |
654 ;; If the last node in the menu is not last in pointer structure, | |
655 ;; move forward until we can't go any farther. | |
656 (while (Info-forward-node t t) nil) | |
657 ;; Then keep moving down to last subnode, unless we reach an index. | |
658 (while (and (not (string-match "\\<index\\>" Info-current-node)) | |
659 (save-excursion (search-forward "\n* Menu:" nil t))) | |
660 (Info-goto-node (Info-extract-menu-counting nil))))) | |
661 | |
662 (defun Info-forward-node (&optional not-down no-error) | |
663 "Go forward one node, considering all nodes as forming one sequence." | |
664 (interactive) | |
665 (goto-char (point-min)) | |
666 (forward-line 1) | |
667 ;; three possibilities, in order of priority: | |
668 ;; 1. next node is in a menu in this node (but not in an index) | |
669 ;; 2. next node is next at same level | |
670 ;; 3. next node is up and next | |
671 (cond ((and (not not-down) | |
672 (save-excursion (search-forward "\n* menu:" nil t)) | |
673 (not (string-match "\\<index\\>" Info-current-node))) | |
674 (Info-first-menu-item) | |
675 t) | |
676 ((save-excursion (search-backward "next:" nil t)) | |
677 (Info-next) | |
678 t) | |
679 ((and (save-excursion (search-backward "up:" nil t)) | |
680 (not (equal (downcase (Info-extract-pointer "up")) "top"))) | |
681 (let ((old-node Info-current-node)) | |
682 (Info-up) | |
683 (let (Info-history success) | |
684 (unwind-protect | |
685 (setq success (Info-forward-node t no-error)) | |
686 (or success (Info-goto-node old-node)))))) | |
687 (no-error nil) | |
688 (t (error "No pointer forward from this node")))) | |
689 | |
690 (defun Info-backward-node () | |
691 "Go backward one node, considering all nodes as forming one sequence." | |
692 (interactive) | |
693 (let ((prevnode (Info-extract-pointer "prev[ious]*" t)) | |
694 (upnode (Info-extract-pointer "up" t))) | |
695 (cond ((and upnode (string-match "(" upnode)) | |
696 (error "First node in file")) | |
697 ((and upnode (or (null prevnode) | |
698 (equal (downcase prevnode) (downcase upnode)))) | |
699 (Info-up)) | |
700 (prevnode | |
701 ;; If we move back at the same level, | |
702 ;; go down to find the last subnode*. | |
703 (Info-prev) | |
704 (let (Info-history) | |
705 (while (and (not (string-match "\\<index\\>" Info-current-node)) | |
706 (save-excursion (search-forward "\n* Menu:" nil t))) | |
707 (Info-goto-node (Info-extract-menu-counting nil))))) | |
708 (t | |
709 (error "No pointer backward from this node"))))) | |
710 | |
711 (defun Info-exit () | |
712 "Exit Info by selecting some other buffer." | |
713 (interactive) | |
714 (switch-to-buffer (prog1 (other-buffer (current-buffer)) | |
715 (bury-buffer (current-buffer))))) | |
716 | |
929
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
717 (defun Info-next-menu-item () |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
718 (interactive) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
719 (save-excursion |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
720 (forward-line -1) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
721 (search-forward "\n* menu:" nil t) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
722 (or (search-forward "\n* " nil t) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
723 (error "No more items in menu")) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
724 (Info-goto-node (Info-extract-menu-node-name)))) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
725 |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
726 (defun Info-last-menu-item () |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
727 (interactive) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
728 (save-excursion |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
729 (forward-line 1) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
730 (search-backward "\n* menu:" nil t) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
731 (or (search-backward "\n* " nil t) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
732 (error "No previous items in menu")) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
733 (Info-goto-node (Info-extract-menu-node-name)))) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
734 |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
735 (defmacro no-error (&rest body) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
736 (list 'condition-case nil (cons 'progn (append body '(t))) '(error nil))) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
737 |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
738 (defun Info-next-preorder () |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
739 "Go to the next node, popping up a level if there is none." |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
740 (interactive) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
741 (cond ((no-error (Info-next-menu-item)) ) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
742 ((no-error (Info-up)) (forward-line 1)) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
743 (t (error "No more nodes")))) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
744 |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
745 (defun Info-last-preorder () |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
746 "Go to the last node, popping up a level if there is none." |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
747 (interactive) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
748 (cond ((no-error (Info-last-menu-item)) ) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
749 ((no-error (Info-up)) (forward-line -1)) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
750 (t (error "No previous nodes")))) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
751 |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
752 (defun Info-scroll-up () |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
753 "Read the next screen. If end of buffer is visible, go to next entry." |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
754 (interactive) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
755 (if (pos-visible-in-window-p (point-max)) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
756 (Info-next-preorder) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
757 (scroll-up)) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
758 ) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
759 |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
760 (defun Info-scroll-down () |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
761 "Read the previous screen. If start of buffer is visible, go to last entry." |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
762 (interactive) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
763 (if (pos-visible-in-window-p (point-min)) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
764 (Info-last-preorder) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
765 (scroll-down)) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
766 ) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
767 |
325 | 768 (defun Info-undefined () |
769 "Make command be undefined in Info." | |
770 (interactive) | |
771 (ding)) | |
772 | |
773 (defun Info-help () | |
774 "Enter the Info tutorial." | |
775 (interactive) | |
776 (delete-other-windows) | |
777 (Info-find-node "info" | |
778 (if (< (window-height) 23) | |
779 "Help-Small-Screen" | |
780 "Help"))) | |
781 | |
782 (defun Info-summary () | |
783 "Display a brief summary of all Info commands." | |
784 (interactive) | |
785 (save-window-excursion | |
786 (switch-to-buffer "*Help*") | |
787 (erase-buffer) | |
788 (insert (documentation 'Info-mode)) | |
789 (goto-char (point-min)) | |
790 (let (ch flag) | |
791 (while (progn (setq flag (not (pos-visible-in-window-p (point-max)))) | |
792 (message (if flag "Type Space to see more" | |
793 "Type Space to return to Info")) | |
794 (if (/= ?\ (setq ch (read-char))) | |
795 (progn (setq unread-command-char ch) nil) | |
796 flag)) | |
797 (scroll-up))))) | |
798 | |
799 (defun Info-get-token (pos start all &optional errorstring) | |
800 "Return the token around POS, | |
801 POS must be somewhere inside the token | |
802 START is a regular expression which will match the | |
803 beginning of the tokens delimited string | |
804 ALL is a regular expression with a single | |
805 parenthized subpattern which is the token to be | |
806 returned. E.g. '{\(.*\)}' would return any string | |
807 enclosed in braces around POS. | |
808 SIG optional fourth argument, controls action on no match | |
809 nil: return nil | |
810 t: beep | |
811 a string: signal an error, using that string." | |
812 (save-excursion | |
813 (goto-char pos) | |
814 (re-search-backward start (max (point-min) (- pos 200)) 'yes) | |
815 (while (and (re-search-forward all (min (point-max) (+ pos 200)) 'yes) | |
816 (not (and (<= (match-beginning 0) pos) | |
817 (> (match-end 0) pos))))) | |
818 (if (and (<= (match-beginning 0) pos) | |
819 (> (match-end 0) pos)) | |
820 (buffer-substring (match-beginning 1) (match-end 1)) | |
821 (cond ((null errorstring) | |
822 nil) | |
823 ((eq errorstring t) | |
824 (beep) | |
825 nil) | |
826 (t | |
827 (error "No %s around position %d" errorstring pos)))))) | |
828 | |
540 | 829 (defun Info-follow-nearest-node (click) |
325 | 830 "\\<Info-mode-map>Follow a node reference near point. Like \\[Info-menu], \\Info-follow-reference], \\[Info-next], \\[Info-previous] or \\Info-up] command. |
831 At end of the node's text, moves to the next node." | |
540 | 832 (interactive "K") |
833 (let* ((relative-coordinates (coordinates-in-window-p (mouse-coords click) | |
325 | 834 (selected-window))) |
835 (rel-x (car relative-coordinates)) | |
540 | 836 (rel-y (cdr relative-coordinates))) |
325 | 837 (move-to-window-line rel-y) |
838 (move-to-column rel-x)) | |
839 (let (node) | |
840 (cond | |
841 ((setq node (Info-get-token (point) "\\*note " "\\*note \\([^:]*\\):" t)) | |
842 (Info-follow-reference node)) | |
843 ((setq node (Info-get-token (point) "\\* " "\\* \\([^:]*\\)::" t)) | |
844 (Info-goto-node node)) | |
845 ((setq node (Info-get-token (point) "\\* " "\\* \\([^:]*\\):" t)) | |
846 (Info-menu node)) | |
847 ((setq node (Info-get-token (point) "Up: " "Up: \\([^,\n\t]*\\)" t)) | |
848 (Info-goto-node node)) | |
849 ((setq node (Info-get-token (point) "Next: " "Next: \\([^,\n\t]*\\)" t)) | |
850 (Info-goto-node node)) | |
851 ((setq node (Info-get-token (point) "File: " "File: \\([^,\n\t]*\\)" t)) | |
852 (Info-goto-node "Top")) | |
853 ((setq node (Info-get-token (point) "Prev: " "Prev: \\([^,\n\t]*\\)" t)) | |
854 (Info-goto-node node)) | |
855 ((save-excursion (forward-line 1) (eobp)) | |
856 (Info-next))) | |
857 )) | |
858 | |
859 (defvar Info-mode-map nil | |
860 "Keymap containing Info commands.") | |
861 (if Info-mode-map | |
862 nil | |
863 (setq Info-mode-map (make-keymap)) | |
864 (suppress-keymap Info-mode-map) | |
865 (define-key Info-mode-map "." 'beginning-of-buffer) | |
929
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
866 (define-key Info-mode-map " " 'Info-scroll-up) |
27262a6c632a
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
846
diff
changeset
|
867 (define-key Info-mode-map "\C-m" 'Info-next-preorder) |
325 | 868 (define-key Info-mode-map "1" 'Info-first-menu-item) |
869 (define-key Info-mode-map "2" 'Info-second-menu-item) | |
870 (define-key Info-mode-map "3" 'Info-third-menu-item) | |
871 (define-key Info-mode-map "4" 'Info-fourth-menu-item) | |
872 (define-key Info-mode-map "5" 'Info-fifth-menu-item) | |
873 (define-key Info-mode-map "6" 'undefined) | |
874 (define-key Info-mode-map "7" 'undefined) | |
875 (define-key Info-mode-map "8" 'undefined) | |
876 (define-key Info-mode-map "9" 'undefined) | |
877 (define-key Info-mode-map "0" 'undefined) | |
878 (define-key Info-mode-map "?" 'Info-summary) | |
879 (define-key Info-mode-map "]" 'Info-forward-node) | |
880 (define-key Info-mode-map "[" 'Info-backward-node) | |
881 (define-key Info-mode-map "<" 'Info-top-node) | |
882 (define-key Info-mode-map ">" 'Info-final-node) | |
883 (define-key Info-mode-map "b" 'beginning-of-buffer) | |
884 (define-key Info-mode-map "d" 'Info-directory) | |
885 (define-key Info-mode-map "e" 'Info-edit) | |
886 (define-key Info-mode-map "f" 'Info-follow-reference) | |
887 (define-key Info-mode-map "g" 'Info-goto-node) | |
888 (define-key Info-mode-map "h" 'Info-help) | |
889 (define-key Info-mode-map "l" 'Info-last) | |
890 (define-key Info-mode-map "m" 'Info-menu) | |
891 (define-key Info-mode-map "n" 'Info-next) | |
892 (define-key Info-mode-map "p" 'Info-prev) | |
893 (define-key Info-mode-map "q" 'Info-exit) | |
894 (define-key Info-mode-map "s" 'Info-search) | |
895 (define-key Info-mode-map "u" 'Info-up) | |
930
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
896 (define-key Info-mode-map "\177" 'Info-scroll-down) |
540 | 897 ) |
325 | 898 |
899 ;; Info mode is suitable only for specially formatted data. | |
900 (put 'info-mode 'mode-class 'special) | |
901 | |
902 (defun Info-mode () | |
903 "\\<Info-mode-map> | |
904 Info mode provides commands for browsing through the Info documentation tree. | |
905 Documentation in Info is divided into \"nodes\", each of which discusses | |
906 one topic and contains references to other nodes which discuss related | |
907 topics. Info has commands to follow the references and show you other nodes. | |
908 | |
909 \\[Info-help] Invoke the Info tutorial. | |
910 | |
911 Selecting other nodes: | |
912 \\[Info-next] Move to the \"next\" node of this node. | |
913 \\[Info-previous] Move to the \"previous\" node of this node. | |
914 \\[Info-up] Move \"up\" from this node. | |
915 \\[Info-menu] Pick menu item specified by name (or abbreviation). | |
916 Picking a menu item causes another node to be selected. | |
540 | 917 \\[Info-directory] Go to the Info directory node. |
325 | 918 \\[Info-follow-reference] Follow a cross reference. Reads name of reference. |
919 \\[Info-last] Move to the last node you were at. | |
920 | |
921 Moving within a node: | |
930
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
922 \\[scroll-up] Normally, scroll forward a full screen. If the end of the buffer is |
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
923 already visible, try to go to the next menu entry, or up if there is none. |
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
924 \\[scroll-down] Normally, scroll backward. If the beginning of the buffer is |
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
925 already visible, try to go to the previous menu entry, or up if there is none. |
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
926 \\[beginning-of-buffer] Go to beginning of node. |
325 | 927 |
928 Advanced commands: | |
929 \\[Info-exit] Quit Info: reselect previously selected buffer. | |
930 \\[Info-edit] Edit contents of selected node. | |
931 1 Pick first item in node's menu. | |
932 2, 3, 4, 5 Pick second ... fifth item in node's menu. | |
933 \\[Info-goto-node] Move to node specified by name. | |
934 You may include a filename as well, as (FILENAME)NODENAME. | |
935 \\[Info-search] Search through this Info file for specified regexp, | |
930
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
936 and select the node in which the next occurrence is found. |
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
937 \\[Info-next-preorder] Next-preorder; that is, try to go to the next menu item, |
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
938 and if that fails try to move up, and if that fails, tell user |
1dac458b5117
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
929
diff
changeset
|
939 he/she is done reading." |
325 | 940 (kill-all-local-variables) |
941 (setq major-mode 'Info-mode) | |
942 (setq mode-name "Info") | |
943 (use-local-map Info-mode-map) | |
944 (set-syntax-table text-mode-syntax-table) | |
945 (setq local-abbrev-table text-mode-abbrev-table) | |
946 (setq case-fold-search t) | |
947 (setq buffer-read-only t) | |
948 (make-local-variable 'Info-current-file) | |
949 (make-local-variable 'Info-current-subfile) | |
950 (make-local-variable 'Info-current-node) | |
951 (make-local-variable 'Info-tag-table-marker) | |
952 (make-local-variable 'Info-history) | |
953 (Info-set-mode-line) | |
954 (run-hooks 'Info-mode-hook)) | |
955 | |
956 (defvar Info-edit-map nil | |
957 "Local keymap used within `e' command of Info.") | |
958 (if Info-edit-map | |
959 nil | |
960 (setq Info-edit-map (nconc (make-sparse-keymap) text-mode-map)) | |
961 (define-key Info-edit-map "\C-c\C-c" 'Info-cease-edit)) | |
962 | |
963 ;; Info-edit mode is suitable only for specially formatted data. | |
964 (put 'info-edit-mode 'mode-class 'special) | |
965 | |
966 (defun Info-edit-mode () | |
967 "Major mode for editing the contents of an Info node. | |
968 Like text mode with the addition of Info-cease-edit | |
969 which returns to Info mode for browsing. | |
970 \\{Info-edit-map}" | |
971 ) | |
972 | |
973 (defun Info-edit () | |
974 "Edit the contents of this Info node. | |
975 Allowed only if variable `Info-enable-edit' is non-nil." | |
976 (interactive) | |
977 (or Info-enable-edit | |
978 (error "Editing info nodes is not enabled")) | |
979 (use-local-map Info-edit-map) | |
980 (setq major-mode 'Info-edit-mode) | |
981 (setq mode-name "Info Edit") | |
982 (kill-local-variable 'mode-line-buffer-identification) | |
983 (setq buffer-read-only nil) | |
984 ;; Make mode line update. | |
985 (set-buffer-modified-p (buffer-modified-p)) | |
986 (message (substitute-command-keys | |
987 "Editing: Type \\<info-mode-map>\\[Info-cease-edit] to return to info"))) | |
988 | |
989 (defun Info-cease-edit () | |
990 "Finish editing Info node; switch back to Info proper." | |
991 (interactive) | |
992 ;; Do this first, so nothing has changed if user C-g's at query. | |
993 (and (buffer-modified-p) | |
994 (y-or-n-p "Save the file? ") | |
995 (save-buffer)) | |
996 (use-local-map Info-mode-map) | |
997 (setq major-mode 'Info-mode) | |
998 (setq mode-name "Info") | |
999 (Info-set-mode-line) | |
1000 (setq buffer-read-only t) | |
1001 ;; Make mode line update. | |
1002 (set-buffer-modified-p (buffer-modified-p)) | |
1003 (and (marker-position Info-tag-table-marker) | |
1004 (buffer-modified-p) | |
1005 (message "Tags may have changed. Use Info-tagify if necessary"))) | |
359 | 1006 |
1007 (defun Info-find-emacs-command-nodes (command) | |
1008 "Return a list of locations documenting COMMAND in the Emacs Info manual. | |
1009 The locations are of the format used in Info-history, i.e. | |
1010 \(FILENAME NODENAME BUFFERPOS\)." | |
1011 (require 'info) | |
1012 (let ((where '()) | |
1013 (cmd-desc (concat "^\\* " (regexp-quote (symbol-name command)) | |
1014 ":\\s *\\(.*\\)\\.$"))) | |
1015 (save-excursion | |
1016 (Info-find-node "emacs" "Command Index") | |
1017 ;; Take the index node off the Info history. | |
1018 (setq Info-history (cdr Info-history)) | |
1019 (goto-char (point-max)) | |
1020 (while (re-search-backward cmd-desc nil t) | |
1021 (setq where (cons (list Info-current-file | |
1022 (buffer-substring | |
1023 (match-beginning 1) | |
1024 (match-end 1)) | |
1025 0) | |
1026 where))) | |
1027 where))) | |
1028 | |
1029 ;;;###autoload | |
1030 (defun Info-goto-emacs-command-node (command) | |
1031 "Go to the Info node in the Emacs manual for command COMMAND." | |
1032 (interactive "CFind documentation for command: ") | |
1033 (or (commandp command) | |
1034 (signal 'wrong-type-argument (list 'commandp command))) | |
1035 (let ((where (Info-find-emacs-command-nodes command))) | |
1036 (if where | |
1037 (let ((num-matches (length where))) | |
1038 ;; Get Info running, and pop to it in another window. | |
1039 (save-window-excursion | |
1040 (info)) | |
1041 (pop-to-buffer "*info*") | |
1042 (Info-find-node (car (car where)) | |
1043 (car (cdr (car where)))) | |
1044 (if (> num-matches 1) | |
1045 (progn | |
1046 ;; Info-find-node already pushed (car where) onto | |
1047 ;; Info-history. Put the other nodes that were found on | |
1048 ;; the history. | |
1049 (setq Info-history (nconc (cdr where) Info-history)) | |
1050 (message (substitute-command-keys | |
1051 "Found %d other entr%. Use \\[Info-last] to see %s." | |
1052 (1- num-matches) | |
1053 (if (> num-matches 2) "ies" "y") | |
1054 (if (> num-matches 2) "them" "it")))))) | |
1055 (error "Couldn't find documentation for %s." command)))) | |
1056 | |
1057 ;;;###autoload | |
1058 (defun Info-goto-emacs-key-command-node (key) | |
1059 "Go to the Info node in the Emacs manual the command bound to KEY, a string. | |
1060 Interactively, if the binding is execute-extended-command, a command is read." | |
1061 (interactive "kFind documentation for key:") | |
1062 (let ((command (key-binding key))) | |
1063 (cond ((null command) | |
1064 (message "%s is undefined" (key-description keys))) | |
1065 ((and (interactive-p) | |
1066 (eq command 'execute-extended-command)) | |
1067 (Info-goto-emacs-command-node | |
1068 (read-command "Find documentation for command: "))) | |
1069 (t | |
1070 (Info-goto-emacs-command-node command))))) | |
584 | 1071 |
1072 (provide 'info) | |
1073 | |
660
08eb386dd0f3
*** empty log message ***
Eric S. Raymond <esr@snark.thyrsus.com>
parents:
584
diff
changeset
|
1074 ;;; info.el ends here |