Function: Info-toc-nodes

Info-toc-nodes is a byte-compiled function defined in info.el.gz.

Signature

(Info-toc-nodes FILENAME)

Documentation

Return a node list of Info FILENAME with parent-children information.

This information is cached in the variable Info-toc-nodes(var)/Info-toc-nodes(fun) with the help of the function Info-toc-build.

Source Code

;; Defined in /usr/src/emacs/lisp/info.el.gz
(defun Info-toc-nodes (filename)
  "Return a node list of Info FILENAME with parent-children information.
This information is cached in the variable `Info-toc-nodes' with the help
of the function `Info-toc-build'."
  (cond
   ((Info-virtual-call
     (Info-virtual-fun 'toc-nodes (or filename Info-current-file) nil)
     filename))
   (t
    (or filename (setq filename Info-current-file))
    (or (assoc filename Info-toc-nodes)
	;; Skip virtual Info files
	(and (or (not (stringp filename))
		 (Info-virtual-file-p filename))
	     (push (cons filename nil) Info-toc-nodes))
	;; Scan the entire manual and cache the result in Info-toc-nodes
	(let ((nodes (Info-toc-build filename)))
	  (push (cons filename nodes) Info-toc-nodes)
	  nodes)
	;; If there is an error, still add nil to the cache
	(push (cons filename nil) Info-toc-nodes))
    (cdr (assoc filename Info-toc-nodes)))))