Mercurial > emacs
annotate lisp/info-xref.el @ 104246:81a43a652b4b
(next-error-move-function): New variable.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Thu, 13 Aug 2009 00:57:17 +0000 |
parents | a9dc0e7c3f2b |
children | 1d1d5d9bd884 |
rev | line source |
---|---|
54544 | 1 ;;; info-xref.el --- check external references in an Info document |
49698 | 2 |
100908 | 3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009 |
4 ;; Free Software Foundation, Inc. | |
54544 | 5 |
49698 | 6 ;; Author: Kevin Ryde <user42@zip.com.au> |
7 ;; Keywords: docs | |
54544 | 8 |
9 ;; This file is part of GNU Emacs. | |
10 | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
11 ;; GNU Emacs is free software: you can redistribute it and/or modify |
54544 | 12 ;; it under the terms of the GNU General Public License as published by |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
13 ;; the Free Software Foundation, either version 3 of the License, or |
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
14 ;; (at your option) any later version. |
54544 | 15 |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
94678
ee5932bf781d
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93975
diff
changeset
|
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
49698 | 23 |
24 ;;; Commentary: | |
25 | |
26 ;; This file implements some simple checking of external cross references in | |
27 ;; info files, by attempting to visit the nodes specified. | |
28 ;; | |
29 ;; "makeinfo" checks references internal to a document, but not external | |
30 ;; references, which makes it rather easy for mistakes to creep in or node | |
31 ;; name changes to go unnoticed. `Info-validate' doesn't check external | |
32 ;; references either. | |
33 ;; | |
34 ;; `M-x info-xref-check' checks one file. When invoked from an Info-mode or | |
35 ;; texinfo-mode buffer, the current info file is the default at the prompt. | |
36 ;; | |
37 ;; `M-x info-xref-check-all' looks at everything in the normal info path. | |
38 ;; This might be a lot of files but it's a good way to check the consistency | |
39 ;; of the whole system. | |
40 ;; | |
41 ;; Results are shown in a buffer. The format is a bit rough, but hopefully | |
42 ;; there won't be too many problems normally, and correcting them is a | |
43 ;; manual process anyway, a case of finding the right spot in the original | |
44 ;; .texi and finding what node it ought to point to. | |
45 ;; | |
46 ;; When a target info file doesn't exist there's clearly no way to validate | |
47 ;; node references within it. A message is given for missing target files | |
48 ;; (once per source document), it could be simply that the target hasn't | |
49 ;; been installed, or it could be a mistake in the reference. | |
50 ;; | |
51 ;; Indirect info files are understood, just pass the top-level foo.info to | |
52 ;; `info-xref-check' and it traverses all sub-files. Compressed info files | |
53 ;; are accepted too, as usual for `Info-mode'. | |
54 ;; | |
55 ;; `info-xref-check-all' is rather permissive in what it considers an info | |
56 ;; file. It has to be since info files don't necessarily have a ".info" | |
57 ;; suffix (eg. this is usual for the emacs manuals). One consequence of | |
58 ;; this is that if for instance there's a source code directory in | |
59 ;; `Info-directory-list' then a lot of extraneous files might be read, which | |
60 ;; will be time consuming but should be harmless. | |
54543
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
61 ;; |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
62 ;; `M-x info-xref-check-all-custom' is a related command, it goes through |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
63 ;; all info document references in customizable variables, checking them |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
64 ;; like info file cross references. |
49698 | 65 |
66 ;;; Code: | |
67 | |
68 (require 'info) | |
69 | |
70 (defconst info-xref-results-buffer "*info-xref results*" | |
71 "Name of the buffer for info-xref results.") | |
72 | |
73 ;;;###autoload | |
74 (defun info-xref-check (filename) | |
75 "Check external references in FILENAME, an info document." | |
76 (interactive | |
77 (list | |
78 (let* ((default-filename | |
79 (cond ((eq major-mode 'Info-mode) | |
80 Info-current-file) | |
81 ((eq major-mode 'texinfo-mode) | |
82 ;; look for @setfilename like makeinfo.el does | |
83 (save-excursion | |
84 (goto-char (point-min)) | |
85 (if (re-search-forward | |
86 "^@setfilename[ \t]+\\([^ \t\n]+\\)[ \t]*" | |
49729
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
87 (line-beginning-position 100) t) |
49698 | 88 (expand-file-name (match-string 1))))))) |
89 (prompt (if default-filename | |
90 (format "Info file (%s): " default-filename) | |
91 "Info file: "))) | |
49729
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
92 (read-file-name prompt nil default-filename t)))) |
49698 | 93 (info-xref-check-list (list filename))) |
94 | |
95 ;;;###autoload | |
96 (defun info-xref-check-all () | |
97 "Check external references in all info documents in the usual path. | |
98 The usual path is `Info-directory-list' and `Info-additional-directory-list'." | |
99 (interactive) | |
100 (info-xref-check-list (info-xref-all-info-files))) | |
101 | |
102 ;; An alternative to trying to get only top-level files here would be to | |
103 ;; simply return all files, and have info-xref-check-list not follow | |
104 ;; Indirect:. The current way seems a bit nicer though, because it gets the | |
105 ;; proper top-level filename into the error messages, and suppresses | |
106 ;; duplicate "not available" messages for all subfiles of a single document. | |
107 | |
108 (defun info-xref-all-info-files () | |
109 "Return a list of all available info files. | |
110 Only top-level files are returned, subfiles are excluded. | |
111 | |
112 Since info files don't have to have a .info suffix, all files in the | |
113 relevant directories are considered, which might mean a lot of extraneous | |
114 things are returned if for instance a source code directory is in the path." | |
115 | |
116 (info-initialize) ;; establish Info-directory-list | |
49729
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
117 (apply 'nconc |
49698 | 118 (mapcar |
119 (lambda (dir) | |
120 (let ((result nil)) | |
121 (dolist (name (directory-files dir t)) | |
49729
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
122 (unless (or (file-directory-p name) (info-xref-subfile-p name)) |
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
123 (push name result))) |
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
124 (nreverse result))) |
49698 | 125 (append Info-directory-list Info-additional-directory-list)))) |
126 | |
127 (defun info-xref-subfile-p (filename) | |
128 "Return t if FILENAME is an info subfile. | |
129 If removing the last \"-<NUM>\" from the filename gives a file that exists, | |
130 then consider FILENAME a subfile. This is an imperfect test, we probably | |
131 should open up the purported top file and see what subfiles it says." | |
132 (and (string-match "\\`\\(\\([^-]*-\\)*[^-]*\\)-[0-9]+\\(.*\\)\\'" filename) | |
133 (file-exists-p (concat (match-string 1 filename) | |
134 (match-string 3 filename))))) | |
135 | |
136 | |
137 ;; Some dynamic variables are used to share information with sub-functions | |
138 ;; below. | |
139 ;; | |
65137
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
140 ;; info-xref-filename-header - a heading message for the current top-level |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
141 ;; filename, or "" when it's been printed. |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
142 ;; |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
143 (defvar info-xref-xfile-alist) |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
144 ;; |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
145 ;; info-xref-good - count of good cross references. |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
146 ;; |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
147 (defvar info-xref-good) |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
148 ;; |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
149 ;; info-xref-bad - count of bad cross references. |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
150 ;; |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
151 (defvar info-xref-bad) |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
152 ;; |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
153 ;; info-xref-xfile-alist - indexed by "(foo)" with value nil or t according |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
154 ;; to whether "(foo)" exists or not. This is used to suppress duplicate |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
155 ;; messages about foo not being available. (Duplicates within one |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
156 ;; top-level file that is.) |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
157 ;; |
4377043d399d
Move the `defvar's to the top level.
Juanma Barranquero <lekktu@gmail.com>
parents:
65095
diff
changeset
|
158 (defvar info-xref-filename-heading) |
49698 | 159 |
160 (defun info-xref-check-list (filename-list) | |
161 "Check external references in info documents in FILENAME-LIST." | |
162 (pop-to-buffer info-xref-results-buffer t) | |
163 (erase-buffer) | |
164 (let ((info-xref-good 0) | |
165 (info-xref-bad 0)) | |
166 (dolist (info-xref-filename filename-list) | |
167 (let ((info-xref-filename-heading | |
168 (format "In file %s:\n" info-xref-filename)) | |
169 (info-xref-xfile-alist nil)) | |
170 (with-temp-message (format "Looking at %s" info-xref-filename) | |
171 (with-temp-buffer | |
172 (info-insert-file-contents info-xref-filename) | |
173 (goto-char (point-min)) | |
174 (if (re-search-forward "\^_\nIndirect:\n" nil t) | |
175 (let ((dir (file-name-directory info-xref-filename))) | |
176 (while (looking-at "\\(.*\\): [0-9]+\n") | |
177 (let ((subfile (match-string 1))) | |
178 (with-temp-buffer | |
179 (info-insert-file-contents | |
180 (expand-file-name subfile dir)) | |
181 (info-xref-check-buffer))) | |
182 (forward-line))) | |
183 (info-xref-check-buffer)))))) | |
184 (insert (format "done, %d good, %d bad\n" info-xref-good info-xref-bad)))) | |
185 | |
186 (defun info-xref-check-buffer () | |
187 "Check external references in the info file in the current buffer. | |
49717
ecb17cef5c44
(info-xref-check-buffer): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents:
49698
diff
changeset
|
188 This should be the raw file contents, not `Info-mode'." |
49698 | 189 (goto-char (point-min)) |
190 (while (re-search-forward | |
54543
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
191 "\\*[Nn]ote[ \n\t]+[^:]*:[ \n\t]+\\(\\(([^)]*)\\)[^.,]+\\)[.,]" |
49698 | 192 nil t) |
193 (let* ((file (match-string 2)) | |
49729
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
194 (node ;; Canonicalize spaces: we could use "[\t\n ]+" but |
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
195 ;; we try to avoid uselessly replacing " " with " ". |
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
196 (replace-regexp-in-string "[\t\n][\t\n ]*\\| [\t\n ]+" " " |
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
197 (match-string 1) t t))) |
54543
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
198 (if (string-equal "()" file) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
199 (info-xref-output "Empty filename part: %s\n" node) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
200 ;; see if the file exists, if we haven't tried it before |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
201 (unless (assoc file info-xref-xfile-alist) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
202 (let ((found (info-xref-goto-node-p file))) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
203 (push (cons file found) info-xref-xfile-alist) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
204 (unless found |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
205 (info-xref-output "Not available to check: %s\n" file)))) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
206 ;; if the file exists, try the node |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
207 (when (cdr (assoc file info-xref-xfile-alist)) |
49698 | 208 (if (info-xref-goto-node-p node) |
209 (setq info-xref-good (1+ info-xref-good)) | |
210 (setq info-xref-bad (1+ info-xref-bad)) | |
54543
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
211 (info-xref-output "No such node: %s\n" node))))))) |
49698 | 212 |
54543
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
213 (defun info-xref-output (str &rest args) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
214 "Emit a `format'-ed message STR+ARGS to the info-xref output buffer." |
49698 | 215 (with-current-buffer info-xref-results-buffer |
54543
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
216 (insert info-xref-filename-heading |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
217 (apply 'format str args)) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
218 (setq info-xref-filename-heading "") |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
219 ;; all this info-xref can be pretty slow, display now so the user can |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
220 ;; see some progress |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
221 (sit-for 0))) |
49698 | 222 |
223 ;; When asking Info-goto-node to fork, *info* needs to be the current | |
224 ;; buffer, otherwise it seems to clone the current buffer but then do the | |
225 ;; goto-node in plain *info*. | |
226 ;; | |
227 ;; We only fork if *info* already exists, if it doesn't then we can create | |
228 ;; and destroy just that instead of a new name. | |
229 ;; | |
230 ;; If Info-goto-node can't find the file, then no new buffer is created. If | |
231 ;; it finds the file but not the node, then a buffer is created. Handle | |
232 ;; this difference by checking before killing. | |
233 ;; | |
234 (defun info-xref-goto-node-p (node) | |
49729
f3c2ee28113b
(info-xref-check): Use line-beginning-position.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
49717
diff
changeset
|
235 "Return t if it's possible to go to the given NODE." |
49698 | 236 (let ((oldbuf (current-buffer))) |
237 (save-excursion | |
238 (save-window-excursion | |
239 (prog1 | |
240 (condition-case err | |
241 (progn | |
242 (Info-goto-node node | |
243 (when (get-buffer "*info*") | |
244 (set-buffer "*info*") | |
245 "xref - temporary")) | |
246 t) | |
247 (error nil)) | |
248 (unless (equal (current-buffer) oldbuf) | |
249 (kill-buffer (current-buffer)))))))) | |
250 | |
54543
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
251 ;;;###autoload |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
252 (defun info-xref-check-all-custom () |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
253 "Check info references in all customize groups and variables. |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
254 `custom-manual' and `info-link' entries in the `custom-links' list are checked. |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
255 |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
256 `custom-load' autoloads for all symbols are loaded in order to get all the |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
257 link information. This will be a lot of lisp packages loaded, and can take |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
258 quite a while." |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
259 |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
260 (interactive) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
261 (pop-to-buffer info-xref-results-buffer t) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
262 (erase-buffer) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
263 (let ((info-xref-filename-heading "")) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
264 |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
265 ;; `custom-load-symbol' is not used, since it quietly ignores errors, |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
266 ;; but we want to show them (since they may mean incomplete checking). |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
267 ;; |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
268 ;; Just one pass through mapatoms is made. There shouldn't be any new |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
269 ;; custom-loads setup by packages loaded. |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
270 ;; |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
271 (info-xref-output "Loading custom-load autoloads ...\n") |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
272 (require 'cus-start) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
273 (require 'cus-load) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
274 (let ((viper-mode nil)) ;; tell viper.el not to ask about viperizing |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
275 (mapatoms |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
276 (lambda (symbol) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
277 (dolist (load (get symbol 'custom-loads)) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
278 (cond ((symbolp load) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
279 (condition-case cause (require load) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
280 (error |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
281 (info-xref-output "Symbol `%s': cannot require '%s: %s\n" |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
282 symbol load cause)))) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
283 ;; skip if previously loaded |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
284 ((assoc load load-history)) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
285 ((assoc (locate-library load) load-history)) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
286 (t |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
287 (condition-case cause (load load) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
288 (error |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
289 (info-xref-output "Symbol `%s': cannot load \"%s\": %s\n" |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
290 symbol load cause))))))))) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
291 |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
292 ;; Don't bother to check whether the info file exists as opposed to just |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
293 ;; a missing node. If you have the lisp then you should have the |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
294 ;; documentation, so missing node name will be the usual fault. |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
295 ;; |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
296 (info-xref-output "\nChecking custom-links references ...\n") |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
297 (let ((good 0) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
298 (bad 0)) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
299 (mapatoms |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
300 (lambda (symbol) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
301 (dolist (link (get symbol 'custom-links)) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
302 (when (memq (car link) '(custom-manual info-link)) |
70775
5a774661776f
(info-xref-check-all-custom): Skip :tag part of
Eli Zaretskii <eliz@gnu.org>
parents:
68651
diff
changeset
|
303 ;; skip :tag part of (custom-manual :tag "Foo" "(foo)Node") |
5a774661776f
(info-xref-check-all-custom): Skip :tag part of
Eli Zaretskii <eliz@gnu.org>
parents:
68651
diff
changeset
|
304 (if (eq :tag (cadr link)) |
5a774661776f
(info-xref-check-all-custom): Skip :tag part of
Eli Zaretskii <eliz@gnu.org>
parents:
68651
diff
changeset
|
305 (setq link (cddr link))) |
5a774661776f
(info-xref-check-all-custom): Skip :tag part of
Eli Zaretskii <eliz@gnu.org>
parents:
68651
diff
changeset
|
306 (if (info-xref-goto-node-p (cadr link)) |
54543
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
307 (setq good (1+ good)) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
308 (setq bad (1+ bad)) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
309 ;; symbol-file gives nil for preloaded variables, would need |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
310 ;; to copy what describe-variable does to show the right place |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
311 (info-xref-output "Symbol `%s' (in %s): cannot goto node: %s\n" |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
312 symbol (symbol-file symbol) (cadr link))))))) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
313 (info-xref-output "%d good, %d bad\n" good bad)))) |
5766a12d96ac
(info-xref-check-buffer): Report empty filename parts.
Juri Linkov <juri@jurta.org>
parents:
52401
diff
changeset
|
314 |
49698 | 315 (provide 'info-xref) |
316 | |
93975
1e3a407766b9
Fix up comment convention on the arch-tag lines.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
79721
diff
changeset
|
317 ;; arch-tag: 69d4d528-69ed-4cc2-8eb4-c666a0c1d5ac |
49698 | 318 ;;; info-xref.el ends here |