Current File : //usr/local/share/emacs/27.2/lisp/info-xref.elc
;ELC
;;; Compiled
;;; in Emacs version 27.2
;;; with all optimizations.
;;; This file uses dynamic docstrings, first added in Emacs 19.29.
;;; This file does not contain utf-8 non-ASCII characters,
;;; and so can be loaded in Emacs versions earlier than 23.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(byte-code "\300\301!\210\302\303\304\305\306\307%\210\310\311\312\313\314DD\315\306\303\316\317\320\321& \207" [require info custom-declare-group info-xref nil "Check external cross-references in Info documents." :group docs custom-declare-variable info-xref-case-fold funcall function #[0 "\300\207" [nil] 1] "Non-nil means node checks should ignore case.\nWhen following cross-references, the Emacs Info reader first tries a\ncase-sensitive match, then if that fails a case-insensitive one.\nThe standalone Info reader does not do this, nor does this work\nfor links in the html versions of Texinfo manuals. Therefore\nto ensure your cross-references work on the widest range of platforms,\nyou should set this variable to nil." :type boolean :version "24.4"] 10)
#@116 Return non-nil if FILENAME is an Emacs lock file.
A lock file is ".#foo.txt" etc per `lock-buffer'.
(fn FILENAME)
(defalias 'info-xref-lock-file-p #[257 "\300\301\"\207" [string-match "\\(\\`\\|/\\)\\.#"] 4 (#$ . 1177)])
#@274 Return t if FILENAME is an info subfile.
If removing the last "-<NUM>" from the filename gives a file
which exists, then consider FILENAME a subfile. This is an
imperfect test, probably ought to open up the purported top file
and see what subfiles it says.
(fn FILENAME)
(defalias 'info-xref-subfile-p #[257 "\300\301\"\205 \302\303\304\"\303\305\"P!\207" [string-match "\\`\\(\\([^-]*-\\)*[^-]*\\)-[0-9]+\\(.*\\)\\'" file-exists-p match-string 1 3] 6 (#$ . 1407)])
#@451 Evaluate BODY in a buffer containing the contents of FILENAME.
If FILENAME is already in a buffer then that's used, otherwise a
temporary buffer.
The current implementation uses `insert-file-contents' rather
than `find-file-noselect' so as not to be held up by queries
about local variables or possible weirdness in a major mode.
`lm-with-file' does a similar thing, but it sets
`emacs-lisp-mode' which is not wanted here.
(fn FILENAME &rest BODY)
(defalias 'info-xref-with-file '(macro . #[385 "\300\301D\302\303\304BBD\305BB\306\307\310\311\312D\313BBFE\207" [let* info-xref-with-file--filename info-xref-with-file--body lambda nil ((info-xref-with-file--existing (find-buffer-visiting info-xref-with-file--filename))) if info-xref-with-file--existing (with-current-buffer info-xref-with-file--existing (save-excursion (funcall info-xref-with-file--body))) with-temp-buffer insert-file-contents ((funcall info-xref-with-file--body))] 10 (#$ . 1886)]))
(byte-code "\300\301\302\303#\210\304\301\305\306#\300\207" [put info-xref-with-file edebug-form-spec t function-put lisp-indent-function 1] 4)
#@43 Name of the buffer for info-xref results.
(defconst info-xref-output-buffer "*info-xref results*" (#$ . 2996))
#@62 Count of good cross references, during info-xref processing.
(defvar info-xref-good 0 (#$ . 3113))
#@61 Count of bad cross references, during info-xref processing.
(defvar info-xref-bad 0 (#$ . 3218))
#@69 Count of unavailable cross references, during info-xref processing.
(defvar info-xref-unavail 0 (#$ . 3321))
#@106 A heading string, during info-xref processing.
This is shown if there's an error, but not if successful.
(defvar info-xref-output-heading "" (#$ . 3437))
#@160 The current buffer's filename, during info-xref processing.
When looking at file contents in a temp buffer there's no
`buffer-file-name', hence this variable.
(defvar info-xref-filename nil (#$ . 3598))
#@280 Info files found or not found, during info-xref processing.
Key is "(foo)" etc and value nil or t according to whether info
manual "(foo)" exists or not. This is used to suppress
duplicate messages about foo not being available. (Duplicates
within one top-level file that is.)
(defvar info-xref-xfile-alist nil (#$ . 3808))
(defvar info-xref-in-progress nil)
#@305 Run BODY with an info-xref output buffer.
This is meant to nest, so you can wrap it around a set of
different info-xref checks and have them write to the one output
buffer created by the outermost `info-xref-with-output', with an
overall good/bad count summary inserted at the very end.
(fn &rest BODY)
(defalias 'info-xref-with-output '(macro . #[128 "\300\301\302\303BB\304BBB\207" [save-excursion (unless info-xref-in-progress (display-buffer (get-buffer-create info-xref-output-buffer)) (set-buffer info-xref-output-buffer) (setq buffer-read-only nil) (fundamental-mode) (erase-buffer) (insert ";; info-xref output -*- mode: compilation -*-\n\n") (compilation-mode) (setq info-xref-good 0 info-xref-bad 0 info-xref-unavail 0 info-xref-xfile-alist nil)) let ((info-xref-in-progress t) (info-xref-output-heading "")) ((unless info-xref-in-progress (info-xref-output "done, %d good, %d bad, %d unavailable" info-xref-good info-xref-bad info-xref-unavail)))] 6 (#$ . 4176)]))
(put 'info-xref-with-output 'edebug-form-spec t)
#@100 Emit a `format-message'-ed message FMT+ARGS to the `info-xref-output-buffer'.
(fn FMT &rest ARGS)
(defalias 'info-xref-output #[385 "rq\210\212db\210\303\n\304\305#\306\261\210*\307\310\311!)\207" [info-xref-output-buffer inhibit-read-only info-xref-output-heading t apply format-message "\n" "" sit-for 0] 7 (#$ . 5210)])
(put 'info-xref-output 'byte-compile-format-like t)
#@189 Emit a `format'-ed error FMT+ARGS to the `info-xref-output-buffer'.
The error is attributed to `info-xref-filename' and the current
buffer's line and column of point.
(fn FMT &rest ARGS)
(defalias 'info-xref-output-error #[385 "\301\302\303P\304e\305 \"TiT&\207" [info-xref-filename apply info-xref-output "%s:%s:%s: " count-lines line-beginning-position] 9 (#$ . 5599)])
(put 'info-xref-output-error 'byte-compile-format-like t)
#@63 Return t if it's possible to go to the given NODE.
(fn NODE)
(defalias 'info-xref-goto-node-p #[257 "p\212\301 \302\303\304\305\306!\307\"\310$\216\3111) \312\313\314!\205 \314q\210\315?#\210\3160\202+ \210\317p\232\2044 \320 \210)\262)\207" [info-xref-case-fold current-window-configuration make-byte-code 0 "\301\300!\207" vconcat vector [set-window-configuration] 2 (error) Info-goto-node get-buffer "*info*" "xref - temporary" t nil kill-buffer] 9 (#$ . 6041)])
#@13
(fn NODE)
(defalias 'info-xref-check-node #[257 "\304\305\306\307\211%\262\310\311\"\204 \312\313\"\207\314\315\"\211\316\230\203& \312\317\"\202c \320\"\204@ \321!BB\211\204? \312\322\"\210\210\320\"A\204O T\211\202c \321!\203\\ \nT\211\202c T\312\323\"\207" [info-xref-xfile-alist info-xref-unavail info-xref-good info-xref-bad replace-regexp-in-string "[ \n][ \n ]*\\| [ \n ]+" " " t string-match "\\`([^)]*)" info-xref-output-error "no `(file)' part at start of node: %s\n" match-string 0 "()" "empty filename part: %s" assoc info-xref-goto-node-p "not available to check: %s\n (this reported once per file)" "no such node: %s"] 7 (#$ . 6520)])
#@1184 Check external references in FILENAME, an info document.
Interactively from an `Info-mode' or `texinfo-mode' buffer the
current info file is the default.
Results are shown in a `compilation-mode' buffer. The format is
a bit rough, but there shouldn't be many problems normally. The
file:line:column: is the info document, but of course normally
any correction should be made in the original .texi file.
Finding the right place in the .texi is a manual process.
When a target info file doesn't exist there's obviously no way to
validate node references within it. A message is given for
missing target files once per source document. It could be
simply that you don't have the target installed, or it could be a
mistake in the reference.
Indirect info files are understood, just pass the top-level
foo.info to `info-xref-check' and it traverses all sub-files.
Compressed info files are accepted too as usual for `Info-mode'.
"makeinfo" checks references internal to an info document, but
not external references, which makes it rather easy for mistakes
to creep in or node name changes to go unnoticed.
`Info-validate' doesn't check external references either.
(fn FILENAME)
(defalias 'info-xref-check #[257 "\300C!\207" [info-xref-check-list] 3 (#$ . 7206) (byte-code "\302\267\202! \202\" \212eb\210\303\304\305\306!\307#\205 \310\311\312!!)\202\" \313\211\203- \314\315\"\202. \316\317\313\307$\266\202C\207" [major-mode Info-current-file #s(hash-table size 2 test eq rehash-size 1.5 rehash-threshold 0.8125 purecopy t data (Info-mode 6 texinfo-mode 10)) re-search-forward "^@setfilename[ ]+\\([^ \n]+\\)[ ]*" line-beginning-position 100 t expand-file-name match-string 1 nil format "Info file (%s): " "Info file: " read-file-name] 7)])
#@527 Check external references in all info documents in the info path.
`Info-directory-list' and `Info-additional-directory-list' are
the info paths. See `info-xref-check' for how each file is
checked.
The search for "all" info files is rather permissive, since
info files don't necessarily have a ".info" extension and in
particular the Emacs manuals normally don't. If you have a
source code directory in `Info-directory-list' then a lot of
extraneous files might be read. This will be time consuming but
should be harmless.
(defalias 'info-xref-check-all #[0 "\300\301 !\207" [info-xref-check-list info-xref-all-info-files] 2 (#$ . 8971) nil])
#@309 Return a list of all available info files.
Only top level files are returned, subfiles are excluded.
Since info files don't have to have a .info suffix, all files in
the relevant directories are considered, which might mean a lot
of extraneous things if for instance a source code directory is
in the path.
(defalias 'info-xref-all-info-files #[0 "\302 \210\303\304\305\306\307 \"\"\"\207" [Info-directory-list Info-additional-directory-list info-initialize apply nconc mapcar #[257 "\300\301\302\303#\211\2037 \211@\304!\2030 \305\306\"\2040 \307!\2040 \310!\2040 \311!\2040 \211B\262A\266\202\202 \210\211\237\207" [nil directory-files t "\\`[^.]" file-exists-p string-match "\\.te?xi\\'" backup-file-name-p file-directory-p info-xref-subfile-p] 7 "\n\n(fn DIR)"] append] 7 (#$ . 9624)])
#@83 Check external references in info documents in FILENAME-LIST.
(fn FILENAME-LIST)
(defalias 'info-xref-check-list #[257 "\212\204% \306\307 !!\210 q\210\310\311 \210\312 \210\313c\210\314 \210\315\211\315\310.\316\317 /\211\211\203\317 \211@ 0\310.\320\3210\" /\320\3220\"\310C\323\315\324\325\326\"\327\"\330$\216\203a \211\331 \240\210\332\333\"\210\334\335!r\211q\210\323\315\336\325\326!\337\"\340$\216\3410!\210eb\210\342\343\310\316#\203\276 \3440!\345\346!\203\272 \347\350\351!\" 0\334\335!r\211q\210\323\315\336\325\326!\352\"\340$\216\3410!\210\353 \210*\210)\310y\210\202\210 \210\202\301 \353 \210*\210)\266)\211A\262)\202+ \210*?\205\334 \354\355 \f
$)\207" [info-xref-in-progress info-xref-output-buffer buffer-read-only info-xref-good info-xref-bad info-xref-unavail display-buffer get-buffer-create nil fundamental-mode erase-buffer ";; info-xref output -*- mode: compilation -*-\n\n" compilation-mode 0 t "" format "Info file %s\n" "Looking at %s" make-byte-code "\300\205 \301\242\203 \302\303\301\242\"\207\302\304!\207" vconcat vector [message #1="%s" nil] 3 current-message message #1# generate-new-buffer " *temp*" "\301\300!\205 \302\300!\207" [buffer-name kill-buffer] 2 info-insert-file-contents search-forward " \nIndirect:\n" file-name-directory looking-at "\\(.*\\): [0-9]+\n" expand-file-name match-string 1 [buffer-name kill-buffer] info-xref-check-buffer info-xref-output "done, %d good, %d bad, %d unavailable" info-xref-xfile-alist info-xref-output-heading info-xref-filename] 14 (#$ . 10432)])
#@45 Regexp with subexp 1 matching (manual)node.
(defconst info-xref-node-re "\\(?1:\\(([^)]*)\\)[^.,]+\\)" (#$ . 11994))
#@36 Regexp matching a "*note..." link.
(defconst info-xref-note-re (concat "\\*[Nn]ote[ \n ]+\\(?:[^:]*:[ \n ]+" info-xref-node-re "\\|" info-xref-node-re "::\\)[.,]") (#$ . 12117))
#@122 Check external references in the info file in the current buffer.
This should be the raw file contents, not `Info-mode'.
(defalias 'info-xref-check-buffer #[0 "eb\210\301\302\303#\205 \212\304\224b\210\305\306\304!!\210)\202 \207" [info-xref-note-re re-search-forward nil t 1 info-xref-check-node match-string] 4 (#$ . 12302)])
#@320 Check info references in all customize groups and variables.
Info references can be in `custom-manual' or `info-link' entries
of the `custom-links' for a variable.
Any `custom-load' autoloads in variables are loaded in order to
get full link information. This will be a lot of Lisp packages
and can take a long time.
(defalias 'info-xref-check-all-custom #[0 "\212\204% \306\307 !!\210 q\210\310\311 \210\312 \210\313c\210\314 \210\315\211\315\310 \316\317 \320\321!\210\322\323!\210\322\324!\210\325\326!\204? \310\325\327!\204H \310\330\331!\210\320\332!\210\330\333!\210*?\205` \320\334 \f
$)\207" [info-xref-in-progress info-xref-output-buffer buffer-read-only info-xref-good info-xref-bad info-xref-unavail display-buffer get-buffer-create nil fundamental-mode erase-buffer ";; info-xref output -*- mode: compilation -*-\n\n" compilation-mode 0 t "" info-xref-output "Loading custom-load autoloads ..." require cus-start cus-load boundp viper-mode gnus-registry-install mapatoms #[257 "\211\301N\211\205R \211@\2119\203% \3021 \303!0\202! \304\305$\262\210\202K \306\"\204K \306\307!\"\204K \3101@ \311!0\202J \304\312\313!$\262\210A\266\202\202 \207" [load-history custom-loads (error) require info-xref-output "Symbol `%s': cannot require `%s': %s" assoc locate-library (error) load "Symbol `%s': cannot load \"%s\": %s" error-message-string] 10 "\n\n(fn SYMBOL)"] "\nChecking custom-links references ..." #[257 "\211\302N\211\205B \211@\211@\303>\203; \211A@\304=\203 \211AA\262\305A@!\203+ T\202; T\306\307\310\311\"A@$\210A\266\202\202 \207" [info-xref-good info-xref-bad custom-links (custom-manual info-link) :tag info-xref-goto-node-p info-xref-output "Symbol `%s' (file %s): cannot goto node: %s" symbol-file defvar] 9 "\n\n(fn SYMBOL)"] "done, %d good, %d bad, %d unavailable" info-xref-xfile-alist info-xref-output-heading] 6 (#$ . 12640) nil])
#@814 Check docstring info node references in source files.
The given files are searched for docstring hyperlinks like
Info node `(elisp)Documentation Tips'
and those links checked by attempting to visit the target nodes
as per `info-xref-check' does.
Interactively filenames are read as a wildcard pattern like
"foo*.el", with the current file as a default. Usually this
will be lisp sources, but anything with such hyperlinks can be
checked, including the Emacs .c sources (or the etc/DOC file of
all builtins).
Because info node hyperlinks are found by a simple regexp search
in the files, the Lisp code checked doesn't have to be loaded,
and links can be in the file commentary or elsewhere too. Even
.elc files can usually be checked successfully if you don't have
the sources handy.
(fn FILENAME-LIST)
(defalias 'info-xref-docstrings #[257 "\306\307!\210\212\204) \310\311 !!\210 q\210\312\313 \210\314 \210\315c\210\316 \210\317\211\317\312 \320\321 \211\211\203w \211@ !\312 !\322\323!\211\203P r\211q\210\212 \210*\202m \324\325!r\211q\210\326\317\327\330\331!\332\"\333$\216\334!!\210 \210*\210\266\211A\262)\202/ \210*?\205\204 \335\336 \f
$)\207" [info-xref-in-progress info-xref-output-buffer buffer-read-only info-xref-good info-xref-bad info-xref-unavail require help-mode display-buffer get-buffer-create nil fundamental-mode erase-buffer ";; info-xref output -*- mode: compilation -*-\n\n" compilation-mode 0 t "" #[0 "eb\210\301\302\303#\205/ \304\305!\212\305\224b\210\306\307\"\204* \306\310\"\204& \311P\262\312!\210)\210\202 \207" [help-xref-info-regexp re-search-forward nil t match-string 2 string-match "%" "\\`(" "(emacs)" info-xref-check-node] 4] find-buffer-visiting generate-new-buffer " *temp*" make-byte-code "\301\300!\205 \302\300!\207" vconcat vector [buffer-name kill-buffer] 2 insert-file-contents info-xref-output "done, %d good, %d bad, %d unavailable" info-xref-xfile-alist info-xref-output-heading info-xref-filename] 13 (#$ . 14553) (byte-code "\205 \301!\211\203 \302\303\"\202 \304\305\306#\307\310\"\306\211\203< \211@\311!\2045 \312!\2045 \211B\262A\266\202\202 \237\262\262\204K \313\314\"\210C\207" [buffer-file-name file-relative-name format "Filename with wildcards (%s): " "Filename with wildcards: " read-file-name nil file-expand-wildcards t info-xref-lock-file-p file-directory-p error "No files: %S"] 9)])
(provide 'info-xref)
Mini Shell