xemacs-beta: lisp/info.el comparison

comparison lisp/info.el @ 404:2f8bb876ab1d r21-2-32

Import from CVS: tag r21-2-32

author	cvs
date	Mon, 13 Aug 2007 11:16:07 +0200
parents	a86b2b5e0111
children	de805c49cfc1

comparison

equal deleted inserted replaced

-:9f011ab08d48
+:2f8bb876ab1d
 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 ;; General Public License for more details.
 ;; You should have received a copy of the GNU General Public License
 ;; along with XEmacs; see the file COPYING.  If not, write to the
 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 ;; Boston, MA 02111-1307, USA.
 ;;; Synched up with: Not synched with FSF.
 ;;
 ;; Added automatic dir/localdir (re)building capability for directories that
 ;; contain none or when it has become older than info files in the same
 ;; directory.
-;; Modified 1998-09-23 by Didier Verna <verna@inf.enst.fr>
+;; Modified 1998-09-23 by Didier Verna <didier@xemacs.org>
 ;;
 ;; Use the new macro `with-search-caps-disable-folding'
 ;; Code:
 (eval-when-compile
 use any existing `dir' or `localdir' file and ignore info
 directories containing none
 `always' auto-generate a directory listing ignoring existing
 `dir' and `localdir' files
 `if-missing', the default, auto-generates a directory listing
 if no `dir' or `localdir' file is present.  Otherwise the
 contents of any of these files is used instead.
 `if-outdated' auto-generates a directory listing if the `dir'
 and `localdir' are either inexistent or outdated (touched
 less recently than an info file in the same directory)."
 :type '(choice (const :tag "never" never)
 		 (const :tag "always" always)
 		 (const :tag "if-missing" if-missing)
 		 (const :tag "if-outdated" if-outdated))
 :group 'info)
 (defcustom Info-save-auto-generated-dir 'never
 "*Whether an auto-generated info directory listing should be saved.
 Possible values are:
 nil or `never', the default, auto-generated info directory
 information will never be saved.
 `always', auto-generated info directory information will be saved to
 a `dir' file in the same directory overwriting it if it exists
 `conservative', auto-generated info directory information will be saved
 to a `dir' file in the same directory but the user is asked before
 overwriting any existing file."
 :type '(choice (const :tag "never" never)
 		 (const :tag "always" always)
 		 (const :tag "conservative" conservative))
 :group 'info)
 (defface info-xref '((t (:bold t)))
 "Face used for cross-references in info."
 :group 'info-faces)
 ;; Is this right for NT?  .zip, with -c for to stdout, right?
 (defvar Info-suffix-list '( ("" . nil)
 			    (".info" . nil)
 			    (".info.bz2" . "bzip2 -dc %s")
 			    (".info.gz" . "gzip -dc %s")
 			    (".info-z" . "gzip -dc %s")
 			    (".info.Z" . "uncompress -c %s")
 This is the file .../info/dir, which contains the topmost node of the
 Info hierarchy.  The first time you invoke Info you start off
 looking at that node, which is (dir)Top.
 File: dir	Node: Top	This is the top of the INFO tree
 This (the Directory node) gives a menu of major topics.
 * Menu: The list of major topics begins on the next line.
 ")
 ;; empty filename is simple case
 ((null filename)
 (Info-find-file-node nil nodename no-going-back tryfile line))
 ;; Convert filename to lower case if not found as specified.
 ;; Expand it, look harder...
 ((let (temp temp-downcase found
 	       (fname (substitute-in-file-name filename)))
 (let ((dirs (cond
 		   ((string-match "^\\./" fname) ; If specified name starts with `./'
 		    (list default-directory)) ; then just try current directory.
 		   ((file-name-absolute-p fname)
 	  (if (equal temp-downcase temp) (setq temp-downcase nil))
 	  ;; Try several variants of specified name.
 	  ;; Try downcasing, appending a suffix, or both.
 	  (setq found (Info-suffixed-file temp temp-downcase))
 	  (setq dirs (cdr dirs)))
 	(if found
 	    (progn (setq filename (expand-file-name found))
 		   t))))
 (Info-find-file-node filename nodename no-going-back tryfile line))
 ;; Look for a URL.  This pattern is stolen from w3.el to prevent
 ;; loading it if we won't need it.
 		      (set-buffer (or buf
 				      (generate-new-buffer
 				       (if (string-match "localdir" file)
 					   "localdir"
 					 "info dir"))))
 		      (if (not buf)
 			  (insert-file-contents file))
 		      (if (string-match "localdir" (buffer-name))
 			  (setq lbuffers (cons (current-buffer) lbuffers))
 			(setq buffers (cons (current-buffer) buffers)))
 		      (if attrs
 			  (setq Info-dir-file-attributes
 				(cons (cons file attrs)
 				      Info-dir-file-attributes)))))))
 	  (or (cdr dirs) (setq Info-dir-contents-directory (car dirs)))
 	  (setq dirs (cdr dirs))))
 ;; ensure that the localdir files are inserted last, and reverse
 ;; the list of them so that when they get pushed in, they appear
 ;; in the same order they got specified in the path, from top to
 ;; bottom.
 (nconc buffers (reverse lbuffers))
 (or buffers
 	  (error "Can't find the Info directory node"))
 ;; Distinguish the dir file that comes with Emacs from all the
 ;; others.  Yes, that is really what this is supposed to do.
 ;; If it doesn't work, fix it.
 		  (search-forward "\n\^_" nil 'move)
 		  (beginning-of-line)
 		  (setq end (point))
 		  (setq nodes (cons (list nodename other beg end) nodes))))))
 	  (setq others (cdr others))))
 ;; Add to the main menu a menu item for each other node.
 (re-search-forward "^\\* Menu:" nil t)
 (forward-line 1)
 (let ((menu-items '("top"))
 	    (nodes nodes)
 (unless (or (not (file-exists-p (file-name-directory file)))
 	      (null (directory-files (file-name-directory file) nil "\\.info")))
 (if (not (find-buffer-visiting file))
 	(if (not (file-exists-p file))
 	    (if (or (eq Info-auto-generate-directory 'always)
 		    (eq Info-auto-generate-directory 'if-missing))
 		(Info-build-dir-anew (file-name-directory file)))
 	  (if (or (eq Info-auto-generate-directory 'always)
 		  (and (eq Info-auto-generate-directory 'if-outdated)
 		       (Info-dir-outdated-p file)))
 	      (Info-rebuild-dir file))))))
 directory has been modified more recently."
 (let ((dir-mod-time (nth 5 (file-attributes file)))
 	f-mod-time
 	newer)
 (setq Info-dir-newer-info-files nil)
 (mapcar
 #'(lambda (f)
 	 (prog2
 	     (setq f-mod-time (nth 5 (file-attributes f)))
 	     (setq newer (or (> (car f-mod-time) (car dir-mod-time))
 			     (and (= (car f-mod-time) (car dir-mod-time))
 				  (> (car (cdr f-mod-time)) (car (cdr dir-mod-time))))))
 	   (if (and (file-readable-p f)
 		    newer)
 	       (setq Info-dir-newer-info-files
 		     (cons f Info-dir-newer-info-files)))))
 (directory-files (file-name-directory file)
 		      'fullname
 		      ".*\\.info\\(\\.gz\\|\\.bz2\\|\\.Z\\|-z\\|\\.zip\\)?$"
 		      'nosort
 	(while (re-search-forward "^\\* \\([^:]+\\):\\([ \t]*(\\([^)]*\\))\\w*\\.\\|:\\)" nil t)
 	  (setq entry (list (match-string 2)
 			    (match-string 1)
 			    (downcase (or (match-string 3)
 					  (match-string 1)))))
 	  (setq entry
 		(cons (nreverse
 		       (cdr
 			(nreverse
 			 (split-string
 			  (buffer-substring
 			   (re-search-forward "[ \t]*" nil t)
 			   (or (and (re-search-forward "^[^ \t]" nil t)
 				    (goto-char (match-beginning 0)))
 			       (point-max)))
 			  "[ \t]*\n[ \t]*"))))
 		(setq len (length (concat (car e)
 					  (car (cdr e)))))
 		(if (> len description-col)
 		    (setq description-col len)))
 	    entries)
 (setq description-col (+ 5 description-col))
 (mapcar #'(lambda (e)
 		(setq e (cdr e))	; Drop filename
 		(insert "* " (car e) ":" (car (cdr e)))
 		(setq e (car (cdr (cdr e))))
 		(while e
 (insert "\n")))
 (defun Info-build-dir-anew (directory)
 "Build info directory information for DIRECTORY.
 The generated directory listing may be saved to a `dir' according
 to the value of `Info-save-auto-generated-dir'"
 (save-excursion
 (let* ((dirfile (expand-file-name "dir" directory))
 	   (to-temp (or (null Info-save-auto-generated-dir)
 			(eq Info-save-auto-generated-dir 'never)
 			(and (not (file-writable-p dirfile))
 			     (message "File not writable %s. Using temporary." dirfile))))
 	   (info-files
 	    (directory-files directory
 			     'fullname
 			     ".*\\.info\\(.gz\\|.Z\\|-z\\|.zip\\)?$"
 			     nil
 			     t)))
 (set-buffer (find-file-noselect dirfile t))
 (setq buffer-read-only nil)
 (erase-buffer)
 (insert Info-dir-prologue
 	      "Info files in " directory ":\n\n")
 (Info-dump-dir-entries
 (mapcar
 	#'(lambda (f)
 	    (or (Info-extract-dir-entry-from f)
 		(list 'dummy
 		      (progn
 			(string-match "\\(.*\\)\\.info\\(.gz\\|.Z\\|-z\\|.zip\\)?$"
 				      (file-name-nondirectory f))
 			(capitalize (match-string 1 (file-name-nondirectory f))))
 		      ":"
 		      (list Info-no-description-string))))
 	info-files))
 	(message "Creating %s...done" dirfile)))))
 (defun Info-rebuild-dir (file)
 "Build info directory information in the directory of dir FILE.
 Description of info files are merged from the info files in the
 directory and the contents of FILE with the description in info files
 taking precedence over descriptions in FILE.
 The generated directory listing may be saved to a `dir' according to
 the value of `Info-save-auto-generated-dir' "
 (save-excursion
 (save-restriction
 (let (dir-section-contents dir-full-contents
 	    dir-entry
 	    file-dir-entry
 	    mark next-section
 	    not-first-section
 	    (to-temp
 	     (or (null Info-save-auto-generated-dir)
 		 (eq Info-save-auto-generated-dir 'never)
 		 (and (eq Info-save-auto-generated-dir 'always)
 		      (not (file-writable-p file))
 		      (message "File not writable %s. Using temporary." file))
 		 (and (eq Info-save-auto-generated-dir 'conservative)
 		      (or (and (not (file-writable-p file))
 			       (message "File not writable %s. Using temporary." file))
 			  (not (y-or-n-p
 				(message "%s is outdated. Overwrite ? "
 					 file))))))))
 	(set-buffer (find-file-noselect file t))
 	(setq buffer-read-only nil)
 	(if to-temp
 	    (message "Rebuilding temporary %s..." file)
 					(file-name-nondirectory file)))
 				      dir-full-contents))
 		     (if file-dir-entry
 			 (setq dir-section-contents (cons file-dir-entry
 							  dir-section-contents))
 		       (setq dir-section-contents
 			     (cons (list 'dummy
 					 (capitalize (file-name-sans-extension
 						      (file-name-nondirectory file)))
 					 ":"
 					 (list Info-no-description-string))
 				   dir-section-contents))))))
 	     Info-dir-newer-info-files)
 	    (delete-region (point-min) (point-max))
 	    (Info-dump-dir-entries (nreverse dir-section-contents))
 	    (widen)
 	      (set-buffer-modified-p nil)
 	      (message "Rebuilding temporary %s...done" file))
 	  (save-buffer)
 	  (message "Rebuilding %s...done" file))))))
 ;;;###autoload
 (defun Info-batch-rebuild-dir ()
 "(Re)build info `dir' files in the directories remaining on the command line.
 Use this from the command line, with `-batch';
 it won't work in an interactive Emacs.
 Each file is processed even if an error occurred previously.
 (if  (not (file-directory-p (car command-line-args-left)))
 	  (message "Warning: Skipped %s. Not a directory."
 		   (car command-line-args-left))
 	(setq dir (expand-file-name "dir" (car command-line-args-left)))
 	(setq localdir (expand-file-name "localdir" (car command-line-args-left)))
 	(cond
 	 ((file-exists-p dir)
 	  (Info-rebuild-dir dir))
 	 ((file-exists-p localdir)
 	  (Info-rebuild-dir localdir))
 	 (t
 		(forward-line 1)
 		(let ((beg (point)))
 		  (forward-line 1)
 		  (if (re-search-backward "Node: *\\([^,\n]*\\) *[,\n\t]"
 					  beg t)
 		      (setq compl
 			    (cons (list (buffer-substring (match-beginning 1)
 							  (match-end 1)))
 				  compl))))))))
 	(setq Info-current-file-completions compl))))
 (or (and (equal onode Info-current-node)
 (equal ofile Info-current-file))
 (Info-history-add ofile onode opoint)))))
 ;; Extract the value of the node-pointer named NAME.
 ;; If there is none, use ERRORNAME in the error message;
 ;; if ERRORNAME is nil, just return nil.
 (defun Info-extract-pointer (name &optional errorname)
 (save-excursion
 (goto-char (point-min))
 (forward-line 4)
 	         (setq item nil))))
 (list item))))
 ;; there is a problem here in that if several menu items have the same
 ;; name you can only go to the node of the first with this command.
 (Info-goto-node (Info-extract-menu-item menu-item) nil t))
 (defun Info-extract-menu-item (menu-item &optional noerror)
 (save-excursion
 (goto-char (point-min))
 (if (let ((case-fold-search t))
 	  (search-forward "\n* menu:" nil t))
 ;;;###autoload
 (defun Info-elisp-ref (func)
 "Look up an Emacs Lisp function in the Elisp manual in the Info system.
 This command is designed to be used whether you are already in Info or not."
 (interactive (let ((fn (function-at-point))
 		     (enable-recursive-minibuffers t)
 		     val)
 		 (setq val (completing-read
 			    (format "Look up Emacs Lisp function%s: "
 				    (if fn
 					(format " (default %s)" fn)
 "Construct a menu of Info commands.
 Adds an entry for the node at EVENT, or under point if EVENT is omitted.
 Used to construct the menubar submenu and popup menu."
 (or event (setq event (point)))
 (let ((case-fold-search t)
 	(xref-regexp (concat "\\*"
 			     (regexp-quote Info-footnote-tag)
 			     "[ \n\t]*\\([^:]*\\):"))
 	up-p prev-p next-p menu xrefs subnodes in)
 (save-excursion
 ;; `one-space' fixes "Notes:" xrefs that are split across lines.

Mercurial > hg > xemacs-beta

comparison lisp/info.el @ 404:2f8bb876ab1d r21-2-32